Macros
Collaboration diagram for IRDA Private Macros:

Macros

#define IRDA_BRR(_PCLK_, _BAUD_)
 
#define IRDA_DIV(_PCLK_, _BAUD_)   ((uint32_t)((((uint64_t)(_PCLK_))*25U)/(4U*(((uint64_t)(_BAUD_))))))
 
#define IRDA_DIVFRAQ(_PCLK_, _BAUD_)   ((((IRDA_DIV((_PCLK_), (_BAUD_)) - (IRDA_DIVMANT((_PCLK_), (_BAUD_)) * 100U)) * 16U) + 50U) / 100U)
 
#define IRDA_DIVMANT(_PCLK_, _BAUD_)   (IRDA_DIV((_PCLK_), (_BAUD_))/100U)
 
#define IS_IRDA_BAUDRATE(__BAUDRATE__)   ((__BAUDRATE__) < 115201U)
 Ensure that IRDA Baud rate is less or equal to maximum value. More...
 
#define IS_IRDA_BAUDRATE(BAUDRATE)   ((BAUDRATE) < 115201U)
 
#define IS_IRDA_DMA_RX(__DMARX__)
 Ensure that IRDA DMA RX mode is valid. More...
 
#define IS_IRDA_DMA_TX(__DMATX__)
 Ensure that IRDA DMA TX mode is valid. More...
 
#define IS_IRDA_MODE(__MODE__)
 Ensure that IRDA associated UART/USART mode is valid. More...
 
#define IS_IRDA_MODE(MODE)   ((((MODE) & 0x0000FFF3U) == 0x00U) && ((MODE) != 0x00000000U))
 
#define IS_IRDA_ONE_BIT_SAMPLE(__ONEBIT__)
 Ensure that IRDA sampling rate is valid. More...
 
#define IS_IRDA_PARITY(__PARITY__)
 Ensure that IRDA frame parity is valid. More...
 
#define IS_IRDA_PARITY(PARITY)
 
#define IS_IRDA_POWERMODE(__MODE__)
 Ensure that IRDA power mode is valid. More...
 
#define IS_IRDA_POWERMODE(MODE)
 
#define IS_IRDA_PRESCALER(__PRESCALER__)   ((__PRESCALER__) > 0U)
 Ensure that IRDA prescaler value is strictly larger than 0. More...
 
#define IS_IRDA_REQUEST_PARAMETER(__PARAM__)
 Ensure that IRDA request is valid. More...
 
#define IS_IRDA_STATE(__STATE__)
 Ensure that IRDA state is valid. More...
 
#define IS_IRDA_TX_RX_MODE(__MODE__)
 Ensure that IRDA communication mode is valid. More...
 
#define IS_IRDA_WORD_LENGTH(LENGTH)
 

Detailed Description

Macro Definition Documentation

◆ IRDA_BRR

#define IRDA_BRR (   _PCLK_,
  _BAUD_ 
)
Value:
(((IRDA_DIVMANT((_PCLK_), (_BAUD_)) << 4U) + \
(IRDA_DIVFRAQ((_PCLK_), (_BAUD_)) & 0xF0U)) + \
(IRDA_DIVFRAQ((_PCLK_), (_BAUD_)) & 0x0FU))

Definition at line 653 of file stm32f4xx_hal_irda.h.

◆ IRDA_DIV

#define IRDA_DIV (   _PCLK_,
  _BAUD_ 
)    ((uint32_t)((((uint64_t)(_PCLK_))*25U)/(4U*(((uint64_t)(_BAUD_))))))

Definition at line 645 of file stm32f4xx_hal_irda.h.

◆ IRDA_DIVFRAQ

#define IRDA_DIVFRAQ (   _PCLK_,
  _BAUD_ 
)    ((((IRDA_DIV((_PCLK_), (_BAUD_)) - (IRDA_DIVMANT((_PCLK_), (_BAUD_)) * 100U)) * 16U) + 50U) / 100U)

Definition at line 649 of file stm32f4xx_hal_irda.h.

◆ IRDA_DIVMANT

#define IRDA_DIVMANT (   _PCLK_,
  _BAUD_ 
)    (IRDA_DIV((_PCLK_), (_BAUD_))/100U)

Definition at line 647 of file stm32f4xx_hal_irda.h.

◆ IS_IRDA_BAUDRATE [1/2]

#define IS_IRDA_BAUDRATE (   __BAUDRATE__)    ((__BAUDRATE__) < 115201U)

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

Parameters
<strong>BAUDRATE</strong>specifies the IRDA Baudrate set by the user.
Return values
Trueor False

Definition at line 668 of file stm32f7xx_hal_irda.h.

◆ IS_IRDA_BAUDRATE [2/2]

#define IS_IRDA_BAUDRATE (   BAUDRATE)    ((BAUDRATE) < 115201U)

Definition at line 643 of file stm32f4xx_hal_irda.h.

◆ 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
<strong>DMARX</strong>IRDA DMA RX mode.
Return values
SET(DMARX is valid) or RESET (DMARX is invalid)

Definition at line 730 of file stm32f7xx_hal_irda.h.

◆ 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
<strong>DMATX</strong>IRDA DMA TX mode.
Return values
SET(DMATX is valid) or RESET (DMATX is invalid)

Definition at line 723 of file stm32f7xx_hal_irda.h.

◆ IS_IRDA_MODE [1/2]

#define IS_IRDA_MODE (   __MODE__)
Value:
(((__MODE__) == IRDA_MODE_DISABLE) || \
((__MODE__) == IRDA_MODE_ENABLE))

Ensure that IRDA associated UART/USART mode is valid.

Parameters
<strong>MODE</strong>IRDA associated UART/USART mode.
Return values
SET(MODE is valid) or RESET (MODE is invalid)

Definition at line 709 of file stm32f7xx_hal_irda.h.

◆ IS_IRDA_MODE [2/2]

#define IS_IRDA_MODE (   MODE)    ((((MODE) & 0x0000FFF3U) == 0x00U) && ((MODE) != 0x00000000U))

Definition at line 638 of file stm32f4xx_hal_irda.h.

◆ 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
<strong>ONEBIT</strong>IRDA sampling rate.
Return values
SET(ONEBIT is valid) or RESET (ONEBIT is invalid)

Definition at line 716 of file stm32f7xx_hal_irda.h.

◆ IS_IRDA_PARITY [1/2]

#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
<strong>PARITY</strong>IRDA frame parity.
Return values
SET(PARITY is valid) or RESET (PARITY is invalid)

Definition at line 680 of file stm32f7xx_hal_irda.h.

◆ IS_IRDA_PARITY [2/2]

#define IS_IRDA_PARITY (   PARITY)
Value:
(((PARITY) == IRDA_PARITY_NONE) || \
((PARITY) == IRDA_PARITY_EVEN) || \
((PARITY) == IRDA_PARITY_ODD))

Definition at line 634 of file stm32f4xx_hal_irda.h.

◆ IS_IRDA_POWERMODE [1/2]

#define IS_IRDA_POWERMODE (   __MODE__)
Value:
(((__MODE__) == IRDA_POWERMODE_LOWPOWER) || \
((__MODE__) == IRDA_POWERMODE_NORMAL))

Ensure that IRDA power mode is valid.

Parameters
<strong>MODE</strong>IRDA power mode.
Return values
SET(MODE is valid) or RESET (MODE is invalid)

Definition at line 695 of file stm32f7xx_hal_irda.h.

◆ IS_IRDA_POWERMODE [2/2]

#define IS_IRDA_POWERMODE (   MODE)
Value:
(((MODE) == IRDA_POWERMODE_LOWPOWER) || \
((MODE) == IRDA_POWERMODE_NORMAL))

Definition at line 640 of file stm32f4xx_hal_irda.h.

◆ IS_IRDA_PRESCALER

#define IS_IRDA_PRESCALER (   __PRESCALER__)    ((__PRESCALER__) > 0U)

Ensure that IRDA prescaler value is strictly larger than 0.

Parameters
<strong>PRESCALER</strong>specifies the IRDA prescaler value set by the user.
Return values
Trueor False

Definition at line 674 of file stm32f7xx_hal_irda.h.

◆ 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
<strong>PARAM</strong>IRDA request.
Return values
SET(PARAM is valid) or RESET (PARAM is invalid)

Definition at line 737 of file stm32f7xx_hal_irda.h.

◆ IS_IRDA_STATE

#define IS_IRDA_STATE (   __STATE__)
Value:
(((__STATE__) == IRDA_STATE_DISABLE) || \
((__STATE__) == IRDA_STATE_ENABLE))

Ensure that IRDA state is valid.

Parameters
<strong>STATE</strong>IRDA state mode.
Return values
SET(STATE is valid) or RESET (STATE is invalid)

Definition at line 702 of file stm32f7xx_hal_irda.h.

◆ 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
<strong>MODE</strong>IRDA communication mode.
Return values
SET(MODE is valid) or RESET (MODE is invalid)

Definition at line 688 of file stm32f7xx_hal_irda.h.

◆ IS_IRDA_WORD_LENGTH

#define IS_IRDA_WORD_LENGTH (   LENGTH)
Value:
(((LENGTH) == IRDA_WORDLENGTH_8B) || \
((LENGTH) == IRDA_WORDLENGTH_9B))

Definition at line 631 of file stm32f4xx_hal_irda.h.

IRDA_DMA_RX_ENABLE
#define IRDA_DMA_RX_ENABLE
Definition: stm32f7xx_hal_irda.h:343
IRDA_DMA_RX_DISABLE
#define IRDA_DMA_RX_DISABLE
Definition: stm32f7xx_hal_irda.h:342
IRDA_DMA_TX_DISABLE
#define IRDA_DMA_TX_DISABLE
Definition: stm32f7xx_hal_irda.h:333
IRDA_RXDATA_FLUSH_REQUEST
#define IRDA_RXDATA_FLUSH_REQUEST
Definition: stm32f7xx_hal_irda.h:352
IRDA_PARITY_EVEN
#define IRDA_PARITY_EVEN
Definition: stm32f7xx_hal_irda.h:278
IRDA_DIVMANT
#define IRDA_DIVMANT(_PCLK_, _BAUD_)
Definition: stm32f4xx_hal_irda.h:647
IRDA_MODE_DISABLE
#define IRDA_MODE_DISABLE
Definition: stm32f7xx_hal_irda.h:315
IRDA_PARITY_ODD
#define IRDA_PARITY_ODD
Definition: stm32f7xx_hal_irda.h:279
IRDA_DMA_TX_ENABLE
#define IRDA_DMA_TX_ENABLE
Definition: stm32f7xx_hal_irda.h:334
IRDA_ONE_BIT_SAMPLE_DISABLE
#define IRDA_ONE_BIT_SAMPLE_DISABLE
Definition: stm32f7xx_hal_irda.h:324
IRDA_MODE_TX_RX
#define IRDA_MODE_TX_RX
Definition: stm32f7xx_hal_irda.h:289
IRDA_MODE_ENABLE
#define IRDA_MODE_ENABLE
Definition: stm32f7xx_hal_irda.h:316
IRDA_PARITY_NONE
#define IRDA_PARITY_NONE
Definition: stm32f7xx_hal_irda.h:277
IRDA_WORDLENGTH_8B
#define IRDA_WORDLENGTH_8B
Definition: stm32f4xx_hal_irda.h:254
IRDA_STATE_DISABLE
#define IRDA_STATE_DISABLE
Definition: stm32f7xx_hal_irda.h:306
IRDA_ONE_BIT_SAMPLE_ENABLE
#define IRDA_ONE_BIT_SAMPLE_ENABLE
Definition: stm32f7xx_hal_irda.h:325
IRDA_AUTOBAUD_REQUEST
#define IRDA_AUTOBAUD_REQUEST
Definition: stm32f7xx_hal_irda.h:351
IRDA_STATE_ENABLE
#define IRDA_STATE_ENABLE
Definition: stm32f7xx_hal_irda.h:307
IRDA_TXDATA_FLUSH_REQUEST
#define IRDA_TXDATA_FLUSH_REQUEST
Definition: stm32f7xx_hal_irda.h:353
IRDA_POWERMODE_LOWPOWER
#define IRDA_POWERMODE_LOWPOWER
Definition: stm32f7xx_hal_irda.h:298
IRDA_WORDLENGTH_9B
#define IRDA_WORDLENGTH_9B
Definition: stm32f4xx_hal_irda.h:255
IRDA_DIVFRAQ
#define IRDA_DIVFRAQ(_PCLK_, _BAUD_)
Definition: stm32f4xx_hal_irda.h:649
IRDA_POWERMODE_NORMAL
#define IRDA_POWERMODE_NORMAL
Definition: stm32f7xx_hal_irda.h:297


picovoice_driver
Author(s):
autogenerated on Fri Apr 1 2022 02:15:08