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

   1 /*\r
   2         FreeRTOS V4.0.1 - Copyright (C) 2003-2006 Richard Barry.\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\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 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; 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, 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 */\r
  32 \r
  33 #ifndef SERIAL_COMMS_H\r
  34 #define SERIAL_COMMS_H\r
  35 \r
  36 typedef void * xComPortHandle;\r
  37 \r
  38 typedef enum\r
  39 { \r
  40         serCOM1, \r
  41         serCOM2, \r
  42         serCOM3, \r
  43         serCOM4, \r
  44         serCOM5, \r
  45         serCOM6, \r
  46         serCOM7, \r
  47         serCOM8 \r
  48 } eCOMPort;\r
  49 \r
  50 typedef enum \r
  51 { \r
  52         serNO_PARITY, \r
  53         serODD_PARITY, \r
  54         serEVEN_PARITY, \r
  55         serMARK_PARITY, \r
  56         serSPACE_PARITY \r
  57 } eParity;\r
  58 \r
  59 typedef enum \r
  60 { \r
  61         serSTOP_1, \r
  62         serSTOP_2 \r
  63 } eStopBits;\r
  64 \r
  65 typedef enum \r
  66 { \r
  67         serBITS_5, \r
  68         serBITS_6, \r
  69         serBITS_7, \r
  70         serBITS_8 \r
  71 } eDataBits;\r
  72 \r
  73 typedef enum \r
  74 { \r
  75         ser50,          \r
  76         ser75,          \r
  77         ser110,         \r
  78         ser134,         \r
  79         ser150,    \r
  80         ser200,\r
  81         ser300,         \r
  82         ser600,         \r
  83         ser1200,        \r
  84         ser1800,        \r
  85         ser2400,   \r
  86         ser4800,\r
  87         ser9600,                \r
  88         ser19200,       \r
  89         ser38400,       \r
  90         ser57600,       \r
  91         ser115200\r
  92 } eBaud;\r
  93 \r
  94 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength );\r
  95 xComPortHandle xSerialPortInit( eCOMPort ePort, eBaud eWantedBaud, eParity eWantedParity, eDataBits eWantedDataBits, eStopBits eWantedStopBits, unsigned portBASE_TYPE uxBufferLength );\r
  96 void vSerialPutString( xComPortHandle pxPort, const signed portCHAR * const pcString, unsigned portSHORT usStringLength );\r
  97 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime );\r
  98 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime );\r
  99 portBASE_TYPE xSerialWaitForSemaphore( xComPortHandle xPort );\r
 100 void vSerialClose( xComPortHandle xPort );\r
 101 \r
 102 #endif\r
 103 \r