2 * at91sam7s USB CDC device implementation
4 * Copyright (c) 2012, Roel Verdult
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. Neither the name of the copyright holders nor the
15 * names of its contributors may be used to endorse or promote products
16 * derived from this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
19 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
22 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 * based on the "Basic USB Example" from ATMEL (doc6123.pdf)
36 #include "config_gpio.h"
38 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
39 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
40 #define AT91C_EP_IN_SIZE 0x40
41 #define AT91C_EP_OUT 1
42 #define AT91C_EP_OUT_SIZE 0x40
45 const char devDescriptor
[] = {
46 /* Device descriptor */
48 0x01, // bDescriptorType
49 //0x10,0x01, // Complies with USB Spec. Release (0110h = release 1.10)
50 0x00,0x02, // Complies with USB Spec. Release (0110h = release 2.00)
51 0x02, // bDeviceClass: CDC class code
52 0x00, // bDeviceSubclass: CDC class sub code
53 0x00, // bDeviceProtocol: CDC Device protocol
54 0x08, // bMaxPacketSize0
55 0x2d,0x2d, // Vendor ID (--)
56 0x4d,0x50, // Product ID (PM), transmitted in reverse
57 0x01,0x00, // Device release number (0001)
58 0x01, // iManufacturer // 0x01
64 const char cfgDescriptor
[] = {
65 /* ============== CONFIGURATION 1 =========== */
66 /* Configuration 1 descriptor */
68 0x02, // CbDescriptorType
69 0x43, // CwTotalLength 2 EP + Control
71 0x02, // CbNumInterfaces
72 0x01, // CbConfigurationValue
73 0x00, // CiConfiguration
74 0xC0, // CbmAttributes 0xA0
77 /* Communication Class Interface Descriptor Requirement */
79 0x04, // bDescriptorType
80 0x00, // bInterfaceNumber
81 0x00, // bAlternateSetting
82 0x01, // bNumEndpoints
83 0x02, // bInterfaceClass
84 0x02, // bInterfaceSubclass
85 0x00, // bInterfaceProtocol
88 /* Header Functional Descriptor */
89 0x05, // bFunction Length
90 0x24, // bDescriptor type: CS_INTERFACE
91 0x00, // bDescriptor subtype: Header Func Desc
95 /* ACM Functional Descriptor */
96 0x04, // bFunctionLength
97 0x24, // bDescriptor Type: CS_INTERFACE
98 0x02, // bDescriptor Subtype: ACM Func Desc
99 0x00, // bmCapabilities
101 /* Union Functional Descriptor */
102 0x05, // bFunctionLength
103 0x24, // bDescriptorType: CS_INTERFACE
104 0x06, // bDescriptor Subtype: Union Func Desc
105 0x00, // bMasterInterface: Communication Class Interface
106 0x01, // bSlaveInterface0: Data Class Interface
108 /* Call Management Functional Descriptor */
109 0x05, // bFunctionLength
110 0x24, // bDescriptor Type: CS_INTERFACE
111 0x01, // bDescriptor Subtype: Call Management Func Desc
112 0x00, // bmCapabilities: D1 + D0
113 0x01, // bDataInterface: Data Class Interface 1
115 /* Endpoint 1 descriptor */
117 0x05, // bDescriptorType
118 0x83, // bEndpointAddress, Endpoint 03 - IN
119 0x03, // bmAttributes INT
120 0x08, // wMaxPacketSize
124 /* Data Class Interface Descriptor Requirement */
126 0x04, // bDescriptorType
127 0x01, // bInterfaceNumber
128 0x00, // bAlternateSetting
129 0x02, // bNumEndpoints
130 0x0A, // bInterfaceClass
131 0x00, // bInterfaceSubclass
132 0x00, // bInterfaceProtocol
135 /* First alternate setting */
136 /* Endpoint 1 descriptor */
138 0x05, // bDescriptorType
139 0x01, // bEndpointAddress, Endpoint 01 - OUT
140 0x02, // bmAttributes BULK
141 AT91C_EP_OUT_SIZE
, // wMaxPacketSize
145 /* Endpoint 2 descriptor */
147 0x05, // bDescriptorType
148 0x82, // bEndpointAddress, Endpoint 02 - IN
149 0x02, // bmAttributes BULK
150 AT91C_EP_IN_SIZE
, // wMaxPacketSize
155 const char strDescriptor
[] = {
157 0x03, // Type is string
173 /* USB standard request code */
174 #define STD_GET_STATUS_ZERO 0x0080
175 #define STD_GET_STATUS_INTERFACE 0x0081
176 #define STD_GET_STATUS_ENDPOINT 0x0082
178 #define STD_CLEAR_FEATURE_ZERO 0x0100
179 #define STD_CLEAR_FEATURE_INTERFACE 0x0101
180 #define STD_CLEAR_FEATURE_ENDPOINT 0x0102
182 #define STD_SET_FEATURE_ZERO 0x0300
183 #define STD_SET_FEATURE_INTERFACE 0x0301
184 #define STD_SET_FEATURE_ENDPOINT 0x0302
186 #define STD_SET_ADDRESS 0x0500
187 #define STD_GET_DESCRIPTOR 0x0680
188 #define STD_SET_DESCRIPTOR 0x0700
189 #define STD_GET_CONFIGURATION 0x0880
190 #define STD_SET_CONFIGURATION 0x0900
191 #define STD_GET_INTERFACE 0x0A81
192 #define STD_SET_INTERFACE 0x0B01
193 #define STD_SYNCH_FRAME 0x0C82
195 /* CDC Class Specific Request Code */
196 #define GET_LINE_CODING 0x21A1
197 #define SET_LINE_CODING 0x2021
198 #define SET_CONTROL_LINE_STATE 0x2221
201 unsigned int dwDTERRate
;
205 } AT91S_CDC_LINE_CODING
, *AT91PS_CDC_LINE_CODING
;
207 AT91S_CDC_LINE_CODING line
= {
213 void AT91F_CDC_Enumerate();
215 AT91PS_UDP pUdp
= AT91C_BASE_UDP
;
216 byte_t btConfiguration
= 0;
217 byte_t btConnection
= 0;
218 byte_t btReceiveBank
= AT91C_UDP_RX_DATA_BK0
;
220 //*----------------------------------------------------------------------------
222 //* \brief This function deactivates the USB device
223 //*----------------------------------------------------------------------------
225 // Disconnect the USB device
226 AT91C_BASE_PIOA
->PIO_ODR
= GPIO_USB_PU
;
228 // Clear all lingering interrupts
229 if(pUdp
->UDP_ISR
& AT91C_UDP_ENDBUSRES
) {
230 pUdp
->UDP_ICR
= AT91C_UDP_ENDBUSRES
;
234 //*----------------------------------------------------------------------------
236 //* \brief This function Activates the USB device
237 //*----------------------------------------------------------------------------
239 // Set the PLL USB Divider
240 AT91C_BASE_CKGR
->CKGR_PLLR
|= AT91C_CKGR_USBDIV_1
;
242 // Specific Chip USB Initialisation
243 // Enables the 48MHz USB clock UDPCK and System Peripheral USB Clock
244 AT91C_BASE_PMC
->PMC_SCER
= AT91C_PMC_UDP
;
245 AT91C_BASE_PMC
->PMC_PCER
= (1 << AT91C_ID_UDP
);
247 // Enable UDP PullUp (USB_DP_PUP) : enable & Clear of the corresponding PIO
248 // Set in PIO mode and Configure in Output
249 AT91C_BASE_PIOA
->PIO_PER
= GPIO_USB_PU
; // Set in PIO mode
250 AT91C_BASE_PIOA
->PIO_OER
= GPIO_USB_PU
; // Configure as Output
252 // Clear for set the Pullup resistor
253 AT91C_BASE_PIOA
->PIO_CODR
= GPIO_USB_PU
;
255 // Disconnect and reconnect USB controller for 100ms
258 // Wait for a short while
259 for (volatile size_t i
=0; i
<0x100000; i
++);
262 // Reconnect USB reconnect
263 AT91C_BASE_PIOA
->PIO_SODR
= GPIO_USB_PU
;
264 AT91C_BASE_PIOA
->PIO_OER
= GPIO_USB_PU
;
267 //*----------------------------------------------------------------------------
269 //* \brief Test if the device is configured and handle enumeration
270 //*----------------------------------------------------------------------------
272 AT91_REG isr
= pUdp
->UDP_ISR
;
274 if (isr
& AT91C_UDP_ENDBUSRES
) {
275 pUdp
->UDP_ICR
= AT91C_UDP_ENDBUSRES
;
276 // reset all endpoints
277 pUdp
->UDP_RSTEP
= (unsigned int)-1;
279 // Enable the function
280 pUdp
->UDP_FADDR
= AT91C_UDP_FEN
;
281 // Configure endpoint 0
282 pUdp
->UDP_CSR
[0] = (AT91C_UDP_EPEDS
| AT91C_UDP_EPTYPE_CTRL
);
284 else if (isr
& AT91C_UDP_EPINT0
) {
285 pUdp
->UDP_ICR
= AT91C_UDP_EPINT0
;
286 AT91F_CDC_Enumerate();
288 return (btConfiguration
) ? true : false;
294 if (!usb_check()) return false;
295 return (pUdp
->UDP_CSR
[AT91C_EP_OUT
] & btReceiveBank
);
299 In github PR #129, some users appears to get a false positive from
300 usb_poll, which returns true, but the usb_read operation
302 This check is basically the same as above, but also checks
303 that the length available to read is non-zero, thus hopefully fixes the
306 bool usb_poll_validate_length()
308 if (!usb_check()) return false;
309 if (!(pUdp
->UDP_CSR
[AT91C_EP_OUT
] & btReceiveBank
)) return false;
310 return (pUdp
->UDP_CSR
[AT91C_EP_OUT
] >> 16) > 0;
313 //*----------------------------------------------------------------------------
315 //* \brief Read available data from Endpoint OUT
316 //*----------------------------------------------------------------------------
317 uint32_t usb_read(byte_t
* data
, size_t len
) {
318 byte_t bank
= btReceiveBank
;
319 uint32_t packetSize
, nbBytesRcv
= 0;
320 uint32_t time_out
= 0;
323 if (!usb_check()) break;
325 if ( pUdp
->UDP_CSR
[AT91C_EP_OUT
] & bank
) {
326 packetSize
= MIN(pUdp
->UDP_CSR
[AT91C_EP_OUT
] >> 16, len
);
329 data
[nbBytesRcv
++] = pUdp
->UDP_FDR
[AT91C_EP_OUT
];
331 pUdp
->UDP_CSR
[AT91C_EP_OUT
] &= ~(bank
);
333 if (bank
== AT91C_UDP_RX_DATA_BK0
)
334 bank
= AT91C_UDP_RX_DATA_BK1
;
336 bank
= AT91C_UDP_RX_DATA_BK0
;
338 if (time_out
++ == 0x1fff) break;
341 btReceiveBank
= bank
;
345 //*----------------------------------------------------------------------------
347 //* \brief Send through endpoint 2
348 //*----------------------------------------------------------------------------
349 uint32_t usb_write(const byte_t
* data
, const size_t len
) {
353 if (!length
) return 0;
354 if (!usb_check()) return 0;
356 // Send the first packet
357 cpt
= MIN(length
, AT91C_EP_IN_SIZE
-1);
359 while (cpt
--) pUdp
->UDP_FDR
[AT91C_EP_IN
] = *data
++;
360 pUdp
->UDP_CSR
[AT91C_EP_IN
] |= AT91C_UDP_TXPKTRDY
;
363 // Fill the second bank
364 cpt
= MIN(length
, AT91C_EP_IN_SIZE
-1);
366 while (cpt
--) pUdp
->UDP_FDR
[AT91C_EP_IN
] = *data
++;
367 // Wait for the first bank to be sent
368 while (!(pUdp
->UDP_CSR
[AT91C_EP_IN
] & AT91C_UDP_TXCOMP
)) {
369 if (!usb_check()) return length
;
371 pUdp
->UDP_CSR
[AT91C_EP_IN
] &= ~(AT91C_UDP_TXCOMP
);
373 while (pUdp
->UDP_CSR
[AT91C_EP_IN
] & AT91C_UDP_TXCOMP
);
375 pUdp
->UDP_CSR
[AT91C_EP_IN
] |= AT91C_UDP_TXPKTRDY
;
378 // Wait for the end of transfer
379 while (!(pUdp
->UDP_CSR
[AT91C_EP_IN
] & AT91C_UDP_TXCOMP
)) {
380 if (!usb_check()) return length
;
383 pUdp
->UDP_CSR
[AT91C_EP_IN
] &= ~(AT91C_UDP_TXCOMP
);
384 while (pUdp
->UDP_CSR
[AT91C_EP_IN
] & AT91C_UDP_TXCOMP
);
389 //*----------------------------------------------------------------------------
390 //* \fn AT91F_USB_SendData
391 //* \brief Send Data through the control endpoint
392 //*----------------------------------------------------------------------------
393 unsigned int csrTab
[100] = {0x00};
394 unsigned char csrIdx
= 0;
396 static void AT91F_USB_SendData(AT91PS_UDP pUdp
, const char *pData
, uint32_t length
) {
401 cpt
= MIN(length
, 8);
405 pUdp
->UDP_FDR
[0] = *pData
++;
407 if (pUdp
->UDP_CSR
[0] & AT91C_UDP_TXCOMP
) {
408 pUdp
->UDP_CSR
[0] &= ~(AT91C_UDP_TXCOMP
);
409 while (pUdp
->UDP_CSR
[0] & AT91C_UDP_TXCOMP
);
412 pUdp
->UDP_CSR
[0] |= AT91C_UDP_TXPKTRDY
;
414 csr
= pUdp
->UDP_CSR
[0];
416 // Data IN stage has been stopped by a status OUT
417 if (csr
& AT91C_UDP_RX_DATA_BK0
) {
418 pUdp
->UDP_CSR
[0] &= ~(AT91C_UDP_RX_DATA_BK0
);
421 } while ( !(csr
& AT91C_UDP_TXCOMP
) );
425 if (pUdp
->UDP_CSR
[0] & AT91C_UDP_TXCOMP
) {
426 pUdp
->UDP_CSR
[0] &= ~(AT91C_UDP_TXCOMP
);
427 while (pUdp
->UDP_CSR
[0] & AT91C_UDP_TXCOMP
);
431 //*----------------------------------------------------------------------------
432 //* \fn AT91F_USB_SendZlp
433 //* \brief Send zero length packet through the control endpoint
434 //*----------------------------------------------------------------------------
435 void AT91F_USB_SendZlp(AT91PS_UDP pUdp
) {
436 pUdp
->UDP_CSR
[0] |= AT91C_UDP_TXPKTRDY
;
437 while ( !(pUdp
->UDP_CSR
[0] & AT91C_UDP_TXCOMP
) );
438 pUdp
->UDP_CSR
[0] &= ~(AT91C_UDP_TXCOMP
);
439 while (pUdp
->UDP_CSR
[0] & AT91C_UDP_TXCOMP
);
442 //*----------------------------------------------------------------------------
443 //* \fn AT91F_USB_SendStall
444 //* \brief Stall the control endpoint
445 //*----------------------------------------------------------------------------
446 void AT91F_USB_SendStall(AT91PS_UDP pUdp
) {
447 pUdp
->UDP_CSR
[0] |= AT91C_UDP_FORCESTALL
;
448 while ( !(pUdp
->UDP_CSR
[0] & AT91C_UDP_ISOERROR
) );
449 pUdp
->UDP_CSR
[0] &= ~(AT91C_UDP_FORCESTALL
| AT91C_UDP_ISOERROR
);
450 while (pUdp
->UDP_CSR
[0] & (AT91C_UDP_FORCESTALL
| AT91C_UDP_ISOERROR
));
453 //*----------------------------------------------------------------------------
454 //* \fn AT91F_CDC_Enumerate
455 //* \brief This function is a callback invoked when a SETUP packet is received
456 //*----------------------------------------------------------------------------
457 void AT91F_CDC_Enumerate() {
458 byte_t bmRequestType
, bRequest
;
459 uint16_t wValue
, wIndex
, wLength
, wStatus
;
461 if ( !(pUdp
->UDP_CSR
[0] & AT91C_UDP_RXSETUP
) )
464 bmRequestType
= pUdp
->UDP_FDR
[0];
465 bRequest
= pUdp
->UDP_FDR
[0];
466 wValue
= (pUdp
->UDP_FDR
[0] & 0xFF);
467 wValue
|= (pUdp
->UDP_FDR
[0] << 8);
468 wIndex
= (pUdp
->UDP_FDR
[0] & 0xFF);
469 wIndex
|= (pUdp
->UDP_FDR
[0] << 8);
470 wLength
= (pUdp
->UDP_FDR
[0] & 0xFF);
471 wLength
|= (pUdp
->UDP_FDR
[0] << 8);
473 if (bmRequestType
& 0x80) {
474 pUdp
->UDP_CSR
[0] |= AT91C_UDP_DIR
;
475 while ( !(pUdp
->UDP_CSR
[0] & AT91C_UDP_DIR
) );
477 pUdp
->UDP_CSR
[0] &= ~AT91C_UDP_RXSETUP
;
478 while ( (pUdp
->UDP_CSR
[0] & AT91C_UDP_RXSETUP
) );
480 // Handle supported standard device request Cf Table 9-3 in USB specification Rev 1.1
481 switch ((bRequest
<< 8) | bmRequestType
) {
482 case STD_GET_DESCRIPTOR
:
483 if (wValue
== 0x100) // Return Device Descriptor
484 AT91F_USB_SendData(pUdp
, devDescriptor
, MIN(sizeof(devDescriptor
), wLength
));
485 else if (wValue
== 0x200) // Return Configuration Descriptor
486 AT91F_USB_SendData(pUdp
, cfgDescriptor
, MIN(sizeof(cfgDescriptor
), wLength
));
487 else if ((wValue
& 0x300) == 0x300) // Return String Descriptor
488 AT91F_USB_SendData(pUdp
, strDescriptor
, MIN(sizeof(strDescriptor
), wLength
));
490 AT91F_USB_SendStall(pUdp
);
492 case STD_SET_ADDRESS
:
493 AT91F_USB_SendZlp(pUdp
);
494 pUdp
->UDP_FADDR
= (AT91C_UDP_FEN
| wValue
);
495 pUdp
->UDP_GLBSTATE
= (wValue
) ? AT91C_UDP_FADDEN
: 0;
497 case STD_SET_CONFIGURATION
:
498 btConfiguration
= wValue
;
499 AT91F_USB_SendZlp(pUdp
);
500 pUdp
->UDP_GLBSTATE
= (wValue
) ? AT91C_UDP_CONFG
: AT91C_UDP_FADDEN
;
501 pUdp
->UDP_CSR
[1] = (wValue
) ? (AT91C_UDP_EPEDS
| AT91C_UDP_EPTYPE_BULK_OUT
) : 0;
502 pUdp
->UDP_CSR
[2] = (wValue
) ? (AT91C_UDP_EPEDS
| AT91C_UDP_EPTYPE_BULK_IN
) : 0;
503 pUdp
->UDP_CSR
[3] = (wValue
) ? (AT91C_UDP_EPEDS
| AT91C_UDP_EPTYPE_INT_IN
) : 0;
505 case STD_GET_CONFIGURATION
:
506 AT91F_USB_SendData(pUdp
, (char *) &(btConfiguration
), sizeof(btConfiguration
));
508 case STD_GET_STATUS_ZERO
:
510 AT91F_USB_SendData(pUdp
, (char *) &wStatus
, sizeof(wStatus
));
512 case STD_GET_STATUS_INTERFACE
:
514 AT91F_USB_SendData(pUdp
, (char *) &wStatus
, sizeof(wStatus
));
516 case STD_GET_STATUS_ENDPOINT
:
519 if ((pUdp
->UDP_GLBSTATE
& AT91C_UDP_CONFG
) && (wIndex
<= 3)) {
520 wStatus
= (pUdp
->UDP_CSR
[wIndex
] & AT91C_UDP_EPEDS
) ? 0 : 1;
521 AT91F_USB_SendData(pUdp
, (char *) &wStatus
, sizeof(wStatus
));
523 else if ((pUdp
->UDP_GLBSTATE
& AT91C_UDP_FADDEN
) && (wIndex
== 0)) {
524 wStatus
= (pUdp
->UDP_CSR
[wIndex
] & AT91C_UDP_EPEDS
) ? 0 : 1;
525 AT91F_USB_SendData(pUdp
, (char *) &wStatus
, sizeof(wStatus
));
528 AT91F_USB_SendStall(pUdp
);
530 case STD_SET_FEATURE_ZERO
:
531 AT91F_USB_SendStall(pUdp
);
533 case STD_SET_FEATURE_INTERFACE
:
534 AT91F_USB_SendZlp(pUdp
);
536 case STD_SET_FEATURE_ENDPOINT
:
538 if ((wValue
== 0) && wIndex
&& (wIndex
<= 3)) {
539 pUdp
->UDP_CSR
[wIndex
] = 0;
540 AT91F_USB_SendZlp(pUdp
);
543 AT91F_USB_SendStall(pUdp
);
545 case STD_CLEAR_FEATURE_ZERO
:
546 AT91F_USB_SendStall(pUdp
);
548 case STD_CLEAR_FEATURE_INTERFACE
:
549 AT91F_USB_SendZlp(pUdp
);
551 case STD_CLEAR_FEATURE_ENDPOINT
:
553 if ((wValue
== 0) && wIndex
&& (wIndex
<= 3)) {
555 pUdp
->UDP_CSR
[1] = (AT91C_UDP_EPEDS
| AT91C_UDP_EPTYPE_BULK_OUT
);
556 else if (wIndex
== 2)
557 pUdp
->UDP_CSR
[2] = (AT91C_UDP_EPEDS
| AT91C_UDP_EPTYPE_BULK_IN
);
558 else if (wIndex
== 3)
559 pUdp
->UDP_CSR
[3] = (AT91C_UDP_EPEDS
| AT91C_UDP_EPTYPE_ISO_IN
);
560 AT91F_USB_SendZlp(pUdp
);
563 AT91F_USB_SendStall(pUdp
);
566 // handle CDC class requests
567 case SET_LINE_CODING
:
568 while ( !(pUdp
->UDP_CSR
[0] & AT91C_UDP_RX_DATA_BK0
) );
569 pUdp
->UDP_CSR
[0] &= ~(AT91C_UDP_RX_DATA_BK0
);
570 AT91F_USB_SendZlp(pUdp
);
572 case GET_LINE_CODING
:
573 AT91F_USB_SendData(pUdp
, (char *) &line
, MIN(sizeof(line
), wLength
));
575 case SET_CONTROL_LINE_STATE
:
576 btConnection
= wValue
;
577 AT91F_USB_SendZlp(pUdp
);
580 AT91F_USB_SendStall(pUdp
);