Commit | Line | Data |
---|---|---|
9bf211a3 GS |
1 | /* |
2 | * Copyright (c) 2012 Smith Micro Software, Inc. | |
3 | * Copyright (c) 2012 Bjørn Mork <bjorn@mork.no> | |
4 | * | |
5 | * This driver is based on and reuse most of cdc_ncm, which is | |
6 | * Copyright (C) ST-Ericsson 2010-2012 | |
7 | * | |
8 | * This program is free software; you can redistribute it and/or | |
9 | * modify it under the terms of the GNU General Public License | |
10 | * version 2 as published by the Free Software Foundation. | |
11 | */ | |
12 | ||
13 | #include <linux/module.h> | |
14 | #include <linux/netdevice.h> | |
15 | #include <linux/ethtool.h> | |
a82c7ce5 | 16 | #include <linux/if_vlan.h> |
9bf211a3 GS |
17 | #include <linux/ip.h> |
18 | #include <linux/mii.h> | |
19 | #include <linux/usb.h> | |
20 | #include <linux/usb/cdc.h> | |
21 | #include <linux/usb/usbnet.h> | |
22 | #include <linux/usb/cdc-wdm.h> | |
23 | #include <linux/usb/cdc_ncm.h> | |
5b8f15f7 BM |
24 | #include <net/ipv6.h> |
25 | #include <net/addrconf.h> | |
9bf211a3 | 26 | |
146a08d2 BM |
27 | /* alternative VLAN for IP session 0 if not untagged */ |
28 | #define MBIM_IPS0_VID 4094 | |
29 | ||
9bf211a3 GS |
30 | /* driver specific data - must match cdc_ncm usage */ |
31 | struct cdc_mbim_state { | |
32 | struct cdc_ncm_ctx *ctx; | |
33 | atomic_t pmcount; | |
34 | struct usb_driver *subdriver; | |
146a08d2 BM |
35 | unsigned long _unused; |
36 | unsigned long flags; | |
37 | }; | |
38 | ||
39 | /* flags for the cdc_mbim_state.flags field */ | |
40 | enum cdc_mbim_flags { | |
41 | FLAG_IPS0_VLAN = 1 << 0, /* IP session 0 is tagged */ | |
9bf211a3 GS |
42 | }; |
43 | ||
44 | /* using a counter to merge subdriver requests with our own into a combined state */ | |
45 | static int cdc_mbim_manage_power(struct usbnet *dev, int on) | |
46 | { | |
47 | struct cdc_mbim_state *info = (void *)&dev->data; | |
48 | int rv = 0; | |
49 | ||
50 | dev_dbg(&dev->intf->dev, "%s() pmcount=%d, on=%d\n", __func__, atomic_read(&info->pmcount), on); | |
51 | ||
52 | if ((on && atomic_add_return(1, &info->pmcount) == 1) || (!on && atomic_dec_and_test(&info->pmcount))) { | |
53 | /* need autopm_get/put here to ensure the usbcore sees the new value */ | |
54 | rv = usb_autopm_get_interface(dev->intf); | |
9bf211a3 | 55 | dev->intf->needs_remote_wakeup = on; |
04d948a9 BM |
56 | if (!rv) |
57 | usb_autopm_put_interface(dev->intf); | |
9bf211a3 | 58 | } |
04d948a9 | 59 | return 0; |
9bf211a3 GS |
60 | } |
61 | ||
62 | static int cdc_mbim_wdm_manage_power(struct usb_interface *intf, int status) | |
63 | { | |
64 | struct usbnet *dev = usb_get_intfdata(intf); | |
65 | ||
66 | /* can be called while disconnecting */ | |
67 | if (!dev) | |
68 | return 0; | |
69 | ||
70 | return cdc_mbim_manage_power(dev, status); | |
71 | } | |
72 | ||
146a08d2 BM |
73 | static int cdc_mbim_rx_add_vid(struct net_device *netdev, __be16 proto, u16 vid) |
74 | { | |
75 | struct usbnet *dev = netdev_priv(netdev); | |
76 | struct cdc_mbim_state *info = (void *)&dev->data; | |
77 | ||
78 | /* creation of this VLAN is a request to tag IP session 0 */ | |
79 | if (vid == MBIM_IPS0_VID) | |
80 | info->flags |= FLAG_IPS0_VLAN; | |
81 | else | |
82 | if (vid >= 512) /* we don't map these to MBIM session */ | |
83 | return -EINVAL; | |
84 | return 0; | |
85 | } | |
86 | ||
87 | static int cdc_mbim_rx_kill_vid(struct net_device *netdev, __be16 proto, u16 vid) | |
88 | { | |
89 | struct usbnet *dev = netdev_priv(netdev); | |
90 | struct cdc_mbim_state *info = (void *)&dev->data; | |
91 | ||
92 | /* this is a request for an untagged IP session 0 */ | |
93 | if (vid == MBIM_IPS0_VID) | |
94 | info->flags &= ~FLAG_IPS0_VLAN; | |
95 | return 0; | |
96 | } | |
97 | ||
98 | static const struct net_device_ops cdc_mbim_netdev_ops = { | |
99 | .ndo_open = usbnet_open, | |
100 | .ndo_stop = usbnet_stop, | |
101 | .ndo_start_xmit = usbnet_start_xmit, | |
102 | .ndo_tx_timeout = usbnet_tx_timeout, | |
1dfddff5 | 103 | .ndo_change_mtu = cdc_ncm_change_mtu, |
146a08d2 BM |
104 | .ndo_set_mac_address = eth_mac_addr, |
105 | .ndo_validate_addr = eth_validate_addr, | |
106 | .ndo_vlan_rx_add_vid = cdc_mbim_rx_add_vid, | |
107 | .ndo_vlan_rx_kill_vid = cdc_mbim_rx_kill_vid, | |
108 | }; | |
9bf211a3 | 109 | |
50a0ffaf BM |
110 | /* Change the control interface altsetting and update the .driver_info |
111 | * pointer if the matching entry after changing class codes points to | |
112 | * a different struct | |
113 | */ | |
114 | static int cdc_mbim_set_ctrlalt(struct usbnet *dev, struct usb_interface *intf, u8 alt) | |
115 | { | |
116 | struct usb_driver *driver = to_usb_driver(intf->dev.driver); | |
117 | const struct usb_device_id *id; | |
118 | struct driver_info *info; | |
119 | int ret; | |
120 | ||
121 | ret = usb_set_interface(dev->udev, | |
122 | intf->cur_altsetting->desc.bInterfaceNumber, | |
123 | alt); | |
124 | if (ret) | |
125 | return ret; | |
126 | ||
127 | id = usb_match_id(intf, driver->id_table); | |
128 | if (!id) | |
129 | return -ENODEV; | |
130 | ||
131 | info = (struct driver_info *)id->driver_info; | |
132 | if (info != dev->driver_info) { | |
133 | dev_dbg(&intf->dev, "driver_info updated to '%s'\n", | |
134 | info->description); | |
135 | dev->driver_info = info; | |
136 | } | |
137 | return 0; | |
138 | } | |
139 | ||
9bf211a3 GS |
140 | static int cdc_mbim_bind(struct usbnet *dev, struct usb_interface *intf) |
141 | { | |
142 | struct cdc_ncm_ctx *ctx; | |
143 | struct usb_driver *subdriver = ERR_PTR(-ENODEV); | |
144 | int ret = -ENODEV; | |
50a0ffaf | 145 | u8 data_altsetting = 1; |
9bf211a3 GS |
146 | struct cdc_mbim_state *info = (void *)&dev->data; |
147 | ||
50a0ffaf BM |
148 | /* should we change control altsetting on a NCM/MBIM function? */ |
149 | if (cdc_ncm_select_altsetting(intf) == CDC_NCM_COMM_ALTSETTING_MBIM) { | |
150 | data_altsetting = CDC_NCM_DATA_ALTSETTING_MBIM; | |
151 | ret = cdc_mbim_set_ctrlalt(dev, intf, CDC_NCM_COMM_ALTSETTING_MBIM); | |
152 | if (ret) | |
153 | goto err; | |
154 | ret = -ENODEV; | |
155 | } | |
156 | ||
157 | /* we will hit this for NCM/MBIM functions if prefer_mbim is false */ | |
9bf211a3 GS |
158 | if (!cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting)) |
159 | goto err; | |
160 | ||
f8c0cfa5 | 161 | ret = cdc_ncm_bind_common(dev, intf, data_altsetting, dev->driver_info->data); |
9bf211a3 GS |
162 | if (ret) |
163 | goto err; | |
164 | ||
165 | ctx = info->ctx; | |
166 | ||
167 | /* The MBIM descriptor and the status endpoint are required */ | |
168 | if (ctx->mbim_desc && dev->status) | |
169 | subdriver = usb_cdc_wdm_register(ctx->control, | |
170 | &dev->status->desc, | |
171 | le16_to_cpu(ctx->mbim_desc->wMaxControlMessage), | |
172 | cdc_mbim_wdm_manage_power); | |
173 | if (IS_ERR(subdriver)) { | |
174 | ret = PTR_ERR(subdriver); | |
175 | cdc_ncm_unbind(dev, intf); | |
176 | goto err; | |
177 | } | |
178 | ||
179 | /* can't let usbnet use the interrupt endpoint */ | |
180 | dev->status = NULL; | |
181 | info->subdriver = subdriver; | |
182 | ||
183 | /* MBIM cannot do ARP */ | |
184 | dev->net->flags |= IFF_NOARP; | |
a82c7ce5 BM |
185 | |
186 | /* no need to put the VLAN tci in the packet headers */ | |
146a08d2 BM |
187 | dev->net->features |= NETIF_F_HW_VLAN_CTAG_TX | NETIF_F_HW_VLAN_CTAG_FILTER; |
188 | ||
189 | /* monitor VLAN additions and removals */ | |
190 | dev->net->netdev_ops = &cdc_mbim_netdev_ops; | |
9bf211a3 GS |
191 | err: |
192 | return ret; | |
193 | } | |
194 | ||
195 | static void cdc_mbim_unbind(struct usbnet *dev, struct usb_interface *intf) | |
196 | { | |
197 | struct cdc_mbim_state *info = (void *)&dev->data; | |
198 | struct cdc_ncm_ctx *ctx = info->ctx; | |
199 | ||
200 | /* disconnect subdriver from control interface */ | |
201 | if (info->subdriver && info->subdriver->disconnect) | |
202 | info->subdriver->disconnect(ctx->control); | |
203 | info->subdriver = NULL; | |
204 | ||
205 | /* let NCM unbind clean up both control and data interface */ | |
206 | cdc_ncm_unbind(dev, intf); | |
207 | } | |
208 | ||
6b5eeb7f BM |
209 | /* verify that the ethernet protocol is IPv4 or IPv6 */ |
210 | static bool is_ip_proto(__be16 proto) | |
211 | { | |
212 | switch (proto) { | |
213 | case htons(ETH_P_IP): | |
214 | case htons(ETH_P_IPV6): | |
215 | return true; | |
216 | } | |
217 | return false; | |
218 | } | |
9bf211a3 GS |
219 | |
220 | static struct sk_buff *cdc_mbim_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags) | |
221 | { | |
222 | struct sk_buff *skb_out; | |
223 | struct cdc_mbim_state *info = (void *)&dev->data; | |
224 | struct cdc_ncm_ctx *ctx = info->ctx; | |
a82c7ce5 BM |
225 | __le32 sign = cpu_to_le32(USB_CDC_MBIM_NDP16_IPS_SIGN); |
226 | u16 tci = 0; | |
6b5eeb7f | 227 | bool is_ip; |
a82c7ce5 | 228 | u8 *c; |
9bf211a3 GS |
229 | |
230 | if (!ctx) | |
231 | goto error; | |
232 | ||
233 | if (skb) { | |
32b161aa | 234 | if (skb->len <= ETH_HLEN) |
9bf211a3 GS |
235 | goto error; |
236 | ||
6b5eeb7f BM |
237 | /* Some applications using e.g. packet sockets will |
238 | * bypass the VLAN acceleration and create tagged | |
239 | * ethernet frames directly. We primarily look for | |
240 | * the accelerated out-of-band tag, but fall back if | |
241 | * required | |
242 | */ | |
243 | skb_reset_mac_header(skb); | |
244 | if (vlan_get_tag(skb, &tci) < 0 && skb->len > VLAN_ETH_HLEN && | |
245 | __vlan_get_tag(skb, &tci) == 0) { | |
246 | is_ip = is_ip_proto(vlan_eth_hdr(skb)->h_vlan_encapsulated_proto); | |
247 | skb_pull(skb, VLAN_ETH_HLEN); | |
248 | } else { | |
249 | is_ip = is_ip_proto(eth_hdr(skb)->h_proto); | |
250 | skb_pull(skb, ETH_HLEN); | |
251 | } | |
252 | ||
146a08d2 BM |
253 | /* Is IP session <0> tagged too? */ |
254 | if (info->flags & FLAG_IPS0_VLAN) { | |
255 | /* drop all untagged packets */ | |
256 | if (!tci) | |
257 | goto error; | |
258 | /* map MBIM_IPS0_VID to IPS<0> */ | |
259 | if (tci == MBIM_IPS0_VID) | |
260 | tci = 0; | |
261 | } | |
262 | ||
a82c7ce5 | 263 | /* mapping VLANs to MBIM sessions: |
146a08d2 | 264 | * no tag => IPS session <0> if !FLAG_IPS0_VLAN |
a82c7ce5 | 265 | * 1 - 255 => IPS session <vlanid> |
9f651cac | 266 | * 256 - 511 => DSS session <vlanid - 256> |
146a08d2 BM |
267 | * 512 - 4093 => unsupported, drop |
268 | * 4094 => IPS session <0> if FLAG_IPS0_VLAN | |
a82c7ce5 | 269 | */ |
146a08d2 | 270 | |
a82c7ce5 BM |
271 | switch (tci & 0x0f00) { |
272 | case 0x0000: /* VLAN ID 0 - 255 */ | |
6b5eeb7f | 273 | if (!is_ip) |
9f651cac | 274 | goto error; |
9f651cac BM |
275 | c = (u8 *)&sign; |
276 | c[3] = tci; | |
277 | break; | |
278 | case 0x0100: /* VLAN ID 256 - 511 */ | |
6e1b3095 BM |
279 | if (is_ip) |
280 | goto error; | |
9f651cac | 281 | sign = cpu_to_le32(USB_CDC_MBIM_NDP16_DSS_SIGN); |
a82c7ce5 BM |
282 | c = (u8 *)&sign; |
283 | c[3] = tci; | |
284 | break; | |
285 | default: | |
286 | netif_err(dev, tx_err, dev->net, | |
287 | "unsupported tci=0x%04x\n", tci); | |
288 | goto error; | |
289 | } | |
9bf211a3 GS |
290 | } |
291 | ||
292 | spin_lock_bh(&ctx->mtx); | |
bed6f762 | 293 | skb_out = cdc_ncm_fill_tx_frame(dev, skb, sign); |
9bf211a3 GS |
294 | spin_unlock_bh(&ctx->mtx); |
295 | return skb_out; | |
296 | ||
297 | error: | |
298 | if (skb) | |
299 | dev_kfree_skb_any(skb); | |
300 | ||
301 | return NULL; | |
302 | } | |
303 | ||
5b8f15f7 BM |
304 | /* Some devices are known to send Neigbor Solicitation messages and |
305 | * require Neigbor Advertisement replies. The IPv6 core will not | |
306 | * respond since IFF_NOARP is set, so we must handle them ourselves. | |
307 | */ | |
308 | static void do_neigh_solicit(struct usbnet *dev, u8 *buf, u16 tci) | |
309 | { | |
310 | struct ipv6hdr *iph = (void *)buf; | |
311 | struct nd_msg *msg = (void *)(iph + 1); | |
312 | struct net_device *netdev; | |
313 | struct inet6_dev *in6_dev; | |
314 | bool is_router; | |
315 | ||
316 | /* we'll only respond to requests from unicast addresses to | |
317 | * our solicited node addresses. | |
318 | */ | |
319 | if (!ipv6_addr_is_solict_mult(&iph->daddr) || | |
320 | !(ipv6_addr_type(&iph->saddr) & IPV6_ADDR_UNICAST)) | |
321 | return; | |
322 | ||
323 | /* need to send the NA on the VLAN dev, if any */ | |
4f4178f3 BM |
324 | rcu_read_lock(); |
325 | if (tci) { | |
f06c7f9f | 326 | netdev = __vlan_find_dev_deep_rcu(dev->net, htons(ETH_P_8021Q), |
327 | tci); | |
4f4178f3 BM |
328 | if (!netdev) { |
329 | rcu_read_unlock(); | |
330 | return; | |
331 | } | |
332 | } else { | |
5b8f15f7 | 333 | netdev = dev->net; |
4f4178f3 BM |
334 | } |
335 | dev_hold(netdev); | |
336 | rcu_read_unlock(); | |
5b8f15f7 BM |
337 | |
338 | in6_dev = in6_dev_get(netdev); | |
339 | if (!in6_dev) | |
4f4178f3 | 340 | goto out; |
5b8f15f7 BM |
341 | is_router = !!in6_dev->cnf.forwarding; |
342 | in6_dev_put(in6_dev); | |
343 | ||
344 | /* ipv6_stub != NULL if in6_dev_get returned an inet6_dev */ | |
38cf595b | 345 | ipv6_stub->ndisc_send_na(netdev, &iph->saddr, &msg->target, |
5b8f15f7 BM |
346 | is_router /* router */, |
347 | true /* solicited */, | |
348 | false /* override */, | |
349 | true /* inc_opt */); | |
4f4178f3 BM |
350 | out: |
351 | dev_put(netdev); | |
5b8f15f7 BM |
352 | } |
353 | ||
354 | static bool is_neigh_solicit(u8 *buf, size_t len) | |
355 | { | |
356 | struct ipv6hdr *iph = (void *)buf; | |
357 | struct nd_msg *msg = (void *)(iph + 1); | |
358 | ||
359 | return (len >= sizeof(struct ipv6hdr) + sizeof(struct nd_msg) && | |
360 | iph->nexthdr == IPPROTO_ICMPV6 && | |
361 | msg->icmph.icmp6_code == 0 && | |
362 | msg->icmph.icmp6_type == NDISC_NEIGHBOUR_SOLICITATION); | |
363 | } | |
364 | ||
365 | ||
a82c7ce5 | 366 | static struct sk_buff *cdc_mbim_process_dgram(struct usbnet *dev, u8 *buf, size_t len, u16 tci) |
9bf211a3 | 367 | { |
9f651cac | 368 | __be16 proto = htons(ETH_P_802_3); |
9bf211a3 GS |
369 | struct sk_buff *skb = NULL; |
370 | ||
146a08d2 | 371 | if (tci < 256 || tci == MBIM_IPS0_VID) { /* IPS session? */ |
9f651cac BM |
372 | if (len < sizeof(struct iphdr)) |
373 | goto err; | |
a82c7ce5 | 374 | |
9f651cac BM |
375 | switch (*buf & 0xf0) { |
376 | case 0x40: | |
377 | proto = htons(ETH_P_IP); | |
378 | break; | |
379 | case 0x60: | |
5b8f15f7 BM |
380 | if (is_neigh_solicit(buf, len)) |
381 | do_neigh_solicit(dev, buf, tci); | |
9f651cac BM |
382 | proto = htons(ETH_P_IPV6); |
383 | break; | |
384 | default: | |
385 | goto err; | |
386 | } | |
9bf211a3 GS |
387 | } |
388 | ||
389 | skb = netdev_alloc_skb_ip_align(dev->net, len + ETH_HLEN); | |
390 | if (!skb) | |
391 | goto err; | |
392 | ||
393 | /* add an ethernet header */ | |
394 | skb_put(skb, ETH_HLEN); | |
395 | skb_reset_mac_header(skb); | |
396 | eth_hdr(skb)->h_proto = proto; | |
519983b1 | 397 | eth_zero_addr(eth_hdr(skb)->h_source); |
9bf211a3 GS |
398 | memcpy(eth_hdr(skb)->h_dest, dev->net->dev_addr, ETH_ALEN); |
399 | ||
400 | /* add datagram */ | |
401 | memcpy(skb_put(skb, len), buf, len); | |
a82c7ce5 BM |
402 | |
403 | /* map MBIM session to VLAN */ | |
404 | if (tci) | |
b4bef1b5 | 405 | __vlan_hwaccel_put_tag(skb, htons(ETH_P_8021Q), tci); |
9bf211a3 GS |
406 | err: |
407 | return skb; | |
408 | } | |
409 | ||
410 | static int cdc_mbim_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in) | |
411 | { | |
412 | struct sk_buff *skb; | |
a82c7ce5 BM |
413 | struct cdc_mbim_state *info = (void *)&dev->data; |
414 | struct cdc_ncm_ctx *ctx = info->ctx; | |
9bf211a3 GS |
415 | int len; |
416 | int nframes; | |
417 | int x; | |
418 | int offset; | |
419 | struct usb_cdc_ncm_ndp16 *ndp16; | |
420 | struct usb_cdc_ncm_dpe16 *dpe16; | |
421 | int ndpoffset; | |
422 | int loopcount = 50; /* arbitrary max preventing infinite loop */ | |
beeecd42 | 423 | u32 payload = 0; |
a82c7ce5 BM |
424 | u8 *c; |
425 | u16 tci; | |
9bf211a3 GS |
426 | |
427 | ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in); | |
428 | if (ndpoffset < 0) | |
429 | goto error; | |
430 | ||
431 | next_ndp: | |
432 | nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset); | |
433 | if (nframes < 0) | |
434 | goto error; | |
435 | ||
436 | ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset); | |
437 | ||
a82c7ce5 | 438 | switch (ndp16->dwSignature & cpu_to_le32(0x00ffffff)) { |
9bf211a3 | 439 | case cpu_to_le32(USB_CDC_MBIM_NDP16_IPS_SIGN): |
a82c7ce5 BM |
440 | c = (u8 *)&ndp16->dwSignature; |
441 | tci = c[3]; | |
146a08d2 BM |
442 | /* tag IPS<0> packets too if MBIM_IPS0_VID exists */ |
443 | if (!tci && info->flags & FLAG_IPS0_VLAN) | |
444 | tci = MBIM_IPS0_VID; | |
9bf211a3 | 445 | break; |
9f651cac BM |
446 | case cpu_to_le32(USB_CDC_MBIM_NDP16_DSS_SIGN): |
447 | c = (u8 *)&ndp16->dwSignature; | |
448 | tci = c[3] + 256; | |
449 | break; | |
9bf211a3 GS |
450 | default: |
451 | netif_dbg(dev, rx_err, dev->net, | |
452 | "unsupported NDP signature <0x%08x>\n", | |
453 | le32_to_cpu(ndp16->dwSignature)); | |
454 | goto err_ndp; | |
455 | ||
456 | } | |
457 | ||
458 | dpe16 = ndp16->dpe16; | |
459 | for (x = 0; x < nframes; x++, dpe16++) { | |
460 | offset = le16_to_cpu(dpe16->wDatagramIndex); | |
461 | len = le16_to_cpu(dpe16->wDatagramLength); | |
462 | ||
463 | /* | |
464 | * CDC NCM ch. 3.7 | |
465 | * All entries after first NULL entry are to be ignored | |
466 | */ | |
467 | if ((offset == 0) || (len == 0)) { | |
468 | if (!x) | |
469 | goto err_ndp; /* empty NTB */ | |
470 | break; | |
471 | } | |
472 | ||
473 | /* sanity checking */ | |
a82c7ce5 | 474 | if (((offset + len) > skb_in->len) || (len > ctx->rx_max)) { |
9bf211a3 GS |
475 | netif_dbg(dev, rx_err, dev->net, |
476 | "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n", | |
477 | x, offset, len, skb_in); | |
478 | if (!x) | |
479 | goto err_ndp; | |
480 | break; | |
481 | } else { | |
a82c7ce5 | 482 | skb = cdc_mbim_process_dgram(dev, skb_in->data + offset, len, tci); |
9bf211a3 GS |
483 | if (!skb) |
484 | goto error; | |
485 | usbnet_skb_return(dev, skb); | |
beeecd42 | 486 | payload += len; /* count payload bytes in this NTB */ |
9bf211a3 GS |
487 | } |
488 | } | |
489 | err_ndp: | |
490 | /* are there more NDPs to process? */ | |
491 | ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex); | |
492 | if (ndpoffset && loopcount--) | |
493 | goto next_ndp; | |
494 | ||
beeecd42 BM |
495 | /* update stats */ |
496 | ctx->rx_overhead += skb_in->len - payload; | |
497 | ctx->rx_ntbs++; | |
498 | ||
9bf211a3 GS |
499 | return 1; |
500 | error: | |
501 | return 0; | |
502 | } | |
503 | ||
504 | static int cdc_mbim_suspend(struct usb_interface *intf, pm_message_t message) | |
505 | { | |
e62416e8 | 506 | int ret = -ENODEV; |
9bf211a3 GS |
507 | struct usbnet *dev = usb_get_intfdata(intf); |
508 | struct cdc_mbim_state *info = (void *)&dev->data; | |
509 | struct cdc_ncm_ctx *ctx = info->ctx; | |
510 | ||
e62416e8 | 511 | if (!ctx) |
9bf211a3 | 512 | goto error; |
9bf211a3 | 513 | |
9a44312a ML |
514 | /* |
515 | * Both usbnet_suspend() and subdriver->suspend() MUST return 0 | |
516 | * in system sleep context, otherwise, the resume callback has | |
517 | * to recover device from previous suspend failure. | |
518 | */ | |
9bf211a3 GS |
519 | ret = usbnet_suspend(intf, message); |
520 | if (ret < 0) | |
521 | goto error; | |
522 | ||
523 | if (intf == ctx->control && info->subdriver && info->subdriver->suspend) | |
524 | ret = info->subdriver->suspend(intf, message); | |
525 | if (ret < 0) | |
526 | usbnet_resume(intf); | |
527 | ||
528 | error: | |
529 | return ret; | |
530 | } | |
531 | ||
532 | static int cdc_mbim_resume(struct usb_interface *intf) | |
533 | { | |
534 | int ret = 0; | |
535 | struct usbnet *dev = usb_get_intfdata(intf); | |
536 | struct cdc_mbim_state *info = (void *)&dev->data; | |
537 | struct cdc_ncm_ctx *ctx = info->ctx; | |
538 | bool callsub = (intf == ctx->control && info->subdriver && info->subdriver->resume); | |
539 | ||
540 | if (callsub) | |
541 | ret = info->subdriver->resume(intf); | |
542 | if (ret < 0) | |
543 | goto err; | |
544 | ret = usbnet_resume(intf); | |
c37ac9b2 | 545 | if (ret < 0 && callsub) |
9bf211a3 GS |
546 | info->subdriver->suspend(intf, PMSG_SUSPEND); |
547 | err: | |
548 | return ret; | |
549 | } | |
550 | ||
551 | static const struct driver_info cdc_mbim_info = { | |
844e88f0 BM |
552 | .description = "CDC MBIM", |
553 | .flags = FLAG_NO_SETINT | FLAG_MULTI_PACKET | FLAG_WWAN, | |
554 | .bind = cdc_mbim_bind, | |
555 | .unbind = cdc_mbim_unbind, | |
556 | .manage_power = cdc_mbim_manage_power, | |
557 | .rx_fixup = cdc_mbim_rx_fixup, | |
558 | .tx_fixup = cdc_mbim_tx_fixup, | |
559 | }; | |
560 | ||
561 | /* MBIM and NCM devices should not need a ZLP after NTBs with | |
c1a2e954 BM |
562 | * dwNtbOutMaxSize length. Nevertheless, a number of devices from |
563 | * different vendor IDs will fail unless we send ZLPs, forcing us | |
564 | * to make this the default. | |
565 | * | |
566 | * This default may cause a performance penalty for spec conforming | |
567 | * devices wanting to take advantage of optimizations possible without | |
568 | * ZLPs. A whitelist is added in an attempt to avoid this for devices | |
569 | * known to conform to the MBIM specification. | |
570 | * | |
571 | * All known devices supporting NCM compatibility mode are also | |
572 | * conforming to the NCM and MBIM specifications. For this reason, the | |
573 | * NCM subclass entry is also in the ZLP whitelist. | |
844e88f0 BM |
574 | */ |
575 | static const struct driver_info cdc_mbim_info_zlp = { | |
9bf211a3 | 576 | .description = "CDC MBIM", |
328d7b8a | 577 | .flags = FLAG_NO_SETINT | FLAG_MULTI_PACKET | FLAG_WWAN | FLAG_SEND_ZLP, |
9bf211a3 GS |
578 | .bind = cdc_mbim_bind, |
579 | .unbind = cdc_mbim_unbind, | |
580 | .manage_power = cdc_mbim_manage_power, | |
581 | .rx_fixup = cdc_mbim_rx_fixup, | |
582 | .tx_fixup = cdc_mbim_tx_fixup, | |
583 | }; | |
584 | ||
f8c0cfa5 BM |
585 | /* The spefication explicitly allows NDPs to be placed anywhere in the |
586 | * frame, but some devices fail unless the NDP is placed after the IP | |
587 | * packets. Using the CDC_NCM_FLAG_NDP_TO_END flags to force this | |
588 | * behaviour. | |
589 | * | |
590 | * Note: The current implementation of this feature restricts each NTB | |
591 | * to a single NDP, implying that multiplexed sessions cannot share an | |
592 | * NTB. This might affect performace for multiplexed sessions. | |
593 | */ | |
594 | static const struct driver_info cdc_mbim_info_ndp_to_end = { | |
595 | .description = "CDC MBIM", | |
596 | .flags = FLAG_NO_SETINT | FLAG_MULTI_PACKET | FLAG_WWAN, | |
597 | .bind = cdc_mbim_bind, | |
598 | .unbind = cdc_mbim_unbind, | |
599 | .manage_power = cdc_mbim_manage_power, | |
600 | .rx_fixup = cdc_mbim_rx_fixup, | |
601 | .tx_fixup = cdc_mbim_tx_fixup, | |
602 | .data = CDC_NCM_FLAG_NDP_TO_END, | |
603 | }; | |
604 | ||
9bf211a3 GS |
605 | static const struct usb_device_id mbim_devs[] = { |
606 | /* This duplicate NCM entry is intentional. MBIM devices can | |
607 | * be disguised as NCM by default, and this is necessary to | |
608 | * allow us to bind the correct driver_info to such devices. | |
609 | * | |
610 | * bind() will sort out this for us, selecting the correct | |
611 | * entry and reject the other | |
612 | */ | |
613 | { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE), | |
614 | .driver_info = (unsigned long)&cdc_mbim_info, | |
615 | }, | |
c1a2e954 BM |
616 | /* ZLP conformance whitelist: All Ericsson MBIM devices */ |
617 | { USB_VENDOR_AND_INTERFACE_INFO(0x0bdb, USB_CLASS_COMM, USB_CDC_SUBCLASS_MBIM, USB_CDC_PROTO_NONE), | |
618 | .driver_info = (unsigned long)&cdc_mbim_info, | |
03803a59 | 619 | }, |
c5b5343c BM |
620 | |
621 | /* Some Huawei devices, ME906s-158 (12d1:15c1) and E3372 | |
622 | * (12d1:157d), are known to fail unless the NDP is placed | |
623 | * after the IP packets. Applying the quirk to all Huawei | |
624 | * devices is broader than necessary, but harmless. | |
625 | */ | |
626 | { USB_VENDOR_AND_INTERFACE_INFO(0x12d1, USB_CLASS_COMM, USB_CDC_SUBCLASS_MBIM, USB_CDC_PROTO_NONE), | |
f8c0cfa5 BM |
627 | .driver_info = (unsigned long)&cdc_mbim_info_ndp_to_end, |
628 | }, | |
c1a2e954 | 629 | /* default entry */ |
9bf211a3 | 630 | { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_MBIM, USB_CDC_PROTO_NONE), |
c1a2e954 | 631 | .driver_info = (unsigned long)&cdc_mbim_info_zlp, |
9bf211a3 GS |
632 | }, |
633 | { | |
634 | }, | |
635 | }; | |
636 | MODULE_DEVICE_TABLE(usb, mbim_devs); | |
637 | ||
638 | static struct usb_driver cdc_mbim_driver = { | |
639 | .name = "cdc_mbim", | |
640 | .id_table = mbim_devs, | |
641 | .probe = usbnet_probe, | |
642 | .disconnect = usbnet_disconnect, | |
643 | .suspend = cdc_mbim_suspend, | |
644 | .resume = cdc_mbim_resume, | |
645 | .reset_resume = cdc_mbim_resume, | |
646 | .supports_autosuspend = 1, | |
647 | .disable_hub_initiated_lpm = 1, | |
648 | }; | |
649 | module_usb_driver(cdc_mbim_driver); | |
650 | ||
651 | MODULE_AUTHOR("Greg Suarez <gsuarez@smithmicro.com>"); | |
652 | MODULE_AUTHOR("Bjørn Mork <bjorn@mork.no>"); | |
653 | MODULE_DESCRIPTION("USB CDC MBIM host driver"); | |
654 | MODULE_LICENSE("GPL"); |