Merge pull request #2 from arduino/master

pull master

Author: me-no-dev

hardware/arduino/avr/cores/arduino/PluggableUSB.cpp

@@ -23,78 +23,93 @@
 #if defined(USBCON)	
 #ifdef PLUGGABLE_USB_ENABLED
 
-#define MAX_MODULES	6
+extern uint8_t _initEndpoints[];
 
-static u8 lastIf = CDC_ACM_INTERFACE + CDC_INTERFACE_COUNT;
-static u8 lastEp = CDC_FIRST_ENDPOINT + CDC_ENPOINT_COUNT;
-
-extern u8 _initEndpoints[];
-
-//PUSBCallbacks cbs[MAX_MODULES];
-static u8 modules_count = 0;
-
-static PUSBListNode* rootNode = NULL;
+int PluggableUSB_::getInterface(uint8_t* interfaceCount)
+{
+	int sent = 0;
+	PluggableUSBModule* node;
+	for (node = rootNode; node; node = node->next) {
+		int res = node->getInterface(interfaceCount);
+		if (res < 0)
+			return -1;
+		sent += res;
+	}
+	return sent;
+}
 
-int PUSB_GetInterface(u8* interfaceNum)
+int PluggableUSB_::getDescriptor(USBSetup& setup)
 {
-	int ret = 0;
-	PUSBListNode* node = rootNode;
-	for (u8 i=0; i<modules_count; i++) {
-		ret = node->cb->getInterface(interfaceNum);
-		node = node->next;
+	PluggableUSBModule* node;
+	for (node = rootNode; node; node = node->next) {
+		int ret = node->getDescriptor(setup);
+		// ret!=0 -> request has been processed
+		if (ret)
+			return ret;
 	}
-	return ret;
+	return 0;
 }
 
-int PUSB_GetDescriptor(int8_t t)
+void PluggableUSB_::getShortName(char *iSerialNum)
 {
-	int ret = 0;
-	PUSBListNode* node = rootNode;
-	for (u8 i=0; i<modules_count && ret == 0; i++) {
-		ret = node->cb->getDescriptor(t);
-		node = node->next;
+	PluggableUSBModule* node;
+	for (node = rootNode; node; node = node->next) {
+		iSerialNum += node->getShortName(iSerialNum);
 	}
-	return ret;
+	*iSerialNum = 0;
 }
 
-bool PUSB_Setup(USBSetup& setup, u8 j)
+bool PluggableUSB_::setup(USBSetup& setup)
 {
-	bool ret = false;
-	PUSBListNode* node = rootNode;
-	for (u8 i=0; i<modules_count && ret == false; i++) {
-		ret = node->cb->setup(setup, j);
-		node = node->next;
+	PluggableUSBModule* node;
+	for (node = rootNode; node; node = node->next) {
+		if (node->setup(setup)) {
+			return true;
+		}
 	}
-	return ret;
+	return false;
 }
 
-int8_t PUSB_AddFunction(PUSBListNode *node, u8* interface)
+bool PluggableUSB_::plug(PluggableUSBModule *node)
 {
-	if (modules_count >= MAX_MODULES) {
-		return 0;
+	if ((lastEp + node->numEndpoints) > USB_ENDPOINTS) {
+		return false;
 	}
 
-	if (modules_count == 0) {
+	if (!rootNode) {
 		rootNode = node;
 	} else {
-		PUSBListNode *current = rootNode;
-		while(current->next != NULL) {
+		PluggableUSBModule *current = rootNode;
+		while (current->next) {
 			current = current->next;
 		}
 		current->next = node;
 	}
 
-	*interface = lastIf;
-	lastIf += node->cb->numInterfaces;
-	for ( u8 i = 0; i< node->cb->numEndpoints; i++) {
-		_initEndpoints[lastEp] = node->cb->endpointType[i];
+	node->pluggedInterface = lastIf;
+	node->pluggedEndpoint = lastEp;
+	lastIf += node->numInterfaces;
+	for (uint8_t i = 0; i < node->numEndpoints; i++) {
+		_initEndpoints[lastEp] = node->endpointType[i];
 		lastEp++;
 	}
-	modules_count++;
-	return lastEp - node->cb->numEndpoints;
+	return true;
 	// restart USB layer???
 }
 
+PluggableUSB_& PluggableUSB()
+{
+	static PluggableUSB_ obj;
+	return obj;
+}
+
+PluggableUSB_::PluggableUSB_() : lastIf(CDC_ACM_INTERFACE + CDC_INTERFACE_COUNT),
+                                 lastEp(CDC_FIRST_ENDPOINT + CDC_ENPOINT_COUNT),
+                                 rootNode(NULL)
+{
+	// Empty
+}
+
 #endif
 
-#endif /* if defined(USBCON) */
+#endif /* if defined(USBCON) */

hardware/arduino/avr/cores/arduino/PluggableUSB.h

@@ -25,30 +25,49 @@
 
 #if defined(USBCON)
 
-typedef struct __attribute__((packed))
-{
-  bool (*setup)(USBSetup& setup, u8 i);
-  int (*getInterface)(u8* interfaceNum);
-  int (*getDescriptor)(int8_t t);
-  int8_t numEndpoints;
-  int8_t numInterfaces;
-  uint8_t *endpointType;
-} PUSBCallbacks;
-
-class PUSBListNode {
+class PluggableUSBModule {
 public:
-  PUSBListNode *next = NULL;
-  PUSBCallbacks *cb;
-  PUSBListNode(PUSBCallbacks *ncb) {cb = ncb;}
-};
+  PluggableUSBModule(uint8_t numEps, uint8_t numIfs, uint8_t *epType) :
+    numEndpoints(numEps), numInterfaces(numIfs), endpointType(epType)
+  { }
+
+protected:
+  virtual bool setup(USBSetup& setup) = 0;
+  virtual int getInterface(uint8_t* interfaceCount) = 0;
+  virtual int getDescriptor(USBSetup& setup) = 0;
+  virtual uint8_t getShortName(char *name) { name[0] = 'A'+pluggedInterface; return 1; }
+
+  uint8_t pluggedInterface;
+  uint8_t pluggedEndpoint;
+
+  const uint8_t numEndpoints;
+  const uint8_t numInterfaces;
+  const uint8_t *endpointType;
 
-int8_t PUSB_AddFunction(PUSBListNode *node, u8 *interface);
+  PluggableUSBModule *next = NULL;
 
-int PUSB_GetInterface(u8* interfaceNum);
+  friend class PluggableUSB_;
+};
+
+class PluggableUSB_ {
+public:
+  PluggableUSB_();
+  bool plug(PluggableUSBModule *node);
+  int getInterface(uint8_t* interfaceCount);
+  int getDescriptor(USBSetup& setup);
+  bool setup(USBSetup& setup);
+  void getShortName(char *iSerialNum);
 
-int PUSB_GetDescriptor(int8_t t);
+private:
+  uint8_t lastIf;
+  uint8_t lastEp;
+  PluggableUSBModule* rootNode;
+};
 
-bool PUSB_Setup(USBSetup& setup, u8 i);
+// Replacement for global singleton.
+// This function prevents static-initialization-order-fiasco
+// https://isocpp.org/wiki/faq/ctors#static-init-order-on-first-use
+PluggableUSB_& PluggableUSB();
 
 #endif
 

hardware/arduino/avr/cores/arduino/USBCore.cpp

@@ -18,6 +18,7 @@
 
 #include "USBAPI.h"
 #include "PluggableUSB.h"
+#include <stdlib.h>
 
 #if defined(USBCON)
 
@@ -69,10 +70,10 @@ const u8 STRING_MANUFACTURER[] PROGMEM = USB_MANUFACTURER;
 
 //	DEVICE DESCRIPTOR
 const DeviceDescriptor USB_DeviceDescriptor =
-	D_DEVICE(0x00,0x00,0x00,64,USB_VID,USB_PID,0x100,IMANUFACTURER,IPRODUCT,0,1);
+	D_DEVICE(0x00,0x00,0x00,64,USB_VID,USB_PID,0x100,IMANUFACTURER,IPRODUCT,ISERIAL,1);
 
 const DeviceDescriptor USB_DeviceDescriptorB =
-	D_DEVICE(0xEF,0x02,0x01,64,USB_VID,USB_PID,0x100,IMANUFACTURER,IPRODUCT,0,1);
+	D_DEVICE(0xEF,0x02,0x01,64,USB_VID,USB_PID,0x100,IMANUFACTURER,IPRODUCT,ISERIAL,1);
 
 //==================================================================
 //==================================================================
@@ -308,20 +309,15 @@ int USB_Send(u8 ep, const void* d, int len)
 	return r;
 }
 
-u8 _initEndpoints[] =
+u8 _initEndpoints[USB_ENDPOINTS] =
 {
-	0,
+	0,                      // Control Endpoint
 
-	EP_TYPE_INTERRUPT_IN,		// CDC_ENDPOINT_ACM
-	EP_TYPE_BULK_OUT,			// CDC_ENDPOINT_OUT
-	EP_TYPE_BULK_IN,			// CDC_ENDPOINT_IN
+	EP_TYPE_INTERRUPT_IN,   // CDC_ENDPOINT_ACM
+	EP_TYPE_BULK_OUT,       // CDC_ENDPOINT_OUT
+	EP_TYPE_BULK_IN,        // CDC_ENDPOINT_IN
 
-#ifdef PLUGGABLE_USB_ENABLED
-	//allocate 3 endpoints and remove const so they can be changed by the user
-	0,
-	0,
-	0,
-#endif
+	// Following endpoints are automatically initialized to 0
 };
 
 #define EP_SINGLE_64 0x32	// EP0
@@ -367,7 +363,7 @@ bool ClassInterfaceRequest(USBSetup& setup)
 		return CDC_Setup(setup);
 
 #ifdef PLUGGABLE_USB_ENABLED
-	return PUSB_Setup(setup, i);
+	return PluggableUSB().setup(setup);
 #endif
 	return false;
 }
@@ -414,11 +410,12 @@ int USB_SendControl(u8 flags, const void* d, int len)
 // Send a USB descriptor string. The string is stored in PROGMEM as a
 // plain ASCII string but is sent out as UTF-16 with the correct 2-byte
 // prefix
-static bool USB_SendStringDescriptor(const u8*string_P, u8 string_len) {
+static bool USB_SendStringDescriptor(const u8*string_P, u8 string_len, uint8_t flags) {
         SendControl(2 + string_len * 2);
         SendControl(3);
+        bool pgm = flags & TRANSFER_PGM;
         for(u8 i = 0; i < string_len; i++) {
-                bool r = SendControl(pgm_read_byte(&string_P[i]));
+                bool r = SendControl(pgm ? pgm_read_byte(&string_P[i]) : string_P[i]);
                 r &= SendControl(0); // high byte
                 if(!r) {
                         return false;
@@ -445,7 +442,7 @@ static u8 SendInterfaces()
 	CDC_GetInterface(&interfaces);
 
 #ifdef PLUGGABLE_USB_ENABLED
-	PUSB_GetInterface(&interfaces);
+	PluggableUSB().getInterface(&interfaces);
 #endif
 
 	return interfaces;
@@ -481,7 +478,7 @@ bool SendDescriptor(USBSetup& setup)
 
 	InitControl(setup.wLength);
 #ifdef PLUGGABLE_USB_ENABLED
-	ret = PUSB_GetDescriptor(t);
+	ret = PluggableUSB().getDescriptor(setup);
 	if (ret != 0) {
 		return (ret > 0 ? true : false);
 	}
@@ -500,10 +497,17 @@ bool SendDescriptor(USBSetup& setup)
 			desc_addr = (const u8*)&STRING_LANGUAGE;
 		}
 		else if (setup.wValueL == IPRODUCT) {
-			return USB_SendStringDescriptor(STRING_PRODUCT, strlen(USB_PRODUCT));
+			return USB_SendStringDescriptor(STRING_PRODUCT, strlen(USB_PRODUCT), TRANSFER_PGM);
 		}
 		else if (setup.wValueL == IMANUFACTURER) {
-			return USB_SendStringDescriptor(STRING_MANUFACTURER, strlen(USB_MANUFACTURER));
+			return USB_SendStringDescriptor(STRING_MANUFACTURER, strlen(USB_MANUFACTURER), TRANSFER_PGM);
+		}
+		else if (setup.wValueL == ISERIAL) {
+#ifdef PLUGGABLE_USB_ENABLED
+			char name[ISERIAL_MAX_LEN];
+			PluggableUSB().getShortName(name);
+			return USB_SendStringDescriptor((uint8_t*)name, strlen(name), 0);
+#endif
 		}
 		else
 			return false;

hardware/arduino/avr/cores/arduino/USBCore.h

@@ -49,8 +49,9 @@
 #define REQUEST_OTHER			0x03
 #define REQUEST_RECIPIENT		0x03
 
-#define REQUEST_DEVICETOHOST_CLASS_INTERFACE  (REQUEST_DEVICETOHOST + REQUEST_CLASS + REQUEST_INTERFACE)
-#define REQUEST_HOSTTODEVICE_CLASS_INTERFACE  (REQUEST_HOSTTODEVICE + REQUEST_CLASS + REQUEST_INTERFACE)
+#define REQUEST_DEVICETOHOST_CLASS_INTERFACE    (REQUEST_DEVICETOHOST | REQUEST_CLASS | REQUEST_INTERFACE)
+#define REQUEST_HOSTTODEVICE_CLASS_INTERFACE    (REQUEST_HOSTTODEVICE | REQUEST_CLASS | REQUEST_INTERFACE)
+#define REQUEST_DEVICETOHOST_STANDARD_INTERFACE (REQUEST_DEVICETOHOST | REQUEST_STANDARD | REQUEST_INTERFACE)
 
 //	Class requests
 
@@ -99,8 +100,8 @@
 
 // bEndpointAddress in Endpoint Descriptor
 #define USB_ENDPOINT_DIRECTION_MASK            0x80
-#define USB_ENDPOINT_OUT(addr)                 ((addr) | 0x00)
-#define USB_ENDPOINT_IN(addr)                  ((addr) | 0x80)
+#define USB_ENDPOINT_OUT(addr)                 (lowByte((addr) | 0x00))
+#define USB_ENDPOINT_IN(addr)                  (lowByte((addr) | 0x80))
 
 #define USB_ENDPOINT_TYPE_MASK                 0x03
 #define USB_ENDPOINT_TYPE_CONTROL              0x00
@@ -277,4 +278,4 @@ typedef struct
 #define D_CDCCS4(_subtype,_d0)		{ 4, 0x24, _subtype, _d0 }
 
 
-#endif
+#endif