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, 0x9000)},
481 {USB_DEVICE(0x0af0, 0xd035)},
482 {USB_DEVICE(0x0af0, 0xd055)},
483 {USB_DEVICE(0x0af0, 0xd155)},
484 {USB_DEVICE(0x0af0, 0xd255)},
485 {USB_DEVICE(0x0af0, 0xd057)},
486 {USB_DEVICE(0x0af0, 0xd157)},
487 {USB_DEVICE(0x0af0, 0xd257)},
488 {USB_DEVICE(0x0af0, 0xd357)},
489 {USB_DEVICE(0x0af0, 0xd058)},
490 {USB_DEVICE(0x0af0, 0xc100)},
493 MODULE_DEVICE_TABLE(usb, hso_ids);
495 /* Sysfs attribute */
496 static ssize_t hso_sysfs_show_porttype(struct device *dev,
497 struct device_attribute *attr,
500 struct hso_device *hso_dev = dev_get_drvdata(dev);
506 switch (hso_dev->port_spec & HSO_PORT_MASK) {
507 case HSO_PORT_CONTROL:
508 port_name = "Control";
511 port_name = "Application";
514 port_name = "Application2";
519 case HSO_PORT_GPS_CONTROL:
520 port_name = "GPS Control";
526 port_name = "Diagnostic";
529 port_name = "Diagnostic2";
534 case HSO_PORT_NETWORK:
535 port_name = "Network";
538 port_name = "Unknown";
542 return sprintf(buf, "%s\n", port_name);
544 static DEVICE_ATTR(hsotype, S_IRUGO, hso_sysfs_show_porttype, NULL);
546 static int hso_urb_to_index(struct hso_serial *serial, struct urb *urb)
550 for (idx = 0; idx < serial->num_rx_urbs; idx++)
551 if (serial->rx_urb[idx] == urb)
553 dev_err(serial->parent->dev, "hso_urb_to_index failed\n");
557 /* converts mux value to a port spec value */
558 static u32 hso_mux_to_port(int mux)
564 result = HSO_PORT_CONTROL;
567 result = HSO_PORT_APP;
570 result = HSO_PORT_PCSC;
573 result = HSO_PORT_GPS;
576 result = HSO_PORT_APP2;
579 result = HSO_PORT_NO_PORT;
584 /* converts port spec value to a mux value */
585 static u32 hso_port_to_mux(int port)
589 switch (port & HSO_PORT_MASK) {
590 case HSO_PORT_CONTROL:
611 static struct hso_serial *get_serial_by_shared_int_and_type(
612 struct hso_shared_int *shared_int,
617 port = hso_mux_to_port(mux);
619 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
620 if (serial_table[i] &&
621 (dev2ser(serial_table[i])->shared_int == shared_int) &&
622 ((serial_table[i]->port_spec & HSO_PORT_MASK) == port)) {
623 return dev2ser(serial_table[i]);
630 static struct hso_serial *get_serial_by_index(unsigned index)
632 struct hso_serial *serial = NULL;
635 spin_lock_irqsave(&serial_table_lock, flags);
636 if (serial_table[index])
637 serial = dev2ser(serial_table[index]);
638 spin_unlock_irqrestore(&serial_table_lock, flags);
643 static int get_free_serial_index(void)
648 spin_lock_irqsave(&serial_table_lock, flags);
649 for (index = 0; index < HSO_SERIAL_TTY_MINORS; index++) {
650 if (serial_table[index] == NULL) {
651 spin_unlock_irqrestore(&serial_table_lock, flags);
655 spin_unlock_irqrestore(&serial_table_lock, flags);
657 printk(KERN_ERR "%s: no free serial devices in table\n", __func__);
661 static void set_serial_by_index(unsigned index, struct hso_serial *serial)
665 spin_lock_irqsave(&serial_table_lock, flags);
667 serial_table[index] = serial->parent;
669 serial_table[index] = NULL;
670 spin_unlock_irqrestore(&serial_table_lock, flags);
673 static void handle_usb_error(int status, const char *function,
674 struct hso_device *hso_dev)
680 explanation = "no device";
683 explanation = "endpoint not enabled";
686 explanation = "endpoint stalled";
689 explanation = "not enough bandwidth";
692 explanation = "device disabled";
695 explanation = "device suspended";
701 explanation = "internal error";
707 explanation = "protocol error";
709 schedule_work(&hso_dev->reset_device);
712 explanation = "unknown status";
716 /* log a meaningful explanation of an USB status */
717 D1("%s: received USB status - %s (%d)", function, explanation, status);
720 /* Network interface functions */
722 /* called when net interface is brought up by ifconfig */
723 static int hso_net_open(struct net_device *net)
725 struct hso_net *odev = netdev_priv(net);
726 unsigned long flags = 0;
729 dev_err(&net->dev, "No net device !\n");
733 odev->skb_tx_buf = NULL;
735 /* setup environment */
736 spin_lock_irqsave(&odev->net_lock, flags);
737 odev->rx_parse_state = WAIT_IP;
738 odev->rx_buf_size = 0;
739 odev->rx_buf_missing = sizeof(struct iphdr);
740 spin_unlock_irqrestore(&odev->net_lock, flags);
742 /* We are up and running. */
743 set_bit(HSO_NET_RUNNING, &odev->flags);
744 hso_start_net_device(odev->parent);
746 /* Tell the kernel we are ready to start receiving from it */
747 netif_start_queue(net);
752 /* called when interface is brought down by ifconfig */
753 static int hso_net_close(struct net_device *net)
755 struct hso_net *odev = netdev_priv(net);
757 /* we don't need the queue anymore */
758 netif_stop_queue(net);
759 /* no longer running */
760 clear_bit(HSO_NET_RUNNING, &odev->flags);
762 hso_stop_net_device(odev->parent);
768 /* USB tells is xmit done, we should start the netqueue again */
769 static void write_bulk_callback(struct urb *urb)
771 struct hso_net *odev = urb->context;
772 int status = urb->status;
775 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
776 dev_err(&urb->dev->dev, "%s: device not running\n", __func__);
780 /* Do we still have a valid kernel network device? */
781 if (!netif_device_present(odev->net)) {
782 dev_err(&urb->dev->dev, "%s: net device not present\n",
787 /* log status, but don't act on it, we don't need to resubmit anything
790 handle_usb_error(status, __func__, odev->parent);
792 hso_put_activity(odev->parent);
794 /* Tell the network interface we are ready for another frame */
795 netif_wake_queue(odev->net);
798 /* called by kernel when we need to transmit a packet */
799 static netdev_tx_t hso_net_start_xmit(struct sk_buff *skb,
800 struct net_device *net)
802 struct hso_net *odev = netdev_priv(net);
805 /* Tell the kernel, "No more frames 'til we are done with this one." */
806 netif_stop_queue(net);
807 if (hso_get_activity(odev->parent) == -EAGAIN) {
808 odev->skb_tx_buf = skb;
813 DUMP1(skb->data, skb->len);
814 /* Copy it from kernel memory to OUR memory */
815 memcpy(odev->mux_bulk_tx_buf, skb->data, skb->len);
816 D1("len: %d/%d", skb->len, MUX_BULK_TX_BUF_SIZE);
818 /* Fill in the URB for shipping it out. */
819 usb_fill_bulk_urb(odev->mux_bulk_tx_urb,
821 usb_sndbulkpipe(odev->parent->usb,
823 bEndpointAddress & 0x7F),
824 odev->mux_bulk_tx_buf, skb->len, write_bulk_callback,
827 /* Deal with the Zero Length packet problem, I hope */
828 odev->mux_bulk_tx_urb->transfer_flags |= URB_ZERO_PACKET;
830 /* Send the URB on its merry way. */
831 result = usb_submit_urb(odev->mux_bulk_tx_urb, GFP_ATOMIC);
833 dev_warn(&odev->parent->interface->dev,
834 "failed mux_bulk_tx_urb %d\n", result);
835 net->stats.tx_errors++;
836 netif_start_queue(net);
838 net->stats.tx_packets++;
839 net->stats.tx_bytes += skb->len;
846 static void hso_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *info)
848 struct hso_net *odev = netdev_priv(net);
850 strncpy(info->driver, driver_name, ETHTOOL_BUSINFO_LEN);
851 usb_make_path(odev->parent->usb, info->bus_info, sizeof info->bus_info);
854 static const struct ethtool_ops ops = {
855 .get_drvinfo = hso_get_drvinfo,
856 .get_link = ethtool_op_get_link
859 /* called when a packet did not ack after watchdogtimeout */
860 static void hso_net_tx_timeout(struct net_device *net)
862 struct hso_net *odev = netdev_priv(net);
867 /* Tell syslog we are hosed. */
868 dev_warn(&net->dev, "Tx timed out.\n");
870 /* Tear the waiting frame off the list */
871 if (odev->mux_bulk_tx_urb &&
872 (odev->mux_bulk_tx_urb->status == -EINPROGRESS))
873 usb_unlink_urb(odev->mux_bulk_tx_urb);
875 /* Update statistics */
876 net->stats.tx_errors++;
879 /* make a real packet from the received USB buffer */
880 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt,
881 unsigned int count, unsigned char is_eop)
883 unsigned short temp_bytes;
884 unsigned short buffer_offset = 0;
885 unsigned short frame_len;
886 unsigned char *tmp_rx_buf;
889 D1("Rx %d bytes", count);
890 DUMP(ip_pkt, min(128, (int)count));
893 switch (odev->rx_parse_state) {
895 /* waiting for IP header. */
896 /* wanted bytes - size of ip header */
899 odev->rx_buf_missing) ? count : odev->
902 memcpy(((unsigned char *)(&odev->rx_ip_hdr)) +
903 odev->rx_buf_size, ip_pkt + buffer_offset,
906 odev->rx_buf_size += temp_bytes;
907 buffer_offset += temp_bytes;
908 odev->rx_buf_missing -= temp_bytes;
911 if (!odev->rx_buf_missing) {
912 /* header is complete allocate an sk_buffer and
913 * continue to WAIT_DATA */
914 frame_len = ntohs(odev->rx_ip_hdr.tot_len);
916 if ((frame_len > DEFAULT_MRU) ||
917 (frame_len < sizeof(struct iphdr))) {
918 dev_err(&odev->net->dev,
919 "Invalid frame (%d) length\n",
921 odev->rx_parse_state = WAIT_SYNC;
924 /* Allocate an sk_buff */
925 odev->skb_rx_buf = netdev_alloc_skb(odev->net,
927 if (!odev->skb_rx_buf) {
928 /* We got no receive buffer. */
929 D1("could not allocate memory");
930 odev->rx_parse_state = WAIT_SYNC;
934 /* Copy what we got so far. make room for iphdr
937 skb_put(odev->skb_rx_buf,
938 sizeof(struct iphdr));
939 memcpy(tmp_rx_buf, (char *)&(odev->rx_ip_hdr),
940 sizeof(struct iphdr));
943 odev->rx_buf_size = sizeof(struct iphdr);
945 /* Filip actually use .tot_len */
946 odev->rx_buf_missing =
947 frame_len - sizeof(struct iphdr);
948 odev->rx_parse_state = WAIT_DATA;
953 temp_bytes = (count < odev->rx_buf_missing)
954 ? count : odev->rx_buf_missing;
956 /* Copy the rest of the bytes that are left in the
957 * buffer into the waiting sk_buf. */
958 /* Make room for temp_bytes after tail. */
959 tmp_rx_buf = skb_put(odev->skb_rx_buf, temp_bytes);
960 memcpy(tmp_rx_buf, ip_pkt + buffer_offset, temp_bytes);
962 odev->rx_buf_missing -= temp_bytes;
964 buffer_offset += temp_bytes;
965 odev->rx_buf_size += temp_bytes;
966 if (!odev->rx_buf_missing) {
967 /* Packet is complete. Inject into stack. */
968 /* We have IP packet here */
969 odev->skb_rx_buf->protocol = cpu_to_be16(ETH_P_IP);
971 odev->skb_rx_buf->ip_summed =
972 CHECKSUM_UNNECESSARY;
974 skb_reset_mac_header(odev->skb_rx_buf);
976 /* Ship it off to the kernel */
977 netif_rx(odev->skb_rx_buf);
978 /* No longer our buffer. */
979 odev->skb_rx_buf = NULL;
981 /* update out statistics */
982 odev->net->stats.rx_packets++;
984 odev->net->stats.rx_bytes += odev->rx_buf_size;
986 odev->rx_buf_size = 0;
987 odev->rx_buf_missing = sizeof(struct iphdr);
988 odev->rx_parse_state = WAIT_IP;
1003 /* Recovery mechanism for WAIT_SYNC state. */
1005 if (odev->rx_parse_state == WAIT_SYNC) {
1006 odev->rx_parse_state = WAIT_IP;
1007 odev->rx_buf_size = 0;
1008 odev->rx_buf_missing = sizeof(struct iphdr);
1013 /* Moving data from usb to kernel (in interrupt state) */
1014 static void read_bulk_callback(struct urb *urb)
1016 struct hso_net *odev = urb->context;
1017 struct net_device *net;
1019 int status = urb->status;
1021 /* is al ok? (Filip: Who's Al ?) */
1023 handle_usb_error(status, __func__, odev->parent);
1028 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
1029 D1("BULK IN callback but driver is not active!");
1032 usb_mark_last_busy(urb->dev);
1036 if (!netif_device_present(net)) {
1037 /* Somebody killed our network interface... */
1041 if (odev->parent->port_spec & HSO_INFO_CRC_BUG) {
1043 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1044 rest = urb->actual_length %
1045 le16_to_cpu(odev->in_endp->wMaxPacketSize);
1046 if (((rest == 5) || (rest == 6)) &&
1047 !memcmp(((u8 *) urb->transfer_buffer) +
1048 urb->actual_length - 4, crc_check, 4)) {
1049 urb->actual_length -= 4;
1053 /* do we even have a packet? */
1054 if (urb->actual_length) {
1055 /* Handle the IP stream, add header and push it onto network
1056 * stack if the packet is complete. */
1057 spin_lock(&odev->net_lock);
1058 packetizeRx(odev, urb->transfer_buffer, urb->actual_length,
1059 (urb->transfer_buffer_length >
1060 urb->actual_length) ? 1 : 0);
1061 spin_unlock(&odev->net_lock);
1064 /* We are done with this URB, resubmit it. Prep the USB to wait for
1065 * another frame. Reuse same as received. */
1066 usb_fill_bulk_urb(urb,
1068 usb_rcvbulkpipe(odev->parent->usb,
1070 bEndpointAddress & 0x7F),
1071 urb->transfer_buffer, MUX_BULK_RX_BUF_SIZE,
1072 read_bulk_callback, odev);
1074 /* Give this to the USB subsystem so it can tell us when more data
1076 result = usb_submit_urb(urb, GFP_ATOMIC);
1078 dev_warn(&odev->parent->interface->dev,
1079 "%s failed submit mux_bulk_rx_urb %d\n", __func__,
1083 /* Serial driver functions */
1085 static void hso_init_termios(struct ktermios *termios)
1088 * The default requirements for this device are:
1091 ~(IGNBRK /* disable ignore break */
1092 | BRKINT /* disable break causes interrupt */
1093 | PARMRK /* disable mark parity errors */
1094 | ISTRIP /* disable clear high bit of input characters */
1095 | INLCR /* disable translate NL to CR */
1096 | IGNCR /* disable ignore CR */
1097 | ICRNL /* disable translate CR to NL */
1098 | IXON); /* disable enable XON/XOFF flow control */
1100 /* disable postprocess output characters */
1101 termios->c_oflag &= ~OPOST;
1104 ~(ECHO /* disable echo input characters */
1105 | ECHONL /* disable echo new line */
1106 | ICANON /* disable erase, kill, werase, and rprnt
1107 special characters */
1108 | ISIG /* disable interrupt, quit, and suspend special
1110 | IEXTEN); /* disable non-POSIX special characters */
1113 ~(CSIZE /* no size */
1114 | PARENB /* disable parity bit */
1115 | CBAUD /* clear current baud rate */
1116 | CBAUDEX); /* clear current buad rate */
1118 termios->c_cflag |= CS8; /* character size 8 bits */
1120 /* baud rate 115200 */
1121 tty_termios_encode_baud_rate(termios, 115200, 115200);
1124 static void _hso_serial_set_termios(struct tty_struct *tty,
1125 struct ktermios *old)
1127 struct hso_serial *serial = get_serial_by_tty(tty);
1128 struct ktermios *termios;
1131 printk(KERN_ERR "%s: no tty structures", __func__);
1135 D4("port %d", serial->minor);
1138 * Fix up unsupported bits
1140 termios = tty->termios;
1141 termios->c_iflag &= ~IXON; /* disable enable XON/XOFF flow control */
1144 ~(CSIZE /* no size */
1145 | PARENB /* disable parity bit */
1146 | CBAUD /* clear current baud rate */
1147 | CBAUDEX); /* clear current buad rate */
1149 termios->c_cflag |= CS8; /* character size 8 bits */
1151 /* baud rate 115200 */
1152 tty_encode_baud_rate(tty, 115200, 115200);
1155 static void hso_resubmit_rx_bulk_urb(struct hso_serial *serial, struct urb *urb)
1158 /* We are done with this URB, resubmit it. Prep the USB to wait for
1160 usb_fill_bulk_urb(urb, serial->parent->usb,
1161 usb_rcvbulkpipe(serial->parent->usb,
1163 bEndpointAddress & 0x7F),
1164 urb->transfer_buffer, serial->rx_data_length,
1165 hso_std_serial_read_bulk_callback, serial);
1166 /* Give this to the USB subsystem so it can tell us when more data
1168 result = usb_submit_urb(urb, GFP_ATOMIC);
1170 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1178 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1181 struct urb *curr_urb;
1183 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1184 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1185 count = put_rxbuf_data(curr_urb, serial);
1189 serial->curr_rx_urb_idx++;
1190 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1191 serial->curr_rx_urb_idx = 0;
1192 hso_resubmit_rx_bulk_urb(serial, curr_urb);
1197 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1202 urb = serial->rx_urb[0];
1203 if (serial->open_count > 0) {
1204 count = put_rxbuf_data(urb, serial);
1208 /* Re issue a read as long as we receive data. */
1210 if (count == 0 && ((urb->actual_length != 0) ||
1211 (serial->rx_state == RX_PENDING))) {
1212 serial->rx_state = RX_SENT;
1213 hso_mux_serial_read(serial);
1215 serial->rx_state = RX_IDLE;
1219 /* read callback for Diag and CS port */
1220 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1222 struct hso_serial *serial = urb->context;
1223 int status = urb->status;
1227 D1("serial == NULL");
1229 } else if (status) {
1230 handle_usb_error(status, __func__, serial->parent);
1234 D4("\n--- Got serial_read_bulk callback %02x ---", status);
1235 D1("Actual length = %d\n", urb->actual_length);
1236 DUMP1(urb->transfer_buffer, urb->actual_length);
1238 /* Anyone listening? */
1239 if (serial->open_count == 0)
1243 if (serial->parent->port_spec & HSO_INFO_CRC_BUG) {
1245 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1247 urb->actual_length %
1248 le16_to_cpu(serial->in_endp->wMaxPacketSize);
1249 if (((rest == 5) || (rest == 6)) &&
1250 !memcmp(((u8 *) urb->transfer_buffer) +
1251 urb->actual_length - 4, crc_check, 4)) {
1252 urb->actual_length -= 4;
1255 /* Valid data, handle RX data */
1256 spin_lock(&serial->serial_lock);
1257 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1258 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1259 spin_unlock(&serial->serial_lock);
1260 } else if (status == -ENOENT || status == -ECONNRESET) {
1261 /* Unlinked - check for throttled port. */
1262 D2("Port %d, successfully unlinked urb", serial->minor);
1263 spin_lock(&serial->serial_lock);
1264 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
1265 hso_resubmit_rx_bulk_urb(serial, urb);
1266 spin_unlock(&serial->serial_lock);
1268 D2("Port %d, status = %d for read urb", serial->minor, status);
1274 * This needs to be a tasklet otherwise we will
1275 * end up recursively calling this function.
1277 static void hso_unthrottle_tasklet(struct hso_serial *serial)
1279 unsigned long flags;
1281 spin_lock_irqsave(&serial->serial_lock, flags);
1282 if ((serial->parent->port_spec & HSO_INTF_MUX))
1283 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1285 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1286 spin_unlock_irqrestore(&serial->serial_lock, flags);
1289 static void hso_unthrottle(struct tty_struct *tty)
1291 struct hso_serial *serial = get_serial_by_tty(tty);
1293 tasklet_hi_schedule(&serial->unthrottle_tasklet);
1296 static void hso_unthrottle_workfunc(struct work_struct *work)
1298 struct hso_serial *serial =
1299 container_of(work, struct hso_serial,
1300 retry_unthrottle_workqueue);
1301 hso_unthrottle_tasklet(serial);
1304 /* open the requested serial port */
1305 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1307 struct hso_serial *serial = get_serial_by_index(tty->index);
1311 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1313 tty->driver_data = NULL;
1314 D1("Failed to open port");
1318 mutex_lock(&serial->parent->mutex);
1319 result = usb_autopm_get_interface(serial->parent->interface);
1323 D1("Opening %d", serial->minor);
1324 kref_get(&serial->parent->ref);
1327 spin_lock_irq(&serial->serial_lock);
1328 tty->driver_data = serial;
1329 tty_kref_put(serial->tty);
1330 serial->tty = tty_kref_get(tty);
1331 spin_unlock_irq(&serial->serial_lock);
1333 /* check for port already opened, if not set the termios */
1334 serial->open_count++;
1335 if (serial->open_count == 1) {
1336 serial->rx_state = RX_IDLE;
1337 /* Force default termio settings */
1338 _hso_serial_set_termios(tty, NULL);
1339 tasklet_init(&serial->unthrottle_tasklet,
1340 (void (*)(unsigned long))hso_unthrottle_tasklet,
1341 (unsigned long)serial);
1342 INIT_WORK(&serial->retry_unthrottle_workqueue,
1343 hso_unthrottle_workfunc);
1344 result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1346 hso_stop_serial_device(serial->parent);
1347 serial->open_count--;
1348 kref_put(&serial->parent->ref, hso_serial_ref_free);
1351 D1("Port was already open");
1354 usb_autopm_put_interface(serial->parent->interface);
1358 hso_serial_tiocmset(tty, NULL, TIOCM_RTS | TIOCM_DTR, 0);
1360 mutex_unlock(&serial->parent->mutex);
1364 /* close the requested serial port */
1365 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1367 struct hso_serial *serial = tty->driver_data;
1370 D1("Closing serial port");
1372 /* Open failed, no close cleanup required */
1376 mutex_lock(&serial->parent->mutex);
1377 usb_gone = serial->parent->usb_gone;
1380 usb_autopm_get_interface(serial->parent->interface);
1382 /* reset the rts and dtr */
1383 /* do the actual close */
1384 serial->open_count--;
1386 if (serial->open_count <= 0) {
1387 serial->open_count = 0;
1388 spin_lock_irq(&serial->serial_lock);
1389 if (serial->tty == tty) {
1390 serial->tty->driver_data = NULL;
1394 spin_unlock_irq(&serial->serial_lock);
1396 hso_stop_serial_device(serial->parent);
1397 tasklet_kill(&serial->unthrottle_tasklet);
1398 cancel_work_sync(&serial->retry_unthrottle_workqueue);
1402 usb_autopm_put_interface(serial->parent->interface);
1404 mutex_unlock(&serial->parent->mutex);
1406 kref_put(&serial->parent->ref, hso_serial_ref_free);
1409 /* close the requested serial port */
1410 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1413 struct hso_serial *serial = get_serial_by_tty(tty);
1414 int space, tx_bytes;
1415 unsigned long flags;
1418 if (serial == NULL) {
1419 printk(KERN_ERR "%s: serial is NULL\n", __func__);
1423 spin_lock_irqsave(&serial->serial_lock, flags);
1425 space = serial->tx_data_length - serial->tx_buffer_count;
1426 tx_bytes = (count < space) ? count : space;
1431 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1432 serial->tx_buffer_count += tx_bytes;
1435 spin_unlock_irqrestore(&serial->serial_lock, flags);
1437 hso_kick_transmit(serial);
1442 /* how much room is there for writing */
1443 static int hso_serial_write_room(struct tty_struct *tty)
1445 struct hso_serial *serial = get_serial_by_tty(tty);
1447 unsigned long flags;
1449 spin_lock_irqsave(&serial->serial_lock, flags);
1450 room = serial->tx_data_length - serial->tx_buffer_count;
1451 spin_unlock_irqrestore(&serial->serial_lock, flags);
1453 /* return free room */
1457 /* setup the term */
1458 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1460 struct hso_serial *serial = get_serial_by_tty(tty);
1461 unsigned long flags;
1464 D5("Termios called with: cflags new[%d] - old[%d]",
1465 tty->termios->c_cflag, old->c_cflag);
1467 /* the actual setup */
1468 spin_lock_irqsave(&serial->serial_lock, flags);
1469 if (serial->open_count)
1470 _hso_serial_set_termios(tty, old);
1473 spin_unlock_irqrestore(&serial->serial_lock, flags);
1478 /* how many characters in the buffer */
1479 static int hso_serial_chars_in_buffer(struct tty_struct *tty)
1481 struct hso_serial *serial = get_serial_by_tty(tty);
1483 unsigned long flags;
1489 spin_lock_irqsave(&serial->serial_lock, flags);
1490 chars = serial->tx_buffer_count;
1491 spin_unlock_irqrestore(&serial->serial_lock, flags);
1495 static int tiocmget_submit_urb(struct hso_serial *serial,
1496 struct hso_tiocmget *tiocmget,
1497 struct usb_device *usb)
1501 if (serial->parent->usb_gone)
1503 usb_fill_int_urb(tiocmget->urb, usb,
1506 bEndpointAddress & 0x7F),
1507 &tiocmget->serial_state_notification,
1508 sizeof(struct hso_serial_state_notification),
1509 tiocmget_intr_callback, serial,
1510 tiocmget->endp->bInterval);
1511 result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC);
1513 dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__,
1520 static void tiocmget_intr_callback(struct urb *urb)
1522 struct hso_serial *serial = urb->context;
1523 struct hso_tiocmget *tiocmget;
1524 int status = urb->status;
1525 u16 UART_state_bitmap, prev_UART_state_bitmap;
1526 struct uart_icount *icount;
1527 struct hso_serial_state_notification *serial_state_notification;
1528 struct usb_device *usb;
1534 handle_usb_error(status, __func__, serial->parent);
1537 tiocmget = serial->tiocmget;
1540 usb = serial->parent->usb;
1541 serial_state_notification = &tiocmget->serial_state_notification;
1542 if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1543 serial_state_notification->bNotification != B_NOTIFICATION ||
1544 le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1545 le16_to_cpu(serial_state_notification->wIndex) != W_INDEX ||
1546 le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1548 "hso received invalid serial state notification\n");
1549 DUMP(serial_state_notification,
1550 sizeof(struct hso_serial_state_notification));
1553 UART_state_bitmap = le16_to_cpu(serial_state_notification->
1555 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1556 icount = &tiocmget->icount;
1557 spin_lock(&serial->serial_lock);
1558 if ((UART_state_bitmap & B_OVERRUN) !=
1559 (prev_UART_state_bitmap & B_OVERRUN))
1561 if ((UART_state_bitmap & B_PARITY) !=
1562 (prev_UART_state_bitmap & B_PARITY))
1564 if ((UART_state_bitmap & B_FRAMING) !=
1565 (prev_UART_state_bitmap & B_FRAMING))
1567 if ((UART_state_bitmap & B_RING_SIGNAL) &&
1568 !(prev_UART_state_bitmap & B_RING_SIGNAL))
1570 if ((UART_state_bitmap & B_BREAK) !=
1571 (prev_UART_state_bitmap & B_BREAK))
1573 if ((UART_state_bitmap & B_TX_CARRIER) !=
1574 (prev_UART_state_bitmap & B_TX_CARRIER))
1576 if ((UART_state_bitmap & B_RX_CARRIER) !=
1577 (prev_UART_state_bitmap & B_RX_CARRIER))
1579 tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1580 spin_unlock(&serial->serial_lock);
1581 tiocmget->intr_completed = 1;
1582 wake_up_interruptible(&tiocmget->waitq);
1584 memset(serial_state_notification, 0,
1585 sizeof(struct hso_serial_state_notification));
1586 tiocmget_submit_urb(serial,
1588 serial->parent->usb);
1592 * next few functions largely stolen from drivers/serial/serial_core.c
1594 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1595 * - mask passed in arg for lines of interest
1596 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1597 * Caller should use TIOCGICOUNT to see which one it was
1600 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1602 DECLARE_WAITQUEUE(wait, current);
1603 struct uart_icount cprev, cnow;
1604 struct hso_tiocmget *tiocmget;
1607 tiocmget = serial->tiocmget;
1611 * note the counters on entry
1613 spin_lock_irq(&serial->serial_lock);
1614 memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1615 spin_unlock_irq(&serial->serial_lock);
1616 add_wait_queue(&tiocmget->waitq, &wait);
1618 spin_lock_irq(&serial->serial_lock);
1619 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1620 spin_unlock_irq(&serial->serial_lock);
1621 set_current_state(TASK_INTERRUPTIBLE);
1622 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1623 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1624 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd))) {
1629 /* see if a signal did it */
1630 if (signal_pending(current)) {
1636 current->state = TASK_RUNNING;
1637 remove_wait_queue(&tiocmget->waitq, &wait);
1643 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1644 * Return: write counters to the user passed counter struct
1645 * NB: both 1->0 and 0->1 transitions are counted except for
1646 * RI where only 0->1 is counted.
1648 static int hso_get_count(struct hso_serial *serial,
1649 struct serial_icounter_struct __user *icnt)
1651 struct serial_icounter_struct icount;
1652 struct uart_icount cnow;
1653 struct hso_tiocmget *tiocmget = serial->tiocmget;
1657 spin_lock_irq(&serial->serial_lock);
1658 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1659 spin_unlock_irq(&serial->serial_lock);
1661 icount.cts = cnow.cts;
1662 icount.dsr = cnow.dsr;
1663 icount.rng = cnow.rng;
1664 icount.dcd = cnow.dcd;
1665 icount.rx = cnow.rx;
1666 icount.tx = cnow.tx;
1667 icount.frame = cnow.frame;
1668 icount.overrun = cnow.overrun;
1669 icount.parity = cnow.parity;
1670 icount.brk = cnow.brk;
1671 icount.buf_overrun = cnow.buf_overrun;
1673 return copy_to_user(icnt, &icount, sizeof(icount)) ? -EFAULT : 0;
1677 static int hso_serial_tiocmget(struct tty_struct *tty, struct file *file)
1680 struct hso_serial *serial = get_serial_by_tty(tty);
1681 struct hso_tiocmget *tiocmget;
1682 u16 UART_state_bitmap;
1686 D1("no tty structures");
1689 spin_lock_irq(&serial->serial_lock);
1690 retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1691 ((serial->dtr_state) ? TIOCM_DTR : 0);
1692 tiocmget = serial->tiocmget;
1695 UART_state_bitmap = le16_to_cpu(
1696 tiocmget->prev_UART_state_bitmap);
1697 if (UART_state_bitmap & B_RING_SIGNAL)
1698 retval |= TIOCM_RNG;
1699 if (UART_state_bitmap & B_RX_CARRIER)
1701 if (UART_state_bitmap & B_TX_CARRIER)
1702 retval |= TIOCM_DSR;
1704 spin_unlock_irq(&serial->serial_lock);
1708 static int hso_serial_tiocmset(struct tty_struct *tty, struct file *file,
1709 unsigned int set, unsigned int clear)
1712 unsigned long flags;
1714 struct hso_serial *serial = get_serial_by_tty(tty);
1718 D1("no tty structures");
1722 if ((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM)
1725 if_num = serial->parent->interface->altsetting->desc.bInterfaceNumber;
1727 spin_lock_irqsave(&serial->serial_lock, flags);
1728 if (set & TIOCM_RTS)
1729 serial->rts_state = 1;
1730 if (set & TIOCM_DTR)
1731 serial->dtr_state = 1;
1733 if (clear & TIOCM_RTS)
1734 serial->rts_state = 0;
1735 if (clear & TIOCM_DTR)
1736 serial->dtr_state = 0;
1738 if (serial->dtr_state)
1740 if (serial->rts_state)
1743 spin_unlock_irqrestore(&serial->serial_lock, flags);
1745 return usb_control_msg(serial->parent->usb,
1746 usb_rcvctrlpipe(serial->parent->usb, 0), 0x22,
1747 0x21, val, if_num, NULL, 0,
1748 USB_CTRL_SET_TIMEOUT);
1751 static int hso_serial_ioctl(struct tty_struct *tty, struct file *file,
1752 unsigned int cmd, unsigned long arg)
1754 struct hso_serial *serial = get_serial_by_tty(tty);
1755 void __user *uarg = (void __user *)arg;
1757 D4("IOCTL cmd: %d, arg: %ld", cmd, arg);
1763 ret = hso_wait_modem_status(serial, arg);
1767 ret = hso_get_count(serial, uarg);
1777 /* starts a transmit */
1778 static void hso_kick_transmit(struct hso_serial *serial)
1781 unsigned long flags;
1784 spin_lock_irqsave(&serial->serial_lock, flags);
1785 if (!serial->tx_buffer_count)
1788 if (serial->tx_urb_used)
1791 /* Wakeup USB interface if necessary */
1792 if (hso_get_activity(serial->parent) == -EAGAIN)
1795 /* Switch pointers around to avoid memcpy */
1796 temp = serial->tx_buffer;
1797 serial->tx_buffer = serial->tx_data;
1798 serial->tx_data = temp;
1799 serial->tx_data_count = serial->tx_buffer_count;
1800 serial->tx_buffer_count = 0;
1802 /* If temp is set, it means we switched buffers */
1803 if (temp && serial->write_data) {
1804 res = serial->write_data(serial);
1806 serial->tx_urb_used = 1;
1809 spin_unlock_irqrestore(&serial->serial_lock, flags);
1812 /* make a request (for reading and writing data to muxed serial port) */
1813 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1814 struct urb *ctrl_urb,
1815 struct usb_ctrlrequest *ctrl_req,
1816 u8 *ctrl_urb_data, u32 size)
1822 if (!serial || !ctrl_urb || !ctrl_req) {
1823 printk(KERN_ERR "%s: Wrong arguments\n", __func__);
1828 ctrl_req->wValue = 0;
1829 ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1830 ctrl_req->wLength = cpu_to_le16(size);
1832 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1833 /* Reading command */
1834 ctrl_req->bRequestType = USB_DIR_IN |
1835 USB_TYPE_OPTION_VENDOR |
1836 USB_RECIP_INTERFACE;
1837 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1838 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1840 /* Writing command */
1841 ctrl_req->bRequestType = USB_DIR_OUT |
1842 USB_TYPE_OPTION_VENDOR |
1843 USB_RECIP_INTERFACE;
1844 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1845 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1848 D2("%s command (%02x) len: %d, port: %d",
1849 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1850 ctrl_req->bRequestType, ctrl_req->wLength, port);
1853 ctrl_urb->transfer_flags = 0;
1854 usb_fill_control_urb(ctrl_urb,
1855 serial->parent->usb,
1858 ctrl_urb_data, size, ctrl_callback, serial);
1859 /* Send it on merry way */
1860 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1862 dev_err(&ctrl_urb->dev->dev,
1863 "%s failed submit ctrl_urb %d type %d\n", __func__,
1872 /* called by intr_callback when read occurs */
1873 static int hso_mux_serial_read(struct hso_serial *serial)
1879 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1880 /* make the request */
1882 if (serial->num_rx_urbs != 1) {
1883 dev_err(&serial->parent->interface->dev,
1884 "ERROR: mux'd reads with multiple buffers "
1888 return mux_device_request(serial,
1889 USB_CDC_GET_ENCAPSULATED_RESPONSE,
1890 serial->parent->port_spec & HSO_PORT_MASK,
1892 &serial->ctrl_req_rx,
1893 serial->rx_data[0], serial->rx_data_length);
1896 /* used for muxed serial port callback (muxed serial read) */
1897 static void intr_callback(struct urb *urb)
1899 struct hso_shared_int *shared_int = urb->context;
1900 struct hso_serial *serial;
1901 unsigned char *port_req;
1902 int status = urb->status;
1905 usb_mark_last_busy(urb->dev);
1913 handle_usb_error(status, __func__, NULL);
1916 D4("\n--- Got intr callback 0x%02X ---", status);
1919 port_req = urb->transfer_buffer;
1920 D4(" port_req = 0x%.2X\n", *port_req);
1921 /* loop over all muxed ports to find the one sending this */
1922 for (i = 0; i < 8; i++) {
1923 /* max 8 channels on MUX */
1924 if (*port_req & (1 << i)) {
1925 serial = get_serial_by_shared_int_and_type(shared_int,
1927 if (serial != NULL) {
1928 D1("Pending read interrupt on port %d\n", i);
1929 spin_lock(&serial->serial_lock);
1930 if (serial->rx_state == RX_IDLE &&
1931 serial->open_count > 0) {
1932 /* Setup and send a ctrl req read on
1934 if (!serial->rx_urb_filled[0]) {
1935 serial->rx_state = RX_SENT;
1936 hso_mux_serial_read(serial);
1938 serial->rx_state = RX_PENDING;
1940 D1("Already a read pending on "
1941 "port %d or port not open\n", i);
1943 spin_unlock(&serial->serial_lock);
1947 /* Resubmit interrupt urb */
1948 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1951 /* called for writing to muxed serial port */
1952 static int hso_mux_serial_write_data(struct hso_serial *serial)
1957 return mux_device_request(serial,
1958 USB_CDC_SEND_ENCAPSULATED_COMMAND,
1959 serial->parent->port_spec & HSO_PORT_MASK,
1961 &serial->ctrl_req_tx,
1962 serial->tx_data, serial->tx_data_count);
1965 /* write callback for Diag and CS port */
1966 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1968 struct hso_serial *serial = urb->context;
1969 int status = urb->status;
1970 struct tty_struct *tty;
1974 D1("serial == NULL");
1978 spin_lock(&serial->serial_lock);
1979 serial->tx_urb_used = 0;
1980 tty = tty_kref_get(serial->tty);
1981 spin_unlock(&serial->serial_lock);
1983 handle_usb_error(status, __func__, serial->parent);
1987 hso_put_activity(serial->parent);
1992 hso_kick_transmit(serial);
1997 /* called for writing diag or CS serial port */
1998 static int hso_std_serial_write_data(struct hso_serial *serial)
2000 int count = serial->tx_data_count;
2003 usb_fill_bulk_urb(serial->tx_urb,
2004 serial->parent->usb,
2005 usb_sndbulkpipe(serial->parent->usb,
2007 bEndpointAddress & 0x7F),
2008 serial->tx_data, serial->tx_data_count,
2009 hso_std_serial_write_bulk_callback, serial);
2011 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
2013 dev_warn(&serial->parent->usb->dev,
2014 "Failed to submit urb - res %d\n", result);
2021 /* callback after read or write on muxed serial port */
2022 static void ctrl_callback(struct urb *urb)
2024 struct hso_serial *serial = urb->context;
2025 struct usb_ctrlrequest *req;
2026 int status = urb->status;
2027 struct tty_struct *tty;
2033 spin_lock(&serial->serial_lock);
2034 serial->tx_urb_used = 0;
2035 tty = tty_kref_get(serial->tty);
2036 spin_unlock(&serial->serial_lock);
2038 handle_usb_error(status, __func__, serial->parent);
2044 req = (struct usb_ctrlrequest *)(urb->setup_packet);
2045 D4("\n--- Got muxed ctrl callback 0x%02X ---", status);
2046 D4("Actual length of urb = %d\n", urb->actual_length);
2047 DUMP1(urb->transfer_buffer, urb->actual_length);
2049 if (req->bRequestType ==
2050 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
2051 /* response to a read command */
2052 serial->rx_urb_filled[0] = 1;
2053 spin_lock(&serial->serial_lock);
2054 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
2055 spin_unlock(&serial->serial_lock);
2057 hso_put_activity(serial->parent);
2060 /* response to a write command */
2061 hso_kick_transmit(serial);
2066 /* handle RX data for serial port */
2067 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
2069 struct tty_struct *tty;
2070 int write_length_remaining = 0;
2074 if (urb == NULL || serial == NULL) {
2075 D1("serial = NULL");
2079 /* All callers to put_rxbuf_data hold serial_lock */
2080 tty = tty_kref_get(serial->tty);
2082 /* Push data to tty */
2084 write_length_remaining = urb->actual_length -
2085 serial->curr_rx_urb_offset;
2086 D1("data to push to tty");
2087 while (write_length_remaining) {
2088 if (test_bit(TTY_THROTTLED, &tty->flags)) {
2092 curr_write_len = tty_insert_flip_string
2093 (tty, urb->transfer_buffer +
2094 serial->curr_rx_urb_offset,
2095 write_length_remaining);
2096 serial->curr_rx_urb_offset += curr_write_len;
2097 write_length_remaining -= curr_write_len;
2098 tty_flip_buffer_push(tty);
2101 if (write_length_remaining == 0) {
2102 serial->curr_rx_urb_offset = 0;
2103 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2106 return write_length_remaining;
2110 /* Base driver functions */
2112 static void hso_log_port(struct hso_device *hso_dev)
2117 switch (hso_dev->port_spec & HSO_PORT_MASK) {
2118 case HSO_PORT_CONTROL:
2119 port_type = "Control";
2122 port_type = "Application";
2127 case HSO_PORT_GPS_CONTROL:
2128 port_type = "GPS control";
2131 port_type = "Application2";
2137 port_type = "Diagnostic";
2139 case HSO_PORT_DIAG2:
2140 port_type = "Diagnostic2";
2142 case HSO_PORT_MODEM:
2143 port_type = "Modem";
2145 case HSO_PORT_NETWORK:
2146 port_type = "Network";
2149 port_type = "Unknown";
2152 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2153 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2155 sprintf(port_dev, "/dev/%s%d", tty_filename,
2156 dev2ser(hso_dev)->minor);
2158 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2159 port_type, port_dev);
2162 static int hso_start_net_device(struct hso_device *hso_dev)
2165 struct hso_net *hso_net = dev2net(hso_dev);
2170 /* send URBs for all read buffers */
2171 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2173 /* Prep a receive URB */
2174 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2176 usb_rcvbulkpipe(hso_dev->usb,
2178 bEndpointAddress & 0x7F),
2179 hso_net->mux_bulk_rx_buf_pool[i],
2180 MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2183 /* Put it out there so the device can send us stuff */
2184 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2187 dev_warn(&hso_dev->usb->dev,
2188 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2195 static int hso_stop_net_device(struct hso_device *hso_dev)
2198 struct hso_net *hso_net = dev2net(hso_dev);
2203 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2204 if (hso_net->mux_bulk_rx_urb_pool[i])
2205 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2208 if (hso_net->mux_bulk_tx_urb)
2209 usb_kill_urb(hso_net->mux_bulk_tx_urb);
2214 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2217 struct hso_serial *serial = dev2ser(hso_dev);
2222 /* If it is not the MUX port fill in and submit a bulk urb (already
2223 * allocated in hso_serial_start) */
2224 if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2225 for (i = 0; i < serial->num_rx_urbs; i++) {
2226 usb_fill_bulk_urb(serial->rx_urb[i],
2227 serial->parent->usb,
2228 usb_rcvbulkpipe(serial->parent->usb,
2233 serial->rx_data_length,
2234 hso_std_serial_read_bulk_callback,
2236 result = usb_submit_urb(serial->rx_urb[i], flags);
2238 dev_warn(&serial->parent->usb->dev,
2239 "Failed to submit urb - res %d\n",
2245 mutex_lock(&serial->shared_int->shared_int_lock);
2246 if (!serial->shared_int->use_count) {
2248 hso_mux_submit_intr_urb(serial->shared_int,
2249 hso_dev->usb, flags);
2251 serial->shared_int->use_count++;
2252 mutex_unlock(&serial->shared_int->shared_int_lock);
2254 if (serial->tiocmget)
2255 tiocmget_submit_urb(serial,
2257 serial->parent->usb);
2261 static int hso_stop_serial_device(struct hso_device *hso_dev)
2264 struct hso_serial *serial = dev2ser(hso_dev);
2265 struct hso_tiocmget *tiocmget;
2270 for (i = 0; i < serial->num_rx_urbs; i++) {
2271 if (serial->rx_urb[i]) {
2272 usb_kill_urb(serial->rx_urb[i]);
2273 serial->rx_urb_filled[i] = 0;
2276 serial->curr_rx_urb_idx = 0;
2277 serial->curr_rx_urb_offset = 0;
2280 usb_kill_urb(serial->tx_urb);
2282 if (serial->shared_int) {
2283 mutex_lock(&serial->shared_int->shared_int_lock);
2284 if (serial->shared_int->use_count &&
2285 (--serial->shared_int->use_count == 0)) {
2288 urb = serial->shared_int->shared_intr_urb;
2292 mutex_unlock(&serial->shared_int->shared_int_lock);
2294 tiocmget = serial->tiocmget;
2296 wake_up_interruptible(&tiocmget->waitq);
2297 usb_kill_urb(tiocmget->urb);
2303 static void hso_serial_common_free(struct hso_serial *serial)
2307 if (serial->parent->dev)
2308 device_remove_file(serial->parent->dev, &dev_attr_hsotype);
2310 tty_unregister_device(tty_drv, serial->minor);
2312 for (i = 0; i < serial->num_rx_urbs; i++) {
2313 /* unlink and free RX URB */
2314 usb_free_urb(serial->rx_urb[i]);
2315 /* free the RX buffer */
2316 kfree(serial->rx_data[i]);
2319 /* unlink and free TX URB */
2320 usb_free_urb(serial->tx_urb);
2321 kfree(serial->tx_data);
2324 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
2325 int rx_size, int tx_size)
2331 minor = get_free_serial_index();
2335 /* register our minor number */
2336 serial->parent->dev = tty_register_device(tty_drv, minor,
2337 &serial->parent->interface->dev);
2338 dev = serial->parent->dev;
2339 dev_set_drvdata(dev, serial->parent);
2340 i = device_create_file(dev, &dev_attr_hsotype);
2342 /* fill in specific data for later use */
2343 serial->minor = minor;
2344 serial->magic = HSO_SERIAL_MAGIC;
2345 spin_lock_init(&serial->serial_lock);
2346 serial->num_rx_urbs = num_urbs;
2348 /* RX, allocate urb and initialize */
2350 /* prepare our RX buffer */
2351 serial->rx_data_length = rx_size;
2352 for (i = 0; i < serial->num_rx_urbs; i++) {
2353 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2354 if (!serial->rx_urb[i]) {
2355 dev_err(dev, "Could not allocate urb?\n");
2358 serial->rx_urb[i]->transfer_buffer = NULL;
2359 serial->rx_urb[i]->transfer_buffer_length = 0;
2360 serial->rx_data[i] = kzalloc(serial->rx_data_length,
2362 if (!serial->rx_data[i]) {
2363 dev_err(dev, "%s - Out of memory\n", __func__);
2368 /* TX, allocate urb and initialize */
2369 serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2370 if (!serial->tx_urb) {
2371 dev_err(dev, "Could not allocate urb?\n");
2374 serial->tx_urb->transfer_buffer = NULL;
2375 serial->tx_urb->transfer_buffer_length = 0;
2376 /* prepare our TX buffer */
2377 serial->tx_data_count = 0;
2378 serial->tx_buffer_count = 0;
2379 serial->tx_data_length = tx_size;
2380 serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2381 if (!serial->tx_data) {
2382 dev_err(dev, "%s - Out of memory\n", __func__);
2385 serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2386 if (!serial->tx_buffer) {
2387 dev_err(dev, "%s - Out of memory\n", __func__);
2393 hso_serial_common_free(serial);
2397 /* Creates a general hso device */
2398 static struct hso_device *hso_create_device(struct usb_interface *intf,
2401 struct hso_device *hso_dev;
2403 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2407 hso_dev->port_spec = port_spec;
2408 hso_dev->usb = interface_to_usbdev(intf);
2409 hso_dev->interface = intf;
2410 kref_init(&hso_dev->ref);
2411 mutex_init(&hso_dev->mutex);
2413 INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2414 INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2415 INIT_WORK(&hso_dev->reset_device, reset_device);
2420 /* Removes a network device in the network device table */
2421 static int remove_net_device(struct hso_device *hso_dev)
2425 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2426 if (network_table[i] == hso_dev) {
2427 network_table[i] = NULL;
2431 if (i == HSO_MAX_NET_DEVICES)
2436 /* Frees our network device */
2437 static void hso_free_net_device(struct hso_device *hso_dev)
2440 struct hso_net *hso_net = dev2net(hso_dev);
2445 remove_net_device(hso_net->parent);
2448 unregister_netdev(hso_net->net);
2449 free_netdev(hso_net->net);
2453 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2454 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2455 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2456 hso_net->mux_bulk_rx_buf_pool[i] = NULL;
2458 usb_free_urb(hso_net->mux_bulk_tx_urb);
2459 kfree(hso_net->mux_bulk_tx_buf);
2460 hso_net->mux_bulk_tx_buf = NULL;
2465 static const struct net_device_ops hso_netdev_ops = {
2466 .ndo_open = hso_net_open,
2467 .ndo_stop = hso_net_close,
2468 .ndo_start_xmit = hso_net_start_xmit,
2469 .ndo_tx_timeout = hso_net_tx_timeout,
2472 /* initialize the network interface */
2473 static void hso_net_init(struct net_device *net)
2475 struct hso_net *hso_net = netdev_priv(net);
2477 D1("sizeof hso_net is %d", (int)sizeof(*hso_net));
2479 /* fill in the other fields */
2480 net->netdev_ops = &hso_netdev_ops;
2481 net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2482 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2483 net->type = ARPHRD_NONE;
2484 net->mtu = DEFAULT_MTU - 14;
2485 net->tx_queue_len = 10;
2486 SET_ETHTOOL_OPS(net, &ops);
2488 /* and initialize the semaphore */
2489 spin_lock_init(&hso_net->net_lock);
2492 /* Adds a network device in the network device table */
2493 static int add_net_device(struct hso_device *hso_dev)
2497 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2498 if (network_table[i] == NULL) {
2499 network_table[i] = hso_dev;
2503 if (i == HSO_MAX_NET_DEVICES)
2508 static int hso_rfkill_set_block(void *data, bool blocked)
2510 struct hso_device *hso_dev = data;
2511 int enabled = !blocked;
2514 mutex_lock(&hso_dev->mutex);
2515 if (hso_dev->usb_gone)
2518 rv = usb_control_msg(hso_dev->usb, usb_rcvctrlpipe(hso_dev->usb, 0),
2519 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2520 USB_CTRL_SET_TIMEOUT);
2521 mutex_unlock(&hso_dev->mutex);
2525 static const struct rfkill_ops hso_rfkill_ops = {
2526 .set_block = hso_rfkill_set_block,
2529 /* Creates and sets up everything for rfkill */
2530 static void hso_create_rfkill(struct hso_device *hso_dev,
2531 struct usb_interface *interface)
2533 struct hso_net *hso_net = dev2net(hso_dev);
2534 struct device *dev = &hso_net->net->dev;
2537 rfkn = kzalloc(20, GFP_KERNEL);
2539 dev_err(dev, "%s - Out of memory\n", __func__);
2541 snprintf(rfkn, 20, "hso-%d",
2542 interface->altsetting->desc.bInterfaceNumber);
2544 hso_net->rfkill = rfkill_alloc(rfkn,
2545 &interface_to_usbdev(interface)->dev,
2547 &hso_rfkill_ops, hso_dev);
2548 if (!hso_net->rfkill) {
2549 dev_err(dev, "%s - Out of memory\n", __func__);
2553 if (rfkill_register(hso_net->rfkill) < 0) {
2554 rfkill_destroy(hso_net->rfkill);
2556 hso_net->rfkill = NULL;
2557 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2562 static struct device_type hso_type = {
2566 /* Creates our network device */
2567 static struct hso_device *hso_create_net_device(struct usb_interface *interface,
2571 struct net_device *net;
2572 struct hso_net *hso_net;
2573 struct hso_device *hso_dev;
2575 hso_dev = hso_create_device(interface, port_spec);
2579 /* allocate our network device, then we can put in our private data */
2580 /* call hso_net_init to do the basic initialization */
2581 net = alloc_netdev(sizeof(struct hso_net), "hso%d", hso_net_init);
2583 dev_err(&interface->dev, "Unable to create ethernet device\n");
2587 hso_net = netdev_priv(net);
2589 hso_dev->port_data.dev_net = hso_net;
2591 hso_net->parent = hso_dev;
2593 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2595 if (!hso_net->in_endp) {
2596 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2599 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2601 if (!hso_net->out_endp) {
2602 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2605 SET_NETDEV_DEV(net, &interface->dev);
2606 SET_NETDEV_DEVTYPE(net, &hso_type);
2608 /* registering our net device */
2609 result = register_netdev(net);
2611 dev_err(&interface->dev, "Failed to register device\n");
2615 /* start allocating */
2616 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2617 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2618 if (!hso_net->mux_bulk_rx_urb_pool[i]) {
2619 dev_err(&interface->dev, "Could not allocate rx urb\n");
2622 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2624 if (!hso_net->mux_bulk_rx_buf_pool[i]) {
2625 dev_err(&interface->dev, "Could not allocate rx buf\n");
2629 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2630 if (!hso_net->mux_bulk_tx_urb) {
2631 dev_err(&interface->dev, "Could not allocate tx urb\n");
2634 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2635 if (!hso_net->mux_bulk_tx_buf) {
2636 dev_err(&interface->dev, "Could not allocate tx buf\n");
2640 add_net_device(hso_dev);
2642 hso_log_port(hso_dev);
2644 hso_create_rfkill(hso_dev, interface);
2648 hso_free_net_device(hso_dev);
2652 static void hso_free_tiomget(struct hso_serial *serial)
2654 struct hso_tiocmget *tiocmget = serial->tiocmget;
2656 if (tiocmget->urb) {
2657 usb_free_urb(tiocmget->urb);
2658 tiocmget->urb = NULL;
2660 serial->tiocmget = NULL;
2666 /* Frees an AT channel ( goes for both mux and non-mux ) */
2667 static void hso_free_serial_device(struct hso_device *hso_dev)
2669 struct hso_serial *serial = dev2ser(hso_dev);
2673 set_serial_by_index(serial->minor, NULL);
2675 hso_serial_common_free(serial);
2677 if (serial->shared_int) {
2678 mutex_lock(&serial->shared_int->shared_int_lock);
2679 if (--serial->shared_int->ref_count == 0)
2680 hso_free_shared_int(serial->shared_int);
2682 mutex_unlock(&serial->shared_int->shared_int_lock);
2684 hso_free_tiomget(serial);
2689 /* Creates a bulk AT channel */
2690 static struct hso_device *hso_create_bulk_serial_device(
2691 struct usb_interface *interface, int port)
2693 struct hso_device *hso_dev;
2694 struct hso_serial *serial;
2696 struct hso_tiocmget *tiocmget;
2698 hso_dev = hso_create_device(interface, port);
2702 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2706 serial->parent = hso_dev;
2707 hso_dev->port_data.dev_serial = serial;
2709 if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2711 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2713 /* it isn't going to break our heart if serial->tiocmget
2714 * allocation fails don't bother checking this.
2716 if (serial->tiocmget) {
2717 tiocmget = serial->tiocmget;
2718 tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2719 if (tiocmget->urb) {
2720 mutex_init(&tiocmget->mutex);
2721 init_waitqueue_head(&tiocmget->waitq);
2722 tiocmget->endp = hso_get_ep(
2724 USB_ENDPOINT_XFER_INT,
2727 hso_free_tiomget(serial);
2733 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2737 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2739 if (!serial->in_endp) {
2740 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2746 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2747 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2751 serial->write_data = hso_std_serial_write_data;
2753 /* and record this serial */
2754 set_serial_by_index(serial->minor, serial);
2756 /* setup the proc dirs and files if needed */
2757 hso_log_port(hso_dev);
2759 /* done, return it */
2763 hso_serial_common_free(serial);
2765 hso_free_tiomget(serial);
2771 /* Creates a multiplexed AT channel */
2773 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2775 struct hso_shared_int *mux)
2777 struct hso_device *hso_dev;
2778 struct hso_serial *serial;
2781 port_spec = HSO_INTF_MUX;
2782 port_spec &= ~HSO_PORT_MASK;
2784 port_spec |= hso_mux_to_port(port);
2785 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2788 hso_dev = hso_create_device(interface, port_spec);
2792 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2796 hso_dev->port_data.dev_serial = serial;
2797 serial->parent = hso_dev;
2799 if (hso_serial_common_create
2800 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2803 serial->tx_data_length--;
2804 serial->write_data = hso_mux_serial_write_data;
2806 serial->shared_int = mux;
2807 mutex_lock(&serial->shared_int->shared_int_lock);
2808 serial->shared_int->ref_count++;
2809 mutex_unlock(&serial->shared_int->shared_int_lock);
2811 /* and record this serial */
2812 set_serial_by_index(serial->minor, serial);
2814 /* setup the proc dirs and files if needed */
2815 hso_log_port(hso_dev);
2817 /* done, return it */
2822 tty_unregister_device(tty_drv, serial->minor);
2831 static void hso_free_shared_int(struct hso_shared_int *mux)
2833 usb_free_urb(mux->shared_intr_urb);
2834 kfree(mux->shared_intr_buf);
2835 mutex_unlock(&mux->shared_int_lock);
2840 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2842 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2847 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2849 if (!mux->intr_endp) {
2850 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2854 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2855 if (!mux->shared_intr_urb) {
2856 dev_err(&interface->dev, "Could not allocate intr urb?\n");
2859 mux->shared_intr_buf =
2860 kzalloc(le16_to_cpu(mux->intr_endp->wMaxPacketSize),
2862 if (!mux->shared_intr_buf) {
2863 dev_err(&interface->dev, "Could not allocate intr buf?\n");
2867 mutex_init(&mux->shared_int_lock);
2872 kfree(mux->shared_intr_buf);
2873 usb_free_urb(mux->shared_intr_urb);
2878 /* Gets the port spec for a certain interface */
2879 static int hso_get_config_data(struct usb_interface *interface)
2881 struct usb_device *usbdev = interface_to_usbdev(interface);
2883 u32 if_num = interface->altsetting->desc.bInterfaceNumber;
2886 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2887 0x86, 0xC0, 0, 0, config_data, 17,
2888 USB_CTRL_SET_TIMEOUT) != 0x11) {
2892 switch (config_data[if_num]) {
2897 result = HSO_PORT_DIAG;
2900 result = HSO_PORT_GPS;
2903 result = HSO_PORT_GPS_CONTROL;
2906 result = HSO_PORT_APP;
2909 result = HSO_PORT_APP2;
2912 result = HSO_PORT_CONTROL;
2915 result = HSO_PORT_NETWORK;
2918 result = HSO_PORT_MODEM;
2921 result = HSO_PORT_MSD;
2924 result = HSO_PORT_PCSC;
2927 result = HSO_PORT_VOICE;
2934 result |= HSO_INTF_BULK;
2936 if (config_data[16] & 0x1)
2937 result |= HSO_INFO_CRC_BUG;
2942 /* called once for each interface upon device insertion */
2943 static int hso_probe(struct usb_interface *interface,
2944 const struct usb_device_id *id)
2946 int mux, i, if_num, port_spec;
2947 unsigned char port_mask;
2948 struct hso_device *hso_dev = NULL;
2949 struct hso_shared_int *shared_int;
2950 struct hso_device *tmp_dev = NULL;
2952 if_num = interface->altsetting->desc.bInterfaceNumber;
2954 /* Get the interface/port specification from either driver_info or from
2955 * the device itself */
2956 if (id->driver_info)
2957 port_spec = ((u32 *)(id->driver_info))[if_num];
2959 port_spec = hso_get_config_data(interface);
2961 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2962 dev_err(&interface->dev, "Not our interface\n");
2965 /* Check if we need to switch to alt interfaces prior to port
2967 if (interface->num_altsetting > 1)
2968 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2969 interface->needs_remote_wakeup = 1;
2971 /* Allocate new hso device(s) */
2972 switch (port_spec & HSO_INTF_MASK) {
2974 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2975 /* Create the network device */
2977 hso_dev = hso_create_net_device(interface,
2985 if (hso_get_mux_ports(interface, &port_mask))
2986 /* TODO: de-allocate everything */
2989 shared_int = hso_create_shared_int(interface);
2993 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2994 if (port_mask & i) {
2995 hso_dev = hso_create_mux_serial_device(
2996 interface, i, shared_int);
3007 /* It's a regular bulk interface */
3008 if (((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) &&
3010 hso_dev = hso_create_net_device(interface, port_spec);
3013 hso_create_bulk_serial_device(interface, port_spec);
3021 /* save our data pointer in this device */
3022 usb_set_intfdata(interface, hso_dev);
3027 hso_free_interface(interface);
3031 /* device removed, cleaning up */
3032 static void hso_disconnect(struct usb_interface *interface)
3034 hso_free_interface(interface);
3036 /* remove reference of our private data */
3037 usb_set_intfdata(interface, NULL);
3040 static void async_get_intf(struct work_struct *data)
3042 struct hso_device *hso_dev =
3043 container_of(data, struct hso_device, async_get_intf);
3044 usb_autopm_get_interface(hso_dev->interface);
3047 static void async_put_intf(struct work_struct *data)
3049 struct hso_device *hso_dev =
3050 container_of(data, struct hso_device, async_put_intf);
3051 usb_autopm_put_interface(hso_dev->interface);
3054 static int hso_get_activity(struct hso_device *hso_dev)
3056 if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
3057 if (!hso_dev->is_active) {
3058 hso_dev->is_active = 1;
3059 schedule_work(&hso_dev->async_get_intf);
3063 if (hso_dev->usb->state != USB_STATE_CONFIGURED)
3066 usb_mark_last_busy(hso_dev->usb);
3071 static int hso_put_activity(struct hso_device *hso_dev)
3073 if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
3074 if (hso_dev->is_active) {
3075 hso_dev->is_active = 0;
3076 schedule_work(&hso_dev->async_put_intf);
3080 hso_dev->is_active = 0;
3084 /* called by kernel when we need to suspend device */
3085 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3089 /* Stop all serial ports */
3090 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3091 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3092 result = hso_stop_serial_device(serial_table[i]);
3098 /* Stop all network ports */
3099 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3100 if (network_table[i] &&
3101 (network_table[i]->interface == iface)) {
3102 result = hso_stop_net_device(network_table[i]);
3112 /* called by kernel when we need to resume device */
3113 static int hso_resume(struct usb_interface *iface)
3116 struct hso_net *hso_net;
3118 /* Start all serial ports */
3119 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3120 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3121 if (dev2ser(serial_table[i])->open_count) {
3123 hso_start_serial_device(serial_table[i], GFP_NOIO);
3124 hso_kick_transmit(dev2ser(serial_table[i]));
3131 /* Start all network ports */
3132 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3133 if (network_table[i] &&
3134 (network_table[i]->interface == iface)) {
3135 hso_net = dev2net(network_table[i]);
3136 if (hso_net->flags & IFF_UP) {
3137 /* First transmit any lingering data,
3138 then restart the device. */
3139 if (hso_net->skb_tx_buf) {
3140 dev_dbg(&iface->dev,
3142 " lingering data\n");
3143 hso_net_start_xmit(hso_net->skb_tx_buf,
3145 hso_net->skb_tx_buf = NULL;
3147 result = hso_start_net_device(network_table[i]);
3158 static void reset_device(struct work_struct *data)
3160 struct hso_device *hso_dev =
3161 container_of(data, struct hso_device, reset_device);
3162 struct usb_device *usb = hso_dev->usb;
3165 if (hso_dev->usb_gone) {
3166 D1("No reset during disconnect\n");
3168 result = usb_lock_device_for_reset(usb, hso_dev->interface);
3170 D1("unable to lock device for reset: %d\n", result);
3172 usb_reset_device(usb);
3173 usb_unlock_device(usb);
3178 static void hso_serial_ref_free(struct kref *ref)
3180 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3182 hso_free_serial_device(hso_dev);
3185 static void hso_free_interface(struct usb_interface *interface)
3187 struct hso_serial *hso_dev;
3188 struct tty_struct *tty;
3191 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3192 if (serial_table[i] &&
3193 (serial_table[i]->interface == interface)) {
3194 hso_dev = dev2ser(serial_table[i]);
3195 spin_lock_irq(&hso_dev->serial_lock);
3196 tty = tty_kref_get(hso_dev->tty);
3197 spin_unlock_irq(&hso_dev->serial_lock);
3200 mutex_lock(&hso_dev->parent->mutex);
3202 hso_dev->parent->usb_gone = 1;
3203 mutex_unlock(&hso_dev->parent->mutex);
3204 kref_put(&serial_table[i]->ref, hso_serial_ref_free);
3208 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3209 if (network_table[i] &&
3210 (network_table[i]->interface == interface)) {
3211 struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3212 /* hso_stop_net_device doesn't stop the net queue since
3213 * traffic needs to start it again when suspended */
3214 netif_stop_queue(dev2net(network_table[i])->net);
3215 hso_stop_net_device(network_table[i]);
3216 cancel_work_sync(&network_table[i]->async_put_intf);
3217 cancel_work_sync(&network_table[i]->async_get_intf);
3219 rfkill_unregister(rfk);
3220 rfkill_destroy(rfk);
3222 hso_free_net_device(network_table[i]);
3227 /* Helper functions */
3229 /* Get the endpoint ! */
3230 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3234 struct usb_host_interface *iface = intf->cur_altsetting;
3235 struct usb_endpoint_descriptor *endp;
3237 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3238 endp = &iface->endpoint[i].desc;
3239 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3240 (usb_endpoint_type(endp) == type))
3247 /* Get the byte that describes which ports are enabled */
3248 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3251 struct usb_host_interface *iface = intf->cur_altsetting;
3253 if (iface->extralen == 3) {
3254 *ports = iface->extra[2];
3258 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3259 if (iface->endpoint[i].extralen == 3) {
3260 *ports = iface->endpoint[i].extra[2];
3268 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3269 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3270 struct usb_device *usb, gfp_t gfp)
3274 usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3276 shared_int->intr_endp->bEndpointAddress & 0x7F),
3277 shared_int->shared_intr_buf,
3279 intr_callback, shared_int,
3280 shared_int->intr_endp->bInterval);
3282 result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3284 dev_warn(&usb->dev, "%s failed mux_intr_urb %d\n", __func__,
3290 /* operations setup of the serial interface */
3291 static const struct tty_operations hso_serial_ops = {
3292 .open = hso_serial_open,
3293 .close = hso_serial_close,
3294 .write = hso_serial_write,
3295 .write_room = hso_serial_write_room,
3296 .ioctl = hso_serial_ioctl,
3297 .set_termios = hso_serial_set_termios,
3298 .chars_in_buffer = hso_serial_chars_in_buffer,
3299 .tiocmget = hso_serial_tiocmget,
3300 .tiocmset = hso_serial_tiocmset,
3301 .unthrottle = hso_unthrottle
3304 static struct usb_driver hso_driver = {
3305 .name = driver_name,
3307 .disconnect = hso_disconnect,
3308 .id_table = hso_ids,
3309 .suspend = hso_suspend,
3310 .resume = hso_resume,
3311 .reset_resume = hso_resume,
3312 .supports_autosuspend = 1,
3315 static int __init hso_init(void)
3320 /* put it in the log */
3321 printk(KERN_INFO "hso: %s\n", version);
3323 /* Initialise the serial table semaphore and table */
3324 spin_lock_init(&serial_table_lock);
3325 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3326 serial_table[i] = NULL;
3328 /* allocate our driver using the proper amount of supported minors */
3329 tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
3333 /* fill in all needed values */
3334 tty_drv->magic = TTY_DRIVER_MAGIC;
3335 tty_drv->owner = THIS_MODULE;
3336 tty_drv->driver_name = driver_name;
3337 tty_drv->name = tty_filename;
3339 /* if major number is provided as parameter, use that one */
3341 tty_drv->major = tty_major;
3343 tty_drv->minor_start = 0;
3344 tty_drv->num = HSO_SERIAL_TTY_MINORS;
3345 tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3346 tty_drv->subtype = SERIAL_TYPE_NORMAL;
3347 tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
3348 tty_drv->init_termios = tty_std_termios;
3349 hso_init_termios(&tty_drv->init_termios);
3350 tty_set_operations(tty_drv, &hso_serial_ops);
3352 /* register the tty driver */
3353 result = tty_register_driver(tty_drv);
3355 printk(KERN_ERR "%s - tty_register_driver failed(%d)\n",
3360 /* register this module as an usb driver */
3361 result = usb_register(&hso_driver);
3363 printk(KERN_ERR "Could not register hso driver? error: %d\n",
3365 /* cleanup serial interface */
3366 tty_unregister_driver(tty_drv);
3374 static void __exit hso_exit(void)
3376 printk(KERN_INFO "hso: unloaded\n");
3378 tty_unregister_driver(tty_drv);
3379 /* deregister the usb driver */
3380 usb_deregister(&hso_driver);
3383 /* Module definitions */
3384 module_init(hso_init);
3385 module_exit(hso_exit);
3387 MODULE_AUTHOR(MOD_AUTHOR);
3388 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3389 MODULE_LICENSE(MOD_LICENSE);
3391 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3392 MODULE_PARM_DESC(debug, "Level of debug [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3393 module_param(debug, int, S_IRUGO | S_IWUSR);
3395 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3396 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3397 module_param(tty_major, int, S_IRUGO | S_IWUSR);
3399 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3400 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3401 module_param(disable_net, int, S_IRUGO | S_IWUSR);