begriffs open source - freertos/blob - Demo/Common/include/serial.h

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