STM32F103xB HAL User Manual
stm32f1xx_hal_can.h
Go to the documentation of this file.
00001 /**
00002   ******************************************************************************
00003   * @file    stm32f1xx_hal_can.h
00004   * @author  MCD Application Team
00005   * @brief   Header file of CAN HAL module.
00006   ******************************************************************************
00007   * @attention
00008   *
00009   * <h2><center>&copy; Copyright (c) 2016 STMicroelectronics.
00010   * All rights reserved.</center></h2>
00011   *
00012   * This software component is licensed by ST under BSD 3-Clause license,
00013   * the "License"; You may not use this file except in compliance with the
00014   * License. You may obtain a copy of the License at:
00015   *                        opensource.org/licenses/BSD-3-Clause
00016   *
00017   ******************************************************************************
00018   */
00019 
00020 /* Define to prevent recursive inclusion -------------------------------------*/
00021 #ifndef STM32F1xx_HAL_CAN_H
00022 #define STM32F1xx_HAL_CAN_H
00023 
00024 #ifdef __cplusplus
00025 extern "C" {
00026 #endif
00027 
00028 /* Includes ------------------------------------------------------------------*/
00029 #include "stm32f1xx_hal_def.h"
00030 
00031 /** @addtogroup STM32F1xx_HAL_Driver
00032   * @{
00033   */
00034 
00035 #if defined (CAN1)
00036 /** @addtogroup CAN
00037   * @{
00038   */
00039 
00040 /* Exported types ------------------------------------------------------------*/
00041 /** @defgroup CAN_Exported_Types CAN Exported Types
00042   * @{
00043   */
00044 /**
00045   * @brief  HAL State structures definition
00046   */
00047 typedef enum
00048 {
00049   HAL_CAN_STATE_RESET             = 0x00U,  /*!< CAN not yet initialized or disabled */
00050   HAL_CAN_STATE_READY             = 0x01U,  /*!< CAN initialized and ready for use   */
00051   HAL_CAN_STATE_LISTENING         = 0x02U,  /*!< CAN receive process is ongoing      */
00052   HAL_CAN_STATE_SLEEP_PENDING     = 0x03U,  /*!< CAN sleep request is pending        */
00053   HAL_CAN_STATE_SLEEP_ACTIVE      = 0x04U,  /*!< CAN sleep mode is active            */
00054   HAL_CAN_STATE_ERROR             = 0x05U   /*!< CAN error state                     */
00055 
00056 } HAL_CAN_StateTypeDef;
00057 
00058 /**
00059   * @brief  CAN init structure definition
00060   */
00061 typedef struct
00062 {
00063   uint32_t Prescaler;                  /*!< Specifies the length of a time quantum.
00064                                             This parameter must be a number between Min_Data = 1 and Max_Data = 1024. */
00065 
00066   uint32_t Mode;                       /*!< Specifies the CAN operating mode.
00067                                             This parameter can be a value of @ref CAN_operating_mode */
00068 
00069   uint32_t SyncJumpWidth;              /*!< Specifies the maximum number of time quanta the CAN hardware
00070                                             is allowed to lengthen or shorten a bit to perform resynchronization.
00071                                             This parameter can be a value of @ref CAN_synchronisation_jump_width */
00072 
00073   uint32_t TimeSeg1;                   /*!< Specifies the number of time quanta in Bit Segment 1.
00074                                             This parameter can be a value of @ref CAN_time_quantum_in_bit_segment_1 */
00075 
00076   uint32_t TimeSeg2;                   /*!< Specifies the number of time quanta in Bit Segment 2.
00077                                             This parameter can be a value of @ref CAN_time_quantum_in_bit_segment_2 */
00078 
00079   FunctionalState TimeTriggeredMode;   /*!< Enable or disable the time triggered communication mode.
00080                                             This parameter can be set to ENABLE or DISABLE. */
00081 
00082   FunctionalState AutoBusOff;          /*!< Enable or disable the automatic bus-off management.
00083                                             This parameter can be set to ENABLE or DISABLE. */
00084 
00085   FunctionalState AutoWakeUp;          /*!< Enable or disable the automatic wake-up mode.
00086                                             This parameter can be set to ENABLE or DISABLE. */
00087 
00088   FunctionalState AutoRetransmission;  /*!< Enable or disable the non-automatic retransmission mode.
00089                                             This parameter can be set to ENABLE or DISABLE. */
00090 
00091   FunctionalState ReceiveFifoLocked;   /*!< Enable or disable the Receive FIFO Locked mode.
00092                                             This parameter can be set to ENABLE or DISABLE. */
00093 
00094   FunctionalState TransmitFifoPriority;/*!< Enable or disable the transmit FIFO priority.
00095                                             This parameter can be set to ENABLE or DISABLE. */
00096 
00097 } CAN_InitTypeDef;
00098 
00099 /**
00100   * @brief  CAN filter configuration structure definition
00101   */
00102 typedef struct
00103 {
00104   uint32_t FilterIdHigh;          /*!< Specifies the filter identification number (MSBs for a 32-bit
00105                                        configuration, first one for a 16-bit configuration).
00106                                        This parameter must be a number between Min_Data = 0x0000 and Max_Data = 0xFFFF. */
00107 
00108   uint32_t FilterIdLow;           /*!< Specifies the filter identification number (LSBs for a 32-bit
00109                                        configuration, second one for a 16-bit configuration).
00110                                        This parameter must be a number between Min_Data = 0x0000 and Max_Data = 0xFFFF. */
00111 
00112   uint32_t FilterMaskIdHigh;      /*!< Specifies the filter mask number or identification number,
00113                                        according to the mode (MSBs for a 32-bit configuration,
00114                                        first one for a 16-bit configuration).
00115                                        This parameter must be a number between Min_Data = 0x0000 and Max_Data = 0xFFFF. */
00116 
00117   uint32_t FilterMaskIdLow;       /*!< Specifies the filter mask number or identification number,
00118                                        according to the mode (LSBs for a 32-bit configuration,
00119                                        second one for a 16-bit configuration).
00120                                        This parameter must be a number between Min_Data = 0x0000 and Max_Data = 0xFFFF. */
00121 
00122   uint32_t FilterFIFOAssignment;  /*!< Specifies the FIFO (0 or 1U) which will be assigned to the filter.
00123                                        This parameter can be a value of @ref CAN_filter_FIFO */
00124 
00125   uint32_t FilterBank;            /*!< Specifies the filter bank which will be initialized.
00126                                        For single CAN instance(14 dedicated filter banks),
00127                                        this parameter must be a number between Min_Data = 0 and Max_Data = 13.
00128                                        For dual CAN instances(28 filter banks shared),
00129                                        this parameter must be a number between Min_Data = 0 and Max_Data = 27. */
00130 
00131   uint32_t FilterMode;            /*!< Specifies the filter mode to be initialized.
00132                                        This parameter can be a value of @ref CAN_filter_mode */
00133 
00134   uint32_t FilterScale;           /*!< Specifies the filter scale.
00135                                        This parameter can be a value of @ref CAN_filter_scale */
00136 
00137   uint32_t FilterActivation;      /*!< Enable or disable the filter.
00138                                        This parameter can be a value of @ref CAN_filter_activation */
00139 
00140   uint32_t SlaveStartFilterBank;  /*!< Select the start filter bank for the slave CAN instance.
00141                                        For single CAN instances, this parameter is meaningless.
00142                                        For dual CAN instances, all filter banks with lower index are assigned to master
00143                                        CAN instance, whereas all filter banks with greater index are assigned to slave
00144                                        CAN instance.
00145                                        This parameter must be a number between Min_Data = 0 and Max_Data = 27. */
00146 
00147 } CAN_FilterTypeDef;
00148 
00149 /**
00150   * @brief  CAN Tx message header structure definition
00151   */
00152 typedef struct
00153 {
00154   uint32_t StdId;    /*!< Specifies the standard identifier.
00155                           This parameter must be a number between Min_Data = 0 and Max_Data = 0x7FF. */
00156 
00157   uint32_t ExtId;    /*!< Specifies the extended identifier.
00158                           This parameter must be a number between Min_Data = 0 and Max_Data = 0x1FFFFFFF. */
00159 
00160   uint32_t IDE;      /*!< Specifies the type of identifier for the message that will be transmitted.
00161                           This parameter can be a value of @ref CAN_identifier_type */
00162 
00163   uint32_t RTR;      /*!< Specifies the type of frame for the message that will be transmitted.
00164                           This parameter can be a value of @ref CAN_remote_transmission_request */
00165 
00166   uint32_t DLC;      /*!< Specifies the length of the frame that will be transmitted.
00167                           This parameter must be a number between Min_Data = 0 and Max_Data = 8. */
00168 
00169   FunctionalState TransmitGlobalTime; /*!< Specifies whether the timestamp counter value captured on start
00170                           of frame transmission, is sent in DATA6 and DATA7 replacing pData[6] and pData[7].
00171                           @note: Time Triggered Communication Mode must be enabled.
00172                           @note: DLC must be programmed as 8 bytes, in order these 2 bytes are sent.
00173                           This parameter can be set to ENABLE or DISABLE. */
00174 
00175 } CAN_TxHeaderTypeDef;
00176 
00177 /**
00178   * @brief  CAN Rx message header structure definition
00179   */
00180 typedef struct
00181 {
00182   uint32_t StdId;    /*!< Specifies the standard identifier.
00183                           This parameter must be a number between Min_Data = 0 and Max_Data = 0x7FF. */
00184 
00185   uint32_t ExtId;    /*!< Specifies the extended identifier.
00186                           This parameter must be a number between Min_Data = 0 and Max_Data = 0x1FFFFFFF. */
00187 
00188   uint32_t IDE;      /*!< Specifies the type of identifier for the message that will be transmitted.
00189                           This parameter can be a value of @ref CAN_identifier_type */
00190 
00191   uint32_t RTR;      /*!< Specifies the type of frame for the message that will be transmitted.
00192                           This parameter can be a value of @ref CAN_remote_transmission_request */
00193 
00194   uint32_t DLC;      /*!< Specifies the length of the frame that will be transmitted.
00195                           This parameter must be a number between Min_Data = 0 and Max_Data = 8. */
00196 
00197   uint32_t Timestamp; /*!< Specifies the timestamp counter value captured on start of frame reception.
00198                           @note: Time Triggered Communication Mode must be enabled.
00199                           This parameter must be a number between Min_Data = 0 and Max_Data = 0xFFFF. */
00200 
00201   uint32_t FilterMatchIndex; /*!< Specifies the index of matching acceptance filter element.
00202                           This parameter must be a number between Min_Data = 0 and Max_Data = 0xFF. */
00203 
00204 } CAN_RxHeaderTypeDef;
00205 
00206 /**
00207   * @brief  CAN handle Structure definition
00208   */
00209 typedef struct __CAN_HandleTypeDef
00210 {
00211   CAN_TypeDef                 *Instance;                 /*!< Register base address */
00212 
00213   CAN_InitTypeDef             Init;                      /*!< CAN required parameters */
00214 
00215   __IO HAL_CAN_StateTypeDef   State;                     /*!< CAN communication state */
00216 
00217   __IO uint32_t               ErrorCode;                 /*!< CAN Error code.
00218                                                               This parameter can be a value of @ref CAN_Error_Code */
00219 
00220 #if USE_HAL_CAN_REGISTER_CALLBACKS == 1
00221   void (* TxMailbox0CompleteCallback)(struct __CAN_HandleTypeDef *hcan);/*!< CAN Tx Mailbox 0 complete callback    */
00222   void (* TxMailbox1CompleteCallback)(struct __CAN_HandleTypeDef *hcan);/*!< CAN Tx Mailbox 1 complete callback    */
00223   void (* TxMailbox2CompleteCallback)(struct __CAN_HandleTypeDef *hcan);/*!< CAN Tx Mailbox 2 complete callback    */
00224   void (* TxMailbox0AbortCallback)(struct __CAN_HandleTypeDef *hcan);   /*!< CAN Tx Mailbox 0 abort callback       */
00225   void (* TxMailbox1AbortCallback)(struct __CAN_HandleTypeDef *hcan);   /*!< CAN Tx Mailbox 1 abort callback       */
00226   void (* TxMailbox2AbortCallback)(struct __CAN_HandleTypeDef *hcan);   /*!< CAN Tx Mailbox 2 abort callback       */
00227   void (* RxFifo0MsgPendingCallback)(struct __CAN_HandleTypeDef *hcan); /*!< CAN Rx FIFO 0 msg pending callback    */
00228   void (* RxFifo0FullCallback)(struct __CAN_HandleTypeDef *hcan);       /*!< CAN Rx FIFO 0 full callback           */
00229   void (* RxFifo1MsgPendingCallback)(struct __CAN_HandleTypeDef *hcan); /*!< CAN Rx FIFO 1 msg pending callback    */
00230   void (* RxFifo1FullCallback)(struct __CAN_HandleTypeDef *hcan);       /*!< CAN Rx FIFO 1 full callback           */
00231   void (* SleepCallback)(struct __CAN_HandleTypeDef *hcan);             /*!< CAN Sleep callback                    */
00232   void (* WakeUpFromRxMsgCallback)(struct __CAN_HandleTypeDef *hcan);   /*!< CAN Wake Up from Rx msg callback      */
00233   void (* ErrorCallback)(struct __CAN_HandleTypeDef *hcan);             /*!< CAN Error callback                    */
00234 
00235   void (* MspInitCallback)(struct __CAN_HandleTypeDef *hcan);           /*!< CAN Msp Init callback                 */
00236   void (* MspDeInitCallback)(struct __CAN_HandleTypeDef *hcan);         /*!< CAN Msp DeInit callback               */
00237 
00238 #endif /* (USE_HAL_CAN_REGISTER_CALLBACKS) */
00239 } CAN_HandleTypeDef;
00240 
00241 #if USE_HAL_CAN_REGISTER_CALLBACKS == 1
00242 /**
00243   * @brief  HAL CAN common Callback ID enumeration definition
00244   */
00245 typedef enum
00246 {
00247   HAL_CAN_TX_MAILBOX0_COMPLETE_CB_ID       = 0x00U,    /*!< CAN Tx Mailbox 0 complete callback ID         */
00248   HAL_CAN_TX_MAILBOX1_COMPLETE_CB_ID       = 0x01U,    /*!< CAN Tx Mailbox 1 complete callback ID         */
00249   HAL_CAN_TX_MAILBOX2_COMPLETE_CB_ID       = 0x02U,    /*!< CAN Tx Mailbox 2 complete callback ID         */
00250   HAL_CAN_TX_MAILBOX0_ABORT_CB_ID          = 0x03U,    /*!< CAN Tx Mailbox 0 abort callback ID            */
00251   HAL_CAN_TX_MAILBOX1_ABORT_CB_ID          = 0x04U,    /*!< CAN Tx Mailbox 1 abort callback ID            */
00252   HAL_CAN_TX_MAILBOX2_ABORT_CB_ID          = 0x05U,    /*!< CAN Tx Mailbox 2 abort callback ID            */
00253   HAL_CAN_RX_FIFO0_MSG_PENDING_CB_ID       = 0x06U,    /*!< CAN Rx FIFO 0 message pending callback ID     */
00254   HAL_CAN_RX_FIFO0_FULL_CB_ID              = 0x07U,    /*!< CAN Rx FIFO 0 full callback ID                */
00255   HAL_CAN_RX_FIFO1_MSG_PENDING_CB_ID       = 0x08U,    /*!< CAN Rx FIFO 1 message pending callback ID     */
00256   HAL_CAN_RX_FIFO1_FULL_CB_ID              = 0x09U,    /*!< CAN Rx FIFO 1 full callback ID                */
00257   HAL_CAN_SLEEP_CB_ID                      = 0x0AU,    /*!< CAN Sleep callback ID                         */
00258   HAL_CAN_WAKEUP_FROM_RX_MSG_CB_ID         = 0x0BU,    /*!< CAN Wake Up from Rx msg callback ID          */
00259   HAL_CAN_ERROR_CB_ID                      = 0x0CU,    /*!< CAN Error callback ID                         */
00260 
00261   HAL_CAN_MSPINIT_CB_ID                    = 0x0DU,    /*!< CAN MspInit callback ID                       */
00262   HAL_CAN_MSPDEINIT_CB_ID                  = 0x0EU,    /*!< CAN MspDeInit callback ID                     */
00263 
00264 } HAL_CAN_CallbackIDTypeDef;
00265 
00266 /**
00267   * @brief  HAL CAN Callback pointer definition
00268   */
00269 typedef  void (*pCAN_CallbackTypeDef)(CAN_HandleTypeDef *hcan); /*!< pointer to a CAN callback function   */
00270 
00271 #endif /* USE_HAL_CAN_REGISTER_CALLBACKS */
00272 /**
00273   * @}
00274   */
00275 
00276 /* Exported constants --------------------------------------------------------*/
00277 
00278 /** @defgroup CAN_Exported_Constants CAN Exported Constants
00279   * @{
00280   */
00281 
00282 /** @defgroup CAN_Error_Code CAN Error Code
00283   * @{
00284   */
00285 #define HAL_CAN_ERROR_NONE            (0x00000000U)  /*!< No error                                             */
00286 #define HAL_CAN_ERROR_EWG             (0x00000001U)  /*!< Protocol Error Warning                               */
00287 #define HAL_CAN_ERROR_EPV             (0x00000002U)  /*!< Error Passive                                        */
00288 #define HAL_CAN_ERROR_BOF             (0x00000004U)  /*!< Bus-off error                                        */
00289 #define HAL_CAN_ERROR_STF             (0x00000008U)  /*!< Stuff error                                          */
00290 #define HAL_CAN_ERROR_FOR             (0x00000010U)  /*!< Form error                                           */
00291 #define HAL_CAN_ERROR_ACK             (0x00000020U)  /*!< Acknowledgment error                                 */
00292 #define HAL_CAN_ERROR_BR              (0x00000040U)  /*!< Bit recessive error                                  */
00293 #define HAL_CAN_ERROR_BD              (0x00000080U)  /*!< Bit dominant error                                   */
00294 #define HAL_CAN_ERROR_CRC             (0x00000100U)  /*!< CRC error                                            */
00295 #define HAL_CAN_ERROR_RX_FOV0         (0x00000200U)  /*!< Rx FIFO0 overrun error                               */
00296 #define HAL_CAN_ERROR_RX_FOV1         (0x00000400U)  /*!< Rx FIFO1 overrun error                               */
00297 #define HAL_CAN_ERROR_TX_ALST0        (0x00000800U)  /*!< TxMailbox 0 transmit failure due to arbitration lost */
00298 #define HAL_CAN_ERROR_TX_TERR0        (0x00001000U)  /*!< TxMailbox 0 transmit failure due to transmit error    */
00299 #define HAL_CAN_ERROR_TX_ALST1        (0x00002000U)  /*!< TxMailbox 1 transmit failure due to arbitration lost */
00300 #define HAL_CAN_ERROR_TX_TERR1        (0x00004000U)  /*!< TxMailbox 1 transmit failure due to transmit error    */
00301 #define HAL_CAN_ERROR_TX_ALST2        (0x00008000U)  /*!< TxMailbox 2 transmit failure due to arbitration lost */
00302 #define HAL_CAN_ERROR_TX_TERR2        (0x00010000U)  /*!< TxMailbox 2 transmit failure due to transmit error    */
00303 #define HAL_CAN_ERROR_TIMEOUT         (0x00020000U)  /*!< Timeout error                                        */
00304 #define HAL_CAN_ERROR_NOT_INITIALIZED (0x00040000U)  /*!< Peripheral not initialized                           */
00305 #define HAL_CAN_ERROR_NOT_READY       (0x00080000U)  /*!< Peripheral not ready                                 */
00306 #define HAL_CAN_ERROR_NOT_STARTED     (0x00100000U)  /*!< Peripheral not started                               */
00307 #define HAL_CAN_ERROR_PARAM           (0x00200000U)  /*!< Parameter error                                      */
00308 
00309 #if USE_HAL_CAN_REGISTER_CALLBACKS == 1
00310 #define HAL_CAN_ERROR_INVALID_CALLBACK (0x00400000U) /*!< Invalid Callback error                               */
00311 #endif /* USE_HAL_CAN_REGISTER_CALLBACKS */
00312 #define HAL_CAN_ERROR_INTERNAL        (0x00800000U)  /*!< Internal error                                       */
00313 
00314 /**
00315   * @}
00316   */
00317 
00318 /** @defgroup CAN_InitStatus CAN InitStatus
00319   * @{
00320   */
00321 #define CAN_INITSTATUS_FAILED       (0x00000000U)  /*!< CAN initialization failed */
00322 #define CAN_INITSTATUS_SUCCESS      (0x00000001U)  /*!< CAN initialization OK     */
00323 /**
00324   * @}
00325   */
00326 
00327 /** @defgroup CAN_operating_mode CAN Operating Mode
00328   * @{
00329   */
00330 #define CAN_MODE_NORMAL             (0x00000000U)                              /*!< Normal mode   */
00331 #define CAN_MODE_LOOPBACK           ((uint32_t)CAN_BTR_LBKM)                   /*!< Loopback mode */
00332 #define CAN_MODE_SILENT             ((uint32_t)CAN_BTR_SILM)                   /*!< Silent mode   */
00333 #define CAN_MODE_SILENT_LOOPBACK    ((uint32_t)(CAN_BTR_LBKM | CAN_BTR_SILM))  /*!< Loopback combined with silent mode */
00334 /**
00335   * @}
00336   */
00337 
00338 
00339 /** @defgroup CAN_synchronisation_jump_width CAN Synchronization Jump Width
00340   * @{
00341   */
00342 #define CAN_SJW_1TQ                 (0x00000000U)              /*!< 1 time quantum */
00343 #define CAN_SJW_2TQ                 ((uint32_t)CAN_BTR_SJW_0)  /*!< 2 time quantum */
00344 #define CAN_SJW_3TQ                 ((uint32_t)CAN_BTR_SJW_1)  /*!< 3 time quantum */
00345 #define CAN_SJW_4TQ                 ((uint32_t)CAN_BTR_SJW)    /*!< 4 time quantum */
00346 /**
00347   * @}
00348   */
00349 
00350 /** @defgroup CAN_time_quantum_in_bit_segment_1 CAN Time Quantum in Bit Segment 1
00351   * @{
00352   */
00353 #define CAN_BS1_1TQ                 (0x00000000U)                                                /*!< 1 time quantum  */
00354 #define CAN_BS1_2TQ                 ((uint32_t)CAN_BTR_TS1_0)                                    /*!< 2 time quantum  */
00355 #define CAN_BS1_3TQ                 ((uint32_t)CAN_BTR_TS1_1)                                    /*!< 3 time quantum  */
00356 #define CAN_BS1_4TQ                 ((uint32_t)(CAN_BTR_TS1_1 | CAN_BTR_TS1_0))                  /*!< 4 time quantum  */
00357 #define CAN_BS1_5TQ                 ((uint32_t)CAN_BTR_TS1_2)                                    /*!< 5 time quantum  */
00358 #define CAN_BS1_6TQ                 ((uint32_t)(CAN_BTR_TS1_2 | CAN_BTR_TS1_0))                  /*!< 6 time quantum  */
00359 #define CAN_BS1_7TQ                 ((uint32_t)(CAN_BTR_TS1_2 | CAN_BTR_TS1_1))                  /*!< 7 time quantum  */
00360 #define CAN_BS1_8TQ                 ((uint32_t)(CAN_BTR_TS1_2 | CAN_BTR_TS1_1 | CAN_BTR_TS1_0))  /*!< 8 time quantum  */
00361 #define CAN_BS1_9TQ                 ((uint32_t)CAN_BTR_TS1_3)                                    /*!< 9 time quantum  */
00362 #define CAN_BS1_10TQ                ((uint32_t)(CAN_BTR_TS1_3 | CAN_BTR_TS1_0))                  /*!< 10 time quantum */
00363 #define CAN_BS1_11TQ                ((uint32_t)(CAN_BTR_TS1_3 | CAN_BTR_TS1_1))                  /*!< 11 time quantum */
00364 #define CAN_BS1_12TQ                ((uint32_t)(CAN_BTR_TS1_3 | CAN_BTR_TS1_1 | CAN_BTR_TS1_0))  /*!< 12 time quantum */
00365 #define CAN_BS1_13TQ                ((uint32_t)(CAN_BTR_TS1_3 | CAN_BTR_TS1_2))                  /*!< 13 time quantum */
00366 #define CAN_BS1_14TQ                ((uint32_t)(CAN_BTR_TS1_3 | CAN_BTR_TS1_2 | CAN_BTR_TS1_0))  /*!< 14 time quantum */
00367 #define CAN_BS1_15TQ                ((uint32_t)(CAN_BTR_TS1_3 | CAN_BTR_TS1_2 | CAN_BTR_TS1_1))  /*!< 15 time quantum */
00368 #define CAN_BS1_16TQ                ((uint32_t)CAN_BTR_TS1) /*!< 16 time quantum */
00369 /**
00370   * @}
00371   */
00372 
00373 /** @defgroup CAN_time_quantum_in_bit_segment_2 CAN Time Quantum in Bit Segment 2
00374   * @{
00375   */
00376 #define CAN_BS2_1TQ                 (0x00000000U)                                /*!< 1 time quantum */
00377 #define CAN_BS2_2TQ                 ((uint32_t)CAN_BTR_TS2_0)                    /*!< 2 time quantum */
00378 #define CAN_BS2_3TQ                 ((uint32_t)CAN_BTR_TS2_1)                    /*!< 3 time quantum */
00379 #define CAN_BS2_4TQ                 ((uint32_t)(CAN_BTR_TS2_1 | CAN_BTR_TS2_0))  /*!< 4 time quantum */
00380 #define CAN_BS2_5TQ                 ((uint32_t)CAN_BTR_TS2_2)                    /*!< 5 time quantum */
00381 #define CAN_BS2_6TQ                 ((uint32_t)(CAN_BTR_TS2_2 | CAN_BTR_TS2_0))  /*!< 6 time quantum */
00382 #define CAN_BS2_7TQ                 ((uint32_t)(CAN_BTR_TS2_2 | CAN_BTR_TS2_1))  /*!< 7 time quantum */
00383 #define CAN_BS2_8TQ                 ((uint32_t)CAN_BTR_TS2)                      /*!< 8 time quantum */
00384 /**
00385   * @}
00386   */
00387 
00388 /** @defgroup CAN_filter_mode CAN Filter Mode
00389   * @{
00390   */
00391 #define CAN_FILTERMODE_IDMASK       (0x00000000U)  /*!< Identifier mask mode */
00392 #define CAN_FILTERMODE_IDLIST       (0x00000001U)  /*!< Identifier list mode */
00393 /**
00394   * @}
00395   */
00396 
00397 /** @defgroup CAN_filter_scale CAN Filter Scale
00398   * @{
00399   */
00400 #define CAN_FILTERSCALE_16BIT       (0x00000000U)  /*!< Two 16-bit filters */
00401 #define CAN_FILTERSCALE_32BIT       (0x00000001U)  /*!< One 32-bit filter  */
00402 /**
00403   * @}
00404   */
00405 
00406 /** @defgroup CAN_filter_activation CAN Filter Activation
00407   * @{
00408   */
00409 #define CAN_FILTER_DISABLE          (0x00000000U)  /*!< Disable filter */
00410 #define CAN_FILTER_ENABLE           (0x00000001U)  /*!< Enable filter  */
00411 /**
00412   * @}
00413   */
00414 
00415 /** @defgroup CAN_filter_FIFO CAN Filter FIFO
00416   * @{
00417   */
00418 #define CAN_FILTER_FIFO0            (0x00000000U)  /*!< Filter FIFO 0 assignment for filter x */
00419 #define CAN_FILTER_FIFO1            (0x00000001U)  /*!< Filter FIFO 1 assignment for filter x */
00420 /**
00421   * @}
00422   */
00423 
00424 /** @defgroup CAN_identifier_type CAN Identifier Type
00425   * @{
00426   */
00427 #define CAN_ID_STD                  (0x00000000U)  /*!< Standard Id */
00428 #define CAN_ID_EXT                  (0x00000004U)  /*!< Extended Id */
00429 /**
00430   * @}
00431   */
00432 
00433 /** @defgroup CAN_remote_transmission_request CAN Remote Transmission Request
00434   * @{
00435   */
00436 #define CAN_RTR_DATA                (0x00000000U)  /*!< Data frame   */
00437 #define CAN_RTR_REMOTE              (0x00000002U)  /*!< Remote frame */
00438 /**
00439   * @}
00440   */
00441 
00442 /** @defgroup CAN_receive_FIFO_number CAN Receive FIFO Number
00443   * @{
00444   */
00445 #define CAN_RX_FIFO0                (0x00000000U)  /*!< CAN receive FIFO 0 */
00446 #define CAN_RX_FIFO1                (0x00000001U)  /*!< CAN receive FIFO 1 */
00447 /**
00448   * @}
00449   */
00450 
00451 /** @defgroup CAN_Tx_Mailboxes CAN Tx Mailboxes
00452   * @{
00453   */
00454 #define CAN_TX_MAILBOX0             (0x00000001U)  /*!< Tx Mailbox 0  */
00455 #define CAN_TX_MAILBOX1             (0x00000002U)  /*!< Tx Mailbox 1  */
00456 #define CAN_TX_MAILBOX2             (0x00000004U)  /*!< Tx Mailbox 2  */
00457 /**
00458   * @}
00459   */
00460 
00461 /** @defgroup CAN_flags CAN Flags
00462   * @{
00463   */
00464 /* Transmit Flags */
00465 #define CAN_FLAG_RQCP0              (0x00000500U)  /*!< Request complete MailBox 0 flag   */
00466 #define CAN_FLAG_TXOK0              (0x00000501U)  /*!< Transmission OK MailBox 0 flag    */
00467 #define CAN_FLAG_ALST0              (0x00000502U)  /*!< Arbitration Lost MailBox 0 flag   */
00468 #define CAN_FLAG_TERR0              (0x00000503U)  /*!< Transmission error MailBox 0 flag */
00469 #define CAN_FLAG_RQCP1              (0x00000508U)  /*!< Request complete MailBox1 flag    */
00470 #define CAN_FLAG_TXOK1              (0x00000509U)  /*!< Transmission OK MailBox 1 flag    */
00471 #define CAN_FLAG_ALST1              (0x0000050AU)  /*!< Arbitration Lost MailBox 1 flag   */
00472 #define CAN_FLAG_TERR1              (0x0000050BU)  /*!< Transmission error MailBox 1 flag */
00473 #define CAN_FLAG_RQCP2              (0x00000510U)  /*!< Request complete MailBox2 flag    */
00474 #define CAN_FLAG_TXOK2              (0x00000511U)  /*!< Transmission OK MailBox 2 flag    */
00475 #define CAN_FLAG_ALST2              (0x00000512U)  /*!< Arbitration Lost MailBox 2 flag   */
00476 #define CAN_FLAG_TERR2              (0x00000513U)  /*!< Transmission error MailBox 2 flag */
00477 #define CAN_FLAG_TME0               (0x0000051AU)  /*!< Transmit mailbox 0 empty flag     */
00478 #define CAN_FLAG_TME1               (0x0000051BU)  /*!< Transmit mailbox 1 empty flag     */
00479 #define CAN_FLAG_TME2               (0x0000051CU)  /*!< Transmit mailbox 2 empty flag     */
00480 #define CAN_FLAG_LOW0               (0x0000051DU)  /*!< Lowest priority mailbox 0 flag    */
00481 #define CAN_FLAG_LOW1               (0x0000051EU)  /*!< Lowest priority mailbox 1 flag    */
00482 #define CAN_FLAG_LOW2               (0x0000051FU)  /*!< Lowest priority mailbox 2 flag    */
00483 
00484 /* Receive Flags */
00485 #define CAN_FLAG_FF0                (0x00000203U)  /*!< RX FIFO 0 Full flag               */
00486 #define CAN_FLAG_FOV0               (0x00000204U)  /*!< RX FIFO 0 Overrun flag            */
00487 #define CAN_FLAG_FF1                (0x00000403U)  /*!< RX FIFO 1 Full flag               */
00488 #define CAN_FLAG_FOV1               (0x00000404U)  /*!< RX FIFO 1 Overrun flag            */
00489 
00490 /* Operating Mode Flags */
00491 #define CAN_FLAG_INAK               (0x00000100U)  /*!< Initialization acknowledge flag   */
00492 #define CAN_FLAG_SLAK               (0x00000101U)  /*!< Sleep acknowledge flag            */
00493 #define CAN_FLAG_ERRI               (0x00000102U)  /*!< Error flag                        */
00494 #define CAN_FLAG_WKU                (0x00000103U)  /*!< Wake up interrupt flag            */
00495 #define CAN_FLAG_SLAKI              (0x00000104U)  /*!< Sleep acknowledge interrupt flag  */
00496 
00497 /* Error Flags */
00498 #define CAN_FLAG_EWG                (0x00000300U)  /*!< Error warning flag                */
00499 #define CAN_FLAG_EPV                (0x00000301U)  /*!< Error passive flag                */
00500 #define CAN_FLAG_BOF                (0x00000302U)  /*!< Bus-Off flag                      */
00501 /**
00502   * @}
00503   */
00504 
00505 
00506 /** @defgroup CAN_Interrupts CAN Interrupts
00507   * @{
00508   */
00509 /* Transmit Interrupt */
00510 #define CAN_IT_TX_MAILBOX_EMPTY     ((uint32_t)CAN_IER_TMEIE)   /*!< Transmit mailbox empty interrupt */
00511 
00512 /* Receive Interrupts */
00513 #define CAN_IT_RX_FIFO0_MSG_PENDING ((uint32_t)CAN_IER_FMPIE0)  /*!< FIFO 0 message pending interrupt */
00514 #define CAN_IT_RX_FIFO0_FULL        ((uint32_t)CAN_IER_FFIE0)   /*!< FIFO 0 full interrupt            */
00515 #define CAN_IT_RX_FIFO0_OVERRUN     ((uint32_t)CAN_IER_FOVIE0)  /*!< FIFO 0 overrun interrupt         */
00516 #define CAN_IT_RX_FIFO1_MSG_PENDING ((uint32_t)CAN_IER_FMPIE1)  /*!< FIFO 1 message pending interrupt */
00517 #define CAN_IT_RX_FIFO1_FULL        ((uint32_t)CAN_IER_FFIE1)   /*!< FIFO 1 full interrupt            */
00518 #define CAN_IT_RX_FIFO1_OVERRUN     ((uint32_t)CAN_IER_FOVIE1)  /*!< FIFO 1 overrun interrupt         */
00519 
00520 /* Operating Mode Interrupts */
00521 #define CAN_IT_WAKEUP               ((uint32_t)CAN_IER_WKUIE)   /*!< Wake-up interrupt                */
00522 #define CAN_IT_SLEEP_ACK            ((uint32_t)CAN_IER_SLKIE)   /*!< Sleep acknowledge interrupt      */
00523 
00524 /* Error Interrupts */
00525 #define CAN_IT_ERROR_WARNING        ((uint32_t)CAN_IER_EWGIE)   /*!< Error warning interrupt          */
00526 #define CAN_IT_ERROR_PASSIVE        ((uint32_t)CAN_IER_EPVIE)   /*!< Error passive interrupt          */
00527 #define CAN_IT_BUSOFF               ((uint32_t)CAN_IER_BOFIE)   /*!< Bus-off interrupt                */
00528 #define CAN_IT_LAST_ERROR_CODE      ((uint32_t)CAN_IER_LECIE)   /*!< Last error code interrupt        */
00529 #define CAN_IT_ERROR                ((uint32_t)CAN_IER_ERRIE)   /*!< Error Interrupt                  */
00530 /**
00531   * @}
00532   */
00533 
00534 /**
00535   * @}
00536   */
00537 
00538 /* Exported macros -----------------------------------------------------------*/
00539 /** @defgroup CAN_Exported_Macros CAN Exported Macros
00540   * @{
00541   */
00542 
00543 /** @brief  Reset CAN handle state
00544   * @param  __HANDLE__ CAN handle.
00545   * @retval None
00546   */
00547 #if USE_HAL_CAN_REGISTER_CALLBACKS == 1
00548 #define __HAL_CAN_RESET_HANDLE_STATE(__HANDLE__) do{                                              \
00549                                                      (__HANDLE__)->State = HAL_CAN_STATE_RESET;   \
00550                                                      (__HANDLE__)->MspInitCallback = NULL;        \
00551                                                      (__HANDLE__)->MspDeInitCallback = NULL;      \
00552                                                    } while(0)
00553 #else
00554 #define __HAL_CAN_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_CAN_STATE_RESET)
00555 #endif /*USE_HAL_CAN_REGISTER_CALLBACKS */
00556 
00557 /**
00558   * @brief  Enable the specified CAN interrupts.
00559   * @param  __HANDLE__ CAN handle.
00560   * @param  __INTERRUPT__ CAN Interrupt sources to enable.
00561   *           This parameter can be any combination of @arg CAN_Interrupts
00562   * @retval None
00563   */
00564 #define __HAL_CAN_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->IER) |= (__INTERRUPT__))
00565 
00566 /**
00567   * @brief  Disable the specified CAN interrupts.
00568   * @param  __HANDLE__ CAN handle.
00569   * @param  __INTERRUPT__ CAN Interrupt sources to disable.
00570   *           This parameter can be any combination of @arg CAN_Interrupts
00571   * @retval None
00572   */
00573 #define __HAL_CAN_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->IER) &= ~(__INTERRUPT__))
00574 
00575 /** @brief  Check if the specified CAN interrupt source is enabled or disabled.
00576   * @param  __HANDLE__ specifies the CAN Handle.
00577   * @param  __INTERRUPT__ specifies the CAN interrupt source to check.
00578   *           This parameter can be a value of @arg CAN_Interrupts
00579   * @retval The state of __IT__ (TRUE or FALSE).
00580   */
00581 #define __HAL_CAN_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->IER) & (__INTERRUPT__))
00582 
00583 /** @brief  Check whether the specified CAN flag is set or not.
00584   * @param  __HANDLE__ specifies the CAN Handle.
00585   * @param  __FLAG__ specifies the flag to check.
00586   *         This parameter can be one of @arg CAN_flags
00587   * @retval The state of __FLAG__ (TRUE or FALSE).
00588   */
00589 #define __HAL_CAN_GET_FLAG(__HANDLE__, __FLAG__) \
00590   ((((__FLAG__) >> 8U) == 5U)? ((((__HANDLE__)->Instance->TSR) & (1U << ((__FLAG__) & CAN_FLAG_MASK))) == (1U << ((__FLAG__) & CAN_FLAG_MASK))): \
00591    (((__FLAG__) >> 8U) == 2U)? ((((__HANDLE__)->Instance->RF0R) & (1U << ((__FLAG__) & CAN_FLAG_MASK))) == (1U << ((__FLAG__) & CAN_FLAG_MASK))): \
00592    (((__FLAG__) >> 8U) == 4U)? ((((__HANDLE__)->Instance->RF1R) & (1U << ((__FLAG__) & CAN_FLAG_MASK))) == (1U << ((__FLAG__) & CAN_FLAG_MASK))): \
00593    (((__FLAG__) >> 8U) == 1U)? ((((__HANDLE__)->Instance->MSR) & (1U << ((__FLAG__) & CAN_FLAG_MASK))) == (1U << ((__FLAG__) & CAN_FLAG_MASK))): \
00594    (((__FLAG__) >> 8U) == 3U)? ((((__HANDLE__)->Instance->ESR) & (1U << ((__FLAG__) & CAN_FLAG_MASK))) == (1U << ((__FLAG__) & CAN_FLAG_MASK))): 0U)
00595 
00596 /** @brief  Clear the specified CAN pending flag.
00597   * @param  __HANDLE__ specifies the CAN Handle.
00598   * @param  __FLAG__ specifies the flag to check.
00599   *         This parameter can be one of the following values:
00600   *            @arg CAN_FLAG_RQCP0: Request complete MailBox 0 Flag
00601   *            @arg CAN_FLAG_TXOK0: Transmission OK MailBox 0 Flag
00602   *            @arg CAN_FLAG_ALST0: Arbitration Lost MailBox 0 Flag
00603   *            @arg CAN_FLAG_TERR0: Transmission error MailBox 0 Flag
00604   *            @arg CAN_FLAG_RQCP1: Request complete MailBox 1 Flag
00605   *            @arg CAN_FLAG_TXOK1: Transmission OK MailBox 1 Flag
00606   *            @arg CAN_FLAG_ALST1: Arbitration Lost MailBox 1 Flag
00607   *            @arg CAN_FLAG_TERR1: Transmission error MailBox 1 Flag
00608   *            @arg CAN_FLAG_RQCP2: Request complete MailBox 2 Flag
00609   *            @arg CAN_FLAG_TXOK2: Transmission OK MailBox 2 Flag
00610   *            @arg CAN_FLAG_ALST2: Arbitration Lost MailBox 2 Flag
00611   *            @arg CAN_FLAG_TERR2: Transmission error MailBox 2 Flag
00612   *            @arg CAN_FLAG_FF0:   RX FIFO 0 Full Flag
00613   *            @arg CAN_FLAG_FOV0:  RX FIFO 0 Overrun Flag
00614   *            @arg CAN_FLAG_FF1:   RX FIFO 1 Full Flag
00615   *            @arg CAN_FLAG_FOV1:  RX FIFO 1 Overrun Flag
00616   *            @arg CAN_FLAG_WKUI:  Wake up Interrupt Flag
00617   *            @arg CAN_FLAG_SLAKI: Sleep acknowledge Interrupt Flag
00618   * @retval None
00619   */
00620 #define __HAL_CAN_CLEAR_FLAG(__HANDLE__, __FLAG__) \
00621   ((((__FLAG__) >> 8U) == 5U)? (((__HANDLE__)->Instance->TSR) = (1U << ((__FLAG__) & CAN_FLAG_MASK))): \
00622    (((__FLAG__) >> 8U) == 2U)? (((__HANDLE__)->Instance->RF0R) = (1U << ((__FLAG__) & CAN_FLAG_MASK))): \
00623    (((__FLAG__) >> 8U) == 4U)? (((__HANDLE__)->Instance->RF1R) = (1U << ((__FLAG__) & CAN_FLAG_MASK))): \
00624    (((__FLAG__) >> 8U) == 1U)? (((__HANDLE__)->Instance->MSR) = (1U << ((__FLAG__) & CAN_FLAG_MASK))): 0U)
00625 
00626 /**
00627  * @}
00628  */
00629 
00630 /* Exported functions --------------------------------------------------------*/
00631 /** @addtogroup CAN_Exported_Functions CAN Exported Functions
00632   * @{
00633   */
00634 
00635 /** @addtogroup CAN_Exported_Functions_Group1 Initialization and de-initialization functions
00636  *  @brief    Initialization and Configuration functions
00637  * @{
00638  */
00639 
00640 /* Initialization and de-initialization functions *****************************/
00641 HAL_StatusTypeDef HAL_CAN_Init(CAN_HandleTypeDef *hcan);
00642 HAL_StatusTypeDef HAL_CAN_DeInit(CAN_HandleTypeDef *hcan);
00643 void HAL_CAN_MspInit(CAN_HandleTypeDef *hcan);
00644 void HAL_CAN_MspDeInit(CAN_HandleTypeDef *hcan);
00645 
00646 #if USE_HAL_CAN_REGISTER_CALLBACKS == 1
00647 /* Callbacks Register/UnRegister functions  ***********************************/
00648 HAL_StatusTypeDef HAL_CAN_RegisterCallback(CAN_HandleTypeDef *hcan, HAL_CAN_CallbackIDTypeDef CallbackID, void (* pCallback)(CAN_HandleTypeDef *_hcan));
00649 HAL_StatusTypeDef HAL_CAN_UnRegisterCallback(CAN_HandleTypeDef *hcan, HAL_CAN_CallbackIDTypeDef CallbackID);
00650 
00651 #endif /* (USE_HAL_CAN_REGISTER_CALLBACKS) */
00652 /**
00653  * @}
00654  */
00655 
00656 /** @addtogroup CAN_Exported_Functions_Group2 Configuration functions
00657  *  @brief    Configuration functions
00658  * @{
00659  */
00660 
00661 /* Configuration functions ****************************************************/
00662 HAL_StatusTypeDef HAL_CAN_ConfigFilter(CAN_HandleTypeDef *hcan, CAN_FilterTypeDef *sFilterConfig);
00663 
00664 /**
00665  * @}
00666  */
00667 
00668 /** @addtogroup CAN_Exported_Functions_Group3 Control functions
00669  *  @brief    Control functions
00670  * @{
00671  */
00672 
00673 /* Control functions **********************************************************/
00674 HAL_StatusTypeDef HAL_CAN_Start(CAN_HandleTypeDef *hcan);
00675 HAL_StatusTypeDef HAL_CAN_Stop(CAN_HandleTypeDef *hcan);
00676 HAL_StatusTypeDef HAL_CAN_RequestSleep(CAN_HandleTypeDef *hcan);
00677 HAL_StatusTypeDef HAL_CAN_WakeUp(CAN_HandleTypeDef *hcan);
00678 uint32_t HAL_CAN_IsSleepActive(CAN_HandleTypeDef *hcan);
00679 HAL_StatusTypeDef HAL_CAN_AddTxMessage(CAN_HandleTypeDef *hcan, CAN_TxHeaderTypeDef *pHeader, uint8_t aData[], uint32_t *pTxMailbox);
00680 HAL_StatusTypeDef HAL_CAN_AbortTxRequest(CAN_HandleTypeDef *hcan, uint32_t TxMailboxes);
00681 uint32_t HAL_CAN_GetTxMailboxesFreeLevel(CAN_HandleTypeDef *hcan);
00682 uint32_t HAL_CAN_IsTxMessagePending(CAN_HandleTypeDef *hcan, uint32_t TxMailboxes);
00683 uint32_t HAL_CAN_GetTxTimestamp(CAN_HandleTypeDef *hcan, uint32_t TxMailbox);
00684 HAL_StatusTypeDef HAL_CAN_GetRxMessage(CAN_HandleTypeDef *hcan, uint32_t RxFifo, CAN_RxHeaderTypeDef *pHeader, uint8_t aData[]);
00685 uint32_t HAL_CAN_GetRxFifoFillLevel(CAN_HandleTypeDef *hcan, uint32_t RxFifo);
00686 
00687 /**
00688  * @}
00689  */
00690 
00691 /** @addtogroup CAN_Exported_Functions_Group4 Interrupts management
00692  *  @brief    Interrupts management
00693  * @{
00694  */
00695 /* Interrupts management ******************************************************/
00696 HAL_StatusTypeDef HAL_CAN_ActivateNotification(CAN_HandleTypeDef *hcan, uint32_t ActiveITs);
00697 HAL_StatusTypeDef HAL_CAN_DeactivateNotification(CAN_HandleTypeDef *hcan, uint32_t InactiveITs);
00698 void HAL_CAN_IRQHandler(CAN_HandleTypeDef *hcan);
00699 
00700 /**
00701  * @}
00702  */
00703 
00704 /** @addtogroup CAN_Exported_Functions_Group5 Callback functions
00705  *  @brief    Callback functions
00706  * @{
00707  */
00708 /* Callbacks functions ********************************************************/
00709 
00710 void HAL_CAN_TxMailbox0CompleteCallback(CAN_HandleTypeDef *hcan);
00711 void HAL_CAN_TxMailbox1CompleteCallback(CAN_HandleTypeDef *hcan);
00712 void HAL_CAN_TxMailbox2CompleteCallback(CAN_HandleTypeDef *hcan);
00713 void HAL_CAN_TxMailbox0AbortCallback(CAN_HandleTypeDef *hcan);
00714 void HAL_CAN_TxMailbox1AbortCallback(CAN_HandleTypeDef *hcan);
00715 void HAL_CAN_TxMailbox2AbortCallback(CAN_HandleTypeDef *hcan);
00716 void HAL_CAN_RxFifo0MsgPendingCallback(CAN_HandleTypeDef *hcan);
00717 void HAL_CAN_RxFifo0FullCallback(CAN_HandleTypeDef *hcan);
00718 void HAL_CAN_RxFifo1MsgPendingCallback(CAN_HandleTypeDef *hcan);
00719 void HAL_CAN_RxFifo1FullCallback(CAN_HandleTypeDef *hcan);
00720 void HAL_CAN_SleepCallback(CAN_HandleTypeDef *hcan);
00721 void HAL_CAN_WakeUpFromRxMsgCallback(CAN_HandleTypeDef *hcan);
00722 void HAL_CAN_ErrorCallback(CAN_HandleTypeDef *hcan);
00723 
00724 /**
00725  * @}
00726  */
00727 
00728 /** @addtogroup CAN_Exported_Functions_Group6 Peripheral State and Error functions
00729  *  @brief   CAN Peripheral State functions
00730  * @{
00731  */
00732 /* Peripheral State and Error functions ***************************************/
00733 HAL_CAN_StateTypeDef HAL_CAN_GetState(CAN_HandleTypeDef *hcan);
00734 uint32_t HAL_CAN_GetError(CAN_HandleTypeDef *hcan);
00735 HAL_StatusTypeDef HAL_CAN_ResetError(CAN_HandleTypeDef *hcan);
00736 
00737 /**
00738  * @}
00739  */
00740 
00741 /**
00742  * @}
00743  */
00744 
00745 /* Private types -------------------------------------------------------------*/
00746 /** @defgroup CAN_Private_Types CAN Private Types
00747   * @{
00748   */
00749 
00750 /**
00751   * @}
00752   */
00753 
00754 /* Private variables ---------------------------------------------------------*/
00755 /** @defgroup CAN_Private_Variables CAN Private Variables
00756   * @{
00757   */
00758 
00759 /**
00760   * @}
00761   */
00762 
00763 /* Private constants ---------------------------------------------------------*/
00764 /** @defgroup CAN_Private_Constants CAN Private Constants
00765   * @{
00766   */
00767 #define CAN_FLAG_MASK  (0x000000FFU)
00768 /**
00769   * @}
00770   */
00771 
00772 /* Private Macros -----------------------------------------------------------*/
00773 /** @defgroup CAN_Private_Macros CAN Private Macros
00774   * @{
00775   */
00776 
00777 #define IS_CAN_MODE(MODE) (((MODE) == CAN_MODE_NORMAL) || \
00778                            ((MODE) == CAN_MODE_LOOPBACK)|| \
00779                            ((MODE) == CAN_MODE_SILENT) || \
00780                            ((MODE) == CAN_MODE_SILENT_LOOPBACK))
00781 #define IS_CAN_SJW(SJW) (((SJW) == CAN_SJW_1TQ) || ((SJW) == CAN_SJW_2TQ) || \
00782                          ((SJW) == CAN_SJW_3TQ) || ((SJW) == CAN_SJW_4TQ))
00783 #define IS_CAN_BS1(BS1) (((BS1) == CAN_BS1_1TQ) || ((BS1) == CAN_BS1_2TQ) || \
00784                          ((BS1) == CAN_BS1_3TQ) || ((BS1) == CAN_BS1_4TQ) || \
00785                          ((BS1) == CAN_BS1_5TQ) || ((BS1) == CAN_BS1_6TQ) || \
00786                          ((BS1) == CAN_BS1_7TQ) || ((BS1) == CAN_BS1_8TQ) || \
00787                          ((BS1) == CAN_BS1_9TQ) || ((BS1) == CAN_BS1_10TQ)|| \
00788                          ((BS1) == CAN_BS1_11TQ)|| ((BS1) == CAN_BS1_12TQ)|| \
00789                          ((BS1) == CAN_BS1_13TQ)|| ((BS1) == CAN_BS1_14TQ)|| \
00790                          ((BS1) == CAN_BS1_15TQ)|| ((BS1) == CAN_BS1_16TQ))
00791 #define IS_CAN_BS2(BS2) (((BS2) == CAN_BS2_1TQ) || ((BS2) == CAN_BS2_2TQ) || \
00792                          ((BS2) == CAN_BS2_3TQ) || ((BS2) == CAN_BS2_4TQ) || \
00793                          ((BS2) == CAN_BS2_5TQ) || ((BS2) == CAN_BS2_6TQ) || \
00794                          ((BS2) == CAN_BS2_7TQ) || ((BS2) == CAN_BS2_8TQ))
00795 #define IS_CAN_PRESCALER(PRESCALER) (((PRESCALER) >= 1U) && ((PRESCALER) <= 1024U))
00796 #define IS_CAN_FILTER_ID_HALFWORD(HALFWORD) ((HALFWORD) <= 0xFFFFU)
00797 #if   defined(CAN2)
00798 #define IS_CAN_FILTER_BANK_DUAL(BANK) ((BANK) <= 27U)
00799 #endif
00800 #define IS_CAN_FILTER_BANK_SINGLE(BANK) ((BANK) <= 13U)
00801 #define IS_CAN_FILTER_MODE(MODE) (((MODE) == CAN_FILTERMODE_IDMASK) || \
00802                                   ((MODE) == CAN_FILTERMODE_IDLIST))
00803 #define IS_CAN_FILTER_SCALE(SCALE) (((SCALE) == CAN_FILTERSCALE_16BIT) || \
00804                                     ((SCALE) == CAN_FILTERSCALE_32BIT))
00805 #define IS_CAN_FILTER_ACTIVATION(ACTIVATION) (((ACTIVATION) == CAN_FILTER_DISABLE) || \
00806                                               ((ACTIVATION) == CAN_FILTER_ENABLE))
00807 #define IS_CAN_FILTER_FIFO(FIFO) (((FIFO) == CAN_FILTER_FIFO0) || \
00808                                   ((FIFO) == CAN_FILTER_FIFO1))
00809 #define IS_CAN_TX_MAILBOX(TRANSMITMAILBOX) (((TRANSMITMAILBOX) == CAN_TX_MAILBOX0 ) || \
00810                                             ((TRANSMITMAILBOX) == CAN_TX_MAILBOX1 ) || \
00811                                             ((TRANSMITMAILBOX) == CAN_TX_MAILBOX2 ))
00812 #define IS_CAN_TX_MAILBOX_LIST(TRANSMITMAILBOX) ((TRANSMITMAILBOX) <= (CAN_TX_MAILBOX0 | CAN_TX_MAILBOX1 | CAN_TX_MAILBOX2))
00813 #define IS_CAN_STDID(STDID)   ((STDID) <= 0x7FFU)
00814 #define IS_CAN_EXTID(EXTID)   ((EXTID) <= 0x1FFFFFFFU)
00815 #define IS_CAN_DLC(DLC)       ((DLC) <= 8U)
00816 #define IS_CAN_IDTYPE(IDTYPE)  (((IDTYPE) == CAN_ID_STD) || \
00817                                 ((IDTYPE) == CAN_ID_EXT))
00818 #define IS_CAN_RTR(RTR) (((RTR) == CAN_RTR_DATA) || ((RTR) == CAN_RTR_REMOTE))
00819 #define IS_CAN_RX_FIFO(FIFO) (((FIFO) == CAN_RX_FIFO0) || ((FIFO) == CAN_RX_FIFO1))
00820 #define IS_CAN_IT(IT) ((IT) <= (CAN_IT_TX_MAILBOX_EMPTY     | CAN_IT_RX_FIFO0_MSG_PENDING      | \
00821                                 CAN_IT_RX_FIFO0_FULL        | CAN_IT_RX_FIFO0_OVERRUN          | \
00822                                 CAN_IT_RX_FIFO1_MSG_PENDING | CAN_IT_RX_FIFO1_FULL             | \
00823                                 CAN_IT_RX_FIFO1_OVERRUN     | CAN_IT_WAKEUP                    | \
00824                                 CAN_IT_SLEEP_ACK            | CAN_IT_ERROR_WARNING             | \
00825                                 CAN_IT_ERROR_PASSIVE        | CAN_IT_BUSOFF                    | \
00826                                 CAN_IT_LAST_ERROR_CODE      | CAN_IT_ERROR))
00827 
00828 /**
00829   * @}
00830   */
00831 /* End of private macros -----------------------------------------------------*/
00832 
00833 /**
00834   * @}
00835   */
00836 
00837 
00838 #endif /* CAN1 */
00839 /**
00840   * @}
00841   */
00842 
00843 #ifdef __cplusplus
00844 }
00845 #endif
00846 
00847 #endif /* STM32F1xx_HAL_CAN_H */
00848 
00849 
00850 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/