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 * Copyright (C) 2007 Andrew Bird (Sphere Systems Ltd)
9 * <ajb@spheresystems.co.uk>
10 * Copyright (C) 2008 Greg Kroah-Hartman <gregkh@suse.de>
11 * Copyright (C) 2008 Novell, Inc.
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License version 2 as
15 * published by the Free Software Foundation.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
28 *****************************************************************************/
30 /******************************************************************************
32 * Description of the device:
34 * Interface 0: Contains the IP network interface on the bulk end points.
35 * The multiplexed serial ports are using the interrupt and
37 * Interrupt contains a bitmap telling which multiplexed
38 * serialport needs servicing.
40 * Interface 1: Diagnostics port, uses bulk only, do not submit urbs until the
41 * port is opened, as this have a huge impact on the network port
44 * Interface 2: Standard modem interface - circuit switched interface, this
45 * can be used to make a standard ppp connection however it
46 * should not be used in conjunction with the IP network interface
47 * enabled for USB performance reasons i.e. if using this set
48 * ideally disable_net=1.
50 *****************************************************************************/
52 #include <linux/sched.h>
53 #include <linux/slab.h>
54 #include <linux/init.h>
55 #include <linux/delay.h>
56 #include <linux/netdevice.h>
57 #include <linux/module.h>
58 #include <linux/ethtool.h>
59 #include <linux/usb.h>
60 #include <linux/timer.h>
61 #include <linux/tty.h>
62 #include <linux/tty_driver.h>
63 #include <linux/tty_flip.h>
64 #include <linux/kmod.h>
65 #include <linux/rfkill.h>
67 #include <linux/uaccess.h>
68 #include <linux/usb/cdc.h>
70 #include <asm/byteorder.h>
71 #include <linux/serial_core.h>
72 #include <linux/serial.h>
75 #define DRIVER_VERSION "1.2"
76 #define MOD_AUTHOR "Option Wireless"
77 #define MOD_DESCRIPTION "USB High Speed Option driver"
78 #define MOD_LICENSE "GPL"
80 #define HSO_MAX_NET_DEVICES 10
81 #define HSO__MAX_MTU 2048
82 #define DEFAULT_MTU 1500
83 #define DEFAULT_MRU 1500
85 #define CTRL_URB_RX_SIZE 1024
86 #define CTRL_URB_TX_SIZE 64
88 #define BULK_URB_RX_SIZE 4096
89 #define BULK_URB_TX_SIZE 8192
91 #define MUX_BULK_RX_BUF_SIZE HSO__MAX_MTU
92 #define MUX_BULK_TX_BUF_SIZE HSO__MAX_MTU
93 #define MUX_BULK_RX_BUF_COUNT 4
94 #define USB_TYPE_OPTION_VENDOR 0x20
96 /* These definitions are used with the struct hso_net flags element */
97 /* - use *_bit operations on it. (bit indices not values.) */
98 #define HSO_NET_RUNNING 0
100 #define HSO_NET_TX_TIMEOUT (HZ*10)
102 #define HSO_SERIAL_MAGIC 0x48534f31
104 /* Number of ttys to handle */
105 #define HSO_SERIAL_TTY_MINORS 256
107 #define MAX_RX_URBS 2
109 static inline struct hso_serial *get_serial_by_tty(struct tty_struct *tty)
112 return tty->driver_data;
116 /*****************************************************************************/
117 /* Debugging functions */
118 /*****************************************************************************/
119 #define D__(lvl_, fmt, arg...) \
121 printk(lvl_ "[%d:%s]: " fmt "\n", \
122 __LINE__, __func__, ## arg); \
125 #define D_(lvl, args...) \
128 D__(KERN_INFO, args); \
131 #define D1(args...) D_(0x01, ##args)
132 #define D2(args...) D_(0x02, ##args)
133 #define D3(args...) D_(0x04, ##args)
134 #define D4(args...) D_(0x08, ##args)
135 #define D5(args...) D_(0x10, ##args)
137 /*****************************************************************************/
139 /*****************************************************************************/
140 enum pkt_parse_state {
146 /*****************************************************************************/
148 /*****************************************************************************/
150 struct hso_shared_int {
151 struct usb_endpoint_descriptor *intr_endp;
152 void *shared_intr_buf;
153 struct urb *shared_intr_urb;
154 struct usb_device *usb;
157 struct mutex shared_int_lock;
161 struct hso_device *parent;
162 struct net_device *net;
163 struct rfkill *rfkill;
165 struct usb_endpoint_descriptor *in_endp;
166 struct usb_endpoint_descriptor *out_endp;
168 struct urb *mux_bulk_rx_urb_pool[MUX_BULK_RX_BUF_COUNT];
169 struct urb *mux_bulk_tx_urb;
170 void *mux_bulk_rx_buf_pool[MUX_BULK_RX_BUF_COUNT];
171 void *mux_bulk_tx_buf;
173 struct sk_buff *skb_rx_buf;
174 struct sk_buff *skb_tx_buf;
176 enum pkt_parse_state rx_parse_state;
179 unsigned short rx_buf_size;
180 unsigned short rx_buf_missing;
181 struct iphdr rx_ip_hdr;
192 #define BM_REQUEST_TYPE (0xa1)
193 #define B_NOTIFICATION (0x20)
194 #define W_VALUE (0x0)
195 #define W_INDEX (0x2)
196 #define W_LENGTH (0x2)
198 #define B_OVERRUN (0x1<<6)
199 #define B_PARITY (0x1<<5)
200 #define B_FRAMING (0x1<<4)
201 #define B_RING_SIGNAL (0x1<<3)
202 #define B_BREAK (0x1<<2)
203 #define B_TX_CARRIER (0x1<<1)
204 #define B_RX_CARRIER (0x1<<0)
206 struct hso_serial_state_notification {
212 u16 UART_state_bitmap;
213 } __attribute__((packed));
215 struct hso_tiocmget {
217 wait_queue_head_t waitq;
219 struct usb_endpoint_descriptor *endp;
221 struct hso_serial_state_notification serial_state_notification;
222 u16 prev_UART_state_bitmap;
223 struct uart_icount icount;
228 struct hso_device *parent;
232 struct hso_shared_int *shared_int;
234 /* rx/tx urb could be either a bulk urb or a control urb depending
235 on which serial port it is used on. */
236 struct urb *rx_urb[MAX_RX_URBS];
238 u8 *rx_data[MAX_RX_URBS];
239 u16 rx_data_length; /* should contain allocated length */
244 u16 tx_data_length; /* should contain allocated length */
247 struct usb_ctrlrequest ctrl_req_tx;
248 struct usb_ctrlrequest ctrl_req_rx;
250 struct usb_endpoint_descriptor *in_endp;
251 struct usb_endpoint_descriptor *out_endp;
253 enum rx_ctrl_state rx_state;
256 unsigned tx_urb_used:1;
258 /* from usb_serial_port */
259 struct tty_struct *tty;
261 spinlock_t serial_lock;
263 int (*write_data) (struct hso_serial *serial);
264 struct hso_tiocmget *tiocmget;
265 /* Hacks required to get flow control
266 * working on the serial receive buffers
267 * so as not to drop characters on the floor.
270 u16 curr_rx_urb_offset;
271 u8 rx_urb_filled[MAX_RX_URBS];
272 struct tasklet_struct unthrottle_tasklet;
273 struct work_struct retry_unthrottle_workqueue;
278 struct hso_serial *dev_serial;
279 struct hso_net *dev_net;
286 struct work_struct async_get_intf;
287 struct work_struct async_put_intf;
289 struct usb_device *usb;
290 struct usb_interface *interface;
297 /* Type of interface */
298 #define HSO_INTF_MASK 0xFF00
299 #define HSO_INTF_MUX 0x0100
300 #define HSO_INTF_BULK 0x0200
303 #define HSO_PORT_MASK 0xFF
304 #define HSO_PORT_NO_PORT 0x0
305 #define HSO_PORT_CONTROL 0x1
306 #define HSO_PORT_APP 0x2
307 #define HSO_PORT_GPS 0x3
308 #define HSO_PORT_PCSC 0x4
309 #define HSO_PORT_APP2 0x5
310 #define HSO_PORT_GPS_CONTROL 0x6
311 #define HSO_PORT_MSD 0x7
312 #define HSO_PORT_VOICE 0x8
313 #define HSO_PORT_DIAG2 0x9
314 #define HSO_PORT_DIAG 0x10
315 #define HSO_PORT_MODEM 0x11
316 #define HSO_PORT_NETWORK 0x12
318 /* Additional device info */
319 #define HSO_INFO_MASK 0xFF000000
320 #define HSO_INFO_CRC_BUG 0x01000000
322 /*****************************************************************************/
324 /*****************************************************************************/
325 /* Serial driver functions */
326 static int hso_serial_tiocmset(struct tty_struct *tty, struct file *file,
327 unsigned int set, unsigned int clear);
328 static void ctrl_callback(struct urb *urb);
329 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial);
330 static void hso_kick_transmit(struct hso_serial *serial);
331 /* Helper functions */
332 static int hso_mux_submit_intr_urb(struct hso_shared_int *mux_int,
333 struct usb_device *usb, gfp_t gfp);
334 static void log_usb_status(int status, const char *function);
335 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
337 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports);
338 static void hso_free_interface(struct usb_interface *intf);
339 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags);
340 static int hso_stop_serial_device(struct hso_device *hso_dev);
341 static int hso_start_net_device(struct hso_device *hso_dev);
342 static void hso_free_shared_int(struct hso_shared_int *shared_int);
343 static int hso_stop_net_device(struct hso_device *hso_dev);
344 static void hso_serial_ref_free(struct kref *ref);
345 static void hso_std_serial_read_bulk_callback(struct urb *urb);
346 static int hso_mux_serial_read(struct hso_serial *serial);
347 static void async_get_intf(struct work_struct *data);
348 static void async_put_intf(struct work_struct *data);
349 static int hso_put_activity(struct hso_device *hso_dev);
350 static int hso_get_activity(struct hso_device *hso_dev);
351 static void tiocmget_intr_callback(struct urb *urb);
352 /*****************************************************************************/
353 /* Helping functions */
354 /*****************************************************************************/
358 static inline struct hso_net *dev2net(struct hso_device *hso_dev)
360 return hso_dev->port_data.dev_net;
363 static inline struct hso_serial *dev2ser(struct hso_device *hso_dev)
365 return hso_dev->port_data.dev_serial;
368 /* Debugging functions */
370 static void dbg_dump(int line_count, const char *func_name, unsigned char *buf,
373 static char name[255];
375 sprintf(name, "hso[%d:%s]", line_count, func_name);
376 print_hex_dump_bytes(name, DUMP_PREFIX_NONE, buf, len);
379 #define DUMP(buf_, len_) \
380 dbg_dump(__LINE__, __func__, buf_, len_)
382 #define DUMP1(buf_, len_) \
388 #define DUMP(buf_, len_)
389 #define DUMP1(buf_, len_)
392 /* module parameters */
394 static int tty_major;
395 static int disable_net;
398 static const char driver_name[] = "hso";
399 static const char tty_filename[] = "ttyHS";
400 static const char *version = __FILE__ ": " DRIVER_VERSION " " MOD_AUTHOR;
401 /* the usb driver itself (registered in hso_init) */
402 static struct usb_driver hso_driver;
403 /* serial structures */
404 static struct tty_driver *tty_drv;
405 static struct hso_device *serial_table[HSO_SERIAL_TTY_MINORS];
406 static struct hso_device *network_table[HSO_MAX_NET_DEVICES];
407 static spinlock_t serial_table_lock;
409 static const s32 default_port_spec[] = {
410 HSO_INTF_MUX | HSO_PORT_NETWORK,
411 HSO_INTF_BULK | HSO_PORT_DIAG,
412 HSO_INTF_BULK | HSO_PORT_MODEM,
416 static const s32 icon321_port_spec[] = {
417 HSO_INTF_MUX | HSO_PORT_NETWORK,
418 HSO_INTF_BULK | HSO_PORT_DIAG2,
419 HSO_INTF_BULK | HSO_PORT_MODEM,
420 HSO_INTF_BULK | HSO_PORT_DIAG,
424 #define default_port_device(vendor, product) \
425 USB_DEVICE(vendor, product), \
426 .driver_info = (kernel_ulong_t)default_port_spec
428 #define icon321_port_device(vendor, product) \
429 USB_DEVICE(vendor, product), \
430 .driver_info = (kernel_ulong_t)icon321_port_spec
432 /* list of devices we support */
433 static const struct usb_device_id hso_ids[] = {
434 {default_port_device(0x0af0, 0x6711)},
435 {default_port_device(0x0af0, 0x6731)},
436 {default_port_device(0x0af0, 0x6751)},
437 {default_port_device(0x0af0, 0x6771)},
438 {default_port_device(0x0af0, 0x6791)},
439 {default_port_device(0x0af0, 0x6811)},
440 {default_port_device(0x0af0, 0x6911)},
441 {default_port_device(0x0af0, 0x6951)},
442 {default_port_device(0x0af0, 0x6971)},
443 {default_port_device(0x0af0, 0x7011)},
444 {default_port_device(0x0af0, 0x7031)},
445 {default_port_device(0x0af0, 0x7051)},
446 {default_port_device(0x0af0, 0x7071)},
447 {default_port_device(0x0af0, 0x7111)},
448 {default_port_device(0x0af0, 0x7211)},
449 {default_port_device(0x0af0, 0x7251)},
450 {default_port_device(0x0af0, 0x7271)},
451 {default_port_device(0x0af0, 0x7311)},
452 {default_port_device(0x0af0, 0xc031)}, /* Icon-Edge */
453 {icon321_port_device(0x0af0, 0xd013)}, /* Module HSxPA */
454 {icon321_port_device(0x0af0, 0xd031)}, /* Icon-321 */
455 {icon321_port_device(0x0af0, 0xd033)}, /* Icon-322 */
456 {USB_DEVICE(0x0af0, 0x7301)}, /* GE40x */
457 {USB_DEVICE(0x0af0, 0x7361)}, /* GE40x */
458 {USB_DEVICE(0x0af0, 0x7381)}, /* GE40x */
459 {USB_DEVICE(0x0af0, 0x7401)}, /* GI 0401 */
460 {USB_DEVICE(0x0af0, 0x7501)}, /* GTM 382 */
461 {USB_DEVICE(0x0af0, 0x7601)}, /* GE40x */
462 {USB_DEVICE(0x0af0, 0x7701)},
463 {USB_DEVICE(0x0af0, 0x7801)},
464 {USB_DEVICE(0x0af0, 0x7901)},
465 {USB_DEVICE(0x0af0, 0x8200)},
466 {USB_DEVICE(0x0af0, 0x8201)},
467 {USB_DEVICE(0x0af0, 0xd035)},
468 {USB_DEVICE(0x0af0, 0xd055)},
469 {USB_DEVICE(0x0af0, 0xd155)},
470 {USB_DEVICE(0x0af0, 0xd255)},
471 {USB_DEVICE(0x0af0, 0xd057)},
472 {USB_DEVICE(0x0af0, 0xd157)},
473 {USB_DEVICE(0x0af0, 0xd257)},
474 {USB_DEVICE(0x0af0, 0xd357)},
477 MODULE_DEVICE_TABLE(usb, hso_ids);
479 /* Sysfs attribute */
480 static ssize_t hso_sysfs_show_porttype(struct device *dev,
481 struct device_attribute *attr,
484 struct hso_device *hso_dev = dev->driver_data;
490 switch (hso_dev->port_spec & HSO_PORT_MASK) {
491 case HSO_PORT_CONTROL:
492 port_name = "Control";
495 port_name = "Application";
498 port_name = "Application2";
503 case HSO_PORT_GPS_CONTROL:
504 port_name = "GPS Control";
510 port_name = "Diagnostic";
513 port_name = "Diagnostic2";
518 case HSO_PORT_NETWORK:
519 port_name = "Network";
522 port_name = "Unknown";
526 return sprintf(buf, "%s\n", port_name);
528 static DEVICE_ATTR(hsotype, S_IRUGO, hso_sysfs_show_porttype, NULL);
530 static int hso_urb_to_index(struct hso_serial *serial, struct urb *urb)
534 for (idx = 0; idx < serial->num_rx_urbs; idx++)
535 if (serial->rx_urb[idx] == urb)
537 dev_err(serial->parent->dev, "hso_urb_to_index failed\n");
541 /* converts mux value to a port spec value */
542 static u32 hso_mux_to_port(int mux)
548 result = HSO_PORT_CONTROL;
551 result = HSO_PORT_APP;
554 result = HSO_PORT_PCSC;
557 result = HSO_PORT_GPS;
560 result = HSO_PORT_APP2;
563 result = HSO_PORT_NO_PORT;
568 /* converts port spec value to a mux value */
569 static u32 hso_port_to_mux(int port)
573 switch (port & HSO_PORT_MASK) {
574 case HSO_PORT_CONTROL:
595 static struct hso_serial *get_serial_by_shared_int_and_type(
596 struct hso_shared_int *shared_int,
601 port = hso_mux_to_port(mux);
603 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
605 && (dev2ser(serial_table[i])->shared_int == shared_int)
606 && ((serial_table[i]->port_spec & HSO_PORT_MASK) == port)) {
607 return dev2ser(serial_table[i]);
614 static struct hso_serial *get_serial_by_index(unsigned index)
616 struct hso_serial *serial = NULL;
619 spin_lock_irqsave(&serial_table_lock, flags);
620 if (serial_table[index])
621 serial = dev2ser(serial_table[index]);
622 spin_unlock_irqrestore(&serial_table_lock, flags);
627 static int get_free_serial_index(void)
632 spin_lock_irqsave(&serial_table_lock, flags);
633 for (index = 0; index < HSO_SERIAL_TTY_MINORS; index++) {
634 if (serial_table[index] == NULL) {
635 spin_unlock_irqrestore(&serial_table_lock, flags);
639 spin_unlock_irqrestore(&serial_table_lock, flags);
641 printk(KERN_ERR "%s: no free serial devices in table\n", __func__);
645 static void set_serial_by_index(unsigned index, struct hso_serial *serial)
649 spin_lock_irqsave(&serial_table_lock, flags);
651 serial_table[index] = serial->parent;
653 serial_table[index] = NULL;
654 spin_unlock_irqrestore(&serial_table_lock, flags);
657 /* log a meaningful explanation of an USB status */
658 static void log_usb_status(int status, const char *function)
664 explanation = "no device";
667 explanation = "endpoint not enabled";
670 explanation = "endpoint stalled";
673 explanation = "not enough bandwidth";
676 explanation = "device disabled";
679 explanation = "device suspended";
685 explanation = "internal error";
688 explanation = "unknown status";
691 D1("%s: received USB status - %s (%d)", function, explanation, status);
694 /* Network interface functions */
696 /* called when net interface is brought up by ifconfig */
697 static int hso_net_open(struct net_device *net)
699 struct hso_net *odev = netdev_priv(net);
700 unsigned long flags = 0;
703 dev_err(&net->dev, "No net device !\n");
707 odev->skb_tx_buf = NULL;
709 /* setup environment */
710 spin_lock_irqsave(&odev->net_lock, flags);
711 odev->rx_parse_state = WAIT_IP;
712 odev->rx_buf_size = 0;
713 odev->rx_buf_missing = sizeof(struct iphdr);
714 spin_unlock_irqrestore(&odev->net_lock, flags);
716 /* We are up and running. */
717 set_bit(HSO_NET_RUNNING, &odev->flags);
718 hso_start_net_device(odev->parent);
720 /* Tell the kernel we are ready to start receiving from it */
721 netif_start_queue(net);
726 /* called when interface is brought down by ifconfig */
727 static int hso_net_close(struct net_device *net)
729 struct hso_net *odev = netdev_priv(net);
731 /* we don't need the queue anymore */
732 netif_stop_queue(net);
733 /* no longer running */
734 clear_bit(HSO_NET_RUNNING, &odev->flags);
736 hso_stop_net_device(odev->parent);
742 /* USB tells is xmit done, we should start the netqueue again */
743 static void write_bulk_callback(struct urb *urb)
745 struct hso_net *odev = urb->context;
746 int status = urb->status;
749 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
750 dev_err(&urb->dev->dev, "%s: device not running\n", __func__);
754 /* Do we still have a valid kernel network device? */
755 if (!netif_device_present(odev->net)) {
756 dev_err(&urb->dev->dev, "%s: net device not present\n",
761 /* log status, but don't act on it, we don't need to resubmit anything
764 log_usb_status(status, __func__);
766 hso_put_activity(odev->parent);
768 /* Tell the network interface we are ready for another frame */
769 netif_wake_queue(odev->net);
772 /* called by kernel when we need to transmit a packet */
773 static int hso_net_start_xmit(struct sk_buff *skb, struct net_device *net)
775 struct hso_net *odev = netdev_priv(net);
778 /* Tell the kernel, "No more frames 'til we are done with this one." */
779 netif_stop_queue(net);
780 if (hso_get_activity(odev->parent) == -EAGAIN) {
781 odev->skb_tx_buf = skb;
786 DUMP1(skb->data, skb->len);
787 /* Copy it from kernel memory to OUR memory */
788 memcpy(odev->mux_bulk_tx_buf, skb->data, skb->len);
789 D1("len: %d/%d", skb->len, MUX_BULK_TX_BUF_SIZE);
791 /* Fill in the URB for shipping it out. */
792 usb_fill_bulk_urb(odev->mux_bulk_tx_urb,
794 usb_sndbulkpipe(odev->parent->usb,
796 bEndpointAddress & 0x7F),
797 odev->mux_bulk_tx_buf, skb->len, write_bulk_callback,
800 /* Deal with the Zero Length packet problem, I hope */
801 odev->mux_bulk_tx_urb->transfer_flags |= URB_ZERO_PACKET;
803 /* Send the URB on its merry way. */
804 result = usb_submit_urb(odev->mux_bulk_tx_urb, GFP_ATOMIC);
806 dev_warn(&odev->parent->interface->dev,
807 "failed mux_bulk_tx_urb %d", result);
808 net->stats.tx_errors++;
809 netif_start_queue(net);
811 net->stats.tx_packets++;
812 net->stats.tx_bytes += skb->len;
813 /* And tell the kernel when the last transmit started. */
814 net->trans_start = jiffies;
821 static void hso_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *info)
823 struct hso_net *odev = netdev_priv(net);
825 strncpy(info->driver, driver_name, ETHTOOL_BUSINFO_LEN);
826 strncpy(info->version, DRIVER_VERSION, ETHTOOL_BUSINFO_LEN);
827 usb_make_path(odev->parent->usb, info->bus_info, sizeof info->bus_info);
830 static struct ethtool_ops ops = {
831 .get_drvinfo = hso_get_drvinfo,
832 .get_link = ethtool_op_get_link
835 /* called when a packet did not ack after watchdogtimeout */
836 static void hso_net_tx_timeout(struct net_device *net)
838 struct hso_net *odev = netdev_priv(net);
843 /* Tell syslog we are hosed. */
844 dev_warn(&net->dev, "Tx timed out.\n");
846 /* Tear the waiting frame off the list */
847 if (odev->mux_bulk_tx_urb
848 && (odev->mux_bulk_tx_urb->status == -EINPROGRESS))
849 usb_unlink_urb(odev->mux_bulk_tx_urb);
851 /* Update statistics */
852 net->stats.tx_errors++;
855 /* make a real packet from the received USB buffer */
856 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt,
857 unsigned int count, unsigned char is_eop)
859 unsigned short temp_bytes;
860 unsigned short buffer_offset = 0;
861 unsigned short frame_len;
862 unsigned char *tmp_rx_buf;
865 D1("Rx %d bytes", count);
866 DUMP(ip_pkt, min(128, (int)count));
869 switch (odev->rx_parse_state) {
871 /* waiting for IP header. */
872 /* wanted bytes - size of ip header */
875 odev->rx_buf_missing) ? count : odev->
878 memcpy(((unsigned char *)(&odev->rx_ip_hdr)) +
879 odev->rx_buf_size, ip_pkt + buffer_offset,
882 odev->rx_buf_size += temp_bytes;
883 buffer_offset += temp_bytes;
884 odev->rx_buf_missing -= temp_bytes;
887 if (!odev->rx_buf_missing) {
888 /* header is complete allocate an sk_buffer and
889 * continue to WAIT_DATA */
890 frame_len = ntohs(odev->rx_ip_hdr.tot_len);
892 if ((frame_len > DEFAULT_MRU) ||
893 (frame_len < sizeof(struct iphdr))) {
894 dev_err(&odev->net->dev,
895 "Invalid frame (%d) length\n",
897 odev->rx_parse_state = WAIT_SYNC;
900 /* Allocate an sk_buff */
901 odev->skb_rx_buf = dev_alloc_skb(frame_len);
902 if (!odev->skb_rx_buf) {
903 /* We got no receive buffer. */
904 D1("could not allocate memory");
905 odev->rx_parse_state = WAIT_SYNC;
908 /* Here's where it came from */
909 odev->skb_rx_buf->dev = odev->net;
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);
948 odev->skb_rx_buf->ip_summed =
949 CHECKSUM_UNNECESSARY;
951 skb_reset_mac_header(odev->skb_rx_buf);
953 /* Ship it off to the kernel */
954 netif_rx(odev->skb_rx_buf);
955 /* No longer our buffer. */
956 odev->skb_rx_buf = NULL;
958 /* update out statistics */
959 odev->net->stats.rx_packets++;
961 odev->net->stats.rx_bytes += odev->rx_buf_size;
963 odev->rx_buf_size = 0;
964 odev->rx_buf_missing = sizeof(struct iphdr);
965 odev->rx_parse_state = WAIT_IP;
980 /* Recovery mechanism for WAIT_SYNC state. */
982 if (odev->rx_parse_state == WAIT_SYNC) {
983 odev->rx_parse_state = WAIT_IP;
984 odev->rx_buf_size = 0;
985 odev->rx_buf_missing = sizeof(struct iphdr);
990 /* Moving data from usb to kernel (in interrupt state) */
991 static void read_bulk_callback(struct urb *urb)
993 struct hso_net *odev = urb->context;
994 struct net_device *net;
996 int status = urb->status;
998 /* is al ok? (Filip: Who's Al ?) */
1000 log_usb_status(status, __func__);
1005 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
1006 D1("BULK IN callback but driver is not active!");
1009 usb_mark_last_busy(urb->dev);
1013 if (!netif_device_present(net)) {
1014 /* Somebody killed our network interface... */
1018 if (odev->parent->port_spec & HSO_INFO_CRC_BUG) {
1020 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1021 rest = urb->actual_length % odev->in_endp->wMaxPacketSize;
1022 if (((rest == 5) || (rest == 6))
1023 && !memcmp(((u8 *) urb->transfer_buffer) +
1024 urb->actual_length - 4, crc_check, 4)) {
1025 urb->actual_length -= 4;
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", __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 = get_serial_by_tty(tty);
1104 struct ktermios *termios;
1107 printk(KERN_ERR "%s: no tty structures", __func__);
1111 D4("port %d", serial->minor);
1114 * Fix up unsupported bits
1116 termios = tty->termios;
1117 termios->c_iflag &= ~IXON; /* disable enable XON/XOFF flow control */
1120 ~(CSIZE /* no size */
1121 | PARENB /* disable parity bit */
1122 | CBAUD /* clear current baud rate */
1123 | CBAUDEX); /* clear current buad rate */
1125 termios->c_cflag |= CS8; /* character size 8 bits */
1127 /* baud rate 115200 */
1128 tty_encode_baud_rate(tty, 115200, 115200);
1131 static void hso_resubmit_rx_bulk_urb(struct hso_serial *serial, struct urb *urb)
1134 #ifdef CONFIG_HSO_AUTOPM
1135 usb_mark_last_busy(urb->dev);
1137 /* We are done with this URB, resubmit it. Prep the USB to wait for
1139 usb_fill_bulk_urb(urb, serial->parent->usb,
1140 usb_rcvbulkpipe(serial->parent->usb,
1142 bEndpointAddress & 0x7F),
1143 urb->transfer_buffer, serial->rx_data_length,
1144 hso_std_serial_read_bulk_callback, serial);
1145 /* Give this to the USB subsystem so it can tell us when more data
1147 result = usb_submit_urb(urb, GFP_ATOMIC);
1149 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1157 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1160 struct urb *curr_urb;
1162 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1163 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1164 count = put_rxbuf_data(curr_urb, serial);
1168 serial->curr_rx_urb_idx++;
1169 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1170 serial->curr_rx_urb_idx = 0;
1171 hso_resubmit_rx_bulk_urb(serial, curr_urb);
1176 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1181 urb = serial->rx_urb[0];
1182 if (serial->open_count > 0) {
1183 count = put_rxbuf_data(urb, serial);
1187 /* Re issue a read as long as we receive data. */
1189 if (count == 0 && ((urb->actual_length != 0) ||
1190 (serial->rx_state == RX_PENDING))) {
1191 serial->rx_state = RX_SENT;
1192 hso_mux_serial_read(serial);
1194 serial->rx_state = RX_IDLE;
1198 /* read callback for Diag and CS port */
1199 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1201 struct hso_serial *serial = urb->context;
1202 int status = urb->status;
1206 D1("serial == NULL");
1208 } else if (status) {
1209 log_usb_status(status, __func__);
1213 D4("\n--- Got serial_read_bulk callback %02x ---", status);
1214 D1("Actual length = %d\n", urb->actual_length);
1215 DUMP1(urb->transfer_buffer, urb->actual_length);
1217 /* Anyone listening? */
1218 if (serial->open_count == 0)
1222 if (serial->parent->port_spec & HSO_INFO_CRC_BUG) {
1224 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1226 urb->actual_length %
1227 serial->in_endp->wMaxPacketSize;
1228 if (((rest == 5) || (rest == 6))
1229 && !memcmp(((u8 *) urb->transfer_buffer) +
1230 urb->actual_length - 4, crc_check, 4)) {
1231 urb->actual_length -= 4;
1234 /* Valid data, handle RX data */
1235 spin_lock(&serial->serial_lock);
1236 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1237 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1238 spin_unlock(&serial->serial_lock);
1239 } else if (status == -ENOENT || status == -ECONNRESET) {
1240 /* Unlinked - check for throttled port. */
1241 D2("Port %d, successfully unlinked urb", serial->minor);
1242 spin_lock(&serial->serial_lock);
1243 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
1244 hso_resubmit_rx_bulk_urb(serial, urb);
1245 spin_unlock(&serial->serial_lock);
1247 D2("Port %d, status = %d for read urb", serial->minor, status);
1253 * This needs to be a tasklet otherwise we will
1254 * end up recursively calling this function.
1256 static void hso_unthrottle_tasklet(struct hso_serial *serial)
1258 unsigned long flags;
1260 spin_lock_irqsave(&serial->serial_lock, flags);
1261 if ((serial->parent->port_spec & HSO_INTF_MUX))
1262 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1264 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1265 spin_unlock_irqrestore(&serial->serial_lock, flags);
1268 static void hso_unthrottle(struct tty_struct *tty)
1270 struct hso_serial *serial = get_serial_by_tty(tty);
1272 tasklet_hi_schedule(&serial->unthrottle_tasklet);
1275 static void hso_unthrottle_workfunc(struct work_struct *work)
1277 struct hso_serial *serial =
1278 container_of(work, struct hso_serial,
1279 retry_unthrottle_workqueue);
1280 hso_unthrottle_tasklet(serial);
1283 /* open the requested serial port */
1284 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1286 struct hso_serial *serial = get_serial_by_index(tty->index);
1290 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1292 tty->driver_data = NULL;
1293 D1("Failed to open port");
1297 mutex_lock(&serial->parent->mutex);
1298 result = usb_autopm_get_interface(serial->parent->interface);
1302 D1("Opening %d", serial->minor);
1303 kref_get(&serial->parent->ref);
1306 spin_lock_irq(&serial->serial_lock);
1307 tty->driver_data = serial;
1308 tty_kref_put(serial->tty);
1309 serial->tty = tty_kref_get(tty);
1310 spin_unlock_irq(&serial->serial_lock);
1312 /* check for port already opened, if not set the termios */
1313 serial->open_count++;
1314 if (serial->open_count == 1) {
1315 tty->low_latency = 1;
1316 serial->rx_state = RX_IDLE;
1317 /* Force default termio settings */
1318 _hso_serial_set_termios(tty, NULL);
1319 tasklet_init(&serial->unthrottle_tasklet,
1320 (void (*)(unsigned long))hso_unthrottle_tasklet,
1321 (unsigned long)serial);
1322 INIT_WORK(&serial->retry_unthrottle_workqueue,
1323 hso_unthrottle_workfunc);
1324 result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1326 hso_stop_serial_device(serial->parent);
1327 serial->open_count--;
1328 kref_put(&serial->parent->ref, hso_serial_ref_free);
1331 D1("Port was already open");
1334 usb_autopm_put_interface(serial->parent->interface);
1338 hso_serial_tiocmset(tty, NULL, TIOCM_RTS | TIOCM_DTR, 0);
1340 mutex_unlock(&serial->parent->mutex);
1344 /* close the requested serial port */
1345 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1347 struct hso_serial *serial = tty->driver_data;
1350 D1("Closing serial port");
1352 /* Open failed, no close cleanup required */
1356 mutex_lock(&serial->parent->mutex);
1357 usb_gone = serial->parent->usb_gone;
1360 usb_autopm_get_interface(serial->parent->interface);
1362 /* reset the rts and dtr */
1363 /* do the actual close */
1364 serial->open_count--;
1365 kref_put(&serial->parent->ref, hso_serial_ref_free);
1366 if (serial->open_count <= 0) {
1367 serial->open_count = 0;
1368 spin_lock_irq(&serial->serial_lock);
1369 if (serial->tty == tty) {
1370 serial->tty->driver_data = NULL;
1374 spin_unlock_irq(&serial->serial_lock);
1376 hso_stop_serial_device(serial->parent);
1377 tasklet_kill(&serial->unthrottle_tasklet);
1378 cancel_work_sync(&serial->retry_unthrottle_workqueue);
1382 usb_autopm_put_interface(serial->parent->interface);
1384 mutex_unlock(&serial->parent->mutex);
1387 /* close the requested serial port */
1388 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1391 struct hso_serial *serial = get_serial_by_tty(tty);
1392 int space, tx_bytes;
1393 unsigned long flags;
1396 if (serial == NULL) {
1397 printk(KERN_ERR "%s: serial is NULL\n", __func__);
1401 spin_lock_irqsave(&serial->serial_lock, flags);
1403 space = serial->tx_data_length - serial->tx_buffer_count;
1404 tx_bytes = (count < space) ? count : space;
1409 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1410 serial->tx_buffer_count += tx_bytes;
1413 spin_unlock_irqrestore(&serial->serial_lock, flags);
1415 hso_kick_transmit(serial);
1420 /* how much room is there for writing */
1421 static int hso_serial_write_room(struct tty_struct *tty)
1423 struct hso_serial *serial = get_serial_by_tty(tty);
1425 unsigned long flags;
1427 spin_lock_irqsave(&serial->serial_lock, flags);
1428 room = serial->tx_data_length - serial->tx_buffer_count;
1429 spin_unlock_irqrestore(&serial->serial_lock, flags);
1431 /* return free room */
1435 /* setup the term */
1436 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1438 struct hso_serial *serial = get_serial_by_tty(tty);
1439 unsigned long flags;
1442 D5("Termios called with: cflags new[%d] - old[%d]",
1443 tty->termios->c_cflag, old->c_cflag);
1445 /* the actual setup */
1446 spin_lock_irqsave(&serial->serial_lock, flags);
1447 if (serial->open_count)
1448 _hso_serial_set_termios(tty, old);
1451 spin_unlock_irqrestore(&serial->serial_lock, flags);
1457 /* how many characters in the buffer */
1458 static int hso_serial_chars_in_buffer(struct tty_struct *tty)
1460 struct hso_serial *serial = get_serial_by_tty(tty);
1462 unsigned long flags;
1468 spin_lock_irqsave(&serial->serial_lock, flags);
1469 chars = serial->tx_buffer_count;
1470 spin_unlock_irqrestore(&serial->serial_lock, flags);
1474 static int tiocmget_submit_urb(struct hso_serial *serial,
1475 struct hso_tiocmget *tiocmget,
1476 struct usb_device *usb)
1480 if (serial->parent->usb_gone)
1482 usb_fill_int_urb(tiocmget->urb, usb,
1485 bEndpointAddress & 0x7F),
1486 &tiocmget->serial_state_notification,
1487 sizeof(struct hso_serial_state_notification),
1488 tiocmget_intr_callback, serial,
1489 tiocmget->endp->bInterval);
1490 result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC);
1492 dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__,
1499 static void tiocmget_intr_callback(struct urb *urb)
1501 struct hso_serial *serial = urb->context;
1502 struct hso_tiocmget *tiocmget;
1503 int status = urb->status;
1504 u16 UART_state_bitmap, prev_UART_state_bitmap;
1505 struct uart_icount *icount;
1506 struct hso_serial_state_notification *serial_state_notification;
1507 struct usb_device *usb;
1513 log_usb_status(status, __func__);
1516 tiocmget = serial->tiocmget;
1519 usb = serial->parent->usb;
1520 serial_state_notification = &tiocmget->serial_state_notification;
1521 if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1522 serial_state_notification->bNotification != B_NOTIFICATION ||
1523 le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1524 le16_to_cpu(serial_state_notification->wIndex) != W_INDEX ||
1525 le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1527 "hso received invalid serial state notification\n");
1528 DUMP(serial_state_notification,
1529 sizeof(hso_serial_state_notifation))
1532 UART_state_bitmap = le16_to_cpu(serial_state_notification->
1534 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1535 icount = &tiocmget->icount;
1536 spin_lock(&serial->serial_lock);
1537 if ((UART_state_bitmap & B_OVERRUN) !=
1538 (prev_UART_state_bitmap & B_OVERRUN))
1540 if ((UART_state_bitmap & B_PARITY) !=
1541 (prev_UART_state_bitmap & B_PARITY))
1543 if ((UART_state_bitmap & B_FRAMING) !=
1544 (prev_UART_state_bitmap & B_FRAMING))
1546 if ((UART_state_bitmap & B_RING_SIGNAL) &&
1547 !(prev_UART_state_bitmap & B_RING_SIGNAL))
1549 if ((UART_state_bitmap & B_BREAK) !=
1550 (prev_UART_state_bitmap & B_BREAK))
1552 if ((UART_state_bitmap & B_TX_CARRIER) !=
1553 (prev_UART_state_bitmap & B_TX_CARRIER))
1555 if ((UART_state_bitmap & B_RX_CARRIER) !=
1556 (prev_UART_state_bitmap & B_RX_CARRIER))
1558 tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1559 spin_unlock(&serial->serial_lock);
1560 tiocmget->intr_completed = 1;
1561 wake_up_interruptible(&tiocmget->waitq);
1563 memset(serial_state_notification, 0,
1564 sizeof(struct hso_serial_state_notification));
1565 tiocmget_submit_urb(serial,
1567 serial->parent->usb);
1571 * next few functions largely stolen from drivers/serial/serial_core.c
1573 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1574 * - mask passed in arg for lines of interest
1575 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1576 * Caller should use TIOCGICOUNT to see which one it was
1579 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1581 DECLARE_WAITQUEUE(wait, current);
1582 struct uart_icount cprev, cnow;
1583 struct hso_tiocmget *tiocmget;
1586 tiocmget = serial->tiocmget;
1590 * note the counters on entry
1592 spin_lock_irq(&serial->serial_lock);
1593 memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1594 spin_unlock_irq(&serial->serial_lock);
1595 add_wait_queue(&tiocmget->waitq, &wait);
1597 spin_lock_irq(&serial->serial_lock);
1598 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1599 spin_unlock_irq(&serial->serial_lock);
1600 set_current_state(TASK_INTERRUPTIBLE);
1601 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1602 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1603 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd))) {
1608 /* see if a signal did it */
1609 if (signal_pending(current)) {
1615 current->state = TASK_RUNNING;
1616 remove_wait_queue(&tiocmget->waitq, &wait);
1622 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1623 * Return: write counters to the user passed counter struct
1624 * NB: both 1->0 and 0->1 transitions are counted except for
1625 * RI where only 0->1 is counted.
1627 static int hso_get_count(struct hso_serial *serial,
1628 struct serial_icounter_struct __user *icnt)
1630 struct serial_icounter_struct icount;
1631 struct uart_icount cnow;
1632 struct hso_tiocmget *tiocmget = serial->tiocmget;
1636 spin_lock_irq(&serial->serial_lock);
1637 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1638 spin_unlock_irq(&serial->serial_lock);
1640 icount.cts = cnow.cts;
1641 icount.dsr = cnow.dsr;
1642 icount.rng = cnow.rng;
1643 icount.dcd = cnow.dcd;
1644 icount.rx = cnow.rx;
1645 icount.tx = cnow.tx;
1646 icount.frame = cnow.frame;
1647 icount.overrun = cnow.overrun;
1648 icount.parity = cnow.parity;
1649 icount.brk = cnow.brk;
1650 icount.buf_overrun = cnow.buf_overrun;
1652 return copy_to_user(icnt, &icount, sizeof(icount)) ? -EFAULT : 0;
1656 static int hso_serial_tiocmget(struct tty_struct *tty, struct file *file)
1659 struct hso_serial *serial = get_serial_by_tty(tty);
1660 struct hso_tiocmget *tiocmget;
1661 u16 UART_state_bitmap;
1665 D1("no tty structures");
1668 spin_lock_irq(&serial->serial_lock);
1669 retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1670 ((serial->dtr_state) ? TIOCM_DTR : 0);
1671 tiocmget = serial->tiocmget;
1674 UART_state_bitmap = le16_to_cpu(
1675 tiocmget->prev_UART_state_bitmap);
1676 if (UART_state_bitmap & B_RING_SIGNAL)
1677 retval |= TIOCM_RNG;
1678 if (UART_state_bitmap & B_RX_CARRIER)
1680 if (UART_state_bitmap & B_TX_CARRIER)
1681 retval |= TIOCM_DSR;
1683 spin_unlock_irq(&serial->serial_lock);
1687 static int hso_serial_tiocmset(struct tty_struct *tty, struct file *file,
1688 unsigned int set, unsigned int clear)
1691 unsigned long flags;
1693 struct hso_serial *serial = get_serial_by_tty(tty);
1697 D1("no tty structures");
1700 if_num = serial->parent->interface->altsetting->desc.bInterfaceNumber;
1702 spin_lock_irqsave(&serial->serial_lock, flags);
1703 if (set & TIOCM_RTS)
1704 serial->rts_state = 1;
1705 if (set & TIOCM_DTR)
1706 serial->dtr_state = 1;
1708 if (clear & TIOCM_RTS)
1709 serial->rts_state = 0;
1710 if (clear & TIOCM_DTR)
1711 serial->dtr_state = 0;
1713 if (serial->dtr_state)
1715 if (serial->rts_state)
1718 spin_unlock_irqrestore(&serial->serial_lock, flags);
1720 return usb_control_msg(serial->parent->usb,
1721 usb_rcvctrlpipe(serial->parent->usb, 0), 0x22,
1722 0x21, val, if_num, NULL, 0,
1723 USB_CTRL_SET_TIMEOUT);
1726 static int hso_serial_ioctl(struct tty_struct *tty, struct file *file,
1727 unsigned int cmd, unsigned long arg)
1729 struct hso_serial *serial = get_serial_by_tty(tty);
1730 void __user *uarg = (void __user *)arg;
1732 D4("IOCTL cmd: %d, arg: %ld", cmd, arg);
1738 ret = hso_wait_modem_status(serial, arg);
1742 ret = hso_get_count(serial, uarg);
1752 /* starts a transmit */
1753 static void hso_kick_transmit(struct hso_serial *serial)
1756 unsigned long flags;
1759 spin_lock_irqsave(&serial->serial_lock, flags);
1760 if (!serial->tx_buffer_count)
1763 if (serial->tx_urb_used)
1766 /* Wakeup USB interface if necessary */
1767 if (hso_get_activity(serial->parent) == -EAGAIN)
1770 /* Switch pointers around to avoid memcpy */
1771 temp = serial->tx_buffer;
1772 serial->tx_buffer = serial->tx_data;
1773 serial->tx_data = temp;
1774 serial->tx_data_count = serial->tx_buffer_count;
1775 serial->tx_buffer_count = 0;
1777 /* If temp is set, it means we switched buffers */
1778 if (temp && serial->write_data) {
1779 res = serial->write_data(serial);
1781 serial->tx_urb_used = 1;
1784 spin_unlock_irqrestore(&serial->serial_lock, flags);
1787 /* make a request (for reading and writing data to muxed serial port) */
1788 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1789 struct urb *ctrl_urb,
1790 struct usb_ctrlrequest *ctrl_req,
1791 u8 *ctrl_urb_data, u32 size)
1797 if (!serial || !ctrl_urb || !ctrl_req) {
1798 printk(KERN_ERR "%s: Wrong arguments\n", __func__);
1803 ctrl_req->wValue = 0;
1804 ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1805 ctrl_req->wLength = cpu_to_le16(size);
1807 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1808 /* Reading command */
1809 ctrl_req->bRequestType = USB_DIR_IN |
1810 USB_TYPE_OPTION_VENDOR |
1811 USB_RECIP_INTERFACE;
1812 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1813 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1815 /* Writing command */
1816 ctrl_req->bRequestType = USB_DIR_OUT |
1817 USB_TYPE_OPTION_VENDOR |
1818 USB_RECIP_INTERFACE;
1819 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1820 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1823 D2("%s command (%02x) len: %d, port: %d",
1824 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1825 ctrl_req->bRequestType, ctrl_req->wLength, port);
1828 ctrl_urb->transfer_flags = 0;
1829 usb_fill_control_urb(ctrl_urb,
1830 serial->parent->usb,
1833 ctrl_urb_data, size, ctrl_callback, serial);
1834 /* Send it on merry way */
1835 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1837 dev_err(&ctrl_urb->dev->dev,
1838 "%s failed submit ctrl_urb %d type %d", __func__,
1847 /* called by intr_callback when read occurs */
1848 static int hso_mux_serial_read(struct hso_serial *serial)
1854 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1855 /* make the request */
1857 if (serial->num_rx_urbs != 1) {
1858 dev_err(&serial->parent->interface->dev,
1859 "ERROR: mux'd reads with multiple buffers "
1863 return mux_device_request(serial,
1864 USB_CDC_GET_ENCAPSULATED_RESPONSE,
1865 serial->parent->port_spec & HSO_PORT_MASK,
1867 &serial->ctrl_req_rx,
1868 serial->rx_data[0], serial->rx_data_length);
1871 /* used for muxed serial port callback (muxed serial read) */
1872 static void intr_callback(struct urb *urb)
1874 struct hso_shared_int *shared_int = urb->context;
1875 struct hso_serial *serial;
1876 unsigned char *port_req;
1877 int status = urb->status;
1880 usb_mark_last_busy(urb->dev);
1888 log_usb_status(status, __func__);
1891 D4("\n--- Got intr callback 0x%02X ---", status);
1894 port_req = urb->transfer_buffer;
1895 D4(" port_req = 0x%.2X\n", *port_req);
1896 /* loop over all muxed ports to find the one sending this */
1897 for (i = 0; i < 8; i++) {
1898 /* max 8 channels on MUX */
1899 if (*port_req & (1 << i)) {
1900 serial = get_serial_by_shared_int_and_type(shared_int,
1902 if (serial != NULL) {
1903 D1("Pending read interrupt on port %d\n", i);
1904 spin_lock(&serial->serial_lock);
1905 if (serial->rx_state == RX_IDLE) {
1906 /* Setup and send a ctrl req read on
1908 if (!serial->rx_urb_filled[0]) {
1909 serial->rx_state = RX_SENT;
1910 hso_mux_serial_read(serial);
1912 serial->rx_state = RX_PENDING;
1915 D1("Already pending a read on "
1918 spin_unlock(&serial->serial_lock);
1922 /* Resubmit interrupt urb */
1923 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1926 /* called for writing to muxed serial port */
1927 static int hso_mux_serial_write_data(struct hso_serial *serial)
1932 return mux_device_request(serial,
1933 USB_CDC_SEND_ENCAPSULATED_COMMAND,
1934 serial->parent->port_spec & HSO_PORT_MASK,
1936 &serial->ctrl_req_tx,
1937 serial->tx_data, serial->tx_data_count);
1940 /* write callback for Diag and CS port */
1941 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1943 struct hso_serial *serial = urb->context;
1944 int status = urb->status;
1945 struct tty_struct *tty;
1949 D1("serial == NULL");
1953 spin_lock(&serial->serial_lock);
1954 serial->tx_urb_used = 0;
1955 tty = tty_kref_get(serial->tty);
1956 spin_unlock(&serial->serial_lock);
1958 log_usb_status(status, __func__);
1962 hso_put_activity(serial->parent);
1967 hso_kick_transmit(serial);
1973 /* called for writing diag or CS serial port */
1974 static int hso_std_serial_write_data(struct hso_serial *serial)
1976 int count = serial->tx_data_count;
1979 usb_fill_bulk_urb(serial->tx_urb,
1980 serial->parent->usb,
1981 usb_sndbulkpipe(serial->parent->usb,
1983 bEndpointAddress & 0x7F),
1984 serial->tx_data, serial->tx_data_count,
1985 hso_std_serial_write_bulk_callback, serial);
1987 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
1989 dev_warn(&serial->parent->usb->dev,
1990 "Failed to submit urb - res %d\n", result);
1997 /* callback after read or write on muxed serial port */
1998 static void ctrl_callback(struct urb *urb)
2000 struct hso_serial *serial = urb->context;
2001 struct usb_ctrlrequest *req;
2002 int status = urb->status;
2003 struct tty_struct *tty;
2009 spin_lock(&serial->serial_lock);
2010 serial->tx_urb_used = 0;
2011 tty = tty_kref_get(serial->tty);
2012 spin_unlock(&serial->serial_lock);
2014 log_usb_status(status, __func__);
2020 req = (struct usb_ctrlrequest *)(urb->setup_packet);
2021 D4("\n--- Got muxed ctrl callback 0x%02X ---", status);
2022 D4("Actual length of urb = %d\n", urb->actual_length);
2023 DUMP1(urb->transfer_buffer, urb->actual_length);
2025 if (req->bRequestType ==
2026 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
2027 /* response to a read command */
2028 serial->rx_urb_filled[0] = 1;
2029 spin_lock(&serial->serial_lock);
2030 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
2031 spin_unlock(&serial->serial_lock);
2033 hso_put_activity(serial->parent);
2036 /* response to a write command */
2037 hso_kick_transmit(serial);
2042 /* handle RX data for serial port */
2043 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
2045 struct tty_struct *tty;
2046 int write_length_remaining = 0;
2050 if (urb == NULL || serial == NULL) {
2051 D1("serial = NULL");
2055 /* All callers to put_rxbuf_data hold serial_lock */
2056 tty = tty_kref_get(serial->tty);
2058 /* Push data to tty */
2060 write_length_remaining = urb->actual_length -
2061 serial->curr_rx_urb_offset;
2062 D1("data to push to tty");
2063 while (write_length_remaining) {
2064 if (test_bit(TTY_THROTTLED, &tty->flags)) {
2068 curr_write_len = tty_insert_flip_string
2069 (tty, urb->transfer_buffer +
2070 serial->curr_rx_urb_offset,
2071 write_length_remaining);
2072 serial->curr_rx_urb_offset += curr_write_len;
2073 write_length_remaining -= curr_write_len;
2074 tty_flip_buffer_push(tty);
2077 if (write_length_remaining == 0) {
2078 serial->curr_rx_urb_offset = 0;
2079 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2082 return write_length_remaining;
2086 /* Base driver functions */
2088 static void hso_log_port(struct hso_device *hso_dev)
2093 switch (hso_dev->port_spec & HSO_PORT_MASK) {
2094 case HSO_PORT_CONTROL:
2095 port_type = "Control";
2098 port_type = "Application";
2103 case HSO_PORT_GPS_CONTROL:
2104 port_type = "GPS control";
2107 port_type = "Application2";
2113 port_type = "Diagnostic";
2115 case HSO_PORT_DIAG2:
2116 port_type = "Diagnostic2";
2118 case HSO_PORT_MODEM:
2119 port_type = "Modem";
2121 case HSO_PORT_NETWORK:
2122 port_type = "Network";
2125 port_type = "Unknown";
2128 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2129 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2131 sprintf(port_dev, "/dev/%s%d", tty_filename,
2132 dev2ser(hso_dev)->minor);
2134 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2135 port_type, port_dev);
2138 static int hso_start_net_device(struct hso_device *hso_dev)
2141 struct hso_net *hso_net = dev2net(hso_dev);
2146 /* send URBs for all read buffers */
2147 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2149 /* Prep a receive URB */
2150 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2152 usb_rcvbulkpipe(hso_dev->usb,
2154 bEndpointAddress & 0x7F),
2155 hso_net->mux_bulk_rx_buf_pool[i],
2156 MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2159 /* Put it out there so the device can send us stuff */
2160 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2163 dev_warn(&hso_dev->usb->dev,
2164 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2171 static int hso_stop_net_device(struct hso_device *hso_dev)
2174 struct hso_net *hso_net = dev2net(hso_dev);
2179 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2180 if (hso_net->mux_bulk_rx_urb_pool[i])
2181 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2184 if (hso_net->mux_bulk_tx_urb)
2185 usb_kill_urb(hso_net->mux_bulk_tx_urb);
2190 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2193 struct hso_serial *serial = dev2ser(hso_dev);
2198 /* If it is not the MUX port fill in and submit a bulk urb (already
2199 * allocated in hso_serial_start) */
2200 if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2201 for (i = 0; i < serial->num_rx_urbs; i++) {
2202 usb_fill_bulk_urb(serial->rx_urb[i],
2203 serial->parent->usb,
2204 usb_rcvbulkpipe(serial->parent->usb,
2209 serial->rx_data_length,
2210 hso_std_serial_read_bulk_callback,
2212 result = usb_submit_urb(serial->rx_urb[i], flags);
2214 dev_warn(&serial->parent->usb->dev,
2215 "Failed to submit urb - res %d\n",
2221 mutex_lock(&serial->shared_int->shared_int_lock);
2222 if (!serial->shared_int->use_count) {
2224 hso_mux_submit_intr_urb(serial->shared_int,
2225 hso_dev->usb, flags);
2227 serial->shared_int->use_count++;
2228 mutex_unlock(&serial->shared_int->shared_int_lock);
2230 if (serial->tiocmget)
2231 tiocmget_submit_urb(serial,
2233 serial->parent->usb);
2237 static int hso_stop_serial_device(struct hso_device *hso_dev)
2240 struct hso_serial *serial = dev2ser(hso_dev);
2241 struct hso_tiocmget *tiocmget;
2246 for (i = 0; i < serial->num_rx_urbs; i++) {
2247 if (serial->rx_urb[i]) {
2248 usb_kill_urb(serial->rx_urb[i]);
2249 serial->rx_urb_filled[i] = 0;
2252 serial->curr_rx_urb_idx = 0;
2253 serial->curr_rx_urb_offset = 0;
2256 usb_kill_urb(serial->tx_urb);
2258 if (serial->shared_int) {
2259 mutex_lock(&serial->shared_int->shared_int_lock);
2260 if (serial->shared_int->use_count &&
2261 (--serial->shared_int->use_count == 0)) {
2264 urb = serial->shared_int->shared_intr_urb;
2268 mutex_unlock(&serial->shared_int->shared_int_lock);
2270 tiocmget = serial->tiocmget;
2272 wake_up_interruptible(&tiocmget->waitq);
2273 usb_kill_urb(tiocmget->urb);
2279 static void hso_serial_common_free(struct hso_serial *serial)
2283 if (serial->parent->dev)
2284 device_remove_file(serial->parent->dev, &dev_attr_hsotype);
2286 tty_unregister_device(tty_drv, serial->minor);
2288 for (i = 0; i < serial->num_rx_urbs; i++) {
2289 /* unlink and free RX URB */
2290 usb_free_urb(serial->rx_urb[i]);
2291 /* free the RX buffer */
2292 kfree(serial->rx_data[i]);
2295 /* unlink and free TX URB */
2296 usb_free_urb(serial->tx_urb);
2297 kfree(serial->tx_data);
2300 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
2301 int rx_size, int tx_size)
2307 minor = get_free_serial_index();
2311 /* register our minor number */
2312 serial->parent->dev = tty_register_device(tty_drv, minor,
2313 &serial->parent->interface->dev);
2314 dev = serial->parent->dev;
2315 dev->driver_data = serial->parent;
2316 i = device_create_file(dev, &dev_attr_hsotype);
2318 /* fill in specific data for later use */
2319 serial->minor = minor;
2320 serial->magic = HSO_SERIAL_MAGIC;
2321 spin_lock_init(&serial->serial_lock);
2322 serial->num_rx_urbs = num_urbs;
2324 /* RX, allocate urb and initialize */
2326 /* prepare our RX buffer */
2327 serial->rx_data_length = rx_size;
2328 for (i = 0; i < serial->num_rx_urbs; i++) {
2329 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2330 if (!serial->rx_urb[i]) {
2331 dev_err(dev, "Could not allocate urb?\n");
2334 serial->rx_urb[i]->transfer_buffer = NULL;
2335 serial->rx_urb[i]->transfer_buffer_length = 0;
2336 serial->rx_data[i] = kzalloc(serial->rx_data_length,
2338 if (!serial->rx_data[i]) {
2339 dev_err(dev, "%s - Out of memory\n", __func__);
2344 /* TX, allocate urb and initialize */
2345 serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2346 if (!serial->tx_urb) {
2347 dev_err(dev, "Could not allocate urb?\n");
2350 serial->tx_urb->transfer_buffer = NULL;
2351 serial->tx_urb->transfer_buffer_length = 0;
2352 /* prepare our TX buffer */
2353 serial->tx_data_count = 0;
2354 serial->tx_buffer_count = 0;
2355 serial->tx_data_length = tx_size;
2356 serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2357 if (!serial->tx_data) {
2358 dev_err(dev, "%s - Out of memory", __func__);
2361 serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2362 if (!serial->tx_buffer) {
2363 dev_err(dev, "%s - Out of memory", __func__);
2369 hso_serial_common_free(serial);
2373 /* Creates a general hso device */
2374 static struct hso_device *hso_create_device(struct usb_interface *intf,
2377 struct hso_device *hso_dev;
2379 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2383 hso_dev->port_spec = port_spec;
2384 hso_dev->usb = interface_to_usbdev(intf);
2385 hso_dev->interface = intf;
2386 kref_init(&hso_dev->ref);
2387 mutex_init(&hso_dev->mutex);
2389 INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2390 INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2395 /* Removes a network device in the network device table */
2396 static int remove_net_device(struct hso_device *hso_dev)
2400 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2401 if (network_table[i] == hso_dev) {
2402 network_table[i] = NULL;
2406 if (i == HSO_MAX_NET_DEVICES)
2411 /* Frees our network device */
2412 static void hso_free_net_device(struct hso_device *hso_dev)
2415 struct hso_net *hso_net = dev2net(hso_dev);
2421 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2422 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2423 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2425 usb_free_urb(hso_net->mux_bulk_tx_urb);
2426 kfree(hso_net->mux_bulk_tx_buf);
2428 remove_net_device(hso_net->parent);
2431 unregister_netdev(hso_net->net);
2432 free_netdev(hso_net->net);
2438 static const struct net_device_ops hso_netdev_ops = {
2439 .ndo_open = hso_net_open,
2440 .ndo_stop = hso_net_close,
2441 .ndo_start_xmit = hso_net_start_xmit,
2442 .ndo_tx_timeout = hso_net_tx_timeout,
2445 /* initialize the network interface */
2446 static void hso_net_init(struct net_device *net)
2448 struct hso_net *hso_net = netdev_priv(net);
2450 D1("sizeof hso_net is %d", (int)sizeof(*hso_net));
2452 /* fill in the other fields */
2453 net->netdev_ops = &hso_netdev_ops;
2454 net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2455 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2456 net->type = ARPHRD_NONE;
2457 net->mtu = DEFAULT_MTU - 14;
2458 net->tx_queue_len = 10;
2459 SET_ETHTOOL_OPS(net, &ops);
2461 /* and initialize the semaphore */
2462 spin_lock_init(&hso_net->net_lock);
2465 /* Adds a network device in the network device table */
2466 static int add_net_device(struct hso_device *hso_dev)
2470 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2471 if (network_table[i] == NULL) {
2472 network_table[i] = hso_dev;
2476 if (i == HSO_MAX_NET_DEVICES)
2481 static int hso_radio_toggle(void *data, enum rfkill_state state)
2483 struct hso_device *hso_dev = data;
2484 int enabled = (state == RFKILL_STATE_ON);
2487 mutex_lock(&hso_dev->mutex);
2488 if (hso_dev->usb_gone)
2491 rv = usb_control_msg(hso_dev->usb, usb_rcvctrlpipe(hso_dev->usb, 0),
2492 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2493 USB_CTRL_SET_TIMEOUT);
2494 mutex_unlock(&hso_dev->mutex);
2498 /* Creates and sets up everything for rfkill */
2499 static void hso_create_rfkill(struct hso_device *hso_dev,
2500 struct usb_interface *interface)
2502 struct hso_net *hso_net = dev2net(hso_dev);
2503 struct device *dev = &hso_net->net->dev;
2506 hso_net->rfkill = rfkill_allocate(&interface_to_usbdev(interface)->dev,
2508 if (!hso_net->rfkill) {
2509 dev_err(dev, "%s - Out of memory\n", __func__);
2512 rfkn = kzalloc(20, GFP_KERNEL);
2514 rfkill_free(hso_net->rfkill);
2515 hso_net->rfkill = NULL;
2516 dev_err(dev, "%s - Out of memory\n", __func__);
2519 snprintf(rfkn, 20, "hso-%d",
2520 interface->altsetting->desc.bInterfaceNumber);
2521 hso_net->rfkill->name = rfkn;
2522 hso_net->rfkill->state = RFKILL_STATE_ON;
2523 hso_net->rfkill->data = hso_dev;
2524 hso_net->rfkill->toggle_radio = hso_radio_toggle;
2525 if (rfkill_register(hso_net->rfkill) < 0) {
2527 hso_net->rfkill->name = NULL;
2528 rfkill_free(hso_net->rfkill);
2529 hso_net->rfkill = NULL;
2530 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2535 /* Creates our network device */
2536 static struct hso_device *hso_create_net_device(struct usb_interface *interface)
2539 struct net_device *net;
2540 struct hso_net *hso_net;
2541 struct hso_device *hso_dev;
2543 hso_dev = hso_create_device(interface, HSO_INTF_MUX | HSO_PORT_NETWORK);
2547 /* allocate our network device, then we can put in our private data */
2548 /* call hso_net_init to do the basic initialization */
2549 net = alloc_netdev(sizeof(struct hso_net), "hso%d", hso_net_init);
2551 dev_err(&interface->dev, "Unable to create ethernet device\n");
2555 hso_net = netdev_priv(net);
2557 hso_dev->port_data.dev_net = hso_net;
2559 hso_net->parent = hso_dev;
2561 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2563 if (!hso_net->in_endp) {
2564 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2567 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2569 if (!hso_net->out_endp) {
2570 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2573 SET_NETDEV_DEV(net, &interface->dev);
2575 /* registering our net device */
2576 result = register_netdev(net);
2578 dev_err(&interface->dev, "Failed to register device\n");
2582 /* start allocating */
2583 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2584 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2585 if (!hso_net->mux_bulk_rx_urb_pool[i]) {
2586 dev_err(&interface->dev, "Could not allocate rx urb\n");
2589 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2591 if (!hso_net->mux_bulk_rx_buf_pool[i]) {
2592 dev_err(&interface->dev, "Could not allocate rx buf\n");
2596 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2597 if (!hso_net->mux_bulk_tx_urb) {
2598 dev_err(&interface->dev, "Could not allocate tx urb\n");
2601 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2602 if (!hso_net->mux_bulk_tx_buf) {
2603 dev_err(&interface->dev, "Could not allocate tx buf\n");
2607 add_net_device(hso_dev);
2609 hso_log_port(hso_dev);
2611 hso_create_rfkill(hso_dev, interface);
2615 hso_free_net_device(hso_dev);
2619 static void hso_free_tiomget(struct hso_serial *serial)
2621 struct hso_tiocmget *tiocmget = serial->tiocmget;
2624 if (tiocmget->urb) {
2625 usb_free_urb(tiocmget->urb);
2626 tiocmget->urb = NULL;
2628 serial->tiocmget = NULL;
2633 /* Frees an AT channel ( goes for both mux and non-mux ) */
2634 static void hso_free_serial_device(struct hso_device *hso_dev)
2636 struct hso_serial *serial = dev2ser(hso_dev);
2640 set_serial_by_index(serial->minor, NULL);
2642 hso_serial_common_free(serial);
2644 if (serial->shared_int) {
2645 mutex_lock(&serial->shared_int->shared_int_lock);
2646 if (--serial->shared_int->ref_count == 0)
2647 hso_free_shared_int(serial->shared_int);
2649 mutex_unlock(&serial->shared_int->shared_int_lock);
2651 hso_free_tiomget(serial);
2656 /* Creates a bulk AT channel */
2657 static struct hso_device *hso_create_bulk_serial_device(
2658 struct usb_interface *interface, int port)
2660 struct hso_device *hso_dev;
2661 struct hso_serial *serial;
2663 struct hso_tiocmget *tiocmget;
2665 hso_dev = hso_create_device(interface, port);
2669 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2673 serial->parent = hso_dev;
2674 hso_dev->port_data.dev_serial = serial;
2676 if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2678 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2680 /* it isn't going to break our heart if serial->tiocmget
2681 * allocation fails don't bother checking this.
2683 if (serial->tiocmget) {
2684 tiocmget = serial->tiocmget;
2685 tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2686 if (tiocmget->urb) {
2687 mutex_init(&tiocmget->mutex);
2688 init_waitqueue_head(&tiocmget->waitq);
2689 tiocmget->endp = hso_get_ep(
2691 USB_ENDPOINT_XFER_INT,
2694 hso_free_tiomget(serial);
2700 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2704 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2706 if (!serial->in_endp) {
2707 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2713 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2714 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2718 serial->write_data = hso_std_serial_write_data;
2720 /* and record this serial */
2721 set_serial_by_index(serial->minor, serial);
2723 /* setup the proc dirs and files if needed */
2724 hso_log_port(hso_dev);
2726 /* done, return it */
2730 hso_serial_common_free(serial);
2732 hso_free_tiomget(serial);
2738 /* Creates a multiplexed AT channel */
2740 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2742 struct hso_shared_int *mux)
2744 struct hso_device *hso_dev;
2745 struct hso_serial *serial;
2748 port_spec = HSO_INTF_MUX;
2749 port_spec &= ~HSO_PORT_MASK;
2751 port_spec |= hso_mux_to_port(port);
2752 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2755 hso_dev = hso_create_device(interface, port_spec);
2759 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2763 hso_dev->port_data.dev_serial = serial;
2764 serial->parent = hso_dev;
2766 if (hso_serial_common_create
2767 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2770 serial->tx_data_length--;
2771 serial->write_data = hso_mux_serial_write_data;
2773 serial->shared_int = mux;
2774 mutex_lock(&serial->shared_int->shared_int_lock);
2775 serial->shared_int->ref_count++;
2776 mutex_unlock(&serial->shared_int->shared_int_lock);
2778 /* and record this serial */
2779 set_serial_by_index(serial->minor, serial);
2781 /* setup the proc dirs and files if needed */
2782 hso_log_port(hso_dev);
2784 /* done, return it */
2789 tty_unregister_device(tty_drv, serial->minor);
2798 static void hso_free_shared_int(struct hso_shared_int *mux)
2800 usb_free_urb(mux->shared_intr_urb);
2801 kfree(mux->shared_intr_buf);
2802 mutex_unlock(&mux->shared_int_lock);
2807 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2809 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2814 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2816 if (!mux->intr_endp) {
2817 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2821 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2822 if (!mux->shared_intr_urb) {
2823 dev_err(&interface->dev, "Could not allocate intr urb?");
2826 mux->shared_intr_buf = kzalloc(mux->intr_endp->wMaxPacketSize,
2828 if (!mux->shared_intr_buf) {
2829 dev_err(&interface->dev, "Could not allocate intr buf?");
2833 mutex_init(&mux->shared_int_lock);
2838 kfree(mux->shared_intr_buf);
2839 usb_free_urb(mux->shared_intr_urb);
2844 /* Gets the port spec for a certain interface */
2845 static int hso_get_config_data(struct usb_interface *interface)
2847 struct usb_device *usbdev = interface_to_usbdev(interface);
2849 u32 if_num = interface->altsetting->desc.bInterfaceNumber;
2852 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2853 0x86, 0xC0, 0, 0, config_data, 17,
2854 USB_CTRL_SET_TIMEOUT) != 0x11) {
2858 switch (config_data[if_num]) {
2863 result = HSO_PORT_DIAG;
2866 result = HSO_PORT_GPS;
2869 result = HSO_PORT_GPS_CONTROL;
2872 result = HSO_PORT_APP;
2875 result = HSO_PORT_APP2;
2878 result = HSO_PORT_CONTROL;
2881 result = HSO_PORT_NETWORK;
2884 result = HSO_PORT_MODEM;
2887 result = HSO_PORT_MSD;
2890 result = HSO_PORT_PCSC;
2893 result = HSO_PORT_VOICE;
2900 result |= HSO_INTF_BULK;
2902 if (config_data[16] & 0x1)
2903 result |= HSO_INFO_CRC_BUG;
2908 /* called once for each interface upon device insertion */
2909 static int hso_probe(struct usb_interface *interface,
2910 const struct usb_device_id *id)
2912 int mux, i, if_num, port_spec;
2913 unsigned char port_mask;
2914 struct hso_device *hso_dev = NULL;
2915 struct hso_shared_int *shared_int;
2916 struct hso_device *tmp_dev = NULL;
2918 if_num = interface->altsetting->desc.bInterfaceNumber;
2920 /* Get the interface/port specification from either driver_info or from
2921 * the device itself */
2922 if (id->driver_info)
2923 port_spec = ((u32 *)(id->driver_info))[if_num];
2925 port_spec = hso_get_config_data(interface);
2927 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2928 dev_err(&interface->dev, "Not our interface\n");
2931 /* Check if we need to switch to alt interfaces prior to port
2933 if (interface->num_altsetting > 1)
2934 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2935 interface->needs_remote_wakeup = 1;
2937 /* Allocate new hso device(s) */
2938 switch (port_spec & HSO_INTF_MASK) {
2940 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2941 /* Create the network device */
2943 hso_dev = hso_create_net_device(interface);
2950 if (hso_get_mux_ports(interface, &port_mask))
2951 /* TODO: de-allocate everything */
2954 shared_int = hso_create_shared_int(interface);
2958 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2959 if (port_mask & i) {
2960 hso_dev = hso_create_mux_serial_device(
2961 interface, i, shared_int);
2972 /* It's a regular bulk interface */
2973 if (((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK)
2975 hso_dev = hso_create_net_device(interface);
2978 hso_create_bulk_serial_device(interface, port_spec);
2986 /* save our data pointer in this device */
2987 usb_set_intfdata(interface, hso_dev);
2992 hso_free_interface(interface);
2996 /* device removed, cleaning up */
2997 static void hso_disconnect(struct usb_interface *interface)
2999 hso_free_interface(interface);
3001 /* remove reference of our private data */
3002 usb_set_intfdata(interface, NULL);
3005 static void async_get_intf(struct work_struct *data)
3007 struct hso_device *hso_dev =
3008 container_of(data, struct hso_device, async_get_intf);
3009 usb_autopm_get_interface(hso_dev->interface);
3012 static void async_put_intf(struct work_struct *data)
3014 struct hso_device *hso_dev =
3015 container_of(data, struct hso_device, async_put_intf);
3016 usb_autopm_put_interface(hso_dev->interface);
3019 static int hso_get_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 = 1;
3024 schedule_work(&hso_dev->async_get_intf);
3028 if (hso_dev->usb->state != USB_STATE_CONFIGURED)
3031 usb_mark_last_busy(hso_dev->usb);
3036 static int hso_put_activity(struct hso_device *hso_dev)
3038 if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
3039 if (hso_dev->is_active) {
3040 hso_dev->is_active = 0;
3041 schedule_work(&hso_dev->async_put_intf);
3045 hso_dev->is_active = 0;
3049 /* called by kernel when we need to suspend device */
3050 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3054 /* Stop all serial ports */
3055 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3056 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3057 result = hso_stop_serial_device(serial_table[i]);
3063 /* Stop all network ports */
3064 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3065 if (network_table[i] &&
3066 (network_table[i]->interface == iface)) {
3067 result = hso_stop_net_device(network_table[i]);
3077 /* called by kernel when we need to resume device */
3078 static int hso_resume(struct usb_interface *iface)
3081 struct hso_net *hso_net;
3083 /* Start all serial ports */
3084 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3085 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3086 if (dev2ser(serial_table[i])->open_count) {
3088 hso_start_serial_device(serial_table[i], GFP_NOIO);
3089 hso_kick_transmit(dev2ser(serial_table[i]));
3096 /* Start all network ports */
3097 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3098 if (network_table[i] &&
3099 (network_table[i]->interface == iface)) {
3100 hso_net = dev2net(network_table[i]);
3101 if (hso_net->flags & IFF_UP) {
3102 /* First transmit any lingering data,
3103 then restart the device. */
3104 if (hso_net->skb_tx_buf) {
3105 dev_dbg(&iface->dev,
3107 " lingering data\n");
3108 hso_net_start_xmit(hso_net->skb_tx_buf,
3110 hso_net->skb_tx_buf = NULL;
3112 result = hso_start_net_device(network_table[i]);
3123 static void hso_serial_ref_free(struct kref *ref)
3125 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3127 hso_free_serial_device(hso_dev);
3130 static void hso_free_interface(struct usb_interface *interface)
3132 struct hso_serial *hso_dev;
3133 struct tty_struct *tty;
3136 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3138 && (serial_table[i]->interface == interface)) {
3139 hso_dev = dev2ser(serial_table[i]);
3140 spin_lock_irq(&hso_dev->serial_lock);
3141 tty = tty_kref_get(hso_dev->tty);
3142 spin_unlock_irq(&hso_dev->serial_lock);
3145 mutex_lock(&hso_dev->parent->mutex);
3147 hso_dev->parent->usb_gone = 1;
3148 mutex_unlock(&hso_dev->parent->mutex);
3149 kref_put(&serial_table[i]->ref, hso_serial_ref_free);
3153 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3154 if (network_table[i]
3155 && (network_table[i]->interface == interface)) {
3156 struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3157 /* hso_stop_net_device doesn't stop the net queue since
3158 * traffic needs to start it again when suspended */
3159 netif_stop_queue(dev2net(network_table[i])->net);
3160 hso_stop_net_device(network_table[i]);
3161 cancel_work_sync(&network_table[i]->async_put_intf);
3162 cancel_work_sync(&network_table[i]->async_get_intf);
3164 rfkill_unregister(rfk);
3165 hso_free_net_device(network_table[i]);
3170 /* Helper functions */
3172 /* Get the endpoint ! */
3173 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3177 struct usb_host_interface *iface = intf->cur_altsetting;
3178 struct usb_endpoint_descriptor *endp;
3180 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3181 endp = &iface->endpoint[i].desc;
3182 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3183 (usb_endpoint_type(endp) == type))
3190 /* Get the byte that describes which ports are enabled */
3191 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3194 struct usb_host_interface *iface = intf->cur_altsetting;
3196 if (iface->extralen == 3) {
3197 *ports = iface->extra[2];
3201 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3202 if (iface->endpoint[i].extralen == 3) {
3203 *ports = iface->endpoint[i].extra[2];
3211 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3212 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3213 struct usb_device *usb, gfp_t gfp)
3217 usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3219 shared_int->intr_endp->bEndpointAddress & 0x7F),
3220 shared_int->shared_intr_buf,
3221 shared_int->intr_endp->wMaxPacketSize,
3222 intr_callback, shared_int,
3223 shared_int->intr_endp->bInterval);
3225 result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3227 dev_warn(&usb->dev, "%s failed mux_intr_urb %d", __func__,
3233 /* operations setup of the serial interface */
3234 static const struct tty_operations hso_serial_ops = {
3235 .open = hso_serial_open,
3236 .close = hso_serial_close,
3237 .write = hso_serial_write,
3238 .write_room = hso_serial_write_room,
3239 .ioctl = hso_serial_ioctl,
3240 .set_termios = hso_serial_set_termios,
3241 .chars_in_buffer = hso_serial_chars_in_buffer,
3242 .tiocmget = hso_serial_tiocmget,
3243 .tiocmset = hso_serial_tiocmset,
3244 .unthrottle = hso_unthrottle
3247 static struct usb_driver hso_driver = {
3248 .name = driver_name,
3250 .disconnect = hso_disconnect,
3251 .id_table = hso_ids,
3252 .suspend = hso_suspend,
3253 .resume = hso_resume,
3254 .reset_resume = hso_resume,
3255 .supports_autosuspend = 1,
3258 static int __init hso_init(void)
3263 /* put it in the log */
3264 printk(KERN_INFO "hso: %s\n", version);
3266 /* Initialise the serial table semaphore and table */
3267 spin_lock_init(&serial_table_lock);
3268 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3269 serial_table[i] = NULL;
3271 /* allocate our driver using the proper amount of supported minors */
3272 tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
3276 /* fill in all needed values */
3277 tty_drv->magic = TTY_DRIVER_MAGIC;
3278 tty_drv->owner = THIS_MODULE;
3279 tty_drv->driver_name = driver_name;
3280 tty_drv->name = tty_filename;
3282 /* if major number is provided as parameter, use that one */
3284 tty_drv->major = tty_major;
3286 tty_drv->minor_start = 0;
3287 tty_drv->num = HSO_SERIAL_TTY_MINORS;
3288 tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3289 tty_drv->subtype = SERIAL_TYPE_NORMAL;
3290 tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
3291 tty_drv->init_termios = tty_std_termios;
3292 hso_init_termios(&tty_drv->init_termios);
3293 tty_set_operations(tty_drv, &hso_serial_ops);
3295 /* register the tty driver */
3296 result = tty_register_driver(tty_drv);
3298 printk(KERN_ERR "%s - tty_register_driver failed(%d)\n",
3303 /* register this module as an usb driver */
3304 result = usb_register(&hso_driver);
3306 printk(KERN_ERR "Could not register hso driver? error: %d\n",
3308 /* cleanup serial interface */
3309 tty_unregister_driver(tty_drv);
3317 static void __exit hso_exit(void)
3319 printk(KERN_INFO "hso: unloaded\n");
3321 tty_unregister_driver(tty_drv);
3322 /* deregister the usb driver */
3323 usb_deregister(&hso_driver);
3326 /* Module definitions */
3327 module_init(hso_init);
3328 module_exit(hso_exit);
3330 MODULE_AUTHOR(MOD_AUTHOR);
3331 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3332 MODULE_LICENSE(MOD_LICENSE);
3333 MODULE_INFO(Version, DRIVER_VERSION);
3335 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3336 MODULE_PARM_DESC(debug, "Level of debug [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3337 module_param(debug, int, S_IRUGO | S_IWUSR);
3339 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3340 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3341 module_param(tty_major, int, S_IRUGO | S_IWUSR);
3343 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3344 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3345 module_param(disable_net, int, S_IRUGO | S_IWUSR);