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

   1 /*\r
   2         FreeRTOS.org V5.0.2 - Copyright (C) 2003-2008 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     ***************************************************************************\r
  28     *                                                                         *\r
  29     * SAVE TIME AND MONEY!  We can port FreeRTOS.org to your own hardware,    *\r
  30     * and even write all or part of your application on your behalf.          *\r
  31     * See http://www.OpenRTOS.com for details of the services we provide to   *\r
  32     * expedite your project.                                                  *\r
  33     *                                                                         *\r
  34     ***************************************************************************\r
  35     ***************************************************************************\r
  36 \r
  37         Please ensure to read the configuration and relevant port sections of the\r
  38         online documentation.\r
  39 \r
  40         http://www.FreeRTOS.org - Documentation, latest information, license and \r
  41         contact details.\r
  42 \r
  43         http://www.SafeRTOS.com - A version that is certified for use in safety \r
  44         critical systems.\r
  45 \r
  46         http://www.OpenRTOS.com - Commercial support, development, porting, \r
  47         licensing and training services.\r
  48 */\r
  49 \r
  50 #ifndef SERIAL_COMMS_H\r
  51 #define SERIAL_COMMS_H\r
  52 \r
  53 typedef void * xComPortHandle;\r
  54 \r
  55 typedef enum\r
  56 { \r
  57         serCOM1, \r
  58         serCOM2, \r
  59         serCOM3, \r
  60         serCOM4, \r
  61         serCOM5, \r
  62         serCOM6, \r
  63         serCOM7, \r
  64         serCOM8 \r
  65 } eCOMPort;\r
  66 \r
  67 typedef enum \r
  68 { \r
  69         serNO_PARITY, \r
  70         serODD_PARITY, \r
  71         serEVEN_PARITY, \r
  72         serMARK_PARITY, \r
  73         serSPACE_PARITY \r
  74 } eParity;\r
  75 \r
  76 typedef enum \r
  77 { \r
  78         serSTOP_1, \r
  79         serSTOP_2 \r
  80 } eStopBits;\r
  81 \r
  82 typedef enum \r
  83 { \r
  84         serBITS_5, \r
  85         serBITS_6, \r
  86         serBITS_7, \r
  87         serBITS_8 \r
  88 } eDataBits;\r
  89 \r
  90 typedef enum \r
  91 { \r
  92         ser50,          \r
  93         ser75,          \r
  94         ser110,         \r
  95         ser134,         \r
  96         ser150,    \r
  97         ser200,\r
  98         ser300,         \r
  99         ser600,         \r
 100         ser1200,        \r
 101         ser1800,        \r
 102         ser2400,   \r
 103         ser4800,\r
 104         ser9600,                \r
 105         ser19200,       \r
 106         ser38400,       \r
 107         ser57600,       \r
 108         ser115200\r
 109 } eBaud;\r
 110 \r
 111 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength );\r
 112 xComPortHandle xSerialPortInit( eCOMPort ePort, eBaud eWantedBaud, eParity eWantedParity, eDataBits eWantedDataBits, eStopBits eWantedStopBits, unsigned portBASE_TYPE uxBufferLength );\r
 113 void vSerialPutString( xComPortHandle pxPort, const signed portCHAR * const pcString, unsigned portSHORT usStringLength );\r
 114 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime );\r
 115 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime );\r
 116 portBASE_TYPE xSerialWaitForSemaphore( xComPortHandle xPort );\r
 117 void vSerialClose( xComPortHandle xPort );\r
 118 \r
 119 #endif\r
 120 \r