Add support for standard USB Smartcard Readers (#765)

[proxmark3-svn] / common / usb_cdc.c

diff --git a/common/usb_cdc.c b/common/usb_cdc.c
index 7fd2933c322463f5d5790b9397d5c7aeb8d3b72a..d33bca7bcbd5dd0e0975c2742470bc47e358b364 100644 (file)
--- a/common/usb_cdc.c
+++ b/common/usb_cdc.c
@@ -33,34 +33,41 @@
  */\r
 \r
 #include "usb_cdc.h"\r
  */\r
 \r
 #include "usb_cdc.h"\r

+#include "at91sam7s512.h"\r

 #include "config_gpio.h"\r
 \r
 #include "config_gpio.h"\r
 \r

-#define MIN(a, b) (((a) < (b)) ? (a) : (b))\r
-#define MAX(a, b) (((a) > (b)) ? (a) : (b))\r
-#define AT91C_EP_IN_SIZE  0x40\r
+\r
+#define AT91C_EP_CONTROL     0\r

 #define AT91C_EP_OUT         1\r
 #define AT91C_EP_OUT         1\r

-#define AT91C_EP_OUT_SIZE 0x40\r

 #define AT91C_EP_IN          2\r
 #define AT91C_EP_IN          2\r

+#define AT91C_EP_NOTIFY      3\r
+#define AT91C_EP_OUT_SIZE 0x40\r
+#define AT91C_EP_IN_SIZE  0x40\r

 \r
 \r

-const char devDescriptor[] = {\r
+// Language must always be 0.\r
+#define STR_LANGUAGE_CODES 0x00\r
+#define STR_MANUFACTURER   0x01\r
+#define STR_PRODUCT        0x02\r
+\r
+static const char devDescriptor[] = {\r

        /* Device descriptor */\r
        0x12,      // bLength\r
        0x01,      // bDescriptorType\r
        /* Device descriptor */\r
        0x12,      // bLength\r
        0x01,      // bDescriptorType\r

-       0x10,0x01, // Complies with USB Spec. Release (0110h = release 1.10)\r
-       0x02,      // bDeviceClass:    CDC class code\r
-       0x00,      // bDeviceSubclass: CDC class sub code\r
-       0x00,      // bDeviceProtocol: CDC Device protocol\r
+       0x00,0x02, // Complies with USB Spec. Release (0200h = release 2.0)\r
+       0x02,      // bDeviceClass:    (Communication Device Class)\r
+       0x00,      // bDeviceSubclass: (unused at this time)\r
+       0x00,      // bDeviceProtocol: (unused at this time)\r

        0x08,      // bMaxPacketSize0\r
        0x08,      // bMaxPacketSize0\r

-       0x2d,0x2d, // Vendor ID (--)\r
-       0x4d,0x50, // Product ID (PM), transmitted in reverse\r
+       0xc4,0x9a, // Vendor ID (0x9ac4 = J. Westhues)\r
+       0x8f,0x4b, // Product ID (0x4b8f = Proxmark-3 RFID Instrument)\r

        0x01,0x00, // Device release number (0001)\r
        0x01,0x00, // Device release number (0001)\r

-       0x01,      // iManufacturer    // 0x01\r
-       0x00,      // iProduct\r
-       0x00,      // SerialNumber\r
+       STR_MANUFACTURER,  // iManufacturer\r
+       STR_PRODUCT,       // iProduct\r
+       0x00,      // iSerialNumber\r

        0x01       // bNumConfigs\r
 };\r
 \r
        0x01       // bNumConfigs\r
 };\r
 \r

-const char cfgDescriptor[] = {\r
+static const char cfgDescriptor[] = {\r

        /* ============== CONFIGURATION 1 =========== */\r
        /* Configuration 1 descriptor */\r
        0x09,   // CbLength\r
        /* ============== CONFIGURATION 1 =========== */\r
        /* Configuration 1 descriptor */\r
        0x09,   // CbLength\r


@@ -70,89 +77,96 @@ const char cfgDescriptor[] = {
        0x02,   // CbNumInterfaces\r
        0x01,   // CbConfigurationValue\r
        0x00,   // CiConfiguration\r
        0x02,   // CbNumInterfaces\r
        0x01,   // CbConfigurationValue\r
        0x00,   // CiConfiguration\r

-       0xC0,   // CbmAttributes 0xA0\r
-       0x00,   // CMaxPower\r
+       0x80,   // CbmAttributes (Bus Powered)\r
+       0x4B,   // CMaxPower (150mA max current drawn from bus)\r

 \r
 \r

-       /* Communication Class Interface Descriptor Requirement */\r
+       /* Interface 0 Descriptor: Communication Class Interface */\r

        0x09, // bLength\r
        0x04, // bDescriptorType\r
        0x00, // bInterfaceNumber\r
        0x00, // bAlternateSetting\r
        0x01, // bNumEndpoints\r
        0x09, // bLength\r
        0x04, // bDescriptorType\r
        0x00, // bInterfaceNumber\r
        0x00, // bAlternateSetting\r
        0x01, // bNumEndpoints\r

-       0x02, // bInterfaceClass\r
-       0x02, // bInterfaceSubclass\r
-       0x00, // bInterfaceProtocol\r
+       0x02, // bInterfaceClass:       Communication Interface Class\r
+       0x02, // bInterfaceSubclass:    Abstract Control Model\r
+       0x01, // bInterfaceProtocol:    Common AT Commands, V.25ter\r

        0x00, // iInterface\r
 \r
        /* Header Functional Descriptor */\r
        0x05, // bFunction Length\r
        0x00, // iInterface\r
 \r
        /* Header Functional Descriptor */\r
        0x05, // bFunction Length\r

-       0x24, // bDescriptor type: CS_INTERFACE\r
-       0x00, // bDescriptor subtype: Header Func Desc\r
+       0x24, // bDescriptor type:      CS_INTERFACE\r
+       0x00, // bDescriptor subtype:   Header Functional Descriptor\r

        0x10, // bcdCDC:1.1\r
        0x01,\r
 \r
        /* ACM Functional Descriptor */\r
        0x04, // bFunctionLength\r
        0x10, // bcdCDC:1.1\r
        0x01,\r
 \r
        /* ACM Functional Descriptor */\r
        0x04, // bFunctionLength\r

-       0x24, // bDescriptor Type: CS_INTERFACE\r
-       0x02, // bDescriptor Subtype: ACM Func Desc\r
-       0x00, // bmCapabilities\r
+       0x24, // bDescriptor Type:      CS_INTERFACE\r
+       0x02, // bDescriptor Subtype:   Abstract Control Management Functional Descriptor\r
+       0x02, // bmCapabilities:        D1: Device supports the request combination of Set_Line_Coding, Set_Control_Line_State, Get_Line_Coding, and the notification Serial_State\r

 \r
        /* Union Functional Descriptor */\r
        0x05, // bFunctionLength\r
 \r
        /* Union Functional Descriptor */\r
        0x05, // bFunctionLength\r

-       0x24, // bDescriptorType: CS_INTERFACE\r
-       0x06, // bDescriptor Subtype: Union Func Desc\r
-       0x00, // bMasterInterface: Communication Class Interface\r
-       0x01, // bSlaveInterface0: Data Class Interface\r
+       0x24, // bDescriptorType:       CS_INTERFACE\r
+       0x06, // bDescriptor Subtype:   Union Functional Descriptor\r
+       0x00, // bMasterInterface:      Communication Class Interface\r
+       0x01, // bSlaveInterface0:      Data Class Interface\r

 \r
        /* Call Management Functional Descriptor */\r
        0x05, // bFunctionLength\r
 \r
        /* Call Management Functional Descriptor */\r
        0x05, // bFunctionLength\r

-       0x24, // bDescriptor Type: CS_INTERFACE\r
-       0x01, // bDescriptor Subtype: Call Management Func Desc\r
-       0x00, // bmCapabilities: D1 + D0\r
-       0x01, // bDataInterface: Data Class Interface 1\r
+       0x24, // bDescriptor Type:      CS_INTERFACE\r
+       0x01, // bDescriptor Subtype:   Call Management Functional Descriptor\r
+       0x00, // bmCapabilities:        Device sends/receives call management information only over the Communication Class interface. Device does not handle call management itself\r
+       0x01, // bDataInterface:        Data Class Interface 1\r

 \r
        /* Endpoint 1 descriptor */\r
        0x07,   // bLength\r
        0x05,   // bDescriptorType\r
 \r
        /* Endpoint 1 descriptor */\r
        0x07,   // bLength\r
        0x05,   // bDescriptorType\r

-       0x83,   // bEndpointAddress, Endpoint 03 - IN\r
-       0x03,   // bmAttributes      INT\r
-       0x08,   // wMaxPacketSize\r
+       0x83,   // bEndpointAddress:    Endpoint 03 - IN\r
+       0x03,   // bmAttributes:        INT\r
+       0x08,   // wMaxPacketSize:      8\r

        0x00,\r
        0xFF,   // bInterval\r
 \r
        0x00,\r
        0xFF,   // bInterval\r
 \r

-       /* Data Class Interface Descriptor Requirement */\r
+       /* Interface 1 Descriptor: Data Class Interface */\r

        0x09, // bLength\r
        0x04, // bDescriptorType\r
        0x01, // bInterfaceNumber\r
        0x00, // bAlternateSetting\r
        0x02, // bNumEndpoints\r
        0x09, // bLength\r
        0x04, // bDescriptorType\r
        0x01, // bInterfaceNumber\r
        0x00, // bAlternateSetting\r
        0x02, // bNumEndpoints\r

-       0x0A, // bInterfaceClass\r
-       0x00, // bInterfaceSubclass\r
-       0x00, // bInterfaceProtocol\r
+       0x0A, // bInterfaceClass:       Data Interface Class\r
+       0x00, // bInterfaceSubclass:    not used\r
+       0x00, // bInterfaceProtocol:    No class specific protocol required)\r

        0x00, // iInterface\r
 \r
        0x00, // iInterface\r
 \r

-       /* First alternate setting */\r

        /* Endpoint 1 descriptor */\r
        0x07,   // bLength\r
        0x05,   // bDescriptorType\r
        /* Endpoint 1 descriptor */\r
        0x07,   // bLength\r
        0x05,   // bDescriptorType\r

-       0x01,   // bEndpointAddress, Endpoint 01 - OUT\r
-       0x02,   // bmAttributes      BULK\r
-       AT91C_EP_OUT_SIZE,   // wMaxPacketSize\r
+       0x01,   // bEndpointAddress:    Endpoint 01 - OUT\r
+       0x02,   // bmAttributes:        BULK\r
+       AT91C_EP_OUT_SIZE, // wMaxPacketSize\r

        0x00,\r
        0x00,   // bInterval\r
 \r
        /* Endpoint 2 descriptor */\r
        0x07,   // bLength\r
        0x05,   // bDescriptorType\r
        0x00,\r
        0x00,   // bInterval\r
 \r
        /* Endpoint 2 descriptor */\r
        0x07,   // bLength\r
        0x05,   // bDescriptorType\r

-       0x82,   // bEndpointAddress, Endpoint 02 - IN\r
-       0x02,   // bmAttributes      BULK\r
+       0x82,   // bEndpointAddress:    Endpoint 02 - IN\r
+       0x02,   // bmAttributes:        BULK\r

        AT91C_EP_IN_SIZE,   // wMaxPacketSize\r
        0x00,\r
        0x00    // bInterval\r
 };\r
 \r
        AT91C_EP_IN_SIZE,   // wMaxPacketSize\r
        0x00,\r
        0x00    // bInterval\r
 };\r
 \r

-const char strDescriptor[] = {\r
-  26,                          // Length\r
+static const char StrDescLanguageCodes[] = {\r
+  4,                   // Length\r
+  0x03,                        // Type is string\r
+  0x09, 0x04   // supported language Code 0 = 0x0409 (English)\r
+};\r
+\r
+// Note: ModemManager (Linux) ignores Proxmark3 devices by matching the\r
+// manufacturer string "proxmark.org". Don't change this.\r
+static const char StrDescManufacturer[] = {\r
+  26,                  // Length\r

   0x03,                        // Type is string\r
   'p', 0x00,\r
   'r', 0x00,\r
   0x03,                        // Type is string\r
   'p', 0x00,\r
   'r', 0x00,\r


@@ -165,11 +179,61 @@ const char strDescriptor[] = {
   '.', 0x00,\r
   'o', 0x00,\r
   'r', 0x00,\r
   '.', 0x00,\r
   'o', 0x00,\r
   'r', 0x00,\r

-  'g', 0x00,\r
+  'g', 0x00\r
+};\r
+\r
+static const char StrDescProduct[] = {\r
+  20,                  // Length\r
+  0x03,                        // Type is string\r
+  'p', 0x00,\r
+  'r', 0x00,\r
+  'o', 0x00,\r
+  'x', 0x00,\r
+  'm', 0x00,\r
+  'a', 0x00,\r
+  'r', 0x00,\r
+  'k', 0x00,\r
+  '3', 0x00\r

 };\r
 \r
 };\r
 \r

+const char* getStringDescriptor(uint8_t idx)\r
+{\r
+       switch (idx) {\r
+               case STR_LANGUAGE_CODES:\r
+                       return StrDescLanguageCodes;\r
+               case STR_MANUFACTURER:\r
+                       return StrDescManufacturer;\r
+               case STR_PRODUCT:\r
+                       return StrDescProduct;\r
+               default:\r
+                       return NULL;\r
+       }\r
+}\r
+\r
+// Bitmap for all status bits in CSR which must be written as 1 to cause no effect\r
+#define REG_NO_EFFECT_1_ALL      AT91C_UDP_RX_DATA_BK0 | AT91C_UDP_RX_DATA_BK1 \\r
+                                |AT91C_UDP_STALLSENT   | AT91C_UDP_RXSETUP \\r
+                                |AT91C_UDP_TXCOMP\r
+\r
+// Clear flags in the UDP_CSR register\r
+#define UDP_CLEAR_EP_FLAGS(endpoint, flags) { \\r
+       volatile unsigned int reg; \\r
+       reg = pUdp->UDP_CSR[(endpoint)]; \\r
+       reg |= REG_NO_EFFECT_1_ALL; \\r
+       reg &= ~(flags); \\r
+       pUdp->UDP_CSR[(endpoint)] = reg; \\r
+} \r
+\r
+// Set flags in the UDP_CSR register\r
+#define UDP_SET_EP_FLAGS(endpoint, flags) { \\r
+       volatile unsigned int reg; \\r
+       reg = pUdp->UDP_CSR[(endpoint)]; \\r
+       reg |= REG_NO_EFFECT_1_ALL; \\r
+       reg |= (flags); \\r
+       pUdp->UDP_CSR[(endpoint)] = reg; \\r
+}\r

 \r
 \r

-/* USB standard request code */\r
+/* USB standard request codes */\r

 #define STD_GET_STATUS_ZERO           0x0080\r
 #define STD_GET_STATUS_INTERFACE      0x0081\r
 #define STD_GET_STATUS_ENDPOINT       0x0082\r
 #define STD_GET_STATUS_ZERO           0x0080\r
 #define STD_GET_STATUS_INTERFACE      0x0081\r
 #define STD_GET_STATUS_ENDPOINT       0x0082\r


@@ -209,6 +273,7 @@ AT91S_CDC_LINE_CODING line = {
        0,      // None Parity\r
        8};     // 8 Data bits\r
 \r
        0,      // None Parity\r
        8};     // 8 Data bits\r
 \r

+\r

 void AT91F_CDC_Enumerate();\r
 \r
 AT91PS_UDP pUdp = AT91C_BASE_UDP;\r
 void AT91F_CDC_Enumerate();\r
 \r
 AT91PS_UDP pUdp = AT91C_BASE_UDP;\r


@@ -216,52 +281,55 @@ byte_t btConfiguration = 0;
 byte_t btConnection    = 0;\r
 byte_t btReceiveBank   = AT91C_UDP_RX_DATA_BK0;\r
 \r
 byte_t btConnection    = 0;\r
 byte_t btReceiveBank   = AT91C_UDP_RX_DATA_BK0;\r
 \r

+\r

 //*----------------------------------------------------------------------------\r
 //* \fn    usb_disable\r
 //* \brief This function deactivates the USB device\r
 //*----------------------------------------------------------------------------\r
 void usb_disable() {\r
 //*----------------------------------------------------------------------------\r
 //* \fn    usb_disable\r
 //* \brief This function deactivates the USB device\r
 //*----------------------------------------------------------------------------\r
 void usb_disable() {\r

-  // Disconnect the USB device\r
-  AT91C_BASE_PIOA->PIO_ODR = GPIO_USB_PU;\r
-  \r
-  // Clear all lingering interrupts\r
-  if(pUdp->UDP_ISR & AT91C_UDP_ENDBUSRES) {\r
-    pUdp->UDP_ICR = AT91C_UDP_ENDBUSRES;\r
-  }\r
+       // Disconnect the USB device\r
+       AT91C_BASE_PIOA->PIO_ODR = GPIO_USB_PU;\r
+\r
+       // Clear all lingering interrupts\r
+       if(pUdp->UDP_ISR & AT91C_UDP_ENDBUSRES) {\r
+               pUdp->UDP_ICR = AT91C_UDP_ENDBUSRES;\r
+       }\r

 }\r
 \r
 }\r
 \r

+\r

 //*----------------------------------------------------------------------------\r
 //* \fn    usb_enable\r
 //* \brief This function Activates the USB device\r
 //*----------------------------------------------------------------------------\r
 void usb_enable() {\r
 //*----------------------------------------------------------------------------\r
 //* \fn    usb_enable\r
 //* \brief This function Activates the USB device\r
 //*----------------------------------------------------------------------------\r
 void usb_enable() {\r

-  // Set the PLL USB Divider\r
-  AT91C_BASE_CKGR->CKGR_PLLR |= AT91C_CKGR_USBDIV_1 ;\r
-  \r
-  // Specific Chip USB Initialisation\r
-  // Enables the 48MHz USB clock UDPCK and System Peripheral USB Clock\r
-  AT91C_BASE_PMC->PMC_SCER = AT91C_PMC_UDP;\r
-  AT91C_BASE_PMC->PMC_PCER = (1 << AT91C_ID_UDP);\r
-  \r
-  // Enable UDP PullUp (USB_DP_PUP) : enable & Clear of the corresponding PIO\r
-  // Set in PIO mode and Configure in Output\r
-  AT91C_BASE_PIOA->PIO_PER = GPIO_USB_PU; // Set in PIO mode\r
+       // Set the PLL USB Divider\r
+       AT91C_BASE_CKGR->CKGR_PLLR |= AT91C_CKGR_USBDIV_1 ;\r
+\r
+       // Specific Chip USB Initialisation\r
+       // Enables the 48MHz USB clock UDPCK and System Peripheral USB Clock\r
+       AT91C_BASE_PMC->PMC_SCER = AT91C_PMC_UDP;\r
+       AT91C_BASE_PMC->PMC_PCER = (1 << AT91C_ID_UDP);\r
+\r
+       // Enable UDP PullUp (USB_DP_PUP) : enable & Clear of the corresponding PIO\r
+       // Set in PIO mode and Configure in Output\r
+       AT91C_BASE_PIOA->PIO_PER = GPIO_USB_PU; // Set in PIO mode\r

        AT91C_BASE_PIOA->PIO_OER = GPIO_USB_PU; // Configure as Output\r
        AT91C_BASE_PIOA->PIO_OER = GPIO_USB_PU; // Configure as Output\r

-  \r
-  // Clear for set the Pullup resistor\r
+\r
+       // Clear for set the Pullup resistor\r

        AT91C_BASE_PIOA->PIO_CODR = GPIO_USB_PU;\r
        AT91C_BASE_PIOA->PIO_CODR = GPIO_USB_PU;\r

-  \r
-  // Disconnect and reconnect USB controller for 100ms\r
-  usb_disable();\r
-  \r
-  // Wait for a short while\r
-  for (volatile size_t i=0; i<0x100000; i++);\r

 \r
 \r

-  // Reconnect USB reconnect\r
-  AT91C_BASE_PIOA->PIO_SODR = GPIO_USB_PU;\r
-  AT91C_BASE_PIOA->PIO_OER = GPIO_USB_PU;\r
+       // Disconnect and reconnect USB controller for 100ms\r
+       usb_disable();\r
+\r
+       // Wait for a short while\r
+       for (volatile size_t i=0; i<0x100000; i++);\r
+\r
+       // Reconnect USB reconnect\r
+       AT91C_BASE_PIOA->PIO_SODR = GPIO_USB_PU;\r
+       AT91C_BASE_PIOA->PIO_OER = GPIO_USB_PU;\r

 }\r
 \r
 }\r
 \r

+\r

 //*----------------------------------------------------------------------------\r
 //* \fn    usb_check\r
 //* \brief Test if the device is configured and handle enumeration\r
 //*----------------------------------------------------------------------------\r
 //* \fn    usb_check\r
 //* \brief Test if the device is configured and handle enumeration\r


@@ -277,9 +345,8 @@ bool usb_check() {
                // Enable the function\r
                pUdp->UDP_FADDR = AT91C_UDP_FEN;\r
                // Configure endpoint 0\r
                // Enable the function\r
                pUdp->UDP_FADDR = AT91C_UDP_FEN;\r
                // Configure endpoint 0\r

-               pUdp->UDP_CSR[0] = (AT91C_UDP_EPEDS | AT91C_UDP_EPTYPE_CTRL);\r
-       }\r
-       else if (isr & AT91C_UDP_EPINT0) {\r
+               pUdp->UDP_CSR[AT91C_EP_CONTROL] = (AT91C_UDP_EPEDS | AT91C_UDP_EPTYPE_CTRL);\r
+       } else if (isr & AT91C_UDP_EPINT0) {\r

                pUdp->UDP_ICR = AT91C_UDP_EPINT0;\r
                AT91F_CDC_Enumerate();\r
        }\r
                pUdp->UDP_ICR = AT91C_UDP_EPINT0;\r
                AT91F_CDC_Enumerate();\r
        }\r


@@ -289,10 +356,11 @@ bool usb_check() {
 \r
 bool usb_poll()\r
 {\r
 \r
 bool usb_poll()\r
 {\r

-  if (!usb_check()) return false;\r
-  return (pUdp->UDP_CSR[AT91C_EP_OUT] & btReceiveBank);\r
+       if (!usb_check()) return false;\r
+       return (pUdp->UDP_CSR[AT91C_EP_OUT] & btReceiveBank);\r

 }\r
 \r
 }\r
 \r

+\r

 /**\r
        In github PR #129, some users appears to get a false positive from\r
        usb_poll, which returns true, but the usb_read operation\r
 /**\r
        In github PR #129, some users appears to get a false positive from\r
        usb_poll, which returns true, but the usb_read operation\r


@@ -303,7 +371,6 @@ bool usb_poll()
 **/\r
 bool usb_poll_validate_length()\r
 {\r
 **/\r
 bool usb_poll_validate_length()\r
 {\r

-\r

        if (!usb_check()) return false;\r
        if (!(pUdp->UDP_CSR[AT91C_EP_OUT] & btReceiveBank)) return false;\r
        return (pUdp->UDP_CSR[AT91C_EP_OUT] >> 16) >  0;\r
        if (!usb_check()) return false;\r
        if (!(pUdp->UDP_CSR[AT91C_EP_OUT] & btReceiveBank)) return false;\r
        return (pUdp->UDP_CSR[AT91C_EP_OUT] >> 16) >  0;\r


@@ -326,7 +393,7 @@ uint32_t usb_read(byte_t* data, size_t len) {
                        len -= packetSize;\r
                        while(packetSize--)\r
                                data[nbBytesRcv++] = pUdp->UDP_FDR[AT91C_EP_OUT];\r
                        len -= packetSize;\r
                        while(packetSize--)\r
                                data[nbBytesRcv++] = pUdp->UDP_FDR[AT91C_EP_OUT];\r

-                       pUdp->UDP_CSR[AT91C_EP_OUT] &= ~(bank);\r
+                       UDP_CLEAR_EP_FLAGS(AT91C_EP_OUT, bank);\r

                        if (bank == AT91C_UDP_RX_DATA_BK0) {\r
                                bank = AT91C_UDP_RX_DATA_BK1;\r
                        } else {\r
                        if (bank == AT91C_UDP_RX_DATA_BK0) {\r
                                bank = AT91C_UDP_RX_DATA_BK1;\r
                        } else {\r


@@ -340,48 +407,54 @@ uint32_t usb_read(byte_t* data, size_t len) {
        return nbBytesRcv;\r
 }\r
 \r
        return nbBytesRcv;\r
 }\r
 \r

+\r

 //*----------------------------------------------------------------------------\r
 //* \fn    usb_write\r
 //* \brief Send through endpoint 2\r
 //*----------------------------------------------------------------------------\r
 uint32_t usb_write(const byte_t* data, const size_t len) {\r
 //*----------------------------------------------------------------------------\r
 //* \fn    usb_write\r
 //* \brief Send through endpoint 2\r
 //*----------------------------------------------------------------------------\r
 uint32_t usb_write(const byte_t* data, const size_t len) {\r

-  size_t length = len;\r
+       size_t length = len;\r

        uint32_t cpt = 0;\r
 \r
        uint32_t cpt = 0;\r
 \r

-  if (!length) return 0;\r
-  if (!usb_check()) return 0;\r
-  \r
+       if (!length) return 0;\r
+       if (!usb_check()) return 0;\r
+\r

        // Send the first packet\r
        // Send the first packet\r

-       cpt = MIN(length, AT91C_EP_IN_SIZE-1);\r
+       cpt = MIN(length, AT91C_EP_IN_SIZE);\r

        length -= cpt;\r
        length -= cpt;\r

-       while (cpt--) pUdp->UDP_FDR[AT91C_EP_IN] = *data++;\r
-       pUdp->UDP_CSR[AT91C_EP_IN] |= AT91C_UDP_TXPKTRDY;\r
+       while (cpt--) {\r
+               pUdp->UDP_FDR[AT91C_EP_IN] = *data++;\r
+       }\r
+       UDP_SET_EP_FLAGS(AT91C_EP_IN, AT91C_UDP_TXPKTRDY);\r

 \r
        while (length) {\r
 \r
        while (length) {\r

-               // Fill the second bank\r
-               cpt = MIN(length, AT91C_EP_IN_SIZE-1);\r
+               // Fill the next bank\r
+               cpt = MIN(length, AT91C_EP_IN_SIZE);\r

                length -= cpt;\r
                length -= cpt;\r

-               while (cpt--) pUdp->UDP_FDR[AT91C_EP_IN] = *data++;\r
-               // Wait for the first bank to be sent\r
+               while (cpt--) {\r
+                       pUdp->UDP_FDR[AT91C_EP_IN] = *data++;\r
+               }\r
+               // Wait for the previous bank to be sent\r

                while (!(pUdp->UDP_CSR[AT91C_EP_IN] & AT91C_UDP_TXCOMP)) {\r
                        if (!usb_check()) return length;\r
                while (!(pUdp->UDP_CSR[AT91C_EP_IN] & AT91C_UDP_TXCOMP)) {\r
                        if (!usb_check()) return length;\r

-    }\r
-               pUdp->UDP_CSR[AT91C_EP_IN] &= ~(AT91C_UDP_TXCOMP);\r
+               }\r
+               UDP_CLEAR_EP_FLAGS(AT91C_EP_IN, AT91C_UDP_TXCOMP);\r

                while (pUdp->UDP_CSR[AT91C_EP_IN] & AT91C_UDP_TXCOMP);\r
                while (pUdp->UDP_CSR[AT91C_EP_IN] & AT91C_UDP_TXCOMP);\r

-               pUdp->UDP_CSR[AT91C_EP_IN] |= AT91C_UDP_TXPKTRDY;\r
+               UDP_SET_EP_FLAGS(AT91C_EP_IN, AT91C_UDP_TXPKTRDY);\r

        }\r
        }\r

-  \r
+\r

        // Wait for the end of transfer\r
        while (!(pUdp->UDP_CSR[AT91C_EP_IN] & AT91C_UDP_TXCOMP)) {\r
                if (!usb_check()) return length;\r
        // Wait for the end of transfer\r
        while (!(pUdp->UDP_CSR[AT91C_EP_IN] & AT91C_UDP_TXCOMP)) {\r
                if (!usb_check()) return length;\r

-  }\r
-  \r
-       pUdp->UDP_CSR[AT91C_EP_IN] &= ~(AT91C_UDP_TXCOMP);\r
+       }\r
+\r
+       UDP_CLEAR_EP_FLAGS(AT91C_EP_IN, AT91C_UDP_TXCOMP);\r

        while (pUdp->UDP_CSR[AT91C_EP_IN] & AT91C_UDP_TXCOMP);\r
 \r
        return length;\r
 }\r
 \r
        while (pUdp->UDP_CSR[AT91C_EP_IN] & AT91C_UDP_TXCOMP);\r
 \r
        return length;\r
 }\r
 \r

+\r

 //*----------------------------------------------------------------------------\r
 //* \fn    AT91F_USB_SendData\r
 //* \brief Send Data through the control endpoint\r
 //*----------------------------------------------------------------------------\r
 //* \fn    AT91F_USB_SendData\r
 //* \brief Send Data through the control endpoint\r


@@ -400,52 +473,55 @@ static void AT91F_USB_SendData(AT91PS_UDP pUdp, const char *pData, uint32_t leng
                while (cpt--)\r
                        pUdp->UDP_FDR[0] = *pData++;\r
 \r
                while (cpt--)\r
                        pUdp->UDP_FDR[0] = *pData++;\r
 \r

-               if (pUdp->UDP_CSR[0] & AT91C_UDP_TXCOMP) {\r
-                       pUdp->UDP_CSR[0] &= ~(AT91C_UDP_TXCOMP);\r
-                       while (pUdp->UDP_CSR[0] & AT91C_UDP_TXCOMP);\r
+               if (pUdp->UDP_CSR[AT91C_EP_CONTROL] & AT91C_UDP_TXCOMP) {\r
+                       UDP_CLEAR_EP_FLAGS(AT91C_EP_CONTROL, AT91C_UDP_TXCOMP);\r
+                       while (pUdp->UDP_CSR[AT91C_EP_CONTROL] & AT91C_UDP_TXCOMP);\r

                }\r
 \r
                }\r
 \r

-               pUdp->UDP_CSR[0] |= AT91C_UDP_TXPKTRDY;\r
+               UDP_SET_EP_FLAGS(AT91C_EP_CONTROL, AT91C_UDP_TXPKTRDY);\r

                do {\r
                do {\r

-                       csr = pUdp->UDP_CSR[0];\r
+                       csr = pUdp->UDP_CSR[AT91C_EP_CONTROL];\r

 \r
                        // Data IN stage has been stopped by a status OUT\r
                        if (csr & AT91C_UDP_RX_DATA_BK0) {\r
 \r
                        // Data IN stage has been stopped by a status OUT\r
                        if (csr & AT91C_UDP_RX_DATA_BK0) {\r

-                               pUdp->UDP_CSR[0] &= ~(AT91C_UDP_RX_DATA_BK0);\r
+                               UDP_CLEAR_EP_FLAGS(AT91C_EP_CONTROL, AT91C_UDP_RX_DATA_BK0);\r

                                return;\r
                        }\r
                } while ( !(csr & AT91C_UDP_TXCOMP) );\r
 \r
        } while (length);\r
 \r
                                return;\r
                        }\r
                } while ( !(csr & AT91C_UDP_TXCOMP) );\r
 \r
        } while (length);\r
 \r

-       if (pUdp->UDP_CSR[0] & AT91C_UDP_TXCOMP) {\r
-               pUdp->UDP_CSR[0] &= ~(AT91C_UDP_TXCOMP);\r
-               while (pUdp->UDP_CSR[0] & AT91C_UDP_TXCOMP);\r
+       if (pUdp->UDP_CSR[AT91C_EP_CONTROL] & AT91C_UDP_TXCOMP) {\r
+               UDP_CLEAR_EP_FLAGS(AT91C_EP_CONTROL, AT91C_UDP_TXCOMP);\r
+               while (pUdp->UDP_CSR[AT91C_EP_CONTROL] & AT91C_UDP_TXCOMP);\r

        }\r
 }\r
 \r
        }\r
 }\r
 \r

+\r

 //*----------------------------------------------------------------------------\r
 //* \fn    AT91F_USB_SendZlp\r
 //* \brief Send zero length packet through the control endpoint\r
 //*----------------------------------------------------------------------------\r
 void AT91F_USB_SendZlp(AT91PS_UDP pUdp) {\r
 //*----------------------------------------------------------------------------\r
 //* \fn    AT91F_USB_SendZlp\r
 //* \brief Send zero length packet through the control endpoint\r
 //*----------------------------------------------------------------------------\r
 void AT91F_USB_SendZlp(AT91PS_UDP pUdp) {\r

-       pUdp->UDP_CSR[0] |= AT91C_UDP_TXPKTRDY;\r
-       while ( !(pUdp->UDP_CSR[0] & AT91C_UDP_TXCOMP) );\r
-       pUdp->UDP_CSR[0] &= ~(AT91C_UDP_TXCOMP);\r
-       while (pUdp->UDP_CSR[0] & AT91C_UDP_TXCOMP);\r
+       UDP_SET_EP_FLAGS(AT91C_EP_CONTROL, AT91C_UDP_TXPKTRDY);\r
+       while ( !(pUdp->UDP_CSR[AT91C_EP_CONTROL] & AT91C_UDP_TXCOMP) );\r
+       UDP_CLEAR_EP_FLAGS(AT91C_EP_CONTROL, AT91C_UDP_TXCOMP);\r
+       while (pUdp->UDP_CSR[AT91C_EP_CONTROL] & AT91C_UDP_TXCOMP);\r

 }\r
 \r
 }\r
 \r

+\r

 //*----------------------------------------------------------------------------\r
 //* \fn    AT91F_USB_SendStall\r
 //* \brief Stall the control endpoint\r
 //*----------------------------------------------------------------------------\r
 void AT91F_USB_SendStall(AT91PS_UDP pUdp) {\r
 //*----------------------------------------------------------------------------\r
 //* \fn    AT91F_USB_SendStall\r
 //* \brief Stall the control endpoint\r
 //*----------------------------------------------------------------------------\r
 void AT91F_USB_SendStall(AT91PS_UDP pUdp) {\r

-       pUdp->UDP_CSR[0] |= AT91C_UDP_FORCESTALL;\r
-       while ( !(pUdp->UDP_CSR[0] & AT91C_UDP_ISOERROR) );\r
-       pUdp->UDP_CSR[0] &= ~(AT91C_UDP_FORCESTALL | AT91C_UDP_ISOERROR);\r
-       while (pUdp->UDP_CSR[0] & (AT91C_UDP_FORCESTALL | AT91C_UDP_ISOERROR));\r
+       UDP_SET_EP_FLAGS(AT91C_EP_CONTROL, AT91C_UDP_FORCESTALL);\r
+       while ( !(pUdp->UDP_CSR[AT91C_EP_CONTROL] & AT91C_UDP_ISOERROR) );\r
+       UDP_CLEAR_EP_FLAGS(AT91C_EP_CONTROL, AT91C_UDP_FORCESTALL | AT91C_UDP_ISOERROR);\r
+       while (pUdp->UDP_CSR[AT91C_EP_CONTROL] & (AT91C_UDP_FORCESTALL | AT91C_UDP_ISOERROR));\r

 }\r
 \r
 }\r
 \r

+\r

 //*----------------------------------------------------------------------------\r
 //* \fn    AT91F_CDC_Enumerate\r
 //* \brief This function is a callback invoked when a SETUP packet is received\r
 //*----------------------------------------------------------------------------\r
 //* \fn    AT91F_CDC_Enumerate\r
 //* \brief This function is a callback invoked when a SETUP packet is received\r


@@ -454,24 +530,24 @@ void AT91F_CDC_Enumerate() {
        byte_t bmRequestType, bRequest;\r
        uint16_t wValue, wIndex, wLength, wStatus;\r
 \r
        byte_t bmRequestType, bRequest;\r
        uint16_t wValue, wIndex, wLength, wStatus;\r
 \r

-       if ( !(pUdp->UDP_CSR[0] & AT91C_UDP_RXSETUP) )\r
+       if ( !(pUdp->UDP_CSR[AT91C_EP_CONTROL] & AT91C_UDP_RXSETUP) )\r

                return;\r
 \r
                return;\r
 \r

-       bmRequestType = pUdp->UDP_FDR[0];\r
-       bRequest      = pUdp->UDP_FDR[0];\r
-       wValue        = (pUdp->UDP_FDR[0] & 0xFF);\r
-       wValue       |= (pUdp->UDP_FDR[0] << 8);\r
-       wIndex        = (pUdp->UDP_FDR[0] & 0xFF);\r
-       wIndex       |= (pUdp->UDP_FDR[0] << 8);\r
-       wLength       = (pUdp->UDP_FDR[0] & 0xFF);\r
-       wLength      |= (pUdp->UDP_FDR[0] << 8);\r
-\r
-       if (bmRequestType & 0x80) {\r
-               pUdp->UDP_CSR[0] |= AT91C_UDP_DIR;\r
-               while ( !(pUdp->UDP_CSR[0] & AT91C_UDP_DIR) );\r
+       bmRequestType = pUdp->UDP_FDR[AT91C_EP_CONTROL];\r
+       bRequest      = pUdp->UDP_FDR[AT91C_EP_CONTROL];\r
+       wValue        = (pUdp->UDP_FDR[AT91C_EP_CONTROL] & 0xFF);\r
+       wValue       |= (pUdp->UDP_FDR[AT91C_EP_CONTROL] << 8);\r
+       wIndex        = (pUdp->UDP_FDR[AT91C_EP_CONTROL] & 0xFF);\r
+       wIndex       |= (pUdp->UDP_FDR[AT91C_EP_CONTROL] << 8);\r
+       wLength       = (pUdp->UDP_FDR[AT91C_EP_CONTROL] & 0xFF);\r
+       wLength      |= (pUdp->UDP_FDR[AT91C_EP_CONTROL] << 8);\r
+\r
+       if (bmRequestType & 0x80) {     // Data Phase Transfer Direction Device to Host\r
+               UDP_SET_EP_FLAGS(AT91C_EP_CONTROL, AT91C_UDP_DIR);\r
+               while ( !(pUdp->UDP_CSR[AT91C_EP_CONTROL] & AT91C_UDP_DIR) );\r

        }\r
        }\r

-       pUdp->UDP_CSR[0] &= ~AT91C_UDP_RXSETUP;\r
-       while ( (pUdp->UDP_CSR[0]  & AT91C_UDP_RXSETUP)  );\r
+       UDP_CLEAR_EP_FLAGS(AT91C_EP_CONTROL, AT91C_UDP_RXSETUP);\r
+       while ( (pUdp->UDP_CSR[AT91C_EP_CONTROL] & AT91C_UDP_RXSETUP)  );\r

 \r
        // Handle supported standard device request Cf Table 9-3 in USB specification Rev 1.1\r
        switch ((bRequest << 8) | bmRequestType) {\r
 \r
        // Handle supported standard device request Cf Table 9-3 in USB specification Rev 1.1\r
        switch ((bRequest << 8) | bmRequestType) {\r


@@ -480,8 +556,14 @@ void AT91F_CDC_Enumerate() {
                        AT91F_USB_SendData(pUdp, devDescriptor, MIN(sizeof(devDescriptor), wLength));\r
                else if (wValue == 0x200)  // Return Configuration Descriptor\r
                        AT91F_USB_SendData(pUdp, cfgDescriptor, MIN(sizeof(cfgDescriptor), wLength));\r
                        AT91F_USB_SendData(pUdp, devDescriptor, MIN(sizeof(devDescriptor), wLength));\r
                else if (wValue == 0x200)  // Return Configuration Descriptor\r
                        AT91F_USB_SendData(pUdp, cfgDescriptor, MIN(sizeof(cfgDescriptor), wLength));\r

-               else if ((wValue & 0x300) == 0x300)  // Return String Descriptor\r
-                       AT91F_USB_SendData(pUdp, strDescriptor, MIN(sizeof(strDescriptor), wLength));\r
+               else if ((wValue & 0xF00) == 0x300) { // Return String Descriptor\r
+                       const char *strDescriptor = getStringDescriptor(wValue & 0xff);\r
+                       if (strDescriptor != NULL) {\r
+                               AT91F_USB_SendData(pUdp, strDescriptor, MIN(strDescriptor[0], wLength));\r
+                       } else {\r
+                               AT91F_USB_SendStall(pUdp);\r
+                       }\r
+               }\r

                else\r
                        AT91F_USB_SendStall(pUdp);\r
                break;\r
                else\r
                        AT91F_USB_SendStall(pUdp);\r
                break;\r


@@ -494,29 +576,29 @@ void AT91F_CDC_Enumerate() {
                btConfiguration = wValue;\r
                AT91F_USB_SendZlp(pUdp);\r
                pUdp->UDP_GLBSTATE  = (wValue) ? AT91C_UDP_CONFG : AT91C_UDP_FADDEN;\r
                btConfiguration = wValue;\r
                AT91F_USB_SendZlp(pUdp);\r
                pUdp->UDP_GLBSTATE  = (wValue) ? AT91C_UDP_CONFG : AT91C_UDP_FADDEN;\r

-               pUdp->UDP_CSR[1] = (wValue) ? (AT91C_UDP_EPEDS | AT91C_UDP_EPTYPE_BULK_OUT) : 0;\r
-               pUdp->UDP_CSR[2] = (wValue) ? (AT91C_UDP_EPEDS | AT91C_UDP_EPTYPE_BULK_IN)  : 0;\r
-               pUdp->UDP_CSR[3] = (wValue) ? (AT91C_UDP_EPEDS | AT91C_UDP_EPTYPE_INT_IN)   : 0;\r
+               pUdp->UDP_CSR[AT91C_EP_OUT]    = (wValue) ? (AT91C_UDP_EPEDS | AT91C_UDP_EPTYPE_BULK_OUT) : 0;\r
+               pUdp->UDP_CSR[AT91C_EP_IN]     = (wValue) ? (AT91C_UDP_EPEDS | AT91C_UDP_EPTYPE_BULK_IN)  : 0;\r
+               pUdp->UDP_CSR[AT91C_EP_NOTIFY] = (wValue) ? (AT91C_UDP_EPEDS | AT91C_UDP_EPTYPE_INT_IN)   : 0;\r

                break;\r
        case STD_GET_CONFIGURATION:\r
                AT91F_USB_SendData(pUdp, (char *) &(btConfiguration), sizeof(btConfiguration));\r
                break;\r
        case STD_GET_STATUS_ZERO:\r
                break;\r
        case STD_GET_CONFIGURATION:\r
                AT91F_USB_SendData(pUdp, (char *) &(btConfiguration), sizeof(btConfiguration));\r
                break;\r
        case STD_GET_STATUS_ZERO:\r

-               wStatus = 0;\r
+               wStatus = 0;    // Device is Bus powered, remote wakeup disabled\r

                AT91F_USB_SendData(pUdp, (char *) &wStatus, sizeof(wStatus));\r
                break;\r
        case STD_GET_STATUS_INTERFACE:\r
                AT91F_USB_SendData(pUdp, (char *) &wStatus, sizeof(wStatus));\r
                break;\r
        case STD_GET_STATUS_INTERFACE:\r

-               wStatus = 0;\r
+               wStatus = 0;    // reserved for future use\r

                AT91F_USB_SendData(pUdp, (char *) &wStatus, sizeof(wStatus));\r
                break;\r
        case STD_GET_STATUS_ENDPOINT:\r
                wStatus = 0;\r
                wIndex &= 0x0F;\r
                AT91F_USB_SendData(pUdp, (char *) &wStatus, sizeof(wStatus));\r
                break;\r
        case STD_GET_STATUS_ENDPOINT:\r
                wStatus = 0;\r
                wIndex &= 0x0F;\r

-               if ((pUdp->UDP_GLBSTATE & AT91C_UDP_CONFG) && (wIndex <= 3)) {\r
+               if ((pUdp->UDP_GLBSTATE & AT91C_UDP_CONFG) && (wIndex <= AT91C_EP_NOTIFY)) {\r

                        wStatus = (pUdp->UDP_CSR[wIndex] & AT91C_UDP_EPEDS) ? 0 : 1;\r
                        AT91F_USB_SendData(pUdp, (char *) &wStatus, sizeof(wStatus));\r
                }\r
                        wStatus = (pUdp->UDP_CSR[wIndex] & AT91C_UDP_EPEDS) ? 0 : 1;\r
                        AT91F_USB_SendData(pUdp, (char *) &wStatus, sizeof(wStatus));\r
                }\r

-               else if ((pUdp->UDP_GLBSTATE & AT91C_UDP_FADDEN) && (wIndex == 0)) {\r
+               else if ((pUdp->UDP_GLBSTATE & AT91C_UDP_FADDEN) && (wIndex == AT91C_EP_CONTROL)) {\r

                        wStatus = (pUdp->UDP_CSR[wIndex] & AT91C_UDP_EPEDS) ? 0 : 1;\r
                        AT91F_USB_SendData(pUdp, (char *) &wStatus, sizeof(wStatus));\r
                }\r
                        wStatus = (pUdp->UDP_CSR[wIndex] & AT91C_UDP_EPEDS) ? 0 : 1;\r
                        AT91F_USB_SendData(pUdp, (char *) &wStatus, sizeof(wStatus));\r
                }\r


@@ -531,7 +613,7 @@ void AT91F_CDC_Enumerate() {
                break;\r
        case STD_SET_FEATURE_ENDPOINT:\r
                wIndex &= 0x0F;\r
                break;\r
        case STD_SET_FEATURE_ENDPOINT:\r
                wIndex &= 0x0F;\r

-               if ((wValue == 0) && wIndex && (wIndex <= 3)) {\r
+               if ((wValue == 0) && (wIndex >= AT91C_EP_OUT) && (wIndex <= AT91C_EP_NOTIFY)) {\r

                        pUdp->UDP_CSR[wIndex] = 0;\r
                        AT91F_USB_SendZlp(pUdp);\r
                }\r
                        pUdp->UDP_CSR[wIndex] = 0;\r
                        AT91F_USB_SendZlp(pUdp);\r
                }\r


@@ -546,13 +628,13 @@ void AT91F_CDC_Enumerate() {
                break;\r
        case STD_CLEAR_FEATURE_ENDPOINT:\r
                wIndex &= 0x0F;\r
                break;\r
        case STD_CLEAR_FEATURE_ENDPOINT:\r
                wIndex &= 0x0F;\r

-               if ((wValue == 0) && wIndex && (wIndex <= 3)) {\r
-                       if (wIndex == 1)\r
-                               pUdp->UDP_CSR[1] = (AT91C_UDP_EPEDS | AT91C_UDP_EPTYPE_BULK_OUT);\r
-                       else if (wIndex == 2)\r
-                               pUdp->UDP_CSR[2] = (AT91C_UDP_EPEDS | AT91C_UDP_EPTYPE_BULK_IN);\r
-                       else if (wIndex == 3)\r
-                               pUdp->UDP_CSR[3] = (AT91C_UDP_EPEDS | AT91C_UDP_EPTYPE_ISO_IN);\r
+               if ((wValue == 0) && (wIndex >= AT91C_EP_OUT) && (wIndex <= AT91C_EP_NOTIFY)) {\r
+                       if (wIndex == AT91C_EP_OUT)\r
+                               pUdp->UDP_CSR[AT91C_EP_OUT] = (AT91C_UDP_EPEDS | AT91C_UDP_EPTYPE_BULK_OUT);\r
+                       else if (wIndex == AT91C_EP_IN)\r
+                               pUdp->UDP_CSR[AT91C_EP_IN] = (AT91C_UDP_EPEDS | AT91C_UDP_EPTYPE_BULK_IN);\r
+                       else if (wIndex == AT91C_EP_NOTIFY)\r
+                               pUdp->UDP_CSR[AT91C_EP_NOTIFY] = (AT91C_UDP_EPEDS | AT91C_UDP_EPTYPE_INT_IN);\r

                        AT91F_USB_SendZlp(pUdp);\r
                }\r
                else\r
                        AT91F_USB_SendZlp(pUdp);\r
                }\r
                else\r


@@ -561,8 +643,8 @@ void AT91F_CDC_Enumerate() {
 \r
        // handle CDC class requests\r
        case SET_LINE_CODING:\r
 \r
        // handle CDC class requests\r
        case SET_LINE_CODING:\r

-               while ( !(pUdp->UDP_CSR[0] & AT91C_UDP_RX_DATA_BK0) );\r
-               pUdp->UDP_CSR[0] &= ~(AT91C_UDP_RX_DATA_BK0);\r
+               while ( !(pUdp->UDP_CSR[AT91C_EP_CONTROL] & AT91C_UDP_RX_DATA_BK0) );\r
+               UDP_CLEAR_EP_FLAGS(AT91C_EP_CONTROL, AT91C_UDP_RX_DATA_BK0);\r

                AT91F_USB_SendZlp(pUdp);\r
                break;\r
        case GET_LINE_CODING:\r
                AT91F_USB_SendZlp(pUdp);\r
                break;\r
        case GET_LINE_CODING:\r