omninet.c 7.1 KB

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