]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Demo/CORTEX_MPU_M33F_NXP_LPC55S69_MCUXpresso/NXP_Code/component/serial_manager/serial_port_uart.h
commit 9f316c246baafa15c542a5aea81a94f26e3d6507
[freertos] / FreeRTOS / Demo / CORTEX_MPU_M33F_NXP_LPC55S69_MCUXpresso / NXP_Code / component / serial_manager / serial_port_uart.h
index c210b4a376ad2ab52245a98b486a669716a68afb..aa412479d632e2b25b94add5d26c2f73fe7118aa 100644 (file)
@@ -9,39 +9,49 @@
 #ifndef __SERIAL_PORT_UART_H__\r
 #define __SERIAL_PORT_UART_H__\r
 \r
+#include "uart.h"\r
+\r
+/*!\r
+ * @addtogroup serial_port_uart\r
+ * @{\r
+ */\r
+\r
 /*******************************************************************************\r
  * Definitions\r
  ******************************************************************************/\r
-\r
+/*! @brief serial port uart handle size*/\r
 #if (defined(SERIAL_MANAGER_NON_BLOCKING_MODE) && (SERIAL_MANAGER_NON_BLOCKING_MODE > 0U))\r
-#define SERIAL_PORT_UART_HANDLE_SIZE          (166U)\r
+#define SERIAL_PORT_UART_HANDLE_SIZE (76U + HAL_UART_HANDLE_SIZE)\r
 #else\r
-#define SERIAL_PORT_UART_HANDLE_SIZE          (4U)\r
+#define SERIAL_PORT_UART_HANDLE_SIZE (HAL_UART_HANDLE_SIZE)\r
 #endif\r
 \r
+/*! @brief serial port uart parity mode*/\r
 typedef enum _serial_port_uart_parity_mode\r
 {\r
     kSerialManager_UartParityDisabled = 0x0U, /*!< Parity disabled */\r
-    kSerialManager_UartParityEven = 0x1U,     /*!< Parity even enabled */\r
-    kSerialManager_UartParityOdd = 0x2U,      /*!< Parity odd enabled */\r
+    kSerialManager_UartParityEven     = 0x1U, /*!< Parity even enabled */\r
+    kSerialManager_UartParityOdd      = 0x2U, /*!< Parity odd enabled */\r
 } serial_port_uart_parity_mode_t;\r
 \r
+/*! @brief serial port uart stop bit count*/\r
 typedef enum _serial_port_uart_stop_bit_count\r
 {\r
     kSerialManager_UartOneStopBit = 0U, /*!< One stop bit */\r
     kSerialManager_UartTwoStopBit = 1U, /*!< Two stop bits */\r
 } serial_port_uart_stop_bit_count_t;\r
 \r
+/*! @brief serial port uart config struct*/\r
 typedef struct _serial_port_uart_config\r
 {\r
-    uint32_t clockRate;                                 /*!< clock rate  */\r
-    uint32_t baudRate;                                  /*!< baud rate  */\r
-    serial_port_uart_parity_mode_t parityMode;          /*!< Parity mode, disabled (default), even, odd */\r
-    serial_port_uart_stop_bit_count_t stopBitCount;     /*!< Number of stop bits, 1 stop bit (default) or 2 stop bits  */\r
-    uint8_t instance;                                   /*!< Instance (0 - UART0, 1 - UART1, ...), detail information\r
-                                                             please refer to the SOC corresponding RM. */\r
-    uint8_t enableRx;                                   /*!< Enable RX */\r
-    uint8_t enableTx;                                   /*!< Enable TX */\r
+    uint32_t clockRate;                             /*!< clock rate  */\r
+    uint32_t baudRate;                              /*!< baud rate  */\r
+    serial_port_uart_parity_mode_t parityMode;      /*!< Parity mode, disabled (default), even, odd */\r
+    serial_port_uart_stop_bit_count_t stopBitCount; /*!< Number of stop bits, 1 stop bit (default) or 2 stop bits  */\r
+    uint8_t instance;                               /*!< Instance (0 - UART0, 1 - UART1, ...), detail information\r
+                                                         please refer to the SOC corresponding RM. */\r
+    uint8_t enableRx;                               /*!< Enable RX */\r
+    uint8_t enableTx;                               /*!< Enable TX */\r
 } serial_port_uart_config_t;\r
-\r
+/*! @} */\r
 #endif /* __SERIAL_PORT_UART_H__ */\r