omninet.c 4.75 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
Linus Torvalds's avatar
Linus Torvalds committed
2 3 4
/*
 * USB ZyXEL omni.net LCD PLUS driver
 *
5 6
 * Copyright (C) 2013,2017 Johan Hovold <johan@kernel.org>
 *
Alan Cox's avatar
Alan Cox committed
7 8
 * See Documentation/usb/usb-serial.txt for more information on using this
 * driver
Linus Torvalds's avatar
Linus Torvalds committed
9 10 11 12 13 14 15 16 17 18 19
 *
 * 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>
Alan Cox's avatar
Alan Cox committed
20
#include <linux/uaccess.h>
Linus Torvalds's avatar
Linus Torvalds committed
21
#include <linux/usb.h>
22
#include <linux/usb/serial.h>
Linus Torvalds's avatar
Linus Torvalds committed
23 24 25 26 27 28

#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
Alan Cox's avatar
Alan Cox committed
29 30
/* This one seems to be a re-branded ZyXEL device */
#define BT_IGNITIONPRO_ID	0x2000
Linus Torvalds's avatar
Linus Torvalds committed
31 32

/* function prototypes */
33
static void omninet_process_read_urb(struct urb *urb);
34 35
static int omninet_prepare_write_buffer(struct usb_serial_port *port,
				void *buf, size_t count);
36 37
static int omninet_calc_num_ports(struct usb_serial *serial,
				struct usb_serial_endpoints *epds);
38 39
static int omninet_port_probe(struct usb_serial_port *port);
static int omninet_port_remove(struct usb_serial_port *port);
Alan Cox's avatar
Alan Cox committed
40

41
static const struct usb_device_id id_table[] = {
Linus Torvalds's avatar
Linus Torvalds committed
42 43 44 45
	{ USB_DEVICE(ZYXEL_VENDOR_ID, ZYXEL_OMNINET_ID) },
	{ USB_DEVICE(ZYXEL_VENDOR_ID, BT_IGNITIONPRO_ID) },
	{ }						/* Terminating entry */
};
Alan Cox's avatar
Alan Cox committed
46
MODULE_DEVICE_TABLE(usb, id_table);
Linus Torvalds's avatar
Linus Torvalds committed
47

48
static struct usb_serial_driver zyxel_omninet_device = {
49 50
	.driver = {
		.owner =	THIS_MODULE,
51
		.name =		"omninet",
52
	},
53
	.description =		"ZyXEL - omni.net lcd plus usb",
Linus Torvalds's avatar
Linus Torvalds committed
54
	.id_table =		id_table,
55
	.num_bulk_out =		2,
56
	.calc_num_ports =	omninet_calc_num_ports,
57 58
	.port_probe =		omninet_port_probe,
	.port_remove =		omninet_port_remove,
59
	.process_read_urb =	omninet_process_read_urb,
60
	.prepare_write_buffer =	omninet_prepare_write_buffer,
Linus Torvalds's avatar
Linus Torvalds committed
61 62
};

63 64 65 66
static struct usb_serial_driver * const serial_drivers[] = {
	&zyxel_omninet_device, NULL
};

Linus Torvalds's avatar
Linus Torvalds committed
67

68 69
/*
 * The protocol.
Linus Torvalds's avatar
Linus Torvalds committed
70 71
 *
 * The omni.net always exchange 64 bytes of data with the host. The first
72
 * four bytes are the control header.
Linus Torvalds's avatar
Linus Torvalds committed
73 74 75 76
 *
 * 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.
77
 *	I normally set it to 0x03 in transmitted frames.
Linus Torvalds's avatar
Linus Torvalds committed
78 79 80 81 82 83
 *	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
84 85
 *	1: handshaking, unknown, usually set to 1 in transmitted frames
 *	0: handshaking, unknown, usually set to 1 in transmitted frames
Linus Torvalds's avatar
Linus Torvalds committed
86 87 88 89
 * oh_pad Probably a pad byte.
 *
 * After the header you will find data bytes if oh_len was greater than zero.
 */
Alan Cox's avatar
Alan Cox committed
90
struct omninet_header {
Linus Torvalds's avatar
Linus Torvalds committed
91 92 93 94 95 96
	__u8	oh_seq;
	__u8	oh_len;
	__u8	oh_xxx;
	__u8	oh_pad;
};

Alan Cox's avatar
Alan Cox committed
97 98
struct omninet_data {
	__u8	od_outseq;	/* Sequence number for bulk_out URBs */
Linus Torvalds's avatar
Linus Torvalds committed
99 100
};

101 102 103 104 105 106 107 108 109 110
static int omninet_calc_num_ports(struct usb_serial *serial,
					struct usb_serial_endpoints *epds)
{
	/* We need only the second bulk-out for our single-port device. */
	epds->bulk_out[0] = epds->bulk_out[1];
	epds->num_bulk_out = 1;

	return 1;
}

111
static int omninet_port_probe(struct usb_serial_port *port)
112 113 114
{
	struct omninet_data *od;

115
	od = kzalloc(sizeof(*od), GFP_KERNEL);
116
	if (!od)
117
		return -ENOMEM;
118

119
	usb_set_serial_port_data(port, od);
120 121 122 123 124 125 126 127 128 129 130

	return 0;
}

static int omninet_port_remove(struct usb_serial_port *port)
{
	struct omninet_data *od;

	od = usb_get_serial_port_data(port);
	kfree(od);

131 132 133
	return 0;
}

134 135 136
#define OMNINET_HEADERLEN	4
#define OMNINET_BULKOUTSIZE	64
#define OMNINET_PAYLOADSIZE	(OMNINET_BULKOUTSIZE - OMNINET_HEADERLEN)
Linus Torvalds's avatar
Linus Torvalds committed
137

138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
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);
}

155 156
static int omninet_prepare_write_buffer(struct usb_serial_port *port,
					void *buf, size_t count)
Linus Torvalds's avatar
Linus Torvalds committed
157
{
Alan Cox's avatar
Alan Cox committed
158
	struct omninet_data *od = usb_get_serial_port_data(port);
159
	struct omninet_header *header = buf;
Linus Torvalds's avatar
Linus Torvalds committed
160

161
	count = min_t(size_t, count, OMNINET_PAYLOADSIZE);
Linus Torvalds's avatar
Linus Torvalds committed
162

163 164
	count = kfifo_out_locked(&port->write_fifo, buf + OMNINET_HEADERLEN,
			count, &port->lock);
Linus Torvalds's avatar
Linus Torvalds committed
165

166 167 168 169
	header->oh_seq = od->od_outseq++;
	header->oh_len = count;
	header->oh_xxx = 0x03;
	header->oh_pad = 0x00;
Linus Torvalds's avatar
Linus Torvalds committed
170

171 172
	/* always 64 bytes */
	return OMNINET_BULKOUTSIZE;
Linus Torvalds's avatar
Linus Torvalds committed
173 174
}

175
module_usb_serial_driver(serial_drivers, id_table);
Linus Torvalds's avatar
Linus Torvalds committed
176

Alan Cox's avatar
Alan Cox committed
177 178
MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
179
MODULE_LICENSE("GPL v2");