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;
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 log_usb_status(int status, const char *function);
336 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
338 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports);
339 static void hso_free_interface(struct usb_interface *intf);
340 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags);
341 static int hso_stop_serial_device(struct hso_device *hso_dev);
342 static int hso_start_net_device(struct hso_device *hso_dev);
343 static void hso_free_shared_int(struct hso_shared_int *shared_int);
344 static int hso_stop_net_device(struct hso_device *hso_dev);
345 static void hso_serial_ref_free(struct kref *ref);
346 static void hso_std_serial_read_bulk_callback(struct urb *urb);
347 static int hso_mux_serial_read(struct hso_serial *serial);
348 static void async_get_intf(struct work_struct *data);
349 static void async_put_intf(struct work_struct *data);
350 static int hso_put_activity(struct hso_device *hso_dev);
351 static int hso_get_activity(struct hso_device *hso_dev);
352 static void tiocmget_intr_callback(struct urb *urb);
353 /*****************************************************************************/
354 /* Helping functions */
355 /*****************************************************************************/
359 static inline struct hso_net *dev2net(struct hso_device *hso_dev)
361 return hso_dev->port_data.dev_net;
364 static inline struct hso_serial *dev2ser(struct hso_device *hso_dev)
366 return hso_dev->port_data.dev_serial;
369 /* Debugging functions */
371 static void dbg_dump(int line_count, const char *func_name, unsigned char *buf,
374 static char name[255];
376 sprintf(name, "hso[%d:%s]", line_count, func_name);
377 print_hex_dump_bytes(name, DUMP_PREFIX_NONE, buf, len);
380 #define DUMP(buf_, len_) \
381 dbg_dump(__LINE__, __func__, (unsigned char *)buf_, len_)
383 #define DUMP1(buf_, len_) \
389 #define DUMP(buf_, len_)
390 #define DUMP1(buf_, len_)
393 /* module parameters */
395 static int tty_major;
396 static int disable_net;
399 static const char driver_name[] = "hso";
400 static const char tty_filename[] = "ttyHS";
401 static const char *version = __FILE__ ": " DRIVER_VERSION " " MOD_AUTHOR;
402 /* the usb driver itself (registered in hso_init) */
403 static struct usb_driver hso_driver;
404 /* serial structures */
405 static struct tty_driver *tty_drv;
406 static struct hso_device *serial_table[HSO_SERIAL_TTY_MINORS];
407 static struct hso_device *network_table[HSO_MAX_NET_DEVICES];
408 static spinlock_t serial_table_lock;
410 static const s32 default_port_spec[] = {
411 HSO_INTF_MUX | HSO_PORT_NETWORK,
412 HSO_INTF_BULK | HSO_PORT_DIAG,
413 HSO_INTF_BULK | HSO_PORT_MODEM,
417 static const s32 icon321_port_spec[] = {
418 HSO_INTF_MUX | HSO_PORT_NETWORK,
419 HSO_INTF_BULK | HSO_PORT_DIAG2,
420 HSO_INTF_BULK | HSO_PORT_MODEM,
421 HSO_INTF_BULK | HSO_PORT_DIAG,
425 #define default_port_device(vendor, product) \
426 USB_DEVICE(vendor, product), \
427 .driver_info = (kernel_ulong_t)default_port_spec
429 #define icon321_port_device(vendor, product) \
430 USB_DEVICE(vendor, product), \
431 .driver_info = (kernel_ulong_t)icon321_port_spec
433 /* list of devices we support */
434 static const struct usb_device_id hso_ids[] = {
435 {default_port_device(0x0af0, 0x6711)},
436 {default_port_device(0x0af0, 0x6731)},
437 {default_port_device(0x0af0, 0x6751)},
438 {default_port_device(0x0af0, 0x6771)},
439 {default_port_device(0x0af0, 0x6791)},
440 {default_port_device(0x0af0, 0x6811)},
441 {default_port_device(0x0af0, 0x6911)},
442 {default_port_device(0x0af0, 0x6951)},
443 {default_port_device(0x0af0, 0x6971)},
444 {default_port_device(0x0af0, 0x7011)},
445 {default_port_device(0x0af0, 0x7031)},
446 {default_port_device(0x0af0, 0x7051)},
447 {default_port_device(0x0af0, 0x7071)},
448 {default_port_device(0x0af0, 0x7111)},
449 {default_port_device(0x0af0, 0x7211)},
450 {default_port_device(0x0af0, 0x7251)},
451 {default_port_device(0x0af0, 0x7271)},
452 {default_port_device(0x0af0, 0x7311)},
453 {default_port_device(0x0af0, 0xc031)}, /* Icon-Edge */
454 {icon321_port_device(0x0af0, 0xd013)}, /* Module HSxPA */
455 {icon321_port_device(0x0af0, 0xd031)}, /* Icon-321 */
456 {icon321_port_device(0x0af0, 0xd033)}, /* Icon-322 */
457 {USB_DEVICE(0x0af0, 0x7301)}, /* GE40x */
458 {USB_DEVICE(0x0af0, 0x7361)}, /* GE40x */
459 {USB_DEVICE(0x0af0, 0x7381)}, /* GE40x */
460 {USB_DEVICE(0x0af0, 0x7401)}, /* GI 0401 */
461 {USB_DEVICE(0x0af0, 0x7501)}, /* GTM 382 */
462 {USB_DEVICE(0x0af0, 0x7601)}, /* GE40x */
463 {USB_DEVICE(0x0af0, 0x7701)},
464 {USB_DEVICE(0x0af0, 0x7706)},
465 {USB_DEVICE(0x0af0, 0x7801)},
466 {USB_DEVICE(0x0af0, 0x7901)},
467 {USB_DEVICE(0x0af0, 0x7A01)},
468 {USB_DEVICE(0x0af0, 0x7A05)},
469 {USB_DEVICE(0x0af0, 0x8200)},
470 {USB_DEVICE(0x0af0, 0x8201)},
471 {USB_DEVICE(0x0af0, 0x8300)},
472 {USB_DEVICE(0x0af0, 0x8302)},
473 {USB_DEVICE(0x0af0, 0x8304)},
474 {USB_DEVICE(0x0af0, 0x8400)},
475 {USB_DEVICE(0x0af0, 0xd035)},
476 {USB_DEVICE(0x0af0, 0xd055)},
477 {USB_DEVICE(0x0af0, 0xd155)},
478 {USB_DEVICE(0x0af0, 0xd255)},
479 {USB_DEVICE(0x0af0, 0xd057)},
480 {USB_DEVICE(0x0af0, 0xd157)},
481 {USB_DEVICE(0x0af0, 0xd257)},
482 {USB_DEVICE(0x0af0, 0xd357)},
483 {USB_DEVICE(0x0af0, 0xd058)},
484 {USB_DEVICE(0x0af0, 0xc100)},
487 MODULE_DEVICE_TABLE(usb, hso_ids);
489 /* Sysfs attribute */
490 static ssize_t hso_sysfs_show_porttype(struct device *dev,
491 struct device_attribute *attr,
494 struct hso_device *hso_dev = dev_get_drvdata(dev);
500 switch (hso_dev->port_spec & HSO_PORT_MASK) {
501 case HSO_PORT_CONTROL:
502 port_name = "Control";
505 port_name = "Application";
508 port_name = "Application2";
513 case HSO_PORT_GPS_CONTROL:
514 port_name = "GPS Control";
520 port_name = "Diagnostic";
523 port_name = "Diagnostic2";
528 case HSO_PORT_NETWORK:
529 port_name = "Network";
532 port_name = "Unknown";
536 return sprintf(buf, "%s\n", port_name);
538 static DEVICE_ATTR(hsotype, S_IRUGO, hso_sysfs_show_porttype, NULL);
540 static int hso_urb_to_index(struct hso_serial *serial, struct urb *urb)
544 for (idx = 0; idx < serial->num_rx_urbs; idx++)
545 if (serial->rx_urb[idx] == urb)
547 dev_err(serial->parent->dev, "hso_urb_to_index failed\n");
551 /* converts mux value to a port spec value */
552 static u32 hso_mux_to_port(int mux)
558 result = HSO_PORT_CONTROL;
561 result = HSO_PORT_APP;
564 result = HSO_PORT_PCSC;
567 result = HSO_PORT_GPS;
570 result = HSO_PORT_APP2;
573 result = HSO_PORT_NO_PORT;
578 /* converts port spec value to a mux value */
579 static u32 hso_port_to_mux(int port)
583 switch (port & HSO_PORT_MASK) {
584 case HSO_PORT_CONTROL:
605 static struct hso_serial *get_serial_by_shared_int_and_type(
606 struct hso_shared_int *shared_int,
611 port = hso_mux_to_port(mux);
613 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
614 if (serial_table[i] &&
615 (dev2ser(serial_table[i])->shared_int == shared_int) &&
616 ((serial_table[i]->port_spec & HSO_PORT_MASK) == port)) {
617 return dev2ser(serial_table[i]);
624 static struct hso_serial *get_serial_by_index(unsigned index)
626 struct hso_serial *serial = NULL;
629 spin_lock_irqsave(&serial_table_lock, flags);
630 if (serial_table[index])
631 serial = dev2ser(serial_table[index]);
632 spin_unlock_irqrestore(&serial_table_lock, flags);
637 static int get_free_serial_index(void)
642 spin_lock_irqsave(&serial_table_lock, flags);
643 for (index = 0; index < HSO_SERIAL_TTY_MINORS; index++) {
644 if (serial_table[index] == NULL) {
645 spin_unlock_irqrestore(&serial_table_lock, flags);
649 spin_unlock_irqrestore(&serial_table_lock, flags);
651 printk(KERN_ERR "%s: no free serial devices in table\n", __func__);
655 static void set_serial_by_index(unsigned index, struct hso_serial *serial)
659 spin_lock_irqsave(&serial_table_lock, flags);
661 serial_table[index] = serial->parent;
663 serial_table[index] = NULL;
664 spin_unlock_irqrestore(&serial_table_lock, flags);
667 /* log a meaningful explanation of an USB status */
668 static void log_usb_status(int status, const char *function)
674 explanation = "no device";
677 explanation = "endpoint not enabled";
680 explanation = "endpoint stalled";
683 explanation = "not enough bandwidth";
686 explanation = "device disabled";
689 explanation = "device suspended";
695 explanation = "internal error";
698 explanation = "unknown status";
701 D1("%s: received USB status - %s (%d)", function, explanation, status);
704 /* Network interface functions */
706 /* called when net interface is brought up by ifconfig */
707 static int hso_net_open(struct net_device *net)
709 struct hso_net *odev = netdev_priv(net);
710 unsigned long flags = 0;
713 dev_err(&net->dev, "No net device !\n");
717 odev->skb_tx_buf = NULL;
719 /* setup environment */
720 spin_lock_irqsave(&odev->net_lock, flags);
721 odev->rx_parse_state = WAIT_IP;
722 odev->rx_buf_size = 0;
723 odev->rx_buf_missing = sizeof(struct iphdr);
724 spin_unlock_irqrestore(&odev->net_lock, flags);
726 /* We are up and running. */
727 set_bit(HSO_NET_RUNNING, &odev->flags);
728 hso_start_net_device(odev->parent);
730 /* Tell the kernel we are ready to start receiving from it */
731 netif_start_queue(net);
736 /* called when interface is brought down by ifconfig */
737 static int hso_net_close(struct net_device *net)
739 struct hso_net *odev = netdev_priv(net);
741 /* we don't need the queue anymore */
742 netif_stop_queue(net);
743 /* no longer running */
744 clear_bit(HSO_NET_RUNNING, &odev->flags);
746 hso_stop_net_device(odev->parent);
752 /* USB tells is xmit done, we should start the netqueue again */
753 static void write_bulk_callback(struct urb *urb)
755 struct hso_net *odev = urb->context;
756 int status = urb->status;
759 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
760 dev_err(&urb->dev->dev, "%s: device not running\n", __func__);
764 /* Do we still have a valid kernel network device? */
765 if (!netif_device_present(odev->net)) {
766 dev_err(&urb->dev->dev, "%s: net device not present\n",
771 /* log status, but don't act on it, we don't need to resubmit anything
774 log_usb_status(status, __func__);
776 hso_put_activity(odev->parent);
778 /* Tell the network interface we are ready for another frame */
779 netif_wake_queue(odev->net);
782 /* called by kernel when we need to transmit a packet */
783 static netdev_tx_t hso_net_start_xmit(struct sk_buff *skb,
784 struct net_device *net)
786 struct hso_net *odev = netdev_priv(net);
789 /* Tell the kernel, "No more frames 'til we are done with this one." */
790 netif_stop_queue(net);
791 if (hso_get_activity(odev->parent) == -EAGAIN) {
792 odev->skb_tx_buf = skb;
797 DUMP1(skb->data, skb->len);
798 /* Copy it from kernel memory to OUR memory */
799 memcpy(odev->mux_bulk_tx_buf, skb->data, skb->len);
800 D1("len: %d/%d", skb->len, MUX_BULK_TX_BUF_SIZE);
802 /* Fill in the URB for shipping it out. */
803 usb_fill_bulk_urb(odev->mux_bulk_tx_urb,
805 usb_sndbulkpipe(odev->parent->usb,
807 bEndpointAddress & 0x7F),
808 odev->mux_bulk_tx_buf, skb->len, write_bulk_callback,
811 /* Deal with the Zero Length packet problem, I hope */
812 odev->mux_bulk_tx_urb->transfer_flags |= URB_ZERO_PACKET;
814 /* Send the URB on its merry way. */
815 result = usb_submit_urb(odev->mux_bulk_tx_urb, GFP_ATOMIC);
817 dev_warn(&odev->parent->interface->dev,
818 "failed mux_bulk_tx_urb %d", result);
819 net->stats.tx_errors++;
820 netif_start_queue(net);
822 net->stats.tx_packets++;
823 net->stats.tx_bytes += skb->len;
824 /* And tell the kernel when the last transmit started. */
825 net->trans_start = jiffies;
832 static void hso_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *info)
834 struct hso_net *odev = netdev_priv(net);
836 strncpy(info->driver, driver_name, ETHTOOL_BUSINFO_LEN);
837 strncpy(info->version, DRIVER_VERSION, ETHTOOL_BUSINFO_LEN);
838 usb_make_path(odev->parent->usb, info->bus_info, sizeof info->bus_info);
841 static const struct ethtool_ops ops = {
842 .get_drvinfo = hso_get_drvinfo,
843 .get_link = ethtool_op_get_link
846 /* called when a packet did not ack after watchdogtimeout */
847 static void hso_net_tx_timeout(struct net_device *net)
849 struct hso_net *odev = netdev_priv(net);
854 /* Tell syslog we are hosed. */
855 dev_warn(&net->dev, "Tx timed out.\n");
857 /* Tear the waiting frame off the list */
858 if (odev->mux_bulk_tx_urb &&
859 (odev->mux_bulk_tx_urb->status == -EINPROGRESS))
860 usb_unlink_urb(odev->mux_bulk_tx_urb);
862 /* Update statistics */
863 net->stats.tx_errors++;
866 /* make a real packet from the received USB buffer */
867 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt,
868 unsigned int count, unsigned char is_eop)
870 unsigned short temp_bytes;
871 unsigned short buffer_offset = 0;
872 unsigned short frame_len;
873 unsigned char *tmp_rx_buf;
876 D1("Rx %d bytes", count);
877 DUMP(ip_pkt, min(128, (int)count));
880 switch (odev->rx_parse_state) {
882 /* waiting for IP header. */
883 /* wanted bytes - size of ip header */
886 odev->rx_buf_missing) ? count : odev->
889 memcpy(((unsigned char *)(&odev->rx_ip_hdr)) +
890 odev->rx_buf_size, ip_pkt + buffer_offset,
893 odev->rx_buf_size += temp_bytes;
894 buffer_offset += temp_bytes;
895 odev->rx_buf_missing -= temp_bytes;
898 if (!odev->rx_buf_missing) {
899 /* header is complete allocate an sk_buffer and
900 * continue to WAIT_DATA */
901 frame_len = ntohs(odev->rx_ip_hdr.tot_len);
903 if ((frame_len > DEFAULT_MRU) ||
904 (frame_len < sizeof(struct iphdr))) {
905 dev_err(&odev->net->dev,
906 "Invalid frame (%d) length\n",
908 odev->rx_parse_state = WAIT_SYNC;
911 /* Allocate an sk_buff */
912 odev->skb_rx_buf = netdev_alloc_skb(odev->net,
914 if (!odev->skb_rx_buf) {
915 /* We got no receive buffer. */
916 D1("could not allocate memory");
917 odev->rx_parse_state = WAIT_SYNC;
921 /* Copy what we got so far. make room for iphdr
924 skb_put(odev->skb_rx_buf,
925 sizeof(struct iphdr));
926 memcpy(tmp_rx_buf, (char *)&(odev->rx_ip_hdr),
927 sizeof(struct iphdr));
930 odev->rx_buf_size = sizeof(struct iphdr);
932 /* Filip actually use .tot_len */
933 odev->rx_buf_missing =
934 frame_len - sizeof(struct iphdr);
935 odev->rx_parse_state = WAIT_DATA;
940 temp_bytes = (count < odev->rx_buf_missing)
941 ? count : odev->rx_buf_missing;
943 /* Copy the rest of the bytes that are left in the
944 * buffer into the waiting sk_buf. */
945 /* Make room for temp_bytes after tail. */
946 tmp_rx_buf = skb_put(odev->skb_rx_buf, temp_bytes);
947 memcpy(tmp_rx_buf, ip_pkt + buffer_offset, temp_bytes);
949 odev->rx_buf_missing -= temp_bytes;
951 buffer_offset += temp_bytes;
952 odev->rx_buf_size += temp_bytes;
953 if (!odev->rx_buf_missing) {
954 /* Packet is complete. Inject into stack. */
955 /* We have IP packet here */
956 odev->skb_rx_buf->protocol = cpu_to_be16(ETH_P_IP);
958 odev->skb_rx_buf->ip_summed =
959 CHECKSUM_UNNECESSARY;
961 skb_reset_mac_header(odev->skb_rx_buf);
963 /* Ship it off to the kernel */
964 netif_rx(odev->skb_rx_buf);
965 /* No longer our buffer. */
966 odev->skb_rx_buf = NULL;
968 /* update out statistics */
969 odev->net->stats.rx_packets++;
971 odev->net->stats.rx_bytes += odev->rx_buf_size;
973 odev->rx_buf_size = 0;
974 odev->rx_buf_missing = sizeof(struct iphdr);
975 odev->rx_parse_state = WAIT_IP;
990 /* Recovery mechanism for WAIT_SYNC state. */
992 if (odev->rx_parse_state == WAIT_SYNC) {
993 odev->rx_parse_state = WAIT_IP;
994 odev->rx_buf_size = 0;
995 odev->rx_buf_missing = sizeof(struct iphdr);
1000 /* Moving data from usb to kernel (in interrupt state) */
1001 static void read_bulk_callback(struct urb *urb)
1003 struct hso_net *odev = urb->context;
1004 struct net_device *net;
1006 int status = urb->status;
1008 /* is al ok? (Filip: Who's Al ?) */
1010 log_usb_status(status, __func__);
1015 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
1016 D1("BULK IN callback but driver is not active!");
1019 usb_mark_last_busy(urb->dev);
1023 if (!netif_device_present(net)) {
1024 /* Somebody killed our network interface... */
1028 if (odev->parent->port_spec & HSO_INFO_CRC_BUG) {
1030 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1031 rest = urb->actual_length %
1032 le16_to_cpu(odev->in_endp->wMaxPacketSize);
1033 if (((rest == 5) || (rest == 6)) &&
1034 !memcmp(((u8 *) urb->transfer_buffer) +
1035 urb->actual_length - 4, crc_check, 4)) {
1036 urb->actual_length -= 4;
1040 /* do we even have a packet? */
1041 if (urb->actual_length) {
1042 /* Handle the IP stream, add header and push it onto network
1043 * stack if the packet is complete. */
1044 spin_lock(&odev->net_lock);
1045 packetizeRx(odev, urb->transfer_buffer, urb->actual_length,
1046 (urb->transfer_buffer_length >
1047 urb->actual_length) ? 1 : 0);
1048 spin_unlock(&odev->net_lock);
1051 /* We are done with this URB, resubmit it. Prep the USB to wait for
1052 * another frame. Reuse same as received. */
1053 usb_fill_bulk_urb(urb,
1055 usb_rcvbulkpipe(odev->parent->usb,
1057 bEndpointAddress & 0x7F),
1058 urb->transfer_buffer, MUX_BULK_RX_BUF_SIZE,
1059 read_bulk_callback, odev);
1061 /* Give this to the USB subsystem so it can tell us when more data
1063 result = usb_submit_urb(urb, GFP_ATOMIC);
1065 dev_warn(&odev->parent->interface->dev,
1066 "%s failed submit mux_bulk_rx_urb %d", __func__,
1070 /* Serial driver functions */
1072 static void hso_init_termios(struct ktermios *termios)
1075 * The default requirements for this device are:
1078 ~(IGNBRK /* disable ignore break */
1079 | BRKINT /* disable break causes interrupt */
1080 | PARMRK /* disable mark parity errors */
1081 | ISTRIP /* disable clear high bit of input characters */
1082 | INLCR /* disable translate NL to CR */
1083 | IGNCR /* disable ignore CR */
1084 | ICRNL /* disable translate CR to NL */
1085 | IXON); /* disable enable XON/XOFF flow control */
1087 /* disable postprocess output characters */
1088 termios->c_oflag &= ~OPOST;
1091 ~(ECHO /* disable echo input characters */
1092 | ECHONL /* disable echo new line */
1093 | ICANON /* disable erase, kill, werase, and rprnt
1094 special characters */
1095 | ISIG /* disable interrupt, quit, and suspend special
1097 | IEXTEN); /* disable non-POSIX special characters */
1100 ~(CSIZE /* no size */
1101 | PARENB /* disable parity bit */
1102 | CBAUD /* clear current baud rate */
1103 | CBAUDEX); /* clear current buad rate */
1105 termios->c_cflag |= CS8; /* character size 8 bits */
1107 /* baud rate 115200 */
1108 tty_termios_encode_baud_rate(termios, 115200, 115200);
1111 static void _hso_serial_set_termios(struct tty_struct *tty,
1112 struct ktermios *old)
1114 struct hso_serial *serial = get_serial_by_tty(tty);
1115 struct ktermios *termios;
1118 printk(KERN_ERR "%s: no tty structures", __func__);
1122 D4("port %d", serial->minor);
1125 * Fix up unsupported bits
1127 termios = tty->termios;
1128 termios->c_iflag &= ~IXON; /* disable enable XON/XOFF flow control */
1131 ~(CSIZE /* no size */
1132 | PARENB /* disable parity bit */
1133 | CBAUD /* clear current baud rate */
1134 | CBAUDEX); /* clear current buad rate */
1136 termios->c_cflag |= CS8; /* character size 8 bits */
1138 /* baud rate 115200 */
1139 tty_encode_baud_rate(tty, 115200, 115200);
1142 static void hso_resubmit_rx_bulk_urb(struct hso_serial *serial, struct urb *urb)
1145 #ifdef CONFIG_HSO_AUTOPM
1146 usb_mark_last_busy(urb->dev);
1148 /* We are done with this URB, resubmit it. Prep the USB to wait for
1150 usb_fill_bulk_urb(urb, serial->parent->usb,
1151 usb_rcvbulkpipe(serial->parent->usb,
1153 bEndpointAddress & 0x7F),
1154 urb->transfer_buffer, serial->rx_data_length,
1155 hso_std_serial_read_bulk_callback, serial);
1156 /* Give this to the USB subsystem so it can tell us when more data
1158 result = usb_submit_urb(urb, GFP_ATOMIC);
1160 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1168 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1171 struct urb *curr_urb;
1173 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1174 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1175 count = put_rxbuf_data(curr_urb, serial);
1179 serial->curr_rx_urb_idx++;
1180 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1181 serial->curr_rx_urb_idx = 0;
1182 hso_resubmit_rx_bulk_urb(serial, curr_urb);
1187 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1192 urb = serial->rx_urb[0];
1193 if (serial->open_count > 0) {
1194 count = put_rxbuf_data(urb, serial);
1198 /* Re issue a read as long as we receive data. */
1200 if (count == 0 && ((urb->actual_length != 0) ||
1201 (serial->rx_state == RX_PENDING))) {
1202 serial->rx_state = RX_SENT;
1203 hso_mux_serial_read(serial);
1205 serial->rx_state = RX_IDLE;
1209 /* read callback for Diag and CS port */
1210 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1212 struct hso_serial *serial = urb->context;
1213 int status = urb->status;
1217 D1("serial == NULL");
1219 } else if (status) {
1220 log_usb_status(status, __func__);
1224 D4("\n--- Got serial_read_bulk callback %02x ---", status);
1225 D1("Actual length = %d\n", urb->actual_length);
1226 DUMP1(urb->transfer_buffer, urb->actual_length);
1228 /* Anyone listening? */
1229 if (serial->open_count == 0)
1233 if (serial->parent->port_spec & HSO_INFO_CRC_BUG) {
1235 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1237 urb->actual_length %
1238 le16_to_cpu(serial->in_endp->wMaxPacketSize);
1239 if (((rest == 5) || (rest == 6)) &&
1240 !memcmp(((u8 *) urb->transfer_buffer) +
1241 urb->actual_length - 4, crc_check, 4)) {
1242 urb->actual_length -= 4;
1245 /* Valid data, handle RX data */
1246 spin_lock(&serial->serial_lock);
1247 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1248 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1249 spin_unlock(&serial->serial_lock);
1250 } else if (status == -ENOENT || status == -ECONNRESET) {
1251 /* Unlinked - check for throttled port. */
1252 D2("Port %d, successfully unlinked urb", serial->minor);
1253 spin_lock(&serial->serial_lock);
1254 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
1255 hso_resubmit_rx_bulk_urb(serial, urb);
1256 spin_unlock(&serial->serial_lock);
1258 D2("Port %d, status = %d for read urb", serial->minor, status);
1264 * This needs to be a tasklet otherwise we will
1265 * end up recursively calling this function.
1267 static void hso_unthrottle_tasklet(struct hso_serial *serial)
1269 unsigned long flags;
1271 spin_lock_irqsave(&serial->serial_lock, flags);
1272 if ((serial->parent->port_spec & HSO_INTF_MUX))
1273 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1275 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1276 spin_unlock_irqrestore(&serial->serial_lock, flags);
1279 static void hso_unthrottle(struct tty_struct *tty)
1281 struct hso_serial *serial = get_serial_by_tty(tty);
1283 tasklet_hi_schedule(&serial->unthrottle_tasklet);
1286 static void hso_unthrottle_workfunc(struct work_struct *work)
1288 struct hso_serial *serial =
1289 container_of(work, struct hso_serial,
1290 retry_unthrottle_workqueue);
1291 hso_unthrottle_tasklet(serial);
1294 /* open the requested serial port */
1295 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1297 struct hso_serial *serial = get_serial_by_index(tty->index);
1301 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1303 tty->driver_data = NULL;
1304 D1("Failed to open port");
1308 mutex_lock(&serial->parent->mutex);
1309 result = usb_autopm_get_interface(serial->parent->interface);
1313 D1("Opening %d", serial->minor);
1314 kref_get(&serial->parent->ref);
1317 spin_lock_irq(&serial->serial_lock);
1318 tty->driver_data = serial;
1319 tty_kref_put(serial->tty);
1320 serial->tty = tty_kref_get(tty);
1321 spin_unlock_irq(&serial->serial_lock);
1323 /* check for port already opened, if not set the termios */
1324 serial->open_count++;
1325 if (serial->open_count == 1) {
1326 tty->low_latency = 1;
1327 serial->rx_state = RX_IDLE;
1328 /* Force default termio settings */
1329 _hso_serial_set_termios(tty, NULL);
1330 tasklet_init(&serial->unthrottle_tasklet,
1331 (void (*)(unsigned long))hso_unthrottle_tasklet,
1332 (unsigned long)serial);
1333 INIT_WORK(&serial->retry_unthrottle_workqueue,
1334 hso_unthrottle_workfunc);
1335 result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1337 hso_stop_serial_device(serial->parent);
1338 serial->open_count--;
1339 kref_put(&serial->parent->ref, hso_serial_ref_free);
1342 D1("Port was already open");
1345 usb_autopm_put_interface(serial->parent->interface);
1349 hso_serial_tiocmset(tty, NULL, TIOCM_RTS | TIOCM_DTR, 0);
1351 mutex_unlock(&serial->parent->mutex);
1355 /* close the requested serial port */
1356 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1358 struct hso_serial *serial = tty->driver_data;
1361 D1("Closing serial port");
1363 /* Open failed, no close cleanup required */
1367 mutex_lock(&serial->parent->mutex);
1368 usb_gone = serial->parent->usb_gone;
1371 usb_autopm_get_interface(serial->parent->interface);
1373 /* reset the rts and dtr */
1374 /* do the actual close */
1375 serial->open_count--;
1377 if (serial->open_count <= 0) {
1378 serial->open_count = 0;
1379 spin_lock_irq(&serial->serial_lock);
1380 if (serial->tty == tty) {
1381 serial->tty->driver_data = NULL;
1385 spin_unlock_irq(&serial->serial_lock);
1387 hso_stop_serial_device(serial->parent);
1388 tasklet_kill(&serial->unthrottle_tasklet);
1389 cancel_work_sync(&serial->retry_unthrottle_workqueue);
1393 usb_autopm_put_interface(serial->parent->interface);
1395 mutex_unlock(&serial->parent->mutex);
1397 kref_put(&serial->parent->ref, hso_serial_ref_free);
1400 /* close the requested serial port */
1401 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1404 struct hso_serial *serial = get_serial_by_tty(tty);
1405 int space, tx_bytes;
1406 unsigned long flags;
1409 if (serial == NULL) {
1410 printk(KERN_ERR "%s: serial is NULL\n", __func__);
1414 spin_lock_irqsave(&serial->serial_lock, flags);
1416 space = serial->tx_data_length - serial->tx_buffer_count;
1417 tx_bytes = (count < space) ? count : space;
1422 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1423 serial->tx_buffer_count += tx_bytes;
1426 spin_unlock_irqrestore(&serial->serial_lock, flags);
1428 hso_kick_transmit(serial);
1433 /* how much room is there for writing */
1434 static int hso_serial_write_room(struct tty_struct *tty)
1436 struct hso_serial *serial = get_serial_by_tty(tty);
1438 unsigned long flags;
1440 spin_lock_irqsave(&serial->serial_lock, flags);
1441 room = serial->tx_data_length - serial->tx_buffer_count;
1442 spin_unlock_irqrestore(&serial->serial_lock, flags);
1444 /* return free room */
1448 /* setup the term */
1449 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1451 struct hso_serial *serial = get_serial_by_tty(tty);
1452 unsigned long flags;
1455 D5("Termios called with: cflags new[%d] - old[%d]",
1456 tty->termios->c_cflag, old->c_cflag);
1458 /* the actual setup */
1459 spin_lock_irqsave(&serial->serial_lock, flags);
1460 if (serial->open_count)
1461 _hso_serial_set_termios(tty, old);
1464 spin_unlock_irqrestore(&serial->serial_lock, flags);
1470 /* how many characters in the buffer */
1471 static int hso_serial_chars_in_buffer(struct tty_struct *tty)
1473 struct hso_serial *serial = get_serial_by_tty(tty);
1475 unsigned long flags;
1481 spin_lock_irqsave(&serial->serial_lock, flags);
1482 chars = serial->tx_buffer_count;
1483 spin_unlock_irqrestore(&serial->serial_lock, flags);
1487 static int tiocmget_submit_urb(struct hso_serial *serial,
1488 struct hso_tiocmget *tiocmget,
1489 struct usb_device *usb)
1493 if (serial->parent->usb_gone)
1495 usb_fill_int_urb(tiocmget->urb, usb,
1498 bEndpointAddress & 0x7F),
1499 &tiocmget->serial_state_notification,
1500 sizeof(struct hso_serial_state_notification),
1501 tiocmget_intr_callback, serial,
1502 tiocmget->endp->bInterval);
1503 result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC);
1505 dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__,
1512 static void tiocmget_intr_callback(struct urb *urb)
1514 struct hso_serial *serial = urb->context;
1515 struct hso_tiocmget *tiocmget;
1516 int status = urb->status;
1517 u16 UART_state_bitmap, prev_UART_state_bitmap;
1518 struct uart_icount *icount;
1519 struct hso_serial_state_notification *serial_state_notification;
1520 struct usb_device *usb;
1526 log_usb_status(status, __func__);
1529 tiocmget = serial->tiocmget;
1532 usb = serial->parent->usb;
1533 serial_state_notification = &tiocmget->serial_state_notification;
1534 if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1535 serial_state_notification->bNotification != B_NOTIFICATION ||
1536 le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1537 le16_to_cpu(serial_state_notification->wIndex) != W_INDEX ||
1538 le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1540 "hso received invalid serial state notification\n");
1541 DUMP(serial_state_notification,
1542 sizeof(struct hso_serial_state_notification));
1545 UART_state_bitmap = le16_to_cpu(serial_state_notification->
1547 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1548 icount = &tiocmget->icount;
1549 spin_lock(&serial->serial_lock);
1550 if ((UART_state_bitmap & B_OVERRUN) !=
1551 (prev_UART_state_bitmap & B_OVERRUN))
1553 if ((UART_state_bitmap & B_PARITY) !=
1554 (prev_UART_state_bitmap & B_PARITY))
1556 if ((UART_state_bitmap & B_FRAMING) !=
1557 (prev_UART_state_bitmap & B_FRAMING))
1559 if ((UART_state_bitmap & B_RING_SIGNAL) &&
1560 !(prev_UART_state_bitmap & B_RING_SIGNAL))
1562 if ((UART_state_bitmap & B_BREAK) !=
1563 (prev_UART_state_bitmap & B_BREAK))
1565 if ((UART_state_bitmap & B_TX_CARRIER) !=
1566 (prev_UART_state_bitmap & B_TX_CARRIER))
1568 if ((UART_state_bitmap & B_RX_CARRIER) !=
1569 (prev_UART_state_bitmap & B_RX_CARRIER))
1571 tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1572 spin_unlock(&serial->serial_lock);
1573 tiocmget->intr_completed = 1;
1574 wake_up_interruptible(&tiocmget->waitq);
1576 memset(serial_state_notification, 0,
1577 sizeof(struct hso_serial_state_notification));
1578 tiocmget_submit_urb(serial,
1580 serial->parent->usb);
1584 * next few functions largely stolen from drivers/serial/serial_core.c
1586 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1587 * - mask passed in arg for lines of interest
1588 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1589 * Caller should use TIOCGICOUNT to see which one it was
1592 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1594 DECLARE_WAITQUEUE(wait, current);
1595 struct uart_icount cprev, cnow;
1596 struct hso_tiocmget *tiocmget;
1599 tiocmget = serial->tiocmget;
1603 * note the counters on entry
1605 spin_lock_irq(&serial->serial_lock);
1606 memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1607 spin_unlock_irq(&serial->serial_lock);
1608 add_wait_queue(&tiocmget->waitq, &wait);
1610 spin_lock_irq(&serial->serial_lock);
1611 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1612 spin_unlock_irq(&serial->serial_lock);
1613 set_current_state(TASK_INTERRUPTIBLE);
1614 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1615 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1616 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd))) {
1621 /* see if a signal did it */
1622 if (signal_pending(current)) {
1628 current->state = TASK_RUNNING;
1629 remove_wait_queue(&tiocmget->waitq, &wait);
1635 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1636 * Return: write counters to the user passed counter struct
1637 * NB: both 1->0 and 0->1 transitions are counted except for
1638 * RI where only 0->1 is counted.
1640 static int hso_get_count(struct hso_serial *serial,
1641 struct serial_icounter_struct __user *icnt)
1643 struct serial_icounter_struct icount;
1644 struct uart_icount cnow;
1645 struct hso_tiocmget *tiocmget = serial->tiocmget;
1649 spin_lock_irq(&serial->serial_lock);
1650 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1651 spin_unlock_irq(&serial->serial_lock);
1653 icount.cts = cnow.cts;
1654 icount.dsr = cnow.dsr;
1655 icount.rng = cnow.rng;
1656 icount.dcd = cnow.dcd;
1657 icount.rx = cnow.rx;
1658 icount.tx = cnow.tx;
1659 icount.frame = cnow.frame;
1660 icount.overrun = cnow.overrun;
1661 icount.parity = cnow.parity;
1662 icount.brk = cnow.brk;
1663 icount.buf_overrun = cnow.buf_overrun;
1665 return copy_to_user(icnt, &icount, sizeof(icount)) ? -EFAULT : 0;
1669 static int hso_serial_tiocmget(struct tty_struct *tty, struct file *file)
1672 struct hso_serial *serial = get_serial_by_tty(tty);
1673 struct hso_tiocmget *tiocmget;
1674 u16 UART_state_bitmap;
1678 D1("no tty structures");
1681 spin_lock_irq(&serial->serial_lock);
1682 retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1683 ((serial->dtr_state) ? TIOCM_DTR : 0);
1684 tiocmget = serial->tiocmget;
1687 UART_state_bitmap = le16_to_cpu(
1688 tiocmget->prev_UART_state_bitmap);
1689 if (UART_state_bitmap & B_RING_SIGNAL)
1690 retval |= TIOCM_RNG;
1691 if (UART_state_bitmap & B_RX_CARRIER)
1693 if (UART_state_bitmap & B_TX_CARRIER)
1694 retval |= TIOCM_DSR;
1696 spin_unlock_irq(&serial->serial_lock);
1700 static int hso_serial_tiocmset(struct tty_struct *tty, struct file *file,
1701 unsigned int set, unsigned int clear)
1704 unsigned long flags;
1706 struct hso_serial *serial = get_serial_by_tty(tty);
1710 D1("no tty structures");
1713 if_num = serial->parent->interface->altsetting->desc.bInterfaceNumber;
1715 spin_lock_irqsave(&serial->serial_lock, flags);
1716 if (set & TIOCM_RTS)
1717 serial->rts_state = 1;
1718 if (set & TIOCM_DTR)
1719 serial->dtr_state = 1;
1721 if (clear & TIOCM_RTS)
1722 serial->rts_state = 0;
1723 if (clear & TIOCM_DTR)
1724 serial->dtr_state = 0;
1726 if (serial->dtr_state)
1728 if (serial->rts_state)
1731 spin_unlock_irqrestore(&serial->serial_lock, flags);
1733 return usb_control_msg(serial->parent->usb,
1734 usb_rcvctrlpipe(serial->parent->usb, 0), 0x22,
1735 0x21, val, if_num, NULL, 0,
1736 USB_CTRL_SET_TIMEOUT);
1739 static int hso_serial_ioctl(struct tty_struct *tty, struct file *file,
1740 unsigned int cmd, unsigned long arg)
1742 struct hso_serial *serial = get_serial_by_tty(tty);
1743 void __user *uarg = (void __user *)arg;
1745 D4("IOCTL cmd: %d, arg: %ld", cmd, arg);
1751 ret = hso_wait_modem_status(serial, arg);
1755 ret = hso_get_count(serial, uarg);
1765 /* starts a transmit */
1766 static void hso_kick_transmit(struct hso_serial *serial)
1769 unsigned long flags;
1772 spin_lock_irqsave(&serial->serial_lock, flags);
1773 if (!serial->tx_buffer_count)
1776 if (serial->tx_urb_used)
1779 /* Wakeup USB interface if necessary */
1780 if (hso_get_activity(serial->parent) == -EAGAIN)
1783 /* Switch pointers around to avoid memcpy */
1784 temp = serial->tx_buffer;
1785 serial->tx_buffer = serial->tx_data;
1786 serial->tx_data = temp;
1787 serial->tx_data_count = serial->tx_buffer_count;
1788 serial->tx_buffer_count = 0;
1790 /* If temp is set, it means we switched buffers */
1791 if (temp && serial->write_data) {
1792 res = serial->write_data(serial);
1794 serial->tx_urb_used = 1;
1797 spin_unlock_irqrestore(&serial->serial_lock, flags);
1800 /* make a request (for reading and writing data to muxed serial port) */
1801 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1802 struct urb *ctrl_urb,
1803 struct usb_ctrlrequest *ctrl_req,
1804 u8 *ctrl_urb_data, u32 size)
1810 if (!serial || !ctrl_urb || !ctrl_req) {
1811 printk(KERN_ERR "%s: Wrong arguments\n", __func__);
1816 ctrl_req->wValue = 0;
1817 ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1818 ctrl_req->wLength = cpu_to_le16(size);
1820 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1821 /* Reading command */
1822 ctrl_req->bRequestType = USB_DIR_IN |
1823 USB_TYPE_OPTION_VENDOR |
1824 USB_RECIP_INTERFACE;
1825 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1826 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1828 /* Writing command */
1829 ctrl_req->bRequestType = USB_DIR_OUT |
1830 USB_TYPE_OPTION_VENDOR |
1831 USB_RECIP_INTERFACE;
1832 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1833 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1836 D2("%s command (%02x) len: %d, port: %d",
1837 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1838 ctrl_req->bRequestType, ctrl_req->wLength, port);
1841 ctrl_urb->transfer_flags = 0;
1842 usb_fill_control_urb(ctrl_urb,
1843 serial->parent->usb,
1846 ctrl_urb_data, size, ctrl_callback, serial);
1847 /* Send it on merry way */
1848 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1850 dev_err(&ctrl_urb->dev->dev,
1851 "%s failed submit ctrl_urb %d type %d", __func__,
1860 /* called by intr_callback when read occurs */
1861 static int hso_mux_serial_read(struct hso_serial *serial)
1867 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1868 /* make the request */
1870 if (serial->num_rx_urbs != 1) {
1871 dev_err(&serial->parent->interface->dev,
1872 "ERROR: mux'd reads with multiple buffers "
1876 return mux_device_request(serial,
1877 USB_CDC_GET_ENCAPSULATED_RESPONSE,
1878 serial->parent->port_spec & HSO_PORT_MASK,
1880 &serial->ctrl_req_rx,
1881 serial->rx_data[0], serial->rx_data_length);
1884 /* used for muxed serial port callback (muxed serial read) */
1885 static void intr_callback(struct urb *urb)
1887 struct hso_shared_int *shared_int = urb->context;
1888 struct hso_serial *serial;
1889 unsigned char *port_req;
1890 int status = urb->status;
1893 usb_mark_last_busy(urb->dev);
1901 log_usb_status(status, __func__);
1904 D4("\n--- Got intr callback 0x%02X ---", status);
1907 port_req = urb->transfer_buffer;
1908 D4(" port_req = 0x%.2X\n", *port_req);
1909 /* loop over all muxed ports to find the one sending this */
1910 for (i = 0; i < 8; i++) {
1911 /* max 8 channels on MUX */
1912 if (*port_req & (1 << i)) {
1913 serial = get_serial_by_shared_int_and_type(shared_int,
1915 if (serial != NULL) {
1916 D1("Pending read interrupt on port %d\n", i);
1917 spin_lock(&serial->serial_lock);
1918 if (serial->rx_state == RX_IDLE &&
1919 serial->open_count > 0) {
1920 /* Setup and send a ctrl req read on
1922 if (!serial->rx_urb_filled[0]) {
1923 serial->rx_state = RX_SENT;
1924 hso_mux_serial_read(serial);
1926 serial->rx_state = RX_PENDING;
1928 D1("Already a read pending on "
1929 "port %d or port not open\n", i);
1931 spin_unlock(&serial->serial_lock);
1935 /* Resubmit interrupt urb */
1936 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1939 /* called for writing to muxed serial port */
1940 static int hso_mux_serial_write_data(struct hso_serial *serial)
1945 return mux_device_request(serial,
1946 USB_CDC_SEND_ENCAPSULATED_COMMAND,
1947 serial->parent->port_spec & HSO_PORT_MASK,
1949 &serial->ctrl_req_tx,
1950 serial->tx_data, serial->tx_data_count);
1953 /* write callback for Diag and CS port */
1954 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1956 struct hso_serial *serial = urb->context;
1957 int status = urb->status;
1958 struct tty_struct *tty;
1962 D1("serial == NULL");
1966 spin_lock(&serial->serial_lock);
1967 serial->tx_urb_used = 0;
1968 tty = tty_kref_get(serial->tty);
1969 spin_unlock(&serial->serial_lock);
1971 log_usb_status(status, __func__);
1975 hso_put_activity(serial->parent);
1980 hso_kick_transmit(serial);
1986 /* called for writing diag or CS serial port */
1987 static int hso_std_serial_write_data(struct hso_serial *serial)
1989 int count = serial->tx_data_count;
1992 usb_fill_bulk_urb(serial->tx_urb,
1993 serial->parent->usb,
1994 usb_sndbulkpipe(serial->parent->usb,
1996 bEndpointAddress & 0x7F),
1997 serial->tx_data, serial->tx_data_count,
1998 hso_std_serial_write_bulk_callback, serial);
2000 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
2002 dev_warn(&serial->parent->usb->dev,
2003 "Failed to submit urb - res %d\n", result);
2010 /* callback after read or write on muxed serial port */
2011 static void ctrl_callback(struct urb *urb)
2013 struct hso_serial *serial = urb->context;
2014 struct usb_ctrlrequest *req;
2015 int status = urb->status;
2016 struct tty_struct *tty;
2022 spin_lock(&serial->serial_lock);
2023 serial->tx_urb_used = 0;
2024 tty = tty_kref_get(serial->tty);
2025 spin_unlock(&serial->serial_lock);
2027 log_usb_status(status, __func__);
2033 req = (struct usb_ctrlrequest *)(urb->setup_packet);
2034 D4("\n--- Got muxed ctrl callback 0x%02X ---", status);
2035 D4("Actual length of urb = %d\n", urb->actual_length);
2036 DUMP1(urb->transfer_buffer, urb->actual_length);
2038 if (req->bRequestType ==
2039 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
2040 /* response to a read command */
2041 serial->rx_urb_filled[0] = 1;
2042 spin_lock(&serial->serial_lock);
2043 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
2044 spin_unlock(&serial->serial_lock);
2046 hso_put_activity(serial->parent);
2049 /* response to a write command */
2050 hso_kick_transmit(serial);
2055 /* handle RX data for serial port */
2056 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
2058 struct tty_struct *tty;
2059 int write_length_remaining = 0;
2063 if (urb == NULL || serial == NULL) {
2064 D1("serial = NULL");
2068 /* All callers to put_rxbuf_data hold serial_lock */
2069 tty = tty_kref_get(serial->tty);
2071 /* Push data to tty */
2073 write_length_remaining = urb->actual_length -
2074 serial->curr_rx_urb_offset;
2075 D1("data to push to tty");
2076 while (write_length_remaining) {
2077 if (test_bit(TTY_THROTTLED, &tty->flags)) {
2081 curr_write_len = tty_insert_flip_string
2082 (tty, urb->transfer_buffer +
2083 serial->curr_rx_urb_offset,
2084 write_length_remaining);
2085 serial->curr_rx_urb_offset += curr_write_len;
2086 write_length_remaining -= curr_write_len;
2087 tty_flip_buffer_push(tty);
2090 if (write_length_remaining == 0) {
2091 serial->curr_rx_urb_offset = 0;
2092 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2095 return write_length_remaining;
2099 /* Base driver functions */
2101 static void hso_log_port(struct hso_device *hso_dev)
2106 switch (hso_dev->port_spec & HSO_PORT_MASK) {
2107 case HSO_PORT_CONTROL:
2108 port_type = "Control";
2111 port_type = "Application";
2116 case HSO_PORT_GPS_CONTROL:
2117 port_type = "GPS control";
2120 port_type = "Application2";
2126 port_type = "Diagnostic";
2128 case HSO_PORT_DIAG2:
2129 port_type = "Diagnostic2";
2131 case HSO_PORT_MODEM:
2132 port_type = "Modem";
2134 case HSO_PORT_NETWORK:
2135 port_type = "Network";
2138 port_type = "Unknown";
2141 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2142 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2144 sprintf(port_dev, "/dev/%s%d", tty_filename,
2145 dev2ser(hso_dev)->minor);
2147 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2148 port_type, port_dev);
2151 static int hso_start_net_device(struct hso_device *hso_dev)
2154 struct hso_net *hso_net = dev2net(hso_dev);
2159 /* send URBs for all read buffers */
2160 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2162 /* Prep a receive URB */
2163 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2165 usb_rcvbulkpipe(hso_dev->usb,
2167 bEndpointAddress & 0x7F),
2168 hso_net->mux_bulk_rx_buf_pool[i],
2169 MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2172 /* Put it out there so the device can send us stuff */
2173 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2176 dev_warn(&hso_dev->usb->dev,
2177 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2184 static int hso_stop_net_device(struct hso_device *hso_dev)
2187 struct hso_net *hso_net = dev2net(hso_dev);
2192 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2193 if (hso_net->mux_bulk_rx_urb_pool[i])
2194 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2197 if (hso_net->mux_bulk_tx_urb)
2198 usb_kill_urb(hso_net->mux_bulk_tx_urb);
2203 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2206 struct hso_serial *serial = dev2ser(hso_dev);
2211 /* If it is not the MUX port fill in and submit a bulk urb (already
2212 * allocated in hso_serial_start) */
2213 if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2214 for (i = 0; i < serial->num_rx_urbs; i++) {
2215 usb_fill_bulk_urb(serial->rx_urb[i],
2216 serial->parent->usb,
2217 usb_rcvbulkpipe(serial->parent->usb,
2222 serial->rx_data_length,
2223 hso_std_serial_read_bulk_callback,
2225 result = usb_submit_urb(serial->rx_urb[i], flags);
2227 dev_warn(&serial->parent->usb->dev,
2228 "Failed to submit urb - res %d\n",
2234 mutex_lock(&serial->shared_int->shared_int_lock);
2235 if (!serial->shared_int->use_count) {
2237 hso_mux_submit_intr_urb(serial->shared_int,
2238 hso_dev->usb, flags);
2240 serial->shared_int->use_count++;
2241 mutex_unlock(&serial->shared_int->shared_int_lock);
2243 if (serial->tiocmget)
2244 tiocmget_submit_urb(serial,
2246 serial->parent->usb);
2250 static int hso_stop_serial_device(struct hso_device *hso_dev)
2253 struct hso_serial *serial = dev2ser(hso_dev);
2254 struct hso_tiocmget *tiocmget;
2259 for (i = 0; i < serial->num_rx_urbs; i++) {
2260 if (serial->rx_urb[i]) {
2261 usb_kill_urb(serial->rx_urb[i]);
2262 serial->rx_urb_filled[i] = 0;
2265 serial->curr_rx_urb_idx = 0;
2266 serial->curr_rx_urb_offset = 0;
2269 usb_kill_urb(serial->tx_urb);
2271 if (serial->shared_int) {
2272 mutex_lock(&serial->shared_int->shared_int_lock);
2273 if (serial->shared_int->use_count &&
2274 (--serial->shared_int->use_count == 0)) {
2277 urb = serial->shared_int->shared_intr_urb;
2281 mutex_unlock(&serial->shared_int->shared_int_lock);
2283 tiocmget = serial->tiocmget;
2285 wake_up_interruptible(&tiocmget->waitq);
2286 usb_kill_urb(tiocmget->urb);
2292 static void hso_serial_common_free(struct hso_serial *serial)
2296 if (serial->parent->dev)
2297 device_remove_file(serial->parent->dev, &dev_attr_hsotype);
2299 tty_unregister_device(tty_drv, serial->minor);
2301 for (i = 0; i < serial->num_rx_urbs; i++) {
2302 /* unlink and free RX URB */
2303 usb_free_urb(serial->rx_urb[i]);
2304 /* free the RX buffer */
2305 kfree(serial->rx_data[i]);
2308 /* unlink and free TX URB */
2309 usb_free_urb(serial->tx_urb);
2310 kfree(serial->tx_data);
2313 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
2314 int rx_size, int tx_size)
2320 minor = get_free_serial_index();
2324 /* register our minor number */
2325 serial->parent->dev = tty_register_device(tty_drv, minor,
2326 &serial->parent->interface->dev);
2327 dev = serial->parent->dev;
2328 dev_set_drvdata(dev, serial->parent);
2329 i = device_create_file(dev, &dev_attr_hsotype);
2331 /* fill in specific data for later use */
2332 serial->minor = minor;
2333 serial->magic = HSO_SERIAL_MAGIC;
2334 spin_lock_init(&serial->serial_lock);
2335 serial->num_rx_urbs = num_urbs;
2337 /* RX, allocate urb and initialize */
2339 /* prepare our RX buffer */
2340 serial->rx_data_length = rx_size;
2341 for (i = 0; i < serial->num_rx_urbs; i++) {
2342 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2343 if (!serial->rx_urb[i]) {
2344 dev_err(dev, "Could not allocate urb?\n");
2347 serial->rx_urb[i]->transfer_buffer = NULL;
2348 serial->rx_urb[i]->transfer_buffer_length = 0;
2349 serial->rx_data[i] = kzalloc(serial->rx_data_length,
2351 if (!serial->rx_data[i]) {
2352 dev_err(dev, "%s - Out of memory\n", __func__);
2357 /* TX, allocate urb and initialize */
2358 serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2359 if (!serial->tx_urb) {
2360 dev_err(dev, "Could not allocate urb?\n");
2363 serial->tx_urb->transfer_buffer = NULL;
2364 serial->tx_urb->transfer_buffer_length = 0;
2365 /* prepare our TX buffer */
2366 serial->tx_data_count = 0;
2367 serial->tx_buffer_count = 0;
2368 serial->tx_data_length = tx_size;
2369 serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2370 if (!serial->tx_data) {
2371 dev_err(dev, "%s - Out of memory", __func__);
2374 serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2375 if (!serial->tx_buffer) {
2376 dev_err(dev, "%s - Out of memory", __func__);
2382 hso_serial_common_free(serial);
2386 /* Creates a general hso device */
2387 static struct hso_device *hso_create_device(struct usb_interface *intf,
2390 struct hso_device *hso_dev;
2392 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2396 hso_dev->port_spec = port_spec;
2397 hso_dev->usb = interface_to_usbdev(intf);
2398 hso_dev->interface = intf;
2399 kref_init(&hso_dev->ref);
2400 mutex_init(&hso_dev->mutex);
2402 INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2403 INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2408 /* Removes a network device in the network device table */
2409 static int remove_net_device(struct hso_device *hso_dev)
2413 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2414 if (network_table[i] == hso_dev) {
2415 network_table[i] = NULL;
2419 if (i == HSO_MAX_NET_DEVICES)
2424 /* Frees our network device */
2425 static void hso_free_net_device(struct hso_device *hso_dev)
2428 struct hso_net *hso_net = dev2net(hso_dev);
2433 remove_net_device(hso_net->parent);
2436 unregister_netdev(hso_net->net);
2437 free_netdev(hso_net->net);
2441 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2442 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2443 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2444 hso_net->mux_bulk_rx_buf_pool[i] = NULL;
2446 usb_free_urb(hso_net->mux_bulk_tx_urb);
2447 kfree(hso_net->mux_bulk_tx_buf);
2448 hso_net->mux_bulk_tx_buf = NULL;
2453 static const struct net_device_ops hso_netdev_ops = {
2454 .ndo_open = hso_net_open,
2455 .ndo_stop = hso_net_close,
2456 .ndo_start_xmit = hso_net_start_xmit,
2457 .ndo_tx_timeout = hso_net_tx_timeout,
2460 /* initialize the network interface */
2461 static void hso_net_init(struct net_device *net)
2463 struct hso_net *hso_net = netdev_priv(net);
2465 D1("sizeof hso_net is %d", (int)sizeof(*hso_net));
2467 /* fill in the other fields */
2468 net->netdev_ops = &hso_netdev_ops;
2469 net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2470 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2471 net->type = ARPHRD_NONE;
2472 net->mtu = DEFAULT_MTU - 14;
2473 net->tx_queue_len = 10;
2474 SET_ETHTOOL_OPS(net, &ops);
2476 /* and initialize the semaphore */
2477 spin_lock_init(&hso_net->net_lock);
2480 /* Adds a network device in the network device table */
2481 static int add_net_device(struct hso_device *hso_dev)
2485 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2486 if (network_table[i] == NULL) {
2487 network_table[i] = hso_dev;
2491 if (i == HSO_MAX_NET_DEVICES)
2496 static int hso_rfkill_set_block(void *data, bool blocked)
2498 struct hso_device *hso_dev = data;
2499 int enabled = !blocked;
2502 mutex_lock(&hso_dev->mutex);
2503 if (hso_dev->usb_gone)
2506 rv = usb_control_msg(hso_dev->usb, usb_rcvctrlpipe(hso_dev->usb, 0),
2507 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2508 USB_CTRL_SET_TIMEOUT);
2509 mutex_unlock(&hso_dev->mutex);
2513 static const struct rfkill_ops hso_rfkill_ops = {
2514 .set_block = hso_rfkill_set_block,
2517 /* Creates and sets up everything for rfkill */
2518 static void hso_create_rfkill(struct hso_device *hso_dev,
2519 struct usb_interface *interface)
2521 struct hso_net *hso_net = dev2net(hso_dev);
2522 struct device *dev = &hso_net->net->dev;
2525 rfkn = kzalloc(20, GFP_KERNEL);
2527 dev_err(dev, "%s - Out of memory\n", __func__);
2529 snprintf(rfkn, 20, "hso-%d",
2530 interface->altsetting->desc.bInterfaceNumber);
2532 hso_net->rfkill = rfkill_alloc(rfkn,
2533 &interface_to_usbdev(interface)->dev,
2535 &hso_rfkill_ops, hso_dev);
2536 if (!hso_net->rfkill) {
2537 dev_err(dev, "%s - Out of memory\n", __func__);
2541 if (rfkill_register(hso_net->rfkill) < 0) {
2542 rfkill_destroy(hso_net->rfkill);
2544 hso_net->rfkill = NULL;
2545 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2550 static struct device_type hso_type = {
2554 /* Creates our network device */
2555 static struct hso_device *hso_create_net_device(struct usb_interface *interface,
2559 struct net_device *net;
2560 struct hso_net *hso_net;
2561 struct hso_device *hso_dev;
2563 hso_dev = hso_create_device(interface, port_spec);
2567 /* allocate our network device, then we can put in our private data */
2568 /* call hso_net_init to do the basic initialization */
2569 net = alloc_netdev(sizeof(struct hso_net), "hso%d", hso_net_init);
2571 dev_err(&interface->dev, "Unable to create ethernet device\n");
2575 hso_net = netdev_priv(net);
2577 hso_dev->port_data.dev_net = hso_net;
2579 hso_net->parent = hso_dev;
2581 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2583 if (!hso_net->in_endp) {
2584 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2587 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2589 if (!hso_net->out_endp) {
2590 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2593 SET_NETDEV_DEV(net, &interface->dev);
2594 SET_NETDEV_DEVTYPE(net, &hso_type);
2596 /* registering our net device */
2597 result = register_netdev(net);
2599 dev_err(&interface->dev, "Failed to register device\n");
2603 /* start allocating */
2604 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2605 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2606 if (!hso_net->mux_bulk_rx_urb_pool[i]) {
2607 dev_err(&interface->dev, "Could not allocate rx urb\n");
2610 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2612 if (!hso_net->mux_bulk_rx_buf_pool[i]) {
2613 dev_err(&interface->dev, "Could not allocate rx buf\n");
2617 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2618 if (!hso_net->mux_bulk_tx_urb) {
2619 dev_err(&interface->dev, "Could not allocate tx urb\n");
2622 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2623 if (!hso_net->mux_bulk_tx_buf) {
2624 dev_err(&interface->dev, "Could not allocate tx buf\n");
2628 add_net_device(hso_dev);
2630 hso_log_port(hso_dev);
2632 hso_create_rfkill(hso_dev, interface);
2636 hso_free_net_device(hso_dev);
2640 static void hso_free_tiomget(struct hso_serial *serial)
2642 struct hso_tiocmget *tiocmget = serial->tiocmget;
2644 if (tiocmget->urb) {
2645 usb_free_urb(tiocmget->urb);
2646 tiocmget->urb = NULL;
2648 serial->tiocmget = NULL;
2654 /* Frees an AT channel ( goes for both mux and non-mux ) */
2655 static void hso_free_serial_device(struct hso_device *hso_dev)
2657 struct hso_serial *serial = dev2ser(hso_dev);
2661 set_serial_by_index(serial->minor, NULL);
2663 hso_serial_common_free(serial);
2665 if (serial->shared_int) {
2666 mutex_lock(&serial->shared_int->shared_int_lock);
2667 if (--serial->shared_int->ref_count == 0)
2668 hso_free_shared_int(serial->shared_int);
2670 mutex_unlock(&serial->shared_int->shared_int_lock);
2672 hso_free_tiomget(serial);
2677 /* Creates a bulk AT channel */
2678 static struct hso_device *hso_create_bulk_serial_device(
2679 struct usb_interface *interface, int port)
2681 struct hso_device *hso_dev;
2682 struct hso_serial *serial;
2684 struct hso_tiocmget *tiocmget;
2686 hso_dev = hso_create_device(interface, port);
2690 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2694 serial->parent = hso_dev;
2695 hso_dev->port_data.dev_serial = serial;
2697 if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2699 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2701 /* it isn't going to break our heart if serial->tiocmget
2702 * allocation fails don't bother checking this.
2704 if (serial->tiocmget) {
2705 tiocmget = serial->tiocmget;
2706 tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2707 if (tiocmget->urb) {
2708 mutex_init(&tiocmget->mutex);
2709 init_waitqueue_head(&tiocmget->waitq);
2710 tiocmget->endp = hso_get_ep(
2712 USB_ENDPOINT_XFER_INT,
2715 hso_free_tiomget(serial);
2721 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2725 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2727 if (!serial->in_endp) {
2728 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2734 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2735 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2739 serial->write_data = hso_std_serial_write_data;
2741 /* and record this serial */
2742 set_serial_by_index(serial->minor, serial);
2744 /* setup the proc dirs and files if needed */
2745 hso_log_port(hso_dev);
2747 /* done, return it */
2751 hso_serial_common_free(serial);
2753 hso_free_tiomget(serial);
2759 /* Creates a multiplexed AT channel */
2761 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2763 struct hso_shared_int *mux)
2765 struct hso_device *hso_dev;
2766 struct hso_serial *serial;
2769 port_spec = HSO_INTF_MUX;
2770 port_spec &= ~HSO_PORT_MASK;
2772 port_spec |= hso_mux_to_port(port);
2773 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2776 hso_dev = hso_create_device(interface, port_spec);
2780 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2784 hso_dev->port_data.dev_serial = serial;
2785 serial->parent = hso_dev;
2787 if (hso_serial_common_create
2788 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2791 serial->tx_data_length--;
2792 serial->write_data = hso_mux_serial_write_data;
2794 serial->shared_int = mux;
2795 mutex_lock(&serial->shared_int->shared_int_lock);
2796 serial->shared_int->ref_count++;
2797 mutex_unlock(&serial->shared_int->shared_int_lock);
2799 /* and record this serial */
2800 set_serial_by_index(serial->minor, serial);
2802 /* setup the proc dirs and files if needed */
2803 hso_log_port(hso_dev);
2805 /* done, return it */
2810 tty_unregister_device(tty_drv, serial->minor);
2819 static void hso_free_shared_int(struct hso_shared_int *mux)
2821 usb_free_urb(mux->shared_intr_urb);
2822 kfree(mux->shared_intr_buf);
2823 mutex_unlock(&mux->shared_int_lock);
2828 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2830 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2835 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2837 if (!mux->intr_endp) {
2838 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2842 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2843 if (!mux->shared_intr_urb) {
2844 dev_err(&interface->dev, "Could not allocate intr urb?");
2847 mux->shared_intr_buf =
2848 kzalloc(le16_to_cpu(mux->intr_endp->wMaxPacketSize),
2850 if (!mux->shared_intr_buf) {
2851 dev_err(&interface->dev, "Could not allocate intr buf?");
2855 mutex_init(&mux->shared_int_lock);
2860 kfree(mux->shared_intr_buf);
2861 usb_free_urb(mux->shared_intr_urb);
2866 /* Gets the port spec for a certain interface */
2867 static int hso_get_config_data(struct usb_interface *interface)
2869 struct usb_device *usbdev = interface_to_usbdev(interface);
2871 u32 if_num = interface->altsetting->desc.bInterfaceNumber;
2874 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2875 0x86, 0xC0, 0, 0, config_data, 17,
2876 USB_CTRL_SET_TIMEOUT) != 0x11) {
2880 switch (config_data[if_num]) {
2885 result = HSO_PORT_DIAG;
2888 result = HSO_PORT_GPS;
2891 result = HSO_PORT_GPS_CONTROL;
2894 result = HSO_PORT_APP;
2897 result = HSO_PORT_APP2;
2900 result = HSO_PORT_CONTROL;
2903 result = HSO_PORT_NETWORK;
2906 result = HSO_PORT_MODEM;
2909 result = HSO_PORT_MSD;
2912 result = HSO_PORT_PCSC;
2915 result = HSO_PORT_VOICE;
2922 result |= HSO_INTF_BULK;
2924 if (config_data[16] & 0x1)
2925 result |= HSO_INFO_CRC_BUG;
2930 /* called once for each interface upon device insertion */
2931 static int hso_probe(struct usb_interface *interface,
2932 const struct usb_device_id *id)
2934 int mux, i, if_num, port_spec;
2935 unsigned char port_mask;
2936 struct hso_device *hso_dev = NULL;
2937 struct hso_shared_int *shared_int;
2938 struct hso_device *tmp_dev = NULL;
2940 if_num = interface->altsetting->desc.bInterfaceNumber;
2942 /* Get the interface/port specification from either driver_info or from
2943 * the device itself */
2944 if (id->driver_info)
2945 port_spec = ((u32 *)(id->driver_info))[if_num];
2947 port_spec = hso_get_config_data(interface);
2949 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2950 dev_err(&interface->dev, "Not our interface\n");
2953 /* Check if we need to switch to alt interfaces prior to port
2955 if (interface->num_altsetting > 1)
2956 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2957 interface->needs_remote_wakeup = 1;
2959 /* Allocate new hso device(s) */
2960 switch (port_spec & HSO_INTF_MASK) {
2962 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2963 /* Create the network device */
2965 hso_dev = hso_create_net_device(interface,
2973 if (hso_get_mux_ports(interface, &port_mask))
2974 /* TODO: de-allocate everything */
2977 shared_int = hso_create_shared_int(interface);
2981 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2982 if (port_mask & i) {
2983 hso_dev = hso_create_mux_serial_device(
2984 interface, i, shared_int);
2995 /* It's a regular bulk interface */
2996 if (((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) &&
2998 hso_dev = hso_create_net_device(interface, port_spec);
3001 hso_create_bulk_serial_device(interface, port_spec);
3009 /* save our data pointer in this device */
3010 usb_set_intfdata(interface, hso_dev);
3015 hso_free_interface(interface);
3019 /* device removed, cleaning up */
3020 static void hso_disconnect(struct usb_interface *interface)
3022 hso_free_interface(interface);
3024 /* remove reference of our private data */
3025 usb_set_intfdata(interface, NULL);
3028 static void async_get_intf(struct work_struct *data)
3030 struct hso_device *hso_dev =
3031 container_of(data, struct hso_device, async_get_intf);
3032 usb_autopm_get_interface(hso_dev->interface);
3035 static void async_put_intf(struct work_struct *data)
3037 struct hso_device *hso_dev =
3038 container_of(data, struct hso_device, async_put_intf);
3039 usb_autopm_put_interface(hso_dev->interface);
3042 static int hso_get_activity(struct hso_device *hso_dev)
3044 if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
3045 if (!hso_dev->is_active) {
3046 hso_dev->is_active = 1;
3047 schedule_work(&hso_dev->async_get_intf);
3051 if (hso_dev->usb->state != USB_STATE_CONFIGURED)
3054 usb_mark_last_busy(hso_dev->usb);
3059 static int hso_put_activity(struct hso_device *hso_dev)
3061 if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
3062 if (hso_dev->is_active) {
3063 hso_dev->is_active = 0;
3064 schedule_work(&hso_dev->async_put_intf);
3068 hso_dev->is_active = 0;
3072 /* called by kernel when we need to suspend device */
3073 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3077 /* Stop all serial ports */
3078 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3079 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3080 result = hso_stop_serial_device(serial_table[i]);
3086 /* Stop all network ports */
3087 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3088 if (network_table[i] &&
3089 (network_table[i]->interface == iface)) {
3090 result = hso_stop_net_device(network_table[i]);
3100 /* called by kernel when we need to resume device */
3101 static int hso_resume(struct usb_interface *iface)
3104 struct hso_net *hso_net;
3106 /* Start all serial ports */
3107 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3108 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3109 if (dev2ser(serial_table[i])->open_count) {
3111 hso_start_serial_device(serial_table[i], GFP_NOIO);
3112 hso_kick_transmit(dev2ser(serial_table[i]));
3119 /* Start all network ports */
3120 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3121 if (network_table[i] &&
3122 (network_table[i]->interface == iface)) {
3123 hso_net = dev2net(network_table[i]);
3124 if (hso_net->flags & IFF_UP) {
3125 /* First transmit any lingering data,
3126 then restart the device. */
3127 if (hso_net->skb_tx_buf) {
3128 dev_dbg(&iface->dev,
3130 " lingering data\n");
3131 hso_net_start_xmit(hso_net->skb_tx_buf,
3133 hso_net->skb_tx_buf = NULL;
3135 result = hso_start_net_device(network_table[i]);
3146 static void hso_serial_ref_free(struct kref *ref)
3148 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3150 hso_free_serial_device(hso_dev);
3153 static void hso_free_interface(struct usb_interface *interface)
3155 struct hso_serial *hso_dev;
3156 struct tty_struct *tty;
3159 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3160 if (serial_table[i] &&
3161 (serial_table[i]->interface == interface)) {
3162 hso_dev = dev2ser(serial_table[i]);
3163 spin_lock_irq(&hso_dev->serial_lock);
3164 tty = tty_kref_get(hso_dev->tty);
3165 spin_unlock_irq(&hso_dev->serial_lock);
3168 mutex_lock(&hso_dev->parent->mutex);
3170 hso_dev->parent->usb_gone = 1;
3171 mutex_unlock(&hso_dev->parent->mutex);
3172 kref_put(&serial_table[i]->ref, hso_serial_ref_free);
3176 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3177 if (network_table[i] &&
3178 (network_table[i]->interface == interface)) {
3179 struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3180 /* hso_stop_net_device doesn't stop the net queue since
3181 * traffic needs to start it again when suspended */
3182 netif_stop_queue(dev2net(network_table[i])->net);
3183 hso_stop_net_device(network_table[i]);
3184 cancel_work_sync(&network_table[i]->async_put_intf);
3185 cancel_work_sync(&network_table[i]->async_get_intf);
3187 rfkill_unregister(rfk);
3188 rfkill_destroy(rfk);
3190 hso_free_net_device(network_table[i]);
3195 /* Helper functions */
3197 /* Get the endpoint ! */
3198 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3202 struct usb_host_interface *iface = intf->cur_altsetting;
3203 struct usb_endpoint_descriptor *endp;
3205 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3206 endp = &iface->endpoint[i].desc;
3207 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3208 (usb_endpoint_type(endp) == type))
3215 /* Get the byte that describes which ports are enabled */
3216 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3219 struct usb_host_interface *iface = intf->cur_altsetting;
3221 if (iface->extralen == 3) {
3222 *ports = iface->extra[2];
3226 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3227 if (iface->endpoint[i].extralen == 3) {
3228 *ports = iface->endpoint[i].extra[2];
3236 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3237 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3238 struct usb_device *usb, gfp_t gfp)
3242 usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3244 shared_int->intr_endp->bEndpointAddress & 0x7F),
3245 shared_int->shared_intr_buf,
3247 intr_callback, shared_int,
3248 shared_int->intr_endp->bInterval);
3250 result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3252 dev_warn(&usb->dev, "%s failed mux_intr_urb %d", __func__,
3258 /* operations setup of the serial interface */
3259 static const struct tty_operations hso_serial_ops = {
3260 .open = hso_serial_open,
3261 .close = hso_serial_close,
3262 .write = hso_serial_write,
3263 .write_room = hso_serial_write_room,
3264 .ioctl = hso_serial_ioctl,
3265 .set_termios = hso_serial_set_termios,
3266 .chars_in_buffer = hso_serial_chars_in_buffer,
3267 .tiocmget = hso_serial_tiocmget,
3268 .tiocmset = hso_serial_tiocmset,
3269 .unthrottle = hso_unthrottle
3272 static struct usb_driver hso_driver = {
3273 .name = driver_name,
3275 .disconnect = hso_disconnect,
3276 .id_table = hso_ids,
3277 .suspend = hso_suspend,
3278 .resume = hso_resume,
3279 .reset_resume = hso_resume,
3280 .supports_autosuspend = 1,
3283 static int __init hso_init(void)
3288 /* put it in the log */
3289 printk(KERN_INFO "hso: %s\n", version);
3291 /* Initialise the serial table semaphore and table */
3292 spin_lock_init(&serial_table_lock);
3293 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3294 serial_table[i] = NULL;
3296 /* allocate our driver using the proper amount of supported minors */
3297 tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
3301 /* fill in all needed values */
3302 tty_drv->magic = TTY_DRIVER_MAGIC;
3303 tty_drv->owner = THIS_MODULE;
3304 tty_drv->driver_name = driver_name;
3305 tty_drv->name = tty_filename;
3307 /* if major number is provided as parameter, use that one */
3309 tty_drv->major = tty_major;
3311 tty_drv->minor_start = 0;
3312 tty_drv->num = HSO_SERIAL_TTY_MINORS;
3313 tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3314 tty_drv->subtype = SERIAL_TYPE_NORMAL;
3315 tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
3316 tty_drv->init_termios = tty_std_termios;
3317 hso_init_termios(&tty_drv->init_termios);
3318 tty_set_operations(tty_drv, &hso_serial_ops);
3320 /* register the tty driver */
3321 result = tty_register_driver(tty_drv);
3323 printk(KERN_ERR "%s - tty_register_driver failed(%d)\n",
3328 /* register this module as an usb driver */
3329 result = usb_register(&hso_driver);
3331 printk(KERN_ERR "Could not register hso driver? error: %d\n",
3333 /* cleanup serial interface */
3334 tty_unregister_driver(tty_drv);
3342 static void __exit hso_exit(void)
3344 printk(KERN_INFO "hso: unloaded\n");
3346 tty_unregister_driver(tty_drv);
3347 /* deregister the usb driver */
3348 usb_deregister(&hso_driver);
3351 /* Module definitions */
3352 module_init(hso_init);
3353 module_exit(hso_exit);
3355 MODULE_AUTHOR(MOD_AUTHOR);
3356 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3357 MODULE_LICENSE(MOD_LICENSE);
3358 MODULE_INFO(Version, DRIVER_VERSION);
3360 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3361 MODULE_PARM_DESC(debug, "Level of debug [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3362 module_param(debug, int, S_IRUGO | S_IWUSR);
3364 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3365 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3366 module_param(tty_major, int, S_IRUGO | S_IWUSR);
3368 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3369 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3370 module_param(disable_net, int, S_IRUGO | S_IWUSR);