git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M0+_LPC51U68_LPCXpresso/component/serial_manager/serial_port_uart.h

   1 /*\r
   2  * Copyright 2018 NXP\r
   3  * All rights reserved.\r
   4  *\r
   5  *\r
   6  * SPDX-License-Identifier: BSD-3-Clause\r
   7  */\r
   8 \r
   9 #ifndef __SERIAL_PORT_UART_H__\r
  10 #define __SERIAL_PORT_UART_H__\r
  11 \r
  12 /*!\r
  13  * @addtogroup serial_port_uart\r
  14  * @{\r
  15  */\r
  16 \r
  17 /*******************************************************************************\r
  18  * Definitions\r
  19  ******************************************************************************/\r
  20 /*! @brief serial port uart handle size*/\r
  21 #if (defined(SERIAL_MANAGER_NON_BLOCKING_MODE) && (SERIAL_MANAGER_NON_BLOCKING_MODE > 0U))\r
  22 #define SERIAL_PORT_UART_HANDLE_SIZE (166U)\r
  23 #else\r
  24 #define SERIAL_PORT_UART_HANDLE_SIZE (4U)\r
  25 #endif\r
  26 \r
  27 /*! @brief serial port uart parity mode*/\r
  28 typedef enum _serial_port_uart_parity_mode\r
  29 {\r
  30     kSerialManager_UartParityDisabled = 0x0U, /*!< Parity disabled */\r
  31     kSerialManager_UartParityEven     = 0x1U, /*!< Parity even enabled */\r
  32     kSerialManager_UartParityOdd      = 0x2U, /*!< Parity odd enabled */\r
  33 } serial_port_uart_parity_mode_t;\r
  34 \r
  35 /*! @brief serial port uart stop bit count*/\r
  36 typedef enum _serial_port_uart_stop_bit_count\r
  37 {\r
  38     kSerialManager_UartOneStopBit = 0U, /*!< One stop bit */\r
  39     kSerialManager_UartTwoStopBit = 1U, /*!< Two stop bits */\r
  40 } serial_port_uart_stop_bit_count_t;\r
  41 \r
  42 /*! @brief serial port uart config struct*/\r
  43 typedef struct _serial_port_uart_config\r
  44 {\r
  45     uint32_t clockRate;                             /*!< clock rate  */\r
  46     uint32_t baudRate;                              /*!< baud rate  */\r
  47     serial_port_uart_parity_mode_t parityMode;      /*!< Parity mode, disabled (default), even, odd */\r
  48     serial_port_uart_stop_bit_count_t stopBitCount; /*!< Number of stop bits, 1 stop bit (default) or 2 stop bits  */\r
  49     uint8_t instance;                               /*!< Instance (0 - UART0, 1 - UART1, ...), detail information\r
  50                                                          please refer to the SOC corresponding RM. */\r
  51     uint8_t enableRx;                               /*!< Enable RX */\r
  52     uint8_t enableTx;                               /*!< Enable TX */\r
  53 } serial_port_uart_config_t;\r
  54 /*! @} */\r
  55 #endif /* __SERIAL_PORT_UART_H__ */\r