IRDA_Private_Macros

Macros
#define	IS_IRDA_BAUDRATE(__BAUDRATE__)   ((__BAUDRATE__) < 115201U)
	Ensure that IRDA Baud rate is less or equal to maximum value. More...
#define	IS_IRDA_PRESCALER(__PRESCALER__)   ((__PRESCALER__) > 0U)
	Ensure that IRDA prescaler value is strictly larger than 0. More...
#define	IS_IRDA_PARITY(__PARITY__)
	Ensure that IRDA frame parity is valid. More...
#define	IS_IRDA_TX_RX_MODE(__MODE__)
	Ensure that IRDA communication mode is valid. More...
#define	IS_IRDA_POWERMODE(__MODE__)
	Ensure that IRDA power mode is valid. More...
#define	IS_IRDA_CLOCKPRESCALER(__CLOCKPRESCALER__)
	Ensure that IRDA clock Prescaler is valid. More...
#define	IS_IRDA_STATE(__STATE__)
	Ensure that IRDA state is valid. More...
#define	IS_IRDA_MODE(__MODE__)
	Ensure that IRDA associated UART/USART mode is valid. More...
#define	IS_IRDA_ONE_BIT_SAMPLE(__ONEBIT__)
	Ensure that IRDA sampling rate is valid. More...
#define	IS_IRDA_DMA_TX(__DMATX__)
	Ensure that IRDA DMA TX mode is valid. More...
#define	IS_IRDA_DMA_RX(__DMARX__)
	Ensure that IRDA DMA RX mode is valid. More...
#define	IS_IRDA_REQUEST_PARAMETER(__PARAM__)
	Ensure that IRDA request is valid. More...

Detailed Description

Macro Definition Documentation

IS_IRDA_BAUDRATE

#define IS_IRDA_BAUDRATE

(

__BAUDRATE__

)

((__BAUDRATE__) < 115201U)

Ensure that IRDA Baud rate is less or equal to maximum value.

Parameters

__BAUDRATE__

specifies the IRDA Baudrate set by the user.

Return values

True

or False

IS_IRDA_CLOCKPRESCALER

#define IS_IRDA_CLOCKPRESCALER

(

__CLOCKPRESCALER__

)

Value:

                                                    (((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV1) || \
                                                    ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV2)   || \
                                                    ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV4)   || \
                                                    ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV6)   || \
                                                    ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV8)   || \
                                                    ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV10)  || \
                                                    ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV12)  || \
                                                    ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV16)  || \
                                                    ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV32)  || \
                                                    ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV64)  || \
                                                    ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV128) || \
                                                    ((__CLOCKPRESCALER__) == IRDA_PRESCALER_DIV256))

Ensure that IRDA clock Prescaler is valid.

Parameters

__CLOCKPRESCALER__

IRDA clock Prescaler value.

Return values

SET	(CLOCKPRESCALER is valid) or RESET (CLOCKPRESCALER is invalid)

IS_IRDA_DMA_RX

#define IS_IRDA_DMA_RX

(

__DMARX__

)

Value:

                                   (((__DMARX__) == IRDA_DMA_RX_DISABLE) || \
                                   ((__DMARX__) == IRDA_DMA_RX_ENABLE))

Ensure that IRDA DMA RX mode is valid.

Parameters

__DMARX__

IRDA DMA RX mode.

Return values

SET	(DMARX is valid) or RESET (DMARX is invalid)

IS_IRDA_DMA_TX

#define IS_IRDA_DMA_TX

(

__DMATX__

)

Value:

                                       (((__DMATX__) == IRDA_DMA_TX_DISABLE) || \
                                       ((__DMATX__) == IRDA_DMA_TX_ENABLE))

Ensure that IRDA DMA TX mode is valid.

Parameters

__DMATX__

IRDA DMA TX mode.

Return values

SET	(DMATX is valid) or RESET (DMATX is invalid)

IS_IRDA_MODE

#define IS_IRDA_MODE

(

__MODE__

)

Value:

                                 (((__MODE__) == IRDA_MODE_DISABLE) || \
                                 ((__MODE__) == IRDA_MODE_ENABLE))

Ensure that IRDA associated UART/USART mode is valid.

Parameters

__MODE__

IRDA associated UART/USART mode.

Return values

SET	(MODE is valid) or RESET (MODE is invalid)

IS_IRDA_ONE_BIT_SAMPLE

#define IS_IRDA_ONE_BIT_SAMPLE

(

__ONEBIT__

)

Value:

                                                 (((__ONEBIT__) == IRDA_ONE_BIT_SAMPLE_DISABLE) || \
                                                 ((__ONEBIT__) == IRDA_ONE_BIT_SAMPLE_ENABLE))

Ensure that IRDA sampling rate is valid.

Parameters

__ONEBIT__

IRDA sampling rate.

Return values

SET	(ONEBIT is valid) or RESET (ONEBIT is invalid)

IS_IRDA_PARITY

#define IS_IRDA_PARITY

(

__PARITY__

)

Value:

                                    (((__PARITY__) == IRDA_PARITY_NONE) || \
                                    ((__PARITY__) == IRDA_PARITY_EVEN) || \
                                    ((__PARITY__) == IRDA_PARITY_ODD))

Ensure that IRDA frame parity is valid.

Parameters

__PARITY__

IRDA frame parity.

Return values

SET	(PARITY is valid) or RESET (PARITY is invalid)

IS_IRDA_POWERMODE

#define IS_IRDA_POWERMODE

(

__MODE__

)

Value:

                                     (((__MODE__) == IRDA_POWERMODE_LOWPOWER) || \
                                     ((__MODE__) == IRDA_POWERMODE_NORMAL))

Ensure that IRDA power mode is valid.

Parameters

__MODE__

IRDA power mode.

Return values

SET	(MODE is valid) or RESET (MODE is invalid)

IS_IRDA_PRESCALER

#define IS_IRDA_PRESCALER

(

__PRESCALER__

)

((__PRESCALER__) > 0U)

Ensure that IRDA prescaler value is strictly larger than 0.

Parameters

__PRESCALER__

specifies the IRDA prescaler value set by the user.

Return values

True

or False

IS_IRDA_REQUEST_PARAMETER

#define IS_IRDA_REQUEST_PARAMETER

(

__PARAM__

)

Value:

                                              (((__PARAM__) == IRDA_AUTOBAUD_REQUEST) || \
                                              ((__PARAM__) == IRDA_RXDATA_FLUSH_REQUEST) || \
                                              ((__PARAM__) == IRDA_TXDATA_FLUSH_REQUEST))

Ensure that IRDA request is valid.

Parameters

__PARAM__

IRDA request.

Return values

SET	(PARAM is valid) or RESET (PARAM is invalid)

IS_IRDA_STATE

#define IS_IRDA_STATE

(

__STATE__

)

Value:

                                  (((__STATE__) == IRDA_STATE_DISABLE) || \
                                  ((__STATE__) == IRDA_STATE_ENABLE))

Ensure that IRDA state is valid.

Parameters

__STATE__

IRDA state mode.

Return values

SET	(STATE is valid) or RESET (STATE is invalid)

IS_IRDA_TX_RX_MODE

#define IS_IRDA_TX_RX_MODE

(

__MODE__

)

Value:

                                        ((((__MODE__)\
                                        & (~((uint32_t)(IRDA_MODE_TX_RX)))) == 0x00U) && ((__MODE__) != 0x00U))

Ensure that IRDA communication mode is valid.

Parameters

__MODE__

IRDA communication mode.

Return values

SET	(MODE is valid) or RESET (MODE is invalid)