Major refactoring

- Configuration is now implementation dependant instead of global
- Abstraction of common platform operations (time & memcpy)
- Added some Bugfixes to usb implementation
- Added timeout for TX buffer to avoid deadlocks / endless waiting

Author: CShark

.vscode/settings.json

@@ -6,6 +6,9 @@
         "usb.h": "c",
         "stdint.h": "c",
         "hid_config.h": "c",
-        "platform.h": "c"
+        "platform.h": "c",
+        "ncm_netif.h": "c",
+        "usb_config.h": "c",
+        "ncm_config.h": "c"
     }
 }

Inc/cdc/cdc_config.h

@@ -0,0 +1,9 @@
+#ifndef __CDC_CONFIG_H__
+#define __CDC_CONFIG_H__
+
+#include "usb.h"
+#include "platform.h"
+
+USB_Implementation CDC_GetImplementation();
+
+#endif

Inc/hid/hid_config.h

@@ -1,3 +1,8 @@
-#include "usb_config.h"
+#ifndef __HID_CONFIG_H__
+#define __HID_CONFIG_H__
 
-USB_Implementation HID_GetImplementation();
+#include "usb.h"
+
+USB_Implementation HID_GetImplementation();
+
+#endif

Inc/ncm/ncm_config.h

@@ -0,0 +1,11 @@
+#ifndef __NCM_CONFIG_H__
+#define __NCM_CONFIG_H__
+
+#include "usb.h"
+#include "platform.h"
+
+void NCM_Init();
+void NCM_Loop();
+USB_Implementation NCM_GetImplementation();
+
+#endif

Inc/ncm_device.h renamed to Inc/ncm/ncm_device.h

@@ -3,5 +3,12 @@
 
 #define STM32G441xx
 #include "stm32g4xx.h"
+#include <stddef.h>
 
-#endif
+unsigned int sys_jiffies();
+unsigned int sys_now();
+void delay_ms(unsigned int ms);
+
+void Systick_Init();
+
+#endif

eth/Inc/ncm_netif.h renamed to Inc/ncm/ncm_netif.h

@@ -1,6 +1,8 @@
 #ifndef __USB_H
 #define __USB_H
 
+#include "usb_config.h"
+
 typedef struct {
     unsigned char RequestType;
     unsigned char Request;
@@ -20,16 +22,38 @@ typedef struct {
     unsigned char RxBufferSize;
     unsigned char TxBufferSize;
     unsigned short Type;
-    void (*RxCallback)(char ep, short length);
-    void (*TxCallback)(char ep, short length);
+    void (*RxCallback)(unsigned char ep, short length);
+    void (*TxCallback)(unsigned char ep, short length);
 } USB_CONFIG_EP;
 
+typedef struct {
+    const USB_DESCRIPTOR_DEVICE *DeviceDescriptor;
+    const unsigned char *ConfigDescriptor;
+    unsigned short ConfigDescriptorLength;
+
+    const USB_CONFIG_EP* Endpoints;
+    unsigned short NumEndpoints;
+    unsigned short NumInterfaces;
+
+    char *(*GetString)(char, short, short *);
+    char *(*GetOSDescriptor)(short *);
+
+    char (*SetupPacket_Handler)(USB_SETUP_PACKET *, const unsigned char *, short);
+    void (*ResetInterface_Handler)(char, char);
+
+    void (*Suspend_Handler)();
+    void (*Wakeup_Handler)();
+} USB_Implementation;
+
 #define USB_OK 0
 #define USB_BUSY 1
 #define USB_ERR 2
 
+// Disable this define to disable the timeout feature
+#define USB_TXTIMEOUT 50
+
 /// @brief Initialize all USB related stuff
-void USB_Init();
+void USB_Init(USB_Implementation impl);
 /// @brief Low Priority handler for most interrupts
 void USB_LP_IRQHandler();
 /// @brief High Priority handler for Burst and Isochronous transfers
@@ -40,17 +64,29 @@ void USB_HP_IRQHandler();
 /// @param buffer A pointer to the buffer containing the data
 /// @param length The number of bytes to sent
 /// @remark Will automatically split the transmission into multiple chunks if necessary
-void USB_Transmit(char ep, char* buffer, short length);
+void USB_Transmit(unsigned char ep, const unsigned char* buffer, short length);
 /// @brief Whether there is currently any unfinished transfer running
 /// @param ep The endpoint to check
 /// @remark Do not busy-wait on this during reception. It will stall the USB-ISR
-char USB_IsTransmitPending(char ep);
+char USB_IsTransmitPending(unsigned char ep);
 /// @brief Get data out of the reception buffers
 /// @param ep The endpoint id to fetch data from
 /// @param buffer The target buffer to write to
 /// @param length The length of the buffer. Will contain the number of bytes read
-void USB_Fetch(char ep, char* buffer, short *length);
+void USB_Fetch(unsigned char ep, unsigned char* buffer, short *length);
 /// @brief Configure an endpoint
 void USB_SetEPConfig(USB_CONFIG_EP config);
 
+/// @brief Set USB implementation details
+/// @param impl The function calls & settings to use
+void USB_SetImplementation(USB_Implementation impl);
+
+/// @brief Compose the complete USB descriptor
+/// @param buffer the target to build the descriptor into
+/// @param size the size of the target buffer for sanity checks
+/// @param num The number of parts
+/// @param parts A list of parts
+/// @returns Length of the final descriptor in the buffer
+unsigned short USB_BuildDescriptor(unsigned char *buffer, unsigned short size, unsigned char num, const void **parts);
+
 #endif

Inc/platform.h

@@ -1,7 +1,6 @@
 #ifndef __USB_CONFIG_H
 #define __USB_CONFIG_H
 
-#include "usb.h"
 #include "platform.h"
 
 #ifndef __weak
@@ -101,6 +100,27 @@ typedef struct {
     unsigned char SubInterface0;
 } USB_DESC_FUNC_UNION1;
 
+// ECM120 Table 3
+typedef struct {
+    unsigned char Length;
+    unsigned char Type;
+    unsigned char SubType;
+    unsigned char strMacAddress;
+    unsigned int EthernetStatistics;
+    unsigned short MaxSegmentSize;
+    unsigned short NumberMcFilters;
+    unsigned char NumberPowerFilters;
+} USB_DESC_FUNC_ECM;
+
+// NCM10 Table 5-2
+typedef struct {
+    unsigned char Length;
+    unsigned char Type;
+    unsigned char SubType;
+    unsigned short NcmVersion;
+    unsigned char NetworkCapabilities;
+} USB_DESC_FUNC_NCM;
+
 // PSTN120 Table 3
 typedef struct {
     unsigned char Length;
@@ -131,48 +151,8 @@ typedef struct {
 
 #pragma pack()
 
-typedef struct {
-    USB_DESCRIPTOR_DEVICE *(*GetDeviceDescriptor)();
-    char *(*GetConfigDescriptor)(short *);
-    char *(*GetString)(char, short, short *);
-    char *(*GetOSDescriptor)(short *);
-    void (*ConfigureEndpoints)();
-} USB_Implementation;
-
-/// @brief Set config implementation for example flexibility
-/// @param impl The function calls to use
-void USB_SetImplementation(USB_Implementation impl);
-
-/// @brief Get the device descriptor
-USB_DESCRIPTOR_DEVICE *USB_GetDeviceDescriptor();
-/// @brief Get the complete descriptor
-/// @param length A pointer which will contain the length of the descriptor
-char *USB_GetConfigDescriptor(short *length);
-/// @brief Get a string from the string table (str... entries)
-/// @param index The index of the string
-/// @param lcid The language code of the string
-/// @param length Will contain the length of the string
-char *USB_GetString(char index, short lcid, short *length);
-/// @brief Get the OS Descriptor (String descriptor at 0xEE)
-/// @param length Will contain the length of the descriptor
-char *USB_GetOSDescriptor(short *length);
-/// @brief Configure all endpoints used by the configuration
-void USB_ConfigureEndpoints();
-
-/// @brief Handle a setup packet that is targeted at an interface or class
-/// @param setup The setup packet
-/// @param data A pointer to data that was sent with the setup
-/// @param length The length of the data
-char USB_HandleClassSetup(USB_SETUP_PACKET *setup, char *data, short length);
-
-/// @brief Called when the host triggers a SetInterface to choose an alternate id
-/// @param interface The interface id that was triggered
-/// @param alternateId The new alternate id that was activated
-void USB_ResetClass(char interface, char alternateId);
-
-/// @brief Suspend the device and go into low power mode
-void USB_SuspendDevice();
-/// @brief Reactivate the device
-void USB_WakeupDevice();
+#define USB_SelfPowered 0
+#define USB_NumEndpoints 8
+#define USB_MaxControlData 64
 
 #endif