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

   1 /*\r
   2     FreeRTOS V8.1.2 - Copyright (C) 2014 Real Time Engineers Ltd. \r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  28     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  29     >>!   obliged to provide the source code for proprietary components     !<<\r
  30     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 #ifndef SERIAL_COMMS_H\r
  67 #define SERIAL_COMMS_H\r
  68 \r
  69 typedef void * xComPortHandle;\r
  70 \r
  71 typedef enum\r
  72 { \r
  73         serCOM1, \r
  74         serCOM2, \r
  75         serCOM3, \r
  76         serCOM4, \r
  77         serCOM5, \r
  78         serCOM6, \r
  79         serCOM7, \r
  80         serCOM8 \r
  81 } eCOMPort;\r
  82 \r
  83 typedef enum \r
  84 { \r
  85         serNO_PARITY, \r
  86         serODD_PARITY, \r
  87         serEVEN_PARITY, \r
  88         serMARK_PARITY, \r
  89         serSPACE_PARITY \r
  90 } eParity;\r
  91 \r
  92 typedef enum \r
  93 { \r
  94         serSTOP_1, \r
  95         serSTOP_2 \r
  96 } eStopBits;\r
  97 \r
  98 typedef enum \r
  99 { \r
 100         serBITS_5, \r
 101         serBITS_6, \r
 102         serBITS_7, \r
 103         serBITS_8 \r
 104 } eDataBits;\r
 105 \r
 106 typedef enum \r
 107 { \r
 108         ser50,          \r
 109         ser75,          \r
 110         ser110,         \r
 111         ser134,         \r
 112         ser150,    \r
 113         ser200,\r
 114         ser300,         \r
 115         ser600,         \r
 116         ser1200,        \r
 117         ser1800,        \r
 118         ser2400,   \r
 119         ser4800,\r
 120         ser9600,                \r
 121         ser19200,       \r
 122         ser38400,       \r
 123         ser57600,       \r
 124         ser115200\r
 125 } eBaud;\r
 126 \r
 127 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength );\r
 128 xComPortHandle xSerialPortInit( eCOMPort ePort, eBaud eWantedBaud, eParity eWantedParity, eDataBits eWantedDataBits, eStopBits eWantedStopBits, unsigned portBASE_TYPE uxBufferLength );\r
 129 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength );\r
 130 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, TickType_t xBlockTime );\r
 131 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, TickType_t xBlockTime );\r
 132 portBASE_TYPE xSerialWaitForSemaphore( xComPortHandle xPort );\r
 133 void vSerialClose( xComPortHandle xPort );\r
 134 \r
 135 #endif\r
 136 \r