USB Rewrite

Author: kuldeepdhaka

examples/Makefile.rules

@@ -163,16 +163,16 @@ $(LDSCRIPT):
 	$(Q)$(LD) $(LDFLAGS) $(ARCH_FLAGS) $(OBJS) $(LDLIBS) -o $(*).elf
 
 %.o: %.c
-	@#printf "  CC      $(*).c\n"
-	$(Q)$(CC) $(CFLAGS) $(CPPFLAGS) $(ARCH_FLAGS) -o $(*).o -c $(*).c
+	@#printf "  CC      $<\n"
+	$(Q)$(CC) $(CFLAGS) $(CPPFLAGS) $(ARCH_FLAGS) -o $@ -c $<
 
 %.o: %.cxx
-	@#printf "  CXX     $(*).cxx\n"
-	$(Q)$(CXX) $(CXXFLAGS) $(CPPFLAGS) $(ARCH_FLAGS) -o $(*).o -c $(*).cxx
+	@#printf "  CXX     $<\n"
+	$(Q)$(CXX) $(CXXFLAGS) $(CPPFLAGS) $(ARCH_FLAGS) -o $@ -c $<
 
 %.o: %.cpp
-	@#printf "  CXX     $(*).cpp\n"
-	$(Q)$(CXX) $(CXXFLAGS) $(CPPFLAGS) $(ARCH_FLAGS) -o $(*).o -c $(*).cpp
+	@#printf "  CXX     $<\n"
+	$(Q)$(CXX) $(CXXFLAGS) $(CPPFLAGS) $(ARCH_FLAGS) -o $@ -c $<
 
 clean:
 	@#printf "  CLEAN\n"

examples/common/usb_cdcacm/README.md

@@ -0,0 +1,5 @@
+# README
+
+This example implements a USB CDC-ACM device (aka Virtual Serial Port)
+to demonstrate the use of the USB device stack.
+

examples/common/usb_cdcacm/cdcacm-target.h

@@ -0,0 +1,36 @@
+/*
+ * This file is part of the unicore-mx project.
+ *
+ * Copyright (C) 2015 Kuldeep Singh Dhaka <[email protected]>
+ *
+ * This library is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this library.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef CDCACM_TARGET_H
+#define CDCACM_TARGET_H
+
+#include <unicore-mx/usbd/usbd.h>
+
+/* these functions are provided by target */
+
+extern void cdcacm_target_init(void);
+extern const usbd_backend *cdcacm_target_usb_driver(void);
+
+/* see main() in cdcacm.c for more on this */
+extern void cdcacm_target_usbd_after_init_and_before_first_poll(void);
+
+/* see cdcacm_data_rx_cb() in cdcacm.c for more on this */
+extern void cdcacm_target_data_rx_cb_before_return(void);
+
+#endif

examples/stm32/f3/stm32f3-discovery/usb_cdcacm/cdcacm.c renamed to examples/common/usb_cdcacm/cdcacm.c

@@ -2,6 +2,7 @@
  * This file is part of the unicore-mx project.
  *
  * Copyright (C) 2010 Gareth McMullin <[email protected]>
+ * Copyright (C) 2015 Kuldeep Singh Dhaka <[email protected]>
  *
  * This library is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -17,28 +18,11 @@
  * along with this library.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include <stdlib.h>
-#include <unicore-mx/stm32/rcc.h>
-#include <unicore-mx/stm32/gpio.h>
+#include <string.h>
 #include <unicore-mx/usbd/usbd.h>
-#include <unicore-mx/usb/cdc.h>
-
-static const struct usb_device_descriptor dev = {
-	.bLength = USB_DT_DEVICE_SIZE,
-	.bDescriptorType = USB_DT_DEVICE,
-	.bcdUSB = 0x0200,
-	.bDeviceClass = USB_CLASS_CDC,
-	.bDeviceSubClass = 0,
-	.bDeviceProtocol = 0,
-	.bMaxPacketSize0 = 64,
-	.idVendor = 0x0483,
-	.idProduct = 0x5740,
-	.bcdDevice = 0x0200,
-	.iManufacturer = 1,
-	.iProduct = 2,
-	.iSerialNumber = 3,
-	.bNumConfigurations = 1,
-};
+#include <unicore-mx/usb/class/cdc.h>
+#include <unicore-mx/usbd/misc/string.h>
+#include "cdcacm-target.h"
 
 /*
  * This notification endpoint isn't implemented. According to CDC spec its
@@ -119,7 +103,7 @@ static const struct usb_interface_descriptor comm_iface[] = {{
 	.endpoint = comm_endp,
 
 	.extra = &cdcacm_functional_descriptors,
-	.extralen = sizeof(cdcacm_functional_descriptors),
+	.extra_len = sizeof(cdcacm_functional_descriptors),
 }};
 
 static const struct usb_interface_descriptor data_iface[] = {{
@@ -144,7 +128,7 @@ static const struct usb_interface ifaces[] = {{
 	.altsetting = data_iface,
 }};
 
-static const struct usb_config_descriptor config = {
+static const struct usb_config_descriptor config[] = {{
 	.bLength = USB_DT_CONFIGURATION_SIZE,
 	.bDescriptorType = USB_DT_CONFIGURATION,
 	.wTotalLength = 0,
@@ -155,25 +139,103 @@ static const struct usb_config_descriptor config = {
 	.bMaxPower = 0x32,
 
 	.interface = ifaces,
+}};
+
+const uint8_t *usb_string_english[] = {
+	(uint8_t *) "Black Sphere Technologies",
+	(uint8_t *) "CDC-ACM Demo",
+	(uint8_t *) "DEMO",
 };
 
-static const char *usb_strings[] = {
-	"Black Sphere Technologies",
-	"CDC-ACM Demo",
-	"DEMO",
+/*
+ * Black = काला
+ * Sphere = गोला
+ * Technologies = प्रौद्योगिकी
+ * CDC-ACM = सीडीसी-एसीएम
+ * Demo, DEMO = नमूना
+ */
+const uint8_t *usb_string_hindi[] = {
+	(uint8_t *) "काला गोला प्रौद्योगिकी",
+	(uint8_t *) "सीडीसी-एसीएम नमूना",
+	(uint8_t *) "नमूना"
+};
+
+const uint16_t supported_lang[] = {
+	USB_LANGID_ENGLISH_UNITED_STATES,
+	USB_LANGID_HINDI
+};
+
+static int usb_strings(usbd_device *usbd_dev, struct usbd_get_string_arg *arg)
+{
+	(void) usbd_dev;
+
+	const uint8_t **strings;
+
+	/* supported languages */
+	if (!arg->index) {
+		uint16_t len = arg->len;
+		if (len > 2) {
+			len = 2;
+		}
+		memcpy(arg->buf, supported_lang, len);
+		return len;
+	}
+
+	/* we only have 3 strings */
+	if (arg->index > 3) {
+		return -1;
+	}
+
+	/* language */
+	switch(arg->lang_id) {
+	case USB_LANGID_ENGLISH_UNITED_STATES:
+		strings = usb_string_english;
+		break;
+	case USB_LANGID_HINDI:
+		strings = usb_string_hindi;
+		break;
+	default:
+		return -1;
+	}
+
+	return usbd_utf8_to_utf16(strings[arg->index - 1], arg->buf, arg->len);
+}
+
+static const struct usb_device_descriptor dev = {
+	.bLength = USB_DT_DEVICE_SIZE,
+	.bDescriptorType = USB_DT_DEVICE,
+	.bcdUSB = 0x0200,
+	.bDeviceClass = USB_CLASS_CDC,
+	.bDeviceSubClass = 0,
+	.bDeviceProtocol = 0,
+	.bMaxPacketSize0 = 64,
+	.idVendor = 0x0483,
+	.idProduct = 0x5740,
+	.bcdDevice = 0x0200,
+	.iManufacturer = 1,
+	.iProduct = 2,
+	.iSerialNumber = 3,
+	.bNumConfigurations = 1,
+
+	.config = config,
 };
 
 /* Buffer to be used for control requests. */
 uint8_t usbd_control_buffer[128];
 
-static int cdcacm_control_request(usbd_device *usbd_dev, struct usb_setup_data *req, uint8_t **buf,
-		uint16_t *len, void (**complete)(usbd_device *usbd_dev, struct usb_setup_data *req))
+static enum usbd_control_result
+cdcacm_control_request(usbd_device *usbd_dev, struct usbd_control_arg *arg)
 {
-	(void)complete;
-	(void)buf;
 	(void)usbd_dev;
 
-	switch (req->bRequest) {
+	const uint8_t bmReqMask = USB_REQ_TYPE_TYPE | USB_REQ_TYPE_RECIPIENT;
+	const uint8_t bmReqVal = USB_REQ_TYPE_CLASS | USB_REQ_TYPE_INTERFACE;
+
+	if ((arg->setup.bmRequestType & bmReqMask) != bmReqVal) {
+		return USBD_REQ_NEXT;
+	}
+
+	switch (arg->setup.bRequest) {
 	case USB_CDC_REQ_SET_CONTROL_LINE_STATE: {
 		/*
 		 * This Linux cdc_acm driver requires this to be implemented
@@ -189,19 +251,23 @@ static int cdcacm_control_request(usbd_device *usbd_dev, struct usb_setup_data *
 		notif->wValue = 0;
 		notif->wIndex = 0;
 		notif->wLength = 2;
-		local_buf[8] = req->wValue & 3;
+		local_buf[8] = arg->setup.wValue & 3;
 		local_buf[9] = 0;
 		// usbd_ep_write_packet(0x83, buf, 10);
-		return 1;
+		return USBD_REQ_HANDLED;
 		}
 	case USB_CDC_REQ_SET_LINE_CODING:
-		if (*len < sizeof(struct usb_cdc_line_coding))
-			return 0;
-		return 1;
+		if (arg->len < sizeof(struct usb_cdc_line_coding)) {
+			return USBD_REQ_STALL;
+		}
+		return USBD_REQ_HANDLED;
 	}
-	return 0;
+	return USBD_REQ_STALL;
 }
 
+void __attribute__((weak))
+cdcacm_target_data_rx_cb_before_return(void) { /* empty */ }
+
 static void cdcacm_data_rx_cb(usbd_device *usbd_dev, uint8_t ep)
 {
 	(void)ep;
@@ -214,53 +280,43 @@ static void cdcacm_data_rx_cb(usbd_device *usbd_dev, uint8_t ep)
 		usbd_ep_write_packet(usbd_dev, 0x82, buf, len);
 		buf[len] = 0;
 	}
+
+	/* this was only found in f1/lisa-m-1/usb_cdcacm.c */
+	cdcacm_target_data_rx_cb_before_return();
 }
 
-static void cdcacm_set_config(usbd_device *usbd_dev, uint16_t wValue)
+static void cdcacm_set_config(usbd_device *usbd_dev,
+				const struct usb_config_descriptor *cfg)
 {
-	(void)wValue;
-	(void)usbd_dev;
+	(void)cfg;
 
 	usbd_ep_setup(usbd_dev, 0x01, USB_ENDPOINT_ATTR_BULK, 64, cdcacm_data_rx_cb);
 	usbd_ep_setup(usbd_dev, 0x82, USB_ENDPOINT_ATTR_BULK, 64, NULL);
 	usbd_ep_setup(usbd_dev, 0x83, USB_ENDPOINT_ATTR_INTERRUPT, 16, NULL);
-
-	usbd_register_control_callback(
-				usbd_dev,
-				USB_REQ_TYPE_CLASS | USB_REQ_TYPE_INTERFACE,
-				USB_REQ_TYPE_TYPE | USB_REQ_TYPE_RECIPIENT,
-				cdcacm_control_request);
 }
 
-
-static void usb_setup(void)
-{
-	/* Enable clocks for GPIO port A (for GPIO_USART2_TX) and USART2. */
-	rcc_usb_prescale_1();
-	rcc_periph_clock_enable(RCC_USB);
-	rcc_periph_clock_enable(RCC_GPIOA);
-
-	/* Setup GPIO pin GPIO_USART2_TX/GPIO9 on GPIO port A for transmit. */
-	gpio_mode_setup(GPIOA, GPIO_MODE_AF, GPIO_PUPD_NONE, GPIO11 | GPIO12);
-	gpio_set_af(GPIOA, GPIO_AF14, GPIO11| GPIO12);
-}
+void __attribute__((weak))
+cdcacm_target_usbd_after_init_and_before_first_poll(void) { /* empty */ }
 
 int main(void)
 {
-	int i;
-
 	usbd_device *usbd_dev;
 
-	rcc_clock_setup_hsi(&rcc_hsi_8mhz[RCC_CLOCK_48MHZ]);
-	usb_setup();
+	cdcacm_target_init();
+
+	usbd_dev = usbd_init(cdcacm_target_usb_driver(), &dev,
+		usbd_control_buffer, sizeof(usbd_control_buffer));
 
-	usbd_dev = usbd_init(&st_usbfs_v1_usb_driver, &dev, &config, usb_strings,
-			3, usbd_control_buffer, sizeof(usbd_control_buffer));
 	usbd_register_set_config_callback(usbd_dev, cdcacm_set_config);
+	usbd_register_control_callback(usbd_dev, cdcacm_control_request);
+	usbd_register_get_string_callback(usbd_dev, usb_strings);
 
-	for (i = 0; i < 0x800000; i++)
-		__asm__("nop");
+	/* on f3, here was a busy loop after usbd init and before first poll.
+	 *  as the use of the busy loop is unknow,
+	 *  retaining the code for compatibility */
+	cdcacm_target_usbd_after_init_and_before_first_poll();
 
-	while (1)
+	while (1) {
 		usbd_poll(usbd_dev);
+	}
 }

examples/stm32/f1/lisa-m-1/usb_cdcacm/cdcacm_test.py renamed to examples/common/usb_cdcacm/cdcacm_test.py

@@ -0,0 +1,5 @@
+# README
+
+This example implements a USB Device Firmware Upgrade (DFU) bootloader
+to demonstrate the use of the USB device stack.
+

examples/stm32/f1/waveshare-open103r/usbserial/echo.py renamed to examples/common/usb_cdcacm/echo.py

@@ -0,0 +1,39 @@
+/*
+ * This file is part of the unicore-mx project.
+ *
+ * Copyright (C) 2015 Kuldeep Singh Dhaka <[email protected]>
+ *
+ * This library is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this library.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef USBDFU_TARGET_H
+#define USBDFU_TARGET_H
+
+#include <unicore-mx/usbd/usbd.h>
+
+/* these functions are provided by target */
+
+extern void usbdfu_target_init(void);
+extern const usbd_backend *usbdfu_target_usb_driver(void);
+
+/* see main() in usbdfu.c for more on this */
+extern void usbdfu_target_usbd_after_init_and_before_first_poll(void);
+
+/* flash operations */
+void usbdfu_target_flash_lock(void);
+void usbdfu_target_flash_unlock(void);
+void usbdfu_target_flash_erase_page(uint32_t page);
+void usbdfu_target_flash_write(uint32_t baseaddr, uint8_t *buf, uint16_t len);
+
+#endif