drivers/usb/serial/omninet.c

   1 /*
   2  * USB ZyXEL omni.net LCD PLUS driver
   3  *
   4  * Copyright (C) 2013,2017 Johan Hovold <johan@kernel.org>
   5  *
   6  *      This program is free software; you can redistribute it and/or
   7  *      modify it under the terms of the GNU General Public License version
   8  *      2 as published by the Free Software Foundation.
   9  *
  10  * See Documentation/usb/usb-serial.txt for more information on using this
  11  * driver
  12  *
  13  * Please report both successes and troubles to the author at omninet@kroah.com
  14  */
  15
  16 #include <linux/kernel.h>
  17 #include <linux/errno.h>
  18 #include <linux/slab.h>
  19 #include <linux/tty.h>
  20 #include <linux/tty_driver.h>
  21 #include <linux/tty_flip.h>
  22 #include <linux/module.h>
  23 #include <linux/uaccess.h>
  24 #include <linux/usb.h>
  25 #include <linux/usb/serial.h>
  26
  27 #define DRIVER_AUTHOR "Alessandro Zummo"
  28 #define DRIVER_DESC "USB ZyXEL omni.net LCD PLUS Driver"
  29
  30 #define ZYXEL_VENDOR_ID         0x0586
  31 #define ZYXEL_OMNINET_ID        0x1000
  32 #define ZYXEL_OMNI_56K_PLUS_ID  0x1500
  33 /* This one seems to be a re-branded ZyXEL device */
  34 #define BT_IGNITIONPRO_ID       0x2000
  35
  36 /* function prototypes */
  37 static void omninet_process_read_urb(struct urb *urb);
  38 static int omninet_prepare_write_buffer(struct usb_serial_port *port,
  39                                 void *buf, size_t count);
  40 static int omninet_calc_num_ports(struct usb_serial *serial,
  41                                 struct usb_serial_endpoints *epds);
  42 static int omninet_port_probe(struct usb_serial_port *port);
  43 static int omninet_port_remove(struct usb_serial_port *port);
  44
  45 static const struct usb_device_id id_table[] = {
  46         { USB_DEVICE(ZYXEL_VENDOR_ID, ZYXEL_OMNINET_ID) },
  47         { USB_DEVICE(ZYXEL_VENDOR_ID, ZYXEL_OMNI_56K_PLUS_ID) },
  48         { USB_DEVICE(ZYXEL_VENDOR_ID, BT_IGNITIONPRO_ID) },
  49         { }                                             /* Terminating entry */
  50 };
  51 MODULE_DEVICE_TABLE(usb, id_table);
  52
  53 static struct usb_serial_driver zyxel_omninet_device = {
  54         .driver = {
  55                 .owner =        THIS_MODULE,
  56                 .name =         "omninet",
  57         },
  58         .description =          "ZyXEL - omni.net lcd plus usb",
  59         .id_table =             id_table,
  60         .num_bulk_out =         2,
  61         .calc_num_ports =       omninet_calc_num_ports,
  62         .port_probe =           omninet_port_probe,
  63         .port_remove =          omninet_port_remove,
  64         .process_read_urb =     omninet_process_read_urb,
  65         .prepare_write_buffer = omninet_prepare_write_buffer,
  66 };
  67
  68 static struct usb_serial_driver * const serial_drivers[] = {
  69         &zyxel_omninet_device, NULL
  70 };
  71
  72
  73 /*
  74  * The protocol.
  75  *
  76  * The omni.net always exchange 64 bytes of data with the host. The first
  77  * four bytes are the control header.
  78  *
  79  * oh_seq is a sequence number. Don't know if/how it's used.
  80  * oh_len is the length of the data bytes in the packet.
  81  * oh_xxx Bit-mapped, related to handshaking and status info.
  82  *      I normally set it to 0x03 in transmitted frames.
  83  *      7: Active when the TA is in a CONNECTed state.
  84  *      6: unknown
  85  *      5: handshaking, unknown
  86  *      4: handshaking, unknown
  87  *      3: unknown, usually 0
  88  *      2: unknown, usually 0
  89  *      1: handshaking, unknown, usually set to 1 in transmitted frames
  90  *      0: handshaking, unknown, usually set to 1 in transmitted frames
  91  * oh_pad Probably a pad byte.
  92  *
  93  * After the header you will find data bytes if oh_len was greater than zero.
  94  */
  95 struct omninet_header {
  96         __u8    oh_seq;
  97         __u8    oh_len;
  98         __u8    oh_xxx;
  99         __u8    oh_pad;
 100 };
 101
 102 struct omninet_data {
 103         __u8    od_outseq;      /* Sequence number for bulk_out URBs */
 104 };
 105
 106 static int omninet_calc_num_ports(struct usb_serial *serial,
 107                                         struct usb_serial_endpoints *epds)
 108 {
 109         /* We need only the second bulk-out for our single-port device. */
 110         epds->bulk_out[0] = epds->bulk_out[1];
 111         epds->num_bulk_out = 1;
 112
 113         return 1;
 114 }
 115
 116 static int omninet_port_probe(struct usb_serial_port *port)
 117 {
 118         struct omninet_data *od;
 119
 120         od = kzalloc(sizeof(*od), GFP_KERNEL);
 121         if (!od)
 122                 return -ENOMEM;
 123
 124         usb_set_serial_port_data(port, od);
 125
 126         return 0;
 127 }
 128
 129 static int omninet_port_remove(struct usb_serial_port *port)
 130 {
 131         struct omninet_data *od;
 132
 133         od = usb_get_serial_port_data(port);
 134         kfree(od);
 135
 136         return 0;
 137 }
 138
 139 #define OMNINET_HEADERLEN       4
 140 #define OMNINET_BULKOUTSIZE     64
 141 #define OMNINET_PAYLOADSIZE     (OMNINET_BULKOUTSIZE - OMNINET_HEADERLEN)
 142
 143 static void omninet_process_read_urb(struct urb *urb)
 144 {
 145         struct usb_serial_port *port = urb->context;
 146         const struct omninet_header *hdr = urb->transfer_buffer;
 147         const unsigned char *data;
 148         size_t data_len;
 149
 150         if (urb->actual_length <= OMNINET_HEADERLEN || !hdr->oh_len)
 151                 return;
 152
 153         data = (char *)urb->transfer_buffer + OMNINET_HEADERLEN;
 154         data_len = min_t(size_t, urb->actual_length - OMNINET_HEADERLEN,
 155                                                                 hdr->oh_len);
 156         tty_insert_flip_string(&port->port, data, data_len);
 157         tty_flip_buffer_push(&port->port);
 158 }
 159
 160 static int omninet_prepare_write_buffer(struct usb_serial_port *port,
 161                                         void *buf, size_t count)
 162 {
 163         struct omninet_data *od = usb_get_serial_port_data(port);
 164         struct omninet_header *header = buf;
 165
 166         count = min_t(size_t, count, OMNINET_PAYLOADSIZE);
 167
 168         count = kfifo_out_locked(&port->write_fifo, buf + OMNINET_HEADERLEN,
 169                         count, &port->lock);
 170
 171         header->oh_seq = od->od_outseq++;
 172         header->oh_len = count;
 173         header->oh_xxx = 0x03;
 174         header->oh_pad = 0x00;
 175
 176         /* always 64 bytes */
 177         return OMNINET_BULKOUTSIZE;
 178 }
 179
 180 module_usb_serial_driver(serial_drivers, id_table);
 181
 182 MODULE_AUTHOR(DRIVER_AUTHOR);
 183 MODULE_DESCRIPTION(DRIVER_DESC);
 184 MODULE_LICENSE("GPL");