STM8S/A Standard Peripherals Firmware Library: CAN_Private_Macros

STM8S/A

STM8S/A Standard Peripherals Firmware Library
CAN_Private_Macros

Defines

#define CAN_IT_CONFIG_MASK   ~(uint16_t)(CAN_IT_TME|CAN_IT_FMP|CAN_IT_FF|CAN_IT_FOV|CAN_IT_WKU|CAN_IT_EWG|CAN_IT_EPV|CAN_IT_BOF|CAN_IT_LEC|CAN_IT_ERR)
 Macro used by the assert function in order to check the CAN Configuration interrupts.
#define IS_CAN_BITSEG1_OK(BS1)   ((BS1) <= CAN_BitSeg1_16TimeQuantum)
 Macro used by the assert function in order to check time quantum in bit segment 1 .
#define IS_CAN_BITSEG2_OK(BS2)   ((((BS2) >= CAN_BitSeg2_2TimeQuantum) && ((BS2) <= CAN_BitSeg2_8TimeQuantum))|| ((BS2) == CAN_BitSeg2_1TimeQuantum))
 Macro used by the assert function in order to check time quantum in bit segment 2.
#define IS_CAN_DLC_OK(DLC)   ((DLC) <= CAN_DLC_MAX)
 Macro used by the assert function in order to check the DLC to be sent.
#define IS_CAN_EXTID_OK(EXTID)   ((EXTID) <= ((uint32_t)CAN_EXTID_SIZE))
 Macro used by the assert function in order to check the Extended ID to be sent.
#define IS_CAN_FILTER_MODE_OK(MODE)
 Macro used by the assert function in order to check CAN filter mode.
#define IS_CAN_FILTER_NUMBER_OK(NUMBER)
 Macro used by the assert function in order to check CAN filter number.
#define IS_CAN_FILTER_SCALE_OK(SCALE)
 Macro used by the assert function in order to check CAN filter scale.
#define IS_CAN_FLAG_CLEAR_OK(FLAG)
 Macro used by the assert function in order to check CAN flags which can be cleared by CAN_ClearFlag.
#define IS_CAN_FLAG_STATUS_OK(FLAG)
 Macro used by the assert function in order to check CAN flags which can be got by CAN_GetFlagStatus.
#define IS_CAN_IDTYPE_OK(IDTYPE)   (((IDTYPE) == CAN_Id_Standard) || ((IDTYPE) == CAN_Id_Extended))
 Macro used by the assert function in order to check the type of the ID to be sent.
#define IS_CAN_IT_CONFIG_OK(IT)   (((IT) != 0x0000) && ((uint16_t)((uint16_t)(IT) & (uint16_t)CAN_IT_CONFIG_MASK) == 0x0000))
#define IS_CAN_IT_PENDING_BIT_OK(IT)
 Macro used by the assert function in order to check the CAN Pending bit interrupts.
#define IS_CAN_IT_STATUS_OK(IT)
 Macro used by the assert function in order to check the CAN status interrupts.
#define IS_CAN_LAST_ERROR_CODE_OK(CODE)   (((CODE) & 0x8F) == 0x00)
 Macro used by the assert function in order to check the Last Error Code.
#define IS_CAN_MASTERCTRL_OK(MODE)
 Macro used by the assert function in order to check CAN Time Triggered Communication mode.
#define IS_CAN_MODE_OK(MODE)
 Macro used by the assert function in order to check CAN mode options .
#define IS_CAN_OPERATINGMODE_OK(MODE)
 Macro used by the assert function in order to check CAN operating mode.
#define IS_CAN_PRESCALER_OK(PRESCALER)   (((PRESCALER) >= 1) && ((PRESCALER) <= 64))
 Macro used by the assert function in order to check CAN clock prescaler.
#define IS_CAN_RTR_OK(RTR)   (((RTR) == CAN_RTR_Data) || ((RTR) == CAN_RTR_Remote))
 Macro used by the assert function in order to check CAN transmission Frame Type.
#define IS_CAN_ST7_COMPATIBILITY_OK(STATE)   (((STATE) == CAN_ST7Compatibility_Enable) || ((STATE) == CAN_ST7Compatibility_Disable))
 Macro used by the assert function in order to check the CAN ST7 Compatibility parameters.
#define IS_CAN_STDID_OK(STDID)   ((STDID) <= ((uint16_t)CAN_STDID_SIZE))
 Macro used by the assert function in order to check the Standard ID to be sent.
#define IS_CAN_SYNJUMPWIDTH_OK(SJW)
 Macro used by the assert function in order to check the CAN synchronisation jump width (SJW).
#define IS_CAN_TRANSMITMAILBOX_OK(TRANSMITMAILBOX)
 Macro used by the assert function in order to check CAN Tx mailboxes.

Define Documentation

#define CAN_IT_CONFIG_MASK   ~(uint16_t)(CAN_IT_TME|CAN_IT_FMP|CAN_IT_FF|CAN_IT_FOV|CAN_IT_WKU|CAN_IT_EWG|CAN_IT_EPV|CAN_IT_BOF|CAN_IT_LEC|CAN_IT_ERR)

Macro used by the assert function in order to check the CAN Configuration interrupts.

Definition at line 435 of file stm8s_can.h.

#define IS_CAN_BITSEG1_OK (   BS1)    ((BS1) <= CAN_BitSeg1_16TimeQuantum)

Macro used by the assert function in order to check time quantum in bit segment 1 .

Definition at line 357 of file stm8s_can.h.

Referenced by CAN_Init().

#define IS_CAN_BITSEG2_OK (   BS2)    ((((BS2) >= CAN_BitSeg2_2TimeQuantum) && ((BS2) <= CAN_BitSeg2_8TimeQuantum))|| ((BS2) == CAN_BitSeg2_1TimeQuantum))

Macro used by the assert function in order to check time quantum in bit segment 2.

Definition at line 361 of file stm8s_can.h.

Referenced by CAN_Init().

#define IS_CAN_DLC_OK (   DLC)    ((DLC) <= CAN_DLC_MAX)

Macro used by the assert function in order to check the DLC to be sent.

Definition at line 406 of file stm8s_can.h.

Referenced by CAN_GetReceivedData(), and CAN_Transmit().

#define IS_CAN_EXTID_OK (   EXTID)    ((EXTID) <= ((uint32_t)CAN_EXTID_SIZE))

Macro used by the assert function in order to check the Extended ID to be sent.

Definition at line 402 of file stm8s_can.h.

Referenced by CAN_Transmit().

#define IS_CAN_FILTER_MODE_OK (   MODE)
Value:
(((MODE) == CAN_FilterMode_IdMask) || \
                                     ((MODE) == CAN_FilterMode_IdMask_IdList) || \
                                     ((MODE) == CAN_FilterMode_IdList_IdMask) || \
                                  ((MODE) == CAN_FilterMode_IdList))

Macro used by the assert function in order to check CAN filter mode.

Definition at line 378 of file stm8s_can.h.

Referenced by CAN_FilterInit().

#define IS_CAN_FILTER_NUMBER_OK (   NUMBER)
Value:
(((NUMBER) == CAN_FilterNumber_0) || \
                                       ((NUMBER) == CAN_FilterNumber_1) || \
                                       ((NUMBER) == CAN_FilterNumber_2) || \
                                       ((NUMBER) == CAN_FilterNumber_3) || \
                                       ((NUMBER) == CAN_FilterNumber_4) || \
                                       ((NUMBER) == CAN_FilterNumber_5))

Macro used by the assert function in order to check CAN filter number.

Definition at line 369 of file stm8s_can.h.

Referenced by CAN_FilterInit().

#define IS_CAN_FILTER_SCALE_OK (   SCALE)
Value:
(((SCALE) == CAN_FilterScale_8Bit)|| \
                                    ((SCALE) == CAN_FilterScale_16_8Bit) ||\
                                    ((SCALE) == CAN_FilterScale_16Bit  )||\
                                    ((SCALE) == CAN_FilterScale_32Bit))

Macro used by the assert function in order to check CAN filter scale.

Definition at line 385 of file stm8s_can.h.

Referenced by CAN_FilterInit().

#define IS_CAN_FLAG_CLEAR_OK (   FLAG)
Value:
(((FLAG) == CAN_FLAG_RQCP0) || ((FLAG) == CAN_FLAG_RQCP1) ||\
                                    ((FLAG) == CAN_FLAG_RQCP2) ||  ((FLAG) == CAN_FLAG_FF)   ||\
                                    ((FLAG) == CAN_FLAG_FOV)  ||  ((FLAG) == CAN_FLAG_WKU) ||\
                                    ((FLAG) == CAN_FLAG_LEC))

Macro used by the assert function in order to check CAN flags which can be cleared by CAN_ClearFlag.

Definition at line 428 of file stm8s_can.h.

Referenced by CAN_ClearFlag().

#define IS_CAN_FLAG_STATUS_OK (   FLAG)
Value:
(((FLAG) == CAN_FLAG_RQCP0) || ((FLAG) == CAN_FLAG_RQCP1) ||\
                                  ((FLAG) == CAN_FLAG_RQCP2) || ((FLAG) == CAN_FLAG_FMP) ||\
                                  ((FLAG) == CAN_FLAG_FF) || ((FLAG) == CAN_FLAG_FOV) ||\
                                  ((FLAG) == CAN_FLAG_WKU) || ((FLAG) == CAN_FLAG_EWG) ||\
                                  ((FLAG) == CAN_FLAG_EPV) || ((FLAG) == CAN_FLAG_BOF) ||\
                                  ((FLAG) == CAN_FLAG_LEC))

Macro used by the assert function in order to check CAN flags which can be got by CAN_GetFlagStatus.

Definition at line 419 of file stm8s_can.h.

Referenced by CAN_GetFlagStatus().

#define IS_CAN_IDTYPE_OK (   IDTYPE)    (((IDTYPE) == CAN_Id_Standard) || ((IDTYPE) == CAN_Id_Extended))

Macro used by the assert function in order to check the type of the ID to be sent.

Definition at line 410 of file stm8s_can.h.

Referenced by CAN_Transmit().

#define IS_CAN_IT_CONFIG_OK (   IT)    (((IT) != 0x0000) && ((uint16_t)((uint16_t)(IT) & (uint16_t)CAN_IT_CONFIG_MASK) == 0x0000))

Definition at line 436 of file stm8s_can.h.

Referenced by CAN_ITConfig().

#define IS_CAN_IT_PENDING_BIT_OK (   IT)
Value:
(((IT) == CAN_IT_TME) || ((IT) == CAN_IT_FF)  ||\
                                      ((IT) == CAN_IT_FOV)  || ((IT) == CAN_IT_WKU) ||\
                                      ((IT) == CAN_IT_ERR)  || ((IT) == CAN_IT_EWG) ||\
                                      ((IT) == CAN_IT_EPV) || ((IT) == CAN_IT_BOF)||\
                                      ((IT) == CAN_IT_LEC))

Macro used by the assert function in order to check the CAN Pending bit interrupts.

Definition at line 448 of file stm8s_can.h.

Referenced by CAN_ClearITPendingBit().

#define IS_CAN_IT_STATUS_OK (   IT)
Value:
(((IT) == CAN_IT_TME)   || ((IT) == CAN_IT_FMP) ||\
                             ((IT) == CAN_IT_FF)    || ((IT) == CAN_IT_FOV) || \
                             ((IT) == CAN_IT_WKU)   || ((IT) == CAN_IT_ERR)  || \
                             ((IT) == CAN_IT_EWG)   || ((IT) == CAN_IT_EPV)  || \
                             ((IT) == CAN_IT_BOF)   || ((IT) == CAN_IT_LEC)  )

Macro used by the assert function in order to check the CAN status interrupts.

Definition at line 440 of file stm8s_can.h.

Referenced by CAN_GetITStatus().

#define IS_CAN_LAST_ERROR_CODE_OK (   CODE)    (((CODE) & 0x8F) == 0x00)

Macro used by the assert function in order to check the Last Error Code.

Definition at line 456 of file stm8s_can.h.

#define IS_CAN_MASTERCTRL_OK (   MODE)
Value:

Macro used by the assert function in order to check CAN Time Triggered Communication mode.

Definition at line 342 of file stm8s_can.h.

Referenced by CAN_Init().

#define IS_CAN_MODE_OK (   MODE)
Value:
(((MODE) == CAN_Mode_Normal) || ((MODE) == CAN_Mode_LoopBack)|| \
                           ((MODE) == CAN_Mode_Silent) || ((MODE) == CAN_Mode_Silent_LoopBack))

Macro used by the assert function in order to check CAN mode options .

Definition at line 347 of file stm8s_can.h.

Referenced by CAN_Init().

#define IS_CAN_OPERATINGMODE_OK (   MODE)
Value:

Macro used by the assert function in order to check CAN operating mode.

Definition at line 336 of file stm8s_can.h.

Referenced by CAN_OperatingModeRequest().

#define IS_CAN_PRESCALER_OK (   PRESCALER)    (((PRESCALER) >= 1) && ((PRESCALER) <= 64))

Macro used by the assert function in order to check CAN clock prescaler.

Definition at line 365 of file stm8s_can.h.

Referenced by CAN_Init().

#define IS_CAN_RTR_OK (   RTR)    (((RTR) == CAN_RTR_Data) || ((RTR) == CAN_RTR_Remote))

Macro used by the assert function in order to check CAN transmission Frame Type.

Definition at line 414 of file stm8s_can.h.

Referenced by CAN_Transmit().

#define IS_CAN_ST7_COMPATIBILITY_OK (   STATE)    (((STATE) == CAN_ST7Compatibility_Enable) || ((STATE) == CAN_ST7Compatibility_Disable))

Macro used by the assert function in order to check the CAN ST7 Compatibility parameters.

Definition at line 332 of file stm8s_can.h.

Referenced by CAN_ST7CompatibilityCmd().

#define IS_CAN_STDID_OK (   STDID)    ((STDID) <= ((uint16_t)CAN_STDID_SIZE))

Macro used by the assert function in order to check the Standard ID to be sent.

Definition at line 398 of file stm8s_can.h.

Referenced by CAN_Transmit().

#define IS_CAN_SYNJUMPWIDTH_OK (   SJW)
Value:

Macro used by the assert function in order to check the CAN synchronisation jump width (SJW).

Definition at line 352 of file stm8s_can.h.

Referenced by CAN_Init().

#define IS_CAN_TRANSMITMAILBOX_OK (   TRANSMITMAILBOX)
Value:
(((TRANSMITMAILBOX) == CAN_TransmitMailBox_0) || \
                                                 ((TRANSMITMAILBOX) == CAN_TransmitMailBox_1) || \
                                                 ((TRANSMITMAILBOX) == CAN_TransmitMailBox_2))

Macro used by the assert function in order to check CAN Tx mailboxes.

Definition at line 392 of file stm8s_can.h.

Referenced by CAN_CancelTransmit(), and CAN_TransmitStatus().

STM8 Standard Peripherals Library: Footer

 

 

 

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