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

   1 /*\r
   2     FreeRTOS V6.1.0 - Copyright (C) 2010 Real Time Engineers Ltd.\r
   3 \r
   4     ***************************************************************************\r
   5     *                                                                         *\r
   6     * If you are:                                                             *\r
   7     *                                                                         *\r
   8     *    + New to FreeRTOS,                                                   *\r
   9     *    + Wanting to learn FreeRTOS or multitasking in general quickly       *\r
  10     *    + Looking for basic training,                                        *\r
  11     *    + Wanting to improve your FreeRTOS skills and productivity           *\r
  12     *                                                                         *\r
  13     * then take a look at the FreeRTOS books - available as PDF or paperback  *\r
  14     *                                                                         *\r
  15     *        "Using the FreeRTOS Real Time Kernel - a Practical Guide"        *\r
  16     *                  http://www.FreeRTOS.org/Documentation                  *\r
  17     *                                                                         *\r
  18     * A pdf reference manual is also available.  Both are usually delivered   *\r
  19     * to your inbox within 20 minutes to two hours when purchased between 8am *\r
  20     * and 8pm GMT (although please allow up to 24 hours in case of            *\r
  21     * exceptional circumstances).  Thank you for your support!                *\r
  22     *                                                                         *\r
  23     ***************************************************************************\r
  24 \r
  25     This file is part of the FreeRTOS distribution.\r
  26 \r
  27     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  28     the terms of the GNU General Public License (version 2) as published by the\r
  29     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  30     ***NOTE*** The exception to the GPL is included to allow you to distribute\r
  31     a combined work that includes FreeRTOS without being obliged to provide the\r
  32     source code for proprietary components outside of the FreeRTOS kernel.\r
  33     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT\r
  34     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  35     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  36     more details. You should have received a copy of the GNU General Public \r
  37     License and the FreeRTOS license exception along with FreeRTOS; if not it \r
  38     can be viewed here: http://www.freertos.org/a00114.html and also obtained \r
  39     by writing to Richard Barry, contact details for whom are available on the\r
  40     FreeRTOS WEB site.\r
  41 \r
  42     1 tab == 4 spaces!\r
  43 \r
  44     http://www.FreeRTOS.org - Documentation, latest information, license and\r
  45     contact details.\r
  46 \r
  47     http://www.SafeRTOS.com - A version that is certified for use in safety\r
  48     critical systems.\r
  49 \r
  50     http://www.OpenRTOS.com - Commercial support, development, porting,\r
  51     licensing and training services.\r
  52 */\r
  53 \r
  54 #ifndef SERIAL_COMMS_H\r
  55 #define SERIAL_COMMS_H\r
  56 \r
  57 typedef void * xComPortHandle;\r
  58 \r
  59 typedef enum\r
  60 { \r
  61         serCOM1, \r
  62         serCOM2, \r
  63         serCOM3, \r
  64         serCOM4, \r
  65         serCOM5, \r
  66         serCOM6, \r
  67         serCOM7, \r
  68         serCOM8 \r
  69 } eCOMPort;\r
  70 \r
  71 typedef enum \r
  72 { \r
  73         serNO_PARITY, \r
  74         serODD_PARITY, \r
  75         serEVEN_PARITY, \r
  76         serMARK_PARITY, \r
  77         serSPACE_PARITY \r
  78 } eParity;\r
  79 \r
  80 typedef enum \r
  81 { \r
  82         serSTOP_1, \r
  83         serSTOP_2 \r
  84 } eStopBits;\r
  85 \r
  86 typedef enum \r
  87 { \r
  88         serBITS_5, \r
  89         serBITS_6, \r
  90         serBITS_7, \r
  91         serBITS_8 \r
  92 } eDataBits;\r
  93 \r
  94 typedef enum \r
  95 { \r
  96         ser50,          \r
  97         ser75,          \r
  98         ser110,         \r
  99         ser134,         \r
 100         ser150,    \r
 101         ser200,\r
 102         ser300,         \r
 103         ser600,         \r
 104         ser1200,        \r
 105         ser1800,        \r
 106         ser2400,   \r
 107         ser4800,\r
 108         ser9600,                \r
 109         ser19200,       \r
 110         ser38400,       \r
 111         ser57600,       \r
 112         ser115200\r
 113 } eBaud;\r
 114 \r
 115 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength );\r
 116 xComPortHandle xSerialPortInit( eCOMPort ePort, eBaud eWantedBaud, eParity eWantedParity, eDataBits eWantedDataBits, eStopBits eWantedStopBits, unsigned portBASE_TYPE uxBufferLength );\r
 117 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength );\r
 118 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime );\r
 119 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime );\r
 120 portBASE_TYPE xSerialWaitForSemaphore( xComPortHandle xPort );\r
 121 void vSerialClose( xComPortHandle xPort );\r
 122 \r
 123 #endif\r
 124 \r