]> git.sur5r.net Git - freertos/blob - Demo/ARM7_AT91SAM7S64_IAR/USB/USBSample.c
Update version number.
[freertos] / Demo / ARM7_AT91SAM7S64_IAR / USB / USBSample.c
1 /*\r
2         FreeRTOS.org V5.4.0 - Copyright (C) 2003-2009 Richard Barry.\r
3 \r
4         This file is part of the FreeRTOS.org distribution.\r
5 \r
6         FreeRTOS.org is free software; you can redistribute it and/or modify it\r
7         under the terms of the GNU General Public License (version 2) as published\r
8         by the Free Software Foundation and modified by the FreeRTOS exception.\r
9         **NOTE** The exception to the GPL is included to allow you to distribute a\r
10         combined work that includes FreeRTOS.org without being obliged to provide\r
11         the source code for any proprietary components.  Alternative commercial\r
12         license and support terms are also available upon request.  See the \r
13         licensing section of http://www.FreeRTOS.org for full details.\r
14 \r
15         FreeRTOS.org is distributed in the hope that it will be useful, but WITHOUT\r
16         ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
17         FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
18         more details.\r
19 \r
20         You should have received a copy of the GNU General Public License along\r
21         with FreeRTOS.org; if not, write to the Free Software Foundation, Inc., 59\r
22         Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
23 \r
24 \r
25         ***************************************************************************\r
26         *                                                                         *\r
27         * Get the FreeRTOS eBook!  See http://www.FreeRTOS.org/Documentation      *\r
28         *                                                                         *\r
29         * This is a concise, step by step, 'hands on' guide that describes both   *\r
30         * general multitasking concepts and FreeRTOS specifics. It presents and   *\r
31         * explains numerous examples that are written using the FreeRTOS API.     *\r
32         * Full source code for all the examples is provided in an accompanying    *\r
33         * .zip file.                                                              *\r
34         *                                                                         *\r
35         ***************************************************************************\r
36 \r
37         1 tab == 4 spaces!\r
38 \r
39         Please ensure to read the configuration and relevant port sections of the\r
40         online documentation.\r
41 \r
42         http://www.FreeRTOS.org - Documentation, latest information, license and\r
43         contact details.\r
44 \r
45         http://www.SafeRTOS.com - A version that is certified for use in safety\r
46         critical systems.\r
47 \r
48         http://www.OpenRTOS.com - Commercial support, development, porting,\r
49         licensing and training services.\r
50 */\r
51 \r
52 /*\r
53         Sample interrupt driven USB device driver.  This is a minimal implementation\r
54         for demonstration only.  Although functional, it is not a full and compliant\r
55         implementation.\r
56         \r
57         The USB device enumerates as a simple 3 axis joystick, and once configured\r
58         transmits 3 axis of data which can be viewed from the USB host machine.\r
59 \r
60         This file implements the USB interrupt service routine, and a demo FreeRTOS\r
61         task.  The interrupt service routine handles the USB hardware - taking a\r
62         snapshot of the USB status at the point of the interrupt.  The task receives\r
63         the status information from the interrupt for processing at the task level.\r
64         \r
65         See the FreeRTOS.org WEB documentation for more information.\r
66 */\r
67 \r
68 /*\r
69         Changes from V2.5.5\r
70         \r
71         + Descriptors that have a length that is an exact multiple of usbFIFO_LENGTH\r
72           can now be transmitted.  To this end an extra parameter has been\r
73           added to the prvSendControlData() function, and the state\r
74           eSENDING_EVEN_DESCRIPTOR has been introduced.  Thanks to Scott Miller for\r
75           assisting with this contribution.\r
76 \r
77         Changes from V2.6.0\r
78 \r
79         + Replaced the duplicated RX_DATA_BK0 in the interrupt mask with the\r
80           RX_DATA_BK1.\r
81 */\r
82 \r
83 /* Standard includes. */\r
84 #include <string.h>\r
85 \r
86 /* Demo board includes. */\r
87 #include "board.h"\r
88 \r
89 /* Scheduler includes. */\r
90 #include "FreeRTOS.h"\r
91 #include "task.h"\r
92 #include "queue.h"\r
93 \r
94 \r
95 /* Descriptor type definitions. */\r
96 #define usbDESCRIPTOR_TYPE_DEVICE                       ( 0x01 )\r
97 #define usbDESCRIPTOR_TYPE_CONFIGURATION        ( 0x02 )\r
98 #define usbDESCRIPTOR_TYPE_STRING                       ( 0x03 )\r
99 \r
100 /* USB request type definitions. */\r
101 #define usbGET_REPORT_REQUEST                           ( 0x01 )\r
102 #define usbGET_IDLE_REQUEST                                     ( 0x02 )\r
103 #define usbGET_PROTOCOL_REQUEST                         ( 0x03 )\r
104 #define usbSET_REPORT_REQUEST                           ( 0x09 )\r
105 #define usbSET_IDLE_REQUEST                                     ( 0x0A )\r
106 #define usbSET_PROTOCOL_REQUEST                         ( 0x0B )\r
107 #define usbGET_CONFIGURATION_REQUEST            ( 0x08 )\r
108 #define usbGET_STATUS_REQUEST                           ( 0x00 )\r
109 #define usbCLEAR_FEATURE_REQUEST                        ( 0x01 )\r
110 #define usbSET_FEATURE_REQUEST                          ( 0x03 )\r
111 #define usbSET_ADDRESS_REQUEST                          ( 0x05 )\r
112 #define usbGET_DESCRIPTOR_REQUEST                       ( 0x06 )\r
113 #define usbSET_CONFIGURATION_REQUEST            ( 0x09 )\r
114 #define usbGET_INTERFACE_REQUEST                        ( 0x0A )\r
115 #define usbSET_INTERFACE_REQUEST                        ( 0x0B )\r
116 \r
117 \r
118 /* Misc USB definitions. */\r
119 #define usbDEVICE_CLASS_VENDOR_SPECIFIC         ( 0xFF )\r
120 #define usbBUS_POWERED                                          ( 0x80 )\r
121 #define usbHID_REPORT_DESCRIPTOR                        ( 0x22 )\r
122 #define AT91C_UDP_TRANSCEIVER_ENABLE                    ( *( ( unsigned long * ) 0xfffb0074 ) )\r
123 \r
124 /* Index to the various string. */\r
125 #define usbLANGUAGE_STRING                                      ( 0 )\r
126 #define usbMANUFACTURER_STRING                          ( 1 )\r
127 #define usbPRODUCT_STRING                                       ( 2 )\r
128 #define usbCONFIGURATION_STRING                         ( 3 )\r
129 #define usbINTERFACE_STRING                                     ( 4 )\r
130 \r
131 /* Data indexes for reading the request from the xISRStatus.ucFifoData[]\r
132 into xUSB_REQUEST.  The data order is designed for speed - so looks a\r
133 little odd. */\r
134 #define usbREQUEST_TYPE_INDEX                           ( 7 )\r
135 #define usbREQUEST_INDEX                                        ( 6 )\r
136 #define usbVALUE_HIGH_BYTE                                      ( 4 )\r
137 #define usbVALUE_LOW_BYTE                                       ( 5 )\r
138 #define usbINDEX_HIGH_BYTE                                      ( 2 )\r
139 #define usbINDEX_LOW_BYTE                                       ( 3 )\r
140 #define usbLENGTH_HIGH_BYTE                                     ( 0 )\r
141 #define usbLENGTH_LOW_BYTE                                      ( 1 )\r
142 \r
143 /* Misc application definitions. */\r
144 #define usbINTERRUPT_PRIORITY                           ( 3 )\r
145 #define usbQUEUE_LENGTH                                         ( 0x3 ) /* Must have all bits set! */\r
146 #define usbFIFO_LENGTH                                          ( ( unsigned portLONG ) 8 )\r
147 #define usbEND_POINT_0                                          ( 0 )\r
148 #define usbEND_POINT_1                                          ( 1 )\r
149 #define usbXUP                                                          ( 1 )\r
150 #define usbXDOWN                                                        ( 2 )\r
151 #define usbYUP                                                          ( 3 )\r
152 #define usbYDOWN                                                        ( 4 )\r
153 #define usbMAX_COORD                                            ( 120 )\r
154 #define usbMAX_TX_MESSAGE_SIZE                          ( 128 )\r
155 #define usbRX_COUNT_MASK                                        ( ( unsigned portLONG ) 0x7ff )\r
156 #define AT91C_UDP_STALLSENT                                     AT91C_UDP_ISOERROR\r
157 #define usbSHORTEST_DELAY                                       ( ( portTickType ) 1 )\r
158 #define usbINIT_DELAY                                           ( ( portTickType ) 500 / portTICK_RATE_MS )\r
159 #define usbSHORT_DELAY                                          ( ( portTickType ) 50 / portTICK_RATE_MS )\r
160 #define usbEND_POINT_RESET_MASK                         ( ( unsigned portLONG ) 0x0f )\r
161 #define usbDATA_INC                                                     ( ( portCHAR ) 5 )\r
162 #define usbEXPECTED_NUMBER_OF_BYTES                     ( ( unsigned portLONG ) 8 )\r
163 \r
164 /* Control request types. */\r
165 #define usbSTANDARD_DEVICE_REQUEST                      ( 0 )\r
166 #define usbSTANDARD_INTERFACE_REQUEST           ( 1 )\r
167 #define usbSTANDARD_END_POINT_REQUEST           ( 2 )\r
168 #define usbCLASS_INTERFACE_REQUEST                      ( 5 )\r
169 \r
170 /*-----------------------------------------------------------*/\r
171 \r
172 /* Structure used to take a snapshot of the USB status from within the ISR. */\r
173 typedef struct X_ISR_STATUS\r
174 {\r
175         unsigned portLONG ulISR;\r
176         unsigned portLONG ulCSR0;\r
177         unsigned portCHAR ucFifoData[ 8 ];\r
178 } xISRStatus;\r
179 \r
180 /* Structure used to hold the received requests. */\r
181 typedef struct\r
182 {\r
183         unsigned portCHAR ucReqType;\r
184         unsigned portCHAR ucRequest;\r
185         unsigned portSHORT usValue;\r
186         unsigned portSHORT usIndex;\r
187         unsigned portSHORT usLength;\r
188 } xUSB_REQUEST;\r
189 \r
190 typedef enum\r
191 {\r
192         eNOTHING,\r
193         eJUST_RESET,\r
194         eJUST_GOT_CONFIG,\r
195         eJUST_GOT_ADDRESS,\r
196         eSENDING_EVEN_DESCRIPTOR,\r
197         eREADY_TO_SEND\r
198 } eDRIVER_STATE;\r
199 \r
200 /* Structure used to control the data being sent to the host. */\r
201 typedef struct\r
202 {\r
203         unsigned portCHAR ucTxBuffer[ usbMAX_TX_MESSAGE_SIZE ];\r
204         unsigned portLONG ulNextCharIndex;\r
205         unsigned portLONG ulTotalDataLength;\r
206 } xTX_MESSAGE;\r
207 \r
208 /*-----------------------------------------------------------*/\r
209 \r
210 /*\r
211  * The USB interrupt service routine.  This takes a snapshot of the USB\r
212  * device at the time of the interrupt, clears the interrupts, and posts\r
213  * the data to the USB processing task.\r
214  */\r
215 __arm void vUSB_ISR( void );\r
216 \r
217 /*\r
218  * Called after the bus reset interrupt - this function readies all the\r
219  * end points for communication.\r
220  */\r
221 static void prvResetEndPoints( void );\r
222 \r
223 /*\r
224  * Setup the USB hardware, install the interrupt service routine and\r
225  * initialise all the state variables.\r
226  */\r
227 static void vInitUSBInterface( void );\r
228 \r
229 /*\r
230  * Decode and act upon an interrupt generated by the control end point.\r
231  */\r
232 static void prvProcessEndPoint0Interrupt( xISRStatus *pxMessage );\r
233 \r
234 /*\r
235  * For simplicity requests are separated into device, interface, class\r
236  * interface and end point requests.\r
237  *\r
238  * Decode and handle standard device requests originating on the control\r
239  * end point.\r
240  */\r
241 static void prvHandleStandardDeviceRequest( xUSB_REQUEST *pxRequest );\r
242 \r
243 /*\r
244  * For simplicity requests are separated into device, interface, class\r
245  * interface and end point requests.\r
246  *\r
247  * Decode and handle standard interface requests originating on the control\r
248  * end point.\r
249  */\r
250 static void prvHandleStandardInterfaceRequest( xUSB_REQUEST *pxRequest );\r
251 \r
252 /*\r
253  * For simplicity requests are separated into device, interface, class\r
254  * interface and end point requests.\r
255  *\r
256  * Decode and handle standard end point requests originating on the control\r
257  * end point.\r
258  */\r
259 static void prvHandleStandardEndPointRequest( xUSB_REQUEST *pxRequest );\r
260 \r
261 /*\r
262  * For simplicity requests are separated into device, interface, class\r
263  * interface and end point requests.\r
264  *\r
265  * Decode and handle the class interface requests.\r
266  */\r
267 static void prvHandleClassInterfaceRequest( xUSB_REQUEST *pxRequest );\r
268 \r
269 /*\r
270  * Setup the Tx buffer to send data in response to a control request.\r
271  *\r
272  * The data to be transmitted is buffered, the state variables are updated,\r
273  * then prvSendNextSegment() is called to start the transmission off.  Once\r
274  * the first segment has been sent the remaining segments are transmitted\r
275  * in response to TXCOMP interrupts until the entire buffer has been\r
276  * sent.\r
277  */\r
278 static void prvSendControlData( unsigned portCHAR *pucData, unsigned portSHORT usRequestedLength, unsigned portLONG ulLengthLeftToSend, portLONG lSendingDescriptor );\r
279 \r
280 /*\r
281  * Examine the Tx buffer to see if there is any more data to be transmitted.\r
282  *\r
283  * If there is data to be transmitted then send the next segment.  A segment\r
284  * can have a maximum of 8 bytes (this is defined as the maximum for the end\r
285  * point by the descriptor).  The final segment may be less than 8 bytes if\r
286  * the total data length was not an exact multiple of 8.\r
287  */\r
288 static void prvSendNextSegment( void );\r
289 \r
290 /*\r
291  * A stall condition is forced each time the host makes a request that is not\r
292  * supported by this minimal implementation.\r
293  *\r
294  * A stall is forced by setting the appropriate bit in the end points control\r
295  * and status register.\r
296  */\r
297 static void prvSendStall( void );\r
298 \r
299 /*\r
300  * A NULL (or zero length packet) is transmitted in acknowledge the reception\r
301  * of certain events from the host.\r
302  */\r
303 static void prvUSBTransmitNull( void );\r
304 \r
305 /*\r
306  * When the host requests a descriptor this function is called to determine\r
307  * which descriptor is being requested and start its transmission.\r
308  */\r
309 static void prvGetStandardInterfaceDescriptor( xUSB_REQUEST *pxRequest );\r
310 \r
311 /*\r
312  * This demo USB device enumerates as a simple 3 axis joystick.  Once\r
313  * configured this function is periodically called to generate some sample\r
314  * joystick data.\r
315  *\r
316  * The x and y axis are made to move in a square.  The z axis is made to\r
317  * repeatedly increment up to its maximum.\r
318  */\r
319 static void prvTransmitSampleValues( void );\r
320 \r
321 /*\r
322  * The created task to handle the USB demo functionality.\r
323  */\r
324 void vUSBDemoTask( void *pvParameters );\r
325 \r
326 /*-----------------------------------------------------------*/\r
327 \r
328 /*\r
329         - DESCRIPTOR DEFINITIONS -\r
330 */\r
331 \r
332 /* String descriptors used during the enumeration process.\r
333 These take the form:\r
334 \r
335 {\r
336         Length of descriptor,\r
337         Descriptor type,\r
338         Data\r
339 }\r
340 */\r
341 const portCHAR pxLanguageStringDescriptor[] =\r
342 {\r
343         4,\r
344         usbDESCRIPTOR_TYPE_STRING,\r
345         0x09, 0x04\r
346 };\r
347 \r
348 const portCHAR pxManufacturerStringDescriptor[] =\r
349 {\r
350         18,\r
351         usbDESCRIPTOR_TYPE_STRING,\r
352 \r
353         'F', 0x00,\r
354         'r', 0x00,\r
355         'e', 0x00,\r
356         'e', 0x00,\r
357         'R', 0x00,\r
358         'T', 0x00,\r
359         'O', 0x00,\r
360         'S', 0x00       \r
361 };\r
362 \r
363 const portCHAR pxProductStringDescriptor[] =\r
364 {\r
365         44,\r
366         usbDESCRIPTOR_TYPE_STRING,\r
367 \r
368         'F', 0x00,\r
369         'r', 0x00,\r
370         'e', 0x00,\r
371         'e', 0x00,\r
372         'R', 0x00,\r
373         'T', 0x00,\r
374         'O', 0x00,\r
375         'S', 0x00,\r
376         '.', 0x00,\r
377         'o', 0x00,\r
378         'r', 0x00,\r
379         'g', 0x00,\r
380         ' ', 0x00,\r
381         'J', 0x00,\r
382         'o', 0x00,\r
383         'y', 0x00,\r
384         's', 0x00,\r
385         't', 0x00,\r
386         'i', 0x00,\r
387         'c', 0x00,\r
388         'k', 0x00\r
389 };\r
390 \r
391 const portCHAR pxConfigurationStringDescriptor[] =\r
392 {\r
393         38,\r
394         usbDESCRIPTOR_TYPE_STRING,\r
395 \r
396         'C', 0x00,\r
397         'o', 0x00,\r
398         'n', 0x00,\r
399         'f', 0x00,\r
400         'i', 0x00,\r
401         'g', 0x00,\r
402         'u', 0x00,\r
403         'r', 0x00,\r
404         'a', 0x00,\r
405         't', 0x00,\r
406         'i', 0x00,\r
407         'o', 0x00,\r
408         'n', 0x00,\r
409         ' ', 0x00,\r
410         'N', 0x00,\r
411         'a', 0x00,\r
412         'm', 0x00,\r
413         'e', 0x00\r
414 };\r
415 \r
416 const portCHAR pxInterfaceStringDescriptor[] =\r
417 {\r
418         30,\r
419         usbDESCRIPTOR_TYPE_STRING,\r
420 \r
421         'I', 0x00,\r
422         'n', 0x00,\r
423         't', 0x00,\r
424         'e', 0x00,\r
425         'r', 0x00,\r
426         'f', 0x00,\r
427         'a', 0x00,\r
428         'c', 0x00,\r
429         'e', 0x00,\r
430         ' ', 0x00,\r
431         'N', 0x00,\r
432         'a', 0x00,\r
433         'm', 0x00,\r
434         'e', 0x00\r
435 };\r
436 \r
437 /* Enumeration descriptors. */\r
438 const portCHAR pxReportDescriptor[] =\r
439 {\r
440          0x05,  0x01,   /* USAGE_PAGE (Generic Desktop)         */\r
441          0x09,  0x04,   /* USAGE (Joystick)                                     */\r
442          0xa1,  0x01,   /* COLLECTION (Application)                     */\r
443          0x05,  0x01,   /*   USAGE_PAGE (Generic Desktop)       */\r
444          0x09,  0x01,   /*   USAGE (Pointer)                            */\r
445          0xa1,  0x00,   /*   COLLECTION (Physical)                      */\r
446          0x09,  0x30,   /*     USAGE (X)                                        */\r
447          0x09,  0x31,   /*     USAGE (Y)                                        */\r
448          0x09,  0x32,   /*     USAGE (Z)                                        */\r
449          0x15,  0x81,   /*     LOGICAL_MINIMUM (-127)           */\r
450          0x25,  0x7f,   /*     LOGICAL_MAXIMUM (127)            */\r
451          0x75,  0x08,   /*     REPORT_SIZE (8)                          */\r
452          0x95,  0x03,   /*     REPORT_COUNT (3)                         */\r
453          0x81,  0x02,   /*     INPUT (Data,Var,Abs)                     */\r
454          0xc0,                  /*   END_COLLECTION                                     */\r
455          0xc0                   /* END_COLLECTION                                       */\r
456 };\r
457 \r
458 const char pxDeviceDescriptor[] =\r
459 {\r
460         /* Device descriptor */\r
461         0x12,                                                           /* bLength                              */\r
462         0x01,                                                           /* bDescriptorType              */\r
463         0x10, 0x01,                                                     /* bcdUSBL                              */\r
464         usbDEVICE_CLASS_VENDOR_SPECIFIC,        /* bDeviceClass:                */\r
465         0x00,                                                           /* bDeviceSubclass:             */\r
466         0x00,                                                           /* bDeviceProtocol:             */\r
467         0x08,                                                           /* bMaxPacketSize0              */\r
468         0xFF, 0xFF,                                                     /* idVendorL                    */\r
469         0x01, 0x00,                                                     /* idProductL                   */\r
470         0x00, 0x01,                                                     /* bcdDeviceL                   */\r
471         usbMANUFACTURER_STRING,                         /* iManufacturer                */\r
472         usbPRODUCT_STRING,                                      /* iProduct                             */\r
473         0x00,                                                           /* SerialNumber                 */\r
474         0x01                                                            /* bNumConfigs                  */\r
475 };\r
476 \r
477 const char pxConfigDescriptor[] = {\r
478         /* Configuration 1 descriptor */\r
479         0x09,                   /* CbLength                                                                     */\r
480         0x02,                   /* CbDescriptorType                                                     */\r
481         0x22, 0x00,             /* CwTotalLength 2 EP + Control                         */\r
482         0x01,                   /* CbNumInterfaces                                                      */\r
483         0x01,                   /* CbConfigurationValue                                         */\r
484         usbCONFIGURATION_STRING,/* CiConfiguration                                      */\r
485         usbBUS_POWERED, /* CbmAttributes Bus powered + Remote Wakeup*/\r
486         0x32,                   /* CMaxPower: 100mA                                                     */\r
487 \r
488         /* Joystick Interface Descriptor Requirement */\r
489         0x09,                   /* bLength                                                                      */\r
490         0x04,                   /* bDescriptorType                                                      */\r
491         0x00,                   /* bInterfaceNumber                                                     */\r
492         0x00,                   /* bAlternateSetting                                            */\r
493         0x01,                   /* bNumEndpoints                                                        */\r
494         0x03,                   /* bInterfaceClass: HID code                            */\r
495         0x00,                   /* bInterfaceSubclass                                           */\r
496         0x00,                   /* bInterfaceProtocol                                           */\r
497         usbINTERFACE_STRING,/* iInterface                                                       */\r
498 \r
499         /* HID Descriptor */\r
500         0x09,                   /* bLength                                                                      */\r
501         0x21,                   /* bDescriptor type: HID Descriptor Type        */\r
502         0x00, 0x01,             /* bcdHID                                                                       */\r
503         0x00,                   /* bCountryCode                                                         */\r
504         0x01,                   /* bNumDescriptors                                                      */\r
505         usbHID_REPORT_DESCRIPTOR,         /* bDescriptorType                    */\r
506         sizeof( pxReportDescriptor ), 0x00, /* wItemLength                      */\r
507 \r
508         /* Endpoint 1 descriptor */\r
509         0x07,                   /* bLength                                                                      */\r
510         0x05,                   /* bDescriptorType                                                      */\r
511         0x81,                   /* bEndpointAddress, Endpoint 01 - IN           */\r
512         0x03,                   /* bmAttributes      INT                                        */\r
513         0x03, 0x00,             /* wMaxPacketSize: 3 bytes (x, y, z)            */\r
514         0x0A                    /* bInterval                                                            */\r
515 };\r
516 \r
517 /*-----------------------------------------------------------*/\r
518 \r
519 /* File scope state variables. */\r
520 static unsigned portCHAR ucUSBConfig = ( unsigned portCHAR ) 0;\r
521 static unsigned portLONG ulReceivedAddress = ( unsigned portLONG ) 0;\r
522 static eDRIVER_STATE eDriverState = eNOTHING;\r
523 \r
524 /* Array in which the USB interrupt status is passed between the ISR and task. */\r
525 static xISRStatus xISRMessages[ usbQUEUE_LENGTH + 1 ];\r
526 \r
527 /* Structure used to control the characters being sent to the host. */\r
528 static xTX_MESSAGE pxCharsForTx;\r
529 \r
530 /* Queue used to pass messages between the ISR and the task. */\r
531 static xQueueHandle xUSBInterruptQueue;\r
532 \r
533 /* ISR entry has to be written in the asm file as we want a context switch\r
534 to occur from within the ISR.  See the port documentation on the FreeRTOS.org\r
535 WEB site for more information. */\r
536 extern void vUSBISREntry( void );\r
537 \r
538 /*-----------------------------------------------------------*/\r
539 \r
540 /* Macros to manipulate the control and status registers.  These registers\r
541 cannot be accessed using a direct read modify write operation outside of the\r
542 ISR as some bits are left unchanged by writing with a 0, and some are left\r
543 unchanged by writing with a 1. */\r
544 \r
545 #define usbINT_CLEAR_MASK       (AT91C_UDP_TXCOMP | AT91C_UDP_STALLSENT | AT91C_UDP_RXSETUP | AT91C_UDP_RX_DATA_BK0 | AT91C_UDP_RX_DATA_BK1 )\r
546 \r
547 #define usbCSR_SET_BIT( pulValueNow, ulBit )                                                                                    \\r
548 {                                                                                                                                                                               \\r
549         /* Set TXCOMP, RX_DATA_BK0, RXSETUP, */                                                                                         \\r
550         /* STALLSENT and RX_DATA_BK1 to 1 so the */                                                                                     \\r
551         /* write has no effect. */                                                                                                                      \\r
552         ( * ( ( unsigned portLONG * ) pulValueNow ) ) |= ( unsigned portLONG ) 0x4f;            \\r
553                                                                                                                                                                                 \\r
554         /* Clear the FORCE_STALL and TXPKTRDY bits */                                                                           \\r
555         /* so the write has no effect. */                                                                                                       \\r
556         ( * ( ( unsigned portLONG * ) pulValueNow ) ) &= ( unsigned portLONG ) 0xffffffcf;      \\r
557                                                                                                                                                                                 \\r
558         /* Set whichever bit we want set. */                                                                                            \\r
559         ( * ( ( unsigned portLONG * ) pulValueNow ) ) |= ( ulBit );                                                     \\r
560 }\r
561 \r
562 #define usbCSR_CLEAR_BIT( pulValueNow, ulBit )                                                                                  \\r
563 {                                                                                                                                                                               \\r
564         /* Set TXCOMP, RX_DATA_BK0, RXSETUP, */                                                                                         \\r
565         /* STALLSENT and RX_DATA_BK1 to 1 so the */                                                                                     \\r
566         /* write has no effect. */                                                                                                                      \\r
567         ( * ( ( unsigned portLONG * ) pulValueNow ) ) |= ( unsigned portLONG ) 0x4f;            \\r
568                                                                                                                                                                                 \\r
569         /* Clear the FORCE_STALL and TXPKTRDY bits */                                                                           \\r
570         /* so the write has no effect. */                                                                                                       \\r
571         ( * ( ( unsigned portLONG * ) pulValueNow ) ) &= ( unsigned portLONG ) 0xffffffcf;      \\r
572                                                                                                                                                                                 \\r
573         /* Clear whichever bit we want clear. */                                                                                        \\r
574         ( * ( ( unsigned portLONG * ) pulValueNow ) ) &= ( ~ulBit );                                            \\r
575 }\r
576 \r
577 /*-----------------------------------------------------------*/\r
578 \r
579 __arm void vUSB_ISR( void )\r
580 {\r
581 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
582 static volatile unsigned portLONG ulNextMessage = 0;\r
583 xISRStatus *pxMessage;\r
584 unsigned portLONG ulTemp, ulRxBytes;\r
585 \r
586         /* Take the next message from the queue.  Note that usbQUEUE_LENGTH *must*\r
587         be all 1's, as in 0x01, 0x03, 0x07, etc. */\r
588         pxMessage = &( xISRMessages[ ( ulNextMessage & usbQUEUE_LENGTH ) ] );\r
589         ulNextMessage++;\r
590 \r
591         /* Take a snapshot of the current USB state for processing at the task\r
592         level. */\r
593         pxMessage->ulISR = AT91C_BASE_UDP->UDP_ISR;\r
594         pxMessage->ulCSR0 = AT91C_BASE_UDP->UDP_CSR[ usbEND_POINT_0 ];\r
595 \r
596         /* Clear the interrupts from the ICR register.  The bus end interrupt is\r
597         cleared separately as it does not appear in the mask register. */\r
598         AT91C_BASE_UDP->UDP_ICR = AT91C_BASE_UDP->UDP_IMR | AT91C_UDP_ENDBUSRES;\r
599         \r
600         /* If there are bytes in the FIFO then we have to retrieve them here.\r
601         Ideally this would be done at the task level.  However we need to clear the\r
602         RXSETUP interrupt before leaving the ISR, and this may cause the data in\r
603         the FIFO to be overwritten.  Also the DIR bit has to be changed before the\r
604         RXSETUP bit is cleared (as per the SAM7 manual). */\r
605         ulTemp = pxMessage->ulCSR0;\r
606         \r
607         /* Are there any bytes in the FIFO? */\r
608         ulRxBytes = ulTemp >> 16;\r
609         ulRxBytes &= usbRX_COUNT_MASK;\r
610         \r
611         /* With this minimal implementation we are only interested in receiving\r
612         setup bytes on the control end point. */\r
613         if( ( ulRxBytes > 0 ) && ( ulTemp & AT91C_UDP_RXSETUP ) )\r
614         {\r
615                 /* Take off 1 for a zero based index. */\r
616                 while( ulRxBytes > 0 )\r
617                 {\r
618                         ulRxBytes--;\r
619                         pxMessage->ucFifoData[ ulRxBytes ] = AT91C_BASE_UDP->UDP_FDR[ usbEND_POINT_0 ];                 \r
620                 }\r
621                 \r
622                 /* The direction must be changed first. */\r
623                 usbCSR_SET_BIT( &ulTemp, ( AT91C_UDP_DIR ) );\r
624                 AT91C_BASE_UDP->UDP_CSR[ usbEND_POINT_0 ] = ulTemp;\r
625         }\r
626         \r
627         /* Must write zero's to TXCOMP, STALLSENT, RXSETUP, and the RX DATA\r
628         registers to clear the interrupts in the CSR register. */\r
629         usbCSR_CLEAR_BIT( &ulTemp, usbINT_CLEAR_MASK );\r
630         AT91C_BASE_UDP->UDP_CSR[ usbEND_POINT_0 ] = ulTemp;\r
631 \r
632         /* Also clear the interrupts in the CSR1 register. */\r
633         ulTemp = AT91C_BASE_UDP->UDP_CSR[ usbEND_POINT_1 ];\r
634         usbCSR_CLEAR_BIT( &ulTemp, usbINT_CLEAR_MASK ); \r
635         AT91C_BASE_UDP->UDP_CSR[ usbEND_POINT_1 ] = ulTemp;\r
636 \r
637         /* The message now contains the entire state and optional data from\r
638         the USB interrupt.  This can now be posted on the Rx queue ready for\r
639         processing at the task level. */\r
640         xQueueSendFromISR( xUSBInterruptQueue, &pxMessage, &xHigherPriorityTaskWoken );\r
641 \r
642         /* We may want to switch to the USB task, if this message has made\r
643         it the highest priority task that is ready to execute. */\r
644         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
645 \r
646         /* Clear the AIC ready for the next interrupt. */               \r
647         AT91C_BASE_AIC->AIC_EOICR = 0;\r
648 }\r
649 /*-----------------------------------------------------------*/\r
650 \r
651 void vUSBDemoTask( void *pvParameters )\r
652 {\r
653 xISRStatus *pxMessage;\r
654 \r
655         /* The parameters are not used in this task. */\r
656         ( void ) pvParameters;\r
657 \r
658     /* Init USB device */\r
659     portENTER_CRITICAL();\r
660             vInitUSBInterface();\r
661     portEXIT_CRITICAL();\r
662 \r
663         /* Process interrupts as they arrive.   The ISR takes a snapshot of the\r
664         interrupt status then posts the information on this queue for processing\r
665         at the task level.  This simple demo implementation only processes\r
666         a few interrupt sources. */\r
667         for( ;; )\r
668         {\r
669                 if( xQueueReceive( xUSBInterruptQueue, &pxMessage, usbSHORT_DELAY ) )\r
670                 {\r
671                         if( pxMessage->ulISR & AT91C_UDP_EPINT0 )\r
672                         {\r
673                                 /* Process end point 0 interrupt. */\r
674                                 prvProcessEndPoint0Interrupt( pxMessage );\r
675                         }\r
676 \r
677                         if( pxMessage->ulISR & AT91C_UDP_ENDBUSRES )\r
678                         {\r
679                                 /* Process an end of bus reset interrupt. */\r
680                                 prvResetEndPoints();            \r
681                         }\r
682                 }\r
683                 else\r
684                 {\r
685                         /* The ISR did not post any data for us to process on the queue, so\r
686                         just generate and send some sample data. */\r
687                         if( eDriverState == eREADY_TO_SEND )\r
688                         {\r
689                                 prvTransmitSampleValues();\r
690                         }\r
691                 }\r
692         }\r
693 }\r
694 /*-----------------------------------------------------------*/\r
695 \r
696 static void prvTransmitSampleValues( void )\r
697 {\r
698 unsigned portLONG ulStatus;\r
699 static portLONG lState = usbXUP;\r
700 \r
701 /* Variables to hold dummy x, y and z joystick axis data. */\r
702 static signed portCHAR x = 0, y = 0, z = 0;\r
703 \r
704         /* Generate some sample data in the x and y axis - draw a square. */\r
705         switch( lState )\r
706         {\r
707                 case usbXUP     :       x += usbDATA_INC;\r
708                                                 if( x >= usbMAX_COORD )\r
709                                                 {\r
710                                                         lState = usbYUP;\r
711                                                 }\r
712                                                 break;\r
713                                                 \r
714                 case usbXDOWN : x -= usbDATA_INC;\r
715                                                 if( x <= -usbMAX_COORD )\r
716                                                 {\r
717                                                         lState = usbYDOWN;\r
718                                                 }\r
719                                                 break;\r
720                                                 \r
721                 case usbYUP :   y += usbDATA_INC;\r
722                                                 if( y >= usbMAX_COORD )\r
723                                                 {\r
724                                                         lState = usbXDOWN;\r
725                                                 }\r
726                                                 break;\r
727                                                 \r
728                 case usbYDOWN : y -= usbDATA_INC;\r
729                                                 if( y <= -usbMAX_COORD )\r
730                                                 {\r
731                                                         lState = usbXUP;\r
732                                                 }\r
733                                                 break;\r
734         }\r
735 \r
736         /* Just make the z axis go up and down. */\r
737         z += usbDATA_INC;\r
738 \r
739         /* Can we place data in the fifo? */\r
740         if( !( AT91C_BASE_UDP->UDP_CSR[ usbEND_POINT_1 ] & AT91C_UDP_TXPKTRDY ) )\r
741         {\r
742                 /* Write our sample data to the fifo. */\r
743                 AT91C_BASE_UDP->UDP_FDR[ usbEND_POINT_1 ] = x;\r
744                 AT91C_BASE_UDP->UDP_FDR[ usbEND_POINT_1 ] = y;\r
745                 AT91C_BASE_UDP->UDP_FDR[ usbEND_POINT_1 ] = z;\r
746                 \r
747                 /* Send the data. */\r
748                 portENTER_CRITICAL();\r
749                 {\r
750                         ulStatus = AT91C_BASE_UDP->UDP_CSR[ usbEND_POINT_1 ];\r
751                         usbCSR_SET_BIT( &ulStatus, ( AT91C_UDP_TXPKTRDY ) );\r
752                         AT91C_BASE_UDP->UDP_CSR[ usbEND_POINT_1 ] = ulStatus;\r
753                 }\r
754                 portEXIT_CRITICAL();\r
755         }\r
756 }\r
757 /*-----------------------------------------------------------*/\r
758 \r
759 static void prvUSBTransmitNull( void )\r
760 {\r
761 unsigned portLONG ulStatus;\r
762 \r
763         /* Wait until the FIFO is free - even though we are not going to use it.\r
764         THERE IS NO TIMEOUT HERE! */\r
765         while( AT91C_BASE_UDP->UDP_CSR[ usbEND_POINT_0 ] & AT91C_UDP_TXPKTRDY )\r
766         {\r
767                 vTaskDelay( usbSHORTEST_DELAY );\r
768         }\r
769 \r
770         portENTER_CRITICAL();\r
771         {\r
772                 /* Set the length of data to send to equal the index of the next byte\r
773                 to send.  This will prevent the ACK to this NULL packet causing any\r
774                 further data transmissions. */\r
775                 pxCharsForTx.ulTotalDataLength = pxCharsForTx.ulNextCharIndex;\r
776 \r
777                 /* Set the TXPKTRDY bit to cause a transmission with no data. */\r
778                 ulStatus = AT91C_BASE_UDP->UDP_CSR[ usbEND_POINT_0 ];\r
779                 usbCSR_SET_BIT( &ulStatus, ( AT91C_UDP_TXPKTRDY ) );\r
780                 AT91C_BASE_UDP->UDP_CSR[ usbEND_POINT_0 ] = ulStatus;\r
781         }\r
782         portEXIT_CRITICAL();\r
783 }\r
784 /*-----------------------------------------------------------*/\r
785 \r
786 static void prvSendStall( void )\r
787 {\r
788 unsigned portLONG ulStatus;\r
789 \r
790         portENTER_CRITICAL();\r
791         {\r
792                 /* Force a stall by simply setting the FORCESTALL bit in the CSR. */\r
793                 ulStatus = AT91C_BASE_UDP->UDP_CSR[ usbEND_POINT_0 ];\r
794                 usbCSR_SET_BIT( &ulStatus, AT91C_UDP_FORCESTALL );\r
795                 AT91C_BASE_UDP->UDP_CSR[ usbEND_POINT_0 ] = ulStatus;\r
796         }\r
797         portEXIT_CRITICAL();\r
798 }\r
799 /*-----------------------------------------------------------*/\r
800 \r
801 static void prvResetEndPoints( void )\r
802 {\r
803 unsigned portLONG ulTemp;\r
804 \r
805         eDriverState = eJUST_RESET;\r
806 \r
807         /* Reset all the end points. */\r
808         AT91C_BASE_UDP->UDP_RSTEP  = usbEND_POINT_RESET_MASK;\r
809         AT91C_BASE_UDP->UDP_RSTEP  = ( unsigned portLONG ) 0x00;\r
810 \r
811         /* Enable data to be sent and received. */\r
812         AT91C_BASE_UDP->UDP_FADDR = AT91C_UDP_FEN;\r
813 \r
814         /* Repair the configuration end point. */\r
815         portENTER_CRITICAL();\r
816         {\r
817                 ulTemp = AT91C_BASE_UDP->UDP_CSR[ usbEND_POINT_0 ];\r
818                 usbCSR_SET_BIT( &ulTemp, ( ( unsigned portLONG ) ( AT91C_UDP_EPEDS | AT91C_UDP_EPTYPE_CTRL ) ) );\r
819                 AT91C_BASE_UDP->UDP_CSR[ usbEND_POINT_0 ] = ulTemp;\r
820                 AT91F_UDP_EnableIt( AT91C_BASE_UDP, AT91C_UDP_EPINT0 );\r
821         }\r
822         portEXIT_CRITICAL();\r
823 }\r
824 /*-----------------------------------------------------------*/\r
825 \r
826 static void prvProcessEndPoint0Interrupt( xISRStatus *pxMessage )\r
827 {\r
828         if( pxMessage->ulCSR0 & AT91C_UDP_RX_DATA_BK0 )\r
829         {               \r
830                 /* We only expect to receive zero length data here as ACK's.\r
831                 Set the data pointer to the end of the current Tx packet to\r
832                 ensure we don't send out any more data. */      \r
833                 pxCharsForTx.ulNextCharIndex = pxCharsForTx.ulTotalDataLength;\r
834         }\r
835 \r
836         if( pxMessage->ulCSR0 & AT91C_UDP_TXCOMP )\r
837         {\r
838                 /* We received a TX complete interrupt.  What we do depends on\r
839                 what we sent to get this interrupt. */\r
840 \r
841                 if( eDriverState == eJUST_GOT_CONFIG )\r
842                 {\r
843                         /* We sent an acknowledgement of a SET_CONFIG request.  We\r
844                         are now at the end of the enumeration. */\r
845                         AT91C_BASE_UDP->UDP_GLBSTATE = AT91C_UDP_CONFG;\r
846 \r
847                         /* Read the end point for data transfer. */\r
848                         portENTER_CRITICAL();\r
849                         {\r
850                                 unsigned portLONG ulTemp;\r
851 \r
852                                 ulTemp = AT91C_BASE_UDP->UDP_CSR[ usbEND_POINT_1 ];                                     \r
853                                 usbCSR_SET_BIT( &ulTemp, AT91C_UDP_EPEDS | AT91C_UDP_EPTYPE_INT_IN );\r
854                                 AT91C_BASE_UDP->UDP_CSR[ usbEND_POINT_1 ] = ulTemp;             \r
855                                 AT91F_UDP_EnableIt( AT91C_BASE_UDP, AT91C_UDP_EPINT1 );\r
856                         }\r
857                         portEXIT_CRITICAL();\r
858 \r
859                         eDriverState = eREADY_TO_SEND;\r
860                 }               \r
861                 else if( eDriverState == eJUST_GOT_ADDRESS )\r
862                 {\r
863                         /* We sent an acknowledgement of a SET_ADDRESS request.  Move\r
864                         to the addressed state. */\r
865                         if( ulReceivedAddress != ( unsigned portLONG ) 0 )\r
866                         {                       \r
867                                 AT91C_BASE_UDP->UDP_GLBSTATE = AT91C_UDP_FADDEN;\r
868                         }\r
869                         else\r
870                         {\r
871                                 AT91C_BASE_UDP->UDP_GLBSTATE = 0;\r
872                         }                       \r
873 \r
874                         AT91C_BASE_UDP->UDP_FADDR = ( AT91C_UDP_FEN | ulReceivedAddress );              \r
875                         eDriverState = eNOTHING;\r
876                 }\r
877                 else\r
878                 {               \r
879                         /* The TXCOMP was not for any special type of transmission.  See\r
880                         if there is any more data to send. */\r
881                         prvSendNextSegment();\r
882                 }\r
883         }\r
884 \r
885         if( pxMessage->ulCSR0 & AT91C_UDP_RXSETUP )\r
886         {\r
887                 xUSB_REQUEST xRequest;\r
888                 unsigned portCHAR ucRequest;\r
889                 unsigned portLONG ulRxBytes;\r
890 \r
891                 /* A data packet is available. */       \r
892                 ulRxBytes = pxMessage->ulCSR0 >> 16;\r
893                 ulRxBytes &= usbRX_COUNT_MASK;\r
894 \r
895                 if( ulRxBytes >= usbEXPECTED_NUMBER_OF_BYTES )\r
896                 {\r
897                         /* Create an xUSB_REQUEST variable from the raw bytes array. */\r
898 \r
899                         xRequest.ucReqType = pxMessage->ucFifoData[ usbREQUEST_TYPE_INDEX ];\r
900                         xRequest.ucRequest = pxMessage->ucFifoData[ usbREQUEST_INDEX ];\r
901 \r
902                         /* NOT PORTABLE CODE! */\r
903                         xRequest.usValue = pxMessage->ucFifoData[ usbVALUE_HIGH_BYTE ];\r
904                         xRequest.usValue <<= 8;\r
905                         xRequest.usValue |= pxMessage->ucFifoData[ usbVALUE_LOW_BYTE ];\r
906                                                 \r
907                         xRequest.usIndex = pxMessage->ucFifoData[ usbINDEX_HIGH_BYTE ];\r
908                         xRequest.usIndex <<= 8;\r
909                         xRequest.usIndex |= pxMessage->ucFifoData[ usbINDEX_LOW_BYTE ];\r
910                         \r
911                         xRequest.usLength = pxMessage->ucFifoData[ usbLENGTH_HIGH_BYTE ];\r
912                         xRequest.usLength <<= 8;\r
913                         xRequest.usLength |= pxMessage->ucFifoData[ usbLENGTH_LOW_BYTE ];\r
914         \r
915                         /* Manipulate the ucRequestType and the ucRequest parameters to\r
916                         generate a zero based request selection.  This is just done to\r
917                         break up the requests into subsections for clarity.  The\r
918                         alternative would be to have more huge switch statement that would\r
919                         be difficult to optimise. */\r
920                         ucRequest = ( ( xRequest.ucReqType & 0x60 ) >> 3 );\r
921                         ucRequest |= ( xRequest.ucReqType & 0x03 );\r
922 \r
923                         switch( ucRequest )\r
924                         {\r
925                                 case usbSTANDARD_DEVICE_REQUEST:        \r
926                                                         /* Standard Device request */\r
927                                                         prvHandleStandardDeviceRequest( &xRequest );\r
928                                                         break;\r
929         \r
930                                 case usbSTANDARD_INTERFACE_REQUEST:     \r
931                                                         /* Standard Interface request */\r
932                                                         prvHandleStandardInterfaceRequest( &xRequest );\r
933                                                         break;\r
934         \r
935                                 case usbSTANDARD_END_POINT_REQUEST:     \r
936                                                         /* Standard Endpoint request */\r
937                                                         prvHandleStandardEndPointRequest( &xRequest );\r
938                                                         break;\r
939         \r
940                                 case usbCLASS_INTERFACE_REQUEST:        \r
941                                                         /* Class Interface request */\r
942                                                         prvHandleClassInterfaceRequest( &xRequest );\r
943                                                         break;\r
944         \r
945                                 default:        /* This is not something we want to respond to. */\r
946                                                         prvSendStall(); \r
947                         }\r
948                 }\r
949         }\r
950 }\r
951 /*-----------------------------------------------------------*/\r
952 \r
953 static void prvGetStandardDeviceDescriptor( xUSB_REQUEST *pxRequest )\r
954 {\r
955         /* The type is in the high byte.  Return whatever has been requested. */\r
956         switch( ( pxRequest->usValue & 0xff00 ) >> 8 )\r
957         {\r
958             case usbDESCRIPTOR_TYPE_DEVICE:\r
959                         prvSendControlData( ( unsigned portCHAR * ) &pxDeviceDescriptor, pxRequest->usLength, sizeof( pxDeviceDescriptor ), pdTRUE );\r
960                     break;\r
961         \r
962             case usbDESCRIPTOR_TYPE_CONFIGURATION:\r
963                         prvSendControlData( ( unsigned portCHAR * ) &( pxConfigDescriptor ), pxRequest->usLength, sizeof( pxConfigDescriptor ), pdTRUE );\r
964                     break;\r
965 \r
966             case usbDESCRIPTOR_TYPE_STRING:\r
967 \r
968                         /* The index to the string descriptor is the lower byte. */\r
969                     switch( pxRequest->usValue & 0xff )\r
970                         {                       \r
971                         case usbLANGUAGE_STRING:\r
972                                         prvSendControlData( ( unsigned portCHAR * ) &pxLanguageStringDescriptor, pxRequest->usLength, sizeof(pxLanguageStringDescriptor), pdTRUE );\r
973                                 break;\r
974 \r
975                         case usbMANUFACTURER_STRING:\r
976                                         prvSendControlData( ( unsigned portCHAR * ) &pxManufacturerStringDescriptor, pxRequest->usLength, sizeof( pxManufacturerStringDescriptor ), pdTRUE );\r
977                                 break;\r
978 \r
979                         case usbPRODUCT_STRING:\r
980                                         prvSendControlData( ( unsigned portCHAR * ) &pxProductStringDescriptor, pxRequest->usLength, sizeof( pxProductStringDescriptor ), pdTRUE );\r
981                                 break;\r
982 \r
983                         case usbCONFIGURATION_STRING:\r
984                                         prvSendControlData( ( unsigned portCHAR * ) &pxConfigurationStringDescriptor, pxRequest->usLength, sizeof( pxConfigurationStringDescriptor ), pdTRUE );\r
985                                 break;\r
986 \r
987                         case usbINTERFACE_STRING:\r
988                                         prvSendControlData( ( unsigned portCHAR * ) &pxInterfaceStringDescriptor, pxRequest->usLength, sizeof( pxInterfaceStringDescriptor ), pdTRUE );\r
989                                 break;\r
990 \r
991                         default:\r
992                                 /* Don't know what this string is. */\r
993                                         prvSendStall();\r
994                                         break;\r
995                         }\r
996 \r
997                         break;\r
998 \r
999             default:\r
1000                         /* We are not responding to anything else. */\r
1001                         prvSendStall();\r
1002                     break;\r
1003         }\r
1004 }\r
1005 /*-----------------------------------------------------------*/\r
1006 \r
1007 static void prvHandleStandardDeviceRequest( xUSB_REQUEST *pxRequest )\r
1008 {\r
1009 unsigned portSHORT usStatus = 0;\r
1010 \r
1011         switch( pxRequest->ucRequest )\r
1012         {\r
1013             case usbGET_STATUS_REQUEST:\r
1014                         /* Just send two byte dummy status. */\r
1015                         prvSendControlData( ( unsigned portCHAR * ) &usStatus, sizeof( usStatus ), sizeof( usStatus ), pdFALSE );\r
1016                     break;\r
1017 \r
1018             case usbGET_DESCRIPTOR_REQUEST:\r
1019                         /* Send device descriptor */\r
1020                     prvGetStandardDeviceDescriptor( pxRequest );\r
1021                     break;\r
1022 \r
1023             case usbGET_CONFIGURATION_REQUEST:\r
1024                         /* Send selected device configuration */\r
1025                         prvSendControlData( ( unsigned portCHAR * ) &ucUSBConfig, sizeof( ucUSBConfig ), sizeof( ucUSBConfig ), pdFALSE );\r
1026                     break;\r
1027 \r
1028                 case usbSET_FEATURE_REQUEST:\r
1029                     prvUSBTransmitNull();\r
1030                     break;\r
1031 \r
1032             case usbSET_ADDRESS_REQUEST:\r
1033                 \r
1034                         /* Acknowledge the SET_ADDRESS, but (according to the manual) we\r
1035                         cannot actually move to the addressed state until we get a TXCOMP\r
1036                         interrupt from this NULL packet.  Therefore we just remember the\r
1037                         address and set our state so we know we have received the address. */\r
1038                 prvUSBTransmitNull();                   \r
1039                         eDriverState = eJUST_GOT_ADDRESS;               \r
1040                         ulReceivedAddress = ( unsigned portLONG ) pxRequest->usValue;\r
1041                     break;\r
1042 \r
1043             case usbSET_CONFIGURATION_REQUEST:\r
1044 \r
1045                         /* Acknowledge the SET_CONFIGURATION, but (according to the manual)\r
1046                         we cannot actually move to the configured state until we get a\r
1047                         TXCOMP interrupt from this NULL packet.  Therefore we just remember the\r
1048                         config and set our state so we know we have received the go ahead. */                   \r
1049                         ucUSBConfig = ( unsigned portCHAR ) ( pxRequest->usValue & 0xff );\r
1050                         eDriverState = eJUST_GOT_CONFIG;\r
1051                         prvUSBTransmitNull();\r
1052                     break;\r
1053 \r
1054             default:\r
1055 \r
1056                     /* We don't answer to anything else. */\r
1057                         prvSendStall();\r
1058                     break;\r
1059         }\r
1060 }\r
1061 /*-----------------------------------------------------------*/\r
1062 \r
1063 static void prvHandleClassInterfaceRequest( xUSB_REQUEST *pxRequest )\r
1064 {\r
1065         switch( pxRequest->ucRequest )\r
1066         {\r
1067             case usbSET_IDLE_REQUEST:\r
1068                 prvUSBTransmitNull();\r
1069                         break;\r
1070 \r
1071                 /* This minimal implementation ignores these. */\r
1072             case usbGET_REPORT_REQUEST:\r
1073             case usbGET_IDLE_REQUEST:\r
1074             case usbGET_PROTOCOL_REQUEST:\r
1075             case usbSET_REPORT_REQUEST:\r
1076             case usbSET_PROTOCOL_REQUEST:       \r
1077             default:\r
1078 \r
1079                         prvSendStall();\r
1080                         break;\r
1081         }\r
1082 }\r
1083 /*-----------------------------------------------------------*/\r
1084 \r
1085 static void prvGetStandardInterfaceDescriptor( xUSB_REQUEST *pxRequest )\r
1086 {\r
1087         switch( ( pxRequest->usValue & ( unsigned portSHORT ) 0xff00 ) >> 8 )\r
1088         {\r
1089             case usbHID_REPORT_DESCRIPTOR:\r
1090                         prvSendControlData( ( unsigned portCHAR * ) pxReportDescriptor, pxRequest->usLength, sizeof( pxReportDescriptor ), pdTRUE );\r
1091                     break;\r
1092 \r
1093             default:\r
1094 \r
1095                         /* Don't expect to send any others. */\r
1096                         prvSendStall();\r
1097                     break;\r
1098         }\r
1099 }\r
1100 /*-----------------------------------------------------------*/\r
1101 \r
1102 static void prvHandleStandardInterfaceRequest( xUSB_REQUEST *pxRequest )\r
1103 {\r
1104 unsigned portSHORT usStatus = 0;\r
1105 \r
1106         switch( pxRequest->ucRequest )\r
1107         {\r
1108             case usbGET_STATUS_REQUEST:\r
1109                         /* Send dummy 2 bytes. */\r
1110                         prvSendControlData( ( unsigned portCHAR * ) &usStatus, sizeof( usStatus ), sizeof( usStatus ), pdFALSE );\r
1111                         break;\r
1112 \r
1113             case usbGET_DESCRIPTOR_REQUEST:\r
1114                         prvGetStandardInterfaceDescriptor( pxRequest );\r
1115                         break;\r
1116 \r
1117                 /* This minimal implementation does not respond to these. */\r
1118             case usbGET_INTERFACE_REQUEST:\r
1119             case usbSET_FEATURE_REQUEST:\r
1120             case usbSET_INTERFACE_REQUEST:      \r
1121 \r
1122             default:\r
1123                         prvSendStall();\r
1124                         break;\r
1125         }\r
1126 }\r
1127 /*-----------------------------------------------------------*/\r
1128 \r
1129 static void prvHandleStandardEndPointRequest( xUSB_REQUEST *pxRequest )\r
1130 {\r
1131         switch( pxRequest->ucRequest )\r
1132         {\r
1133                 /* This minimal implementation does not expect to respond to these. */\r
1134             case usbGET_STATUS_REQUEST:\r
1135             case usbCLEAR_FEATURE_REQUEST:\r
1136             case usbSET_FEATURE_REQUEST:\r
1137 \r
1138             default:                    \r
1139                         prvSendStall();\r
1140                         break;\r
1141         }\r
1142 }\r
1143 /*-----------------------------------------------------------*/\r
1144 \r
1145 static void vInitUSBInterface( void )\r
1146 {\r
1147 volatile unsigned portLONG ulTemp;\r
1148 \r
1149         /* Create the queue used to communicate between the USB ISR and task. */\r
1150         xUSBInterruptQueue = xQueueCreate( usbQUEUE_LENGTH + 1, sizeof( xISRStatus * ) );\r
1151 \r
1152         /* Initialise a few state variables. */\r
1153         pxCharsForTx.ulNextCharIndex = ( unsigned portLONG ) 0;\r
1154         ucUSBConfig = ( unsigned portCHAR ) 0;\r
1155         eDriverState = eNOTHING;\r
1156 \r
1157         /* HARDWARE SETUP */\r
1158 \r
1159     /* Set the PLL USB Divider */\r
1160     AT91C_BASE_CKGR->CKGR_PLLR |= AT91C_CKGR_USBDIV_1;\r
1161 \r
1162     /* Enables the 48MHz USB clock UDPCK and System Peripheral USB Clock. */\r
1163     AT91C_BASE_PMC->PMC_SCER = AT91C_PMC_UDP;\r
1164     AT91C_BASE_PMC->PMC_PCER = (1 << AT91C_ID_UDP);\r
1165 \r
1166     /* Setup the PIO for the USB pull up resistor. */\r
1167     AT91F_PIO_CfgOutput(AT91C_BASE_PIOA,AT91C_PIO_PA16);\r
1168 \r
1169     /* Start without the pullup - this will get set at the end of this\r
1170         function. */\r
1171     AT91F_PIO_SetOutput( AT91C_BASE_PIOA, AT91C_PIO_PA16 );\r
1172 \r
1173         /* When using the USB debugger the peripheral registers do not always get\r
1174         set to the correct default values.  To make sure set the relevant registers\r
1175         manually here. */\r
1176         AT91C_BASE_UDP->UDP_IDR = ( unsigned portLONG ) 0xffffffff;\r
1177         AT91C_BASE_UDP->UDP_ICR = ( unsigned portLONG ) 0xffffffff;\r
1178         AT91C_BASE_UDP->UDP_CSR[ 0 ] = ( unsigned portLONG ) 0x00;\r
1179         AT91C_BASE_UDP->UDP_CSR[ 1 ] = ( unsigned portLONG ) 0x00;\r
1180         AT91C_BASE_UDP->UDP_GLBSTATE = 0;\r
1181         AT91C_BASE_UDP->UDP_FADDR = 0;\r
1182 \r
1183         /* Enable the transceiver. */\r
1184         AT91C_UDP_TRANSCEIVER_ENABLE = 0;\r
1185 \r
1186         /* Enable the USB interrupts - other interrupts get enabled as the\r
1187         enumeration process progresses. */\r
1188         AT91F_AIC_ConfigureIt( AT91C_BASE_AIC, AT91C_ID_UDP, usbINTERRUPT_PRIORITY, AT91C_AIC_SRCTYPE_INT_LEVEL_SENSITIVE, ( void (*)( void ) ) vUSBISREntry );\r
1189         AT91F_AIC_EnableIt( AT91C_BASE_AIC, AT91C_ID_UDP );\r
1190 \r
1191         /* Wait a short while before making our presence known. */\r
1192         vTaskDelay( usbINIT_DELAY );\r
1193     AT91F_PIO_ClearOutput(AT91C_BASE_PIOA, AT91C_PIO_PA16 );\r
1194 }\r
1195 /*-----------------------------------------------------------*/\r
1196 \r
1197 static void prvSendControlData( unsigned portCHAR *pucData, unsigned portSHORT usRequestedLength, unsigned portLONG ulLengthToSend, portLONG lSendingDescriptor )\r
1198 {\r
1199         if( ( ( unsigned portLONG ) usRequestedLength < ulLengthToSend ) )\r
1200         {\r
1201                 /* Cap the data length to that requested. */\r
1202                 ulLengthToSend = ( unsigned portSHORT ) usRequestedLength;\r
1203         }\r
1204         else if( ( ulLengthToSend < ( unsigned portLONG ) usRequestedLength ) && lSendingDescriptor )\r
1205         {\r
1206                 /* We are sending a descriptor.  If the descriptor is an exact\r
1207                 multiple of the FIFO length then it will have to be terminated\r
1208                 with a NULL packet.  Set the state to indicate this if\r
1209                 necessary. */\r
1210                 if( ( ulLengthToSend % usbFIFO_LENGTH ) == 0 )\r
1211                 {\r
1212                         eDriverState = eSENDING_EVEN_DESCRIPTOR;\r
1213                 }\r
1214         }\r
1215 \r
1216         /* Here we assume that the previous message has been sent.  THERE IS NO\r
1217         BUFFER OVERFLOW PROTECTION HERE.\r
1218 \r
1219         Copy the data to send into the buffer as we cannot send it all at once\r
1220         (if it is greater than 8 bytes in length). */\r
1221         memcpy( pxCharsForTx.ucTxBuffer, pucData, ulLengthToSend );\r
1222 \r
1223         /* Reinitialise the buffer index so we start sending from the start of\r
1224         the data. */\r
1225         pxCharsForTx.ulTotalDataLength = ulLengthToSend;\r
1226         pxCharsForTx.ulNextCharIndex = ( unsigned portLONG ) 0;\r
1227 \r
1228         /* Send the first 8 bytes now.  The rest will get sent in response to\r
1229         TXCOMP interrupts. */\r
1230         prvSendNextSegment();\r
1231 }\r
1232 /*-----------------------------------------------------------*/\r
1233 \r
1234 static void prvSendNextSegment( void )\r
1235 {\r
1236 volatile unsigned portLONG ulNextLength, ulStatus, ulLengthLeftToSend;\r
1237 \r
1238         /* Is there any data to send? */\r
1239         if( pxCharsForTx.ulTotalDataLength > pxCharsForTx.ulNextCharIndex )\r
1240         {\r
1241                 ulLengthLeftToSend = pxCharsForTx.ulTotalDataLength - pxCharsForTx.ulNextCharIndex;\r
1242         \r
1243                 /* We can only send 8 bytes to the fifo at a time. */\r
1244                 if( ulLengthLeftToSend > usbFIFO_LENGTH )\r
1245                 {\r
1246                         ulNextLength = usbFIFO_LENGTH;\r
1247                 }\r
1248                 else\r
1249                 {\r
1250                         ulNextLength = ulLengthLeftToSend;\r
1251                 }\r
1252 \r
1253                 /* Wait until we can place data in the fifo.  THERE IS NO TIMEOUT\r
1254                 HERE! */\r
1255                 while( AT91C_BASE_UDP->UDP_CSR[ usbEND_POINT_0 ] & AT91C_UDP_TXPKTRDY )\r
1256                 {\r
1257                         vTaskDelay( usbSHORTEST_DELAY );\r
1258                 }\r
1259 \r
1260                 /* Write the data to the FIFO. */\r
1261                 while( ulNextLength > ( unsigned portLONG ) 0 )\r
1262                 {\r
1263                         AT91C_BASE_UDP->UDP_FDR[ usbEND_POINT_0 ] = pxCharsForTx.ucTxBuffer[ pxCharsForTx.ulNextCharIndex ];\r
1264         \r
1265                         ulNextLength--;\r
1266                         pxCharsForTx.ulNextCharIndex++;\r
1267                 }\r
1268         \r
1269                 /* Start the transmission. */\r
1270                 portENTER_CRITICAL();\r
1271                 {\r
1272                         ulStatus = AT91C_BASE_UDP->UDP_CSR[ usbEND_POINT_0 ];\r
1273                         usbCSR_SET_BIT( &ulStatus, ( ( unsigned portLONG ) 0x10 ) );\r
1274                         AT91C_BASE_UDP->UDP_CSR[ usbEND_POINT_0 ] = ulStatus;\r
1275                 }\r
1276                 portEXIT_CRITICAL();\r
1277         }\r
1278         else\r
1279         {\r
1280                 /* There is no data to send.  If we were sending a descriptor and the\r
1281                 descriptor was an exact multiple of the max packet size then we need\r
1282                 to send a null to terminate the transmission. */\r
1283                 if( eDriverState == eSENDING_EVEN_DESCRIPTOR )\r
1284                 {\r
1285                         prvUSBTransmitNull();\r
1286                         eDriverState = eNOTHING;\r
1287                 }\r
1288         }\r
1289 }\r
1290 \r
1291 \r
1292 \r