STM8S/A Standard Peripherals Drivers: UART4_Private_Macros

STM8S/A Standard Peripherals Library

STM8S/A Standard Peripherals Drivers
UART4_Private_Macros

Defines

#define IS_UART4_ADDRESS_OK(node)   ((node) < UART4_ADDRESS_MAX )
#define IS_UART4_AUTOSYNC_OK(AutosyncMode)
 Macro used by the assert_param function in order to check the LIN automatic resynchronization mode.
#define IS_UART4_BAUDRATE_OK(NUM)   ((NUM) <= (uint32_t)625000)
 Macro used by the assert_param function in order to check the maximum baudrate value.
#define IS_UART4_CLEAR_FLAG_OK(Flag)
 Macro used by the assert_param function in order to check the different sensitivity values for the FLAGs that can be cleared by writing 0.
#define IS_UART4_CLEAR_IT_OK(ITPendingBit)
 Macro used by the assert function in order to check the different sensitivity values for the pending bit that can be cleared by writing 0.
#define IS_UART4_CONFIG_IT_OK(Interrupt)
 Macro used by the assert_param function in order to check the different sensitivity values for the Interrupts.
#define IS_UART4_DIVUP_OK(DivupMethode)
 Macro used by the assert_param function in order to check the LIN divider update method.
#define IS_UART4_FLAG_OK(Flag)
 Macro used by the assert_param function in order to check the different sensitivity values for the FLAGs.
#define IS_UART4_GET_IT_OK(ITPendingBit)
 Macro used by the assert function in order to check the different sensitivity values for the pending bit.
#define IS_UART4_IRDAMODE_OK(IrDAMode)
 Macro used by the assert_param function in order to check the different sensitivity values for the IrDAModes.
#define IS_UART4_LINBREAKDETECTIONLENGTH_OK(LINBreakDetectionLength)
 Macro used by the assert_param function in order to check the different sensitivity values for the LINBreakDetectionLengths.
#define IS_UART4_MODE_OK(Mode)
 Macro used by the assert function to check the different functions parameters.
#define IS_UART4_PARITY_OK(Parity)
 Macro used by the assert_param function in order to check the different sensitivity values for the Paritys.
#define IS_UART4_SLAVE_OK(Mode)
 Macro used by the assert_param function in order to check the LIN mode.
#define IS_UART4_STOPBITS_OK(StopBit)
 Macro used by the assert_param function in order to check the different sensitivity values for the UART4_StopBits.
#define IS_UART4_SYNCMODE_OK(SyncMode)
 Macro used by the assert_param function in order to check the different sensitivity values for the SyncModes; it should exclude values such as UART4_CLOCK_ENABLE|UART4_CLOCK_DISABLE.
#define IS_UART4_WAKEUP_OK(WakeUp)
 Macro used by the assert_param function in order to check the different sensitivity values for the WakeUps.
#define IS_UART4_WORDLENGTH_OK(WordLength)
 Macro used by the assert_param function in order to check the different sensitivity values for the WordLengths.
#define UART4_ADDRESS_MAX   ((uint8_t)16)
 Macro used by the assert_param function in order to check the address of the UART4 or UART node.

Define Documentation

#define IS_UART4_ADDRESS_OK (   node)    ((node) < UART4_ADDRESS_MAX )

Definition at line 367 of file stm8s_uart4.h.

Referenced by UART4_SetAddress().

#define IS_UART4_AUTOSYNC_OK (   AutosyncMode)
Value:
(((AutosyncMode) ==  UART4_LIN_AUTOSYNC_ENABLE) || \
   ((AutosyncMode) == UART4_LIN_AUTOSYNC_DISABLE))

Macro used by the assert_param function in order to check the LIN automatic resynchronization mode.

Definition at line 380 of file stm8s_uart4.h.

Referenced by UART4_LINConfig().

#define IS_UART4_BAUDRATE_OK (   NUM)    ((NUM) <= (uint32_t)625000)

Macro used by the assert_param function in order to check the maximum baudrate value.

Definition at line 360 of file stm8s_uart4.h.

Referenced by UART4_Init().

#define IS_UART4_CLEAR_FLAG_OK (   Flag)
Value:
(((Flag) == UART4_FLAG_RXNE) || \
   ((Flag) == UART4_FLAG_LHDF) || \
   ((Flag) == UART4_FLAG_LSF) || \
   ((Flag) == UART4_FLAG_LBDF))

Macro used by the assert_param function in order to check the different sensitivity values for the FLAGs that can be cleared by writing 0.

Definition at line 271 of file stm8s_uart4.h.

Referenced by UART4_ClearFlag().

#define IS_UART4_CLEAR_IT_OK (   ITPendingBit)
Value:
(((ITPendingBit) == UART4_IT_RXNE) || \
   ((ITPendingBit) == UART4_IT_LHDF) || \
   ((ITPendingBit) == UART4_IT_LBDF))

Macro used by the assert function in order to check the different sensitivity values for the pending bit that can be cleared by writing 0.

Definition at line 309 of file stm8s_uart4.h.

Referenced by UART4_ClearITPendingBit().

#define IS_UART4_CONFIG_IT_OK (   Interrupt)
Value:
(((Interrupt) == UART4_IT_PE) || \
   ((Interrupt) == UART4_IT_TXE) || \
   ((Interrupt) == UART4_IT_TC) || \
   ((Interrupt) == UART4_IT_RXNE_OR ) || \
   ((Interrupt) == UART4_IT_IDLE) || \
   ((Interrupt) == UART4_IT_LHDF) || \
   ((Interrupt) == UART4_IT_LBDF))

Macro used by the assert_param function in order to check the different sensitivity values for the Interrupts.

Definition at line 282 of file stm8s_uart4.h.

Referenced by UART4_ITConfig().

#define IS_UART4_DIVUP_OK (   DivupMethode)
Value:
(((DivupMethode) == UART4_LIN_DIVUP_LBRR1) || \
   ((DivupMethode) == UART4_LIN_DIVUP_NEXTRXNE))

Macro used by the assert_param function in order to check the LIN divider update method.

Definition at line 387 of file stm8s_uart4.h.

Referenced by UART4_LINConfig().

#define IS_UART4_FLAG_OK (   Flag)
Value:
(((Flag) == UART4_FLAG_TXE) || \
   ((Flag) == UART4_FLAG_TC)  || \
   ((Flag) == UART4_FLAG_RXNE) || \
   ((Flag) == UART4_FLAG_IDLE) || \
   ((Flag) == UART4_FLAG_OR_LHE) || \
   ((Flag) == UART4_FLAG_NF) || \
   ((Flag) == UART4_FLAG_FE) || \
   ((Flag) == UART4_FLAG_PE) || \
   ((Flag) == UART4_FLAG_SBK) || \
   ((Flag) == UART4_FLAG_LSF) || \
   ((Flag) == UART4_FLAG_LHDF) || \
   ((Flag) == UART4_FLAG_LBDF))

Macro used by the assert_param function in order to check the different sensitivity values for the FLAGs.

Definition at line 252 of file stm8s_uart4.h.

Referenced by UART4_GetFlagStatus().

#define IS_UART4_GET_IT_OK (   ITPendingBit)
Value:
(((ITPendingBit) == UART4_IT_TXE)  || \
   ((ITPendingBit) == UART4_IT_TC)   || \
   ((ITPendingBit) == UART4_IT_RXNE) || \
   ((ITPendingBit) == UART4_IT_IDLE) || \
   ((ITPendingBit) == UART4_IT_OR)  || \
   ((ITPendingBit) == UART4_IT_LBDF)  || \
   ((ITPendingBit) == UART4_IT_LHDF)  || \
   ((ITPendingBit) == UART4_IT_PE))

Macro used by the assert function in order to check the different sensitivity values for the pending bit.

Definition at line 295 of file stm8s_uart4.h.

Referenced by UART4_GetITStatus().

#define IS_UART4_IRDAMODE_OK (   IrDAMode)
Value:
(((IrDAMode) == UART4_IRDAMODE_LOWPOWER) || \
   ((IrDAMode) == UART4_IRDAMODE_NORMAL))

Macro used by the assert_param function in order to check the different sensitivity values for the IrDAModes.

Definition at line 319 of file stm8s_uart4.h.

Referenced by UART4_IrDAConfig().

#define IS_UART4_LINBREAKDETECTIONLENGTH_OK (   LINBreakDetectionLength)
Value:
(((LINBreakDetectionLength) == UART4_LINBREAKDETECTIONLENGTH_10BITS) || \
   ((LINBreakDetectionLength) == UART4_LINBREAKDETECTIONLENGTH_11BITS))

Macro used by the assert_param function in order to check the different sensitivity values for the LINBreakDetectionLengths.

Definition at line 335 of file stm8s_uart4.h.

Referenced by UART4_LINBreakDetectionConfig().

#define IS_UART4_MODE_OK (   Mode)
Value:
(((Mode) == (uint8_t)UART4_MODE_RX_ENABLE) || \
   ((Mode) == (uint8_t)UART4_MODE_RX_DISABLE) || \
   ((Mode) == (uint8_t)UART4_MODE_TX_ENABLE) || \
   ((Mode) == (uint8_t)UART4_MODE_TX_DISABLE) || \
   ((Mode) == (uint8_t)UART4_MODE_TXRX_ENABLE) || \
   ((Mode) == (uint8_t)((uint8_t)UART4_MODE_TX_ENABLE|(uint8_t)UART4_MODE_RX_ENABLE)) || \
   ((Mode) == (uint8_t)((uint8_t)UART4_MODE_TX_ENABLE|(uint8_t)UART4_MODE_RX_DISABLE)) || \
   ((Mode) == (uint8_t)((uint8_t)UART4_MODE_TX_DISABLE|(uint8_t)UART4_MODE_RX_DISABLE)) || \
   ((Mode) == (uint8_t)((uint8_t)UART4_MODE_TX_DISABLE|(uint8_t)UART4_MODE_RX_ENABLE)))

Macro used by the assert function to check the different functions parameters.

Macro used by the assert_param function in order to check the different sensitivity values for the MODEs possible combination should be one of the following.

Definition at line 218 of file stm8s_uart4.h.

Referenced by UART4_Init().

#define IS_UART4_PARITY_OK (   Parity)
Value:
(((Parity) == UART4_PARITY_NO) || \
                                    ((Parity) == UART4_PARITY_EVEN) || \
                                    ((Parity) == UART4_PARITY_ODD ))

Macro used by the assert_param function in order to check the different sensitivity values for the Paritys.

Definition at line 352 of file stm8s_uart4.h.

Referenced by UART4_Init().

#define IS_UART4_SLAVE_OK (   Mode)
Value:
(((Mode) == UART4_LIN_MODE_MASTER) || \
   ((Mode) == UART4_LIN_MODE_SLAVE))

Macro used by the assert_param function in order to check the LIN mode.

Definition at line 372 of file stm8s_uart4.h.

Referenced by UART4_LINConfig().

#define IS_UART4_STOPBITS_OK (   StopBit)
Value:
(((StopBit) == UART4_STOPBITS_1) || \
                                       ((StopBit) == UART4_STOPBITS_0_5) || \
                                       ((StopBit) == UART4_STOPBITS_2) || \
                                       ((StopBit) == UART4_STOPBITS_1_5 ))

Macro used by the assert_param function in order to check the different sensitivity values for the UART4_StopBits.

Definition at line 343 of file stm8s_uart4.h.

Referenced by UART4_Init().

#define IS_UART4_SYNCMODE_OK (   SyncMode)
Value:
(!((((SyncMode)&(((uint8_t)UART4_SYNCMODE_CLOCK_ENABLE)|((uint8_t)UART4_SYNCMODE_CLOCK_DISABLE))) == (((uint8_t)UART4_SYNCMODE_CLOCK_ENABLE)|((uint8_t)UART4_SYNCMODE_CLOCK_DISABLE))) || \
     (((SyncMode)&(((uint8_t)UART4_SYNCMODE_CPOL_LOW )|((uint8_t)UART4_SYNCMODE_CPOL_HIGH))) == (((uint8_t)UART4_SYNCMODE_CPOL_LOW )|((uint8_t)UART4_SYNCMODE_CPOL_HIGH))) || \
     (((SyncMode)&(((uint8_t)UART4_SYNCMODE_CPHA_MIDDLE)|((uint8_t)UART4_SYNCMODE_CPHA_BEGINING))) == (((uint8_t)UART4_SYNCMODE_CPHA_MIDDLE)|((uint8_t)UART4_SYNCMODE_CPHA_BEGINING))) || \
     (((SyncMode)&(((uint8_t)UART4_SYNCMODE_LASTBIT_DISABLE)|((uint8_t)UART4_SYNCMODE_LASTBIT_ENABLE))) == (((uint8_t)UART4_SYNCMODE_LASTBIT_DISABLE)|((uint8_t)UART4_SYNCMODE_LASTBIT_ENABLE)))))

Macro used by the assert_param function in order to check the different sensitivity values for the SyncModes; it should exclude values such as UART4_CLOCK_ENABLE|UART4_CLOCK_DISABLE.

Definition at line 242 of file stm8s_uart4.h.

Referenced by UART4_Init().

#define IS_UART4_WAKEUP_OK (   WakeUp)
Value:
(((WakeUp) == UART4_WAKEUP_IDLELINE) || \
   ((WakeUp) == UART4_WAKEUP_ADDRESSMARK))

Macro used by the assert_param function in order to check the different sensitivity values for the WakeUps.

Definition at line 327 of file stm8s_uart4.h.

Referenced by UART4_WakeUpConfig().

#define IS_UART4_WORDLENGTH_OK (   WordLength)
Value:
(((WordLength) == UART4_WORDLENGTH_8D) || \
   ((WordLength) == UART4_WORDLENGTH_9D))

Macro used by the assert_param function in order to check the different sensitivity values for the WordLengths.

Definition at line 233 of file stm8s_uart4.h.

Referenced by UART4_Init().

#define UART4_ADDRESS_MAX   ((uint8_t)16)

Macro used by the assert_param function in order to check the address of the UART4 or UART node.

Definition at line 366 of file stm8s_uart4.h.

STM8 Standard Peripherals Library: Footer

 

 

 

      For complete documentation on STM8 8-bit Microcontrollers platform visit www.st.com