git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_MPU_LPC54018_MCUXpresso/NXP_Code/component/serial_manager/serial_port_internal.h

   1 /*\r
   2  * Copyright 2019 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_INTERNAL_H__\r
  10 #define __SERIAL_PORT_INTERNAL_H__\r
  11 \r
  12 /*******************************************************************************\r
  13  * Definitions\r
  14  ******************************************************************************/\r
  15 \r
  16 /*******************************************************************************\r
  17  * API\r
  18  ******************************************************************************/\r
  19 \r
  20 #if defined(__cplusplus)\r
  21 extern "C" {\r
  22 #endif /* _cplusplus */\r
  23 \r
  24 #if (defined(SERIAL_PORT_TYPE_UART) && (SERIAL_PORT_TYPE_UART > 0U))\r
  25 serial_manager_status_t Serial_UartInit(serial_handle_t serialHandle, void *serialConfig);\r
  26 serial_manager_status_t Serial_UartDeinit(serial_handle_t serialHandle);\r
  27 serial_manager_status_t Serial_UartWrite(serial_handle_t serialHandle, uint8_t *buffer, uint32_t length);\r
  28 #if !(defined(SERIAL_MANAGER_NON_BLOCKING_MODE) && (SERIAL_MANAGER_NON_BLOCKING_MODE > 0U))\r
  29 serial_manager_status_t Serial_UartRead(serial_handle_t serialHandle, uint8_t *buffer, uint32_t length);\r
  30 #endif\r
  31 \r
  32 #if (defined(SERIAL_MANAGER_NON_BLOCKING_MODE) && (SERIAL_MANAGER_NON_BLOCKING_MODE > 0U))\r
  33 serial_manager_status_t Serial_UartCancelWrite(serial_handle_t serialHandle);\r
  34 serial_manager_status_t Serial_UartInstallTxCallback(serial_handle_t serialHandle,\r
  35                                                      serial_manager_callback_t callback,\r
  36                                                      void *callbackParam);\r
  37 serial_manager_status_t Serial_UartInstallRxCallback(serial_handle_t serialHandle,\r
  38                                                      serial_manager_callback_t callback,\r
  39                                                      void *callbackParam);\r
  40 void Serial_UartIsrFunction(serial_handle_t serialHandle);\r
  41 #endif\r
  42 serial_manager_status_t Serial_UartEnterLowpower(serial_handle_t serialHandle);\r
  43 serial_manager_status_t Serial_UartExitLowpower(serial_handle_t serialHandle);\r
  44 #endif\r
  45 \r
  46 #if (defined(SERIAL_PORT_TYPE_USBCDC) && (SERIAL_PORT_TYPE_USBCDC > 0U))\r
  47 serial_manager_status_t Serial_UsbCdcInit(serial_handle_t serialHandle, void *config);\r
  48 serial_manager_status_t Serial_UsbCdcDeinit(serial_handle_t serialHandle);\r
  49 serial_manager_status_t Serial_UsbCdcWrite(serial_handle_t serialHandle, uint8_t *buffer, uint32_t length);\r
  50 serial_manager_status_t Serial_UsbCdcRead(serial_handle_t serialHandle, uint8_t *buffer, uint32_t length);\r
  51 serial_manager_status_t Serial_UsbCdcCancelWrite(serial_handle_t serialHandle);\r
  52 serial_manager_status_t Serial_UsbCdcInstallTxCallback(serial_handle_t serialHandle,\r
  53                                                        serial_manager_callback_t callback,\r
  54                                                        void *callbackParam);\r
  55 serial_manager_status_t Serial_UsbCdcInstallRxCallback(serial_handle_t serialHandle,\r
  56                                                        serial_manager_callback_t callback,\r
  57                                                        void *callbackParam);\r
  58 void Serial_UsbCdcIsrFunction(serial_handle_t serialHandle);\r
  59 #endif\r
  60 \r
  61 #if (defined(SERIAL_PORT_TYPE_SWO) && (SERIAL_PORT_TYPE_SWO > 0U))\r
  62 serial_manager_status_t Serial_SwoInit(serial_handle_t serialHandle, void *config);\r
  63 serial_manager_status_t Serial_SwoDeinit(serial_handle_t serialHandle);\r
  64 serial_manager_status_t Serial_SwoWrite(serial_handle_t serialHandle, uint8_t *buffer, uint32_t length);\r
  65 #if !(defined(SERIAL_MANAGER_NON_BLOCKING_MODE) && (SERIAL_MANAGER_NON_BLOCKING_MODE > 0U))\r
  66 serial_manager_status_t Serial_SwoRead(serial_handle_t serialHandle, uint8_t *buffer, uint32_t length);\r
  67 #endif\r
  68 #if (defined(SERIAL_MANAGER_NON_BLOCKING_MODE) && (SERIAL_MANAGER_NON_BLOCKING_MODE > 0U))\r
  69 serial_manager_status_t Serial_SwoCancelWrite(serial_handle_t serialHandle);\r
  70 serial_manager_status_t Serial_SwoInstallTxCallback(serial_handle_t serialHandle,\r
  71                                                     serial_manager_callback_t callback,\r
  72                                                     void *callbackParam);\r
  73 serial_manager_status_t Serial_SwoInstallRxCallback(serial_handle_t serialHandle,\r
  74                                                     serial_manager_callback_t callback,\r
  75                                                     void *callbackParam);\r
  76 void Serial_SwoIsrFunction(serial_handle_t serialHandle);\r
  77 #endif\r
  78 #endif\r
  79 \r
  80 #if (defined(SERIAL_PORT_TYPE_USBCDC_VIRTUAL) && (SERIAL_PORT_TYPE_USBCDC_VIRTUAL > 0U))\r
  81 serial_manager_status_t Serial_UsbCdcVirtualInit(serial_handle_t serialHandle, void *config);\r
  82 serial_manager_status_t Serial_UsbCdcVirtualDeinit(serial_handle_t serialHandle);\r
  83 serial_manager_status_t Serial_UsbCdcVirtualWrite(serial_handle_t serialHandle, uint8_t *buffer, uint32_t length);\r
  84 serial_manager_status_t Serial_UsbCdcVirtualRead(serial_handle_t serialHandle, uint8_t *buffer, uint32_t length);\r
  85 serial_manager_status_t Serial_UsbCdcVirtualCancelWrite(serial_handle_t serialHandle);\r
  86 serial_manager_status_t Serial_UsbCdcVirtualInstallTxCallback(serial_handle_t serialHandle,\r
  87                                                               serial_manager_callback_t callback,\r
  88                                                               void *callbackParam);\r
  89 serial_manager_status_t Serial_UsbCdcVirtualInstallRxCallback(serial_handle_t serialHandle,\r
  90                                                               serial_manager_callback_t callback,\r
  91                                                               void *callbackParam);\r
  92 void Serial_UsbCdcVirtualIsrFunction(serial_handle_t serialHandle);\r
  93 #endif\r
  94 \r
  95 #if defined(__cplusplus)\r
  96 }\r
  97 #endif\r
  98 \r
  99 #endif /* __SERIAL_PORT_INTERNAL_H__ */\r