]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/usb/serial/omninet.c
usb: fix ipw.c build error, select USB_SERIAL_WWAN
[mirror_ubuntu-bionic-kernel.git] / drivers / usb / serial / omninet.c
CommitLineData
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
f89d0dff 12 *
1da177e4 13 * (05/30/2001) gkh
f89d0dff
AC
14 * switched from using spinlock to a semaphore, which fixes lots of
15 * problems.
1da177e4
LT
16 *
17 * (04/08/2001) gb
18 * Identify version on module load.
19 *
20 * (11/01/2000) Adam J. Richter
21 * usb_device_id table support
f89d0dff 22 *
1da177e4
LT
23 * (10/05/2000) gkh
24 * Fixed bug with urb->dev not being set properly, now that the usb
25 * core needs it.
f89d0dff 26 *
1da177e4
LT
27 * (08/28/2000) gkh
28 * Added locks for SMP safeness.
f89d0dff 29 * Fixed MOD_INC and MOD_DEC logic and the ability to open a port more
1da177e4
LT
30 * than once.
31 * Fixed potential race in omninet_write_bulk_callback
32 *
33 * (07/19/2000) gkh
34 * Added module_init and module_exit functions to handle the fact that this
35 * driver is a loadable module now.
36 *
37 */
38
1da177e4
LT
39#include <linux/kernel.h>
40#include <linux/errno.h>
41#include <linux/init.h>
42#include <linux/slab.h>
43#include <linux/tty.h>
44#include <linux/tty_driver.h>
45#include <linux/tty_flip.h>
46#include <linux/module.h>
47#include <linux/spinlock.h>
f89d0dff 48#include <linux/uaccess.h>
1da177e4 49#include <linux/usb.h>
a969888c 50#include <linux/usb/serial.h>
1da177e4
LT
51
52static int debug;
53
54/*
55 * Version Information
56 */
57#define DRIVER_VERSION "v1.1"
58#define DRIVER_AUTHOR "Alessandro Zummo"
59#define DRIVER_DESC "USB ZyXEL omni.net LCD PLUS Driver"
60
61#define ZYXEL_VENDOR_ID 0x0586
62#define ZYXEL_OMNINET_ID 0x1000
f89d0dff
AC
63/* This one seems to be a re-branded ZyXEL device */
64#define BT_IGNITIONPRO_ID 0x2000
1da177e4
LT
65
66/* function prototypes */
a509a7e4 67static int omninet_open(struct tty_struct *tty, struct usb_serial_port *port);
335f8514 68static void omninet_close(struct usb_serial_port *port);
f89d0dff
AC
69static void omninet_read_bulk_callback(struct urb *urb);
70static void omninet_write_bulk_callback(struct urb *urb);
71static int omninet_write(struct tty_struct *tty, struct usb_serial_port *port,
72 const unsigned char *buf, int count);
73static int omninet_write_room(struct tty_struct *tty);
f9c99bb8
AS
74static void omninet_disconnect(struct usb_serial *serial);
75static void omninet_release(struct usb_serial *serial);
f89d0dff
AC
76static int omninet_attach(struct usb_serial *serial);
77
7d40d7e8 78static const struct usb_device_id id_table[] = {
1da177e4
LT
79 { USB_DEVICE(ZYXEL_VENDOR_ID, ZYXEL_OMNINET_ID) },
80 { USB_DEVICE(ZYXEL_VENDOR_ID, BT_IGNITIONPRO_ID) },
81 { } /* Terminating entry */
82};
83
f89d0dff 84MODULE_DEVICE_TABLE(usb, id_table);
1da177e4
LT
85
86static struct usb_driver omninet_driver = {
1da177e4
LT
87 .name = "omninet",
88 .probe = usb_serial_probe,
89 .disconnect = usb_serial_disconnect,
90 .id_table = id_table,
ba9dc657 91 .no_dynamic_id = 1,
1da177e4
LT
92};
93
94
ea65370d 95static struct usb_serial_driver zyxel_omninet_device = {
18fcac35
GKH
96 .driver = {
97 .owner = THIS_MODULE,
269bda1c 98 .name = "omninet",
18fcac35 99 },
269bda1c 100 .description = "ZyXEL - omni.net lcd plus usb",
d9b1b787 101 .usb_driver = &omninet_driver,
1da177e4 102 .id_table = id_table,
1da177e4 103 .num_ports = 1,
5ec1862e 104 .attach = omninet_attach,
1da177e4
LT
105 .open = omninet_open,
106 .close = omninet_close,
107 .write = omninet_write,
108 .write_room = omninet_write_room,
109 .read_bulk_callback = omninet_read_bulk_callback,
110 .write_bulk_callback = omninet_write_bulk_callback,
f9c99bb8
AS
111 .disconnect = omninet_disconnect,
112 .release = omninet_release,
1da177e4
LT
113};
114
115
116/* The protocol.
117 *
118 * The omni.net always exchange 64 bytes of data with the host. The first
119 * four bytes are the control header, you can see it in the above structure.
120 *
121 * oh_seq is a sequence number. Don't know if/how it's used.
122 * oh_len is the length of the data bytes in the packet.
123 * oh_xxx Bit-mapped, related to handshaking and status info.
124 * I normally set it to 0x03 in trasmitted frames.
125 * 7: Active when the TA is in a CONNECTed state.
126 * 6: unknown
127 * 5: handshaking, unknown
128 * 4: handshaking, unknown
129 * 3: unknown, usually 0
130 * 2: unknown, usually 0
131 * 1: handshaking, unknown, usually set to 1 in trasmitted frames
132 * 0: handshaking, unknown, usually set to 1 in trasmitted frames
133 * oh_pad Probably a pad byte.
134 *
135 * After the header you will find data bytes if oh_len was greater than zero.
136 *
137 */
138
f89d0dff 139struct omninet_header {
1da177e4
LT
140 __u8 oh_seq;
141 __u8 oh_len;
142 __u8 oh_xxx;
143 __u8 oh_pad;
144};
145
f89d0dff
AC
146struct omninet_data {
147 __u8 od_outseq; /* Sequence number for bulk_out URBs */
1da177e4
LT
148};
149
f89d0dff 150static int omninet_attach(struct usb_serial *serial)
5ec1862e
ON
151{
152 struct omninet_data *od;
153 struct usb_serial_port *port = serial->port[0];
154
f89d0dff
AC
155 od = kmalloc(sizeof(struct omninet_data), GFP_KERNEL);
156 if (!od) {
194343d9
GKH
157 dev_err(&port->dev, "%s- kmalloc(%Zd) failed.\n",
158 __func__, sizeof(struct omninet_data));
5ec1862e
ON
159 return -ENOMEM;
160 }
161 usb_set_serial_port_data(port, od);
162 return 0;
163}
164
a509a7e4 165static int omninet_open(struct tty_struct *tty, struct usb_serial_port *port)
1da177e4
LT
166{
167 struct usb_serial *serial = port->serial;
168 struct usb_serial_port *wport;
1da177e4
LT
169 int result = 0;
170
441b62c1 171 dbg("%s - port %d", __func__, port->number);
1da177e4 172
1da177e4 173 wport = serial->port[1];
4a90f09b 174 tty_port_tty_set(&wport->port, tty);
1da177e4
LT
175
176 /* Start reading from the device */
f89d0dff
AC
177 usb_fill_bulk_urb(port->read_urb, serial->dev,
178 usb_rcvbulkpipe(serial->dev,
179 port->bulk_in_endpointAddress),
180 port->read_urb->transfer_buffer,
181 port->read_urb->transfer_buffer_length,
182 omninet_read_bulk_callback, port);
1da177e4 183 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
f89d0dff 184 if (result)
194343d9
GKH
185 dev_err(&port->dev,
186 "%s - failed submitting read urb, error %d\n",
187 __func__, result);
1da177e4
LT
188 return result;
189}
190
335f8514 191static void omninet_close(struct usb_serial_port *port)
1da177e4 192{
441b62c1 193 dbg("%s - port %d", __func__, port->number);
1da177e4 194 usb_kill_urb(port->read_urb);
1da177e4
LT
195}
196
197
198#define OMNINET_DATAOFFSET 0x04
199#define OMNINET_HEADERLEN sizeof(struct omninet_header)
200#define OMNINET_BULKOUTSIZE (64 - OMNINET_HEADERLEN)
201
f89d0dff 202static void omninet_read_bulk_callback(struct urb *urb)
1da177e4 203{
cdc97792 204 struct usb_serial_port *port = urb->context;
1da177e4
LT
205 unsigned char *data = urb->transfer_buffer;
206 struct omninet_header *header = (struct omninet_header *) &data[0];
fdc2deb3 207 int status = urb->status;
1da177e4 208 int result;
4944d400 209 int i;
1da177e4 210
441b62c1 211 dbg("%s - port %d", __func__, port->number);
1da177e4 212
fdc2deb3
GKH
213 if (status) {
214 dbg("%s - nonzero read bulk status received: %d",
441b62c1 215 __func__, status);
1da177e4
LT
216 return;
217 }
218
f89d0dff 219 if (debug && header->oh_xxx != 0x30) {
1da177e4 220 if (urb->actual_length) {
f45ba776
JP
221 printk(KERN_DEBUG "%s: omninet_read %d: ",
222 __FILE__, header->oh_len);
f89d0dff
AC
223 for (i = 0; i < (header->oh_len +
224 OMNINET_HEADERLEN); i++)
225 printk("%.2x ", data[i]);
226 printk("\n");
1da177e4
LT
227 }
228 }
229
230 if (urb->actual_length && header->oh_len) {
4a90f09b
AC
231 struct tty_struct *tty = tty_port_tty_get(&port->port);
232 tty_insert_flip_string(tty, data + OMNINET_DATAOFFSET,
233 header->oh_len);
234 tty_flip_buffer_push(tty);
235 tty_kref_put(tty);
1da177e4
LT
236 }
237
238 /* Continue trying to always read */
f89d0dff
AC
239 usb_fill_bulk_urb(urb, port->serial->dev,
240 usb_rcvbulkpipe(port->serial->dev,
241 port->bulk_in_endpointAddress),
242 urb->transfer_buffer, urb->transfer_buffer_length,
243 omninet_read_bulk_callback, port);
1da177e4
LT
244 result = usb_submit_urb(urb, GFP_ATOMIC);
245 if (result)
194343d9
GKH
246 dev_err(&port->dev,
247 "%s - failed resubmitting read urb, error %d\n",
248 __func__, result);
1da177e4
LT
249}
250
95da310e
AC
251static int omninet_write(struct tty_struct *tty, struct usb_serial_port *port,
252 const unsigned char *buf, int count)
1da177e4 253{
f89d0dff
AC
254 struct usb_serial *serial = port->serial;
255 struct usb_serial_port *wport = serial->port[1];
1da177e4 256
f89d0dff
AC
257 struct omninet_data *od = usb_get_serial_port_data(port);
258 struct omninet_header *header = (struct omninet_header *)
259 wport->write_urb->transfer_buffer;
1da177e4
LT
260
261 int result;
262
441b62c1 263 dbg("%s - port %d", __func__, port->number);
1da177e4
LT
264
265 if (count == 0) {
441b62c1 266 dbg("%s - write request of 0 bytes", __func__);
f89d0dff 267 return 0;
1da177e4 268 }
507ca9bc 269
e81ee637 270 spin_lock_bh(&wport->lock);
df3fccb1 271 if (wport->write_urb_busy) {
e81ee637 272 spin_unlock_bh(&wport->lock);
441b62c1 273 dbg("%s - already writing", __func__);
507ca9bc 274 return 0;
1da177e4 275 }
df3fccb1 276 wport->write_urb_busy = 1;
e81ee637 277 spin_unlock_bh(&wport->lock);
1da177e4
LT
278
279 count = (count > OMNINET_BULKOUTSIZE) ? OMNINET_BULKOUTSIZE : count;
280
f89d0dff
AC
281 memcpy(wport->write_urb->transfer_buffer + OMNINET_DATAOFFSET,
282 buf, count);
1da177e4 283
f89d0dff
AC
284 usb_serial_debug_data(debug, &port->dev, __func__, count,
285 wport->write_urb->transfer_buffer);
1da177e4
LT
286
287 header->oh_seq = od->od_outseq++;
288 header->oh_len = count;
289 header->oh_xxx = 0x03;
290 header->oh_pad = 0x00;
291
292 /* send the data out the bulk port, always 64 bytes */
293 wport->write_urb->transfer_buffer_length = 64;
294
295 wport->write_urb->dev = serial->dev;
296 result = usb_submit_urb(wport->write_urb, GFP_ATOMIC);
507ca9bc 297 if (result) {
df3fccb1 298 wport->write_urb_busy = 0;
194343d9
GKH
299 dev_err(&port->dev,
300 "%s - failed submitting write urb, error %d\n",
301 __func__, result);
507ca9bc 302 } else
1da177e4
LT
303 result = count;
304
305 return result;
306}
307
308
f89d0dff 309static int omninet_write_room(struct tty_struct *tty)
1da177e4 310{
95da310e 311 struct usb_serial_port *port = tty->driver_data;
1da177e4
LT
312 struct usb_serial *serial = port->serial;
313 struct usb_serial_port *wport = serial->port[1];
314
a5b6f60c 315 int room = 0; /* Default: no room */
1da177e4 316
a5b6f60c 317 /* FIXME: no consistent locking for write_urb_busy */
507ca9bc 318 if (wport->write_urb_busy)
1da177e4
LT
319 room = wport->bulk_out_size - OMNINET_HEADERLEN;
320
441b62c1 321 dbg("%s - returns %d", __func__, room);
1da177e4 322
f89d0dff 323 return room;
1da177e4
LT
324}
325
f89d0dff 326static void omninet_write_bulk_callback(struct urb *urb)
1da177e4 327{
f89d0dff
AC
328/* struct omninet_header *header = (struct omninet_header *)
329 urb->transfer_buffer; */
cdc97792 330 struct usb_serial_port *port = urb->context;
fdc2deb3 331 int status = urb->status;
1da177e4 332
759f3634 333 dbg("%s - port %0x", __func__, port->number);
1da177e4 334
507ca9bc 335 port->write_urb_busy = 0;
fdc2deb3
GKH
336 if (status) {
337 dbg("%s - nonzero write bulk status received: %d",
441b62c1 338 __func__, status);
1da177e4
LT
339 return;
340 }
341
cf2c7481 342 usb_serial_port_softint(port);
1da177e4
LT
343}
344
345
f9c99bb8 346static void omninet_disconnect(struct usb_serial *serial)
1da177e4 347{
5ec1862e 348 struct usb_serial_port *wport = serial->port[1];
f9c99bb8 349
f89d0dff 350 dbg("%s", __func__);
5ec1862e
ON
351
352 usb_kill_urb(wport->write_urb);
f9c99bb8
AS
353}
354
355
356static void omninet_release(struct usb_serial *serial)
357{
358 struct usb_serial_port *port = serial->port[0];
359
360 dbg("%s", __func__);
361
5ec1862e 362 kfree(usb_get_serial_port_data(port));
1da177e4
LT
363}
364
365
f89d0dff 366static int __init omninet_init(void)
1da177e4
LT
367{
368 int retval;
369 retval = usb_serial_register(&zyxel_omninet_device);
370 if (retval)
371 goto failed_usb_serial_register;
372 retval = usb_register(&omninet_driver);
373 if (retval)
374 goto failed_usb_register;
c197a8db
GKH
375 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
376 DRIVER_DESC "\n");
1da177e4
LT
377 return 0;
378failed_usb_register:
379 usb_serial_deregister(&zyxel_omninet_device);
380failed_usb_serial_register:
381 return retval;
382}
383
384
f89d0dff 385static void __exit omninet_exit(void)
1da177e4 386{
f89d0dff
AC
387 usb_deregister(&omninet_driver);
388 usb_serial_deregister(&zyxel_omninet_device);
1da177e4
LT
389}
390
391
392module_init(omninet_init);
393module_exit(omninet_exit);
394
f89d0dff
AC
395MODULE_AUTHOR(DRIVER_AUTHOR);
396MODULE_DESCRIPTION(DRIVER_DESC);
1da177e4
LT
397MODULE_LICENSE("GPL");
398
399module_param(debug, bool, S_IRUGO | S_IWUSR);
400MODULE_PARM_DESC(debug, "Debug enabled or not");