git.sur5r.net Git - freertos/blob - Demo/Common/include/serial.h

   1 /*\r
   2         FreeRTOS V5.4.2 - Copyright (C) 2009 Real Time Engineers Ltd.\r
   3 \r
   4         This file is part of the FreeRTOS distribution.\r
   5 \r
   6         FreeRTOS is free software; you can redistribute it and/or modify it     under \r
   7         the terms of the GNU General Public License (version 2) as published by the \r
   8         Free Software Foundation and modified by the FreeRTOS exception.\r
   9         **NOTE** The exception to the GPL is included to allow you to distribute a\r
  10         combined work that includes FreeRTOS without being obliged to provide the \r
  11         source code for proprietary components outside of the FreeRTOS kernel.  \r
  12         Alternative commercial license and support terms are also available upon \r
  13         request.  See the licensing section of http://www.FreeRTOS.org for full \r
  14         license details.\r
  15 \r
  16         FreeRTOS is distributed in the hope that it will be useful,     but WITHOUT\r
  17         ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  18         FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  19         more details.\r
  20 \r
  21         You should have received a copy of the GNU General Public License along\r
  22         with FreeRTOS; if not, write to the Free Software Foundation, Inc., 59\r
  23         Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
  24 \r
  25 \r
  26         ***************************************************************************\r
  27         *                                                                         *\r
  28         * Looking for a quick start?  Then check out the FreeRTOS eBook!          *\r
  29         * See http://www.FreeRTOS.org/Documentation for details                   *\r
  30         *                                                                         *\r
  31         ***************************************************************************\r
  32 \r
  33         1 tab == 4 spaces!\r
  34 \r
  35         Please ensure to read the configuration and relevant port sections of the\r
  36         online documentation.\r
  37 \r
  38         http://www.FreeRTOS.org - Documentation, latest information, license and\r
  39         contact details.\r
  40 \r
  41         http://www.SafeRTOS.com - A version that is certified for use in safety\r
  42         critical systems.\r
  43 \r
  44         http://www.OpenRTOS.com - Commercial support, development, porting,\r
  45         licensing and training services.\r
  46 */\r
  47 \r
  48 #ifndef SERIAL_COMMS_H\r
  49 #define SERIAL_COMMS_H\r
  50 \r
  51 typedef void * xComPortHandle;\r
  52 \r
  53 typedef enum\r
  54 { \r
  55         serCOM1, \r
  56         serCOM2, \r
  57         serCOM3, \r
  58         serCOM4, \r
  59         serCOM5, \r
  60         serCOM6, \r
  61         serCOM7, \r
  62         serCOM8 \r
  63 } eCOMPort;\r
  64 \r
  65 typedef enum \r
  66 { \r
  67         serNO_PARITY, \r
  68         serODD_PARITY, \r
  69         serEVEN_PARITY, \r
  70         serMARK_PARITY, \r
  71         serSPACE_PARITY \r
  72 } eParity;\r
  73 \r
  74 typedef enum \r
  75 { \r
  76         serSTOP_1, \r
  77         serSTOP_2 \r
  78 } eStopBits;\r
  79 \r
  80 typedef enum \r
  81 { \r
  82         serBITS_5, \r
  83         serBITS_6, \r
  84         serBITS_7, \r
  85         serBITS_8 \r
  86 } eDataBits;\r
  87 \r
  88 typedef enum \r
  89 { \r
  90         ser50,          \r
  91         ser75,          \r
  92         ser110,         \r
  93         ser134,         \r
  94         ser150,    \r
  95         ser200,\r
  96         ser300,         \r
  97         ser600,         \r
  98         ser1200,        \r
  99         ser1800,        \r
 100         ser2400,   \r
 101         ser4800,\r
 102         ser9600,                \r
 103         ser19200,       \r
 104         ser38400,       \r
 105         ser57600,       \r
 106         ser115200\r
 107 } eBaud;\r
 108 \r
 109 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength );\r
 110 xComPortHandle xSerialPortInit( eCOMPort ePort, eBaud eWantedBaud, eParity eWantedParity, eDataBits eWantedDataBits, eStopBits eWantedStopBits, unsigned portBASE_TYPE uxBufferLength );\r
 111 void vSerialPutString( xComPortHandle pxPort, const signed portCHAR * const pcString, unsigned portSHORT usStringLength );\r
 112 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime );\r
 113 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime );\r
 114 portBASE_TYPE xSerialWaitForSemaphore( xComPortHandle xPort );\r
 115 void vSerialClose( xComPortHandle xPort );\r
 116 \r
 117 #endif\r
 118 \r