1 /******************************************************************************
3 * Driver for Option High Speed Mobile Devices.
5 * Copyright (C) 2008 Option International
6 * Copyright (C) 2007 Andrew Bird (Sphere Systems Ltd)
7 * <ajb@spheresystems.co.uk>
8 * Copyright (C) 2008 Greg Kroah-Hartman <gregkh@suse.de>
9 * Copyright (C) 2008 Novell, Inc.
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 2 as
13 * published by the Free Software Foundation.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
26 *****************************************************************************/
28 /******************************************************************************
30 * Description of the device:
32 * Interface 0: Contains the IP network interface on the bulk end points.
33 * The multiplexed serial ports are using the interrupt and
35 * Interrupt contains a bitmap telling which multiplexed
36 * serialport needs servicing.
38 * Interface 1: Diagnostics port, uses bulk only, do not submit urbs until the
39 * port is opened, as this have a huge impact on the network port
42 * Interface 2: Standard modem interface - circuit switched interface, should
45 *****************************************************************************/
47 #include <linux/sched.h>
48 #include <linux/slab.h>
49 #include <linux/init.h>
50 #include <linux/delay.h>
51 #include <linux/netdevice.h>
52 #include <linux/module.h>
53 #include <linux/ethtool.h>
54 #include <linux/usb.h>
55 #include <linux/timer.h>
56 #include <linux/tty.h>
57 #include <linux/tty_driver.h>
58 #include <linux/tty_flip.h>
59 #include <linux/kmod.h>
60 #include <linux/rfkill.h>
62 #include <linux/uaccess.h>
63 #include <linux/usb/cdc.h>
65 #include <asm/byteorder.h>
68 #define DRIVER_VERSION "1.2"
69 #define MOD_AUTHOR "Option Wireless"
70 #define MOD_DESCRIPTION "USB High Speed Option driver"
71 #define MOD_LICENSE "GPL"
73 #define HSO_MAX_NET_DEVICES 10
74 #define HSO__MAX_MTU 2048
75 #define DEFAULT_MTU 1500
76 #define DEFAULT_MRU 1500
78 #define CTRL_URB_RX_SIZE 1024
79 #define CTRL_URB_TX_SIZE 64
81 #define BULK_URB_RX_SIZE 4096
82 #define BULK_URB_TX_SIZE 8192
84 #define MUX_BULK_RX_BUF_SIZE HSO__MAX_MTU
85 #define MUX_BULK_TX_BUF_SIZE HSO__MAX_MTU
86 #define MUX_BULK_RX_BUF_COUNT 4
87 #define USB_TYPE_OPTION_VENDOR 0x20
89 /* These definitions are used with the struct hso_net flags element */
90 /* - use *_bit operations on it. (bit indices not values.) */
91 #define HSO_NET_RUNNING 0
93 #define HSO_NET_TX_TIMEOUT (HZ*10)
95 #define HSO_SERIAL_MAGIC 0x48534f31
97 /* Number of ttys to handle */
98 #define HSO_SERIAL_TTY_MINORS 256
100 #define MAX_RX_URBS 2
102 static inline struct hso_serial *get_serial_by_tty(struct tty_struct *tty)
105 return tty->driver_data;
109 /*****************************************************************************/
110 /* Debugging functions */
111 /*****************************************************************************/
112 #define D__(lvl_, fmt, arg...) \
114 printk(lvl_ "[%d:%s]: " fmt "\n", \
115 __LINE__, __func__, ## arg); \
118 #define D_(lvl, args...) \
121 D__(KERN_INFO, args); \
124 #define D1(args...) D_(0x01, ##args)
125 #define D2(args...) D_(0x02, ##args)
126 #define D3(args...) D_(0x04, ##args)
127 #define D4(args...) D_(0x08, ##args)
128 #define D5(args...) D_(0x10, ##args)
130 /*****************************************************************************/
132 /*****************************************************************************/
133 enum pkt_parse_state {
139 /*****************************************************************************/
141 /*****************************************************************************/
143 struct hso_shared_int {
144 struct usb_endpoint_descriptor *intr_endp;
145 void *shared_intr_buf;
146 struct urb *shared_intr_urb;
147 struct usb_device *usb;
150 struct mutex shared_int_lock;
154 struct hso_device *parent;
155 struct net_device *net;
156 struct rfkill *rfkill;
158 struct usb_endpoint_descriptor *in_endp;
159 struct usb_endpoint_descriptor *out_endp;
161 struct urb *mux_bulk_rx_urb_pool[MUX_BULK_RX_BUF_COUNT];
162 struct urb *mux_bulk_tx_urb;
163 void *mux_bulk_rx_buf_pool[MUX_BULK_RX_BUF_COUNT];
164 void *mux_bulk_tx_buf;
166 struct sk_buff *skb_rx_buf;
167 struct sk_buff *skb_tx_buf;
169 enum pkt_parse_state rx_parse_state;
172 unsigned short rx_buf_size;
173 unsigned short rx_buf_missing;
174 struct iphdr rx_ip_hdr;
186 struct hso_device *parent;
190 struct hso_shared_int *shared_int;
192 /* rx/tx urb could be either a bulk urb or a control urb depending
193 on which serial port it is used on. */
194 struct urb *rx_urb[MAX_RX_URBS];
196 u8 *rx_data[MAX_RX_URBS];
197 u16 rx_data_length; /* should contain allocated length */
202 u16 tx_data_length; /* should contain allocated length */
205 struct usb_ctrlrequest ctrl_req_tx;
206 struct usb_ctrlrequest ctrl_req_rx;
208 struct usb_endpoint_descriptor *in_endp;
209 struct usb_endpoint_descriptor *out_endp;
211 enum rx_ctrl_state rx_state;
214 unsigned tx_urb_used:1;
216 /* from usb_serial_port */
217 struct tty_struct *tty;
219 spinlock_t serial_lock;
221 int (*write_data) (struct hso_serial *serial);
222 /* Hacks required to get flow control
223 * working on the serial receive buffers
224 * so as not to drop characters on the floor.
227 u16 curr_rx_urb_offset;
228 u8 rx_urb_filled[MAX_RX_URBS];
229 struct tasklet_struct unthrottle_tasklet;
230 struct work_struct retry_unthrottle_workqueue;
235 struct hso_serial *dev_serial;
236 struct hso_net *dev_net;
243 struct work_struct async_get_intf;
244 struct work_struct async_put_intf;
246 struct usb_device *usb;
247 struct usb_interface *interface;
254 /* Type of interface */
255 #define HSO_INTF_MASK 0xFF00
256 #define HSO_INTF_MUX 0x0100
257 #define HSO_INTF_BULK 0x0200
260 #define HSO_PORT_MASK 0xFF
261 #define HSO_PORT_NO_PORT 0x0
262 #define HSO_PORT_CONTROL 0x1
263 #define HSO_PORT_APP 0x2
264 #define HSO_PORT_GPS 0x3
265 #define HSO_PORT_PCSC 0x4
266 #define HSO_PORT_APP2 0x5
267 #define HSO_PORT_GPS_CONTROL 0x6
268 #define HSO_PORT_MSD 0x7
269 #define HSO_PORT_VOICE 0x8
270 #define HSO_PORT_DIAG2 0x9
271 #define HSO_PORT_DIAG 0x10
272 #define HSO_PORT_MODEM 0x11
273 #define HSO_PORT_NETWORK 0x12
275 /* Additional device info */
276 #define HSO_INFO_MASK 0xFF000000
277 #define HSO_INFO_CRC_BUG 0x01000000
279 /*****************************************************************************/
281 /*****************************************************************************/
282 /* Serial driver functions */
283 static int hso_serial_tiocmset(struct tty_struct *tty, struct file *file,
284 unsigned int set, unsigned int clear);
285 static void ctrl_callback(struct urb *urb);
286 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial);
287 static void hso_kick_transmit(struct hso_serial *serial);
288 /* Helper functions */
289 static int hso_mux_submit_intr_urb(struct hso_shared_int *mux_int,
290 struct usb_device *usb, gfp_t gfp);
291 static void log_usb_status(int status, const char *function);
292 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
294 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports);
295 static void hso_free_interface(struct usb_interface *intf);
296 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags);
297 static int hso_stop_serial_device(struct hso_device *hso_dev);
298 static int hso_start_net_device(struct hso_device *hso_dev);
299 static void hso_free_shared_int(struct hso_shared_int *shared_int);
300 static int hso_stop_net_device(struct hso_device *hso_dev);
301 static void hso_serial_ref_free(struct kref *ref);
302 static void hso_std_serial_read_bulk_callback(struct urb *urb);
303 static int hso_mux_serial_read(struct hso_serial *serial);
304 static void async_get_intf(struct work_struct *data);
305 static void async_put_intf(struct work_struct *data);
306 static int hso_put_activity(struct hso_device *hso_dev);
307 static int hso_get_activity(struct hso_device *hso_dev);
309 /*****************************************************************************/
310 /* Helping functions */
311 /*****************************************************************************/
315 static inline struct hso_net *dev2net(struct hso_device *hso_dev)
317 return hso_dev->port_data.dev_net;
320 static inline struct hso_serial *dev2ser(struct hso_device *hso_dev)
322 return hso_dev->port_data.dev_serial;
325 /* Debugging functions */
327 static void dbg_dump(int line_count, const char *func_name, unsigned char *buf,
330 static char name[255];
332 sprintf(name, "hso[%d:%s]", line_count, func_name);
333 print_hex_dump_bytes(name, DUMP_PREFIX_NONE, buf, len);
336 #define DUMP(buf_, len_) \
337 dbg_dump(__LINE__, __func__, buf_, len_)
339 #define DUMP1(buf_, len_) \
345 #define DUMP(buf_, len_)
346 #define DUMP1(buf_, len_)
349 /* module parameters */
351 static int tty_major;
352 static int disable_net;
355 static const char driver_name[] = "hso";
356 static const char tty_filename[] = "ttyHS";
357 static const char *version = __FILE__ ": " DRIVER_VERSION " " MOD_AUTHOR;
358 /* the usb driver itself (registered in hso_init) */
359 static struct usb_driver hso_driver;
360 /* serial structures */
361 static struct tty_driver *tty_drv;
362 static struct hso_device *serial_table[HSO_SERIAL_TTY_MINORS];
363 static struct hso_device *network_table[HSO_MAX_NET_DEVICES];
364 static spinlock_t serial_table_lock;
365 static struct ktermios *hso_serial_termios[HSO_SERIAL_TTY_MINORS];
366 static struct ktermios *hso_serial_termios_locked[HSO_SERIAL_TTY_MINORS];
368 static const s32 default_port_spec[] = {
369 HSO_INTF_MUX | HSO_PORT_NETWORK,
370 HSO_INTF_BULK | HSO_PORT_DIAG,
371 HSO_INTF_BULK | HSO_PORT_MODEM,
375 static const s32 icon321_port_spec[] = {
376 HSO_INTF_MUX | HSO_PORT_NETWORK,
377 HSO_INTF_BULK | HSO_PORT_DIAG2,
378 HSO_INTF_BULK | HSO_PORT_MODEM,
379 HSO_INTF_BULK | HSO_PORT_DIAG,
383 #define default_port_device(vendor, product) \
384 USB_DEVICE(vendor, product), \
385 .driver_info = (kernel_ulong_t)default_port_spec
387 #define icon321_port_device(vendor, product) \
388 USB_DEVICE(vendor, product), \
389 .driver_info = (kernel_ulong_t)icon321_port_spec
391 /* list of devices we support */
392 static const struct usb_device_id hso_ids[] = {
393 {default_port_device(0x0af0, 0x6711)},
394 {default_port_device(0x0af0, 0x6731)},
395 {default_port_device(0x0af0, 0x6751)},
396 {default_port_device(0x0af0, 0x6771)},
397 {default_port_device(0x0af0, 0x6791)},
398 {default_port_device(0x0af0, 0x6811)},
399 {default_port_device(0x0af0, 0x6911)},
400 {default_port_device(0x0af0, 0x6951)},
401 {default_port_device(0x0af0, 0x6971)},
402 {default_port_device(0x0af0, 0x7011)},
403 {default_port_device(0x0af0, 0x7031)},
404 {default_port_device(0x0af0, 0x7051)},
405 {default_port_device(0x0af0, 0x7071)},
406 {default_port_device(0x0af0, 0x7111)},
407 {default_port_device(0x0af0, 0x7211)},
408 {default_port_device(0x0af0, 0x7251)},
409 {default_port_device(0x0af0, 0x7271)},
410 {default_port_device(0x0af0, 0x7311)},
411 {default_port_device(0x0af0, 0xc031)}, /* Icon-Edge */
412 {icon321_port_device(0x0af0, 0xd013)}, /* Module HSxPA */
413 {icon321_port_device(0x0af0, 0xd031)}, /* Icon-321 */
414 {icon321_port_device(0x0af0, 0xd033)}, /* Icon-322 */
415 {USB_DEVICE(0x0af0, 0x7301)}, /* GE40x */
416 {USB_DEVICE(0x0af0, 0x7361)}, /* GE40x */
417 {USB_DEVICE(0x0af0, 0x7401)}, /* GI 0401 */
418 {USB_DEVICE(0x0af0, 0x7501)}, /* GTM 382 */
419 {USB_DEVICE(0x0af0, 0x7601)}, /* GE40x */
420 {USB_DEVICE(0x0af0, 0x7701)},
421 {USB_DEVICE(0x0af0, 0x7801)},
422 {USB_DEVICE(0x0af0, 0x7901)},
423 {USB_DEVICE(0x0af0, 0x7361)},
424 {icon321_port_device(0x0af0, 0xd051)},
427 MODULE_DEVICE_TABLE(usb, hso_ids);
429 /* Sysfs attribute */
430 static ssize_t hso_sysfs_show_porttype(struct device *dev,
431 struct device_attribute *attr,
434 struct hso_device *hso_dev = dev->driver_data;
440 switch (hso_dev->port_spec & HSO_PORT_MASK) {
441 case HSO_PORT_CONTROL:
442 port_name = "Control";
445 port_name = "Application";
448 port_name = "Application2";
453 case HSO_PORT_GPS_CONTROL:
454 port_name = "GPS Control";
460 port_name = "Diagnostic";
463 port_name = "Diagnostic2";
468 case HSO_PORT_NETWORK:
469 port_name = "Network";
472 port_name = "Unknown";
476 return sprintf(buf, "%s\n", port_name);
478 static DEVICE_ATTR(hsotype, S_IRUGO, hso_sysfs_show_porttype, NULL);
480 static int hso_urb_to_index(struct hso_serial *serial, struct urb *urb)
484 for (idx = 0; idx < serial->num_rx_urbs; idx++)
485 if (serial->rx_urb[idx] == urb)
487 dev_err(serial->parent->dev, "hso_urb_to_index failed\n");
491 /* converts mux value to a port spec value */
492 static u32 hso_mux_to_port(int mux)
498 result = HSO_PORT_CONTROL;
501 result = HSO_PORT_APP;
504 result = HSO_PORT_PCSC;
507 result = HSO_PORT_GPS;
510 result = HSO_PORT_APP2;
513 result = HSO_PORT_NO_PORT;
518 /* converts port spec value to a mux value */
519 static u32 hso_port_to_mux(int port)
523 switch (port & HSO_PORT_MASK) {
524 case HSO_PORT_CONTROL:
545 static struct hso_serial *get_serial_by_shared_int_and_type(
546 struct hso_shared_int *shared_int,
551 port = hso_mux_to_port(mux);
553 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
555 && (dev2ser(serial_table[i])->shared_int == shared_int)
556 && ((serial_table[i]->port_spec & HSO_PORT_MASK) == port)) {
557 return dev2ser(serial_table[i]);
564 static struct hso_serial *get_serial_by_index(unsigned index)
566 struct hso_serial *serial = NULL;
569 spin_lock_irqsave(&serial_table_lock, flags);
570 if (serial_table[index])
571 serial = dev2ser(serial_table[index]);
572 spin_unlock_irqrestore(&serial_table_lock, flags);
577 static int get_free_serial_index(void)
582 spin_lock_irqsave(&serial_table_lock, flags);
583 for (index = 0; index < HSO_SERIAL_TTY_MINORS; index++) {
584 if (serial_table[index] == NULL) {
585 spin_unlock_irqrestore(&serial_table_lock, flags);
589 spin_unlock_irqrestore(&serial_table_lock, flags);
591 printk(KERN_ERR "%s: no free serial devices in table\n", __func__);
595 static void set_serial_by_index(unsigned index, struct hso_serial *serial)
599 spin_lock_irqsave(&serial_table_lock, flags);
601 serial_table[index] = serial->parent;
603 serial_table[index] = NULL;
604 spin_unlock_irqrestore(&serial_table_lock, flags);
607 /* log a meaningful explanation of an USB status */
608 static void log_usb_status(int status, const char *function)
614 explanation = "no device";
617 explanation = "endpoint not enabled";
620 explanation = "endpoint stalled";
623 explanation = "not enough bandwidth";
626 explanation = "device disabled";
629 explanation = "device suspended";
635 explanation = "internal error";
638 explanation = "unknown status";
641 D1("%s: received USB status - %s (%d)", function, explanation, status);
644 /* Network interface functions */
646 /* called when net interface is brought up by ifconfig */
647 static int hso_net_open(struct net_device *net)
649 struct hso_net *odev = netdev_priv(net);
650 unsigned long flags = 0;
653 dev_err(&net->dev, "No net device !\n");
657 odev->skb_tx_buf = NULL;
659 /* setup environment */
660 spin_lock_irqsave(&odev->net_lock, flags);
661 odev->rx_parse_state = WAIT_IP;
662 odev->rx_buf_size = 0;
663 odev->rx_buf_missing = sizeof(struct iphdr);
664 spin_unlock_irqrestore(&odev->net_lock, flags);
666 hso_start_net_device(odev->parent);
668 /* We are up and running. */
669 set_bit(HSO_NET_RUNNING, &odev->flags);
671 /* Tell the kernel we are ready to start receiving from it */
672 netif_start_queue(net);
677 /* called when interface is brought down by ifconfig */
678 static int hso_net_close(struct net_device *net)
680 struct hso_net *odev = netdev_priv(net);
682 /* we don't need the queue anymore */
683 netif_stop_queue(net);
684 /* no longer running */
685 clear_bit(HSO_NET_RUNNING, &odev->flags);
687 hso_stop_net_device(odev->parent);
693 /* USB tells is xmit done, we should start the netqueue again */
694 static void write_bulk_callback(struct urb *urb)
696 struct hso_net *odev = urb->context;
697 int status = urb->status;
700 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
701 dev_err(&urb->dev->dev, "%s: device not running\n", __func__);
705 /* Do we still have a valid kernel network device? */
706 if (!netif_device_present(odev->net)) {
707 dev_err(&urb->dev->dev, "%s: net device not present\n",
712 /* log status, but don't act on it, we don't need to resubmit anything
715 log_usb_status(status, __func__);
717 hso_put_activity(odev->parent);
719 /* Tell the network interface we are ready for another frame */
720 netif_wake_queue(odev->net);
723 /* called by kernel when we need to transmit a packet */
724 static int hso_net_start_xmit(struct sk_buff *skb, struct net_device *net)
726 struct hso_net *odev = netdev_priv(net);
729 /* Tell the kernel, "No more frames 'til we are done with this one." */
730 netif_stop_queue(net);
731 if (hso_get_activity(odev->parent) == -EAGAIN) {
732 odev->skb_tx_buf = skb;
737 DUMP1(skb->data, skb->len);
738 /* Copy it from kernel memory to OUR memory */
739 memcpy(odev->mux_bulk_tx_buf, skb->data, skb->len);
740 D1("len: %d/%d", skb->len, MUX_BULK_TX_BUF_SIZE);
742 /* Fill in the URB for shipping it out. */
743 usb_fill_bulk_urb(odev->mux_bulk_tx_urb,
745 usb_sndbulkpipe(odev->parent->usb,
747 bEndpointAddress & 0x7F),
748 odev->mux_bulk_tx_buf, skb->len, write_bulk_callback,
751 /* Deal with the Zero Length packet problem, I hope */
752 odev->mux_bulk_tx_urb->transfer_flags |= URB_ZERO_PACKET;
754 /* Send the URB on its merry way. */
755 result = usb_submit_urb(odev->mux_bulk_tx_urb, GFP_ATOMIC);
757 dev_warn(&odev->parent->interface->dev,
758 "failed mux_bulk_tx_urb %d", result);
759 net->stats.tx_errors++;
760 netif_start_queue(net);
762 net->stats.tx_packets++;
763 net->stats.tx_bytes += skb->len;
764 /* And tell the kernel when the last transmit started. */
765 net->trans_start = jiffies;
772 static void hso_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *info)
774 struct hso_net *odev = netdev_priv(net);
776 strncpy(info->driver, driver_name, ETHTOOL_BUSINFO_LEN);
777 strncpy(info->version, DRIVER_VERSION, ETHTOOL_BUSINFO_LEN);
778 usb_make_path(odev->parent->usb, info->bus_info, sizeof info->bus_info);
781 static struct ethtool_ops ops = {
782 .get_drvinfo = hso_get_drvinfo,
783 .get_link = ethtool_op_get_link
786 /* called when a packet did not ack after watchdogtimeout */
787 static void hso_net_tx_timeout(struct net_device *net)
789 struct hso_net *odev = netdev_priv(net);
794 /* Tell syslog we are hosed. */
795 dev_warn(&net->dev, "Tx timed out.\n");
797 /* Tear the waiting frame off the list */
798 if (odev->mux_bulk_tx_urb
799 && (odev->mux_bulk_tx_urb->status == -EINPROGRESS))
800 usb_unlink_urb(odev->mux_bulk_tx_urb);
802 /* Update statistics */
803 net->stats.tx_errors++;
806 /* make a real packet from the received USB buffer */
807 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt,
808 unsigned int count, unsigned char is_eop)
810 unsigned short temp_bytes;
811 unsigned short buffer_offset = 0;
812 unsigned short frame_len;
813 unsigned char *tmp_rx_buf;
816 D1("Rx %d bytes", count);
817 DUMP(ip_pkt, min(128, (int)count));
820 switch (odev->rx_parse_state) {
822 /* waiting for IP header. */
823 /* wanted bytes - size of ip header */
826 odev->rx_buf_missing) ? count : odev->
829 memcpy(((unsigned char *)(&odev->rx_ip_hdr)) +
830 odev->rx_buf_size, ip_pkt + buffer_offset,
833 odev->rx_buf_size += temp_bytes;
834 buffer_offset += temp_bytes;
835 odev->rx_buf_missing -= temp_bytes;
838 if (!odev->rx_buf_missing) {
839 /* header is complete allocate an sk_buffer and
840 * continue to WAIT_DATA */
841 frame_len = ntohs(odev->rx_ip_hdr.tot_len);
843 if ((frame_len > DEFAULT_MRU) ||
844 (frame_len < sizeof(struct iphdr))) {
845 dev_err(&odev->net->dev,
846 "Invalid frame (%d) length\n",
848 odev->rx_parse_state = WAIT_SYNC;
851 /* Allocate an sk_buff */
852 odev->skb_rx_buf = dev_alloc_skb(frame_len);
853 if (!odev->skb_rx_buf) {
854 /* We got no receive buffer. */
855 D1("could not allocate memory");
856 odev->rx_parse_state = WAIT_SYNC;
859 /* Here's where it came from */
860 odev->skb_rx_buf->dev = odev->net;
862 /* Copy what we got so far. make room for iphdr
865 skb_put(odev->skb_rx_buf,
866 sizeof(struct iphdr));
867 memcpy(tmp_rx_buf, (char *)&(odev->rx_ip_hdr),
868 sizeof(struct iphdr));
871 odev->rx_buf_size = sizeof(struct iphdr);
873 /* Filip actually use .tot_len */
874 odev->rx_buf_missing =
875 frame_len - sizeof(struct iphdr);
876 odev->rx_parse_state = WAIT_DATA;
881 temp_bytes = (count < odev->rx_buf_missing)
882 ? count : odev->rx_buf_missing;
884 /* Copy the rest of the bytes that are left in the
885 * buffer into the waiting sk_buf. */
886 /* Make room for temp_bytes after tail. */
887 tmp_rx_buf = skb_put(odev->skb_rx_buf, temp_bytes);
888 memcpy(tmp_rx_buf, ip_pkt + buffer_offset, temp_bytes);
890 odev->rx_buf_missing -= temp_bytes;
892 buffer_offset += temp_bytes;
893 odev->rx_buf_size += temp_bytes;
894 if (!odev->rx_buf_missing) {
895 /* Packet is complete. Inject into stack. */
896 /* We have IP packet here */
897 odev->skb_rx_buf->protocol =
898 __constant_htons(ETH_P_IP);
900 odev->skb_rx_buf->ip_summed =
901 CHECKSUM_UNNECESSARY;
903 skb_reset_mac_header(odev->skb_rx_buf);
905 /* Ship it off to the kernel */
906 netif_rx(odev->skb_rx_buf);
907 /* No longer our buffer. */
908 odev->skb_rx_buf = NULL;
910 /* update out statistics */
911 odev->net->stats.rx_packets++;
913 odev->net->stats.rx_bytes += odev->rx_buf_size;
915 odev->rx_buf_size = 0;
916 odev->rx_buf_missing = sizeof(struct iphdr);
917 odev->rx_parse_state = WAIT_IP;
932 /* Recovery mechanism for WAIT_SYNC state. */
934 if (odev->rx_parse_state == WAIT_SYNC) {
935 odev->rx_parse_state = WAIT_IP;
936 odev->rx_buf_size = 0;
937 odev->rx_buf_missing = sizeof(struct iphdr);
942 /* Moving data from usb to kernel (in interrupt state) */
943 static void read_bulk_callback(struct urb *urb)
945 struct hso_net *odev = urb->context;
946 struct net_device *net;
948 int status = urb->status;
950 /* is al ok? (Filip: Who's Al ?) */
952 log_usb_status(status, __func__);
957 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
958 D1("BULK IN callback but driver is not active!");
961 usb_mark_last_busy(urb->dev);
965 if (!netif_device_present(net)) {
966 /* Somebody killed our network interface... */
970 if (odev->parent->port_spec & HSO_INFO_CRC_BUG) {
972 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
973 rest = urb->actual_length % odev->in_endp->wMaxPacketSize;
974 if (((rest == 5) || (rest == 6))
975 && !memcmp(((u8 *) urb->transfer_buffer) +
976 urb->actual_length - 4, crc_check, 4)) {
977 urb->actual_length -= 4;
981 /* do we even have a packet? */
982 if (urb->actual_length) {
983 /* Handle the IP stream, add header and push it onto network
984 * stack if the packet is complete. */
985 spin_lock(&odev->net_lock);
986 packetizeRx(odev, urb->transfer_buffer, urb->actual_length,
987 (urb->transfer_buffer_length >
988 urb->actual_length) ? 1 : 0);
989 spin_unlock(&odev->net_lock);
992 /* We are done with this URB, resubmit it. Prep the USB to wait for
993 * another frame. Reuse same as received. */
994 usb_fill_bulk_urb(urb,
996 usb_rcvbulkpipe(odev->parent->usb,
998 bEndpointAddress & 0x7F),
999 urb->transfer_buffer, MUX_BULK_RX_BUF_SIZE,
1000 read_bulk_callback, odev);
1002 /* Give this to the USB subsystem so it can tell us when more data
1004 result = usb_submit_urb(urb, GFP_ATOMIC);
1006 dev_warn(&odev->parent->interface->dev,
1007 "%s failed submit mux_bulk_rx_urb %d", __func__,
1011 /* Serial driver functions */
1013 static void _hso_serial_set_termios(struct tty_struct *tty,
1014 struct ktermios *old)
1016 struct hso_serial *serial = get_serial_by_tty(tty);
1017 struct ktermios *termios;
1019 if ((!tty) || (!tty->termios) || (!serial)) {
1020 printk(KERN_ERR "%s: no tty structures", __func__);
1024 D4("port %d", serial->minor);
1027 * The default requirements for this device are:
1029 termios = tty->termios;
1031 ~(IGNBRK /* disable ignore break */
1032 | BRKINT /* disable break causes interrupt */
1033 | PARMRK /* disable mark parity errors */
1034 | ISTRIP /* disable clear high bit of input characters */
1035 | INLCR /* disable translate NL to CR */
1036 | IGNCR /* disable ignore CR */
1037 | ICRNL /* disable translate CR to NL */
1038 | IXON); /* disable enable XON/XOFF flow control */
1040 /* disable postprocess output characters */
1041 termios->c_oflag &= ~OPOST;
1044 ~(ECHO /* disable echo input characters */
1045 | ECHONL /* disable echo new line */
1046 | ICANON /* disable erase, kill, werase, and rprnt
1047 special characters */
1048 | ISIG /* disable interrupt, quit, and suspend special
1050 | IEXTEN); /* disable non-POSIX special characters */
1053 ~(CSIZE /* no size */
1054 | PARENB /* disable parity bit */
1055 | CBAUD /* clear current baud rate */
1056 | CBAUDEX); /* clear current buad rate */
1058 termios->c_cflag |= CS8; /* character size 8 bits */
1060 /* baud rate 115200 */
1061 tty_encode_baud_rate(serial->tty, 115200, 115200);
1064 * Force low_latency on; otherwise the pushes are scheduled;
1065 * this is bad as it opens up the possibility of dropping bytes
1066 * on the floor. We don't want to drop bytes on the floor. :)
1068 serial->tty->low_latency = 1;
1072 static void hso_resubmit_rx_bulk_urb(struct hso_serial *serial, struct urb *urb)
1075 #ifdef CONFIG_HSO_AUTOPM
1076 usb_mark_last_busy(urb->dev);
1078 /* We are done with this URB, resubmit it. Prep the USB to wait for
1080 usb_fill_bulk_urb(urb, serial->parent->usb,
1081 usb_rcvbulkpipe(serial->parent->usb,
1083 bEndpointAddress & 0x7F),
1084 urb->transfer_buffer, serial->rx_data_length,
1085 hso_std_serial_read_bulk_callback, serial);
1086 /* Give this to the USB subsystem so it can tell us when more data
1088 result = usb_submit_urb(urb, GFP_ATOMIC);
1090 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1098 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1101 struct urb *curr_urb;
1103 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1104 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1105 count = put_rxbuf_data(curr_urb, serial);
1109 serial->curr_rx_urb_idx++;
1110 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1111 serial->curr_rx_urb_idx = 0;
1112 hso_resubmit_rx_bulk_urb(serial, curr_urb);
1117 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1122 urb = serial->rx_urb[0];
1123 if (serial->open_count > 0) {
1124 count = put_rxbuf_data(urb, serial);
1128 /* Re issue a read as long as we receive data. */
1130 if (count == 0 && ((urb->actual_length != 0) ||
1131 (serial->rx_state == RX_PENDING))) {
1132 serial->rx_state = RX_SENT;
1133 hso_mux_serial_read(serial);
1135 serial->rx_state = RX_IDLE;
1139 /* read callback for Diag and CS port */
1140 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1142 struct hso_serial *serial = urb->context;
1143 int status = urb->status;
1147 D1("serial == NULL");
1149 } else if (status) {
1150 log_usb_status(status, __func__);
1154 D4("\n--- Got serial_read_bulk callback %02x ---", status);
1155 D1("Actual length = %d\n", urb->actual_length);
1156 DUMP1(urb->transfer_buffer, urb->actual_length);
1158 /* Anyone listening? */
1159 if (serial->open_count == 0)
1163 if (serial->parent->port_spec & HSO_INFO_CRC_BUG) {
1165 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1167 urb->actual_length %
1168 serial->in_endp->wMaxPacketSize;
1169 if (((rest == 5) || (rest == 6))
1170 && !memcmp(((u8 *) urb->transfer_buffer) +
1171 urb->actual_length - 4, crc_check, 4)) {
1172 urb->actual_length -= 4;
1175 /* Valid data, handle RX data */
1176 spin_lock(&serial->serial_lock);
1177 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1178 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1179 spin_unlock(&serial->serial_lock);
1180 } else if (status == -ENOENT || status == -ECONNRESET) {
1181 /* Unlinked - check for throttled port. */
1182 D2("Port %d, successfully unlinked urb", serial->minor);
1183 spin_lock(&serial->serial_lock);
1184 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
1185 hso_resubmit_rx_bulk_urb(serial, urb);
1186 spin_unlock(&serial->serial_lock);
1188 D2("Port %d, status = %d for read urb", serial->minor, status);
1194 * This needs to be a tasklet otherwise we will
1195 * end up recursively calling this function.
1197 void hso_unthrottle_tasklet(struct hso_serial *serial)
1199 unsigned long flags;
1201 spin_lock_irqsave(&serial->serial_lock, flags);
1202 if ((serial->parent->port_spec & HSO_INTF_MUX))
1203 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1205 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1206 spin_unlock_irqrestore(&serial->serial_lock, flags);
1209 static void hso_unthrottle(struct tty_struct *tty)
1211 struct hso_serial *serial = get_serial_by_tty(tty);
1213 tasklet_hi_schedule(&serial->unthrottle_tasklet);
1216 void hso_unthrottle_workfunc(struct work_struct *work)
1218 struct hso_serial *serial =
1219 container_of(work, struct hso_serial,
1220 retry_unthrottle_workqueue);
1221 hso_unthrottle_tasklet(serial);
1224 /* open the requested serial port */
1225 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1227 struct hso_serial *serial = get_serial_by_index(tty->index);
1231 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1232 tty->driver_data = NULL;
1233 D1("Failed to open port");
1237 mutex_lock(&serial->parent->mutex);
1238 /* check for port already opened, if not set the termios */
1239 /* The serial->open count needs to be here as hso_serial_close
1240 * will be called even if hso_serial_open returns -ENODEV.
1242 serial->open_count++;
1243 result = usb_autopm_get_interface(serial->parent->interface);
1247 D1("Opening %d", serial->minor);
1248 kref_get(&serial->parent->ref);
1251 tty->driver_data = serial;
1254 if (serial->open_count == 1) {
1255 tty->low_latency = 1;
1256 serial->rx_state = RX_IDLE;
1257 /* Force default termio settings */
1258 _hso_serial_set_termios(tty, NULL);
1259 tasklet_init(&serial->unthrottle_tasklet,
1260 (void (*)(unsigned long))hso_unthrottle_tasklet,
1261 (unsigned long)serial);
1262 INIT_WORK(&serial->retry_unthrottle_workqueue,
1263 hso_unthrottle_workfunc);
1264 result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1266 hso_stop_serial_device(serial->parent);
1267 serial->open_count--;
1268 kref_put(&serial->parent->ref, hso_serial_ref_free);
1271 D1("Port was already open");
1274 usb_autopm_put_interface(serial->parent->interface);
1278 hso_serial_tiocmset(tty, NULL, TIOCM_RTS | TIOCM_DTR, 0);
1280 mutex_unlock(&serial->parent->mutex);
1284 /* close the requested serial port */
1285 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1287 struct hso_serial *serial = tty->driver_data;
1290 D1("Closing serial port");
1291 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1292 D1("invalid serial structure bailing out.\n");
1296 mutex_lock(&serial->parent->mutex);
1297 usb_gone = serial->parent->usb_gone;
1300 usb_autopm_get_interface(serial->parent->interface);
1302 /* reset the rts and dtr */
1303 /* do the actual close */
1304 serial->open_count--;
1305 kref_put(&serial->parent->ref, hso_serial_ref_free);
1306 if (serial->open_count <= 0) {
1307 serial->open_count = 0;
1309 serial->tty->driver_data = NULL;
1313 hso_stop_serial_device(serial->parent);
1314 tasklet_kill(&serial->unthrottle_tasklet);
1315 cancel_work_sync(&serial->retry_unthrottle_workqueue);
1319 usb_autopm_put_interface(serial->parent->interface);
1321 mutex_unlock(&serial->parent->mutex);
1324 /* close the requested serial port */
1325 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1328 struct hso_serial *serial = get_serial_by_tty(tty);
1329 int space, tx_bytes;
1330 unsigned long flags;
1333 if (serial == NULL) {
1334 printk(KERN_ERR "%s: serial is NULL\n", __func__);
1338 spin_lock_irqsave(&serial->serial_lock, flags);
1340 space = serial->tx_data_length - serial->tx_buffer_count;
1341 tx_bytes = (count < space) ? count : space;
1346 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1347 serial->tx_buffer_count += tx_bytes;
1350 spin_unlock_irqrestore(&serial->serial_lock, flags);
1352 hso_kick_transmit(serial);
1357 /* how much room is there for writing */
1358 static int hso_serial_write_room(struct tty_struct *tty)
1360 struct hso_serial *serial = get_serial_by_tty(tty);
1362 unsigned long flags;
1364 spin_lock_irqsave(&serial->serial_lock, flags);
1365 room = serial->tx_data_length - serial->tx_buffer_count;
1366 spin_unlock_irqrestore(&serial->serial_lock, flags);
1368 /* return free room */
1372 /* setup the term */
1373 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1375 struct hso_serial *serial = get_serial_by_tty(tty);
1376 unsigned long flags;
1379 D5("Termios called with: cflags new[%d] - old[%d]",
1380 tty->termios->c_cflag, old->c_cflag);
1382 /* the actual setup */
1383 spin_lock_irqsave(&serial->serial_lock, flags);
1384 if (serial->open_count)
1385 _hso_serial_set_termios(tty, old);
1388 spin_unlock_irqrestore(&serial->serial_lock, flags);
1394 /* how many characters in the buffer */
1395 static int hso_serial_chars_in_buffer(struct tty_struct *tty)
1397 struct hso_serial *serial = get_serial_by_tty(tty);
1399 unsigned long flags;
1405 spin_lock_irqsave(&serial->serial_lock, flags);
1406 chars = serial->tx_buffer_count;
1407 spin_unlock_irqrestore(&serial->serial_lock, flags);
1412 static int hso_serial_tiocmget(struct tty_struct *tty, struct file *file)
1415 struct hso_serial *serial = get_serial_by_tty(tty);
1416 unsigned long flags;
1420 D1("no tty structures");
1424 spin_lock_irqsave(&serial->serial_lock, flags);
1425 value = ((serial->rts_state) ? TIOCM_RTS : 0) |
1426 ((serial->dtr_state) ? TIOCM_DTR : 0);
1427 spin_unlock_irqrestore(&serial->serial_lock, flags);
1432 static int hso_serial_tiocmset(struct tty_struct *tty, struct file *file,
1433 unsigned int set, unsigned int clear)
1436 unsigned long flags;
1438 struct hso_serial *serial = get_serial_by_tty(tty);
1442 D1("no tty structures");
1445 if_num = serial->parent->interface->altsetting->desc.bInterfaceNumber;
1447 spin_lock_irqsave(&serial->serial_lock, flags);
1448 if (set & TIOCM_RTS)
1449 serial->rts_state = 1;
1450 if (set & TIOCM_DTR)
1451 serial->dtr_state = 1;
1453 if (clear & TIOCM_RTS)
1454 serial->rts_state = 0;
1455 if (clear & TIOCM_DTR)
1456 serial->dtr_state = 0;
1458 if (serial->dtr_state)
1460 if (serial->rts_state)
1463 spin_unlock_irqrestore(&serial->serial_lock, flags);
1465 return usb_control_msg(serial->parent->usb,
1466 usb_rcvctrlpipe(serial->parent->usb, 0), 0x22,
1467 0x21, val, if_num, NULL, 0,
1468 USB_CTRL_SET_TIMEOUT);
1471 /* starts a transmit */
1472 static void hso_kick_transmit(struct hso_serial *serial)
1475 unsigned long flags;
1478 spin_lock_irqsave(&serial->serial_lock, flags);
1479 if (!serial->tx_buffer_count)
1482 if (serial->tx_urb_used)
1485 /* Wakeup USB interface if necessary */
1486 if (hso_get_activity(serial->parent) == -EAGAIN)
1489 /* Switch pointers around to avoid memcpy */
1490 temp = serial->tx_buffer;
1491 serial->tx_buffer = serial->tx_data;
1492 serial->tx_data = temp;
1493 serial->tx_data_count = serial->tx_buffer_count;
1494 serial->tx_buffer_count = 0;
1496 /* If temp is set, it means we switched buffers */
1497 if (temp && serial->write_data) {
1498 res = serial->write_data(serial);
1500 serial->tx_urb_used = 1;
1503 spin_unlock_irqrestore(&serial->serial_lock, flags);
1506 /* make a request (for reading and writing data to muxed serial port) */
1507 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1508 struct urb *ctrl_urb,
1509 struct usb_ctrlrequest *ctrl_req,
1510 u8 *ctrl_urb_data, u32 size)
1516 if (!serial || !ctrl_urb || !ctrl_req) {
1517 printk(KERN_ERR "%s: Wrong arguments\n", __func__);
1522 ctrl_req->wValue = 0;
1523 ctrl_req->wIndex = hso_port_to_mux(port);
1524 ctrl_req->wLength = size;
1526 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1527 /* Reading command */
1528 ctrl_req->bRequestType = USB_DIR_IN |
1529 USB_TYPE_OPTION_VENDOR |
1530 USB_RECIP_INTERFACE;
1531 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1532 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1534 /* Writing command */
1535 ctrl_req->bRequestType = USB_DIR_OUT |
1536 USB_TYPE_OPTION_VENDOR |
1537 USB_RECIP_INTERFACE;
1538 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1539 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1542 D2("%s command (%02x) len: %d, port: %d",
1543 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1544 ctrl_req->bRequestType, ctrl_req->wLength, port);
1547 ctrl_urb->transfer_flags = 0;
1548 usb_fill_control_urb(ctrl_urb,
1549 serial->parent->usb,
1552 ctrl_urb_data, size, ctrl_callback, serial);
1553 /* Send it on merry way */
1554 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1556 dev_err(&ctrl_urb->dev->dev,
1557 "%s failed submit ctrl_urb %d type %d", __func__,
1566 /* called by intr_callback when read occurs */
1567 static int hso_mux_serial_read(struct hso_serial *serial)
1573 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1574 /* make the request */
1576 if (serial->num_rx_urbs != 1) {
1577 dev_err(&serial->parent->interface->dev,
1578 "ERROR: mux'd reads with multiple buffers "
1582 return mux_device_request(serial,
1583 USB_CDC_GET_ENCAPSULATED_RESPONSE,
1584 serial->parent->port_spec & HSO_PORT_MASK,
1586 &serial->ctrl_req_rx,
1587 serial->rx_data[0], serial->rx_data_length);
1590 /* used for muxed serial port callback (muxed serial read) */
1591 static void intr_callback(struct urb *urb)
1593 struct hso_shared_int *shared_int = urb->context;
1594 struct hso_serial *serial;
1595 unsigned char *port_req;
1596 int status = urb->status;
1599 usb_mark_last_busy(urb->dev);
1607 log_usb_status(status, __func__);
1610 D4("\n--- Got intr callback 0x%02X ---", status);
1613 port_req = urb->transfer_buffer;
1614 D4(" port_req = 0x%.2X\n", *port_req);
1615 /* loop over all muxed ports to find the one sending this */
1616 for (i = 0; i < 8; i++) {
1617 /* max 8 channels on MUX */
1618 if (*port_req & (1 << i)) {
1619 serial = get_serial_by_shared_int_and_type(shared_int,
1621 if (serial != NULL) {
1622 D1("Pending read interrupt on port %d\n", i);
1623 spin_lock(&serial->serial_lock);
1624 if (serial->rx_state == RX_IDLE) {
1625 /* Setup and send a ctrl req read on
1627 if (!serial->rx_urb_filled[0]) {
1628 serial->rx_state = RX_SENT;
1629 hso_mux_serial_read(serial);
1631 serial->rx_state = RX_PENDING;
1634 D1("Already pending a read on "
1637 spin_unlock(&serial->serial_lock);
1641 /* Resubmit interrupt urb */
1642 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1645 /* called for writing to muxed serial port */
1646 static int hso_mux_serial_write_data(struct hso_serial *serial)
1651 return mux_device_request(serial,
1652 USB_CDC_SEND_ENCAPSULATED_COMMAND,
1653 serial->parent->port_spec & HSO_PORT_MASK,
1655 &serial->ctrl_req_tx,
1656 serial->tx_data, serial->tx_data_count);
1659 /* write callback for Diag and CS port */
1660 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1662 struct hso_serial *serial = urb->context;
1663 int status = urb->status;
1667 D1("serial == NULL");
1671 spin_lock(&serial->serial_lock);
1672 serial->tx_urb_used = 0;
1673 spin_unlock(&serial->serial_lock);
1675 log_usb_status(status, __func__);
1678 hso_put_activity(serial->parent);
1680 tty_wakeup(serial->tty);
1681 hso_kick_transmit(serial);
1687 /* called for writing diag or CS serial port */
1688 static int hso_std_serial_write_data(struct hso_serial *serial)
1690 int count = serial->tx_data_count;
1693 usb_fill_bulk_urb(serial->tx_urb,
1694 serial->parent->usb,
1695 usb_sndbulkpipe(serial->parent->usb,
1697 bEndpointAddress & 0x7F),
1698 serial->tx_data, serial->tx_data_count,
1699 hso_std_serial_write_bulk_callback, serial);
1701 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
1703 dev_warn(&serial->parent->usb->dev,
1704 "Failed to submit urb - res %d\n", result);
1711 /* callback after read or write on muxed serial port */
1712 static void ctrl_callback(struct urb *urb)
1714 struct hso_serial *serial = urb->context;
1715 struct usb_ctrlrequest *req;
1716 int status = urb->status;
1722 spin_lock(&serial->serial_lock);
1723 serial->tx_urb_used = 0;
1724 spin_unlock(&serial->serial_lock);
1726 log_usb_status(status, __func__);
1731 req = (struct usb_ctrlrequest *)(urb->setup_packet);
1732 D4("\n--- Got muxed ctrl callback 0x%02X ---", status);
1733 D4("Actual length of urb = %d\n", urb->actual_length);
1734 DUMP1(urb->transfer_buffer, urb->actual_length);
1736 if (req->bRequestType ==
1737 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
1738 /* response to a read command */
1739 serial->rx_urb_filled[0] = 1;
1740 spin_lock(&serial->serial_lock);
1741 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1742 spin_unlock(&serial->serial_lock);
1744 hso_put_activity(serial->parent);
1746 tty_wakeup(serial->tty);
1747 /* response to a write command */
1748 hso_kick_transmit(serial);
1752 /* handle RX data for serial port */
1753 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
1755 struct tty_struct *tty = serial->tty;
1756 int write_length_remaining = 0;
1759 if (urb == NULL || serial == NULL) {
1760 D1("serial = NULL");
1764 /* Push data to tty */
1766 write_length_remaining = urb->actual_length -
1767 serial->curr_rx_urb_offset;
1768 D1("data to push to tty");
1769 while (write_length_remaining) {
1770 if (test_bit(TTY_THROTTLED, &tty->flags))
1772 curr_write_len = tty_insert_flip_string
1773 (tty, urb->transfer_buffer +
1774 serial->curr_rx_urb_offset,
1775 write_length_remaining);
1776 serial->curr_rx_urb_offset += curr_write_len;
1777 write_length_remaining -= curr_write_len;
1778 tty_flip_buffer_push(tty);
1781 if (write_length_remaining == 0) {
1782 serial->curr_rx_urb_offset = 0;
1783 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
1785 return write_length_remaining;
1789 /* Base driver functions */
1791 static void hso_log_port(struct hso_device *hso_dev)
1796 switch (hso_dev->port_spec & HSO_PORT_MASK) {
1797 case HSO_PORT_CONTROL:
1798 port_type = "Control";
1801 port_type = "Application";
1806 case HSO_PORT_GPS_CONTROL:
1807 port_type = "GPS control";
1810 port_type = "Application2";
1816 port_type = "Diagnostic";
1818 case HSO_PORT_DIAG2:
1819 port_type = "Diagnostic2";
1821 case HSO_PORT_MODEM:
1822 port_type = "Modem";
1824 case HSO_PORT_NETWORK:
1825 port_type = "Network";
1828 port_type = "Unknown";
1831 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
1832 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
1834 sprintf(port_dev, "/dev/%s%d", tty_filename,
1835 dev2ser(hso_dev)->minor);
1837 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
1838 port_type, port_dev);
1841 static int hso_start_net_device(struct hso_device *hso_dev)
1844 struct hso_net *hso_net = dev2net(hso_dev);
1849 /* send URBs for all read buffers */
1850 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
1852 /* Prep a receive URB */
1853 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
1855 usb_rcvbulkpipe(hso_dev->usb,
1857 bEndpointAddress & 0x7F),
1858 hso_net->mux_bulk_rx_buf_pool[i],
1859 MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
1862 /* Put it out there so the device can send us stuff */
1863 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
1866 dev_warn(&hso_dev->usb->dev,
1867 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
1874 static int hso_stop_net_device(struct hso_device *hso_dev)
1877 struct hso_net *hso_net = dev2net(hso_dev);
1882 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
1883 if (hso_net->mux_bulk_rx_urb_pool[i])
1884 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
1887 if (hso_net->mux_bulk_tx_urb)
1888 usb_kill_urb(hso_net->mux_bulk_tx_urb);
1893 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
1896 struct hso_serial *serial = dev2ser(hso_dev);
1901 /* If it is not the MUX port fill in and submit a bulk urb (already
1902 * allocated in hso_serial_start) */
1903 if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
1904 for (i = 0; i < serial->num_rx_urbs; i++) {
1905 usb_fill_bulk_urb(serial->rx_urb[i],
1906 serial->parent->usb,
1907 usb_rcvbulkpipe(serial->parent->usb,
1912 serial->rx_data_length,
1913 hso_std_serial_read_bulk_callback,
1915 result = usb_submit_urb(serial->rx_urb[i], flags);
1917 dev_warn(&serial->parent->usb->dev,
1918 "Failed to submit urb - res %d\n",
1924 mutex_lock(&serial->shared_int->shared_int_lock);
1925 if (!serial->shared_int->use_count) {
1927 hso_mux_submit_intr_urb(serial->shared_int,
1928 hso_dev->usb, flags);
1930 serial->shared_int->use_count++;
1931 mutex_unlock(&serial->shared_int->shared_int_lock);
1937 static int hso_stop_serial_device(struct hso_device *hso_dev)
1940 struct hso_serial *serial = dev2ser(hso_dev);
1945 for (i = 0; i < serial->num_rx_urbs; i++) {
1946 if (serial->rx_urb[i]) {
1947 usb_kill_urb(serial->rx_urb[i]);
1948 serial->rx_urb_filled[i] = 0;
1951 serial->curr_rx_urb_idx = 0;
1952 serial->curr_rx_urb_offset = 0;
1955 usb_kill_urb(serial->tx_urb);
1957 if (serial->shared_int) {
1958 mutex_lock(&serial->shared_int->shared_int_lock);
1959 if (serial->shared_int->use_count &&
1960 (--serial->shared_int->use_count == 0)) {
1963 urb = serial->shared_int->shared_intr_urb;
1967 mutex_unlock(&serial->shared_int->shared_int_lock);
1973 static void hso_serial_common_free(struct hso_serial *serial)
1977 if (serial->parent->dev)
1978 device_remove_file(serial->parent->dev, &dev_attr_hsotype);
1980 tty_unregister_device(tty_drv, serial->minor);
1982 for (i = 0; i < serial->num_rx_urbs; i++) {
1983 /* unlink and free RX URB */
1984 usb_free_urb(serial->rx_urb[i]);
1985 /* free the RX buffer */
1986 kfree(serial->rx_data[i]);
1989 /* unlink and free TX URB */
1990 usb_free_urb(serial->tx_urb);
1991 kfree(serial->tx_data);
1994 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
1995 int rx_size, int tx_size)
2001 minor = get_free_serial_index();
2005 /* register our minor number */
2006 serial->parent->dev = tty_register_device(tty_drv, minor,
2007 &serial->parent->interface->dev);
2008 dev = serial->parent->dev;
2009 dev->driver_data = serial->parent;
2010 i = device_create_file(dev, &dev_attr_hsotype);
2012 /* fill in specific data for later use */
2013 serial->minor = minor;
2014 serial->magic = HSO_SERIAL_MAGIC;
2015 spin_lock_init(&serial->serial_lock);
2016 serial->num_rx_urbs = num_urbs;
2018 /* RX, allocate urb and initialize */
2020 /* prepare our RX buffer */
2021 serial->rx_data_length = rx_size;
2022 for (i = 0; i < serial->num_rx_urbs; i++) {
2023 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2024 if (!serial->rx_urb[i]) {
2025 dev_err(dev, "Could not allocate urb?\n");
2028 serial->rx_urb[i]->transfer_buffer = NULL;
2029 serial->rx_urb[i]->transfer_buffer_length = 0;
2030 serial->rx_data[i] = kzalloc(serial->rx_data_length,
2032 if (!serial->rx_data[i]) {
2033 dev_err(dev, "%s - Out of memory\n", __func__);
2038 /* TX, allocate urb and initialize */
2039 serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2040 if (!serial->tx_urb) {
2041 dev_err(dev, "Could not allocate urb?\n");
2044 serial->tx_urb->transfer_buffer = NULL;
2045 serial->tx_urb->transfer_buffer_length = 0;
2046 /* prepare our TX buffer */
2047 serial->tx_data_count = 0;
2048 serial->tx_buffer_count = 0;
2049 serial->tx_data_length = tx_size;
2050 serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2051 if (!serial->tx_data) {
2052 dev_err(dev, "%s - Out of memory", __func__);
2055 serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2056 if (!serial->tx_buffer) {
2057 dev_err(dev, "%s - Out of memory", __func__);
2063 hso_serial_common_free(serial);
2067 /* Frees a general hso device */
2068 static void hso_free_device(struct hso_device *hso_dev)
2073 /* Creates a general hso device */
2074 static struct hso_device *hso_create_device(struct usb_interface *intf,
2077 struct hso_device *hso_dev;
2079 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2083 hso_dev->port_spec = port_spec;
2084 hso_dev->usb = interface_to_usbdev(intf);
2085 hso_dev->interface = intf;
2086 kref_init(&hso_dev->ref);
2087 mutex_init(&hso_dev->mutex);
2089 INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2090 INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2095 /* Removes a network device in the network device table */
2096 static int remove_net_device(struct hso_device *hso_dev)
2100 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2101 if (network_table[i] == hso_dev) {
2102 network_table[i] = NULL;
2106 if (i == HSO_MAX_NET_DEVICES)
2111 /* Frees our network device */
2112 static void hso_free_net_device(struct hso_device *hso_dev)
2115 struct hso_net *hso_net = dev2net(hso_dev);
2121 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2122 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2123 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2125 usb_free_urb(hso_net->mux_bulk_tx_urb);
2126 kfree(hso_net->mux_bulk_tx_buf);
2128 remove_net_device(hso_net->parent);
2131 unregister_netdev(hso_net->net);
2132 free_netdev(hso_net->net);
2135 hso_free_device(hso_dev);
2138 /* initialize the network interface */
2139 static void hso_net_init(struct net_device *net)
2141 struct hso_net *hso_net = netdev_priv(net);
2143 D1("sizeof hso_net is %d", (int)sizeof(*hso_net));
2145 /* fill in the other fields */
2146 net->open = hso_net_open;
2147 net->stop = hso_net_close;
2148 net->hard_start_xmit = hso_net_start_xmit;
2149 net->tx_timeout = hso_net_tx_timeout;
2150 net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2151 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2152 net->type = ARPHRD_NONE;
2153 net->mtu = DEFAULT_MTU - 14;
2154 net->tx_queue_len = 10;
2155 SET_ETHTOOL_OPS(net, &ops);
2157 /* and initialize the semaphore */
2158 spin_lock_init(&hso_net->net_lock);
2161 /* Adds a network device in the network device table */
2162 static int add_net_device(struct hso_device *hso_dev)
2166 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2167 if (network_table[i] == NULL) {
2168 network_table[i] = hso_dev;
2172 if (i == HSO_MAX_NET_DEVICES)
2177 static int hso_radio_toggle(void *data, enum rfkill_state state)
2179 struct hso_device *hso_dev = data;
2180 int enabled = (state == RFKILL_STATE_ON);
2183 mutex_lock(&hso_dev->mutex);
2184 if (hso_dev->usb_gone)
2187 rv = usb_control_msg(hso_dev->usb, usb_rcvctrlpipe(hso_dev->usb, 0),
2188 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2189 USB_CTRL_SET_TIMEOUT);
2190 mutex_unlock(&hso_dev->mutex);
2194 /* Creates and sets up everything for rfkill */
2195 static void hso_create_rfkill(struct hso_device *hso_dev,
2196 struct usb_interface *interface)
2198 struct hso_net *hso_net = dev2net(hso_dev);
2199 struct device *dev = &hso_net->net->dev;
2202 hso_net->rfkill = rfkill_allocate(&interface_to_usbdev(interface)->dev,
2204 if (!hso_net->rfkill) {
2205 dev_err(dev, "%s - Out of memory\n", __func__);
2208 rfkn = kzalloc(20, GFP_KERNEL);
2210 rfkill_free(hso_net->rfkill);
2211 hso_net->rfkill = NULL;
2212 dev_err(dev, "%s - Out of memory\n", __func__);
2215 snprintf(rfkn, 20, "hso-%d",
2216 interface->altsetting->desc.bInterfaceNumber);
2217 hso_net->rfkill->name = rfkn;
2218 hso_net->rfkill->state = RFKILL_STATE_ON;
2219 hso_net->rfkill->data = hso_dev;
2220 hso_net->rfkill->toggle_radio = hso_radio_toggle;
2221 if (rfkill_register(hso_net->rfkill) < 0) {
2223 hso_net->rfkill->name = NULL;
2224 rfkill_free(hso_net->rfkill);
2225 hso_net->rfkill = NULL;
2226 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2231 /* Creates our network device */
2232 static struct hso_device *hso_create_net_device(struct usb_interface *interface)
2235 struct net_device *net;
2236 struct hso_net *hso_net;
2237 struct hso_device *hso_dev;
2239 hso_dev = hso_create_device(interface, HSO_INTF_MUX | HSO_PORT_NETWORK);
2243 /* allocate our network device, then we can put in our private data */
2244 /* call hso_net_init to do the basic initialization */
2245 net = alloc_netdev(sizeof(struct hso_net), "hso%d", hso_net_init);
2247 dev_err(&interface->dev, "Unable to create ethernet device\n");
2251 hso_net = netdev_priv(net);
2253 hso_dev->port_data.dev_net = hso_net;
2255 hso_net->parent = hso_dev;
2257 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2259 if (!hso_net->in_endp) {
2260 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2263 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2265 if (!hso_net->out_endp) {
2266 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2269 SET_NETDEV_DEV(net, &interface->dev);
2271 /* registering our net device */
2272 result = register_netdev(net);
2274 dev_err(&interface->dev, "Failed to register device\n");
2278 /* start allocating */
2279 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2280 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2281 if (!hso_net->mux_bulk_rx_urb_pool[i]) {
2282 dev_err(&interface->dev, "Could not allocate rx urb\n");
2285 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2287 if (!hso_net->mux_bulk_rx_buf_pool[i]) {
2288 dev_err(&interface->dev, "Could not allocate rx buf\n");
2292 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2293 if (!hso_net->mux_bulk_tx_urb) {
2294 dev_err(&interface->dev, "Could not allocate tx urb\n");
2297 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2298 if (!hso_net->mux_bulk_tx_buf) {
2299 dev_err(&interface->dev, "Could not allocate tx buf\n");
2303 add_net_device(hso_dev);
2305 hso_log_port(hso_dev);
2307 hso_create_rfkill(hso_dev, interface);
2311 hso_free_net_device(hso_dev);
2315 /* Frees an AT channel ( goes for both mux and non-mux ) */
2316 static void hso_free_serial_device(struct hso_device *hso_dev)
2318 struct hso_serial *serial = dev2ser(hso_dev);
2322 set_serial_by_index(serial->minor, NULL);
2324 hso_serial_common_free(serial);
2326 if (serial->shared_int) {
2327 mutex_lock(&serial->shared_int->shared_int_lock);
2328 if (--serial->shared_int->ref_count == 0)
2329 hso_free_shared_int(serial->shared_int);
2331 mutex_unlock(&serial->shared_int->shared_int_lock);
2334 hso_free_device(hso_dev);
2337 /* Creates a bulk AT channel */
2338 static struct hso_device *hso_create_bulk_serial_device(
2339 struct usb_interface *interface, int port)
2341 struct hso_device *hso_dev;
2342 struct hso_serial *serial;
2345 hso_dev = hso_create_device(interface, port);
2349 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2353 serial->parent = hso_dev;
2354 hso_dev->port_data.dev_serial = serial;
2356 if (port & HSO_PORT_MODEM)
2361 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2365 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2367 if (!serial->in_endp) {
2368 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2374 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2375 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2379 serial->write_data = hso_std_serial_write_data;
2381 /* and record this serial */
2382 set_serial_by_index(serial->minor, serial);
2384 /* setup the proc dirs and files if needed */
2385 hso_log_port(hso_dev);
2387 /* done, return it */
2391 hso_serial_common_free(serial);
2394 hso_free_device(hso_dev);
2398 /* Creates a multiplexed AT channel */
2400 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2402 struct hso_shared_int *mux)
2404 struct hso_device *hso_dev;
2405 struct hso_serial *serial;
2408 port_spec = HSO_INTF_MUX;
2409 port_spec &= ~HSO_PORT_MASK;
2411 port_spec |= hso_mux_to_port(port);
2412 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2415 hso_dev = hso_create_device(interface, port_spec);
2419 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2423 hso_dev->port_data.dev_serial = serial;
2424 serial->parent = hso_dev;
2426 if (hso_serial_common_create
2427 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2430 serial->tx_data_length--;
2431 serial->write_data = hso_mux_serial_write_data;
2433 serial->shared_int = mux;
2434 mutex_lock(&serial->shared_int->shared_int_lock);
2435 serial->shared_int->ref_count++;
2436 mutex_unlock(&serial->shared_int->shared_int_lock);
2438 /* and record this serial */
2439 set_serial_by_index(serial->minor, serial);
2441 /* setup the proc dirs and files if needed */
2442 hso_log_port(hso_dev);
2444 /* done, return it */
2449 tty_unregister_device(tty_drv, serial->minor);
2453 hso_free_device(hso_dev);
2458 static void hso_free_shared_int(struct hso_shared_int *mux)
2460 usb_free_urb(mux->shared_intr_urb);
2461 kfree(mux->shared_intr_buf);
2462 mutex_unlock(&mux->shared_int_lock);
2467 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2469 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2474 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2476 if (!mux->intr_endp) {
2477 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2481 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2482 if (!mux->shared_intr_urb) {
2483 dev_err(&interface->dev, "Could not allocate intr urb?");
2486 mux->shared_intr_buf = kzalloc(mux->intr_endp->wMaxPacketSize,
2488 if (!mux->shared_intr_buf) {
2489 dev_err(&interface->dev, "Could not allocate intr buf?");
2493 mutex_init(&mux->shared_int_lock);
2498 kfree(mux->shared_intr_buf);
2499 usb_free_urb(mux->shared_intr_urb);
2504 /* Gets the port spec for a certain interface */
2505 static int hso_get_config_data(struct usb_interface *interface)
2507 struct usb_device *usbdev = interface_to_usbdev(interface);
2509 u32 if_num = interface->altsetting->desc.bInterfaceNumber;
2512 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2513 0x86, 0xC0, 0, 0, config_data, 17,
2514 USB_CTRL_SET_TIMEOUT) != 0x11) {
2518 switch (config_data[if_num]) {
2523 result = HSO_PORT_DIAG;
2526 result = HSO_PORT_GPS;
2529 result = HSO_PORT_GPS_CONTROL;
2532 result = HSO_PORT_APP;
2535 result = HSO_PORT_APP2;
2538 result = HSO_PORT_CONTROL;
2541 result = HSO_PORT_NETWORK;
2544 result = HSO_PORT_MODEM;
2547 result = HSO_PORT_MSD;
2550 result = HSO_PORT_PCSC;
2553 result = HSO_PORT_VOICE;
2560 result |= HSO_INTF_BULK;
2562 if (config_data[16] & 0x1)
2563 result |= HSO_INFO_CRC_BUG;
2568 /* called once for each interface upon device insertion */
2569 static int hso_probe(struct usb_interface *interface,
2570 const struct usb_device_id *id)
2572 int mux, i, if_num, port_spec;
2573 unsigned char port_mask;
2574 struct hso_device *hso_dev = NULL;
2575 struct hso_shared_int *shared_int;
2576 struct hso_device *tmp_dev = NULL;
2578 if_num = interface->altsetting->desc.bInterfaceNumber;
2580 /* Get the interface/port specification from either driver_info or from
2581 * the device itself */
2582 if (id->driver_info)
2583 port_spec = ((u32 *)(id->driver_info))[if_num];
2585 port_spec = hso_get_config_data(interface);
2587 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2588 dev_err(&interface->dev, "Not our interface\n");
2591 /* Check if we need to switch to alt interfaces prior to port
2593 if (interface->num_altsetting > 1)
2594 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2595 interface->needs_remote_wakeup = 1;
2597 /* Allocate new hso device(s) */
2598 switch (port_spec & HSO_INTF_MASK) {
2600 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2601 /* Create the network device */
2603 hso_dev = hso_create_net_device(interface);
2610 if (hso_get_mux_ports(interface, &port_mask))
2611 /* TODO: de-allocate everything */
2614 shared_int = hso_create_shared_int(interface);
2618 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2619 if (port_mask & i) {
2620 hso_dev = hso_create_mux_serial_device(
2621 interface, i, shared_int);
2632 /* It's a regular bulk interface */
2633 if (((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK)
2635 hso_dev = hso_create_net_device(interface);
2638 hso_create_bulk_serial_device(interface, port_spec);
2646 usb_driver_claim_interface(&hso_driver, interface, hso_dev);
2648 /* save our data pointer in this device */
2649 usb_set_intfdata(interface, hso_dev);
2654 hso_free_interface(interface);
2658 /* device removed, cleaning up */
2659 static void hso_disconnect(struct usb_interface *interface)
2661 hso_free_interface(interface);
2663 /* remove reference of our private data */
2664 usb_set_intfdata(interface, NULL);
2666 usb_driver_release_interface(&hso_driver, interface);
2669 static void async_get_intf(struct work_struct *data)
2671 struct hso_device *hso_dev =
2672 container_of(data, struct hso_device, async_get_intf);
2673 usb_autopm_get_interface(hso_dev->interface);
2676 static void async_put_intf(struct work_struct *data)
2678 struct hso_device *hso_dev =
2679 container_of(data, struct hso_device, async_put_intf);
2680 usb_autopm_put_interface(hso_dev->interface);
2683 static int hso_get_activity(struct hso_device *hso_dev)
2685 if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
2686 if (!hso_dev->is_active) {
2687 hso_dev->is_active = 1;
2688 schedule_work(&hso_dev->async_get_intf);
2692 if (hso_dev->usb->state != USB_STATE_CONFIGURED)
2695 usb_mark_last_busy(hso_dev->usb);
2700 static int hso_put_activity(struct hso_device *hso_dev)
2702 if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
2703 if (hso_dev->is_active) {
2704 hso_dev->is_active = 0;
2705 schedule_work(&hso_dev->async_put_intf);
2709 hso_dev->is_active = 0;
2713 /* called by kernel when we need to suspend device */
2714 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
2718 /* Stop all serial ports */
2719 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
2720 if (serial_table[i] && (serial_table[i]->interface == iface)) {
2721 result = hso_stop_serial_device(serial_table[i]);
2727 /* Stop all network ports */
2728 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2729 if (network_table[i] &&
2730 (network_table[i]->interface == iface)) {
2731 result = hso_stop_net_device(network_table[i]);
2741 /* called by kernel when we need to resume device */
2742 static int hso_resume(struct usb_interface *iface)
2745 struct hso_net *hso_net;
2747 /* Start all serial ports */
2748 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
2749 if (serial_table[i] && (serial_table[i]->interface == iface)) {
2750 if (dev2ser(serial_table[i])->open_count) {
2752 hso_start_serial_device(serial_table[i], GFP_NOIO);
2753 hso_kick_transmit(dev2ser(serial_table[i]));
2760 /* Start all network ports */
2761 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2762 if (network_table[i] &&
2763 (network_table[i]->interface == iface)) {
2764 hso_net = dev2net(network_table[i]);
2765 /* First transmit any lingering data, then restart the
2767 if (hso_net->skb_tx_buf) {
2768 dev_dbg(&iface->dev,
2769 "Transmitting lingering data\n");
2770 hso_net_start_xmit(hso_net->skb_tx_buf,
2772 hso_net->skb_tx_buf = NULL;
2774 result = hso_start_net_device(network_table[i]);
2784 static void hso_serial_ref_free(struct kref *ref)
2786 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
2788 hso_free_serial_device(hso_dev);
2791 static void hso_free_interface(struct usb_interface *interface)
2793 struct hso_serial *hso_dev;
2796 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
2798 && (serial_table[i]->interface == interface)) {
2799 hso_dev = dev2ser(serial_table[i]);
2801 tty_hangup(hso_dev->tty);
2802 mutex_lock(&hso_dev->parent->mutex);
2803 hso_dev->parent->usb_gone = 1;
2804 mutex_unlock(&hso_dev->parent->mutex);
2805 kref_put(&serial_table[i]->ref, hso_serial_ref_free);
2809 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2810 if (network_table[i]
2811 && (network_table[i]->interface == interface)) {
2812 struct rfkill *rfk = dev2net(network_table[i])->rfkill;
2813 /* hso_stop_net_device doesn't stop the net queue since
2814 * traffic needs to start it again when suspended */
2815 netif_stop_queue(dev2net(network_table[i])->net);
2816 hso_stop_net_device(network_table[i]);
2817 cancel_work_sync(&network_table[i]->async_put_intf);
2818 cancel_work_sync(&network_table[i]->async_get_intf);
2820 rfkill_unregister(rfk);
2821 hso_free_net_device(network_table[i]);
2826 /* Helper functions */
2828 /* Get the endpoint ! */
2829 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
2833 struct usb_host_interface *iface = intf->cur_altsetting;
2834 struct usb_endpoint_descriptor *endp;
2836 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
2837 endp = &iface->endpoint[i].desc;
2838 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
2839 ((endp->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == type))
2846 /* Get the byte that describes which ports are enabled */
2847 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
2850 struct usb_host_interface *iface = intf->cur_altsetting;
2852 if (iface->extralen == 3) {
2853 *ports = iface->extra[2];
2857 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
2858 if (iface->endpoint[i].extralen == 3) {
2859 *ports = iface->endpoint[i].extra[2];
2867 /* interrupt urb needs to be submitted, used for serial read of muxed port */
2868 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
2869 struct usb_device *usb, gfp_t gfp)
2873 usb_fill_int_urb(shared_int->shared_intr_urb, usb,
2875 shared_int->intr_endp->bEndpointAddress & 0x7F),
2876 shared_int->shared_intr_buf,
2877 shared_int->intr_endp->wMaxPacketSize,
2878 intr_callback, shared_int,
2879 shared_int->intr_endp->bInterval);
2881 result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
2883 dev_warn(&usb->dev, "%s failed mux_intr_urb %d", __func__,
2889 /* operations setup of the serial interface */
2890 static const struct tty_operations hso_serial_ops = {
2891 .open = hso_serial_open,
2892 .close = hso_serial_close,
2893 .write = hso_serial_write,
2894 .write_room = hso_serial_write_room,
2895 .set_termios = hso_serial_set_termios,
2896 .chars_in_buffer = hso_serial_chars_in_buffer,
2897 .tiocmget = hso_serial_tiocmget,
2898 .tiocmset = hso_serial_tiocmset,
2899 .unthrottle = hso_unthrottle
2902 static struct usb_driver hso_driver = {
2903 .name = driver_name,
2905 .disconnect = hso_disconnect,
2906 .id_table = hso_ids,
2907 .suspend = hso_suspend,
2908 .resume = hso_resume,
2909 .supports_autosuspend = 1,
2912 static int __init hso_init(void)
2917 /* put it in the log */
2918 printk(KERN_INFO "hso: %s\n", version);
2920 /* Initialise the serial table semaphore and table */
2921 spin_lock_init(&serial_table_lock);
2922 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
2923 serial_table[i] = NULL;
2925 /* allocate our driver using the proper amount of supported minors */
2926 tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
2930 /* fill in all needed values */
2931 tty_drv->magic = TTY_DRIVER_MAGIC;
2932 tty_drv->owner = THIS_MODULE;
2933 tty_drv->driver_name = driver_name;
2934 tty_drv->name = tty_filename;
2936 /* if major number is provided as parameter, use that one */
2938 tty_drv->major = tty_major;
2940 tty_drv->minor_start = 0;
2941 tty_drv->num = HSO_SERIAL_TTY_MINORS;
2942 tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
2943 tty_drv->subtype = SERIAL_TYPE_NORMAL;
2944 tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
2945 tty_drv->init_termios = tty_std_termios;
2946 tty_drv->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
2947 tty_drv->termios = hso_serial_termios;
2948 tty_drv->termios_locked = hso_serial_termios_locked;
2949 tty_set_operations(tty_drv, &hso_serial_ops);
2951 /* register the tty driver */
2952 result = tty_register_driver(tty_drv);
2954 printk(KERN_ERR "%s - tty_register_driver failed(%d)\n",
2959 /* register this module as an usb driver */
2960 result = usb_register(&hso_driver);
2962 printk(KERN_ERR "Could not register hso driver? error: %d\n",
2964 /* cleanup serial interface */
2965 tty_unregister_driver(tty_drv);
2973 static void __exit hso_exit(void)
2975 printk(KERN_INFO "hso: unloaded\n");
2977 tty_unregister_driver(tty_drv);
2978 /* deregister the usb driver */
2979 usb_deregister(&hso_driver);
2982 /* Module definitions */
2983 module_init(hso_init);
2984 module_exit(hso_exit);
2986 MODULE_AUTHOR(MOD_AUTHOR);
2987 MODULE_DESCRIPTION(MOD_DESCRIPTION);
2988 MODULE_LICENSE(MOD_LICENSE);
2989 MODULE_INFO(Version, DRIVER_VERSION);
2991 /* change the debug level (eg: insmod hso.ko debug=0x04) */
2992 MODULE_PARM_DESC(debug, "Level of debug [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
2993 module_param(debug, int, S_IRUGO | S_IWUSR);
2995 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
2996 MODULE_PARM_DESC(tty_major, "Set the major tty number");
2997 module_param(tty_major, int, S_IRUGO | S_IWUSR);
2999 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3000 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3001 module_param(disable_net, int, S_IRUGO | S_IWUSR);