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

   1 /*\r
   2         FreeRTOS.org V4.2.1 - Copyright (C) 2003-2007 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS.org distribution.\r
   5 \r
   6         FreeRTOS.org is free software; you can redistribute it and/or modify\r
   7         it under the terms of the GNU General Public License as published by\r
   8         the Free Software Foundation; either version 2 of the License, or\r
   9         (at your option) any later version.\r
  10 \r
  11         FreeRTOS.org is distributed in the hope that it will be useful,\r
  12         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14         GNU General Public License for more details.\r
  15 \r
  16         You should have received a copy of the GNU General Public License\r
  17         along with FreeRTOS.org; if not, write to the Free Software\r
  18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19 \r
  20         A special exception to the GPL can be applied should you wish to distribute\r
  21         a combined work that includes FreeRTOS.org, without being obliged to provide\r
  22         the source code for any proprietary components.  See the licensing section \r
  23         of http://www.FreeRTOS.org for full details of how and when the exception\r
  24         can be applied.\r
  25 \r
  26         ***************************************************************************\r
  27         See http://www.FreeRTOS.org for documentation, latest information, license \r
  28         and contact details.  Please ensure to read the configuration and relevant \r
  29         port sections of the online documentation.\r
  30 \r
  31         Also see http://www.SafeRTOS.com for an IEC 61508 compliant version along\r
  32         with commercial development and support options.\r
  33         ***************************************************************************\r
  34 */\r
  35 \r
  36 #ifndef SERIAL_COMMS_H\r
  37 #define SERIAL_COMMS_H\r
  38 \r
  39 typedef void * xComPortHandle;\r
  40 \r
  41 typedef enum\r
  42 { \r
  43         serCOM1, \r
  44         serCOM2, \r
  45         serCOM3, \r
  46         serCOM4, \r
  47         serCOM5, \r
  48         serCOM6, \r
  49         serCOM7, \r
  50         serCOM8 \r
  51 } eCOMPort;\r
  52 \r
  53 typedef enum \r
  54 { \r
  55         serNO_PARITY, \r
  56         serODD_PARITY, \r
  57         serEVEN_PARITY, \r
  58         serMARK_PARITY, \r
  59         serSPACE_PARITY \r
  60 } eParity;\r
  61 \r
  62 typedef enum \r
  63 { \r
  64         serSTOP_1, \r
  65         serSTOP_2 \r
  66 } eStopBits;\r
  67 \r
  68 typedef enum \r
  69 { \r
  70         serBITS_5, \r
  71         serBITS_6, \r
  72         serBITS_7, \r
  73         serBITS_8 \r
  74 } eDataBits;\r
  75 \r
  76 typedef enum \r
  77 { \r
  78         ser50,          \r
  79         ser75,          \r
  80         ser110,         \r
  81         ser134,         \r
  82         ser150,    \r
  83         ser200,\r
  84         ser300,         \r
  85         ser600,         \r
  86         ser1200,        \r
  87         ser1800,        \r
  88         ser2400,   \r
  89         ser4800,\r
  90         ser9600,                \r
  91         ser19200,       \r
  92         ser38400,       \r
  93         ser57600,       \r
  94         ser115200\r
  95 } eBaud;\r
  96 \r
  97 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength );\r
  98 xComPortHandle xSerialPortInit( eCOMPort ePort, eBaud eWantedBaud, eParity eWantedParity, eDataBits eWantedDataBits, eStopBits eWantedStopBits, unsigned portBASE_TYPE uxBufferLength );\r
  99 void vSerialPutString( xComPortHandle pxPort, const signed portCHAR * const pcString, unsigned portSHORT usStringLength );\r
 100 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime );\r
 101 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime );\r
 102 portBASE_TYPE xSerialWaitForSemaphore( xComPortHandle xPort );\r
 103 void vSerialClose( xComPortHandle xPort );\r
 104 \r
 105 #endif\r
 106 \r