Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * USB ZyXEL omni.net LCD PLUS driver | |
3 | * | |
4d0dce3e GKH |
4 | * This program is free software; you can redistribute it and/or |
5 | * modify it under the terms of the GNU General Public License version | |
6 | * 2 as published by the Free Software Foundation. | |
1da177e4 | 7 | * |
f89d0dff AC |
8 | * See Documentation/usb/usb-serial.txt for more information on using this |
9 | * driver | |
1da177e4 LT |
10 | * |
11 | * Please report both successes and troubles to the author at omninet@kroah.com | |
1da177e4 LT |
12 | */ |
13 | ||
1da177e4 LT |
14 | #include <linux/kernel.h> |
15 | #include <linux/errno.h> | |
1da177e4 LT |
16 | #include <linux/slab.h> |
17 | #include <linux/tty.h> | |
18 | #include <linux/tty_driver.h> | |
19 | #include <linux/tty_flip.h> | |
20 | #include <linux/module.h> | |
f89d0dff | 21 | #include <linux/uaccess.h> |
1da177e4 | 22 | #include <linux/usb.h> |
a969888c | 23 | #include <linux/usb/serial.h> |
1da177e4 | 24 | |
1da177e4 LT |
25 | #define DRIVER_AUTHOR "Alessandro Zummo" |
26 | #define DRIVER_DESC "USB ZyXEL omni.net LCD PLUS Driver" | |
27 | ||
28 | #define ZYXEL_VENDOR_ID 0x0586 | |
29 | #define ZYXEL_OMNINET_ID 0x1000 | |
f89d0dff AC |
30 | /* This one seems to be a re-branded ZyXEL device */ |
31 | #define BT_IGNITIONPRO_ID 0x2000 | |
1da177e4 LT |
32 | |
33 | /* function prototypes */ | |
a509a7e4 | 34 | static int omninet_open(struct tty_struct *tty, struct usb_serial_port *port); |
fbf94773 | 35 | static void omninet_process_read_urb(struct urb *urb); |
f89d0dff AC |
36 | static void omninet_write_bulk_callback(struct urb *urb); |
37 | static int omninet_write(struct tty_struct *tty, struct usb_serial_port *port, | |
38 | const unsigned char *buf, int count); | |
39 | static int omninet_write_room(struct tty_struct *tty); | |
f9c99bb8 | 40 | static void omninet_disconnect(struct usb_serial *serial); |
feffa7ca JH |
41 | static int omninet_port_probe(struct usb_serial_port *port); |
42 | static int omninet_port_remove(struct usb_serial_port *port); | |
f89d0dff | 43 | |
7d40d7e8 | 44 | static const struct usb_device_id id_table[] = { |
1da177e4 LT |
45 | { USB_DEVICE(ZYXEL_VENDOR_ID, ZYXEL_OMNINET_ID) }, |
46 | { USB_DEVICE(ZYXEL_VENDOR_ID, BT_IGNITIONPRO_ID) }, | |
47 | { } /* Terminating entry */ | |
48 | }; | |
f89d0dff | 49 | MODULE_DEVICE_TABLE(usb, id_table); |
1da177e4 | 50 | |
ea65370d | 51 | static struct usb_serial_driver zyxel_omninet_device = { |
18fcac35 GKH |
52 | .driver = { |
53 | .owner = THIS_MODULE, | |
269bda1c | 54 | .name = "omninet", |
18fcac35 | 55 | }, |
269bda1c | 56 | .description = "ZyXEL - omni.net lcd plus usb", |
1da177e4 | 57 | .id_table = id_table, |
1da177e4 | 58 | .num_ports = 1, |
feffa7ca JH |
59 | .port_probe = omninet_port_probe, |
60 | .port_remove = omninet_port_remove, | |
1da177e4 | 61 | .open = omninet_open, |
1da177e4 LT |
62 | .write = omninet_write, |
63 | .write_room = omninet_write_room, | |
1da177e4 | 64 | .write_bulk_callback = omninet_write_bulk_callback, |
fbf94773 | 65 | .process_read_urb = omninet_process_read_urb, |
f9c99bb8 | 66 | .disconnect = omninet_disconnect, |
1da177e4 LT |
67 | }; |
68 | ||
f667ddad AS |
69 | static struct usb_serial_driver * const serial_drivers[] = { |
70 | &zyxel_omninet_device, NULL | |
71 | }; | |
72 | ||
1da177e4 | 73 | |
b42abbcd JH |
74 | /* |
75 | * The protocol. | |
1da177e4 LT |
76 | * |
77 | * The omni.net always exchange 64 bytes of data with the host. The first | |
b42abbcd | 78 | * four bytes are the control header. |
1da177e4 LT |
79 | * |
80 | * oh_seq is a sequence number. Don't know if/how it's used. | |
81 | * oh_len is the length of the data bytes in the packet. | |
82 | * oh_xxx Bit-mapped, related to handshaking and status info. | |
b42abbcd | 83 | * I normally set it to 0x03 in transmitted frames. |
1da177e4 LT |
84 | * 7: Active when the TA is in a CONNECTed state. |
85 | * 6: unknown | |
86 | * 5: handshaking, unknown | |
87 | * 4: handshaking, unknown | |
88 | * 3: unknown, usually 0 | |
89 | * 2: unknown, usually 0 | |
b42abbcd JH |
90 | * 1: handshaking, unknown, usually set to 1 in transmitted frames |
91 | * 0: handshaking, unknown, usually set to 1 in transmitted frames | |
1da177e4 LT |
92 | * oh_pad Probably a pad byte. |
93 | * | |
94 | * After the header you will find data bytes if oh_len was greater than zero. | |
1da177e4 | 95 | */ |
f89d0dff | 96 | struct omninet_header { |
1da177e4 LT |
97 | __u8 oh_seq; |
98 | __u8 oh_len; | |
99 | __u8 oh_xxx; | |
100 | __u8 oh_pad; | |
101 | }; | |
102 | ||
f89d0dff AC |
103 | struct omninet_data { |
104 | __u8 od_outseq; /* Sequence number for bulk_out URBs */ | |
1da177e4 LT |
105 | }; |
106 | ||
feffa7ca | 107 | static int omninet_port_probe(struct usb_serial_port *port) |
5ec1862e ON |
108 | { |
109 | struct omninet_data *od; | |
5ec1862e | 110 | |
81f58c67 | 111 | od = kzalloc(sizeof(*od), GFP_KERNEL); |
feffa7ca | 112 | if (!od) |
5ec1862e | 113 | return -ENOMEM; |
feffa7ca | 114 | |
5ec1862e | 115 | usb_set_serial_port_data(port, od); |
feffa7ca JH |
116 | |
117 | return 0; | |
118 | } | |
119 | ||
120 | static int omninet_port_remove(struct usb_serial_port *port) | |
121 | { | |
122 | struct omninet_data *od; | |
123 | ||
124 | od = usb_get_serial_port_data(port); | |
125 | kfree(od); | |
126 | ||
5ec1862e ON |
127 | return 0; |
128 | } | |
129 | ||
a509a7e4 | 130 | static int omninet_open(struct tty_struct *tty, struct usb_serial_port *port) |
1da177e4 LT |
131 | { |
132 | struct usb_serial *serial = port->serial; | |
133 | struct usb_serial_port *wport; | |
1da177e4 | 134 | |
1da177e4 | 135 | wport = serial->port[1]; |
4a90f09b | 136 | tty_port_tty_set(&wport->port, tty); |
1da177e4 | 137 | |
fbf94773 | 138 | return usb_serial_generic_open(tty, port); |
1da177e4 LT |
139 | } |
140 | ||
d91641b1 JH |
141 | #define OMNINET_HEADERLEN 4 |
142 | #define OMNINET_BULKOUTSIZE 64 | |
143 | #define OMNINET_PAYLOADSIZE (OMNINET_BULKOUTSIZE - OMNINET_HEADERLEN) | |
1da177e4 | 144 | |
a6c042f9 JH |
145 | static void omninet_process_read_urb(struct urb *urb) |
146 | { | |
147 | struct usb_serial_port *port = urb->context; | |
148 | const struct omninet_header *hdr = urb->transfer_buffer; | |
149 | const unsigned char *data; | |
150 | size_t data_len; | |
151 | ||
152 | if (urb->actual_length <= OMNINET_HEADERLEN || !hdr->oh_len) | |
153 | return; | |
154 | ||
155 | data = (char *)urb->transfer_buffer + OMNINET_HEADERLEN; | |
156 | data_len = min_t(size_t, urb->actual_length - OMNINET_HEADERLEN, | |
157 | hdr->oh_len); | |
158 | tty_insert_flip_string(&port->port, data, data_len); | |
159 | tty_flip_buffer_push(&port->port); | |
160 | } | |
161 | ||
95da310e AC |
162 | static int omninet_write(struct tty_struct *tty, struct usb_serial_port *port, |
163 | const unsigned char *buf, int count) | |
1da177e4 | 164 | { |
f89d0dff AC |
165 | struct usb_serial *serial = port->serial; |
166 | struct usb_serial_port *wport = serial->port[1]; | |
1da177e4 | 167 | |
f89d0dff AC |
168 | struct omninet_data *od = usb_get_serial_port_data(port); |
169 | struct omninet_header *header = (struct omninet_header *) | |
170 | wport->write_urb->transfer_buffer; | |
1da177e4 LT |
171 | |
172 | int result; | |
173 | ||
1da177e4 | 174 | if (count == 0) { |
7b5ba275 | 175 | dev_dbg(&port->dev, "%s - write request of 0 bytes\n", __func__); |
f89d0dff | 176 | return 0; |
1da177e4 | 177 | } |
507ca9bc | 178 | |
120f9dbc | 179 | if (!test_and_clear_bit(0, &port->write_urbs_free)) { |
7b5ba275 | 180 | dev_dbg(&port->dev, "%s - already writing\n", __func__); |
507ca9bc | 181 | return 0; |
1da177e4 LT |
182 | } |
183 | ||
d91641b1 | 184 | count = (count > OMNINET_PAYLOADSIZE) ? OMNINET_PAYLOADSIZE : count; |
1da177e4 | 185 | |
d91641b1 | 186 | memcpy(wport->write_urb->transfer_buffer + OMNINET_HEADERLEN, |
f89d0dff | 187 | buf, count); |
1da177e4 | 188 | |
59d33f2f GKH |
189 | usb_serial_debug_data(&port->dev, __func__, count, |
190 | wport->write_urb->transfer_buffer); | |
1da177e4 LT |
191 | |
192 | header->oh_seq = od->od_outseq++; | |
193 | header->oh_len = count; | |
194 | header->oh_xxx = 0x03; | |
195 | header->oh_pad = 0x00; | |
196 | ||
197 | /* send the data out the bulk port, always 64 bytes */ | |
d91641b1 | 198 | wport->write_urb->transfer_buffer_length = OMNINET_BULKOUTSIZE; |
1da177e4 | 199 | |
1da177e4 | 200 | result = usb_submit_urb(wport->write_urb, GFP_ATOMIC); |
507ca9bc | 201 | if (result) { |
120f9dbc | 202 | set_bit(0, &wport->write_urbs_free); |
22a416c4 | 203 | dev_err_console(port, |
194343d9 GKH |
204 | "%s - failed submitting write urb, error %d\n", |
205 | __func__, result); | |
507ca9bc | 206 | } else |
1da177e4 LT |
207 | result = count; |
208 | ||
209 | return result; | |
210 | } | |
211 | ||
212 | ||
f89d0dff | 213 | static int omninet_write_room(struct tty_struct *tty) |
1da177e4 | 214 | { |
95da310e | 215 | struct usb_serial_port *port = tty->driver_data; |
1da177e4 LT |
216 | struct usb_serial *serial = port->serial; |
217 | struct usb_serial_port *wport = serial->port[1]; | |
218 | ||
a5b6f60c | 219 | int room = 0; /* Default: no room */ |
1da177e4 | 220 | |
120f9dbc | 221 | if (test_bit(0, &wport->write_urbs_free)) |
1da177e4 LT |
222 | room = wport->bulk_out_size - OMNINET_HEADERLEN; |
223 | ||
7b5ba275 | 224 | dev_dbg(&port->dev, "%s - returns %d\n", __func__, room); |
1da177e4 | 225 | |
f89d0dff | 226 | return room; |
1da177e4 LT |
227 | } |
228 | ||
f89d0dff | 229 | static void omninet_write_bulk_callback(struct urb *urb) |
1da177e4 | 230 | { |
f89d0dff AC |
231 | /* struct omninet_header *header = (struct omninet_header *) |
232 | urb->transfer_buffer; */ | |
cdc97792 | 233 | struct usb_serial_port *port = urb->context; |
fdc2deb3 | 234 | int status = urb->status; |
1da177e4 | 235 | |
120f9dbc | 236 | set_bit(0, &port->write_urbs_free); |
fdc2deb3 | 237 | if (status) { |
7b5ba275 GKH |
238 | dev_dbg(&port->dev, "%s - nonzero write bulk status received: %d\n", |
239 | __func__, status); | |
1da177e4 LT |
240 | return; |
241 | } | |
242 | ||
cf2c7481 | 243 | usb_serial_port_softint(port); |
1da177e4 LT |
244 | } |
245 | ||
246 | ||
f9c99bb8 | 247 | static void omninet_disconnect(struct usb_serial *serial) |
1da177e4 | 248 | { |
5ec1862e | 249 | struct usb_serial_port *wport = serial->port[1]; |
f9c99bb8 | 250 | |
5ec1862e | 251 | usb_kill_urb(wport->write_urb); |
f9c99bb8 AS |
252 | } |
253 | ||
68e24113 | 254 | module_usb_serial_driver(serial_drivers, id_table); |
1da177e4 | 255 | |
f89d0dff AC |
256 | MODULE_AUTHOR(DRIVER_AUTHOR); |
257 | MODULE_DESCRIPTION(DRIVER_DESC); | |
1da177e4 | 258 | MODULE_LICENSE("GPL"); |