1 /***************************************************************************
2 * Copyright (C) 2011 by Martin Schmoelzer *
3 * <martin.schmoelzer@student.tuwien.ac.at> *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
22 * @file Defines USB descriptors, interrupt routines and helper functions.
23 * To minimize code size, we make the following assumptions:
24 * - The OpenULINK has exactly one configuration
25 * - and exactly one alternate setting
27 * Therefore, we do not have to support the Set Configuration USB request.
34 /* Also update external declarations in "include/usb.h" if making changes to
36 volatile bool EP2_out
;
39 volatile __xdata __at
0x7FE8 struct setup_data setup_data
;
41 /* Define number of endpoints (except Control Endpoint 0) in a central place.
42 * Be sure to include the neccessary endpoint descriptors! */
43 #define NUM_ENDPOINTS 2
46 * Normally, we would initialize the descriptor structures in C99 style:
48 * __code usb_device_descriptor_t device_descriptor = {
50 * .bDescriptorType = bar,
55 * But SDCC currently does not support this, so we have to do it the
56 * old-fashioned way...
59 __code
struct usb_device_descriptor device_descriptor
= {
60 /* .bLength = */ sizeof(struct usb_device_descriptor
),
61 /* .bDescriptorType = */ DESCRIPTOR_TYPE_DEVICE
,
62 /* .bcdUSB = */ 0x0110, /* BCD: 01.00 (Version 1.0 USB spec) */
63 /* .bDeviceClass = */ 0xFF, /* 0xFF = vendor-specific */
64 /* .bDeviceSubClass = */ 0xFF,
65 /* .bDeviceProtocol = */ 0xFF,
66 /* .bMaxPacketSize0 = */ 64,
67 /* .idVendor = */ 0xC251,
68 /* .idProduct = */ 0x2710,
69 /* .bcdDevice = */ 0x0100,
70 /* .iManufacturer = */ 1,
72 /* .iSerialNumber = */ 3,
73 /* .bNumConfigurations = */ 1
76 /* WARNING: ALL config, interface and endpoint descriptors MUST be adjacent! */
78 __code
struct usb_config_descriptor config_descriptor
= {
79 /* .bLength = */ sizeof(struct usb_config_descriptor
),
80 /* .bDescriptorType = */ DESCRIPTOR_TYPE_CONFIGURATION
,
81 /* .wTotalLength = */ sizeof(struct usb_config_descriptor
) +
82 sizeof(struct usb_interface_descriptor
) +
84 sizeof(struct usb_endpoint_descriptor
)),
85 /* .bNumInterfaces = */ 1,
86 /* .bConfigurationValue = */ 1,
87 /* .iConfiguration = */ 4, /* String describing this configuration */
88 /* .bmAttributes = */ 0x80, /* Only MSB set according to USB spec */
89 /* .MaxPower = */ 50 /* 100 mA */
92 __code
struct usb_interface_descriptor interface_descriptor00
= {
93 /* .bLength = */ sizeof(struct usb_interface_descriptor
),
94 /* .bDescriptorType = */ DESCRIPTOR_TYPE_INTERFACE
,
95 /* .bInterfaceNumber = */ 0,
96 /* .bAlternateSetting = */ 0,
97 /* .bNumEndpoints = */ NUM_ENDPOINTS
,
98 /* .bInterfaceClass = */ 0xFF,
99 /* .bInterfaceSubclass = */ 0xFF,
100 /* .bInterfaceProtocol = */ 0xFF,
101 /* .iInterface = */ 0
104 __code
struct usb_endpoint_descriptor Bulk_EP2_IN_Endpoint_Descriptor
= {
105 /* .bLength = */ sizeof(struct usb_endpoint_descriptor
),
106 /* .bDescriptorType = */ 0x05,
107 /* .bEndpointAddress = */ 2 | USB_DIR_IN
,
108 /* .bmAttributes = */ 0x02,
109 /* .wMaxPacketSize = */ 64,
113 __code
struct usb_endpoint_descriptor Bulk_EP2_OUT_Endpoint_Descriptor
= {
114 /* .bLength = */ sizeof(struct usb_endpoint_descriptor
),
115 /* .bDescriptorType = */ 0x05,
116 /* .bEndpointAddress = */ 2 | USB_DIR_OUT
,
117 /* .bmAttributes = */ 0x02,
118 /* .wMaxPacketSize = */ 64,
122 __code
struct usb_language_descriptor language_descriptor
= {
124 /* .bDescriptorType = */ DESCRIPTOR_TYPE_STRING
,
125 /* .wLANGID = */ {0x0409 /* US English */}
128 __code
struct usb_string_descriptor strManufacturer
=
129 STR_DESCR(9, 'O', 'p', 'e', 'n', 'U', 'L', 'I', 'N', 'K');
131 __code
struct usb_string_descriptor strProduct
=
132 STR_DESCR(9, 'O', 'p', 'e', 'n', 'U', 'L', 'I', 'N', 'K');
134 __code
struct usb_string_descriptor strSerialNumber
=
135 STR_DESCR(6, '0', '0', '0', '0', '0', '1');
137 __code
struct usb_string_descriptor strConfigDescr
=
138 STR_DESCR(12, 'J', 'T', 'A', 'G', ' ', 'A', 'd', 'a', 'p', 't', 'e', 'r');
140 /* Table containing pointers to string descriptors */
141 __code
struct usb_string_descriptor
*__code en_string_descriptors
[4] = {
148 void sudav_isr(void) __interrupt SUDAV_ISR
152 usb_handle_setup_data();
158 void sof_isr(void) __interrupt SOF_ISR
161 void sutok_isr(void) __interrupt SUTOK_ISR
164 void suspend_isr(void) __interrupt SUSPEND_ISR
167 void usbreset_isr(void) __interrupt USBRESET_ISR
170 void ibn_isr(void) __interrupt IBN_ISR
174 void ep0in_isr(void) __interrupt EP0IN_ISR
177 void ep0out_isr(void) __interrupt EP0OUT_ISR
180 void ep1in_isr(void) __interrupt EP1IN_ISR
183 void ep1out_isr(void) __interrupt EP1OUT_ISR
188 * EP2 IN: called after the transfer from uC->Host has finished: we sent data
190 void ep2in_isr(void) __interrupt EP2IN_ISR
195 IN07IRQ
= IN2IR
;/* Clear OUT2 IRQ */
199 * EP2 OUT: called after the transfer from Host->uC has finished: we got data
201 void ep2out_isr(void) __interrupt EP2OUT_ISR
206 OUT07IRQ
= OUT2IR
; /* Clear OUT2 IRQ */
209 void ep3in_isr(void) __interrupt EP3IN_ISR
212 void ep3out_isr(void) __interrupt EP3OUT_ISR
215 void ep4in_isr(void) __interrupt EP4IN_ISR
218 void ep4out_isr(void) __interrupt EP4OUT_ISR
221 void ep5in_isr(void) __interrupt EP5IN_ISR
224 void ep5out_isr(void) __interrupt EP5OUT_ISR
227 void ep6in_isr(void) __interrupt EP6IN_ISR
230 void ep6out_isr(void) __interrupt EP6OUT_ISR
233 void ep7in_isr(void) __interrupt EP7IN_ISR
236 void ep7out_isr(void) __interrupt EP7OUT_ISR
241 * Return the control/status register for an endpoint
243 * @param ep endpoint address
244 * @return on success: pointer to Control & Status register for endpoint
246 * @return on failure: NULL
248 __xdata
uint8_t *usb_get_endpoint_cs_reg(uint8_t ep
)
250 /* Mask direction bit */
251 uint8_t ep_num
= ep
& 0x7F;
258 return ep
& 0x80 ? &IN1CS
: &OUT1CS
;
261 return ep
& 0x80 ? &IN2CS
: &OUT2CS
;
264 return ep
& 0x80 ? &IN3CS
: &OUT3CS
;
267 return ep
& 0x80 ? &IN4CS
: &OUT4CS
;
270 return ep
& 0x80 ? &IN5CS
: &OUT5CS
;
273 return ep
& 0x80 ? &IN6CS
: &OUT6CS
;
276 return ep
& 0x80 ? &IN7CS
: &OUT7CS
;
283 void usb_reset_data_toggle(uint8_t ep
)
286 +----+-----+-----+------+-----+-------+-------+-------+
287 | Q | S | R | IO | 0 | EP2 | EP1 | EP0 |
288 +----+-----+-----+------+-----+-------+-------+-------+
290 To reset data toggle bits, we have to write the endpoint direction (IN/OUT)
291 to the IO bit and the endpoint number to the EP2..EP0 bits. Then, in a
292 separate write cycle, the R bit needs to be set.
294 uint8_t togctl_value
= (ep
& 0x80 >> 3) | (ep
& 0x7);
296 /* First step: Write EP number and direction bit */
297 TOGCTL
= togctl_value
;
299 /* Second step: Set R bit */
300 togctl_value
|= TOG_R
;
301 TOGCTL
= togctl_value
;
305 * Handle GET_STATUS request.
307 * @return on success: true
308 * @return on failure: false
310 bool usb_handle_get_status(void)
314 switch (setup_data
.bmRequestType
) {
316 /* Two byte response: Byte 0, Bit 0 = self-powered, Bit 1 = remote wakeup.
317 * Byte 1: reserved, reset to zero */
325 /* Always return two zero bytes according to USB 1.1 spec, p. 191 */
333 /* Get stall bit for endpoint specified in low byte of wIndex */
334 ep_cs
= usb_get_endpoint_cs_reg(setup_data
.wIndex
& 0xff);
336 if (*ep_cs
& EPSTALL
)
341 /* Second byte sent has to be always zero */
356 * Handle CLEAR_FEATURE request.
358 * @return on success: true
359 * @return on failure: false
361 bool usb_handle_clear_feature(void)
363 __xdata
uint8_t *ep_cs
;
365 switch (setup_data
.bmRequestType
) {
367 /* Clear remote wakeup not supported: stall EP0 */
371 if (setup_data
.wValue
== 0) {
372 /* Unstall the endpoint specified in wIndex */
373 ep_cs
= usb_get_endpoint_cs_reg(setup_data
.wIndex
);
378 /* Unsupported feature, stall EP0 */
383 /* Vendor commands... */
390 * Handle SET_FEATURE request.
392 * @return on success: true
393 * @return on failure: false
395 bool usb_handle_set_feature(void)
397 __xdata
uint8_t *ep_cs
;
399 switch (setup_data
.bmRequestType
) {
401 if (setup_data
.wValue
== 2)
405 if (setup_data
.wValue
== 0) {
406 /* Stall the endpoint specified in wIndex */
407 ep_cs
= usb_get_endpoint_cs_reg(setup_data
.wIndex
);
412 /* Unsupported endpoint feature */
417 /* Vendor commands... */
425 * Handle GET_DESCRIPTOR request.
427 * @return on success: true
428 * @return on failure: false
430 bool usb_handle_get_descriptor(void)
432 __xdata
uint8_t descriptor_type
;
433 __xdata
uint8_t descriptor_index
;
435 descriptor_type
= (setup_data
.wValue
& 0xff00) >> 8;
436 descriptor_index
= setup_data
.wValue
& 0x00ff;
438 switch (descriptor_type
) {
439 case DESCRIPTOR_TYPE_DEVICE
:
440 SUDPTRH
= HI8(&device_descriptor
);
441 SUDPTRL
= LO8(&device_descriptor
);
443 case DESCRIPTOR_TYPE_CONFIGURATION
:
444 SUDPTRH
= HI8(&config_descriptor
);
445 SUDPTRL
= LO8(&config_descriptor
);
447 case DESCRIPTOR_TYPE_STRING
:
448 if (setup_data
.wIndex
== 0) {
449 /* Supply language descriptor */
450 SUDPTRH
= HI8(&language_descriptor
);
451 SUDPTRL
= LO8(&language_descriptor
);
452 } else if (setup_data
.wIndex
== 0x0409 /* US English */) {
453 /* Supply string descriptor */
454 SUDPTRH
= HI8(en_string_descriptors
[descriptor_index
- 1]);
455 SUDPTRL
= LO8(en_string_descriptors
[descriptor_index
- 1]);
460 /* Unsupported descriptor type */
469 * Handle SET_INTERFACE request.
471 void usb_handle_set_interface(void)
473 /* Reset Data Toggle */
474 usb_reset_data_toggle(USB_DIR_IN
| 2);
475 usb_reset_data_toggle(USB_DIR_OUT
| 2);
477 /* Unstall & clear busy flag of all valid IN endpoints */
480 /* Unstall all valid OUT endpoints, reset bytecounts */
486 * Handle the arrival of a USB Control Setup Packet.
488 void usb_handle_setup_data(void)
490 switch (setup_data
.bRequest
) {
492 if (!usb_handle_get_status())
496 if (!usb_handle_clear_feature())
500 /* Reserved values */
504 if (!usb_handle_set_feature())
508 /* Handled by USB core */
511 /* Set Descriptor not supported. */
515 if (!usb_handle_get_descriptor())
518 case GET_CONFIGURATION
:
519 /* OpenULINK has only one configuration, return its index */
520 IN0BUF
[0] = config_descriptor
.bConfigurationValue
;
523 case SET_CONFIGURATION
:
524 /* OpenULINK has only one configuration -> nothing to do */
527 /* OpenULINK only has one interface, return its number */
528 IN0BUF
[0] = interface_descriptor00
.bInterfaceNumber
;
532 usb_handle_set_interface();
535 /* Isochronous endpoints not used -> nothing to do */
538 /* Any other requests: do nothing */
544 * USB initialization. Configures USB interrupts, endpoints and performs
549 /* Mark endpoint 2 IN & OUT as valid */
553 /* Make sure no isochronous endpoints are marked valid */
557 /* Disable isochronous endpoints. This makes the isochronous data buffers
558 * available as 8051 XDATA memory at address 0x2000 - 0x27FF */
561 /* Enable USB Autovectoring */
564 /* Enable SUDAV interrupt */
567 /* Enable EP2 OUT & IN interrupts */
571 /* Enable USB interrupt (EIE register) */
574 /* Perform ReNumeration */
575 USBCS
= DISCON
| RENUM
;
577 USBCS
= DISCOE
| RENUM
;
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)