omninet.c 6.9 KB

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