git.sur5r.net Git - freertos/blob - Demo/lwIP_Demo_Rowley_ARM7/USB/USB-CDC.h

   1 /*\r
   2         FreeRTOS V4.0.1 - copyright (C) 2003-2006 Richard Barry.\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\r
   7         it under the terms of the GNU General Public License as published by\r
   8         the Free Software Foundation; either version 2 of the License, or\r
   9         (at your option) any later version.\r
  10 \r
  11         FreeRTOS is distributed in the hope that it will be useful,\r
  12         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14         GNU General Public License for more details.\r
  15 \r
  16         You should have received a copy of the GNU General Public License\r
  17         along with FreeRTOS; if not, write to the Free Software\r
  18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19 \r
  20         A special exception to the GPL can be applied should you wish to distribute\r
  21         a combined work that includes FreeRTOS, without being obliged to provide\r
  22         the source code for any proprietary components.  See the licensing section\r
  23         of http://www.FreeRTOS.org for full details of how and when the exception\r
  24         can be applied.\r
  25 \r
  26         ***************************************************************************\r
  27         See http://www.FreeRTOS.org for documentation, latest information, license\r
  28         and contact details.  Please ensure to read the configuration and relevant\r
  29         port sections of the online documentation.\r
  30         ***************************************************************************\r
  31 */\r
  32 \r
  33 #ifndef USB_CDC_H\r
  34 #define USB_CDC_H\r
  35 \r
  36 #include "usb.h"\r
  37 \r
  38 #define USB_CDC_QUEUE_SIZE    200\r
  39 \r
  40 /* Structure used to take a snapshot of the USB status from within the ISR. */\r
  41 typedef struct X_ISR_STATUS\r
  42 {\r
  43         unsigned portLONG ulISR;\r
  44         unsigned portLONG ulCSR0;\r
  45         unsigned portCHAR ucFifoData[ 8 ];\r
  46 } xISRStatus;\r
  47 \r
  48 /* Structure used to hold the received requests. */\r
  49 typedef struct \r
  50 {\r
  51         unsigned portCHAR ucReqType;\r
  52         unsigned portCHAR ucRequest;\r
  53         unsigned portSHORT usValue;\r
  54         unsigned portSHORT usIndex;\r
  55         unsigned portSHORT usLength;\r
  56 } xUSB_REQUEST;\r
  57 \r
  58 typedef enum\r
  59 {\r
  60         eNOTHING,\r
  61         eJUST_RESET,\r
  62         eJUST_GOT_CONFIG,\r
  63         eJUST_GOT_ADDRESS,\r
  64         eSENDING_EVEN_DESCRIPTOR,\r
  65         eREADY_TO_SEND\r
  66 } eDRIVER_STATE;\r
  67 \r
  68 /* Structure used to control the data being sent to the host. */\r
  69 typedef struct\r
  70 {\r
  71         unsigned portCHAR ucBuffer[ usbMAX_CONTROL_MESSAGE_SIZE ];\r
  72         unsigned portLONG ulNextCharIndex;\r
  73         unsigned portLONG ulTotalDataLength;\r
  74 } xCONTROL_MESSAGE;\r
  75 \r
  76 /*-----------------------------------------------------------*/\r
  77 void vUSBCDCTask( void *pvParameters );\r
  78 \r
  79 /* Send cByte down the USB port.  Characters are simply buffered and not\r
  80 sent unless the port is connected. */\r
  81 void vUSBSendByte( portCHAR cByte );\r
  82 \r
  83 \r
  84 #endif\r
  85 \r
  86 \r