git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/lwIP_Demo_Rowley_ARM7/USB/USB-CDC.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 USB_CDC_H\r
  67 #define USB_CDC_H\r
  68 \r
  69 #include "usb.h"\r
  70 \r
  71 #define USB_CDC_QUEUE_SIZE    200\r
  72 \r
  73 /* Structure used to take a snapshot of the USB status from within the ISR. */\r
  74 typedef struct X_ISR_STATUS\r
  75 {\r
  76         unsigned long ulISR;\r
  77         unsigned long ulCSR0;\r
  78         unsigned char ucFifoData[ 8 ];\r
  79 } xISRStatus;\r
  80 \r
  81 /* Structure used to hold the received requests. */\r
  82 typedef struct \r
  83 {\r
  84         unsigned char ucReqType;\r
  85         unsigned char ucRequest;\r
  86         unsigned short usValue;\r
  87         unsigned short usIndex;\r
  88         unsigned short usLength;\r
  89 } xUSB_REQUEST;\r
  90 \r
  91 typedef enum\r
  92 {\r
  93         eNOTHING,\r
  94         eJUST_RESET,\r
  95         eJUST_GOT_CONFIG,\r
  96         eJUST_GOT_ADDRESS,\r
  97         eSENDING_EVEN_DESCRIPTOR,\r
  98         eREADY_TO_SEND\r
  99 } eDRIVER_STATE;\r
 100 \r
 101 /* Structure used to control the data being sent to the host. */\r
 102 typedef struct\r
 103 {\r
 104         unsigned char ucBuffer[ usbMAX_CONTROL_MESSAGE_SIZE ];\r
 105         unsigned long ulNextCharIndex;\r
 106         unsigned long ulTotalDataLength;\r
 107 } xCONTROL_MESSAGE;\r
 108 \r
 109 /*-----------------------------------------------------------*/\r
 110 void vUSBCDCTask( void *pvParameters );\r
 111 \r
 112 /* Send cByte down the USB port.  Characters are simply buffered and not\r
 113 sent unless the port is connected. */\r
 114 void vUSBSendByte( char cByte );\r
 115 \r
 116 \r
 117 #endif\r
 118 \r
 119 \r