]> git.zerfleddert.de Git - proxmark3-svn/blobdiff - common/usb_cdc.c
Fix typo and gcc-7 warnings (#401)
[proxmark3-svn] / common / usb_cdc.c
index ccbb3c50e91389a4d733e25f75c7f94e50e77ef5..84aa2c06e6dbea6639e3d1606e68a7a0288dd424 100644 (file)
  */\r
 \r
 #include "usb_cdc.h"\r
+#include "at91sam7s512.h"\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
+\r
+#define AT91C_EP_CONTROL     0\r
 #define AT91C_EP_IN_SIZE  0x40\r
 #define AT91C_EP_OUT         1\r
 #define AT91C_EP_OUT_SIZE 0x40\r
 #define AT91C_EP_IN          2\r
 \r
-const char devDescriptor[] = {\r
+static const char devDescriptor[] = {\r
        /* Device descriptor */\r
        0x12,      // bLength\r
        0x01,      // bDescriptorType\r
-       0x10,0x01, // Complies with USB Spec. Release (0110h = release 1.10)\r
+       0x00,0x02, // Complies with USB Spec. Release (0200h = release 2.0)\r
        0x02,      // bDeviceClass:    CDC class code\r
        0x00,      // bDeviceSubclass: CDC class sub code\r
        0x00,      // bDeviceProtocol: CDC Device protocol\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,      // iManufacturer    // 0x01\r
-       0x00,      // iProduct\r
-       0x00,      // SerialNumber\r
+       0x01,      // iManufacturer\r
+       0x02,      // iProduct\r
+       0x00,      // iSerialNumber\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
@@ -71,7 +72,7 @@ const char cfgDescriptor[] = {
        0x01,   // CbConfigurationValue\r
        0x00,   // CiConfiguration\r
        0xC0,   // CbmAttributes 0xA0\r
-       0x00,   // CMaxPower\r
+       0xFA,   // CMaxPower\r
 \r
        /* Communication Class Interface Descriptor Requirement */\r
        0x09, // bLength\r
@@ -81,7 +82,7 @@ const char cfgDescriptor[] = {
        0x01, // bNumEndpoints\r
        0x02, // bInterfaceClass\r
        0x02, // bInterfaceSubclass\r
-       0x00, // bInterfaceProtocol\r
+       0x01, // bInterfaceProtocol\r
        0x00, // iInterface\r
 \r
        /* Header Functional Descriptor */\r
@@ -95,7 +96,7 @@ const char cfgDescriptor[] = {
        0x04, // bFunctionLength\r
        0x24, // bDescriptor Type: CS_INTERFACE\r
        0x02, // bDescriptor Subtype: ACM Func Desc\r
-       0x00, // bmCapabilities\r
+       0x02, // bmCapabilities\r
 \r
        /* Union Functional Descriptor */\r
        0x05, // bFunctionLength\r
@@ -151,8 +152,14 @@ const char cfgDescriptor[] = {
        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
+static const char StrDescManufacturer[] = {\r
+  26,                  // Length\r
   0x03,                        // Type is string\r
   'p', 0x00,\r
   'r', 0x00,\r
@@ -165,11 +172,57 @@ const char strDescriptor[] = {
   '.', 0x00,\r
   'o', 0x00,\r
   'r', 0x00,\r
-  'g', 0x00,\r
+  'g', 0x00\r
 };\r
 \r
+static const char StrDescProduct[] = {\r
+  8,                   // Length\r
+  0x03,                        // Type is string\r
+  'P', 0x00,\r
+  'M', 0x00,\r
+  '3', 0x00\r
+};\r
+       \r
+static const char* const pStrings[] =\r
+{\r
+    StrDescLanguageCodes,\r
+    StrDescManufacturer,\r
+       StrDescProduct\r
+};\r
 \r
-/* USB standard request code */\r
+const char* getStringDescriptor(uint8_t idx)\r
+{\r
+    if(idx >= (sizeof(pStrings) / sizeof(pStrings[0]))) {\r
+        return(NULL);\r
+       } else {\r
+               return(pStrings[idx]);\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
+/* 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
@@ -277,7 +330,7 @@ bool usb_check() {
                // 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
+               pUdp->UDP_CSR[AT91C_EP_CONTROL] = (AT91C_UDP_EPEDS | AT91C_UDP_EPTYPE_CTRL);\r
        }\r
        else if (isr & AT91C_UDP_EPINT0) {\r
                pUdp->UDP_ICR = AT91C_UDP_EPINT0;\r
@@ -293,31 +346,47 @@ bool usb_poll()
   return (pUdp->UDP_CSR[AT91C_EP_OUT] & btReceiveBank);\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
+       still returns 0.\r
+       This check is basically the same as above, but also checks\r
+       that the length available to read is non-zero, thus hopefully fixes the\r
+       bug.\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
+}\r
+\r
 //*----------------------------------------------------------------------------\r
 //* \fn    usb_read\r
 //* \brief Read available data from Endpoint OUT\r
 //*----------------------------------------------------------------------------\r
 uint32_t usb_read(byte_t* data, size_t len) {\r
-  byte_t bank = btReceiveBank;\r
+       byte_t bank = btReceiveBank;\r
        uint32_t packetSize, nbBytesRcv = 0;\r
-  uint32_t time_out = 0;\r
+       uint32_t time_out = 0;\r
   \r
        while (len)  {\r
                if (!usb_check()) break;\r
 \r
                if ( pUdp->UDP_CSR[AT91C_EP_OUT] & bank ) {\r
                        packetSize = MIN(pUdp->UDP_CSR[AT91C_EP_OUT] >> 16, len);\r
-      len -= packetSize;\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
+                       } else {\r
                                bank = AT91C_UDP_RX_DATA_BK0;\r
-      }\r
+                       }\r
                }\r
-    if (time_out++ == 0x1fff) break;\r
+               if (time_out++ == 0x1fff) break;\r
        }\r
 \r
        btReceiveBank = bank;\r
@@ -339,20 +408,20 @@ uint32_t usb_write(const byte_t* data, const size_t len) {
        cpt = MIN(length, AT91C_EP_IN_SIZE-1);\r
        length -= cpt;\r
        while (cpt--) pUdp->UDP_FDR[AT91C_EP_IN] = *data++;\r
-       pUdp->UDP_CSR[AT91C_EP_IN] |= AT91C_UDP_TXPKTRDY;\r
+       UDP_SET_EP_FLAGS(AT91C_EP_IN, AT91C_UDP_TXPKTRDY);\r
 \r
        while (length) {\r
                // Fill the second bank\r
                cpt = MIN(length, AT91C_EP_IN_SIZE-1);\r
                length -= cpt;\r
                while (cpt--) pUdp->UDP_FDR[AT91C_EP_IN] = *data++;\r
-               // Wait for the the first bank to be sent\r
+               // Wait for the first bank to be sent\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
+               UDP_CLEAR_EP_FLAGS(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
        // Wait for the end of transfer\r
@@ -360,7 +429,7 @@ uint32_t usb_write(const byte_t* data, const size_t len) {
                if (!usb_check()) return length;\r
   }\r
   \r
-       pUdp->UDP_CSR[AT91C_EP_IN] &= ~(AT91C_UDP_TXCOMP);\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
@@ -384,27 +453,27 @@ static void AT91F_USB_SendData(AT91PS_UDP pUdp, const char *pData, uint32_t leng
                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
-               pUdp->UDP_CSR[0] |= AT91C_UDP_TXPKTRDY;\r
+               UDP_SET_EP_FLAGS(AT91C_EP_CONTROL, AT91C_UDP_TXPKTRDY);\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
-                               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
-       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
@@ -413,10 +482,10 @@ static void AT91F_USB_SendData(AT91PS_UDP pUdp, const char *pData, uint32_t leng
 //* \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
@@ -424,10 +493,10 @@ void AT91F_USB_SendZlp(AT91PS_UDP pUdp) {
 //* \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
@@ -438,7 +507,7 @@ void AT91F_CDC_Enumerate() {
        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
        bmRequestType = pUdp->UDP_FDR[0];\r
@@ -451,11 +520,11 @@ void AT91F_CDC_Enumerate() {
        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
+               UDP_SET_EP_FLAGS(AT91C_EP_CONTROL, AT91C_UDP_DIR);\r
+               while ( !(pUdp->UDP_CSR[AT91C_EP_CONTROL] & AT91C_UDP_DIR) );\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
@@ -464,8 +533,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
-               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
@@ -545,8 +620,8 @@ void AT91F_CDC_Enumerate() {
 \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
Impressum, Datenschutz