git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/ARM7_AT91SAM7X256_Eclipse/RTOSDemo/USB/USBSample.h

   1 /*\r
   2     FreeRTOS V7.4.1 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32 \r
  33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
  34     distribute a combined work that includes FreeRTOS without being obliged to\r
  35     provide the source code for proprietary components outside of the FreeRTOS\r
  36     kernel.\r
  37 \r
  38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
  41     details. You should have received a copy of the GNU General Public License\r
  42     and the FreeRTOS license exception along with FreeRTOS; if not it can be\r
  43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
  44     writing to Real Time Engineers Ltd., contact details for whom are available\r
  45     on the FreeRTOS WEB site.\r
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \r
  62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
  64     fully thread aware and reentrant UDP/IP stack.\r
  65 \r
  66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
  67     Integrity Systems, who sell the code with commercial support, \r
  68     indemnification and middleware, under the OpenRTOS brand.\r
  69     \r
  70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety \r
  71     engineered and independently SIL3 certified version for use in safety and \r
  72     mission critical applications that require provable dependability.\r
  73 */\r
  74 \r
  75 #ifndef USB_DEMO_H\r
  76 #define USB_DEMO_H\r
  77 \r
  78 \r
  79 /*-----------------------------------------------------------*/\r
  80 \r
  81 #define usbQUEUE_LENGTH                                         ( 0x3 ) /* Must have all bits set! */\r
  82 #define usbEND_POINT_0                                          ( 0 )\r
  83 #define usbEND_POINT_1                                          ( 1 )\r
  84 #define usbRX_COUNT_MASK                                        ( ( unsigned long ) 0x7ff )\r
  85 #define AT91C_UDP_STALLSENT                                     AT91C_UDP_ISOERROR\r
  86 \r
  87 /* Structure used to take a snapshot of the USB status from within the ISR. */\r
  88 typedef struct X_ISR_STATUS\r
  89 {\r
  90         unsigned long ulISR;\r
  91         unsigned long ulCSR0;\r
  92         unsigned char ucFifoData[ 8 ];\r
  93 } xISRStatus;\r
  94 \r
  95 /* Macros to manipulate the control and status registers.  These registers \r
  96 cannot be accessed using a direct read modify write operation outside of the \r
  97 ISR as some bits are left unchanged by writing with a 0, and some are left \r
  98 unchanged by writing with a 1. */\r
  99 \r
 100 #define usbCSR_SET_BIT( pulValueNow, ulBit )                                                                                    \\r
 101 {                                                                                                                                                                               \\r
 102         /* Set TXCOMP, RX_DATA_BK0, RXSETUP, */                                                                                         \\r
 103         /* STALLSENT and RX_DATA_BK1 to 1 so the */                                                                                     \\r
 104         /* write has no effect. */                                                                                                                      \\r
 105         ( * ( ( unsigned long * ) pulValueNow ) ) |= ( unsigned long ) 0x4f;            \\r
 106                                                                                                                                                                                 \\r
 107         /* Clear the FORCE_STALL and TXPKTRDY bits */                                                                           \\r
 108         /* so the write has no effect. */                                                                                                       \\r
 109         ( * ( ( unsigned long * ) pulValueNow ) ) &= ( unsigned long ) 0xffffffcf;      \\r
 110                                                                                                                                                                                 \\r
 111         /* Set whichever bit we want set. */                                                                                            \\r
 112         ( * ( ( unsigned long * ) pulValueNow ) ) |= ( ulBit );                                                 \\r
 113 }\r
 114 \r
 115 /*\r
 116  * Creates the queue used to communicate between the USB task and the USB ISR, then\r
 117  * createst the task that manages the USB peripheral.\r
 118  */\r
 119 void vStartUSBTask( unsigned portBASE_TYPE uxPriority );\r
 120 \r
 121 #endif\r
 122 \r