begriffs open source - cmsis-freertos/blob - Demo/Common/include/serial.h

   1 /*
   2  * FreeRTOS Kernel V10.2.1
   3  * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   6  * this software and associated documentation files (the "Software"), to deal in
   7  * the Software without restriction, including without limitation the rights to
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
   9  * the Software, and to permit persons to whom the Software is furnished to do so,
  10  * subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in all
  13  * copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * http://www.FreeRTOS.org
  23  * http://aws.amazon.com/freertos
  24  *
  25  * 1 tab == 4 spaces!
  26  */
  27
  28 #ifndef SERIAL_COMMS_H
  29 #define SERIAL_COMMS_H
  30
  31 typedef void * xComPortHandle;
  32
  33 typedef enum
  34 {
  35         serCOM1,
  36         serCOM2,
  37         serCOM3,
  38         serCOM4,
  39         serCOM5,
  40         serCOM6,
  41         serCOM7,
  42         serCOM8
  43 } eCOMPort;
  44
  45 typedef enum
  46 {
  47         serNO_PARITY,
  48         serODD_PARITY,
  49         serEVEN_PARITY,
  50         serMARK_PARITY,
  51         serSPACE_PARITY
  52 } eParity;
  53
  54 typedef enum
  55 {
  56         serSTOP_1,
  57         serSTOP_2
  58 } eStopBits;
  59
  60 typedef enum
  61 {
  62         serBITS_5,
  63         serBITS_6,
  64         serBITS_7,
  65         serBITS_8
  66 } eDataBits;
  67
  68 typedef enum
  69 {
  70         ser50,
  71         ser75,
  72         ser110,
  73         ser134,
  74         ser150,
  75         ser200,
  76         ser300,
  77         ser600,
  78         ser1200,
  79         ser1800,
  80         ser2400,
  81         ser4800,
  82         ser9600,
  83         ser19200,
  84         ser38400,
  85         ser57600,
  86         ser115200
  87 } eBaud;
  88
  89 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength );
  90 xComPortHandle xSerialPortInit( eCOMPort ePort, eBaud eWantedBaud, eParity eWantedParity, eDataBits eWantedDataBits, eStopBits eWantedStopBits, unsigned portBASE_TYPE uxBufferLength );
  91 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength );
  92 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, TickType_t xBlockTime );
  93 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, TickType_t xBlockTime );
  94 portBASE_TYPE xSerialWaitForSemaphore( xComPortHandle xPort );
  95 void vSerialClose( xComPortHandle xPort );
  96
  97 #endif
  98