Modify class Serial_ for the new PluggableUSB API

giulcioffi · giulcioffi · commit 56a955ecc058 · 2020-08-31T17:43:34.000+02:00
The new class PluggableUSBModule in ArduinoCore-API does not implement the fuction
void handleEndpoint(int ep)
which was implemented in the previous version of the same class. This function now needs to be called as
proper of SerialUSB and not of PluggableUSB().
diff --git a/cores/arduino/USB/CDC.cpp b/cores/arduino/USB/CDC.cpp
@@ -19,6 +19,7 @@
 #include <Arduino.h>
 #include <Reset.h> // Needed for auto-reset with 1200bps port touch
 #include "CDC.h"
+#include "USBAPI.h"
 #include "SAMD21_USBDevice.h"
 
 #include <stdlib.h>
diff --git a/cores/arduino/USB/CDC.h b/cores/arduino/USB/CDC.h
@@ -5,7 +5,7 @@
 
 #include "USBDesc.h"
 #include "USBAPI.h"
-#include "PluggableUSB.h"
+#include "api/PluggableUSB.h"
 
 
 #define CDC_V1_10                               0x0110
@@ -74,88 +74,5 @@ typedef struct
 } CDCDescriptor;
 
 
-//================================================================================
-//	Serial over CDC (Serial1 is the physical port)
-
-class Serial_ : public Stream, public PluggableUSBModule {
-public:
-	Serial_(USBDeviceClass &_usb);
-
-	void begin(uint32_t baud_count);
-	void begin(unsigned long, uint8_t);
-	void end(void);
-
-	virtual int available(void);
-	virtual int availableForWrite(void);
-	virtual int peek(void);
-	virtual int read(void);
-	virtual void flush(void);
-	virtual void clear(void);
-	virtual size_t write(uint8_t);
-	virtual size_t write(const uint8_t *buffer, size_t size);
-	using Print::write; // pull in write(str) from Print
-	operator bool();
-
-	size_t readBytes(char *buffer, size_t length);
-
-	// This method allows processing "SEND_BREAK" requests sent by
-	// the USB host. Those requests indicate that the host wants to
-	// send a BREAK signal and are accompanied by a single uint16_t
-	// value, specifying the duration of the break. The value 0
-	// means to end any current break, while the value 0xffff means
-	// to start an indefinite break.
-	// readBreak() will return the value of the most recent break
-	// request, but will return it at most once, returning -1 when
-	// readBreak() is called again (until another break request is
-	// received, which is again returned once).
-	// This also mean that if two break requests are received
-	// without readBreak() being called in between, the value of the
-	// first request is lost.
-	// Note that the value returned is a long, so it can return
-	// 0-0xffff as well as -1.
-	int32_t readBreak();
-
-	// These return the settings specified by the USB host for the
-	// serial port. These aren't really used, but are offered here
-	// in case a sketch wants to act on these settings.
-	uint32_t baud();
-	uint8_t stopbits();
-	uint8_t paritytype();
-	uint8_t numbits();
-	bool dtr();
-	bool rts();
-	enum {
-		ONE_STOP_BIT = 0,
-		ONE_AND_HALF_STOP_BIT = 1,
-		TWO_STOP_BITS = 2,
-	};
-	enum {
-		NO_PARITY = 0,
-		ODD_PARITY = 1,
-		EVEN_PARITY = 2,
-		MARK_PARITY = 3,
-		SPACE_PARITY = 4,
-	};
-
-protected:
-    // Implementation of the PUSBListNode
-    int getInterface(uint8_t* interfaceNum);
-    int getDescriptor(USBSetup& setup);
-    bool setup(USBSetup& setup);
-    uint8_t getShortName(char* name);
-    void handleEndpoint(int ep);
-    void enableInterrupt();
-
-friend USBDeviceClass;
-
-private:
-	int availableForStore(void);
-
-	USBDeviceClass &usb;
-	bool stalled;
-	uint32_t epType[3];
-};
-extern Serial_ SerialUSB;
-
 #endif
 #endif
diff --git a/cores/arduino/USB/USBAPI.h b/cores/arduino/USB/USBAPI.h
@@ -33,6 +33,7 @@
 #include "api/Stream.h"
 #include "api/RingBuffer.h"
 #include "api/USBAPI.h"
+#include "CDC.h"
 
 #if ARDUINO_API_VERSION > 10000
 using namespace arduino;
@@ -97,12 +98,87 @@ class USBDeviceClass {
 extern USBDeviceClass USBDevice;
 
 //================================================================================
-//================================================================================
-//	MSC 'Driver'
+//	Serial over CDC (Serial1 is the physical port)
+
+class Serial_ : public Stream, public arduino::PluggableUSBModule
+{
+public:
+	Serial_(USBDeviceClass &_usb);
+	void begin(uint32_t baud_count);
+	void begin(unsigned long, uint8_t);
+	void end(void);
+
+	virtual int available(void);
+	virtual int availableForWrite(void);
+	virtual int peek(void);
+	virtual int read(void);
+	virtual void flush(void);
+	virtual void clear(void);
+	virtual size_t write(uint8_t);
+	virtual size_t write(const uint8_t *buffer, size_t size);
+	using Print::write; // pull in write(str) from Print
+	operator bool();
+
+	size_t readBytes(char *buffer, size_t length);
+
+	// This method allows processing "SEND_BREAK" requests sent by
+	// the USB host. Those requests indicate that the host wants to
+	// send a BREAK signal and are accompanied by a single uint16_t
+	// value, specifying the duration of the break. The value 0
+	// means to end any current break, while the value 0xffff means
+	// to start an indefinite break.
+	// readBreak() will return the value of the most recent break
+	// request, but will return it at most once, returning -1 when
+	// readBreak() is called again (until another break request is
+	// received, which is again returned once).
+	// This also mean that if two break requests are received
+	// without readBreak() being called in between, the value of the
+	// first request is lost.
+	// Note that the value returned is a long, so it can return
+	// 0-0xffff as well as -1.
+	int32_t readBreak();
+
+	// These return the settings specified by the USB host for the
+	// serial port. These aren't really used, but are offered here
+	// in case a sketch wants to act on these settings.
+	uint32_t baud();
+	uint8_t stopbits();
+	uint8_t paritytype();
+	uint8_t numbits();
+	bool dtr();
+	bool rts();
+	enum {
+		ONE_STOP_BIT = 0,
+		ONE_AND_HALF_STOP_BIT = 1,
+		TWO_STOP_BITS = 2,
+	};
+	enum {
+		NO_PARITY = 0,
+		ODD_PARITY = 1,
+		EVEN_PARITY = 2,
+		MARK_PARITY = 3,
+		SPACE_PARITY = 4,
+	};
+
+protected:
+    // Implementation of the PUSBListNode
+    int getInterface(uint8_t* interfaceNum);
+    int getDescriptor(USBSetup& setup);
+    bool setup(USBSetup& setup);
+    uint8_t getShortName(char* name);
+    void handleEndpoint(int ep);
+    void enableInterrupt();
+
+friend USBDeviceClass;
 
-uint32_t		MSC_GetInterface(uint8_t* interfaceNum);
-uint32_t		MSC_GetDescriptor(uint32_t i);
-bool	MSC_Setup(USBSetup& setup);
-bool	MSC_Data(uint8_t rx,uint8_t tx);
+private:
+	int availableForStore(void);
+
+	USBDeviceClass &usb;
+	bool stalled;
+	unsigned int epType[3];
+
+};
+extern Serial_ SerialUSB;
 
 #endif  // __cplusplus
diff --git a/cores/arduino/USB/USBCore.cpp b/cores/arduino/USB/USBCore.cpp
@@ -20,6 +20,8 @@
 
 #include <Arduino.h>
 
+#include "api/USBAPI.h"
+#include "USBAPI.h"
 #include "SAMD21_USBDevice.h"
 #include "CDC.h"
 #include "api/PluggableUSB.h"
@@ -230,11 +232,9 @@ bool USBDeviceClass::sendDescriptor(USBSetup &setup)
 			memset(name, 0, sizeof(name));
 			uint8_t idx = 0;
 #ifdef PLUGGABLE_USB_ENABLED
-			idx += PluggableUSB().getShortName(&name[idx]);
+			PluggableUSB().getShortName(name);
+			return sendStringDescriptor((uint8_t*)name, setup.wLength);
 #endif
-			if (idx > 0) {
-				return sendStringDescriptor((uint8_t*)name, setup.wLength);
-			}
 		}
 		else {
 			return false;
@@ -918,7 +918,7 @@ void USBDeviceClass::ISRHandler()
 				epHandlers[ep]->handleEndpoint();
 			} else {
 				#if defined(PLUGGABLE_USB_ENABLED)
-				PluggableUSB().handleEndpoint(ep);
+				SerialUSB.handleEndpoint(ep);
 				usbd.epAckPendingInterrupts(ep);
 				#endif
 			}
@@ -927,8 +927,8 @@ void USBDeviceClass::ISRHandler()
 }
 
 // PluggableUSB contructor
-PluggableUSB_::PluggableUSB_() : lastIf(CDC_ACM_INTERFACE + CDC_INTERFACE_COUNT),
-                                 lastEp(CDC_FIRST_ENDPOINT + CDC_ENPOINT_COUNT),
+PluggableUSB_::PluggableUSB_() : lastIf(0),
+                                 lastEp(1),
                                  rootNode(NULL), totalEP(USB_ENDPOINTS)
 {
 	// Empty
