General Description

Basic utility types, macros and functions.

Macros
#define	CY_UNUSED_PARAMETER(x) ( (void)(x) )
	Simple macro to suppress the unused parameter warning by casting to void.

#define	CY_ASSERT(x)
	Utility macro when neither NDEBUG or CY_NO_ASSERT is not declared to check a condition and, if false, trigger a breakpoint. More...

#define	CY_LO8(x) ((uint8_t) ((x) & 0xFFU))
	Get the lower 8 bits of a 16-bit value.

#define	CY_HI8(x) ((uint8_t) ((uint16_t)(x) >> 8U))
	Get the upper 8 bits of a 16-bit value.

#define	CY_LO16(x) ((uint16_t) ((x) & 0xFFFFU))
	Get the lower 16 bits of a 32-bit value.

#define	CY_HI16(x) ((uint16_t) ((uint32_t)(x) >> 16U))
	Get the upper 16 bits of a 32-bit value.

#define	CY_SWAP_ENDIAN16(x) ((uint16_t)(((x) << 8U) \| (((x) >> 8U) & 0x00FFU)))
	Swap the byte ordering of a 16-bit value.

#define	CY_SWAP_ENDIAN32(x)
	Swap the byte ordering of a 32-bit value. More...

#define	CY_SWAP_ENDIAN64(x)
	Swap the byte ordering of a 64-bit value. More...

#define	CY_GET_REG8(addr) (((const volatile uint8_t )(addr)))
	Reads the 8-bit value from the specified address. More...

#define	CY_SET_REG8(addr, value) (((volatile uint8_t )(addr)) = (uint8_t)(value))
	Writes an 8-bit value to the specified address. More...

#define	CY_GET_REG16(addr) (((const volatile uint16_t )(addr)))
	Reads the 16-bit value from the specified address. More...

#define	CY_SET_REG16(addr, value) (((volatile uint16_t )(addr)) = (uint16_t)(value))
	Writes the 16-bit value to the specified address. More...

#define	CY_GET_REG24(addr)
	Reads the 24-bit value from the specified address. More...

#define	CY_SET_REG24(addr, value)
	Writes the 24-bit value to the specified address. More...

#define	CY_GET_REG32(addr) (((const volatile uint32_t )(addr)))
	Reads the 32-bit value from the specified register. More...

#define	CY_SET_REG32(addr, value) (((volatile uint32_t )(addr)) = (uint32_t)(value))
	Writes the 32-bit value to the specified register. More...

#define	_CLR_SET_FLD32U(reg, field, value) (((reg) & ((uint32_t)(~(field ## _Msk)))) \| (_VAL2FLD(field, value)))
	The macro for setting a register with a name field and value for providing get-clear-modify-write operations. More...

#define	CY_REG32_CLR_SET(reg, field, value) ((reg) = _CLR_SET_FLD32U((reg), field, (value)))
	Uses _CLR_SET_FLD32U macro for providing get-clear-modify-write operations with a name field and value and writes a resulting value to the 32-bit register.

#define	_CLR_SET_FLD16U(reg, field, value) ((uint16_t)(((reg) & ((uint16_t)(~(field ## _Msk)))) \| ((uint16_t)_VAL2FLD(field, value))))
	The macro for setting a 16-bit register with a name field and value for providing get-clear-modify-write operations. More...

#define	CY_REG16_CLR_SET(reg, field, value) ((reg) = _CLR_SET_FLD16U((reg), field, (value)))
	Uses _CLR_SET_FLD16U macro for providing get-clear-modify-write operations with a name field and value and writes a resulting value to the 16-bit register.

#define	_CLR_SET_FLD8U(reg, field, value) ((uint8_t)(((reg) & ((uint8_t)(~(field ## _Msk)))) \| ((uint8_t)_VAL2FLD(field, value))))
	The macro for setting a 8-bit register with a name field and value for providing get-clear-modify-write operations. More...

#define	CY_REG8_CLR_SET(reg, field, value) ((reg) = _CLR_SET_FLD8U((reg), field, (value)))
	Uses _CLR_SET_FLD8U macro for providing get-clear-modify-write operations with a name field and value and writes a resulting value to the 8-bit register.

#define	_BOOL2FLD(field, value) (((value) != false) ? (field ## _Msk) : 0UL)
	Returns a field mask if the value is not false. More...

#define	_FLD2BOOL(field, value) (((value) & (field ## _Msk)) != 0UL)
	Returns true, if the value includes the field mask. More...

#define	CY_SYSLIB_DIV_ROUND(a, b) (((a) + ((b) / 2U)) / (b))
	Calculates a / b with rounding to the nearest integer, a and b must have the same sign.

#define	CY_SYSLIB_DIV_ROUNDUP(a, b) ((((a) - 1U) / (b)) + 1U)
	Calculates a / b with rounding up if remainder != 0, both a and b must be positive.

Typedefs
typedef char	cy_char8_t
	Specific-length typedef for the basic numerical types of char.

typedef float	cy_float32_t
	Specific-length typedef for the basic numerical types of float.

typedef double	cy_float64_t
	Specific-length typedef for the basic numerical types of double.

Functions
static void	CY_HALT (void)
	Halt the processor in the debug state.

Macro Definition Documentation

◆ CY_ASSERT

#define CY_ASSERT ( x )

Value:

                                do {                \
                                if(!(x))        \
                                {               \
                                    CY_HALT();  \
                                }               \
                            } while(false)

Utility macro when neither NDEBUG or CY_NO_ASSERT is not declared to check a condition and, if false, trigger a breakpoint.

◆ CY_SWAP_ENDIAN32

#define CY_SWAP_ENDIAN32 ( x )

Value:

((uint32_t)((((x) >> 24U) & 0x000000FFU) | (((x) & 0x00FF0000U) >> 8U) | \

(((x) & 0x0000FF00U) << 8U) | ((x) << 24U)))

Swap the byte ordering of a 32-bit value.

◆ CY_SWAP_ENDIAN64

#define CY_SWAP_ENDIAN64 ( x )

Value:

((uint64_t) (((uint64_t) CY_SWAP_ENDIAN32((uint32_t)(x)) << 32U) | \

CY_SWAP_ENDIAN32((uint32_t)((x) >> 32U))))

CY_SWAP_ENDIAN32

#define CY_SWAP_ENDIAN32(x)

Swap the byte ordering of a 32-bit value.

Definition: cy_utils.h:100

Swap the byte ordering of a 64-bit value.

◆ CY_GET_REG8

#define CY_GET_REG8 ( addr ) (*((const volatile uint8_t *)(addr)))

Reads the 8-bit value from the specified address.

This function can't be used to access the Core register, otherwise a fault occurs.

Parameters

addr	The register address.

Returns: The read value.

◆ CY_SET_REG8

#define CY_SET_REG8	(	addr,
		value
	)	(((volatile uint8_t )(addr)) = (uint8_t)(value))

Writes an 8-bit value to the specified address.

This function can't be used to access the Core register, otherwise a fault occurs.

Parameters

addr	The register address.
value	The value to write.

◆ CY_GET_REG16

#define CY_GET_REG16 ( addr ) (*((const volatile uint16_t *)(addr)))

Reads the 16-bit value from the specified address.

Parameters

addr	The register address.

Returns: The read value.

◆ CY_SET_REG16

#define CY_SET_REG16	(	addr,
		value
	)	(((volatile uint16_t )(addr)) = (uint16_t)(value))

Writes the 16-bit value to the specified address.

Parameters

addr	The register address.
value	The value to write.

◆ CY_GET_REG24

#define CY_GET_REG24 ( addr )

Value:

                            (((uint32_t) (*((const volatile uint8_t *)(addr)))) | \
                            (((uint32_t) (*((const volatile uint8_t *)(addr) + 1))) << 8U) | \
                            (((uint32_t) (*((const volatile uint8_t *)(addr) + 2))) << 16U))

Reads the 24-bit value from the specified address.

Parameters

addr	The register address.

Returns: The read value.

◆ CY_SET_REG24

#define CY_SET_REG24	(	addr,
		value
	)

Value:

    do  \
    {   \
        (*((volatile uint8_t *) (addr))) = (uint8_t)(value);                \
        (*((volatile uint8_t *) (addr) + 1)) = (uint8_t)((value) >> 8U);    \
        (*((volatile uint8_t *) (addr) + 2)) = (uint8_t)((value) >> 16U);   \
    }   \
    while(0)

Writes the 24-bit value to the specified address.

Parameters

addr	The register address.
value	The value to write.

◆ CY_GET_REG32

#define CY_GET_REG32 ( addr ) (*((const volatile uint32_t *)(addr)))

Reads the 32-bit value from the specified register.

The address is the little endian order (LSB in lowest address).

Parameters

addr	The register address.

Returns: The read value.

◆ CY_SET_REG32

#define CY_SET_REG32	(	addr,
		value
	)	(((volatile uint32_t )(addr)) = (uint32_t)(value))

Writes the 32-bit value to the specified register.

The address is the little endian order (LSB in lowest address).

Parameters

addr	The register address.
value	The value to write.

◆ _CLR_SET_FLD32U

#define _CLR_SET_FLD32U	(	reg,
		field,
		value
	)	(((reg) & ((uint32_t)(~(field ## _Msk)))) \| (_VAL2FLD(field, value)))

The macro for setting a register with a name field and value for providing get-clear-modify-write operations.

Returns a resulting value to be assigned to the register.

◆ _CLR_SET_FLD16U

#define _CLR_SET_FLD16U	(	reg,
		field,
		value
	)	((uint16_t)(((reg) & ((uint16_t)(~(field ## _Msk)))) \| ((uint16_t)_VAL2FLD(field, value))))

The macro for setting a 16-bit register with a name field and value for providing get-clear-modify-write operations.

Returns a resulting value to be assigned to the 16-bit register.

◆ _CLR_SET_FLD8U

#define _CLR_SET_FLD8U	(	reg,
		field,
		value
	)	((uint8_t)(((reg) & ((uint8_t)(~(field ## _Msk)))) \| ((uint8_t)_VAL2FLD(field, value))))

The macro for setting a 8-bit register with a name field and value for providing get-clear-modify-write operations.

Returns a resulting value to be assigned to the 8-bit register.

◆ _BOOL2FLD

#define _BOOL2FLD	(	field,
		value
	)	(((value) != false) ? (field ## _Msk) : 0UL)

Returns a field mask if the value is not false.

Returns 0, if the value is false.

◆ _FLD2BOOL

#define _FLD2BOOL	(	field,
		value
	)	(((value) & (field ## _Msk)) != 0UL)

Returns true, if the value includes the field mask.

Returns false, if the value doesn't include the field mask.

General Description

Macros

Typedefs

Functions

Macro Definition Documentation

◆ CY_ASSERT

◆ CY_SWAP_ENDIAN32

◆ CY_SWAP_ENDIAN64

◆ CY_GET_REG8

◆ CY_SET_REG8

◆ CY_GET_REG16

◆ CY_SET_REG16

◆ CY_GET_REG24

◆ CY_SET_REG24

◆ CY_GET_REG32

◆ CY_SET_REG32

◆ _CLR_SET_FLD32U

◆ _CLR_SET_FLD16U

◆ _CLR_SET_FLD8U

◆ _BOOL2FLD

◆ _FLD2BOOL