uart.h
上传用户:yyyd609
上传日期:2022-07-18
资源大小:183k
文件大小:16k
源码类别:

微处理器开发

开发平台:

C/C++

  1. /******************** (C) COPYRIGHT 2003 STMicroelectronics ********************
  2. * File Name          : uart.h
  3. * Author             : MCD Application Team
  4. * Date First Issued  : 16/05/2003
  5. * Description        : This file contains all the functions prototypes for the
  6. *                      UART software library.
  7. ********************************************************************************
  8. * History:
  9. *  01/01/2004 : V1.2
  10. *  14/07/2004 : V1.3
  11. *******************************************************************************/
  12. #ifndef _UART_H
  13. #define _UART_H
  14. #include "71x_lib.h"
  15. #ifndef _RCCU
  16.   #error _RCCU must be defined
  17. #endif
  18. #ifdef DEBUG
  19.   #ifndef _PCU
  20.     #error _PCU must be defined
  21.   #endif
  22. #endif /* DEBUG */
  23. typedef enum
  24. {
  25.   UART_RxFIFO,
  26.   UART_TxFIFO
  27. } UARTFIFO_TypeDef;
  28. typedef enum
  29. {
  30.   UART_EVEN_PARITY = 0x0000,
  31.   UART_ODD_PARITY  = 0x0020,
  32.   UART_NO_PARITY
  33. } UARTParity_TypeDef;
  34. typedef enum
  35. {
  36.   UART_0_5_StopBits  = 0x00,
  37.   UART_1_StopBits    = 0x08,
  38.   UART_1_5_StopBits  = 0x10,
  39.   UART_2_StopBits    = 0x18
  40. } UARTStopBits_TypeDef;
  41. typedef enum
  42. {
  43.   UARTM_8D   = 0x01,
  44.   UARTM_7D_P = 0x03,
  45.   UARTM_9D   = 0x04,
  46.   UARTM_8D_W = 0x05,
  47.   UARTM_8D_P = 0x07
  48. } UARTMode_TypeDef;
  49. #define DUMMY 0
  50. // UART flags definition
  51. #define UART_TxFull          0x0200
  52. #define UART_RxHalfFull      0x0100
  53. #define UART_TimeOutIdle     0x0080
  54. #define UART_TimeOutNotEmpty 0x0040
  55. #define UART_OverrunError    0x0020
  56. #define UART_FrameError      0x0010
  57. #define UART_ParityError     0x0008
  58. #define UART_TxHalfEmpty     0x0004
  59. #define UART_TxEmpty         0x0002
  60. #define UART_RxBufFull       0x0001
  61. // CR regiter bit definition
  62. #define UART_FIFOEnableBit 10
  63. #define UART_RxEnableBit   8
  64. #define UART_RunBit        7
  65. #define UART_LoopBackBit   6
  66. #define UART_ParityOddBit  5
  67. #define UART_StopBits      3
  68. // Stop bits definition
  69. #define UART_05StopBits     0x00
  70. #define UART_1StopBit       (0x01<<3)
  71. #define UART_15StopBits     (0x02<<3)
  72. #define UART_2StopBits      (0x03<<3)
  73. // Modes definition
  74. #define UART_8BitsData       0x01
  75. #define UART_7BitsData       0x03
  76. #define UART_9BitsData       0x04
  77. #define UART_8BitsDataWakeUp 0x05
  78. #define UART_8BitsDataParity 0x07
  79. /*******************************************************************************
  80. * Function Name  : UART_Init
  81. * Description    : This function initializes the selected UART.
  82. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  83. * Output         : None
  84. * Return         : None
  85. *******************************************************************************/
  86. void UART_Init(UART_TypeDef *UARTx);
  87. /*******************************************************************************
  88. * Function Name  : UART_ModeConfig
  89. * Description    : This function configures the mode of the selected UART.
  90. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  91. * Input 2        : The UART mode
  92. * Output         : None
  93. * Return         : None
  94. *******************************************************************************/
  95. inline void UART_ModeConfig(UART_TypeDef *UARTx, UARTMode_TypeDef UART_Mode)
  96. {
  97.   UARTx->CR = (UARTx->CR&0xFFF8)|(u16)UART_Mode;
  98. }
  99. /*******************************************************************************
  100. * Function Name  : UART_BaudRateConfig
  101. * Description    : This function configures the baud rate of the selected UART.
  102. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  103. * Input 2        : The baudrate value
  104. * Output         : None
  105. * Return         : None
  106. *******************************************************************************/
  107. void UART_BaudRateConfig(UART_TypeDef *UARTx, u32 BaudRate);
  108. /*******************************************************************************
  109. * Function Name  : UART_ParityConfig
  110. * Description    : This function configures the data parity of the selected UART.
  111. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  112. * Input 2        : The parity type
  113. * Output         : None
  114. * Return         : None
  115. *******************************************************************************/
  116. inline void UART_ParityConfig(UART_TypeDef *UARTx, UARTParity_TypeDef Parity)
  117. {
  118.   UARTx->CR = (UARTx->CR&0xFFDF)|(u16)Parity;
  119. }
  120. /*******************************************************************************
  121. * Function Name  : UART_StopBitsConfig
  122. * Description    : This function configures the number of stop bits of the
  123. *                  selected UART.
  124. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  125. * Input 2        : The number of stop bits
  126. * Output         : None
  127. * Return         : None
  128. *******************************************************************************/
  129. inline void UART_StopBitsConfig(UART_TypeDef *UARTx, UARTStopBits_TypeDef StopBits)
  130. {
  131.   UARTx->CR = (UARTx->CR&0xFFE7)|(u16)StopBits;
  132. }
  133. /*******************************************************************************
  134. * Function Name  : UART_Config
  135. * Description    : This function configures the baudrate, the mode, the data
  136. *                  parity and the number of stop bits of the selected UART.
  137. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  138. * Input 2        : The baudrate value
  139. * Input 3        : The parity type
  140. * Input 4        : The number of stop bits
  141. * Input 5        : The UART mode
  142. * Output         : None
  143. * Return         : None
  144. *******************************************************************************/
  145. void UART_Config(UART_TypeDef *UARTx, u32 BaudRate, UARTParity_TypeDef Parity,
  146.                  UARTStopBits_TypeDef StopBits, UARTMode_TypeDef Mode);
  147. /*******************************************************************************
  148. * Function Name  : UART_ItConfig
  149. * Description    : This function enables or disables the interrupts of the
  150. *                  selected UART.
  151. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  152. * Input 2        : The new interrupt flag
  153. * Input 3        : ENABLE or DISABLE
  154. * Output         : None
  155. * Return         : None
  156. *******************************************************************************/
  157. void UART_ItConfig(UART_TypeDef *UARTx, u16 UART_Flag, FunctionalState NewState);
  158. /*******************************************************************************
  159. * Function Name  : UART_FifoConfig
  160. * Description    : This function enables or disables the Rx and Tx FIFOs of
  161. *                  the selected UART.
  162. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  163. * Input 2        : ENABLE or DISABLE
  164. * Output         : None
  165. * Return         : None
  166. *******************************************************************************/
  167. void UART_FifoConfig(UART_TypeDef *UARTx, FunctionalState NewState);
  168. /*******************************************************************************
  169. * Function Name  : UART_FifoReset
  170. * Description    : This function resets the Rx and the Tx FIFOs of the
  171. *                  selected UART.
  172. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  173. * Input 2        : RxFIFO or TxFIFO
  174. * Output         : None
  175. * Return         : None
  176. *******************************************************************************/
  177. void UART_FifoReset(UART_TypeDef *UARTx, UARTFIFO_TypeDef FIFO);
  178. /*******************************************************************************
  179. * Function Name  : UART_LoopBackConfig
  180. * Description    : This function enables or disables the loop back mode of
  181. *                  the selected UART.
  182. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  183. * Input 2        : ENABLE or DISABLE
  184. * Output         : None
  185. * Return         : None
  186. *******************************************************************************/
  187. void UART_LoopBackConfig(UART_TypeDef *UARTx, FunctionalState NewState);
  188. /*******************************************************************************
  189. * Function Name  : UART_TimeOutPeriodConfig
  190. * Description    : This function configure the Time Out Period.
  191. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  192. * Input 2        : The time-out period value
  193. * Output         : None
  194. * Return         : None
  195. *******************************************************************************/
  196. inline void UART_TimeOutPeriodConfig(UART_TypeDef *UARTx, u16 TimeOutPeriod)
  197. {
  198.   UARTx->TOR = TimeOutPeriod;
  199. }
  200. /*******************************************************************************
  201. * Function Name  : UART_GuardTimeConfig
  202. * Description    : This function configure the Guard Time.
  203. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  204. * Input 2        : The guard time value
  205. * Output         : None
  206. * Return         : None
  207. *******************************************************************************/
  208. inline void UART_GuardTimeConfig(UART_TypeDef *UARTx, u16 GuardTime)
  209. {
  210.   UARTx->GTR = GuardTime;
  211. }
  212. /*******************************************************************************
  213. * Function Name  : UART_RxConfig
  214. * Description    : This function enable and disable the UART data reception.
  215. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  216. * Input 2        : ENABLE or DISABLE
  217. * Output         : None
  218. * Return         : None
  219. *******************************************************************************/
  220. void UART_RxConfig(UART_TypeDef *UARTx, FunctionalState NewState);
  221. /*******************************************************************************
  222. * Function Name  : UART_OnOffConfig
  223. * Description    : This function sets On/Off the selected UART.
  224. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  225. * Input 2        : ENABLE or DISABLE
  226. * Output         : None
  227. * Return         : None
  228. *******************************************************************************/
  229. void UART_OnOffConfig(UART_TypeDef *UARTx, FunctionalState NewState);
  230. /*******************************************************************************
  231. * Function Name  : UART_ByteSend
  232. * Description    : This function sends a data byte to the selected UART.
  233. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  234. * Input 2        : A pointer to the data byte to send
  235. * Output         : None
  236. * Return         : None
  237. *******************************************************************************/
  238. void UART_ByteSend(UART_TypeDef *UARTx, u8 *Data);
  239. /*******************************************************************************
  240. * Function Name  : UART_9BitByteSend
  241. * Description    : This function sends a 9 bits data byte to the selected UART.
  242. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  243. * Input 2        : A pointer to the data to send
  244. * Output         : None
  245. * Return         : None
  246. *******************************************************************************/
  247. void UART_9BitByteSend(UART_TypeDef *UARTx, u16 *Data);
  248. /*******************************************************************************
  249. * Function Name  : UART_DataSend
  250. * Description    : This function sends several data bytes to the selected UART.
  251. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  252. * Input 2        : A pointer to the data to send
  253. * Input 3        : The data length in bytes
  254. * Output         : None
  255. * Return         : None
  256. *******************************************************************************/
  257. void UART_DataSend(UART_TypeDef *UARTx, u8 *Data, u8 DataLength);
  258. /*******************************************************************************
  259. * Function Name  : UART_9BitDataSend
  260. * Description    : This function sends several 9 bits data bytes to the selected UART.
  261. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  262. * Input 2        : A pointer to the data to send
  263. * Input 3        : The data length
  264. * Output         : None
  265. * Return         : None
  266. *******************************************************************************/
  267. void UART_9BitDataSend(UART_TypeDef *UARTx, u16 *Data, u8 DataLength);
  268. /*******************************************************************************
  269. * Function Name  : UART_StringSend
  270. * Description    : This function sends a string to the selected UART.
  271. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  272. * Input 2        : A pointer to the string to send
  273. * Output         : None
  274. * Return         : None
  275. *******************************************************************************/
  276. void UART_StringSend(UART_TypeDef *UARTx, u8 *String);
  277. /*******************************************************************************
  278. * Function Name  : UART_ByteReceive
  279. * Description    : This function gets a data byte from the selected UART.
  280. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  281. * Input 2        : A pointer to the buffer where the data will be stored
  282. * Input 3        : The time-out period
  283. * Output         : The received data
  284. * Return         : The UARTx.SR register contents
  285. *******************************************************************************/
  286. u16 UART_ByteReceive(UART_TypeDef *UARTx, u8 *Data, u8 TimeOut);
  287. /*******************************************************************************
  288. * Function Name  : UART_9BitByteReceive
  289. * Description    : This function gets a 9 bits data byte from the selected UART.
  290. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  291. * Input 2        : A pointer to the buffer where the data will be stored
  292. * Input 3        : The time-out period value
  293. * Output         : The received data
  294. * Return         : The UARTx.SR register contents
  295. *******************************************************************************/
  296. u16 UART_9BitByteReceive(UART_TypeDef *UARTx, u16 *Data, u8 TimeOut);
  297. /*******************************************************************************
  298. * Function Name  : UART_DataReceive
  299. * Description    : This function gets 8 bits data bytes from the selected UART.
  300. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  301. * Input 2        : A pointer to the buffer where the data will be stored
  302. * Input 3        : The data length
  303. * Input 4        : The time-out period value
  304. * Output         : The received data
  305. * Return         : The UARTx.SR register contents
  306. *******************************************************************************/
  307. u16 UART_DataReceive(UART_TypeDef *UARTx, u8 *Data, u8 DataLength, u8 TimeOut);
  308. /*******************************************************************************
  309. * Function Name  : UART_9BitDataReceive
  310. * Description    : This function gets 9 bits data bytes from the selected UART.
  311. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  312. * Input 2        : A pointer to the buffer where the data will be stored
  313. * Input 3        : The data length
  314. * Input 4        : The time-out value
  315. * Output         : The received data
  316. * Return         : The UARTx.SR register contents
  317. *******************************************************************************/
  318. u16 UART_9BitDataReceive(UART_TypeDef *UARTx, u16 *Data, u8 DataLength, u8 TimeOut);
  319. /*******************************************************************************
  320. * Function Name  : UART_StringReceive
  321. * Description    : This function gets 8 bits data bytes from the selected UART.
  322. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  323. * Input 2        : A pointer to the buffer where the string will be stored
  324. * Output         : None
  325. * Return         : None
  326. *******************************************************************************/
  327. u16 UART_StringReceive(UART_TypeDef *UARTx, u8 *Data);
  328. /*******************************************************************************
  329. * Function Name  : UART_FlagStatus
  330. * Description    : This function gets the flags status of the selected UART.
  331. * Input 1        : UARTx (x can be 0,1, 2 or 3) the desired UART
  332. * Output         : None
  333. * Return         : None
  334. *******************************************************************************/
  335. inline u16 UART_FlagStatus(UART_TypeDef *UARTx)
  336. {
  337.   return UARTx->SR;
  338. }
  339. #ifdef USE_SERIAL_PORT
  340. /*******************************************************************************
  341. * Function Name  : sendchar
  342. * Description    : This function sends a character to the selected UART.
  343. * Input 1        : A pointer to the character to send.
  344. * Output         : None
  345. * Return         : None
  346. *******************************************************************************/
  347. void sendchar( char *ch );
  348. #endif /* USE_SERIAL_PORT */
  349. #endif /* _UART_H */
  350. /******************* (C) COPYRIGHT 2003 STMicroelectronics *****END OF FILE****/