/soc/stm/drivers/include/uart/am_stm32f103rbt6_usart.h

https://github.com/zlgopen/ametal · C Header · 173 lines · 48 code · 42 blank · 83 comment · 0 complexity · fb3085bc048e880fa400179e1e75dafa MD5 · raw file 

    

  1. /*******************************************************************************
    2. 

  2. *                                 AMetal
    3. 

  3. *                       ----------------------------
    4. 

  4. *                       innovating embedded platform
    5. 

  5. *
    6. 

  6. * Copyright (c) 2001-2018 Guangzhou ZHIYUAN Electronics Co., Ltd.
    7. 

  7. * All rights reserved.
    8. 

  8. *
    9. 

  9. * Contact information:
    10. 

  10. * web site:    http://www.zlg.cn/
    11. 

  11. *******************************************************************************/
    12. 

  12. 

  13. /**
    14. 

  14.  * \file
    15. 

  15.  * \brief USARTÇý¶¯£¬·þÎñUSART±ê×¼½Ó¿Ú
    16. 

  16.  *
    17. 

  17.  * \internal
    18. 

  18.  * \par Modification History
    19. 

  19.  * - 1.00 17-04-10  ari, first implementation
    20. 

  20.  * \endinternal
    21. 

  21.  */
    22. 

  22. 

  23. #ifndef __AM_STM32F103RBT6_USART_H
    24. 

  24. #define __AM_STM32F103RBT6_USART_H
    25. 

  25. 

  26. #ifdef __cplusplus
    27. 

  27. extern "C" {
    28. 

  28. #endif
    29. 

  29. 

  30. #include "am_uart.h"
    31. 

  31. #include "hw/amhw_stm32f103rbt6_usart.h"
    32. 

  32. 

  33. /**
    34. 

  34.  * \addtogroup am_stm32f103rbt6_if_usart
    35. 

  35.  * \copydoc am_stm32f103rbt6_usart.h
    36. 

  36.  * @{
    37. 

  37.  */
    38. 

  38. 

  39. /**
    40. 

  40.  * \name ´íÎó±àÂëºÅ£¬´íÎó»Øµ÷º¯ÊýµÄcode²ÎÊý£¬ÓÉÇý¶¯´«µÝ¸øÓû§£¬Ö¸Ã÷µ±Ç°µÄ´íÎóÀàÐÍ
    41. 

  41.  *
    42. 

  42.  *  ´íÎó»Øµ÷º¯ÊýµÄ²ÎÊýÔ­ÐÍ£º\n
    43. 

  43.  *  int uart_err(void *p_arg, int code, void *p_data, int size);
    44. 

  44.  *  p_argÊÇÓû§×¢²áµÄÓû§²ÎÊý¡£p_dataºÍsize²»Í¬µÄ´íÎóÀàÐÍ°üº¬µÄÐÅÏ¢ÓÐËù²»Í¬¡£
    45. 

  45.  *  ¿ÉÒÔʹÓÃam_uart_callback_set() º¯ÊýÉèÖô®¿Ú´íÎó»Øµ÷º¯Êý¡£
    46. 

  46.  * @{
    47. 

  47.  */
    48. 

  48. 

  49. /**
    50. 

  50.  * \brief Óû§Ö¸¶¨µÄÆäËüÖжϷ¢Éú,p_dataµÄÀàÐÍΪuint32_t£¬ÖµÎª´®¿ÚµÄÖжÏ״̬£¬·½
    51. 

  51.  *        ±ãÓû§ÅжϾßÌåµÄÖжÏÔ´£¬sizeΪ1¡£
    52. 

  52.  */
    53. 

  53. #define AM_STM32F103RBT6_USART_ERRCODE_USART_OTHER_INT  3
    54. 

  54. 

  55. /**
    56. 

  56.  * \brief ÓÃÓÚÈí¼þÁ÷¿ØµÄXON×Ö·û¶¨Ò壬ĬÈÏ0x11
    57. 

  57.  */
    58. 

  58. #define AM_STM32F103RBT6_USART_XON       0x11
    59. 

  59. 

  60. /**
    61. 

  61.  * \brief ÓÃÓÚÈí¼þÁ÷¿ØµÄXOFF×Ö·û¶¨Ò壬ĬÈÏ0x13
    62. 

  62.  */
    63. 

  63. #define AM_STM32F103RBT6_USART_XOFF      0x13
    64. 

  64. 

  65. /** @} */
    66. 

  66. 

  67. /**
    68. 

  68.  * \brief ´®¿ÚÉ豸ÐÅÏ¢½á¹¹Ì壬¸ÃÉ豸ÐÅÏ¢ÓÃÓÚ´®¿Ú³õʼ»¯
    69. 

  69.  */
    70. 

  70. typedef struct am_stm32f103rbt6_usart_devinfo {
    71. 

  71. 

  72.     uint32_t usart_reg_base;     /**< \brief Ö¸ÏòUSART¼Ä´æÆ÷¿éµÄÖ¸Õë */
    73. 

  73. 

  74.     uint8_t  inum;              /**< \brief ´®¿ÚÖжϺŠ*/
    75. 

  75. 

  76.     int      clk_num;           /**<  \brief ʱÖÓID */
    77. 

  77. 

  78.     /**
    79. 

  79.      * \brief ´®¿ÚÅäÖñêÖ¾£¬AMHW_STM32F103RBT6_USART_DATA_*ºê»òAMHW_STM32F103RBT6_USART_PARITY_*ºê
    80. 

  80.      *        »òAMHW_STM32F103RBT6_USART_STOP_*µÄ»òÖµ
    81. 

  81.      *        (È磺AMHW_STM32F103RBT6_USART_DATA_8BIT|AMHW_STM32F103RBT6_USART_PARITY_NO
    82. 

  82.      *                                       |AMHW_STM32F103RBT6_USART_STOP_1BIT)
    83. 

  83.      */
    84. 

  84.     uint8_t  cfg_flags;
    85. 

  85. 

  86.     uint32_t baud_rate;         /**< \brief ³õʼ»¯²¨ÌØÂÊ */
    87. 

  87. 

  88.     /**
    89. 

  89.      * \brief Ö¸¶¨Ê¹ÄܵÄÆäËüÖжÏ,AMHW_STM32F103RBT6_USART_INT_*ºêÖµ»ò¶à¸öAMHW_STM32F103RBT6_USART_INT_*ºêµÄ
    90. 

  90.      *        »òÖµ£¬³ýÁË(# AMHW_STM32F103RBT6237_USART_INT_TX_EMPTY_ENABLE),
    91. 

  91.      *                (# AMHW_STM32F103RBT6_USART_INT_RX_VAL_ENABLE)ÕâÁ½¸öÖжϡ£
    92. 

  92.      */
    93. 

  93.     uint32_t other_int_enable;
    94. 

  94. 

  95.     /** \brief RS485 ·½Ïò¿ØÖƺ¯Êý, AM_TRUE: ·¢ËÍģʽ£¬ AM_FALSE: ½ÓÊÕģʽ */
    96. 

  96.     void (*pfn_rs485_dir) (am_bool_t is_txmode);
    97. 

  97. 

  98.     void (*pfn_plfm_init)(void);    /**< \brief ƽ̨³õʼ»¯º¯Êý */
    99. 

  99. 

  100.     void (*pfn_plfm_deinit)(void);  /**< \brief ƽ̨ȥ³õʼ»¯º¯Êý */
    101. 

  101. 

  102.     uint32_t  gpio_ck[2];           /**< \brief ck Êä³öÒý½ÅÏà¹Ø¶¨Òå */
    103. 

  103. 

  104.     uint32_t  gpio_cts[2];          /**< \brief cts Êä³öÒý½ÅÏà¹Ø¶¨Òå */
    105. 

  105. 

  106.     uint32_t  gpio_rts[2];          /**< \brief rts ÊäÈëÒý½ÅÏà¹Ø¶¨Òå */
    107. 

  107. 

  108. } am_stm32f103rbt6_usart_devinfo_t;
    109. 

  109. 

  110. /**
    111. 

  111.  * \brief ´®¿ÚÉ豸½á¹¹Ì嶨Òå
    112. 

  112.  */
    113. 

  113. typedef struct am_stm32f103rbt6_usart_dev {
    114. 

  114. 

  115.     am_uart_serv_t  uart_serv; /**< \brief ±ê×¼USART·þÎñ */
    116. 

  116. 

  117.     /** \brief Ö¸ÏòÓû§×¢²áµÄtxchar_getº¯Êý */
    118. 

  118.     int (*pfn_txchar_get)(void *, char *);
    119. 

  119. 

  120.     /** \brief Ö¸ÏòÓû§×¢²áµÄrxchar_putº¯Êý */
    121. 

  121.     int (*pfn_rxchar_put)(void *, char);
    122. 

  122. 

  123.     /** \brief Ö¸ÏòÓû§×¢²áµÄ´íÎó»Øµ÷º¯Êý */
    124. 

  124.     int (*pfn_err)(void *, int, void *, int);
    125. 

  125. 

  126.     void     *txget_arg;                    /**< \brief txchar_getº¯Êý²ÎÊý */
    127. 

  127.     void     *rxput_arg;                    /**< \brief rxchar_putº¯Êý²ÎÊý */
    128. 

  128.     void     *err_arg;                      /**< \brief ´íÎó»Øµ÷º¯ÊýÓû§²ÎÊý */
    129. 

  129. 

  130.     uint8_t   flowctl_mode;                 /**< \brief Á÷¿Øģʽ£¨ÎÞ£¬Èí¼þ£¬Ó²¼þ£©   */
    131. 

  131.     uint8_t   flowctl_tx_stat;              /**< \brief Á÷¿Ø·¢ËÍÆ÷״̬£¨ÓÃÓÚÈíÁ÷¿Ø£© */
    132. 

  132. 

  133.     uint8_t   channel_mode;                 /**< \brief ´®¿Úģʽ ÖжÏ/²éѯ */
    134. 

  134.     uint32_t  baud_rate;                    /**< \brief ´®¿Ú²¨ÌØÂÊ */
    135. 

  135.     uint16_t  options;                      /**< \brief Ó²¼þÉèÖÃÑ¡Ïî */
    136. 

  136. 

  137.     uint32_t  other_int_enable;             /**< \brief Ö¸¶¨Ê¹ÄܵÄÆäËüÖÐ¶Ï */
    138. 

  138. 

  139.     am_bool_t rs485_en;                     /**< \brief ÊÇ·ñʹÄÜÁË 485 ģʽ */
    140. 

  140. 

  141.     const am_stm32f103rbt6_usart_devinfo_t *p_devinfo; /**< \brief Ö¸ÏòÉ豸ÐÅÏ¢³£Á¿µÄÖ¸Õë */
    142. 

  142. 

  143. } am_stm32f103rbt6_usart_dev_t;
    144. 

  144. 

  145. /**
    146. 

  146.  * \brief ³õʼ»¯USART£¬·µ»ØUSART±ê×¼·þÎñ²Ù×÷¾ä±ú
    147. 

  147.  *
    148. 

  148.  * \param[in] p_dev     : Ö¸Ïò´®¿ÚÉ豸µÄÖ¸Õë
    149. 

  149.  * \param[in] p_devinfo : Ö¸Ïò´®¿ÚÉ豸ÐÅÏ¢³£Á¿µÄÖ¸Õë
    150. 

  150.  *
    151. 

  151.  * \return USART±ê×¼·þÎñ²Ù×÷¾ä±ú£¬ÖµÎªNULLʱ±íÃ÷³õʼ»¯Ê§°Ü
    152. 

  152.  */
    153. 

  153. am_uart_handle_t am_stm32f103rbt6_usart_init(am_stm32f103rbt6_usart_dev_t              *p_dev,
    154. 

  154.                                       const am_stm32f103rbt6_usart_devinfo_t    *p_devinfo);
    155. 

  155. 

  156. 

  157. /**
    158. 

  158.  * \brief ´®¿ÚÈ¥³õʼ»¯
    159. 

  159.  *
    160. 

  160.  * \param[in] p_dev     : Ö¸Ïò´®¿ÚÉ豸µÄÖ¸Õë
    161. 

  161.  */
    162. 

  162. void am_stm32f103rbt6_usart_deinit (am_stm32f103rbt6_usart_dev_t *p_dev);
    163. 

  163. /**
    164. 

  164.  * @}
    165. 

  165.  */
    166. 

  166. 

  167. #ifdef __cplusplus
    168. 

  168. }
    169. 

  169. #endif
    170. 

  170. 

  171. #endif /* __AM_STM32F103RBT6_USART_H */
    172. 

  172. 

  173. /* end of file */
    174.