From 4505fa19264945b3761b762a82fc09e7d056b30e Mon Sep 17 00:00:00 2001 From: Joshua Harlan Lifton Date: Sat, 26 Oct 2013 21:59:12 -0700 Subject: [PATCH] Add USB<->serial loopback example to WaveShare Open103R --- .../f1/waveshare-open103r/usbserial/Makefile | 26 ++ .../f1/waveshare-open103r/usbserial/README | 10 + .../f1/waveshare-open103r/usbserial/echo.py | 16 ++ .../waveshare-open103r/usbserial/usbserial.c | 267 ++++++++++++++++++ 4 files changed, 319 insertions(+) create mode 100644 examples/stm32/f1/waveshare-open103r/usbserial/Makefile create mode 100644 examples/stm32/f1/waveshare-open103r/usbserial/README create mode 100755 examples/stm32/f1/waveshare-open103r/usbserial/echo.py create mode 100644 examples/stm32/f1/waveshare-open103r/usbserial/usbserial.c diff --git a/examples/stm32/f1/waveshare-open103r/usbserial/Makefile b/examples/stm32/f1/waveshare-open103r/usbserial/Makefile new file mode 100644 index 0000000..dd54da9 --- /dev/null +++ b/examples/stm32/f1/waveshare-open103r/usbserial/Makefile @@ -0,0 +1,26 @@ +## +## This file is part of the libopencm3 project. +## +## Copyright (C) 2009 Uwe Hermann +## Copyright (C) 2013 Joshua Harlan Lifton +## +## 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 . +## + +BINARY = usbserial + +LDSCRIPT = ../waveshare-open103r.ld + +include ../../Makefile.include + diff --git a/examples/stm32/f1/waveshare-open103r/usbserial/README b/examples/stm32/f1/waveshare-open103r/usbserial/README new file mode 100644 index 0000000..2f0ef4f --- /dev/null +++ b/examples/stm32/f1/waveshare-open103r/usbserial/README @@ -0,0 +1,10 @@ +------------------------------------------------------------------------------ +README +------------------------------------------------------------------------------ + +This example uses the USB port as a serial port and implements a +loopback interface that immediately echos back whatever it receives. After flashing the evaluation board with the usbserial program and connecting it to a host computer with a USB cable, you can run the echo.py command as follows: + +$ sudo ./echo.py hello world +hello world +$ diff --git a/examples/stm32/f1/waveshare-open103r/usbserial/echo.py b/examples/stm32/f1/waveshare-open103r/usbserial/echo.py new file mode 100755 index 0000000..8d8f6f4 --- /dev/null +++ b/examples/stm32/f1/waveshare-open103r/usbserial/echo.py @@ -0,0 +1,16 @@ +#! /usr/bin/python + +import sys +import serial + +def echo(text): + s = serial.Serial() + s.port = "/dev/ttyACM0" + s.open() + print s.read(s.write(text)) + +if __name__ == "__main__": + if len(sys.argv) > 1: + echo(" ".join(sys.argv[1:])) + else: + print "Usage: sudo echo.py hello world" diff --git a/examples/stm32/f1/waveshare-open103r/usbserial/usbserial.c b/examples/stm32/f1/waveshare-open103r/usbserial/usbserial.c new file mode 100644 index 0000000..2062af6 --- /dev/null +++ b/examples/stm32/f1/waveshare-open103r/usbserial/usbserial.c @@ -0,0 +1,267 @@ +/* + * This file is part of the libopencm3 project. + * + * Copyright (C) 2010 Gareth McMullin + * Copyright (C) 2013 Joshua Harlan Lifton + * + * 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 . + */ + +#include +#include +#include +#include +#include + +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, +}; + +/* + * This notification endpoint isn't implemented. According to CDC spec its + * optional, but its absence causes a NULL pointer dereference in Linux + * cdc_acm driver. + */ +static const struct usb_endpoint_descriptor comm_endp[] = { + { + .bLength = USB_DT_ENDPOINT_SIZE, + .bDescriptorType = USB_DT_ENDPOINT, + .bEndpointAddress = 0x83, + .bmAttributes = USB_ENDPOINT_ATTR_INTERRUPT, + .wMaxPacketSize = 16, + .bInterval = 255, + } +}; + +static const struct usb_endpoint_descriptor data_endp[] = { + { + .bLength = USB_DT_ENDPOINT_SIZE, + .bDescriptorType = USB_DT_ENDPOINT, + .bEndpointAddress = 0x01, + .bmAttributes = USB_ENDPOINT_ATTR_BULK, + .wMaxPacketSize = 64, + .bInterval = 1, + }, + { + .bLength = USB_DT_ENDPOINT_SIZE, + .bDescriptorType = USB_DT_ENDPOINT, + .bEndpointAddress = 0x82, + .bmAttributes = USB_ENDPOINT_ATTR_BULK, + .wMaxPacketSize = 64, + .bInterval = 1, + } +}; + +static const struct { + struct usb_cdc_header_descriptor header; + struct usb_cdc_call_management_descriptor call_mgmt; + struct usb_cdc_acm_descriptor acm; + struct usb_cdc_union_descriptor cdc_union; +} __attribute__((packed)) cdcacm_functional_descriptors = { + .header = { + .bFunctionLength = sizeof(struct usb_cdc_header_descriptor), + .bDescriptorType = CS_INTERFACE, + .bDescriptorSubtype = USB_CDC_TYPE_HEADER, + .bcdCDC = 0x0110, + }, + .call_mgmt = { + .bFunctionLength = + sizeof(struct usb_cdc_call_management_descriptor), + .bDescriptorType = CS_INTERFACE, + .bDescriptorSubtype = USB_CDC_TYPE_CALL_MANAGEMENT, + .bmCapabilities = 0, + .bDataInterface = 1, + }, + .acm = { + .bFunctionLength = sizeof(struct usb_cdc_acm_descriptor), + .bDescriptorType = CS_INTERFACE, + .bDescriptorSubtype = USB_CDC_TYPE_ACM, + .bmCapabilities = 0, + }, + .cdc_union = { + .bFunctionLength = sizeof(struct usb_cdc_union_descriptor), + .bDescriptorType = CS_INTERFACE, + .bDescriptorSubtype = USB_CDC_TYPE_UNION, + .bControlInterface = 0, + .bSubordinateInterface0 = 1, + } +}; + +static const struct usb_interface_descriptor comm_iface[] = { + { + .bLength = USB_DT_INTERFACE_SIZE, + .bDescriptorType = USB_DT_INTERFACE, + .bInterfaceNumber = 0, + .bAlternateSetting = 0, + .bNumEndpoints = 1, + .bInterfaceClass = USB_CLASS_CDC, + .bInterfaceSubClass = USB_CDC_SUBCLASS_ACM, + .bInterfaceProtocol = USB_CDC_PROTOCOL_AT, + .iInterface = 0, + .endpoint = comm_endp, + .extra = &cdcacm_functional_descriptors, + .extralen = sizeof(cdcacm_functional_descriptors) + } +}; + +static const struct usb_interface_descriptor data_iface[] = { + { + .bLength = USB_DT_INTERFACE_SIZE, + .bDescriptorType = USB_DT_INTERFACE, + .bInterfaceNumber = 1, + .bAlternateSetting = 0, + .bNumEndpoints = 2, + .bInterfaceClass = USB_CLASS_DATA, + .bInterfaceSubClass = 0, + .bInterfaceProtocol = 0, + .iInterface = 0, + .endpoint = data_endp, + } +}; + +static const struct usb_interface ifaces[] = { + { + .num_altsetting = 1, + .altsetting = comm_iface, + }, + { + .num_altsetting = 1, + .altsetting = data_iface, + } +}; + +static const struct usb_config_descriptor config = { + .bLength = USB_DT_CONFIGURATION_SIZE, + .bDescriptorType = USB_DT_CONFIGURATION, + .wTotalLength = 0, + .bNumInterfaces = 2, + .bConfigurationValue = 1, + .iConfiguration = 0, + .bmAttributes = 0x80, + .bMaxPower = 0x32, + .interface = ifaces, +}; + +static const char *usb_strings[] = { + "Black Sphere Technologies", + "CDC-ACM Demo", + "DEMO", +}; + +/* 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)) +{ + (void)complete; + (void)buf; + (void)usbd_dev; + + switch(req->bRequest) { + case USB_CDC_REQ_SET_CONTROL_LINE_STATE: { + /* + * This Linux cdc_acm driver requires this to be implemented + * even though it's optional in the CDC spec, and we don't + * advertise it in the ACM functional descriptor. + */ + char local_buf[10]; + struct usb_cdc_notification *notif = (void *)local_buf; + + /* We echo signals back to host as notification. */ + notif->bmRequestType = 0xA1; + notif->bNotification = USB_CDC_NOTIFY_SERIAL_STATE; + notif->wValue = 0; + notif->wIndex = 0; + notif->wLength = 2; + local_buf[8] = req->wValue & 3; + local_buf[9] = 0; + // usbd_ep_write_packet(0x83, buf, 10); + return 1; + } + case USB_CDC_REQ_SET_LINE_CODING: + if(*len < sizeof(struct usb_cdc_line_coding)) { + return 0; + } + return 1; + } + return 0; +} + +static void cdcacm_data_rx_cb(usbd_device *usbd_dev, uint8_t ep) +{ + (void)ep; + char buf[64]; + int len = usbd_ep_read_packet(usbd_dev, 0x01, buf, 64); + + if (len) { + usbd_ep_write_packet(usbd_dev, 0x82, buf, len); + buf[len] = 0; + } +} + +static void cdcacm_set_config(usbd_device *usbd_dev, uint16_t wValue) +{ + (void)wValue; + + 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); +} + +int main(void) +{ + usbd_device *usbd_dev; + + rcc_clock_setup_in_hsi_out_48mhz(); + rcc_peripheral_enable_clock(&RCC_APB2ENR, RCC_APB2ENR_AFIOEN); + + AFIO_MAPR |= AFIO_MAPR_SWJ_CFG_JTAG_OFF_SW_ON; + + usbd_dev = usbd_init(&stm32f103_usb_driver, + &dev, + &config, + usb_strings, + 3, + usbd_control_buffer, + sizeof(usbd_control_buffer)); + usbd_register_set_config_callback(usbd_dev, cdcacm_set_config); + + while (1) { + usbd_poll(usbd_dev); + } + +}