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 MOD_AUTHOR "Option Wireless"
77 #define MOD_DESCRIPTION "USB High Speed Option driver"
78 #define MOD_LICENSE "GPL"
80 #define HSO_MAX_NET_DEVICES 10
81 #define HSO__MAX_MTU 2048
82 #define DEFAULT_MTU 1500
83 #define DEFAULT_MRU 1500
85 #define CTRL_URB_RX_SIZE 1024
86 #define CTRL_URB_TX_SIZE 64
88 #define BULK_URB_RX_SIZE 4096
89 #define BULK_URB_TX_SIZE 8192
91 #define MUX_BULK_RX_BUF_SIZE HSO__MAX_MTU
92 #define MUX_BULK_TX_BUF_SIZE HSO__MAX_MTU
93 #define MUX_BULK_RX_BUF_COUNT 4
94 #define USB_TYPE_OPTION_VENDOR 0x20
96 /* These definitions are used with the struct hso_net flags element */
97 /* - use *_bit operations on it. (bit indices not values.) */
98 #define HSO_NET_RUNNING 0
100 #define HSO_NET_TX_TIMEOUT (HZ*10)
102 #define HSO_SERIAL_MAGIC 0x48534f31
104 /* Number of ttys to handle */
105 #define HSO_SERIAL_TTY_MINORS 256
107 #define MAX_RX_URBS 2
109 static inline struct hso_serial *get_serial_by_tty(struct tty_struct *tty)
112 return tty->driver_data;
116 /*****************************************************************************/
117 /* Debugging functions */
118 /*****************************************************************************/
119 #define D__(lvl_, fmt, arg...) \
121 printk(lvl_ "[%d:%s]: " fmt "\n", \
122 __LINE__, __func__, ## arg); \
125 #define D_(lvl, args...) \
128 D__(KERN_INFO, args); \
131 #define D1(args...) D_(0x01, ##args)
132 #define D2(args...) D_(0x02, ##args)
133 #define D3(args...) D_(0x04, ##args)
134 #define D4(args...) D_(0x08, ##args)
135 #define D5(args...) D_(0x10, ##args)
137 /*****************************************************************************/
139 /*****************************************************************************/
140 enum pkt_parse_state {
146 /*****************************************************************************/
148 /*****************************************************************************/
150 struct hso_shared_int {
151 struct usb_endpoint_descriptor *intr_endp;
152 void *shared_intr_buf;
153 struct urb *shared_intr_urb;
154 struct usb_device *usb;
157 struct mutex shared_int_lock;
161 struct hso_device *parent;
162 struct net_device *net;
163 struct rfkill *rfkill;
165 struct usb_endpoint_descriptor *in_endp;
166 struct usb_endpoint_descriptor *out_endp;
168 struct urb *mux_bulk_rx_urb_pool[MUX_BULK_RX_BUF_COUNT];
169 struct urb *mux_bulk_tx_urb;
170 void *mux_bulk_rx_buf_pool[MUX_BULK_RX_BUF_COUNT];
171 void *mux_bulk_tx_buf;
173 struct sk_buff *skb_rx_buf;
174 struct sk_buff *skb_tx_buf;
176 enum pkt_parse_state rx_parse_state;
179 unsigned short rx_buf_size;
180 unsigned short rx_buf_missing;
181 struct iphdr rx_ip_hdr;
192 #define BM_REQUEST_TYPE (0xa1)
193 #define B_NOTIFICATION (0x20)
194 #define W_VALUE (0x0)
195 #define W_INDEX (0x2)
196 #define W_LENGTH (0x2)
198 #define B_OVERRUN (0x1<<6)
199 #define B_PARITY (0x1<<5)
200 #define B_FRAMING (0x1<<4)
201 #define B_RING_SIGNAL (0x1<<3)
202 #define B_BREAK (0x1<<2)
203 #define B_TX_CARRIER (0x1<<1)
204 #define B_RX_CARRIER (0x1<<0)
206 struct hso_serial_state_notification {
212 u16 UART_state_bitmap;
215 struct hso_tiocmget {
217 wait_queue_head_t waitq;
219 struct usb_endpoint_descriptor *endp;
221 struct hso_serial_state_notification serial_state_notification;
222 u16 prev_UART_state_bitmap;
223 struct uart_icount icount;
228 struct hso_device *parent;
232 struct hso_shared_int *shared_int;
234 /* rx/tx urb could be either a bulk urb or a control urb depending
235 on which serial port it is used on. */
236 struct urb *rx_urb[MAX_RX_URBS];
238 u8 *rx_data[MAX_RX_URBS];
239 u16 rx_data_length; /* should contain allocated length */
244 u16 tx_data_length; /* should contain allocated length */
247 struct usb_ctrlrequest ctrl_req_tx;
248 struct usb_ctrlrequest ctrl_req_rx;
250 struct usb_endpoint_descriptor *in_endp;
251 struct usb_endpoint_descriptor *out_endp;
253 enum rx_ctrl_state rx_state;
256 unsigned tx_urb_used:1;
258 /* from usb_serial_port */
259 struct tty_struct *tty;
261 spinlock_t serial_lock;
263 int (*write_data) (struct hso_serial *serial);
264 struct hso_tiocmget *tiocmget;
265 /* Hacks required to get flow control
266 * working on the serial receive buffers
267 * so as not to drop characters on the floor.
270 u16 curr_rx_urb_offset;
271 u8 rx_urb_filled[MAX_RX_URBS];
272 struct tasklet_struct unthrottle_tasklet;
273 struct work_struct retry_unthrottle_workqueue;
278 struct hso_serial *dev_serial;
279 struct hso_net *dev_net;
286 struct work_struct async_get_intf;
287 struct work_struct async_put_intf;
288 struct work_struct reset_device;
290 struct usb_device *usb;
291 struct usb_interface *interface;
298 /* Type of interface */
299 #define HSO_INTF_MASK 0xFF00
300 #define HSO_INTF_MUX 0x0100
301 #define HSO_INTF_BULK 0x0200
304 #define HSO_PORT_MASK 0xFF
305 #define HSO_PORT_NO_PORT 0x0
306 #define HSO_PORT_CONTROL 0x1
307 #define HSO_PORT_APP 0x2
308 #define HSO_PORT_GPS 0x3
309 #define HSO_PORT_PCSC 0x4
310 #define HSO_PORT_APP2 0x5
311 #define HSO_PORT_GPS_CONTROL 0x6
312 #define HSO_PORT_MSD 0x7
313 #define HSO_PORT_VOICE 0x8
314 #define HSO_PORT_DIAG2 0x9
315 #define HSO_PORT_DIAG 0x10
316 #define HSO_PORT_MODEM 0x11
317 #define HSO_PORT_NETWORK 0x12
319 /* Additional device info */
320 #define HSO_INFO_MASK 0xFF000000
321 #define HSO_INFO_CRC_BUG 0x01000000
323 /*****************************************************************************/
325 /*****************************************************************************/
326 /* Serial driver functions */
327 static int hso_serial_tiocmset(struct tty_struct *tty, struct file *file,
328 unsigned int set, unsigned int clear);
329 static void ctrl_callback(struct urb *urb);
330 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial);
331 static void hso_kick_transmit(struct hso_serial *serial);
332 /* Helper functions */
333 static int hso_mux_submit_intr_urb(struct hso_shared_int *mux_int,
334 struct usb_device *usb, gfp_t gfp);
335 static void handle_usb_error(int status, const char *function,
336 struct hso_device *hso_dev);
337 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
339 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports);
340 static void hso_free_interface(struct usb_interface *intf);
341 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags);
342 static int hso_stop_serial_device(struct hso_device *hso_dev);
343 static int hso_start_net_device(struct hso_device *hso_dev);
344 static void hso_free_shared_int(struct hso_shared_int *shared_int);
345 static int hso_stop_net_device(struct hso_device *hso_dev);
346 static void hso_serial_ref_free(struct kref *ref);
347 static void hso_std_serial_read_bulk_callback(struct urb *urb);
348 static int hso_mux_serial_read(struct hso_serial *serial);
349 static void async_get_intf(struct work_struct *data);
350 static void async_put_intf(struct work_struct *data);
351 static int hso_put_activity(struct hso_device *hso_dev);
352 static int hso_get_activity(struct hso_device *hso_dev);
353 static void tiocmget_intr_callback(struct urb *urb);
354 static void reset_device(struct work_struct *data);
355 /*****************************************************************************/
356 /* Helping functions */
357 /*****************************************************************************/
361 static inline struct hso_net *dev2net(struct hso_device *hso_dev)
363 return hso_dev->port_data.dev_net;
366 static inline struct hso_serial *dev2ser(struct hso_device *hso_dev)
368 return hso_dev->port_data.dev_serial;
371 /* Debugging functions */
373 static void dbg_dump(int line_count, const char *func_name, unsigned char *buf,
376 static char name[255];
378 sprintf(name, "hso[%d:%s]", line_count, func_name);
379 print_hex_dump_bytes(name, DUMP_PREFIX_NONE, buf, len);
382 #define DUMP(buf_, len_) \
383 dbg_dump(__LINE__, __func__, (unsigned char *)buf_, len_)
385 #define DUMP1(buf_, len_) \
391 #define DUMP(buf_, len_)
392 #define DUMP1(buf_, len_)
395 /* module parameters */
397 static int tty_major;
398 static int disable_net;
401 static const char driver_name[] = "hso";
402 static const char tty_filename[] = "ttyHS";
403 static const char *version = __FILE__ ": " MOD_AUTHOR;
404 /* the usb driver itself (registered in hso_init) */
405 static struct usb_driver hso_driver;
406 /* serial structures */
407 static struct tty_driver *tty_drv;
408 static struct hso_device *serial_table[HSO_SERIAL_TTY_MINORS];
409 static struct hso_device *network_table[HSO_MAX_NET_DEVICES];
410 static spinlock_t serial_table_lock;
412 static const s32 default_port_spec[] = {
413 HSO_INTF_MUX | HSO_PORT_NETWORK,
414 HSO_INTF_BULK | HSO_PORT_DIAG,
415 HSO_INTF_BULK | HSO_PORT_MODEM,
419 static const s32 icon321_port_spec[] = {
420 HSO_INTF_MUX | HSO_PORT_NETWORK,
421 HSO_INTF_BULK | HSO_PORT_DIAG2,
422 HSO_INTF_BULK | HSO_PORT_MODEM,
423 HSO_INTF_BULK | HSO_PORT_DIAG,
427 #define default_port_device(vendor, product) \
428 USB_DEVICE(vendor, product), \
429 .driver_info = (kernel_ulong_t)default_port_spec
431 #define icon321_port_device(vendor, product) \
432 USB_DEVICE(vendor, product), \
433 .driver_info = (kernel_ulong_t)icon321_port_spec
435 /* list of devices we support */
436 static const struct usb_device_id hso_ids[] = {
437 {default_port_device(0x0af0, 0x6711)},
438 {default_port_device(0x0af0, 0x6731)},
439 {default_port_device(0x0af0, 0x6751)},
440 {default_port_device(0x0af0, 0x6771)},
441 {default_port_device(0x0af0, 0x6791)},
442 {default_port_device(0x0af0, 0x6811)},
443 {default_port_device(0x0af0, 0x6911)},
444 {default_port_device(0x0af0, 0x6951)},
445 {default_port_device(0x0af0, 0x6971)},
446 {default_port_device(0x0af0, 0x7011)},
447 {default_port_device(0x0af0, 0x7031)},
448 {default_port_device(0x0af0, 0x7051)},
449 {default_port_device(0x0af0, 0x7071)},
450 {default_port_device(0x0af0, 0x7111)},
451 {default_port_device(0x0af0, 0x7211)},
452 {default_port_device(0x0af0, 0x7251)},
453 {default_port_device(0x0af0, 0x7271)},
454 {default_port_device(0x0af0, 0x7311)},
455 {default_port_device(0x0af0, 0xc031)}, /* Icon-Edge */
456 {icon321_port_device(0x0af0, 0xd013)}, /* Module HSxPA */
457 {icon321_port_device(0x0af0, 0xd031)}, /* Icon-321 */
458 {icon321_port_device(0x0af0, 0xd033)}, /* Icon-322 */
459 {USB_DEVICE(0x0af0, 0x7301)}, /* GE40x */
460 {USB_DEVICE(0x0af0, 0x7361)}, /* GE40x */
461 {USB_DEVICE(0x0af0, 0x7381)}, /* GE40x */
462 {USB_DEVICE(0x0af0, 0x7401)}, /* GI 0401 */
463 {USB_DEVICE(0x0af0, 0x7501)}, /* GTM 382 */
464 {USB_DEVICE(0x0af0, 0x7601)}, /* GE40x */
465 {USB_DEVICE(0x0af0, 0x7701)},
466 {USB_DEVICE(0x0af0, 0x7706)},
467 {USB_DEVICE(0x0af0, 0x7801)},
468 {USB_DEVICE(0x0af0, 0x7901)},
469 {USB_DEVICE(0x0af0, 0x7A01)},
470 {USB_DEVICE(0x0af0, 0x7A05)},
471 {USB_DEVICE(0x0af0, 0x8200)},
472 {USB_DEVICE(0x0af0, 0x8201)},
473 {USB_DEVICE(0x0af0, 0x8300)},
474 {USB_DEVICE(0x0af0, 0x8302)},
475 {USB_DEVICE(0x0af0, 0x8304)},
476 {USB_DEVICE(0x0af0, 0x8400)},
477 {USB_DEVICE(0x0af0, 0x8600)},
478 {USB_DEVICE(0x0af0, 0x8800)},
479 {USB_DEVICE(0x0af0, 0x8900)},
480 {USB_DEVICE(0x0af0, 0xd035)},
481 {USB_DEVICE(0x0af0, 0xd055)},
482 {USB_DEVICE(0x0af0, 0xd155)},
483 {USB_DEVICE(0x0af0, 0xd255)},
484 {USB_DEVICE(0x0af0, 0xd057)},
485 {USB_DEVICE(0x0af0, 0xd157)},
486 {USB_DEVICE(0x0af0, 0xd257)},
487 {USB_DEVICE(0x0af0, 0xd357)},
488 {USB_DEVICE(0x0af0, 0xd058)},
489 {USB_DEVICE(0x0af0, 0xc100)},
492 MODULE_DEVICE_TABLE(usb, hso_ids);
494 /* Sysfs attribute */
495 static ssize_t hso_sysfs_show_porttype(struct device *dev,
496 struct device_attribute *attr,
499 struct hso_device *hso_dev = dev_get_drvdata(dev);
505 switch (hso_dev->port_spec & HSO_PORT_MASK) {
506 case HSO_PORT_CONTROL:
507 port_name = "Control";
510 port_name = "Application";
513 port_name = "Application2";
518 case HSO_PORT_GPS_CONTROL:
519 port_name = "GPS Control";
525 port_name = "Diagnostic";
528 port_name = "Diagnostic2";
533 case HSO_PORT_NETWORK:
534 port_name = "Network";
537 port_name = "Unknown";
541 return sprintf(buf, "%s\n", port_name);
543 static DEVICE_ATTR(hsotype, S_IRUGO, hso_sysfs_show_porttype, NULL);
545 static int hso_urb_to_index(struct hso_serial *serial, struct urb *urb)
549 for (idx = 0; idx < serial->num_rx_urbs; idx++)
550 if (serial->rx_urb[idx] == urb)
552 dev_err(serial->parent->dev, "hso_urb_to_index failed\n");
556 /* converts mux value to a port spec value */
557 static u32 hso_mux_to_port(int mux)
563 result = HSO_PORT_CONTROL;
566 result = HSO_PORT_APP;
569 result = HSO_PORT_PCSC;
572 result = HSO_PORT_GPS;
575 result = HSO_PORT_APP2;
578 result = HSO_PORT_NO_PORT;
583 /* converts port spec value to a mux value */
584 static u32 hso_port_to_mux(int port)
588 switch (port & HSO_PORT_MASK) {
589 case HSO_PORT_CONTROL:
610 static struct hso_serial *get_serial_by_shared_int_and_type(
611 struct hso_shared_int *shared_int,
616 port = hso_mux_to_port(mux);
618 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
619 if (serial_table[i] &&
620 (dev2ser(serial_table[i])->shared_int == shared_int) &&
621 ((serial_table[i]->port_spec & HSO_PORT_MASK) == port)) {
622 return dev2ser(serial_table[i]);
629 static struct hso_serial *get_serial_by_index(unsigned index)
631 struct hso_serial *serial = NULL;
634 spin_lock_irqsave(&serial_table_lock, flags);
635 if (serial_table[index])
636 serial = dev2ser(serial_table[index]);
637 spin_unlock_irqrestore(&serial_table_lock, flags);
642 static int get_free_serial_index(void)
647 spin_lock_irqsave(&serial_table_lock, flags);
648 for (index = 0; index < HSO_SERIAL_TTY_MINORS; index++) {
649 if (serial_table[index] == NULL) {
650 spin_unlock_irqrestore(&serial_table_lock, flags);
654 spin_unlock_irqrestore(&serial_table_lock, flags);
656 printk(KERN_ERR "%s: no free serial devices in table\n", __func__);
660 static void set_serial_by_index(unsigned index, struct hso_serial *serial)
664 spin_lock_irqsave(&serial_table_lock, flags);
666 serial_table[index] = serial->parent;
668 serial_table[index] = NULL;
669 spin_unlock_irqrestore(&serial_table_lock, flags);
672 static void handle_usb_error(int status, const char *function,
673 struct hso_device *hso_dev)
679 explanation = "no device";
682 explanation = "endpoint not enabled";
685 explanation = "endpoint stalled";
688 explanation = "not enough bandwidth";
691 explanation = "device disabled";
694 explanation = "device suspended";
700 explanation = "internal error";
706 explanation = "protocol error";
708 schedule_work(&hso_dev->reset_device);
711 explanation = "unknown status";
715 /* log a meaningful explanation of an USB status */
716 D1("%s: received USB status - %s (%d)", function, explanation, status);
719 /* Network interface functions */
721 /* called when net interface is brought up by ifconfig */
722 static int hso_net_open(struct net_device *net)
724 struct hso_net *odev = netdev_priv(net);
725 unsigned long flags = 0;
728 dev_err(&net->dev, "No net device !\n");
732 odev->skb_tx_buf = NULL;
734 /* setup environment */
735 spin_lock_irqsave(&odev->net_lock, flags);
736 odev->rx_parse_state = WAIT_IP;
737 odev->rx_buf_size = 0;
738 odev->rx_buf_missing = sizeof(struct iphdr);
739 spin_unlock_irqrestore(&odev->net_lock, flags);
741 /* We are up and running. */
742 set_bit(HSO_NET_RUNNING, &odev->flags);
743 hso_start_net_device(odev->parent);
745 /* Tell the kernel we are ready to start receiving from it */
746 netif_start_queue(net);
751 /* called when interface is brought down by ifconfig */
752 static int hso_net_close(struct net_device *net)
754 struct hso_net *odev = netdev_priv(net);
756 /* we don't need the queue anymore */
757 netif_stop_queue(net);
758 /* no longer running */
759 clear_bit(HSO_NET_RUNNING, &odev->flags);
761 hso_stop_net_device(odev->parent);
767 /* USB tells is xmit done, we should start the netqueue again */
768 static void write_bulk_callback(struct urb *urb)
770 struct hso_net *odev = urb->context;
771 int status = urb->status;
774 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
775 dev_err(&urb->dev->dev, "%s: device not running\n", __func__);
779 /* Do we still have a valid kernel network device? */
780 if (!netif_device_present(odev->net)) {
781 dev_err(&urb->dev->dev, "%s: net device not present\n",
786 /* log status, but don't act on it, we don't need to resubmit anything
789 handle_usb_error(status, __func__, odev->parent);
791 hso_put_activity(odev->parent);
793 /* Tell the network interface we are ready for another frame */
794 netif_wake_queue(odev->net);
797 /* called by kernel when we need to transmit a packet */
798 static netdev_tx_t hso_net_start_xmit(struct sk_buff *skb,
799 struct net_device *net)
801 struct hso_net *odev = netdev_priv(net);
804 /* Tell the kernel, "No more frames 'til we are done with this one." */
805 netif_stop_queue(net);
806 if (hso_get_activity(odev->parent) == -EAGAIN) {
807 odev->skb_tx_buf = skb;
812 DUMP1(skb->data, skb->len);
813 /* Copy it from kernel memory to OUR memory */
814 memcpy(odev->mux_bulk_tx_buf, skb->data, skb->len);
815 D1("len: %d/%d", skb->len, MUX_BULK_TX_BUF_SIZE);
817 /* Fill in the URB for shipping it out. */
818 usb_fill_bulk_urb(odev->mux_bulk_tx_urb,
820 usb_sndbulkpipe(odev->parent->usb,
822 bEndpointAddress & 0x7F),
823 odev->mux_bulk_tx_buf, skb->len, write_bulk_callback,
826 /* Deal with the Zero Length packet problem, I hope */
827 odev->mux_bulk_tx_urb->transfer_flags |= URB_ZERO_PACKET;
829 /* Send the URB on its merry way. */
830 result = usb_submit_urb(odev->mux_bulk_tx_urb, GFP_ATOMIC);
832 dev_warn(&odev->parent->interface->dev,
833 "failed mux_bulk_tx_urb %d\n", result);
834 net->stats.tx_errors++;
835 netif_start_queue(net);
837 net->stats.tx_packets++;
838 net->stats.tx_bytes += skb->len;
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 usb_make_path(odev->parent->usb, info->bus_info, sizeof info->bus_info);
853 static const struct ethtool_ops ops = {
854 .get_drvinfo = hso_get_drvinfo,
855 .get_link = ethtool_op_get_link
858 /* called when a packet did not ack after watchdogtimeout */
859 static void hso_net_tx_timeout(struct net_device *net)
861 struct hso_net *odev = netdev_priv(net);
866 /* Tell syslog we are hosed. */
867 dev_warn(&net->dev, "Tx timed out.\n");
869 /* Tear the waiting frame off the list */
870 if (odev->mux_bulk_tx_urb &&
871 (odev->mux_bulk_tx_urb->status == -EINPROGRESS))
872 usb_unlink_urb(odev->mux_bulk_tx_urb);
874 /* Update statistics */
875 net->stats.tx_errors++;
878 /* make a real packet from the received USB buffer */
879 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt,
880 unsigned int count, unsigned char is_eop)
882 unsigned short temp_bytes;
883 unsigned short buffer_offset = 0;
884 unsigned short frame_len;
885 unsigned char *tmp_rx_buf;
888 D1("Rx %d bytes", count);
889 DUMP(ip_pkt, min(128, (int)count));
892 switch (odev->rx_parse_state) {
894 /* waiting for IP header. */
895 /* wanted bytes - size of ip header */
898 odev->rx_buf_missing) ? count : odev->
901 memcpy(((unsigned char *)(&odev->rx_ip_hdr)) +
902 odev->rx_buf_size, ip_pkt + buffer_offset,
905 odev->rx_buf_size += temp_bytes;
906 buffer_offset += temp_bytes;
907 odev->rx_buf_missing -= temp_bytes;
910 if (!odev->rx_buf_missing) {
911 /* header is complete allocate an sk_buffer and
912 * continue to WAIT_DATA */
913 frame_len = ntohs(odev->rx_ip_hdr.tot_len);
915 if ((frame_len > DEFAULT_MRU) ||
916 (frame_len < sizeof(struct iphdr))) {
917 dev_err(&odev->net->dev,
918 "Invalid frame (%d) length\n",
920 odev->rx_parse_state = WAIT_SYNC;
923 /* Allocate an sk_buff */
924 odev->skb_rx_buf = netdev_alloc_skb(odev->net,
926 if (!odev->skb_rx_buf) {
927 /* We got no receive buffer. */
928 D1("could not allocate memory");
929 odev->rx_parse_state = WAIT_SYNC;
933 /* Copy what we got so far. make room for iphdr
936 skb_put(odev->skb_rx_buf,
937 sizeof(struct iphdr));
938 memcpy(tmp_rx_buf, (char *)&(odev->rx_ip_hdr),
939 sizeof(struct iphdr));
942 odev->rx_buf_size = sizeof(struct iphdr);
944 /* Filip actually use .tot_len */
945 odev->rx_buf_missing =
946 frame_len - sizeof(struct iphdr);
947 odev->rx_parse_state = WAIT_DATA;
952 temp_bytes = (count < odev->rx_buf_missing)
953 ? count : odev->rx_buf_missing;
955 /* Copy the rest of the bytes that are left in the
956 * buffer into the waiting sk_buf. */
957 /* Make room for temp_bytes after tail. */
958 tmp_rx_buf = skb_put(odev->skb_rx_buf, temp_bytes);
959 memcpy(tmp_rx_buf, ip_pkt + buffer_offset, temp_bytes);
961 odev->rx_buf_missing -= temp_bytes;
963 buffer_offset += temp_bytes;
964 odev->rx_buf_size += temp_bytes;
965 if (!odev->rx_buf_missing) {
966 /* Packet is complete. Inject into stack. */
967 /* We have IP packet here */
968 odev->skb_rx_buf->protocol = cpu_to_be16(ETH_P_IP);
970 odev->skb_rx_buf->ip_summed =
971 CHECKSUM_UNNECESSARY;
973 skb_reset_mac_header(odev->skb_rx_buf);
975 /* Ship it off to the kernel */
976 netif_rx(odev->skb_rx_buf);
977 /* No longer our buffer. */
978 odev->skb_rx_buf = NULL;
980 /* update out statistics */
981 odev->net->stats.rx_packets++;
983 odev->net->stats.rx_bytes += odev->rx_buf_size;
985 odev->rx_buf_size = 0;
986 odev->rx_buf_missing = sizeof(struct iphdr);
987 odev->rx_parse_state = WAIT_IP;
1002 /* Recovery mechanism for WAIT_SYNC state. */
1004 if (odev->rx_parse_state == WAIT_SYNC) {
1005 odev->rx_parse_state = WAIT_IP;
1006 odev->rx_buf_size = 0;
1007 odev->rx_buf_missing = sizeof(struct iphdr);
1012 /* Moving data from usb to kernel (in interrupt state) */
1013 static void read_bulk_callback(struct urb *urb)
1015 struct hso_net *odev = urb->context;
1016 struct net_device *net;
1018 int status = urb->status;
1020 /* is al ok? (Filip: Who's Al ?) */
1022 handle_usb_error(status, __func__, odev->parent);
1027 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
1028 D1("BULK IN callback but driver is not active!");
1031 usb_mark_last_busy(urb->dev);
1035 if (!netif_device_present(net)) {
1036 /* Somebody killed our network interface... */
1040 if (odev->parent->port_spec & HSO_INFO_CRC_BUG) {
1042 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1043 rest = urb->actual_length %
1044 le16_to_cpu(odev->in_endp->wMaxPacketSize);
1045 if (((rest == 5) || (rest == 6)) &&
1046 !memcmp(((u8 *) urb->transfer_buffer) +
1047 urb->actual_length - 4, crc_check, 4)) {
1048 urb->actual_length -= 4;
1052 /* do we even have a packet? */
1053 if (urb->actual_length) {
1054 /* Handle the IP stream, add header and push it onto network
1055 * stack if the packet is complete. */
1056 spin_lock(&odev->net_lock);
1057 packetizeRx(odev, urb->transfer_buffer, urb->actual_length,
1058 (urb->transfer_buffer_length >
1059 urb->actual_length) ? 1 : 0);
1060 spin_unlock(&odev->net_lock);
1063 /* We are done with this URB, resubmit it. Prep the USB to wait for
1064 * another frame. Reuse same as received. */
1065 usb_fill_bulk_urb(urb,
1067 usb_rcvbulkpipe(odev->parent->usb,
1069 bEndpointAddress & 0x7F),
1070 urb->transfer_buffer, MUX_BULK_RX_BUF_SIZE,
1071 read_bulk_callback, odev);
1073 /* Give this to the USB subsystem so it can tell us when more data
1075 result = usb_submit_urb(urb, GFP_ATOMIC);
1077 dev_warn(&odev->parent->interface->dev,
1078 "%s failed submit mux_bulk_rx_urb %d\n", __func__,
1082 /* Serial driver functions */
1084 static void hso_init_termios(struct ktermios *termios)
1087 * The default requirements for this device are:
1090 ~(IGNBRK /* disable ignore break */
1091 | BRKINT /* disable break causes interrupt */
1092 | PARMRK /* disable mark parity errors */
1093 | ISTRIP /* disable clear high bit of input characters */
1094 | INLCR /* disable translate NL to CR */
1095 | IGNCR /* disable ignore CR */
1096 | ICRNL /* disable translate CR to NL */
1097 | IXON); /* disable enable XON/XOFF flow control */
1099 /* disable postprocess output characters */
1100 termios->c_oflag &= ~OPOST;
1103 ~(ECHO /* disable echo input characters */
1104 | ECHONL /* disable echo new line */
1105 | ICANON /* disable erase, kill, werase, and rprnt
1106 special characters */
1107 | ISIG /* disable interrupt, quit, and suspend special
1109 | IEXTEN); /* disable non-POSIX special characters */
1112 ~(CSIZE /* no size */
1113 | PARENB /* disable parity bit */
1114 | CBAUD /* clear current baud rate */
1115 | CBAUDEX); /* clear current buad rate */
1117 termios->c_cflag |= CS8; /* character size 8 bits */
1119 /* baud rate 115200 */
1120 tty_termios_encode_baud_rate(termios, 115200, 115200);
1123 static void _hso_serial_set_termios(struct tty_struct *tty,
1124 struct ktermios *old)
1126 struct hso_serial *serial = get_serial_by_tty(tty);
1127 struct ktermios *termios;
1130 printk(KERN_ERR "%s: no tty structures", __func__);
1134 D4("port %d", serial->minor);
1137 * Fix up unsupported bits
1139 termios = tty->termios;
1140 termios->c_iflag &= ~IXON; /* disable enable XON/XOFF flow control */
1143 ~(CSIZE /* no size */
1144 | PARENB /* disable parity bit */
1145 | CBAUD /* clear current baud rate */
1146 | CBAUDEX); /* clear current buad rate */
1148 termios->c_cflag |= CS8; /* character size 8 bits */
1150 /* baud rate 115200 */
1151 tty_encode_baud_rate(tty, 115200, 115200);
1154 static void hso_resubmit_rx_bulk_urb(struct hso_serial *serial, struct urb *urb)
1157 /* We are done with this URB, resubmit it. Prep the USB to wait for
1159 usb_fill_bulk_urb(urb, serial->parent->usb,
1160 usb_rcvbulkpipe(serial->parent->usb,
1162 bEndpointAddress & 0x7F),
1163 urb->transfer_buffer, serial->rx_data_length,
1164 hso_std_serial_read_bulk_callback, serial);
1165 /* Give this to the USB subsystem so it can tell us when more data
1167 result = usb_submit_urb(urb, GFP_ATOMIC);
1169 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1177 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1180 struct urb *curr_urb;
1182 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1183 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1184 count = put_rxbuf_data(curr_urb, serial);
1188 serial->curr_rx_urb_idx++;
1189 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1190 serial->curr_rx_urb_idx = 0;
1191 hso_resubmit_rx_bulk_urb(serial, curr_urb);
1196 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1201 urb = serial->rx_urb[0];
1202 if (serial->open_count > 0) {
1203 count = put_rxbuf_data(urb, serial);
1207 /* Re issue a read as long as we receive data. */
1209 if (count == 0 && ((urb->actual_length != 0) ||
1210 (serial->rx_state == RX_PENDING))) {
1211 serial->rx_state = RX_SENT;
1212 hso_mux_serial_read(serial);
1214 serial->rx_state = RX_IDLE;
1218 /* read callback for Diag and CS port */
1219 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1221 struct hso_serial *serial = urb->context;
1222 int status = urb->status;
1226 D1("serial == NULL");
1228 } else if (status) {
1229 handle_usb_error(status, __func__, serial->parent);
1233 D4("\n--- Got serial_read_bulk callback %02x ---", status);
1234 D1("Actual length = %d\n", urb->actual_length);
1235 DUMP1(urb->transfer_buffer, urb->actual_length);
1237 /* Anyone listening? */
1238 if (serial->open_count == 0)
1242 if (serial->parent->port_spec & HSO_INFO_CRC_BUG) {
1244 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1246 urb->actual_length %
1247 le16_to_cpu(serial->in_endp->wMaxPacketSize);
1248 if (((rest == 5) || (rest == 6)) &&
1249 !memcmp(((u8 *) urb->transfer_buffer) +
1250 urb->actual_length - 4, crc_check, 4)) {
1251 urb->actual_length -= 4;
1254 /* Valid data, handle RX data */
1255 spin_lock(&serial->serial_lock);
1256 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1257 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1258 spin_unlock(&serial->serial_lock);
1259 } else if (status == -ENOENT || status == -ECONNRESET) {
1260 /* Unlinked - check for throttled port. */
1261 D2("Port %d, successfully unlinked urb", serial->minor);
1262 spin_lock(&serial->serial_lock);
1263 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
1264 hso_resubmit_rx_bulk_urb(serial, urb);
1265 spin_unlock(&serial->serial_lock);
1267 D2("Port %d, status = %d for read urb", serial->minor, status);
1273 * This needs to be a tasklet otherwise we will
1274 * end up recursively calling this function.
1276 static void hso_unthrottle_tasklet(struct hso_serial *serial)
1278 unsigned long flags;
1280 spin_lock_irqsave(&serial->serial_lock, flags);
1281 if ((serial->parent->port_spec & HSO_INTF_MUX))
1282 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1284 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1285 spin_unlock_irqrestore(&serial->serial_lock, flags);
1288 static void hso_unthrottle(struct tty_struct *tty)
1290 struct hso_serial *serial = get_serial_by_tty(tty);
1292 tasklet_hi_schedule(&serial->unthrottle_tasklet);
1295 static void hso_unthrottle_workfunc(struct work_struct *work)
1297 struct hso_serial *serial =
1298 container_of(work, struct hso_serial,
1299 retry_unthrottle_workqueue);
1300 hso_unthrottle_tasklet(serial);
1303 /* open the requested serial port */
1304 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1306 struct hso_serial *serial = get_serial_by_index(tty->index);
1310 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1312 tty->driver_data = NULL;
1313 D1("Failed to open port");
1317 mutex_lock(&serial->parent->mutex);
1318 result = usb_autopm_get_interface(serial->parent->interface);
1322 D1("Opening %d", serial->minor);
1323 kref_get(&serial->parent->ref);
1326 spin_lock_irq(&serial->serial_lock);
1327 tty->driver_data = serial;
1328 tty_kref_put(serial->tty);
1329 serial->tty = tty_kref_get(tty);
1330 spin_unlock_irq(&serial->serial_lock);
1332 /* check for port already opened, if not set the termios */
1333 serial->open_count++;
1334 if (serial->open_count == 1) {
1335 serial->rx_state = RX_IDLE;
1336 /* Force default termio settings */
1337 _hso_serial_set_termios(tty, NULL);
1338 tasklet_init(&serial->unthrottle_tasklet,
1339 (void (*)(unsigned long))hso_unthrottle_tasklet,
1340 (unsigned long)serial);
1341 INIT_WORK(&serial->retry_unthrottle_workqueue,
1342 hso_unthrottle_workfunc);
1343 result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1345 hso_stop_serial_device(serial->parent);
1346 serial->open_count--;
1347 kref_put(&serial->parent->ref, hso_serial_ref_free);
1350 D1("Port was already open");
1353 usb_autopm_put_interface(serial->parent->interface);
1357 hso_serial_tiocmset(tty, NULL, TIOCM_RTS | TIOCM_DTR, 0);
1359 mutex_unlock(&serial->parent->mutex);
1363 /* close the requested serial port */
1364 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1366 struct hso_serial *serial = tty->driver_data;
1369 D1("Closing serial port");
1371 /* Open failed, no close cleanup required */
1375 mutex_lock(&serial->parent->mutex);
1376 usb_gone = serial->parent->usb_gone;
1379 usb_autopm_get_interface(serial->parent->interface);
1381 /* reset the rts and dtr */
1382 /* do the actual close */
1383 serial->open_count--;
1385 if (serial->open_count <= 0) {
1386 serial->open_count = 0;
1387 spin_lock_irq(&serial->serial_lock);
1388 if (serial->tty == tty) {
1389 serial->tty->driver_data = NULL;
1393 spin_unlock_irq(&serial->serial_lock);
1395 hso_stop_serial_device(serial->parent);
1396 tasklet_kill(&serial->unthrottle_tasklet);
1397 cancel_work_sync(&serial->retry_unthrottle_workqueue);
1401 usb_autopm_put_interface(serial->parent->interface);
1403 mutex_unlock(&serial->parent->mutex);
1405 kref_put(&serial->parent->ref, hso_serial_ref_free);
1408 /* close the requested serial port */
1409 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1412 struct hso_serial *serial = get_serial_by_tty(tty);
1413 int space, tx_bytes;
1414 unsigned long flags;
1417 if (serial == NULL) {
1418 printk(KERN_ERR "%s: serial is NULL\n", __func__);
1422 spin_lock_irqsave(&serial->serial_lock, flags);
1424 space = serial->tx_data_length - serial->tx_buffer_count;
1425 tx_bytes = (count < space) ? count : space;
1430 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1431 serial->tx_buffer_count += tx_bytes;
1434 spin_unlock_irqrestore(&serial->serial_lock, flags);
1436 hso_kick_transmit(serial);
1441 /* how much room is there for writing */
1442 static int hso_serial_write_room(struct tty_struct *tty)
1444 struct hso_serial *serial = get_serial_by_tty(tty);
1446 unsigned long flags;
1448 spin_lock_irqsave(&serial->serial_lock, flags);
1449 room = serial->tx_data_length - serial->tx_buffer_count;
1450 spin_unlock_irqrestore(&serial->serial_lock, flags);
1452 /* return free room */
1456 /* setup the term */
1457 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1459 struct hso_serial *serial = get_serial_by_tty(tty);
1460 unsigned long flags;
1463 D5("Termios called with: cflags new[%d] - old[%d]",
1464 tty->termios->c_cflag, old->c_cflag);
1466 /* the actual setup */
1467 spin_lock_irqsave(&serial->serial_lock, flags);
1468 if (serial->open_count)
1469 _hso_serial_set_termios(tty, old);
1472 spin_unlock_irqrestore(&serial->serial_lock, flags);
1477 /* how many characters in the buffer */
1478 static int hso_serial_chars_in_buffer(struct tty_struct *tty)
1480 struct hso_serial *serial = get_serial_by_tty(tty);
1482 unsigned long flags;
1488 spin_lock_irqsave(&serial->serial_lock, flags);
1489 chars = serial->tx_buffer_count;
1490 spin_unlock_irqrestore(&serial->serial_lock, flags);
1494 static int tiocmget_submit_urb(struct hso_serial *serial,
1495 struct hso_tiocmget *tiocmget,
1496 struct usb_device *usb)
1500 if (serial->parent->usb_gone)
1502 usb_fill_int_urb(tiocmget->urb, usb,
1505 bEndpointAddress & 0x7F),
1506 &tiocmget->serial_state_notification,
1507 sizeof(struct hso_serial_state_notification),
1508 tiocmget_intr_callback, serial,
1509 tiocmget->endp->bInterval);
1510 result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC);
1512 dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__,
1519 static void tiocmget_intr_callback(struct urb *urb)
1521 struct hso_serial *serial = urb->context;
1522 struct hso_tiocmget *tiocmget;
1523 int status = urb->status;
1524 u16 UART_state_bitmap, prev_UART_state_bitmap;
1525 struct uart_icount *icount;
1526 struct hso_serial_state_notification *serial_state_notification;
1527 struct usb_device *usb;
1533 handle_usb_error(status, __func__, serial->parent);
1536 tiocmget = serial->tiocmget;
1539 usb = serial->parent->usb;
1540 serial_state_notification = &tiocmget->serial_state_notification;
1541 if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1542 serial_state_notification->bNotification != B_NOTIFICATION ||
1543 le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1544 le16_to_cpu(serial_state_notification->wIndex) != W_INDEX ||
1545 le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1547 "hso received invalid serial state notification\n");
1548 DUMP(serial_state_notification,
1549 sizeof(struct hso_serial_state_notification));
1552 UART_state_bitmap = le16_to_cpu(serial_state_notification->
1554 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1555 icount = &tiocmget->icount;
1556 spin_lock(&serial->serial_lock);
1557 if ((UART_state_bitmap & B_OVERRUN) !=
1558 (prev_UART_state_bitmap & B_OVERRUN))
1560 if ((UART_state_bitmap & B_PARITY) !=
1561 (prev_UART_state_bitmap & B_PARITY))
1563 if ((UART_state_bitmap & B_FRAMING) !=
1564 (prev_UART_state_bitmap & B_FRAMING))
1566 if ((UART_state_bitmap & B_RING_SIGNAL) &&
1567 !(prev_UART_state_bitmap & B_RING_SIGNAL))
1569 if ((UART_state_bitmap & B_BREAK) !=
1570 (prev_UART_state_bitmap & B_BREAK))
1572 if ((UART_state_bitmap & B_TX_CARRIER) !=
1573 (prev_UART_state_bitmap & B_TX_CARRIER))
1575 if ((UART_state_bitmap & B_RX_CARRIER) !=
1576 (prev_UART_state_bitmap & B_RX_CARRIER))
1578 tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1579 spin_unlock(&serial->serial_lock);
1580 tiocmget->intr_completed = 1;
1581 wake_up_interruptible(&tiocmget->waitq);
1583 memset(serial_state_notification, 0,
1584 sizeof(struct hso_serial_state_notification));
1585 tiocmget_submit_urb(serial,
1587 serial->parent->usb);
1591 * next few functions largely stolen from drivers/serial/serial_core.c
1593 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1594 * - mask passed in arg for lines of interest
1595 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1596 * Caller should use TIOCGICOUNT to see which one it was
1599 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1601 DECLARE_WAITQUEUE(wait, current);
1602 struct uart_icount cprev, cnow;
1603 struct hso_tiocmget *tiocmget;
1606 tiocmget = serial->tiocmget;
1610 * note the counters on entry
1612 spin_lock_irq(&serial->serial_lock);
1613 memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1614 spin_unlock_irq(&serial->serial_lock);
1615 add_wait_queue(&tiocmget->waitq, &wait);
1617 spin_lock_irq(&serial->serial_lock);
1618 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1619 spin_unlock_irq(&serial->serial_lock);
1620 set_current_state(TASK_INTERRUPTIBLE);
1621 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1622 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1623 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd))) {
1628 /* see if a signal did it */
1629 if (signal_pending(current)) {
1635 current->state = TASK_RUNNING;
1636 remove_wait_queue(&tiocmget->waitq, &wait);
1642 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1643 * Return: write counters to the user passed counter struct
1644 * NB: both 1->0 and 0->1 transitions are counted except for
1645 * RI where only 0->1 is counted.
1647 static int hso_get_count(struct hso_serial *serial,
1648 struct serial_icounter_struct __user *icnt)
1650 struct serial_icounter_struct icount;
1651 struct uart_icount cnow;
1652 struct hso_tiocmget *tiocmget = serial->tiocmget;
1656 spin_lock_irq(&serial->serial_lock);
1657 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1658 spin_unlock_irq(&serial->serial_lock);
1660 icount.cts = cnow.cts;
1661 icount.dsr = cnow.dsr;
1662 icount.rng = cnow.rng;
1663 icount.dcd = cnow.dcd;
1664 icount.rx = cnow.rx;
1665 icount.tx = cnow.tx;
1666 icount.frame = cnow.frame;
1667 icount.overrun = cnow.overrun;
1668 icount.parity = cnow.parity;
1669 icount.brk = cnow.brk;
1670 icount.buf_overrun = cnow.buf_overrun;
1672 return copy_to_user(icnt, &icount, sizeof(icount)) ? -EFAULT : 0;
1676 static int hso_serial_tiocmget(struct tty_struct *tty, struct file *file)
1679 struct hso_serial *serial = get_serial_by_tty(tty);
1680 struct hso_tiocmget *tiocmget;
1681 u16 UART_state_bitmap;
1685 D1("no tty structures");
1688 spin_lock_irq(&serial->serial_lock);
1689 retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1690 ((serial->dtr_state) ? TIOCM_DTR : 0);
1691 tiocmget = serial->tiocmget;
1694 UART_state_bitmap = le16_to_cpu(
1695 tiocmget->prev_UART_state_bitmap);
1696 if (UART_state_bitmap & B_RING_SIGNAL)
1697 retval |= TIOCM_RNG;
1698 if (UART_state_bitmap & B_RX_CARRIER)
1700 if (UART_state_bitmap & B_TX_CARRIER)
1701 retval |= TIOCM_DSR;
1703 spin_unlock_irq(&serial->serial_lock);
1707 static int hso_serial_tiocmset(struct tty_struct *tty, struct file *file,
1708 unsigned int set, unsigned int clear)
1711 unsigned long flags;
1713 struct hso_serial *serial = get_serial_by_tty(tty);
1717 D1("no tty structures");
1721 if ((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM)
1724 if_num = serial->parent->interface->altsetting->desc.bInterfaceNumber;
1726 spin_lock_irqsave(&serial->serial_lock, flags);
1727 if (set & TIOCM_RTS)
1728 serial->rts_state = 1;
1729 if (set & TIOCM_DTR)
1730 serial->dtr_state = 1;
1732 if (clear & TIOCM_RTS)
1733 serial->rts_state = 0;
1734 if (clear & TIOCM_DTR)
1735 serial->dtr_state = 0;
1737 if (serial->dtr_state)
1739 if (serial->rts_state)
1742 spin_unlock_irqrestore(&serial->serial_lock, flags);
1744 return usb_control_msg(serial->parent->usb,
1745 usb_rcvctrlpipe(serial->parent->usb, 0), 0x22,
1746 0x21, val, if_num, NULL, 0,
1747 USB_CTRL_SET_TIMEOUT);
1750 static int hso_serial_ioctl(struct tty_struct *tty, struct file *file,
1751 unsigned int cmd, unsigned long arg)
1753 struct hso_serial *serial = get_serial_by_tty(tty);
1754 void __user *uarg = (void __user *)arg;
1756 D4("IOCTL cmd: %d, arg: %ld", cmd, arg);
1762 ret = hso_wait_modem_status(serial, arg);
1766 ret = hso_get_count(serial, uarg);
1776 /* starts a transmit */
1777 static void hso_kick_transmit(struct hso_serial *serial)
1780 unsigned long flags;
1783 spin_lock_irqsave(&serial->serial_lock, flags);
1784 if (!serial->tx_buffer_count)
1787 if (serial->tx_urb_used)
1790 /* Wakeup USB interface if necessary */
1791 if (hso_get_activity(serial->parent) == -EAGAIN)
1794 /* Switch pointers around to avoid memcpy */
1795 temp = serial->tx_buffer;
1796 serial->tx_buffer = serial->tx_data;
1797 serial->tx_data = temp;
1798 serial->tx_data_count = serial->tx_buffer_count;
1799 serial->tx_buffer_count = 0;
1801 /* If temp is set, it means we switched buffers */
1802 if (temp && serial->write_data) {
1803 res = serial->write_data(serial);
1805 serial->tx_urb_used = 1;
1808 spin_unlock_irqrestore(&serial->serial_lock, flags);
1811 /* make a request (for reading and writing data to muxed serial port) */
1812 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1813 struct urb *ctrl_urb,
1814 struct usb_ctrlrequest *ctrl_req,
1815 u8 *ctrl_urb_data, u32 size)
1821 if (!serial || !ctrl_urb || !ctrl_req) {
1822 printk(KERN_ERR "%s: Wrong arguments\n", __func__);
1827 ctrl_req->wValue = 0;
1828 ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1829 ctrl_req->wLength = cpu_to_le16(size);
1831 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1832 /* Reading command */
1833 ctrl_req->bRequestType = USB_DIR_IN |
1834 USB_TYPE_OPTION_VENDOR |
1835 USB_RECIP_INTERFACE;
1836 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1837 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1839 /* Writing command */
1840 ctrl_req->bRequestType = USB_DIR_OUT |
1841 USB_TYPE_OPTION_VENDOR |
1842 USB_RECIP_INTERFACE;
1843 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1844 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1847 D2("%s command (%02x) len: %d, port: %d",
1848 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1849 ctrl_req->bRequestType, ctrl_req->wLength, port);
1852 ctrl_urb->transfer_flags = 0;
1853 usb_fill_control_urb(ctrl_urb,
1854 serial->parent->usb,
1857 ctrl_urb_data, size, ctrl_callback, serial);
1858 /* Send it on merry way */
1859 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1861 dev_err(&ctrl_urb->dev->dev,
1862 "%s failed submit ctrl_urb %d type %d\n", __func__,
1871 /* called by intr_callback when read occurs */
1872 static int hso_mux_serial_read(struct hso_serial *serial)
1878 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1879 /* make the request */
1881 if (serial->num_rx_urbs != 1) {
1882 dev_err(&serial->parent->interface->dev,
1883 "ERROR: mux'd reads with multiple buffers "
1887 return mux_device_request(serial,
1888 USB_CDC_GET_ENCAPSULATED_RESPONSE,
1889 serial->parent->port_spec & HSO_PORT_MASK,
1891 &serial->ctrl_req_rx,
1892 serial->rx_data[0], serial->rx_data_length);
1895 /* used for muxed serial port callback (muxed serial read) */
1896 static void intr_callback(struct urb *urb)
1898 struct hso_shared_int *shared_int = urb->context;
1899 struct hso_serial *serial;
1900 unsigned char *port_req;
1901 int status = urb->status;
1904 usb_mark_last_busy(urb->dev);
1912 handle_usb_error(status, __func__, NULL);
1915 D4("\n--- Got intr callback 0x%02X ---", status);
1918 port_req = urb->transfer_buffer;
1919 D4(" port_req = 0x%.2X\n", *port_req);
1920 /* loop over all muxed ports to find the one sending this */
1921 for (i = 0; i < 8; i++) {
1922 /* max 8 channels on MUX */
1923 if (*port_req & (1 << i)) {
1924 serial = get_serial_by_shared_int_and_type(shared_int,
1926 if (serial != NULL) {
1927 D1("Pending read interrupt on port %d\n", i);
1928 spin_lock(&serial->serial_lock);
1929 if (serial->rx_state == RX_IDLE &&
1930 serial->open_count > 0) {
1931 /* Setup and send a ctrl req read on
1933 if (!serial->rx_urb_filled[0]) {
1934 serial->rx_state = RX_SENT;
1935 hso_mux_serial_read(serial);
1937 serial->rx_state = RX_PENDING;
1939 D1("Already a read pending on "
1940 "port %d or port not open\n", i);
1942 spin_unlock(&serial->serial_lock);
1946 /* Resubmit interrupt urb */
1947 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1950 /* called for writing to muxed serial port */
1951 static int hso_mux_serial_write_data(struct hso_serial *serial)
1956 return mux_device_request(serial,
1957 USB_CDC_SEND_ENCAPSULATED_COMMAND,
1958 serial->parent->port_spec & HSO_PORT_MASK,
1960 &serial->ctrl_req_tx,
1961 serial->tx_data, serial->tx_data_count);
1964 /* write callback for Diag and CS port */
1965 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1967 struct hso_serial *serial = urb->context;
1968 int status = urb->status;
1969 struct tty_struct *tty;
1973 D1("serial == NULL");
1977 spin_lock(&serial->serial_lock);
1978 serial->tx_urb_used = 0;
1979 tty = tty_kref_get(serial->tty);
1980 spin_unlock(&serial->serial_lock);
1982 handle_usb_error(status, __func__, serial->parent);
1986 hso_put_activity(serial->parent);
1991 hso_kick_transmit(serial);
1996 /* called for writing diag or CS serial port */
1997 static int hso_std_serial_write_data(struct hso_serial *serial)
1999 int count = serial->tx_data_count;
2002 usb_fill_bulk_urb(serial->tx_urb,
2003 serial->parent->usb,
2004 usb_sndbulkpipe(serial->parent->usb,
2006 bEndpointAddress & 0x7F),
2007 serial->tx_data, serial->tx_data_count,
2008 hso_std_serial_write_bulk_callback, serial);
2010 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
2012 dev_warn(&serial->parent->usb->dev,
2013 "Failed to submit urb - res %d\n", result);
2020 /* callback after read or write on muxed serial port */
2021 static void ctrl_callback(struct urb *urb)
2023 struct hso_serial *serial = urb->context;
2024 struct usb_ctrlrequest *req;
2025 int status = urb->status;
2026 struct tty_struct *tty;
2032 spin_lock(&serial->serial_lock);
2033 serial->tx_urb_used = 0;
2034 tty = tty_kref_get(serial->tty);
2035 spin_unlock(&serial->serial_lock);
2037 handle_usb_error(status, __func__, serial->parent);
2043 req = (struct usb_ctrlrequest *)(urb->setup_packet);
2044 D4("\n--- Got muxed ctrl callback 0x%02X ---", status);
2045 D4("Actual length of urb = %d\n", urb->actual_length);
2046 DUMP1(urb->transfer_buffer, urb->actual_length);
2048 if (req->bRequestType ==
2049 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
2050 /* response to a read command */
2051 serial->rx_urb_filled[0] = 1;
2052 spin_lock(&serial->serial_lock);
2053 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
2054 spin_unlock(&serial->serial_lock);
2056 hso_put_activity(serial->parent);
2059 /* response to a write command */
2060 hso_kick_transmit(serial);
2065 /* handle RX data for serial port */
2066 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
2068 struct tty_struct *tty;
2069 int write_length_remaining = 0;
2073 if (urb == NULL || serial == NULL) {
2074 D1("serial = NULL");
2078 /* All callers to put_rxbuf_data hold serial_lock */
2079 tty = tty_kref_get(serial->tty);
2081 /* Push data to tty */
2083 write_length_remaining = urb->actual_length -
2084 serial->curr_rx_urb_offset;
2085 D1("data to push to tty");
2086 while (write_length_remaining) {
2087 if (test_bit(TTY_THROTTLED, &tty->flags)) {
2091 curr_write_len = tty_insert_flip_string
2092 (tty, urb->transfer_buffer +
2093 serial->curr_rx_urb_offset,
2094 write_length_remaining);
2095 serial->curr_rx_urb_offset += curr_write_len;
2096 write_length_remaining -= curr_write_len;
2097 tty_flip_buffer_push(tty);
2100 if (write_length_remaining == 0) {
2101 serial->curr_rx_urb_offset = 0;
2102 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2105 return write_length_remaining;
2109 /* Base driver functions */
2111 static void hso_log_port(struct hso_device *hso_dev)
2116 switch (hso_dev->port_spec & HSO_PORT_MASK) {
2117 case HSO_PORT_CONTROL:
2118 port_type = "Control";
2121 port_type = "Application";
2126 case HSO_PORT_GPS_CONTROL:
2127 port_type = "GPS control";
2130 port_type = "Application2";
2136 port_type = "Diagnostic";
2138 case HSO_PORT_DIAG2:
2139 port_type = "Diagnostic2";
2141 case HSO_PORT_MODEM:
2142 port_type = "Modem";
2144 case HSO_PORT_NETWORK:
2145 port_type = "Network";
2148 port_type = "Unknown";
2151 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2152 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2154 sprintf(port_dev, "/dev/%s%d", tty_filename,
2155 dev2ser(hso_dev)->minor);
2157 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2158 port_type, port_dev);
2161 static int hso_start_net_device(struct hso_device *hso_dev)
2164 struct hso_net *hso_net = dev2net(hso_dev);
2169 /* send URBs for all read buffers */
2170 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2172 /* Prep a receive URB */
2173 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2175 usb_rcvbulkpipe(hso_dev->usb,
2177 bEndpointAddress & 0x7F),
2178 hso_net->mux_bulk_rx_buf_pool[i],
2179 MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2182 /* Put it out there so the device can send us stuff */
2183 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2186 dev_warn(&hso_dev->usb->dev,
2187 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2194 static int hso_stop_net_device(struct hso_device *hso_dev)
2197 struct hso_net *hso_net = dev2net(hso_dev);
2202 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2203 if (hso_net->mux_bulk_rx_urb_pool[i])
2204 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2207 if (hso_net->mux_bulk_tx_urb)
2208 usb_kill_urb(hso_net->mux_bulk_tx_urb);
2213 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2216 struct hso_serial *serial = dev2ser(hso_dev);
2221 /* If it is not the MUX port fill in and submit a bulk urb (already
2222 * allocated in hso_serial_start) */
2223 if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2224 for (i = 0; i < serial->num_rx_urbs; i++) {
2225 usb_fill_bulk_urb(serial->rx_urb[i],
2226 serial->parent->usb,
2227 usb_rcvbulkpipe(serial->parent->usb,
2232 serial->rx_data_length,
2233 hso_std_serial_read_bulk_callback,
2235 result = usb_submit_urb(serial->rx_urb[i], flags);
2237 dev_warn(&serial->parent->usb->dev,
2238 "Failed to submit urb - res %d\n",
2244 mutex_lock(&serial->shared_int->shared_int_lock);
2245 if (!serial->shared_int->use_count) {
2247 hso_mux_submit_intr_urb(serial->shared_int,
2248 hso_dev->usb, flags);
2250 serial->shared_int->use_count++;
2251 mutex_unlock(&serial->shared_int->shared_int_lock);
2253 if (serial->tiocmget)
2254 tiocmget_submit_urb(serial,
2256 serial->parent->usb);
2260 static int hso_stop_serial_device(struct hso_device *hso_dev)
2263 struct hso_serial *serial = dev2ser(hso_dev);
2264 struct hso_tiocmget *tiocmget;
2269 for (i = 0; i < serial->num_rx_urbs; i++) {
2270 if (serial->rx_urb[i]) {
2271 usb_kill_urb(serial->rx_urb[i]);
2272 serial->rx_urb_filled[i] = 0;
2275 serial->curr_rx_urb_idx = 0;
2276 serial->curr_rx_urb_offset = 0;
2279 usb_kill_urb(serial->tx_urb);
2281 if (serial->shared_int) {
2282 mutex_lock(&serial->shared_int->shared_int_lock);
2283 if (serial->shared_int->use_count &&
2284 (--serial->shared_int->use_count == 0)) {
2287 urb = serial->shared_int->shared_intr_urb;
2291 mutex_unlock(&serial->shared_int->shared_int_lock);
2293 tiocmget = serial->tiocmget;
2295 wake_up_interruptible(&tiocmget->waitq);
2296 usb_kill_urb(tiocmget->urb);
2302 static void hso_serial_common_free(struct hso_serial *serial)
2306 if (serial->parent->dev)
2307 device_remove_file(serial->parent->dev, &dev_attr_hsotype);
2309 tty_unregister_device(tty_drv, serial->minor);
2311 for (i = 0; i < serial->num_rx_urbs; i++) {
2312 /* unlink and free RX URB */
2313 usb_free_urb(serial->rx_urb[i]);
2314 /* free the RX buffer */
2315 kfree(serial->rx_data[i]);
2318 /* unlink and free TX URB */
2319 usb_free_urb(serial->tx_urb);
2320 kfree(serial->tx_data);
2323 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
2324 int rx_size, int tx_size)
2330 minor = get_free_serial_index();
2334 /* register our minor number */
2335 serial->parent->dev = tty_register_device(tty_drv, minor,
2336 &serial->parent->interface->dev);
2337 dev = serial->parent->dev;
2338 dev_set_drvdata(dev, serial->parent);
2339 i = device_create_file(dev, &dev_attr_hsotype);
2341 /* fill in specific data for later use */
2342 serial->minor = minor;
2343 serial->magic = HSO_SERIAL_MAGIC;
2344 spin_lock_init(&serial->serial_lock);
2345 serial->num_rx_urbs = num_urbs;
2347 /* RX, allocate urb and initialize */
2349 /* prepare our RX buffer */
2350 serial->rx_data_length = rx_size;
2351 for (i = 0; i < serial->num_rx_urbs; i++) {
2352 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2353 if (!serial->rx_urb[i]) {
2354 dev_err(dev, "Could not allocate urb?\n");
2357 serial->rx_urb[i]->transfer_buffer = NULL;
2358 serial->rx_urb[i]->transfer_buffer_length = 0;
2359 serial->rx_data[i] = kzalloc(serial->rx_data_length,
2361 if (!serial->rx_data[i]) {
2362 dev_err(dev, "%s - Out of memory\n", __func__);
2367 /* TX, allocate urb and initialize */
2368 serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2369 if (!serial->tx_urb) {
2370 dev_err(dev, "Could not allocate urb?\n");
2373 serial->tx_urb->transfer_buffer = NULL;
2374 serial->tx_urb->transfer_buffer_length = 0;
2375 /* prepare our TX buffer */
2376 serial->tx_data_count = 0;
2377 serial->tx_buffer_count = 0;
2378 serial->tx_data_length = tx_size;
2379 serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2380 if (!serial->tx_data) {
2381 dev_err(dev, "%s - Out of memory\n", __func__);
2384 serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2385 if (!serial->tx_buffer) {
2386 dev_err(dev, "%s - Out of memory\n", __func__);
2392 hso_serial_common_free(serial);
2396 /* Creates a general hso device */
2397 static struct hso_device *hso_create_device(struct usb_interface *intf,
2400 struct hso_device *hso_dev;
2402 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2406 hso_dev->port_spec = port_spec;
2407 hso_dev->usb = interface_to_usbdev(intf);
2408 hso_dev->interface = intf;
2409 kref_init(&hso_dev->ref);
2410 mutex_init(&hso_dev->mutex);
2412 INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2413 INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2414 INIT_WORK(&hso_dev->reset_device, reset_device);
2419 /* Removes a network device in the network device table */
2420 static int remove_net_device(struct hso_device *hso_dev)
2424 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2425 if (network_table[i] == hso_dev) {
2426 network_table[i] = NULL;
2430 if (i == HSO_MAX_NET_DEVICES)
2435 /* Frees our network device */
2436 static void hso_free_net_device(struct hso_device *hso_dev)
2439 struct hso_net *hso_net = dev2net(hso_dev);
2444 remove_net_device(hso_net->parent);
2447 unregister_netdev(hso_net->net);
2448 free_netdev(hso_net->net);
2452 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2453 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2454 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2455 hso_net->mux_bulk_rx_buf_pool[i] = NULL;
2457 usb_free_urb(hso_net->mux_bulk_tx_urb);
2458 kfree(hso_net->mux_bulk_tx_buf);
2459 hso_net->mux_bulk_tx_buf = NULL;
2464 static const struct net_device_ops hso_netdev_ops = {
2465 .ndo_open = hso_net_open,
2466 .ndo_stop = hso_net_close,
2467 .ndo_start_xmit = hso_net_start_xmit,
2468 .ndo_tx_timeout = hso_net_tx_timeout,
2471 /* initialize the network interface */
2472 static void hso_net_init(struct net_device *net)
2474 struct hso_net *hso_net = netdev_priv(net);
2476 D1("sizeof hso_net is %d", (int)sizeof(*hso_net));
2478 /* fill in the other fields */
2479 net->netdev_ops = &hso_netdev_ops;
2480 net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2481 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2482 net->type = ARPHRD_NONE;
2483 net->mtu = DEFAULT_MTU - 14;
2484 net->tx_queue_len = 10;
2485 SET_ETHTOOL_OPS(net, &ops);
2487 /* and initialize the semaphore */
2488 spin_lock_init(&hso_net->net_lock);
2491 /* Adds a network device in the network device table */
2492 static int add_net_device(struct hso_device *hso_dev)
2496 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2497 if (network_table[i] == NULL) {
2498 network_table[i] = hso_dev;
2502 if (i == HSO_MAX_NET_DEVICES)
2507 static int hso_rfkill_set_block(void *data, bool blocked)
2509 struct hso_device *hso_dev = data;
2510 int enabled = !blocked;
2513 mutex_lock(&hso_dev->mutex);
2514 if (hso_dev->usb_gone)
2517 rv = usb_control_msg(hso_dev->usb, usb_rcvctrlpipe(hso_dev->usb, 0),
2518 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2519 USB_CTRL_SET_TIMEOUT);
2520 mutex_unlock(&hso_dev->mutex);
2524 static const struct rfkill_ops hso_rfkill_ops = {
2525 .set_block = hso_rfkill_set_block,
2528 /* Creates and sets up everything for rfkill */
2529 static void hso_create_rfkill(struct hso_device *hso_dev,
2530 struct usb_interface *interface)
2532 struct hso_net *hso_net = dev2net(hso_dev);
2533 struct device *dev = &hso_net->net->dev;
2536 rfkn = kzalloc(20, GFP_KERNEL);
2538 dev_err(dev, "%s - Out of memory\n", __func__);
2540 snprintf(rfkn, 20, "hso-%d",
2541 interface->altsetting->desc.bInterfaceNumber);
2543 hso_net->rfkill = rfkill_alloc(rfkn,
2544 &interface_to_usbdev(interface)->dev,
2546 &hso_rfkill_ops, hso_dev);
2547 if (!hso_net->rfkill) {
2548 dev_err(dev, "%s - Out of memory\n", __func__);
2552 if (rfkill_register(hso_net->rfkill) < 0) {
2553 rfkill_destroy(hso_net->rfkill);
2555 hso_net->rfkill = NULL;
2556 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2561 static struct device_type hso_type = {
2565 /* Creates our network device */
2566 static struct hso_device *hso_create_net_device(struct usb_interface *interface,
2570 struct net_device *net;
2571 struct hso_net *hso_net;
2572 struct hso_device *hso_dev;
2574 hso_dev = hso_create_device(interface, port_spec);
2578 /* allocate our network device, then we can put in our private data */
2579 /* call hso_net_init to do the basic initialization */
2580 net = alloc_netdev(sizeof(struct hso_net), "hso%d", hso_net_init);
2582 dev_err(&interface->dev, "Unable to create ethernet device\n");
2586 hso_net = netdev_priv(net);
2588 hso_dev->port_data.dev_net = hso_net;
2590 hso_net->parent = hso_dev;
2592 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2594 if (!hso_net->in_endp) {
2595 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2598 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2600 if (!hso_net->out_endp) {
2601 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2604 SET_NETDEV_DEV(net, &interface->dev);
2605 SET_NETDEV_DEVTYPE(net, &hso_type);
2607 /* registering our net device */
2608 result = register_netdev(net);
2610 dev_err(&interface->dev, "Failed to register device\n");
2614 /* start allocating */
2615 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2616 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2617 if (!hso_net->mux_bulk_rx_urb_pool[i]) {
2618 dev_err(&interface->dev, "Could not allocate rx urb\n");
2621 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2623 if (!hso_net->mux_bulk_rx_buf_pool[i]) {
2624 dev_err(&interface->dev, "Could not allocate rx buf\n");
2628 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2629 if (!hso_net->mux_bulk_tx_urb) {
2630 dev_err(&interface->dev, "Could not allocate tx urb\n");
2633 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2634 if (!hso_net->mux_bulk_tx_buf) {
2635 dev_err(&interface->dev, "Could not allocate tx buf\n");
2639 add_net_device(hso_dev);
2641 hso_log_port(hso_dev);
2643 hso_create_rfkill(hso_dev, interface);
2647 hso_free_net_device(hso_dev);
2651 static void hso_free_tiomget(struct hso_serial *serial)
2653 struct hso_tiocmget *tiocmget = serial->tiocmget;
2655 if (tiocmget->urb) {
2656 usb_free_urb(tiocmget->urb);
2657 tiocmget->urb = NULL;
2659 serial->tiocmget = NULL;
2665 /* Frees an AT channel ( goes for both mux and non-mux ) */
2666 static void hso_free_serial_device(struct hso_device *hso_dev)
2668 struct hso_serial *serial = dev2ser(hso_dev);
2672 set_serial_by_index(serial->minor, NULL);
2674 hso_serial_common_free(serial);
2676 if (serial->shared_int) {
2677 mutex_lock(&serial->shared_int->shared_int_lock);
2678 if (--serial->shared_int->ref_count == 0)
2679 hso_free_shared_int(serial->shared_int);
2681 mutex_unlock(&serial->shared_int->shared_int_lock);
2683 hso_free_tiomget(serial);
2688 /* Creates a bulk AT channel */
2689 static struct hso_device *hso_create_bulk_serial_device(
2690 struct usb_interface *interface, int port)
2692 struct hso_device *hso_dev;
2693 struct hso_serial *serial;
2695 struct hso_tiocmget *tiocmget;
2697 hso_dev = hso_create_device(interface, port);
2701 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2705 serial->parent = hso_dev;
2706 hso_dev->port_data.dev_serial = serial;
2708 if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2710 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2712 /* it isn't going to break our heart if serial->tiocmget
2713 * allocation fails don't bother checking this.
2715 if (serial->tiocmget) {
2716 tiocmget = serial->tiocmget;
2717 tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2718 if (tiocmget->urb) {
2719 mutex_init(&tiocmget->mutex);
2720 init_waitqueue_head(&tiocmget->waitq);
2721 tiocmget->endp = hso_get_ep(
2723 USB_ENDPOINT_XFER_INT,
2726 hso_free_tiomget(serial);
2732 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2736 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2738 if (!serial->in_endp) {
2739 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2745 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2746 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2750 serial->write_data = hso_std_serial_write_data;
2752 /* and record this serial */
2753 set_serial_by_index(serial->minor, serial);
2755 /* setup the proc dirs and files if needed */
2756 hso_log_port(hso_dev);
2758 /* done, return it */
2762 hso_serial_common_free(serial);
2764 hso_free_tiomget(serial);
2770 /* Creates a multiplexed AT channel */
2772 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2774 struct hso_shared_int *mux)
2776 struct hso_device *hso_dev;
2777 struct hso_serial *serial;
2780 port_spec = HSO_INTF_MUX;
2781 port_spec &= ~HSO_PORT_MASK;
2783 port_spec |= hso_mux_to_port(port);
2784 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2787 hso_dev = hso_create_device(interface, port_spec);
2791 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2795 hso_dev->port_data.dev_serial = serial;
2796 serial->parent = hso_dev;
2798 if (hso_serial_common_create
2799 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2802 serial->tx_data_length--;
2803 serial->write_data = hso_mux_serial_write_data;
2805 serial->shared_int = mux;
2806 mutex_lock(&serial->shared_int->shared_int_lock);
2807 serial->shared_int->ref_count++;
2808 mutex_unlock(&serial->shared_int->shared_int_lock);
2810 /* and record this serial */
2811 set_serial_by_index(serial->minor, serial);
2813 /* setup the proc dirs and files if needed */
2814 hso_log_port(hso_dev);
2816 /* done, return it */
2821 tty_unregister_device(tty_drv, serial->minor);
2830 static void hso_free_shared_int(struct hso_shared_int *mux)
2832 usb_free_urb(mux->shared_intr_urb);
2833 kfree(mux->shared_intr_buf);
2834 mutex_unlock(&mux->shared_int_lock);
2839 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2841 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2846 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2848 if (!mux->intr_endp) {
2849 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2853 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2854 if (!mux->shared_intr_urb) {
2855 dev_err(&interface->dev, "Could not allocate intr urb?\n");
2858 mux->shared_intr_buf =
2859 kzalloc(le16_to_cpu(mux->intr_endp->wMaxPacketSize),
2861 if (!mux->shared_intr_buf) {
2862 dev_err(&interface->dev, "Could not allocate intr buf?\n");
2866 mutex_init(&mux->shared_int_lock);
2871 kfree(mux->shared_intr_buf);
2872 usb_free_urb(mux->shared_intr_urb);
2877 /* Gets the port spec for a certain interface */
2878 static int hso_get_config_data(struct usb_interface *interface)
2880 struct usb_device *usbdev = interface_to_usbdev(interface);
2882 u32 if_num = interface->altsetting->desc.bInterfaceNumber;
2885 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2886 0x86, 0xC0, 0, 0, config_data, 17,
2887 USB_CTRL_SET_TIMEOUT) != 0x11) {
2891 switch (config_data[if_num]) {
2896 result = HSO_PORT_DIAG;
2899 result = HSO_PORT_GPS;
2902 result = HSO_PORT_GPS_CONTROL;
2905 result = HSO_PORT_APP;
2908 result = HSO_PORT_APP2;
2911 result = HSO_PORT_CONTROL;
2914 result = HSO_PORT_NETWORK;
2917 result = HSO_PORT_MODEM;
2920 result = HSO_PORT_MSD;
2923 result = HSO_PORT_PCSC;
2926 result = HSO_PORT_VOICE;
2933 result |= HSO_INTF_BULK;
2935 if (config_data[16] & 0x1)
2936 result |= HSO_INFO_CRC_BUG;
2941 /* called once for each interface upon device insertion */
2942 static int hso_probe(struct usb_interface *interface,
2943 const struct usb_device_id *id)
2945 int mux, i, if_num, port_spec;
2946 unsigned char port_mask;
2947 struct hso_device *hso_dev = NULL;
2948 struct hso_shared_int *shared_int;
2949 struct hso_device *tmp_dev = NULL;
2951 if_num = interface->altsetting->desc.bInterfaceNumber;
2953 /* Get the interface/port specification from either driver_info or from
2954 * the device itself */
2955 if (id->driver_info)
2956 port_spec = ((u32 *)(id->driver_info))[if_num];
2958 port_spec = hso_get_config_data(interface);
2960 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2961 dev_err(&interface->dev, "Not our interface\n");
2964 /* Check if we need to switch to alt interfaces prior to port
2966 if (interface->num_altsetting > 1)
2967 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2968 interface->needs_remote_wakeup = 1;
2970 /* Allocate new hso device(s) */
2971 switch (port_spec & HSO_INTF_MASK) {
2973 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2974 /* Create the network device */
2976 hso_dev = hso_create_net_device(interface,
2984 if (hso_get_mux_ports(interface, &port_mask))
2985 /* TODO: de-allocate everything */
2988 shared_int = hso_create_shared_int(interface);
2992 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2993 if (port_mask & i) {
2994 hso_dev = hso_create_mux_serial_device(
2995 interface, i, shared_int);
3006 /* It's a regular bulk interface */
3007 if (((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) &&
3009 hso_dev = hso_create_net_device(interface, port_spec);
3012 hso_create_bulk_serial_device(interface, port_spec);
3020 /* save our data pointer in this device */
3021 usb_set_intfdata(interface, hso_dev);
3026 hso_free_interface(interface);
3030 /* device removed, cleaning up */
3031 static void hso_disconnect(struct usb_interface *interface)
3033 hso_free_interface(interface);
3035 /* remove reference of our private data */
3036 usb_set_intfdata(interface, NULL);
3039 static void async_get_intf(struct work_struct *data)
3041 struct hso_device *hso_dev =
3042 container_of(data, struct hso_device, async_get_intf);
3043 usb_autopm_get_interface(hso_dev->interface);
3046 static void async_put_intf(struct work_struct *data)
3048 struct hso_device *hso_dev =
3049 container_of(data, struct hso_device, async_put_intf);
3050 usb_autopm_put_interface(hso_dev->interface);
3053 static int hso_get_activity(struct hso_device *hso_dev)
3055 if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
3056 if (!hso_dev->is_active) {
3057 hso_dev->is_active = 1;
3058 schedule_work(&hso_dev->async_get_intf);
3062 if (hso_dev->usb->state != USB_STATE_CONFIGURED)
3065 usb_mark_last_busy(hso_dev->usb);
3070 static int hso_put_activity(struct hso_device *hso_dev)
3072 if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
3073 if (hso_dev->is_active) {
3074 hso_dev->is_active = 0;
3075 schedule_work(&hso_dev->async_put_intf);
3079 hso_dev->is_active = 0;
3083 /* called by kernel when we need to suspend device */
3084 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3088 /* Stop all serial ports */
3089 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3090 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3091 result = hso_stop_serial_device(serial_table[i]);
3097 /* Stop all network ports */
3098 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3099 if (network_table[i] &&
3100 (network_table[i]->interface == iface)) {
3101 result = hso_stop_net_device(network_table[i]);
3111 /* called by kernel when we need to resume device */
3112 static int hso_resume(struct usb_interface *iface)
3115 struct hso_net *hso_net;
3117 /* Start all serial ports */
3118 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3119 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3120 if (dev2ser(serial_table[i])->open_count) {
3122 hso_start_serial_device(serial_table[i], GFP_NOIO);
3123 hso_kick_transmit(dev2ser(serial_table[i]));
3130 /* Start all network ports */
3131 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3132 if (network_table[i] &&
3133 (network_table[i]->interface == iface)) {
3134 hso_net = dev2net(network_table[i]);
3135 if (hso_net->flags & IFF_UP) {
3136 /* First transmit any lingering data,
3137 then restart the device. */
3138 if (hso_net->skb_tx_buf) {
3139 dev_dbg(&iface->dev,
3141 " lingering data\n");
3142 hso_net_start_xmit(hso_net->skb_tx_buf,
3144 hso_net->skb_tx_buf = NULL;
3146 result = hso_start_net_device(network_table[i]);
3157 static void reset_device(struct work_struct *data)
3159 struct hso_device *hso_dev =
3160 container_of(data, struct hso_device, reset_device);
3161 struct usb_device *usb = hso_dev->usb;
3164 if (hso_dev->usb_gone) {
3165 D1("No reset during disconnect\n");
3167 result = usb_lock_device_for_reset(usb, hso_dev->interface);
3169 D1("unable to lock device for reset: %d\n", result);
3171 usb_reset_device(usb);
3172 usb_unlock_device(usb);
3177 static void hso_serial_ref_free(struct kref *ref)
3179 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3181 hso_free_serial_device(hso_dev);
3184 static void hso_free_interface(struct usb_interface *interface)
3186 struct hso_serial *hso_dev;
3187 struct tty_struct *tty;
3190 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3191 if (serial_table[i] &&
3192 (serial_table[i]->interface == interface)) {
3193 hso_dev = dev2ser(serial_table[i]);
3194 spin_lock_irq(&hso_dev->serial_lock);
3195 tty = tty_kref_get(hso_dev->tty);
3196 spin_unlock_irq(&hso_dev->serial_lock);
3199 mutex_lock(&hso_dev->parent->mutex);
3201 hso_dev->parent->usb_gone = 1;
3202 mutex_unlock(&hso_dev->parent->mutex);
3203 kref_put(&serial_table[i]->ref, hso_serial_ref_free);
3207 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3208 if (network_table[i] &&
3209 (network_table[i]->interface == interface)) {
3210 struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3211 /* hso_stop_net_device doesn't stop the net queue since
3212 * traffic needs to start it again when suspended */
3213 netif_stop_queue(dev2net(network_table[i])->net);
3214 hso_stop_net_device(network_table[i]);
3215 cancel_work_sync(&network_table[i]->async_put_intf);
3216 cancel_work_sync(&network_table[i]->async_get_intf);
3218 rfkill_unregister(rfk);
3219 rfkill_destroy(rfk);
3221 hso_free_net_device(network_table[i]);
3226 /* Helper functions */
3228 /* Get the endpoint ! */
3229 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3233 struct usb_host_interface *iface = intf->cur_altsetting;
3234 struct usb_endpoint_descriptor *endp;
3236 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3237 endp = &iface->endpoint[i].desc;
3238 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3239 (usb_endpoint_type(endp) == type))
3246 /* Get the byte that describes which ports are enabled */
3247 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3250 struct usb_host_interface *iface = intf->cur_altsetting;
3252 if (iface->extralen == 3) {
3253 *ports = iface->extra[2];
3257 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3258 if (iface->endpoint[i].extralen == 3) {
3259 *ports = iface->endpoint[i].extra[2];
3267 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3268 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3269 struct usb_device *usb, gfp_t gfp)
3273 usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3275 shared_int->intr_endp->bEndpointAddress & 0x7F),
3276 shared_int->shared_intr_buf,
3278 intr_callback, shared_int,
3279 shared_int->intr_endp->bInterval);
3281 result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3283 dev_warn(&usb->dev, "%s failed mux_intr_urb %d\n", __func__,
3289 /* operations setup of the serial interface */
3290 static const struct tty_operations hso_serial_ops = {
3291 .open = hso_serial_open,
3292 .close = hso_serial_close,
3293 .write = hso_serial_write,
3294 .write_room = hso_serial_write_room,
3295 .ioctl = hso_serial_ioctl,
3296 .set_termios = hso_serial_set_termios,
3297 .chars_in_buffer = hso_serial_chars_in_buffer,
3298 .tiocmget = hso_serial_tiocmget,
3299 .tiocmset = hso_serial_tiocmset,
3300 .unthrottle = hso_unthrottle
3303 static struct usb_driver hso_driver = {
3304 .name = driver_name,
3306 .disconnect = hso_disconnect,
3307 .id_table = hso_ids,
3308 .suspend = hso_suspend,
3309 .resume = hso_resume,
3310 .reset_resume = hso_resume,
3311 .supports_autosuspend = 1,
3314 static int __init hso_init(void)
3319 /* put it in the log */
3320 printk(KERN_INFO "hso: %s\n", version);
3322 /* Initialise the serial table semaphore and table */
3323 spin_lock_init(&serial_table_lock);
3324 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3325 serial_table[i] = NULL;
3327 /* allocate our driver using the proper amount of supported minors */
3328 tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
3332 /* fill in all needed values */
3333 tty_drv->magic = TTY_DRIVER_MAGIC;
3334 tty_drv->owner = THIS_MODULE;
3335 tty_drv->driver_name = driver_name;
3336 tty_drv->name = tty_filename;
3338 /* if major number is provided as parameter, use that one */
3340 tty_drv->major = tty_major;
3342 tty_drv->minor_start = 0;
3343 tty_drv->num = HSO_SERIAL_TTY_MINORS;
3344 tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3345 tty_drv->subtype = SERIAL_TYPE_NORMAL;
3346 tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
3347 tty_drv->init_termios = tty_std_termios;
3348 hso_init_termios(&tty_drv->init_termios);
3349 tty_set_operations(tty_drv, &hso_serial_ops);
3351 /* register the tty driver */
3352 result = tty_register_driver(tty_drv);
3354 printk(KERN_ERR "%s - tty_register_driver failed(%d)\n",
3359 /* register this module as an usb driver */
3360 result = usb_register(&hso_driver);
3362 printk(KERN_ERR "Could not register hso driver? error: %d\n",
3364 /* cleanup serial interface */
3365 tty_unregister_driver(tty_drv);
3373 static void __exit hso_exit(void)
3375 printk(KERN_INFO "hso: unloaded\n");
3377 tty_unregister_driver(tty_drv);
3378 /* deregister the usb driver */
3379 usb_deregister(&hso_driver);
3382 /* Module definitions */
3383 module_init(hso_init);
3384 module_exit(hso_exit);
3386 MODULE_AUTHOR(MOD_AUTHOR);
3387 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3388 MODULE_LICENSE(MOD_LICENSE);
3390 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3391 MODULE_PARM_DESC(debug, "Level of debug [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3392 module_param(debug, int, S_IRUGO | S_IWUSR);
3394 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3395 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3396 module_param(tty_major, int, S_IRUGO | S_IWUSR);
3398 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3399 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3400 module_param(disable_net, int, S_IRUGO | S_IWUSR);