STM8S/A Standard Peripherals Drivers: UART3_Private_Macros

STM8S/A

STM8S/A Standard Peripherals Drivers
UART3_Private_Macros

Defines

#define IS_UART3_ADDRESS_OK(Node)   ((Node) < UART3_ADDRESS_MAX)
#define IS_UART3_AUTOSYNC_OK(AutosyncMode)
 Macro used by the assert_param function in order to check the LIN automatic resynchronization mode.
#define IS_UART3_BAUDRATE_OK(NUM)   ((NUM) <= (uint32_t)625000)
 Macro used by the assert_param function in order to check the maximum baudrate value.
#define IS_UART3_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_UART3_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_UART3_CONFIG_IT_OK(Interrupt)
 Macro used by the assert_param function in order to check the different sensitivity values for the Interrupts.
#define IS_UART3_DIVUP_OK(DivupMethod)
 Macro used by the assert_param function in order to check the LIN divider update method.
#define IS_UART3_FLAG_OK(Flag)
 Macro used by the assert_param function in order to check the different sensitivity values for the FLAGs.
#define IS_UART3_GET_IT_OK(ITPendingBit)
 Macro used by the assert function in order to check the different sensitivity values for the pending bit.
#define IS_UART3_LINBREAKDETECTIONLENGTH_OK(LINBreakDetectionLengths)
 Macro used by the assert_param function in order to check the different sensitivity values for the LINBreakDetectionLengths.
#define IS_UART3_MODE_OK(Mode)
 Macro used by the assert_param function in order to check the different sensitivity values for the MODEs.
#define IS_UART3_PARITY_OK(Parity)
 Macro used by the assert_param function in order to check the different sensitivity values for the Parity.
#define IS_UART3_SLAVE_OK(Mode)
 Macro used by the assert_param function in order to check the LIN mode.
#define IS_UART3_STOPBITS_OK(StopBit)
 Macro used by the assert_param function in order to check the different sensitivity values for the UART3_StopBits.
#define IS_UART3_WAKEUP_OK(WakeUpMode)
 Macro used by the assert_param function in order to check the different sensitivity values for the WakeUps.
#define IS_UART3_WORDLENGTH_OK(WordLength)
 Macro used by the assert_param function in order to check the different sensitivity values for the WordLengths.
#define UART3_ADDRESS_MAX   ((uint8_t)16)
 Macro used by the assert_param function in order to check the address of the UART3 or UART node.

Define Documentation

#define IS_UART3_ADDRESS_OK (   Node)    ((Node) < UART3_ADDRESS_MAX)

Definition at line 320 of file stm8s_uart3.h.

Referenced by UART3_SetAddress().

#define IS_UART3_AUTOSYNC_OK (   AutosyncMode)
Value:
(((AutosyncMode) ==  UART3_LIN_AUTOSYNC_ENABLE) || \
   ((AutosyncMode) == UART3_LIN_AUTOSYNC_DISABLE))

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

Definition at line 333 of file stm8s_uart3.h.

Referenced by UART3_LINConfig().

#define IS_UART3_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 313 of file stm8s_uart3.h.

Referenced by UART3_Init().

#define IS_UART3_CLEAR_FLAG_OK (   Flag)
Value:
(((Flag) == UART3_FLAG_RXNE) || \
   ((Flag) == UART3_FLAG_LHDF) || \
   ((Flag) == UART3_FLAG_LSF) || \
   ((Flag) == UART3_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 209 of file stm8s_uart3.h.

Referenced by UART3_ClearFlag().

#define IS_UART3_CLEAR_IT_OK (   ITPendingBit)
Value:
(((ITPendingBit) == UART3_IT_RXNE) || \
   ((ITPendingBit) == UART3_IT_LHDF) || \
   ((ITPendingBit) == UART3_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 247 of file stm8s_uart3.h.

Referenced by UART3_ClearITPendingBit().

#define IS_UART3_CONFIG_IT_OK (   Interrupt)
Value:
(((Interrupt) == UART3_IT_PE) || \
   ((Interrupt) == UART3_IT_TXE) || \
   ((Interrupt) == UART3_IT_TC) || \
   ((Interrupt) == UART3_IT_RXNE_OR ) || \
   ((Interrupt) == UART3_IT_IDLE) || \
   ((Interrupt) == UART3_IT_LHDF) || \
   ((Interrupt) == UART3_IT_LBDF))

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

Definition at line 220 of file stm8s_uart3.h.

Referenced by UART3_ITConfig().

#define IS_UART3_DIVUP_OK (   DivupMethod)
Value:
(((DivupMethod) == UART3_LIN_DIVUP_LBRR1) || \
   ((DivupMethod) == UART3_LIN_DIVUP_NEXTRXNE))

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

Definition at line 341 of file stm8s_uart3.h.

Referenced by UART3_LINConfig().

#define IS_UART3_FLAG_OK (   Flag)
Value:
(((Flag) == UART3_FLAG_TXE) || \
   ((Flag) == UART3_FLAG_TC)  || \
   ((Flag) == UART3_FLAG_RXNE) || \
   ((Flag) == UART3_FLAG_IDLE) || \
   ((Flag) == UART3_FLAG_OR_LHE) || \
   ((Flag) == UART3_FLAG_NF) || \
   ((Flag) == UART3_FLAG_FE) || \
   ((Flag) == UART3_FLAG_PE) || \
   ((Flag) == UART3_FLAG_SBK) || \
   ((Flag) == UART3_FLAG_LSF) || \
   ((Flag) == UART3_FLAG_LHDF) || \
   ((Flag) == UART3_FLAG_LBDF))

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

Definition at line 190 of file stm8s_uart3.h.

Referenced by UART3_GetFlagStatus().

#define IS_UART3_GET_IT_OK (   ITPendingBit)
Value:
(((ITPendingBit) == UART3_IT_TXE)  || \
   ((ITPendingBit) == UART3_IT_TC)   || \
   ((ITPendingBit) == UART3_IT_RXNE) || \
   ((ITPendingBit) == UART3_IT_IDLE) || \
   ((ITPendingBit) == UART3_IT_OR)  || \
   ((ITPendingBit) == UART3_IT_LBDF)  || \
   ((ITPendingBit) == UART3_IT_LHDF)  || \
   ((ITPendingBit) == UART3_IT_PE))

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

Definition at line 233 of file stm8s_uart3.h.

Referenced by UART3_GetITStatus().

#define IS_UART3_LINBREAKDETECTIONLENGTH_OK (   LINBreakDetectionLengths)
Value:
(((LINBreakDetectionLengths) == UART3_LINBREAKDETECTIONLENGTH_10BITS) || \
   ((LINBreakDetectionLengths) == UART3_LINBREAKDETECTIONLENGTH_11BITS))

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

Definition at line 288 of file stm8s_uart3.h.

Referenced by UART3_LINBreakDetectionConfig().

#define IS_UART3_MODE_OK (   Mode)
Value:
(((Mode) == (uint8_t)UART3_MODE_RX_ENABLE) || \
   ((Mode) == (uint8_t)UART3_MODE_RX_DISABLE) || \
   ((Mode) == (uint8_t)UART3_MODE_TX_ENABLE) || \
   ((Mode) == (uint8_t)UART3_MODE_TX_DISABLE) || \
   ((Mode) == (uint8_t)UART3_MODE_TXRX_ENABLE) || \
   ((Mode) == (uint8_t)((uint8_t)UART3_MODE_TX_ENABLE|(uint8_t)UART3_MODE_RX_ENABLE)) || \
   ((Mode) == (uint8_t)((uint8_t)UART3_MODE_TX_ENABLE|(uint8_t)UART3_MODE_RX_DISABLE)) || \
   ((Mode) == (uint8_t)((uint8_t)UART3_MODE_TX_DISABLE|(uint8_t)UART3_MODE_RX_DISABLE)) || \
   ((Mode) == (uint8_t)((uint8_t)UART3_MODE_TX_DISABLE|(uint8_t)UART3_MODE_RX_ENABLE)))

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

Definition at line 256 of file stm8s_uart3.h.

Referenced by UART3_Init().

#define IS_UART3_PARITY_OK (   Parity)
Value:
(((Parity) == UART3_PARITY_NO) || \
   ((Parity) == UART3_PARITY_EVEN) || \
   ((Parity) == UART3_PARITY_ODD ))

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

Definition at line 304 of file stm8s_uart3.h.

Referenced by UART3_Init().

#define IS_UART3_SLAVE_OK (   Mode)
Value:
(((Mode) == UART3_LIN_MODE_MASTER) || \
   ((Mode) == UART3_LIN_MODE_SLAVE))

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

Definition at line 325 of file stm8s_uart3.h.

Referenced by UART3_LINConfig().

#define IS_UART3_STOPBITS_OK (   StopBit)
Value:
(((StopBit) == UART3_STOPBITS_1) || \
   ((StopBit) == UART3_STOPBITS_2))

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

Definition at line 296 of file stm8s_uart3.h.

Referenced by UART3_Init().

#define IS_UART3_WAKEUP_OK (   WakeUpMode)
Value:
(((WakeUpMode) == UART3_WAKEUP_IDLELINE) || \
   ((WakeUpMode) == UART3_WAKEUP_ADDRESSMARK))

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

Definition at line 280 of file stm8s_uart3.h.

Referenced by UART3_WakeUpConfig().

#define IS_UART3_WORDLENGTH_OK (   WordLength)
Value:
(((WordLength) == UART3_WORDLENGTH_8D) || \
   ((WordLength) == UART3_WORDLENGTH_9D))

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

Definition at line 271 of file stm8s_uart3.h.

Referenced by UART3_Init().

#define UART3_ADDRESS_MAX   ((uint8_t)16)

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

Definition at line 319 of file stm8s_uart3.h.

STM8 Standard Peripherals Library: Footer

 

 

 

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