git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M4_ATSAM4S_Atmel_Studio/src/Common-Demo-Source/include/demo_serial.h

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