1 /******************************************************************************
3 * Driver for Option High Speed Mobile Devices.
5 * Copyright (C) 2008 Option International
9 * Copyright (C) 2007 Andrew Bird (Sphere Systems Ltd)
12 * Copyright (C) 2008 Novell, Inc.
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License version 2 as
16 * published by the Free Software Foundation.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
29 *****************************************************************************/
31 /******************************************************************************
33 * Description of the device:
35 * Interface 0: Contains the IP network interface on the bulk end points.
36 * The multiplexed serial ports are using the interrupt and
38 * Interrupt contains a bitmap telling which multiplexed
39 * serialport needs servicing.
41 * Interface 1: Diagnostics port, uses bulk only, do not submit urbs until the
42 * port is opened, as this have a huge impact on the network port
45 * Interface 2: Standard modem interface - circuit switched interface, this
46 * can be used to make a standard ppp connection however it
47 * should not be used in conjunction with the IP network interface
48 * enabled for USB performance reasons i.e. if using this set
49 * ideally disable_net=1.
51 *****************************************************************************/
53 #include <linux/sched.h>
54 #include <linux/slab.h>
55 #include <linux/init.h>
56 #include <linux/delay.h>
57 #include <linux/netdevice.h>
58 #include <linux/module.h>
59 #include <linux/ethtool.h>
60 #include <linux/usb.h>
61 #include <linux/timer.h>
62 #include <linux/tty.h>
63 #include <linux/tty_driver.h>
64 #include <linux/tty_flip.h>
65 #include <linux/kmod.h>
66 #include <linux/rfkill.h>
68 #include <linux/uaccess.h>
69 #include <linux/usb/cdc.h>
71 #include <asm/byteorder.h>
72 #include <linux/serial_core.h>
73 #include <linux/serial.h>
76 #define DRIVER_VERSION "1.2"
77 #define MOD_AUTHOR "Option Wireless"
78 #define MOD_DESCRIPTION "USB High Speed Option driver"
79 #define MOD_LICENSE "GPL"
81 #define HSO_MAX_NET_DEVICES 10
82 #define HSO__MAX_MTU 2048
83 #define DEFAULT_MTU 1500
84 #define DEFAULT_MRU 1500
86 #define CTRL_URB_RX_SIZE 1024
87 #define CTRL_URB_TX_SIZE 64
89 #define BULK_URB_RX_SIZE 4096
90 #define BULK_URB_TX_SIZE 8192
92 #define MUX_BULK_RX_BUF_SIZE HSO__MAX_MTU
93 #define MUX_BULK_TX_BUF_SIZE HSO__MAX_MTU
94 #define MUX_BULK_RX_BUF_COUNT 4
95 #define USB_TYPE_OPTION_VENDOR 0x20
97 /* These definitions are used with the struct hso_net flags element */
98 /* - use *_bit operations on it. (bit indices not values.) */
99 #define HSO_NET_RUNNING 0
101 #define HSO_NET_TX_TIMEOUT (HZ*10)
103 #define HSO_SERIAL_MAGIC 0x48534f31
105 /* Number of ttys to handle */
106 #define HSO_SERIAL_TTY_MINORS 256
108 #define MAX_RX_URBS 2
110 static inline struct hso_serial *get_serial_by_tty(struct tty_struct *tty)
113 return tty->driver_data;
117 /*****************************************************************************/
118 /* Debugging functions */
119 /*****************************************************************************/
120 #define D__(lvl_, fmt, arg...) \
122 printk(lvl_ "[%d:%s]: " fmt "\n", \
123 __LINE__, __func__, ## arg); \
126 #define D_(lvl, args...) \
129 D__(KERN_INFO, args); \
132 #define D1(args...) D_(0x01, ##args)
133 #define D2(args...) D_(0x02, ##args)
134 #define D3(args...) D_(0x04, ##args)
135 #define D4(args...) D_(0x08, ##args)
136 #define D5(args...) D_(0x10, ##args)
138 /*****************************************************************************/
140 /*****************************************************************************/
141 enum pkt_parse_state {
147 /*****************************************************************************/
149 /*****************************************************************************/
151 struct hso_shared_int {
152 struct usb_endpoint_descriptor *intr_endp;
153 void *shared_intr_buf;
154 struct urb *shared_intr_urb;
155 struct usb_device *usb;
158 struct mutex shared_int_lock;
162 struct hso_device *parent;
163 struct net_device *net;
164 struct rfkill *rfkill;
166 struct usb_endpoint_descriptor *in_endp;
167 struct usb_endpoint_descriptor *out_endp;
169 struct urb *mux_bulk_rx_urb_pool[MUX_BULK_RX_BUF_COUNT];
170 struct urb *mux_bulk_tx_urb;
171 void *mux_bulk_rx_buf_pool[MUX_BULK_RX_BUF_COUNT];
172 void *mux_bulk_tx_buf;
174 struct sk_buff *skb_rx_buf;
175 struct sk_buff *skb_tx_buf;
177 enum pkt_parse_state rx_parse_state;
180 unsigned short rx_buf_size;
181 unsigned short rx_buf_missing;
182 struct iphdr rx_ip_hdr;
193 #define BM_REQUEST_TYPE (0xa1)
194 #define B_NOTIFICATION (0x20)
195 #define W_VALUE (0x0)
196 #define W_INDEX (0x2)
197 #define W_LENGTH (0x2)
199 #define B_OVERRUN (0x1<<6)
200 #define B_PARITY (0x1<<5)
201 #define B_FRAMING (0x1<<4)
202 #define B_RING_SIGNAL (0x1<<3)
203 #define B_BREAK (0x1<<2)
204 #define B_TX_CARRIER (0x1<<1)
205 #define B_RX_CARRIER (0x1<<0)
207 struct hso_serial_state_notification {
213 u16 UART_state_bitmap;
214 } __attribute__((packed));
216 struct hso_tiocmget {
218 wait_queue_head_t waitq;
220 struct usb_endpoint_descriptor *endp;
222 struct hso_serial_state_notification serial_state_notification;
223 u16 prev_UART_state_bitmap;
224 struct uart_icount icount;
229 struct hso_device *parent;
233 struct hso_shared_int *shared_int;
235 /* rx/tx urb could be either a bulk urb or a control urb depending
236 on which serial port it is used on. */
237 struct urb *rx_urb[MAX_RX_URBS];
239 u8 *rx_data[MAX_RX_URBS];
240 u16 rx_data_length; /* should contain allocated length */
245 u16 tx_data_length; /* should contain allocated length */
248 struct usb_ctrlrequest ctrl_req_tx;
249 struct usb_ctrlrequest ctrl_req_rx;
251 struct usb_endpoint_descriptor *in_endp;
252 struct usb_endpoint_descriptor *out_endp;
254 enum rx_ctrl_state rx_state;
257 unsigned tx_urb_used:1;
259 /* from usb_serial_port */
260 struct tty_struct *tty;
262 spinlock_t serial_lock;
264 int (*write_data) (struct hso_serial *serial);
265 struct hso_tiocmget *tiocmget;
266 /* Hacks required to get flow control
267 * working on the serial receive buffers
268 * so as not to drop characters on the floor.
271 u16 curr_rx_urb_offset;
272 u8 rx_urb_filled[MAX_RX_URBS];
273 struct tasklet_struct unthrottle_tasklet;
274 struct work_struct retry_unthrottle_workqueue;
279 struct hso_serial *dev_serial;
280 struct hso_net *dev_net;
287 struct work_struct async_get_intf;
288 struct work_struct async_put_intf;
289 struct work_struct reset_device;
291 struct usb_device *usb;
292 struct usb_interface *interface;
299 /* Type of interface */
300 #define HSO_INTF_MASK 0xFF00
301 #define HSO_INTF_MUX 0x0100
302 #define HSO_INTF_BULK 0x0200
305 #define HSO_PORT_MASK 0xFF
306 #define HSO_PORT_NO_PORT 0x0
307 #define HSO_PORT_CONTROL 0x1
308 #define HSO_PORT_APP 0x2
309 #define HSO_PORT_GPS 0x3
310 #define HSO_PORT_PCSC 0x4
311 #define HSO_PORT_APP2 0x5
312 #define HSO_PORT_GPS_CONTROL 0x6
313 #define HSO_PORT_MSD 0x7
314 #define HSO_PORT_VOICE 0x8
315 #define HSO_PORT_DIAG2 0x9
316 #define HSO_PORT_DIAG 0x10
317 #define HSO_PORT_MODEM 0x11
318 #define HSO_PORT_NETWORK 0x12
320 /* Additional device info */
321 #define HSO_INFO_MASK 0xFF000000
322 #define HSO_INFO_CRC_BUG 0x01000000
324 /*****************************************************************************/
326 /*****************************************************************************/
327 /* Serial driver functions */
328 static int hso_serial_tiocmset(struct tty_struct *tty, struct file *file,
329 unsigned int set, unsigned int clear);
330 static void ctrl_callback(struct urb *urb);
331 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial);
332 static void hso_kick_transmit(struct hso_serial *serial);
333 /* Helper functions */
334 static int hso_mux_submit_intr_urb(struct hso_shared_int *mux_int,
335 struct usb_device *usb, gfp_t gfp);
336 static void handle_usb_error(int status, const char *function,
337 struct hso_device *hso_dev);
338 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
340 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports);
341 static void hso_free_interface(struct usb_interface *intf);
342 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags);
343 static int hso_stop_serial_device(struct hso_device *hso_dev);
344 static int hso_start_net_device(struct hso_device *hso_dev);
345 static void hso_free_shared_int(struct hso_shared_int *shared_int);
346 static int hso_stop_net_device(struct hso_device *hso_dev);
347 static void hso_serial_ref_free(struct kref *ref);
348 static void hso_std_serial_read_bulk_callback(struct urb *urb);
349 static int hso_mux_serial_read(struct hso_serial *serial);
350 static void async_get_intf(struct work_struct *data);
351 static void async_put_intf(struct work_struct *data);
352 static int hso_put_activity(struct hso_device *hso_dev);
353 static int hso_get_activity(struct hso_device *hso_dev);
354 static void tiocmget_intr_callback(struct urb *urb);
355 static void reset_device(struct work_struct *data);
356 /*****************************************************************************/
357 /* Helping functions */
358 /*****************************************************************************/
362 static inline struct hso_net *dev2net(struct hso_device *hso_dev)
364 return hso_dev->port_data.dev_net;
367 static inline struct hso_serial *dev2ser(struct hso_device *hso_dev)
369 return hso_dev->port_data.dev_serial;
372 /* Debugging functions */
374 static void dbg_dump(int line_count, const char *func_name, unsigned char *buf,
377 static char name[255];
379 sprintf(name, "hso[%d:%s]", line_count, func_name);
380 print_hex_dump_bytes(name, DUMP_PREFIX_NONE, buf, len);
383 #define DUMP(buf_, len_) \
384 dbg_dump(__LINE__, __func__, (unsigned char *)buf_, len_)
386 #define DUMP1(buf_, len_) \
392 #define DUMP(buf_, len_)
393 #define DUMP1(buf_, len_)
396 /* module parameters */
398 static int tty_major;
399 static int disable_net;
402 static const char driver_name[] = "hso";
403 static const char tty_filename[] = "ttyHS";
404 static const char *version = __FILE__ ": " DRIVER_VERSION " " MOD_AUTHOR;
405 /* the usb driver itself (registered in hso_init) */
406 static struct usb_driver hso_driver;
407 /* serial structures */
408 static struct tty_driver *tty_drv;
409 static struct hso_device *serial_table[HSO_SERIAL_TTY_MINORS];
410 static struct hso_device *network_table[HSO_MAX_NET_DEVICES];
411 static spinlock_t serial_table_lock;
413 static const s32 default_port_spec[] = {
414 HSO_INTF_MUX | HSO_PORT_NETWORK,
415 HSO_INTF_BULK | HSO_PORT_DIAG,
416 HSO_INTF_BULK | HSO_PORT_MODEM,
420 static const s32 icon321_port_spec[] = {
421 HSO_INTF_MUX | HSO_PORT_NETWORK,
422 HSO_INTF_BULK | HSO_PORT_DIAG2,
423 HSO_INTF_BULK | HSO_PORT_MODEM,
424 HSO_INTF_BULK | HSO_PORT_DIAG,
428 #define default_port_device(vendor, product) \
429 USB_DEVICE(vendor, product), \
430 .driver_info = (kernel_ulong_t)default_port_spec
432 #define icon321_port_device(vendor, product) \
433 USB_DEVICE(vendor, product), \
434 .driver_info = (kernel_ulong_t)icon321_port_spec
436 /* list of devices we support */
437 static const struct usb_device_id hso_ids[] = {
438 {default_port_device(0x0af0, 0x6711)},
439 {default_port_device(0x0af0, 0x6731)},
440 {default_port_device(0x0af0, 0x6751)},
441 {default_port_device(0x0af0, 0x6771)},
442 {default_port_device(0x0af0, 0x6791)},
443 {default_port_device(0x0af0, 0x6811)},
444 {default_port_device(0x0af0, 0x6911)},
445 {default_port_device(0x0af0, 0x6951)},
446 {default_port_device(0x0af0, 0x6971)},
447 {default_port_device(0x0af0, 0x7011)},
448 {default_port_device(0x0af0, 0x7031)},
449 {default_port_device(0x0af0, 0x7051)},
450 {default_port_device(0x0af0, 0x7071)},
451 {default_port_device(0x0af0, 0x7111)},
452 {default_port_device(0x0af0, 0x7211)},
453 {default_port_device(0x0af0, 0x7251)},
454 {default_port_device(0x0af0, 0x7271)},
455 {default_port_device(0x0af0, 0x7311)},
456 {default_port_device(0x0af0, 0xc031)}, /* Icon-Edge */
457 {icon321_port_device(0x0af0, 0xd013)}, /* Module HSxPA */
458 {icon321_port_device(0x0af0, 0xd031)}, /* Icon-321 */
459 {icon321_port_device(0x0af0, 0xd033)}, /* Icon-322 */
460 {USB_DEVICE(0x0af0, 0x7301)}, /* GE40x */
461 {USB_DEVICE(0x0af0, 0x7361)}, /* GE40x */
462 {USB_DEVICE(0x0af0, 0x7381)}, /* GE40x */
463 {USB_DEVICE(0x0af0, 0x7401)}, /* GI 0401 */
464 {USB_DEVICE(0x0af0, 0x7501)}, /* GTM 382 */
465 {USB_DEVICE(0x0af0, 0x7601)}, /* GE40x */
466 {USB_DEVICE(0x0af0, 0x7701)},
467 {USB_DEVICE(0x0af0, 0x7706)},
468 {USB_DEVICE(0x0af0, 0x7801)},
469 {USB_DEVICE(0x0af0, 0x7901)},
470 {USB_DEVICE(0x0af0, 0x7A01)},
471 {USB_DEVICE(0x0af0, 0x7A05)},
472 {USB_DEVICE(0x0af0, 0x8200)},
473 {USB_DEVICE(0x0af0, 0x8201)},
474 {USB_DEVICE(0x0af0, 0x8300)},
475 {USB_DEVICE(0x0af0, 0x8302)},
476 {USB_DEVICE(0x0af0, 0x8304)},
477 {USB_DEVICE(0x0af0, 0x8400)},
478 {USB_DEVICE(0x0af0, 0xd035)},
479 {USB_DEVICE(0x0af0, 0xd055)},
480 {USB_DEVICE(0x0af0, 0xd155)},
481 {USB_DEVICE(0x0af0, 0xd255)},
482 {USB_DEVICE(0x0af0, 0xd057)},
483 {USB_DEVICE(0x0af0, 0xd157)},
484 {USB_DEVICE(0x0af0, 0xd257)},
485 {USB_DEVICE(0x0af0, 0xd357)},
486 {USB_DEVICE(0x0af0, 0xd058)},
487 {USB_DEVICE(0x0af0, 0xc100)},
490 MODULE_DEVICE_TABLE(usb, hso_ids);
492 /* Sysfs attribute */
493 static ssize_t hso_sysfs_show_porttype(struct device *dev,
494 struct device_attribute *attr,
497 struct hso_device *hso_dev = dev_get_drvdata(dev);
503 switch (hso_dev->port_spec & HSO_PORT_MASK) {
504 case HSO_PORT_CONTROL:
505 port_name = "Control";
508 port_name = "Application";
511 port_name = "Application2";
516 case HSO_PORT_GPS_CONTROL:
517 port_name = "GPS Control";
523 port_name = "Diagnostic";
526 port_name = "Diagnostic2";
531 case HSO_PORT_NETWORK:
532 port_name = "Network";
535 port_name = "Unknown";
539 return sprintf(buf, "%s\n", port_name);
541 static DEVICE_ATTR(hsotype, S_IRUGO, hso_sysfs_show_porttype, NULL);
543 static int hso_urb_to_index(struct hso_serial *serial, struct urb *urb)
547 for (idx = 0; idx < serial->num_rx_urbs; idx++)
548 if (serial->rx_urb[idx] == urb)
550 dev_err(serial->parent->dev, "hso_urb_to_index failed\n");
554 /* converts mux value to a port spec value */
555 static u32 hso_mux_to_port(int mux)
561 result = HSO_PORT_CONTROL;
564 result = HSO_PORT_APP;
567 result = HSO_PORT_PCSC;
570 result = HSO_PORT_GPS;
573 result = HSO_PORT_APP2;
576 result = HSO_PORT_NO_PORT;
581 /* converts port spec value to a mux value */
582 static u32 hso_port_to_mux(int port)
586 switch (port & HSO_PORT_MASK) {
587 case HSO_PORT_CONTROL:
608 static struct hso_serial *get_serial_by_shared_int_and_type(
609 struct hso_shared_int *shared_int,
614 port = hso_mux_to_port(mux);
616 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
617 if (serial_table[i] &&
618 (dev2ser(serial_table[i])->shared_int == shared_int) &&
619 ((serial_table[i]->port_spec & HSO_PORT_MASK) == port)) {
620 return dev2ser(serial_table[i]);
627 static struct hso_serial *get_serial_by_index(unsigned index)
629 struct hso_serial *serial = NULL;
632 spin_lock_irqsave(&serial_table_lock, flags);
633 if (serial_table[index])
634 serial = dev2ser(serial_table[index]);
635 spin_unlock_irqrestore(&serial_table_lock, flags);
640 static int get_free_serial_index(void)
645 spin_lock_irqsave(&serial_table_lock, flags);
646 for (index = 0; index < HSO_SERIAL_TTY_MINORS; index++) {
647 if (serial_table[index] == NULL) {
648 spin_unlock_irqrestore(&serial_table_lock, flags);
652 spin_unlock_irqrestore(&serial_table_lock, flags);
654 printk(KERN_ERR "%s: no free serial devices in table\n", __func__);
658 static void set_serial_by_index(unsigned index, struct hso_serial *serial)
662 spin_lock_irqsave(&serial_table_lock, flags);
664 serial_table[index] = serial->parent;
666 serial_table[index] = NULL;
667 spin_unlock_irqrestore(&serial_table_lock, flags);
670 static void handle_usb_error(int status, const char *function,
671 struct hso_device *hso_dev)
677 explanation = "no device";
680 explanation = "endpoint not enabled";
683 explanation = "endpoint stalled";
686 explanation = "not enough bandwidth";
689 explanation = "device disabled";
692 explanation = "device suspended";
698 explanation = "internal error";
704 explanation = "protocol error";
706 schedule_work(&hso_dev->reset_device);
709 explanation = "unknown status";
713 /* log a meaningful explanation of an USB status */
714 D1("%s: received USB status - %s (%d)", function, explanation, status);
717 /* Network interface functions */
719 /* called when net interface is brought up by ifconfig */
720 static int hso_net_open(struct net_device *net)
722 struct hso_net *odev = netdev_priv(net);
723 unsigned long flags = 0;
726 dev_err(&net->dev, "No net device !\n");
730 odev->skb_tx_buf = NULL;
732 /* setup environment */
733 spin_lock_irqsave(&odev->net_lock, flags);
734 odev->rx_parse_state = WAIT_IP;
735 odev->rx_buf_size = 0;
736 odev->rx_buf_missing = sizeof(struct iphdr);
737 spin_unlock_irqrestore(&odev->net_lock, flags);
739 /* We are up and running. */
740 set_bit(HSO_NET_RUNNING, &odev->flags);
741 hso_start_net_device(odev->parent);
743 /* Tell the kernel we are ready to start receiving from it */
744 netif_start_queue(net);
749 /* called when interface is brought down by ifconfig */
750 static int hso_net_close(struct net_device *net)
752 struct hso_net *odev = netdev_priv(net);
754 /* we don't need the queue anymore */
755 netif_stop_queue(net);
756 /* no longer running */
757 clear_bit(HSO_NET_RUNNING, &odev->flags);
759 hso_stop_net_device(odev->parent);
765 /* USB tells is xmit done, we should start the netqueue again */
766 static void write_bulk_callback(struct urb *urb)
768 struct hso_net *odev = urb->context;
769 int status = urb->status;
772 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
773 dev_err(&urb->dev->dev, "%s: device not running\n", __func__);
777 /* Do we still have a valid kernel network device? */
778 if (!netif_device_present(odev->net)) {
779 dev_err(&urb->dev->dev, "%s: net device not present\n",
784 /* log status, but don't act on it, we don't need to resubmit anything
787 handle_usb_error(status, __func__, odev->parent);
789 hso_put_activity(odev->parent);
791 /* Tell the network interface we are ready for another frame */
792 netif_wake_queue(odev->net);
795 /* called by kernel when we need to transmit a packet */
796 static netdev_tx_t hso_net_start_xmit(struct sk_buff *skb,
797 struct net_device *net)
799 struct hso_net *odev = netdev_priv(net);
802 /* Tell the kernel, "No more frames 'til we are done with this one." */
803 netif_stop_queue(net);
804 if (hso_get_activity(odev->parent) == -EAGAIN) {
805 odev->skb_tx_buf = skb;
810 DUMP1(skb->data, skb->len);
811 /* Copy it from kernel memory to OUR memory */
812 memcpy(odev->mux_bulk_tx_buf, skb->data, skb->len);
813 D1("len: %d/%d", skb->len, MUX_BULK_TX_BUF_SIZE);
815 /* Fill in the URB for shipping it out. */
816 usb_fill_bulk_urb(odev->mux_bulk_tx_urb,
818 usb_sndbulkpipe(odev->parent->usb,
820 bEndpointAddress & 0x7F),
821 odev->mux_bulk_tx_buf, skb->len, write_bulk_callback,
824 /* Deal with the Zero Length packet problem, I hope */
825 odev->mux_bulk_tx_urb->transfer_flags |= URB_ZERO_PACKET;
827 /* Send the URB on its merry way. */
828 result = usb_submit_urb(odev->mux_bulk_tx_urb, GFP_ATOMIC);
830 dev_warn(&odev->parent->interface->dev,
831 "failed mux_bulk_tx_urb %d\n", result);
832 net->stats.tx_errors++;
833 netif_start_queue(net);
835 net->stats.tx_packets++;
836 net->stats.tx_bytes += skb->len;
837 /* And tell the kernel when the last transmit started. */
838 net->trans_start = jiffies;
845 static void hso_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *info)
847 struct hso_net *odev = netdev_priv(net);
849 strncpy(info->driver, driver_name, ETHTOOL_BUSINFO_LEN);
850 strncpy(info->version, DRIVER_VERSION, ETHTOOL_BUSINFO_LEN);
851 usb_make_path(odev->parent->usb, info->bus_info, sizeof info->bus_info);
854 static const struct ethtool_ops ops = {
855 .get_drvinfo = hso_get_drvinfo,
856 .get_link = ethtool_op_get_link
859 /* called when a packet did not ack after watchdogtimeout */
860 static void hso_net_tx_timeout(struct net_device *net)
862 struct hso_net *odev = netdev_priv(net);
867 /* Tell syslog we are hosed. */
868 dev_warn(&net->dev, "Tx timed out.\n");
870 /* Tear the waiting frame off the list */
871 if (odev->mux_bulk_tx_urb &&
872 (odev->mux_bulk_tx_urb->status == -EINPROGRESS))
873 usb_unlink_urb(odev->mux_bulk_tx_urb);
875 /* Update statistics */
876 net->stats.tx_errors++;
879 /* make a real packet from the received USB buffer */
880 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt,
881 unsigned int count, unsigned char is_eop)
883 unsigned short temp_bytes;
884 unsigned short buffer_offset = 0;
885 unsigned short frame_len;
886 unsigned char *tmp_rx_buf;
889 D1("Rx %d bytes", count);
890 DUMP(ip_pkt, min(128, (int)count));
893 switch (odev->rx_parse_state) {
895 /* waiting for IP header. */
896 /* wanted bytes - size of ip header */
899 odev->rx_buf_missing) ? count : odev->
902 memcpy(((unsigned char *)(&odev->rx_ip_hdr)) +
903 odev->rx_buf_size, ip_pkt + buffer_offset,
906 odev->rx_buf_size += temp_bytes;
907 buffer_offset += temp_bytes;
908 odev->rx_buf_missing -= temp_bytes;
911 if (!odev->rx_buf_missing) {
912 /* header is complete allocate an sk_buffer and
913 * continue to WAIT_DATA */
914 frame_len = ntohs(odev->rx_ip_hdr.tot_len);
916 if ((frame_len > DEFAULT_MRU) ||
917 (frame_len < sizeof(struct iphdr))) {
918 dev_err(&odev->net->dev,
919 "Invalid frame (%d) length\n",
921 odev->rx_parse_state = WAIT_SYNC;
924 /* Allocate an sk_buff */
925 odev->skb_rx_buf = netdev_alloc_skb(odev->net,
927 if (!odev->skb_rx_buf) {
928 /* We got no receive buffer. */
929 D1("could not allocate memory");
930 odev->rx_parse_state = WAIT_SYNC;
934 /* Copy what we got so far. make room for iphdr
937 skb_put(odev->skb_rx_buf,
938 sizeof(struct iphdr));
939 memcpy(tmp_rx_buf, (char *)&(odev->rx_ip_hdr),
940 sizeof(struct iphdr));
943 odev->rx_buf_size = sizeof(struct iphdr);
945 /* Filip actually use .tot_len */
946 odev->rx_buf_missing =
947 frame_len - sizeof(struct iphdr);
948 odev->rx_parse_state = WAIT_DATA;
953 temp_bytes = (count < odev->rx_buf_missing)
954 ? count : odev->rx_buf_missing;
956 /* Copy the rest of the bytes that are left in the
957 * buffer into the waiting sk_buf. */
958 /* Make room for temp_bytes after tail. */
959 tmp_rx_buf = skb_put(odev->skb_rx_buf, temp_bytes);
960 memcpy(tmp_rx_buf, ip_pkt + buffer_offset, temp_bytes);
962 odev->rx_buf_missing -= temp_bytes;
964 buffer_offset += temp_bytes;
965 odev->rx_buf_size += temp_bytes;
966 if (!odev->rx_buf_missing) {
967 /* Packet is complete. Inject into stack. */
968 /* We have IP packet here */
969 odev->skb_rx_buf->protocol = cpu_to_be16(ETH_P_IP);
971 odev->skb_rx_buf->ip_summed =
972 CHECKSUM_UNNECESSARY;
974 skb_reset_mac_header(odev->skb_rx_buf);
976 /* Ship it off to the kernel */
977 netif_rx(odev->skb_rx_buf);
978 /* No longer our buffer. */
979 odev->skb_rx_buf = NULL;
981 /* update out statistics */
982 odev->net->stats.rx_packets++;
984 odev->net->stats.rx_bytes += odev->rx_buf_size;
986 odev->rx_buf_size = 0;
987 odev->rx_buf_missing = sizeof(struct iphdr);
988 odev->rx_parse_state = WAIT_IP;
1003 /* Recovery mechanism for WAIT_SYNC state. */
1005 if (odev->rx_parse_state == WAIT_SYNC) {
1006 odev->rx_parse_state = WAIT_IP;
1007 odev->rx_buf_size = 0;
1008 odev->rx_buf_missing = sizeof(struct iphdr);
1013 /* Moving data from usb to kernel (in interrupt state) */
1014 static void read_bulk_callback(struct urb *urb)
1016 struct hso_net *odev = urb->context;
1017 struct net_device *net;
1019 int status = urb->status;
1021 /* is al ok? (Filip: Who's Al ?) */
1023 handle_usb_error(status, __func__, odev->parent);
1028 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
1029 D1("BULK IN callback but driver is not active!");
1032 usb_mark_last_busy(urb->dev);
1036 if (!netif_device_present(net)) {
1037 /* Somebody killed our network interface... */
1041 if (odev->parent->port_spec & HSO_INFO_CRC_BUG) {
1043 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1044 rest = urb->actual_length %
1045 le16_to_cpu(odev->in_endp->wMaxPacketSize);
1046 if (((rest == 5) || (rest == 6)) &&
1047 !memcmp(((u8 *) urb->transfer_buffer) +
1048 urb->actual_length - 4, crc_check, 4)) {
1049 urb->actual_length -= 4;
1053 /* do we even have a packet? */
1054 if (urb->actual_length) {
1055 /* Handle the IP stream, add header and push it onto network
1056 * stack if the packet is complete. */
1057 spin_lock(&odev->net_lock);
1058 packetizeRx(odev, urb->transfer_buffer, urb->actual_length,
1059 (urb->transfer_buffer_length >
1060 urb->actual_length) ? 1 : 0);
1061 spin_unlock(&odev->net_lock);
1064 /* We are done with this URB, resubmit it. Prep the USB to wait for
1065 * another frame. Reuse same as received. */
1066 usb_fill_bulk_urb(urb,
1068 usb_rcvbulkpipe(odev->parent->usb,
1070 bEndpointAddress & 0x7F),
1071 urb->transfer_buffer, MUX_BULK_RX_BUF_SIZE,
1072 read_bulk_callback, odev);
1074 /* Give this to the USB subsystem so it can tell us when more data
1076 result = usb_submit_urb(urb, GFP_ATOMIC);
1078 dev_warn(&odev->parent->interface->dev,
1079 "%s failed submit mux_bulk_rx_urb %d\n", __func__,
1083 /* Serial driver functions */
1085 static void hso_init_termios(struct ktermios *termios)
1088 * The default requirements for this device are:
1091 ~(IGNBRK /* disable ignore break */
1092 | BRKINT /* disable break causes interrupt */
1093 | PARMRK /* disable mark parity errors */
1094 | ISTRIP /* disable clear high bit of input characters */
1095 | INLCR /* disable translate NL to CR */
1096 | IGNCR /* disable ignore CR */
1097 | ICRNL /* disable translate CR to NL */
1098 | IXON); /* disable enable XON/XOFF flow control */
1100 /* disable postprocess output characters */
1101 termios->c_oflag &= ~OPOST;
1104 ~(ECHO /* disable echo input characters */
1105 | ECHONL /* disable echo new line */
1106 | ICANON /* disable erase, kill, werase, and rprnt
1107 special characters */
1108 | ISIG /* disable interrupt, quit, and suspend special
1110 | IEXTEN); /* disable non-POSIX special characters */
1113 ~(CSIZE /* no size */
1114 | PARENB /* disable parity bit */
1115 | CBAUD /* clear current baud rate */
1116 | CBAUDEX); /* clear current buad rate */
1118 termios->c_cflag |= CS8; /* character size 8 bits */
1120 /* baud rate 115200 */
1121 tty_termios_encode_baud_rate(termios, 115200, 115200);
1124 static void _hso_serial_set_termios(struct tty_struct *tty,
1125 struct ktermios *old)
1127 struct hso_serial *serial = get_serial_by_tty(tty);
1128 struct ktermios *termios;
1131 printk(KERN_ERR "%s: no tty structures", __func__);
1135 D4("port %d", serial->minor);
1138 * Fix up unsupported bits
1140 termios = tty->termios;
1141 termios->c_iflag &= ~IXON; /* disable enable XON/XOFF flow control */
1144 ~(CSIZE /* no size */
1145 | PARENB /* disable parity bit */
1146 | CBAUD /* clear current baud rate */
1147 | CBAUDEX); /* clear current buad rate */
1149 termios->c_cflag |= CS8; /* character size 8 bits */
1151 /* baud rate 115200 */
1152 tty_encode_baud_rate(tty, 115200, 115200);
1155 static void hso_resubmit_rx_bulk_urb(struct hso_serial *serial, struct urb *urb)
1158 /* We are done with this URB, resubmit it. Prep the USB to wait for
1160 usb_fill_bulk_urb(urb, serial->parent->usb,
1161 usb_rcvbulkpipe(serial->parent->usb,
1163 bEndpointAddress & 0x7F),
1164 urb->transfer_buffer, serial->rx_data_length,
1165 hso_std_serial_read_bulk_callback, serial);
1166 /* Give this to the USB subsystem so it can tell us when more data
1168 result = usb_submit_urb(urb, GFP_ATOMIC);
1170 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1178 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1181 struct urb *curr_urb;
1183 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1184 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1185 count = put_rxbuf_data(curr_urb, serial);
1189 serial->curr_rx_urb_idx++;
1190 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1191 serial->curr_rx_urb_idx = 0;
1192 hso_resubmit_rx_bulk_urb(serial, curr_urb);
1197 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1202 urb = serial->rx_urb[0];
1203 if (serial->open_count > 0) {
1204 count = put_rxbuf_data(urb, serial);
1208 /* Re issue a read as long as we receive data. */
1210 if (count == 0 && ((urb->actual_length != 0) ||
1211 (serial->rx_state == RX_PENDING))) {
1212 serial->rx_state = RX_SENT;
1213 hso_mux_serial_read(serial);
1215 serial->rx_state = RX_IDLE;
1219 /* read callback for Diag and CS port */
1220 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1222 struct hso_serial *serial = urb->context;
1223 int status = urb->status;
1227 D1("serial == NULL");
1229 } else if (status) {
1230 handle_usb_error(status, __func__, serial->parent);
1234 D4("\n--- Got serial_read_bulk callback %02x ---", status);
1235 D1("Actual length = %d\n", urb->actual_length);
1236 DUMP1(urb->transfer_buffer, urb->actual_length);
1238 /* Anyone listening? */
1239 if (serial->open_count == 0)
1243 if (serial->parent->port_spec & HSO_INFO_CRC_BUG) {
1245 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1247 urb->actual_length %
1248 le16_to_cpu(serial->in_endp->wMaxPacketSize);
1249 if (((rest == 5) || (rest == 6)) &&
1250 !memcmp(((u8 *) urb->transfer_buffer) +
1251 urb->actual_length - 4, crc_check, 4)) {
1252 urb->actual_length -= 4;
1255 /* Valid data, handle RX data */
1256 spin_lock(&serial->serial_lock);
1257 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1258 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1259 spin_unlock(&serial->serial_lock);
1260 } else if (status == -ENOENT || status == -ECONNRESET) {
1261 /* Unlinked - check for throttled port. */
1262 D2("Port %d, successfully unlinked urb", serial->minor);
1263 spin_lock(&serial->serial_lock);
1264 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
1265 hso_resubmit_rx_bulk_urb(serial, urb);
1266 spin_unlock(&serial->serial_lock);
1268 D2("Port %d, status = %d for read urb", serial->minor, status);
1274 * This needs to be a tasklet otherwise we will
1275 * end up recursively calling this function.
1277 static void hso_unthrottle_tasklet(struct hso_serial *serial)
1279 unsigned long flags;
1281 spin_lock_irqsave(&serial->serial_lock, flags);
1282 if ((serial->parent->port_spec & HSO_INTF_MUX))
1283 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1285 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1286 spin_unlock_irqrestore(&serial->serial_lock, flags);
1289 static void hso_unthrottle(struct tty_struct *tty)
1291 struct hso_serial *serial = get_serial_by_tty(tty);
1293 tasklet_hi_schedule(&serial->unthrottle_tasklet);
1296 static void hso_unthrottle_workfunc(struct work_struct *work)
1298 struct hso_serial *serial =
1299 container_of(work, struct hso_serial,
1300 retry_unthrottle_workqueue);
1301 hso_unthrottle_tasklet(serial);
1304 /* open the requested serial port */
1305 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1307 struct hso_serial *serial = get_serial_by_index(tty->index);
1311 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1313 tty->driver_data = NULL;
1314 D1("Failed to open port");
1318 mutex_lock(&serial->parent->mutex);
1319 result = usb_autopm_get_interface(serial->parent->interface);
1323 D1("Opening %d", serial->minor);
1324 kref_get(&serial->parent->ref);
1327 spin_lock_irq(&serial->serial_lock);
1328 tty->driver_data = serial;
1329 tty_kref_put(serial->tty);
1330 serial->tty = tty_kref_get(tty);
1331 spin_unlock_irq(&serial->serial_lock);
1333 /* check for port already opened, if not set the termios */
1334 serial->open_count++;
1335 if (serial->open_count == 1) {
1336 tty->low_latency = 1;
1337 serial->rx_state = RX_IDLE;
1338 /* Force default termio settings */
1339 _hso_serial_set_termios(tty, NULL);
1340 tasklet_init(&serial->unthrottle_tasklet,
1341 (void (*)(unsigned long))hso_unthrottle_tasklet,
1342 (unsigned long)serial);
1343 INIT_WORK(&serial->retry_unthrottle_workqueue,
1344 hso_unthrottle_workfunc);
1345 result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1347 hso_stop_serial_device(serial->parent);
1348 serial->open_count--;
1349 kref_put(&serial->parent->ref, hso_serial_ref_free);
1352 D1("Port was already open");
1355 usb_autopm_put_interface(serial->parent->interface);
1359 hso_serial_tiocmset(tty, NULL, TIOCM_RTS | TIOCM_DTR, 0);
1361 mutex_unlock(&serial->parent->mutex);
1365 /* close the requested serial port */
1366 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1368 struct hso_serial *serial = tty->driver_data;
1371 D1("Closing serial port");
1373 /* Open failed, no close cleanup required */
1377 mutex_lock(&serial->parent->mutex);
1378 usb_gone = serial->parent->usb_gone;
1381 usb_autopm_get_interface(serial->parent->interface);
1383 /* reset the rts and dtr */
1384 /* do the actual close */
1385 serial->open_count--;
1387 if (serial->open_count <= 0) {
1388 serial->open_count = 0;
1389 spin_lock_irq(&serial->serial_lock);
1390 if (serial->tty == tty) {
1391 serial->tty->driver_data = NULL;
1395 spin_unlock_irq(&serial->serial_lock);
1397 hso_stop_serial_device(serial->parent);
1398 tasklet_kill(&serial->unthrottle_tasklet);
1399 cancel_work_sync(&serial->retry_unthrottle_workqueue);
1403 usb_autopm_put_interface(serial->parent->interface);
1405 mutex_unlock(&serial->parent->mutex);
1407 kref_put(&serial->parent->ref, hso_serial_ref_free);
1410 /* close the requested serial port */
1411 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1414 struct hso_serial *serial = get_serial_by_tty(tty);
1415 int space, tx_bytes;
1416 unsigned long flags;
1419 if (serial == NULL) {
1420 printk(KERN_ERR "%s: serial is NULL\n", __func__);
1424 spin_lock_irqsave(&serial->serial_lock, flags);
1426 space = serial->tx_data_length - serial->tx_buffer_count;
1427 tx_bytes = (count < space) ? count : space;
1432 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1433 serial->tx_buffer_count += tx_bytes;
1436 spin_unlock_irqrestore(&serial->serial_lock, flags);
1438 hso_kick_transmit(serial);
1443 /* how much room is there for writing */
1444 static int hso_serial_write_room(struct tty_struct *tty)
1446 struct hso_serial *serial = get_serial_by_tty(tty);
1448 unsigned long flags;
1450 spin_lock_irqsave(&serial->serial_lock, flags);
1451 room = serial->tx_data_length - serial->tx_buffer_count;
1452 spin_unlock_irqrestore(&serial->serial_lock, flags);
1454 /* return free room */
1458 /* setup the term */
1459 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1461 struct hso_serial *serial = get_serial_by_tty(tty);
1462 unsigned long flags;
1465 D5("Termios called with: cflags new[%d] - old[%d]",
1466 tty->termios->c_cflag, old->c_cflag);
1468 /* the actual setup */
1469 spin_lock_irqsave(&serial->serial_lock, flags);
1470 if (serial->open_count)
1471 _hso_serial_set_termios(tty, old);
1474 spin_unlock_irqrestore(&serial->serial_lock, flags);
1480 /* how many characters in the buffer */
1481 static int hso_serial_chars_in_buffer(struct tty_struct *tty)
1483 struct hso_serial *serial = get_serial_by_tty(tty);
1485 unsigned long flags;
1491 spin_lock_irqsave(&serial->serial_lock, flags);
1492 chars = serial->tx_buffer_count;
1493 spin_unlock_irqrestore(&serial->serial_lock, flags);
1497 static int tiocmget_submit_urb(struct hso_serial *serial,
1498 struct hso_tiocmget *tiocmget,
1499 struct usb_device *usb)
1503 if (serial->parent->usb_gone)
1505 usb_fill_int_urb(tiocmget->urb, usb,
1508 bEndpointAddress & 0x7F),
1509 &tiocmget->serial_state_notification,
1510 sizeof(struct hso_serial_state_notification),
1511 tiocmget_intr_callback, serial,
1512 tiocmget->endp->bInterval);
1513 result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC);
1515 dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__,
1522 static void tiocmget_intr_callback(struct urb *urb)
1524 struct hso_serial *serial = urb->context;
1525 struct hso_tiocmget *tiocmget;
1526 int status = urb->status;
1527 u16 UART_state_bitmap, prev_UART_state_bitmap;
1528 struct uart_icount *icount;
1529 struct hso_serial_state_notification *serial_state_notification;
1530 struct usb_device *usb;
1536 handle_usb_error(status, __func__, serial->parent);
1539 tiocmget = serial->tiocmget;
1542 usb = serial->parent->usb;
1543 serial_state_notification = &tiocmget->serial_state_notification;
1544 if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1545 serial_state_notification->bNotification != B_NOTIFICATION ||
1546 le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1547 le16_to_cpu(serial_state_notification->wIndex) != W_INDEX ||
1548 le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1550 "hso received invalid serial state notification\n");
1551 DUMP(serial_state_notification,
1552 sizeof(struct hso_serial_state_notification));
1555 UART_state_bitmap = le16_to_cpu(serial_state_notification->
1557 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1558 icount = &tiocmget->icount;
1559 spin_lock(&serial->serial_lock);
1560 if ((UART_state_bitmap & B_OVERRUN) !=
1561 (prev_UART_state_bitmap & B_OVERRUN))
1563 if ((UART_state_bitmap & B_PARITY) !=
1564 (prev_UART_state_bitmap & B_PARITY))
1566 if ((UART_state_bitmap & B_FRAMING) !=
1567 (prev_UART_state_bitmap & B_FRAMING))
1569 if ((UART_state_bitmap & B_RING_SIGNAL) &&
1570 !(prev_UART_state_bitmap & B_RING_SIGNAL))
1572 if ((UART_state_bitmap & B_BREAK) !=
1573 (prev_UART_state_bitmap & B_BREAK))
1575 if ((UART_state_bitmap & B_TX_CARRIER) !=
1576 (prev_UART_state_bitmap & B_TX_CARRIER))
1578 if ((UART_state_bitmap & B_RX_CARRIER) !=
1579 (prev_UART_state_bitmap & B_RX_CARRIER))
1581 tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1582 spin_unlock(&serial->serial_lock);
1583 tiocmget->intr_completed = 1;
1584 wake_up_interruptible(&tiocmget->waitq);
1586 memset(serial_state_notification, 0,
1587 sizeof(struct hso_serial_state_notification));
1588 tiocmget_submit_urb(serial,
1590 serial->parent->usb);
1594 * next few functions largely stolen from drivers/serial/serial_core.c
1596 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1597 * - mask passed in arg for lines of interest
1598 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1599 * Caller should use TIOCGICOUNT to see which one it was
1602 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1604 DECLARE_WAITQUEUE(wait, current);
1605 struct uart_icount cprev, cnow;
1606 struct hso_tiocmget *tiocmget;
1609 tiocmget = serial->tiocmget;
1613 * note the counters on entry
1615 spin_lock_irq(&serial->serial_lock);
1616 memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1617 spin_unlock_irq(&serial->serial_lock);
1618 add_wait_queue(&tiocmget->waitq, &wait);
1620 spin_lock_irq(&serial->serial_lock);
1621 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1622 spin_unlock_irq(&serial->serial_lock);
1623 set_current_state(TASK_INTERRUPTIBLE);
1624 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1625 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1626 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd))) {
1631 /* see if a signal did it */
1632 if (signal_pending(current)) {
1638 current->state = TASK_RUNNING;
1639 remove_wait_queue(&tiocmget->waitq, &wait);
1645 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1646 * Return: write counters to the user passed counter struct
1647 * NB: both 1->0 and 0->1 transitions are counted except for
1648 * RI where only 0->1 is counted.
1650 static int hso_get_count(struct hso_serial *serial,
1651 struct serial_icounter_struct __user *icnt)
1653 struct serial_icounter_struct icount;
1654 struct uart_icount cnow;
1655 struct hso_tiocmget *tiocmget = serial->tiocmget;
1659 spin_lock_irq(&serial->serial_lock);
1660 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1661 spin_unlock_irq(&serial->serial_lock);
1663 icount.cts = cnow.cts;
1664 icount.dsr = cnow.dsr;
1665 icount.rng = cnow.rng;
1666 icount.dcd = cnow.dcd;
1667 icount.rx = cnow.rx;
1668 icount.tx = cnow.tx;
1669 icount.frame = cnow.frame;
1670 icount.overrun = cnow.overrun;
1671 icount.parity = cnow.parity;
1672 icount.brk = cnow.brk;
1673 icount.buf_overrun = cnow.buf_overrun;
1675 return copy_to_user(icnt, &icount, sizeof(icount)) ? -EFAULT : 0;
1679 static int hso_serial_tiocmget(struct tty_struct *tty, struct file *file)
1682 struct hso_serial *serial = get_serial_by_tty(tty);
1683 struct hso_tiocmget *tiocmget;
1684 u16 UART_state_bitmap;
1688 D1("no tty structures");
1691 spin_lock_irq(&serial->serial_lock);
1692 retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1693 ((serial->dtr_state) ? TIOCM_DTR : 0);
1694 tiocmget = serial->tiocmget;
1697 UART_state_bitmap = le16_to_cpu(
1698 tiocmget->prev_UART_state_bitmap);
1699 if (UART_state_bitmap & B_RING_SIGNAL)
1700 retval |= TIOCM_RNG;
1701 if (UART_state_bitmap & B_RX_CARRIER)
1703 if (UART_state_bitmap & B_TX_CARRIER)
1704 retval |= TIOCM_DSR;
1706 spin_unlock_irq(&serial->serial_lock);
1710 static int hso_serial_tiocmset(struct tty_struct *tty, struct file *file,
1711 unsigned int set, unsigned int clear)
1714 unsigned long flags;
1716 struct hso_serial *serial = get_serial_by_tty(tty);
1720 D1("no tty structures");
1724 if ((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM)
1727 if_num = serial->parent->interface->altsetting->desc.bInterfaceNumber;
1729 spin_lock_irqsave(&serial->serial_lock, flags);
1730 if (set & TIOCM_RTS)
1731 serial->rts_state = 1;
1732 if (set & TIOCM_DTR)
1733 serial->dtr_state = 1;
1735 if (clear & TIOCM_RTS)
1736 serial->rts_state = 0;
1737 if (clear & TIOCM_DTR)
1738 serial->dtr_state = 0;
1740 if (serial->dtr_state)
1742 if (serial->rts_state)
1745 spin_unlock_irqrestore(&serial->serial_lock, flags);
1747 return usb_control_msg(serial->parent->usb,
1748 usb_rcvctrlpipe(serial->parent->usb, 0), 0x22,
1749 0x21, val, if_num, NULL, 0,
1750 USB_CTRL_SET_TIMEOUT);
1753 static int hso_serial_ioctl(struct tty_struct *tty, struct file *file,
1754 unsigned int cmd, unsigned long arg)
1756 struct hso_serial *serial = get_serial_by_tty(tty);
1757 void __user *uarg = (void __user *)arg;
1759 D4("IOCTL cmd: %d, arg: %ld", cmd, arg);
1765 ret = hso_wait_modem_status(serial, arg);
1769 ret = hso_get_count(serial, uarg);
1779 /* starts a transmit */
1780 static void hso_kick_transmit(struct hso_serial *serial)
1783 unsigned long flags;
1786 spin_lock_irqsave(&serial->serial_lock, flags);
1787 if (!serial->tx_buffer_count)
1790 if (serial->tx_urb_used)
1793 /* Wakeup USB interface if necessary */
1794 if (hso_get_activity(serial->parent) == -EAGAIN)
1797 /* Switch pointers around to avoid memcpy */
1798 temp = serial->tx_buffer;
1799 serial->tx_buffer = serial->tx_data;
1800 serial->tx_data = temp;
1801 serial->tx_data_count = serial->tx_buffer_count;
1802 serial->tx_buffer_count = 0;
1804 /* If temp is set, it means we switched buffers */
1805 if (temp && serial->write_data) {
1806 res = serial->write_data(serial);
1808 serial->tx_urb_used = 1;
1811 spin_unlock_irqrestore(&serial->serial_lock, flags);
1814 /* make a request (for reading and writing data to muxed serial port) */
1815 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1816 struct urb *ctrl_urb,
1817 struct usb_ctrlrequest *ctrl_req,
1818 u8 *ctrl_urb_data, u32 size)
1824 if (!serial || !ctrl_urb || !ctrl_req) {
1825 printk(KERN_ERR "%s: Wrong arguments\n", __func__);
1830 ctrl_req->wValue = 0;
1831 ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1832 ctrl_req->wLength = cpu_to_le16(size);
1834 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1835 /* Reading command */
1836 ctrl_req->bRequestType = USB_DIR_IN |
1837 USB_TYPE_OPTION_VENDOR |
1838 USB_RECIP_INTERFACE;
1839 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1840 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1842 /* Writing command */
1843 ctrl_req->bRequestType = USB_DIR_OUT |
1844 USB_TYPE_OPTION_VENDOR |
1845 USB_RECIP_INTERFACE;
1846 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1847 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1850 D2("%s command (%02x) len: %d, port: %d",
1851 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1852 ctrl_req->bRequestType, ctrl_req->wLength, port);
1855 ctrl_urb->transfer_flags = 0;
1856 usb_fill_control_urb(ctrl_urb,
1857 serial->parent->usb,
1860 ctrl_urb_data, size, ctrl_callback, serial);
1861 /* Send it on merry way */
1862 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1864 dev_err(&ctrl_urb->dev->dev,
1865 "%s failed submit ctrl_urb %d type %d\n", __func__,
1874 /* called by intr_callback when read occurs */
1875 static int hso_mux_serial_read(struct hso_serial *serial)
1881 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1882 /* make the request */
1884 if (serial->num_rx_urbs != 1) {
1885 dev_err(&serial->parent->interface->dev,
1886 "ERROR: mux'd reads with multiple buffers "
1890 return mux_device_request(serial,
1891 USB_CDC_GET_ENCAPSULATED_RESPONSE,
1892 serial->parent->port_spec & HSO_PORT_MASK,
1894 &serial->ctrl_req_rx,
1895 serial->rx_data[0], serial->rx_data_length);
1898 /* used for muxed serial port callback (muxed serial read) */
1899 static void intr_callback(struct urb *urb)
1901 struct hso_shared_int *shared_int = urb->context;
1902 struct hso_serial *serial;
1903 unsigned char *port_req;
1904 int status = urb->status;
1907 usb_mark_last_busy(urb->dev);
1915 handle_usb_error(status, __func__, NULL);
1918 D4("\n--- Got intr callback 0x%02X ---", status);
1921 port_req = urb->transfer_buffer;
1922 D4(" port_req = 0x%.2X\n", *port_req);
1923 /* loop over all muxed ports to find the one sending this */
1924 for (i = 0; i < 8; i++) {
1925 /* max 8 channels on MUX */
1926 if (*port_req & (1 << i)) {
1927 serial = get_serial_by_shared_int_and_type(shared_int,
1929 if (serial != NULL) {
1930 D1("Pending read interrupt on port %d\n", i);
1931 spin_lock(&serial->serial_lock);
1932 if (serial->rx_state == RX_IDLE &&
1933 serial->open_count > 0) {
1934 /* Setup and send a ctrl req read on
1936 if (!serial->rx_urb_filled[0]) {
1937 serial->rx_state = RX_SENT;
1938 hso_mux_serial_read(serial);
1940 serial->rx_state = RX_PENDING;
1942 D1("Already a read pending on "
1943 "port %d or port not open\n", i);
1945 spin_unlock(&serial->serial_lock);
1949 /* Resubmit interrupt urb */
1950 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1953 /* called for writing to muxed serial port */
1954 static int hso_mux_serial_write_data(struct hso_serial *serial)
1959 return mux_device_request(serial,
1960 USB_CDC_SEND_ENCAPSULATED_COMMAND,
1961 serial->parent->port_spec & HSO_PORT_MASK,
1963 &serial->ctrl_req_tx,
1964 serial->tx_data, serial->tx_data_count);
1967 /* write callback for Diag and CS port */
1968 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1970 struct hso_serial *serial = urb->context;
1971 int status = urb->status;
1972 struct tty_struct *tty;
1976 D1("serial == NULL");
1980 spin_lock(&serial->serial_lock);
1981 serial->tx_urb_used = 0;
1982 tty = tty_kref_get(serial->tty);
1983 spin_unlock(&serial->serial_lock);
1985 handle_usb_error(status, __func__, serial->parent);
1989 hso_put_activity(serial->parent);
1994 hso_kick_transmit(serial);
2000 /* called for writing diag or CS serial port */
2001 static int hso_std_serial_write_data(struct hso_serial *serial)
2003 int count = serial->tx_data_count;
2006 usb_fill_bulk_urb(serial->tx_urb,
2007 serial->parent->usb,
2008 usb_sndbulkpipe(serial->parent->usb,
2010 bEndpointAddress & 0x7F),
2011 serial->tx_data, serial->tx_data_count,
2012 hso_std_serial_write_bulk_callback, serial);
2014 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
2016 dev_warn(&serial->parent->usb->dev,
2017 "Failed to submit urb - res %d\n", result);
2024 /* callback after read or write on muxed serial port */
2025 static void ctrl_callback(struct urb *urb)
2027 struct hso_serial *serial = urb->context;
2028 struct usb_ctrlrequest *req;
2029 int status = urb->status;
2030 struct tty_struct *tty;
2036 spin_lock(&serial->serial_lock);
2037 serial->tx_urb_used = 0;
2038 tty = tty_kref_get(serial->tty);
2039 spin_unlock(&serial->serial_lock);
2041 handle_usb_error(status, __func__, serial->parent);
2047 req = (struct usb_ctrlrequest *)(urb->setup_packet);
2048 D4("\n--- Got muxed ctrl callback 0x%02X ---", status);
2049 D4("Actual length of urb = %d\n", urb->actual_length);
2050 DUMP1(urb->transfer_buffer, urb->actual_length);
2052 if (req->bRequestType ==
2053 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
2054 /* response to a read command */
2055 serial->rx_urb_filled[0] = 1;
2056 spin_lock(&serial->serial_lock);
2057 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
2058 spin_unlock(&serial->serial_lock);
2060 hso_put_activity(serial->parent);
2063 /* response to a write command */
2064 hso_kick_transmit(serial);
2069 /* handle RX data for serial port */
2070 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
2072 struct tty_struct *tty;
2073 int write_length_remaining = 0;
2077 if (urb == NULL || serial == NULL) {
2078 D1("serial = NULL");
2082 /* All callers to put_rxbuf_data hold serial_lock */
2083 tty = tty_kref_get(serial->tty);
2085 /* Push data to tty */
2087 write_length_remaining = urb->actual_length -
2088 serial->curr_rx_urb_offset;
2089 D1("data to push to tty");
2090 while (write_length_remaining) {
2091 if (test_bit(TTY_THROTTLED, &tty->flags)) {
2095 curr_write_len = tty_insert_flip_string
2096 (tty, urb->transfer_buffer +
2097 serial->curr_rx_urb_offset,
2098 write_length_remaining);
2099 serial->curr_rx_urb_offset += curr_write_len;
2100 write_length_remaining -= curr_write_len;
2101 tty_flip_buffer_push(tty);
2104 if (write_length_remaining == 0) {
2105 serial->curr_rx_urb_offset = 0;
2106 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2109 return write_length_remaining;
2113 /* Base driver functions */
2115 static void hso_log_port(struct hso_device *hso_dev)
2120 switch (hso_dev->port_spec & HSO_PORT_MASK) {
2121 case HSO_PORT_CONTROL:
2122 port_type = "Control";
2125 port_type = "Application";
2130 case HSO_PORT_GPS_CONTROL:
2131 port_type = "GPS control";
2134 port_type = "Application2";
2140 port_type = "Diagnostic";
2142 case HSO_PORT_DIAG2:
2143 port_type = "Diagnostic2";
2145 case HSO_PORT_MODEM:
2146 port_type = "Modem";
2148 case HSO_PORT_NETWORK:
2149 port_type = "Network";
2152 port_type = "Unknown";
2155 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2156 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2158 sprintf(port_dev, "/dev/%s%d", tty_filename,
2159 dev2ser(hso_dev)->minor);
2161 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2162 port_type, port_dev);
2165 static int hso_start_net_device(struct hso_device *hso_dev)
2168 struct hso_net *hso_net = dev2net(hso_dev);
2173 /* send URBs for all read buffers */
2174 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2176 /* Prep a receive URB */
2177 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2179 usb_rcvbulkpipe(hso_dev->usb,
2181 bEndpointAddress & 0x7F),
2182 hso_net->mux_bulk_rx_buf_pool[i],
2183 MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2186 /* Put it out there so the device can send us stuff */
2187 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2190 dev_warn(&hso_dev->usb->dev,
2191 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2198 static int hso_stop_net_device(struct hso_device *hso_dev)
2201 struct hso_net *hso_net = dev2net(hso_dev);
2206 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2207 if (hso_net->mux_bulk_rx_urb_pool[i])
2208 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2211 if (hso_net->mux_bulk_tx_urb)
2212 usb_kill_urb(hso_net->mux_bulk_tx_urb);
2217 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2220 struct hso_serial *serial = dev2ser(hso_dev);
2225 /* If it is not the MUX port fill in and submit a bulk urb (already
2226 * allocated in hso_serial_start) */
2227 if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2228 for (i = 0; i < serial->num_rx_urbs; i++) {
2229 usb_fill_bulk_urb(serial->rx_urb[i],
2230 serial->parent->usb,
2231 usb_rcvbulkpipe(serial->parent->usb,
2236 serial->rx_data_length,
2237 hso_std_serial_read_bulk_callback,
2239 result = usb_submit_urb(serial->rx_urb[i], flags);
2241 dev_warn(&serial->parent->usb->dev,
2242 "Failed to submit urb - res %d\n",
2248 mutex_lock(&serial->shared_int->shared_int_lock);
2249 if (!serial->shared_int->use_count) {
2251 hso_mux_submit_intr_urb(serial->shared_int,
2252 hso_dev->usb, flags);
2254 serial->shared_int->use_count++;
2255 mutex_unlock(&serial->shared_int->shared_int_lock);
2257 if (serial->tiocmget)
2258 tiocmget_submit_urb(serial,
2260 serial->parent->usb);
2264 static int hso_stop_serial_device(struct hso_device *hso_dev)
2267 struct hso_serial *serial = dev2ser(hso_dev);
2268 struct hso_tiocmget *tiocmget;
2273 for (i = 0; i < serial->num_rx_urbs; i++) {
2274 if (serial->rx_urb[i]) {
2275 usb_kill_urb(serial->rx_urb[i]);
2276 serial->rx_urb_filled[i] = 0;
2279 serial->curr_rx_urb_idx = 0;
2280 serial->curr_rx_urb_offset = 0;
2283 usb_kill_urb(serial->tx_urb);
2285 if (serial->shared_int) {
2286 mutex_lock(&serial->shared_int->shared_int_lock);
2287 if (serial->shared_int->use_count &&
2288 (--serial->shared_int->use_count == 0)) {
2291 urb = serial->shared_int->shared_intr_urb;
2295 mutex_unlock(&serial->shared_int->shared_int_lock);
2297 tiocmget = serial->tiocmget;
2299 wake_up_interruptible(&tiocmget->waitq);
2300 usb_kill_urb(tiocmget->urb);
2306 static void hso_serial_common_free(struct hso_serial *serial)
2310 if (serial->parent->dev)
2311 device_remove_file(serial->parent->dev, &dev_attr_hsotype);
2313 tty_unregister_device(tty_drv, serial->minor);
2315 for (i = 0; i < serial->num_rx_urbs; i++) {
2316 /* unlink and free RX URB */
2317 usb_free_urb(serial->rx_urb[i]);
2318 /* free the RX buffer */
2319 kfree(serial->rx_data[i]);
2322 /* unlink and free TX URB */
2323 usb_free_urb(serial->tx_urb);
2324 kfree(serial->tx_data);
2327 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
2328 int rx_size, int tx_size)
2334 minor = get_free_serial_index();
2338 /* register our minor number */
2339 serial->parent->dev = tty_register_device(tty_drv, minor,
2340 &serial->parent->interface->dev);
2341 dev = serial->parent->dev;
2342 dev_set_drvdata(dev, serial->parent);
2343 i = device_create_file(dev, &dev_attr_hsotype);
2345 /* fill in specific data for later use */
2346 serial->minor = minor;
2347 serial->magic = HSO_SERIAL_MAGIC;
2348 spin_lock_init(&serial->serial_lock);
2349 serial->num_rx_urbs = num_urbs;
2351 /* RX, allocate urb and initialize */
2353 /* prepare our RX buffer */
2354 serial->rx_data_length = rx_size;
2355 for (i = 0; i < serial->num_rx_urbs; i++) {
2356 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2357 if (!serial->rx_urb[i]) {
2358 dev_err(dev, "Could not allocate urb?\n");
2361 serial->rx_urb[i]->transfer_buffer = NULL;
2362 serial->rx_urb[i]->transfer_buffer_length = 0;
2363 serial->rx_data[i] = kzalloc(serial->rx_data_length,
2365 if (!serial->rx_data[i]) {
2366 dev_err(dev, "%s - Out of memory\n", __func__);
2371 /* TX, allocate urb and initialize */
2372 serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2373 if (!serial->tx_urb) {
2374 dev_err(dev, "Could not allocate urb?\n");
2377 serial->tx_urb->transfer_buffer = NULL;
2378 serial->tx_urb->transfer_buffer_length = 0;
2379 /* prepare our TX buffer */
2380 serial->tx_data_count = 0;
2381 serial->tx_buffer_count = 0;
2382 serial->tx_data_length = tx_size;
2383 serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2384 if (!serial->tx_data) {
2385 dev_err(dev, "%s - Out of memory\n", __func__);
2388 serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2389 if (!serial->tx_buffer) {
2390 dev_err(dev, "%s - Out of memory\n", __func__);
2396 hso_serial_common_free(serial);
2400 /* Creates a general hso device */
2401 static struct hso_device *hso_create_device(struct usb_interface *intf,
2404 struct hso_device *hso_dev;
2406 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2410 hso_dev->port_spec = port_spec;
2411 hso_dev->usb = interface_to_usbdev(intf);
2412 hso_dev->interface = intf;
2413 kref_init(&hso_dev->ref);
2414 mutex_init(&hso_dev->mutex);
2416 INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2417 INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2418 INIT_WORK(&hso_dev->reset_device, reset_device);
2423 /* Removes a network device in the network device table */
2424 static int remove_net_device(struct hso_device *hso_dev)
2428 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2429 if (network_table[i] == hso_dev) {
2430 network_table[i] = NULL;
2434 if (i == HSO_MAX_NET_DEVICES)
2439 /* Frees our network device */
2440 static void hso_free_net_device(struct hso_device *hso_dev)
2443 struct hso_net *hso_net = dev2net(hso_dev);
2448 remove_net_device(hso_net->parent);
2451 unregister_netdev(hso_net->net);
2452 free_netdev(hso_net->net);
2456 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2457 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2458 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2459 hso_net->mux_bulk_rx_buf_pool[i] = NULL;
2461 usb_free_urb(hso_net->mux_bulk_tx_urb);
2462 kfree(hso_net->mux_bulk_tx_buf);
2463 hso_net->mux_bulk_tx_buf = NULL;
2468 static const struct net_device_ops hso_netdev_ops = {
2469 .ndo_open = hso_net_open,
2470 .ndo_stop = hso_net_close,
2471 .ndo_start_xmit = hso_net_start_xmit,
2472 .ndo_tx_timeout = hso_net_tx_timeout,
2475 /* initialize the network interface */
2476 static void hso_net_init(struct net_device *net)
2478 struct hso_net *hso_net = netdev_priv(net);
2480 D1("sizeof hso_net is %d", (int)sizeof(*hso_net));
2482 /* fill in the other fields */
2483 net->netdev_ops = &hso_netdev_ops;
2484 net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2485 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2486 net->type = ARPHRD_NONE;
2487 net->mtu = DEFAULT_MTU - 14;
2488 net->tx_queue_len = 10;
2489 SET_ETHTOOL_OPS(net, &ops);
2491 /* and initialize the semaphore */
2492 spin_lock_init(&hso_net->net_lock);
2495 /* Adds a network device in the network device table */
2496 static int add_net_device(struct hso_device *hso_dev)
2500 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2501 if (network_table[i] == NULL) {
2502 network_table[i] = hso_dev;
2506 if (i == HSO_MAX_NET_DEVICES)
2511 static int hso_rfkill_set_block(void *data, bool blocked)
2513 struct hso_device *hso_dev = data;
2514 int enabled = !blocked;
2517 mutex_lock(&hso_dev->mutex);
2518 if (hso_dev->usb_gone)
2521 rv = usb_control_msg(hso_dev->usb, usb_rcvctrlpipe(hso_dev->usb, 0),
2522 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2523 USB_CTRL_SET_TIMEOUT);
2524 mutex_unlock(&hso_dev->mutex);
2528 static const struct rfkill_ops hso_rfkill_ops = {
2529 .set_block = hso_rfkill_set_block,
2532 /* Creates and sets up everything for rfkill */
2533 static void hso_create_rfkill(struct hso_device *hso_dev,
2534 struct usb_interface *interface)
2536 struct hso_net *hso_net = dev2net(hso_dev);
2537 struct device *dev = &hso_net->net->dev;
2540 rfkn = kzalloc(20, GFP_KERNEL);
2542 dev_err(dev, "%s - Out of memory\n", __func__);
2544 snprintf(rfkn, 20, "hso-%d",
2545 interface->altsetting->desc.bInterfaceNumber);
2547 hso_net->rfkill = rfkill_alloc(rfkn,
2548 &interface_to_usbdev(interface)->dev,
2550 &hso_rfkill_ops, hso_dev);
2551 if (!hso_net->rfkill) {
2552 dev_err(dev, "%s - Out of memory\n", __func__);
2556 if (rfkill_register(hso_net->rfkill) < 0) {
2557 rfkill_destroy(hso_net->rfkill);
2559 hso_net->rfkill = NULL;
2560 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2565 static struct device_type hso_type = {
2569 /* Creates our network device */
2570 static struct hso_device *hso_create_net_device(struct usb_interface *interface,
2574 struct net_device *net;
2575 struct hso_net *hso_net;
2576 struct hso_device *hso_dev;
2578 hso_dev = hso_create_device(interface, port_spec);
2582 /* allocate our network device, then we can put in our private data */
2583 /* call hso_net_init to do the basic initialization */
2584 net = alloc_netdev(sizeof(struct hso_net), "hso%d", hso_net_init);
2586 dev_err(&interface->dev, "Unable to create ethernet device\n");
2590 hso_net = netdev_priv(net);
2592 hso_dev->port_data.dev_net = hso_net;
2594 hso_net->parent = hso_dev;
2596 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2598 if (!hso_net->in_endp) {
2599 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2602 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2604 if (!hso_net->out_endp) {
2605 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2608 SET_NETDEV_DEV(net, &interface->dev);
2609 SET_NETDEV_DEVTYPE(net, &hso_type);
2611 /* registering our net device */
2612 result = register_netdev(net);
2614 dev_err(&interface->dev, "Failed to register device\n");
2618 /* start allocating */
2619 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2620 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2621 if (!hso_net->mux_bulk_rx_urb_pool[i]) {
2622 dev_err(&interface->dev, "Could not allocate rx urb\n");
2625 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2627 if (!hso_net->mux_bulk_rx_buf_pool[i]) {
2628 dev_err(&interface->dev, "Could not allocate rx buf\n");
2632 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2633 if (!hso_net->mux_bulk_tx_urb) {
2634 dev_err(&interface->dev, "Could not allocate tx urb\n");
2637 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2638 if (!hso_net->mux_bulk_tx_buf) {
2639 dev_err(&interface->dev, "Could not allocate tx buf\n");
2643 add_net_device(hso_dev);
2645 hso_log_port(hso_dev);
2647 hso_create_rfkill(hso_dev, interface);
2651 hso_free_net_device(hso_dev);
2655 static void hso_free_tiomget(struct hso_serial *serial)
2657 struct hso_tiocmget *tiocmget = serial->tiocmget;
2659 if (tiocmget->urb) {
2660 usb_free_urb(tiocmget->urb);
2661 tiocmget->urb = NULL;
2663 serial->tiocmget = NULL;
2669 /* Frees an AT channel ( goes for both mux and non-mux ) */
2670 static void hso_free_serial_device(struct hso_device *hso_dev)
2672 struct hso_serial *serial = dev2ser(hso_dev);
2676 set_serial_by_index(serial->minor, NULL);
2678 hso_serial_common_free(serial);
2680 if (serial->shared_int) {
2681 mutex_lock(&serial->shared_int->shared_int_lock);
2682 if (--serial->shared_int->ref_count == 0)
2683 hso_free_shared_int(serial->shared_int);
2685 mutex_unlock(&serial->shared_int->shared_int_lock);
2687 hso_free_tiomget(serial);
2692 /* Creates a bulk AT channel */
2693 static struct hso_device *hso_create_bulk_serial_device(
2694 struct usb_interface *interface, int port)
2696 struct hso_device *hso_dev;
2697 struct hso_serial *serial;
2699 struct hso_tiocmget *tiocmget;
2701 hso_dev = hso_create_device(interface, port);
2705 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2709 serial->parent = hso_dev;
2710 hso_dev->port_data.dev_serial = serial;
2712 if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2714 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2716 /* it isn't going to break our heart if serial->tiocmget
2717 * allocation fails don't bother checking this.
2719 if (serial->tiocmget) {
2720 tiocmget = serial->tiocmget;
2721 tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2722 if (tiocmget->urb) {
2723 mutex_init(&tiocmget->mutex);
2724 init_waitqueue_head(&tiocmget->waitq);
2725 tiocmget->endp = hso_get_ep(
2727 USB_ENDPOINT_XFER_INT,
2730 hso_free_tiomget(serial);
2736 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2740 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2742 if (!serial->in_endp) {
2743 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2749 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2750 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2754 serial->write_data = hso_std_serial_write_data;
2756 /* and record this serial */
2757 set_serial_by_index(serial->minor, serial);
2759 /* setup the proc dirs and files if needed */
2760 hso_log_port(hso_dev);
2762 /* done, return it */
2766 hso_serial_common_free(serial);
2768 hso_free_tiomget(serial);
2774 /* Creates a multiplexed AT channel */
2776 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2778 struct hso_shared_int *mux)
2780 struct hso_device *hso_dev;
2781 struct hso_serial *serial;
2784 port_spec = HSO_INTF_MUX;
2785 port_spec &= ~HSO_PORT_MASK;
2787 port_spec |= hso_mux_to_port(port);
2788 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2791 hso_dev = hso_create_device(interface, port_spec);
2795 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2799 hso_dev->port_data.dev_serial = serial;
2800 serial->parent = hso_dev;
2802 if (hso_serial_common_create
2803 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2806 serial->tx_data_length--;
2807 serial->write_data = hso_mux_serial_write_data;
2809 serial->shared_int = mux;
2810 mutex_lock(&serial->shared_int->shared_int_lock);
2811 serial->shared_int->ref_count++;
2812 mutex_unlock(&serial->shared_int->shared_int_lock);
2814 /* and record this serial */
2815 set_serial_by_index(serial->minor, serial);
2817 /* setup the proc dirs and files if needed */
2818 hso_log_port(hso_dev);
2820 /* done, return it */
2825 tty_unregister_device(tty_drv, serial->minor);
2834 static void hso_free_shared_int(struct hso_shared_int *mux)
2836 usb_free_urb(mux->shared_intr_urb);
2837 kfree(mux->shared_intr_buf);
2838 mutex_unlock(&mux->shared_int_lock);
2843 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2845 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2850 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2852 if (!mux->intr_endp) {
2853 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2857 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2858 if (!mux->shared_intr_urb) {
2859 dev_err(&interface->dev, "Could not allocate intr urb?\n");
2862 mux->shared_intr_buf =
2863 kzalloc(le16_to_cpu(mux->intr_endp->wMaxPacketSize),
2865 if (!mux->shared_intr_buf) {
2866 dev_err(&interface->dev, "Could not allocate intr buf?\n");
2870 mutex_init(&mux->shared_int_lock);
2875 kfree(mux->shared_intr_buf);
2876 usb_free_urb(mux->shared_intr_urb);
2881 /* Gets the port spec for a certain interface */
2882 static int hso_get_config_data(struct usb_interface *interface)
2884 struct usb_device *usbdev = interface_to_usbdev(interface);
2886 u32 if_num = interface->altsetting->desc.bInterfaceNumber;
2889 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2890 0x86, 0xC0, 0, 0, config_data, 17,
2891 USB_CTRL_SET_TIMEOUT) != 0x11) {
2895 switch (config_data[if_num]) {
2900 result = HSO_PORT_DIAG;
2903 result = HSO_PORT_GPS;
2906 result = HSO_PORT_GPS_CONTROL;
2909 result = HSO_PORT_APP;
2912 result = HSO_PORT_APP2;
2915 result = HSO_PORT_CONTROL;
2918 result = HSO_PORT_NETWORK;
2921 result = HSO_PORT_MODEM;
2924 result = HSO_PORT_MSD;
2927 result = HSO_PORT_PCSC;
2930 result = HSO_PORT_VOICE;
2937 result |= HSO_INTF_BULK;
2939 if (config_data[16] & 0x1)
2940 result |= HSO_INFO_CRC_BUG;
2945 /* called once for each interface upon device insertion */
2946 static int hso_probe(struct usb_interface *interface,
2947 const struct usb_device_id *id)
2949 int mux, i, if_num, port_spec;
2950 unsigned char port_mask;
2951 struct hso_device *hso_dev = NULL;
2952 struct hso_shared_int *shared_int;
2953 struct hso_device *tmp_dev = NULL;
2955 if_num = interface->altsetting->desc.bInterfaceNumber;
2957 /* Get the interface/port specification from either driver_info or from
2958 * the device itself */
2959 if (id->driver_info)
2960 port_spec = ((u32 *)(id->driver_info))[if_num];
2962 port_spec = hso_get_config_data(interface);
2964 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2965 dev_err(&interface->dev, "Not our interface\n");
2968 /* Check if we need to switch to alt interfaces prior to port
2970 if (interface->num_altsetting > 1)
2971 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2972 interface->needs_remote_wakeup = 1;
2974 /* Allocate new hso device(s) */
2975 switch (port_spec & HSO_INTF_MASK) {
2977 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2978 /* Create the network device */
2980 hso_dev = hso_create_net_device(interface,
2988 if (hso_get_mux_ports(interface, &port_mask))
2989 /* TODO: de-allocate everything */
2992 shared_int = hso_create_shared_int(interface);
2996 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2997 if (port_mask & i) {
2998 hso_dev = hso_create_mux_serial_device(
2999 interface, i, shared_int);
3010 /* It's a regular bulk interface */
3011 if (((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) &&
3013 hso_dev = hso_create_net_device(interface, port_spec);
3016 hso_create_bulk_serial_device(interface, port_spec);
3024 /* save our data pointer in this device */
3025 usb_set_intfdata(interface, hso_dev);
3030 hso_free_interface(interface);
3034 /* device removed, cleaning up */
3035 static void hso_disconnect(struct usb_interface *interface)
3037 hso_free_interface(interface);
3039 /* remove reference of our private data */
3040 usb_set_intfdata(interface, NULL);
3043 static void async_get_intf(struct work_struct *data)
3045 struct hso_device *hso_dev =
3046 container_of(data, struct hso_device, async_get_intf);
3047 usb_autopm_get_interface(hso_dev->interface);
3050 static void async_put_intf(struct work_struct *data)
3052 struct hso_device *hso_dev =
3053 container_of(data, struct hso_device, async_put_intf);
3054 usb_autopm_put_interface(hso_dev->interface);
3057 static int hso_get_activity(struct hso_device *hso_dev)
3059 if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
3060 if (!hso_dev->is_active) {
3061 hso_dev->is_active = 1;
3062 schedule_work(&hso_dev->async_get_intf);
3066 if (hso_dev->usb->state != USB_STATE_CONFIGURED)
3069 usb_mark_last_busy(hso_dev->usb);
3074 static int hso_put_activity(struct hso_device *hso_dev)
3076 if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
3077 if (hso_dev->is_active) {
3078 hso_dev->is_active = 0;
3079 schedule_work(&hso_dev->async_put_intf);
3083 hso_dev->is_active = 0;
3087 /* called by kernel when we need to suspend device */
3088 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3092 /* Stop all serial ports */
3093 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3094 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3095 result = hso_stop_serial_device(serial_table[i]);
3101 /* Stop all network ports */
3102 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3103 if (network_table[i] &&
3104 (network_table[i]->interface == iface)) {
3105 result = hso_stop_net_device(network_table[i]);
3115 /* called by kernel when we need to resume device */
3116 static int hso_resume(struct usb_interface *iface)
3119 struct hso_net *hso_net;
3121 /* Start all serial ports */
3122 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3123 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3124 if (dev2ser(serial_table[i])->open_count) {
3126 hso_start_serial_device(serial_table[i], GFP_NOIO);
3127 hso_kick_transmit(dev2ser(serial_table[i]));
3134 /* Start all network ports */
3135 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3136 if (network_table[i] &&
3137 (network_table[i]->interface == iface)) {
3138 hso_net = dev2net(network_table[i]);
3139 if (hso_net->flags & IFF_UP) {
3140 /* First transmit any lingering data,
3141 then restart the device. */
3142 if (hso_net->skb_tx_buf) {
3143 dev_dbg(&iface->dev,
3145 " lingering data\n");
3146 hso_net_start_xmit(hso_net->skb_tx_buf,
3148 hso_net->skb_tx_buf = NULL;
3150 result = hso_start_net_device(network_table[i]);
3161 static void reset_device(struct work_struct *data)
3163 struct hso_device *hso_dev =
3164 container_of(data, struct hso_device, reset_device);
3165 struct usb_device *usb = hso_dev->usb;
3168 if (hso_dev->usb_gone) {
3169 D1("No reset during disconnect\n");
3171 result = usb_lock_device_for_reset(usb, hso_dev->interface);
3173 D1("unable to lock device for reset: %d\n", result);
3175 usb_reset_device(usb);
3176 usb_unlock_device(usb);
3181 static void hso_serial_ref_free(struct kref *ref)
3183 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3185 hso_free_serial_device(hso_dev);
3188 static void hso_free_interface(struct usb_interface *interface)
3190 struct hso_serial *hso_dev;
3191 struct tty_struct *tty;
3194 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3195 if (serial_table[i] &&
3196 (serial_table[i]->interface == interface)) {
3197 hso_dev = dev2ser(serial_table[i]);
3198 spin_lock_irq(&hso_dev->serial_lock);
3199 tty = tty_kref_get(hso_dev->tty);
3200 spin_unlock_irq(&hso_dev->serial_lock);
3203 mutex_lock(&hso_dev->parent->mutex);
3205 hso_dev->parent->usb_gone = 1;
3206 mutex_unlock(&hso_dev->parent->mutex);
3207 kref_put(&serial_table[i]->ref, hso_serial_ref_free);
3211 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3212 if (network_table[i] &&
3213 (network_table[i]->interface == interface)) {
3214 struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3215 /* hso_stop_net_device doesn't stop the net queue since
3216 * traffic needs to start it again when suspended */
3217 netif_stop_queue(dev2net(network_table[i])->net);
3218 hso_stop_net_device(network_table[i]);
3219 cancel_work_sync(&network_table[i]->async_put_intf);
3220 cancel_work_sync(&network_table[i]->async_get_intf);
3222 rfkill_unregister(rfk);
3223 rfkill_destroy(rfk);
3225 hso_free_net_device(network_table[i]);
3230 /* Helper functions */
3232 /* Get the endpoint ! */
3233 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3237 struct usb_host_interface *iface = intf->cur_altsetting;
3238 struct usb_endpoint_descriptor *endp;
3240 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3241 endp = &iface->endpoint[i].desc;
3242 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3243 (usb_endpoint_type(endp) == type))
3250 /* Get the byte that describes which ports are enabled */
3251 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3254 struct usb_host_interface *iface = intf->cur_altsetting;
3256 if (iface->extralen == 3) {
3257 *ports = iface->extra[2];
3261 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3262 if (iface->endpoint[i].extralen == 3) {
3263 *ports = iface->endpoint[i].extra[2];
3271 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3272 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3273 struct usb_device *usb, gfp_t gfp)
3277 usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3279 shared_int->intr_endp->bEndpointAddress & 0x7F),
3280 shared_int->shared_intr_buf,
3282 intr_callback, shared_int,
3283 shared_int->intr_endp->bInterval);
3285 result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3287 dev_warn(&usb->dev, "%s failed mux_intr_urb %d\n", __func__,
3293 /* operations setup of the serial interface */
3294 static const struct tty_operations hso_serial_ops = {
3295 .open = hso_serial_open,
3296 .close = hso_serial_close,
3297 .write = hso_serial_write,
3298 .write_room = hso_serial_write_room,
3299 .ioctl = hso_serial_ioctl,
3300 .set_termios = hso_serial_set_termios,
3301 .chars_in_buffer = hso_serial_chars_in_buffer,
3302 .tiocmget = hso_serial_tiocmget,
3303 .tiocmset = hso_serial_tiocmset,
3304 .unthrottle = hso_unthrottle
3307 static struct usb_driver hso_driver = {
3308 .name = driver_name,
3310 .disconnect = hso_disconnect,
3311 .id_table = hso_ids,
3312 .suspend = hso_suspend,
3313 .resume = hso_resume,
3314 .reset_resume = hso_resume,
3315 .supports_autosuspend = 1,
3318 static int __init hso_init(void)
3323 /* put it in the log */
3324 printk(KERN_INFO "hso: %s\n", version);
3326 /* Initialise the serial table semaphore and table */
3327 spin_lock_init(&serial_table_lock);
3328 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3329 serial_table[i] = NULL;
3331 /* allocate our driver using the proper amount of supported minors */
3332 tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
3336 /* fill in all needed values */
3337 tty_drv->magic = TTY_DRIVER_MAGIC;
3338 tty_drv->owner = THIS_MODULE;
3339 tty_drv->driver_name = driver_name;
3340 tty_drv->name = tty_filename;
3342 /* if major number is provided as parameter, use that one */
3344 tty_drv->major = tty_major;
3346 tty_drv->minor_start = 0;
3347 tty_drv->num = HSO_SERIAL_TTY_MINORS;
3348 tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3349 tty_drv->subtype = SERIAL_TYPE_NORMAL;
3350 tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
3351 tty_drv->init_termios = tty_std_termios;
3352 hso_init_termios(&tty_drv->init_termios);
3353 tty_set_operations(tty_drv, &hso_serial_ops);
3355 /* register the tty driver */
3356 result = tty_register_driver(tty_drv);
3358 printk(KERN_ERR "%s - tty_register_driver failed(%d)\n",
3363 /* register this module as an usb driver */
3364 result = usb_register(&hso_driver);
3366 printk(KERN_ERR "Could not register hso driver? error: %d\n",
3368 /* cleanup serial interface */
3369 tty_unregister_driver(tty_drv);
3377 static void __exit hso_exit(void)
3379 printk(KERN_INFO "hso: unloaded\n");
3381 tty_unregister_driver(tty_drv);
3382 /* deregister the usb driver */
3383 usb_deregister(&hso_driver);
3386 /* Module definitions */
3387 module_init(hso_init);
3388 module_exit(hso_exit);
3390 MODULE_AUTHOR(MOD_AUTHOR);
3391 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3392 MODULE_LICENSE(MOD_LICENSE);
3393 MODULE_INFO(Version, DRIVER_VERSION);
3395 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3396 MODULE_PARM_DESC(debug, "Level of debug [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3397 module_param(debug, int, S_IRUGO | S_IWUSR);
3399 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3400 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3401 module_param(tty_major, int, S_IRUGO | S_IWUSR);
3403 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3404 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3405 module_param(disable_net, int, S_IRUGO | S_IWUSR);