Release 4.9 drivers/usb/serial/omninet.c
  
  
/*
 * USB ZyXEL omni.net LCD PLUS driver
 *
 *      This program is free software; you can redistribute it and/or
 *      modify it under the terms of the GNU General Public License version
 *      2 as published by the Free Software Foundation.
 *
 * See Documentation/usb/usb-serial.txt for more information on using this
 * driver
 *
 * Please report both successes and troubles to the author at omninet@kroah.com
 */
#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/slab.h>
#include <linux/tty.h>
#include <linux/tty_driver.h>
#include <linux/tty_flip.h>
#include <linux/module.h>
#include <linux/uaccess.h>
#include <linux/usb.h>
#include <linux/usb/serial.h>
#define DRIVER_AUTHOR "Alessandro Zummo"
#define DRIVER_DESC "USB ZyXEL omni.net LCD PLUS Driver"
#define ZYXEL_VENDOR_ID		0x0586
#define ZYXEL_OMNINET_ID	0x1000
/* This one seems to be a re-branded ZyXEL device */
#define BT_IGNITIONPRO_ID	0x2000
/* function prototypes */
static int  omninet_open(struct tty_struct *tty, struct usb_serial_port *port);
static void omninet_process_read_urb(struct urb *urb);
static void omninet_write_bulk_callback(struct urb *urb);
static int  omninet_write(struct tty_struct *tty, struct usb_serial_port *port,
				const unsigned char *buf, int count);
static int  omninet_write_room(struct tty_struct *tty);
static void omninet_disconnect(struct usb_serial *serial);
static int omninet_port_probe(struct usb_serial_port *port);
static int omninet_port_remove(struct usb_serial_port *port);
static const struct usb_device_id id_table[] = {
	{ USB_DEVICE(ZYXEL_VENDOR_ID, ZYXEL_OMNINET_ID) },
	{ USB_DEVICE(ZYXEL_VENDOR_ID, BT_IGNITIONPRO_ID) },
	{ }						/* Terminating entry */
};
MODULE_DEVICE_TABLE(usb, id_table);
static struct usb_serial_driver zyxel_omninet_device = {
	.driver = {
		.owner =	THIS_MODULE,
		.name =		"omninet",
        },
	.description =		"ZyXEL - omni.net lcd plus usb",
	.id_table =		id_table,
	.num_ports =		1,
	.port_probe =		omninet_port_probe,
	.port_remove =		omninet_port_remove,
	.open =			omninet_open,
	.write =		omninet_write,
	.write_room =		omninet_write_room,
	.write_bulk_callback =	omninet_write_bulk_callback,
	.process_read_urb =	omninet_process_read_urb,
	.disconnect =		omninet_disconnect,
};
static struct usb_serial_driver * const serial_drivers[] = {
	&zyxel_omninet_device, NULL
};
/*
 * The protocol.
 *
 * The omni.net always exchange 64 bytes of data with the host. The first
 * four bytes are the control header.
 *
 * oh_seq is a sequence number. Don't know if/how it's used.
 * oh_len is the length of the data bytes in the packet.
 * oh_xxx Bit-mapped, related to handshaking and status info.
 *      I normally set it to 0x03 in transmitted frames.
 *      7: Active when the TA is in a CONNECTed state.
 *      6: unknown
 *      5: handshaking, unknown
 *      4: handshaking, unknown
 *      3: unknown, usually 0
 *      2: unknown, usually 0
 *      1: handshaking, unknown, usually set to 1 in transmitted frames
 *      0: handshaking, unknown, usually set to 1 in transmitted frames
 * oh_pad Probably a pad byte.
 *
 * After the header you will find data bytes if oh_len was greater than zero.
 */
struct omninet_header {
	
__u8	oh_seq;
	
__u8	oh_len;
	
__u8	oh_xxx;
	
__u8	oh_pad;
};
struct omninet_data {
	
__u8	od_outseq;	/* Sequence number for bulk_out URBs */
};
static int omninet_port_probe(struct usb_serial_port *port)
{
	struct omninet_data *od;
	od = kzalloc(sizeof(*od), GFP_KERNEL);
	if (!od)
		return -ENOMEM;
	usb_set_serial_port_data(port, od);
	return 0;
}
Contributors
 | Person | Tokens | Prop | Commits | CommitProp | 
| oliver neukum | oliver neukum | 33 | 68.75% | 1 | 25.00% | 
| johan hovold | johan hovold | 13 | 27.08% | 2 | 50.00% | 
| greg kroah-hartman | greg kroah-hartman | 2 | 4.17% | 1 | 25.00% | 
 | Total | 48 | 100.00% | 4 | 100.00% | 
static int omninet_port_remove(struct usb_serial_port *port)
{
	struct omninet_data *od;
	od = usb_get_serial_port_data(port);
	kfree(od);
	return 0;
}
Contributors
 | Person | Tokens | Prop | Commits | CommitProp | 
| johan hovold | johan hovold | 22 | 70.97% | 1 | 50.00% | 
| oliver neukum | oliver neukum | 9 | 29.03% | 1 | 50.00% | 
 | Total | 31 | 100.00% | 2 | 100.00% | 
static int omninet_open(struct tty_struct *tty, struct usb_serial_port *port)
{
	struct usb_serial	*serial = port->serial;
	struct usb_serial_port	*wport;
	wport = serial->port[1];
	tty_port_tty_set(&wport->port, tty);
	return usb_serial_generic_open(tty, port);
}
Contributors
 | Person | Tokens | Prop | Commits | CommitProp | 
| pre-git | pre-git | 37 | 64.91% | 2 | 25.00% | 
| alan cox | alan cox | 11 | 19.30% | 2 | 25.00% | 
| greg kroah-hartman | greg kroah-hartman | 6 | 10.53% | 3 | 37.50% | 
| johan hovold | johan hovold | 3 | 5.26% | 1 | 12.50% | 
 | Total | 57 | 100.00% | 8 | 100.00% | 
#define OMNINET_HEADERLEN	4
#define OMNINET_BULKOUTSIZE	64
#define OMNINET_PAYLOADSIZE	(OMNINET_BULKOUTSIZE - OMNINET_HEADERLEN)
static void omninet_process_read_urb(struct urb *urb)
{
	struct usb_serial_port *port = urb->context;
	const struct omninet_header *hdr = urb->transfer_buffer;
	const unsigned char *data;
	size_t data_len;
	if (urb->actual_length <= OMNINET_HEADERLEN || !hdr->oh_len)
		return;
	data = (char *)urb->transfer_buffer + OMNINET_HEADERLEN;
	data_len = min_t(size_t, urb->actual_length - OMNINET_HEADERLEN,
								hdr->oh_len);
	tty_insert_flip_string(&port->port, data, data_len);
	tty_flip_buffer_push(&port->port);
}
Contributors
 | Person | Tokens | Prop | Commits | CommitProp | 
| johan hovold | johan hovold | 72 | 70.59% | 1 | 50.00% | 
| pre-git | pre-git | 30 | 29.41% | 1 | 50.00% | 
 | Total | 102 | 100.00% | 2 | 100.00% | 
static int omninet_write(struct tty_struct *tty, struct usb_serial_port *port,
					const unsigned char *buf, int count)
{
	struct usb_serial *serial = port->serial;
	struct usb_serial_port *wport = serial->port[1];
	struct omninet_data *od = usb_get_serial_port_data(port);
	struct omninet_header *header = (struct omninet_header *)
					wport->write_urb->transfer_buffer;
	int			result;
	if (count == 0) {
		dev_dbg(&port->dev, "%s - write request of 0 bytes\n", __func__);
		return 0;
	}
	if (!test_and_clear_bit(0, &port->write_urbs_free)) {
		dev_dbg(&port->dev, "%s - already writing\n", __func__);
		return 0;
	}
	count = (count > OMNINET_PAYLOADSIZE) ? OMNINET_PAYLOADSIZE : count;
	memcpy(wport->write_urb->transfer_buffer + OMNINET_HEADERLEN,
								buf, count);
	usb_serial_debug_data(&port->dev, __func__, count,
			      wport->write_urb->transfer_buffer);
	header->oh_seq 	= od->od_outseq++;
	header->oh_len 	= count;
	header->oh_xxx  = 0x03;
	header->oh_pad 	= 0x00;
	/* send the data out the bulk port, always 64 bytes */
	wport->write_urb->transfer_buffer_length = OMNINET_BULKOUTSIZE;
	result = usb_submit_urb(wport->write_urb, GFP_ATOMIC);
	if (result) {
		set_bit(0, &wport->write_urbs_free);
		dev_err_console(port,
			"%s - failed submitting write urb, error %d\n",
			__func__, result);
	} else
		result = count;
	return result;
}
Contributors
 | Person | Tokens | Prop | Commits | CommitProp | 
| pre-git | pre-git | 170 | 66.67% | 3 | 15.79% | 
| greg kroah-hartman | greg kroah-hartman | 37 | 14.51% | 8 | 42.11% | 
| johan hovold | johan hovold | 20 | 7.84% | 3 | 15.79% | 
| linus torvalds | linus torvalds | 18 | 7.06% | 2 | 10.53% | 
| alan cox | alan cox | 5 | 1.96% | 1 | 5.26% | 
| harvey harrison | harvey harrison | 4 | 1.57% | 1 | 5.26% | 
| ganesh varadarajan | ganesh varadarajan | 1 | 0.39% | 1 | 5.26% | 
 | Total | 255 | 100.00% | 19 | 100.00% | 
static int omninet_write_room(struct tty_struct *tty)
{
	struct usb_serial_port *port = tty->driver_data;
	struct usb_serial 	*serial = port->serial;
	struct usb_serial_port 	*wport 	= serial->port[1];
	int room = 0; /* Default: no room */
	if (test_bit(0, &wport->write_urbs_free))
		room = wport->bulk_out_size - OMNINET_HEADERLEN;
	dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
	return room;
}
Contributors
 | Person | Tokens | Prop | Commits | CommitProp | 
| pre-git | pre-git | 51 | 60.71% | 1 | 14.29% | 
| greg kroah-hartman | greg kroah-hartman | 13 | 15.48% | 2 | 28.57% | 
| alan cox | alan cox | 12 | 14.29% | 2 | 28.57% | 
| johan hovold | johan hovold | 7 | 8.33% | 1 | 14.29% | 
| harvey harrison | harvey harrison | 1 | 1.19% | 1 | 14.29% | 
 | Total | 84 | 100.00% | 7 | 100.00% | 
static void omninet_write_bulk_callback(struct urb *urb)
{
/*      struct omninet_header   *header = (struct omninet_header  *)
                                                urb->transfer_buffer; */
	struct usb_serial_port 	*port   =  urb->context;
	int status = urb->status;
	set_bit(0, &port->write_urbs_free);
	if (status) {
		dev_dbg(&port->dev, "%s - nonzero write bulk status received: %d\n",
			__func__, status);
		return;
	}
	usb_serial_port_softint(port);
}
Contributors
 | Person | Tokens | Prop | Commits | CommitProp | 
| pre-git | pre-git | 36 | 56.25% | 2 | 20.00% | 
| greg kroah-hartman | greg kroah-hartman | 18 | 28.12% | 4 | 40.00% | 
| johan hovold | johan hovold | 7 | 10.94% | 1 | 10.00% | 
| alan cox | alan cox | 1 | 1.56% | 1 | 10.00% | 
| harvey harrison | harvey harrison | 1 | 1.56% | 1 | 10.00% | 
| pete zaitcev | pete zaitcev | 1 | 1.56% | 1 | 10.00% | 
 | Total | 64 | 100.00% | 10 | 100.00% | 
static void omninet_disconnect(struct usb_serial *serial)
{
	struct usb_serial_port *wport = serial->port[1];
	usb_kill_urb(wport->write_urb);
}
Contributors
 | Person | Tokens | Prop | Commits | CommitProp | 
| oliver neukum | oliver neukum | 12 | 40.00% | 1 | 33.33% | 
| alan stern | alan stern | 9 | 30.00% | 1 | 33.33% | 
| pre-git | pre-git | 9 | 30.00% | 1 | 33.33% | 
 | Total | 30 | 100.00% | 3 | 100.00% | 
module_usb_serial_driver(serial_drivers, id_table);
MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_LICENSE("GPL");
Overall Contributors
 | Person | Tokens | Prop | Commits | CommitProp | 
| pre-git | pre-git | 506 | 49.95% | 6 | 10.53% | 
| johan hovold | johan hovold | 171 | 16.88% | 9 | 15.79% | 
| greg kroah-hartman | greg kroah-hartman | 100 | 9.87% | 21 | 36.84% | 
| oliver neukum | oliver neukum | 64 | 6.32% | 1 | 1.75% | 
| linus torvalds | linus torvalds | 49 | 4.84% | 8 | 14.04% | 
| alan cox | alan cox | 44 | 4.34% | 4 | 7.02% | 
| alan stern | alan stern | 37 | 3.65% | 2 | 3.51% | 
| rusty russell | rusty russell | 19 | 1.88% | 1 | 1.75% | 
| alessandro zummo | alessandro zummo | 14 | 1.38% | 1 | 1.75% | 
| harvey harrison | harvey harrison | 6 | 0.59% | 1 | 1.75% | 
| pete zaitcev | pete zaitcev | 1 | 0.10% | 1 | 1.75% | 
| marton nemeth | marton nemeth | 1 | 0.10% | 1 | 1.75% | 
| ganesh varadarajan | ganesh varadarajan | 1 | 0.10% | 1 | 1.75% | 
 | Total | 1013 | 100.00% | 57 | 100.00% |