Move generic USB stuff to a subdir, dedupe .h files.

Adapt examples and the lib code accordingly.
2010-12-29 17:02:36 +01:00
parent f062777930
commit 34fd228bf9
24 changed files with 38 additions and 429 deletions
--- a/include/usb/cdc.h
+++ b/include/usb/cdc.h
@@ -0,0 +1,128 @@
+/*
+ * This file is part of the libopenstm32 project.
+ *
+ * Copyright (C) 2010 Gareth McMullin <gareth@blacksphere.co.nz>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __CDC_H
+#define __CDC_H
+
+/* Definitions of Communications Device Class from
+ * "Universal Serial Bus Class Definitions for Communications Devices 
+ * Revision 1.2"
+ */
+
+/* Table 2: Communications Device Class Code */
+#define USB_CLASS_CDC		0x02
+
+/* Table 4: Class Subclass Code */
+#define USB_CDC_SUBCLASS_DLCM	0x01
+#define USB_CDC_SUBCLASS_ACM	0x02
+/* ... */
+
+/* Table 5 Communications Interface Class Control Protocol Codes */
+#define USB_CDC_PROTOCOL_NONE	0x00
+#define USB_CDC_PROTOCOL_AT	0x01
+/* ... */
+
+/* Table 6: Data Interface Class Code */
+#define USB_CLASS_DATA		0x0A
+
+/* Table 12: Type Values for the bDescriptorType Field */
+#define CS_INTERFACE		0x24
+#define CS_ENDPOINT		0x25
+
+/* Table 13: bDescriptor SubType in Communications Class Functional 
+ * Descriptors */
+#define USB_CDC_TYPE_HEADER	0x00
+#define USB_CDC_TYPE_CALL_MANAGEMENT	0x01
+#define USB_CDC_TYPE_ACM	0x02
+/* ... */
+#define USB_CDC_TYPE_UNION	0x06
+/* ... */
+
+/* Table 15: Class-Specific Descriptor Header Format */
+struct usb_cdc_header_descriptor {
+	uint8_t bFunctionLength;
+	uint8_t bDescriptorType;
+	uint8_t bDescriptorSubtype;
+	uint16_t bcdCDC;
+} __attribute__((packed));
+
+/* Table 16: Union Interface Functional Descriptor */
+struct usb_cdc_union_descriptor {
+	uint8_t bFunctionLength;
+	uint8_t bDescriptorType;
+	uint8_t bDescriptorSubtype;
+	uint8_t bControlInterface;
+	uint8_t bSubordinateInterface0;
+	/* ... */
+} __attribute__((packed));
+
+
+/* Definitions for Abstract Control Model devices from:
+ * "Universal Serial Bus Communications Class Subclass Specification for
+ * PSTN Devices"
+ */
+
+/* Table 3: Call Management Functional Descriptor */
+struct usb_cdc_call_management_descriptor {
+	uint8_t bFunctionLength;
+	uint8_t bDescriptorType;
+	uint8_t bDescriptorSubtype;
+	uint8_t bmCapabilities;
+	uint8_t bDataInterface;
+} __attribute__((packed));
+
+/* Table 4: Abstract Control Management Functional Descriptor */
+struct usb_cdc_acm_descriptor {
+	uint8_t bFunctionLength;
+	uint8_t bDescriptorType;
+	uint8_t bDescriptorSubtype;
+	uint8_t bmCapabilities;
+} __attribute__((packed));
+
+/* Table 13: Class-Specific Request Codes for PSTN subclasses */
+/* ... */
+#define USB_CDC_REQ_SET_LINE_CODING		0x20
+/* ... */
+#define USB_CDC_REQ_SET_CONTROL_LINE_STATE	0x22
+/* ... */
+
+/* Table 17: Line Coding Structure */
+struct usb_cdc_line_coding {
+	uint32_t dwDTERate;
+	uint8_t bCharFormat;
+	uint8_t bParityType;
+	uint8_t bDataBits;
+} __attribute__((packed));
+
+/* Table 30: Class-Specific Notification Codes for PSTN subclasses */
+/* ... */
+#define USB_CDC_NOTIFY_SERIAL_STATE	0x28
+/* ... */
+
+
+/* Notification Structure */
+struct usb_cdc_notification {
+	uint8_t bmRequestType;
+	uint8_t bNotification;
+	uint16_t wValue;
+	uint16_t wIndex;
+	uint16_t wLength;
+} __attribute__((packed));
+
+#endif
--- a/include/usb/dfu.h
+++ b/include/usb/dfu.h
@@ -0,0 +1,81 @@
+/*
+ * This file is part of the libopenstm32 project.
+ *
+ * Copyright (C) 2010 Gareth McMullin <gareth@blacksphere.co.nz>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __DFU_H
+#define __DFU_H
+
+enum dfu_req {
+	DFU_DETACH,
+	DFU_DNLOAD,
+	DFU_UPLOAD,
+	DFU_GETSTATUS,
+	DFU_CLRSTATUS,
+	DFU_GETSTATE,
+	DFU_ABORT
+};
+
+enum dfu_status {
+	DFU_STATUS_OK,
+	DFU_STATUS_ERR_TARGET,
+	DFU_STATUS_ERR_FILE,
+	DFU_STATUS_ERR_WRITE,
+	DFU_STATUS_ERR_ERASE,
+	DFU_STATUS_ERR_CHECK_ERASED,
+	DFU_STATUS_ERR_PROG,
+	DFU_STATUS_ERR_VERIFY,
+	DFU_STATUS_ERR_ADDRESS,
+	DFU_STATUS_ERR_NOTDONE,
+	DFU_STATUS_ERR_FIRMWARE,
+	DFU_STATUS_ERR_VENDOR,
+	DFU_STATUS_ERR_USBR,
+	DFU_STATUS_ERR_POR,
+	DFU_STATUS_ERR_UNKNOWN,
+	DFU_STATUS_ERR_STALLEDPKT,
+};
+
+enum dfu_state {
+	STATE_APP_IDLE,
+	STATE_APP_DETACH,
+	STATE_DFU_IDLE,
+	STATE_DFU_DNLOAD_SYNC,
+	STATE_DFU_DNBUSY,
+	STATE_DFU_DNLOAD_IDLE,
+	STATE_DFU_MANIFEST_SYNC,
+	STATE_DFU_MANIFEST,
+	STATE_DFU_MANIFEST_WAIT_RESET,
+	STATE_DFU_UPLOAD_IDLE,
+	STATE_DFU_ERROR,
+};
+
+#define DFU_FUNCTIONAL			0x21
+struct usb_dfu_descriptor {
+	uint8_t bLength;
+	uint8_t bDescriptorType;
+	uint8_t bmAttributes;
+#define USB_DFU_CAN_DOWNLOAD		0x01
+#define USB_DFU_CAN_UPLOAD		0x02
+#define USB_DFU_MANIFEST_TOLERANT	0x04
+#define USB_DFU_WILL_DETACH		0x08
+
+	uint16_t wDetachTimeout;
+	uint16_t wTransferSize;
+	uint16_t bcdDFUVersion;	
+} __attribute__((packed));
+
+#endif
--- a/include/usb/hid.h
+++ b/include/usb/hid.h
@@ -0,0 +1,38 @@
+/*
+ * This file is part of the libopenstm32 project.
+ *
+ * Copyright (C) 2010 Gareth McMullin <gareth@blacksphere.co.nz>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __HID_H
+#define __HID_H
+
+#include <stdint.h>
+
+#define USB_CLASS_HID	3
+
+#define USB_DT_HID	0x21
+#define USB_DT_REPORT	0x22
+
+struct usb_hid_descriptor {
+	uint8_t bLength;
+	uint8_t bDescriptorType;
+	uint16_t bcdHID;
+	uint8_t bCountryCode;
+	uint8_t bNumDescriptors;
+} __attribute__((packed));
+
+#endif
--- a/include/usb/usbd.h
+++ b/include/usb/usbd.h
@@ -0,0 +1,71 @@
+/*
+ * This file is part of the libopenstm32 project.
+ *
+ * Copyright (C) 2010 Gareth McMullin <gareth@blacksphere.co.nz>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __USBD_H
+#define __USBD_H
+
+#include <usb/usbstd.h>
+
+/* Static buffer for control transactions:
+ * This is defined as weak in the library, applicaiton
+ * may provide if a larger buffer is requred. */
+extern uint8_t usbd_control_buffer[];
+
+/* <usb.c> */
+extern int usbd_init(const struct usb_device_descriptor *dev,
+                     const struct usb_config_descriptor *conf,
+		     const char **strings);
+extern void usbd_set_control_buffer_size(uint16_t size);
+
+extern void usbd_register_reset_callback(void (*callback)(void));
+extern void usbd_register_suspend_callback(void (*callback)(void));
+extern void usbd_register_resume_callback(void (*callback)(void));
+
+typedef int (*usbd_control_callback)(struct usb_setup_data *req, 
+		uint8_t **buf, uint16_t *len, 
+		void (**complete)(struct usb_setup_data *req));
+
+/* <usb_control.c> */
+extern int usbd_register_control_callback(uint8_t type, uint8_t type_mask,
+			usbd_control_callback callback);
+
+/* <usb_standard.c> */
+extern void 
+usbd_register_set_config_callback(void (*callback)(uint16_t wValue));
+
+
+/* Functions to be provided by the hardware abstraction layer */
+extern void usbd_poll(void);
+
+extern void usbd_ep_setup(uint8_t addr, uint8_t type, uint16_t max_size, 
+	      void (*callback)(uint8_t ep));
+
+extern uint16_t
+usbd_ep_write_packet(uint8_t addr, const void *buf, uint16_t len);
+
+extern uint16_t 
+usbd_ep_read_packet(uint8_t addr, void *buf, uint16_t len);
+
+extern void usbd_ep_stall_set(uint8_t addr, uint8_t stall);
+extern uint8_t usbd_ep_stall_get(uint8_t addr);
+
+/* Optional */
+extern void usbd_cable_connect(uint8_t on);
+
+#endif
--- a/include/usb/usbstd.h
+++ b/include/usb/usbstd.h
@@ -0,0 +1,202 @@
+/*
+ * This file is part of the libopenstm32 project.
+ *
+ * Copyright (C) 2010 Gareth McMullin <gareth@blacksphere.co.nz>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __USBSTD_H
+#define __USBSTD_H
+
+/* 
+ * This file contains structure definitions for the USB control structures
+ * defined in chapter 9 of the "Univeral Serial Bus Specification Revision 2.0"
+ * Available from the USB Implementers Forum - http://www.usb.org/
+ */
+
+#include <stdint.h>
+
+/* USB Setup Data structure - Table 9-2 */
+struct usb_setup_data {
+	uint8_t bmRequestType;
+	uint8_t bRequest;
+	uint16_t wValue;
+	uint16_t wIndex;
+	uint16_t wLength;
+} __attribute__((packed));
+
+/* bmRequestType bit definitions */
+#define USB_REQ_TYPE_IN		0x80
+#define USB_REQ_TYPE_STANDARD	0x00
+#define USB_REQ_TYPE_CLASS	0x20
+#define USB_REQ_TYPE_VENDOR	0x40
+#define USB_REQ_TYPE_DEVICE	0x00
+#define USB_REQ_TYPE_INTERFACE	0x01
+#define USB_REQ_TYPE_ENDPOINT	0x02
+
+#define USB_REQ_TYPE_DIRECTION	0x80
+#define USB_REQ_TYPE_TYPE	0x60
+#define USB_REQ_TYPE_RECIPIENT	0x1F
+
+/* USB Standard Request Codes - Table 9-4 */
+#define USB_REQ_GET_STATUS		0
+#define USB_REQ_CLEAR_FEATURE		1
+/* Reserved for future use: 2 */
+#define USB_REQ_SET_FEATURE		3
+/* Reserved for future use: 3 */
+#define USB_REQ_SET_ADDRESS		5
+#define USB_REQ_GET_DESCRIPTOR		6
+#define USB_REQ_SET_DESCRIPTOR		7
+#define USB_REQ_GET_CONFIGURATION	8
+#define USB_REQ_SET_CONFIGURATION	9
+#define USB_REQ_GET_INTERFACE		10
+#define USB_REQ_SET_INTERFACE		11
+#define USB_REQ_SET_SYNCH_FRAME		12
+
+/* USB Descriptor Types - Table 9-5 */
+#define USB_DT_DEVICE			1
+#define USB_DT_CONFIGURATION		2
+#define USB_DT_STRING			3
+#define USB_DT_INTERFACE		4
+#define USB_DT_ENDPOINT			5
+#define USB_DT_DEVICE_QUALIFIER		6
+#define USB_DT_OTHER_SPEED_CONFIGURATION	7
+#define USB_DT_INTERFACE_POWER		8
+
+/* USB Standard Feature Selectors - Table 9-6 */
+#define USB_FEAT_ENDPOINT_HALT		0
+#define USB_FEAT_DEVICE_REMOTE_WAKEUP	1
+#define USB_FEAT_TEST_MODE		2
+
+/* Information Returned by a GetStatus() Request to a Device - Figure 9-4 */
+#define USB_DEV_STATUS_SELF_POWERED	0x01
+#define USB_DEV_STATUS_REMOTE_WAKEUP	0x02
+
+/* USB Standard Device Descriptor - Table 9-8 */
+struct usb_device_descriptor {
+	uint8_t bLength;
+	uint8_t bDescriptorType;
+	uint16_t bcdUSB;
+	uint8_t bDeviceClass;
+	uint8_t bDeviceSubClass;
+	uint8_t bDeviceProtocol;
+	uint8_t bMaxPacketSize0;
+	uint16_t idVendor;
+	uint16_t idProduct;
+	uint16_t bcdDevice;
+	uint8_t iManufacturer;
+	uint8_t iProduct;
+	uint8_t iSerialNumber;
+	uint8_t bNumConfigurations;
+} __attribute__((packed));
+#define USB_DT_DEVICE_SIZE	sizeof(struct usb_device_descriptor)
+
+/* USB Device_Qualifier Descriptor - Table 9-9 
+ * Not used in this implementation. 
+ */
+struct usb_device_qualifier_descriptor {
+	uint8_t bLength;
+	uint8_t bDescriptorType;
+	uint16_t bcdUSB;
+	uint8_t bDeviceClass;
+	uint8_t bDeviceSubClass;
+	uint8_t bDeviceProtocol;
+	uint8_t bMaxPacketSize0;
+	uint8_t bNumConfigurations;
+	uint8_t bReserved;
+} __attribute__((packed));
+
+/* USB Standard Configuration Descriptor - Table 9-10 */
+struct usb_config_descriptor {
+	uint8_t bLength;
+	uint8_t bDescriptorType;
+	uint16_t wTotalLength;
+	uint8_t bNumInterfaces;
+	uint8_t bConfigurationValue;
+	uint8_t iConfiguration;
+	uint8_t bmAttributes;
+	uint8_t bMaxPower;
+	
+	/* Descriptor ends here.  The following are used internally: */
+	const struct usb_interface {
+		int num_altsetting;
+		const struct usb_interface_descriptor *altsetting;
+	} *interface;
+} __attribute__((packed));
+#define USB_DT_CONFIGURATION_SIZE	9
+
+/* USB Configuration Descriptor bmAttributes bit definitions */
+#define USB_CONFIG_ATTR_SELF_POWERED	0x40
+#define USB_CONFIG_ATTR_REMOTE_WAKEUP	0x20
+
+/* Other Speed Configuration is the same as Configuration Descriptor.
+ *  - Table 9-11 
+ */
+
+/* USB Standard Interface Descriptor - Table 9-12 */
+struct usb_interface_descriptor {
+	uint8_t bLength;
+	uint8_t bDescriptorType;
+	uint8_t bInterfaceNumber;
+	uint8_t bAlternateSetting;
+	uint8_t bNumEndpoints;
+	uint8_t bInterfaceClass;
+	uint8_t bInterfaceSubClass;
+	uint8_t bInterfaceProtocol;
+	uint8_t iInterface;
+
+	/* Descriptor ends here.  The following are used internally: */
+	const struct usb_endpoint_descriptor *endpoint;
+	const void *extra;
+	int extralen;
+} __attribute__((packed));
+#define USB_DT_INTERFACE_SIZE		9
+
+/* USB Standard Endpoint Descriptor - Table 9-13 */
+struct usb_endpoint_descriptor {
+	uint8_t bLength;
+	uint8_t bDescriptorType;
+	uint8_t bEndpointAddress;
+	uint8_t bmAttributes;
+	uint16_t wMaxPacketSize;
+	uint8_t bInterval;
+} __attribute__((packed));
+#define USB_DT_ENDPOINT_SIZE		sizeof(struct usb_endpoint_descriptor)
+
+/* USB Endpoint Descriptor bmAttributes bit definitions */
+#define USB_ENDPOINT_ATTR_CONTROL	0x00
+#define USB_ENDPOINT_ATTR_ISOCHRONOUS	0x01
+#define USB_ENDPOINT_ATTR_BULK		0x02
+#define USB_ENDPOINT_ATTR_INTERRUPT	0x03
+
+#define USB_ENDPOINT_ATTR_NOSYNC	0x00
+#define USB_ENDPOINT_ATTR_ASYNC		0x04
+#define USB_ENDPOINT_ATTR_ADAPTIVE	0x08
+#define USB_ENDPOINT_ATTR_SYNC		0x0C
+
+#define USB_ENDPOINT_ATTR_DATA		0x00
+#define USB_ENDPOINT_ATTR_FEEDBACK	0x10
+#define USB_ENDPOINT_ATTR_IMPLICIT_FEEDBACK_DATA 0x20
+
+/* Table 9-15 specifies String Descriptor Zero. 
+ * Table 9-16 specified UNICODE String Descriptor.
+ */
+struct usb_string_descriptor {
+	uint8_t bLength;
+	uint8_t bDescriptorType;
+	uint16_t wData[];
+} __attribute__((packed));
+
+#endif