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

   1 /*\r
   2  * FreeRTOS Kernel V10.0.0\r
   3  * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software. If you wish to use our Amazon\r
  14  * FreeRTOS name, please do so in a fair use way that does not cause confusion.\r
  15  *\r
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  18  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  19  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  20  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  22  *\r
  23  * http://www.FreeRTOS.org\r
  24  * http://aws.amazon.com/freertos\r
  25  *\r
  26  * 1 tab == 4 spaces!\r
  27  */\r
  28 \r
  29 #ifndef USB_CDC_H\r
  30 #define USB_CDC_H\r
  31 \r
  32 #include "usb.h"\r
  33 \r
  34 #define USB_CDC_QUEUE_SIZE    200\r
  35 \r
  36 /* Structure used to take a snapshot of the USB status from within the ISR. */\r
  37 typedef struct X_ISR_STATUS\r
  38 {\r
  39         unsigned long ulISR;\r
  40         unsigned long ulCSR0;\r
  41         unsigned char ucFifoData[ 8 ];\r
  42 } xISRStatus;\r
  43 \r
  44 /* Structure used to hold the received requests. */\r
  45 typedef struct \r
  46 {\r
  47         unsigned char ucReqType;\r
  48         unsigned char ucRequest;\r
  49         unsigned short usValue;\r
  50         unsigned short usIndex;\r
  51         unsigned short usLength;\r
  52 } xUSB_REQUEST;\r
  53 \r
  54 typedef enum\r
  55 {\r
  56         eNOTHING,\r
  57         eJUST_RESET,\r
  58         eJUST_GOT_CONFIG,\r
  59         eJUST_GOT_ADDRESS,\r
  60         eSENDING_EVEN_DESCRIPTOR,\r
  61         eREADY_TO_SEND\r
  62 } eDRIVER_STATE;\r
  63 \r
  64 /* Structure used to control the data being sent to the host. */\r
  65 typedef struct\r
  66 {\r
  67         unsigned char ucBuffer[ usbMAX_CONTROL_MESSAGE_SIZE ];\r
  68         unsigned long ulNextCharIndex;\r
  69         unsigned long ulTotalDataLength;\r
  70 } xCONTROL_MESSAGE;\r
  71 \r
  72 /*-----------------------------------------------------------*/\r
  73 void vUSBCDCTask( void *pvParameters );\r
  74 \r
  75 /* Send cByte down the USB port.  Characters are simply buffered and not\r
  76 sent unless the port is connected. */\r
  77 void vUSBSendByte( char cByte );\r
  78 \r
  79 \r
  80 #endif\r
  81 \r
  82 \r