1 /******************************************************************************
3 * Driver for Option High Speed Mobile Devices.
5 * Copyright (C) 2008 Option International
6 * Filip Aben <f.aben@option.com>
7 * Denis Joseph Barrow <d.barow@option.com>
8 * Jan Dumon <j.dumon@option.com>
9 * Copyright (C) 2007 Andrew Bird (Sphere Systems Ltd)
10 * <ajb@spheresystems.co.uk>
11 * Copyright (C) 2008 Greg Kroah-Hartman <gregkh@suse.de>
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 #ifdef CONFIG_HSO_AUTOPM
1159 usb_mark_last_busy(urb->dev);
1161 /* We are done with this URB, resubmit it. Prep the USB to wait for
1163 usb_fill_bulk_urb(urb, serial->parent->usb,
1164 usb_rcvbulkpipe(serial->parent->usb,
1166 bEndpointAddress & 0x7F),
1167 urb->transfer_buffer, serial->rx_data_length,
1168 hso_std_serial_read_bulk_callback, serial);
1169 /* Give this to the USB subsystem so it can tell us when more data
1171 result = usb_submit_urb(urb, GFP_ATOMIC);
1173 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1181 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1184 struct urb *curr_urb;
1186 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1187 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1188 count = put_rxbuf_data(curr_urb, serial);
1192 serial->curr_rx_urb_idx++;
1193 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1194 serial->curr_rx_urb_idx = 0;
1195 hso_resubmit_rx_bulk_urb(serial, curr_urb);
1200 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1205 urb = serial->rx_urb[0];
1206 if (serial->open_count > 0) {
1207 count = put_rxbuf_data(urb, serial);
1211 /* Re issue a read as long as we receive data. */
1213 if (count == 0 && ((urb->actual_length != 0) ||
1214 (serial->rx_state == RX_PENDING))) {
1215 serial->rx_state = RX_SENT;
1216 hso_mux_serial_read(serial);
1218 serial->rx_state = RX_IDLE;
1222 /* read callback for Diag and CS port */
1223 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1225 struct hso_serial *serial = urb->context;
1226 int status = urb->status;
1230 D1("serial == NULL");
1232 } else if (status) {
1233 handle_usb_error(status, __func__, serial->parent);
1237 D4("\n--- Got serial_read_bulk callback %02x ---", status);
1238 D1("Actual length = %d\n", urb->actual_length);
1239 DUMP1(urb->transfer_buffer, urb->actual_length);
1241 /* Anyone listening? */
1242 if (serial->open_count == 0)
1246 if (serial->parent->port_spec & HSO_INFO_CRC_BUG) {
1248 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1250 urb->actual_length %
1251 le16_to_cpu(serial->in_endp->wMaxPacketSize);
1252 if (((rest == 5) || (rest == 6)) &&
1253 !memcmp(((u8 *) urb->transfer_buffer) +
1254 urb->actual_length - 4, crc_check, 4)) {
1255 urb->actual_length -= 4;
1258 /* Valid data, handle RX data */
1259 spin_lock(&serial->serial_lock);
1260 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1261 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1262 spin_unlock(&serial->serial_lock);
1263 } else if (status == -ENOENT || status == -ECONNRESET) {
1264 /* Unlinked - check for throttled port. */
1265 D2("Port %d, successfully unlinked urb", serial->minor);
1266 spin_lock(&serial->serial_lock);
1267 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
1268 hso_resubmit_rx_bulk_urb(serial, urb);
1269 spin_unlock(&serial->serial_lock);
1271 D2("Port %d, status = %d for read urb", serial->minor, status);
1277 * This needs to be a tasklet otherwise we will
1278 * end up recursively calling this function.
1280 static void hso_unthrottle_tasklet(struct hso_serial *serial)
1282 unsigned long flags;
1284 spin_lock_irqsave(&serial->serial_lock, flags);
1285 if ((serial->parent->port_spec & HSO_INTF_MUX))
1286 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1288 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1289 spin_unlock_irqrestore(&serial->serial_lock, flags);
1292 static void hso_unthrottle(struct tty_struct *tty)
1294 struct hso_serial *serial = get_serial_by_tty(tty);
1296 tasklet_hi_schedule(&serial->unthrottle_tasklet);
1299 static void hso_unthrottle_workfunc(struct work_struct *work)
1301 struct hso_serial *serial =
1302 container_of(work, struct hso_serial,
1303 retry_unthrottle_workqueue);
1304 hso_unthrottle_tasklet(serial);
1307 /* open the requested serial port */
1308 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1310 struct hso_serial *serial = get_serial_by_index(tty->index);
1314 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1316 tty->driver_data = NULL;
1317 D1("Failed to open port");
1321 mutex_lock(&serial->parent->mutex);
1322 result = usb_autopm_get_interface(serial->parent->interface);
1326 D1("Opening %d", serial->minor);
1327 kref_get(&serial->parent->ref);
1330 spin_lock_irq(&serial->serial_lock);
1331 tty->driver_data = serial;
1332 tty_kref_put(serial->tty);
1333 serial->tty = tty_kref_get(tty);
1334 spin_unlock_irq(&serial->serial_lock);
1336 /* check for port already opened, if not set the termios */
1337 serial->open_count++;
1338 if (serial->open_count == 1) {
1339 tty->low_latency = 1;
1340 serial->rx_state = RX_IDLE;
1341 /* Force default termio settings */
1342 _hso_serial_set_termios(tty, NULL);
1343 tasklet_init(&serial->unthrottle_tasklet,
1344 (void (*)(unsigned long))hso_unthrottle_tasklet,
1345 (unsigned long)serial);
1346 INIT_WORK(&serial->retry_unthrottle_workqueue,
1347 hso_unthrottle_workfunc);
1348 result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1350 hso_stop_serial_device(serial->parent);
1351 serial->open_count--;
1352 kref_put(&serial->parent->ref, hso_serial_ref_free);
1355 D1("Port was already open");
1358 usb_autopm_put_interface(serial->parent->interface);
1362 hso_serial_tiocmset(tty, NULL, TIOCM_RTS | TIOCM_DTR, 0);
1364 mutex_unlock(&serial->parent->mutex);
1368 /* close the requested serial port */
1369 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1371 struct hso_serial *serial = tty->driver_data;
1374 D1("Closing serial port");
1376 /* Open failed, no close cleanup required */
1380 mutex_lock(&serial->parent->mutex);
1381 usb_gone = serial->parent->usb_gone;
1384 usb_autopm_get_interface(serial->parent->interface);
1386 /* reset the rts and dtr */
1387 /* do the actual close */
1388 serial->open_count--;
1390 if (serial->open_count <= 0) {
1391 serial->open_count = 0;
1392 spin_lock_irq(&serial->serial_lock);
1393 if (serial->tty == tty) {
1394 serial->tty->driver_data = NULL;
1398 spin_unlock_irq(&serial->serial_lock);
1400 hso_stop_serial_device(serial->parent);
1401 tasklet_kill(&serial->unthrottle_tasklet);
1402 cancel_work_sync(&serial->retry_unthrottle_workqueue);
1406 usb_autopm_put_interface(serial->parent->interface);
1408 mutex_unlock(&serial->parent->mutex);
1410 kref_put(&serial->parent->ref, hso_serial_ref_free);
1413 /* close the requested serial port */
1414 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1417 struct hso_serial *serial = get_serial_by_tty(tty);
1418 int space, tx_bytes;
1419 unsigned long flags;
1422 if (serial == NULL) {
1423 printk(KERN_ERR "%s: serial is NULL\n", __func__);
1427 spin_lock_irqsave(&serial->serial_lock, flags);
1429 space = serial->tx_data_length - serial->tx_buffer_count;
1430 tx_bytes = (count < space) ? count : space;
1435 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1436 serial->tx_buffer_count += tx_bytes;
1439 spin_unlock_irqrestore(&serial->serial_lock, flags);
1441 hso_kick_transmit(serial);
1446 /* how much room is there for writing */
1447 static int hso_serial_write_room(struct tty_struct *tty)
1449 struct hso_serial *serial = get_serial_by_tty(tty);
1451 unsigned long flags;
1453 spin_lock_irqsave(&serial->serial_lock, flags);
1454 room = serial->tx_data_length - serial->tx_buffer_count;
1455 spin_unlock_irqrestore(&serial->serial_lock, flags);
1457 /* return free room */
1461 /* setup the term */
1462 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1464 struct hso_serial *serial = get_serial_by_tty(tty);
1465 unsigned long flags;
1468 D5("Termios called with: cflags new[%d] - old[%d]",
1469 tty->termios->c_cflag, old->c_cflag);
1471 /* the actual setup */
1472 spin_lock_irqsave(&serial->serial_lock, flags);
1473 if (serial->open_count)
1474 _hso_serial_set_termios(tty, old);
1477 spin_unlock_irqrestore(&serial->serial_lock, flags);
1483 /* how many characters in the buffer */
1484 static int hso_serial_chars_in_buffer(struct tty_struct *tty)
1486 struct hso_serial *serial = get_serial_by_tty(tty);
1488 unsigned long flags;
1494 spin_lock_irqsave(&serial->serial_lock, flags);
1495 chars = serial->tx_buffer_count;
1496 spin_unlock_irqrestore(&serial->serial_lock, flags);
1500 static int tiocmget_submit_urb(struct hso_serial *serial,
1501 struct hso_tiocmget *tiocmget,
1502 struct usb_device *usb)
1506 if (serial->parent->usb_gone)
1508 usb_fill_int_urb(tiocmget->urb, usb,
1511 bEndpointAddress & 0x7F),
1512 &tiocmget->serial_state_notification,
1513 sizeof(struct hso_serial_state_notification),
1514 tiocmget_intr_callback, serial,
1515 tiocmget->endp->bInterval);
1516 result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC);
1518 dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__,
1525 static void tiocmget_intr_callback(struct urb *urb)
1527 struct hso_serial *serial = urb->context;
1528 struct hso_tiocmget *tiocmget;
1529 int status = urb->status;
1530 u16 UART_state_bitmap, prev_UART_state_bitmap;
1531 struct uart_icount *icount;
1532 struct hso_serial_state_notification *serial_state_notification;
1533 struct usb_device *usb;
1539 handle_usb_error(status, __func__, serial->parent);
1542 tiocmget = serial->tiocmget;
1545 usb = serial->parent->usb;
1546 serial_state_notification = &tiocmget->serial_state_notification;
1547 if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1548 serial_state_notification->bNotification != B_NOTIFICATION ||
1549 le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1550 le16_to_cpu(serial_state_notification->wIndex) != W_INDEX ||
1551 le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1553 "hso received invalid serial state notification\n");
1554 DUMP(serial_state_notification,
1555 sizeof(struct hso_serial_state_notification));
1558 UART_state_bitmap = le16_to_cpu(serial_state_notification->
1560 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1561 icount = &tiocmget->icount;
1562 spin_lock(&serial->serial_lock);
1563 if ((UART_state_bitmap & B_OVERRUN) !=
1564 (prev_UART_state_bitmap & B_OVERRUN))
1566 if ((UART_state_bitmap & B_PARITY) !=
1567 (prev_UART_state_bitmap & B_PARITY))
1569 if ((UART_state_bitmap & B_FRAMING) !=
1570 (prev_UART_state_bitmap & B_FRAMING))
1572 if ((UART_state_bitmap & B_RING_SIGNAL) &&
1573 !(prev_UART_state_bitmap & B_RING_SIGNAL))
1575 if ((UART_state_bitmap & B_BREAK) !=
1576 (prev_UART_state_bitmap & B_BREAK))
1578 if ((UART_state_bitmap & B_TX_CARRIER) !=
1579 (prev_UART_state_bitmap & B_TX_CARRIER))
1581 if ((UART_state_bitmap & B_RX_CARRIER) !=
1582 (prev_UART_state_bitmap & B_RX_CARRIER))
1584 tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1585 spin_unlock(&serial->serial_lock);
1586 tiocmget->intr_completed = 1;
1587 wake_up_interruptible(&tiocmget->waitq);
1589 memset(serial_state_notification, 0,
1590 sizeof(struct hso_serial_state_notification));
1591 tiocmget_submit_urb(serial,
1593 serial->parent->usb);
1597 * next few functions largely stolen from drivers/serial/serial_core.c
1599 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1600 * - mask passed in arg for lines of interest
1601 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1602 * Caller should use TIOCGICOUNT to see which one it was
1605 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1607 DECLARE_WAITQUEUE(wait, current);
1608 struct uart_icount cprev, cnow;
1609 struct hso_tiocmget *tiocmget;
1612 tiocmget = serial->tiocmget;
1616 * note the counters on entry
1618 spin_lock_irq(&serial->serial_lock);
1619 memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1620 spin_unlock_irq(&serial->serial_lock);
1621 add_wait_queue(&tiocmget->waitq, &wait);
1623 spin_lock_irq(&serial->serial_lock);
1624 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1625 spin_unlock_irq(&serial->serial_lock);
1626 set_current_state(TASK_INTERRUPTIBLE);
1627 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1628 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1629 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd))) {
1634 /* see if a signal did it */
1635 if (signal_pending(current)) {
1641 current->state = TASK_RUNNING;
1642 remove_wait_queue(&tiocmget->waitq, &wait);
1648 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1649 * Return: write counters to the user passed counter struct
1650 * NB: both 1->0 and 0->1 transitions are counted except for
1651 * RI where only 0->1 is counted.
1653 static int hso_get_count(struct hso_serial *serial,
1654 struct serial_icounter_struct __user *icnt)
1656 struct serial_icounter_struct icount;
1657 struct uart_icount cnow;
1658 struct hso_tiocmget *tiocmget = serial->tiocmget;
1662 spin_lock_irq(&serial->serial_lock);
1663 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1664 spin_unlock_irq(&serial->serial_lock);
1666 icount.cts = cnow.cts;
1667 icount.dsr = cnow.dsr;
1668 icount.rng = cnow.rng;
1669 icount.dcd = cnow.dcd;
1670 icount.rx = cnow.rx;
1671 icount.tx = cnow.tx;
1672 icount.frame = cnow.frame;
1673 icount.overrun = cnow.overrun;
1674 icount.parity = cnow.parity;
1675 icount.brk = cnow.brk;
1676 icount.buf_overrun = cnow.buf_overrun;
1678 return copy_to_user(icnt, &icount, sizeof(icount)) ? -EFAULT : 0;
1682 static int hso_serial_tiocmget(struct tty_struct *tty, struct file *file)
1685 struct hso_serial *serial = get_serial_by_tty(tty);
1686 struct hso_tiocmget *tiocmget;
1687 u16 UART_state_bitmap;
1691 D1("no tty structures");
1694 spin_lock_irq(&serial->serial_lock);
1695 retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1696 ((serial->dtr_state) ? TIOCM_DTR : 0);
1697 tiocmget = serial->tiocmget;
1700 UART_state_bitmap = le16_to_cpu(
1701 tiocmget->prev_UART_state_bitmap);
1702 if (UART_state_bitmap & B_RING_SIGNAL)
1703 retval |= TIOCM_RNG;
1704 if (UART_state_bitmap & B_RX_CARRIER)
1706 if (UART_state_bitmap & B_TX_CARRIER)
1707 retval |= TIOCM_DSR;
1709 spin_unlock_irq(&serial->serial_lock);
1713 static int hso_serial_tiocmset(struct tty_struct *tty, struct file *file,
1714 unsigned int set, unsigned int clear)
1717 unsigned long flags;
1719 struct hso_serial *serial = get_serial_by_tty(tty);
1723 D1("no tty structures");
1727 if ((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM)
1730 if_num = serial->parent->interface->altsetting->desc.bInterfaceNumber;
1732 spin_lock_irqsave(&serial->serial_lock, flags);
1733 if (set & TIOCM_RTS)
1734 serial->rts_state = 1;
1735 if (set & TIOCM_DTR)
1736 serial->dtr_state = 1;
1738 if (clear & TIOCM_RTS)
1739 serial->rts_state = 0;
1740 if (clear & TIOCM_DTR)
1741 serial->dtr_state = 0;
1743 if (serial->dtr_state)
1745 if (serial->rts_state)
1748 spin_unlock_irqrestore(&serial->serial_lock, flags);
1750 return usb_control_msg(serial->parent->usb,
1751 usb_rcvctrlpipe(serial->parent->usb, 0), 0x22,
1752 0x21, val, if_num, NULL, 0,
1753 USB_CTRL_SET_TIMEOUT);
1756 static int hso_serial_ioctl(struct tty_struct *tty, struct file *file,
1757 unsigned int cmd, unsigned long arg)
1759 struct hso_serial *serial = get_serial_by_tty(tty);
1760 void __user *uarg = (void __user *)arg;
1762 D4("IOCTL cmd: %d, arg: %ld", cmd, arg);
1768 ret = hso_wait_modem_status(serial, arg);
1772 ret = hso_get_count(serial, uarg);
1782 /* starts a transmit */
1783 static void hso_kick_transmit(struct hso_serial *serial)
1786 unsigned long flags;
1789 spin_lock_irqsave(&serial->serial_lock, flags);
1790 if (!serial->tx_buffer_count)
1793 if (serial->tx_urb_used)
1796 /* Wakeup USB interface if necessary */
1797 if (hso_get_activity(serial->parent) == -EAGAIN)
1800 /* Switch pointers around to avoid memcpy */
1801 temp = serial->tx_buffer;
1802 serial->tx_buffer = serial->tx_data;
1803 serial->tx_data = temp;
1804 serial->tx_data_count = serial->tx_buffer_count;
1805 serial->tx_buffer_count = 0;
1807 /* If temp is set, it means we switched buffers */
1808 if (temp && serial->write_data) {
1809 res = serial->write_data(serial);
1811 serial->tx_urb_used = 1;
1814 spin_unlock_irqrestore(&serial->serial_lock, flags);
1817 /* make a request (for reading and writing data to muxed serial port) */
1818 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1819 struct urb *ctrl_urb,
1820 struct usb_ctrlrequest *ctrl_req,
1821 u8 *ctrl_urb_data, u32 size)
1827 if (!serial || !ctrl_urb || !ctrl_req) {
1828 printk(KERN_ERR "%s: Wrong arguments\n", __func__);
1833 ctrl_req->wValue = 0;
1834 ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1835 ctrl_req->wLength = cpu_to_le16(size);
1837 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1838 /* Reading command */
1839 ctrl_req->bRequestType = USB_DIR_IN |
1840 USB_TYPE_OPTION_VENDOR |
1841 USB_RECIP_INTERFACE;
1842 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1843 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1845 /* Writing command */
1846 ctrl_req->bRequestType = USB_DIR_OUT |
1847 USB_TYPE_OPTION_VENDOR |
1848 USB_RECIP_INTERFACE;
1849 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1850 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1853 D2("%s command (%02x) len: %d, port: %d",
1854 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1855 ctrl_req->bRequestType, ctrl_req->wLength, port);
1858 ctrl_urb->transfer_flags = 0;
1859 usb_fill_control_urb(ctrl_urb,
1860 serial->parent->usb,
1863 ctrl_urb_data, size, ctrl_callback, serial);
1864 /* Send it on merry way */
1865 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1867 dev_err(&ctrl_urb->dev->dev,
1868 "%s failed submit ctrl_urb %d type %d\n", __func__,
1877 /* called by intr_callback when read occurs */
1878 static int hso_mux_serial_read(struct hso_serial *serial)
1884 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1885 /* make the request */
1887 if (serial->num_rx_urbs != 1) {
1888 dev_err(&serial->parent->interface->dev,
1889 "ERROR: mux'd reads with multiple buffers "
1893 return mux_device_request(serial,
1894 USB_CDC_GET_ENCAPSULATED_RESPONSE,
1895 serial->parent->port_spec & HSO_PORT_MASK,
1897 &serial->ctrl_req_rx,
1898 serial->rx_data[0], serial->rx_data_length);
1901 /* used for muxed serial port callback (muxed serial read) */
1902 static void intr_callback(struct urb *urb)
1904 struct hso_shared_int *shared_int = urb->context;
1905 struct hso_serial *serial;
1906 unsigned char *port_req;
1907 int status = urb->status;
1910 usb_mark_last_busy(urb->dev);
1918 handle_usb_error(status, __func__, NULL);
1921 D4("\n--- Got intr callback 0x%02X ---", status);
1924 port_req = urb->transfer_buffer;
1925 D4(" port_req = 0x%.2X\n", *port_req);
1926 /* loop over all muxed ports to find the one sending this */
1927 for (i = 0; i < 8; i++) {
1928 /* max 8 channels on MUX */
1929 if (*port_req & (1 << i)) {
1930 serial = get_serial_by_shared_int_and_type(shared_int,
1932 if (serial != NULL) {
1933 D1("Pending read interrupt on port %d\n", i);
1934 spin_lock(&serial->serial_lock);
1935 if (serial->rx_state == RX_IDLE &&
1936 serial->open_count > 0) {
1937 /* Setup and send a ctrl req read on
1939 if (!serial->rx_urb_filled[0]) {
1940 serial->rx_state = RX_SENT;
1941 hso_mux_serial_read(serial);
1943 serial->rx_state = RX_PENDING;
1945 D1("Already a read pending on "
1946 "port %d or port not open\n", i);
1948 spin_unlock(&serial->serial_lock);
1952 /* Resubmit interrupt urb */
1953 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1956 /* called for writing to muxed serial port */
1957 static int hso_mux_serial_write_data(struct hso_serial *serial)
1962 return mux_device_request(serial,
1963 USB_CDC_SEND_ENCAPSULATED_COMMAND,
1964 serial->parent->port_spec & HSO_PORT_MASK,
1966 &serial->ctrl_req_tx,
1967 serial->tx_data, serial->tx_data_count);
1970 /* write callback for Diag and CS port */
1971 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1973 struct hso_serial *serial = urb->context;
1974 int status = urb->status;
1975 struct tty_struct *tty;
1979 D1("serial == NULL");
1983 spin_lock(&serial->serial_lock);
1984 serial->tx_urb_used = 0;
1985 tty = tty_kref_get(serial->tty);
1986 spin_unlock(&serial->serial_lock);
1988 handle_usb_error(status, __func__, serial->parent);
1992 hso_put_activity(serial->parent);
1997 hso_kick_transmit(serial);
2003 /* called for writing diag or CS serial port */
2004 static int hso_std_serial_write_data(struct hso_serial *serial)
2006 int count = serial->tx_data_count;
2009 usb_fill_bulk_urb(serial->tx_urb,
2010 serial->parent->usb,
2011 usb_sndbulkpipe(serial->parent->usb,
2013 bEndpointAddress & 0x7F),
2014 serial->tx_data, serial->tx_data_count,
2015 hso_std_serial_write_bulk_callback, serial);
2017 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
2019 dev_warn(&serial->parent->usb->dev,
2020 "Failed to submit urb - res %d\n", result);
2027 /* callback after read or write on muxed serial port */
2028 static void ctrl_callback(struct urb *urb)
2030 struct hso_serial *serial = urb->context;
2031 struct usb_ctrlrequest *req;
2032 int status = urb->status;
2033 struct tty_struct *tty;
2039 spin_lock(&serial->serial_lock);
2040 serial->tx_urb_used = 0;
2041 tty = tty_kref_get(serial->tty);
2042 spin_unlock(&serial->serial_lock);
2044 handle_usb_error(status, __func__, serial->parent);
2050 req = (struct usb_ctrlrequest *)(urb->setup_packet);
2051 D4("\n--- Got muxed ctrl callback 0x%02X ---", status);
2052 D4("Actual length of urb = %d\n", urb->actual_length);
2053 DUMP1(urb->transfer_buffer, urb->actual_length);
2055 if (req->bRequestType ==
2056 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
2057 /* response to a read command */
2058 serial->rx_urb_filled[0] = 1;
2059 spin_lock(&serial->serial_lock);
2060 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
2061 spin_unlock(&serial->serial_lock);
2063 hso_put_activity(serial->parent);
2066 /* response to a write command */
2067 hso_kick_transmit(serial);
2072 /* handle RX data for serial port */
2073 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
2075 struct tty_struct *tty;
2076 int write_length_remaining = 0;
2080 if (urb == NULL || serial == NULL) {
2081 D1("serial = NULL");
2085 /* All callers to put_rxbuf_data hold serial_lock */
2086 tty = tty_kref_get(serial->tty);
2088 /* Push data to tty */
2090 write_length_remaining = urb->actual_length -
2091 serial->curr_rx_urb_offset;
2092 D1("data to push to tty");
2093 while (write_length_remaining) {
2094 if (test_bit(TTY_THROTTLED, &tty->flags)) {
2098 curr_write_len = tty_insert_flip_string
2099 (tty, urb->transfer_buffer +
2100 serial->curr_rx_urb_offset,
2101 write_length_remaining);
2102 serial->curr_rx_urb_offset += curr_write_len;
2103 write_length_remaining -= curr_write_len;
2104 tty_flip_buffer_push(tty);
2107 if (write_length_remaining == 0) {
2108 serial->curr_rx_urb_offset = 0;
2109 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2112 return write_length_remaining;
2116 /* Base driver functions */
2118 static void hso_log_port(struct hso_device *hso_dev)
2123 switch (hso_dev->port_spec & HSO_PORT_MASK) {
2124 case HSO_PORT_CONTROL:
2125 port_type = "Control";
2128 port_type = "Application";
2133 case HSO_PORT_GPS_CONTROL:
2134 port_type = "GPS control";
2137 port_type = "Application2";
2143 port_type = "Diagnostic";
2145 case HSO_PORT_DIAG2:
2146 port_type = "Diagnostic2";
2148 case HSO_PORT_MODEM:
2149 port_type = "Modem";
2151 case HSO_PORT_NETWORK:
2152 port_type = "Network";
2155 port_type = "Unknown";
2158 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2159 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2161 sprintf(port_dev, "/dev/%s%d", tty_filename,
2162 dev2ser(hso_dev)->minor);
2164 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2165 port_type, port_dev);
2168 static int hso_start_net_device(struct hso_device *hso_dev)
2171 struct hso_net *hso_net = dev2net(hso_dev);
2176 /* send URBs for all read buffers */
2177 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2179 /* Prep a receive URB */
2180 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2182 usb_rcvbulkpipe(hso_dev->usb,
2184 bEndpointAddress & 0x7F),
2185 hso_net->mux_bulk_rx_buf_pool[i],
2186 MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2189 /* Put it out there so the device can send us stuff */
2190 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2193 dev_warn(&hso_dev->usb->dev,
2194 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2201 static int hso_stop_net_device(struct hso_device *hso_dev)
2204 struct hso_net *hso_net = dev2net(hso_dev);
2209 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2210 if (hso_net->mux_bulk_rx_urb_pool[i])
2211 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2214 if (hso_net->mux_bulk_tx_urb)
2215 usb_kill_urb(hso_net->mux_bulk_tx_urb);
2220 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2223 struct hso_serial *serial = dev2ser(hso_dev);
2228 /* If it is not the MUX port fill in and submit a bulk urb (already
2229 * allocated in hso_serial_start) */
2230 if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2231 for (i = 0; i < serial->num_rx_urbs; i++) {
2232 usb_fill_bulk_urb(serial->rx_urb[i],
2233 serial->parent->usb,
2234 usb_rcvbulkpipe(serial->parent->usb,
2239 serial->rx_data_length,
2240 hso_std_serial_read_bulk_callback,
2242 result = usb_submit_urb(serial->rx_urb[i], flags);
2244 dev_warn(&serial->parent->usb->dev,
2245 "Failed to submit urb - res %d\n",
2251 mutex_lock(&serial->shared_int->shared_int_lock);
2252 if (!serial->shared_int->use_count) {
2254 hso_mux_submit_intr_urb(serial->shared_int,
2255 hso_dev->usb, flags);
2257 serial->shared_int->use_count++;
2258 mutex_unlock(&serial->shared_int->shared_int_lock);
2260 if (serial->tiocmget)
2261 tiocmget_submit_urb(serial,
2263 serial->parent->usb);
2267 static int hso_stop_serial_device(struct hso_device *hso_dev)
2270 struct hso_serial *serial = dev2ser(hso_dev);
2271 struct hso_tiocmget *tiocmget;
2276 for (i = 0; i < serial->num_rx_urbs; i++) {
2277 if (serial->rx_urb[i]) {
2278 usb_kill_urb(serial->rx_urb[i]);
2279 serial->rx_urb_filled[i] = 0;
2282 serial->curr_rx_urb_idx = 0;
2283 serial->curr_rx_urb_offset = 0;
2286 usb_kill_urb(serial->tx_urb);
2288 if (serial->shared_int) {
2289 mutex_lock(&serial->shared_int->shared_int_lock);
2290 if (serial->shared_int->use_count &&
2291 (--serial->shared_int->use_count == 0)) {
2294 urb = serial->shared_int->shared_intr_urb;
2298 mutex_unlock(&serial->shared_int->shared_int_lock);
2300 tiocmget = serial->tiocmget;
2302 wake_up_interruptible(&tiocmget->waitq);
2303 usb_kill_urb(tiocmget->urb);
2309 static void hso_serial_common_free(struct hso_serial *serial)
2313 if (serial->parent->dev)
2314 device_remove_file(serial->parent->dev, &dev_attr_hsotype);
2316 tty_unregister_device(tty_drv, serial->minor);
2318 for (i = 0; i < serial->num_rx_urbs; i++) {
2319 /* unlink and free RX URB */
2320 usb_free_urb(serial->rx_urb[i]);
2321 /* free the RX buffer */
2322 kfree(serial->rx_data[i]);
2325 /* unlink and free TX URB */
2326 usb_free_urb(serial->tx_urb);
2327 kfree(serial->tx_data);
2330 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
2331 int rx_size, int tx_size)
2337 minor = get_free_serial_index();
2341 /* register our minor number */
2342 serial->parent->dev = tty_register_device(tty_drv, minor,
2343 &serial->parent->interface->dev);
2344 dev = serial->parent->dev;
2345 dev_set_drvdata(dev, serial->parent);
2346 i = device_create_file(dev, &dev_attr_hsotype);
2348 /* fill in specific data for later use */
2349 serial->minor = minor;
2350 serial->magic = HSO_SERIAL_MAGIC;
2351 spin_lock_init(&serial->serial_lock);
2352 serial->num_rx_urbs = num_urbs;
2354 /* RX, allocate urb and initialize */
2356 /* prepare our RX buffer */
2357 serial->rx_data_length = rx_size;
2358 for (i = 0; i < serial->num_rx_urbs; i++) {
2359 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2360 if (!serial->rx_urb[i]) {
2361 dev_err(dev, "Could not allocate urb?\n");
2364 serial->rx_urb[i]->transfer_buffer = NULL;
2365 serial->rx_urb[i]->transfer_buffer_length = 0;
2366 serial->rx_data[i] = kzalloc(serial->rx_data_length,
2368 if (!serial->rx_data[i]) {
2369 dev_err(dev, "%s - Out of memory\n", __func__);
2374 /* TX, allocate urb and initialize */
2375 serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2376 if (!serial->tx_urb) {
2377 dev_err(dev, "Could not allocate urb?\n");
2380 serial->tx_urb->transfer_buffer = NULL;
2381 serial->tx_urb->transfer_buffer_length = 0;
2382 /* prepare our TX buffer */
2383 serial->tx_data_count = 0;
2384 serial->tx_buffer_count = 0;
2385 serial->tx_data_length = tx_size;
2386 serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2387 if (!serial->tx_data) {
2388 dev_err(dev, "%s - Out of memory\n", __func__);
2391 serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2392 if (!serial->tx_buffer) {
2393 dev_err(dev, "%s - Out of memory\n", __func__);
2399 hso_serial_common_free(serial);
2403 /* Creates a general hso device */
2404 static struct hso_device *hso_create_device(struct usb_interface *intf,
2407 struct hso_device *hso_dev;
2409 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2413 hso_dev->port_spec = port_spec;
2414 hso_dev->usb = interface_to_usbdev(intf);
2415 hso_dev->interface = intf;
2416 kref_init(&hso_dev->ref);
2417 mutex_init(&hso_dev->mutex);
2419 INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2420 INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2421 INIT_WORK(&hso_dev->reset_device, reset_device);
2426 /* Removes a network device in the network device table */
2427 static int remove_net_device(struct hso_device *hso_dev)
2431 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2432 if (network_table[i] == hso_dev) {
2433 network_table[i] = NULL;
2437 if (i == HSO_MAX_NET_DEVICES)
2442 /* Frees our network device */
2443 static void hso_free_net_device(struct hso_device *hso_dev)
2446 struct hso_net *hso_net = dev2net(hso_dev);
2451 remove_net_device(hso_net->parent);
2454 unregister_netdev(hso_net->net);
2455 free_netdev(hso_net->net);
2459 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2460 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2461 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2462 hso_net->mux_bulk_rx_buf_pool[i] = NULL;
2464 usb_free_urb(hso_net->mux_bulk_tx_urb);
2465 kfree(hso_net->mux_bulk_tx_buf);
2466 hso_net->mux_bulk_tx_buf = NULL;
2471 static const struct net_device_ops hso_netdev_ops = {
2472 .ndo_open = hso_net_open,
2473 .ndo_stop = hso_net_close,
2474 .ndo_start_xmit = hso_net_start_xmit,
2475 .ndo_tx_timeout = hso_net_tx_timeout,
2478 /* initialize the network interface */
2479 static void hso_net_init(struct net_device *net)
2481 struct hso_net *hso_net = netdev_priv(net);
2483 D1("sizeof hso_net is %d", (int)sizeof(*hso_net));
2485 /* fill in the other fields */
2486 net->netdev_ops = &hso_netdev_ops;
2487 net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2488 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2489 net->type = ARPHRD_NONE;
2490 net->mtu = DEFAULT_MTU - 14;
2491 net->tx_queue_len = 10;
2492 SET_ETHTOOL_OPS(net, &ops);
2494 /* and initialize the semaphore */
2495 spin_lock_init(&hso_net->net_lock);
2498 /* Adds a network device in the network device table */
2499 static int add_net_device(struct hso_device *hso_dev)
2503 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2504 if (network_table[i] == NULL) {
2505 network_table[i] = hso_dev;
2509 if (i == HSO_MAX_NET_DEVICES)
2514 static int hso_rfkill_set_block(void *data, bool blocked)
2516 struct hso_device *hso_dev = data;
2517 int enabled = !blocked;
2520 mutex_lock(&hso_dev->mutex);
2521 if (hso_dev->usb_gone)
2524 rv = usb_control_msg(hso_dev->usb, usb_rcvctrlpipe(hso_dev->usb, 0),
2525 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2526 USB_CTRL_SET_TIMEOUT);
2527 mutex_unlock(&hso_dev->mutex);
2531 static const struct rfkill_ops hso_rfkill_ops = {
2532 .set_block = hso_rfkill_set_block,
2535 /* Creates and sets up everything for rfkill */
2536 static void hso_create_rfkill(struct hso_device *hso_dev,
2537 struct usb_interface *interface)
2539 struct hso_net *hso_net = dev2net(hso_dev);
2540 struct device *dev = &hso_net->net->dev;
2543 rfkn = kzalloc(20, GFP_KERNEL);
2545 dev_err(dev, "%s - Out of memory\n", __func__);
2547 snprintf(rfkn, 20, "hso-%d",
2548 interface->altsetting->desc.bInterfaceNumber);
2550 hso_net->rfkill = rfkill_alloc(rfkn,
2551 &interface_to_usbdev(interface)->dev,
2553 &hso_rfkill_ops, hso_dev);
2554 if (!hso_net->rfkill) {
2555 dev_err(dev, "%s - Out of memory\n", __func__);
2559 if (rfkill_register(hso_net->rfkill) < 0) {
2560 rfkill_destroy(hso_net->rfkill);
2562 hso_net->rfkill = NULL;
2563 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2568 static struct device_type hso_type = {
2572 /* Creates our network device */
2573 static struct hso_device *hso_create_net_device(struct usb_interface *interface,
2577 struct net_device *net;
2578 struct hso_net *hso_net;
2579 struct hso_device *hso_dev;
2581 hso_dev = hso_create_device(interface, port_spec);
2585 /* allocate our network device, then we can put in our private data */
2586 /* call hso_net_init to do the basic initialization */
2587 net = alloc_netdev(sizeof(struct hso_net), "hso%d", hso_net_init);
2589 dev_err(&interface->dev, "Unable to create ethernet device\n");
2593 hso_net = netdev_priv(net);
2595 hso_dev->port_data.dev_net = hso_net;
2597 hso_net->parent = hso_dev;
2599 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2601 if (!hso_net->in_endp) {
2602 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2605 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2607 if (!hso_net->out_endp) {
2608 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2611 SET_NETDEV_DEV(net, &interface->dev);
2612 SET_NETDEV_DEVTYPE(net, &hso_type);
2614 /* registering our net device */
2615 result = register_netdev(net);
2617 dev_err(&interface->dev, "Failed to register device\n");
2621 /* start allocating */
2622 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2623 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2624 if (!hso_net->mux_bulk_rx_urb_pool[i]) {
2625 dev_err(&interface->dev, "Could not allocate rx urb\n");
2628 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2630 if (!hso_net->mux_bulk_rx_buf_pool[i]) {
2631 dev_err(&interface->dev, "Could not allocate rx buf\n");
2635 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2636 if (!hso_net->mux_bulk_tx_urb) {
2637 dev_err(&interface->dev, "Could not allocate tx urb\n");
2640 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2641 if (!hso_net->mux_bulk_tx_buf) {
2642 dev_err(&interface->dev, "Could not allocate tx buf\n");
2646 add_net_device(hso_dev);
2648 hso_log_port(hso_dev);
2650 hso_create_rfkill(hso_dev, interface);
2654 hso_free_net_device(hso_dev);
2658 static void hso_free_tiomget(struct hso_serial *serial)
2660 struct hso_tiocmget *tiocmget = serial->tiocmget;
2662 if (tiocmget->urb) {
2663 usb_free_urb(tiocmget->urb);
2664 tiocmget->urb = NULL;
2666 serial->tiocmget = NULL;
2672 /* Frees an AT channel ( goes for both mux and non-mux ) */
2673 static void hso_free_serial_device(struct hso_device *hso_dev)
2675 struct hso_serial *serial = dev2ser(hso_dev);
2679 set_serial_by_index(serial->minor, NULL);
2681 hso_serial_common_free(serial);
2683 if (serial->shared_int) {
2684 mutex_lock(&serial->shared_int->shared_int_lock);
2685 if (--serial->shared_int->ref_count == 0)
2686 hso_free_shared_int(serial->shared_int);
2688 mutex_unlock(&serial->shared_int->shared_int_lock);
2690 hso_free_tiomget(serial);
2695 /* Creates a bulk AT channel */
2696 static struct hso_device *hso_create_bulk_serial_device(
2697 struct usb_interface *interface, int port)
2699 struct hso_device *hso_dev;
2700 struct hso_serial *serial;
2702 struct hso_tiocmget *tiocmget;
2704 hso_dev = hso_create_device(interface, port);
2708 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2712 serial->parent = hso_dev;
2713 hso_dev->port_data.dev_serial = serial;
2715 if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2717 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2719 /* it isn't going to break our heart if serial->tiocmget
2720 * allocation fails don't bother checking this.
2722 if (serial->tiocmget) {
2723 tiocmget = serial->tiocmget;
2724 tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2725 if (tiocmget->urb) {
2726 mutex_init(&tiocmget->mutex);
2727 init_waitqueue_head(&tiocmget->waitq);
2728 tiocmget->endp = hso_get_ep(
2730 USB_ENDPOINT_XFER_INT,
2733 hso_free_tiomget(serial);
2739 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2743 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2745 if (!serial->in_endp) {
2746 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2752 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2753 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2757 serial->write_data = hso_std_serial_write_data;
2759 /* and record this serial */
2760 set_serial_by_index(serial->minor, serial);
2762 /* setup the proc dirs and files if needed */
2763 hso_log_port(hso_dev);
2765 /* done, return it */
2769 hso_serial_common_free(serial);
2771 hso_free_tiomget(serial);
2777 /* Creates a multiplexed AT channel */
2779 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2781 struct hso_shared_int *mux)
2783 struct hso_device *hso_dev;
2784 struct hso_serial *serial;
2787 port_spec = HSO_INTF_MUX;
2788 port_spec &= ~HSO_PORT_MASK;
2790 port_spec |= hso_mux_to_port(port);
2791 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2794 hso_dev = hso_create_device(interface, port_spec);
2798 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2802 hso_dev->port_data.dev_serial = serial;
2803 serial->parent = hso_dev;
2805 if (hso_serial_common_create
2806 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2809 serial->tx_data_length--;
2810 serial->write_data = hso_mux_serial_write_data;
2812 serial->shared_int = mux;
2813 mutex_lock(&serial->shared_int->shared_int_lock);
2814 serial->shared_int->ref_count++;
2815 mutex_unlock(&serial->shared_int->shared_int_lock);
2817 /* and record this serial */
2818 set_serial_by_index(serial->minor, serial);
2820 /* setup the proc dirs and files if needed */
2821 hso_log_port(hso_dev);
2823 /* done, return it */
2828 tty_unregister_device(tty_drv, serial->minor);
2837 static void hso_free_shared_int(struct hso_shared_int *mux)
2839 usb_free_urb(mux->shared_intr_urb);
2840 kfree(mux->shared_intr_buf);
2841 mutex_unlock(&mux->shared_int_lock);
2846 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2848 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2853 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2855 if (!mux->intr_endp) {
2856 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2860 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2861 if (!mux->shared_intr_urb) {
2862 dev_err(&interface->dev, "Could not allocate intr urb?\n");
2865 mux->shared_intr_buf =
2866 kzalloc(le16_to_cpu(mux->intr_endp->wMaxPacketSize),
2868 if (!mux->shared_intr_buf) {
2869 dev_err(&interface->dev, "Could not allocate intr buf?\n");
2873 mutex_init(&mux->shared_int_lock);
2878 kfree(mux->shared_intr_buf);
2879 usb_free_urb(mux->shared_intr_urb);
2884 /* Gets the port spec for a certain interface */
2885 static int hso_get_config_data(struct usb_interface *interface)
2887 struct usb_device *usbdev = interface_to_usbdev(interface);
2889 u32 if_num = interface->altsetting->desc.bInterfaceNumber;
2892 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2893 0x86, 0xC0, 0, 0, config_data, 17,
2894 USB_CTRL_SET_TIMEOUT) != 0x11) {
2898 switch (config_data[if_num]) {
2903 result = HSO_PORT_DIAG;
2906 result = HSO_PORT_GPS;
2909 result = HSO_PORT_GPS_CONTROL;
2912 result = HSO_PORT_APP;
2915 result = HSO_PORT_APP2;
2918 result = HSO_PORT_CONTROL;
2921 result = HSO_PORT_NETWORK;
2924 result = HSO_PORT_MODEM;
2927 result = HSO_PORT_MSD;
2930 result = HSO_PORT_PCSC;
2933 result = HSO_PORT_VOICE;
2940 result |= HSO_INTF_BULK;
2942 if (config_data[16] & 0x1)
2943 result |= HSO_INFO_CRC_BUG;
2948 /* called once for each interface upon device insertion */
2949 static int hso_probe(struct usb_interface *interface,
2950 const struct usb_device_id *id)
2952 int mux, i, if_num, port_spec;
2953 unsigned char port_mask;
2954 struct hso_device *hso_dev = NULL;
2955 struct hso_shared_int *shared_int;
2956 struct hso_device *tmp_dev = NULL;
2958 if_num = interface->altsetting->desc.bInterfaceNumber;
2960 /* Get the interface/port specification from either driver_info or from
2961 * the device itself */
2962 if (id->driver_info)
2963 port_spec = ((u32 *)(id->driver_info))[if_num];
2965 port_spec = hso_get_config_data(interface);
2967 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2968 dev_err(&interface->dev, "Not our interface\n");
2971 /* Check if we need to switch to alt interfaces prior to port
2973 if (interface->num_altsetting > 1)
2974 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2975 interface->needs_remote_wakeup = 1;
2977 /* Allocate new hso device(s) */
2978 switch (port_spec & HSO_INTF_MASK) {
2980 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2981 /* Create the network device */
2983 hso_dev = hso_create_net_device(interface,
2991 if (hso_get_mux_ports(interface, &port_mask))
2992 /* TODO: de-allocate everything */
2995 shared_int = hso_create_shared_int(interface);
2999 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
3000 if (port_mask & i) {
3001 hso_dev = hso_create_mux_serial_device(
3002 interface, i, shared_int);
3013 /* It's a regular bulk interface */
3014 if (((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) &&
3016 hso_dev = hso_create_net_device(interface, port_spec);
3019 hso_create_bulk_serial_device(interface, port_spec);
3027 /* save our data pointer in this device */
3028 usb_set_intfdata(interface, hso_dev);
3033 hso_free_interface(interface);
3037 /* device removed, cleaning up */
3038 static void hso_disconnect(struct usb_interface *interface)
3040 hso_free_interface(interface);
3042 /* remove reference of our private data */
3043 usb_set_intfdata(interface, NULL);
3046 static void async_get_intf(struct work_struct *data)
3048 struct hso_device *hso_dev =
3049 container_of(data, struct hso_device, async_get_intf);
3050 usb_autopm_get_interface(hso_dev->interface);
3053 static void async_put_intf(struct work_struct *data)
3055 struct hso_device *hso_dev =
3056 container_of(data, struct hso_device, async_put_intf);
3057 usb_autopm_put_interface(hso_dev->interface);
3060 static int hso_get_activity(struct hso_device *hso_dev)
3062 if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
3063 if (!hso_dev->is_active) {
3064 hso_dev->is_active = 1;
3065 schedule_work(&hso_dev->async_get_intf);
3069 if (hso_dev->usb->state != USB_STATE_CONFIGURED)
3072 usb_mark_last_busy(hso_dev->usb);
3077 static int hso_put_activity(struct hso_device *hso_dev)
3079 if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
3080 if (hso_dev->is_active) {
3081 hso_dev->is_active = 0;
3082 schedule_work(&hso_dev->async_put_intf);
3086 hso_dev->is_active = 0;
3090 /* called by kernel when we need to suspend device */
3091 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3095 /* Stop all serial ports */
3096 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3097 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3098 result = hso_stop_serial_device(serial_table[i]);
3104 /* Stop all network ports */
3105 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3106 if (network_table[i] &&
3107 (network_table[i]->interface == iface)) {
3108 result = hso_stop_net_device(network_table[i]);
3118 /* called by kernel when we need to resume device */
3119 static int hso_resume(struct usb_interface *iface)
3122 struct hso_net *hso_net;
3124 /* Start all serial ports */
3125 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3126 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3127 if (dev2ser(serial_table[i])->open_count) {
3129 hso_start_serial_device(serial_table[i], GFP_NOIO);
3130 hso_kick_transmit(dev2ser(serial_table[i]));
3137 /* Start all network ports */
3138 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3139 if (network_table[i] &&
3140 (network_table[i]->interface == iface)) {
3141 hso_net = dev2net(network_table[i]);
3142 if (hso_net->flags & IFF_UP) {
3143 /* First transmit any lingering data,
3144 then restart the device. */
3145 if (hso_net->skb_tx_buf) {
3146 dev_dbg(&iface->dev,
3148 " lingering data\n");
3149 hso_net_start_xmit(hso_net->skb_tx_buf,
3151 hso_net->skb_tx_buf = NULL;
3153 result = hso_start_net_device(network_table[i]);
3164 static void reset_device(struct work_struct *data)
3166 struct hso_device *hso_dev =
3167 container_of(data, struct hso_device, reset_device);
3168 struct usb_device *usb = hso_dev->usb;
3171 if (hso_dev->usb_gone) {
3172 D1("No reset during disconnect\n");
3174 result = usb_lock_device_for_reset(usb, hso_dev->interface);
3176 D1("unable to lock device for reset: %d\n", result);
3178 usb_reset_device(usb);
3179 usb_unlock_device(usb);
3184 static void hso_serial_ref_free(struct kref *ref)
3186 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3188 hso_free_serial_device(hso_dev);
3191 static void hso_free_interface(struct usb_interface *interface)
3193 struct hso_serial *hso_dev;
3194 struct tty_struct *tty;
3197 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3198 if (serial_table[i] &&
3199 (serial_table[i]->interface == interface)) {
3200 hso_dev = dev2ser(serial_table[i]);
3201 spin_lock_irq(&hso_dev->serial_lock);
3202 tty = tty_kref_get(hso_dev->tty);
3203 spin_unlock_irq(&hso_dev->serial_lock);
3206 mutex_lock(&hso_dev->parent->mutex);
3208 hso_dev->parent->usb_gone = 1;
3209 mutex_unlock(&hso_dev->parent->mutex);
3210 kref_put(&serial_table[i]->ref, hso_serial_ref_free);
3214 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3215 if (network_table[i] &&
3216 (network_table[i]->interface == interface)) {
3217 struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3218 /* hso_stop_net_device doesn't stop the net queue since
3219 * traffic needs to start it again when suspended */
3220 netif_stop_queue(dev2net(network_table[i])->net);
3221 hso_stop_net_device(network_table[i]);
3222 cancel_work_sync(&network_table[i]->async_put_intf);
3223 cancel_work_sync(&network_table[i]->async_get_intf);
3225 rfkill_unregister(rfk);
3226 rfkill_destroy(rfk);
3228 hso_free_net_device(network_table[i]);
3233 /* Helper functions */
3235 /* Get the endpoint ! */
3236 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3240 struct usb_host_interface *iface = intf->cur_altsetting;
3241 struct usb_endpoint_descriptor *endp;
3243 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3244 endp = &iface->endpoint[i].desc;
3245 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3246 (usb_endpoint_type(endp) == type))
3253 /* Get the byte that describes which ports are enabled */
3254 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3257 struct usb_host_interface *iface = intf->cur_altsetting;
3259 if (iface->extralen == 3) {
3260 *ports = iface->extra[2];
3264 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3265 if (iface->endpoint[i].extralen == 3) {
3266 *ports = iface->endpoint[i].extra[2];
3274 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3275 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3276 struct usb_device *usb, gfp_t gfp)
3280 usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3282 shared_int->intr_endp->bEndpointAddress & 0x7F),
3283 shared_int->shared_intr_buf,
3285 intr_callback, shared_int,
3286 shared_int->intr_endp->bInterval);
3288 result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3290 dev_warn(&usb->dev, "%s failed mux_intr_urb %d\n", __func__,
3296 /* operations setup of the serial interface */
3297 static const struct tty_operations hso_serial_ops = {
3298 .open = hso_serial_open,
3299 .close = hso_serial_close,
3300 .write = hso_serial_write,
3301 .write_room = hso_serial_write_room,
3302 .ioctl = hso_serial_ioctl,
3303 .set_termios = hso_serial_set_termios,
3304 .chars_in_buffer = hso_serial_chars_in_buffer,
3305 .tiocmget = hso_serial_tiocmget,
3306 .tiocmset = hso_serial_tiocmset,
3307 .unthrottle = hso_unthrottle
3310 static struct usb_driver hso_driver = {
3311 .name = driver_name,
3313 .disconnect = hso_disconnect,
3314 .id_table = hso_ids,
3315 .suspend = hso_suspend,
3316 .resume = hso_resume,
3317 .reset_resume = hso_resume,
3318 .supports_autosuspend = 1,
3321 static int __init hso_init(void)
3326 /* put it in the log */
3327 printk(KERN_INFO "hso: %s\n", version);
3329 /* Initialise the serial table semaphore and table */
3330 spin_lock_init(&serial_table_lock);
3331 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3332 serial_table[i] = NULL;
3334 /* allocate our driver using the proper amount of supported minors */
3335 tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
3339 /* fill in all needed values */
3340 tty_drv->magic = TTY_DRIVER_MAGIC;
3341 tty_drv->owner = THIS_MODULE;
3342 tty_drv->driver_name = driver_name;
3343 tty_drv->name = tty_filename;
3345 /* if major number is provided as parameter, use that one */
3347 tty_drv->major = tty_major;
3349 tty_drv->minor_start = 0;
3350 tty_drv->num = HSO_SERIAL_TTY_MINORS;
3351 tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3352 tty_drv->subtype = SERIAL_TYPE_NORMAL;
3353 tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
3354 tty_drv->init_termios = tty_std_termios;
3355 hso_init_termios(&tty_drv->init_termios);
3356 tty_set_operations(tty_drv, &hso_serial_ops);
3358 /* register the tty driver */
3359 result = tty_register_driver(tty_drv);
3361 printk(KERN_ERR "%s - tty_register_driver failed(%d)\n",
3366 /* register this module as an usb driver */
3367 result = usb_register(&hso_driver);
3369 printk(KERN_ERR "Could not register hso driver? error: %d\n",
3371 /* cleanup serial interface */
3372 tty_unregister_driver(tty_drv);
3380 static void __exit hso_exit(void)
3382 printk(KERN_INFO "hso: unloaded\n");
3384 tty_unregister_driver(tty_drv);
3385 /* deregister the usb driver */
3386 usb_deregister(&hso_driver);
3389 /* Module definitions */
3390 module_init(hso_init);
3391 module_exit(hso_exit);
3393 MODULE_AUTHOR(MOD_AUTHOR);
3394 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3395 MODULE_LICENSE(MOD_LICENSE);
3396 MODULE_INFO(Version, DRIVER_VERSION);
3398 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3399 MODULE_PARM_DESC(debug, "Level of debug [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3400 module_param(debug, int, S_IRUGO | S_IWUSR);
3402 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3403 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3404 module_param(tty_major, int, S_IRUGO | S_IWUSR);
3406 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3407 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3408 module_param(disable_net, int, S_IRUGO | S_IWUSR);