David Brownell | c1dca56 | 2008-06-19 17:51:44 -0700 | [diff] [blame] | 1 | /* |
| 2 | * u_serial.h - interface to USB gadget "serial port"/TTY utilities |
| 3 | * |
| 4 | * Copyright (C) 2008 David Brownell |
| 5 | * Copyright (C) 2008 by Nokia Corporation |
| 6 | * |
| 7 | * This software is distributed under the terms of the GNU General |
| 8 | * Public License ("GPL") as published by the Free Software Foundation, |
| 9 | * either version 2 of that License or (at your option) any later version. |
| 10 | */ |
| 11 | |
| 12 | #ifndef __U_SERIAL_H |
| 13 | #define __U_SERIAL_H |
| 14 | |
David Brownell | 4d5a73d | 2008-06-19 18:18:40 -0700 | [diff] [blame] | 15 | #include <linux/usb/composite.h> |
David Brownell | c1dca56 | 2008-06-19 17:51:44 -0700 | [diff] [blame] | 16 | #include <linux/usb/cdc.h> |
| 17 | |
Sebastian Andrzej Siewior | 19b10a8 | 2012-12-23 21:10:06 +0100 | [diff] [blame] | 18 | #define MAX_U_SERIAL_PORTS 4 |
| 19 | |
Sebastian Andrzej Siewior | ff47f59 | 2012-12-23 21:10:07 +0100 | [diff] [blame] | 20 | struct f_serial_opts { |
| 21 | struct usb_function_instance func_inst; |
| 22 | u8 port_num; |
| 23 | }; |
| 24 | |
David Brownell | c1dca56 | 2008-06-19 17:51:44 -0700 | [diff] [blame] | 25 | /* |
| 26 | * One non-multiplexed "serial" I/O port ... there can be several of these |
| 27 | * on any given USB peripheral device, if it provides enough endpoints. |
| 28 | * |
| 29 | * The "u_serial" utility component exists to do one thing: manage TTY |
| 30 | * style I/O using the USB peripheral endpoints listed here, including |
| 31 | * hookups to sysfs and /dev for each logical "tty" device. |
| 32 | * |
David Brownell | 1f1ba11 | 2008-08-06 18:49:57 -0700 | [diff] [blame] | 33 | * REVISIT at least ACM could support tiocmget() if needed. |
David Brownell | c1dca56 | 2008-06-19 17:51:44 -0700 | [diff] [blame] | 34 | * |
| 35 | * REVISIT someday, allow multiplexing several TTYs over these endpoints. |
| 36 | */ |
| 37 | struct gserial { |
David Brownell | 4d5a73d | 2008-06-19 18:18:40 -0700 | [diff] [blame] | 38 | struct usb_function func; |
David Brownell | c1dca56 | 2008-06-19 17:51:44 -0700 | [diff] [blame] | 39 | |
| 40 | /* port is managed by gserial_{connect,disconnect} */ |
| 41 | struct gs_port *ioport; |
| 42 | |
| 43 | struct usb_ep *in; |
| 44 | struct usb_ep *out; |
David Brownell | c1dca56 | 2008-06-19 17:51:44 -0700 | [diff] [blame] | 45 | |
| 46 | /* REVISIT avoid this CDC-ACM support harder ... */ |
| 47 | struct usb_cdc_line_coding port_line_coding; /* 9600-8-N-1 etc */ |
David Brownell | 1f1ba11 | 2008-08-06 18:49:57 -0700 | [diff] [blame] | 48 | |
| 49 | /* notification callbacks */ |
| 50 | void (*connect)(struct gserial *p); |
| 51 | void (*disconnect)(struct gserial *p); |
| 52 | int (*send_break)(struct gserial *p, int duration); |
David Brownell | c1dca56 | 2008-06-19 17:51:44 -0700 | [diff] [blame] | 53 | }; |
| 54 | |
David Brownell | 1f1ba11 | 2008-08-06 18:49:57 -0700 | [diff] [blame] | 55 | /* utilities to allocate/free request and buffer */ |
| 56 | struct usb_request *gs_alloc_req(struct usb_ep *ep, unsigned len, gfp_t flags); |
| 57 | void gs_free_req(struct usb_ep *, struct usb_request *req); |
| 58 | |
Sebastian Andrzej Siewior | 19b10a8 | 2012-12-23 21:10:06 +0100 | [diff] [blame] | 59 | /* management of individual TTY ports */ |
| 60 | int gserial_alloc_line(unsigned char *port_line); |
| 61 | void gserial_free_line(unsigned char port_line); |
David Brownell | c1dca56 | 2008-06-19 17:51:44 -0700 | [diff] [blame] | 62 | |
| 63 | /* connect/disconnect is handled by individual functions */ |
| 64 | int gserial_connect(struct gserial *, u8 port_num); |
| 65 | void gserial_disconnect(struct gserial *); |
| 66 | |
David Brownell | 4d5a73d | 2008-06-19 18:18:40 -0700 | [diff] [blame] | 67 | /* functions are bound to configurations by a config or gadget driver */ |
David Brownell | 61d8bae | 2008-06-19 18:18:50 -0700 | [diff] [blame] | 68 | int gser_bind_config(struct usb_configuration *c, u8 port_num); |
Felipe Balbi | 3086775 | 2008-08-18 17:39:30 -0700 | [diff] [blame] | 69 | int obex_bind_config(struct usb_configuration *c, u8 port_num); |
David Brownell | 4d5a73d | 2008-06-19 18:18:40 -0700 | [diff] [blame] | 70 | |
David Brownell | c1dca56 | 2008-06-19 17:51:44 -0700 | [diff] [blame] | 71 | #endif /* __U_SERIAL_H */ |