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

uCOS

开发平台:

C/C++

  1. /******************** (C) COPYRIGHT 2008 STMicroelectronics ********************
  2. * File Name          : stm32f10x_usart.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. *                      USART 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_USART_H
  18. #define __STM32F10x_USART_H
  19. /* Includes ------------------------------------------------------------------*/
  20. #include "stm32f10x_map.h"
  21. /* Exported types ------------------------------------------------------------*/
  22. /* USART Init Structure definition */
  23. typedef struct
  24. {
  25.   u32 USART_BaudRate;
  26.   u16 USART_WordLength;
  27.   u16 USART_StopBits;
  28.   u16 USART_Parity;
  29.   u16 USART_Mode;
  30.   u16 USART_HardwareFlowControl;  
  31. } USART_InitTypeDef;
  32. /* USART Clock Init Structure definition */
  33. typedef struct
  34. {
  35.   u16 USART_Clock;
  36.   u16 USART_CPOL;
  37.   u16 USART_CPHA;
  38.   u16 USART_LastBit;
  39. } USART_ClockInitTypeDef;
  40. /* Exported constants --------------------------------------------------------*/
  41. #define IS_USART_ALL_PERIPH(PERIPH) (((*(u32*)&(PERIPH)) == USART1_BASE) || 
  42.                                      ((*(u32*)&(PERIPH)) == USART2_BASE) || 
  43.                                      ((*(u32*)&(PERIPH)) == USART3_BASE) || 
  44.                                      ((*(u32*)&(PERIPH)) == UART4_BASE) || 
  45.                                      ((*(u32*)&(PERIPH)) == UART5_BASE))
  46. #define IS_USART_123_PERIPH(PERIPH) (((*(u32*)&(PERIPH)) == USART1_BASE) || 
  47.                                      ((*(u32*)&(PERIPH)) == USART2_BASE) || 
  48.                                      ((*(u32*)&(PERIPH)) == USART3_BASE))
  49. #define IS_USART_1234_PERIPH(PERIPH) (((*(u32*)&(PERIPH)) == USART1_BASE) || 
  50.                                       ((*(u32*)&(PERIPH)) == USART2_BASE) || 
  51.                                       ((*(u32*)&(PERIPH)) == USART3_BASE) || 
  52.                                       ((*(u32*)&(PERIPH)) == UART4_BASE))
  53. /* USART Word Length ---------------------------------------------------------*/
  54. #define USART_WordLength_8b                  ((u16)0x0000)
  55. #define USART_WordLength_9b                  ((u16)0x1000)
  56.                                     
  57. #define IS_USART_WORD_LENGTH(LENGTH) (((LENGTH) == USART_WordLength_8b) || 
  58.                                       ((LENGTH) == USART_WordLength_9b))
  59. /* USART Stop Bits -----------------------------------------------------------*/
  60. #define USART_StopBits_1                     ((u16)0x0000)
  61. #define USART_StopBits_0_5                   ((u16)0x1000)
  62. #define USART_StopBits_2                     ((u16)0x2000)
  63. #define USART_StopBits_1_5                   ((u16)0x3000)
  64. #define IS_USART_STOPBITS(STOPBITS) (((STOPBITS) == USART_StopBits_1) || 
  65.                                      ((STOPBITS) == USART_StopBits_0_5) || 
  66.                                      ((STOPBITS) == USART_StopBits_2) || 
  67.                                      ((STOPBITS) == USART_StopBits_1_5))
  68. /* USART Parity --------------------------------------------------------------*/
  69. #define USART_Parity_No                      ((u16)0x0000)
  70. #define USART_Parity_Even                    ((u16)0x0400)
  71. #define USART_Parity_Odd                     ((u16)0x0600) 
  72. #define IS_USART_PARITY(PARITY) (((PARITY) == USART_Parity_No) || 
  73.                                  ((PARITY) == USART_Parity_Even) || 
  74.                                  ((PARITY) == USART_Parity_Odd))
  75. /* USART Mode ----------------------------------------------------------------*/
  76. #define USART_Mode_Rx                        ((u16)0x0004)
  77. #define USART_Mode_Tx                        ((u16)0x0008)
  78. #define IS_USART_MODE(MODE) ((((MODE) & (u16)0xFFF3) == 0x00) && ((MODE) != (u16)0x00))
  79. /* USART Hardware Flow Control -----------------------------------------------*/
  80. #define USART_HardwareFlowControl_None       ((u16)0x0000)
  81. #define USART_HardwareFlowControl_RTS        ((u16)0x0100)
  82. #define USART_HardwareFlowControl_CTS        ((u16)0x0200)
  83. #define USART_HardwareFlowControl_RTS_CTS    ((u16)0x0300)
  84. #define IS_USART_HARDWARE_FLOW_CONTROL(CONTROL)
  85.                               (((CONTROL) == USART_HardwareFlowControl_None) || 
  86.                                ((CONTROL) == USART_HardwareFlowControl_RTS) || 
  87.                                ((CONTROL) == USART_HardwareFlowControl_CTS) || 
  88.                                ((CONTROL) == USART_HardwareFlowControl_RTS_CTS))
  89. #define IS_USART_PERIPH_HFC(PERIPH, HFC) ((((*(u32*)&(PERIPH)) != UART4_BASE) && 
  90.                                           ((*(u32*)&(PERIPH)) != UART5_BASE)) 
  91.                                           || ((HFC) == USART_HardwareFlowControl_None))                                
  92. /* USART Clock ---------------------------------------------------------------*/
  93. #define USART_Clock_Disable                  ((u16)0x0000)
  94. #define USART_Clock_Enable                   ((u16)0x0800)
  95. #define IS_USART_CLOCK(CLOCK) (((CLOCK) == USART_Clock_Disable) || 
  96.                                ((CLOCK) == USART_Clock_Enable))
  97. /* USART Clock Polarity ------------------------------------------------------*/
  98. #define USART_CPOL_Low                       ((u16)0x0000)
  99. #define USART_CPOL_High                      ((u16)0x0400)
  100. #define IS_USART_CPOL(CPOL) (((CPOL) == USART_CPOL_Low) || ((CPOL) == USART_CPOL_High))
  101.                                
  102. /* USART Clock Phase ---------------------------------------------------------*/
  103. #define USART_CPHA_1Edge                     ((u16)0x0000)
  104. #define USART_CPHA_2Edge                     ((u16)0x0200)
  105. #define IS_USART_CPHA(CPHA) (((CPHA) == USART_CPHA_1Edge) || ((CPHA) == USART_CPHA_2Edge))
  106. /* USART Last Bit ------------------------------------------------------------*/
  107. #define USART_LastBit_Disable                ((u16)0x0000)
  108. #define USART_LastBit_Enable                 ((u16)0x0100)
  109. #define IS_USART_LASTBIT(LASTBIT) (((LASTBIT) == USART_LastBit_Disable) || 
  110.                                    ((LASTBIT) == USART_LastBit_Enable))
  111. /* USART Interrupt definition ------------------------------------------------*/
  112. #define USART_IT_PE                          ((u16)0x0028)
  113. #define USART_IT_TXE                         ((u16)0x0727)
  114. #define USART_IT_TC                          ((u16)0x0626)
  115. #define USART_IT_RXNE                        ((u16)0x0525)
  116. #define USART_IT_IDLE                        ((u16)0x0424)
  117. #define USART_IT_LBD                         ((u16)0x0846)
  118. #define USART_IT_CTS                         ((u16)0x096A)
  119. #define USART_IT_ERR                         ((u16)0x0060)
  120. #define USART_IT_ORE                         ((u16)0x0360)
  121. #define USART_IT_NE                          ((u16)0x0260)
  122. #define USART_IT_FE                          ((u16)0x0160)
  123. #define IS_USART_CONFIG_IT(IT) (((IT) == USART_IT_PE) || ((IT) == USART_IT_TXE) || 
  124.                                ((IT) == USART_IT_TC) || ((IT) == USART_IT_RXNE) || 
  125.                                ((IT) == USART_IT_IDLE) || ((IT) == USART_IT_LBD) || 
  126.                                ((IT) == USART_IT_CTS) || ((IT) == USART_IT_ERR))
  127. #define IS_USART_GET_IT(IT) (((IT) == USART_IT_PE) || ((IT) == USART_IT_TXE) || 
  128.                             ((IT) == USART_IT_TC) || ((IT) == USART_IT_RXNE) || 
  129.                             ((IT) == USART_IT_IDLE) || ((IT) == USART_IT_LBD) || 
  130.                             ((IT) == USART_IT_CTS) || ((IT) == USART_IT_ORE) || 
  131.                             ((IT) == USART_IT_NE) || ((IT) == USART_IT_FE))
  132. #define IS_USART_CLEAR_IT(IT) (((IT) == USART_IT_TC) || ((IT) == USART_IT_RXNE) || 
  133.                                ((IT) == USART_IT_LBD) || ((IT) == USART_IT_CTS))
  134. #define IS_USART_PERIPH_IT(PERIPH, USART_IT) ((((*(u32*)&(PERIPH)) != UART4_BASE) && 
  135.                                               ((*(u32*)&(PERIPH)) != UART5_BASE)) 
  136.                                               || ((USART_IT) != USART_IT_CTS))                                                                           
  137. /* USART DMA Requests --------------------------------------------------------*/
  138. #define USART_DMAReq_Tx                      ((u16)0x0080)
  139. #define USART_DMAReq_Rx                      ((u16)0x0040)
  140. #define IS_USART_DMAREQ(DMAREQ) ((((DMAREQ) & (u16)0xFF3F) == 0x00) && ((DMAREQ) != (u16)0x00))
  141. /* USART WakeUp methods ------------------------------------------------------*/
  142. #define USART_WakeUp_IdleLine                ((u16)0x0000)
  143. #define USART_WakeUp_AddressMark             ((u16)0x0800)
  144. #define IS_USART_WAKEUP(WAKEUP) (((WAKEUP) == USART_WakeUp_IdleLine) || 
  145.                                  ((WAKEUP) == USART_WakeUp_AddressMark))
  146. /* USART LIN Break Detection Length ------------------------------------------*/
  147. #define USART_LINBreakDetectLength_10b      ((u16)0x0000)
  148. #define USART_LINBreakDetectLength_11b      ((u16)0x0020)
  149. #define IS_USART_LIN_BREAK_DETECT_LENGTH(LENGTH) 
  150.                                (((LENGTH) == USART_LINBreakDetectLength_10b) || 
  151.                                 ((LENGTH) == USART_LINBreakDetectLength_11b))
  152. /* USART IrDA Low Power ------------------------------------------------------*/
  153. #define USART_IrDAMode_LowPower              ((u16)0x0004)
  154. #define USART_IrDAMode_Normal                ((u16)0x0000)
  155. #define IS_USART_IRDA_MODE(MODE) (((MODE) == USART_IrDAMode_LowPower) || 
  156.                                   ((MODE) == USART_IrDAMode_Normal))
  157. /* USART Flags ---------------------------------------------------------------*/
  158. #define USART_FLAG_CTS                       ((u16)0x0200)
  159. #define USART_FLAG_LBD                       ((u16)0x0100)
  160. #define USART_FLAG_TXE                       ((u16)0x0080)
  161. #define USART_FLAG_TC                        ((u16)0x0040)
  162. #define USART_FLAG_RXNE                      ((u16)0x0020)
  163. #define USART_FLAG_IDLE                      ((u16)0x0010)
  164. #define USART_FLAG_ORE                       ((u16)0x0008)
  165. #define USART_FLAG_NE                        ((u16)0x0004)
  166. #define USART_FLAG_FE                        ((u16)0x0002)
  167. #define USART_FLAG_PE                        ((u16)0x0001)
  168. #define IS_USART_FLAG(FLAG) (((FLAG) == USART_FLAG_PE) || ((FLAG) == USART_FLAG_TXE) || 
  169.                              ((FLAG) == USART_FLAG_TC) || ((FLAG) == USART_FLAG_RXNE) || 
  170.                              ((FLAG) == USART_FLAG_IDLE) || ((FLAG) == USART_FLAG_LBD) || 
  171.                              ((FLAG) == USART_FLAG_CTS) || ((FLAG) == USART_FLAG_ORE) || 
  172.                              ((FLAG) == USART_FLAG_NE) || ((FLAG) == USART_FLAG_FE))
  173.                               
  174. #define IS_USART_CLEAR_FLAG(FLAG) ((((FLAG) & (u16)0xFC9F) == 0x00) && ((FLAG) != (u16)0x00))
  175. #define IS_USART_PERIPH_FLAG(PERIPH, USART_FLAG) ((((*(u32*)&(PERIPH)) != UART4_BASE) &&
  176.                                                   ((*(u32*)&(PERIPH)) != UART5_BASE)) 
  177.                                                   || ((USART_FLAG) != USART_FLAG_CTS)) 
  178. #define IS_USART_BAUDRATE(BAUDRATE) (((BAUDRATE) > 0) && ((BAUDRATE) < 0x0044AA21))
  179. #define IS_USART_ADDRESS(ADDRESS) ((ADDRESS) <= 0xF)
  180. #define IS_USART_DATA(DATA) ((DATA) <= 0x1FF)
  181. /* Exported macro ------------------------------------------------------------*/
  182. /* Exported functions ------------------------------------------------------- */
  183. void USART_DeInit(USART_TypeDef* USARTx);
  184. void USART_Init(USART_TypeDef* USARTx, USART_InitTypeDef* USART_InitStruct);
  185. void USART_StructInit(USART_InitTypeDef* USART_InitStruct);
  186. void USART_ClockInit(USART_TypeDef* USARTx, USART_ClockInitTypeDef* USART_ClockInitStruct);
  187. void USART_ClockStructInit(USART_ClockInitTypeDef* USART_ClockInitStruct);
  188. void USART_Cmd(USART_TypeDef* USARTx, FunctionalState NewState);
  189. void USART_ITConfig(USART_TypeDef* USARTx, u16 USART_IT, FunctionalState NewState);
  190. void USART_DMACmd(USART_TypeDef* USARTx, u16 USART_DMAReq, FunctionalState NewState);
  191. void USART_SetAddress(USART_TypeDef* USARTx, u8 USART_Address);
  192. void USART_WakeUpConfig(USART_TypeDef* USARTx, u16 USART_WakeUp);
  193. void USART_ReceiverWakeUpCmd(USART_TypeDef* USARTx, FunctionalState NewState);
  194. void USART_LINBreakDetectLengthConfig(USART_TypeDef* USARTx, u16 USART_LINBreakDetectLength);
  195. void USART_LINCmd(USART_TypeDef* USARTx, FunctionalState NewState);
  196. void USART_SendData(USART_TypeDef* USARTx, u16 Data);
  197. u16 USART_ReceiveData(USART_TypeDef* USARTx);
  198. void USART_SendBreak(USART_TypeDef* USARTx);
  199. void USART_SetGuardTime(USART_TypeDef* USARTx, u8 USART_GuardTime);
  200. void USART_SetPrescaler(USART_TypeDef* USARTx, u8 USART_Prescaler);
  201. void USART_SmartCardCmd(USART_TypeDef* USARTx, FunctionalState NewState);
  202. void USART_SmartCardNACKCmd(USART_TypeDef* USARTx, FunctionalState NewState);
  203. void USART_HalfDuplexCmd(USART_TypeDef* USARTx, FunctionalState NewState);
  204. void USART_IrDAConfig(USART_TypeDef* USARTx, u16 USART_IrDAMode);
  205. void USART_IrDACmd(USART_TypeDef* USARTx, FunctionalState NewState);
  206. FlagStatus USART_GetFlagStatus(USART_TypeDef* USARTx, u16 USART_FLAG);
  207. void USART_ClearFlag(USART_TypeDef* USARTx, u16 USART_FLAG);
  208. ITStatus USART_GetITStatus(USART_TypeDef* USARTx, u16 USART_IT);
  209. void USART_ClearITPendingBit(USART_TypeDef* USARTx, u16 USART_IT);
  210. #endif /* __STM32F10x_USART_H */
  211. /******************* (C) COPYRIGHT 2008 STMicroelectronics *****END OF FILE****/