1 /* 2 * USB-to-WWAN Driver for Sierra Wireless modems 3 * 4 * Copyright (C) 2008, 2009, 2010 Paxton Smith, Matthew Safar, Rory Filer 5 * <linux@sierrawireless.com> 6 * 7 * Portions of this based on the cdc_ether driver by David Brownell (2003-2005) 8 * and Ole Andre Vadla Ravnas (ActiveSync) (2006). 9 * 10 * IMPORTANT DISCLAIMER: This driver is not commercially supported by 11 * Sierra Wireless. Use at your own risk. 12 * 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. 17 * 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. 22 * 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 26 */ 27 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"; 32 33 /* if defined debug messages enabled */ 34 /*#define DEBUG*/ 35 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> 44 #include <net/ip.h> 45 #include <net/udp.h> 46 #include <asm/unaligned.h> 47 #include <linux/usb/usbnet.h> 48 49 #define SWI_USB_REQUEST_GET_FW_ATTR 0x06 50 #define SWI_GET_FW_ATTR_MASK 0x08 51 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 54 */ 55 static atomic_t iface_counter = ATOMIC_INIT(0); 56 57 /* 58 * SYNC Timer Delay definition used to set the expiry time 59 */ 60 #define SIERRA_NET_SYNCDELAY (2*HZ) 61 62 /* Max. MTU supported. The modem buffers are limited to 1500 */ 63 #define SIERRA_NET_MAX_SUPPORTED_MTU 1500 64 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) 68 */ 69 #define SIERRA_NET_USBCTL_BUF_LEN 1024 70 71 /* Overriding the default usbnet rx_urb_size */ 72 #define SIERRA_NET_RX_URB_SIZE (8 * 1024) 73 74 /* Private data structure */ 75 struct sierra_net_data { 76 77 u8 ethr_hdr_tmpl[ETH_HLEN]; /* ethernet header template for rx'd pkts */ 78 79 u16 link_up; /* air link up or down */ 80 u8 tx_hdr_template[4]; /* part of HIP hdr for tx'd packets */ 81 82 u8 sync_msg[4]; /* SYNC message */ 83 u8 shdwn_msg[4]; /* Shutdown message */ 84 85 /* Backpointer to the container */ 86 struct usbnet *usbnet; 87 88 u8 ifnum; /* interface number */ 89 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 */ 96 }; 97 98 struct param { 99 int is_present; 100 union { 101 void *ptr; 102 u32 dword; 103 u16 word; 104 u8 byte; 105 }; 106 }; 107 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 */ 114 115 #define SIERRA_NET_HIP_EXT_IP_IN_ID 0x0202 116 #define SIERRA_NET_HIP_EXT_IP_OUT_ID 0x0002 117 118 /* 3G UMTS Link Sense Indication definitions */ 119 #define SIERRA_NET_HIP_LSI_UMTSID 0x78 120 121 /* Reverse Channel Grant Indication HIP message */ 122 #define SIERRA_NET_HIP_RCGI 0x64 123 124 /* LSI Protocol types */ 125 #define SIERRA_NET_PROTOCOL_UMTS 0x01 126 /* LSI Coverage */ 127 #define SIERRA_NET_COVERAGE_NONE 0x00 128 #define SIERRA_NET_COVERAGE_NOPACKET 0x01 129 130 /* LSI Session */ 131 #define SIERRA_NET_SESSION_IDLE 0x00 132 /* LSI Link types */ 133 #define SIERRA_NET_AS_LINK_TYPE_IPv4 0x00 134 135 struct lsi_umts { 136 u8 protocol; 137 u8 unused1; 138 __be16 length; 139 /* eventually use a union for the rest - assume umts for now */ 140 u8 coverage; 141 u8 unused2[41]; 142 u8 session_state; 143 u8 unused3[33]; 144 u8 link_type; 145 u8 pdp_addr_len; /* NW-supplied PDP address len */ 146 u8 pdp_addr[16]; /* NW-supplied PDP address (bigendian)) */ 147 u8 unused4[23]; 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) */ 156 u8 unused5[4]; 157 u8 gw_addr_len; /* NW-supplied GW address len */ 158 u8 gw_addr[16]; /* NW-supplied GW address (bigendian) */ 159 u8 reserved[8]; 160 } __packed; 161 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) 166 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); 170 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, 180 }; 181 182 /* get private data associated with passed in usbnet device */ 183 static inline struct sierra_net_data *sierra_net_get_private(struct usbnet *dev) 184 { 185 return (struct sierra_net_data *)dev->data[0]; 186 } 187 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) 191 { 192 dev->data[0] = (unsigned long)priv; 193 } 194 195 /* is packet IPv4 */ 196 static inline int is_ip(struct sk_buff *skb) 197 { 198 return skb->protocol == cpu_to_be16(ETH_P_IP); 199 } 200 201 /* 202 * check passed in packet and make sure that: 203 * - it is linear (no scatter/gather) 204 * - it is ethernet (mac_header properly set) 205 */ 206 static int check_ethip_packet(struct sk_buff *skb, struct usbnet *dev) 207 { 208 skb_reset_mac_header(skb); /* ethernet header */ 209 210 if (skb_is_nonlinear(skb)) { 211 netdev_err(dev->net, "Non linear buffer-dropping\n"); 212 return 0; 213 } 214 215 if (!pskb_may_pull(skb, ETH_HLEN)) 216 return 0; 217 skb->protocol = eth_hdr(skb)->h_proto; 218 219 return 1; 220 } 221 222 static const u8 *save16bit(struct param *p, const u8 *datap) 223 { 224 p->is_present = 1; 225 p->word = get_unaligned_be16(datap); 226 return datap + sizeof(p->word); 227 } 228 229 static const u8 *save8bit(struct param *p, const u8 *datap) 230 { 231 p->is_present = 1; 232 p->byte = *datap; 233 return datap + sizeof(p->byte); 234 } 235 236 /*----------------------------------------------------------------------------* 237 * BEGIN HIP * 238 *----------------------------------------------------------------------------*/ 239 /* HIP header */ 240 #define SIERRA_NET_HIP_HDR_LEN 4 241 /* Extended HIP header */ 242 #define SIERRA_NET_HIP_EXT_HDR_LEN 6 243 244 struct hip_hdr { 245 int hdrlen; 246 struct param payload_len; 247 struct param msgid; 248 struct param msgspecific; 249 struct param extmsgid; 250 }; 251 252 static int parse_hip(const u8 *buf, const u32 buflen, struct hip_hdr *hh) 253 { 254 const u8 *curp = buf; 255 int padded; 256 257 if (buflen < SIERRA_NET_HIP_HDR_LEN) 258 return -EPROTO; 259 260 curp = save16bit(&hh->payload_len, curp); 261 curp = save8bit(&hh->msgid, curp); 262 curp = save8bit(&hh->msgspecific, curp); 263 264 padded = hh->msgid.byte & 0x80; 265 hh->msgid.byte &= 0x7F; /* 7 bits */ 266 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) 270 return -EPROTO; 271 272 hh->payload_len.word &= 0x3FFF; /* 14 bits */ 273 274 curp = save16bit(&hh->extmsgid, curp); 275 hh->extmsgid.word &= 0x03FF; /* 10 bits */ 276 277 hh->hdrlen = SIERRA_NET_HIP_EXT_HDR_LEN; 278 } else { 279 hh->payload_len.word &= 0x07FF; /* 11 bits */ 280 hh->hdrlen = SIERRA_NET_HIP_HDR_LEN; 281 } 282 283 if (padded) { 284 hh->hdrlen++; 285 hh->payload_len.word--; 286 } 287 288 /* if real packet shorter than the claimed length */ 289 if (buflen < (hh->hdrlen + hh->payload_len.word)) 290 return -EINVAL; 291 292 return 0; 293 } 294 295 static void build_hip(u8 *buf, const u16 payloadlen, 296 struct sierra_net_data *priv) 297 { 298 /* the following doesn't have the full functionality. We 299 * currently build only one kind of header, so it is faster this way 300 */ 301 put_unaligned_be16(payloadlen, buf); 302 memcpy(buf+2, priv->tx_hdr_template, sizeof(priv->tx_hdr_template)); 303 } 304 /*----------------------------------------------------------------------------* 305 * END HIP * 306 *----------------------------------------------------------------------------*/ 307 308 static int sierra_net_send_cmd(struct usbnet *dev, 309 u8 *cmd, int cmdlen, const char * cmd_name) 310 { 311 struct sierra_net_data *priv = sierra_net_get_private(dev); 312 int status; 313 314 status = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, 0), 315 USB_CDC_SEND_ENCAPSULATED_COMMAND, 316 USB_DIR_OUT|USB_TYPE_CLASS|USB_RECIP_INTERFACE, 0, 317 priv->ifnum, cmd, cmdlen, USB_CTRL_SET_TIMEOUT); 318 319 if (status != cmdlen && status != -ENODEV) 320 netdev_err(dev->net, "Submit %s failed %d\n", cmd_name, status); 321 322 return status; 323 } 324 325 static int sierra_net_send_sync(struct usbnet *dev) 326 { 327 int status; 328 struct sierra_net_data *priv = sierra_net_get_private(dev); 329 330 dev_dbg(&dev->udev->dev, "%s", __func__); 331 332 status = sierra_net_send_cmd(dev, priv->sync_msg, 333 sizeof(priv->sync_msg), "SYNC"); 334 335 return status; 336 } 337 338 static void sierra_net_set_ctx_index(struct sierra_net_data *priv, u8 ctx_ix) 339 { 340 dev_dbg(&(priv->usbnet->udev->dev), "%s %d", __func__, ctx_ix); 341 priv->tx_hdr_template[0] = 0x3F; 342 priv->tx_hdr_template[1] = ctx_ix; 343 *((u16 *)&priv->tx_hdr_template[2]) = 344 cpu_to_be16(SIERRA_NET_HIP_EXT_IP_OUT_ID); 345 } 346 347 static inline int sierra_net_is_valid_addrlen(u8 len) 348 { 349 return len == sizeof(struct in_addr); 350 } 351 352 static int sierra_net_parse_lsi(struct usbnet *dev, char *data, int datalen) 353 { 354 struct lsi_umts *lsi = (struct lsi_umts *)data; 355 356 if (datalen < sizeof(struct lsi_umts)) { 357 netdev_err(dev->net, "%s: Data length %d, exp %Zu\n", 358 __func__, datalen, 359 sizeof(struct lsi_umts)); 360 return -1; 361 } 362 363 if (lsi->length != cpu_to_be16(SIERRA_NET_LSI_UMTS_STATUS_LEN)) { 364 netdev_err(dev->net, "%s: LSI_UMTS_STATUS_LEN %d, exp %u\n", 365 __func__, be16_to_cpu(lsi->length), 366 (u32)SIERRA_NET_LSI_UMTS_STATUS_LEN); 367 return -1; 368 } 369 370 /* Validate the protocol - only support UMTS for now */ 371 if (lsi->protocol != SIERRA_NET_PROTOCOL_UMTS) { 372 netdev_err(dev->net, "Protocol unsupported, 0x%02x\n", 373 lsi->protocol); 374 return -1; 375 } 376 377 /* Validate the link type */ 378 if (lsi->link_type != SIERRA_NET_AS_LINK_TYPE_IPv4) { 379 netdev_err(dev->net, "Link type unsupported: 0x%02x\n", 380 lsi->link_type); 381 return -1; 382 } 383 384 /* Validate the coverage */ 385 if (lsi->coverage == SIERRA_NET_COVERAGE_NONE 386 || lsi->coverage == SIERRA_NET_COVERAGE_NOPACKET) { 387 netdev_err(dev->net, "No coverage, 0x%02x\n", lsi->coverage); 388 return 0; 389 } 390 391 /* Validate the session state */ 392 if (lsi->session_state == SIERRA_NET_SESSION_IDLE) { 393 netdev_err(dev->net, "Session idle, 0x%02x\n", 394 lsi->session_state); 395 return 0; 396 } 397 398 /* Set link_sense true */ 399 return 1; 400 } 401 402 static void sierra_net_handle_lsi(struct usbnet *dev, char *data, 403 struct hip_hdr *hh) 404 { 405 struct sierra_net_data *priv = sierra_net_get_private(dev); 406 int link_up; 407 408 link_up = sierra_net_parse_lsi(dev, data + hh->hdrlen, 409 hh->payload_len.word); 410 if (link_up < 0) { 411 netdev_err(dev->net, "Invalid LSI\n"); 412 return; 413 } 414 if (link_up) { 415 sierra_net_set_ctx_index(priv, hh->msgspecific.byte); 416 priv->link_up = 1; 417 netif_carrier_on(dev->net); 418 } else { 419 priv->link_up = 0; 420 netif_carrier_off(dev->net); 421 } 422 } 423 424 static void sierra_net_dosync(struct usbnet *dev) 425 { 426 int status; 427 struct sierra_net_data *priv = sierra_net_get_private(dev); 428 429 dev_dbg(&dev->udev->dev, "%s", __func__); 430 431 /* tell modem we are ready */ 432 status = sierra_net_send_sync(dev); 433 if (status < 0) 434 netdev_err(dev->net, 435 "Send SYNC failed, status %d\n", status); 436 status = sierra_net_send_sync(dev); 437 if (status < 0) 438 netdev_err(dev->net, 439 "Send SYNC failed, status %d\n", status); 440 441 /* Now, start a timer and make sure we get the Restart Indication */ 442 priv->sync_timer.function = sierra_sync_timer; 443 priv->sync_timer.data = (unsigned long) dev; 444 priv->sync_timer.expires = jiffies + SIERRA_NET_SYNCDELAY; 445 add_timer(&priv->sync_timer); 446 } 447 448 static void sierra_net_kevent(struct work_struct *work) 449 { 450 struct sierra_net_data *priv = 451 container_of(work, struct sierra_net_data, sierra_net_kevent); 452 struct usbnet *dev = priv->usbnet; 453 int len; 454 int err; 455 u8 *buf; 456 u8 ifnum; 457 458 if (test_bit(SIERRA_NET_EVENT_RESP_AVAIL, &priv->kevent_flags)) { 459 clear_bit(SIERRA_NET_EVENT_RESP_AVAIL, &priv->kevent_flags); 460 461 /* Query the modem for the LSI message */ 462 buf = kzalloc(SIERRA_NET_USBCTL_BUF_LEN, GFP_KERNEL); 463 if (!buf) { 464 netdev_err(dev->net, 465 "failed to allocate buf for LS msg\n"); 466 return; 467 } 468 ifnum = priv->ifnum; 469 len = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0), 470 USB_CDC_GET_ENCAPSULATED_RESPONSE, 471 USB_DIR_IN|USB_TYPE_CLASS|USB_RECIP_INTERFACE, 472 0, ifnum, buf, SIERRA_NET_USBCTL_BUF_LEN, 473 USB_CTRL_SET_TIMEOUT); 474 475 if (len < 0) { 476 netdev_err(dev->net, 477 "usb_control_msg failed, status %d\n", len); 478 } else { 479 struct hip_hdr hh; 480 481 dev_dbg(&dev->udev->dev, "%s: Received status message," 482 " %04x bytes", __func__, len); 483 484 err = parse_hip(buf, len, &hh); 485 if (err) { 486 netdev_err(dev->net, "%s: Bad packet," 487 " parse result %d\n", __func__, err); 488 kfree(buf); 489 return; 490 } 491 492 /* Validate packet length */ 493 if (len != hh.hdrlen + hh.payload_len.word) { 494 netdev_err(dev->net, "%s: Bad packet, received" 495 " %d, expected %d\n", __func__, len, 496 hh.hdrlen + hh.payload_len.word); 497 kfree(buf); 498 return; 499 } 500 501 /* Switch on received message types */ 502 switch (hh.msgid.byte) { 503 case SIERRA_NET_HIP_LSI_UMTSID: 504 dev_dbg(&dev->udev->dev, "LSI for ctx:%d", 505 hh.msgspecific.byte); 506 sierra_net_handle_lsi(dev, buf, &hh); 507 break; 508 case SIERRA_NET_HIP_RESTART_ID: 509 dev_dbg(&dev->udev->dev, "Restart reported: %d," 510 " stopping sync timer", 511 hh.msgspecific.byte); 512 /* Got sync resp - stop timer & clear mask */ 513 del_timer_sync(&priv->sync_timer); 514 clear_bit(SIERRA_NET_TIMER_EXPIRY, 515 &priv->kevent_flags); 516 break; 517 case SIERRA_NET_HIP_HSYNC_ID: 518 dev_dbg(&dev->udev->dev, "SYNC received"); 519 err = sierra_net_send_sync(dev); 520 if (err < 0) 521 netdev_err(dev->net, 522 "Send SYNC failed %d\n", err); 523 break; 524 case SIERRA_NET_HIP_EXTENDEDID: 525 netdev_err(dev->net, "Unrecognized HIP msg, " 526 "extmsgid 0x%04x\n", hh.extmsgid.word); 527 break; 528 case SIERRA_NET_HIP_RCGI: 529 /* Ignored */ 530 break; 531 default: 532 netdev_err(dev->net, "Unrecognized HIP msg, " 533 "msgid 0x%02x\n", hh.msgid.byte); 534 break; 535 } 536 } 537 kfree(buf); 538 } 539 /* The sync timer bit might be set */ 540 if (test_bit(SIERRA_NET_TIMER_EXPIRY, &priv->kevent_flags)) { 541 clear_bit(SIERRA_NET_TIMER_EXPIRY, &priv->kevent_flags); 542 dev_dbg(&dev->udev->dev, "Deferred sync timer expiry"); 543 sierra_net_dosync(priv->usbnet); 544 } 545 546 if (priv->kevent_flags) 547 dev_dbg(&dev->udev->dev, "sierra_net_kevent done, " 548 "kevent_flags = 0x%lx", priv->kevent_flags); 549 } 550 551 static void sierra_net_defer_kevent(struct usbnet *dev, int work) 552 { 553 struct sierra_net_data *priv = sierra_net_get_private(dev); 554 555 set_bit(work, &priv->kevent_flags); 556 schedule_work(&priv->sierra_net_kevent); 557 } 558 559 /* 560 * Sync Retransmit Timer Handler. On expiry, kick the work queue 561 */ 562 static void sierra_sync_timer(unsigned long syncdata) 563 { 564 struct usbnet *dev = (struct usbnet *)syncdata; 565 566 dev_dbg(&dev->udev->dev, "%s", __func__); 567 /* Kick the tasklet */ 568 sierra_net_defer_kevent(dev, SIERRA_NET_TIMER_EXPIRY); 569 } 570 571 static void sierra_net_status(struct usbnet *dev, struct urb *urb) 572 { 573 struct usb_cdc_notification *event; 574 575 dev_dbg(&dev->udev->dev, "%s", __func__); 576 577 if (urb->actual_length < sizeof *event) 578 return; 579 580 /* Add cases to handle other standard notifications. */ 581 event = urb->transfer_buffer; 582 switch (event->bNotificationType) { 583 case USB_CDC_NOTIFY_NETWORK_CONNECTION: 584 case USB_CDC_NOTIFY_SPEED_CHANGE: 585 /* USB 305 sends those */ 586 break; 587 case USB_CDC_NOTIFY_RESPONSE_AVAILABLE: 588 sierra_net_defer_kevent(dev, SIERRA_NET_EVENT_RESP_AVAIL); 589 break; 590 default: 591 netdev_err(dev->net, ": unexpected notification %02x!\n", 592 event->bNotificationType); 593 break; 594 } 595 } 596 597 static void sierra_net_get_drvinfo(struct net_device *net, 598 struct ethtool_drvinfo *info) 599 { 600 /* Inherit standard device info */ 601 usbnet_get_drvinfo(net, info); 602 strncpy(info->driver, driver_name, sizeof info->driver); 603 strncpy(info->version, DRIVER_VERSION, sizeof info->version); 604 } 605 606 static u32 sierra_net_get_link(struct net_device *net) 607 { 608 struct usbnet *dev = netdev_priv(net); 609 /* Report link is down whenever the interface is down */ 610 return sierra_net_get_private(dev)->link_up && netif_running(net); 611 } 612 613 static const struct ethtool_ops sierra_net_ethtool_ops = { 614 .get_drvinfo = sierra_net_get_drvinfo, 615 .get_link = sierra_net_get_link, 616 .get_msglevel = usbnet_get_msglevel, 617 .set_msglevel = usbnet_set_msglevel, 618 .get_settings = usbnet_get_settings, 619 .set_settings = usbnet_set_settings, 620 .nway_reset = usbnet_nway_reset, 621 }; 622 623 /* MTU can not be more than 1500 bytes, enforce it. */ 624 static int sierra_net_change_mtu(struct net_device *net, int new_mtu) 625 { 626 if (new_mtu > SIERRA_NET_MAX_SUPPORTED_MTU) 627 return -EINVAL; 628 629 return usbnet_change_mtu(net, new_mtu); 630 } 631 632 static int sierra_net_get_fw_attr(struct usbnet *dev, u16 *datap) 633 { 634 int result = 0; 635 u16 *attrdata; 636 637 attrdata = kmalloc(sizeof(*attrdata), GFP_KERNEL); 638 if (!attrdata) 639 return -ENOMEM; 640 641 result = usb_control_msg( 642 dev->udev, 643 usb_rcvctrlpipe(dev->udev, 0), 644 /* _u8 vendor specific request */ 645 SWI_USB_REQUEST_GET_FW_ATTR, 646 USB_DIR_IN | USB_TYPE_VENDOR, /* __u8 request type */ 647 0x0000, /* __u16 value not used */ 648 0x0000, /* __u16 index not used */ 649 attrdata, /* char *data */ 650 sizeof(*attrdata), /* __u16 size */ 651 USB_CTRL_SET_TIMEOUT); /* int timeout */ 652 653 if (result < 0) { 654 kfree(attrdata); 655 return -EIO; 656 } 657 658 *datap = le16_to_cpu(*attrdata); 659 660 kfree(attrdata); 661 return result; 662 } 663 664 /* 665 * collects the bulk endpoints, the status endpoint. 666 */ 667 static int sierra_net_bind(struct usbnet *dev, struct usb_interface *intf) 668 { 669 u8 ifacenum; 670 u8 numendpoints; 671 u16 fwattr = 0; 672 int status; 673 struct ethhdr *eth; 674 struct sierra_net_data *priv; 675 static const u8 sync_tmplate[sizeof(priv->sync_msg)] = { 676 0x00, 0x00, SIERRA_NET_HIP_MSYNC_ID, 0x00}; 677 static const u8 shdwn_tmplate[sizeof(priv->shdwn_msg)] = { 678 0x00, 0x00, SIERRA_NET_HIP_SHUTD_ID, 0x00}; 679 680 dev_dbg(&dev->udev->dev, "%s", __func__); 681 682 ifacenum = intf->cur_altsetting->desc.bInterfaceNumber; 683 numendpoints = intf->cur_altsetting->desc.bNumEndpoints; 684 /* We have three endpoints, bulk in and out, and a status */ 685 if (numendpoints != 3) { 686 dev_err(&dev->udev->dev, "Expected 3 endpoints, found: %d", 687 numendpoints); 688 return -ENODEV; 689 } 690 /* Status endpoint set in usbnet_get_endpoints() */ 691 dev->status = NULL; 692 status = usbnet_get_endpoints(dev, intf); 693 if (status < 0) { 694 dev_err(&dev->udev->dev, "Error in usbnet_get_endpoints (%d)", 695 status); 696 return -ENODEV; 697 } 698 /* Initialize sierra private data */ 699 priv = kzalloc(sizeof *priv, GFP_KERNEL); 700 if (!priv) { 701 dev_err(&dev->udev->dev, "No memory"); 702 return -ENOMEM; 703 } 704 705 priv->usbnet = dev; 706 priv->ifnum = ifacenum; 707 dev->net->netdev_ops = &sierra_net_device_ops; 708 709 /* change MAC addr to include, ifacenum, and to be unique */ 710 dev->net->dev_addr[ETH_ALEN-2] = atomic_inc_return(&iface_counter); 711 dev->net->dev_addr[ETH_ALEN-1] = ifacenum; 712 713 /* we will have to manufacture ethernet headers, prepare template */ 714 eth = (struct ethhdr *)priv->ethr_hdr_tmpl; 715 memcpy(ð->h_dest, dev->net->dev_addr, ETH_ALEN); 716 eth->h_proto = cpu_to_be16(ETH_P_IP); 717 718 /* prepare shutdown message template */ 719 memcpy(priv->shdwn_msg, shdwn_tmplate, sizeof(priv->shdwn_msg)); 720 /* set context index initially to 0 - prepares tx hdr template */ 721 sierra_net_set_ctx_index(priv, 0); 722 723 /* decrease the rx_urb_size and max_tx_size to 4k on USB 1.1 */ 724 dev->rx_urb_size = SIERRA_NET_RX_URB_SIZE; 725 if (dev->udev->speed != USB_SPEED_HIGH) 726 dev->rx_urb_size = min_t(size_t, 4096, SIERRA_NET_RX_URB_SIZE); 727 728 dev->net->hard_header_len += SIERRA_NET_HIP_EXT_HDR_LEN; 729 dev->hard_mtu = dev->net->mtu + dev->net->hard_header_len; 730 731 /* Set up the netdev */ 732 dev->net->flags |= IFF_NOARP; 733 dev->net->ethtool_ops = &sierra_net_ethtool_ops; 734 netif_carrier_off(dev->net); 735 736 sierra_net_set_private(dev, priv); 737 738 priv->kevent_flags = 0; 739 740 /* Use the shared workqueue */ 741 INIT_WORK(&priv->sierra_net_kevent, sierra_net_kevent); 742 743 /* Only need to do this once */ 744 init_timer(&priv->sync_timer); 745 746 /* verify fw attributes */ 747 status = sierra_net_get_fw_attr(dev, &fwattr); 748 dev_dbg(&dev->udev->dev, "Fw attr: %x\n", fwattr); 749 750 /* test whether firmware supports DHCP */ 751 if (!(status == sizeof(fwattr) && (fwattr & SWI_GET_FW_ATTR_MASK))) { 752 /* found incompatible firmware version */ 753 dev_err(&dev->udev->dev, "Incompatible driver and firmware" 754 " versions\n"); 755 kfree(priv); 756 return -ENODEV; 757 } 758 /* prepare sync message from template */ 759 memcpy(priv->sync_msg, sync_tmplate, sizeof(priv->sync_msg)); 760 761 /* initiate the sync sequence */ 762 sierra_net_dosync(dev); 763 764 return 0; 765 } 766 767 static void sierra_net_unbind(struct usbnet *dev, struct usb_interface *intf) 768 { 769 int status; 770 struct sierra_net_data *priv = sierra_net_get_private(dev); 771 772 dev_dbg(&dev->udev->dev, "%s", __func__); 773 774 /* kill the timer and work */ 775 del_timer_sync(&priv->sync_timer); 776 cancel_work_sync(&priv->sierra_net_kevent); 777 778 /* tell modem we are going away */ 779 status = sierra_net_send_cmd(dev, priv->shdwn_msg, 780 sizeof(priv->shdwn_msg), "Shutdown"); 781 if (status < 0) 782 netdev_err(dev->net, 783 "usb_control_msg failed, status %d\n", status); 784 785 sierra_net_set_private(dev, NULL); 786 787 kfree(priv); 788 } 789 790 static struct sk_buff *sierra_net_skb_clone(struct usbnet *dev, 791 struct sk_buff *skb, int len) 792 { 793 struct sk_buff *new_skb; 794 795 /* clone skb */ 796 new_skb = skb_clone(skb, GFP_ATOMIC); 797 798 /* remove len bytes from original */ 799 skb_pull(skb, len); 800 801 /* trim next packet to it's length */ 802 if (new_skb) { 803 skb_trim(new_skb, len); 804 } else { 805 if (netif_msg_rx_err(dev)) 806 netdev_err(dev->net, "failed to get skb\n"); 807 dev->net->stats.rx_dropped++; 808 } 809 810 return new_skb; 811 } 812 813 /* ---------------------------- Receive data path ----------------------*/ 814 static int sierra_net_rx_fixup(struct usbnet *dev, struct sk_buff *skb) 815 { 816 int err; 817 struct hip_hdr hh; 818 struct sk_buff *new_skb; 819 820 dev_dbg(&dev->udev->dev, "%s", __func__); 821 822 /* could contain multiple packets */ 823 while (likely(skb->len)) { 824 err = parse_hip(skb->data, skb->len, &hh); 825 if (err) { 826 if (netif_msg_rx_err(dev)) 827 netdev_err(dev->net, "Invalid HIP header %d\n", 828 err); 829 /* dev->net->stats.rx_errors incremented by caller */ 830 dev->net->stats.rx_length_errors++; 831 return 0; 832 } 833 834 /* Validate Extended HIP header */ 835 if (!hh.extmsgid.is_present 836 || hh.extmsgid.word != SIERRA_NET_HIP_EXT_IP_IN_ID) { 837 if (netif_msg_rx_err(dev)) 838 netdev_err(dev->net, "HIP/ETH: Invalid pkt\n"); 839 840 dev->net->stats.rx_frame_errors++; 841 /* dev->net->stats.rx_errors incremented by caller */ 842 return 0; 843 } 844 845 skb_pull(skb, hh.hdrlen); 846 847 /* We are going to accept this packet, prepare it */ 848 memcpy(skb->data, sierra_net_get_private(dev)->ethr_hdr_tmpl, 849 ETH_HLEN); 850 851 /* Last packet in batch handled by usbnet */ 852 if (hh.payload_len.word == skb->len) 853 return 1; 854 855 new_skb = sierra_net_skb_clone(dev, skb, hh.payload_len.word); 856 if (new_skb) 857 usbnet_skb_return(dev, new_skb); 858 859 } /* while */ 860 861 return 0; 862 } 863 864 /* ---------------------------- Transmit data path ----------------------*/ 865 static struct sk_buff *sierra_net_tx_fixup(struct usbnet *dev, 866 struct sk_buff *skb, gfp_t flags) 867 { 868 struct sierra_net_data *priv = sierra_net_get_private(dev); 869 u16 len; 870 bool need_tail; 871 872 BUILD_BUG_ON(FIELD_SIZEOF(struct usbnet, data) 873 < sizeof(struct cdc_state)); 874 875 dev_dbg(&dev->udev->dev, "%s", __func__); 876 if (priv->link_up && check_ethip_packet(skb, dev) && is_ip(skb)) { 877 /* enough head room as is? */ 878 if (SIERRA_NET_HIP_EXT_HDR_LEN <= skb_headroom(skb)) { 879 /* Save the Eth/IP length and set up HIP hdr */ 880 len = skb->len; 881 skb_push(skb, SIERRA_NET_HIP_EXT_HDR_LEN); 882 /* Handle ZLP issue */ 883 need_tail = ((len + SIERRA_NET_HIP_EXT_HDR_LEN) 884 % dev->maxpacket == 0); 885 if (need_tail) { 886 if (unlikely(skb_tailroom(skb) == 0)) { 887 netdev_err(dev->net, "tx_fixup:" 888 "no room for packet\n"); 889 dev_kfree_skb_any(skb); 890 return NULL; 891 } else { 892 skb->data[skb->len] = 0; 893 __skb_put(skb, 1); 894 len = len + 1; 895 } 896 } 897 build_hip(skb->data, len, priv); 898 return skb; 899 } else { 900 /* 901 * compensate in the future if necessary 902 */ 903 netdev_err(dev->net, "tx_fixup: no room for HIP\n"); 904 } /* headroom */ 905 } 906 907 if (!priv->link_up) 908 dev->net->stats.tx_carrier_errors++; 909 910 /* tx_dropped incremented by usbnet */ 911 912 /* filter the packet out, release it */ 913 dev_kfree_skb_any(skb); 914 return NULL; 915 } 916 917 static const struct driver_info sierra_net_info_direct_ip = { 918 .description = "Sierra Wireless USB-to-WWAN Modem", 919 .flags = FLAG_WWAN | FLAG_SEND_ZLP, 920 .bind = sierra_net_bind, 921 .unbind = sierra_net_unbind, 922 .status = sierra_net_status, 923 .rx_fixup = sierra_net_rx_fixup, 924 .tx_fixup = sierra_net_tx_fixup, 925 }; 926 927 #define DIRECT_IP_DEVICE(vend, prod) \ 928 {USB_DEVICE_INTERFACE_NUMBER(vend, prod, 7), \ 929 .driver_info = (unsigned long)&sierra_net_info_direct_ip}, \ 930 {USB_DEVICE_INTERFACE_NUMBER(vend, prod, 10), \ 931 .driver_info = (unsigned long)&sierra_net_info_direct_ip}, \ 932 {USB_DEVICE_INTERFACE_NUMBER(vend, prod, 11), \ 933 .driver_info = (unsigned long)&sierra_net_info_direct_ip} 934 935 static const struct usb_device_id products[] = { 936 DIRECT_IP_DEVICE(0x1199, 0x68A3), /* Sierra Wireless USB-to-WWAN modem */ 937 DIRECT_IP_DEVICE(0x0F3D, 0x68A3), /* AT&T Direct IP modem */ 938 DIRECT_IP_DEVICE(0x1199, 0x68AA), /* Sierra Wireless Direct IP LTE modem */ 939 DIRECT_IP_DEVICE(0x0F3D, 0x68AA), /* AT&T Direct IP LTE modem */ 940 941 {}, /* last item */ 942 }; 943 MODULE_DEVICE_TABLE(usb, products); 944 945 /* We are based on usbnet, so let it handle the USB driver specifics */ 946 static struct usb_driver sierra_net_driver = { 947 .name = "sierra_net", 948 .id_table = products, 949 .probe = usbnet_probe, 950 .disconnect = usbnet_disconnect, 951 .suspend = usbnet_suspend, 952 .resume = usbnet_resume, 953 .no_dynamic_id = 1, 954 .disable_hub_initiated_lpm = 1, 955 }; 956 957 module_usb_driver(sierra_net_driver); 958 959 MODULE_AUTHOR(DRIVER_AUTHOR); 960 MODULE_DESCRIPTION(DRIVER_DESC); 961 MODULE_VERSION(DRIVER_VERSION); 962 MODULE_LICENSE("GPL"); 963