1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18#ifndef __USBDCORE_H__
19#define __USBDCORE_H__
20
21#include <common.h>
22#include "usbdescriptors.h"
23
24
25#define MAX_URBS_QUEUED 5
26
27
28#if 1
29#define usberr(fmt,args...) serial_printf("ERROR: %s(), %d: "fmt"\n",__FUNCTION__,__LINE__,##args)
30#else
31#define usberr(fmt,args...) do{}while(0)
32#endif
33
34#if 0
35#define usbdbg(fmt,args...) serial_printf("debug: %s(), %d: "fmt"\n",__FUNCTION__,__LINE__,##args)
36#else
37#define usbdbg(fmt,args...) do{}while(0)
38#endif
39
40#if 0
41#define usbinfo(fmt,args...) serial_printf("info: %s(), %d: "fmt"\n",__FUNCTION__,__LINE__,##args)
42#else
43#define usbinfo(fmt,args...) do{}while(0)
44#endif
45
46#ifndef le16_to_cpu
47#define le16_to_cpu(x) (x)
48#endif
49
50#ifndef inb
51#define inb(p) (*(volatile u8*)(p))
52#endif
53
54#ifndef outb
55#define outb(val,p) (*(volatile u8*)(p) = (val))
56#endif
57
58#ifndef inw
59#define inw(p) (*(volatile u16*)(p))
60#endif
61
62#ifndef outw
63#define outw(val,p) (*(volatile u16*)(p) = (val))
64#endif
65
66#ifndef inl
67#define inl(p) (*(volatile u32*)(p))
68#endif
69
70#ifndef outl
71#define outl(val,p) (*(volatile u32*)(p) = (val))
72#endif
73
74#ifndef insw
75#define insw(p,to,len) mmio_insw(p,to,len)
76#endif
77
78#ifndef outsw
79#define outsw(p,from,len) mmio_outsw(p,from,len)
80#endif
81
82#ifndef insb
83#define insb(p,to,len) mmio_insb(p,to,len)
84#endif
85
86#ifndef mmio_insw
87#define mmio_insw(r,b,l) ({ int __i ; \
88 u16 *__b2; \
89 __b2 = (u16 *) b; \
90 for (__i = 0; __i < l; __i++) { \
91 *(__b2 + __i) = inw(r); \
92 }; \
93 })
94#endif
95
96#ifndef mmio_outsw
97#define mmio_outsw(r,b,l) ({ int __i; \
98 u16 *__b2; \
99 __b2 = (u16 *) b; \
100 for (__i = 0; __i < l; __i++) { \
101 outw( *(__b2 + __i), r); \
102 } \
103 })
104#endif
105
106#ifndef mmio_insb
107#define mmio_insb(r,b,l) ({ int __i ; \
108 u8 *__b2; \
109 __b2 = (u8 *) b; \
110 for (__i = 0; __i < l; __i++) { \
111 *(__b2 + __i) = inb(r); \
112 }; \
113 })
114#endif
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142#define _cv_(ptr) ((char*)(void*)(ptr))
143#define member_offset(type,memb) (_cv_(&(((type*)0)->memb))-(char*)0)
144#define p2surround(type,memb,ptr) ((type*)(void*)(_cv_(ptr)-member_offset(type,memb)))
145
146struct urb;
147
148struct usb_endpoint_instance;
149struct usb_interface_instance;
150struct usb_configuration_instance;
151struct usb_device_instance;
152struct usb_bus_instance;
153
154
155
156
157#define USB_CLASS_PER_INTERFACE 0
158#define USB_CLASS_AUDIO 1
159#define USB_CLASS_COMM 2
160#define USB_CLASS_HID 3
161#define USB_CLASS_PHYSICAL 5
162#define USB_CLASS_PRINTER 7
163#define USB_CLASS_MASS_STORAGE 8
164#define USB_CLASS_HUB 9
165#define USB_CLASS_DATA 10
166#define USB_CLASS_APP_SPEC 0xfe
167#define USB_CLASS_VENDOR_SPEC 0xff
168
169
170
171
172#define USB_TYPE_STANDARD (0x00 << 5)
173#define USB_TYPE_CLASS (0x01 << 5)
174#define USB_TYPE_VENDOR (0x02 << 5)
175#define USB_TYPE_RESERVED (0x03 << 5)
176
177
178
179
180#define USB_RECIP_DEVICE 0x00
181#define USB_RECIP_INTERFACE 0x01
182#define USB_RECIP_ENDPOINT 0x02
183#define USB_RECIP_OTHER 0x03
184
185
186
187
188#define USB_DIR_OUT 0
189#define USB_DIR_IN 0x80
190
191
192
193
194#define USB_DT_DEVICE 0x01
195#define USB_DT_CONFIG 0x02
196#define USB_DT_STRING 0x03
197#define USB_DT_INTERFACE 0x04
198#define USB_DT_ENDPOINT 0x05
199
200#if defined(CONFIG_USBD_HS)
201#define USB_DT_QUAL 0x06
202#endif
203
204#define USB_DT_HID (USB_TYPE_CLASS | 0x01)
205#define USB_DT_REPORT (USB_TYPE_CLASS | 0x02)
206#define USB_DT_PHYSICAL (USB_TYPE_CLASS | 0x03)
207#define USB_DT_HUB (USB_TYPE_CLASS | 0x09)
208
209
210
211
212#define USB_DT_DEVICE_SIZE 18
213#define USB_DT_CONFIG_SIZE 9
214#define USB_DT_INTERFACE_SIZE 9
215#define USB_DT_ENDPOINT_SIZE 7
216#define USB_DT_ENDPOINT_AUDIO_SIZE 9
217#define USB_DT_HUB_NONVAR_SIZE 7
218#define USB_DT_HID_SIZE 9
219
220
221
222
223#define USB_ENDPOINT_NUMBER_MASK 0x0f
224#define USB_ENDPOINT_DIR_MASK 0x80
225
226#define USB_ENDPOINT_XFERTYPE_MASK 0x03
227#define USB_ENDPOINT_XFER_CONTROL 0
228#define USB_ENDPOINT_XFER_ISOC 1
229#define USB_ENDPOINT_XFER_BULK 2
230#define USB_ENDPOINT_XFER_INT 3
231
232
233
234
235#define USB_PID_UNDEF_0 0xf0
236#define USB_PID_OUT 0xe1
237#define USB_PID_ACK 0xd2
238#define USB_PID_DATA0 0xc3
239#define USB_PID_PING 0xb4
240#define USB_PID_SOF 0xa5
241#define USB_PID_NYET 0x96
242#define USB_PID_DATA2 0x87
243#define USB_PID_SPLIT 0x78
244#define USB_PID_IN 0x69
245#define USB_PID_NAK 0x5a
246#define USB_PID_DATA1 0x4b
247#define USB_PID_PREAMBLE 0x3c
248#define USB_PID_ERR 0x3c
249#define USB_PID_SETUP 0x2d
250#define USB_PID_STALL 0x1e
251#define USB_PID_MDATA 0x0f
252
253
254
255
256#define USB_REQ_GET_STATUS 0x00
257#define USB_REQ_CLEAR_FEATURE 0x01
258#define USB_REQ_SET_FEATURE 0x03
259#define USB_REQ_SET_ADDRESS 0x05
260#define USB_REQ_GET_DESCRIPTOR 0x06
261#define USB_REQ_SET_DESCRIPTOR 0x07
262#define USB_REQ_GET_CONFIGURATION 0x08
263#define USB_REQ_SET_CONFIGURATION 0x09
264#define USB_REQ_GET_INTERFACE 0x0A
265#define USB_REQ_SET_INTERFACE 0x0B
266#define USB_REQ_SYNCH_FRAME 0x0C
267
268#define USBD_DEVICE_REQUESTS(x) (((unsigned int)x <= USB_REQ_SYNCH_FRAME) ? usbd_device_requests[x] : "UNKNOWN")
269
270
271
272
273#define USB_REQ_GET_REPORT 0x01
274#define USB_REQ_GET_IDLE 0x02
275#define USB_REQ_GET_PROTOCOL 0x03
276#define USB_REQ_SET_REPORT 0x09
277#define USB_REQ_SET_IDLE 0x0A
278#define USB_REQ_SET_PROTOCOL 0x0B
279
280
281
282
283
284
285#if defined(CONFIG_USBD_HS)
286#define USB_BCD_VERSION 0x0200
287#else
288#define USB_BCD_VERSION 0x0110
289#endif
290
291
292
293
294
295
296#define USB_REQ_DIRECTION_MASK 0x80
297#define USB_REQ_TYPE_MASK 0x60
298#define USB_REQ_RECIPIENT_MASK 0x1f
299
300#define USB_REQ_DEVICE2HOST 0x80
301#define USB_REQ_HOST2DEVICE 0x00
302
303#define USB_REQ_TYPE_STANDARD 0x00
304#define USB_REQ_TYPE_CLASS 0x20
305#define USB_REQ_TYPE_VENDOR 0x40
306
307#define USB_REQ_RECIPIENT_DEVICE 0x00
308#define USB_REQ_RECIPIENT_INTERFACE 0x01
309#define USB_REQ_RECIPIENT_ENDPOINT 0x02
310#define USB_REQ_RECIPIENT_OTHER 0x03
311
312
313
314
315
316#define USB_STATUS_SELFPOWERED 0x01
317#define USB_STATUS_REMOTEWAKEUP 0x02
318
319#define USB_STATUS_HALT 0x01
320
321
322
323
324
325#define USB_DESCRIPTOR_TYPE_DEVICE 0x01
326#define USB_DESCRIPTOR_TYPE_CONFIGURATION 0x02
327#define USB_DESCRIPTOR_TYPE_STRING 0x03
328#define USB_DESCRIPTOR_TYPE_INTERFACE 0x04
329#define USB_DESCRIPTOR_TYPE_ENDPOINT 0x05
330#define USB_DESCRIPTOR_TYPE_DEVICE_QUALIFIER 0x06
331#define USB_DESCRIPTOR_TYPE_OTHER_SPEED_CONFIGURATION 0x07
332#define USB_DESCRIPTOR_TYPE_INTERFACE_POWER 0x08
333#define USB_DESCRIPTOR_TYPE_HID 0x21
334#define USB_DESCRIPTOR_TYPE_REPORT 0x22
335
336#define USBD_DEVICE_DESCRIPTORS(x) (((unsigned int)x <= USB_DESCRIPTOR_TYPE_INTERFACE_POWER) ? \
337 usbd_device_descriptors[x] : "UNKNOWN")
338
339
340
341
342#define USB_ENDPOINT_HALT 0x00
343#define USB_DEVICE_REMOTE_WAKEUP 0x01
344#define USB_TEST_MODE 0x02
345
346
347
348
349
350
351struct usb_device_request {
352 u8 bmRequestType;
353 u8 bRequest;
354 u16 wValue;
355 u16 wIndex;
356 u16 wLength;
357} __attribute__ ((packed));
358
359
360
361
362
363typedef enum urb_send_status {
364 SEND_IN_PROGRESS,
365 SEND_FINISHED_OK,
366 SEND_FINISHED_ERROR,
367 RECV_READY,
368 RECV_OK,
369 RECV_ERROR
370} urb_send_status_t;
371
372
373
374
375
376
377
378
379
380
381typedef enum usb_device_state {
382 STATE_INIT,
383 STATE_CREATED,
384 STATE_ATTACHED,
385 STATE_POWERED,
386 STATE_DEFAULT,
387 STATE_ADDRESSED,
388 STATE_CONFIGURED,
389 STATE_UNKNOWN,
390} usb_device_state_t;
391
392#define USBD_DEVICE_STATE(x) (((unsigned int)x <= STATE_UNKNOWN) ? usbd_device_states[x] : "UNKNOWN")
393
394
395
396
397
398
399typedef enum usb_device_status {
400 USBD_OPENING,
401 USBD_OK,
402 USBD_SUSPENDED,
403 USBD_CLOSING,
404} usb_device_status_t;
405
406#define USBD_DEVICE_STATUS(x) (((unsigned int)x <= USBD_CLOSING) ? usbd_device_status[x] : "UNKNOWN")
407
408
409
410
411
412
413
414
415
416
417typedef enum usb_device_event {
418
419 DEVICE_UNKNOWN,
420 DEVICE_INIT,
421 DEVICE_CREATE,
422 DEVICE_HUB_CONFIGURED,
423 DEVICE_RESET,
424
425 DEVICE_ADDRESS_ASSIGNED,
426 DEVICE_CONFIGURED,
427 DEVICE_SET_INTERFACE,
428
429 DEVICE_SET_FEATURE,
430 DEVICE_CLEAR_FEATURE,
431
432 DEVICE_DE_CONFIGURED,
433
434 DEVICE_BUS_INACTIVE,
435 DEVICE_BUS_ACTIVITY,
436
437 DEVICE_POWER_INTERRUPTION,
438 DEVICE_HUB_RESET,
439 DEVICE_DESTROY,
440
441 DEVICE_HOTPLUG,
442
443 DEVICE_FUNCTION_PRIVATE,
444
445} usb_device_event_t;
446
447
448typedef struct urb_link {
449 struct urb_link *next;
450 struct urb_link *prev;
451} urb_link;
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466#define URB_BUF_SIZE 512
467
468struct urb {
469
470 struct usb_endpoint_instance *endpoint;
471 struct usb_device_instance *device;
472
473 struct usb_device_request device_request;
474
475 struct urb_link link;
476
477 u8* buffer;
478 unsigned int buffer_length;
479 unsigned int actual_length;
480
481 urb_send_status_t status;
482 int data;
483
484 u16 buffer_data[URB_BUF_SIZE];
485};
486
487
488
489
490
491
492
493struct usb_endpoint_instance {
494 int endpoint_address;
495
496
497 int status;
498 int state;
499
500
501 struct urb_link rcv;
502 struct urb_link rdy;
503 struct urb *rcv_urb;
504 int rcv_attributes;
505 int rcv_packetSize;
506 int rcv_transferSize;
507 int rcv_queue;
508
509
510 struct urb_link tx;
511 struct urb_link done;
512 struct urb *tx_urb;
513 int tx_attributes;
514 int tx_packetSize;
515 int tx_transferSize;
516 int tx_queue;
517
518 int sent;
519 int last;
520};
521
522struct usb_alternate_instance {
523 struct usb_interface_descriptor *interface_descriptor;
524
525 int endpoints;
526 int *endpoint_transfersize_array;
527 struct usb_endpoint_descriptor **endpoints_descriptor_array;
528};
529
530struct usb_interface_instance {
531 int alternates;
532 struct usb_alternate_instance *alternates_instance_array;
533};
534
535struct usb_configuration_instance {
536 int interfaces;
537 struct usb_configuration_descriptor *configuration_descriptor;
538 struct usb_interface_instance *interface_instance_array;
539};
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560struct usb_device_instance {
561
562
563 char *name;
564 struct usb_device_descriptor *device_descriptor;
565#if defined(CONFIG_USBD_HS)
566 struct usb_qualifier_descriptor *qualifier_descriptor;
567#endif
568
569 void (*event) (struct usb_device_instance *device, usb_device_event_t event, int data);
570
571
572 int (*cdc_recv_setup)(struct usb_device_request *request, struct urb *urb);
573
574
575 struct usb_bus_instance *bus;
576
577
578 int configurations;
579 struct usb_configuration_instance *configuration_instance_array;
580
581
582 usb_device_state_t device_state;
583 usb_device_state_t device_previous_state;
584
585 u8 address;
586 u8 configuration;
587 u8 interface;
588 u8 alternate;
589
590 usb_device_status_t status;
591
592 int urbs_queued;
593
594
595 unsigned long usbd_rxtx_timestamp;
596 unsigned long usbd_last_rxtx_timestamp;
597
598};
599
600
601
602
603
604
605
606
607struct usb_bus_instance {
608
609 struct usb_device_instance *device;
610 struct usb_endpoint_instance *endpoint_array;
611
612 int max_endpoints;
613 unsigned char maxpacketsize;
614
615 unsigned int serial_number;
616 char *serial_number_str;
617 void *privdata;
618
619};
620
621extern char *usbd_device_events[];
622extern char *usbd_device_states[];
623extern char *usbd_device_status[];
624extern char *usbd_device_requests[];
625extern char *usbd_device_descriptors[];
626
627void urb_link_init (urb_link * ul);
628void urb_detach (struct urb *urb);
629urb_link *first_urb_link (urb_link * hd);
630struct urb *first_urb (urb_link * hd);
631struct urb *first_urb_detached (urb_link * hd);
632void urb_append (urb_link * hd, struct urb *urb);
633
634struct urb *usbd_alloc_urb (struct usb_device_instance *device, struct usb_endpoint_instance *endpoint);
635void usbd_dealloc_urb (struct urb *urb);
636
637
638
639
640
641void usbd_device_event_irq (struct usb_device_instance *conf, usb_device_event_t, int);
642void usbd_device_event (struct usb_device_instance *conf, usb_device_event_t, int);
643
644
645
646
647
648
649struct usb_configuration_descriptor *usbd_device_configuration_descriptor (struct usb_device_instance *, int, int);
650struct usb_function_instance *usbd_device_function_instance (struct usb_device_instance *, unsigned int);
651struct usb_interface_instance *usbd_device_interface_instance (struct usb_device_instance *, int, int, int);
652struct usb_alternate_instance *usbd_device_alternate_instance (struct usb_device_instance *, int, int, int, int);
653struct usb_interface_descriptor *usbd_device_interface_descriptor (struct usb_device_instance *, int, int, int, int);
654struct usb_endpoint_descriptor *usbd_device_endpoint_descriptor_index (struct usb_device_instance *, int, int, int, int, int);
655struct usb_class_descriptor *usbd_device_class_descriptor_index (struct usb_device_instance *, int, int, int, int, int);
656struct usb_class_report_descriptor *usbd_device_class_report_descriptor_index( struct usb_device_instance *, int , int , int , int , int );
657struct usb_endpoint_descriptor *usbd_device_endpoint_descriptor (struct usb_device_instance *, int, int, int, int, int);
658int usbd_device_endpoint_transfersize (struct usb_device_instance *, int, int, int, int, int);
659struct usb_string_descriptor *usbd_get_string (u8);
660struct usb_device_descriptor *usbd_device_device_descriptor(struct
661 usb_device_instance *, int);
662
663#if defined(CONFIG_USBD_HS)
664
665
666
667
668
669int is_usbd_high_speed(void);
670#endif
671int usbd_endpoint_halted (struct usb_device_instance *device, int endpoint);
672void usbd_rcv_complete(struct usb_endpoint_instance *endpoint, int len, int urb_bad);
673void usbd_tx_complete (struct usb_endpoint_instance *endpoint);
674
675
676#ifdef DEBUG
677static inline void print_urb(struct urb *u)
678{
679 serial_printf("urb %p\n", (u));
680 serial_printf("\tendpoint %p\n", u->endpoint);
681 serial_printf("\tdevice %p\n", u->device);
682 serial_printf("\tbuffer %p\n", u->buffer);
683 serial_printf("\tbuffer_length %d\n", u->buffer_length);
684 serial_printf("\tactual_length %d\n", u->actual_length);
685 serial_printf("\tstatus %d\n", u->status);
686 serial_printf("\tdata %d\n", u->data);
687}
688
689static inline void print_usb_device_request(struct usb_device_request *r)
690{
691 serial_printf("usb request\n");
692 serial_printf("\tbmRequestType 0x%2.2x\n", r->bmRequestType);
693 if ((r->bmRequestType & USB_REQ_DIRECTION_MASK) == 0)
694 serial_printf("\t\tDirection : To device\n");
695 else
696 serial_printf("\t\tDirection : To host\n");
697 if ((r->bmRequestType & USB_TYPE_STANDARD) == USB_TYPE_STANDARD)
698 serial_printf("\t\tType : Standard\n");
699 if ((r->bmRequestType & USB_TYPE_CLASS) == USB_TYPE_CLASS)
700 serial_printf("\t\tType : Standard\n");
701 if ((r->bmRequestType & USB_TYPE_VENDOR) == USB_TYPE_VENDOR)
702 serial_printf("\t\tType : Standard\n");
703 if ((r->bmRequestType & USB_TYPE_RESERVED) == USB_TYPE_RESERVED)
704 serial_printf("\t\tType : Standard\n");
705 if ((r->bmRequestType & USB_REQ_RECIPIENT_MASK) ==
706 USB_REQ_RECIPIENT_DEVICE)
707 serial_printf("\t\tRecipient : Device\n");
708 if ((r->bmRequestType & USB_REQ_RECIPIENT_MASK) ==
709 USB_REQ_RECIPIENT_INTERFACE)
710 serial_printf("\t\tRecipient : Interface\n");
711 if ((r->bmRequestType & USB_REQ_RECIPIENT_MASK) ==
712 USB_REQ_RECIPIENT_ENDPOINT)
713 serial_printf("\t\tRecipient : Endpoint\n");
714 if ((r->bmRequestType & USB_REQ_RECIPIENT_MASK) ==
715 USB_REQ_RECIPIENT_OTHER)
716 serial_printf("\t\tRecipient : Other\n");
717 serial_printf("\tbRequest 0x%2.2x\n", r->bRequest);
718 if (r->bRequest == USB_REQ_GET_STATUS)
719 serial_printf("\t\tGET_STATUS\n");
720 else if (r->bRequest == USB_REQ_SET_ADDRESS)
721 serial_printf("\t\tSET_ADDRESS\n");
722 else if (r->bRequest == USB_REQ_SET_FEATURE)
723 serial_printf("\t\tSET_FEATURE\n");
724 else if (r->bRequest == USB_REQ_GET_DESCRIPTOR)
725 serial_printf("\t\tGET_DESCRIPTOR\n");
726 else if (r->bRequest == USB_REQ_SET_CONFIGURATION)
727 serial_printf("\t\tSET_CONFIGURATION\n");
728 else if (r->bRequest == USB_REQ_SET_INTERFACE)
729 serial_printf("\t\tUSB_REQ_SET_INTERFACE\n");
730 else
731 serial_printf("\tUNKNOWN %d\n", r->bRequest);
732 serial_printf("\twValue 0x%4.4x\n", r->wValue);
733 if (r->bRequest == USB_REQ_GET_DESCRIPTOR) {
734 switch (r->wValue >> 8) {
735 case USB_DESCRIPTOR_TYPE_DEVICE:
736 serial_printf("\tDEVICE\n");
737 break;
738 case USB_DESCRIPTOR_TYPE_CONFIGURATION:
739 serial_printf("\tCONFIGURATION\n");
740 break;
741 case USB_DESCRIPTOR_TYPE_STRING:
742 serial_printf("\tSTRING\n");
743 break;
744 case USB_DESCRIPTOR_TYPE_INTERFACE:
745 serial_printf("\tINTERFACE\n");
746 break;
747 case USB_DESCRIPTOR_TYPE_ENDPOINT:
748 serial_printf("\tENDPOINT\n");
749 break;
750 case USB_DESCRIPTOR_TYPE_DEVICE_QUALIFIER:
751 serial_printf("\tDEVICE_QUALIFIER\n");
752 break;
753 case USB_DESCRIPTOR_TYPE_OTHER_SPEED_CONFIGURATION:
754 serial_printf("\tOTHER_SPEED_CONFIGURATION\n");
755 break;
756 case USB_DESCRIPTOR_TYPE_INTERFACE_POWER:
757 serial_printf("\tINTERFACE_POWER\n");
758 break;
759 case USB_DESCRIPTOR_TYPE_HID:
760 serial_printf("\tHID\n");
761 break;
762 case USB_DESCRIPTOR_TYPE_REPORT:
763 serial_printf("\tREPORT\n");
764 break;
765 default:
766 serial_printf("\tUNKNOWN TYPE\n");
767 break;
768 }
769 }
770 serial_printf("\twIndex 0x%4.4x\n", r->wIndex);
771 serial_printf("\twLength 0x%4.4x\n", r->wLength);
772}
773#else
774
775#define print_urb(u)
776#define print_usb_device_request(r)
777#endif
778#endif
779