stm32f10x_can.h
上传用户:yj_qqy
上传日期:2017-01-28
资源大小:2911k
文件大小:12k
源码类别:

uCOS

开发平台:

C/C++

  1. /******************** (C) COPYRIGHT 2008 STMicroelectronics ********************
  2. * File Name          : stm32f10x_can.h
  3. * Author             : MCD Application Team
  4. * Version            : V2.0.2
  5. * Date               : 07/11/2008
  6. * Description        : This file contains all the functions prototypes for the
  7. *                      CAN firmware library.
  8. ********************************************************************************
  9. * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
  10. * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE TIME.
  11. * AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY DIRECT,
  12. * INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE
  13. * CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING
  14. * INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
  15. *******************************************************************************/
  16. /* Define to prevent recursive inclusion -------------------------------------*/
  17. #ifndef __STM32F10x_CAN_H
  18. #define __STM32F10x_CAN_H
  19. /* Includes ------------------------------------------------------------------*/
  20. #include "stm32f10x_map.h"
  21. /* Exported types ------------------------------------------------------------*/
  22. /* CAN init structure definition */
  23. typedef struct
  24. {
  25.   FunctionalState CAN_TTCM;
  26.   FunctionalState CAN_ABOM;
  27.   FunctionalState CAN_AWUM;
  28.   FunctionalState CAN_NART;
  29.   FunctionalState CAN_RFLM;
  30.   FunctionalState CAN_TXFP;
  31.   u8 CAN_Mode;
  32.   u8 CAN_SJW;
  33.   u8 CAN_BS1;
  34.   u8 CAN_BS2;
  35.   u16 CAN_Prescaler;
  36. } CAN_InitTypeDef;
  37. /* CAN filter init structure definition */
  38. typedef struct
  39. {
  40.   u8 CAN_FilterNumber;
  41.   u8 CAN_FilterMode;
  42.   u8 CAN_FilterScale;
  43.   u16 CAN_FilterIdHigh;
  44.   u16 CAN_FilterIdLow;
  45.   u16 CAN_FilterMaskIdHigh;
  46.   u16 CAN_FilterMaskIdLow;
  47.   u16 CAN_FilterFIFOAssignment;
  48.   FunctionalState CAN_FilterActivation;
  49. } CAN_FilterInitTypeDef;
  50. /* CAN Tx message structure definition */
  51. typedef struct
  52. {
  53.   u32 StdId;
  54.   u32 ExtId;
  55.   u8 IDE;
  56.   u8 RTR;
  57.   u8 DLC;
  58.   u8 Data[8];
  59. } CanTxMsg;
  60. /* CAN Rx message structure definition */
  61. typedef struct
  62. {
  63.   u32 StdId;
  64.   u32 ExtId;
  65.   u8 IDE;
  66.   u8 RTR;
  67.   u8 DLC;
  68.   u8 Data[8];
  69.   u8 FMI;
  70. } CanRxMsg;
  71. /* Exported constants --------------------------------------------------------*/
  72. /* CAN sleep constants */
  73. #define CANINITFAILED              ((u8)0x00) /* CAN initialization failed */
  74. #define CANINITOK                  ((u8)0x01) /* CAN initialization failed */
  75. /* CAN operating mode */
  76. #define CAN_Mode_Normal             ((u8)0x00)  /* normal mode */
  77. #define CAN_Mode_LoopBack           ((u8)0x01)  /* loopback mode */
  78. #define CAN_Mode_Silent             ((u8)0x02)  /* silent mode */
  79. #define CAN_Mode_Silent_LoopBack    ((u8)0x03)  /* loopback combined with silent mode */
  80. #define IS_CAN_MODE(MODE) (((MODE) == CAN_Mode_Normal) || ((MODE) == CAN_Mode_LoopBack)|| 
  81.                            ((MODE) == CAN_Mode_Silent) || ((MODE) == CAN_Mode_Silent_LoopBack))
  82. /* CAN synchronisation jump width */
  83. #define CAN_SJW_1tq                 ((u8)0x00)  /* 1 time quantum */
  84. #define CAN_SJW_2tq                 ((u8)0x01)  /* 2 time quantum */
  85. #define CAN_SJW_3tq                 ((u8)0x02)  /* 3 time quantum */
  86. #define CAN_SJW_4tq                 ((u8)0x03)  /* 4 time quantum */
  87. #define IS_CAN_SJW(SJW) (((SJW) == CAN_SJW_1tq) || ((SJW) == CAN_SJW_2tq)|| 
  88.                          ((SJW) == CAN_SJW_3tq) || ((SJW) == CAN_SJW_4tq))
  89. /* time quantum in bit segment 1 */
  90. #define CAN_BS1_1tq                 ((u8)0x00)  /* 1 time quantum */
  91. #define CAN_BS1_2tq                 ((u8)0x01)  /* 2 time quantum */
  92. #define CAN_BS1_3tq                 ((u8)0x02)  /* 3 time quantum */
  93. #define CAN_BS1_4tq                 ((u8)0x03)  /* 4 time quantum */
  94. #define CAN_BS1_5tq                 ((u8)0x04)  /* 5 time quantum */
  95. #define CAN_BS1_6tq                 ((u8)0x05)  /* 6 time quantum */
  96. #define CAN_BS1_7tq                 ((u8)0x06)  /* 7 time quantum */
  97. #define CAN_BS1_8tq                 ((u8)0x07)  /* 8 time quantum */
  98. #define CAN_BS1_9tq                 ((u8)0x08)  /* 9 time quantum */
  99. #define CAN_BS1_10tq                ((u8)0x09)  /* 10 time quantum */
  100. #define CAN_BS1_11tq                ((u8)0x0A)  /* 11 time quantum */
  101. #define CAN_BS1_12tq                ((u8)0x0B)  /* 12 time quantum */
  102. #define CAN_BS1_13tq                ((u8)0x0C)  /* 13 time quantum */
  103. #define CAN_BS1_14tq                ((u8)0x0D)  /* 14 time quantum */
  104. #define CAN_BS1_15tq                ((u8)0x0E)  /* 15 time quantum */
  105. #define CAN_BS1_16tq                ((u8)0x0F)  /* 16 time quantum */
  106. #define IS_CAN_BS1(BS1) ((BS1) <= CAN_BS1_16tq)
  107. /* time quantum in bit segment 2 */
  108. #define CAN_BS2_1tq                 ((u8)0x00)  /* 1 time quantum */
  109. #define CAN_BS2_2tq                 ((u8)0x01)  /* 2 time quantum */
  110. #define CAN_BS2_3tq                 ((u8)0x02)  /* 3 time quantum */
  111. #define CAN_BS2_4tq                 ((u8)0x03)  /* 4 time quantum */
  112. #define CAN_BS2_5tq                 ((u8)0x04)  /* 5 time quantum */
  113. #define CAN_BS2_6tq                 ((u8)0x05)  /* 6 time quantum */
  114. #define CAN_BS2_7tq                 ((u8)0x06)  /* 7 time quantum */
  115. #define CAN_BS2_8tq                 ((u8)0x07)  /* 8 time quantum */
  116. #define IS_CAN_BS2(BS2) ((BS2) <= CAN_BS2_8tq)
  117. /* CAN clock prescaler */
  118. #define IS_CAN_PRESCALER(PRESCALER) (((PRESCALER) >= 1) && ((PRESCALER) <= 1024))
  119. /* CAN filter number */
  120. #define IS_CAN_FILTER_NUMBER(NUMBER) ((NUMBER) <= 13)
  121. /* CAN filter mode */
  122. #define CAN_FilterMode_IdMask       ((u8)0x00)  /* id/mask mode */
  123. #define CAN_FilterMode_IdList       ((u8)0x01)  /* identifier list mode */
  124. #define IS_CAN_FILTER_MODE(MODE) (((MODE) == CAN_FilterMode_IdMask) || 
  125.                                   ((MODE) == CAN_FilterMode_IdList))
  126. /* CAN filter scale */
  127. #define CAN_FilterScale_16bit       ((u8)0x00) /* 16-bit filter scale */
  128. #define CAN_FilterScale_32bit       ((u8)0x01) /* 2-bit filter scale */
  129. #define IS_CAN_FILTER_SCALE(SCALE) (((SCALE) == CAN_FilterScale_16bit) || 
  130.                                     ((SCALE) == CAN_FilterScale_32bit))
  131. /* CAN filter FIFO assignation */
  132. #define CAN_FilterFIFO0             ((u8)0x00)  /* Filter FIFO 0 assignment for filter x */
  133. #define CAN_FilterFIFO1             ((u8)0x01)  /* Filter FIFO 1 assignment for filter x */
  134. #define IS_CAN_FILTER_FIFO(FIFO) (((FIFO) == CAN_FilterFIFO0) || 
  135.                                   ((FIFO) == CAN_FilterFIFO1))
  136. /* CAN Tx */
  137. #define IS_CAN_TRANSMITMAILBOX(TRANSMITMAILBOX) ((TRANSMITMAILBOX) <= ((u8)0x02))
  138. #define IS_CAN_STDID(STDID)   ((STDID) <= ((u32)0x7FF))
  139. #define IS_CAN_EXTID(EXTID)   ((EXTID) <= ((u32)0x1FFFFFFF))
  140. #define IS_CAN_DLC(DLC)       ((DLC) <= ((u8)0x08))
  141. /* CAN identifier type */
  142. #define CAN_ID_STD                 ((u32)0x00000000)  /* Standard Id */
  143. #define CAN_ID_EXT                 ((u32)0x00000004)  /* Extended Id */
  144. #define IS_CAN_IDTYPE(IDTYPE) (((IDTYPE) == CAN_ID_STD) || ((IDTYPE) == CAN_ID_EXT))
  145. /* CAN remote transmission request */
  146. #define CAN_RTR_DATA                ((u32)0x00000000)  /* Data frame */
  147. #define CAN_RTR_REMOTE              ((u32)0x00000002)  /* Remote frame */
  148. #define IS_CAN_RTR(RTR) (((RTR) == CAN_RTR_DATA) || ((RTR) == CAN_RTR_REMOTE))
  149. /* CAN transmit constants */
  150. #define CANTXFAILED                 ((u8)0x00) /* CAN transmission failed */
  151. #define CANTXOK                     ((u8)0x01) /* CAN transmission succeeded */
  152. #define CANTXPENDING                ((u8)0x02) /* CAN transmission pending */
  153. #define CAN_NO_MB                   ((u8)0x04) /* CAN cell did not provide an empty mailbox */
  154. /* CAN receive FIFO number constants */
  155. #define CAN_FIFO0                 ((u8)0x00) /* CAN FIFO0 used to receive */
  156. #define CAN_FIFO1                 ((u8)0x01) /* CAN FIFO1 used to receive */
  157. #define IS_CAN_FIFO(FIFO) (((FIFO) == CAN_FIFO0) || ((FIFO) == CAN_FIFO1))
  158. /* CAN sleep constants */
  159. #define CANSLEEPFAILED              ((u8)0x00) /* CAN did not enter the sleep mode */
  160. #define CANSLEEPOK                  ((u8)0x01) /* CAN entered the sleep mode */
  161. /* CAN wake up constants */
  162. #define CANWAKEUPFAILED             ((u8)0x00) /* CAN did not leave the sleep mode */
  163. #define CANWAKEUPOK                 ((u8)0x01) /* CAN leaved the sleep mode */
  164. /* CAN flags */
  165. #define CAN_FLAG_EWG                ((u32)0x00000001) /* Error Warning Flag */
  166. #define CAN_FLAG_EPV                ((u32)0x00000002) /* Error Passive Flag */
  167. #define CAN_FLAG_BOF                ((u32)0x00000004) /* Bus-Off Flag */
  168. #define IS_CAN_FLAG(FLAG) (((FLAG) == CAN_FLAG_EWG) || ((FLAG) == CAN_FLAG_EPV) ||
  169.                            ((FLAG) == CAN_FLAG_BOF))
  170. /* CAN interrupts */
  171. #define CAN_IT_RQCP0                ((u32)0x00000005) /* Request completed mailbox 0 */
  172. #define CAN_IT_RQCP1                ((u32)0x00000006) /* Request completed mailbox 1 */
  173. #define CAN_IT_RQCP2                ((u32)0x00000007) /* Request completed mailbox 2 */
  174. #define CAN_IT_TME                  ((u32)0x00000001) /* Transmit mailbox empty */
  175. #define CAN_IT_FMP0                 ((u32)0x00000002) /* FIFO 0 message pending */
  176. #define CAN_IT_FF0                  ((u32)0x00000004) /* FIFO 0 full */
  177. #define CAN_IT_FOV0                 ((u32)0x00000008) /* FIFO 0 overrun */
  178. #define CAN_IT_FMP1                 ((u32)0x00000010) /* FIFO 1 message pending */
  179. #define CAN_IT_FF1                  ((u32)0x00000020) /* FIFO 1 full */
  180. #define CAN_IT_FOV1                 ((u32)0x00000040) /* FIFO 1 overrun */
  181. #define CAN_IT_EWG                  ((u32)0x00000100) /* Error warning */
  182. #define CAN_IT_EPV                  ((u32)0x00000200) /* Error passive */
  183. #define CAN_IT_BOF                  ((u32)0x00000400) /* Bus-off */
  184. #define CAN_IT_LEC                  ((u32)0x00000800) /* Last error code */
  185. #define CAN_IT_ERR                  ((u32)0x00008000) /* Error */
  186. #define CAN_IT_WKU                  ((u32)0x00010000) /* Wake-up */
  187. #define CAN_IT_SLK                  ((u32)0x00020000) /* Sleep */
  188. #define IS_CAN_ITConfig(IT) (((IT) == CAN_IT_TME)   || ((IT) == CAN_IT_FMP0)  ||
  189.                              ((IT) == CAN_IT_FF0)   || ((IT) == CAN_IT_FOV0)  ||
  190.                              ((IT) == CAN_IT_FMP1)  || ((IT) == CAN_IT_FF1)   ||
  191.                              ((IT) == CAN_IT_FOV1)  || ((IT) == CAN_IT_EWG)   ||
  192.                              ((IT) == CAN_IT_EPV)   || ((IT) == CAN_IT_BOF)   ||
  193.                              ((IT) == CAN_IT_LEC)   || ((IT) == CAN_IT_ERR)   ||
  194.                              ((IT) == CAN_IT_WKU)   || ((IT) == CAN_IT_SLK))
  195. #define IS_CAN_ITStatus(IT) (((IT) == CAN_IT_RQCP0)  || ((IT) == CAN_IT_RQCP1)  ||
  196.                              ((IT) == CAN_IT_RQCP2)  || ((IT) == CAN_IT_FF0)    ||
  197.                              ((IT) == CAN_IT_FOV0)   || ((IT) == CAN_IT_FF1)    ||
  198.                              ((IT) == CAN_IT_FOV1)   || ((IT) == CAN_IT_EWG)    ||
  199.                              ((IT) == CAN_IT_EPV)    || ((IT) == CAN_IT_BOF)    ||
  200.                              ((IT) == CAN_IT_WKU)    || ((IT) == CAN_IT_SLK))
  201. /* Exported macro ------------------------------------------------------------*/
  202. /* Exported function protypes ----------------------------------------------- */
  203. void CAN_DeInit(void);
  204. u8 CAN_Init(CAN_InitTypeDef* CAN_InitStruct);
  205. void CAN_FilterInit(CAN_FilterInitTypeDef* CAN_FilterInitStruct);
  206. void CAN_StructInit(CAN_InitTypeDef* CAN_InitStruct);
  207. void CAN_ITConfig(u32 CAN_IT, FunctionalState NewState);
  208. u8 CAN_Transmit(CanTxMsg* TxMessage);
  209. u8 CAN_TransmitStatus(u8 TransmitMailbox);
  210. void CAN_CancelTransmit(u8 Mailbox);
  211. void CAN_FIFORelease(u8 FIFONumber);
  212. u8 CAN_MessagePending(u8 FIFONumber);
  213. void CAN_Receive(u8 FIFONumber, CanRxMsg* RxMessage);
  214. u8 CAN_Sleep(void);
  215. u8 CAN_WakeUp(void);
  216. FlagStatus CAN_GetFlagStatus(u32 CAN_FLAG);
  217. void CAN_ClearFlag(u32 CAN_FLAG);
  218. ITStatus CAN_GetITStatus(u32 CAN_IT);
  219. void CAN_ClearITPendingBit(u32 CAN_IT);
  220. #endif /* __STM32F10x_CAN_H */
  221. /******************* (C) COPYRIGHT 2008 STMicroelectronics *****END OF FILE****/