2 * USB-to-WWAN Driver for Sierra Wireless modems
4 * Copyright (C) 2008, 2009, 2010 Paxton Smith, Matthew Safar, Rory Filer
5 * <linux@sierrawireless.com>
7 * Portions of this based on the cdc_ether driver by David Brownell (2003-2005)
8 * and Ole Andre Vadla Ravnas (ActiveSync) (2006).
10 * IMPORTANT DISCLAIMER: This driver is not commercially supported by
11 * Sierra Wireless. Use at your own risk.
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 #define DRIVER_VERSION "v.2.0"
29 #define DRIVER_AUTHOR "Paxton Smith, Matthew Safar, Rory Filer"
30 #define DRIVER_DESC "USB-to-WWAN Driver for Sierra Wireless modems"
31 static const char driver_name
[] = "sierra_net";
33 /* if defined debug messages enabled */
36 #include <linux/module.h>
37 #include <linux/etherdevice.h>
38 #include <linux/ethtool.h>
39 #include <linux/mii.h>
40 #include <linux/sched.h>
41 #include <linux/timer.h>
42 #include <linux/usb.h>
43 #include <linux/usb/cdc.h>
46 #include <asm/unaligned.h>
47 #include <linux/usb/usbnet.h>
49 #define SWI_USB_REQUEST_GET_FW_ATTR 0x06
50 #define SWI_GET_FW_ATTR_MASK 0x08
52 /* atomic counter partially included in MAC address to make sure 2 devices
53 * do not end up with the same MAC - concept breaks in case of > 255 ifaces
55 static atomic_t iface_counter
= ATOMIC_INIT(0);
58 * SYNC Timer Delay definition used to set the expiry time
60 #define SIERRA_NET_SYNCDELAY (2*HZ)
62 /* Max. MTU supported. The modem buffers are limited to 1500 */
63 #define SIERRA_NET_MAX_SUPPORTED_MTU 1500
65 /* The SIERRA_NET_USBCTL_BUF_LEN defines a buffer size allocated for control
66 * message reception ... and thus the max. received packet.
67 * (May be the cause for parse_hip returning -EINVAL)
69 #define SIERRA_NET_USBCTL_BUF_LEN 1024
71 /* Overriding the default usbnet rx_urb_size */
72 #define SIERRA_NET_RX_URB_SIZE (8 * 1024)
74 /* Private data structure */
75 struct sierra_net_data
{
77 u8 ethr_hdr_tmpl
[ETH_HLEN
]; /* ethernet header template for rx'd pkts */
79 u16 link_up
; /* air link up or down */
80 u8 tx_hdr_template
[4]; /* part of HIP hdr for tx'd packets */
82 u8 sync_msg
[4]; /* SYNC message */
83 u8 shdwn_msg
[4]; /* Shutdown message */
85 /* Backpointer to the container */
86 struct usbnet
*usbnet
;
88 u8 ifnum
; /* interface number */
90 /* Bit masks, must be a power of 2 */
91 #define SIERRA_NET_EVENT_RESP_AVAIL 0x01
92 #define SIERRA_NET_TIMER_EXPIRY 0x02
93 unsigned long kevent_flags
;
94 struct work_struct sierra_net_kevent
;
95 struct timer_list sync_timer
; /* For retrying SYNC sequence */
108 /* HIP message type */
109 #define SIERRA_NET_HIP_EXTENDEDID 0x7F
110 #define SIERRA_NET_HIP_HSYNC_ID 0x60 /* Modem -> host */
111 #define SIERRA_NET_HIP_RESTART_ID 0x62 /* Modem -> host */
112 #define SIERRA_NET_HIP_MSYNC_ID 0x20 /* Host -> modem */
113 #define SIERRA_NET_HIP_SHUTD_ID 0x26 /* Host -> modem */
115 #define SIERRA_NET_HIP_EXT_IP_IN_ID 0x0202
116 #define SIERRA_NET_HIP_EXT_IP_OUT_ID 0x0002
118 /* 3G UMTS Link Sense Indication definitions */
119 #define SIERRA_NET_HIP_LSI_UMTSID 0x78
121 /* Reverse Channel Grant Indication HIP message */
122 #define SIERRA_NET_HIP_RCGI 0x64
124 /* LSI Protocol types */
125 #define SIERRA_NET_PROTOCOL_UMTS 0x01
127 #define SIERRA_NET_COVERAGE_NONE 0x00
128 #define SIERRA_NET_COVERAGE_NOPACKET 0x01
131 #define SIERRA_NET_SESSION_IDLE 0x00
133 #define SIERRA_NET_AS_LINK_TYPE_IPv4 0x00
139 /* eventually use a union for the rest - assume umts for now */
145 u8 pdp_addr_len
; /* NW-supplied PDP address len */
146 u8 pdp_addr
[16]; /* NW-supplied PDP address (bigendian)) */
148 u8 dns1_addr_len
; /* NW-supplied 1st DNS address len (bigendian) */
149 u8 dns1_addr
[16]; /* NW-supplied 1st DNS address */
150 u8 dns2_addr_len
; /* NW-supplied 2nd DNS address len */
151 u8 dns2_addr
[16]; /* NW-supplied 2nd DNS address (bigendian)*/
152 u8 wins1_addr_len
; /* NW-supplied 1st Wins address len */
153 u8 wins1_addr
[16]; /* NW-supplied 1st Wins address (bigendian)*/
154 u8 wins2_addr_len
; /* NW-supplied 2nd Wins address len */
155 u8 wins2_addr
[16]; /* NW-supplied 2nd Wins address (bigendian) */
157 u8 gw_addr_len
; /* NW-supplied GW address len */
158 u8 gw_addr
[16]; /* NW-supplied GW address (bigendian) */
162 #define SIERRA_NET_LSI_COMMON_LEN 4
163 #define SIERRA_NET_LSI_UMTS_LEN (sizeof(struct lsi_umts))
164 #define SIERRA_NET_LSI_UMTS_STATUS_LEN \
165 (SIERRA_NET_LSI_UMTS_LEN - SIERRA_NET_LSI_COMMON_LEN)
167 /* Forward definitions */
168 static void sierra_sync_timer(unsigned long syncdata
);
169 static int sierra_net_change_mtu(struct net_device
*net
, int new_mtu
);
171 /* Our own net device operations structure */
172 static const struct net_device_ops sierra_net_device_ops
= {
173 .ndo_open
= usbnet_open
,
174 .ndo_stop
= usbnet_stop
,
175 .ndo_start_xmit
= usbnet_start_xmit
,
176 .ndo_tx_timeout
= usbnet_tx_timeout
,
177 .ndo_change_mtu
= sierra_net_change_mtu
,
178 .ndo_set_mac_address
= eth_mac_addr
,
179 .ndo_validate_addr
= eth_validate_addr
,
182 /* get private data associated with passed in usbnet device */
183 static inline struct sierra_net_data
*sierra_net_get_private(struct usbnet
*dev
)
185 return (struct sierra_net_data
*)dev
->data
[0];
188 /* set private data associated with passed in usbnet device */
189 static inline void sierra_net_set_private(struct usbnet
*dev
,
190 struct sierra_net_data
*priv
)
192 dev
->data
[0] = (unsigned long)priv
;
196 static inline int is_ip(struct sk_buff
*skb
)
198 return skb
->protocol
== cpu_to_be16(ETH_P_IP
);
202 * check passed in packet and make sure that:
203 * - it is linear (no scatter/gather)
204 * - it is ethernet (mac_header properly set)
206 static int check_ethip_packet(struct sk_buff
*skb
, struct usbnet
*dev
)
208 skb_reset_mac_header(skb
); /* ethernet header */
210 if (skb_is_nonlinear(skb
)) {
211 netdev_err(dev
->net
, "Non linear buffer-dropping\n");
215 if (!pskb_may_pull(skb
, ETH_HLEN
))
217 skb
->protocol
= eth_hdr(skb
)->h_proto
;
222 static const u8
*save16bit(struct param
*p
, const u8
*datap
)
225 p
->word
= get_unaligned_be16(datap
);
226 return datap
+ sizeof(p
->word
);
229 static const u8
*save8bit(struct param
*p
, const u8
*datap
)
233 return datap
+ sizeof(p
->byte
);
236 /*----------------------------------------------------------------------------*
238 *----------------------------------------------------------------------------*/
240 #define SIERRA_NET_HIP_HDR_LEN 4
241 /* Extended HIP header */
242 #define SIERRA_NET_HIP_EXT_HDR_LEN 6
246 struct param payload_len
;
248 struct param msgspecific
;
249 struct param extmsgid
;
252 static int parse_hip(const u8
*buf
, const u32 buflen
, struct hip_hdr
*hh
)
254 const u8
*curp
= buf
;
257 if (buflen
< SIERRA_NET_HIP_HDR_LEN
)
260 curp
= save16bit(&hh
->payload_len
, curp
);
261 curp
= save8bit(&hh
->msgid
, curp
);
262 curp
= save8bit(&hh
->msgspecific
, curp
);
264 padded
= hh
->msgid
.byte
& 0x80;
265 hh
->msgid
.byte
&= 0x7F; /* 7 bits */
267 hh
->extmsgid
.is_present
= (hh
->msgid
.byte
== SIERRA_NET_HIP_EXTENDEDID
);
268 if (hh
->extmsgid
.is_present
) {
269 if (buflen
< SIERRA_NET_HIP_EXT_HDR_LEN
)
272 hh
->payload_len
.word
&= 0x3FFF; /* 14 bits */
274 curp
= save16bit(&hh
->extmsgid
, curp
);
275 hh
->extmsgid
.word
&= 0x03FF; /* 10 bits */
277 hh
->hdrlen
= SIERRA_NET_HIP_EXT_HDR_LEN
;
279 hh
->payload_len
.word
&= 0x07FF; /* 11 bits */
280 hh
->hdrlen
= SIERRA_NET_HIP_HDR_LEN
;
285 hh
->payload_len
.word
--;
288 /* if real packet shorter than the claimed length */
289 if (buflen
< (hh
->hdrlen
+ hh
->payload_len
.word
))
295 static void build_hip(u8
*buf
, const u16 payloadlen
,
296 struct sierra_net_data
*priv
)
298 /* the following doesn't have the full functionality. We
299 * currently build only one kind of header, so it is faster this way
301 put_unaligned_be16(payloadlen
, buf
);
302 memcpy(buf
+2, priv
->tx_hdr_template
, sizeof(priv
->tx_hdr_template
));
304 /*----------------------------------------------------------------------------*
306 *----------------------------------------------------------------------------*/
308 static int sierra_net_send_cmd(struct usbnet
*dev
,
309 u8
*cmd
, int cmdlen
, const char * cmd_name
)
311 struct sierra_net_data
*priv
= sierra_net_get_private(dev
);
314 status
= usbnet_write_cmd(dev
, USB_CDC_SEND_ENCAPSULATED_COMMAND
,
315 USB_DIR_OUT
|USB_TYPE_CLASS
|USB_RECIP_INTERFACE
,
316 0, priv
->ifnum
, cmd
, cmdlen
);
318 if (status
!= cmdlen
&& status
!= -ENODEV
)
319 netdev_err(dev
->net
, "Submit %s failed %d\n", cmd_name
, status
);
324 static int sierra_net_send_sync(struct usbnet
*dev
)
327 struct sierra_net_data
*priv
= sierra_net_get_private(dev
);
329 dev_dbg(&dev
->udev
->dev
, "%s", __func__
);
331 status
= sierra_net_send_cmd(dev
, priv
->sync_msg
,
332 sizeof(priv
->sync_msg
), "SYNC");
337 static void sierra_net_set_ctx_index(struct sierra_net_data
*priv
, u8 ctx_ix
)
339 dev_dbg(&(priv
->usbnet
->udev
->dev
), "%s %d", __func__
, ctx_ix
);
340 priv
->tx_hdr_template
[0] = 0x3F;
341 priv
->tx_hdr_template
[1] = ctx_ix
;
342 *((__be16
*)&priv
->tx_hdr_template
[2]) =
343 cpu_to_be16(SIERRA_NET_HIP_EXT_IP_OUT_ID
);
346 static inline int sierra_net_is_valid_addrlen(u8 len
)
348 return len
== sizeof(struct in_addr
);
351 static int sierra_net_parse_lsi(struct usbnet
*dev
, char *data
, int datalen
)
353 struct lsi_umts
*lsi
= (struct lsi_umts
*)data
;
355 if (datalen
< sizeof(struct lsi_umts
)) {
356 netdev_err(dev
->net
, "%s: Data length %d, exp %Zu\n",
358 sizeof(struct lsi_umts
));
362 if (lsi
->length
!= cpu_to_be16(SIERRA_NET_LSI_UMTS_STATUS_LEN
)) {
363 netdev_err(dev
->net
, "%s: LSI_UMTS_STATUS_LEN %d, exp %u\n",
364 __func__
, be16_to_cpu(lsi
->length
),
365 (u32
)SIERRA_NET_LSI_UMTS_STATUS_LEN
);
369 /* Validate the protocol - only support UMTS for now */
370 if (lsi
->protocol
!= SIERRA_NET_PROTOCOL_UMTS
) {
371 netdev_err(dev
->net
, "Protocol unsupported, 0x%02x\n",
376 /* Validate the link type */
377 if (lsi
->link_type
!= SIERRA_NET_AS_LINK_TYPE_IPv4
) {
378 netdev_err(dev
->net
, "Link type unsupported: 0x%02x\n",
383 /* Validate the coverage */
384 if (lsi
->coverage
== SIERRA_NET_COVERAGE_NONE
385 || lsi
->coverage
== SIERRA_NET_COVERAGE_NOPACKET
) {
386 netdev_err(dev
->net
, "No coverage, 0x%02x\n", lsi
->coverage
);
390 /* Validate the session state */
391 if (lsi
->session_state
== SIERRA_NET_SESSION_IDLE
) {
392 netdev_err(dev
->net
, "Session idle, 0x%02x\n",
397 /* Set link_sense true */
401 static void sierra_net_handle_lsi(struct usbnet
*dev
, char *data
,
404 struct sierra_net_data
*priv
= sierra_net_get_private(dev
);
407 link_up
= sierra_net_parse_lsi(dev
, data
+ hh
->hdrlen
,
408 hh
->payload_len
.word
);
410 netdev_err(dev
->net
, "Invalid LSI\n");
414 sierra_net_set_ctx_index(priv
, hh
->msgspecific
.byte
);
419 usbnet_link_change(dev
, link_up
, 0);
422 static void sierra_net_dosync(struct usbnet
*dev
)
425 struct sierra_net_data
*priv
= sierra_net_get_private(dev
);
427 dev_dbg(&dev
->udev
->dev
, "%s", __func__
);
429 /* tell modem we are ready */
430 status
= sierra_net_send_sync(dev
);
433 "Send SYNC failed, status %d\n", status
);
434 status
= sierra_net_send_sync(dev
);
437 "Send SYNC failed, status %d\n", status
);
439 /* Now, start a timer and make sure we get the Restart Indication */
440 priv
->sync_timer
.function
= sierra_sync_timer
;
441 priv
->sync_timer
.data
= (unsigned long) dev
;
442 priv
->sync_timer
.expires
= jiffies
+ SIERRA_NET_SYNCDELAY
;
443 add_timer(&priv
->sync_timer
);
446 static void sierra_net_kevent(struct work_struct
*work
)
448 struct sierra_net_data
*priv
=
449 container_of(work
, struct sierra_net_data
, sierra_net_kevent
);
450 struct usbnet
*dev
= priv
->usbnet
;
456 if (test_bit(SIERRA_NET_EVENT_RESP_AVAIL
, &priv
->kevent_flags
)) {
457 clear_bit(SIERRA_NET_EVENT_RESP_AVAIL
, &priv
->kevent_flags
);
459 /* Query the modem for the LSI message */
460 buf
= kzalloc(SIERRA_NET_USBCTL_BUF_LEN
, GFP_KERNEL
);
465 len
= usb_control_msg(dev
->udev
, usb_rcvctrlpipe(dev
->udev
, 0),
466 USB_CDC_GET_ENCAPSULATED_RESPONSE
,
467 USB_DIR_IN
|USB_TYPE_CLASS
|USB_RECIP_INTERFACE
,
468 0, ifnum
, buf
, SIERRA_NET_USBCTL_BUF_LEN
,
469 USB_CTRL_SET_TIMEOUT
);
473 "usb_control_msg failed, status %d\n", len
);
477 dev_dbg(&dev
->udev
->dev
, "%s: Received status message,"
478 " %04x bytes", __func__
, len
);
480 err
= parse_hip(buf
, len
, &hh
);
482 netdev_err(dev
->net
, "%s: Bad packet,"
483 " parse result %d\n", __func__
, err
);
488 /* Validate packet length */
489 if (len
!= hh
.hdrlen
+ hh
.payload_len
.word
) {
490 netdev_err(dev
->net
, "%s: Bad packet, received"
491 " %d, expected %d\n", __func__
, len
,
492 hh
.hdrlen
+ hh
.payload_len
.word
);
497 /* Switch on received message types */
498 switch (hh
.msgid
.byte
) {
499 case SIERRA_NET_HIP_LSI_UMTSID
:
500 dev_dbg(&dev
->udev
->dev
, "LSI for ctx:%d",
501 hh
.msgspecific
.byte
);
502 sierra_net_handle_lsi(dev
, buf
, &hh
);
504 case SIERRA_NET_HIP_RESTART_ID
:
505 dev_dbg(&dev
->udev
->dev
, "Restart reported: %d,"
506 " stopping sync timer",
507 hh
.msgspecific
.byte
);
508 /* Got sync resp - stop timer & clear mask */
509 del_timer_sync(&priv
->sync_timer
);
510 clear_bit(SIERRA_NET_TIMER_EXPIRY
,
511 &priv
->kevent_flags
);
513 case SIERRA_NET_HIP_HSYNC_ID
:
514 dev_dbg(&dev
->udev
->dev
, "SYNC received");
515 err
= sierra_net_send_sync(dev
);
518 "Send SYNC failed %d\n", err
);
520 case SIERRA_NET_HIP_EXTENDEDID
:
521 netdev_err(dev
->net
, "Unrecognized HIP msg, "
522 "extmsgid 0x%04x\n", hh
.extmsgid
.word
);
524 case SIERRA_NET_HIP_RCGI
:
528 netdev_err(dev
->net
, "Unrecognized HIP msg, "
529 "msgid 0x%02x\n", hh
.msgid
.byte
);
535 /* The sync timer bit might be set */
536 if (test_bit(SIERRA_NET_TIMER_EXPIRY
, &priv
->kevent_flags
)) {
537 clear_bit(SIERRA_NET_TIMER_EXPIRY
, &priv
->kevent_flags
);
538 dev_dbg(&dev
->udev
->dev
, "Deferred sync timer expiry");
539 sierra_net_dosync(priv
->usbnet
);
542 if (priv
->kevent_flags
)
543 dev_dbg(&dev
->udev
->dev
, "sierra_net_kevent done, "
544 "kevent_flags = 0x%lx", priv
->kevent_flags
);
547 static void sierra_net_defer_kevent(struct usbnet
*dev
, int work
)
549 struct sierra_net_data
*priv
= sierra_net_get_private(dev
);
551 set_bit(work
, &priv
->kevent_flags
);
552 schedule_work(&priv
->sierra_net_kevent
);
556 * Sync Retransmit Timer Handler. On expiry, kick the work queue
558 static void sierra_sync_timer(unsigned long syncdata
)
560 struct usbnet
*dev
= (struct usbnet
*)syncdata
;
562 dev_dbg(&dev
->udev
->dev
, "%s", __func__
);
563 /* Kick the tasklet */
564 sierra_net_defer_kevent(dev
, SIERRA_NET_TIMER_EXPIRY
);
567 static void sierra_net_status(struct usbnet
*dev
, struct urb
*urb
)
569 struct usb_cdc_notification
*event
;
571 dev_dbg(&dev
->udev
->dev
, "%s", __func__
);
573 if (urb
->actual_length
< sizeof *event
)
576 /* Add cases to handle other standard notifications. */
577 event
= urb
->transfer_buffer
;
578 switch (event
->bNotificationType
) {
579 case USB_CDC_NOTIFY_NETWORK_CONNECTION
:
580 case USB_CDC_NOTIFY_SPEED_CHANGE
:
581 /* USB 305 sends those */
583 case USB_CDC_NOTIFY_RESPONSE_AVAILABLE
:
584 sierra_net_defer_kevent(dev
, SIERRA_NET_EVENT_RESP_AVAIL
);
587 netdev_err(dev
->net
, ": unexpected notification %02x!\n",
588 event
->bNotificationType
);
593 static void sierra_net_get_drvinfo(struct net_device
*net
,
594 struct ethtool_drvinfo
*info
)
596 /* Inherit standard device info */
597 usbnet_get_drvinfo(net
, info
);
598 strlcpy(info
->driver
, driver_name
, sizeof(info
->driver
));
599 strlcpy(info
->version
, DRIVER_VERSION
, sizeof(info
->version
));
602 static u32
sierra_net_get_link(struct net_device
*net
)
604 struct usbnet
*dev
= netdev_priv(net
);
605 /* Report link is down whenever the interface is down */
606 return sierra_net_get_private(dev
)->link_up
&& netif_running(net
);
609 static const struct ethtool_ops sierra_net_ethtool_ops
= {
610 .get_drvinfo
= sierra_net_get_drvinfo
,
611 .get_link
= sierra_net_get_link
,
612 .get_msglevel
= usbnet_get_msglevel
,
613 .set_msglevel
= usbnet_set_msglevel
,
614 .get_settings
= usbnet_get_settings
,
615 .set_settings
= usbnet_set_settings
,
616 .nway_reset
= usbnet_nway_reset
,
619 /* MTU can not be more than 1500 bytes, enforce it. */
620 static int sierra_net_change_mtu(struct net_device
*net
, int new_mtu
)
622 if (new_mtu
> SIERRA_NET_MAX_SUPPORTED_MTU
)
625 return usbnet_change_mtu(net
, new_mtu
);
628 static int sierra_net_get_fw_attr(struct usbnet
*dev
, u16
*datap
)
633 result
= usbnet_read_cmd(dev
,
634 /* _u8 vendor specific request */
635 SWI_USB_REQUEST_GET_FW_ATTR
,
636 USB_DIR_IN
| USB_TYPE_VENDOR
, /* __u8 request type */
637 0x0000, /* __u16 value not used */
638 0x0000, /* __u16 index not used */
639 &attrdata
, /* char *data */
640 sizeof(attrdata
) /* __u16 size */
646 *datap
= le16_to_cpu(attrdata
);
651 * collects the bulk endpoints, the status endpoint.
653 static int sierra_net_bind(struct usbnet
*dev
, struct usb_interface
*intf
)
660 struct sierra_net_data
*priv
;
661 static const u8 sync_tmplate
[sizeof(priv
->sync_msg
)] = {
662 0x00, 0x00, SIERRA_NET_HIP_MSYNC_ID
, 0x00};
663 static const u8 shdwn_tmplate
[sizeof(priv
->shdwn_msg
)] = {
664 0x00, 0x00, SIERRA_NET_HIP_SHUTD_ID
, 0x00};
666 dev_dbg(&dev
->udev
->dev
, "%s", __func__
);
668 ifacenum
= intf
->cur_altsetting
->desc
.bInterfaceNumber
;
669 numendpoints
= intf
->cur_altsetting
->desc
.bNumEndpoints
;
670 /* We have three endpoints, bulk in and out, and a status */
671 if (numendpoints
!= 3) {
672 dev_err(&dev
->udev
->dev
, "Expected 3 endpoints, found: %d",
676 /* Status endpoint set in usbnet_get_endpoints() */
678 status
= usbnet_get_endpoints(dev
, intf
);
680 dev_err(&dev
->udev
->dev
, "Error in usbnet_get_endpoints (%d)",
684 /* Initialize sierra private data */
685 priv
= kzalloc(sizeof *priv
, GFP_KERNEL
);
690 priv
->ifnum
= ifacenum
;
691 dev
->net
->netdev_ops
= &sierra_net_device_ops
;
693 /* change MAC addr to include, ifacenum, and to be unique */
694 dev
->net
->dev_addr
[ETH_ALEN
-2] = atomic_inc_return(&iface_counter
);
695 dev
->net
->dev_addr
[ETH_ALEN
-1] = ifacenum
;
697 /* we will have to manufacture ethernet headers, prepare template */
698 eth
= (struct ethhdr
*)priv
->ethr_hdr_tmpl
;
699 memcpy(ð
->h_dest
, dev
->net
->dev_addr
, ETH_ALEN
);
700 eth
->h_proto
= cpu_to_be16(ETH_P_IP
);
702 /* prepare shutdown message template */
703 memcpy(priv
->shdwn_msg
, shdwn_tmplate
, sizeof(priv
->shdwn_msg
));
704 /* set context index initially to 0 - prepares tx hdr template */
705 sierra_net_set_ctx_index(priv
, 0);
707 /* decrease the rx_urb_size and max_tx_size to 4k on USB 1.1 */
708 dev
->rx_urb_size
= SIERRA_NET_RX_URB_SIZE
;
709 if (dev
->udev
->speed
!= USB_SPEED_HIGH
)
710 dev
->rx_urb_size
= min_t(size_t, 4096, SIERRA_NET_RX_URB_SIZE
);
712 dev
->net
->hard_header_len
+= SIERRA_NET_HIP_EXT_HDR_LEN
;
713 dev
->hard_mtu
= dev
->net
->mtu
+ dev
->net
->hard_header_len
;
715 /* Set up the netdev */
716 dev
->net
->flags
|= IFF_NOARP
;
717 dev
->net
->ethtool_ops
= &sierra_net_ethtool_ops
;
718 netif_carrier_off(dev
->net
);
720 sierra_net_set_private(dev
, priv
);
722 priv
->kevent_flags
= 0;
724 /* Use the shared workqueue */
725 INIT_WORK(&priv
->sierra_net_kevent
, sierra_net_kevent
);
727 /* Only need to do this once */
728 init_timer(&priv
->sync_timer
);
730 /* verify fw attributes */
731 status
= sierra_net_get_fw_attr(dev
, &fwattr
);
732 dev_dbg(&dev
->udev
->dev
, "Fw attr: %x\n", fwattr
);
734 /* test whether firmware supports DHCP */
735 if (!(status
== sizeof(fwattr
) && (fwattr
& SWI_GET_FW_ATTR_MASK
))) {
736 /* found incompatible firmware version */
737 dev_err(&dev
->udev
->dev
, "Incompatible driver and firmware"
742 /* prepare sync message from template */
743 memcpy(priv
->sync_msg
, sync_tmplate
, sizeof(priv
->sync_msg
));
745 /* initiate the sync sequence */
746 sierra_net_dosync(dev
);
751 static void sierra_net_unbind(struct usbnet
*dev
, struct usb_interface
*intf
)
754 struct sierra_net_data
*priv
= sierra_net_get_private(dev
);
756 dev_dbg(&dev
->udev
->dev
, "%s", __func__
);
758 /* kill the timer and work */
759 del_timer_sync(&priv
->sync_timer
);
760 cancel_work_sync(&priv
->sierra_net_kevent
);
762 /* tell modem we are going away */
763 status
= sierra_net_send_cmd(dev
, priv
->shdwn_msg
,
764 sizeof(priv
->shdwn_msg
), "Shutdown");
767 "usb_control_msg failed, status %d\n", status
);
769 sierra_net_set_private(dev
, NULL
);
774 static struct sk_buff
*sierra_net_skb_clone(struct usbnet
*dev
,
775 struct sk_buff
*skb
, int len
)
777 struct sk_buff
*new_skb
;
780 new_skb
= skb_clone(skb
, GFP_ATOMIC
);
782 /* remove len bytes from original */
785 /* trim next packet to it's length */
787 skb_trim(new_skb
, len
);
789 if (netif_msg_rx_err(dev
))
790 netdev_err(dev
->net
, "failed to get skb\n");
791 dev
->net
->stats
.rx_dropped
++;
797 /* ---------------------------- Receive data path ----------------------*/
798 static int sierra_net_rx_fixup(struct usbnet
*dev
, struct sk_buff
*skb
)
802 struct sk_buff
*new_skb
;
804 dev_dbg(&dev
->udev
->dev
, "%s", __func__
);
806 /* could contain multiple packets */
807 while (likely(skb
->len
)) {
808 err
= parse_hip(skb
->data
, skb
->len
, &hh
);
810 if (netif_msg_rx_err(dev
))
811 netdev_err(dev
->net
, "Invalid HIP header %d\n",
813 /* dev->net->stats.rx_errors incremented by caller */
814 dev
->net
->stats
.rx_length_errors
++;
818 /* Validate Extended HIP header */
819 if (!hh
.extmsgid
.is_present
820 || hh
.extmsgid
.word
!= SIERRA_NET_HIP_EXT_IP_IN_ID
) {
821 if (netif_msg_rx_err(dev
))
822 netdev_err(dev
->net
, "HIP/ETH: Invalid pkt\n");
824 dev
->net
->stats
.rx_frame_errors
++;
825 /* dev->net->stats.rx_errors incremented by caller */
829 skb_pull(skb
, hh
.hdrlen
);
831 /* We are going to accept this packet, prepare it */
832 memcpy(skb
->data
, sierra_net_get_private(dev
)->ethr_hdr_tmpl
,
835 /* Last packet in batch handled by usbnet */
836 if (hh
.payload_len
.word
== skb
->len
)
839 new_skb
= sierra_net_skb_clone(dev
, skb
, hh
.payload_len
.word
);
841 usbnet_skb_return(dev
, new_skb
);
848 /* ---------------------------- Transmit data path ----------------------*/
849 static struct sk_buff
*sierra_net_tx_fixup(struct usbnet
*dev
,
850 struct sk_buff
*skb
, gfp_t flags
)
852 struct sierra_net_data
*priv
= sierra_net_get_private(dev
);
856 BUILD_BUG_ON(FIELD_SIZEOF(struct usbnet
, data
)
857 < sizeof(struct cdc_state
));
859 dev_dbg(&dev
->udev
->dev
, "%s", __func__
);
860 if (priv
->link_up
&& check_ethip_packet(skb
, dev
) && is_ip(skb
)) {
861 /* enough head room as is? */
862 if (SIERRA_NET_HIP_EXT_HDR_LEN
<= skb_headroom(skb
)) {
863 /* Save the Eth/IP length and set up HIP hdr */
865 skb_push(skb
, SIERRA_NET_HIP_EXT_HDR_LEN
);
866 /* Handle ZLP issue */
867 need_tail
= ((len
+ SIERRA_NET_HIP_EXT_HDR_LEN
)
868 % dev
->maxpacket
== 0);
870 if (unlikely(skb_tailroom(skb
) == 0)) {
871 netdev_err(dev
->net
, "tx_fixup:"
872 "no room for packet\n");
873 dev_kfree_skb_any(skb
);
876 skb
->data
[skb
->len
] = 0;
881 build_hip(skb
->data
, len
, priv
);
885 * compensate in the future if necessary
887 netdev_err(dev
->net
, "tx_fixup: no room for HIP\n");
892 dev
->net
->stats
.tx_carrier_errors
++;
894 /* tx_dropped incremented by usbnet */
896 /* filter the packet out, release it */
897 dev_kfree_skb_any(skb
);
901 static const struct driver_info sierra_net_info_direct_ip
= {
902 .description
= "Sierra Wireless USB-to-WWAN Modem",
903 .flags
= FLAG_WWAN
| FLAG_SEND_ZLP
,
904 .bind
= sierra_net_bind
,
905 .unbind
= sierra_net_unbind
,
906 .status
= sierra_net_status
,
907 .rx_fixup
= sierra_net_rx_fixup
,
908 .tx_fixup
= sierra_net_tx_fixup
,
911 #define DIRECT_IP_DEVICE(vend, prod) \
912 {USB_DEVICE_INTERFACE_NUMBER(vend, prod, 7), \
913 .driver_info = (unsigned long)&sierra_net_info_direct_ip}, \
914 {USB_DEVICE_INTERFACE_NUMBER(vend, prod, 10), \
915 .driver_info = (unsigned long)&sierra_net_info_direct_ip}, \
916 {USB_DEVICE_INTERFACE_NUMBER(vend, prod, 11), \
917 .driver_info = (unsigned long)&sierra_net_info_direct_ip}
919 static const struct usb_device_id products
[] = {
920 DIRECT_IP_DEVICE(0x1199, 0x68A3), /* Sierra Wireless USB-to-WWAN modem */
921 DIRECT_IP_DEVICE(0x0F3D, 0x68A3), /* AT&T Direct IP modem */
922 DIRECT_IP_DEVICE(0x1199, 0x68AA), /* Sierra Wireless Direct IP LTE modem */
923 DIRECT_IP_DEVICE(0x0F3D, 0x68AA), /* AT&T Direct IP LTE modem */
927 MODULE_DEVICE_TABLE(usb
, products
);
929 /* We are based on usbnet, so let it handle the USB driver specifics */
930 static struct usb_driver sierra_net_driver
= {
931 .name
= "sierra_net",
932 .id_table
= products
,
933 .probe
= usbnet_probe
,
934 .disconnect
= usbnet_disconnect
,
935 .suspend
= usbnet_suspend
,
936 .resume
= usbnet_resume
,
938 .disable_hub_initiated_lpm
= 1,
941 module_usb_driver(sierra_net_driver
);
943 MODULE_AUTHOR(DRIVER_AUTHOR
);
944 MODULE_DESCRIPTION(DRIVER_DESC
);
945 MODULE_VERSION(DRIVER_VERSION
);
946 MODULE_LICENSE("GPL");