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 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
55 #include <linux/sched.h>
56 #include <linux/slab.h>
57 #include <linux/init.h>
58 #include <linux/delay.h>
59 #include <linux/netdevice.h>
60 #include <linux/module.h>
61 #include <linux/ethtool.h>
62 #include <linux/usb.h>
63 #include <linux/tty.h>
64 #include <linux/tty_driver.h>
65 #include <linux/tty_flip.h>
66 #include <linux/kmod.h>
67 #include <linux/rfkill.h>
69 #include <linux/uaccess.h>
70 #include <linux/usb/cdc.h>
72 #include <asm/byteorder.h>
73 #include <linux/serial_core.h>
74 #include <linux/serial.h>
77 #define MOD_AUTHOR "Option Wireless"
78 #define MOD_DESCRIPTION "USB High Speed Option driver"
79 #define MOD_LICENSE "GPL"
81 #define HSO_MAX_NET_DEVICES 10
82 #define HSO__MAX_MTU 2048
83 #define DEFAULT_MTU 1500
84 #define DEFAULT_MRU 1500
86 #define CTRL_URB_RX_SIZE 1024
87 #define CTRL_URB_TX_SIZE 64
89 #define BULK_URB_RX_SIZE 4096
90 #define BULK_URB_TX_SIZE 8192
92 #define MUX_BULK_RX_BUF_SIZE HSO__MAX_MTU
93 #define MUX_BULK_TX_BUF_SIZE HSO__MAX_MTU
94 #define MUX_BULK_RX_BUF_COUNT 4
95 #define USB_TYPE_OPTION_VENDOR 0x20
97 /* These definitions are used with the struct hso_net flags element */
98 /* - use *_bit operations on it. (bit indices not values.) */
99 #define HSO_NET_RUNNING 0
101 #define HSO_NET_TX_TIMEOUT (HZ*10)
103 #define HSO_SERIAL_MAGIC 0x48534f31
105 /* Number of ttys to handle */
106 #define HSO_SERIAL_TTY_MINORS 256
108 #define MAX_RX_URBS 2
110 /*****************************************************************************/
111 /* Debugging functions */
112 /*****************************************************************************/
113 #define hso_dbg(lvl, fmt, ...) \
116 pr_info("[%d:%s] " fmt, \
117 __LINE__, __func__, ##__VA_ARGS__); \
120 /*****************************************************************************/
122 /*****************************************************************************/
123 enum pkt_parse_state {
129 /*****************************************************************************/
131 /*****************************************************************************/
133 struct hso_shared_int {
134 struct usb_endpoint_descriptor *intr_endp;
135 void *shared_intr_buf;
136 struct urb *shared_intr_urb;
137 struct usb_device *usb;
140 struct mutex shared_int_lock;
144 struct hso_device *parent;
145 struct net_device *net;
146 struct rfkill *rfkill;
149 struct usb_endpoint_descriptor *in_endp;
150 struct usb_endpoint_descriptor *out_endp;
152 struct urb *mux_bulk_rx_urb_pool[MUX_BULK_RX_BUF_COUNT];
153 struct urb *mux_bulk_tx_urb;
154 void *mux_bulk_rx_buf_pool[MUX_BULK_RX_BUF_COUNT];
155 void *mux_bulk_tx_buf;
157 struct sk_buff *skb_rx_buf;
158 struct sk_buff *skb_tx_buf;
160 enum pkt_parse_state rx_parse_state;
163 unsigned short rx_buf_size;
164 unsigned short rx_buf_missing;
165 struct iphdr rx_ip_hdr;
176 #define BM_REQUEST_TYPE (0xa1)
177 #define B_NOTIFICATION (0x20)
178 #define W_VALUE (0x0)
179 #define W_LENGTH (0x2)
181 #define B_OVERRUN (0x1<<6)
182 #define B_PARITY (0x1<<5)
183 #define B_FRAMING (0x1<<4)
184 #define B_RING_SIGNAL (0x1<<3)
185 #define B_BREAK (0x1<<2)
186 #define B_TX_CARRIER (0x1<<1)
187 #define B_RX_CARRIER (0x1<<0)
189 struct hso_serial_state_notification {
195 u16 UART_state_bitmap;
198 struct hso_tiocmget {
200 wait_queue_head_t waitq;
202 struct usb_endpoint_descriptor *endp;
204 struct hso_serial_state_notification serial_state_notification;
205 u16 prev_UART_state_bitmap;
206 struct uart_icount icount;
211 struct hso_device *parent;
215 struct hso_shared_int *shared_int;
217 /* rx/tx urb could be either a bulk urb or a control urb depending
218 on which serial port it is used on. */
219 struct urb *rx_urb[MAX_RX_URBS];
221 u8 *rx_data[MAX_RX_URBS];
222 u16 rx_data_length; /* should contain allocated length */
227 u16 tx_data_length; /* should contain allocated length */
230 struct usb_ctrlrequest ctrl_req_tx;
231 struct usb_ctrlrequest ctrl_req_rx;
233 struct usb_endpoint_descriptor *in_endp;
234 struct usb_endpoint_descriptor *out_endp;
236 enum rx_ctrl_state rx_state;
239 unsigned tx_urb_used:1;
241 struct tty_port port;
242 /* from usb_serial_port */
243 spinlock_t serial_lock;
245 int (*write_data) (struct hso_serial *serial);
246 struct hso_tiocmget *tiocmget;
247 /* Hacks required to get flow control
248 * working on the serial receive buffers
249 * so as not to drop characters on the floor.
252 u8 rx_urb_filled[MAX_RX_URBS];
253 struct tasklet_struct unthrottle_tasklet;
258 struct hso_serial *dev_serial;
259 struct hso_net *dev_net;
266 struct work_struct async_get_intf;
267 struct work_struct async_put_intf;
269 struct usb_device *usb;
270 struct usb_interface *interface;
277 /* Type of interface */
278 #define HSO_INTF_MASK 0xFF00
279 #define HSO_INTF_MUX 0x0100
280 #define HSO_INTF_BULK 0x0200
283 #define HSO_PORT_MASK 0xFF
284 #define HSO_PORT_NO_PORT 0x0
285 #define HSO_PORT_CONTROL 0x1
286 #define HSO_PORT_APP 0x2
287 #define HSO_PORT_GPS 0x3
288 #define HSO_PORT_PCSC 0x4
289 #define HSO_PORT_APP2 0x5
290 #define HSO_PORT_GPS_CONTROL 0x6
291 #define HSO_PORT_MSD 0x7
292 #define HSO_PORT_VOICE 0x8
293 #define HSO_PORT_DIAG2 0x9
294 #define HSO_PORT_DIAG 0x10
295 #define HSO_PORT_MODEM 0x11
296 #define HSO_PORT_NETWORK 0x12
298 /* Additional device info */
299 #define HSO_INFO_MASK 0xFF000000
300 #define HSO_INFO_CRC_BUG 0x01000000
302 /*****************************************************************************/
304 /*****************************************************************************/
305 /* Serial driver functions */
306 static int hso_serial_tiocmset(struct tty_struct *tty,
307 unsigned int set, unsigned int clear);
308 static void ctrl_callback(struct urb *urb);
309 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial);
310 static void hso_kick_transmit(struct hso_serial *serial);
311 /* Helper functions */
312 static int hso_mux_submit_intr_urb(struct hso_shared_int *mux_int,
313 struct usb_device *usb, gfp_t gfp);
314 static void handle_usb_error(int status, const char *function,
315 struct hso_device *hso_dev);
316 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
318 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports);
319 static void hso_free_interface(struct usb_interface *intf);
320 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags);
321 static int hso_stop_serial_device(struct hso_device *hso_dev);
322 static int hso_start_net_device(struct hso_device *hso_dev);
323 static void hso_free_shared_int(struct hso_shared_int *shared_int);
324 static int hso_stop_net_device(struct hso_device *hso_dev);
325 static void hso_serial_ref_free(struct kref *ref);
326 static void hso_std_serial_read_bulk_callback(struct urb *urb);
327 static int hso_mux_serial_read(struct hso_serial *serial);
328 static void async_get_intf(struct work_struct *data);
329 static void async_put_intf(struct work_struct *data);
330 static int hso_put_activity(struct hso_device *hso_dev);
331 static int hso_get_activity(struct hso_device *hso_dev);
332 static void tiocmget_intr_callback(struct urb *urb);
333 /*****************************************************************************/
334 /* Helping functions */
335 /*****************************************************************************/
339 static inline struct hso_net *dev2net(struct hso_device *hso_dev)
341 return hso_dev->port_data.dev_net;
344 static inline struct hso_serial *dev2ser(struct hso_device *hso_dev)
346 return hso_dev->port_data.dev_serial;
349 /* Debugging functions */
351 static void dbg_dump(int line_count, const char *func_name, unsigned char *buf,
354 static char name[255];
356 sprintf(name, "hso[%d:%s]", line_count, func_name);
357 print_hex_dump_bytes(name, DUMP_PREFIX_NONE, buf, len);
360 #define DUMP(buf_, len_) \
361 dbg_dump(__LINE__, __func__, (unsigned char *)buf_, len_)
363 #define DUMP1(buf_, len_) \
369 #define DUMP(buf_, len_)
370 #define DUMP1(buf_, len_)
373 /* module parameters */
375 static int tty_major;
376 static int disable_net;
379 static const char driver_name[] = "hso";
380 static const char tty_filename[] = "ttyHS";
381 static const char *version = __FILE__ ": " MOD_AUTHOR;
382 /* the usb driver itself (registered in hso_init) */
383 static struct usb_driver hso_driver;
384 /* serial structures */
385 static struct tty_driver *tty_drv;
386 static struct hso_device *serial_table[HSO_SERIAL_TTY_MINORS];
387 static struct hso_device *network_table[HSO_MAX_NET_DEVICES];
388 static spinlock_t serial_table_lock;
390 static const s32 default_port_spec[] = {
391 HSO_INTF_MUX | HSO_PORT_NETWORK,
392 HSO_INTF_BULK | HSO_PORT_DIAG,
393 HSO_INTF_BULK | HSO_PORT_MODEM,
397 static const s32 icon321_port_spec[] = {
398 HSO_INTF_MUX | HSO_PORT_NETWORK,
399 HSO_INTF_BULK | HSO_PORT_DIAG2,
400 HSO_INTF_BULK | HSO_PORT_MODEM,
401 HSO_INTF_BULK | HSO_PORT_DIAG,
405 #define default_port_device(vendor, product) \
406 USB_DEVICE(vendor, product), \
407 .driver_info = (kernel_ulong_t)default_port_spec
409 #define icon321_port_device(vendor, product) \
410 USB_DEVICE(vendor, product), \
411 .driver_info = (kernel_ulong_t)icon321_port_spec
413 /* list of devices we support */
414 static const struct usb_device_id hso_ids[] = {
415 {default_port_device(0x0af0, 0x6711)},
416 {default_port_device(0x0af0, 0x6731)},
417 {default_port_device(0x0af0, 0x6751)},
418 {default_port_device(0x0af0, 0x6771)},
419 {default_port_device(0x0af0, 0x6791)},
420 {default_port_device(0x0af0, 0x6811)},
421 {default_port_device(0x0af0, 0x6911)},
422 {default_port_device(0x0af0, 0x6951)},
423 {default_port_device(0x0af0, 0x6971)},
424 {default_port_device(0x0af0, 0x7011)},
425 {default_port_device(0x0af0, 0x7031)},
426 {default_port_device(0x0af0, 0x7051)},
427 {default_port_device(0x0af0, 0x7071)},
428 {default_port_device(0x0af0, 0x7111)},
429 {default_port_device(0x0af0, 0x7211)},
430 {default_port_device(0x0af0, 0x7251)},
431 {default_port_device(0x0af0, 0x7271)},
432 {default_port_device(0x0af0, 0x7311)},
433 {default_port_device(0x0af0, 0xc031)}, /* Icon-Edge */
434 {icon321_port_device(0x0af0, 0xd013)}, /* Module HSxPA */
435 {icon321_port_device(0x0af0, 0xd031)}, /* Icon-321 */
436 {icon321_port_device(0x0af0, 0xd033)}, /* Icon-322 */
437 {USB_DEVICE(0x0af0, 0x7301)}, /* GE40x */
438 {USB_DEVICE(0x0af0, 0x7361)}, /* GE40x */
439 {USB_DEVICE(0x0af0, 0x7381)}, /* GE40x */
440 {USB_DEVICE(0x0af0, 0x7401)}, /* GI 0401 */
441 {USB_DEVICE(0x0af0, 0x7501)}, /* GTM 382 */
442 {USB_DEVICE(0x0af0, 0x7601)}, /* GE40x */
443 {USB_DEVICE(0x0af0, 0x7701)},
444 {USB_DEVICE(0x0af0, 0x7706)},
445 {USB_DEVICE(0x0af0, 0x7801)},
446 {USB_DEVICE(0x0af0, 0x7901)},
447 {USB_DEVICE(0x0af0, 0x7A01)},
448 {USB_DEVICE(0x0af0, 0x7A05)},
449 {USB_DEVICE(0x0af0, 0x8200)},
450 {USB_DEVICE(0x0af0, 0x8201)},
451 {USB_DEVICE(0x0af0, 0x8300)},
452 {USB_DEVICE(0x0af0, 0x8302)},
453 {USB_DEVICE(0x0af0, 0x8304)},
454 {USB_DEVICE(0x0af0, 0x8400)},
455 {USB_DEVICE(0x0af0, 0x8600)},
456 {USB_DEVICE(0x0af0, 0x8800)},
457 {USB_DEVICE(0x0af0, 0x8900)},
458 {USB_DEVICE(0x0af0, 0x9000)},
459 {USB_DEVICE(0x0af0, 0x9200)}, /* Option GTM671WFS */
460 {USB_DEVICE(0x0af0, 0xd035)},
461 {USB_DEVICE(0x0af0, 0xd055)},
462 {USB_DEVICE(0x0af0, 0xd155)},
463 {USB_DEVICE(0x0af0, 0xd255)},
464 {USB_DEVICE(0x0af0, 0xd057)},
465 {USB_DEVICE(0x0af0, 0xd157)},
466 {USB_DEVICE(0x0af0, 0xd257)},
467 {USB_DEVICE(0x0af0, 0xd357)},
468 {USB_DEVICE(0x0af0, 0xd058)},
469 {USB_DEVICE(0x0af0, 0xc100)},
472 MODULE_DEVICE_TABLE(usb, hso_ids);
474 /* Sysfs attribute */
475 static ssize_t hso_sysfs_show_porttype(struct device *dev,
476 struct device_attribute *attr,
479 struct hso_device *hso_dev = dev_get_drvdata(dev);
485 switch (hso_dev->port_spec & HSO_PORT_MASK) {
486 case HSO_PORT_CONTROL:
487 port_name = "Control";
490 port_name = "Application";
493 port_name = "Application2";
498 case HSO_PORT_GPS_CONTROL:
499 port_name = "GPS Control";
505 port_name = "Diagnostic";
508 port_name = "Diagnostic2";
513 case HSO_PORT_NETWORK:
514 port_name = "Network";
517 port_name = "Unknown";
521 return sprintf(buf, "%s\n", port_name);
523 static DEVICE_ATTR(hsotype, S_IRUGO, hso_sysfs_show_porttype, NULL);
525 static struct attribute *hso_serial_dev_attrs[] = {
526 &dev_attr_hsotype.attr,
530 ATTRIBUTE_GROUPS(hso_serial_dev);
532 static int hso_urb_to_index(struct hso_serial *serial, struct urb *urb)
536 for (idx = 0; idx < serial->num_rx_urbs; idx++)
537 if (serial->rx_urb[idx] == urb)
539 dev_err(serial->parent->dev, "hso_urb_to_index failed\n");
543 /* converts mux value to a port spec value */
544 static u32 hso_mux_to_port(int mux)
550 result = HSO_PORT_CONTROL;
553 result = HSO_PORT_APP;
556 result = HSO_PORT_PCSC;
559 result = HSO_PORT_GPS;
562 result = HSO_PORT_APP2;
565 result = HSO_PORT_NO_PORT;
570 /* converts port spec value to a mux value */
571 static u32 hso_port_to_mux(int port)
575 switch (port & HSO_PORT_MASK) {
576 case HSO_PORT_CONTROL:
597 static struct hso_serial *get_serial_by_shared_int_and_type(
598 struct hso_shared_int *shared_int,
603 port = hso_mux_to_port(mux);
605 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
606 if (serial_table[i] &&
607 (dev2ser(serial_table[i])->shared_int == shared_int) &&
608 ((serial_table[i]->port_spec & HSO_PORT_MASK) == port)) {
609 return dev2ser(serial_table[i]);
616 static struct hso_serial *get_serial_by_index(unsigned index)
618 struct hso_serial *serial = NULL;
621 spin_lock_irqsave(&serial_table_lock, flags);
622 if (serial_table[index])
623 serial = dev2ser(serial_table[index]);
624 spin_unlock_irqrestore(&serial_table_lock, flags);
629 static int obtain_minor(struct hso_serial *serial)
634 spin_lock_irqsave(&serial_table_lock, flags);
635 for (index = 0; index < HSO_SERIAL_TTY_MINORS; index++) {
636 if (serial_table[index] == NULL) {
637 serial_table[index] = serial->parent;
638 serial->minor = index;
639 spin_unlock_irqrestore(&serial_table_lock, flags);
643 spin_unlock_irqrestore(&serial_table_lock, flags);
645 pr_err("%s: no free serial devices in table\n", __func__);
649 static void release_minor(struct hso_serial *serial)
653 spin_lock_irqsave(&serial_table_lock, flags);
654 serial_table[serial->minor] = NULL;
655 spin_unlock_irqrestore(&serial_table_lock, flags);
658 static void handle_usb_error(int status, const char *function,
659 struct hso_device *hso_dev)
665 explanation = "no device";
668 explanation = "endpoint not enabled";
671 explanation = "endpoint stalled";
674 explanation = "not enough bandwidth";
677 explanation = "device disabled";
680 explanation = "device suspended";
686 explanation = "internal error";
692 explanation = "protocol error";
694 usb_queue_reset_device(hso_dev->interface);
697 explanation = "unknown status";
701 /* log a meaningful explanation of an USB status */
702 hso_dbg(0x1, "%s: received USB status - %s (%d)\n",
703 function, explanation, status);
706 /* Network interface functions */
708 /* called when net interface is brought up by ifconfig */
709 static int hso_net_open(struct net_device *net)
711 struct hso_net *odev = netdev_priv(net);
712 unsigned long flags = 0;
715 dev_err(&net->dev, "No net device !\n");
719 odev->skb_tx_buf = NULL;
721 /* setup environment */
722 spin_lock_irqsave(&odev->net_lock, flags);
723 odev->rx_parse_state = WAIT_IP;
724 odev->rx_buf_size = 0;
725 odev->rx_buf_missing = sizeof(struct iphdr);
726 spin_unlock_irqrestore(&odev->net_lock, flags);
728 /* We are up and running. */
729 set_bit(HSO_NET_RUNNING, &odev->flags);
730 hso_start_net_device(odev->parent);
732 /* Tell the kernel we are ready to start receiving from it */
733 netif_start_queue(net);
738 /* called when interface is brought down by ifconfig */
739 static int hso_net_close(struct net_device *net)
741 struct hso_net *odev = netdev_priv(net);
743 /* we don't need the queue anymore */
744 netif_stop_queue(net);
745 /* no longer running */
746 clear_bit(HSO_NET_RUNNING, &odev->flags);
748 hso_stop_net_device(odev->parent);
754 /* USB tells is xmit done, we should start the netqueue again */
755 static void write_bulk_callback(struct urb *urb)
757 struct hso_net *odev = urb->context;
758 int status = urb->status;
761 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
762 dev_err(&urb->dev->dev, "%s: device not running\n", __func__);
766 /* Do we still have a valid kernel network device? */
767 if (!netif_device_present(odev->net)) {
768 dev_err(&urb->dev->dev, "%s: net device not present\n",
773 /* log status, but don't act on it, we don't need to resubmit anything
776 handle_usb_error(status, __func__, odev->parent);
778 hso_put_activity(odev->parent);
780 /* Tell the network interface we are ready for another frame */
781 netif_wake_queue(odev->net);
784 /* called by kernel when we need to transmit a packet */
785 static netdev_tx_t hso_net_start_xmit(struct sk_buff *skb,
786 struct net_device *net)
788 struct hso_net *odev = netdev_priv(net);
791 /* Tell the kernel, "No more frames 'til we are done with this one." */
792 netif_stop_queue(net);
793 if (hso_get_activity(odev->parent) == -EAGAIN) {
794 odev->skb_tx_buf = skb;
799 DUMP1(skb->data, skb->len);
800 /* Copy it from kernel memory to OUR memory */
801 memcpy(odev->mux_bulk_tx_buf, skb->data, skb->len);
802 hso_dbg(0x1, "len: %d/%d\n", skb->len, MUX_BULK_TX_BUF_SIZE);
804 /* Fill in the URB for shipping it out. */
805 usb_fill_bulk_urb(odev->mux_bulk_tx_urb,
807 usb_sndbulkpipe(odev->parent->usb,
809 bEndpointAddress & 0x7F),
810 odev->mux_bulk_tx_buf, skb->len, write_bulk_callback,
813 /* Deal with the Zero Length packet problem, I hope */
814 odev->mux_bulk_tx_urb->transfer_flags |= URB_ZERO_PACKET;
816 /* Send the URB on its merry way. */
817 result = usb_submit_urb(odev->mux_bulk_tx_urb, GFP_ATOMIC);
819 dev_warn(&odev->parent->interface->dev,
820 "failed mux_bulk_tx_urb %d\n", result);
821 net->stats.tx_errors++;
822 netif_start_queue(net);
824 net->stats.tx_packets++;
825 net->stats.tx_bytes += skb->len;
832 static const struct ethtool_ops ops = {
833 .get_link = ethtool_op_get_link
836 /* called when a packet did not ack after watchdogtimeout */
837 static void hso_net_tx_timeout(struct net_device *net)
839 struct hso_net *odev = netdev_priv(net);
844 /* Tell syslog we are hosed. */
845 dev_warn(&net->dev, "Tx timed out.\n");
847 /* Tear the waiting frame off the list */
848 if (odev->mux_bulk_tx_urb &&
849 (odev->mux_bulk_tx_urb->status == -EINPROGRESS))
850 usb_unlink_urb(odev->mux_bulk_tx_urb);
852 /* Update statistics */
853 net->stats.tx_errors++;
856 /* make a real packet from the received USB buffer */
857 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt,
858 unsigned int count, unsigned char is_eop)
860 unsigned short temp_bytes;
861 unsigned short buffer_offset = 0;
862 unsigned short frame_len;
863 unsigned char *tmp_rx_buf;
866 hso_dbg(0x1, "Rx %d bytes\n", count);
867 DUMP(ip_pkt, min(128, (int)count));
870 switch (odev->rx_parse_state) {
872 /* waiting for IP header. */
873 /* wanted bytes - size of ip header */
876 odev->rx_buf_missing) ? count : odev->
879 memcpy(((unsigned char *)(&odev->rx_ip_hdr)) +
880 odev->rx_buf_size, ip_pkt + buffer_offset,
883 odev->rx_buf_size += temp_bytes;
884 buffer_offset += temp_bytes;
885 odev->rx_buf_missing -= temp_bytes;
888 if (!odev->rx_buf_missing) {
889 /* header is complete allocate an sk_buffer and
890 * continue to WAIT_DATA */
891 frame_len = ntohs(odev->rx_ip_hdr.tot_len);
893 if ((frame_len > DEFAULT_MRU) ||
894 (frame_len < sizeof(struct iphdr))) {
895 dev_err(&odev->net->dev,
896 "Invalid frame (%d) length\n",
898 odev->rx_parse_state = WAIT_SYNC;
901 /* Allocate an sk_buff */
902 odev->skb_rx_buf = netdev_alloc_skb(odev->net,
904 if (!odev->skb_rx_buf) {
905 /* We got no receive buffer. */
906 hso_dbg(0x1, "could not allocate memory\n");
907 odev->rx_parse_state = WAIT_SYNC;
911 /* Copy what we got so far. make room for iphdr
914 skb_put(odev->skb_rx_buf,
915 sizeof(struct iphdr));
916 memcpy(tmp_rx_buf, (char *)&(odev->rx_ip_hdr),
917 sizeof(struct iphdr));
920 odev->rx_buf_size = sizeof(struct iphdr);
922 /* Filip actually use .tot_len */
923 odev->rx_buf_missing =
924 frame_len - sizeof(struct iphdr);
925 odev->rx_parse_state = WAIT_DATA;
930 temp_bytes = (count < odev->rx_buf_missing)
931 ? count : odev->rx_buf_missing;
933 /* Copy the rest of the bytes that are left in the
934 * buffer into the waiting sk_buf. */
935 /* Make room for temp_bytes after tail. */
936 tmp_rx_buf = skb_put(odev->skb_rx_buf, temp_bytes);
937 memcpy(tmp_rx_buf, ip_pkt + buffer_offset, temp_bytes);
939 odev->rx_buf_missing -= temp_bytes;
941 buffer_offset += temp_bytes;
942 odev->rx_buf_size += temp_bytes;
943 if (!odev->rx_buf_missing) {
944 /* Packet is complete. Inject into stack. */
945 /* We have IP packet here */
946 odev->skb_rx_buf->protocol = cpu_to_be16(ETH_P_IP);
947 skb_reset_mac_header(odev->skb_rx_buf);
949 /* Ship it off to the kernel */
950 netif_rx(odev->skb_rx_buf);
951 /* No longer our buffer. */
952 odev->skb_rx_buf = NULL;
954 /* update out statistics */
955 odev->net->stats.rx_packets++;
957 odev->net->stats.rx_bytes += odev->rx_buf_size;
959 odev->rx_buf_size = 0;
960 odev->rx_buf_missing = sizeof(struct iphdr);
961 odev->rx_parse_state = WAIT_IP;
966 hso_dbg(0x1, " W_S\n");
976 /* Recovery mechanism for WAIT_SYNC state. */
978 if (odev->rx_parse_state == WAIT_SYNC) {
979 odev->rx_parse_state = WAIT_IP;
980 odev->rx_buf_size = 0;
981 odev->rx_buf_missing = sizeof(struct iphdr);
986 static void fix_crc_bug(struct urb *urb, __le16 max_packet_size)
988 static const u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
989 u32 rest = urb->actual_length % le16_to_cpu(max_packet_size);
991 if (((rest == 5) || (rest == 6)) &&
992 !memcmp(((u8 *)urb->transfer_buffer) + urb->actual_length - 4,
994 urb->actual_length -= 4;
998 /* Moving data from usb to kernel (in interrupt state) */
999 static void read_bulk_callback(struct urb *urb)
1001 struct hso_net *odev = urb->context;
1002 struct net_device *net;
1004 int status = urb->status;
1006 /* is al ok? (Filip: Who's Al ?) */
1008 handle_usb_error(status, __func__, odev->parent);
1013 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
1014 hso_dbg(0x1, "BULK IN callback but driver is not active!\n");
1017 usb_mark_last_busy(urb->dev);
1021 if (!netif_device_present(net)) {
1022 /* Somebody killed our network interface... */
1026 if (odev->parent->port_spec & HSO_INFO_CRC_BUG)
1027 fix_crc_bug(urb, odev->in_endp->wMaxPacketSize);
1029 /* do we even have a packet? */
1030 if (urb->actual_length) {
1031 /* Handle the IP stream, add header and push it onto network
1032 * stack if the packet is complete. */
1033 spin_lock(&odev->net_lock);
1034 packetizeRx(odev, urb->transfer_buffer, urb->actual_length,
1035 (urb->transfer_buffer_length >
1036 urb->actual_length) ? 1 : 0);
1037 spin_unlock(&odev->net_lock);
1040 /* We are done with this URB, resubmit it. Prep the USB to wait for
1041 * another frame. Reuse same as received. */
1042 usb_fill_bulk_urb(urb,
1044 usb_rcvbulkpipe(odev->parent->usb,
1046 bEndpointAddress & 0x7F),
1047 urb->transfer_buffer, MUX_BULK_RX_BUF_SIZE,
1048 read_bulk_callback, odev);
1050 /* Give this to the USB subsystem so it can tell us when more data
1052 result = usb_submit_urb(urb, GFP_ATOMIC);
1054 dev_warn(&odev->parent->interface->dev,
1055 "%s failed submit mux_bulk_rx_urb %d\n", __func__,
1059 /* Serial driver functions */
1061 static void hso_init_termios(struct ktermios *termios)
1064 * The default requirements for this device are:
1067 ~(IGNBRK /* disable ignore break */
1068 | BRKINT /* disable break causes interrupt */
1069 | PARMRK /* disable mark parity errors */
1070 | ISTRIP /* disable clear high bit of input characters */
1071 | INLCR /* disable translate NL to CR */
1072 | IGNCR /* disable ignore CR */
1073 | ICRNL /* disable translate CR to NL */
1074 | IXON); /* disable enable XON/XOFF flow control */
1076 /* disable postprocess output characters */
1077 termios->c_oflag &= ~OPOST;
1080 ~(ECHO /* disable echo input characters */
1081 | ECHONL /* disable echo new line */
1082 | ICANON /* disable erase, kill, werase, and rprnt
1083 special characters */
1084 | ISIG /* disable interrupt, quit, and suspend special
1086 | IEXTEN); /* disable non-POSIX special characters */
1089 ~(CSIZE /* no size */
1090 | PARENB /* disable parity bit */
1091 | CBAUD /* clear current baud rate */
1092 | CBAUDEX); /* clear current buad rate */
1094 termios->c_cflag |= CS8; /* character size 8 bits */
1096 /* baud rate 115200 */
1097 tty_termios_encode_baud_rate(termios, 115200, 115200);
1100 static void _hso_serial_set_termios(struct tty_struct *tty,
1101 struct ktermios *old)
1103 struct hso_serial *serial = tty->driver_data;
1106 pr_err("%s: no tty structures", __func__);
1110 hso_dbg(0x8, "port %d\n", serial->minor);
1113 * Fix up unsupported bits
1115 tty->termios.c_iflag &= ~IXON; /* disable enable XON/XOFF flow control */
1117 tty->termios.c_cflag &=
1118 ~(CSIZE /* no size */
1119 | PARENB /* disable parity bit */
1120 | CBAUD /* clear current baud rate */
1121 | CBAUDEX); /* clear current buad rate */
1123 tty->termios.c_cflag |= CS8; /* character size 8 bits */
1125 /* baud rate 115200 */
1126 tty_encode_baud_rate(tty, 115200, 115200);
1129 static void hso_resubmit_rx_bulk_urb(struct hso_serial *serial, struct urb *urb)
1132 /* We are done with this URB, resubmit it. Prep the USB to wait for
1134 usb_fill_bulk_urb(urb, serial->parent->usb,
1135 usb_rcvbulkpipe(serial->parent->usb,
1137 bEndpointAddress & 0x7F),
1138 urb->transfer_buffer, serial->rx_data_length,
1139 hso_std_serial_read_bulk_callback, serial);
1140 /* Give this to the USB subsystem so it can tell us when more data
1142 result = usb_submit_urb(urb, GFP_ATOMIC);
1144 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1152 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1155 struct urb *curr_urb;
1157 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1158 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1159 count = put_rxbuf_data(curr_urb, serial);
1163 serial->curr_rx_urb_idx++;
1164 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1165 serial->curr_rx_urb_idx = 0;
1166 hso_resubmit_rx_bulk_urb(serial, curr_urb);
1171 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1176 urb = serial->rx_urb[0];
1177 if (serial->port.count > 0) {
1178 count = put_rxbuf_data(urb, serial);
1182 /* Re issue a read as long as we receive data. */
1184 if (count == 0 && ((urb->actual_length != 0) ||
1185 (serial->rx_state == RX_PENDING))) {
1186 serial->rx_state = RX_SENT;
1187 hso_mux_serial_read(serial);
1189 serial->rx_state = RX_IDLE;
1193 /* read callback for Diag and CS port */
1194 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1196 struct hso_serial *serial = urb->context;
1197 int status = urb->status;
1199 hso_dbg(0x8, "--- Got serial_read_bulk callback %02x ---\n", status);
1203 hso_dbg(0x1, "serial == NULL\n");
1207 handle_usb_error(status, __func__, serial->parent);
1211 hso_dbg(0x1, "Actual length = %d\n", urb->actual_length);
1212 DUMP1(urb->transfer_buffer, urb->actual_length);
1214 /* Anyone listening? */
1215 if (serial->port.count == 0)
1218 if (serial->parent->port_spec & HSO_INFO_CRC_BUG)
1219 fix_crc_bug(urb, serial->in_endp->wMaxPacketSize);
1220 /* Valid data, handle RX data */
1221 spin_lock(&serial->serial_lock);
1222 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1223 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1224 spin_unlock(&serial->serial_lock);
1228 * This needs to be a tasklet otherwise we will
1229 * end up recursively calling this function.
1231 static void hso_unthrottle_tasklet(struct hso_serial *serial)
1233 unsigned long flags;
1235 spin_lock_irqsave(&serial->serial_lock, flags);
1236 if ((serial->parent->port_spec & HSO_INTF_MUX))
1237 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1239 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1240 spin_unlock_irqrestore(&serial->serial_lock, flags);
1243 static void hso_unthrottle(struct tty_struct *tty)
1245 struct hso_serial *serial = tty->driver_data;
1247 tasklet_hi_schedule(&serial->unthrottle_tasklet);
1250 /* open the requested serial port */
1251 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1253 struct hso_serial *serial = get_serial_by_index(tty->index);
1257 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1259 tty->driver_data = NULL;
1260 hso_dbg(0x1, "Failed to open port\n");
1264 mutex_lock(&serial->parent->mutex);
1265 result = usb_autopm_get_interface(serial->parent->interface);
1269 hso_dbg(0x1, "Opening %d\n", serial->minor);
1272 tty->driver_data = serial;
1273 tty_port_tty_set(&serial->port, tty);
1275 /* check for port already opened, if not set the termios */
1276 serial->port.count++;
1277 if (serial->port.count == 1) {
1278 serial->rx_state = RX_IDLE;
1279 /* Force default termio settings */
1280 _hso_serial_set_termios(tty, NULL);
1281 tasklet_init(&serial->unthrottle_tasklet,
1282 (void (*)(unsigned long))hso_unthrottle_tasklet,
1283 (unsigned long)serial);
1284 result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1286 hso_stop_serial_device(serial->parent);
1287 serial->port.count--;
1289 kref_get(&serial->parent->ref);
1292 hso_dbg(0x1, "Port was already open\n");
1295 usb_autopm_put_interface(serial->parent->interface);
1299 hso_serial_tiocmset(tty, TIOCM_RTS | TIOCM_DTR, 0);
1301 mutex_unlock(&serial->parent->mutex);
1305 /* close the requested serial port */
1306 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1308 struct hso_serial *serial = tty->driver_data;
1311 hso_dbg(0x1, "Closing serial port\n");
1313 /* Open failed, no close cleanup required */
1317 mutex_lock(&serial->parent->mutex);
1318 usb_gone = serial->parent->usb_gone;
1321 usb_autopm_get_interface(serial->parent->interface);
1323 /* reset the rts and dtr */
1324 /* do the actual close */
1325 serial->port.count--;
1327 if (serial->port.count <= 0) {
1328 serial->port.count = 0;
1329 tty_port_tty_set(&serial->port, NULL);
1331 hso_stop_serial_device(serial->parent);
1332 tasklet_kill(&serial->unthrottle_tasklet);
1336 usb_autopm_put_interface(serial->parent->interface);
1338 mutex_unlock(&serial->parent->mutex);
1341 /* close the requested serial port */
1342 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1345 struct hso_serial *serial = tty->driver_data;
1346 int space, tx_bytes;
1347 unsigned long flags;
1350 if (serial == NULL) {
1351 pr_err("%s: serial is NULL\n", __func__);
1355 spin_lock_irqsave(&serial->serial_lock, flags);
1357 space = serial->tx_data_length - serial->tx_buffer_count;
1358 tx_bytes = (count < space) ? count : space;
1363 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1364 serial->tx_buffer_count += tx_bytes;
1367 spin_unlock_irqrestore(&serial->serial_lock, flags);
1369 hso_kick_transmit(serial);
1374 /* how much room is there for writing */
1375 static int hso_serial_write_room(struct tty_struct *tty)
1377 struct hso_serial *serial = tty->driver_data;
1379 unsigned long flags;
1381 spin_lock_irqsave(&serial->serial_lock, flags);
1382 room = serial->tx_data_length - serial->tx_buffer_count;
1383 spin_unlock_irqrestore(&serial->serial_lock, flags);
1385 /* return free room */
1389 static void hso_serial_cleanup(struct tty_struct *tty)
1391 struct hso_serial *serial = tty->driver_data;
1396 kref_put(&serial->parent->ref, hso_serial_ref_free);
1399 /* setup the term */
1400 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1402 struct hso_serial *serial = tty->driver_data;
1403 unsigned long flags;
1406 hso_dbg(0x16, "Termios called with: cflags new[%u] - old[%u]\n",
1407 (unsigned int)tty->termios.c_cflag,
1408 (unsigned int)old->c_cflag);
1410 /* the actual setup */
1411 spin_lock_irqsave(&serial->serial_lock, flags);
1412 if (serial->port.count)
1413 _hso_serial_set_termios(tty, old);
1415 tty->termios = *old;
1416 spin_unlock_irqrestore(&serial->serial_lock, flags);
1421 /* how many characters in the buffer */
1422 static int hso_serial_chars_in_buffer(struct tty_struct *tty)
1424 struct hso_serial *serial = tty->driver_data;
1426 unsigned long flags;
1432 spin_lock_irqsave(&serial->serial_lock, flags);
1433 chars = serial->tx_buffer_count;
1434 spin_unlock_irqrestore(&serial->serial_lock, flags);
1438 static int tiocmget_submit_urb(struct hso_serial *serial,
1439 struct hso_tiocmget *tiocmget,
1440 struct usb_device *usb)
1444 if (serial->parent->usb_gone)
1446 usb_fill_int_urb(tiocmget->urb, usb,
1449 bEndpointAddress & 0x7F),
1450 &tiocmget->serial_state_notification,
1451 sizeof(struct hso_serial_state_notification),
1452 tiocmget_intr_callback, serial,
1453 tiocmget->endp->bInterval);
1454 result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC);
1456 dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__,
1463 static void tiocmget_intr_callback(struct urb *urb)
1465 struct hso_serial *serial = urb->context;
1466 struct hso_tiocmget *tiocmget;
1467 int status = urb->status;
1468 u16 UART_state_bitmap, prev_UART_state_bitmap;
1469 struct uart_icount *icount;
1470 struct hso_serial_state_notification *serial_state_notification;
1471 struct usb_device *usb;
1472 struct usb_interface *interface;
1479 handle_usb_error(status, __func__, serial->parent);
1483 /* tiocmget is only supported on HSO_PORT_MODEM */
1484 tiocmget = serial->tiocmget;
1487 BUG_ON((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM);
1489 usb = serial->parent->usb;
1490 interface = serial->parent->interface;
1492 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
1494 /* wIndex should be the USB interface number of the port to which the
1495 * notification applies, which should always be the Modem port.
1497 serial_state_notification = &tiocmget->serial_state_notification;
1498 if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1499 serial_state_notification->bNotification != B_NOTIFICATION ||
1500 le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1501 le16_to_cpu(serial_state_notification->wIndex) != if_num ||
1502 le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1504 "hso received invalid serial state notification\n");
1505 DUMP(serial_state_notification,
1506 sizeof(struct hso_serial_state_notification));
1509 UART_state_bitmap = le16_to_cpu(serial_state_notification->
1511 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1512 icount = &tiocmget->icount;
1513 spin_lock(&serial->serial_lock);
1514 if ((UART_state_bitmap & B_OVERRUN) !=
1515 (prev_UART_state_bitmap & B_OVERRUN))
1517 if ((UART_state_bitmap & B_PARITY) !=
1518 (prev_UART_state_bitmap & B_PARITY))
1520 if ((UART_state_bitmap & B_FRAMING) !=
1521 (prev_UART_state_bitmap & B_FRAMING))
1523 if ((UART_state_bitmap & B_RING_SIGNAL) &&
1524 !(prev_UART_state_bitmap & B_RING_SIGNAL))
1526 if ((UART_state_bitmap & B_BREAK) !=
1527 (prev_UART_state_bitmap & B_BREAK))
1529 if ((UART_state_bitmap & B_TX_CARRIER) !=
1530 (prev_UART_state_bitmap & B_TX_CARRIER))
1532 if ((UART_state_bitmap & B_RX_CARRIER) !=
1533 (prev_UART_state_bitmap & B_RX_CARRIER))
1535 tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1536 spin_unlock(&serial->serial_lock);
1537 tiocmget->intr_completed = 1;
1538 wake_up_interruptible(&tiocmget->waitq);
1540 memset(serial_state_notification, 0,
1541 sizeof(struct hso_serial_state_notification));
1542 tiocmget_submit_urb(serial,
1544 serial->parent->usb);
1548 * next few functions largely stolen from drivers/serial/serial_core.c
1550 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1551 * - mask passed in arg for lines of interest
1552 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1553 * Caller should use TIOCGICOUNT to see which one it was
1556 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1558 DECLARE_WAITQUEUE(wait, current);
1559 struct uart_icount cprev, cnow;
1560 struct hso_tiocmget *tiocmget;
1563 tiocmget = serial->tiocmget;
1567 * note the counters on entry
1569 spin_lock_irq(&serial->serial_lock);
1570 memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1571 spin_unlock_irq(&serial->serial_lock);
1572 add_wait_queue(&tiocmget->waitq, &wait);
1574 spin_lock_irq(&serial->serial_lock);
1575 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1576 spin_unlock_irq(&serial->serial_lock);
1577 set_current_state(TASK_INTERRUPTIBLE);
1578 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1579 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1580 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd))) {
1585 /* see if a signal did it */
1586 if (signal_pending(current)) {
1592 __set_current_state(TASK_RUNNING);
1593 remove_wait_queue(&tiocmget->waitq, &wait);
1599 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1600 * Return: write counters to the user passed counter struct
1601 * NB: both 1->0 and 0->1 transitions are counted except for
1602 * RI where only 0->1 is counted.
1604 static int hso_get_count(struct tty_struct *tty,
1605 struct serial_icounter_struct *icount)
1607 struct uart_icount cnow;
1608 struct hso_serial *serial = tty->driver_data;
1609 struct hso_tiocmget *tiocmget = serial->tiocmget;
1611 memset(icount, 0, sizeof(struct serial_icounter_struct));
1615 spin_lock_irq(&serial->serial_lock);
1616 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1617 spin_unlock_irq(&serial->serial_lock);
1619 icount->cts = cnow.cts;
1620 icount->dsr = cnow.dsr;
1621 icount->rng = cnow.rng;
1622 icount->dcd = cnow.dcd;
1623 icount->rx = cnow.rx;
1624 icount->tx = cnow.tx;
1625 icount->frame = cnow.frame;
1626 icount->overrun = cnow.overrun;
1627 icount->parity = cnow.parity;
1628 icount->brk = cnow.brk;
1629 icount->buf_overrun = cnow.buf_overrun;
1635 static int hso_serial_tiocmget(struct tty_struct *tty)
1638 struct hso_serial *serial = tty->driver_data;
1639 struct hso_tiocmget *tiocmget;
1640 u16 UART_state_bitmap;
1644 hso_dbg(0x1, "no tty structures\n");
1647 spin_lock_irq(&serial->serial_lock);
1648 retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1649 ((serial->dtr_state) ? TIOCM_DTR : 0);
1650 tiocmget = serial->tiocmget;
1653 UART_state_bitmap = le16_to_cpu(
1654 tiocmget->prev_UART_state_bitmap);
1655 if (UART_state_bitmap & B_RING_SIGNAL)
1656 retval |= TIOCM_RNG;
1657 if (UART_state_bitmap & B_RX_CARRIER)
1659 if (UART_state_bitmap & B_TX_CARRIER)
1660 retval |= TIOCM_DSR;
1662 spin_unlock_irq(&serial->serial_lock);
1666 static int hso_serial_tiocmset(struct tty_struct *tty,
1667 unsigned int set, unsigned int clear)
1670 unsigned long flags;
1672 struct hso_serial *serial = tty->driver_data;
1673 struct usb_interface *interface;
1677 hso_dbg(0x1, "no tty structures\n");
1681 if ((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM)
1684 interface = serial->parent->interface;
1685 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
1687 spin_lock_irqsave(&serial->serial_lock, flags);
1688 if (set & TIOCM_RTS)
1689 serial->rts_state = 1;
1690 if (set & TIOCM_DTR)
1691 serial->dtr_state = 1;
1693 if (clear & TIOCM_RTS)
1694 serial->rts_state = 0;
1695 if (clear & TIOCM_DTR)
1696 serial->dtr_state = 0;
1698 if (serial->dtr_state)
1700 if (serial->rts_state)
1703 spin_unlock_irqrestore(&serial->serial_lock, flags);
1705 return usb_control_msg(serial->parent->usb,
1706 usb_sndctrlpipe(serial->parent->usb, 0), 0x22,
1707 0x21, val, if_num, NULL, 0,
1708 USB_CTRL_SET_TIMEOUT);
1711 static int hso_serial_ioctl(struct tty_struct *tty,
1712 unsigned int cmd, unsigned long arg)
1714 struct hso_serial *serial = tty->driver_data;
1716 hso_dbg(0x8, "IOCTL cmd: %d, arg: %ld\n", cmd, arg);
1722 ret = hso_wait_modem_status(serial, arg);
1732 /* starts a transmit */
1733 static void hso_kick_transmit(struct hso_serial *serial)
1736 unsigned long flags;
1739 spin_lock_irqsave(&serial->serial_lock, flags);
1740 if (!serial->tx_buffer_count)
1743 if (serial->tx_urb_used)
1746 /* Wakeup USB interface if necessary */
1747 if (hso_get_activity(serial->parent) == -EAGAIN)
1750 /* Switch pointers around to avoid memcpy */
1751 temp = serial->tx_buffer;
1752 serial->tx_buffer = serial->tx_data;
1753 serial->tx_data = temp;
1754 serial->tx_data_count = serial->tx_buffer_count;
1755 serial->tx_buffer_count = 0;
1757 /* If temp is set, it means we switched buffers */
1758 if (temp && serial->write_data) {
1759 res = serial->write_data(serial);
1761 serial->tx_urb_used = 1;
1764 spin_unlock_irqrestore(&serial->serial_lock, flags);
1767 /* make a request (for reading and writing data to muxed serial port) */
1768 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1769 struct urb *ctrl_urb,
1770 struct usb_ctrlrequest *ctrl_req,
1771 u8 *ctrl_urb_data, u32 size)
1777 if (!serial || !ctrl_urb || !ctrl_req) {
1778 pr_err("%s: Wrong arguments\n", __func__);
1783 ctrl_req->wValue = 0;
1784 ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1785 ctrl_req->wLength = cpu_to_le16(size);
1787 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1788 /* Reading command */
1789 ctrl_req->bRequestType = USB_DIR_IN |
1790 USB_TYPE_OPTION_VENDOR |
1791 USB_RECIP_INTERFACE;
1792 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1793 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1795 /* Writing command */
1796 ctrl_req->bRequestType = USB_DIR_OUT |
1797 USB_TYPE_OPTION_VENDOR |
1798 USB_RECIP_INTERFACE;
1799 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1800 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1803 hso_dbg(0x2, "%s command (%02x) len: %d, port: %d\n",
1804 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1805 ctrl_req->bRequestType, ctrl_req->wLength, port);
1808 ctrl_urb->transfer_flags = 0;
1809 usb_fill_control_urb(ctrl_urb,
1810 serial->parent->usb,
1813 ctrl_urb_data, size, ctrl_callback, serial);
1814 /* Send it on merry way */
1815 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1817 dev_err(&ctrl_urb->dev->dev,
1818 "%s failed submit ctrl_urb %d type %d\n", __func__,
1827 /* called by intr_callback when read occurs */
1828 static int hso_mux_serial_read(struct hso_serial *serial)
1834 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1835 /* make the request */
1837 if (serial->num_rx_urbs != 1) {
1838 dev_err(&serial->parent->interface->dev,
1839 "ERROR: mux'd reads with multiple buffers "
1843 return mux_device_request(serial,
1844 USB_CDC_GET_ENCAPSULATED_RESPONSE,
1845 serial->parent->port_spec & HSO_PORT_MASK,
1847 &serial->ctrl_req_rx,
1848 serial->rx_data[0], serial->rx_data_length);
1851 /* used for muxed serial port callback (muxed serial read) */
1852 static void intr_callback(struct urb *urb)
1854 struct hso_shared_int *shared_int = urb->context;
1855 struct hso_serial *serial;
1856 unsigned char *port_req;
1857 int status = urb->status;
1860 usb_mark_last_busy(urb->dev);
1868 handle_usb_error(status, __func__, NULL);
1871 hso_dbg(0x8, "--- Got intr callback 0x%02X ---\n", status);
1874 port_req = urb->transfer_buffer;
1875 hso_dbg(0x8, "port_req = 0x%.2X\n", *port_req);
1876 /* loop over all muxed ports to find the one sending this */
1877 for (i = 0; i < 8; i++) {
1878 /* max 8 channels on MUX */
1879 if (*port_req & (1 << i)) {
1880 serial = get_serial_by_shared_int_and_type(shared_int,
1882 if (serial != NULL) {
1883 hso_dbg(0x1, "Pending read interrupt on port %d\n",
1885 spin_lock(&serial->serial_lock);
1886 if (serial->rx_state == RX_IDLE &&
1887 serial->port.count > 0) {
1888 /* Setup and send a ctrl req read on
1890 if (!serial->rx_urb_filled[0]) {
1891 serial->rx_state = RX_SENT;
1892 hso_mux_serial_read(serial);
1894 serial->rx_state = RX_PENDING;
1896 hso_dbg(0x1, "Already a read pending on port %d or port not open\n",
1899 spin_unlock(&serial->serial_lock);
1903 /* Resubmit interrupt urb */
1904 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1907 /* called for writing to muxed serial port */
1908 static int hso_mux_serial_write_data(struct hso_serial *serial)
1913 return mux_device_request(serial,
1914 USB_CDC_SEND_ENCAPSULATED_COMMAND,
1915 serial->parent->port_spec & HSO_PORT_MASK,
1917 &serial->ctrl_req_tx,
1918 serial->tx_data, serial->tx_data_count);
1921 /* write callback for Diag and CS port */
1922 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1924 struct hso_serial *serial = urb->context;
1925 int status = urb->status;
1929 hso_dbg(0x1, "serial == NULL\n");
1933 spin_lock(&serial->serial_lock);
1934 serial->tx_urb_used = 0;
1935 spin_unlock(&serial->serial_lock);
1937 handle_usb_error(status, __func__, serial->parent);
1940 hso_put_activity(serial->parent);
1941 tty_port_tty_wakeup(&serial->port);
1942 hso_kick_transmit(serial);
1947 /* called for writing diag or CS serial port */
1948 static int hso_std_serial_write_data(struct hso_serial *serial)
1950 int count = serial->tx_data_count;
1953 usb_fill_bulk_urb(serial->tx_urb,
1954 serial->parent->usb,
1955 usb_sndbulkpipe(serial->parent->usb,
1957 bEndpointAddress & 0x7F),
1958 serial->tx_data, serial->tx_data_count,
1959 hso_std_serial_write_bulk_callback, serial);
1961 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
1963 dev_warn(&serial->parent->usb->dev,
1964 "Failed to submit urb - res %d\n", result);
1971 /* callback after read or write on muxed serial port */
1972 static void ctrl_callback(struct urb *urb)
1974 struct hso_serial *serial = urb->context;
1975 struct usb_ctrlrequest *req;
1976 int status = urb->status;
1982 spin_lock(&serial->serial_lock);
1983 serial->tx_urb_used = 0;
1984 spin_unlock(&serial->serial_lock);
1986 handle_usb_error(status, __func__, serial->parent);
1991 req = (struct usb_ctrlrequest *)(urb->setup_packet);
1992 hso_dbg(0x8, "--- Got muxed ctrl callback 0x%02X ---\n", status);
1993 hso_dbg(0x8, "Actual length of urb = %d\n", urb->actual_length);
1994 DUMP1(urb->transfer_buffer, urb->actual_length);
1996 if (req->bRequestType ==
1997 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
1998 /* response to a read command */
1999 serial->rx_urb_filled[0] = 1;
2000 spin_lock(&serial->serial_lock);
2001 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
2002 spin_unlock(&serial->serial_lock);
2004 hso_put_activity(serial->parent);
2005 tty_port_tty_wakeup(&serial->port);
2006 /* response to a write command */
2007 hso_kick_transmit(serial);
2011 /* handle RX data for serial port */
2012 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
2014 struct tty_struct *tty;
2018 if (urb == NULL || serial == NULL) {
2019 hso_dbg(0x1, "serial = NULL\n");
2023 tty = tty_port_tty_get(&serial->port);
2025 if (tty && tty_throttled(tty)) {
2030 /* Push data to tty */
2031 hso_dbg(0x1, "data to push to tty\n");
2032 count = tty_buffer_request_room(&serial->port, urb->actual_length);
2033 if (count >= urb->actual_length) {
2034 tty_insert_flip_string(&serial->port, urb->transfer_buffer,
2035 urb->actual_length);
2036 tty_flip_buffer_push(&serial->port);
2038 dev_warn(&serial->parent->usb->dev,
2039 "dropping data, %d bytes lost\n", urb->actual_length);
2044 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2050 /* Base driver functions */
2052 static void hso_log_port(struct hso_device *hso_dev)
2057 switch (hso_dev->port_spec & HSO_PORT_MASK) {
2058 case HSO_PORT_CONTROL:
2059 port_type = "Control";
2062 port_type = "Application";
2067 case HSO_PORT_GPS_CONTROL:
2068 port_type = "GPS control";
2071 port_type = "Application2";
2077 port_type = "Diagnostic";
2079 case HSO_PORT_DIAG2:
2080 port_type = "Diagnostic2";
2082 case HSO_PORT_MODEM:
2083 port_type = "Modem";
2085 case HSO_PORT_NETWORK:
2086 port_type = "Network";
2089 port_type = "Unknown";
2092 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2093 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2095 sprintf(port_dev, "/dev/%s%d", tty_filename,
2096 dev2ser(hso_dev)->minor);
2098 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2099 port_type, port_dev);
2102 static int hso_start_net_device(struct hso_device *hso_dev)
2105 struct hso_net *hso_net = dev2net(hso_dev);
2110 /* send URBs for all read buffers */
2111 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2113 /* Prep a receive URB */
2114 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2116 usb_rcvbulkpipe(hso_dev->usb,
2118 bEndpointAddress & 0x7F),
2119 hso_net->mux_bulk_rx_buf_pool[i],
2120 MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2123 /* Put it out there so the device can send us stuff */
2124 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2127 dev_warn(&hso_dev->usb->dev,
2128 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2135 static int hso_stop_net_device(struct hso_device *hso_dev)
2138 struct hso_net *hso_net = dev2net(hso_dev);
2143 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2144 if (hso_net->mux_bulk_rx_urb_pool[i])
2145 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2148 if (hso_net->mux_bulk_tx_urb)
2149 usb_kill_urb(hso_net->mux_bulk_tx_urb);
2154 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2157 struct hso_serial *serial = dev2ser(hso_dev);
2162 /* If it is not the MUX port fill in and submit a bulk urb (already
2163 * allocated in hso_serial_start) */
2164 if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2165 for (i = 0; i < serial->num_rx_urbs; i++) {
2166 usb_fill_bulk_urb(serial->rx_urb[i],
2167 serial->parent->usb,
2168 usb_rcvbulkpipe(serial->parent->usb,
2173 serial->rx_data_length,
2174 hso_std_serial_read_bulk_callback,
2176 result = usb_submit_urb(serial->rx_urb[i], flags);
2178 dev_warn(&serial->parent->usb->dev,
2179 "Failed to submit urb - res %d\n",
2185 mutex_lock(&serial->shared_int->shared_int_lock);
2186 if (!serial->shared_int->use_count) {
2188 hso_mux_submit_intr_urb(serial->shared_int,
2189 hso_dev->usb, flags);
2191 serial->shared_int->use_count++;
2192 mutex_unlock(&serial->shared_int->shared_int_lock);
2194 if (serial->tiocmget)
2195 tiocmget_submit_urb(serial,
2197 serial->parent->usb);
2201 static int hso_stop_serial_device(struct hso_device *hso_dev)
2204 struct hso_serial *serial = dev2ser(hso_dev);
2205 struct hso_tiocmget *tiocmget;
2210 for (i = 0; i < serial->num_rx_urbs; i++) {
2211 if (serial->rx_urb[i]) {
2212 usb_kill_urb(serial->rx_urb[i]);
2213 serial->rx_urb_filled[i] = 0;
2216 serial->curr_rx_urb_idx = 0;
2219 usb_kill_urb(serial->tx_urb);
2221 if (serial->shared_int) {
2222 mutex_lock(&serial->shared_int->shared_int_lock);
2223 if (serial->shared_int->use_count &&
2224 (--serial->shared_int->use_count == 0)) {
2227 urb = serial->shared_int->shared_intr_urb;
2231 mutex_unlock(&serial->shared_int->shared_int_lock);
2233 tiocmget = serial->tiocmget;
2235 wake_up_interruptible(&tiocmget->waitq);
2236 usb_kill_urb(tiocmget->urb);
2242 static void hso_serial_tty_unregister(struct hso_serial *serial)
2244 tty_unregister_device(tty_drv, serial->minor);
2245 release_minor(serial);
2248 static void hso_serial_common_free(struct hso_serial *serial)
2252 for (i = 0; i < serial->num_rx_urbs; i++) {
2253 /* unlink and free RX URB */
2254 usb_free_urb(serial->rx_urb[i]);
2255 /* free the RX buffer */
2256 kfree(serial->rx_data[i]);
2259 /* unlink and free TX URB */
2260 usb_free_urb(serial->tx_urb);
2261 kfree(serial->tx_buffer);
2262 kfree(serial->tx_data);
2263 tty_port_destroy(&serial->port);
2266 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
2267 int rx_size, int tx_size)
2272 tty_port_init(&serial->port);
2274 if (obtain_minor(serial))
2277 /* register our minor number */
2278 serial->parent->dev = tty_port_register_device_attr(&serial->port,
2279 tty_drv, serial->minor, &serial->parent->interface->dev,
2280 serial->parent, hso_serial_dev_groups);
2281 if (IS_ERR(serial->parent->dev)) {
2282 release_minor(serial);
2285 dev = serial->parent->dev;
2287 serial->magic = HSO_SERIAL_MAGIC;
2288 spin_lock_init(&serial->serial_lock);
2289 serial->num_rx_urbs = num_urbs;
2291 /* RX, allocate urb and initialize */
2293 /* prepare our RX buffer */
2294 serial->rx_data_length = rx_size;
2295 for (i = 0; i < serial->num_rx_urbs; i++) {
2296 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2297 if (!serial->rx_urb[i])
2299 serial->rx_urb[i]->transfer_buffer = NULL;
2300 serial->rx_urb[i]->transfer_buffer_length = 0;
2301 serial->rx_data[i] = kzalloc(serial->rx_data_length,
2303 if (!serial->rx_data[i])
2307 /* TX, allocate urb and initialize */
2308 serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2309 if (!serial->tx_urb)
2311 serial->tx_urb->transfer_buffer = NULL;
2312 serial->tx_urb->transfer_buffer_length = 0;
2313 /* prepare our TX buffer */
2314 serial->tx_data_count = 0;
2315 serial->tx_buffer_count = 0;
2316 serial->tx_data_length = tx_size;
2317 serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2318 if (!serial->tx_data)
2321 serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2322 if (!serial->tx_buffer)
2327 hso_serial_tty_unregister(serial);
2329 hso_serial_common_free(serial);
2333 /* Creates a general hso device */
2334 static struct hso_device *hso_create_device(struct usb_interface *intf,
2337 struct hso_device *hso_dev;
2339 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2343 hso_dev->port_spec = port_spec;
2344 hso_dev->usb = interface_to_usbdev(intf);
2345 hso_dev->interface = intf;
2346 kref_init(&hso_dev->ref);
2347 mutex_init(&hso_dev->mutex);
2349 INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2350 INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2355 /* Removes a network device in the network device table */
2356 static int remove_net_device(struct hso_device *hso_dev)
2360 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2361 if (network_table[i] == hso_dev) {
2362 network_table[i] = NULL;
2366 if (i == HSO_MAX_NET_DEVICES)
2371 /* Frees our network device */
2372 static void hso_free_net_device(struct hso_device *hso_dev)
2375 struct hso_net *hso_net = dev2net(hso_dev);
2380 remove_net_device(hso_net->parent);
2383 unregister_netdev(hso_net->net);
2386 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2387 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2388 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2389 hso_net->mux_bulk_rx_buf_pool[i] = NULL;
2391 usb_free_urb(hso_net->mux_bulk_tx_urb);
2392 kfree(hso_net->mux_bulk_tx_buf);
2393 hso_net->mux_bulk_tx_buf = NULL;
2396 free_netdev(hso_net->net);
2401 static const struct net_device_ops hso_netdev_ops = {
2402 .ndo_open = hso_net_open,
2403 .ndo_stop = hso_net_close,
2404 .ndo_start_xmit = hso_net_start_xmit,
2405 .ndo_tx_timeout = hso_net_tx_timeout,
2408 /* initialize the network interface */
2409 static void hso_net_init(struct net_device *net)
2411 struct hso_net *hso_net = netdev_priv(net);
2413 hso_dbg(0x1, "sizeof hso_net is %zu\n", sizeof(*hso_net));
2415 /* fill in the other fields */
2416 net->netdev_ops = &hso_netdev_ops;
2417 net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2418 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2419 net->type = ARPHRD_NONE;
2420 net->mtu = DEFAULT_MTU - 14;
2421 net->tx_queue_len = 10;
2422 net->ethtool_ops = &ops;
2424 /* and initialize the semaphore */
2425 spin_lock_init(&hso_net->net_lock);
2428 /* Adds a network device in the network device table */
2429 static int add_net_device(struct hso_device *hso_dev)
2433 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2434 if (network_table[i] == NULL) {
2435 network_table[i] = hso_dev;
2439 if (i == HSO_MAX_NET_DEVICES)
2444 static int hso_rfkill_set_block(void *data, bool blocked)
2446 struct hso_device *hso_dev = data;
2447 int enabled = !blocked;
2450 mutex_lock(&hso_dev->mutex);
2451 if (hso_dev->usb_gone)
2454 rv = usb_control_msg(hso_dev->usb, usb_sndctrlpipe(hso_dev->usb, 0),
2455 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2456 USB_CTRL_SET_TIMEOUT);
2457 mutex_unlock(&hso_dev->mutex);
2461 static const struct rfkill_ops hso_rfkill_ops = {
2462 .set_block = hso_rfkill_set_block,
2465 /* Creates and sets up everything for rfkill */
2466 static void hso_create_rfkill(struct hso_device *hso_dev,
2467 struct usb_interface *interface)
2469 struct hso_net *hso_net = dev2net(hso_dev);
2470 struct device *dev = &hso_net->net->dev;
2471 static u32 rfkill_counter;
2473 snprintf(hso_net->name, sizeof(hso_net->name), "hso-%d",
2476 hso_net->rfkill = rfkill_alloc(hso_net->name,
2477 &interface_to_usbdev(interface)->dev,
2479 &hso_rfkill_ops, hso_dev);
2480 if (!hso_net->rfkill) {
2481 dev_err(dev, "%s - Out of memory\n", __func__);
2484 if (rfkill_register(hso_net->rfkill) < 0) {
2485 rfkill_destroy(hso_net->rfkill);
2486 hso_net->rfkill = NULL;
2487 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2492 static struct device_type hso_type = {
2496 /* Creates our network device */
2497 static struct hso_device *hso_create_net_device(struct usb_interface *interface,
2501 struct net_device *net;
2502 struct hso_net *hso_net;
2503 struct hso_device *hso_dev;
2505 hso_dev = hso_create_device(interface, port_spec);
2509 /* allocate our network device, then we can put in our private data */
2510 /* call hso_net_init to do the basic initialization */
2511 net = alloc_netdev(sizeof(struct hso_net), "hso%d", NET_NAME_UNKNOWN,
2514 dev_err(&interface->dev, "Unable to create ethernet device\n");
2518 hso_net = netdev_priv(net);
2520 hso_dev->port_data.dev_net = hso_net;
2522 hso_net->parent = hso_dev;
2524 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2526 if (!hso_net->in_endp) {
2527 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2530 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2532 if (!hso_net->out_endp) {
2533 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2536 SET_NETDEV_DEV(net, &interface->dev);
2537 SET_NETDEV_DEVTYPE(net, &hso_type);
2539 /* start allocating */
2540 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2541 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2542 if (!hso_net->mux_bulk_rx_urb_pool[i])
2543 goto err_mux_bulk_rx;
2544 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2546 if (!hso_net->mux_bulk_rx_buf_pool[i])
2547 goto err_mux_bulk_rx;
2549 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2550 if (!hso_net->mux_bulk_tx_urb)
2551 goto err_mux_bulk_rx;
2552 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2553 if (!hso_net->mux_bulk_tx_buf)
2554 goto err_free_tx_urb;
2556 add_net_device(hso_dev);
2558 /* registering our net device */
2559 result = register_netdev(net);
2561 dev_err(&interface->dev, "Failed to register device\n");
2562 goto err_free_tx_buf;
2565 hso_log_port(hso_dev);
2567 hso_create_rfkill(hso_dev, interface);
2572 remove_net_device(hso_dev);
2573 kfree(hso_net->mux_bulk_tx_buf);
2575 usb_free_urb(hso_net->mux_bulk_tx_urb);
2577 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2578 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2579 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2588 static void hso_free_tiomget(struct hso_serial *serial)
2590 struct hso_tiocmget *tiocmget;
2593 tiocmget = serial->tiocmget;
2595 usb_free_urb(tiocmget->urb);
2596 tiocmget->urb = NULL;
2597 serial->tiocmget = NULL;
2602 /* Frees an AT channel ( goes for both mux and non-mux ) */
2603 static void hso_free_serial_device(struct hso_device *hso_dev)
2605 struct hso_serial *serial = dev2ser(hso_dev);
2610 hso_serial_common_free(serial);
2612 if (serial->shared_int) {
2613 mutex_lock(&serial->shared_int->shared_int_lock);
2614 if (--serial->shared_int->ref_count == 0)
2615 hso_free_shared_int(serial->shared_int);
2617 mutex_unlock(&serial->shared_int->shared_int_lock);
2619 hso_free_tiomget(serial);
2624 /* Creates a bulk AT channel */
2625 static struct hso_device *hso_create_bulk_serial_device(
2626 struct usb_interface *interface, int port)
2628 struct hso_device *hso_dev;
2629 struct hso_serial *serial;
2631 struct hso_tiocmget *tiocmget;
2633 hso_dev = hso_create_device(interface, port);
2637 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2641 serial->parent = hso_dev;
2642 hso_dev->port_data.dev_serial = serial;
2644 if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2646 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2648 /* it isn't going to break our heart if serial->tiocmget
2649 * allocation fails don't bother checking this.
2651 if (serial->tiocmget) {
2652 tiocmget = serial->tiocmget;
2653 tiocmget->endp = hso_get_ep(interface,
2654 USB_ENDPOINT_XFER_INT,
2656 if (!tiocmget->endp) {
2657 dev_err(&interface->dev, "Failed to find INT IN ep\n");
2661 tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2662 if (tiocmget->urb) {
2663 mutex_init(&tiocmget->mutex);
2664 init_waitqueue_head(&tiocmget->waitq);
2666 hso_free_tiomget(serial);
2672 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2676 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2678 if (!serial->in_endp) {
2679 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2685 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2686 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2690 serial->write_data = hso_std_serial_write_data;
2692 /* setup the proc dirs and files if needed */
2693 hso_log_port(hso_dev);
2695 /* done, return it */
2699 hso_serial_tty_unregister(serial);
2700 hso_serial_common_free(serial);
2702 hso_free_tiomget(serial);
2708 /* Creates a multiplexed AT channel */
2710 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2712 struct hso_shared_int *mux)
2714 struct hso_device *hso_dev;
2715 struct hso_serial *serial;
2718 port_spec = HSO_INTF_MUX;
2719 port_spec &= ~HSO_PORT_MASK;
2721 port_spec |= hso_mux_to_port(port);
2722 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2725 hso_dev = hso_create_device(interface, port_spec);
2729 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2733 hso_dev->port_data.dev_serial = serial;
2734 serial->parent = hso_dev;
2736 if (hso_serial_common_create
2737 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2738 goto err_free_serial;
2740 serial->tx_data_length--;
2741 serial->write_data = hso_mux_serial_write_data;
2743 serial->shared_int = mux;
2744 mutex_lock(&serial->shared_int->shared_int_lock);
2745 serial->shared_int->ref_count++;
2746 mutex_unlock(&serial->shared_int->shared_int_lock);
2748 /* setup the proc dirs and files if needed */
2749 hso_log_port(hso_dev);
2751 /* done, return it */
2762 static void hso_free_shared_int(struct hso_shared_int *mux)
2764 usb_free_urb(mux->shared_intr_urb);
2765 kfree(mux->shared_intr_buf);
2766 mutex_unlock(&mux->shared_int_lock);
2771 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2773 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2778 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2780 if (!mux->intr_endp) {
2781 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2785 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2786 if (!mux->shared_intr_urb)
2788 mux->shared_intr_buf =
2789 kzalloc(le16_to_cpu(mux->intr_endp->wMaxPacketSize),
2791 if (!mux->shared_intr_buf)
2794 mutex_init(&mux->shared_int_lock);
2799 kfree(mux->shared_intr_buf);
2800 usb_free_urb(mux->shared_intr_urb);
2805 /* Gets the port spec for a certain interface */
2806 static int hso_get_config_data(struct usb_interface *interface)
2808 struct usb_device *usbdev = interface_to_usbdev(interface);
2809 u8 *config_data = kmalloc(17, GFP_KERNEL);
2810 u32 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
2815 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2816 0x86, 0xC0, 0, 0, config_data, 17,
2817 USB_CTRL_SET_TIMEOUT) != 0x11) {
2822 /* check if we have a valid interface */
2828 switch (config_data[if_num]) {
2833 result = HSO_PORT_DIAG;
2836 result = HSO_PORT_GPS;
2839 result = HSO_PORT_GPS_CONTROL;
2842 result = HSO_PORT_APP;
2845 result = HSO_PORT_APP2;
2848 result = HSO_PORT_CONTROL;
2851 result = HSO_PORT_NETWORK;
2854 result = HSO_PORT_MODEM;
2857 result = HSO_PORT_MSD;
2860 result = HSO_PORT_PCSC;
2863 result = HSO_PORT_VOICE;
2870 result |= HSO_INTF_BULK;
2872 if (config_data[16] & 0x1)
2873 result |= HSO_INFO_CRC_BUG;
2879 /* called once for each interface upon device insertion */
2880 static int hso_probe(struct usb_interface *interface,
2881 const struct usb_device_id *id)
2883 int mux, i, if_num, port_spec;
2884 unsigned char port_mask;
2885 struct hso_device *hso_dev = NULL;
2886 struct hso_shared_int *shared_int;
2887 struct hso_device *tmp_dev = NULL;
2889 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2890 dev_err(&interface->dev, "Not our interface\n");
2894 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
2896 /* Get the interface/port specification from either driver_info or from
2897 * the device itself */
2898 if (id->driver_info) {
2899 /* if_num is controlled by the device, driver_info is a 0 terminated
2900 * array. Make sure, the access is in bounds! */
2901 for (i = 0; i <= if_num; ++i)
2902 if (((u32 *)(id->driver_info))[i] == 0)
2904 port_spec = ((u32 *)(id->driver_info))[if_num];
2906 port_spec = hso_get_config_data(interface);
2911 /* Check if we need to switch to alt interfaces prior to port
2913 if (interface->num_altsetting > 1)
2914 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2915 interface->needs_remote_wakeup = 1;
2917 /* Allocate new hso device(s) */
2918 switch (port_spec & HSO_INTF_MASK) {
2920 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2921 /* Create the network device */
2923 hso_dev = hso_create_net_device(interface,
2931 if (hso_get_mux_ports(interface, &port_mask))
2932 /* TODO: de-allocate everything */
2935 shared_int = hso_create_shared_int(interface);
2939 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2940 if (port_mask & i) {
2941 hso_dev = hso_create_mux_serial_device(
2942 interface, i, shared_int);
2953 /* It's a regular bulk interface */
2954 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2957 hso_create_net_device(interface, port_spec);
2960 hso_create_bulk_serial_device(interface, port_spec);
2969 /* save our data pointer in this device */
2970 usb_set_intfdata(interface, hso_dev);
2975 hso_free_interface(interface);
2979 /* device removed, cleaning up */
2980 static void hso_disconnect(struct usb_interface *interface)
2982 hso_free_interface(interface);
2984 /* remove reference of our private data */
2985 usb_set_intfdata(interface, NULL);
2988 static void async_get_intf(struct work_struct *data)
2990 struct hso_device *hso_dev =
2991 container_of(data, struct hso_device, async_get_intf);
2992 usb_autopm_get_interface(hso_dev->interface);
2995 static void async_put_intf(struct work_struct *data)
2997 struct hso_device *hso_dev =
2998 container_of(data, struct hso_device, async_put_intf);
2999 usb_autopm_put_interface(hso_dev->interface);
3002 static int hso_get_activity(struct hso_device *hso_dev)
3004 if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
3005 if (!hso_dev->is_active) {
3006 hso_dev->is_active = 1;
3007 schedule_work(&hso_dev->async_get_intf);
3011 if (hso_dev->usb->state != USB_STATE_CONFIGURED)
3014 usb_mark_last_busy(hso_dev->usb);
3019 static int hso_put_activity(struct hso_device *hso_dev)
3021 if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
3022 if (hso_dev->is_active) {
3023 hso_dev->is_active = 0;
3024 schedule_work(&hso_dev->async_put_intf);
3028 hso_dev->is_active = 0;
3032 /* called by kernel when we need to suspend device */
3033 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3037 /* Stop all serial ports */
3038 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3039 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3040 result = hso_stop_serial_device(serial_table[i]);
3046 /* Stop all network ports */
3047 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3048 if (network_table[i] &&
3049 (network_table[i]->interface == iface)) {
3050 result = hso_stop_net_device(network_table[i]);
3060 /* called by kernel when we need to resume device */
3061 static int hso_resume(struct usb_interface *iface)
3064 struct hso_net *hso_net;
3066 /* Start all serial ports */
3067 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3068 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3069 if (dev2ser(serial_table[i])->port.count) {
3071 hso_start_serial_device(serial_table[i], GFP_NOIO);
3072 hso_kick_transmit(dev2ser(serial_table[i]));
3079 /* Start all network ports */
3080 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3081 if (network_table[i] &&
3082 (network_table[i]->interface == iface)) {
3083 hso_net = dev2net(network_table[i]);
3084 if (hso_net->flags & IFF_UP) {
3085 /* First transmit any lingering data,
3086 then restart the device. */
3087 if (hso_net->skb_tx_buf) {
3088 dev_dbg(&iface->dev,
3090 " lingering data\n");
3091 hso_net_start_xmit(hso_net->skb_tx_buf,
3093 hso_net->skb_tx_buf = NULL;
3095 result = hso_start_net_device(network_table[i]);
3106 static void hso_serial_ref_free(struct kref *ref)
3108 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3110 hso_free_serial_device(hso_dev);
3113 static void hso_free_interface(struct usb_interface *interface)
3115 struct hso_serial *serial;
3118 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3119 if (serial_table[i] &&
3120 (serial_table[i]->interface == interface)) {
3121 serial = dev2ser(serial_table[i]);
3122 tty_port_tty_hangup(&serial->port, false);
3123 mutex_lock(&serial->parent->mutex);
3124 serial->parent->usb_gone = 1;
3125 mutex_unlock(&serial->parent->mutex);
3126 cancel_work_sync(&serial_table[i]->async_put_intf);
3127 cancel_work_sync(&serial_table[i]->async_get_intf);
3128 hso_serial_tty_unregister(serial);
3129 kref_put(&serial->parent->ref, hso_serial_ref_free);
3133 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3134 if (network_table[i] &&
3135 (network_table[i]->interface == interface)) {
3136 struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3137 /* hso_stop_net_device doesn't stop the net queue since
3138 * traffic needs to start it again when suspended */
3139 netif_stop_queue(dev2net(network_table[i])->net);
3140 hso_stop_net_device(network_table[i]);
3141 cancel_work_sync(&network_table[i]->async_put_intf);
3142 cancel_work_sync(&network_table[i]->async_get_intf);
3144 rfkill_unregister(rfk);
3145 rfkill_destroy(rfk);
3147 hso_free_net_device(network_table[i]);
3152 /* Helper functions */
3154 /* Get the endpoint ! */
3155 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3159 struct usb_host_interface *iface = intf->cur_altsetting;
3160 struct usb_endpoint_descriptor *endp;
3162 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3163 endp = &iface->endpoint[i].desc;
3164 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3165 (usb_endpoint_type(endp) == type))
3172 /* Get the byte that describes which ports are enabled */
3173 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3176 struct usb_host_interface *iface = intf->cur_altsetting;
3178 if (iface->extralen == 3) {
3179 *ports = iface->extra[2];
3183 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3184 if (iface->endpoint[i].extralen == 3) {
3185 *ports = iface->endpoint[i].extra[2];
3193 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3194 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3195 struct usb_device *usb, gfp_t gfp)
3199 usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3201 shared_int->intr_endp->bEndpointAddress & 0x7F),
3202 shared_int->shared_intr_buf,
3204 intr_callback, shared_int,
3205 shared_int->intr_endp->bInterval);
3207 result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3209 dev_warn(&usb->dev, "%s failed mux_intr_urb %d\n", __func__,
3215 /* operations setup of the serial interface */
3216 static const struct tty_operations hso_serial_ops = {
3217 .open = hso_serial_open,
3218 .close = hso_serial_close,
3219 .write = hso_serial_write,
3220 .write_room = hso_serial_write_room,
3221 .cleanup = hso_serial_cleanup,
3222 .ioctl = hso_serial_ioctl,
3223 .set_termios = hso_serial_set_termios,
3224 .chars_in_buffer = hso_serial_chars_in_buffer,
3225 .tiocmget = hso_serial_tiocmget,
3226 .tiocmset = hso_serial_tiocmset,
3227 .get_icount = hso_get_count,
3228 .unthrottle = hso_unthrottle
3231 static struct usb_driver hso_driver = {
3232 .name = driver_name,
3234 .disconnect = hso_disconnect,
3235 .id_table = hso_ids,
3236 .suspend = hso_suspend,
3237 .resume = hso_resume,
3238 .reset_resume = hso_resume,
3239 .supports_autosuspend = 1,
3240 .disable_hub_initiated_lpm = 1,
3243 static int __init hso_init(void)
3248 /* put it in the log */
3249 pr_info("%s\n", version);
3251 /* Initialise the serial table semaphore and table */
3252 spin_lock_init(&serial_table_lock);
3253 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3254 serial_table[i] = NULL;
3256 /* allocate our driver using the proper amount of supported minors */
3257 tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
3261 /* fill in all needed values */
3262 tty_drv->driver_name = driver_name;
3263 tty_drv->name = tty_filename;
3265 /* if major number is provided as parameter, use that one */
3267 tty_drv->major = tty_major;
3269 tty_drv->minor_start = 0;
3270 tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3271 tty_drv->subtype = SERIAL_TYPE_NORMAL;
3272 tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
3273 tty_drv->init_termios = tty_std_termios;
3274 hso_init_termios(&tty_drv->init_termios);
3275 tty_set_operations(tty_drv, &hso_serial_ops);
3277 /* register the tty driver */
3278 result = tty_register_driver(tty_drv);
3280 pr_err("%s - tty_register_driver failed(%d)\n",
3285 /* register this module as an usb driver */
3286 result = usb_register(&hso_driver);
3288 pr_err("Could not register hso driver - error: %d\n", result);
3295 tty_unregister_driver(tty_drv);
3297 put_tty_driver(tty_drv);
3301 static void __exit hso_exit(void)
3303 pr_info("unloaded\n");
3305 tty_unregister_driver(tty_drv);
3306 put_tty_driver(tty_drv);
3307 /* deregister the usb driver */
3308 usb_deregister(&hso_driver);
3311 /* Module definitions */
3312 module_init(hso_init);
3313 module_exit(hso_exit);
3315 MODULE_AUTHOR(MOD_AUTHOR);
3316 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3317 MODULE_LICENSE(MOD_LICENSE);
3319 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3320 MODULE_PARM_DESC(debug, "debug level mask [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3321 module_param(debug, int, S_IRUGO | S_IWUSR);
3323 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3324 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3325 module_param(tty_major, int, S_IRUGO | S_IWUSR);
3327 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3328 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3329 module_param(disable_net, int, S_IRUGO | S_IWUSR);