4 * This file is part of BeRTOS.
6 * Bertos is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * As a special exception, you may use this file as part of a free software
21 * library without restriction. Specifically, if other files instantiate
22 * templates or use macros or inline functions from this file, or you compile
23 * this file and link it with other files to produce an executable, this
24 * file does not by itself cause the resulting executable to be covered by
25 * the GNU General Public License. This exception does not however
26 * invalidate any other reasons why the executable file might be covered by
27 * the GNU General Public License.
29 * Copyright 2010 Develer S.r.l. (http://www.develer.com/)
33 * \author Andrea Righi <arighi@develer.com>
35 * \brief Generic USB serial device driver.
39 #include "cfg/cfg_usbser.h"
41 #define LOG_LEVEL USB_SERIAL_LOG_LEVEL
42 #define LOG_FORMAT USB_SERIAL_LOG_FORMAT
45 #include <cfg/debug.h>
46 #include <cfg/macros.h>
48 #include <cfg/compiler.h>
49 #include <cfg/module.h>
51 #include <cpu/irq.h> /* IRQ_DISABLE / IRQ_ENABLE */
52 #include <cpu/power.h> /* cpu_relax() */
55 #include <drv/usb_endpoint.h>
57 #include <string.h> /* memcpy() */
59 #include "drv/usbser.h"
61 #define USB_SERIAL_INTERFACES 1
62 #define USB_SERIAL_ENDPOINTS 3
64 #define USB_STRING_MANUFACTURER 1
65 #define USB_STRING_PRODUCT 2
66 #define USB_STRING_SERIAL 3
68 static UsbDeviceDesc usb_serial_device_descriptor =
70 .bLength = sizeof(usb_serial_device_descriptor),
71 .bDescriptorType = USB_DT_DEVICE,
73 .bDeviceClass = USB_CLASS_COMM,
76 .idVendor = USB_SERIAL_VENDOR_ID,
77 .idProduct = USB_SERIAL_PRODUCT_ID,
79 .iManufacturer = USB_STRING_MANUFACTURER,
80 .iProduct = USB_STRING_PRODUCT,
81 .iSerialNumber = USB_STRING_SERIAL,
82 .bNumConfigurations = 1,
85 static const UsbConfigDesc usb_serial_config_descriptor =
87 .bLength = sizeof(usb_serial_config_descriptor),
88 .bDescriptorType = USB_DT_CONFIG,
89 .bNumInterfaces = USB_SERIAL_INTERFACES,
90 .bConfigurationValue = 1,
92 .bmAttributes = USB_CONFIG_ATT_ONE,
93 .bMaxPower = 50, /* 100 mA */
96 static const UsbInterfaceDesc usb_serial_interface_descriptor =
98 .bLength = sizeof(usb_serial_interface_descriptor),
99 .bDescriptorType = USB_DT_INTERFACE,
100 .bInterfaceNumber = 0,
101 .bAlternateSetting = 0,
102 .bNumEndpoints = USB_SERIAL_ENDPOINTS,
103 .bInterfaceClass = 0xff,
104 .bInterfaceSubClass = 0,
105 .bInterfaceProtocol = 0,
109 static const UsbEndpointDesc usb_serial_ep_report_descriptor =
111 .bLength = sizeof(usb_serial_ep_report_descriptor),
112 .bDescriptorType = USB_DT_ENDPOINT,
113 .bEndpointAddress = USB_DIR_IN | USB_SERIAL_EP_REPORT,
114 .bmAttributes = USB_ENDPOINT_XFER_INT,
115 .wMaxPacketSize = usb_cpu_to_le16((uint16_t)8),
119 static const UsbEndpointDesc usb_serial_ep_in_descriptor =
121 .bLength = sizeof(usb_serial_ep_in_descriptor),
122 .bDescriptorType = USB_DT_ENDPOINT,
123 .bEndpointAddress = USB_DIR_IN | USB_SERIAL_EP_IN,
124 .bmAttributes = USB_ENDPOINT_XFER_BULK,
125 .wMaxPacketSize = usb_cpu_to_le16((uint16_t)64),
129 static const UsbEndpointDesc usb_serial_ep_out_descriptor =
131 .bLength = sizeof(usb_serial_ep_in_descriptor),
132 .bDescriptorType = USB_DT_ENDPOINT,
133 .bEndpointAddress = USB_DIR_OUT | USB_SERIAL_EP_OUT,
134 .bmAttributes = USB_ENDPOINT_XFER_BULK,
135 .wMaxPacketSize = usb_cpu_to_le16((uint16_t)64),
139 static const UsbDescHeader *usb_serial_config[] =
141 (const UsbDescHeader *)&usb_serial_config_descriptor,
142 (const UsbDescHeader *)&usb_serial_interface_descriptor,
143 (const UsbDescHeader *)&usb_serial_ep_report_descriptor,
144 (const UsbDescHeader *)&usb_serial_ep_in_descriptor,
145 (const UsbDescHeader *)&usb_serial_ep_out_descriptor,
149 static const DEFINE_USB_STRING(language_str, "\x09\x04"); // Language ID: en_US
150 static const DEFINE_USB_STRING(manufacturer_str,
151 USB_STRING("B", "e", "R", "T", "O", "S"));
152 static const DEFINE_USB_STRING(product_str,
153 USB_STRING("U", "S", "B", "-", "s", "e", "r", "i", "a", "l"));
154 static const DEFINE_USB_STRING(serial_str,
155 USB_STRING("0", "0", "1"));
157 static const UsbStringDesc *usb_serial_strings[] =
159 (const UsbStringDesc *)&language_str,
160 (const UsbStringDesc *)&manufacturer_str,
161 (const UsbStringDesc *)&product_str,
162 (const UsbStringDesc *)&serial_str,
166 /* Global usb-serial descriptor that identifies the usb-serial device */
167 static UsbDevice usb_serial = {
168 .device = &usb_serial_device_descriptor,
169 .config = usb_serial_config,
170 .strings = usb_serial_strings,
173 /* Low-level usb-serial device initialization */
174 static int usb_serial_hw_init(void)
179 if (usb_deviceRegister(&usb_serial) < 0)
181 LOG_INFO("usb-serial: registered new USB interface driver\n");
186 * \brief Write a buffer to a usb-serial port.
188 * \return number of bytes actually written.
190 static size_t usb_serial_write(struct KFile *fd,
191 const void *buf, size_t size)
193 DB(USBSerial *fds = USB_SERIAL_CAST(fd));
195 /* Silent compiler warnings if _DEBUG is not enabled */
197 ASSERT(fds->is_open);
198 return usb_endpointWrite(usb_serial_ep_in_descriptor.bEndpointAddress,
203 * Read at most \a size bytes from a usb-serial port and put them in \a buf
205 * \return number of bytes actually read.
207 static size_t usb_serial_read(struct KFile *fd, void *buf, size_t size)
209 DB(USBSerial *fds = USB_SERIAL_CAST(fd));
211 /* Silent compiler warnings if _DEBUG is not enabled */
213 ASSERT(fds->is_open);
214 return usb_endpointRead(usb_serial_ep_out_descriptor.bEndpointAddress,
219 * Return the status of a usb-serial port.
221 * \todo properly implement usb-serial error handling.
223 static int usb_serial_error(struct KFile *fd)
225 USBSerial *fds = USB_SERIAL_CAST(fd);
230 * Clear the status of a usb-serial port.
232 * \todo properly implement usb-serial error handling.
234 static void usb_serial_clearerr(struct KFile *fd)
236 USBSerial *fds = USB_SERIAL_CAST(fd);
241 * Close an USB serial port.
243 static int usb_serial_close(struct KFile *fd)
245 DB(USBSerial *fds = USB_SERIAL_CAST(fd));
247 /* Silent compiler warnings if _DEBUG is not enabled */
249 ASSERT(fds->is_open);
250 DB(fds->is_open = false);
255 * Initialize an USB serial port.
257 * \param fds KFile Serial struct interface.
258 * \param unit Serial unit to open.
260 static int usb_serial_open(struct USBSerial *fds, int unit)
263 ASSERT(!fds->is_open);
264 /* TODO: only a single usb-serial unit is supported for now */
267 /* Initialize usb-serial driver */
268 if (usb_serial_hw_init() < 0)
270 /* Clear error flags */
272 DB(fds->is_open = true);
278 * Reopen a usb-serial port.
280 static struct KFile *usb_serial_reopen(struct KFile *fd)
282 USBSerial *fds = USB_SERIAL_CAST(fd);
284 usb_serial_close(fd);
285 usb_serial_open(fds, fds->unit);
290 * Init serial driver for a usb-serial port \a unit.
292 * \return 0 if OK, a negative value in case of error.
294 int usbser_init(struct USBSerial *fds, int unit)
296 memset(fds, 0, sizeof(*fds));
298 DB(fds->fd._type = KFT_USB_SERIAL);
299 fds->fd.reopen = usb_serial_reopen;
300 fds->fd.close = usb_serial_close;
301 fds->fd.read = usb_serial_read;
302 fds->fd.write = usb_serial_write;
303 /* TODO: properly implement error handling. */
304 fds->fd.error = usb_serial_error;
305 fds->fd.clearerr = usb_serial_clearerr;
307 return usb_serial_open(fds, unit);