blob: feb61eaffe3273821c9a6b1db23c349ef89a7c70 [file] [log] [blame]
Alexey Orishko900d4952010-11-29 23:23:28 +00001/*
2 * cdc_ncm.c
3 *
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00004 * Copyright (C) ST-Ericsson 2010-2012
Alexey Orishko900d4952010-11-29 23:23:28 +00005 * Contact: Alexey Orishko <alexey.orishko@stericsson.com>
6 * Original author: Hans Petter Selasky <hans.petter.selasky@stericsson.com>
7 *
8 * USB Host Driver for Network Control Model (NCM)
Enrico Mioso22401ff2015-07-11 17:30:01 +02009 * http://www.usb.org/developers/docs/devclass_docs/NCM10_012011.zip
Alexey Orishko900d4952010-11-29 23:23:28 +000010 *
11 * The NCM encoding, decoding and initialization logic
12 * derives from FreeBSD 8.x. if_cdce.c and if_cdcereg.h
13 *
14 * This software is available to you under a choice of one of two
15 * licenses. You may choose this file to be licensed under the terms
16 * of the GNU General Public License (GPL) Version 2 or the 2-clause
17 * BSD license listed below:
18 *
19 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions
21 * are met:
22 * 1. Redistributions of source code must retain the above copyright
23 * notice, this list of conditions and the following disclaimer.
24 * 2. Redistributions in binary form must reproduce the above copyright
25 * notice, this list of conditions and the following disclaimer in the
26 * documentation and/or other materials provided with the distribution.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
29 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
32 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 * SUCH DAMAGE.
39 */
40
41#include <linux/module.h>
Alexey Orishko900d4952010-11-29 23:23:28 +000042#include <linux/netdevice.h>
43#include <linux/ctype.h>
Bjørn Mork1dfddff52015-12-23 13:42:43 +010044#include <linux/etherdevice.h>
Alexey Orishko900d4952010-11-29 23:23:28 +000045#include <linux/ethtool.h>
46#include <linux/workqueue.h>
47#include <linux/mii.h>
48#include <linux/crc32.h>
49#include <linux/usb.h>
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +000050#include <linux/hrtimer.h>
Alexey Orishko900d4952010-11-29 23:23:28 +000051#include <linux/atomic.h>
52#include <linux/usb/usbnet.h>
53#include <linux/usb/cdc.h>
Bjørn Morkc91ce3b2012-10-22 10:56:35 +000054#include <linux/usb/cdc_ncm.h>
Alexey Orishko900d4952010-11-29 23:23:28 +000055
Bjørn Mork1e8bbe62013-03-14 01:05:13 +000056#if IS_ENABLED(CONFIG_USB_NET_CDC_MBIM)
57static bool prefer_mbim = true;
58#else
59static bool prefer_mbim;
60#endif
61module_param(prefer_mbim, bool, S_IRUGO | S_IWUSR);
62MODULE_PARM_DESC(prefer_mbim, "Prefer MBIM setting on dual NCM/MBIM functions");
63
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +000064static void cdc_ncm_txpath_bh(unsigned long param);
65static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx);
66static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *hr_timer);
Alexey Orishko900d4952010-11-29 23:23:28 +000067static struct usb_driver cdc_ncm_driver;
Alexey Orishko900d4952010-11-29 23:23:28 +000068
Bjørn Morkbeeecd42014-05-16 21:48:25 +020069struct cdc_ncm_stats {
70 char stat_string[ETH_GSTRING_LEN];
71 int sizeof_stat;
72 int stat_offset;
73};
74
75#define CDC_NCM_STAT(str, m) { \
76 .stat_string = str, \
77 .sizeof_stat = sizeof(((struct cdc_ncm_ctx *)0)->m), \
78 .stat_offset = offsetof(struct cdc_ncm_ctx, m) }
79#define CDC_NCM_SIMPLE_STAT(m) CDC_NCM_STAT(__stringify(m), m)
80
81static const struct cdc_ncm_stats cdc_ncm_gstrings_stats[] = {
82 CDC_NCM_SIMPLE_STAT(tx_reason_ntb_full),
83 CDC_NCM_SIMPLE_STAT(tx_reason_ndp_full),
84 CDC_NCM_SIMPLE_STAT(tx_reason_timeout),
85 CDC_NCM_SIMPLE_STAT(tx_reason_max_datagram),
86 CDC_NCM_SIMPLE_STAT(tx_overhead),
87 CDC_NCM_SIMPLE_STAT(tx_ntbs),
88 CDC_NCM_SIMPLE_STAT(rx_overhead),
89 CDC_NCM_SIMPLE_STAT(rx_ntbs),
90};
91
92static int cdc_ncm_get_sset_count(struct net_device __always_unused *netdev, int sset)
93{
94 switch (sset) {
95 case ETH_SS_STATS:
96 return ARRAY_SIZE(cdc_ncm_gstrings_stats);
97 default:
98 return -EOPNOTSUPP;
99 }
100}
101
102static void cdc_ncm_get_ethtool_stats(struct net_device *netdev,
103 struct ethtool_stats __always_unused *stats,
104 u64 *data)
105{
106 struct usbnet *dev = netdev_priv(netdev);
107 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
108 int i;
109 char *p = NULL;
110
111 for (i = 0; i < ARRAY_SIZE(cdc_ncm_gstrings_stats); i++) {
112 p = (char *)ctx + cdc_ncm_gstrings_stats[i].stat_offset;
113 data[i] = (cdc_ncm_gstrings_stats[i].sizeof_stat == sizeof(u64)) ? *(u64 *)p : *(u32 *)p;
114 }
115}
116
117static void cdc_ncm_get_strings(struct net_device __always_unused *netdev, u32 stringset, u8 *data)
118{
119 u8 *p = data;
120 int i;
121
122 switch (stringset) {
123 case ETH_SS_STATS:
124 for (i = 0; i < ARRAY_SIZE(cdc_ncm_gstrings_stats); i++) {
125 memcpy(p, cdc_ncm_gstrings_stats[i].stat_string, ETH_GSTRING_LEN);
126 p += ETH_GSTRING_LEN;
127 }
128 }
129}
130
Bjørn Mork6c4e5482014-05-16 21:48:22 +0200131static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx);
132
Bjørn Mork6c4e5482014-05-16 21:48:22 +0200133static const struct ethtool_ops cdc_ncm_ethtool_ops = {
134 .get_settings = usbnet_get_settings,
135 .set_settings = usbnet_set_settings,
136 .get_link = usbnet_get_link,
137 .nway_reset = usbnet_nway_reset,
138 .get_drvinfo = usbnet_get_drvinfo,
139 .get_msglevel = usbnet_get_msglevel,
140 .set_msglevel = usbnet_set_msglevel,
141 .get_ts_info = ethtool_op_get_ts_info,
Bjørn Morkbeeecd42014-05-16 21:48:25 +0200142 .get_sset_count = cdc_ncm_get_sset_count,
143 .get_strings = cdc_ncm_get_strings,
144 .get_ethtool_stats = cdc_ncm_get_ethtool_stats,
Bjørn Mork6c4e5482014-05-16 21:48:22 +0200145};
146
Bjørn Mork289507d2014-05-30 09:31:06 +0200147static u32 cdc_ncm_check_rx_max(struct usbnet *dev, u32 new_rx)
Bjørn Mork5aa73d52014-05-16 21:48:18 +0200148{
149 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
Bjørn Mork5aa73d52014-05-16 21:48:18 +0200150 u32 val, max, min;
151
152 /* clamp new_rx to sane values */
153 min = USB_CDC_NCM_NTB_MIN_IN_SIZE;
154 max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_RX, le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
155
156 /* dwNtbInMaxSize spec violation? Use MIN size for both limits */
157 if (max < min) {
158 dev_warn(&dev->intf->dev, "dwNtbInMaxSize=%u is too small. Using %u\n",
159 le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize), min);
160 max = min;
161 }
162
163 val = clamp_t(u32, new_rx, min, max);
Bjørn Mork289507d2014-05-30 09:31:06 +0200164 if (val != new_rx)
165 dev_dbg(&dev->intf->dev, "rx_max must be in the [%u, %u] range\n", min, max);
166
167 return val;
168}
169
170static u32 cdc_ncm_check_tx_max(struct usbnet *dev, u32 new_tx)
171{
172 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
173 u32 val, max, min;
174
175 /* clamp new_tx to sane values */
176 min = ctx->max_datagram_size + ctx->max_ndp_size + sizeof(struct usb_cdc_ncm_nth16);
177 max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_TX, le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
178
179 /* some devices set dwNtbOutMaxSize too low for the above default */
180 min = min(min, max);
181
182 val = clamp_t(u32, new_tx, min, max);
183 if (val != new_tx)
184 dev_dbg(&dev->intf->dev, "tx_max must be in the [%u, %u] range\n", min, max);
185
186 return val;
187}
188
Bjørn Mork39eb7e02014-05-30 09:31:09 +0200189static ssize_t cdc_ncm_show_min_tx_pkt(struct device *d, struct device_attribute *attr, char *buf)
190{
191 struct usbnet *dev = netdev_priv(to_net_dev(d));
192 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
193
194 return sprintf(buf, "%u\n", ctx->min_tx_pkt);
195}
196
Bjørn Mork289507d2014-05-30 09:31:06 +0200197static ssize_t cdc_ncm_show_rx_max(struct device *d, struct device_attribute *attr, char *buf)
198{
199 struct usbnet *dev = netdev_priv(to_net_dev(d));
200 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
201
202 return sprintf(buf, "%u\n", ctx->rx_max);
203}
204
205static ssize_t cdc_ncm_show_tx_max(struct device *d, struct device_attribute *attr, char *buf)
206{
207 struct usbnet *dev = netdev_priv(to_net_dev(d));
208 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
209
210 return sprintf(buf, "%u\n", ctx->tx_max);
211}
212
213static ssize_t cdc_ncm_show_tx_timer_usecs(struct device *d, struct device_attribute *attr, char *buf)
214{
215 struct usbnet *dev = netdev_priv(to_net_dev(d));
216 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
217
218 return sprintf(buf, "%u\n", ctx->timer_interval / (u32)NSEC_PER_USEC);
219}
220
Bjørn Mork39eb7e02014-05-30 09:31:09 +0200221static ssize_t cdc_ncm_store_min_tx_pkt(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
222{
223 struct usbnet *dev = netdev_priv(to_net_dev(d));
224 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
225 unsigned long val;
226
227 /* no need to restrict values - anything from 0 to infinity is OK */
228 if (kstrtoul(buf, 0, &val))
229 return -EINVAL;
230
231 ctx->min_tx_pkt = val;
232 return len;
233}
234
Bjørn Mork289507d2014-05-30 09:31:06 +0200235static ssize_t cdc_ncm_store_rx_max(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
236{
237 struct usbnet *dev = netdev_priv(to_net_dev(d));
238 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
239 unsigned long val;
240
241 if (kstrtoul(buf, 0, &val) || cdc_ncm_check_rx_max(dev, val) != val)
242 return -EINVAL;
243
244 cdc_ncm_update_rxtx_max(dev, val, ctx->tx_max);
245 return len;
246}
247
248static ssize_t cdc_ncm_store_tx_max(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
249{
250 struct usbnet *dev = netdev_priv(to_net_dev(d));
251 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
252 unsigned long val;
253
254 if (kstrtoul(buf, 0, &val) || cdc_ncm_check_tx_max(dev, val) != val)
255 return -EINVAL;
256
257 cdc_ncm_update_rxtx_max(dev, ctx->rx_max, val);
258 return len;
259}
260
261static ssize_t cdc_ncm_store_tx_timer_usecs(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
262{
263 struct usbnet *dev = netdev_priv(to_net_dev(d));
264 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
265 ssize_t ret;
266 unsigned long val;
267
268 ret = kstrtoul(buf, 0, &val);
269 if (ret)
270 return ret;
271 if (val && (val < CDC_NCM_TIMER_INTERVAL_MIN || val > CDC_NCM_TIMER_INTERVAL_MAX))
272 return -EINVAL;
273
274 spin_lock_bh(&ctx->mtx);
275 ctx->timer_interval = val * NSEC_PER_USEC;
276 if (!ctx->timer_interval)
277 ctx->tx_timer_pending = 0;
278 spin_unlock_bh(&ctx->mtx);
279 return len;
280}
281
Bjørn Mork39eb7e02014-05-30 09:31:09 +0200282static DEVICE_ATTR(min_tx_pkt, S_IRUGO | S_IWUSR, cdc_ncm_show_min_tx_pkt, cdc_ncm_store_min_tx_pkt);
Bjørn Mork289507d2014-05-30 09:31:06 +0200283static DEVICE_ATTR(rx_max, S_IRUGO | S_IWUSR, cdc_ncm_show_rx_max, cdc_ncm_store_rx_max);
284static DEVICE_ATTR(tx_max, S_IRUGO | S_IWUSR, cdc_ncm_show_tx_max, cdc_ncm_store_tx_max);
285static DEVICE_ATTR(tx_timer_usecs, S_IRUGO | S_IWUSR, cdc_ncm_show_tx_timer_usecs, cdc_ncm_store_tx_timer_usecs);
286
Bjørn Mork404814a2015-12-06 22:47:15 +0100287static ssize_t ndp_to_end_show(struct device *d, struct device_attribute *attr, char *buf)
288{
289 struct usbnet *dev = netdev_priv(to_net_dev(d));
290 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
291
292 return sprintf(buf, "%c\n", ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END ? 'Y' : 'N');
293}
294
295static ssize_t ndp_to_end_store(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
296{
297 struct usbnet *dev = netdev_priv(to_net_dev(d));
298 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
299 bool enable;
300
301 if (strtobool(buf, &enable))
302 return -EINVAL;
303
304 /* no change? */
305 if (enable == (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
306 return len;
307
308 if (enable && !ctx->delayed_ndp16) {
309 ctx->delayed_ndp16 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
310 if (!ctx->delayed_ndp16)
311 return -ENOMEM;
312 }
313
314 /* flush pending data before changing flag */
315 netif_tx_lock_bh(dev->net);
316 usbnet_start_xmit(NULL, dev->net);
317 spin_lock_bh(&ctx->mtx);
318 if (enable)
319 ctx->drvflags |= CDC_NCM_FLAG_NDP_TO_END;
320 else
321 ctx->drvflags &= ~CDC_NCM_FLAG_NDP_TO_END;
322 spin_unlock_bh(&ctx->mtx);
323 netif_tx_unlock_bh(dev->net);
324
325 return len;
326}
327static DEVICE_ATTR_RW(ndp_to_end);
328
Bjørn Mork871578c2014-05-30 09:31:08 +0200329#define NCM_PARM_ATTR(name, format, tocpu) \
330static ssize_t cdc_ncm_show_##name(struct device *d, struct device_attribute *attr, char *buf) \
331{ \
332 struct usbnet *dev = netdev_priv(to_net_dev(d)); \
333 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0]; \
334 return sprintf(buf, format "\n", tocpu(ctx->ncm_parm.name)); \
335} \
336static DEVICE_ATTR(name, S_IRUGO, cdc_ncm_show_##name, NULL)
337
338NCM_PARM_ATTR(bmNtbFormatsSupported, "0x%04x", le16_to_cpu);
339NCM_PARM_ATTR(dwNtbInMaxSize, "%u", le32_to_cpu);
340NCM_PARM_ATTR(wNdpInDivisor, "%u", le16_to_cpu);
341NCM_PARM_ATTR(wNdpInPayloadRemainder, "%u", le16_to_cpu);
342NCM_PARM_ATTR(wNdpInAlignment, "%u", le16_to_cpu);
343NCM_PARM_ATTR(dwNtbOutMaxSize, "%u", le32_to_cpu);
344NCM_PARM_ATTR(wNdpOutDivisor, "%u", le16_to_cpu);
345NCM_PARM_ATTR(wNdpOutPayloadRemainder, "%u", le16_to_cpu);
346NCM_PARM_ATTR(wNdpOutAlignment, "%u", le16_to_cpu);
347NCM_PARM_ATTR(wNtbOutMaxDatagrams, "%u", le16_to_cpu);
348
Bjørn Mork289507d2014-05-30 09:31:06 +0200349static struct attribute *cdc_ncm_sysfs_attrs[] = {
Bjørn Mork39eb7e02014-05-30 09:31:09 +0200350 &dev_attr_min_tx_pkt.attr,
Bjørn Mork404814a2015-12-06 22:47:15 +0100351 &dev_attr_ndp_to_end.attr,
Bjørn Mork289507d2014-05-30 09:31:06 +0200352 &dev_attr_rx_max.attr,
353 &dev_attr_tx_max.attr,
354 &dev_attr_tx_timer_usecs.attr,
Bjørn Mork871578c2014-05-30 09:31:08 +0200355 &dev_attr_bmNtbFormatsSupported.attr,
356 &dev_attr_dwNtbInMaxSize.attr,
357 &dev_attr_wNdpInDivisor.attr,
358 &dev_attr_wNdpInPayloadRemainder.attr,
359 &dev_attr_wNdpInAlignment.attr,
360 &dev_attr_dwNtbOutMaxSize.attr,
361 &dev_attr_wNdpOutDivisor.attr,
362 &dev_attr_wNdpOutPayloadRemainder.attr,
363 &dev_attr_wNdpOutAlignment.attr,
364 &dev_attr_wNtbOutMaxDatagrams.attr,
Bjørn Mork289507d2014-05-30 09:31:06 +0200365 NULL,
366};
367
368static struct attribute_group cdc_ncm_sysfs_attr_group = {
369 .name = "cdc_ncm",
370 .attrs = cdc_ncm_sysfs_attrs,
371};
372
373/* handle rx_max and tx_max changes */
374static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx)
375{
376 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
377 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
378 u32 val;
379
380 val = cdc_ncm_check_rx_max(dev, new_rx);
Bjørn Mork5aa73d52014-05-16 21:48:18 +0200381
382 /* inform device about NTB input size changes */
383 if (val != ctx->rx_max) {
384 __le32 dwNtbInMaxSize = cpu_to_le32(val);
385
386 dev_info(&dev->intf->dev, "setting rx_max = %u\n", val);
Bjørn Mork68864ab2014-05-16 21:48:21 +0200387
Bjørn Mork68864ab2014-05-16 21:48:21 +0200388 /* tell device to use new size */
Bjørn Mork5aa73d52014-05-16 21:48:18 +0200389 if (usbnet_write_cmd(dev, USB_CDC_SET_NTB_INPUT_SIZE,
390 USB_TYPE_CLASS | USB_DIR_OUT
391 | USB_RECIP_INTERFACE,
392 0, iface_no, &dwNtbInMaxSize, 4) < 0)
393 dev_dbg(&dev->intf->dev, "Setting NTB Input Size failed\n");
394 else
395 ctx->rx_max = val;
396 }
397
Bjørn Morkf42763d2014-05-30 09:31:05 +0200398 /* usbnet use these values for sizing rx queues */
399 if (dev->rx_urb_size != ctx->rx_max) {
400 dev->rx_urb_size = ctx->rx_max;
401 if (netif_running(dev->net))
402 usbnet_unlink_rx_urbs(dev);
403 }
404
Bjørn Mork289507d2014-05-30 09:31:06 +0200405 val = cdc_ncm_check_tx_max(dev, new_tx);
Bjørn Mork5aa73d52014-05-16 21:48:18 +0200406 if (val != ctx->tx_max)
407 dev_info(&dev->intf->dev, "setting tx_max = %u\n", val);
Bjørn Mork08c74fc2014-05-16 21:48:20 +0200408
409 /* Adding a pad byte here if necessary simplifies the handling
410 * in cdc_ncm_fill_tx_frame, making tx_max always represent
411 * the real skb max size.
412 *
413 * We cannot use dev->maxpacket here because this is called from
414 * .bind which is called before usbnet sets up dev->maxpacket
415 */
Bjørn Mork68864ab2014-05-16 21:48:21 +0200416 if (val != le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize) &&
417 val % usb_maxpacket(dev->udev, dev->out, 1) == 0)
418 val++;
Bjørn Mork08c74fc2014-05-16 21:48:20 +0200419
Bjørn Mork68864ab2014-05-16 21:48:21 +0200420 /* we might need to flush any pending tx buffers if running */
421 if (netif_running(dev->net) && val > ctx->tx_max) {
422 netif_tx_lock_bh(dev->net);
423 usbnet_start_xmit(NULL, dev->net);
Bjørn Mork1ba5d0f2014-05-30 09:31:04 +0200424 /* make sure tx_curr_skb is reallocated if it was empty */
425 if (ctx->tx_curr_skb) {
426 dev_kfree_skb_any(ctx->tx_curr_skb);
427 ctx->tx_curr_skb = NULL;
428 }
Bjørn Mork68864ab2014-05-16 21:48:21 +0200429 ctx->tx_max = val;
430 netif_tx_unlock_bh(dev->net);
431 } else {
432 ctx->tx_max = val;
433 }
434
Bjørn Mork08c74fc2014-05-16 21:48:20 +0200435 dev->hard_mtu = ctx->tx_max;
Bjørn Mork68864ab2014-05-16 21:48:21 +0200436
437 /* max qlen depend on hard_mtu and rx_urb_size */
438 usbnet_update_max_qlen(dev);
Bjørn Mork43e4c6d2014-05-16 21:48:24 +0200439
440 /* never pad more than 3 full USB packets per transfer */
441 ctx->min_tx_pkt = clamp_t(u16, ctx->tx_max - 3 * usb_maxpacket(dev->udev, dev->out, 1),
442 CDC_NCM_MIN_TX_PKT, ctx->tx_max);
Bjørn Mork5aa73d52014-05-16 21:48:18 +0200443}
444
Bjørn Morkf8afb732014-05-16 21:48:19 +0200445/* helpers for NCM and MBIM differences */
446static u8 cdc_ncm_flags(struct usbnet *dev)
Alexey Orishko900d4952010-11-29 23:23:28 +0000447{
Bjørn Morkbed6f762013-11-01 11:16:42 +0100448 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
Alexey Orishko900d4952010-11-29 23:23:28 +0000449
Bjørn Morkf8afb732014-05-16 21:48:19 +0200450 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
451 return ctx->mbim_desc->bmNetworkCapabilities;
452 if (ctx->func_desc)
453 return ctx->func_desc->bmNetworkCapabilities;
454 return 0;
455}
456
457static int cdc_ncm_eth_hlen(struct usbnet *dev)
458{
459 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
460 return 0;
461 return ETH_HLEN;
462}
463
464static u32 cdc_ncm_min_dgram_size(struct usbnet *dev)
465{
466 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
467 return CDC_MBIM_MIN_DATAGRAM_SIZE;
468 return CDC_NCM_MIN_DATAGRAM_SIZE;
469}
470
471static u32 cdc_ncm_max_dgram_size(struct usbnet *dev)
472{
473 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
474
475 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
476 return le16_to_cpu(ctx->mbim_desc->wMaxSegmentSize);
477 if (ctx->ether_desc)
478 return le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
479 return CDC_NCM_MAX_DATAGRAM_SIZE;
480}
481
482/* initial one-time device setup. MUST be called with the data interface
483 * in altsetting 0
484 */
485static int cdc_ncm_init(struct usbnet *dev)
486{
487 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
488 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
489 int err;
Alexey Orishko900d4952010-11-29 23:23:28 +0000490
Ming Lei90b8b032012-10-24 19:46:56 +0000491 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
492 USB_TYPE_CLASS | USB_DIR_IN
493 |USB_RECIP_INTERFACE,
Bjørn Morkff0992e92014-03-17 16:25:18 +0100494 0, iface_no, &ctx->ncm_parm,
495 sizeof(ctx->ncm_parm));
Giuseppe Scrivano36c35412011-08-03 22:10:29 +0000496 if (err < 0) {
Bjørn Mork59ede312013-11-01 11:16:59 +0100497 dev_err(&dev->intf->dev, "failed GET_NTB_PARAMETERS\n");
498 return err; /* GET_NTB_PARAMETERS is required */
Alexey Orishko900d4952010-11-29 23:23:28 +0000499 }
500
Bjørn Morkf8afb732014-05-16 21:48:19 +0200501 /* set CRC Mode */
502 if (cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_CRC_MODE) {
503 dev_dbg(&dev->intf->dev, "Setting CRC mode off\n");
504 err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
505 USB_TYPE_CLASS | USB_DIR_OUT
506 | USB_RECIP_INTERFACE,
507 USB_CDC_NCM_CRC_NOT_APPENDED,
508 iface_no, NULL, 0);
509 if (err < 0)
510 dev_err(&dev->intf->dev, "SET_CRC_MODE failed\n");
511 }
512
513 /* set NTB format, if both formats are supported.
514 *
515 * "The host shall only send this command while the NCM Data
516 * Interface is in alternate setting 0."
517 */
Dan Carpenterd22adbf2014-05-22 10:52:29 +0300518 if (le16_to_cpu(ctx->ncm_parm.bmNtbFormatsSupported) &
519 USB_CDC_NCM_NTB32_SUPPORTED) {
Bjørn Morkf8afb732014-05-16 21:48:19 +0200520 dev_dbg(&dev->intf->dev, "Setting NTB format to 16-bit\n");
521 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
522 USB_TYPE_CLASS | USB_DIR_OUT
523 | USB_RECIP_INTERFACE,
524 USB_CDC_NCM_NTB16_FORMAT,
525 iface_no, NULL, 0);
526 if (err < 0)
527 dev_err(&dev->intf->dev, "SET_NTB_FORMAT failed\n");
528 }
529
530 /* set initial device values */
Bjørn Morkff0992e92014-03-17 16:25:18 +0100531 ctx->rx_max = le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize);
532 ctx->tx_max = le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize);
533 ctx->tx_remainder = le16_to_cpu(ctx->ncm_parm.wNdpOutPayloadRemainder);
534 ctx->tx_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutDivisor);
535 ctx->tx_ndp_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutAlignment);
Alexey Orishko84e77a82011-02-07 09:45:10 +0000536 /* devices prior to NCM Errata shall set this field to zero */
Bjørn Morkff0992e92014-03-17 16:25:18 +0100537 ctx->tx_max_datagrams = le16_to_cpu(ctx->ncm_parm.wNtbOutMaxDatagrams);
Bjørn Mork47175e52013-11-01 11:16:58 +0100538
Bjørn Morkae223cd2013-11-01 11:16:54 +0100539 dev_dbg(&dev->intf->dev,
540 "dwNtbInMaxSize=%u dwNtbOutMaxSize=%u wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
541 ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
Bjørn Morkf8afb732014-05-16 21:48:19 +0200542 ctx->tx_ndp_modulus, ctx->tx_max_datagrams, cdc_ncm_flags(dev));
Alexey Orishko900d4952010-11-29 23:23:28 +0000543
Alexey Orishko84e77a82011-02-07 09:45:10 +0000544 /* max count of tx datagrams */
545 if ((ctx->tx_max_datagrams == 0) ||
546 (ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
547 ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
Alexey Orishko900d4952010-11-29 23:23:28 +0000548
Bjørn Mork70559b82014-05-16 21:48:23 +0200549 /* set up maximum NDP size */
550 ctx->max_ndp_size = sizeof(struct usb_cdc_ncm_ndp16) + (ctx->tx_max_datagrams + 1) * sizeof(struct usb_cdc_ncm_dpe16);
551
Bjørn Mork6c4e5482014-05-16 21:48:22 +0200552 /* initial coalescing timer interval */
553 ctx->timer_interval = CDC_NCM_TIMER_INTERVAL_USEC * NSEC_PER_USEC;
554
Bjørn Morkf8afb732014-05-16 21:48:19 +0200555 return 0;
556}
557
558/* set a new max datagram size */
559static void cdc_ncm_set_dgram_size(struct usbnet *dev, int new_size)
560{
561 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
562 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
563 __le16 max_datagram_size;
564 u16 mbim_mtu;
565 int err;
566
567 /* set default based on descriptors */
568 ctx->max_datagram_size = clamp_t(u32, new_size,
569 cdc_ncm_min_dgram_size(dev),
570 CDC_NCM_MAX_DATAGRAM_SIZE);
571
572 /* inform the device about the selected Max Datagram Size? */
573 if (!(cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE))
574 goto out;
575
576 /* read current mtu value from device */
577 err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
578 USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
579 0, iface_no, &max_datagram_size, 2);
580 if (err < 0) {
581 dev_dbg(&dev->intf->dev, "GET_MAX_DATAGRAM_SIZE failed\n");
582 goto out;
583 }
584
585 if (le16_to_cpu(max_datagram_size) == ctx->max_datagram_size)
586 goto out;
587
588 max_datagram_size = cpu_to_le16(ctx->max_datagram_size);
589 err = usbnet_write_cmd(dev, USB_CDC_SET_MAX_DATAGRAM_SIZE,
590 USB_TYPE_CLASS | USB_DIR_OUT | USB_RECIP_INTERFACE,
591 0, iface_no, &max_datagram_size, 2);
592 if (err < 0)
593 dev_dbg(&dev->intf->dev, "SET_MAX_DATAGRAM_SIZE failed\n");
594
595out:
596 /* set MTU to max supported by the device if necessary */
597 dev->net->mtu = min_t(int, dev->net->mtu, ctx->max_datagram_size - cdc_ncm_eth_hlen(dev));
598
599 /* do not exceed operater preferred MTU */
600 if (ctx->mbim_extended_desc) {
601 mbim_mtu = le16_to_cpu(ctx->mbim_extended_desc->wMTU);
602 if (mbim_mtu != 0 && mbim_mtu < dev->net->mtu)
603 dev->net->mtu = mbim_mtu;
604 }
605}
606
607static void cdc_ncm_fix_modulus(struct usbnet *dev)
608{
609 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
610 u32 val;
Alexey Orishko900d4952010-11-29 23:23:28 +0000611
612 /*
613 * verify that the structure alignment is:
614 * - power of two
615 * - not greater than the maximum transmit length
616 * - not less than four bytes
617 */
618 val = ctx->tx_ndp_modulus;
619
620 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
621 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
Bjørn Morkae223cd2013-11-01 11:16:54 +0100622 dev_dbg(&dev->intf->dev, "Using default alignment: 4 bytes\n");
Alexey Orishko900d4952010-11-29 23:23:28 +0000623 ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
624 }
625
626 /*
627 * verify that the payload alignment is:
628 * - power of two
629 * - not greater than the maximum transmit length
630 * - not less than four bytes
631 */
632 val = ctx->tx_modulus;
633
634 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
635 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
Bjørn Morkae223cd2013-11-01 11:16:54 +0100636 dev_dbg(&dev->intf->dev, "Using default transmit modulus: 4 bytes\n");
Alexey Orishko900d4952010-11-29 23:23:28 +0000637 ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
638 }
639
640 /* verify the payload remainder */
641 if (ctx->tx_remainder >= ctx->tx_modulus) {
Bjørn Morkae223cd2013-11-01 11:16:54 +0100642 dev_dbg(&dev->intf->dev, "Using default transmit remainder: 0 bytes\n");
Alexey Orishko900d4952010-11-29 23:23:28 +0000643 ctx->tx_remainder = 0;
644 }
645
646 /* adjust TX-remainder according to NCM specification. */
Bjørn Morkf8afb732014-05-16 21:48:19 +0200647 ctx->tx_remainder = ((ctx->tx_remainder - cdc_ncm_eth_hlen(dev)) &
Greg Suarez2d1c4312012-10-22 10:56:30 +0000648 (ctx->tx_modulus - 1));
Bjørn Morkf8afb732014-05-16 21:48:19 +0200649}
Alexey Orishko900d4952010-11-29 23:23:28 +0000650
Bjørn Morkf8afb732014-05-16 21:48:19 +0200651static int cdc_ncm_setup(struct usbnet *dev)
652{
653 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
Bjørn Mork50f1cb12014-05-16 21:48:26 +0200654 u32 def_rx, def_tx;
655
656 /* be conservative when selecting intial buffer size to
657 * increase the number of hosts this will work for
658 */
659 def_rx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_RX,
660 le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
661 def_tx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_TX,
662 le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
Alexey Orishko900d4952010-11-29 23:23:28 +0000663
Bjørn Morkf8afb732014-05-16 21:48:19 +0200664 /* clamp rx_max and tx_max and inform device */
Bjørn Mork50f1cb12014-05-16 21:48:26 +0200665 cdc_ncm_update_rxtx_max(dev, def_rx, def_tx);
Alexey Orishko84e77a82011-02-07 09:45:10 +0000666
Bjørn Morkf8afb732014-05-16 21:48:19 +0200667 /* sanitize the modulus and remainder values */
668 cdc_ncm_fix_modulus(dev);
Alexey Orishko900d4952010-11-29 23:23:28 +0000669
Bjørn Morkf8afb732014-05-16 21:48:19 +0200670 /* set max datagram size */
671 cdc_ncm_set_dgram_size(dev, cdc_ncm_max_dgram_size(dev));
Alexey Orishko900d4952010-11-29 23:23:28 +0000672 return 0;
673}
674
675static void
Bjørn Morkff1632a2013-11-01 11:16:41 +0100676cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
Alexey Orishko900d4952010-11-29 23:23:28 +0000677{
Bjørn Morkff1632a2013-11-01 11:16:41 +0100678 struct usb_host_endpoint *e, *in = NULL, *out = NULL;
Alexey Orishko900d4952010-11-29 23:23:28 +0000679 u8 ep;
680
681 for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {
682
683 e = intf->cur_altsetting->endpoint + ep;
684 switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
685 case USB_ENDPOINT_XFER_INT:
686 if (usb_endpoint_dir_in(&e->desc)) {
Bjørn Morkff1632a2013-11-01 11:16:41 +0100687 if (!dev->status)
688 dev->status = e;
Alexey Orishko900d4952010-11-29 23:23:28 +0000689 }
690 break;
691
692 case USB_ENDPOINT_XFER_BULK:
693 if (usb_endpoint_dir_in(&e->desc)) {
Bjørn Morkff1632a2013-11-01 11:16:41 +0100694 if (!in)
695 in = e;
Alexey Orishko900d4952010-11-29 23:23:28 +0000696 } else {
Bjørn Morkff1632a2013-11-01 11:16:41 +0100697 if (!out)
698 out = e;
Alexey Orishko900d4952010-11-29 23:23:28 +0000699 }
700 break;
701
702 default:
703 break;
704 }
705 }
Bjørn Morkff1632a2013-11-01 11:16:41 +0100706 if (in && !dev->in)
707 dev->in = usb_rcvbulkpipe(dev->udev,
708 in->desc.bEndpointAddress &
709 USB_ENDPOINT_NUMBER_MASK);
710 if (out && !dev->out)
711 dev->out = usb_sndbulkpipe(dev->udev,
712 out->desc.bEndpointAddress &
713 USB_ENDPOINT_NUMBER_MASK);
Alexey Orishko900d4952010-11-29 23:23:28 +0000714}
715
716static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
717{
718 if (ctx == NULL)
719 return;
720
Alexey Orishko900d4952010-11-29 23:23:28 +0000721 if (ctx->tx_rem_skb != NULL) {
722 dev_kfree_skb_any(ctx->tx_rem_skb);
723 ctx->tx_rem_skb = NULL;
724 }
725
726 if (ctx->tx_curr_skb != NULL) {
727 dev_kfree_skb_any(ctx->tx_curr_skb);
728 ctx->tx_curr_skb = NULL;
729 }
730
Enrico Mioso4a0e3e92015-07-08 13:05:57 +0200731 kfree(ctx->delayed_ndp16);
732
Alexey Orishko900d4952010-11-29 23:23:28 +0000733 kfree(ctx);
734}
735
Bjørn Mork1dfddff52015-12-23 13:42:43 +0100736/* we need to override the usbnet change_mtu ndo for two reasons:
737 * - respect the negotiated maximum datagram size
738 * - avoid unwanted changes to rx and tx buffers
739 */
740int cdc_ncm_change_mtu(struct net_device *net, int new_mtu)
741{
742 struct usbnet *dev = netdev_priv(net);
Rafal Redzimski05a56482016-05-19 11:56:09 +0200743 int maxmtu = cdc_ncm_max_dgram_size(dev) - cdc_ncm_eth_hlen(dev);
Bjørn Mork1dfddff52015-12-23 13:42:43 +0100744
745 if (new_mtu <= 0 || new_mtu > maxmtu)
746 return -EINVAL;
Rafal Redzimski05a56482016-05-19 11:56:09 +0200747
Bjørn Mork1dfddff52015-12-23 13:42:43 +0100748 net->mtu = new_mtu;
Rafal Redzimski05a56482016-05-19 11:56:09 +0200749 cdc_ncm_set_dgram_size(dev, new_mtu + cdc_ncm_eth_hlen(dev));
750
Bjørn Mork1dfddff52015-12-23 13:42:43 +0100751 return 0;
752}
753EXPORT_SYMBOL_GPL(cdc_ncm_change_mtu);
754
755static const struct net_device_ops cdc_ncm_netdev_ops = {
756 .ndo_open = usbnet_open,
757 .ndo_stop = usbnet_stop,
758 .ndo_start_xmit = usbnet_start_xmit,
759 .ndo_tx_timeout = usbnet_tx_timeout,
760 .ndo_change_mtu = cdc_ncm_change_mtu,
761 .ndo_set_mac_address = eth_mac_addr,
762 .ndo_validate_addr = eth_validate_addr,
763};
764
Enrico Mioso4a0e3e92015-07-08 13:05:57 +0200765int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting, int drvflags)
Alexey Orishko900d4952010-11-29 23:23:28 +0000766{
767 struct cdc_ncm_ctx *ctx;
768 struct usb_driver *driver;
769 u8 *buf;
770 int len;
771 int temp;
Enrico Miosobddc61e2017-07-11 17:21:52 +0200772 int err;
Alexey Orishko900d4952010-11-29 23:23:28 +0000773 u8 iface_no;
Oliver Neukum77b0a092015-09-07 16:05:39 +0200774 struct usb_cdc_parsed_header hdr;
Enrico Miosobddc61e2017-07-11 17:21:52 +0200775 u16 curr_ntb_format;
Alexey Orishko900d4952010-11-29 23:23:28 +0000776
Thomas Meyerc7969842011-11-17 12:43:40 +0000777 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
Devendra Naga8f0923c2013-03-29 23:03:22 +0000778 if (!ctx)
779 return -ENOMEM;
Alexey Orishko900d4952010-11-29 23:23:28 +0000780
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +0000781 hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
782 ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
Bjørn Morkbed6f762013-11-01 11:16:42 +0100783 ctx->bh.data = (unsigned long)dev;
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +0000784 ctx->bh.func = cdc_ncm_txpath_bh;
785 atomic_set(&ctx->stop, 0);
Alexey Orishko900d4952010-11-29 23:23:28 +0000786 spin_lock_init(&ctx->mtx);
Alexey Orishko900d4952010-11-29 23:23:28 +0000787
788 /* store ctx pointer in device data field */
789 dev->data[0] = (unsigned long)ctx;
790
Bjørn Mork9fe02342013-11-01 11:16:48 +0100791 /* only the control interface can be successfully probed */
792 ctx->control = intf;
793
Alexey Orishko900d4952010-11-29 23:23:28 +0000794 /* get some pointers */
795 driver = driver_of(intf);
796 buf = intf->cur_altsetting->extra;
797 len = intf->cur_altsetting->extralen;
798
Alexey Orishko900d4952010-11-29 23:23:28 +0000799 /* parse through descriptors associated with control interface */
Oliver Neukum77b0a092015-09-07 16:05:39 +0200800 cdc_parse_cdc_header(&hdr, intf, buf, len);
Alexey Orishko900d4952010-11-29 23:23:28 +0000801
Bjørn Mork6527f832015-11-23 14:32:10 +0100802 if (hdr.usb_cdc_union_desc)
803 ctx->data = usb_ifnum_to_if(dev->udev,
804 hdr.usb_cdc_union_desc->bSlaveInterface0);
Oliver Neukum77b0a092015-09-07 16:05:39 +0200805 ctx->ether_desc = hdr.usb_cdc_ether_desc;
806 ctx->func_desc = hdr.usb_cdc_ncm_desc;
807 ctx->mbim_desc = hdr.usb_cdc_mbim_desc;
808 ctx->mbim_extended_desc = hdr.usb_cdc_mbim_extended_desc;
Alexey Orishko900d4952010-11-29 23:23:28 +0000809
Bjørn Mork9992c2e2013-01-21 05:50:38 +0000810 /* some buggy devices have an IAD but no CDC Union */
Bjørn Mork6527f832015-11-23 14:32:10 +0100811 if (!hdr.usb_cdc_union_desc && intf->intf_assoc && intf->intf_assoc->bInterfaceCount == 2) {
Bjørn Mork56a666d2013-01-25 23:36:59 +0000812 ctx->data = usb_ifnum_to_if(dev->udev, intf->cur_altsetting->desc.bInterfaceNumber + 1);
813 dev_dbg(&intf->dev, "CDC Union missing - got slave from IAD\n");
Bjørn Mork9992c2e2013-01-21 05:50:38 +0000814 }
815
Alexey Orishko900d4952010-11-29 23:23:28 +0000816 /* check if we got everything */
Bjørn Morkf8afb732014-05-16 21:48:19 +0200817 if (!ctx->data) {
818 dev_dbg(&intf->dev, "CDC Union missing and no IAD found\n");
Alexey Orishko900d4952010-11-29 23:23:28 +0000819 goto error;
Bjørn Mork296e81f2013-11-01 11:17:00 +0100820 }
Bjørn Morkf8afb732014-05-16 21:48:19 +0200821 if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting)) {
822 if (!ctx->mbim_desc) {
823 dev_dbg(&intf->dev, "MBIM functional descriptor missing\n");
824 goto error;
825 }
826 } else {
827 if (!ctx->ether_desc || !ctx->func_desc) {
828 dev_dbg(&intf->dev, "NCM or ECM functional descriptors missing\n");
829 goto error;
830 }
831 }
Alexey Orishko900d4952010-11-29 23:23:28 +0000832
Bjørn Morkbbc8d922012-11-13 03:19:43 +0000833 /* claim data interface, if different from control */
834 if (ctx->data != ctx->control) {
835 temp = usb_driver_claim_interface(driver, ctx->data, dev);
Bjørn Mork296e81f2013-11-01 11:17:00 +0100836 if (temp) {
837 dev_dbg(&intf->dev, "failed to claim data intf\n");
Bjørn Morkbbc8d922012-11-13 03:19:43 +0000838 goto error;
Bjørn Mork296e81f2013-11-01 11:17:00 +0100839 }
Bjørn Morkbbc8d922012-11-13 03:19:43 +0000840 }
Alexey Orishko900d4952010-11-29 23:23:28 +0000841
842 iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
843
Daniele Palmas7b8076c2016-12-07 14:07:48 +0100844 /* Device-specific flags */
845 ctx->drvflags = drvflags;
846
Bjørn Mork48906f62016-03-03 22:20:53 +0100847 /* Reset data interface. Some devices will not reset properly
848 * unless they are configured first. Toggle the altsetting to
Daniele Palmas7b8076c2016-12-07 14:07:48 +0100849 * force a reset.
850 * Some other devices do not work properly with this procedure
851 * that can be avoided using quirk CDC_MBIM_FLAG_AVOID_ALTSETTING_TOGGLE
Bjørn Mork48906f62016-03-03 22:20:53 +0100852 */
Daniele Palmas7b8076c2016-12-07 14:07:48 +0100853 if (!(ctx->drvflags & CDC_MBIM_FLAG_AVOID_ALTSETTING_TOGGLE))
854 usb_set_interface(dev->udev, iface_no, data_altsetting);
855
Alexey Orishko900d4952010-11-29 23:23:28 +0000856 temp = usb_set_interface(dev->udev, iface_no, 0);
Bjørn Mork296e81f2013-11-01 11:17:00 +0100857 if (temp) {
858 dev_dbg(&intf->dev, "set interface failed\n");
Alexey Orishko19694ac2011-05-24 05:26:13 +0000859 goto error2;
Bjørn Mork296e81f2013-11-01 11:17:00 +0100860 }
Alexey Orishko900d4952010-11-29 23:23:28 +0000861
Bjørn Mork08c74fc2014-05-16 21:48:20 +0200862 /* initialize basic device settings */
863 if (cdc_ncm_init(dev))
Bjørn Morkff0992e92014-03-17 16:25:18 +0100864 goto error2;
865
Bjørn Morkc086e702016-07-03 22:24:50 +0200866 /* Some firmwares need a pause here or they will silently fail
867 * to set up the interface properly. This value was decided
868 * empirically on a Sierra Wireless MC7455 running 02.08.02.00
869 * firmware.
870 */
871 usleep_range(10000, 20000);
872
Alexey Orishko900d4952010-11-29 23:23:28 +0000873 /* configure data interface */
Greg Suarez38396e42012-10-22 10:56:31 +0000874 temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
Bjørn Mork296e81f2013-11-01 11:17:00 +0100875 if (temp) {
876 dev_dbg(&intf->dev, "set interface failed\n");
Alexey Orishko19694ac2011-05-24 05:26:13 +0000877 goto error2;
Bjørn Mork296e81f2013-11-01 11:17:00 +0100878 }
Alexey Orishko900d4952010-11-29 23:23:28 +0000879
Enrico Miosobddc61e2017-07-11 17:21:52 +0200880 /*
881 * Some Huawei devices have been observed to come out of reset in NDP32 mode.
882 * Let's check if this is the case, and set the device to NDP16 mode again if
883 * needed.
884 */
885 if (ctx->drvflags & CDC_NCM_FLAG_RESET_NTB16) {
886 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_FORMAT,
887 USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
888 0, iface_no, &curr_ntb_format, 2);
889 if (err < 0) {
890 goto error2;
891 }
892
893 if (curr_ntb_format == USB_CDC_NCM_NTB32_FORMAT) {
894 dev_info(&intf->dev, "resetting NTB format to 16-bit");
895 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
896 USB_TYPE_CLASS | USB_DIR_OUT
897 | USB_RECIP_INTERFACE,
898 USB_CDC_NCM_NTB16_FORMAT,
899 iface_no, NULL, 0);
900
901 if (err < 0)
902 goto error2;
903 }
904 }
905
Bjørn Morkff1632a2013-11-01 11:16:41 +0100906 cdc_ncm_find_endpoints(dev, ctx->data);
907 cdc_ncm_find_endpoints(dev, ctx->control);
Bjørn Mork296e81f2013-11-01 11:17:00 +0100908 if (!dev->in || !dev->out || !dev->status) {
909 dev_dbg(&intf->dev, "failed to collect endpoints\n");
Alexey Orishko19694ac2011-05-24 05:26:13 +0000910 goto error2;
Bjørn Mork296e81f2013-11-01 11:17:00 +0100911 }
Alexey Orishko900d4952010-11-29 23:23:28 +0000912
Alexey Orishko900d4952010-11-29 23:23:28 +0000913 usb_set_intfdata(ctx->data, dev);
914 usb_set_intfdata(ctx->control, dev);
Alexey Orishko900d4952010-11-29 23:23:28 +0000915
Greg Suarez38396e42012-10-22 10:56:31 +0000916 if (ctx->ether_desc) {
917 temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
Bjørn Mork296e81f2013-11-01 11:17:00 +0100918 if (temp) {
919 dev_dbg(&intf->dev, "failed to get mac address\n");
Greg Suarez38396e42012-10-22 10:56:31 +0000920 goto error2;
Bjørn Mork296e81f2013-11-01 11:17:00 +0100921 }
922 dev_info(&intf->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
Greg Suarez38396e42012-10-22 10:56:31 +0000923 }
Alexey Orishko900d4952010-11-29 23:23:28 +0000924
Bjørn Mork08c74fc2014-05-16 21:48:20 +0200925 /* finish setting up the device specific data */
926 cdc_ncm_setup(dev);
Bjørn Morkff0992e92014-03-17 16:25:18 +0100927
Enrico Mioso4a0e3e92015-07-08 13:05:57 +0200928 /* Allocate the delayed NDP if needed. */
929 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
930 ctx->delayed_ndp16 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
931 if (!ctx->delayed_ndp16)
932 goto error2;
933 dev_info(&intf->dev, "NDP will be placed at end of frame for this device.");
934 }
935
Bjørn Mork6c4e5482014-05-16 21:48:22 +0200936 /* override ethtool_ops */
937 dev->net->ethtool_ops = &cdc_ncm_ethtool_ops;
938
Bjørn Mork289507d2014-05-30 09:31:06 +0200939 /* add our sysfs attrs */
940 dev->net->sysfs_groups[0] = &cdc_ncm_sysfs_attr_group;
941
Bjørn Mork1dfddff52015-12-23 13:42:43 +0100942 /* must handle MTU changes */
943 dev->net->netdev_ops = &cdc_ncm_netdev_ops;
944
Alexey Orishko900d4952010-11-29 23:23:28 +0000945 return 0;
946
Alexey Orishko19694ac2011-05-24 05:26:13 +0000947error2:
948 usb_set_intfdata(ctx->control, NULL);
949 usb_set_intfdata(ctx->data, NULL);
Bjørn Mork6b4ef602013-01-21 05:50:40 +0000950 if (ctx->data != ctx->control)
951 usb_driver_release_interface(driver, ctx->data);
Alexey Orishko900d4952010-11-29 23:23:28 +0000952error:
953 cdc_ncm_free((struct cdc_ncm_ctx *)dev->data[0]);
954 dev->data[0] = 0;
Bjørn Mork296e81f2013-11-01 11:17:00 +0100955 dev_info(&intf->dev, "bind() failure\n");
Alexey Orishko900d4952010-11-29 23:23:28 +0000956 return -ENODEV;
957}
Bjørn Morkc91ce3b2012-10-22 10:56:35 +0000958EXPORT_SYMBOL_GPL(cdc_ncm_bind_common);
Alexey Orishko900d4952010-11-29 23:23:28 +0000959
Bjørn Morkc91ce3b2012-10-22 10:56:35 +0000960void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf)
Alexey Orishko900d4952010-11-29 23:23:28 +0000961{
962 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
Alexey Orishko19694ac2011-05-24 05:26:13 +0000963 struct usb_driver *driver = driver_of(intf);
Alexey Orishko900d4952010-11-29 23:23:28 +0000964
965 if (ctx == NULL)
966 return; /* no setup */
967
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +0000968 atomic_set(&ctx->stop, 1);
969
970 if (hrtimer_active(&ctx->tx_timer))
971 hrtimer_cancel(&ctx->tx_timer);
972
973 tasklet_kill(&ctx->bh);
974
Bjørn Morkbbc8d922012-11-13 03:19:43 +0000975 /* handle devices with combined control and data interface */
976 if (ctx->control == ctx->data)
977 ctx->data = NULL;
978
Alexey Orishko19694ac2011-05-24 05:26:13 +0000979 /* disconnect master --> disconnect slave */
980 if (intf == ctx->control && ctx->data) {
981 usb_set_intfdata(ctx->data, NULL);
Alexey Orishko900d4952010-11-29 23:23:28 +0000982 usb_driver_release_interface(driver, ctx->data);
Alexey Orishko19694ac2011-05-24 05:26:13 +0000983 ctx->data = NULL;
Alexey Orishko900d4952010-11-29 23:23:28 +0000984
Alexey Orishko19694ac2011-05-24 05:26:13 +0000985 } else if (intf == ctx->data && ctx->control) {
986 usb_set_intfdata(ctx->control, NULL);
Alexey Orishko900d4952010-11-29 23:23:28 +0000987 usb_driver_release_interface(driver, ctx->control);
Alexey Orishko19694ac2011-05-24 05:26:13 +0000988 ctx->control = NULL;
Alexey Orishko900d4952010-11-29 23:23:28 +0000989 }
990
Bjørn Mork3e515662013-11-01 11:16:40 +0100991 usb_set_intfdata(intf, NULL);
Alexey Orishko900d4952010-11-29 23:23:28 +0000992 cdc_ncm_free(ctx);
993}
Bjørn Morkc91ce3b2012-10-22 10:56:35 +0000994EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
Alexey Orishko900d4952010-11-29 23:23:28 +0000995
Bjørn Mork50a0ffa2014-05-11 10:47:15 +0200996/* Return the number of the MBIM control interface altsetting iff it
997 * is preferred and available,
Bjørn Mork1e8bbe62013-03-14 01:05:13 +0000998 */
Bjørn Mork50a0ffa2014-05-11 10:47:15 +0200999u8 cdc_ncm_select_altsetting(struct usb_interface *intf)
Greg Suarez38396e42012-10-22 10:56:31 +00001000{
Bjørn Mork1e8bbe62013-03-14 01:05:13 +00001001 struct usb_host_interface *alt;
Greg Suarez38396e42012-10-22 10:56:31 +00001002
Bjørn Morkbd329e12012-10-22 10:56:38 +00001003 /* The MBIM spec defines a NCM compatible default altsetting,
1004 * which we may have matched:
1005 *
1006 * "Functions that implement both NCM 1.0 and MBIM (an
1007 * “NCM/MBIM function”) according to this recommendation
1008 * shall provide two alternate settings for the
1009 * Communication Interface. Alternate setting 0, and the
1010 * associated class and endpoint descriptors, shall be
1011 * constructed according to the rules given for the
1012 * Communication Interface in section 5 of [USBNCM10].
1013 * Alternate setting 1, and the associated class and
1014 * endpoint descriptors, shall be constructed according to
1015 * the rules given in section 6 (USB Device Model) of this
1016 * specification."
Bjørn Morkbd329e12012-10-22 10:56:38 +00001017 */
Bjørn Mork50a0ffa2014-05-11 10:47:15 +02001018 if (intf->num_altsetting < 2)
1019 return intf->cur_altsetting->desc.bAlternateSetting;
1020
1021 if (prefer_mbim) {
Bjørn Mork1e8bbe62013-03-14 01:05:13 +00001022 alt = usb_altnum_to_altsetting(intf, CDC_NCM_COMM_ALTSETTING_MBIM);
Bjørn Mork50a0ffa2014-05-11 10:47:15 +02001023 if (alt && cdc_ncm_comm_intf_is_mbim(alt))
1024 return CDC_NCM_COMM_ALTSETTING_MBIM;
Bjørn Morkf350ca02013-02-13 12:09:52 +00001025 }
Bjørn Mork50a0ffa2014-05-11 10:47:15 +02001026 return CDC_NCM_COMM_ALTSETTING_NCM;
Bjørn Mork1e8bbe62013-03-14 01:05:13 +00001027}
1028EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting);
1029
1030static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
1031{
Bjørn Mork1e8bbe62013-03-14 01:05:13 +00001032 /* MBIM backwards compatible function? */
Bjørn Mork50a0ffa2014-05-11 10:47:15 +02001033 if (cdc_ncm_select_altsetting(intf) != CDC_NCM_COMM_ALTSETTING_NCM)
Bjørn Mork1e8bbe62013-03-14 01:05:13 +00001034 return -ENODEV;
Bjørn Morkbd329e12012-10-22 10:56:38 +00001035
Enrico Mioso4a0e3e92015-07-08 13:05:57 +02001036 /* The NCM data altsetting is fixed, so we hard-coded it.
1037 * Additionally, generic NCM devices are assumed to accept arbitrarily
1038 * placed NDP.
1039 */
Bjørn Mork4d06dd52016-03-07 21:15:36 +01001040 return cdc_ncm_bind_common(dev, intf, CDC_NCM_DATA_ALTSETTING_NCM, 0);
Greg Suarez38396e42012-10-22 10:56:31 +00001041}
1042
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001043static void cdc_ncm_align_tail(struct sk_buff *skb, size_t modulus, size_t remainder, size_t max)
Alexey Orishko900d4952010-11-29 23:23:28 +00001044{
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001045 size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;
1046
1047 if (skb->len + align > max)
1048 align = max - skb->len;
1049 if (align && skb_tailroom(skb) >= align)
1050 memset(skb_put(skb, align), 0, align);
1051}
1052
1053/* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
1054 * allocating a new one within skb
1055 */
1056static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
1057{
1058 struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
1059 struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
1060 size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);
1061
Enrico Mioso4a0e3e92015-07-08 13:05:57 +02001062 /* If NDP should be moved to the end of the NCM package, we can't follow the
1063 * NTH16 header as we would normally do. NDP isn't written to the SKB yet, and
1064 * the wNdpIndex field in the header is actually not consistent with reality. It will be later.
1065 */
Bjørn Morkf8c0cfa2015-12-05 13:01:50 +01001066 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
Enrico Mioso4a0e3e92015-07-08 13:05:57 +02001067 if (ctx->delayed_ndp16->dwSignature == sign)
1068 return ctx->delayed_ndp16;
1069
Bjørn Morkf8c0cfa2015-12-05 13:01:50 +01001070 /* We can only push a single NDP to the end. Return
1071 * NULL to send what we've already got and queue this
1072 * skb for later.
1073 */
1074 else if (ctx->delayed_ndp16->dwSignature)
1075 return NULL;
1076 }
1077
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001078 /* follow the chain of NDPs, looking for a match */
1079 while (ndpoffset) {
1080 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
1081 if (ndp16->dwSignature == sign)
1082 return ndp16;
1083 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1084 }
1085
1086 /* align new NDP */
Enrico Mioso4a0e3e92015-07-08 13:05:57 +02001087 if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1088 cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_max);
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001089
1090 /* verify that there is room for the NDP and the datagram (reserve) */
Bjørn Mork70559b82014-05-16 21:48:23 +02001091 if ((ctx->tx_max - skb->len - reserve) < ctx->max_ndp_size)
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001092 return NULL;
1093
1094 /* link to it */
1095 if (ndp16)
1096 ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
1097 else
1098 nth16->wNdpIndex = cpu_to_le16(skb->len);
1099
1100 /* push a new empty NDP */
Enrico Mioso4a0e3e92015-07-08 13:05:57 +02001101 if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
1102 ndp16 = (struct usb_cdc_ncm_ndp16 *)memset(skb_put(skb, ctx->max_ndp_size), 0, ctx->max_ndp_size);
1103 else
1104 ndp16 = ctx->delayed_ndp16;
1105
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001106 ndp16->dwSignature = sign;
1107 ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
1108 return ndp16;
Alexey Orishko900d4952010-11-29 23:23:28 +00001109}
1110
Bjørn Morkc91ce3b2012-10-22 10:56:35 +00001111struct sk_buff *
Bjørn Morkbed6f762013-11-01 11:16:42 +01001112cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign)
Alexey Orishko900d4952010-11-29 23:23:28 +00001113{
Bjørn Morkbed6f762013-11-01 11:16:42 +01001114 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001115 struct usb_cdc_ncm_nth16 *nth16;
1116 struct usb_cdc_ncm_ndp16 *ndp16;
Alexey Orishko900d4952010-11-29 23:23:28 +00001117 struct sk_buff *skb_out;
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001118 u16 n = 0, index, ndplen;
Alexey Orishko84e77a82011-02-07 09:45:10 +00001119 u8 ready2send = 0;
Enrico Mioso4a0e3e92015-07-08 13:05:57 +02001120 u32 delayed_ndp_size;
Jim Baxter2d118402017-05-08 13:49:57 +01001121 size_t padding_count;
Enrico Mioso4a0e3e92015-07-08 13:05:57 +02001122
1123 /* When our NDP gets written in cdc_ncm_ndp(), then skb_out->len gets updated
1124 * accordingly. Otherwise, we should check here.
1125 */
1126 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END)
1127 delayed_ndp_size = ctx->max_ndp_size;
1128 else
1129 delayed_ndp_size = 0;
Alexey Orishko900d4952010-11-29 23:23:28 +00001130
1131 /* if there is a remaining skb, it gets priority */
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001132 if (skb != NULL) {
Alexey Orishko900d4952010-11-29 23:23:28 +00001133 swap(skb, ctx->tx_rem_skb);
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001134 swap(sign, ctx->tx_rem_sign);
1135 } else {
Alexey Orishko84e77a82011-02-07 09:45:10 +00001136 ready2send = 1;
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001137 }
Alexey Orishko900d4952010-11-29 23:23:28 +00001138
1139 /* check if we are resuming an OUT skb */
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001140 skb_out = ctx->tx_curr_skb;
Alexey Orishko900d4952010-11-29 23:23:28 +00001141
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001142 /* allocate a new OUT skb */
1143 if (!skb_out) {
Bjørn Mork20572222013-11-01 11:16:38 +01001144 skb_out = alloc_skb(ctx->tx_max, GFP_ATOMIC);
Alexey Orishko900d4952010-11-29 23:23:28 +00001145 if (skb_out == NULL) {
1146 if (skb != NULL) {
1147 dev_kfree_skb_any(skb);
Bjørn Morkbed6f762013-11-01 11:16:42 +01001148 dev->net->stats.tx_dropped++;
Alexey Orishko900d4952010-11-29 23:23:28 +00001149 }
1150 goto exit_no_skb;
1151 }
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001152 /* fill out the initial 16-bit NTB header */
1153 nth16 = (struct usb_cdc_ncm_nth16 *)memset(skb_put(skb_out, sizeof(struct usb_cdc_ncm_nth16)), 0, sizeof(struct usb_cdc_ncm_nth16));
1154 nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
1155 nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
1156 nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
Alexey Orishko900d4952010-11-29 23:23:28 +00001157
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001158 /* count total number of frames in this NTB */
Alexey Orishko900d4952010-11-29 23:23:28 +00001159 ctx->tx_curr_frame_num = 0;
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001160
1161 /* recent payload counter for this skb_out */
1162 ctx->tx_curr_frame_payload = 0;
Alexey Orishko900d4952010-11-29 23:23:28 +00001163 }
1164
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001165 for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
1166 /* send any remaining skb first */
Alexey Orishko900d4952010-11-29 23:23:28 +00001167 if (skb == NULL) {
1168 skb = ctx->tx_rem_skb;
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001169 sign = ctx->tx_rem_sign;
Alexey Orishko900d4952010-11-29 23:23:28 +00001170 ctx->tx_rem_skb = NULL;
1171
1172 /* check for end of skb */
1173 if (skb == NULL)
1174 break;
1175 }
1176
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001177 /* get the appropriate NDP for this skb */
1178 ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
1179
1180 /* align beginning of next frame */
1181 cdc_ncm_align_tail(skb_out, ctx->tx_modulus, ctx->tx_remainder, ctx->tx_max);
1182
1183 /* check if we had enough room left for both NDP and frame */
Enrico Mioso4a0e3e92015-07-08 13:05:57 +02001184 if (!ndp16 || skb_out->len + skb->len + delayed_ndp_size > ctx->tx_max) {
Alexey Orishko900d4952010-11-29 23:23:28 +00001185 if (n == 0) {
1186 /* won't fit, MTU problem? */
1187 dev_kfree_skb_any(skb);
1188 skb = NULL;
Bjørn Morkbed6f762013-11-01 11:16:42 +01001189 dev->net->stats.tx_dropped++;
Alexey Orishko900d4952010-11-29 23:23:28 +00001190 } else {
1191 /* no room for skb - store for later */
1192 if (ctx->tx_rem_skb != NULL) {
1193 dev_kfree_skb_any(ctx->tx_rem_skb);
Bjørn Morkbed6f762013-11-01 11:16:42 +01001194 dev->net->stats.tx_dropped++;
Alexey Orishko900d4952010-11-29 23:23:28 +00001195 }
1196 ctx->tx_rem_skb = skb;
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001197 ctx->tx_rem_sign = sign;
Alexey Orishko900d4952010-11-29 23:23:28 +00001198 skb = NULL;
Alexey Orishko84e77a82011-02-07 09:45:10 +00001199 ready2send = 1;
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001200 ctx->tx_reason_ntb_full++; /* count reason for transmitting */
Alexey Orishko900d4952010-11-29 23:23:28 +00001201 }
1202 break;
1203 }
1204
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001205 /* calculate frame number withing this NDP */
1206 ndplen = le16_to_cpu(ndp16->wLength);
1207 index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
Alexey Orishko900d4952010-11-29 23:23:28 +00001208
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001209 /* OK, add this skb */
1210 ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
1211 ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
1212 ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
1213 memcpy(skb_put(skb_out, skb->len), skb->data, skb->len);
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001214 ctx->tx_curr_frame_payload += skb->len; /* count real tx payload data */
Alexey Orishko900d4952010-11-29 23:23:28 +00001215 dev_kfree_skb_any(skb);
1216 skb = NULL;
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001217
1218 /* send now if this NDP is full */
1219 if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
1220 ready2send = 1;
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001221 ctx->tx_reason_ndp_full++; /* count reason for transmitting */
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001222 break;
1223 }
Alexey Orishko900d4952010-11-29 23:23:28 +00001224 }
1225
1226 /* free up any dangling skb */
1227 if (skb != NULL) {
1228 dev_kfree_skb_any(skb);
1229 skb = NULL;
Bjørn Morkbed6f762013-11-01 11:16:42 +01001230 dev->net->stats.tx_dropped++;
Alexey Orishko900d4952010-11-29 23:23:28 +00001231 }
1232
1233 ctx->tx_curr_frame_num = n;
1234
1235 if (n == 0) {
1236 /* wait for more frames */
1237 /* push variables */
1238 ctx->tx_curr_skb = skb_out;
Alexey Orishko900d4952010-11-29 23:23:28 +00001239 goto exit_no_skb;
1240
Bjørn Mork6c4e5482014-05-16 21:48:22 +02001241 } else if ((n < ctx->tx_max_datagrams) && (ready2send == 0) && (ctx->timer_interval > 0)) {
Alexey Orishko900d4952010-11-29 23:23:28 +00001242 /* wait for more frames */
1243 /* push variables */
1244 ctx->tx_curr_skb = skb_out;
Alexey Orishko900d4952010-11-29 23:23:28 +00001245 /* set the pending count */
1246 if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001247 ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
Alexey Orishko900d4952010-11-29 23:23:28 +00001248 goto exit_no_skb;
1249
1250 } else {
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001251 if (n == ctx->tx_max_datagrams)
1252 ctx->tx_reason_max_datagram++; /* count reason for transmitting */
Alexey Orishko900d4952010-11-29 23:23:28 +00001253 /* frame goes out */
1254 /* variables will be reset at next call */
1255 }
1256
Enrico Mioso4a0e3e92015-07-08 13:05:57 +02001257 /* If requested, put NDP at end of frame. */
1258 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
1259 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1260 cdc_ncm_align_tail(skb_out, ctx->tx_ndp_modulus, 0, ctx->tx_max);
1261 nth16->wNdpIndex = cpu_to_le16(skb_out->len);
1262 memcpy(skb_put(skb_out, ctx->max_ndp_size), ctx->delayed_ndp16, ctx->max_ndp_size);
1263
1264 /* Zero out delayed NDP - signature checking will naturally fail. */
1265 ndp16 = memset(ctx->delayed_ndp16, 0, ctx->max_ndp_size);
1266 }
1267
Bjørn Mork43e4c6d2014-05-16 21:48:24 +02001268 /* If collected data size is less or equal ctx->min_tx_pkt
Bjørn Mork20572222013-11-01 11:16:38 +01001269 * bytes, we send buffers as it is. If we get more data, it
1270 * would be more efficient for USB HS mobile device with DMA
1271 * engine to receive a full size NTB, than canceling DMA
1272 * transfer and receiving a short packet.
Bjørn Mork4d619f62013-11-01 11:16:49 +01001273 *
1274 * This optimization support is pointless if we end up sending
1275 * a ZLP after full sized NTBs.
Alexey Orishko900d4952010-11-29 23:23:28 +00001276 */
Bjørn Mork4d619f62013-11-01 11:16:49 +01001277 if (!(dev->driver_info->flags & FLAG_SEND_ZLP) &&
Jim Baxter2d118402017-05-08 13:49:57 +01001278 skb_out->len > ctx->min_tx_pkt) {
1279 padding_count = ctx->tx_max - skb_out->len;
1280 memset(skb_put(skb_out, padding_count), 0, padding_count);
1281 } else if (skb_out->len < ctx->tx_max &&
1282 (skb_out->len % dev->maxpacket) == 0) {
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001283 *skb_put(skb_out, 1) = 0; /* force short packet */
Jim Baxter2d118402017-05-08 13:49:57 +01001284 }
Alexey Orishko900d4952010-11-29 23:23:28 +00001285
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001286 /* set final frame length */
1287 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1288 nth16->wBlockLength = cpu_to_le16(skb_out->len);
Alexey Orishko900d4952010-11-29 23:23:28 +00001289
1290 /* return skb */
1291 ctx->tx_curr_skb = NULL;
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001292
1293 /* keep private stats: framing overhead and number of NTBs */
1294 ctx->tx_overhead += skb_out->len - ctx->tx_curr_frame_payload;
1295 ctx->tx_ntbs++;
1296
Ben Hutchings7a1e8902015-03-25 21:41:33 +01001297 /* usbnet will count all the framing overhead by default.
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001298 * Adjust the stats so that the tx_bytes counter show real
1299 * payload data instead.
1300 */
Ben Hutchings7a1e8902015-03-25 21:41:33 +01001301 usbnet_set_skb_tx_stats(skb_out, n,
Bjørn Mork44f67312015-05-22 13:15:22 +02001302 (long)ctx->tx_curr_frame_payload - skb_out->len);
Ben Hutchings1e9e39f2015-02-26 19:34:37 +00001303
Alexey Orishko900d4952010-11-29 23:23:28 +00001304 return skb_out;
1305
1306exit_no_skb:
Bjørn Mork046c6592014-05-16 21:48:29 +02001307 /* Start timer, if there is a remaining non-empty skb */
1308 if (ctx->tx_curr_skb != NULL && n > 0)
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001309 cdc_ncm_tx_timeout_start(ctx);
Alexey Orishko900d4952010-11-29 23:23:28 +00001310 return NULL;
1311}
Bjørn Morkc91ce3b2012-10-22 10:56:35 +00001312EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
Alexey Orishko900d4952010-11-29 23:23:28 +00001313
1314static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
1315{
1316 /* start timer, if not already started */
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001317 if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
1318 hrtimer_start(&ctx->tx_timer,
Bjørn Mork6c4e5482014-05-16 21:48:22 +02001319 ktime_set(0, ctx->timer_interval),
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001320 HRTIMER_MODE_REL);
Alexey Orishko900d4952010-11-29 23:23:28 +00001321}
1322
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001323static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
Alexey Orishko900d4952010-11-29 23:23:28 +00001324{
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001325 struct cdc_ncm_ctx *ctx =
1326 container_of(timer, struct cdc_ncm_ctx, tx_timer);
Alexey Orishko900d4952010-11-29 23:23:28 +00001327
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001328 if (!atomic_read(&ctx->stop))
1329 tasklet_schedule(&ctx->bh);
1330 return HRTIMER_NORESTART;
1331}
1332
1333static void cdc_ncm_txpath_bh(unsigned long param)
1334{
Bjørn Morkbed6f762013-11-01 11:16:42 +01001335 struct usbnet *dev = (struct usbnet *)param;
1336 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001337
1338 spin_lock_bh(&ctx->mtx);
Alexey Orishko900d4952010-11-29 23:23:28 +00001339 if (ctx->tx_timer_pending != 0) {
1340 ctx->tx_timer_pending--;
Alexey Orishko900d4952010-11-29 23:23:28 +00001341 cdc_ncm_tx_timeout_start(ctx);
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001342 spin_unlock_bh(&ctx->mtx);
Bjørn Morkbed6f762013-11-01 11:16:42 +01001343 } else if (dev->net != NULL) {
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001344 ctx->tx_reason_timeout++; /* count reason for transmitting */
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001345 spin_unlock_bh(&ctx->mtx);
Bjørn Morkbed6f762013-11-01 11:16:42 +01001346 netif_tx_lock_bh(dev->net);
1347 usbnet_start_xmit(NULL, dev->net);
1348 netif_tx_unlock_bh(dev->net);
Bjørn Mork7b1e0cb2012-10-25 21:44:09 +00001349 } else {
1350 spin_unlock_bh(&ctx->mtx);
Alexey Orishkof742aa82011-01-17 07:07:25 +00001351 }
Alexey Orishko900d4952010-11-29 23:23:28 +00001352}
1353
Enrico Mioso2f69702c2013-11-04 09:50:47 +01001354struct sk_buff *
Alexey Orishko900d4952010-11-29 23:23:28 +00001355cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
1356{
1357 struct sk_buff *skb_out;
1358 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
Alexey Orishko900d4952010-11-29 23:23:28 +00001359
1360 /*
1361 * The Ethernet API we are using does not support transmitting
1362 * multiple Ethernet frames in a single call. This driver will
1363 * accumulate multiple Ethernet frames and send out a larger
1364 * USB frame when the USB buffer is full or when a single jiffies
1365 * timeout happens.
1366 */
1367 if (ctx == NULL)
1368 goto error;
1369
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001370 spin_lock_bh(&ctx->mtx);
Bjørn Morkbed6f762013-11-01 11:16:42 +01001371 skb_out = cdc_ncm_fill_tx_frame(dev, skb, cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN));
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001372 spin_unlock_bh(&ctx->mtx);
Alexey Orishko900d4952010-11-29 23:23:28 +00001373 return skb_out;
1374
1375error:
1376 if (skb != NULL)
1377 dev_kfree_skb_any(skb);
1378
1379 return NULL;
1380}
Enrico Mioso2f69702c2013-11-04 09:50:47 +01001381EXPORT_SYMBOL_GPL(cdc_ncm_tx_fixup);
Alexey Orishko900d4952010-11-29 23:23:28 +00001382
Bjørn Morkff06ab12012-10-22 10:56:33 +00001383/* verify NTB header and return offset of first NDP, or negative error */
Bjørn Morkc91ce3b2012-10-22 10:56:35 +00001384int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
Alexey Orishko900d4952010-11-29 23:23:28 +00001385{
Bjørn Morkae223cd2013-11-01 11:16:54 +01001386 struct usbnet *dev = netdev_priv(skb_in->dev);
Alexey Orishkod5ddb4a2012-03-14 11:26:12 +00001387 struct usb_cdc_ncm_nth16 *nth16;
Bjørn Morkff06ab12012-10-22 10:56:33 +00001388 int len;
1389 int ret = -EINVAL;
Alexey Orishko900d4952010-11-29 23:23:28 +00001390
Alexey Orishko900d4952010-11-29 23:23:28 +00001391 if (ctx == NULL)
1392 goto error;
1393
Alexey Orishkod5ddb4a2012-03-14 11:26:12 +00001394 if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
1395 sizeof(struct usb_cdc_ncm_ndp16))) {
Bjørn Morkae223cd2013-11-01 11:16:54 +01001396 netif_dbg(dev, rx_err, dev->net, "frame too short\n");
Alexey Orishko900d4952010-11-29 23:23:28 +00001397 goto error;
1398 }
1399
Alexey Orishkod5ddb4a2012-03-14 11:26:12 +00001400 nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
Alexey Orishko900d4952010-11-29 23:23:28 +00001401
Bjørn Mork986e10d2013-11-01 11:16:56 +01001402 if (nth16->dwSignature != cpu_to_le32(USB_CDC_NCM_NTH16_SIGN)) {
Bjørn Mork5448d752013-11-01 11:16:55 +01001403 netif_dbg(dev, rx_err, dev->net,
1404 "invalid NTH16 signature <%#010x>\n",
1405 le32_to_cpu(nth16->dwSignature));
Alexey Orishko900d4952010-11-29 23:23:28 +00001406 goto error;
1407 }
1408
Alexey Orishkod5ddb4a2012-03-14 11:26:12 +00001409 len = le16_to_cpu(nth16->wBlockLength);
1410 if (len > ctx->rx_max) {
Bjørn Morkae223cd2013-11-01 11:16:54 +01001411 netif_dbg(dev, rx_err, dev->net,
1412 "unsupported NTB block length %u/%u\n", len,
1413 ctx->rx_max);
Alexey Orishko900d4952010-11-29 23:23:28 +00001414 goto error;
1415 }
1416
Alexey Orishkod5ddb4a2012-03-14 11:26:12 +00001417 if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
Bjørn Morkae223cd2013-11-01 11:16:54 +01001418 (ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
1419 !((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
1420 netif_dbg(dev, rx_err, dev->net,
1421 "sequence number glitch prev=%d curr=%d\n",
1422 ctx->rx_seq, le16_to_cpu(nth16->wSequence));
Alexey Orishkod5ddb4a2012-03-14 11:26:12 +00001423 }
1424 ctx->rx_seq = le16_to_cpu(nth16->wSequence);
1425
Bjørn Morkff06ab12012-10-22 10:56:33 +00001426 ret = le16_to_cpu(nth16->wNdpIndex);
1427error:
1428 return ret;
1429}
Bjørn Morkc91ce3b2012-10-22 10:56:35 +00001430EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
Bjørn Morkff06ab12012-10-22 10:56:33 +00001431
1432/* verify NDP header and return number of datagrams, or negative error */
Bjørn Morkc91ce3b2012-10-22 10:56:35 +00001433int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
Bjørn Morkff06ab12012-10-22 10:56:33 +00001434{
Bjørn Morkae223cd2013-11-01 11:16:54 +01001435 struct usbnet *dev = netdev_priv(skb_in->dev);
Bjørn Morkff06ab12012-10-22 10:56:33 +00001436 struct usb_cdc_ncm_ndp16 *ndp16;
1437 int ret = -EINVAL;
1438
Bjørn Mork75d67d32012-10-22 10:56:32 +00001439 if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
Bjørn Morkae223cd2013-11-01 11:16:54 +01001440 netif_dbg(dev, rx_err, dev->net, "invalid NDP offset <%u>\n",
1441 ndpoffset);
Alexey Orishko900d4952010-11-29 23:23:28 +00001442 goto error;
1443 }
Bjørn Mork75d67d32012-10-22 10:56:32 +00001444 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
Alexey Orishko900d4952010-11-29 23:23:28 +00001445
Alexey Orishkod5ddb4a2012-03-14 11:26:12 +00001446 if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
Bjørn Morkae223cd2013-11-01 11:16:54 +01001447 netif_dbg(dev, rx_err, dev->net, "invalid DPT16 length <%u>\n",
1448 le16_to_cpu(ndp16->wLength));
Bjørn Morkff06ab12012-10-22 10:56:33 +00001449 goto error;
Alexey Orishko900d4952010-11-29 23:23:28 +00001450 }
1451
Bjørn Morkff06ab12012-10-22 10:56:33 +00001452 ret = ((le16_to_cpu(ndp16->wLength) -
Alexey Orishko900d4952010-11-29 23:23:28 +00001453 sizeof(struct usb_cdc_ncm_ndp16)) /
1454 sizeof(struct usb_cdc_ncm_dpe16));
Bjørn Morkff06ab12012-10-22 10:56:33 +00001455 ret--; /* we process NDP entries except for the last one */
Alexey Orishko900d4952010-11-29 23:23:28 +00001456
Bjørn Morkae223cd2013-11-01 11:16:54 +01001457 if ((sizeof(struct usb_cdc_ncm_ndp16) +
1458 ret * (sizeof(struct usb_cdc_ncm_dpe16))) > skb_in->len) {
1459 netif_dbg(dev, rx_err, dev->net, "Invalid nframes = %d\n", ret);
Bjørn Morkff06ab12012-10-22 10:56:33 +00001460 ret = -EINVAL;
Alexey Orishko900d4952010-11-29 23:23:28 +00001461 }
1462
Bjørn Morkff06ab12012-10-22 10:56:33 +00001463error:
1464 return ret;
1465}
Bjørn Morkc91ce3b2012-10-22 10:56:35 +00001466EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
Bjørn Morkff06ab12012-10-22 10:56:33 +00001467
Enrico Mioso2f69702c2013-11-04 09:50:47 +01001468int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
Bjørn Morkff06ab12012-10-22 10:56:33 +00001469{
1470 struct sk_buff *skb;
1471 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1472 int len;
1473 int nframes;
1474 int x;
1475 int offset;
1476 struct usb_cdc_ncm_ndp16 *ndp16;
1477 struct usb_cdc_ncm_dpe16 *dpe16;
1478 int ndpoffset;
1479 int loopcount = 50; /* arbitrary max preventing infinite loop */
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001480 u32 payload = 0;
Bjørn Morkff06ab12012-10-22 10:56:33 +00001481
1482 ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
1483 if (ndpoffset < 0)
1484 goto error;
1485
1486next_ndp:
1487 nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
1488 if (nframes < 0)
1489 goto error;
1490
1491 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1492
Bjørn Mork986e10d2013-11-01 11:16:56 +01001493 if (ndp16->dwSignature != cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN)) {
Bjørn Mork5448d752013-11-01 11:16:55 +01001494 netif_dbg(dev, rx_err, dev->net,
1495 "invalid DPT16 signature <%#010x>\n",
1496 le32_to_cpu(ndp16->dwSignature));
Bjørn Morkff06ab12012-10-22 10:56:33 +00001497 goto err_ndp;
1498 }
1499 dpe16 = ndp16->dpe16;
Alexey Orishko900d4952010-11-29 23:23:28 +00001500
Alexey Orishkod5ddb4a2012-03-14 11:26:12 +00001501 for (x = 0; x < nframes; x++, dpe16++) {
1502 offset = le16_to_cpu(dpe16->wDatagramIndex);
1503 len = le16_to_cpu(dpe16->wDatagramLength);
Alexey Orishko900d4952010-11-29 23:23:28 +00001504
1505 /*
1506 * CDC NCM ch. 3.7
1507 * All entries after first NULL entry are to be ignored
1508 */
Alexey Orishkod5ddb4a2012-03-14 11:26:12 +00001509 if ((offset == 0) || (len == 0)) {
Alexey Orishko900d4952010-11-29 23:23:28 +00001510 if (!x)
Bjørn Mork75d67d32012-10-22 10:56:32 +00001511 goto err_ndp; /* empty NTB */
Alexey Orishko900d4952010-11-29 23:23:28 +00001512 break;
1513 }
1514
1515 /* sanity checking */
Alexey Orishkod5ddb4a2012-03-14 11:26:12 +00001516 if (((offset + len) > skb_in->len) ||
1517 (len > ctx->rx_max) || (len < ETH_HLEN)) {
Bjørn Morkae223cd2013-11-01 11:16:54 +01001518 netif_dbg(dev, rx_err, dev->net,
1519 "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
1520 x, offset, len, skb_in);
Alexey Orishko900d4952010-11-29 23:23:28 +00001521 if (!x)
Bjørn Mork75d67d32012-10-22 10:56:32 +00001522 goto err_ndp;
Alexey Orishko900d4952010-11-29 23:23:28 +00001523 break;
1524
1525 } else {
Bjørn Mork1e2c6112014-05-30 09:31:03 +02001526 /* create a fresh copy to reduce truesize */
1527 skb = netdev_alloc_skb_ip_align(dev->net, len);
Jesper Juhl9e567902011-01-13 11:40:11 +00001528 if (!skb)
1529 goto error;
Bjørn Mork1e2c6112014-05-30 09:31:03 +02001530 memcpy(skb_put(skb, len), skb_in->data + offset, len);
Alexey Orishko900d4952010-11-29 23:23:28 +00001531 usbnet_skb_return(dev, skb);
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001532 payload += len; /* count payload bytes in this NTB */
Alexey Orishko900d4952010-11-29 23:23:28 +00001533 }
1534 }
Bjørn Mork75d67d32012-10-22 10:56:32 +00001535err_ndp:
1536 /* are there more NDPs to process? */
1537 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1538 if (ndpoffset && loopcount--)
1539 goto next_ndp;
1540
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001541 /* update stats */
1542 ctx->rx_overhead += skb_in->len - payload;
1543 ctx->rx_ntbs++;
1544
Alexey Orishko900d4952010-11-29 23:23:28 +00001545 return 1;
1546error:
1547 return 0;
1548}
Enrico Mioso2f69702c2013-11-04 09:50:47 +01001549EXPORT_SYMBOL_GPL(cdc_ncm_rx_fixup);
Alexey Orishko900d4952010-11-29 23:23:28 +00001550
1551static void
Bjørn Morkbed6f762013-11-01 11:16:42 +01001552cdc_ncm_speed_change(struct usbnet *dev,
Alexey Orishko84e77a82011-02-07 09:45:10 +00001553 struct usb_cdc_speed_change *data)
Alexey Orishko900d4952010-11-29 23:23:28 +00001554{
Alexey Orishko84e77a82011-02-07 09:45:10 +00001555 uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1556 uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
Alexey Orishko900d4952010-11-29 23:23:28 +00001557
1558 /*
1559 * Currently the USB-NET API does not support reporting the actual
1560 * device speed. Do print it instead.
1561 */
Bjørn Morkf3028c52013-11-01 11:16:44 +01001562 if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
Bjørn Morkae223cd2013-11-01 11:16:54 +01001563 netif_info(dev, link, dev->net,
Bjørn Mork916f7642014-05-16 21:48:27 +02001564 "%u mbit/s downlink %u mbit/s uplink\n",
1565 (unsigned int)(rx_speed / 1000000U),
1566 (unsigned int)(tx_speed / 1000000U));
Bjørn Morkf3028c52013-11-01 11:16:44 +01001567 } else {
Bjørn Morkae223cd2013-11-01 11:16:54 +01001568 netif_info(dev, link, dev->net,
Bjørn Mork916f7642014-05-16 21:48:27 +02001569 "%u kbit/s downlink %u kbit/s uplink\n",
1570 (unsigned int)(rx_speed / 1000U),
1571 (unsigned int)(tx_speed / 1000U));
Alexey Orishko900d4952010-11-29 23:23:28 +00001572 }
1573}
1574
1575static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1576{
1577 struct cdc_ncm_ctx *ctx;
1578 struct usb_cdc_notification *event;
1579
1580 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1581
1582 if (urb->actual_length < sizeof(*event))
1583 return;
1584
1585 /* test for split data in 8-byte chunks */
1586 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
Bjørn Morkbed6f762013-11-01 11:16:42 +01001587 cdc_ncm_speed_change(dev,
Alexey Orishko84e77a82011-02-07 09:45:10 +00001588 (struct usb_cdc_speed_change *)urb->transfer_buffer);
Alexey Orishko900d4952010-11-29 23:23:28 +00001589 return;
1590 }
1591
1592 event = urb->transfer_buffer;
1593
1594 switch (event->bNotificationType) {
1595 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1596 /*
1597 * According to the CDC NCM specification ch.7.1
1598 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1599 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1600 */
Bjørn Morkae223cd2013-11-01 11:16:54 +01001601 netif_info(dev, link, dev->net,
1602 "network connection: %sconnected\n",
Bjørn Morkfa83dbe2014-05-16 21:48:28 +02001603 !!event->wValue ? "" : "dis");
1604 usbnet_link_change(dev, !!event->wValue, 0);
Alexey Orishko900d4952010-11-29 23:23:28 +00001605 break;
1606
1607 case USB_CDC_NOTIFY_SPEED_CHANGE:
Alexey Orishko84e77a82011-02-07 09:45:10 +00001608 if (urb->actual_length < (sizeof(*event) +
1609 sizeof(struct usb_cdc_speed_change)))
Alexey Orishko900d4952010-11-29 23:23:28 +00001610 set_bit(EVENT_STS_SPLIT, &dev->flags);
1611 else
Bjørn Morkbed6f762013-11-01 11:16:42 +01001612 cdc_ncm_speed_change(dev,
1613 (struct usb_cdc_speed_change *)&event[1]);
Alexey Orishko900d4952010-11-29 23:23:28 +00001614 break;
1615
1616 default:
Bjørn Mork67a36602013-04-08 08:26:23 +00001617 dev_dbg(&dev->udev->dev,
1618 "NCM: unexpected notification 0x%02x!\n",
1619 event->bNotificationType);
Alexey Orishko900d4952010-11-29 23:23:28 +00001620 break;
1621 }
1622}
1623
Alexey Orishko900d4952010-11-29 23:23:28 +00001624static const struct driver_info cdc_ncm_info = {
1625 .description = "CDC NCM",
Bjørn Mork4d06dd52016-03-07 21:15:36 +01001626 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1627 | FLAG_LINK_INTR,
Alexey Orishko900d4952010-11-29 23:23:28 +00001628 .bind = cdc_ncm_bind,
1629 .unbind = cdc_ncm_unbind,
Oliver Neukuma5e40702012-12-18 04:46:12 +00001630 .manage_power = usbnet_manage_power,
Alexey Orishko900d4952010-11-29 23:23:28 +00001631 .status = cdc_ncm_status,
1632 .rx_fixup = cdc_ncm_rx_fixup,
1633 .tx_fixup = cdc_ncm_tx_fixup,
1634};
1635
Dan Williamsf94898e2012-07-24 08:43:22 +00001636/* Same as cdc_ncm_info, but with FLAG_WWAN */
1637static const struct driver_info wwan_info = {
1638 .description = "Mobile Broadband Network Device",
1639 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
Bjørn Mork4d06dd52016-03-07 21:15:36 +01001640 | FLAG_LINK_INTR | FLAG_WWAN,
Dan Williamsf94898e2012-07-24 08:43:22 +00001641 .bind = cdc_ncm_bind,
1642 .unbind = cdc_ncm_unbind,
Oliver Neukuma5e40702012-12-18 04:46:12 +00001643 .manage_power = usbnet_manage_power,
Dan Williamsf94898e2012-07-24 08:43:22 +00001644 .status = cdc_ncm_status,
1645 .rx_fixup = cdc_ncm_rx_fixup,
1646 .tx_fixup = cdc_ncm_tx_fixup,
1647};
1648
Wei Shuai2f62d5a2013-01-21 06:00:32 +00001649/* Same as wwan_info, but with FLAG_NOARP */
1650static const struct driver_info wwan_noarp_info = {
1651 .description = "Mobile Broadband Network Device (NO ARP)",
1652 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
Bjørn Mork4d06dd52016-03-07 21:15:36 +01001653 | FLAG_LINK_INTR | FLAG_WWAN | FLAG_NOARP,
Wei Shuai2f62d5a2013-01-21 06:00:32 +00001654 .bind = cdc_ncm_bind,
1655 .unbind = cdc_ncm_unbind,
Wei Shuai2f62d5a2013-01-21 06:00:32 +00001656 .manage_power = usbnet_manage_power,
1657 .status = cdc_ncm_status,
1658 .rx_fixup = cdc_ncm_rx_fixup,
1659 .tx_fixup = cdc_ncm_tx_fixup,
1660};
1661
Dan Williamsf94898e2012-07-24 08:43:22 +00001662static const struct usb_device_id cdc_devs[] = {
1663 /* Ericsson MBM devices like F5521gw */
1664 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1665 | USB_DEVICE_ID_MATCH_VENDOR,
1666 .idVendor = 0x0bdb,
1667 .bInterfaceClass = USB_CLASS_COMM,
1668 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1669 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1670 .driver_info = (unsigned long) &wwan_info,
1671 },
1672
Daniele Palmas79f42232016-03-31 15:16:47 +02001673 /* Telit LE910 V2 */
1674 { USB_DEVICE_AND_INTERFACE_INFO(0x1bc7, 0x0036,
1675 USB_CLASS_COMM,
1676 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1677 .driver_info = (unsigned long)&wwan_noarp_info,
1678 },
1679
Daniele Palmas670c0d62015-12-18 14:43:33 +01001680 /* DW5812 LTE Verizon Mobile Broadband Card
1681 * Unlike DW5550 this device requires FLAG_NOARP
1682 */
1683 { USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x81bb,
1684 USB_CLASS_COMM,
1685 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1686 .driver_info = (unsigned long)&wwan_noarp_info,
1687 },
1688
Daniele Palmasfb83d5f2015-12-18 14:43:34 +01001689 /* DW5813 LTE AT&T Mobile Broadband Card
1690 * Unlike DW5550 this device requires FLAG_NOARP
1691 */
1692 { USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x81bc,
1693 USB_CLASS_COMM,
1694 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1695 .driver_info = (unsigned long)&wwan_noarp_info,
1696 },
1697
Peter Meiserf3a1ef92012-08-02 02:30:20 +00001698 /* Dell branded MBM devices like DW5550 */
1699 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1700 | USB_DEVICE_ID_MATCH_VENDOR,
1701 .idVendor = 0x413c,
1702 .bInterfaceClass = USB_CLASS_COMM,
1703 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1704 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1705 .driver_info = (unsigned long) &wwan_info,
1706 },
1707
1708 /* Toshiba branded MBM devices */
1709 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1710 | USB_DEVICE_ID_MATCH_VENDOR,
1711 .idVendor = 0x0930,
1712 .bInterfaceClass = USB_CLASS_COMM,
1713 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1714 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1715 .driver_info = (unsigned long) &wwan_info,
1716 },
1717
Bjørn Mork1f84eab2013-02-27 03:08:58 +00001718 /* tag Huawei devices as wwan */
1719 { USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
1720 USB_CLASS_COMM,
1721 USB_CDC_SUBCLASS_NCM,
1722 USB_CDC_PROTO_NONE),
1723 .driver_info = (unsigned long)&wwan_info,
1724 },
1725
Wei Shuai2f62d5a2013-01-21 06:00:32 +00001726 /* Infineon(now Intel) HSPA Modem platform */
1727 { USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
1728 USB_CLASS_COMM,
1729 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1730 .driver_info = (unsigned long)&wwan_noarp_info,
1731 },
1732
Dan Williamsf94898e2012-07-24 08:43:22 +00001733 /* Generic CDC-NCM devices */
1734 { USB_INTERFACE_INFO(USB_CLASS_COMM,
1735 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1736 .driver_info = (unsigned long)&cdc_ncm_info,
1737 },
1738 {
1739 },
1740};
1741MODULE_DEVICE_TABLE(usb, cdc_devs);
1742
Alexey Orishko900d4952010-11-29 23:23:28 +00001743static struct usb_driver cdc_ncm_driver = {
1744 .name = "cdc_ncm",
1745 .id_table = cdc_devs,
Bjørn Mork085e50e2013-11-01 11:16:50 +01001746 .probe = usbnet_probe,
1747 .disconnect = usbnet_disconnect,
Alexey Orishko900d4952010-11-29 23:23:28 +00001748 .suspend = usbnet_suspend,
1749 .resume = usbnet_resume,
Stefan Metzmacher85e3c652011-06-01 02:01:41 +00001750 .reset_resume = usbnet_resume,
Alexey Orishko900d4952010-11-29 23:23:28 +00001751 .supports_autosuspend = 1,
Sarah Sharpe1f12eb2012-04-23 10:08:51 -07001752 .disable_hub_initiated_lpm = 1,
Alexey Orishko900d4952010-11-29 23:23:28 +00001753};
1754
Greg Kroah-Hartmand632eb12011-11-18 09:44:20 -08001755module_usb_driver(cdc_ncm_driver);
Alexey Orishko900d4952010-11-29 23:23:28 +00001756
1757MODULE_AUTHOR("Hans Petter Selasky");
1758MODULE_DESCRIPTION("USB CDC NCM host driver");
1759MODULE_LICENSE("Dual BSD/GPL");