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 = 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); 317 318 if (status != cmdlen && status != -ENODEV) 319 netdev_err(dev->net, "Submit %s failed %d\n", cmd_name, status); 320 321 return status; 322 } 323 324 static int sierra_net_send_sync(struct usbnet *dev) 325 { 326 int status; 327 struct sierra_net_data *priv = sierra_net_get_private(dev); 328 329 dev_dbg(&dev->udev->dev, "%s", __func__); 330 331 status = sierra_net_send_cmd(dev, priv->sync_msg, 332 sizeof(priv->sync_msg), "SYNC"); 333 334 return status; 335 } 336 337 static void sierra_net_set_ctx_index(struct sierra_net_data *priv, u8 ctx_ix) 338 { 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); 344 } 345 346 static inline int sierra_net_is_valid_addrlen(u8 len) 347 { 348 return len == sizeof(struct in_addr); 349 } 350 351 static int sierra_net_parse_lsi(struct usbnet *dev, char *data, int datalen) 352 { 353 struct lsi_umts *lsi = (struct lsi_umts *)data; 354 355 if (datalen < sizeof(struct lsi_umts)) { 356 netdev_err(dev->net, "%s: Data length %d, exp %Zu\n", 357 __func__, datalen, 358 sizeof(struct lsi_umts)); 359 return -1; 360 } 361 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); 366 return -1; 367 } 368 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", 372 lsi->protocol); 373 return -1; 374 } 375 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", 379 lsi->link_type); 380 return -1; 381 } 382 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); 387 return 0; 388 } 389 390 /* Validate the session state */ 391 if (lsi->session_state == SIERRA_NET_SESSION_IDLE) { 392 netdev_err(dev->net, "Session idle, 0x%02x\n", 393 lsi->session_state); 394 return 0; 395 } 396 397 /* Set link_sense true */ 398 return 1; 399 } 400 401 static void sierra_net_handle_lsi(struct usbnet *dev, char *data, 402 struct hip_hdr *hh) 403 { 404 struct sierra_net_data *priv = sierra_net_get_private(dev); 405 int link_up; 406 407 link_up = sierra_net_parse_lsi(dev, data + hh->hdrlen, 408 hh->payload_len.word); 409 if (link_up < 0) { 410 netdev_err(dev->net, "Invalid LSI\n"); 411 return; 412 } 413 if (link_up) { 414 sierra_net_set_ctx_index(priv, hh->msgspecific.byte); 415 priv->link_up = 1; 416 netif_carrier_on(dev->net); 417 } else { 418 priv->link_up = 0; 419 netif_carrier_off(dev->net); 420 } 421 } 422 423 static void sierra_net_dosync(struct usbnet *dev) 424 { 425 int status; 426 struct sierra_net_data *priv = sierra_net_get_private(dev); 427 428 dev_dbg(&dev->udev->dev, "%s", __func__); 429 430 /* tell modem we are ready */ 431 status = sierra_net_send_sync(dev); 432 if (status < 0) 433 netdev_err(dev->net, 434 "Send SYNC failed, status %d\n", status); 435 status = sierra_net_send_sync(dev); 436 if (status < 0) 437 netdev_err(dev->net, 438 "Send SYNC failed, status %d\n", status); 439 440 /* Now, start a timer and make sure we get the Restart Indication */ 441 priv->sync_timer.function = sierra_sync_timer; 442 priv->sync_timer.data = (unsigned long) dev; 443 priv->sync_timer.expires = jiffies + SIERRA_NET_SYNCDELAY; 444 add_timer(&priv->sync_timer); 445 } 446 447 static void sierra_net_kevent(struct work_struct *work) 448 { 449 struct sierra_net_data *priv = 450 container_of(work, struct sierra_net_data, sierra_net_kevent); 451 struct usbnet *dev = priv->usbnet; 452 int len; 453 int err; 454 u8 *buf; 455 u8 ifnum; 456 457 if (test_bit(SIERRA_NET_EVENT_RESP_AVAIL, &priv->kevent_flags)) { 458 clear_bit(SIERRA_NET_EVENT_RESP_AVAIL, &priv->kevent_flags); 459 460 /* Query the modem for the LSI message */ 461 buf = kzalloc(SIERRA_NET_USBCTL_BUF_LEN, GFP_KERNEL); 462 if (!buf) { 463 netdev_err(dev->net, 464 "failed to allocate buf for LS msg\n"); 465 return; 466 } 467 ifnum = priv->ifnum; 468 len = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0), 469 USB_CDC_GET_ENCAPSULATED_RESPONSE, 470 USB_DIR_IN|USB_TYPE_CLASS|USB_RECIP_INTERFACE, 471 0, ifnum, buf, SIERRA_NET_USBCTL_BUF_LEN, 472 USB_CTRL_SET_TIMEOUT); 473 474 if (len < 0) { 475 netdev_err(dev->net, 476 "usb_control_msg failed, status %d\n", len); 477 } else { 478 struct hip_hdr hh; 479 480 dev_dbg(&dev->udev->dev, "%s: Received status message," 481 " %04x bytes", __func__, len); 482 483 err = parse_hip(buf, len, &hh); 484 if (err) { 485 netdev_err(dev->net, "%s: Bad packet," 486 " parse result %d\n", __func__, err); 487 kfree(buf); 488 return; 489 } 490 491 /* Validate packet length */ 492 if (len != hh.hdrlen + hh.payload_len.word) { 493 netdev_err(dev->net, "%s: Bad packet, received" 494 " %d, expected %d\n", __func__, len, 495 hh.hdrlen + hh.payload_len.word); 496 kfree(buf); 497 return; 498 } 499 500 /* Switch on received message types */ 501 switch (hh.msgid.byte) { 502 case SIERRA_NET_HIP_LSI_UMTSID: 503 dev_dbg(&dev->udev->dev, "LSI for ctx:%d", 504 hh.msgspecific.byte); 505 sierra_net_handle_lsi(dev, buf, &hh); 506 break; 507 case SIERRA_NET_HIP_RESTART_ID: 508 dev_dbg(&dev->udev->dev, "Restart reported: %d," 509 " stopping sync timer", 510 hh.msgspecific.byte); 511 /* Got sync resp - stop timer & clear mask */ 512 del_timer_sync(&priv->sync_timer); 513 clear_bit(SIERRA_NET_TIMER_EXPIRY, 514 &priv->kevent_flags); 515 break; 516 case SIERRA_NET_HIP_HSYNC_ID: 517 dev_dbg(&dev->udev->dev, "SYNC received"); 518 err = sierra_net_send_sync(dev); 519 if (err < 0) 520 netdev_err(dev->net, 521 "Send SYNC failed %d\n", err); 522 break; 523 case SIERRA_NET_HIP_EXTENDEDID: 524 netdev_err(dev->net, "Unrecognized HIP msg, " 525 "extmsgid 0x%04x\n", hh.extmsgid.word); 526 break; 527 case SIERRA_NET_HIP_RCGI: 528 /* Ignored */ 529 break; 530 default: 531 netdev_err(dev->net, "Unrecognized HIP msg, " 532 "msgid 0x%02x\n", hh.msgid.byte); 533 break; 534 } 535 } 536 kfree(buf); 537 } 538 /* The sync timer bit might be set */ 539 if (test_bit(SIERRA_NET_TIMER_EXPIRY, &priv->kevent_flags)) { 540 clear_bit(SIERRA_NET_TIMER_EXPIRY, &priv->kevent_flags); 541 dev_dbg(&dev->udev->dev, "Deferred sync timer expiry"); 542 sierra_net_dosync(priv->usbnet); 543 } 544 545 if (priv->kevent_flags) 546 dev_dbg(&dev->udev->dev, "sierra_net_kevent done, " 547 "kevent_flags = 0x%lx", priv->kevent_flags); 548 } 549 550 static void sierra_net_defer_kevent(struct usbnet *dev, int work) 551 { 552 struct sierra_net_data *priv = sierra_net_get_private(dev); 553 554 set_bit(work, &priv->kevent_flags); 555 schedule_work(&priv->sierra_net_kevent); 556 } 557 558 /* 559 * Sync Retransmit Timer Handler. On expiry, kick the work queue 560 */ 561 static void sierra_sync_timer(unsigned long syncdata) 562 { 563 struct usbnet *dev = (struct usbnet *)syncdata; 564 565 dev_dbg(&dev->udev->dev, "%s", __func__); 566 /* Kick the tasklet */ 567 sierra_net_defer_kevent(dev, SIERRA_NET_TIMER_EXPIRY); 568 } 569 570 static void sierra_net_status(struct usbnet *dev, struct urb *urb) 571 { 572 struct usb_cdc_notification *event; 573 574 dev_dbg(&dev->udev->dev, "%s", __func__); 575 576 if (urb->actual_length < sizeof *event) 577 return; 578 579 /* Add cases to handle other standard notifications. */ 580 event = urb->transfer_buffer; 581 switch (event->bNotificationType) { 582 case USB_CDC_NOTIFY_NETWORK_CONNECTION: 583 case USB_CDC_NOTIFY_SPEED_CHANGE: 584 /* USB 305 sends those */ 585 break; 586 case USB_CDC_NOTIFY_RESPONSE_AVAILABLE: 587 sierra_net_defer_kevent(dev, SIERRA_NET_EVENT_RESP_AVAIL); 588 break; 589 default: 590 netdev_err(dev->net, ": unexpected notification %02x!\n", 591 event->bNotificationType); 592 break; 593 } 594 } 595 596 static void sierra_net_get_drvinfo(struct net_device *net, 597 struct ethtool_drvinfo *info) 598 { 599 /* Inherit standard device info */ 600 usbnet_get_drvinfo(net, info); 601 strncpy(info->driver, driver_name, sizeof info->driver); 602 strncpy(info->version, DRIVER_VERSION, sizeof info->version); 603 } 604 605 static u32 sierra_net_get_link(struct net_device *net) 606 { 607 struct usbnet *dev = netdev_priv(net); 608 /* Report link is down whenever the interface is down */ 609 return sierra_net_get_private(dev)->link_up && netif_running(net); 610 } 611 612 static const struct ethtool_ops sierra_net_ethtool_ops = { 613 .get_drvinfo = sierra_net_get_drvinfo, 614 .get_link = sierra_net_get_link, 615 .get_msglevel = usbnet_get_msglevel, 616 .set_msglevel = usbnet_set_msglevel, 617 .get_settings = usbnet_get_settings, 618 .set_settings = usbnet_set_settings, 619 .nway_reset = usbnet_nway_reset, 620 }; 621 622 /* MTU can not be more than 1500 bytes, enforce it. */ 623 static int sierra_net_change_mtu(struct net_device *net, int new_mtu) 624 { 625 if (new_mtu > SIERRA_NET_MAX_SUPPORTED_MTU) 626 return -EINVAL; 627 628 return usbnet_change_mtu(net, new_mtu); 629 } 630 631 static int sierra_net_get_fw_attr(struct usbnet *dev, u16 *datap) 632 { 633 int result = 0; 634 __le16 attrdata; 635 636 result = usbnet_read_cmd(dev, 637 /* _u8 vendor specific request */ 638 SWI_USB_REQUEST_GET_FW_ATTR, 639 USB_DIR_IN | USB_TYPE_VENDOR, /* __u8 request type */ 640 0x0000, /* __u16 value not used */ 641 0x0000, /* __u16 index not used */ 642 &attrdata, /* char *data */ 643 sizeof(attrdata) /* __u16 size */ 644 ); 645 646 if (result < 0) 647 return -EIO; 648 649 *datap = le16_to_cpu(attrdata); 650 return result; 651 } 652 653 /* 654 * collects the bulk endpoints, the status endpoint. 655 */ 656 static int sierra_net_bind(struct usbnet *dev, struct usb_interface *intf) 657 { 658 u8 ifacenum; 659 u8 numendpoints; 660 u16 fwattr = 0; 661 int status; 662 struct ethhdr *eth; 663 struct sierra_net_data *priv; 664 static const u8 sync_tmplate[sizeof(priv->sync_msg)] = { 665 0x00, 0x00, SIERRA_NET_HIP_MSYNC_ID, 0x00}; 666 static const u8 shdwn_tmplate[sizeof(priv->shdwn_msg)] = { 667 0x00, 0x00, SIERRA_NET_HIP_SHUTD_ID, 0x00}; 668 669 dev_dbg(&dev->udev->dev, "%s", __func__); 670 671 ifacenum = intf->cur_altsetting->desc.bInterfaceNumber; 672 numendpoints = intf->cur_altsetting->desc.bNumEndpoints; 673 /* We have three endpoints, bulk in and out, and a status */ 674 if (numendpoints != 3) { 675 dev_err(&dev->udev->dev, "Expected 3 endpoints, found: %d", 676 numendpoints); 677 return -ENODEV; 678 } 679 /* Status endpoint set in usbnet_get_endpoints() */ 680 dev->status = NULL; 681 status = usbnet_get_endpoints(dev, intf); 682 if (status < 0) { 683 dev_err(&dev->udev->dev, "Error in usbnet_get_endpoints (%d)", 684 status); 685 return -ENODEV; 686 } 687 /* Initialize sierra private data */ 688 priv = kzalloc(sizeof *priv, GFP_KERNEL); 689 if (!priv) { 690 dev_err(&dev->udev->dev, "No memory"); 691 return -ENOMEM; 692 } 693 694 priv->usbnet = dev; 695 priv->ifnum = ifacenum; 696 dev->net->netdev_ops = &sierra_net_device_ops; 697 698 /* change MAC addr to include, ifacenum, and to be unique */ 699 dev->net->dev_addr[ETH_ALEN-2] = atomic_inc_return(&iface_counter); 700 dev->net->dev_addr[ETH_ALEN-1] = ifacenum; 701 702 /* we will have to manufacture ethernet headers, prepare template */ 703 eth = (struct ethhdr *)priv->ethr_hdr_tmpl; 704 memcpy(ð->h_dest, dev->net->dev_addr, ETH_ALEN); 705 eth->h_proto = cpu_to_be16(ETH_P_IP); 706 707 /* prepare shutdown message template */ 708 memcpy(priv->shdwn_msg, shdwn_tmplate, sizeof(priv->shdwn_msg)); 709 /* set context index initially to 0 - prepares tx hdr template */ 710 sierra_net_set_ctx_index(priv, 0); 711 712 /* decrease the rx_urb_size and max_tx_size to 4k on USB 1.1 */ 713 dev->rx_urb_size = SIERRA_NET_RX_URB_SIZE; 714 if (dev->udev->speed != USB_SPEED_HIGH) 715 dev->rx_urb_size = min_t(size_t, 4096, SIERRA_NET_RX_URB_SIZE); 716 717 dev->net->hard_header_len += SIERRA_NET_HIP_EXT_HDR_LEN; 718 dev->hard_mtu = dev->net->mtu + dev->net->hard_header_len; 719 720 /* Set up the netdev */ 721 dev->net->flags |= IFF_NOARP; 722 dev->net->ethtool_ops = &sierra_net_ethtool_ops; 723 netif_carrier_off(dev->net); 724 725 sierra_net_set_private(dev, priv); 726 727 priv->kevent_flags = 0; 728 729 /* Use the shared workqueue */ 730 INIT_WORK(&priv->sierra_net_kevent, sierra_net_kevent); 731 732 /* Only need to do this once */ 733 init_timer(&priv->sync_timer); 734 735 /* verify fw attributes */ 736 status = sierra_net_get_fw_attr(dev, &fwattr); 737 dev_dbg(&dev->udev->dev, "Fw attr: %x\n", fwattr); 738 739 /* test whether firmware supports DHCP */ 740 if (!(status == sizeof(fwattr) && (fwattr & SWI_GET_FW_ATTR_MASK))) { 741 /* found incompatible firmware version */ 742 dev_err(&dev->udev->dev, "Incompatible driver and firmware" 743 " versions\n"); 744 kfree(priv); 745 return -ENODEV; 746 } 747 /* prepare sync message from template */ 748 memcpy(priv->sync_msg, sync_tmplate, sizeof(priv->sync_msg)); 749 750 /* initiate the sync sequence */ 751 sierra_net_dosync(dev); 752 753 return 0; 754 } 755 756 static void sierra_net_unbind(struct usbnet *dev, struct usb_interface *intf) 757 { 758 int status; 759 struct sierra_net_data *priv = sierra_net_get_private(dev); 760 761 dev_dbg(&dev->udev->dev, "%s", __func__); 762 763 /* kill the timer and work */ 764 del_timer_sync(&priv->sync_timer); 765 cancel_work_sync(&priv->sierra_net_kevent); 766 767 /* tell modem we are going away */ 768 status = sierra_net_send_cmd(dev, priv->shdwn_msg, 769 sizeof(priv->shdwn_msg), "Shutdown"); 770 if (status < 0) 771 netdev_err(dev->net, 772 "usb_control_msg failed, status %d\n", status); 773 774 sierra_net_set_private(dev, NULL); 775 776 kfree(priv); 777 } 778 779 static struct sk_buff *sierra_net_skb_clone(struct usbnet *dev, 780 struct sk_buff *skb, int len) 781 { 782 struct sk_buff *new_skb; 783 784 /* clone skb */ 785 new_skb = skb_clone(skb, GFP_ATOMIC); 786 787 /* remove len bytes from original */ 788 skb_pull(skb, len); 789 790 /* trim next packet to it's length */ 791 if (new_skb) { 792 skb_trim(new_skb, len); 793 } else { 794 if (netif_msg_rx_err(dev)) 795 netdev_err(dev->net, "failed to get skb\n"); 796 dev->net->stats.rx_dropped++; 797 } 798 799 return new_skb; 800 } 801 802 /* ---------------------------- Receive data path ----------------------*/ 803 static int sierra_net_rx_fixup(struct usbnet *dev, struct sk_buff *skb) 804 { 805 int err; 806 struct hip_hdr hh; 807 struct sk_buff *new_skb; 808 809 dev_dbg(&dev->udev->dev, "%s", __func__); 810 811 /* could contain multiple packets */ 812 while (likely(skb->len)) { 813 err = parse_hip(skb->data, skb->len, &hh); 814 if (err) { 815 if (netif_msg_rx_err(dev)) 816 netdev_err(dev->net, "Invalid HIP header %d\n", 817 err); 818 /* dev->net->stats.rx_errors incremented by caller */ 819 dev->net->stats.rx_length_errors++; 820 return 0; 821 } 822 823 /* Validate Extended HIP header */ 824 if (!hh.extmsgid.is_present 825 || hh.extmsgid.word != SIERRA_NET_HIP_EXT_IP_IN_ID) { 826 if (netif_msg_rx_err(dev)) 827 netdev_err(dev->net, "HIP/ETH: Invalid pkt\n"); 828 829 dev->net->stats.rx_frame_errors++; 830 /* dev->net->stats.rx_errors incremented by caller */ 831 return 0; 832 } 833 834 skb_pull(skb, hh.hdrlen); 835 836 /* We are going to accept this packet, prepare it */ 837 memcpy(skb->data, sierra_net_get_private(dev)->ethr_hdr_tmpl, 838 ETH_HLEN); 839 840 /* Last packet in batch handled by usbnet */ 841 if (hh.payload_len.word == skb->len) 842 return 1; 843 844 new_skb = sierra_net_skb_clone(dev, skb, hh.payload_len.word); 845 if (new_skb) 846 usbnet_skb_return(dev, new_skb); 847 848 } /* while */ 849 850 return 0; 851 } 852 853 /* ---------------------------- Transmit data path ----------------------*/ 854 static struct sk_buff *sierra_net_tx_fixup(struct usbnet *dev, 855 struct sk_buff *skb, gfp_t flags) 856 { 857 struct sierra_net_data *priv = sierra_net_get_private(dev); 858 u16 len; 859 bool need_tail; 860 861 BUILD_BUG_ON(FIELD_SIZEOF(struct usbnet, data) 862 < sizeof(struct cdc_state)); 863 864 dev_dbg(&dev->udev->dev, "%s", __func__); 865 if (priv->link_up && check_ethip_packet(skb, dev) && is_ip(skb)) { 866 /* enough head room as is? */ 867 if (SIERRA_NET_HIP_EXT_HDR_LEN <= skb_headroom(skb)) { 868 /* Save the Eth/IP length and set up HIP hdr */ 869 len = skb->len; 870 skb_push(skb, SIERRA_NET_HIP_EXT_HDR_LEN); 871 /* Handle ZLP issue */ 872 need_tail = ((len + SIERRA_NET_HIP_EXT_HDR_LEN) 873 % dev->maxpacket == 0); 874 if (need_tail) { 875 if (unlikely(skb_tailroom(skb) == 0)) { 876 netdev_err(dev->net, "tx_fixup:" 877 "no room for packet\n"); 878 dev_kfree_skb_any(skb); 879 return NULL; 880 } else { 881 skb->data[skb->len] = 0; 882 __skb_put(skb, 1); 883 len = len + 1; 884 } 885 } 886 build_hip(skb->data, len, priv); 887 return skb; 888 } else { 889 /* 890 * compensate in the future if necessary 891 */ 892 netdev_err(dev->net, "tx_fixup: no room for HIP\n"); 893 } /* headroom */ 894 } 895 896 if (!priv->link_up) 897 dev->net->stats.tx_carrier_errors++; 898 899 /* tx_dropped incremented by usbnet */ 900 901 /* filter the packet out, release it */ 902 dev_kfree_skb_any(skb); 903 return NULL; 904 } 905 906 static const struct driver_info sierra_net_info_direct_ip = { 907 .description = "Sierra Wireless USB-to-WWAN Modem", 908 .flags = FLAG_WWAN | FLAG_SEND_ZLP, 909 .bind = sierra_net_bind, 910 .unbind = sierra_net_unbind, 911 .status = sierra_net_status, 912 .rx_fixup = sierra_net_rx_fixup, 913 .tx_fixup = sierra_net_tx_fixup, 914 }; 915 916 #define DIRECT_IP_DEVICE(vend, prod) \ 917 {USB_DEVICE_INTERFACE_NUMBER(vend, prod, 7), \ 918 .driver_info = (unsigned long)&sierra_net_info_direct_ip}, \ 919 {USB_DEVICE_INTERFACE_NUMBER(vend, prod, 10), \ 920 .driver_info = (unsigned long)&sierra_net_info_direct_ip}, \ 921 {USB_DEVICE_INTERFACE_NUMBER(vend, prod, 11), \ 922 .driver_info = (unsigned long)&sierra_net_info_direct_ip} 923 924 static const struct usb_device_id products[] = { 925 DIRECT_IP_DEVICE(0x1199, 0x68A3), /* Sierra Wireless USB-to-WWAN modem */ 926 DIRECT_IP_DEVICE(0x0F3D, 0x68A3), /* AT&T Direct IP modem */ 927 DIRECT_IP_DEVICE(0x1199, 0x68AA), /* Sierra Wireless Direct IP LTE modem */ 928 DIRECT_IP_DEVICE(0x0F3D, 0x68AA), /* AT&T Direct IP LTE modem */ 929 930 {}, /* last item */ 931 }; 932 MODULE_DEVICE_TABLE(usb, products); 933 934 /* We are based on usbnet, so let it handle the USB driver specifics */ 935 static struct usb_driver sierra_net_driver = { 936 .name = "sierra_net", 937 .id_table = products, 938 .probe = usbnet_probe, 939 .disconnect = usbnet_disconnect, 940 .suspend = usbnet_suspend, 941 .resume = usbnet_resume, 942 .no_dynamic_id = 1, 943 .disable_hub_initiated_lpm = 1, 944 }; 945 946 module_usb_driver(sierra_net_driver); 947 948 MODULE_AUTHOR(DRIVER_AUTHOR); 949 MODULE_DESCRIPTION(DRIVER_DESC); 950 MODULE_VERSION(DRIVER_VERSION); 951 MODULE_LICENSE("GPL"); 952