source: src/linux/universal/linux-3.18/drivers/usb/serial/omninet.c @ 31869

Last change on this file since 31869 was 31869, checked in by brainslayer, 2 months ago

update

File size: 6.8 KB
Line 
1/*
2 * USB ZyXEL omni.net LCD PLUS driver
3 *
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.
7 *
8 * See Documentation/usb/usb-serial.txt for more information on using this
9 * driver
10 *
11 * Please report both successes and troubles to the author at omninet@kroah.com
12 */
13
14#include <linux/kernel.h>
15#include <linux/errno.h>
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>
21#include <linux/uaccess.h>
22#include <linux/usb.h>
23#include <linux/usb/serial.h>
24
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
30/* This one seems to be a re-branded ZyXEL device */
31#define BT_IGNITIONPRO_ID       0x2000
32
33/* function prototypes */
34static int  omninet_open(struct tty_struct *tty, struct usb_serial_port *port);
35static void omninet_process_read_urb(struct urb *urb);
36static void omninet_write_bulk_callback(struct urb *urb);
37static int  omninet_write(struct tty_struct *tty, struct usb_serial_port *port,
38                                const unsigned char *buf, int count);
39static int  omninet_write_room(struct tty_struct *tty);
40static void omninet_disconnect(struct usb_serial *serial);
41static int omninet_port_probe(struct usb_serial_port *port);
42static int omninet_port_remove(struct usb_serial_port *port);
43
44static const struct usb_device_id id_table[] = {
45        { USB_DEVICE(ZYXEL_VENDOR_ID, ZYXEL_OMNINET_ID) },
46        { USB_DEVICE(ZYXEL_VENDOR_ID, BT_IGNITIONPRO_ID) },
47        { }                                             /* Terminating entry */
48};
49MODULE_DEVICE_TABLE(usb, id_table);
50
51static struct usb_serial_driver zyxel_omninet_device = {
52        .driver = {
53                .owner =        THIS_MODULE,
54                .name =         "omninet",
55        },
56        .description =          "ZyXEL - omni.net lcd plus usb",
57        .id_table =             id_table,
58        .num_ports =            1,
59        .port_probe =           omninet_port_probe,
60        .port_remove =          omninet_port_remove,
61        .open =                 omninet_open,
62        .write =                omninet_write,
63        .write_room =           omninet_write_room,
64        .write_bulk_callback =  omninet_write_bulk_callback,
65        .process_read_urb =     omninet_process_read_urb,
66        .disconnect =           omninet_disconnect,
67};
68
69static struct usb_serial_driver * const serial_drivers[] = {
70        &zyxel_omninet_device, NULL
71};
72
73
74/*
75 * The protocol.
76 *
77 * The omni.net always exchange 64 bytes of data with the host. The first
78 * four bytes are the control header.
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.
83 *      I normally set it to 0x03 in transmitted frames.
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
90 *      1: handshaking, unknown, usually set to 1 in transmitted frames
91 *      0: handshaking, unknown, usually set to 1 in transmitted frames
92 * oh_pad Probably a pad byte.
93 *
94 * After the header you will find data bytes if oh_len was greater than zero.
95 */
96struct omninet_header {
97        __u8    oh_seq;
98        __u8    oh_len;
99        __u8    oh_xxx;
100        __u8    oh_pad;
101};
102
103struct omninet_data {
104        __u8    od_outseq;      /* Sequence number for bulk_out URBs */
105};
106
107static int omninet_port_probe(struct usb_serial_port *port)
108{
109        struct omninet_data *od;
110
111        od = kzalloc(sizeof(*od), GFP_KERNEL);
112        if (!od)
113                return -ENOMEM;
114
115        usb_set_serial_port_data(port, od);
116
117        return 0;
118}
119
120static 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
127        return 0;
128}
129
130static int omninet_open(struct tty_struct *tty, struct usb_serial_port *port)
131{
132        return usb_serial_generic_open(tty, port);
133}
134
135#define OMNINET_HEADERLEN       4
136#define OMNINET_BULKOUTSIZE     64
137#define OMNINET_PAYLOADSIZE     (OMNINET_BULKOUTSIZE - OMNINET_HEADERLEN)
138
139static void omninet_process_read_urb(struct urb *urb)
140{
141        struct usb_serial_port *port = urb->context;
142        const struct omninet_header *hdr = urb->transfer_buffer;
143        const unsigned char *data;
144        size_t data_len;
145
146        if (urb->actual_length <= OMNINET_HEADERLEN || !hdr->oh_len)
147                return;
148
149        data = (char *)urb->transfer_buffer + OMNINET_HEADERLEN;
150        data_len = min_t(size_t, urb->actual_length - OMNINET_HEADERLEN,
151                                                                hdr->oh_len);
152        tty_insert_flip_string(&port->port, data, data_len);
153        tty_flip_buffer_push(&port->port);
154}
155
156static int omninet_write(struct tty_struct *tty, struct usb_serial_port *port,
157                                        const unsigned char *buf, int count)
158{
159        struct usb_serial *serial = port->serial;
160        struct usb_serial_port *wport = serial->port[1];
161
162        struct omninet_data *od = usb_get_serial_port_data(port);
163        struct omninet_header *header = (struct omninet_header *)
164                                        wport->write_urb->transfer_buffer;
165
166        int                     result;
167
168        if (count == 0) {
169                dev_dbg(&port->dev, "%s - write request of 0 bytes\n", __func__);
170                return 0;
171        }
172
173        if (!test_and_clear_bit(0, &port->write_urbs_free)) {
174                dev_dbg(&port->dev, "%s - already writing\n", __func__);
175                return 0;
176        }
177
178        count = (count > OMNINET_PAYLOADSIZE) ? OMNINET_PAYLOADSIZE : count;
179
180        memcpy(wport->write_urb->transfer_buffer + OMNINET_HEADERLEN,
181                                                                buf, count);
182
183        usb_serial_debug_data(&port->dev, __func__, count,
184                              wport->write_urb->transfer_buffer);
185
186        header->oh_seq  = od->od_outseq++;
187        header->oh_len  = count;
188        header->oh_xxx  = 0x03;
189        header->oh_pad  = 0x00;
190
191        /* send the data out the bulk port, always 64 bytes */
192        wport->write_urb->transfer_buffer_length = OMNINET_BULKOUTSIZE;
193
194        result = usb_submit_urb(wport->write_urb, GFP_ATOMIC);
195        if (result) {
196                set_bit(0, &wport->write_urbs_free);
197                dev_err_console(port,
198                        "%s - failed submitting write urb, error %d\n",
199                        __func__, result);
200        } else
201                result = count;
202
203        return result;
204}
205
206
207static int omninet_write_room(struct tty_struct *tty)
208{
209        struct usb_serial_port *port = tty->driver_data;
210        struct usb_serial       *serial = port->serial;
211        struct usb_serial_port  *wport  = serial->port[1];
212
213        int room = 0; /* Default: no room */
214
215        if (test_bit(0, &wport->write_urbs_free))
216                room = wport->bulk_out_size - OMNINET_HEADERLEN;
217
218        dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
219
220        return room;
221}
222
223static void omninet_write_bulk_callback(struct urb *urb)
224{
225/*      struct omninet_header   *header = (struct omninet_header  *)
226                                                urb->transfer_buffer; */
227        struct usb_serial_port  *port   =  urb->context;
228        int status = urb->status;
229
230        set_bit(0, &port->write_urbs_free);
231        if (status) {
232                dev_dbg(&port->dev, "%s - nonzero write bulk status received: %d\n",
233                        __func__, status);
234                return;
235        }
236
237        usb_serial_port_softint(port);
238}
239
240
241static void omninet_disconnect(struct usb_serial *serial)
242{
243        struct usb_serial_port *wport = serial->port[1];
244
245        usb_kill_urb(wport->write_urb);
246}
247
248module_usb_serial_driver(serial_drivers, id_table);
249
250MODULE_AUTHOR(DRIVER_AUTHOR);
251MODULE_DESCRIPTION(DRIVER_DESC);
252MODULE_LICENSE("GPL");
Note: See TracBrowser for help on using the repository browser.