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