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

   1 /*\r
   2     FreeRTOS V9.0.0rc2 - Copyright (C) 2016 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     This file is part of the FreeRTOS distribution.\r
   8 \r
   9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  10     the terms of the GNU General Public License (version 2) as published by the\r
  11     Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.\r
  12 \r
  13     ***************************************************************************\r
  14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  16     >>!   obliged to provide the source code for proprietary components     !<<\r
  17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  18     ***************************************************************************\r
  19 \r
  20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  23     link: http://www.freertos.org/a00114.html\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    FreeRTOS provides completely free yet professionally developed,    *\r
  28      *    robust, strictly quality controlled, supported, and cross          *\r
  29      *    platform software that is more than just the market leader, it     *\r
  30      *    is the industry's de facto standard.                               *\r
  31      *                                                                       *\r
  32      *    Help yourself get started quickly while simultaneously helping     *\r
  33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  34      *    tutorial book, reference manual, or both:                          *\r
  35      *    http://www.FreeRTOS.org/Documentation                              *\r
  36      *                                                                       *\r
  37     ***************************************************************************\r
  38 \r
  39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
  40     the FAQ page "My application does not run, what could be wrong?".  Have you\r
  41     defined configASSERT()?\r
  42 \r
  43     http://www.FreeRTOS.org/support - In return for receiving this top quality\r
  44     embedded software for free we request you assist our global community by\r
  45     participating in the support forum.\r
  46 \r
  47     http://www.FreeRTOS.org/training - Investing in training allows your team to\r
  48     be as productive as possible as early as possible.  Now you can receive\r
  49     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
  50     Ltd, and the world's leading authority on the world's leading RTOS.\r
  51 \r
  52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  55 \r
  56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  58 \r
  59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
  60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  61     licenses offer ticketed support, indemnification and commercial middleware.\r
  62 \r
  63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  64     engineered and independently SIL3 certified version for use in safety and\r
  65     mission critical applications that require provable dependability.\r
  66 \r
  67     1 tab == 4 spaces!\r
  68 */\r
  69 \r
  70 #ifndef USB_CDC_H\r
  71 #define USB_CDC_H\r
  72 \r
  73 #include "usb.h"\r
  74 \r
  75 #define USB_CDC_QUEUE_SIZE    200\r
  76 \r
  77 /* Structure used to take a snapshot of the USB status from within the ISR. */\r
  78 typedef struct X_ISR_STATUS\r
  79 {\r
  80         unsigned long ulISR;\r
  81         unsigned long ulCSR0;\r
  82         unsigned char ucFifoData[ 8 ];\r
  83 } xISRStatus;\r
  84 \r
  85 /* Structure used to hold the received requests. */\r
  86 typedef struct \r
  87 {\r
  88         unsigned char ucReqType;\r
  89         unsigned char ucRequest;\r
  90         unsigned short usValue;\r
  91         unsigned short usIndex;\r
  92         unsigned short usLength;\r
  93 } xUSB_REQUEST;\r
  94 \r
  95 typedef enum\r
  96 {\r
  97         eNOTHING,\r
  98         eJUST_RESET,\r
  99         eJUST_GOT_CONFIG,\r
 100         eJUST_GOT_ADDRESS,\r
 101         eSENDING_EVEN_DESCRIPTOR,\r
 102         eREADY_TO_SEND\r
 103 } eDRIVER_STATE;\r
 104 \r
 105 /* Structure used to control the data being sent to the host. */\r
 106 typedef struct\r
 107 {\r
 108         unsigned char ucBuffer[ usbMAX_CONTROL_MESSAGE_SIZE ];\r
 109         unsigned long ulNextCharIndex;\r
 110         unsigned long ulTotalDataLength;\r
 111 } xCONTROL_MESSAGE;\r
 112 \r
 113 /*-----------------------------------------------------------*/\r
 114 void vUSBCDCTask( void *pvParameters );\r
 115 \r
 116 /* Send cByte down the USB port.  Characters are simply buffered and not\r
 117 sent unless the port is connected. */\r
 118 void vUSBSendByte( char cByte );\r
 119 \r
 120 \r
 121 #endif\r
 122 \r
 123 \r