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

   1 /*\r
   2     FreeRTOS V8.1.1 - 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_DEMO_H\r
  67 #define USB_DEMO_H\r
  68 \r
  69 \r
  70 /*-----------------------------------------------------------*/\r
  71 \r
  72 #define usbQUEUE_LENGTH                                         ( 0x3 ) /* Must have all bits set! */\r
  73 #define usbEND_POINT_0                                          ( 0 )\r
  74 #define usbEND_POINT_1                                          ( 1 )\r
  75 #define usbRX_COUNT_MASK                                        ( ( unsigned long ) 0x7ff )\r
  76 #define AT91C_UDP_STALLSENT                                     AT91C_UDP_ISOERROR\r
  77 \r
  78 /* Structure used to take a snapshot of the USB status from within the ISR. */\r
  79 typedef struct X_ISR_STATUS\r
  80 {\r
  81         unsigned long ulISR;\r
  82         unsigned long ulCSR0;\r
  83         unsigned char ucFifoData[ 8 ];\r
  84 } xISRStatus;\r
  85 \r
  86 /* Macros to manipulate the control and status registers.  These registers \r
  87 cannot be accessed using a direct read modify write operation outside of the \r
  88 ISR as some bits are left unchanged by writing with a 0, and some are left \r
  89 unchanged by writing with a 1. */\r
  90 \r
  91 #define usbCSR_SET_BIT( pulValueNow, ulBit )                                                                                    \\r
  92 {                                                                                                                                                                               \\r
  93         /* Set TXCOMP, RX_DATA_BK0, RXSETUP, */                                                                                         \\r
  94         /* STALLSENT and RX_DATA_BK1 to 1 so the */                                                                                     \\r
  95         /* write has no effect. */                                                                                                                      \\r
  96         ( * ( ( unsigned long * ) pulValueNow ) ) |= ( unsigned long ) 0x4f;            \\r
  97                                                                                                                                                                                 \\r
  98         /* Clear the FORCE_STALL and TXPKTRDY bits */                                                                           \\r
  99         /* so the write has no effect. */                                                                                                       \\r
 100         ( * ( ( unsigned long * ) pulValueNow ) ) &= ( unsigned long ) 0xffffffcf;      \\r
 101                                                                                                                                                                                 \\r
 102         /* Set whichever bit we want set. */                                                                                            \\r
 103         ( * ( ( unsigned long * ) pulValueNow ) ) |= ( ulBit );                                                 \\r
 104 }\r
 105 \r
 106 /*\r
 107  * Creates the queue used to communicate between the USB task and the USB ISR, then\r
 108  * createst the task that manages the USB peripheral.\r
 109  */\r
 110 void vStartUSBTask( unsigned portBASE_TYPE uxPriority );\r
 111 \r
 112 #endif\r
 113 \r