tty: Convert the USB drivers to the new icount interface
[linux-2.6/libata-dev.git] / drivers / net / usb / hso.c
blobb8e957249132c7fe75f56a197e956d51d7e8c2ef
1 /******************************************************************************
3 * Driver for Option High Speed Mobile Devices.
5 * Copyright (C) 2008 Option International
6 * Filip Aben <f.aben@option.com>
7 * Denis Joseph Barrow <d.barow@option.com>
8 * Jan Dumon <j.dumon@option.com>
9 * Copyright (C) 2007 Andrew Bird (Sphere Systems Ltd)
10 * <ajb@spheresystems.co.uk>
11 * Copyright (C) 2008 Greg Kroah-Hartman <gregkh@suse.de>
12 * Copyright (C) 2008 Novell, Inc.
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License version 2 as
16 * published by the Free Software Foundation.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
26 * USA
29 *****************************************************************************/
31 /******************************************************************************
33 * Description of the device:
35 * Interface 0: Contains the IP network interface on the bulk end points.
36 * The multiplexed serial ports are using the interrupt and
37 * control endpoints.
38 * Interrupt contains a bitmap telling which multiplexed
39 * serialport needs servicing.
41 * Interface 1: Diagnostics port, uses bulk only, do not submit urbs until the
42 * port is opened, as this have a huge impact on the network port
43 * throughput.
45 * Interface 2: Standard modem interface - circuit switched interface, this
46 * can be used to make a standard ppp connection however it
47 * should not be used in conjunction with the IP network interface
48 * enabled for USB performance reasons i.e. if using this set
49 * ideally disable_net=1.
51 *****************************************************************************/
53 #include <linux/sched.h>
54 #include <linux/slab.h>
55 #include <linux/init.h>
56 #include <linux/delay.h>
57 #include <linux/netdevice.h>
58 #include <linux/module.h>
59 #include <linux/ethtool.h>
60 #include <linux/usb.h>
61 #include <linux/timer.h>
62 #include <linux/tty.h>
63 #include <linux/tty_driver.h>
64 #include <linux/tty_flip.h>
65 #include <linux/kmod.h>
66 #include <linux/rfkill.h>
67 #include <linux/ip.h>
68 #include <linux/uaccess.h>
69 #include <linux/usb/cdc.h>
70 #include <net/arp.h>
71 #include <asm/byteorder.h>
72 #include <linux/serial_core.h>
73 #include <linux/serial.h>
76 #define MOD_AUTHOR "Option Wireless"
77 #define MOD_DESCRIPTION "USB High Speed Option driver"
78 #define MOD_LICENSE "GPL"
80 #define HSO_MAX_NET_DEVICES 10
81 #define HSO__MAX_MTU 2048
82 #define DEFAULT_MTU 1500
83 #define DEFAULT_MRU 1500
85 #define CTRL_URB_RX_SIZE 1024
86 #define CTRL_URB_TX_SIZE 64
88 #define BULK_URB_RX_SIZE 4096
89 #define BULK_URB_TX_SIZE 8192
91 #define MUX_BULK_RX_BUF_SIZE HSO__MAX_MTU
92 #define MUX_BULK_TX_BUF_SIZE HSO__MAX_MTU
93 #define MUX_BULK_RX_BUF_COUNT 4
94 #define USB_TYPE_OPTION_VENDOR 0x20
96 /* These definitions are used with the struct hso_net flags element */
97 /* - use *_bit operations on it. (bit indices not values.) */
98 #define HSO_NET_RUNNING 0
100 #define HSO_NET_TX_TIMEOUT (HZ*10)
102 #define HSO_SERIAL_MAGIC 0x48534f31
104 /* Number of ttys to handle */
105 #define HSO_SERIAL_TTY_MINORS 256
107 #define MAX_RX_URBS 2
109 static inline struct hso_serial *get_serial_by_tty(struct tty_struct *tty)
111 if (tty)
112 return tty->driver_data;
113 return NULL;
116 /*****************************************************************************/
117 /* Debugging functions */
118 /*****************************************************************************/
119 #define D__(lvl_, fmt, arg...) \
120 do { \
121 printk(lvl_ "[%d:%s]: " fmt "\n", \
122 __LINE__, __func__, ## arg); \
123 } while (0)
125 #define D_(lvl, args...) \
126 do { \
127 if (lvl & debug) \
128 D__(KERN_INFO, args); \
129 } while (0)
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 /*****************************************************************************/
138 /* Enumerators */
139 /*****************************************************************************/
140 enum pkt_parse_state {
141 WAIT_IP,
142 WAIT_DATA,
143 WAIT_SYNC
146 /*****************************************************************************/
147 /* Structs */
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;
155 int use_count;
156 int ref_count;
157 struct mutex shared_int_lock;
160 struct hso_net {
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;
177 spinlock_t net_lock;
179 unsigned short rx_buf_size;
180 unsigned short rx_buf_missing;
181 struct iphdr rx_ip_hdr;
183 unsigned long flags;
186 enum rx_ctrl_state{
187 RX_IDLE,
188 RX_SENT,
189 RX_PENDING
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 {
207 u8 bmRequestType;
208 u8 bNotification;
209 u16 wValue;
210 u16 wIndex;
211 u16 wLength;
212 u16 UART_state_bitmap;
213 } __packed;
215 struct hso_tiocmget {
216 struct mutex mutex;
217 wait_queue_head_t waitq;
218 int intr_completed;
219 struct usb_endpoint_descriptor *endp;
220 struct urb *urb;
221 struct hso_serial_state_notification serial_state_notification;
222 u16 prev_UART_state_bitmap;
223 struct uart_icount icount;
227 struct hso_serial {
228 struct hso_device *parent;
229 int magic;
230 u8 minor;
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];
237 u8 num_rx_urbs;
238 u8 *rx_data[MAX_RX_URBS];
239 u16 rx_data_length; /* should contain allocated length */
241 struct urb *tx_urb;
242 u8 *tx_data;
243 u8 *tx_buffer;
244 u16 tx_data_length; /* should contain allocated length */
245 u16 tx_data_count;
246 u16 tx_buffer_count;
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;
254 u8 rts_state;
255 u8 dtr_state;
256 unsigned tx_urb_used:1;
258 /* from usb_serial_port */
259 struct tty_struct *tty;
260 int open_count;
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.
269 int curr_rx_urb_idx;
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;
276 struct hso_device {
277 union {
278 struct hso_serial *dev_serial;
279 struct hso_net *dev_net;
280 } port_data;
282 u32 port_spec;
284 u8 is_active;
285 u8 usb_gone;
286 struct work_struct async_get_intf;
287 struct work_struct async_put_intf;
288 struct work_struct reset_device;
290 struct usb_device *usb;
291 struct usb_interface *interface;
293 struct device *dev;
294 struct kref ref;
295 struct mutex mutex;
298 /* Type of interface */
299 #define HSO_INTF_MASK 0xFF00
300 #define HSO_INTF_MUX 0x0100
301 #define HSO_INTF_BULK 0x0200
303 /* Type of port */
304 #define HSO_PORT_MASK 0xFF
305 #define HSO_PORT_NO_PORT 0x0
306 #define HSO_PORT_CONTROL 0x1
307 #define HSO_PORT_APP 0x2
308 #define HSO_PORT_GPS 0x3
309 #define HSO_PORT_PCSC 0x4
310 #define HSO_PORT_APP2 0x5
311 #define HSO_PORT_GPS_CONTROL 0x6
312 #define HSO_PORT_MSD 0x7
313 #define HSO_PORT_VOICE 0x8
314 #define HSO_PORT_DIAG2 0x9
315 #define HSO_PORT_DIAG 0x10
316 #define HSO_PORT_MODEM 0x11
317 #define HSO_PORT_NETWORK 0x12
319 /* Additional device info */
320 #define HSO_INFO_MASK 0xFF000000
321 #define HSO_INFO_CRC_BUG 0x01000000
323 /*****************************************************************************/
324 /* Prototypes */
325 /*****************************************************************************/
326 /* Serial driver functions */
327 static int hso_serial_tiocmset(struct tty_struct *tty, struct file *file,
328 unsigned int set, unsigned int clear);
329 static void ctrl_callback(struct urb *urb);
330 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial);
331 static void hso_kick_transmit(struct hso_serial *serial);
332 /* Helper functions */
333 static int hso_mux_submit_intr_urb(struct hso_shared_int *mux_int,
334 struct usb_device *usb, gfp_t gfp);
335 static void handle_usb_error(int status, const char *function,
336 struct hso_device *hso_dev);
337 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
338 int type, int dir);
339 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports);
340 static void hso_free_interface(struct usb_interface *intf);
341 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags);
342 static int hso_stop_serial_device(struct hso_device *hso_dev);
343 static int hso_start_net_device(struct hso_device *hso_dev);
344 static void hso_free_shared_int(struct hso_shared_int *shared_int);
345 static int hso_stop_net_device(struct hso_device *hso_dev);
346 static void hso_serial_ref_free(struct kref *ref);
347 static void hso_std_serial_read_bulk_callback(struct urb *urb);
348 static int hso_mux_serial_read(struct hso_serial *serial);
349 static void async_get_intf(struct work_struct *data);
350 static void async_put_intf(struct work_struct *data);
351 static int hso_put_activity(struct hso_device *hso_dev);
352 static int hso_get_activity(struct hso_device *hso_dev);
353 static void tiocmget_intr_callback(struct urb *urb);
354 static void reset_device(struct work_struct *data);
355 /*****************************************************************************/
356 /* Helping functions */
357 /*****************************************************************************/
359 /* #define DEBUG */
361 static inline struct hso_net *dev2net(struct hso_device *hso_dev)
363 return hso_dev->port_data.dev_net;
366 static inline struct hso_serial *dev2ser(struct hso_device *hso_dev)
368 return hso_dev->port_data.dev_serial;
371 /* Debugging functions */
372 #ifdef DEBUG
373 static void dbg_dump(int line_count, const char *func_name, unsigned char *buf,
374 unsigned int len)
376 static char name[255];
378 sprintf(name, "hso[%d:%s]", line_count, func_name);
379 print_hex_dump_bytes(name, DUMP_PREFIX_NONE, buf, len);
382 #define DUMP(buf_, len_) \
383 dbg_dump(__LINE__, __func__, (unsigned char *)buf_, len_)
385 #define DUMP1(buf_, len_) \
386 do { \
387 if (0x01 & debug) \
388 DUMP(buf_, len_); \
389 } while (0)
390 #else
391 #define DUMP(buf_, len_)
392 #define DUMP1(buf_, len_)
393 #endif
395 /* module parameters */
396 static int debug;
397 static int tty_major;
398 static int disable_net;
400 /* driver info */
401 static const char driver_name[] = "hso";
402 static const char tty_filename[] = "ttyHS";
403 static const char *version = __FILE__ ": " MOD_AUTHOR;
404 /* the usb driver itself (registered in hso_init) */
405 static struct usb_driver hso_driver;
406 /* serial structures */
407 static struct tty_driver *tty_drv;
408 static struct hso_device *serial_table[HSO_SERIAL_TTY_MINORS];
409 static struct hso_device *network_table[HSO_MAX_NET_DEVICES];
410 static spinlock_t serial_table_lock;
412 static const s32 default_port_spec[] = {
413 HSO_INTF_MUX | HSO_PORT_NETWORK,
414 HSO_INTF_BULK | HSO_PORT_DIAG,
415 HSO_INTF_BULK | HSO_PORT_MODEM,
419 static const s32 icon321_port_spec[] = {
420 HSO_INTF_MUX | HSO_PORT_NETWORK,
421 HSO_INTF_BULK | HSO_PORT_DIAG2,
422 HSO_INTF_BULK | HSO_PORT_MODEM,
423 HSO_INTF_BULK | HSO_PORT_DIAG,
427 #define default_port_device(vendor, product) \
428 USB_DEVICE(vendor, product), \
429 .driver_info = (kernel_ulong_t)default_port_spec
431 #define icon321_port_device(vendor, product) \
432 USB_DEVICE(vendor, product), \
433 .driver_info = (kernel_ulong_t)icon321_port_spec
435 /* list of devices we support */
436 static const struct usb_device_id hso_ids[] = {
437 {default_port_device(0x0af0, 0x6711)},
438 {default_port_device(0x0af0, 0x6731)},
439 {default_port_device(0x0af0, 0x6751)},
440 {default_port_device(0x0af0, 0x6771)},
441 {default_port_device(0x0af0, 0x6791)},
442 {default_port_device(0x0af0, 0x6811)},
443 {default_port_device(0x0af0, 0x6911)},
444 {default_port_device(0x0af0, 0x6951)},
445 {default_port_device(0x0af0, 0x6971)},
446 {default_port_device(0x0af0, 0x7011)},
447 {default_port_device(0x0af0, 0x7031)},
448 {default_port_device(0x0af0, 0x7051)},
449 {default_port_device(0x0af0, 0x7071)},
450 {default_port_device(0x0af0, 0x7111)},
451 {default_port_device(0x0af0, 0x7211)},
452 {default_port_device(0x0af0, 0x7251)},
453 {default_port_device(0x0af0, 0x7271)},
454 {default_port_device(0x0af0, 0x7311)},
455 {default_port_device(0x0af0, 0xc031)}, /* Icon-Edge */
456 {icon321_port_device(0x0af0, 0xd013)}, /* Module HSxPA */
457 {icon321_port_device(0x0af0, 0xd031)}, /* Icon-321 */
458 {icon321_port_device(0x0af0, 0xd033)}, /* Icon-322 */
459 {USB_DEVICE(0x0af0, 0x7301)}, /* GE40x */
460 {USB_DEVICE(0x0af0, 0x7361)}, /* GE40x */
461 {USB_DEVICE(0x0af0, 0x7381)}, /* GE40x */
462 {USB_DEVICE(0x0af0, 0x7401)}, /* GI 0401 */
463 {USB_DEVICE(0x0af0, 0x7501)}, /* GTM 382 */
464 {USB_DEVICE(0x0af0, 0x7601)}, /* GE40x */
465 {USB_DEVICE(0x0af0, 0x7701)},
466 {USB_DEVICE(0x0af0, 0x7706)},
467 {USB_DEVICE(0x0af0, 0x7801)},
468 {USB_DEVICE(0x0af0, 0x7901)},
469 {USB_DEVICE(0x0af0, 0x7A01)},
470 {USB_DEVICE(0x0af0, 0x7A05)},
471 {USB_DEVICE(0x0af0, 0x8200)},
472 {USB_DEVICE(0x0af0, 0x8201)},
473 {USB_DEVICE(0x0af0, 0x8300)},
474 {USB_DEVICE(0x0af0, 0x8302)},
475 {USB_DEVICE(0x0af0, 0x8304)},
476 {USB_DEVICE(0x0af0, 0x8400)},
477 {USB_DEVICE(0x0af0, 0x8600)},
478 {USB_DEVICE(0x0af0, 0x8800)},
479 {USB_DEVICE(0x0af0, 0x8900)},
480 {USB_DEVICE(0x0af0, 0x9000)},
481 {USB_DEVICE(0x0af0, 0xd035)},
482 {USB_DEVICE(0x0af0, 0xd055)},
483 {USB_DEVICE(0x0af0, 0xd155)},
484 {USB_DEVICE(0x0af0, 0xd255)},
485 {USB_DEVICE(0x0af0, 0xd057)},
486 {USB_DEVICE(0x0af0, 0xd157)},
487 {USB_DEVICE(0x0af0, 0xd257)},
488 {USB_DEVICE(0x0af0, 0xd357)},
489 {USB_DEVICE(0x0af0, 0xd058)},
490 {USB_DEVICE(0x0af0, 0xc100)},
493 MODULE_DEVICE_TABLE(usb, hso_ids);
495 /* Sysfs attribute */
496 static ssize_t hso_sysfs_show_porttype(struct device *dev,
497 struct device_attribute *attr,
498 char *buf)
500 struct hso_device *hso_dev = dev_get_drvdata(dev);
501 char *port_name;
503 if (!hso_dev)
504 return 0;
506 switch (hso_dev->port_spec & HSO_PORT_MASK) {
507 case HSO_PORT_CONTROL:
508 port_name = "Control";
509 break;
510 case HSO_PORT_APP:
511 port_name = "Application";
512 break;
513 case HSO_PORT_APP2:
514 port_name = "Application2";
515 break;
516 case HSO_PORT_GPS:
517 port_name = "GPS";
518 break;
519 case HSO_PORT_GPS_CONTROL:
520 port_name = "GPS Control";
521 break;
522 case HSO_PORT_PCSC:
523 port_name = "PCSC";
524 break;
525 case HSO_PORT_DIAG:
526 port_name = "Diagnostic";
527 break;
528 case HSO_PORT_DIAG2:
529 port_name = "Diagnostic2";
530 break;
531 case HSO_PORT_MODEM:
532 port_name = "Modem";
533 break;
534 case HSO_PORT_NETWORK:
535 port_name = "Network";
536 break;
537 default:
538 port_name = "Unknown";
539 break;
542 return sprintf(buf, "%s\n", port_name);
544 static DEVICE_ATTR(hsotype, S_IRUGO, hso_sysfs_show_porttype, NULL);
546 static int hso_urb_to_index(struct hso_serial *serial, struct urb *urb)
548 int idx;
550 for (idx = 0; idx < serial->num_rx_urbs; idx++)
551 if (serial->rx_urb[idx] == urb)
552 return idx;
553 dev_err(serial->parent->dev, "hso_urb_to_index failed\n");
554 return -1;
557 /* converts mux value to a port spec value */
558 static u32 hso_mux_to_port(int mux)
560 u32 result;
562 switch (mux) {
563 case 0x1:
564 result = HSO_PORT_CONTROL;
565 break;
566 case 0x2:
567 result = HSO_PORT_APP;
568 break;
569 case 0x4:
570 result = HSO_PORT_PCSC;
571 break;
572 case 0x8:
573 result = HSO_PORT_GPS;
574 break;
575 case 0x10:
576 result = HSO_PORT_APP2;
577 break;
578 default:
579 result = HSO_PORT_NO_PORT;
581 return result;
584 /* converts port spec value to a mux value */
585 static u32 hso_port_to_mux(int port)
587 u32 result;
589 switch (port & HSO_PORT_MASK) {
590 case HSO_PORT_CONTROL:
591 result = 0x0;
592 break;
593 case HSO_PORT_APP:
594 result = 0x1;
595 break;
596 case HSO_PORT_PCSC:
597 result = 0x2;
598 break;
599 case HSO_PORT_GPS:
600 result = 0x3;
601 break;
602 case HSO_PORT_APP2:
603 result = 0x4;
604 break;
605 default:
606 result = 0x0;
608 return result;
611 static struct hso_serial *get_serial_by_shared_int_and_type(
612 struct hso_shared_int *shared_int,
613 int mux)
615 int i, port;
617 port = hso_mux_to_port(mux);
619 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
620 if (serial_table[i] &&
621 (dev2ser(serial_table[i])->shared_int == shared_int) &&
622 ((serial_table[i]->port_spec & HSO_PORT_MASK) == port)) {
623 return dev2ser(serial_table[i]);
627 return NULL;
630 static struct hso_serial *get_serial_by_index(unsigned index)
632 struct hso_serial *serial = NULL;
633 unsigned long flags;
635 spin_lock_irqsave(&serial_table_lock, flags);
636 if (serial_table[index])
637 serial = dev2ser(serial_table[index]);
638 spin_unlock_irqrestore(&serial_table_lock, flags);
640 return serial;
643 static int get_free_serial_index(void)
645 int index;
646 unsigned long flags;
648 spin_lock_irqsave(&serial_table_lock, flags);
649 for (index = 0; index < HSO_SERIAL_TTY_MINORS; index++) {
650 if (serial_table[index] == NULL) {
651 spin_unlock_irqrestore(&serial_table_lock, flags);
652 return index;
655 spin_unlock_irqrestore(&serial_table_lock, flags);
657 printk(KERN_ERR "%s: no free serial devices in table\n", __func__);
658 return -1;
661 static void set_serial_by_index(unsigned index, struct hso_serial *serial)
663 unsigned long flags;
665 spin_lock_irqsave(&serial_table_lock, flags);
666 if (serial)
667 serial_table[index] = serial->parent;
668 else
669 serial_table[index] = NULL;
670 spin_unlock_irqrestore(&serial_table_lock, flags);
673 static void handle_usb_error(int status, const char *function,
674 struct hso_device *hso_dev)
676 char *explanation;
678 switch (status) {
679 case -ENODEV:
680 explanation = "no device";
681 break;
682 case -ENOENT:
683 explanation = "endpoint not enabled";
684 break;
685 case -EPIPE:
686 explanation = "endpoint stalled";
687 break;
688 case -ENOSPC:
689 explanation = "not enough bandwidth";
690 break;
691 case -ESHUTDOWN:
692 explanation = "device disabled";
693 break;
694 case -EHOSTUNREACH:
695 explanation = "device suspended";
696 break;
697 case -EINVAL:
698 case -EAGAIN:
699 case -EFBIG:
700 case -EMSGSIZE:
701 explanation = "internal error";
702 break;
703 case -EILSEQ:
704 case -EPROTO:
705 case -ETIME:
706 case -ETIMEDOUT:
707 explanation = "protocol error";
708 if (hso_dev)
709 schedule_work(&hso_dev->reset_device);
710 break;
711 default:
712 explanation = "unknown status";
713 break;
716 /* log a meaningful explanation of an USB status */
717 D1("%s: received USB status - %s (%d)", function, explanation, status);
720 /* Network interface functions */
722 /* called when net interface is brought up by ifconfig */
723 static int hso_net_open(struct net_device *net)
725 struct hso_net *odev = netdev_priv(net);
726 unsigned long flags = 0;
728 if (!odev) {
729 dev_err(&net->dev, "No net device !\n");
730 return -ENODEV;
733 odev->skb_tx_buf = NULL;
735 /* setup environment */
736 spin_lock_irqsave(&odev->net_lock, flags);
737 odev->rx_parse_state = WAIT_IP;
738 odev->rx_buf_size = 0;
739 odev->rx_buf_missing = sizeof(struct iphdr);
740 spin_unlock_irqrestore(&odev->net_lock, flags);
742 /* We are up and running. */
743 set_bit(HSO_NET_RUNNING, &odev->flags);
744 hso_start_net_device(odev->parent);
746 /* Tell the kernel we are ready to start receiving from it */
747 netif_start_queue(net);
749 return 0;
752 /* called when interface is brought down by ifconfig */
753 static int hso_net_close(struct net_device *net)
755 struct hso_net *odev = netdev_priv(net);
757 /* we don't need the queue anymore */
758 netif_stop_queue(net);
759 /* no longer running */
760 clear_bit(HSO_NET_RUNNING, &odev->flags);
762 hso_stop_net_device(odev->parent);
764 /* done */
765 return 0;
768 /* USB tells is xmit done, we should start the netqueue again */
769 static void write_bulk_callback(struct urb *urb)
771 struct hso_net *odev = urb->context;
772 int status = urb->status;
774 /* Sanity check */
775 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
776 dev_err(&urb->dev->dev, "%s: device not running\n", __func__);
777 return;
780 /* Do we still have a valid kernel network device? */
781 if (!netif_device_present(odev->net)) {
782 dev_err(&urb->dev->dev, "%s: net device not present\n",
783 __func__);
784 return;
787 /* log status, but don't act on it, we don't need to resubmit anything
788 * anyhow */
789 if (status)
790 handle_usb_error(status, __func__, odev->parent);
792 hso_put_activity(odev->parent);
794 /* Tell the network interface we are ready for another frame */
795 netif_wake_queue(odev->net);
798 /* called by kernel when we need to transmit a packet */
799 static netdev_tx_t hso_net_start_xmit(struct sk_buff *skb,
800 struct net_device *net)
802 struct hso_net *odev = netdev_priv(net);
803 int result;
805 /* Tell the kernel, "No more frames 'til we are done with this one." */
806 netif_stop_queue(net);
807 if (hso_get_activity(odev->parent) == -EAGAIN) {
808 odev->skb_tx_buf = skb;
809 return NETDEV_TX_OK;
812 /* log if asked */
813 DUMP1(skb->data, skb->len);
814 /* Copy it from kernel memory to OUR memory */
815 memcpy(odev->mux_bulk_tx_buf, skb->data, skb->len);
816 D1("len: %d/%d", skb->len, MUX_BULK_TX_BUF_SIZE);
818 /* Fill in the URB for shipping it out. */
819 usb_fill_bulk_urb(odev->mux_bulk_tx_urb,
820 odev->parent->usb,
821 usb_sndbulkpipe(odev->parent->usb,
822 odev->out_endp->
823 bEndpointAddress & 0x7F),
824 odev->mux_bulk_tx_buf, skb->len, write_bulk_callback,
825 odev);
827 /* Deal with the Zero Length packet problem, I hope */
828 odev->mux_bulk_tx_urb->transfer_flags |= URB_ZERO_PACKET;
830 /* Send the URB on its merry way. */
831 result = usb_submit_urb(odev->mux_bulk_tx_urb, GFP_ATOMIC);
832 if (result) {
833 dev_warn(&odev->parent->interface->dev,
834 "failed mux_bulk_tx_urb %d\n", result);
835 net->stats.tx_errors++;
836 netif_start_queue(net);
837 } else {
838 net->stats.tx_packets++;
839 net->stats.tx_bytes += skb->len;
841 dev_kfree_skb(skb);
842 /* we're done */
843 return NETDEV_TX_OK;
846 static void hso_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *info)
848 struct hso_net *odev = netdev_priv(net);
850 strncpy(info->driver, driver_name, ETHTOOL_BUSINFO_LEN);
851 usb_make_path(odev->parent->usb, info->bus_info, sizeof info->bus_info);
854 static const struct ethtool_ops ops = {
855 .get_drvinfo = hso_get_drvinfo,
856 .get_link = ethtool_op_get_link
859 /* called when a packet did not ack after watchdogtimeout */
860 static void hso_net_tx_timeout(struct net_device *net)
862 struct hso_net *odev = netdev_priv(net);
864 if (!odev)
865 return;
867 /* Tell syslog we are hosed. */
868 dev_warn(&net->dev, "Tx timed out.\n");
870 /* Tear the waiting frame off the list */
871 if (odev->mux_bulk_tx_urb &&
872 (odev->mux_bulk_tx_urb->status == -EINPROGRESS))
873 usb_unlink_urb(odev->mux_bulk_tx_urb);
875 /* Update statistics */
876 net->stats.tx_errors++;
879 /* make a real packet from the received USB buffer */
880 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt,
881 unsigned int count, unsigned char is_eop)
883 unsigned short temp_bytes;
884 unsigned short buffer_offset = 0;
885 unsigned short frame_len;
886 unsigned char *tmp_rx_buf;
888 /* log if needed */
889 D1("Rx %d bytes", count);
890 DUMP(ip_pkt, min(128, (int)count));
892 while (count) {
893 switch (odev->rx_parse_state) {
894 case WAIT_IP:
895 /* waiting for IP header. */
896 /* wanted bytes - size of ip header */
897 temp_bytes =
898 (count <
899 odev->rx_buf_missing) ? count : odev->
900 rx_buf_missing;
902 memcpy(((unsigned char *)(&odev->rx_ip_hdr)) +
903 odev->rx_buf_size, ip_pkt + buffer_offset,
904 temp_bytes);
906 odev->rx_buf_size += temp_bytes;
907 buffer_offset += temp_bytes;
908 odev->rx_buf_missing -= temp_bytes;
909 count -= temp_bytes;
911 if (!odev->rx_buf_missing) {
912 /* header is complete allocate an sk_buffer and
913 * continue to WAIT_DATA */
914 frame_len = ntohs(odev->rx_ip_hdr.tot_len);
916 if ((frame_len > DEFAULT_MRU) ||
917 (frame_len < sizeof(struct iphdr))) {
918 dev_err(&odev->net->dev,
919 "Invalid frame (%d) length\n",
920 frame_len);
921 odev->rx_parse_state = WAIT_SYNC;
922 continue;
924 /* Allocate an sk_buff */
925 odev->skb_rx_buf = netdev_alloc_skb(odev->net,
926 frame_len);
927 if (!odev->skb_rx_buf) {
928 /* We got no receive buffer. */
929 D1("could not allocate memory");
930 odev->rx_parse_state = WAIT_SYNC;
931 return;
934 /* Copy what we got so far. make room for iphdr
935 * after tail. */
936 tmp_rx_buf =
937 skb_put(odev->skb_rx_buf,
938 sizeof(struct iphdr));
939 memcpy(tmp_rx_buf, (char *)&(odev->rx_ip_hdr),
940 sizeof(struct iphdr));
942 /* ETH_HLEN */
943 odev->rx_buf_size = sizeof(struct iphdr);
945 /* Filip actually use .tot_len */
946 odev->rx_buf_missing =
947 frame_len - sizeof(struct iphdr);
948 odev->rx_parse_state = WAIT_DATA;
950 break;
952 case WAIT_DATA:
953 temp_bytes = (count < odev->rx_buf_missing)
954 ? count : odev->rx_buf_missing;
956 /* Copy the rest of the bytes that are left in the
957 * buffer into the waiting sk_buf. */
958 /* Make room for temp_bytes after tail. */
959 tmp_rx_buf = skb_put(odev->skb_rx_buf, temp_bytes);
960 memcpy(tmp_rx_buf, ip_pkt + buffer_offset, temp_bytes);
962 odev->rx_buf_missing -= temp_bytes;
963 count -= temp_bytes;
964 buffer_offset += temp_bytes;
965 odev->rx_buf_size += temp_bytes;
966 if (!odev->rx_buf_missing) {
967 /* Packet is complete. Inject into stack. */
968 /* We have IP packet here */
969 odev->skb_rx_buf->protocol = cpu_to_be16(ETH_P_IP);
970 /* don't check it */
971 odev->skb_rx_buf->ip_summed =
972 CHECKSUM_UNNECESSARY;
974 skb_reset_mac_header(odev->skb_rx_buf);
976 /* Ship it off to the kernel */
977 netif_rx(odev->skb_rx_buf);
978 /* No longer our buffer. */
979 odev->skb_rx_buf = NULL;
981 /* update out statistics */
982 odev->net->stats.rx_packets++;
984 odev->net->stats.rx_bytes += odev->rx_buf_size;
986 odev->rx_buf_size = 0;
987 odev->rx_buf_missing = sizeof(struct iphdr);
988 odev->rx_parse_state = WAIT_IP;
990 break;
992 case WAIT_SYNC:
993 D1(" W_S");
994 count = 0;
995 break;
996 default:
997 D1(" ");
998 count--;
999 break;
1003 /* Recovery mechanism for WAIT_SYNC state. */
1004 if (is_eop) {
1005 if (odev->rx_parse_state == WAIT_SYNC) {
1006 odev->rx_parse_state = WAIT_IP;
1007 odev->rx_buf_size = 0;
1008 odev->rx_buf_missing = sizeof(struct iphdr);
1013 /* Moving data from usb to kernel (in interrupt state) */
1014 static void read_bulk_callback(struct urb *urb)
1016 struct hso_net *odev = urb->context;
1017 struct net_device *net;
1018 int result;
1019 int status = urb->status;
1021 /* is al ok? (Filip: Who's Al ?) */
1022 if (status) {
1023 handle_usb_error(status, __func__, odev->parent);
1024 return;
1027 /* Sanity check */
1028 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
1029 D1("BULK IN callback but driver is not active!");
1030 return;
1032 usb_mark_last_busy(urb->dev);
1034 net = odev->net;
1036 if (!netif_device_present(net)) {
1037 /* Somebody killed our network interface... */
1038 return;
1041 if (odev->parent->port_spec & HSO_INFO_CRC_BUG) {
1042 u32 rest;
1043 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1044 rest = urb->actual_length %
1045 le16_to_cpu(odev->in_endp->wMaxPacketSize);
1046 if (((rest == 5) || (rest == 6)) &&
1047 !memcmp(((u8 *) urb->transfer_buffer) +
1048 urb->actual_length - 4, crc_check, 4)) {
1049 urb->actual_length -= 4;
1053 /* do we even have a packet? */
1054 if (urb->actual_length) {
1055 /* Handle the IP stream, add header and push it onto network
1056 * stack if the packet is complete. */
1057 spin_lock(&odev->net_lock);
1058 packetizeRx(odev, urb->transfer_buffer, urb->actual_length,
1059 (urb->transfer_buffer_length >
1060 urb->actual_length) ? 1 : 0);
1061 spin_unlock(&odev->net_lock);
1064 /* We are done with this URB, resubmit it. Prep the USB to wait for
1065 * another frame. Reuse same as received. */
1066 usb_fill_bulk_urb(urb,
1067 odev->parent->usb,
1068 usb_rcvbulkpipe(odev->parent->usb,
1069 odev->in_endp->
1070 bEndpointAddress & 0x7F),
1071 urb->transfer_buffer, MUX_BULK_RX_BUF_SIZE,
1072 read_bulk_callback, odev);
1074 /* Give this to the USB subsystem so it can tell us when more data
1075 * arrives. */
1076 result = usb_submit_urb(urb, GFP_ATOMIC);
1077 if (result)
1078 dev_warn(&odev->parent->interface->dev,
1079 "%s failed submit mux_bulk_rx_urb %d\n", __func__,
1080 result);
1083 /* Serial driver functions */
1085 static void hso_init_termios(struct ktermios *termios)
1088 * The default requirements for this device are:
1090 termios->c_iflag &=
1091 ~(IGNBRK /* disable ignore break */
1092 | BRKINT /* disable break causes interrupt */
1093 | PARMRK /* disable mark parity errors */
1094 | ISTRIP /* disable clear high bit of input characters */
1095 | INLCR /* disable translate NL to CR */
1096 | IGNCR /* disable ignore CR */
1097 | ICRNL /* disable translate CR to NL */
1098 | IXON); /* disable enable XON/XOFF flow control */
1100 /* disable postprocess output characters */
1101 termios->c_oflag &= ~OPOST;
1103 termios->c_lflag &=
1104 ~(ECHO /* disable echo input characters */
1105 | ECHONL /* disable echo new line */
1106 | ICANON /* disable erase, kill, werase, and rprnt
1107 special characters */
1108 | ISIG /* disable interrupt, quit, and suspend special
1109 characters */
1110 | IEXTEN); /* disable non-POSIX special characters */
1112 termios->c_cflag &=
1113 ~(CSIZE /* no size */
1114 | PARENB /* disable parity bit */
1115 | CBAUD /* clear current baud rate */
1116 | CBAUDEX); /* clear current buad rate */
1118 termios->c_cflag |= CS8; /* character size 8 bits */
1120 /* baud rate 115200 */
1121 tty_termios_encode_baud_rate(termios, 115200, 115200);
1124 static void _hso_serial_set_termios(struct tty_struct *tty,
1125 struct ktermios *old)
1127 struct hso_serial *serial = get_serial_by_tty(tty);
1128 struct ktermios *termios;
1130 if (!serial) {
1131 printk(KERN_ERR "%s: no tty structures", __func__);
1132 return;
1135 D4("port %d", serial->minor);
1138 * Fix up unsupported bits
1140 termios = tty->termios;
1141 termios->c_iflag &= ~IXON; /* disable enable XON/XOFF flow control */
1143 termios->c_cflag &=
1144 ~(CSIZE /* no size */
1145 | PARENB /* disable parity bit */
1146 | CBAUD /* clear current baud rate */
1147 | CBAUDEX); /* clear current buad rate */
1149 termios->c_cflag |= CS8; /* character size 8 bits */
1151 /* baud rate 115200 */
1152 tty_encode_baud_rate(tty, 115200, 115200);
1155 static void hso_resubmit_rx_bulk_urb(struct hso_serial *serial, struct urb *urb)
1157 int result;
1158 /* We are done with this URB, resubmit it. Prep the USB to wait for
1159 * another frame */
1160 usb_fill_bulk_urb(urb, serial->parent->usb,
1161 usb_rcvbulkpipe(serial->parent->usb,
1162 serial->in_endp->
1163 bEndpointAddress & 0x7F),
1164 urb->transfer_buffer, serial->rx_data_length,
1165 hso_std_serial_read_bulk_callback, serial);
1166 /* Give this to the USB subsystem so it can tell us when more data
1167 * arrives. */
1168 result = usb_submit_urb(urb, GFP_ATOMIC);
1169 if (result) {
1170 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1171 __func__, result);
1178 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1180 int count;
1181 struct urb *curr_urb;
1183 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1184 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1185 count = put_rxbuf_data(curr_urb, serial);
1186 if (count == -1)
1187 return;
1188 if (count == 0) {
1189 serial->curr_rx_urb_idx++;
1190 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1191 serial->curr_rx_urb_idx = 0;
1192 hso_resubmit_rx_bulk_urb(serial, curr_urb);
1197 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1199 int count = 0;
1200 struct urb *urb;
1202 urb = serial->rx_urb[0];
1203 if (serial->open_count > 0) {
1204 count = put_rxbuf_data(urb, serial);
1205 if (count == -1)
1206 return;
1208 /* Re issue a read as long as we receive data. */
1210 if (count == 0 && ((urb->actual_length != 0) ||
1211 (serial->rx_state == RX_PENDING))) {
1212 serial->rx_state = RX_SENT;
1213 hso_mux_serial_read(serial);
1214 } else
1215 serial->rx_state = RX_IDLE;
1219 /* read callback for Diag and CS port */
1220 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1222 struct hso_serial *serial = urb->context;
1223 int status = urb->status;
1225 /* sanity check */
1226 if (!serial) {
1227 D1("serial == NULL");
1228 return;
1229 } else if (status) {
1230 handle_usb_error(status, __func__, serial->parent);
1231 return;
1234 D4("\n--- Got serial_read_bulk callback %02x ---", status);
1235 D1("Actual length = %d\n", urb->actual_length);
1236 DUMP1(urb->transfer_buffer, urb->actual_length);
1238 /* Anyone listening? */
1239 if (serial->open_count == 0)
1240 return;
1242 if (status == 0) {
1243 if (serial->parent->port_spec & HSO_INFO_CRC_BUG) {
1244 u32 rest;
1245 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1246 rest =
1247 urb->actual_length %
1248 le16_to_cpu(serial->in_endp->wMaxPacketSize);
1249 if (((rest == 5) || (rest == 6)) &&
1250 !memcmp(((u8 *) urb->transfer_buffer) +
1251 urb->actual_length - 4, crc_check, 4)) {
1252 urb->actual_length -= 4;
1255 /* Valid data, handle RX data */
1256 spin_lock(&serial->serial_lock);
1257 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1258 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1259 spin_unlock(&serial->serial_lock);
1260 } else if (status == -ENOENT || status == -ECONNRESET) {
1261 /* Unlinked - check for throttled port. */
1262 D2("Port %d, successfully unlinked urb", serial->minor);
1263 spin_lock(&serial->serial_lock);
1264 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
1265 hso_resubmit_rx_bulk_urb(serial, urb);
1266 spin_unlock(&serial->serial_lock);
1267 } else {
1268 D2("Port %d, status = %d for read urb", serial->minor, status);
1269 return;
1274 * This needs to be a tasklet otherwise we will
1275 * end up recursively calling this function.
1277 static void hso_unthrottle_tasklet(struct hso_serial *serial)
1279 unsigned long flags;
1281 spin_lock_irqsave(&serial->serial_lock, flags);
1282 if ((serial->parent->port_spec & HSO_INTF_MUX))
1283 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1284 else
1285 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1286 spin_unlock_irqrestore(&serial->serial_lock, flags);
1289 static void hso_unthrottle(struct tty_struct *tty)
1291 struct hso_serial *serial = get_serial_by_tty(tty);
1293 tasklet_hi_schedule(&serial->unthrottle_tasklet);
1296 static void hso_unthrottle_workfunc(struct work_struct *work)
1298 struct hso_serial *serial =
1299 container_of(work, struct hso_serial,
1300 retry_unthrottle_workqueue);
1301 hso_unthrottle_tasklet(serial);
1304 /* open the requested serial port */
1305 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1307 struct hso_serial *serial = get_serial_by_index(tty->index);
1308 int result;
1310 /* sanity check */
1311 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1312 WARN_ON(1);
1313 tty->driver_data = NULL;
1314 D1("Failed to open port");
1315 return -ENODEV;
1318 mutex_lock(&serial->parent->mutex);
1319 result = usb_autopm_get_interface(serial->parent->interface);
1320 if (result < 0)
1321 goto err_out;
1323 D1("Opening %d", serial->minor);
1324 kref_get(&serial->parent->ref);
1326 /* setup */
1327 spin_lock_irq(&serial->serial_lock);
1328 tty->driver_data = serial;
1329 tty_kref_put(serial->tty);
1330 serial->tty = tty_kref_get(tty);
1331 spin_unlock_irq(&serial->serial_lock);
1333 /* check for port already opened, if not set the termios */
1334 serial->open_count++;
1335 if (serial->open_count == 1) {
1336 serial->rx_state = RX_IDLE;
1337 /* Force default termio settings */
1338 _hso_serial_set_termios(tty, NULL);
1339 tasklet_init(&serial->unthrottle_tasklet,
1340 (void (*)(unsigned long))hso_unthrottle_tasklet,
1341 (unsigned long)serial);
1342 INIT_WORK(&serial->retry_unthrottle_workqueue,
1343 hso_unthrottle_workfunc);
1344 result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1345 if (result) {
1346 hso_stop_serial_device(serial->parent);
1347 serial->open_count--;
1348 kref_put(&serial->parent->ref, hso_serial_ref_free);
1350 } else {
1351 D1("Port was already open");
1354 usb_autopm_put_interface(serial->parent->interface);
1356 /* done */
1357 if (result)
1358 hso_serial_tiocmset(tty, NULL, TIOCM_RTS | TIOCM_DTR, 0);
1359 err_out:
1360 mutex_unlock(&serial->parent->mutex);
1361 return result;
1364 /* close the requested serial port */
1365 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1367 struct hso_serial *serial = tty->driver_data;
1368 u8 usb_gone;
1370 D1("Closing serial port");
1372 /* Open failed, no close cleanup required */
1373 if (serial == NULL)
1374 return;
1376 mutex_lock(&serial->parent->mutex);
1377 usb_gone = serial->parent->usb_gone;
1379 if (!usb_gone)
1380 usb_autopm_get_interface(serial->parent->interface);
1382 /* reset the rts and dtr */
1383 /* do the actual close */
1384 serial->open_count--;
1386 if (serial->open_count <= 0) {
1387 serial->open_count = 0;
1388 spin_lock_irq(&serial->serial_lock);
1389 if (serial->tty == tty) {
1390 serial->tty->driver_data = NULL;
1391 serial->tty = NULL;
1392 tty_kref_put(tty);
1394 spin_unlock_irq(&serial->serial_lock);
1395 if (!usb_gone)
1396 hso_stop_serial_device(serial->parent);
1397 tasklet_kill(&serial->unthrottle_tasklet);
1398 cancel_work_sync(&serial->retry_unthrottle_workqueue);
1401 if (!usb_gone)
1402 usb_autopm_put_interface(serial->parent->interface);
1404 mutex_unlock(&serial->parent->mutex);
1406 kref_put(&serial->parent->ref, hso_serial_ref_free);
1409 /* close the requested serial port */
1410 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1411 int count)
1413 struct hso_serial *serial = get_serial_by_tty(tty);
1414 int space, tx_bytes;
1415 unsigned long flags;
1417 /* sanity check */
1418 if (serial == NULL) {
1419 printk(KERN_ERR "%s: serial is NULL\n", __func__);
1420 return -ENODEV;
1423 spin_lock_irqsave(&serial->serial_lock, flags);
1425 space = serial->tx_data_length - serial->tx_buffer_count;
1426 tx_bytes = (count < space) ? count : space;
1428 if (!tx_bytes)
1429 goto out;
1431 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1432 serial->tx_buffer_count += tx_bytes;
1434 out:
1435 spin_unlock_irqrestore(&serial->serial_lock, flags);
1437 hso_kick_transmit(serial);
1438 /* done */
1439 return tx_bytes;
1442 /* how much room is there for writing */
1443 static int hso_serial_write_room(struct tty_struct *tty)
1445 struct hso_serial *serial = get_serial_by_tty(tty);
1446 int room;
1447 unsigned long flags;
1449 spin_lock_irqsave(&serial->serial_lock, flags);
1450 room = serial->tx_data_length - serial->tx_buffer_count;
1451 spin_unlock_irqrestore(&serial->serial_lock, flags);
1453 /* return free room */
1454 return room;
1457 /* setup the term */
1458 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1460 struct hso_serial *serial = get_serial_by_tty(tty);
1461 unsigned long flags;
1463 if (old)
1464 D5("Termios called with: cflags new[%d] - old[%d]",
1465 tty->termios->c_cflag, old->c_cflag);
1467 /* the actual setup */
1468 spin_lock_irqsave(&serial->serial_lock, flags);
1469 if (serial->open_count)
1470 _hso_serial_set_termios(tty, old);
1471 else
1472 tty->termios = old;
1473 spin_unlock_irqrestore(&serial->serial_lock, flags);
1475 /* done */
1478 /* how many characters in the buffer */
1479 static int hso_serial_chars_in_buffer(struct tty_struct *tty)
1481 struct hso_serial *serial = get_serial_by_tty(tty);
1482 int chars;
1483 unsigned long flags;
1485 /* sanity check */
1486 if (serial == NULL)
1487 return 0;
1489 spin_lock_irqsave(&serial->serial_lock, flags);
1490 chars = serial->tx_buffer_count;
1491 spin_unlock_irqrestore(&serial->serial_lock, flags);
1493 return chars;
1495 static int tiocmget_submit_urb(struct hso_serial *serial,
1496 struct hso_tiocmget *tiocmget,
1497 struct usb_device *usb)
1499 int result;
1501 if (serial->parent->usb_gone)
1502 return -ENODEV;
1503 usb_fill_int_urb(tiocmget->urb, usb,
1504 usb_rcvintpipe(usb,
1505 tiocmget->endp->
1506 bEndpointAddress & 0x7F),
1507 &tiocmget->serial_state_notification,
1508 sizeof(struct hso_serial_state_notification),
1509 tiocmget_intr_callback, serial,
1510 tiocmget->endp->bInterval);
1511 result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC);
1512 if (result) {
1513 dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__,
1514 result);
1516 return result;
1520 static void tiocmget_intr_callback(struct urb *urb)
1522 struct hso_serial *serial = urb->context;
1523 struct hso_tiocmget *tiocmget;
1524 int status = urb->status;
1525 u16 UART_state_bitmap, prev_UART_state_bitmap;
1526 struct uart_icount *icount;
1527 struct hso_serial_state_notification *serial_state_notification;
1528 struct usb_device *usb;
1530 /* Sanity checks */
1531 if (!serial)
1532 return;
1533 if (status) {
1534 handle_usb_error(status, __func__, serial->parent);
1535 return;
1537 tiocmget = serial->tiocmget;
1538 if (!tiocmget)
1539 return;
1540 usb = serial->parent->usb;
1541 serial_state_notification = &tiocmget->serial_state_notification;
1542 if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1543 serial_state_notification->bNotification != B_NOTIFICATION ||
1544 le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1545 le16_to_cpu(serial_state_notification->wIndex) != W_INDEX ||
1546 le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1547 dev_warn(&usb->dev,
1548 "hso received invalid serial state notification\n");
1549 DUMP(serial_state_notification,
1550 sizeof(struct hso_serial_state_notification));
1551 } else {
1553 UART_state_bitmap = le16_to_cpu(serial_state_notification->
1554 UART_state_bitmap);
1555 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1556 icount = &tiocmget->icount;
1557 spin_lock(&serial->serial_lock);
1558 if ((UART_state_bitmap & B_OVERRUN) !=
1559 (prev_UART_state_bitmap & B_OVERRUN))
1560 icount->parity++;
1561 if ((UART_state_bitmap & B_PARITY) !=
1562 (prev_UART_state_bitmap & B_PARITY))
1563 icount->parity++;
1564 if ((UART_state_bitmap & B_FRAMING) !=
1565 (prev_UART_state_bitmap & B_FRAMING))
1566 icount->frame++;
1567 if ((UART_state_bitmap & B_RING_SIGNAL) &&
1568 !(prev_UART_state_bitmap & B_RING_SIGNAL))
1569 icount->rng++;
1570 if ((UART_state_bitmap & B_BREAK) !=
1571 (prev_UART_state_bitmap & B_BREAK))
1572 icount->brk++;
1573 if ((UART_state_bitmap & B_TX_CARRIER) !=
1574 (prev_UART_state_bitmap & B_TX_CARRIER))
1575 icount->dsr++;
1576 if ((UART_state_bitmap & B_RX_CARRIER) !=
1577 (prev_UART_state_bitmap & B_RX_CARRIER))
1578 icount->dcd++;
1579 tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1580 spin_unlock(&serial->serial_lock);
1581 tiocmget->intr_completed = 1;
1582 wake_up_interruptible(&tiocmget->waitq);
1584 memset(serial_state_notification, 0,
1585 sizeof(struct hso_serial_state_notification));
1586 tiocmget_submit_urb(serial,
1587 tiocmget,
1588 serial->parent->usb);
1592 * next few functions largely stolen from drivers/serial/serial_core.c
1594 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1595 * - mask passed in arg for lines of interest
1596 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1597 * Caller should use TIOCGICOUNT to see which one it was
1599 static int
1600 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1602 DECLARE_WAITQUEUE(wait, current);
1603 struct uart_icount cprev, cnow;
1604 struct hso_tiocmget *tiocmget;
1605 int ret;
1607 tiocmget = serial->tiocmget;
1608 if (!tiocmget)
1609 return -ENOENT;
1611 * note the counters on entry
1613 spin_lock_irq(&serial->serial_lock);
1614 memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1615 spin_unlock_irq(&serial->serial_lock);
1616 add_wait_queue(&tiocmget->waitq, &wait);
1617 for (;;) {
1618 spin_lock_irq(&serial->serial_lock);
1619 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1620 spin_unlock_irq(&serial->serial_lock);
1621 set_current_state(TASK_INTERRUPTIBLE);
1622 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1623 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1624 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd))) {
1625 ret = 0;
1626 break;
1628 schedule();
1629 /* see if a signal did it */
1630 if (signal_pending(current)) {
1631 ret = -ERESTARTSYS;
1632 break;
1634 cprev = cnow;
1636 current->state = TASK_RUNNING;
1637 remove_wait_queue(&tiocmget->waitq, &wait);
1639 return ret;
1643 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1644 * Return: write counters to the user passed counter struct
1645 * NB: both 1->0 and 0->1 transitions are counted except for
1646 * RI where only 0->1 is counted.
1648 static int hso_get_count(struct tty_struct *tty,
1649 struct serial_icounter_struct *icount)
1651 struct uart_icount cnow;
1652 struct hso_serial *serial = get_serial_by_tty(tty);
1653 struct hso_tiocmget *tiocmget = serial->tiocmget;
1655 memset(&icount, 0, sizeof(struct serial_icounter_struct));
1657 if (!tiocmget)
1658 return -ENOENT;
1659 spin_lock_irq(&serial->serial_lock);
1660 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1661 spin_unlock_irq(&serial->serial_lock);
1663 icount->cts = cnow.cts;
1664 icount->dsr = cnow.dsr;
1665 icount->rng = cnow.rng;
1666 icount->dcd = cnow.dcd;
1667 icount->rx = cnow.rx;
1668 icount->tx = cnow.tx;
1669 icount->frame = cnow.frame;
1670 icount->overrun = cnow.overrun;
1671 icount->parity = cnow.parity;
1672 icount->brk = cnow.brk;
1673 icount->buf_overrun = cnow.buf_overrun;
1675 return 0;
1679 static int hso_serial_tiocmget(struct tty_struct *tty, struct file *file)
1681 int retval;
1682 struct hso_serial *serial = get_serial_by_tty(tty);
1683 struct hso_tiocmget *tiocmget;
1684 u16 UART_state_bitmap;
1686 /* sanity check */
1687 if (!serial) {
1688 D1("no tty structures");
1689 return -EINVAL;
1691 spin_lock_irq(&serial->serial_lock);
1692 retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1693 ((serial->dtr_state) ? TIOCM_DTR : 0);
1694 tiocmget = serial->tiocmget;
1695 if (tiocmget) {
1697 UART_state_bitmap = le16_to_cpu(
1698 tiocmget->prev_UART_state_bitmap);
1699 if (UART_state_bitmap & B_RING_SIGNAL)
1700 retval |= TIOCM_RNG;
1701 if (UART_state_bitmap & B_RX_CARRIER)
1702 retval |= TIOCM_CD;
1703 if (UART_state_bitmap & B_TX_CARRIER)
1704 retval |= TIOCM_DSR;
1706 spin_unlock_irq(&serial->serial_lock);
1707 return retval;
1710 static int hso_serial_tiocmset(struct tty_struct *tty, struct file *file,
1711 unsigned int set, unsigned int clear)
1713 int val = 0;
1714 unsigned long flags;
1715 int if_num;
1716 struct hso_serial *serial = get_serial_by_tty(tty);
1718 /* sanity check */
1719 if (!serial) {
1720 D1("no tty structures");
1721 return -EINVAL;
1724 if ((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM)
1725 return -EINVAL;
1727 if_num = serial->parent->interface->altsetting->desc.bInterfaceNumber;
1729 spin_lock_irqsave(&serial->serial_lock, flags);
1730 if (set & TIOCM_RTS)
1731 serial->rts_state = 1;
1732 if (set & TIOCM_DTR)
1733 serial->dtr_state = 1;
1735 if (clear & TIOCM_RTS)
1736 serial->rts_state = 0;
1737 if (clear & TIOCM_DTR)
1738 serial->dtr_state = 0;
1740 if (serial->dtr_state)
1741 val |= 0x01;
1742 if (serial->rts_state)
1743 val |= 0x02;
1745 spin_unlock_irqrestore(&serial->serial_lock, flags);
1747 return usb_control_msg(serial->parent->usb,
1748 usb_rcvctrlpipe(serial->parent->usb, 0), 0x22,
1749 0x21, val, if_num, NULL, 0,
1750 USB_CTRL_SET_TIMEOUT);
1753 static int hso_serial_ioctl(struct tty_struct *tty, struct file *file,
1754 unsigned int cmd, unsigned long arg)
1756 struct hso_serial *serial = get_serial_by_tty(tty);
1757 void __user *uarg = (void __user *)arg;
1758 int ret = 0;
1759 D4("IOCTL cmd: %d, arg: %ld", cmd, arg);
1761 if (!serial)
1762 return -ENODEV;
1763 switch (cmd) {
1764 case TIOCMIWAIT:
1765 ret = hso_wait_modem_status(serial, arg);
1766 break;
1767 default:
1768 ret = -ENOIOCTLCMD;
1769 break;
1771 return ret;
1775 /* starts a transmit */
1776 static void hso_kick_transmit(struct hso_serial *serial)
1778 u8 *temp;
1779 unsigned long flags;
1780 int res;
1782 spin_lock_irqsave(&serial->serial_lock, flags);
1783 if (!serial->tx_buffer_count)
1784 goto out;
1786 if (serial->tx_urb_used)
1787 goto out;
1789 /* Wakeup USB interface if necessary */
1790 if (hso_get_activity(serial->parent) == -EAGAIN)
1791 goto out;
1793 /* Switch pointers around to avoid memcpy */
1794 temp = serial->tx_buffer;
1795 serial->tx_buffer = serial->tx_data;
1796 serial->tx_data = temp;
1797 serial->tx_data_count = serial->tx_buffer_count;
1798 serial->tx_buffer_count = 0;
1800 /* If temp is set, it means we switched buffers */
1801 if (temp && serial->write_data) {
1802 res = serial->write_data(serial);
1803 if (res >= 0)
1804 serial->tx_urb_used = 1;
1806 out:
1807 spin_unlock_irqrestore(&serial->serial_lock, flags);
1810 /* make a request (for reading and writing data to muxed serial port) */
1811 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1812 struct urb *ctrl_urb,
1813 struct usb_ctrlrequest *ctrl_req,
1814 u8 *ctrl_urb_data, u32 size)
1816 int result;
1817 int pipe;
1819 /* Sanity check */
1820 if (!serial || !ctrl_urb || !ctrl_req) {
1821 printk(KERN_ERR "%s: Wrong arguments\n", __func__);
1822 return -EINVAL;
1825 /* initialize */
1826 ctrl_req->wValue = 0;
1827 ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1828 ctrl_req->wLength = cpu_to_le16(size);
1830 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1831 /* Reading command */
1832 ctrl_req->bRequestType = USB_DIR_IN |
1833 USB_TYPE_OPTION_VENDOR |
1834 USB_RECIP_INTERFACE;
1835 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1836 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1837 } else {
1838 /* Writing command */
1839 ctrl_req->bRequestType = USB_DIR_OUT |
1840 USB_TYPE_OPTION_VENDOR |
1841 USB_RECIP_INTERFACE;
1842 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1843 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1845 /* syslog */
1846 D2("%s command (%02x) len: %d, port: %d",
1847 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1848 ctrl_req->bRequestType, ctrl_req->wLength, port);
1850 /* Load ctrl urb */
1851 ctrl_urb->transfer_flags = 0;
1852 usb_fill_control_urb(ctrl_urb,
1853 serial->parent->usb,
1854 pipe,
1855 (u8 *) ctrl_req,
1856 ctrl_urb_data, size, ctrl_callback, serial);
1857 /* Send it on merry way */
1858 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1859 if (result) {
1860 dev_err(&ctrl_urb->dev->dev,
1861 "%s failed submit ctrl_urb %d type %d\n", __func__,
1862 result, type);
1863 return result;
1866 /* done */
1867 return size;
1870 /* called by intr_callback when read occurs */
1871 static int hso_mux_serial_read(struct hso_serial *serial)
1873 if (!serial)
1874 return -EINVAL;
1876 /* clean data */
1877 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1878 /* make the request */
1880 if (serial->num_rx_urbs != 1) {
1881 dev_err(&serial->parent->interface->dev,
1882 "ERROR: mux'd reads with multiple buffers "
1883 "not possible\n");
1884 return 0;
1886 return mux_device_request(serial,
1887 USB_CDC_GET_ENCAPSULATED_RESPONSE,
1888 serial->parent->port_spec & HSO_PORT_MASK,
1889 serial->rx_urb[0],
1890 &serial->ctrl_req_rx,
1891 serial->rx_data[0], serial->rx_data_length);
1894 /* used for muxed serial port callback (muxed serial read) */
1895 static void intr_callback(struct urb *urb)
1897 struct hso_shared_int *shared_int = urb->context;
1898 struct hso_serial *serial;
1899 unsigned char *port_req;
1900 int status = urb->status;
1901 int i;
1903 usb_mark_last_busy(urb->dev);
1905 /* sanity check */
1906 if (!shared_int)
1907 return;
1909 /* status check */
1910 if (status) {
1911 handle_usb_error(status, __func__, NULL);
1912 return;
1914 D4("\n--- Got intr callback 0x%02X ---", status);
1916 /* what request? */
1917 port_req = urb->transfer_buffer;
1918 D4(" port_req = 0x%.2X\n", *port_req);
1919 /* loop over all muxed ports to find the one sending this */
1920 for (i = 0; i < 8; i++) {
1921 /* max 8 channels on MUX */
1922 if (*port_req & (1 << i)) {
1923 serial = get_serial_by_shared_int_and_type(shared_int,
1924 (1 << i));
1925 if (serial != NULL) {
1926 D1("Pending read interrupt on port %d\n", i);
1927 spin_lock(&serial->serial_lock);
1928 if (serial->rx_state == RX_IDLE &&
1929 serial->open_count > 0) {
1930 /* Setup and send a ctrl req read on
1931 * port i */
1932 if (!serial->rx_urb_filled[0]) {
1933 serial->rx_state = RX_SENT;
1934 hso_mux_serial_read(serial);
1935 } else
1936 serial->rx_state = RX_PENDING;
1937 } else {
1938 D1("Already a read pending on "
1939 "port %d or port not open\n", i);
1941 spin_unlock(&serial->serial_lock);
1945 /* Resubmit interrupt urb */
1946 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1949 /* called for writing to muxed serial port */
1950 static int hso_mux_serial_write_data(struct hso_serial *serial)
1952 if (NULL == serial)
1953 return -EINVAL;
1955 return mux_device_request(serial,
1956 USB_CDC_SEND_ENCAPSULATED_COMMAND,
1957 serial->parent->port_spec & HSO_PORT_MASK,
1958 serial->tx_urb,
1959 &serial->ctrl_req_tx,
1960 serial->tx_data, serial->tx_data_count);
1963 /* write callback for Diag and CS port */
1964 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1966 struct hso_serial *serial = urb->context;
1967 int status = urb->status;
1968 struct tty_struct *tty;
1970 /* sanity check */
1971 if (!serial) {
1972 D1("serial == NULL");
1973 return;
1976 spin_lock(&serial->serial_lock);
1977 serial->tx_urb_used = 0;
1978 tty = tty_kref_get(serial->tty);
1979 spin_unlock(&serial->serial_lock);
1980 if (status) {
1981 handle_usb_error(status, __func__, serial->parent);
1982 tty_kref_put(tty);
1983 return;
1985 hso_put_activity(serial->parent);
1986 if (tty) {
1987 tty_wakeup(tty);
1988 tty_kref_put(tty);
1990 hso_kick_transmit(serial);
1992 D1(" ");
1995 /* called for writing diag or CS serial port */
1996 static int hso_std_serial_write_data(struct hso_serial *serial)
1998 int count = serial->tx_data_count;
1999 int result;
2001 usb_fill_bulk_urb(serial->tx_urb,
2002 serial->parent->usb,
2003 usb_sndbulkpipe(serial->parent->usb,
2004 serial->out_endp->
2005 bEndpointAddress & 0x7F),
2006 serial->tx_data, serial->tx_data_count,
2007 hso_std_serial_write_bulk_callback, serial);
2009 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
2010 if (result) {
2011 dev_warn(&serial->parent->usb->dev,
2012 "Failed to submit urb - res %d\n", result);
2013 return result;
2016 return count;
2019 /* callback after read or write on muxed serial port */
2020 static void ctrl_callback(struct urb *urb)
2022 struct hso_serial *serial = urb->context;
2023 struct usb_ctrlrequest *req;
2024 int status = urb->status;
2025 struct tty_struct *tty;
2027 /* sanity check */
2028 if (!serial)
2029 return;
2031 spin_lock(&serial->serial_lock);
2032 serial->tx_urb_used = 0;
2033 tty = tty_kref_get(serial->tty);
2034 spin_unlock(&serial->serial_lock);
2035 if (status) {
2036 handle_usb_error(status, __func__, serial->parent);
2037 tty_kref_put(tty);
2038 return;
2041 /* what request? */
2042 req = (struct usb_ctrlrequest *)(urb->setup_packet);
2043 D4("\n--- Got muxed ctrl callback 0x%02X ---", status);
2044 D4("Actual length of urb = %d\n", urb->actual_length);
2045 DUMP1(urb->transfer_buffer, urb->actual_length);
2047 if (req->bRequestType ==
2048 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
2049 /* response to a read command */
2050 serial->rx_urb_filled[0] = 1;
2051 spin_lock(&serial->serial_lock);
2052 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
2053 spin_unlock(&serial->serial_lock);
2054 } else {
2055 hso_put_activity(serial->parent);
2056 if (tty)
2057 tty_wakeup(tty);
2058 /* response to a write command */
2059 hso_kick_transmit(serial);
2061 tty_kref_put(tty);
2064 /* handle RX data for serial port */
2065 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
2067 struct tty_struct *tty;
2068 int write_length_remaining = 0;
2069 int curr_write_len;
2071 /* Sanity check */
2072 if (urb == NULL || serial == NULL) {
2073 D1("serial = NULL");
2074 return -2;
2077 /* All callers to put_rxbuf_data hold serial_lock */
2078 tty = tty_kref_get(serial->tty);
2080 /* Push data to tty */
2081 if (tty) {
2082 write_length_remaining = urb->actual_length -
2083 serial->curr_rx_urb_offset;
2084 D1("data to push to tty");
2085 while (write_length_remaining) {
2086 if (test_bit(TTY_THROTTLED, &tty->flags)) {
2087 tty_kref_put(tty);
2088 return -1;
2090 curr_write_len = tty_insert_flip_string
2091 (tty, urb->transfer_buffer +
2092 serial->curr_rx_urb_offset,
2093 write_length_remaining);
2094 serial->curr_rx_urb_offset += curr_write_len;
2095 write_length_remaining -= curr_write_len;
2096 tty_flip_buffer_push(tty);
2099 if (write_length_remaining == 0) {
2100 serial->curr_rx_urb_offset = 0;
2101 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2103 tty_kref_put(tty);
2104 return write_length_remaining;
2108 /* Base driver functions */
2110 static void hso_log_port(struct hso_device *hso_dev)
2112 char *port_type;
2113 char port_dev[20];
2115 switch (hso_dev->port_spec & HSO_PORT_MASK) {
2116 case HSO_PORT_CONTROL:
2117 port_type = "Control";
2118 break;
2119 case HSO_PORT_APP:
2120 port_type = "Application";
2121 break;
2122 case HSO_PORT_GPS:
2123 port_type = "GPS";
2124 break;
2125 case HSO_PORT_GPS_CONTROL:
2126 port_type = "GPS control";
2127 break;
2128 case HSO_PORT_APP2:
2129 port_type = "Application2";
2130 break;
2131 case HSO_PORT_PCSC:
2132 port_type = "PCSC";
2133 break;
2134 case HSO_PORT_DIAG:
2135 port_type = "Diagnostic";
2136 break;
2137 case HSO_PORT_DIAG2:
2138 port_type = "Diagnostic2";
2139 break;
2140 case HSO_PORT_MODEM:
2141 port_type = "Modem";
2142 break;
2143 case HSO_PORT_NETWORK:
2144 port_type = "Network";
2145 break;
2146 default:
2147 port_type = "Unknown";
2148 break;
2150 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2151 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2152 } else
2153 sprintf(port_dev, "/dev/%s%d", tty_filename,
2154 dev2ser(hso_dev)->minor);
2156 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2157 port_type, port_dev);
2160 static int hso_start_net_device(struct hso_device *hso_dev)
2162 int i, result = 0;
2163 struct hso_net *hso_net = dev2net(hso_dev);
2165 if (!hso_net)
2166 return -ENODEV;
2168 /* send URBs for all read buffers */
2169 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2171 /* Prep a receive URB */
2172 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2173 hso_dev->usb,
2174 usb_rcvbulkpipe(hso_dev->usb,
2175 hso_net->in_endp->
2176 bEndpointAddress & 0x7F),
2177 hso_net->mux_bulk_rx_buf_pool[i],
2178 MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2179 hso_net);
2181 /* Put it out there so the device can send us stuff */
2182 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2183 GFP_NOIO);
2184 if (result)
2185 dev_warn(&hso_dev->usb->dev,
2186 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2187 i, result);
2190 return result;
2193 static int hso_stop_net_device(struct hso_device *hso_dev)
2195 int i;
2196 struct hso_net *hso_net = dev2net(hso_dev);
2198 if (!hso_net)
2199 return -ENODEV;
2201 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2202 if (hso_net->mux_bulk_rx_urb_pool[i])
2203 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2206 if (hso_net->mux_bulk_tx_urb)
2207 usb_kill_urb(hso_net->mux_bulk_tx_urb);
2209 return 0;
2212 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2214 int i, result = 0;
2215 struct hso_serial *serial = dev2ser(hso_dev);
2217 if (!serial)
2218 return -ENODEV;
2220 /* If it is not the MUX port fill in and submit a bulk urb (already
2221 * allocated in hso_serial_start) */
2222 if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2223 for (i = 0; i < serial->num_rx_urbs; i++) {
2224 usb_fill_bulk_urb(serial->rx_urb[i],
2225 serial->parent->usb,
2226 usb_rcvbulkpipe(serial->parent->usb,
2227 serial->in_endp->
2228 bEndpointAddress &
2229 0x7F),
2230 serial->rx_data[i],
2231 serial->rx_data_length,
2232 hso_std_serial_read_bulk_callback,
2233 serial);
2234 result = usb_submit_urb(serial->rx_urb[i], flags);
2235 if (result) {
2236 dev_warn(&serial->parent->usb->dev,
2237 "Failed to submit urb - res %d\n",
2238 result);
2239 break;
2242 } else {
2243 mutex_lock(&serial->shared_int->shared_int_lock);
2244 if (!serial->shared_int->use_count) {
2245 result =
2246 hso_mux_submit_intr_urb(serial->shared_int,
2247 hso_dev->usb, flags);
2249 serial->shared_int->use_count++;
2250 mutex_unlock(&serial->shared_int->shared_int_lock);
2252 if (serial->tiocmget)
2253 tiocmget_submit_urb(serial,
2254 serial->tiocmget,
2255 serial->parent->usb);
2256 return result;
2259 static int hso_stop_serial_device(struct hso_device *hso_dev)
2261 int i;
2262 struct hso_serial *serial = dev2ser(hso_dev);
2263 struct hso_tiocmget *tiocmget;
2265 if (!serial)
2266 return -ENODEV;
2268 for (i = 0; i < serial->num_rx_urbs; i++) {
2269 if (serial->rx_urb[i]) {
2270 usb_kill_urb(serial->rx_urb[i]);
2271 serial->rx_urb_filled[i] = 0;
2274 serial->curr_rx_urb_idx = 0;
2275 serial->curr_rx_urb_offset = 0;
2277 if (serial->tx_urb)
2278 usb_kill_urb(serial->tx_urb);
2280 if (serial->shared_int) {
2281 mutex_lock(&serial->shared_int->shared_int_lock);
2282 if (serial->shared_int->use_count &&
2283 (--serial->shared_int->use_count == 0)) {
2284 struct urb *urb;
2286 urb = serial->shared_int->shared_intr_urb;
2287 if (urb)
2288 usb_kill_urb(urb);
2290 mutex_unlock(&serial->shared_int->shared_int_lock);
2292 tiocmget = serial->tiocmget;
2293 if (tiocmget) {
2294 wake_up_interruptible(&tiocmget->waitq);
2295 usb_kill_urb(tiocmget->urb);
2298 return 0;
2301 static void hso_serial_common_free(struct hso_serial *serial)
2303 int i;
2305 if (serial->parent->dev)
2306 device_remove_file(serial->parent->dev, &dev_attr_hsotype);
2308 tty_unregister_device(tty_drv, serial->minor);
2310 for (i = 0; i < serial->num_rx_urbs; i++) {
2311 /* unlink and free RX URB */
2312 usb_free_urb(serial->rx_urb[i]);
2313 /* free the RX buffer */
2314 kfree(serial->rx_data[i]);
2317 /* unlink and free TX URB */
2318 usb_free_urb(serial->tx_urb);
2319 kfree(serial->tx_data);
2322 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
2323 int rx_size, int tx_size)
2325 struct device *dev;
2326 int minor;
2327 int i;
2329 minor = get_free_serial_index();
2330 if (minor < 0)
2331 goto exit;
2333 /* register our minor number */
2334 serial->parent->dev = tty_register_device(tty_drv, minor,
2335 &serial->parent->interface->dev);
2336 dev = serial->parent->dev;
2337 dev_set_drvdata(dev, serial->parent);
2338 i = device_create_file(dev, &dev_attr_hsotype);
2340 /* fill in specific data for later use */
2341 serial->minor = minor;
2342 serial->magic = HSO_SERIAL_MAGIC;
2343 spin_lock_init(&serial->serial_lock);
2344 serial->num_rx_urbs = num_urbs;
2346 /* RX, allocate urb and initialize */
2348 /* prepare our RX buffer */
2349 serial->rx_data_length = rx_size;
2350 for (i = 0; i < serial->num_rx_urbs; i++) {
2351 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2352 if (!serial->rx_urb[i]) {
2353 dev_err(dev, "Could not allocate urb?\n");
2354 goto exit;
2356 serial->rx_urb[i]->transfer_buffer = NULL;
2357 serial->rx_urb[i]->transfer_buffer_length = 0;
2358 serial->rx_data[i] = kzalloc(serial->rx_data_length,
2359 GFP_KERNEL);
2360 if (!serial->rx_data[i]) {
2361 dev_err(dev, "%s - Out of memory\n", __func__);
2362 goto exit;
2366 /* TX, allocate urb and initialize */
2367 serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2368 if (!serial->tx_urb) {
2369 dev_err(dev, "Could not allocate urb?\n");
2370 goto exit;
2372 serial->tx_urb->transfer_buffer = NULL;
2373 serial->tx_urb->transfer_buffer_length = 0;
2374 /* prepare our TX buffer */
2375 serial->tx_data_count = 0;
2376 serial->tx_buffer_count = 0;
2377 serial->tx_data_length = tx_size;
2378 serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2379 if (!serial->tx_data) {
2380 dev_err(dev, "%s - Out of memory\n", __func__);
2381 goto exit;
2383 serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2384 if (!serial->tx_buffer) {
2385 dev_err(dev, "%s - Out of memory\n", __func__);
2386 goto exit;
2389 return 0;
2390 exit:
2391 hso_serial_common_free(serial);
2392 return -1;
2395 /* Creates a general hso device */
2396 static struct hso_device *hso_create_device(struct usb_interface *intf,
2397 int port_spec)
2399 struct hso_device *hso_dev;
2401 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2402 if (!hso_dev)
2403 return NULL;
2405 hso_dev->port_spec = port_spec;
2406 hso_dev->usb = interface_to_usbdev(intf);
2407 hso_dev->interface = intf;
2408 kref_init(&hso_dev->ref);
2409 mutex_init(&hso_dev->mutex);
2411 INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2412 INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2413 INIT_WORK(&hso_dev->reset_device, reset_device);
2415 return hso_dev;
2418 /* Removes a network device in the network device table */
2419 static int remove_net_device(struct hso_device *hso_dev)
2421 int i;
2423 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2424 if (network_table[i] == hso_dev) {
2425 network_table[i] = NULL;
2426 break;
2429 if (i == HSO_MAX_NET_DEVICES)
2430 return -1;
2431 return 0;
2434 /* Frees our network device */
2435 static void hso_free_net_device(struct hso_device *hso_dev)
2437 int i;
2438 struct hso_net *hso_net = dev2net(hso_dev);
2440 if (!hso_net)
2441 return;
2443 remove_net_device(hso_net->parent);
2445 if (hso_net->net) {
2446 unregister_netdev(hso_net->net);
2447 free_netdev(hso_net->net);
2450 /* start freeing */
2451 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2452 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2453 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2454 hso_net->mux_bulk_rx_buf_pool[i] = NULL;
2456 usb_free_urb(hso_net->mux_bulk_tx_urb);
2457 kfree(hso_net->mux_bulk_tx_buf);
2458 hso_net->mux_bulk_tx_buf = NULL;
2460 kfree(hso_dev);
2463 static const struct net_device_ops hso_netdev_ops = {
2464 .ndo_open = hso_net_open,
2465 .ndo_stop = hso_net_close,
2466 .ndo_start_xmit = hso_net_start_xmit,
2467 .ndo_tx_timeout = hso_net_tx_timeout,
2470 /* initialize the network interface */
2471 static void hso_net_init(struct net_device *net)
2473 struct hso_net *hso_net = netdev_priv(net);
2475 D1("sizeof hso_net is %d", (int)sizeof(*hso_net));
2477 /* fill in the other fields */
2478 net->netdev_ops = &hso_netdev_ops;
2479 net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2480 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2481 net->type = ARPHRD_NONE;
2482 net->mtu = DEFAULT_MTU - 14;
2483 net->tx_queue_len = 10;
2484 SET_ETHTOOL_OPS(net, &ops);
2486 /* and initialize the semaphore */
2487 spin_lock_init(&hso_net->net_lock);
2490 /* Adds a network device in the network device table */
2491 static int add_net_device(struct hso_device *hso_dev)
2493 int i;
2495 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2496 if (network_table[i] == NULL) {
2497 network_table[i] = hso_dev;
2498 break;
2501 if (i == HSO_MAX_NET_DEVICES)
2502 return -1;
2503 return 0;
2506 static int hso_rfkill_set_block(void *data, bool blocked)
2508 struct hso_device *hso_dev = data;
2509 int enabled = !blocked;
2510 int rv;
2512 mutex_lock(&hso_dev->mutex);
2513 if (hso_dev->usb_gone)
2514 rv = 0;
2515 else
2516 rv = usb_control_msg(hso_dev->usb, usb_rcvctrlpipe(hso_dev->usb, 0),
2517 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2518 USB_CTRL_SET_TIMEOUT);
2519 mutex_unlock(&hso_dev->mutex);
2520 return rv;
2523 static const struct rfkill_ops hso_rfkill_ops = {
2524 .set_block = hso_rfkill_set_block,
2527 /* Creates and sets up everything for rfkill */
2528 static void hso_create_rfkill(struct hso_device *hso_dev,
2529 struct usb_interface *interface)
2531 struct hso_net *hso_net = dev2net(hso_dev);
2532 struct device *dev = &hso_net->net->dev;
2533 char *rfkn;
2535 rfkn = kzalloc(20, GFP_KERNEL);
2536 if (!rfkn)
2537 dev_err(dev, "%s - Out of memory\n", __func__);
2539 snprintf(rfkn, 20, "hso-%d",
2540 interface->altsetting->desc.bInterfaceNumber);
2542 hso_net->rfkill = rfkill_alloc(rfkn,
2543 &interface_to_usbdev(interface)->dev,
2544 RFKILL_TYPE_WWAN,
2545 &hso_rfkill_ops, hso_dev);
2546 if (!hso_net->rfkill) {
2547 dev_err(dev, "%s - Out of memory\n", __func__);
2548 kfree(rfkn);
2549 return;
2551 if (rfkill_register(hso_net->rfkill) < 0) {
2552 rfkill_destroy(hso_net->rfkill);
2553 kfree(rfkn);
2554 hso_net->rfkill = NULL;
2555 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2556 return;
2560 static struct device_type hso_type = {
2561 .name = "wwan",
2564 /* Creates our network device */
2565 static struct hso_device *hso_create_net_device(struct usb_interface *interface,
2566 int port_spec)
2568 int result, i;
2569 struct net_device *net;
2570 struct hso_net *hso_net;
2571 struct hso_device *hso_dev;
2573 hso_dev = hso_create_device(interface, port_spec);
2574 if (!hso_dev)
2575 return NULL;
2577 /* allocate our network device, then we can put in our private data */
2578 /* call hso_net_init to do the basic initialization */
2579 net = alloc_netdev(sizeof(struct hso_net), "hso%d", hso_net_init);
2580 if (!net) {
2581 dev_err(&interface->dev, "Unable to create ethernet device\n");
2582 goto exit;
2585 hso_net = netdev_priv(net);
2587 hso_dev->port_data.dev_net = hso_net;
2588 hso_net->net = net;
2589 hso_net->parent = hso_dev;
2591 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2592 USB_DIR_IN);
2593 if (!hso_net->in_endp) {
2594 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2595 goto exit;
2597 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2598 USB_DIR_OUT);
2599 if (!hso_net->out_endp) {
2600 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2601 goto exit;
2603 SET_NETDEV_DEV(net, &interface->dev);
2604 SET_NETDEV_DEVTYPE(net, &hso_type);
2606 /* registering our net device */
2607 result = register_netdev(net);
2608 if (result) {
2609 dev_err(&interface->dev, "Failed to register device\n");
2610 goto exit;
2613 /* start allocating */
2614 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2615 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2616 if (!hso_net->mux_bulk_rx_urb_pool[i]) {
2617 dev_err(&interface->dev, "Could not allocate rx urb\n");
2618 goto exit;
2620 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2621 GFP_KERNEL);
2622 if (!hso_net->mux_bulk_rx_buf_pool[i]) {
2623 dev_err(&interface->dev, "Could not allocate rx buf\n");
2624 goto exit;
2627 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2628 if (!hso_net->mux_bulk_tx_urb) {
2629 dev_err(&interface->dev, "Could not allocate tx urb\n");
2630 goto exit;
2632 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2633 if (!hso_net->mux_bulk_tx_buf) {
2634 dev_err(&interface->dev, "Could not allocate tx buf\n");
2635 goto exit;
2638 add_net_device(hso_dev);
2640 hso_log_port(hso_dev);
2642 hso_create_rfkill(hso_dev, interface);
2644 return hso_dev;
2645 exit:
2646 hso_free_net_device(hso_dev);
2647 return NULL;
2650 static void hso_free_tiomget(struct hso_serial *serial)
2652 struct hso_tiocmget *tiocmget = serial->tiocmget;
2653 if (tiocmget) {
2654 if (tiocmget->urb) {
2655 usb_free_urb(tiocmget->urb);
2656 tiocmget->urb = NULL;
2658 serial->tiocmget = NULL;
2659 kfree(tiocmget);
2664 /* Frees an AT channel ( goes for both mux and non-mux ) */
2665 static void hso_free_serial_device(struct hso_device *hso_dev)
2667 struct hso_serial *serial = dev2ser(hso_dev);
2669 if (!serial)
2670 return;
2671 set_serial_by_index(serial->minor, NULL);
2673 hso_serial_common_free(serial);
2675 if (serial->shared_int) {
2676 mutex_lock(&serial->shared_int->shared_int_lock);
2677 if (--serial->shared_int->ref_count == 0)
2678 hso_free_shared_int(serial->shared_int);
2679 else
2680 mutex_unlock(&serial->shared_int->shared_int_lock);
2682 hso_free_tiomget(serial);
2683 kfree(serial);
2684 kfree(hso_dev);
2687 /* Creates a bulk AT channel */
2688 static struct hso_device *hso_create_bulk_serial_device(
2689 struct usb_interface *interface, int port)
2691 struct hso_device *hso_dev;
2692 struct hso_serial *serial;
2693 int num_urbs;
2694 struct hso_tiocmget *tiocmget;
2696 hso_dev = hso_create_device(interface, port);
2697 if (!hso_dev)
2698 return NULL;
2700 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2701 if (!serial)
2702 goto exit;
2704 serial->parent = hso_dev;
2705 hso_dev->port_data.dev_serial = serial;
2707 if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2708 num_urbs = 2;
2709 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2710 GFP_KERNEL);
2711 /* it isn't going to break our heart if serial->tiocmget
2712 * allocation fails don't bother checking this.
2714 if (serial->tiocmget) {
2715 tiocmget = serial->tiocmget;
2716 tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2717 if (tiocmget->urb) {
2718 mutex_init(&tiocmget->mutex);
2719 init_waitqueue_head(&tiocmget->waitq);
2720 tiocmget->endp = hso_get_ep(
2721 interface,
2722 USB_ENDPOINT_XFER_INT,
2723 USB_DIR_IN);
2724 } else
2725 hso_free_tiomget(serial);
2728 else
2729 num_urbs = 1;
2731 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2732 BULK_URB_TX_SIZE))
2733 goto exit;
2735 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2736 USB_DIR_IN);
2737 if (!serial->in_endp) {
2738 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2739 goto exit2;
2742 if (!
2743 (serial->out_endp =
2744 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2745 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2746 goto exit2;
2749 serial->write_data = hso_std_serial_write_data;
2751 /* and record this serial */
2752 set_serial_by_index(serial->minor, serial);
2754 /* setup the proc dirs and files if needed */
2755 hso_log_port(hso_dev);
2757 /* done, return it */
2758 return hso_dev;
2760 exit2:
2761 hso_serial_common_free(serial);
2762 exit:
2763 hso_free_tiomget(serial);
2764 kfree(serial);
2765 kfree(hso_dev);
2766 return NULL;
2769 /* Creates a multiplexed AT channel */
2770 static
2771 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2772 int port,
2773 struct hso_shared_int *mux)
2775 struct hso_device *hso_dev;
2776 struct hso_serial *serial;
2777 int port_spec;
2779 port_spec = HSO_INTF_MUX;
2780 port_spec &= ~HSO_PORT_MASK;
2782 port_spec |= hso_mux_to_port(port);
2783 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2784 return NULL;
2786 hso_dev = hso_create_device(interface, port_spec);
2787 if (!hso_dev)
2788 return NULL;
2790 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2791 if (!serial)
2792 goto exit;
2794 hso_dev->port_data.dev_serial = serial;
2795 serial->parent = hso_dev;
2797 if (hso_serial_common_create
2798 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2799 goto exit;
2801 serial->tx_data_length--;
2802 serial->write_data = hso_mux_serial_write_data;
2804 serial->shared_int = mux;
2805 mutex_lock(&serial->shared_int->shared_int_lock);
2806 serial->shared_int->ref_count++;
2807 mutex_unlock(&serial->shared_int->shared_int_lock);
2809 /* and record this serial */
2810 set_serial_by_index(serial->minor, serial);
2812 /* setup the proc dirs and files if needed */
2813 hso_log_port(hso_dev);
2815 /* done, return it */
2816 return hso_dev;
2818 exit:
2819 if (serial) {
2820 tty_unregister_device(tty_drv, serial->minor);
2821 kfree(serial);
2823 if (hso_dev)
2824 kfree(hso_dev);
2825 return NULL;
2829 static void hso_free_shared_int(struct hso_shared_int *mux)
2831 usb_free_urb(mux->shared_intr_urb);
2832 kfree(mux->shared_intr_buf);
2833 mutex_unlock(&mux->shared_int_lock);
2834 kfree(mux);
2837 static
2838 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2840 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2842 if (!mux)
2843 return NULL;
2845 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2846 USB_DIR_IN);
2847 if (!mux->intr_endp) {
2848 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2849 goto exit;
2852 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2853 if (!mux->shared_intr_urb) {
2854 dev_err(&interface->dev, "Could not allocate intr urb?\n");
2855 goto exit;
2857 mux->shared_intr_buf =
2858 kzalloc(le16_to_cpu(mux->intr_endp->wMaxPacketSize),
2859 GFP_KERNEL);
2860 if (!mux->shared_intr_buf) {
2861 dev_err(&interface->dev, "Could not allocate intr buf?\n");
2862 goto exit;
2865 mutex_init(&mux->shared_int_lock);
2867 return mux;
2869 exit:
2870 kfree(mux->shared_intr_buf);
2871 usb_free_urb(mux->shared_intr_urb);
2872 kfree(mux);
2873 return NULL;
2876 /* Gets the port spec for a certain interface */
2877 static int hso_get_config_data(struct usb_interface *interface)
2879 struct usb_device *usbdev = interface_to_usbdev(interface);
2880 u8 config_data[17];
2881 u32 if_num = interface->altsetting->desc.bInterfaceNumber;
2882 s32 result;
2884 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2885 0x86, 0xC0, 0, 0, config_data, 17,
2886 USB_CTRL_SET_TIMEOUT) != 0x11) {
2887 return -EIO;
2890 switch (config_data[if_num]) {
2891 case 0x0:
2892 result = 0;
2893 break;
2894 case 0x1:
2895 result = HSO_PORT_DIAG;
2896 break;
2897 case 0x2:
2898 result = HSO_PORT_GPS;
2899 break;
2900 case 0x3:
2901 result = HSO_PORT_GPS_CONTROL;
2902 break;
2903 case 0x4:
2904 result = HSO_PORT_APP;
2905 break;
2906 case 0x5:
2907 result = HSO_PORT_APP2;
2908 break;
2909 case 0x6:
2910 result = HSO_PORT_CONTROL;
2911 break;
2912 case 0x7:
2913 result = HSO_PORT_NETWORK;
2914 break;
2915 case 0x8:
2916 result = HSO_PORT_MODEM;
2917 break;
2918 case 0x9:
2919 result = HSO_PORT_MSD;
2920 break;
2921 case 0xa:
2922 result = HSO_PORT_PCSC;
2923 break;
2924 case 0xb:
2925 result = HSO_PORT_VOICE;
2926 break;
2927 default:
2928 result = 0;
2931 if (result)
2932 result |= HSO_INTF_BULK;
2934 if (config_data[16] & 0x1)
2935 result |= HSO_INFO_CRC_BUG;
2937 return result;
2940 /* called once for each interface upon device insertion */
2941 static int hso_probe(struct usb_interface *interface,
2942 const struct usb_device_id *id)
2944 int mux, i, if_num, port_spec;
2945 unsigned char port_mask;
2946 struct hso_device *hso_dev = NULL;
2947 struct hso_shared_int *shared_int;
2948 struct hso_device *tmp_dev = NULL;
2950 if_num = interface->altsetting->desc.bInterfaceNumber;
2952 /* Get the interface/port specification from either driver_info or from
2953 * the device itself */
2954 if (id->driver_info)
2955 port_spec = ((u32 *)(id->driver_info))[if_num];
2956 else
2957 port_spec = hso_get_config_data(interface);
2959 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2960 dev_err(&interface->dev, "Not our interface\n");
2961 return -ENODEV;
2963 /* Check if we need to switch to alt interfaces prior to port
2964 * configuration */
2965 if (interface->num_altsetting > 1)
2966 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2967 interface->needs_remote_wakeup = 1;
2969 /* Allocate new hso device(s) */
2970 switch (port_spec & HSO_INTF_MASK) {
2971 case HSO_INTF_MUX:
2972 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2973 /* Create the network device */
2974 if (!disable_net) {
2975 hso_dev = hso_create_net_device(interface,
2976 port_spec);
2977 if (!hso_dev)
2978 goto exit;
2979 tmp_dev = hso_dev;
2983 if (hso_get_mux_ports(interface, &port_mask))
2984 /* TODO: de-allocate everything */
2985 goto exit;
2987 shared_int = hso_create_shared_int(interface);
2988 if (!shared_int)
2989 goto exit;
2991 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2992 if (port_mask & i) {
2993 hso_dev = hso_create_mux_serial_device(
2994 interface, i, shared_int);
2995 if (!hso_dev)
2996 goto exit;
3000 if (tmp_dev)
3001 hso_dev = tmp_dev;
3002 break;
3004 case HSO_INTF_BULK:
3005 /* It's a regular bulk interface */
3006 if (((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) &&
3007 !disable_net)
3008 hso_dev = hso_create_net_device(interface, port_spec);
3009 else
3010 hso_dev =
3011 hso_create_bulk_serial_device(interface, port_spec);
3012 if (!hso_dev)
3013 goto exit;
3014 break;
3015 default:
3016 goto exit;
3019 /* save our data pointer in this device */
3020 usb_set_intfdata(interface, hso_dev);
3022 /* done */
3023 return 0;
3024 exit:
3025 hso_free_interface(interface);
3026 return -ENODEV;
3029 /* device removed, cleaning up */
3030 static void hso_disconnect(struct usb_interface *interface)
3032 hso_free_interface(interface);
3034 /* remove reference of our private data */
3035 usb_set_intfdata(interface, NULL);
3038 static void async_get_intf(struct work_struct *data)
3040 struct hso_device *hso_dev =
3041 container_of(data, struct hso_device, async_get_intf);
3042 usb_autopm_get_interface(hso_dev->interface);
3045 static void async_put_intf(struct work_struct *data)
3047 struct hso_device *hso_dev =
3048 container_of(data, struct hso_device, async_put_intf);
3049 usb_autopm_put_interface(hso_dev->interface);
3052 static int hso_get_activity(struct hso_device *hso_dev)
3054 if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
3055 if (!hso_dev->is_active) {
3056 hso_dev->is_active = 1;
3057 schedule_work(&hso_dev->async_get_intf);
3061 if (hso_dev->usb->state != USB_STATE_CONFIGURED)
3062 return -EAGAIN;
3064 usb_mark_last_busy(hso_dev->usb);
3066 return 0;
3069 static int hso_put_activity(struct hso_device *hso_dev)
3071 if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
3072 if (hso_dev->is_active) {
3073 hso_dev->is_active = 0;
3074 schedule_work(&hso_dev->async_put_intf);
3075 return -EAGAIN;
3078 hso_dev->is_active = 0;
3079 return 0;
3082 /* called by kernel when we need to suspend device */
3083 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3085 int i, result;
3087 /* Stop all serial ports */
3088 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3089 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3090 result = hso_stop_serial_device(serial_table[i]);
3091 if (result)
3092 goto out;
3096 /* Stop 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 result = hso_stop_net_device(network_table[i]);
3101 if (result)
3102 goto out;
3106 out:
3107 return 0;
3110 /* called by kernel when we need to resume device */
3111 static int hso_resume(struct usb_interface *iface)
3113 int i, result = 0;
3114 struct hso_net *hso_net;
3116 /* Start all serial ports */
3117 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3118 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3119 if (dev2ser(serial_table[i])->open_count) {
3120 result =
3121 hso_start_serial_device(serial_table[i], GFP_NOIO);
3122 hso_kick_transmit(dev2ser(serial_table[i]));
3123 if (result)
3124 goto out;
3129 /* Start all network ports */
3130 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3131 if (network_table[i] &&
3132 (network_table[i]->interface == iface)) {
3133 hso_net = dev2net(network_table[i]);
3134 if (hso_net->flags & IFF_UP) {
3135 /* First transmit any lingering data,
3136 then restart the device. */
3137 if (hso_net->skb_tx_buf) {
3138 dev_dbg(&iface->dev,
3139 "Transmitting"
3140 " lingering data\n");
3141 hso_net_start_xmit(hso_net->skb_tx_buf,
3142 hso_net->net);
3143 hso_net->skb_tx_buf = NULL;
3145 result = hso_start_net_device(network_table[i]);
3146 if (result)
3147 goto out;
3152 out:
3153 return result;
3156 static void reset_device(struct work_struct *data)
3158 struct hso_device *hso_dev =
3159 container_of(data, struct hso_device, reset_device);
3160 struct usb_device *usb = hso_dev->usb;
3161 int result;
3163 if (hso_dev->usb_gone) {
3164 D1("No reset during disconnect\n");
3165 } else {
3166 result = usb_lock_device_for_reset(usb, hso_dev->interface);
3167 if (result < 0)
3168 D1("unable to lock device for reset: %d\n", result);
3169 else {
3170 usb_reset_device(usb);
3171 usb_unlock_device(usb);
3176 static void hso_serial_ref_free(struct kref *ref)
3178 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3180 hso_free_serial_device(hso_dev);
3183 static void hso_free_interface(struct usb_interface *interface)
3185 struct hso_serial *hso_dev;
3186 struct tty_struct *tty;
3187 int i;
3189 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3190 if (serial_table[i] &&
3191 (serial_table[i]->interface == interface)) {
3192 hso_dev = dev2ser(serial_table[i]);
3193 spin_lock_irq(&hso_dev->serial_lock);
3194 tty = tty_kref_get(hso_dev->tty);
3195 spin_unlock_irq(&hso_dev->serial_lock);
3196 if (tty)
3197 tty_hangup(tty);
3198 mutex_lock(&hso_dev->parent->mutex);
3199 tty_kref_put(tty);
3200 hso_dev->parent->usb_gone = 1;
3201 mutex_unlock(&hso_dev->parent->mutex);
3202 kref_put(&serial_table[i]->ref, hso_serial_ref_free);
3206 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3207 if (network_table[i] &&
3208 (network_table[i]->interface == interface)) {
3209 struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3210 /* hso_stop_net_device doesn't stop the net queue since
3211 * traffic needs to start it again when suspended */
3212 netif_stop_queue(dev2net(network_table[i])->net);
3213 hso_stop_net_device(network_table[i]);
3214 cancel_work_sync(&network_table[i]->async_put_intf);
3215 cancel_work_sync(&network_table[i]->async_get_intf);
3216 if (rfk) {
3217 rfkill_unregister(rfk);
3218 rfkill_destroy(rfk);
3220 hso_free_net_device(network_table[i]);
3225 /* Helper functions */
3227 /* Get the endpoint ! */
3228 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3229 int type, int dir)
3231 int i;
3232 struct usb_host_interface *iface = intf->cur_altsetting;
3233 struct usb_endpoint_descriptor *endp;
3235 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3236 endp = &iface->endpoint[i].desc;
3237 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3238 (usb_endpoint_type(endp) == type))
3239 return endp;
3242 return NULL;
3245 /* Get the byte that describes which ports are enabled */
3246 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3248 int i;
3249 struct usb_host_interface *iface = intf->cur_altsetting;
3251 if (iface->extralen == 3) {
3252 *ports = iface->extra[2];
3253 return 0;
3256 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3257 if (iface->endpoint[i].extralen == 3) {
3258 *ports = iface->endpoint[i].extra[2];
3259 return 0;
3263 return -1;
3266 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3267 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3268 struct usb_device *usb, gfp_t gfp)
3270 int result;
3272 usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3273 usb_rcvintpipe(usb,
3274 shared_int->intr_endp->bEndpointAddress & 0x7F),
3275 shared_int->shared_intr_buf,
3277 intr_callback, shared_int,
3278 shared_int->intr_endp->bInterval);
3280 result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3281 if (result)
3282 dev_warn(&usb->dev, "%s failed mux_intr_urb %d\n", __func__,
3283 result);
3285 return result;
3288 /* operations setup of the serial interface */
3289 static const struct tty_operations hso_serial_ops = {
3290 .open = hso_serial_open,
3291 .close = hso_serial_close,
3292 .write = hso_serial_write,
3293 .write_room = hso_serial_write_room,
3294 .ioctl = hso_serial_ioctl,
3295 .set_termios = hso_serial_set_termios,
3296 .chars_in_buffer = hso_serial_chars_in_buffer,
3297 .tiocmget = hso_serial_tiocmget,
3298 .tiocmset = hso_serial_tiocmset,
3299 .get_icount = hso_get_count,
3300 .unthrottle = hso_unthrottle
3303 static struct usb_driver hso_driver = {
3304 .name = driver_name,
3305 .probe = hso_probe,
3306 .disconnect = hso_disconnect,
3307 .id_table = hso_ids,
3308 .suspend = hso_suspend,
3309 .resume = hso_resume,
3310 .reset_resume = hso_resume,
3311 .supports_autosuspend = 1,
3314 static int __init hso_init(void)
3316 int i;
3317 int result;
3319 /* put it in the log */
3320 printk(KERN_INFO "hso: %s\n", version);
3322 /* Initialise the serial table semaphore and table */
3323 spin_lock_init(&serial_table_lock);
3324 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3325 serial_table[i] = NULL;
3327 /* allocate our driver using the proper amount of supported minors */
3328 tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
3329 if (!tty_drv)
3330 return -ENOMEM;
3332 /* fill in all needed values */
3333 tty_drv->magic = TTY_DRIVER_MAGIC;
3334 tty_drv->owner = THIS_MODULE;
3335 tty_drv->driver_name = driver_name;
3336 tty_drv->name = tty_filename;
3338 /* if major number is provided as parameter, use that one */
3339 if (tty_major)
3340 tty_drv->major = tty_major;
3342 tty_drv->minor_start = 0;
3343 tty_drv->num = HSO_SERIAL_TTY_MINORS;
3344 tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3345 tty_drv->subtype = SERIAL_TYPE_NORMAL;
3346 tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
3347 tty_drv->init_termios = tty_std_termios;
3348 hso_init_termios(&tty_drv->init_termios);
3349 tty_set_operations(tty_drv, &hso_serial_ops);
3351 /* register the tty driver */
3352 result = tty_register_driver(tty_drv);
3353 if (result) {
3354 printk(KERN_ERR "%s - tty_register_driver failed(%d)\n",
3355 __func__, result);
3356 return result;
3359 /* register this module as an usb driver */
3360 result = usb_register(&hso_driver);
3361 if (result) {
3362 printk(KERN_ERR "Could not register hso driver? error: %d\n",
3363 result);
3364 /* cleanup serial interface */
3365 tty_unregister_driver(tty_drv);
3366 return result;
3369 /* done */
3370 return 0;
3373 static void __exit hso_exit(void)
3375 printk(KERN_INFO "hso: unloaded\n");
3377 tty_unregister_driver(tty_drv);
3378 /* deregister the usb driver */
3379 usb_deregister(&hso_driver);
3382 /* Module definitions */
3383 module_init(hso_init);
3384 module_exit(hso_exit);
3386 MODULE_AUTHOR(MOD_AUTHOR);
3387 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3388 MODULE_LICENSE(MOD_LICENSE);
3390 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3391 MODULE_PARM_DESC(debug, "Level of debug [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3392 module_param(debug, int, S_IRUGO | S_IWUSR);
3394 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3395 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3396 module_param(tty_major, int, S_IRUGO | S_IWUSR);
3398 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3399 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3400 module_param(disable_net, int, S_IRUGO | S_IWUSR);