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/tty.h>
62 #include <linux/tty_driver.h>
63 #include <linux/tty_flip.h>
64 #include <linux/kmod.h>
65 #include <linux/rfkill.h>
67 #include <linux/uaccess.h>
68 #include <linux/usb/cdc.h>
70 #include <asm/byteorder.h>
71 #include <linux/serial_core.h>
72 #include <linux/serial.h>
75 #define MOD_AUTHOR "Option Wireless"
76 #define MOD_DESCRIPTION "USB High Speed Option driver"
77 #define MOD_LICENSE "GPL"
79 #define HSO_MAX_NET_DEVICES 10
80 #define HSO__MAX_MTU 2048
81 #define DEFAULT_MTU 1500
82 #define DEFAULT_MRU 1500
84 #define CTRL_URB_RX_SIZE 1024
85 #define CTRL_URB_TX_SIZE 64
87 #define BULK_URB_RX_SIZE 4096
88 #define BULK_URB_TX_SIZE 8192
90 #define MUX_BULK_RX_BUF_SIZE HSO__MAX_MTU
91 #define MUX_BULK_TX_BUF_SIZE HSO__MAX_MTU
92 #define MUX_BULK_RX_BUF_COUNT 4
93 #define USB_TYPE_OPTION_VENDOR 0x20
95 /* These definitions are used with the struct hso_net flags element */
96 /* - use *_bit operations on it. (bit indices not values.) */
97 #define HSO_NET_RUNNING 0
99 #define HSO_NET_TX_TIMEOUT (HZ*10)
101 #define HSO_SERIAL_MAGIC 0x48534f31
103 /* Number of ttys to handle */
104 #define HSO_SERIAL_TTY_MINORS 256
106 #define MAX_RX_URBS 2
108 /*****************************************************************************/
109 /* Debugging functions */
110 /*****************************************************************************/
111 #define hso_dbg(lvl, fmt, ...) \
114 pr_info("[%d:%s] " fmt, \
115 __LINE__, __func__, ##__VA_ARGS__); \
118 /*****************************************************************************/
120 /*****************************************************************************/
121 enum pkt_parse_state {
127 /*****************************************************************************/
129 /*****************************************************************************/
131 struct hso_shared_int {
132 struct usb_endpoint_descriptor *intr_endp;
133 void *shared_intr_buf;
134 struct urb *shared_intr_urb;
135 struct usb_device *usb;
138 struct mutex shared_int_lock;
142 struct hso_device *parent;
143 struct net_device *net;
144 struct rfkill *rfkill;
147 struct usb_endpoint_descriptor *in_endp;
148 struct usb_endpoint_descriptor *out_endp;
150 struct urb *mux_bulk_rx_urb_pool[MUX_BULK_RX_BUF_COUNT];
151 struct urb *mux_bulk_tx_urb;
152 void *mux_bulk_rx_buf_pool[MUX_BULK_RX_BUF_COUNT];
153 void *mux_bulk_tx_buf;
155 struct sk_buff *skb_rx_buf;
156 struct sk_buff *skb_tx_buf;
158 enum pkt_parse_state rx_parse_state;
161 unsigned short rx_buf_size;
162 unsigned short rx_buf_missing;
163 struct iphdr rx_ip_hdr;
174 #define BM_REQUEST_TYPE (0xa1)
175 #define B_NOTIFICATION (0x20)
176 #define W_VALUE (0x0)
177 #define W_LENGTH (0x2)
179 #define B_OVERRUN (0x1<<6)
180 #define B_PARITY (0x1<<5)
181 #define B_FRAMING (0x1<<4)
182 #define B_RING_SIGNAL (0x1<<3)
183 #define B_BREAK (0x1<<2)
184 #define B_TX_CARRIER (0x1<<1)
185 #define B_RX_CARRIER (0x1<<0)
187 struct hso_serial_state_notification {
193 u16 UART_state_bitmap;
196 struct hso_tiocmget {
198 wait_queue_head_t waitq;
200 struct usb_endpoint_descriptor *endp;
202 struct hso_serial_state_notification serial_state_notification;
203 u16 prev_UART_state_bitmap;
204 struct uart_icount icount;
209 struct hso_device *parent;
213 struct hso_shared_int *shared_int;
215 /* rx/tx urb could be either a bulk urb or a control urb depending
216 on which serial port it is used on. */
217 struct urb *rx_urb[MAX_RX_URBS];
219 u8 *rx_data[MAX_RX_URBS];
220 u16 rx_data_length; /* should contain allocated length */
225 u16 tx_data_length; /* should contain allocated length */
228 struct usb_ctrlrequest ctrl_req_tx;
229 struct usb_ctrlrequest ctrl_req_rx;
231 struct usb_endpoint_descriptor *in_endp;
232 struct usb_endpoint_descriptor *out_endp;
234 enum rx_ctrl_state rx_state;
237 unsigned tx_urb_used:1;
239 struct tty_port port;
240 /* from usb_serial_port */
241 spinlock_t serial_lock;
243 int (*write_data) (struct hso_serial *serial);
244 struct hso_tiocmget *tiocmget;
245 /* Hacks required to get flow control
246 * working on the serial receive buffers
247 * so as not to drop characters on the floor.
250 u8 rx_urb_filled[MAX_RX_URBS];
251 struct tasklet_struct unthrottle_tasklet;
256 struct hso_serial *dev_serial;
257 struct hso_net *dev_net;
264 struct work_struct async_get_intf;
265 struct work_struct async_put_intf;
267 struct usb_device *usb;
268 struct usb_interface *interface;
275 /* Type of interface */
276 #define HSO_INTF_MASK 0xFF00
277 #define HSO_INTF_MUX 0x0100
278 #define HSO_INTF_BULK 0x0200
281 #define HSO_PORT_MASK 0xFF
282 #define HSO_PORT_NO_PORT 0x0
283 #define HSO_PORT_CONTROL 0x1
284 #define HSO_PORT_APP 0x2
285 #define HSO_PORT_GPS 0x3
286 #define HSO_PORT_PCSC 0x4
287 #define HSO_PORT_APP2 0x5
288 #define HSO_PORT_GPS_CONTROL 0x6
289 #define HSO_PORT_MSD 0x7
290 #define HSO_PORT_VOICE 0x8
291 #define HSO_PORT_DIAG2 0x9
292 #define HSO_PORT_DIAG 0x10
293 #define HSO_PORT_MODEM 0x11
294 #define HSO_PORT_NETWORK 0x12
296 /* Additional device info */
297 #define HSO_INFO_MASK 0xFF000000
298 #define HSO_INFO_CRC_BUG 0x01000000
300 /*****************************************************************************/
302 /*****************************************************************************/
303 /* Serial driver functions */
304 static int hso_serial_tiocmset(struct tty_struct *tty,
305 unsigned int set, unsigned int clear);
306 static void ctrl_callback(struct urb *urb);
307 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial);
308 static void hso_kick_transmit(struct hso_serial *serial);
309 /* Helper functions */
310 static int hso_mux_submit_intr_urb(struct hso_shared_int *mux_int,
311 struct usb_device *usb, gfp_t gfp);
312 static void handle_usb_error(int status, const char *function,
313 struct hso_device *hso_dev);
314 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
316 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports);
317 static void hso_free_interface(struct usb_interface *intf);
318 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags);
319 static int hso_stop_serial_device(struct hso_device *hso_dev);
320 static int hso_start_net_device(struct hso_device *hso_dev);
321 static void hso_free_shared_int(struct hso_shared_int *shared_int);
322 static int hso_stop_net_device(struct hso_device *hso_dev);
323 static void hso_serial_ref_free(struct kref *ref);
324 static void hso_std_serial_read_bulk_callback(struct urb *urb);
325 static int hso_mux_serial_read(struct hso_serial *serial);
326 static void async_get_intf(struct work_struct *data);
327 static void async_put_intf(struct work_struct *data);
328 static int hso_put_activity(struct hso_device *hso_dev);
329 static int hso_get_activity(struct hso_device *hso_dev);
330 static void tiocmget_intr_callback(struct urb *urb);
331 /*****************************************************************************/
332 /* Helping functions */
333 /*****************************************************************************/
337 static inline struct hso_net *dev2net(struct hso_device *hso_dev)
339 return hso_dev->port_data.dev_net;
342 static inline struct hso_serial *dev2ser(struct hso_device *hso_dev)
344 return hso_dev->port_data.dev_serial;
347 /* Debugging functions */
349 static void dbg_dump(int line_count, const char *func_name, unsigned char *buf,
352 static char name[255];
354 sprintf(name, "hso[%d:%s]", line_count, func_name);
355 print_hex_dump_bytes(name, DUMP_PREFIX_NONE, buf, len);
358 #define DUMP(buf_, len_) \
359 dbg_dump(__LINE__, __func__, (unsigned char *)buf_, len_)
361 #define DUMP1(buf_, len_) \
367 #define DUMP(buf_, len_)
368 #define DUMP1(buf_, len_)
371 /* module parameters */
373 static int tty_major;
374 static int disable_net;
377 static const char driver_name[] = "hso";
378 static const char tty_filename[] = "ttyHS";
379 static const char *version = __FILE__ ": " MOD_AUTHOR;
380 /* the usb driver itself (registered in hso_init) */
381 static struct usb_driver hso_driver;
382 /* serial structures */
383 static struct tty_driver *tty_drv;
384 static struct hso_device *serial_table[HSO_SERIAL_TTY_MINORS];
385 static struct hso_device *network_table[HSO_MAX_NET_DEVICES];
386 static spinlock_t serial_table_lock;
388 static const s32 default_port_spec[] = {
389 HSO_INTF_MUX | HSO_PORT_NETWORK,
390 HSO_INTF_BULK | HSO_PORT_DIAG,
391 HSO_INTF_BULK | HSO_PORT_MODEM,
395 static const s32 icon321_port_spec[] = {
396 HSO_INTF_MUX | HSO_PORT_NETWORK,
397 HSO_INTF_BULK | HSO_PORT_DIAG2,
398 HSO_INTF_BULK | HSO_PORT_MODEM,
399 HSO_INTF_BULK | HSO_PORT_DIAG,
403 #define default_port_device(vendor, product) \
404 USB_DEVICE(vendor, product), \
405 .driver_info = (kernel_ulong_t)default_port_spec
407 #define icon321_port_device(vendor, product) \
408 USB_DEVICE(vendor, product), \
409 .driver_info = (kernel_ulong_t)icon321_port_spec
411 /* list of devices we support */
412 static const struct usb_device_id hso_ids[] = {
413 {default_port_device(0x0af0, 0x6711)},
414 {default_port_device(0x0af0, 0x6731)},
415 {default_port_device(0x0af0, 0x6751)},
416 {default_port_device(0x0af0, 0x6771)},
417 {default_port_device(0x0af0, 0x6791)},
418 {default_port_device(0x0af0, 0x6811)},
419 {default_port_device(0x0af0, 0x6911)},
420 {default_port_device(0x0af0, 0x6951)},
421 {default_port_device(0x0af0, 0x6971)},
422 {default_port_device(0x0af0, 0x7011)},
423 {default_port_device(0x0af0, 0x7031)},
424 {default_port_device(0x0af0, 0x7051)},
425 {default_port_device(0x0af0, 0x7071)},
426 {default_port_device(0x0af0, 0x7111)},
427 {default_port_device(0x0af0, 0x7211)},
428 {default_port_device(0x0af0, 0x7251)},
429 {default_port_device(0x0af0, 0x7271)},
430 {default_port_device(0x0af0, 0x7311)},
431 {default_port_device(0x0af0, 0xc031)}, /* Icon-Edge */
432 {icon321_port_device(0x0af0, 0xd013)}, /* Module HSxPA */
433 {icon321_port_device(0x0af0, 0xd031)}, /* Icon-321 */
434 {icon321_port_device(0x0af0, 0xd033)}, /* Icon-322 */
435 {USB_DEVICE(0x0af0, 0x7301)}, /* GE40x */
436 {USB_DEVICE(0x0af0, 0x7361)}, /* GE40x */
437 {USB_DEVICE(0x0af0, 0x7381)}, /* GE40x */
438 {USB_DEVICE(0x0af0, 0x7401)}, /* GI 0401 */
439 {USB_DEVICE(0x0af0, 0x7501)}, /* GTM 382 */
440 {USB_DEVICE(0x0af0, 0x7601)}, /* GE40x */
441 {USB_DEVICE(0x0af0, 0x7701)},
442 {USB_DEVICE(0x0af0, 0x7706)},
443 {USB_DEVICE(0x0af0, 0x7801)},
444 {USB_DEVICE(0x0af0, 0x7901)},
445 {USB_DEVICE(0x0af0, 0x7A01)},
446 {USB_DEVICE(0x0af0, 0x7A05)},
447 {USB_DEVICE(0x0af0, 0x8200)},
448 {USB_DEVICE(0x0af0, 0x8201)},
449 {USB_DEVICE(0x0af0, 0x8300)},
450 {USB_DEVICE(0x0af0, 0x8302)},
451 {USB_DEVICE(0x0af0, 0x8304)},
452 {USB_DEVICE(0x0af0, 0x8400)},
453 {USB_DEVICE(0x0af0, 0x8600)},
454 {USB_DEVICE(0x0af0, 0x8800)},
455 {USB_DEVICE(0x0af0, 0x8900)},
456 {USB_DEVICE(0x0af0, 0x9000)},
457 {USB_DEVICE(0x0af0, 0x9200)}, /* Option GTM671WFS */
458 {USB_DEVICE(0x0af0, 0xd035)},
459 {USB_DEVICE(0x0af0, 0xd055)},
460 {USB_DEVICE(0x0af0, 0xd155)},
461 {USB_DEVICE(0x0af0, 0xd255)},
462 {USB_DEVICE(0x0af0, 0xd057)},
463 {USB_DEVICE(0x0af0, 0xd157)},
464 {USB_DEVICE(0x0af0, 0xd257)},
465 {USB_DEVICE(0x0af0, 0xd357)},
466 {USB_DEVICE(0x0af0, 0xd058)},
467 {USB_DEVICE(0x0af0, 0xc100)},
470 MODULE_DEVICE_TABLE(usb, hso_ids);
472 /* Sysfs attribute */
473 static ssize_t hso_sysfs_show_porttype(struct device *dev,
474 struct device_attribute *attr,
477 struct hso_device *hso_dev = dev_get_drvdata(dev);
483 switch (hso_dev->port_spec & HSO_PORT_MASK) {
484 case HSO_PORT_CONTROL:
485 port_name = "Control";
488 port_name = "Application";
491 port_name = "Application2";
496 case HSO_PORT_GPS_CONTROL:
497 port_name = "GPS Control";
503 port_name = "Diagnostic";
506 port_name = "Diagnostic2";
511 case HSO_PORT_NETWORK:
512 port_name = "Network";
515 port_name = "Unknown";
519 return sprintf(buf, "%s\n", port_name);
521 static DEVICE_ATTR(hsotype, S_IRUGO, hso_sysfs_show_porttype, NULL);
523 static struct attribute *hso_serial_dev_attrs[] = {
524 &dev_attr_hsotype.attr,
528 ATTRIBUTE_GROUPS(hso_serial_dev);
530 static int hso_urb_to_index(struct hso_serial *serial, struct urb *urb)
534 for (idx = 0; idx < serial->num_rx_urbs; idx++)
535 if (serial->rx_urb[idx] == urb)
537 dev_err(serial->parent->dev, "hso_urb_to_index failed\n");
541 /* converts mux value to a port spec value */
542 static u32 hso_mux_to_port(int mux)
548 result = HSO_PORT_CONTROL;
551 result = HSO_PORT_APP;
554 result = HSO_PORT_PCSC;
557 result = HSO_PORT_GPS;
560 result = HSO_PORT_APP2;
563 result = HSO_PORT_NO_PORT;
568 /* converts port spec value to a mux value */
569 static u32 hso_port_to_mux(int port)
573 switch (port & HSO_PORT_MASK) {
574 case HSO_PORT_CONTROL:
595 static struct hso_serial *get_serial_by_shared_int_and_type(
596 struct hso_shared_int *shared_int,
601 port = hso_mux_to_port(mux);
603 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
604 if (serial_table[i] &&
605 (dev2ser(serial_table[i])->shared_int == shared_int) &&
606 ((serial_table[i]->port_spec & HSO_PORT_MASK) == port)) {
607 return dev2ser(serial_table[i]);
614 static struct hso_serial *get_serial_by_index(unsigned index)
616 struct hso_serial *serial = NULL;
619 spin_lock_irqsave(&serial_table_lock, flags);
620 if (serial_table[index])
621 serial = dev2ser(serial_table[index]);
622 spin_unlock_irqrestore(&serial_table_lock, flags);
627 static int get_free_serial_index(void)
632 spin_lock_irqsave(&serial_table_lock, flags);
633 for (index = 0; index < HSO_SERIAL_TTY_MINORS; index++) {
634 if (serial_table[index] == NULL) {
635 spin_unlock_irqrestore(&serial_table_lock, flags);
639 spin_unlock_irqrestore(&serial_table_lock, flags);
641 printk(KERN_ERR "%s: no free serial devices in table\n", __func__);
645 static void set_serial_by_index(unsigned index, struct hso_serial *serial)
649 spin_lock_irqsave(&serial_table_lock, flags);
651 serial_table[index] = serial->parent;
653 serial_table[index] = NULL;
654 spin_unlock_irqrestore(&serial_table_lock, flags);
657 static void handle_usb_error(int status, const char *function,
658 struct hso_device *hso_dev)
664 explanation = "no device";
667 explanation = "endpoint not enabled";
670 explanation = "endpoint stalled";
673 explanation = "not enough bandwidth";
676 explanation = "device disabled";
679 explanation = "device suspended";
685 explanation = "internal error";
691 explanation = "protocol error";
693 usb_queue_reset_device(hso_dev->interface);
696 explanation = "unknown status";
700 /* log a meaningful explanation of an USB status */
701 hso_dbg(0x1, "%s: received USB status - %s (%d)\n",
702 function, explanation, status);
705 /* Network interface functions */
707 /* called when net interface is brought up by ifconfig */
708 static int hso_net_open(struct net_device *net)
710 struct hso_net *odev = netdev_priv(net);
711 unsigned long flags = 0;
714 dev_err(&net->dev, "No net device !\n");
718 odev->skb_tx_buf = NULL;
720 /* setup environment */
721 spin_lock_irqsave(&odev->net_lock, flags);
722 odev->rx_parse_state = WAIT_IP;
723 odev->rx_buf_size = 0;
724 odev->rx_buf_missing = sizeof(struct iphdr);
725 spin_unlock_irqrestore(&odev->net_lock, flags);
727 /* We are up and running. */
728 set_bit(HSO_NET_RUNNING, &odev->flags);
729 hso_start_net_device(odev->parent);
731 /* Tell the kernel we are ready to start receiving from it */
732 netif_start_queue(net);
737 /* called when interface is brought down by ifconfig */
738 static int hso_net_close(struct net_device *net)
740 struct hso_net *odev = netdev_priv(net);
742 /* we don't need the queue anymore */
743 netif_stop_queue(net);
744 /* no longer running */
745 clear_bit(HSO_NET_RUNNING, &odev->flags);
747 hso_stop_net_device(odev->parent);
753 /* USB tells is xmit done, we should start the netqueue again */
754 static void write_bulk_callback(struct urb *urb)
756 struct hso_net *odev = urb->context;
757 int status = urb->status;
760 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
761 dev_err(&urb->dev->dev, "%s: device not running\n", __func__);
765 /* Do we still have a valid kernel network device? */
766 if (!netif_device_present(odev->net)) {
767 dev_err(&urb->dev->dev, "%s: net device not present\n",
772 /* log status, but don't act on it, we don't need to resubmit anything
775 handle_usb_error(status, __func__, odev->parent);
777 hso_put_activity(odev->parent);
779 /* Tell the network interface we are ready for another frame */
780 netif_wake_queue(odev->net);
783 /* called by kernel when we need to transmit a packet */
784 static netdev_tx_t hso_net_start_xmit(struct sk_buff *skb,
785 struct net_device *net)
787 struct hso_net *odev = netdev_priv(net);
790 /* Tell the kernel, "No more frames 'til we are done with this one." */
791 netif_stop_queue(net);
792 if (hso_get_activity(odev->parent) == -EAGAIN) {
793 odev->skb_tx_buf = skb;
798 DUMP1(skb->data, skb->len);
799 /* Copy it from kernel memory to OUR memory */
800 memcpy(odev->mux_bulk_tx_buf, skb->data, skb->len);
801 hso_dbg(0x1, "len: %d/%d\n", skb->len, MUX_BULK_TX_BUF_SIZE);
803 /* Fill in the URB for shipping it out. */
804 usb_fill_bulk_urb(odev->mux_bulk_tx_urb,
806 usb_sndbulkpipe(odev->parent->usb,
808 bEndpointAddress & 0x7F),
809 odev->mux_bulk_tx_buf, skb->len, write_bulk_callback,
812 /* Deal with the Zero Length packet problem, I hope */
813 odev->mux_bulk_tx_urb->transfer_flags |= URB_ZERO_PACKET;
815 /* Send the URB on its merry way. */
816 result = usb_submit_urb(odev->mux_bulk_tx_urb, GFP_ATOMIC);
818 dev_warn(&odev->parent->interface->dev,
819 "failed mux_bulk_tx_urb %d\n", result);
820 net->stats.tx_errors++;
821 netif_start_queue(net);
823 net->stats.tx_packets++;
824 net->stats.tx_bytes += skb->len;
831 static const struct ethtool_ops ops = {
832 .get_link = ethtool_op_get_link
835 /* called when a packet did not ack after watchdogtimeout */
836 static void hso_net_tx_timeout(struct net_device *net)
838 struct hso_net *odev = netdev_priv(net);
843 /* Tell syslog we are hosed. */
844 dev_warn(&net->dev, "Tx timed out.\n");
846 /* Tear the waiting frame off the list */
847 if (odev->mux_bulk_tx_urb &&
848 (odev->mux_bulk_tx_urb->status == -EINPROGRESS))
849 usb_unlink_urb(odev->mux_bulk_tx_urb);
851 /* Update statistics */
852 net->stats.tx_errors++;
855 /* make a real packet from the received USB buffer */
856 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt,
857 unsigned int count, unsigned char is_eop)
859 unsigned short temp_bytes;
860 unsigned short buffer_offset = 0;
861 unsigned short frame_len;
862 unsigned char *tmp_rx_buf;
865 hso_dbg(0x1, "Rx %d bytes\n", count);
866 DUMP(ip_pkt, min(128, (int)count));
869 switch (odev->rx_parse_state) {
871 /* waiting for IP header. */
872 /* wanted bytes - size of ip header */
875 odev->rx_buf_missing) ? count : odev->
878 memcpy(((unsigned char *)(&odev->rx_ip_hdr)) +
879 odev->rx_buf_size, ip_pkt + buffer_offset,
882 odev->rx_buf_size += temp_bytes;
883 buffer_offset += temp_bytes;
884 odev->rx_buf_missing -= temp_bytes;
887 if (!odev->rx_buf_missing) {
888 /* header is complete allocate an sk_buffer and
889 * continue to WAIT_DATA */
890 frame_len = ntohs(odev->rx_ip_hdr.tot_len);
892 if ((frame_len > DEFAULT_MRU) ||
893 (frame_len < sizeof(struct iphdr))) {
894 dev_err(&odev->net->dev,
895 "Invalid frame (%d) length\n",
897 odev->rx_parse_state = WAIT_SYNC;
900 /* Allocate an sk_buff */
901 odev->skb_rx_buf = netdev_alloc_skb(odev->net,
903 if (!odev->skb_rx_buf) {
904 /* We got no receive buffer. */
905 hso_dbg(0x1, "could not allocate memory\n");
906 odev->rx_parse_state = WAIT_SYNC;
910 /* Copy what we got so far. make room for iphdr
913 skb_put(odev->skb_rx_buf,
914 sizeof(struct iphdr));
915 memcpy(tmp_rx_buf, (char *)&(odev->rx_ip_hdr),
916 sizeof(struct iphdr));
919 odev->rx_buf_size = sizeof(struct iphdr);
921 /* Filip actually use .tot_len */
922 odev->rx_buf_missing =
923 frame_len - sizeof(struct iphdr);
924 odev->rx_parse_state = WAIT_DATA;
929 temp_bytes = (count < odev->rx_buf_missing)
930 ? count : odev->rx_buf_missing;
932 /* Copy the rest of the bytes that are left in the
933 * buffer into the waiting sk_buf. */
934 /* Make room for temp_bytes after tail. */
935 tmp_rx_buf = skb_put(odev->skb_rx_buf, temp_bytes);
936 memcpy(tmp_rx_buf, ip_pkt + buffer_offset, temp_bytes);
938 odev->rx_buf_missing -= temp_bytes;
940 buffer_offset += temp_bytes;
941 odev->rx_buf_size += temp_bytes;
942 if (!odev->rx_buf_missing) {
943 /* Packet is complete. Inject into stack. */
944 /* We have IP packet here */
945 odev->skb_rx_buf->protocol = cpu_to_be16(ETH_P_IP);
946 skb_reset_mac_header(odev->skb_rx_buf);
948 /* Ship it off to the kernel */
949 netif_rx(odev->skb_rx_buf);
950 /* No longer our buffer. */
951 odev->skb_rx_buf = NULL;
953 /* update out statistics */
954 odev->net->stats.rx_packets++;
956 odev->net->stats.rx_bytes += odev->rx_buf_size;
958 odev->rx_buf_size = 0;
959 odev->rx_buf_missing = sizeof(struct iphdr);
960 odev->rx_parse_state = WAIT_IP;
965 hso_dbg(0x1, " W_S\n");
975 /* Recovery mechanism for WAIT_SYNC state. */
977 if (odev->rx_parse_state == WAIT_SYNC) {
978 odev->rx_parse_state = WAIT_IP;
979 odev->rx_buf_size = 0;
980 odev->rx_buf_missing = sizeof(struct iphdr);
985 static void fix_crc_bug(struct urb *urb, __le16 max_packet_size)
987 static const u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
988 u32 rest = urb->actual_length % le16_to_cpu(max_packet_size);
990 if (((rest == 5) || (rest == 6)) &&
991 !memcmp(((u8 *)urb->transfer_buffer) + urb->actual_length - 4,
993 urb->actual_length -= 4;
997 /* Moving data from usb to kernel (in interrupt state) */
998 static void read_bulk_callback(struct urb *urb)
1000 struct hso_net *odev = urb->context;
1001 struct net_device *net;
1003 int status = urb->status;
1005 /* is al ok? (Filip: Who's Al ?) */
1007 handle_usb_error(status, __func__, odev->parent);
1012 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
1013 hso_dbg(0x1, "BULK IN callback but driver is not active!\n");
1016 usb_mark_last_busy(urb->dev);
1020 if (!netif_device_present(net)) {
1021 /* Somebody killed our network interface... */
1025 if (odev->parent->port_spec & HSO_INFO_CRC_BUG)
1026 fix_crc_bug(urb, odev->in_endp->wMaxPacketSize);
1028 /* do we even have a packet? */
1029 if (urb->actual_length) {
1030 /* Handle the IP stream, add header and push it onto network
1031 * stack if the packet is complete. */
1032 spin_lock(&odev->net_lock);
1033 packetizeRx(odev, urb->transfer_buffer, urb->actual_length,
1034 (urb->transfer_buffer_length >
1035 urb->actual_length) ? 1 : 0);
1036 spin_unlock(&odev->net_lock);
1039 /* We are done with this URB, resubmit it. Prep the USB to wait for
1040 * another frame. Reuse same as received. */
1041 usb_fill_bulk_urb(urb,
1043 usb_rcvbulkpipe(odev->parent->usb,
1045 bEndpointAddress & 0x7F),
1046 urb->transfer_buffer, MUX_BULK_RX_BUF_SIZE,
1047 read_bulk_callback, odev);
1049 /* Give this to the USB subsystem so it can tell us when more data
1051 result = usb_submit_urb(urb, GFP_ATOMIC);
1053 dev_warn(&odev->parent->interface->dev,
1054 "%s failed submit mux_bulk_rx_urb %d\n", __func__,
1058 /* Serial driver functions */
1060 static void hso_init_termios(struct ktermios *termios)
1063 * The default requirements for this device are:
1066 ~(IGNBRK /* disable ignore break */
1067 | BRKINT /* disable break causes interrupt */
1068 | PARMRK /* disable mark parity errors */
1069 | ISTRIP /* disable clear high bit of input characters */
1070 | INLCR /* disable translate NL to CR */
1071 | IGNCR /* disable ignore CR */
1072 | ICRNL /* disable translate CR to NL */
1073 | IXON); /* disable enable XON/XOFF flow control */
1075 /* disable postprocess output characters */
1076 termios->c_oflag &= ~OPOST;
1079 ~(ECHO /* disable echo input characters */
1080 | ECHONL /* disable echo new line */
1081 | ICANON /* disable erase, kill, werase, and rprnt
1082 special characters */
1083 | ISIG /* disable interrupt, quit, and suspend special
1085 | IEXTEN); /* disable non-POSIX special characters */
1088 ~(CSIZE /* no size */
1089 | PARENB /* disable parity bit */
1090 | CBAUD /* clear current baud rate */
1091 | CBAUDEX); /* clear current buad rate */
1093 termios->c_cflag |= CS8; /* character size 8 bits */
1095 /* baud rate 115200 */
1096 tty_termios_encode_baud_rate(termios, 115200, 115200);
1099 static void _hso_serial_set_termios(struct tty_struct *tty,
1100 struct ktermios *old)
1102 struct hso_serial *serial = tty->driver_data;
1105 printk(KERN_ERR "%s: no tty structures", __func__);
1109 hso_dbg(0x8, "port %d\n", serial->minor);
1112 * Fix up unsupported bits
1114 tty->termios.c_iflag &= ~IXON; /* disable enable XON/XOFF flow control */
1116 tty->termios.c_cflag &=
1117 ~(CSIZE /* no size */
1118 | PARENB /* disable parity bit */
1119 | CBAUD /* clear current baud rate */
1120 | CBAUDEX); /* clear current buad rate */
1122 tty->termios.c_cflag |= CS8; /* character size 8 bits */
1124 /* baud rate 115200 */
1125 tty_encode_baud_rate(tty, 115200, 115200);
1128 static void hso_resubmit_rx_bulk_urb(struct hso_serial *serial, struct urb *urb)
1131 /* We are done with this URB, resubmit it. Prep the USB to wait for
1133 usb_fill_bulk_urb(urb, serial->parent->usb,
1134 usb_rcvbulkpipe(serial->parent->usb,
1136 bEndpointAddress & 0x7F),
1137 urb->transfer_buffer, serial->rx_data_length,
1138 hso_std_serial_read_bulk_callback, serial);
1139 /* Give this to the USB subsystem so it can tell us when more data
1141 result = usb_submit_urb(urb, GFP_ATOMIC);
1143 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1151 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1154 struct urb *curr_urb;
1156 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1157 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1158 count = put_rxbuf_data(curr_urb, serial);
1162 serial->curr_rx_urb_idx++;
1163 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1164 serial->curr_rx_urb_idx = 0;
1165 hso_resubmit_rx_bulk_urb(serial, curr_urb);
1170 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1175 urb = serial->rx_urb[0];
1176 if (serial->port.count > 0) {
1177 count = put_rxbuf_data(urb, serial);
1181 /* Re issue a read as long as we receive data. */
1183 if (count == 0 && ((urb->actual_length != 0) ||
1184 (serial->rx_state == RX_PENDING))) {
1185 serial->rx_state = RX_SENT;
1186 hso_mux_serial_read(serial);
1188 serial->rx_state = RX_IDLE;
1192 /* read callback for Diag and CS port */
1193 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1195 struct hso_serial *serial = urb->context;
1196 int status = urb->status;
1198 hso_dbg(0x8, "--- Got serial_read_bulk callback %02x ---\n", status);
1202 hso_dbg(0x1, "serial == NULL\n");
1206 handle_usb_error(status, __func__, serial->parent);
1210 hso_dbg(0x1, "Actual length = %d\n", urb->actual_length);
1211 DUMP1(urb->transfer_buffer, urb->actual_length);
1213 /* Anyone listening? */
1214 if (serial->port.count == 0)
1217 if (serial->parent->port_spec & HSO_INFO_CRC_BUG)
1218 fix_crc_bug(urb, serial->in_endp->wMaxPacketSize);
1219 /* Valid data, handle RX data */
1220 spin_lock(&serial->serial_lock);
1221 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1222 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1223 spin_unlock(&serial->serial_lock);
1227 * This needs to be a tasklet otherwise we will
1228 * end up recursively calling this function.
1230 static void hso_unthrottle_tasklet(struct hso_serial *serial)
1232 unsigned long flags;
1234 spin_lock_irqsave(&serial->serial_lock, flags);
1235 if ((serial->parent->port_spec & HSO_INTF_MUX))
1236 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1238 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1239 spin_unlock_irqrestore(&serial->serial_lock, flags);
1242 static void hso_unthrottle(struct tty_struct *tty)
1244 struct hso_serial *serial = tty->driver_data;
1246 tasklet_hi_schedule(&serial->unthrottle_tasklet);
1249 /* open the requested serial port */
1250 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1252 struct hso_serial *serial = get_serial_by_index(tty->index);
1256 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1258 tty->driver_data = NULL;
1259 hso_dbg(0x1, "Failed to open port\n");
1263 mutex_lock(&serial->parent->mutex);
1264 result = usb_autopm_get_interface(serial->parent->interface);
1268 hso_dbg(0x1, "Opening %d\n", serial->minor);
1271 tty->driver_data = serial;
1272 tty_port_tty_set(&serial->port, tty);
1274 /* check for port already opened, if not set the termios */
1275 serial->port.count++;
1276 if (serial->port.count == 1) {
1277 serial->rx_state = RX_IDLE;
1278 /* Force default termio settings */
1279 _hso_serial_set_termios(tty, NULL);
1280 tasklet_init(&serial->unthrottle_tasklet,
1281 (void (*)(unsigned long))hso_unthrottle_tasklet,
1282 (unsigned long)serial);
1283 result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1285 hso_stop_serial_device(serial->parent);
1286 serial->port.count--;
1288 kref_get(&serial->parent->ref);
1291 hso_dbg(0x1, "Port was already open\n");
1294 usb_autopm_put_interface(serial->parent->interface);
1298 hso_serial_tiocmset(tty, TIOCM_RTS | TIOCM_DTR, 0);
1300 mutex_unlock(&serial->parent->mutex);
1304 /* close the requested serial port */
1305 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1307 struct hso_serial *serial = tty->driver_data;
1310 hso_dbg(0x1, "Closing serial port\n");
1312 /* Open failed, no close cleanup required */
1316 mutex_lock(&serial->parent->mutex);
1317 usb_gone = serial->parent->usb_gone;
1320 usb_autopm_get_interface(serial->parent->interface);
1322 /* reset the rts and dtr */
1323 /* do the actual close */
1324 serial->port.count--;
1326 if (serial->port.count <= 0) {
1327 serial->port.count = 0;
1328 tty_port_tty_set(&serial->port, NULL);
1330 hso_stop_serial_device(serial->parent);
1331 tasklet_kill(&serial->unthrottle_tasklet);
1335 usb_autopm_put_interface(serial->parent->interface);
1337 mutex_unlock(&serial->parent->mutex);
1340 /* close the requested serial port */
1341 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1344 struct hso_serial *serial = tty->driver_data;
1345 int space, tx_bytes;
1346 unsigned long flags;
1349 if (serial == NULL) {
1350 printk(KERN_ERR "%s: serial is NULL\n", __func__);
1354 spin_lock_irqsave(&serial->serial_lock, flags);
1356 space = serial->tx_data_length - serial->tx_buffer_count;
1357 tx_bytes = (count < space) ? count : space;
1362 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1363 serial->tx_buffer_count += tx_bytes;
1366 spin_unlock_irqrestore(&serial->serial_lock, flags);
1368 hso_kick_transmit(serial);
1373 /* how much room is there for writing */
1374 static int hso_serial_write_room(struct tty_struct *tty)
1376 struct hso_serial *serial = tty->driver_data;
1378 unsigned long flags;
1380 spin_lock_irqsave(&serial->serial_lock, flags);
1381 room = serial->tx_data_length - serial->tx_buffer_count;
1382 spin_unlock_irqrestore(&serial->serial_lock, flags);
1384 /* return free room */
1388 static void hso_serial_cleanup(struct tty_struct *tty)
1390 struct hso_serial *serial = tty->driver_data;
1395 kref_put(&serial->parent->ref, hso_serial_ref_free);
1398 /* setup the term */
1399 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1401 struct hso_serial *serial = tty->driver_data;
1402 unsigned long flags;
1405 hso_dbg(0x16, "Termios called with: cflags new[%d] - old[%d]\n",
1406 tty->termios.c_cflag, old->c_cflag);
1408 /* the actual setup */
1409 spin_lock_irqsave(&serial->serial_lock, flags);
1410 if (serial->port.count)
1411 _hso_serial_set_termios(tty, old);
1413 tty->termios = *old;
1414 spin_unlock_irqrestore(&serial->serial_lock, flags);
1419 /* how many characters in the buffer */
1420 static int hso_serial_chars_in_buffer(struct tty_struct *tty)
1422 struct hso_serial *serial = tty->driver_data;
1424 unsigned long flags;
1430 spin_lock_irqsave(&serial->serial_lock, flags);
1431 chars = serial->tx_buffer_count;
1432 spin_unlock_irqrestore(&serial->serial_lock, flags);
1436 static int tiocmget_submit_urb(struct hso_serial *serial,
1437 struct hso_tiocmget *tiocmget,
1438 struct usb_device *usb)
1442 if (serial->parent->usb_gone)
1444 usb_fill_int_urb(tiocmget->urb, usb,
1447 bEndpointAddress & 0x7F),
1448 &tiocmget->serial_state_notification,
1449 sizeof(struct hso_serial_state_notification),
1450 tiocmget_intr_callback, serial,
1451 tiocmget->endp->bInterval);
1452 result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC);
1454 dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__,
1461 static void tiocmget_intr_callback(struct urb *urb)
1463 struct hso_serial *serial = urb->context;
1464 struct hso_tiocmget *tiocmget;
1465 int status = urb->status;
1466 u16 UART_state_bitmap, prev_UART_state_bitmap;
1467 struct uart_icount *icount;
1468 struct hso_serial_state_notification *serial_state_notification;
1469 struct usb_device *usb;
1470 struct usb_interface *interface;
1477 handle_usb_error(status, __func__, serial->parent);
1481 /* tiocmget is only supported on HSO_PORT_MODEM */
1482 tiocmget = serial->tiocmget;
1485 BUG_ON((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM);
1487 usb = serial->parent->usb;
1488 interface = serial->parent->interface;
1490 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
1492 /* wIndex should be the USB interface number of the port to which the
1493 * notification applies, which should always be the Modem port.
1495 serial_state_notification = &tiocmget->serial_state_notification;
1496 if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1497 serial_state_notification->bNotification != B_NOTIFICATION ||
1498 le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1499 le16_to_cpu(serial_state_notification->wIndex) != if_num ||
1500 le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1502 "hso received invalid serial state notification\n");
1503 DUMP(serial_state_notification,
1504 sizeof(struct hso_serial_state_notification));
1507 UART_state_bitmap = le16_to_cpu(serial_state_notification->
1509 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1510 icount = &tiocmget->icount;
1511 spin_lock(&serial->serial_lock);
1512 if ((UART_state_bitmap & B_OVERRUN) !=
1513 (prev_UART_state_bitmap & B_OVERRUN))
1515 if ((UART_state_bitmap & B_PARITY) !=
1516 (prev_UART_state_bitmap & B_PARITY))
1518 if ((UART_state_bitmap & B_FRAMING) !=
1519 (prev_UART_state_bitmap & B_FRAMING))
1521 if ((UART_state_bitmap & B_RING_SIGNAL) &&
1522 !(prev_UART_state_bitmap & B_RING_SIGNAL))
1524 if ((UART_state_bitmap & B_BREAK) !=
1525 (prev_UART_state_bitmap & B_BREAK))
1527 if ((UART_state_bitmap & B_TX_CARRIER) !=
1528 (prev_UART_state_bitmap & B_TX_CARRIER))
1530 if ((UART_state_bitmap & B_RX_CARRIER) !=
1531 (prev_UART_state_bitmap & B_RX_CARRIER))
1533 tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1534 spin_unlock(&serial->serial_lock);
1535 tiocmget->intr_completed = 1;
1536 wake_up_interruptible(&tiocmget->waitq);
1538 memset(serial_state_notification, 0,
1539 sizeof(struct hso_serial_state_notification));
1540 tiocmget_submit_urb(serial,
1542 serial->parent->usb);
1546 * next few functions largely stolen from drivers/serial/serial_core.c
1548 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1549 * - mask passed in arg for lines of interest
1550 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1551 * Caller should use TIOCGICOUNT to see which one it was
1554 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1556 DECLARE_WAITQUEUE(wait, current);
1557 struct uart_icount cprev, cnow;
1558 struct hso_tiocmget *tiocmget;
1561 tiocmget = serial->tiocmget;
1565 * note the counters on entry
1567 spin_lock_irq(&serial->serial_lock);
1568 memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1569 spin_unlock_irq(&serial->serial_lock);
1570 add_wait_queue(&tiocmget->waitq, &wait);
1572 spin_lock_irq(&serial->serial_lock);
1573 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1574 spin_unlock_irq(&serial->serial_lock);
1575 set_current_state(TASK_INTERRUPTIBLE);
1576 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1577 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1578 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd))) {
1583 /* see if a signal did it */
1584 if (signal_pending(current)) {
1590 __set_current_state(TASK_RUNNING);
1591 remove_wait_queue(&tiocmget->waitq, &wait);
1597 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1598 * Return: write counters to the user passed counter struct
1599 * NB: both 1->0 and 0->1 transitions are counted except for
1600 * RI where only 0->1 is counted.
1602 static int hso_get_count(struct tty_struct *tty,
1603 struct serial_icounter_struct *icount)
1605 struct uart_icount cnow;
1606 struct hso_serial *serial = tty->driver_data;
1607 struct hso_tiocmget *tiocmget = serial->tiocmget;
1609 memset(icount, 0, sizeof(struct serial_icounter_struct));
1613 spin_lock_irq(&serial->serial_lock);
1614 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1615 spin_unlock_irq(&serial->serial_lock);
1617 icount->cts = cnow.cts;
1618 icount->dsr = cnow.dsr;
1619 icount->rng = cnow.rng;
1620 icount->dcd = cnow.dcd;
1621 icount->rx = cnow.rx;
1622 icount->tx = cnow.tx;
1623 icount->frame = cnow.frame;
1624 icount->overrun = cnow.overrun;
1625 icount->parity = cnow.parity;
1626 icount->brk = cnow.brk;
1627 icount->buf_overrun = cnow.buf_overrun;
1633 static int hso_serial_tiocmget(struct tty_struct *tty)
1636 struct hso_serial *serial = tty->driver_data;
1637 struct hso_tiocmget *tiocmget;
1638 u16 UART_state_bitmap;
1642 hso_dbg(0x1, "no tty structures\n");
1645 spin_lock_irq(&serial->serial_lock);
1646 retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1647 ((serial->dtr_state) ? TIOCM_DTR : 0);
1648 tiocmget = serial->tiocmget;
1651 UART_state_bitmap = le16_to_cpu(
1652 tiocmget->prev_UART_state_bitmap);
1653 if (UART_state_bitmap & B_RING_SIGNAL)
1654 retval |= TIOCM_RNG;
1655 if (UART_state_bitmap & B_RX_CARRIER)
1657 if (UART_state_bitmap & B_TX_CARRIER)
1658 retval |= TIOCM_DSR;
1660 spin_unlock_irq(&serial->serial_lock);
1664 static int hso_serial_tiocmset(struct tty_struct *tty,
1665 unsigned int set, unsigned int clear)
1668 unsigned long flags;
1670 struct hso_serial *serial = tty->driver_data;
1671 struct usb_interface *interface;
1675 hso_dbg(0x1, "no tty structures\n");
1679 if ((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM)
1682 interface = serial->parent->interface;
1683 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
1685 spin_lock_irqsave(&serial->serial_lock, flags);
1686 if (set & TIOCM_RTS)
1687 serial->rts_state = 1;
1688 if (set & TIOCM_DTR)
1689 serial->dtr_state = 1;
1691 if (clear & TIOCM_RTS)
1692 serial->rts_state = 0;
1693 if (clear & TIOCM_DTR)
1694 serial->dtr_state = 0;
1696 if (serial->dtr_state)
1698 if (serial->rts_state)
1701 spin_unlock_irqrestore(&serial->serial_lock, flags);
1703 return usb_control_msg(serial->parent->usb,
1704 usb_rcvctrlpipe(serial->parent->usb, 0), 0x22,
1705 0x21, val, if_num, NULL, 0,
1706 USB_CTRL_SET_TIMEOUT);
1709 static int hso_serial_ioctl(struct tty_struct *tty,
1710 unsigned int cmd, unsigned long arg)
1712 struct hso_serial *serial = tty->driver_data;
1714 hso_dbg(0x8, "IOCTL cmd: %d, arg: %ld\n", cmd, arg);
1720 ret = hso_wait_modem_status(serial, arg);
1730 /* starts a transmit */
1731 static void hso_kick_transmit(struct hso_serial *serial)
1734 unsigned long flags;
1737 spin_lock_irqsave(&serial->serial_lock, flags);
1738 if (!serial->tx_buffer_count)
1741 if (serial->tx_urb_used)
1744 /* Wakeup USB interface if necessary */
1745 if (hso_get_activity(serial->parent) == -EAGAIN)
1748 /* Switch pointers around to avoid memcpy */
1749 temp = serial->tx_buffer;
1750 serial->tx_buffer = serial->tx_data;
1751 serial->tx_data = temp;
1752 serial->tx_data_count = serial->tx_buffer_count;
1753 serial->tx_buffer_count = 0;
1755 /* If temp is set, it means we switched buffers */
1756 if (temp && serial->write_data) {
1757 res = serial->write_data(serial);
1759 serial->tx_urb_used = 1;
1762 spin_unlock_irqrestore(&serial->serial_lock, flags);
1765 /* make a request (for reading and writing data to muxed serial port) */
1766 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1767 struct urb *ctrl_urb,
1768 struct usb_ctrlrequest *ctrl_req,
1769 u8 *ctrl_urb_data, u32 size)
1775 if (!serial || !ctrl_urb || !ctrl_req) {
1776 printk(KERN_ERR "%s: Wrong arguments\n", __func__);
1781 ctrl_req->wValue = 0;
1782 ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1783 ctrl_req->wLength = cpu_to_le16(size);
1785 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1786 /* Reading command */
1787 ctrl_req->bRequestType = USB_DIR_IN |
1788 USB_TYPE_OPTION_VENDOR |
1789 USB_RECIP_INTERFACE;
1790 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1791 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1793 /* Writing command */
1794 ctrl_req->bRequestType = USB_DIR_OUT |
1795 USB_TYPE_OPTION_VENDOR |
1796 USB_RECIP_INTERFACE;
1797 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1798 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1801 hso_dbg(0x2, "%s command (%02x) len: %d, port: %d\n",
1802 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1803 ctrl_req->bRequestType, ctrl_req->wLength, port);
1806 ctrl_urb->transfer_flags = 0;
1807 usb_fill_control_urb(ctrl_urb,
1808 serial->parent->usb,
1811 ctrl_urb_data, size, ctrl_callback, serial);
1812 /* Send it on merry way */
1813 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1815 dev_err(&ctrl_urb->dev->dev,
1816 "%s failed submit ctrl_urb %d type %d\n", __func__,
1825 /* called by intr_callback when read occurs */
1826 static int hso_mux_serial_read(struct hso_serial *serial)
1832 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1833 /* make the request */
1835 if (serial->num_rx_urbs != 1) {
1836 dev_err(&serial->parent->interface->dev,
1837 "ERROR: mux'd reads with multiple buffers "
1841 return mux_device_request(serial,
1842 USB_CDC_GET_ENCAPSULATED_RESPONSE,
1843 serial->parent->port_spec & HSO_PORT_MASK,
1845 &serial->ctrl_req_rx,
1846 serial->rx_data[0], serial->rx_data_length);
1849 /* used for muxed serial port callback (muxed serial read) */
1850 static void intr_callback(struct urb *urb)
1852 struct hso_shared_int *shared_int = urb->context;
1853 struct hso_serial *serial;
1854 unsigned char *port_req;
1855 int status = urb->status;
1858 usb_mark_last_busy(urb->dev);
1866 handle_usb_error(status, __func__, NULL);
1869 hso_dbg(0x8, "--- Got intr callback 0x%02X ---\n", status);
1872 port_req = urb->transfer_buffer;
1873 hso_dbg(0x8, "port_req = 0x%.2X\n", *port_req);
1874 /* loop over all muxed ports to find the one sending this */
1875 for (i = 0; i < 8; i++) {
1876 /* max 8 channels on MUX */
1877 if (*port_req & (1 << i)) {
1878 serial = get_serial_by_shared_int_and_type(shared_int,
1880 if (serial != NULL) {
1881 hso_dbg(0x1, "Pending read interrupt on port %d\n",
1883 spin_lock(&serial->serial_lock);
1884 if (serial->rx_state == RX_IDLE &&
1885 serial->port.count > 0) {
1886 /* Setup and send a ctrl req read on
1888 if (!serial->rx_urb_filled[0]) {
1889 serial->rx_state = RX_SENT;
1890 hso_mux_serial_read(serial);
1892 serial->rx_state = RX_PENDING;
1894 hso_dbg(0x1, "Already a read pending on port %d or port not open\n",
1897 spin_unlock(&serial->serial_lock);
1901 /* Resubmit interrupt urb */
1902 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1905 /* called for writing to muxed serial port */
1906 static int hso_mux_serial_write_data(struct hso_serial *serial)
1911 return mux_device_request(serial,
1912 USB_CDC_SEND_ENCAPSULATED_COMMAND,
1913 serial->parent->port_spec & HSO_PORT_MASK,
1915 &serial->ctrl_req_tx,
1916 serial->tx_data, serial->tx_data_count);
1919 /* write callback for Diag and CS port */
1920 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1922 struct hso_serial *serial = urb->context;
1923 int status = urb->status;
1927 hso_dbg(0x1, "serial == NULL\n");
1931 spin_lock(&serial->serial_lock);
1932 serial->tx_urb_used = 0;
1933 spin_unlock(&serial->serial_lock);
1935 handle_usb_error(status, __func__, serial->parent);
1938 hso_put_activity(serial->parent);
1939 tty_port_tty_wakeup(&serial->port);
1940 hso_kick_transmit(serial);
1945 /* called for writing diag or CS serial port */
1946 static int hso_std_serial_write_data(struct hso_serial *serial)
1948 int count = serial->tx_data_count;
1951 usb_fill_bulk_urb(serial->tx_urb,
1952 serial->parent->usb,
1953 usb_sndbulkpipe(serial->parent->usb,
1955 bEndpointAddress & 0x7F),
1956 serial->tx_data, serial->tx_data_count,
1957 hso_std_serial_write_bulk_callback, serial);
1959 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
1961 dev_warn(&serial->parent->usb->dev,
1962 "Failed to submit urb - res %d\n", result);
1969 /* callback after read or write on muxed serial port */
1970 static void ctrl_callback(struct urb *urb)
1972 struct hso_serial *serial = urb->context;
1973 struct usb_ctrlrequest *req;
1974 int status = urb->status;
1980 spin_lock(&serial->serial_lock);
1981 serial->tx_urb_used = 0;
1982 spin_unlock(&serial->serial_lock);
1984 handle_usb_error(status, __func__, serial->parent);
1989 req = (struct usb_ctrlrequest *)(urb->setup_packet);
1990 hso_dbg(0x8, "--- Got muxed ctrl callback 0x%02X ---\n", status);
1991 hso_dbg(0x8, "Actual length of urb = %d\n", urb->actual_length);
1992 DUMP1(urb->transfer_buffer, urb->actual_length);
1994 if (req->bRequestType ==
1995 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
1996 /* response to a read command */
1997 serial->rx_urb_filled[0] = 1;
1998 spin_lock(&serial->serial_lock);
1999 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
2000 spin_unlock(&serial->serial_lock);
2002 hso_put_activity(serial->parent);
2003 tty_port_tty_wakeup(&serial->port);
2004 /* response to a write command */
2005 hso_kick_transmit(serial);
2009 /* handle RX data for serial port */
2010 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
2012 struct tty_struct *tty;
2016 if (urb == NULL || serial == NULL) {
2017 hso_dbg(0x1, "serial = NULL\n");
2021 tty = tty_port_tty_get(&serial->port);
2023 if (tty && tty_throttled(tty)) {
2028 /* Push data to tty */
2029 hso_dbg(0x1, "data to push to tty\n");
2030 count = tty_buffer_request_room(&serial->port, urb->actual_length);
2031 if (count >= urb->actual_length) {
2032 tty_insert_flip_string(&serial->port, urb->transfer_buffer,
2033 urb->actual_length);
2034 tty_flip_buffer_push(&serial->port);
2036 dev_warn(&serial->parent->usb->dev,
2037 "dropping data, %d bytes lost\n", urb->actual_length);
2042 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2048 /* Base driver functions */
2050 static void hso_log_port(struct hso_device *hso_dev)
2055 switch (hso_dev->port_spec & HSO_PORT_MASK) {
2056 case HSO_PORT_CONTROL:
2057 port_type = "Control";
2060 port_type = "Application";
2065 case HSO_PORT_GPS_CONTROL:
2066 port_type = "GPS control";
2069 port_type = "Application2";
2075 port_type = "Diagnostic";
2077 case HSO_PORT_DIAG2:
2078 port_type = "Diagnostic2";
2080 case HSO_PORT_MODEM:
2081 port_type = "Modem";
2083 case HSO_PORT_NETWORK:
2084 port_type = "Network";
2087 port_type = "Unknown";
2090 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2091 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2093 sprintf(port_dev, "/dev/%s%d", tty_filename,
2094 dev2ser(hso_dev)->minor);
2096 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2097 port_type, port_dev);
2100 static int hso_start_net_device(struct hso_device *hso_dev)
2103 struct hso_net *hso_net = dev2net(hso_dev);
2108 /* send URBs for all read buffers */
2109 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2111 /* Prep a receive URB */
2112 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2114 usb_rcvbulkpipe(hso_dev->usb,
2116 bEndpointAddress & 0x7F),
2117 hso_net->mux_bulk_rx_buf_pool[i],
2118 MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2121 /* Put it out there so the device can send us stuff */
2122 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2125 dev_warn(&hso_dev->usb->dev,
2126 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2133 static int hso_stop_net_device(struct hso_device *hso_dev)
2136 struct hso_net *hso_net = dev2net(hso_dev);
2141 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2142 if (hso_net->mux_bulk_rx_urb_pool[i])
2143 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2146 if (hso_net->mux_bulk_tx_urb)
2147 usb_kill_urb(hso_net->mux_bulk_tx_urb);
2152 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2155 struct hso_serial *serial = dev2ser(hso_dev);
2160 /* If it is not the MUX port fill in and submit a bulk urb (already
2161 * allocated in hso_serial_start) */
2162 if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2163 for (i = 0; i < serial->num_rx_urbs; i++) {
2164 usb_fill_bulk_urb(serial->rx_urb[i],
2165 serial->parent->usb,
2166 usb_rcvbulkpipe(serial->parent->usb,
2171 serial->rx_data_length,
2172 hso_std_serial_read_bulk_callback,
2174 result = usb_submit_urb(serial->rx_urb[i], flags);
2176 dev_warn(&serial->parent->usb->dev,
2177 "Failed to submit urb - res %d\n",
2183 mutex_lock(&serial->shared_int->shared_int_lock);
2184 if (!serial->shared_int->use_count) {
2186 hso_mux_submit_intr_urb(serial->shared_int,
2187 hso_dev->usb, flags);
2189 serial->shared_int->use_count++;
2190 mutex_unlock(&serial->shared_int->shared_int_lock);
2192 if (serial->tiocmget)
2193 tiocmget_submit_urb(serial,
2195 serial->parent->usb);
2199 static int hso_stop_serial_device(struct hso_device *hso_dev)
2202 struct hso_serial *serial = dev2ser(hso_dev);
2203 struct hso_tiocmget *tiocmget;
2208 for (i = 0; i < serial->num_rx_urbs; i++) {
2209 if (serial->rx_urb[i]) {
2210 usb_kill_urb(serial->rx_urb[i]);
2211 serial->rx_urb_filled[i] = 0;
2214 serial->curr_rx_urb_idx = 0;
2217 usb_kill_urb(serial->tx_urb);
2219 if (serial->shared_int) {
2220 mutex_lock(&serial->shared_int->shared_int_lock);
2221 if (serial->shared_int->use_count &&
2222 (--serial->shared_int->use_count == 0)) {
2225 urb = serial->shared_int->shared_intr_urb;
2229 mutex_unlock(&serial->shared_int->shared_int_lock);
2231 tiocmget = serial->tiocmget;
2233 wake_up_interruptible(&tiocmget->waitq);
2234 usb_kill_urb(tiocmget->urb);
2240 static void hso_serial_tty_unregister(struct hso_serial *serial)
2242 tty_unregister_device(tty_drv, serial->minor);
2245 static void hso_serial_common_free(struct hso_serial *serial)
2249 for (i = 0; i < serial->num_rx_urbs; i++) {
2250 /* unlink and free RX URB */
2251 usb_free_urb(serial->rx_urb[i]);
2252 /* free the RX buffer */
2253 kfree(serial->rx_data[i]);
2256 /* unlink and free TX URB */
2257 usb_free_urb(serial->tx_urb);
2258 kfree(serial->tx_buffer);
2259 kfree(serial->tx_data);
2260 tty_port_destroy(&serial->port);
2263 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
2264 int rx_size, int tx_size)
2270 tty_port_init(&serial->port);
2272 minor = get_free_serial_index();
2276 /* register our minor number */
2277 serial->parent->dev = tty_port_register_device_attr(&serial->port,
2278 tty_drv, minor, &serial->parent->interface->dev,
2279 serial->parent, hso_serial_dev_groups);
2280 dev = serial->parent->dev;
2282 /* fill in specific data for later use */
2283 serial->minor = minor;
2284 serial->magic = HSO_SERIAL_MAGIC;
2285 spin_lock_init(&serial->serial_lock);
2286 serial->num_rx_urbs = num_urbs;
2288 /* RX, allocate urb and initialize */
2290 /* prepare our RX buffer */
2291 serial->rx_data_length = rx_size;
2292 for (i = 0; i < serial->num_rx_urbs; i++) {
2293 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2294 if (!serial->rx_urb[i])
2296 serial->rx_urb[i]->transfer_buffer = NULL;
2297 serial->rx_urb[i]->transfer_buffer_length = 0;
2298 serial->rx_data[i] = kzalloc(serial->rx_data_length,
2300 if (!serial->rx_data[i])
2304 /* TX, allocate urb and initialize */
2305 serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2306 if (!serial->tx_urb)
2308 serial->tx_urb->transfer_buffer = NULL;
2309 serial->tx_urb->transfer_buffer_length = 0;
2310 /* prepare our TX buffer */
2311 serial->tx_data_count = 0;
2312 serial->tx_buffer_count = 0;
2313 serial->tx_data_length = tx_size;
2314 serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2315 if (!serial->tx_data)
2318 serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2319 if (!serial->tx_buffer)
2324 hso_serial_tty_unregister(serial);
2325 hso_serial_common_free(serial);
2329 /* Creates a general hso device */
2330 static struct hso_device *hso_create_device(struct usb_interface *intf,
2333 struct hso_device *hso_dev;
2335 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2339 hso_dev->port_spec = port_spec;
2340 hso_dev->usb = interface_to_usbdev(intf);
2341 hso_dev->interface = intf;
2342 kref_init(&hso_dev->ref);
2343 mutex_init(&hso_dev->mutex);
2345 INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2346 INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2351 /* Removes a network device in the network device table */
2352 static int remove_net_device(struct hso_device *hso_dev)
2356 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2357 if (network_table[i] == hso_dev) {
2358 network_table[i] = NULL;
2362 if (i == HSO_MAX_NET_DEVICES)
2367 /* Frees our network device */
2368 static void hso_free_net_device(struct hso_device *hso_dev)
2371 struct hso_net *hso_net = dev2net(hso_dev);
2376 remove_net_device(hso_net->parent);
2379 unregister_netdev(hso_net->net);
2382 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2383 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2384 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2385 hso_net->mux_bulk_rx_buf_pool[i] = NULL;
2387 usb_free_urb(hso_net->mux_bulk_tx_urb);
2388 kfree(hso_net->mux_bulk_tx_buf);
2389 hso_net->mux_bulk_tx_buf = NULL;
2392 free_netdev(hso_net->net);
2397 static const struct net_device_ops hso_netdev_ops = {
2398 .ndo_open = hso_net_open,
2399 .ndo_stop = hso_net_close,
2400 .ndo_start_xmit = hso_net_start_xmit,
2401 .ndo_tx_timeout = hso_net_tx_timeout,
2404 /* initialize the network interface */
2405 static void hso_net_init(struct net_device *net)
2407 struct hso_net *hso_net = netdev_priv(net);
2409 hso_dbg(0x1, "sizeof hso_net is %zu\n", sizeof(*hso_net));
2411 /* fill in the other fields */
2412 net->netdev_ops = &hso_netdev_ops;
2413 net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2414 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2415 net->type = ARPHRD_NONE;
2416 net->mtu = DEFAULT_MTU - 14;
2417 net->tx_queue_len = 10;
2418 net->ethtool_ops = &ops;
2420 /* and initialize the semaphore */
2421 spin_lock_init(&hso_net->net_lock);
2424 /* Adds a network device in the network device table */
2425 static int add_net_device(struct hso_device *hso_dev)
2429 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2430 if (network_table[i] == NULL) {
2431 network_table[i] = hso_dev;
2435 if (i == HSO_MAX_NET_DEVICES)
2440 static int hso_rfkill_set_block(void *data, bool blocked)
2442 struct hso_device *hso_dev = data;
2443 int enabled = !blocked;
2446 mutex_lock(&hso_dev->mutex);
2447 if (hso_dev->usb_gone)
2450 rv = usb_control_msg(hso_dev->usb, usb_rcvctrlpipe(hso_dev->usb, 0),
2451 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2452 USB_CTRL_SET_TIMEOUT);
2453 mutex_unlock(&hso_dev->mutex);
2457 static const struct rfkill_ops hso_rfkill_ops = {
2458 .set_block = hso_rfkill_set_block,
2461 /* Creates and sets up everything for rfkill */
2462 static void hso_create_rfkill(struct hso_device *hso_dev,
2463 struct usb_interface *interface)
2465 struct hso_net *hso_net = dev2net(hso_dev);
2466 struct device *dev = &hso_net->net->dev;
2467 static u32 rfkill_counter;
2469 snprintf(hso_net->name, sizeof(hso_net->name), "hso-%d",
2472 hso_net->rfkill = rfkill_alloc(hso_net->name,
2473 &interface_to_usbdev(interface)->dev,
2475 &hso_rfkill_ops, hso_dev);
2476 if (!hso_net->rfkill) {
2477 dev_err(dev, "%s - Out of memory\n", __func__);
2480 if (rfkill_register(hso_net->rfkill) < 0) {
2481 rfkill_destroy(hso_net->rfkill);
2482 hso_net->rfkill = NULL;
2483 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2488 static struct device_type hso_type = {
2492 /* Creates our network device */
2493 static struct hso_device *hso_create_net_device(struct usb_interface *interface,
2497 struct net_device *net;
2498 struct hso_net *hso_net;
2499 struct hso_device *hso_dev;
2501 hso_dev = hso_create_device(interface, port_spec);
2505 /* allocate our network device, then we can put in our private data */
2506 /* call hso_net_init to do the basic initialization */
2507 net = alloc_netdev(sizeof(struct hso_net), "hso%d", NET_NAME_UNKNOWN,
2510 dev_err(&interface->dev, "Unable to create ethernet device\n");
2514 hso_net = netdev_priv(net);
2516 hso_dev->port_data.dev_net = hso_net;
2518 hso_net->parent = hso_dev;
2520 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2522 if (!hso_net->in_endp) {
2523 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2526 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2528 if (!hso_net->out_endp) {
2529 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2532 SET_NETDEV_DEV(net, &interface->dev);
2533 SET_NETDEV_DEVTYPE(net, &hso_type);
2535 /* registering our net device */
2536 result = register_netdev(net);
2538 dev_err(&interface->dev, "Failed to register device\n");
2542 /* start allocating */
2543 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2544 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2545 if (!hso_net->mux_bulk_rx_urb_pool[i])
2547 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2549 if (!hso_net->mux_bulk_rx_buf_pool[i])
2552 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2553 if (!hso_net->mux_bulk_tx_urb)
2555 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2556 if (!hso_net->mux_bulk_tx_buf)
2559 add_net_device(hso_dev);
2561 hso_log_port(hso_dev);
2563 hso_create_rfkill(hso_dev, interface);
2567 hso_free_net_device(hso_dev);
2571 static void hso_free_tiomget(struct hso_serial *serial)
2573 struct hso_tiocmget *tiocmget;
2576 tiocmget = serial->tiocmget;
2578 usb_free_urb(tiocmget->urb);
2579 tiocmget->urb = NULL;
2580 serial->tiocmget = NULL;
2585 /* Frees an AT channel ( goes for both mux and non-mux ) */
2586 static void hso_free_serial_device(struct hso_device *hso_dev)
2588 struct hso_serial *serial = dev2ser(hso_dev);
2593 hso_serial_common_free(serial);
2595 if (serial->shared_int) {
2596 mutex_lock(&serial->shared_int->shared_int_lock);
2597 if (--serial->shared_int->ref_count == 0)
2598 hso_free_shared_int(serial->shared_int);
2600 mutex_unlock(&serial->shared_int->shared_int_lock);
2602 hso_free_tiomget(serial);
2607 /* Creates a bulk AT channel */
2608 static struct hso_device *hso_create_bulk_serial_device(
2609 struct usb_interface *interface, int port)
2611 struct hso_device *hso_dev;
2612 struct hso_serial *serial;
2614 struct hso_tiocmget *tiocmget;
2616 hso_dev = hso_create_device(interface, port);
2620 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2624 serial->parent = hso_dev;
2625 hso_dev->port_data.dev_serial = serial;
2627 if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2629 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2631 /* it isn't going to break our heart if serial->tiocmget
2632 * allocation fails don't bother checking this.
2634 if (serial->tiocmget) {
2635 tiocmget = serial->tiocmget;
2636 tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2637 if (tiocmget->urb) {
2638 mutex_init(&tiocmget->mutex);
2639 init_waitqueue_head(&tiocmget->waitq);
2640 tiocmget->endp = hso_get_ep(
2642 USB_ENDPOINT_XFER_INT,
2645 hso_free_tiomget(serial);
2651 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2655 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2657 if (!serial->in_endp) {
2658 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2664 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2665 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2669 serial->write_data = hso_std_serial_write_data;
2671 /* and record this serial */
2672 set_serial_by_index(serial->minor, serial);
2674 /* setup the proc dirs and files if needed */
2675 hso_log_port(hso_dev);
2677 /* done, return it */
2681 hso_serial_tty_unregister(serial);
2682 hso_serial_common_free(serial);
2684 hso_free_tiomget(serial);
2690 /* Creates a multiplexed AT channel */
2692 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2694 struct hso_shared_int *mux)
2696 struct hso_device *hso_dev;
2697 struct hso_serial *serial;
2700 port_spec = HSO_INTF_MUX;
2701 port_spec &= ~HSO_PORT_MASK;
2703 port_spec |= hso_mux_to_port(port);
2704 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2707 hso_dev = hso_create_device(interface, port_spec);
2711 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2715 hso_dev->port_data.dev_serial = serial;
2716 serial->parent = hso_dev;
2718 if (hso_serial_common_create
2719 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2722 serial->tx_data_length--;
2723 serial->write_data = hso_mux_serial_write_data;
2725 serial->shared_int = mux;
2726 mutex_lock(&serial->shared_int->shared_int_lock);
2727 serial->shared_int->ref_count++;
2728 mutex_unlock(&serial->shared_int->shared_int_lock);
2730 /* and record this serial */
2731 set_serial_by_index(serial->minor, serial);
2733 /* setup the proc dirs and files if needed */
2734 hso_log_port(hso_dev);
2736 /* done, return it */
2741 tty_unregister_device(tty_drv, serial->minor);
2749 static void hso_free_shared_int(struct hso_shared_int *mux)
2751 usb_free_urb(mux->shared_intr_urb);
2752 kfree(mux->shared_intr_buf);
2753 mutex_unlock(&mux->shared_int_lock);
2758 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2760 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2765 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2767 if (!mux->intr_endp) {
2768 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2772 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2773 if (!mux->shared_intr_urb)
2775 mux->shared_intr_buf =
2776 kzalloc(le16_to_cpu(mux->intr_endp->wMaxPacketSize),
2778 if (!mux->shared_intr_buf)
2781 mutex_init(&mux->shared_int_lock);
2786 kfree(mux->shared_intr_buf);
2787 usb_free_urb(mux->shared_intr_urb);
2792 /* Gets the port spec for a certain interface */
2793 static int hso_get_config_data(struct usb_interface *interface)
2795 struct usb_device *usbdev = interface_to_usbdev(interface);
2796 u8 *config_data = kmalloc(17, GFP_KERNEL);
2797 u32 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
2802 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2803 0x86, 0xC0, 0, 0, config_data, 17,
2804 USB_CTRL_SET_TIMEOUT) != 0x11) {
2809 switch (config_data[if_num]) {
2814 result = HSO_PORT_DIAG;
2817 result = HSO_PORT_GPS;
2820 result = HSO_PORT_GPS_CONTROL;
2823 result = HSO_PORT_APP;
2826 result = HSO_PORT_APP2;
2829 result = HSO_PORT_CONTROL;
2832 result = HSO_PORT_NETWORK;
2835 result = HSO_PORT_MODEM;
2838 result = HSO_PORT_MSD;
2841 result = HSO_PORT_PCSC;
2844 result = HSO_PORT_VOICE;
2851 result |= HSO_INTF_BULK;
2853 if (config_data[16] & 0x1)
2854 result |= HSO_INFO_CRC_BUG;
2860 /* called once for each interface upon device insertion */
2861 static int hso_probe(struct usb_interface *interface,
2862 const struct usb_device_id *id)
2864 int mux, i, if_num, port_spec;
2865 unsigned char port_mask;
2866 struct hso_device *hso_dev = NULL;
2867 struct hso_shared_int *shared_int;
2868 struct hso_device *tmp_dev = NULL;
2870 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2871 dev_err(&interface->dev, "Not our interface\n");
2875 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
2877 /* Get the interface/port specification from either driver_info or from
2878 * the device itself */
2879 if (id->driver_info)
2880 port_spec = ((u32 *)(id->driver_info))[if_num];
2882 port_spec = hso_get_config_data(interface);
2884 /* Check if we need to switch to alt interfaces prior to port
2886 if (interface->num_altsetting > 1)
2887 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2888 interface->needs_remote_wakeup = 1;
2890 /* Allocate new hso device(s) */
2891 switch (port_spec & HSO_INTF_MASK) {
2893 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2894 /* Create the network device */
2896 hso_dev = hso_create_net_device(interface,
2904 if (hso_get_mux_ports(interface, &port_mask))
2905 /* TODO: de-allocate everything */
2908 shared_int = hso_create_shared_int(interface);
2912 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2913 if (port_mask & i) {
2914 hso_dev = hso_create_mux_serial_device(
2915 interface, i, shared_int);
2926 /* It's a regular bulk interface */
2927 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2930 hso_create_net_device(interface, port_spec);
2933 hso_create_bulk_serial_device(interface, port_spec);
2942 /* save our data pointer in this device */
2943 usb_set_intfdata(interface, hso_dev);
2948 hso_free_interface(interface);
2952 /* device removed, cleaning up */
2953 static void hso_disconnect(struct usb_interface *interface)
2955 hso_free_interface(interface);
2957 /* remove reference of our private data */
2958 usb_set_intfdata(interface, NULL);
2961 static void async_get_intf(struct work_struct *data)
2963 struct hso_device *hso_dev =
2964 container_of(data, struct hso_device, async_get_intf);
2965 usb_autopm_get_interface(hso_dev->interface);
2968 static void async_put_intf(struct work_struct *data)
2970 struct hso_device *hso_dev =
2971 container_of(data, struct hso_device, async_put_intf);
2972 usb_autopm_put_interface(hso_dev->interface);
2975 static int hso_get_activity(struct hso_device *hso_dev)
2977 if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
2978 if (!hso_dev->is_active) {
2979 hso_dev->is_active = 1;
2980 schedule_work(&hso_dev->async_get_intf);
2984 if (hso_dev->usb->state != USB_STATE_CONFIGURED)
2987 usb_mark_last_busy(hso_dev->usb);
2992 static int hso_put_activity(struct hso_device *hso_dev)
2994 if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
2995 if (hso_dev->is_active) {
2996 hso_dev->is_active = 0;
2997 schedule_work(&hso_dev->async_put_intf);
3001 hso_dev->is_active = 0;
3005 /* called by kernel when we need to suspend device */
3006 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3010 /* Stop all serial ports */
3011 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3012 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3013 result = hso_stop_serial_device(serial_table[i]);
3019 /* Stop all network ports */
3020 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3021 if (network_table[i] &&
3022 (network_table[i]->interface == iface)) {
3023 result = hso_stop_net_device(network_table[i]);
3033 /* called by kernel when we need to resume device */
3034 static int hso_resume(struct usb_interface *iface)
3037 struct hso_net *hso_net;
3039 /* Start all serial ports */
3040 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3041 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3042 if (dev2ser(serial_table[i])->port.count) {
3044 hso_start_serial_device(serial_table[i], GFP_NOIO);
3045 hso_kick_transmit(dev2ser(serial_table[i]));
3052 /* Start all network ports */
3053 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3054 if (network_table[i] &&
3055 (network_table[i]->interface == iface)) {
3056 hso_net = dev2net(network_table[i]);
3057 if (hso_net->flags & IFF_UP) {
3058 /* First transmit any lingering data,
3059 then restart the device. */
3060 if (hso_net->skb_tx_buf) {
3061 dev_dbg(&iface->dev,
3063 " lingering data\n");
3064 hso_net_start_xmit(hso_net->skb_tx_buf,
3066 hso_net->skb_tx_buf = NULL;
3068 result = hso_start_net_device(network_table[i]);
3079 static void hso_serial_ref_free(struct kref *ref)
3081 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3083 hso_free_serial_device(hso_dev);
3086 static void hso_free_interface(struct usb_interface *interface)
3088 struct hso_serial *serial;
3091 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3092 if (serial_table[i] &&
3093 (serial_table[i]->interface == interface)) {
3094 serial = dev2ser(serial_table[i]);
3095 tty_port_tty_hangup(&serial->port, false);
3096 mutex_lock(&serial->parent->mutex);
3097 serial->parent->usb_gone = 1;
3098 mutex_unlock(&serial->parent->mutex);
3099 cancel_work_sync(&serial_table[i]->async_put_intf);
3100 cancel_work_sync(&serial_table[i]->async_get_intf);
3101 hso_serial_tty_unregister(serial);
3102 kref_put(&serial_table[i]->ref, hso_serial_ref_free);
3103 set_serial_by_index(i, NULL);
3107 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3108 if (network_table[i] &&
3109 (network_table[i]->interface == interface)) {
3110 struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3111 /* hso_stop_net_device doesn't stop the net queue since
3112 * traffic needs to start it again when suspended */
3113 netif_stop_queue(dev2net(network_table[i])->net);
3114 hso_stop_net_device(network_table[i]);
3115 cancel_work_sync(&network_table[i]->async_put_intf);
3116 cancel_work_sync(&network_table[i]->async_get_intf);
3118 rfkill_unregister(rfk);
3119 rfkill_destroy(rfk);
3121 hso_free_net_device(network_table[i]);
3126 /* Helper functions */
3128 /* Get the endpoint ! */
3129 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3133 struct usb_host_interface *iface = intf->cur_altsetting;
3134 struct usb_endpoint_descriptor *endp;
3136 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3137 endp = &iface->endpoint[i].desc;
3138 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3139 (usb_endpoint_type(endp) == type))
3146 /* Get the byte that describes which ports are enabled */
3147 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3150 struct usb_host_interface *iface = intf->cur_altsetting;
3152 if (iface->extralen == 3) {
3153 *ports = iface->extra[2];
3157 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3158 if (iface->endpoint[i].extralen == 3) {
3159 *ports = iface->endpoint[i].extra[2];
3167 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3168 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3169 struct usb_device *usb, gfp_t gfp)
3173 usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3175 shared_int->intr_endp->bEndpointAddress & 0x7F),
3176 shared_int->shared_intr_buf,
3178 intr_callback, shared_int,
3179 shared_int->intr_endp->bInterval);
3181 result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3183 dev_warn(&usb->dev, "%s failed mux_intr_urb %d\n", __func__,
3189 /* operations setup of the serial interface */
3190 static const struct tty_operations hso_serial_ops = {
3191 .open = hso_serial_open,
3192 .close = hso_serial_close,
3193 .write = hso_serial_write,
3194 .write_room = hso_serial_write_room,
3195 .cleanup = hso_serial_cleanup,
3196 .ioctl = hso_serial_ioctl,
3197 .set_termios = hso_serial_set_termios,
3198 .chars_in_buffer = hso_serial_chars_in_buffer,
3199 .tiocmget = hso_serial_tiocmget,
3200 .tiocmset = hso_serial_tiocmset,
3201 .get_icount = hso_get_count,
3202 .unthrottle = hso_unthrottle
3205 static struct usb_driver hso_driver = {
3206 .name = driver_name,
3208 .disconnect = hso_disconnect,
3209 .id_table = hso_ids,
3210 .suspend = hso_suspend,
3211 .resume = hso_resume,
3212 .reset_resume = hso_resume,
3213 .supports_autosuspend = 1,
3214 .disable_hub_initiated_lpm = 1,
3217 static int __init hso_init(void)
3222 /* put it in the log */
3223 printk(KERN_INFO "hso: %s\n", version);
3225 /* Initialise the serial table semaphore and table */
3226 spin_lock_init(&serial_table_lock);
3227 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3228 serial_table[i] = NULL;
3230 /* allocate our driver using the proper amount of supported minors */
3231 tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
3235 /* fill in all needed values */
3236 tty_drv->driver_name = driver_name;
3237 tty_drv->name = tty_filename;
3239 /* if major number is provided as parameter, use that one */
3241 tty_drv->major = tty_major;
3243 tty_drv->minor_start = 0;
3244 tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3245 tty_drv->subtype = SERIAL_TYPE_NORMAL;
3246 tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
3247 tty_drv->init_termios = tty_std_termios;
3248 hso_init_termios(&tty_drv->init_termios);
3249 tty_set_operations(tty_drv, &hso_serial_ops);
3251 /* register the tty driver */
3252 result = tty_register_driver(tty_drv);
3254 printk(KERN_ERR "%s - tty_register_driver failed(%d)\n",
3259 /* register this module as an usb driver */
3260 result = usb_register(&hso_driver);
3262 printk(KERN_ERR "Could not register hso driver? error: %d\n",
3270 tty_unregister_driver(tty_drv);
3272 put_tty_driver(tty_drv);
3276 static void __exit hso_exit(void)
3278 printk(KERN_INFO "hso: unloaded\n");
3280 tty_unregister_driver(tty_drv);
3281 put_tty_driver(tty_drv);
3282 /* deregister the usb driver */
3283 usb_deregister(&hso_driver);
3286 /* Module definitions */
3287 module_init(hso_init);
3288 module_exit(hso_exit);
3290 MODULE_AUTHOR(MOD_AUTHOR);
3291 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3292 MODULE_LICENSE(MOD_LICENSE);
3294 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3295 MODULE_PARM_DESC(debug, "debug level mask [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3296 module_param(debug, int, S_IRUGO | S_IWUSR);
3298 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3299 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3300 module_param(tty_major, int, S_IRUGO | S_IWUSR);
3302 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3303 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3304 module_param(disable_net, int, S_IRUGO | S_IWUSR);