IRDAEx Private Macros

Macros
#define	IRDA_GETCLOCKSOURCE(__HANDLE__, __CLOCKSOURCE__)
	Report the IRDA clock source.
#define	IRDA_MASK_COMPUTATION(__HANDLE__)
	Compute the mask to apply to retrieve the received data according to the word length and to the parity bits activation.
#define	IS_IRDA_WORD_LENGTH(__LENGTH__)
	Ensure that IRDA frame length is valid.

Detailed Description

Macro Definition Documentation

IRDA_GETCLOCKSOURCE

#define IRDA_GETCLOCKSOURCE	(		__HANDLE__,
			__CLOCKSOURCE__
	)

Report the IRDA clock source.

Parameters

__HANDLE__	specifies the IRDA Handle.
__CLOCKSOURCE__	output variable.

Return values

IRDA	clocking source, written in CLOCKSOURCE.

IRDA_MASK_COMPUTATION

#define IRDA_MASK_COMPUTATION

(

__HANDLE__

)

Compute the mask to apply to retrieve the received data according to the word length and to the parity bits activation.

Parameters

__HANDLE__

specifies the IRDA Handle.

Return values

None,the

mask to apply to the associated UART RDR register is stored in (HANDLE)->Mask field.

IS_IRDA_WORD_LENGTH

#define IS_IRDA_WORD_LENGTH

(

__LENGTH__

)

Value:

                                         (((__LENGTH__) == IRDA_WORDLENGTH_7B) || \
                                         ((__LENGTH__) == IRDA_WORDLENGTH_8B) || \
                                         ((__LENGTH__) == IRDA_WORDLENGTH_9B))

Ensure that IRDA frame length is valid.

Parameters

__LENGTH__

IRDA frame length.

Return values

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