blob: 1eaec648bd1f716db3d06622cdfb7834e64e4e38 [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
Joe Perchesd61e4032018-03-23 15:54:39 -070061module_param(prefer_mbim, bool, 0644);
Bjørn Mork1e8bbe62013-03-14 01:05:13 +000062MODULE_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
Jim Baxtere1069bb2017-06-28 21:35:29 +010092#define CDC_NCM_LOW_MEM_MAX_CNT 10
93
Bjørn Morkbeeecd42014-05-16 21:48:25 +020094static int cdc_ncm_get_sset_count(struct net_device __always_unused *netdev, int sset)
95{
96 switch (sset) {
97 case ETH_SS_STATS:
98 return ARRAY_SIZE(cdc_ncm_gstrings_stats);
99 default:
100 return -EOPNOTSUPP;
101 }
102}
103
104static void cdc_ncm_get_ethtool_stats(struct net_device *netdev,
105 struct ethtool_stats __always_unused *stats,
106 u64 *data)
107{
108 struct usbnet *dev = netdev_priv(netdev);
109 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
110 int i;
111 char *p = NULL;
112
113 for (i = 0; i < ARRAY_SIZE(cdc_ncm_gstrings_stats); i++) {
114 p = (char *)ctx + cdc_ncm_gstrings_stats[i].stat_offset;
115 data[i] = (cdc_ncm_gstrings_stats[i].sizeof_stat == sizeof(u64)) ? *(u64 *)p : *(u32 *)p;
116 }
117}
118
119static void cdc_ncm_get_strings(struct net_device __always_unused *netdev, u32 stringset, u8 *data)
120{
121 u8 *p = data;
122 int i;
123
124 switch (stringset) {
125 case ETH_SS_STATS:
126 for (i = 0; i < ARRAY_SIZE(cdc_ncm_gstrings_stats); i++) {
127 memcpy(p, cdc_ncm_gstrings_stats[i].stat_string, ETH_GSTRING_LEN);
128 p += ETH_GSTRING_LEN;
129 }
130 }
131}
132
Bjørn Mork6c4e5482014-05-16 21:48:22 +0200133static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx);
134
Bjørn Mork6c4e5482014-05-16 21:48:22 +0200135static const struct ethtool_ops cdc_ncm_ethtool_ops = {
Bjørn Mork6c4e5482014-05-16 21:48:22 +0200136 .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,
Philippe Reynesd0b3ab32017-03-16 23:18:50 +0100145 .get_link_ksettings = usbnet_get_link_ksettings,
146 .set_link_ksettings = usbnet_set_link_ksettings,
Bjørn Mork6c4e5482014-05-16 21:48:22 +0200147};
148
Bjørn Mork289507d2014-05-30 09:31:06 +0200149static u32 cdc_ncm_check_rx_max(struct usbnet *dev, u32 new_rx)
Bjørn Mork5aa73d52014-05-16 21:48:18 +0200150{
151 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
Bjørn Mork5aa73d52014-05-16 21:48:18 +0200152 u32 val, max, min;
153
154 /* clamp new_rx to sane values */
155 min = USB_CDC_NCM_NTB_MIN_IN_SIZE;
156 max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_RX, le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
157
158 /* dwNtbInMaxSize spec violation? Use MIN size for both limits */
159 if (max < min) {
160 dev_warn(&dev->intf->dev, "dwNtbInMaxSize=%u is too small. Using %u\n",
161 le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize), min);
162 max = min;
163 }
164
165 val = clamp_t(u32, new_rx, min, max);
Bjørn Mork289507d2014-05-30 09:31:06 +0200166 if (val != new_rx)
167 dev_dbg(&dev->intf->dev, "rx_max must be in the [%u, %u] range\n", min, max);
168
169 return val;
170}
171
172static u32 cdc_ncm_check_tx_max(struct usbnet *dev, u32 new_tx)
173{
174 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
175 u32 val, max, min;
176
177 /* clamp new_tx to sane values */
178 min = ctx->max_datagram_size + ctx->max_ndp_size + sizeof(struct usb_cdc_ncm_nth16);
179 max = min_t(u32, CDC_NCM_NTB_MAX_SIZE_TX, le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
180
181 /* some devices set dwNtbOutMaxSize too low for the above default */
182 min = min(min, max);
183
184 val = clamp_t(u32, new_tx, min, max);
185 if (val != new_tx)
186 dev_dbg(&dev->intf->dev, "tx_max must be in the [%u, %u] range\n", min, max);
187
188 return val;
189}
190
Bjørn Mork39eb7e02014-05-30 09:31:09 +0200191static ssize_t cdc_ncm_show_min_tx_pkt(struct device *d, struct device_attribute *attr, char *buf)
192{
193 struct usbnet *dev = netdev_priv(to_net_dev(d));
194 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
195
196 return sprintf(buf, "%u\n", ctx->min_tx_pkt);
197}
198
Bjørn Mork289507d2014-05-30 09:31:06 +0200199static ssize_t cdc_ncm_show_rx_max(struct device *d, struct device_attribute *attr, char *buf)
200{
201 struct usbnet *dev = netdev_priv(to_net_dev(d));
202 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
203
204 return sprintf(buf, "%u\n", ctx->rx_max);
205}
206
207static ssize_t cdc_ncm_show_tx_max(struct device *d, struct device_attribute *attr, char *buf)
208{
209 struct usbnet *dev = netdev_priv(to_net_dev(d));
210 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
211
212 return sprintf(buf, "%u\n", ctx->tx_max);
213}
214
215static ssize_t cdc_ncm_show_tx_timer_usecs(struct device *d, struct device_attribute *attr, char *buf)
216{
217 struct usbnet *dev = netdev_priv(to_net_dev(d));
218 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
219
220 return sprintf(buf, "%u\n", ctx->timer_interval / (u32)NSEC_PER_USEC);
221}
222
Bjørn Mork39eb7e02014-05-30 09:31:09 +0200223static ssize_t cdc_ncm_store_min_tx_pkt(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
224{
225 struct usbnet *dev = netdev_priv(to_net_dev(d));
226 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
227 unsigned long val;
228
229 /* no need to restrict values - anything from 0 to infinity is OK */
230 if (kstrtoul(buf, 0, &val))
231 return -EINVAL;
232
233 ctx->min_tx_pkt = val;
234 return len;
235}
236
Bjørn Mork289507d2014-05-30 09:31:06 +0200237static ssize_t cdc_ncm_store_rx_max(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
238{
239 struct usbnet *dev = netdev_priv(to_net_dev(d));
240 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
241 unsigned long val;
242
243 if (kstrtoul(buf, 0, &val) || cdc_ncm_check_rx_max(dev, val) != val)
244 return -EINVAL;
245
246 cdc_ncm_update_rxtx_max(dev, val, ctx->tx_max);
247 return len;
248}
249
250static ssize_t cdc_ncm_store_tx_max(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
251{
252 struct usbnet *dev = netdev_priv(to_net_dev(d));
253 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
254 unsigned long val;
255
256 if (kstrtoul(buf, 0, &val) || cdc_ncm_check_tx_max(dev, val) != val)
257 return -EINVAL;
258
259 cdc_ncm_update_rxtx_max(dev, ctx->rx_max, val);
260 return len;
261}
262
263static ssize_t cdc_ncm_store_tx_timer_usecs(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
264{
265 struct usbnet *dev = netdev_priv(to_net_dev(d));
266 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
267 ssize_t ret;
268 unsigned long val;
269
270 ret = kstrtoul(buf, 0, &val);
271 if (ret)
272 return ret;
273 if (val && (val < CDC_NCM_TIMER_INTERVAL_MIN || val > CDC_NCM_TIMER_INTERVAL_MAX))
274 return -EINVAL;
275
276 spin_lock_bh(&ctx->mtx);
277 ctx->timer_interval = val * NSEC_PER_USEC;
278 if (!ctx->timer_interval)
279 ctx->tx_timer_pending = 0;
280 spin_unlock_bh(&ctx->mtx);
281 return len;
282}
283
Joe Perchesd61e4032018-03-23 15:54:39 -0700284static DEVICE_ATTR(min_tx_pkt, 0644, cdc_ncm_show_min_tx_pkt, cdc_ncm_store_min_tx_pkt);
285static DEVICE_ATTR(rx_max, 0644, cdc_ncm_show_rx_max, cdc_ncm_store_rx_max);
286static DEVICE_ATTR(tx_max, 0644, cdc_ncm_show_tx_max, cdc_ncm_store_tx_max);
287static DEVICE_ATTR(tx_timer_usecs, 0644, cdc_ncm_show_tx_timer_usecs, cdc_ncm_store_tx_timer_usecs);
Bjørn Mork289507d2014-05-30 09:31:06 +0200288
Bjørn Mork404814a2015-12-06 22:47:15 +0100289static ssize_t ndp_to_end_show(struct device *d, struct device_attribute *attr, char *buf)
290{
291 struct usbnet *dev = netdev_priv(to_net_dev(d));
292 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
293
294 return sprintf(buf, "%c\n", ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END ? 'Y' : 'N');
295}
296
297static ssize_t ndp_to_end_store(struct device *d, struct device_attribute *attr, const char *buf, size_t len)
298{
299 struct usbnet *dev = netdev_priv(to_net_dev(d));
300 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
301 bool enable;
302
303 if (strtobool(buf, &enable))
304 return -EINVAL;
305
306 /* no change? */
307 if (enable == (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
308 return len;
309
310 if (enable && !ctx->delayed_ndp16) {
311 ctx->delayed_ndp16 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
312 if (!ctx->delayed_ndp16)
313 return -ENOMEM;
314 }
315
316 /* flush pending data before changing flag */
317 netif_tx_lock_bh(dev->net);
318 usbnet_start_xmit(NULL, dev->net);
319 spin_lock_bh(&ctx->mtx);
320 if (enable)
321 ctx->drvflags |= CDC_NCM_FLAG_NDP_TO_END;
322 else
323 ctx->drvflags &= ~CDC_NCM_FLAG_NDP_TO_END;
324 spin_unlock_bh(&ctx->mtx);
325 netif_tx_unlock_bh(dev->net);
326
327 return len;
328}
329static DEVICE_ATTR_RW(ndp_to_end);
330
Bjørn Mork871578c2014-05-30 09:31:08 +0200331#define NCM_PARM_ATTR(name, format, tocpu) \
332static ssize_t cdc_ncm_show_##name(struct device *d, struct device_attribute *attr, char *buf) \
333{ \
334 struct usbnet *dev = netdev_priv(to_net_dev(d)); \
335 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0]; \
336 return sprintf(buf, format "\n", tocpu(ctx->ncm_parm.name)); \
337} \
Joe Perchesd61e4032018-03-23 15:54:39 -0700338static DEVICE_ATTR(name, 0444, cdc_ncm_show_##name, NULL)
Bjørn Mork871578c2014-05-30 09:31:08 +0200339
340NCM_PARM_ATTR(bmNtbFormatsSupported, "0x%04x", le16_to_cpu);
341NCM_PARM_ATTR(dwNtbInMaxSize, "%u", le32_to_cpu);
342NCM_PARM_ATTR(wNdpInDivisor, "%u", le16_to_cpu);
343NCM_PARM_ATTR(wNdpInPayloadRemainder, "%u", le16_to_cpu);
344NCM_PARM_ATTR(wNdpInAlignment, "%u", le16_to_cpu);
345NCM_PARM_ATTR(dwNtbOutMaxSize, "%u", le32_to_cpu);
346NCM_PARM_ATTR(wNdpOutDivisor, "%u", le16_to_cpu);
347NCM_PARM_ATTR(wNdpOutPayloadRemainder, "%u", le16_to_cpu);
348NCM_PARM_ATTR(wNdpOutAlignment, "%u", le16_to_cpu);
349NCM_PARM_ATTR(wNtbOutMaxDatagrams, "%u", le16_to_cpu);
350
Bjørn Mork289507d2014-05-30 09:31:06 +0200351static struct attribute *cdc_ncm_sysfs_attrs[] = {
Bjørn Mork39eb7e02014-05-30 09:31:09 +0200352 &dev_attr_min_tx_pkt.attr,
Bjørn Mork404814a2015-12-06 22:47:15 +0100353 &dev_attr_ndp_to_end.attr,
Bjørn Mork289507d2014-05-30 09:31:06 +0200354 &dev_attr_rx_max.attr,
355 &dev_attr_tx_max.attr,
356 &dev_attr_tx_timer_usecs.attr,
Bjørn Mork871578c2014-05-30 09:31:08 +0200357 &dev_attr_bmNtbFormatsSupported.attr,
358 &dev_attr_dwNtbInMaxSize.attr,
359 &dev_attr_wNdpInDivisor.attr,
360 &dev_attr_wNdpInPayloadRemainder.attr,
361 &dev_attr_wNdpInAlignment.attr,
362 &dev_attr_dwNtbOutMaxSize.attr,
363 &dev_attr_wNdpOutDivisor.attr,
364 &dev_attr_wNdpOutPayloadRemainder.attr,
365 &dev_attr_wNdpOutAlignment.attr,
366 &dev_attr_wNtbOutMaxDatagrams.attr,
Bjørn Mork289507d2014-05-30 09:31:06 +0200367 NULL,
368};
369
Arvind Yadav43f51ef2017-07-18 15:13:45 +0530370static const struct attribute_group cdc_ncm_sysfs_attr_group = {
Bjørn Mork289507d2014-05-30 09:31:06 +0200371 .name = "cdc_ncm",
372 .attrs = cdc_ncm_sysfs_attrs,
373};
374
375/* handle rx_max and tx_max changes */
376static void cdc_ncm_update_rxtx_max(struct usbnet *dev, u32 new_rx, u32 new_tx)
377{
378 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
379 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
380 u32 val;
381
382 val = cdc_ncm_check_rx_max(dev, new_rx);
Bjørn Mork5aa73d52014-05-16 21:48:18 +0200383
384 /* inform device about NTB input size changes */
385 if (val != ctx->rx_max) {
386 __le32 dwNtbInMaxSize = cpu_to_le32(val);
387
388 dev_info(&dev->intf->dev, "setting rx_max = %u\n", val);
Bjørn Mork68864ab2014-05-16 21:48:21 +0200389
Bjørn Mork68864ab2014-05-16 21:48:21 +0200390 /* tell device to use new size */
Bjørn Mork5aa73d52014-05-16 21:48:18 +0200391 if (usbnet_write_cmd(dev, USB_CDC_SET_NTB_INPUT_SIZE,
392 USB_TYPE_CLASS | USB_DIR_OUT
393 | USB_RECIP_INTERFACE,
394 0, iface_no, &dwNtbInMaxSize, 4) < 0)
395 dev_dbg(&dev->intf->dev, "Setting NTB Input Size failed\n");
396 else
397 ctx->rx_max = val;
398 }
399
Bjørn Morkf42763d2014-05-30 09:31:05 +0200400 /* usbnet use these values for sizing rx queues */
401 if (dev->rx_urb_size != ctx->rx_max) {
402 dev->rx_urb_size = ctx->rx_max;
403 if (netif_running(dev->net))
404 usbnet_unlink_rx_urbs(dev);
405 }
406
Bjørn Mork289507d2014-05-30 09:31:06 +0200407 val = cdc_ncm_check_tx_max(dev, new_tx);
Bjørn Mork5aa73d52014-05-16 21:48:18 +0200408 if (val != ctx->tx_max)
409 dev_info(&dev->intf->dev, "setting tx_max = %u\n", val);
Bjørn Mork08c74fc2014-05-16 21:48:20 +0200410
411 /* Adding a pad byte here if necessary simplifies the handling
412 * in cdc_ncm_fill_tx_frame, making tx_max always represent
413 * the real skb max size.
414 *
415 * We cannot use dev->maxpacket here because this is called from
416 * .bind which is called before usbnet sets up dev->maxpacket
417 */
Bjørn Mork68864ab2014-05-16 21:48:21 +0200418 if (val != le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize) &&
419 val % usb_maxpacket(dev->udev, dev->out, 1) == 0)
420 val++;
Bjørn Mork08c74fc2014-05-16 21:48:20 +0200421
Bjørn Mork68864ab2014-05-16 21:48:21 +0200422 /* we might need to flush any pending tx buffers if running */
423 if (netif_running(dev->net) && val > ctx->tx_max) {
424 netif_tx_lock_bh(dev->net);
425 usbnet_start_xmit(NULL, dev->net);
Bjørn Mork1ba5d0f2014-05-30 09:31:04 +0200426 /* make sure tx_curr_skb is reallocated if it was empty */
427 if (ctx->tx_curr_skb) {
428 dev_kfree_skb_any(ctx->tx_curr_skb);
429 ctx->tx_curr_skb = NULL;
430 }
Bjørn Mork68864ab2014-05-16 21:48:21 +0200431 ctx->tx_max = val;
432 netif_tx_unlock_bh(dev->net);
433 } else {
434 ctx->tx_max = val;
435 }
436
Bjørn Mork08c74fc2014-05-16 21:48:20 +0200437 dev->hard_mtu = ctx->tx_max;
Bjørn Mork68864ab2014-05-16 21:48:21 +0200438
439 /* max qlen depend on hard_mtu and rx_urb_size */
440 usbnet_update_max_qlen(dev);
Bjørn Mork43e4c6d2014-05-16 21:48:24 +0200441
442 /* never pad more than 3 full USB packets per transfer */
443 ctx->min_tx_pkt = clamp_t(u16, ctx->tx_max - 3 * usb_maxpacket(dev->udev, dev->out, 1),
444 CDC_NCM_MIN_TX_PKT, ctx->tx_max);
Bjørn Mork5aa73d52014-05-16 21:48:18 +0200445}
446
Bjørn Morkf8afb732014-05-16 21:48:19 +0200447/* helpers for NCM and MBIM differences */
448static u8 cdc_ncm_flags(struct usbnet *dev)
Alexey Orishko900d4952010-11-29 23:23:28 +0000449{
Bjørn Morkbed6f762013-11-01 11:16:42 +0100450 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
Alexey Orishko900d4952010-11-29 23:23:28 +0000451
Bjørn Morkf8afb732014-05-16 21:48:19 +0200452 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
453 return ctx->mbim_desc->bmNetworkCapabilities;
454 if (ctx->func_desc)
455 return ctx->func_desc->bmNetworkCapabilities;
456 return 0;
457}
458
459static int cdc_ncm_eth_hlen(struct usbnet *dev)
460{
461 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
462 return 0;
463 return ETH_HLEN;
464}
465
466static u32 cdc_ncm_min_dgram_size(struct usbnet *dev)
467{
468 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting))
469 return CDC_MBIM_MIN_DATAGRAM_SIZE;
470 return CDC_NCM_MIN_DATAGRAM_SIZE;
471}
472
473static u32 cdc_ncm_max_dgram_size(struct usbnet *dev)
474{
475 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
476
477 if (cdc_ncm_comm_intf_is_mbim(dev->intf->cur_altsetting) && ctx->mbim_desc)
478 return le16_to_cpu(ctx->mbim_desc->wMaxSegmentSize);
479 if (ctx->ether_desc)
480 return le16_to_cpu(ctx->ether_desc->wMaxSegmentSize);
481 return CDC_NCM_MAX_DATAGRAM_SIZE;
482}
483
484/* initial one-time device setup. MUST be called with the data interface
485 * in altsetting 0
486 */
487static int cdc_ncm_init(struct usbnet *dev)
488{
489 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
490 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
491 int err;
Alexey Orishko900d4952010-11-29 23:23:28 +0000492
Ming Lei90b8b032012-10-24 19:46:56 +0000493 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_PARAMETERS,
494 USB_TYPE_CLASS | USB_DIR_IN
495 |USB_RECIP_INTERFACE,
Bjørn Morkff0992e2014-03-17 16:25:18 +0100496 0, iface_no, &ctx->ncm_parm,
497 sizeof(ctx->ncm_parm));
Giuseppe Scrivano36c35412011-08-03 22:10:29 +0000498 if (err < 0) {
Bjørn Mork59ede312013-11-01 11:16:59 +0100499 dev_err(&dev->intf->dev, "failed GET_NTB_PARAMETERS\n");
500 return err; /* GET_NTB_PARAMETERS is required */
Alexey Orishko900d4952010-11-29 23:23:28 +0000501 }
502
Bjørn Morkf8afb732014-05-16 21:48:19 +0200503 /* set CRC Mode */
504 if (cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_CRC_MODE) {
505 dev_dbg(&dev->intf->dev, "Setting CRC mode off\n");
506 err = usbnet_write_cmd(dev, USB_CDC_SET_CRC_MODE,
507 USB_TYPE_CLASS | USB_DIR_OUT
508 | USB_RECIP_INTERFACE,
509 USB_CDC_NCM_CRC_NOT_APPENDED,
510 iface_no, NULL, 0);
511 if (err < 0)
512 dev_err(&dev->intf->dev, "SET_CRC_MODE failed\n");
513 }
514
515 /* set NTB format, if both formats are supported.
516 *
517 * "The host shall only send this command while the NCM Data
518 * Interface is in alternate setting 0."
519 */
Dan Carpenterd22adbf2014-05-22 10:52:29 +0300520 if (le16_to_cpu(ctx->ncm_parm.bmNtbFormatsSupported) &
521 USB_CDC_NCM_NTB32_SUPPORTED) {
Bjørn Morkf8afb732014-05-16 21:48:19 +0200522 dev_dbg(&dev->intf->dev, "Setting NTB format to 16-bit\n");
523 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
524 USB_TYPE_CLASS | USB_DIR_OUT
525 | USB_RECIP_INTERFACE,
526 USB_CDC_NCM_NTB16_FORMAT,
527 iface_no, NULL, 0);
528 if (err < 0)
529 dev_err(&dev->intf->dev, "SET_NTB_FORMAT failed\n");
530 }
531
532 /* set initial device values */
Bjørn Morkff0992e2014-03-17 16:25:18 +0100533 ctx->rx_max = le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize);
534 ctx->tx_max = le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize);
535 ctx->tx_remainder = le16_to_cpu(ctx->ncm_parm.wNdpOutPayloadRemainder);
536 ctx->tx_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutDivisor);
537 ctx->tx_ndp_modulus = le16_to_cpu(ctx->ncm_parm.wNdpOutAlignment);
Alexey Orishko84e77a82011-02-07 09:45:10 +0000538 /* devices prior to NCM Errata shall set this field to zero */
Bjørn Morkff0992e2014-03-17 16:25:18 +0100539 ctx->tx_max_datagrams = le16_to_cpu(ctx->ncm_parm.wNtbOutMaxDatagrams);
Bjørn Mork47175e52013-11-01 11:16:58 +0100540
Bjørn Morkae223cd2013-11-01 11:16:54 +0100541 dev_dbg(&dev->intf->dev,
542 "dwNtbInMaxSize=%u dwNtbOutMaxSize=%u wNdpOutPayloadRemainder=%u wNdpOutDivisor=%u wNdpOutAlignment=%u wNtbOutMaxDatagrams=%u flags=0x%x\n",
543 ctx->rx_max, ctx->tx_max, ctx->tx_remainder, ctx->tx_modulus,
Bjørn Morkf8afb732014-05-16 21:48:19 +0200544 ctx->tx_ndp_modulus, ctx->tx_max_datagrams, cdc_ncm_flags(dev));
Alexey Orishko900d4952010-11-29 23:23:28 +0000545
Alexey Orishko84e77a82011-02-07 09:45:10 +0000546 /* max count of tx datagrams */
547 if ((ctx->tx_max_datagrams == 0) ||
548 (ctx->tx_max_datagrams > CDC_NCM_DPT_DATAGRAMS_MAX))
549 ctx->tx_max_datagrams = CDC_NCM_DPT_DATAGRAMS_MAX;
Alexey Orishko900d4952010-11-29 23:23:28 +0000550
Bjørn Mork70559b82014-05-16 21:48:23 +0200551 /* set up maximum NDP size */
552 ctx->max_ndp_size = sizeof(struct usb_cdc_ncm_ndp16) + (ctx->tx_max_datagrams + 1) * sizeof(struct usb_cdc_ncm_dpe16);
553
Bjørn Mork6c4e5482014-05-16 21:48:22 +0200554 /* initial coalescing timer interval */
555 ctx->timer_interval = CDC_NCM_TIMER_INTERVAL_USEC * NSEC_PER_USEC;
556
Bjørn Morkf8afb732014-05-16 21:48:19 +0200557 return 0;
558}
559
560/* set a new max datagram size */
561static void cdc_ncm_set_dgram_size(struct usbnet *dev, int new_size)
562{
563 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
564 u8 iface_no = ctx->control->cur_altsetting->desc.bInterfaceNumber;
565 __le16 max_datagram_size;
566 u16 mbim_mtu;
567 int err;
568
569 /* set default based on descriptors */
570 ctx->max_datagram_size = clamp_t(u32, new_size,
571 cdc_ncm_min_dgram_size(dev),
572 CDC_NCM_MAX_DATAGRAM_SIZE);
573
574 /* inform the device about the selected Max Datagram Size? */
575 if (!(cdc_ncm_flags(dev) & USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE))
576 goto out;
577
578 /* read current mtu value from device */
579 err = usbnet_read_cmd(dev, USB_CDC_GET_MAX_DATAGRAM_SIZE,
580 USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
581 0, iface_no, &max_datagram_size, 2);
582 if (err < 0) {
583 dev_dbg(&dev->intf->dev, "GET_MAX_DATAGRAM_SIZE failed\n");
584 goto out;
585 }
586
587 if (le16_to_cpu(max_datagram_size) == ctx->max_datagram_size)
588 goto out;
589
590 max_datagram_size = cpu_to_le16(ctx->max_datagram_size);
591 err = usbnet_write_cmd(dev, USB_CDC_SET_MAX_DATAGRAM_SIZE,
592 USB_TYPE_CLASS | USB_DIR_OUT | USB_RECIP_INTERFACE,
593 0, iface_no, &max_datagram_size, 2);
594 if (err < 0)
595 dev_dbg(&dev->intf->dev, "SET_MAX_DATAGRAM_SIZE failed\n");
596
597out:
598 /* set MTU to max supported by the device if necessary */
599 dev->net->mtu = min_t(int, dev->net->mtu, ctx->max_datagram_size - cdc_ncm_eth_hlen(dev));
600
601 /* do not exceed operater preferred MTU */
602 if (ctx->mbim_extended_desc) {
603 mbim_mtu = le16_to_cpu(ctx->mbim_extended_desc->wMTU);
604 if (mbim_mtu != 0 && mbim_mtu < dev->net->mtu)
605 dev->net->mtu = mbim_mtu;
606 }
607}
608
609static void cdc_ncm_fix_modulus(struct usbnet *dev)
610{
611 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
612 u32 val;
Alexey Orishko900d4952010-11-29 23:23:28 +0000613
614 /*
615 * verify that the structure alignment is:
616 * - power of two
617 * - not greater than the maximum transmit length
618 * - not less than four bytes
619 */
620 val = ctx->tx_ndp_modulus;
621
622 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
623 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
Bjørn Morkae223cd2013-11-01 11:16:54 +0100624 dev_dbg(&dev->intf->dev, "Using default alignment: 4 bytes\n");
Alexey Orishko900d4952010-11-29 23:23:28 +0000625 ctx->tx_ndp_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
626 }
627
628 /*
629 * verify that the payload alignment is:
630 * - power of two
631 * - not greater than the maximum transmit length
632 * - not less than four bytes
633 */
634 val = ctx->tx_modulus;
635
636 if ((val < USB_CDC_NCM_NDP_ALIGN_MIN_SIZE) ||
637 (val != ((-val) & val)) || (val >= ctx->tx_max)) {
Bjørn Morkae223cd2013-11-01 11:16:54 +0100638 dev_dbg(&dev->intf->dev, "Using default transmit modulus: 4 bytes\n");
Alexey Orishko900d4952010-11-29 23:23:28 +0000639 ctx->tx_modulus = USB_CDC_NCM_NDP_ALIGN_MIN_SIZE;
640 }
641
642 /* verify the payload remainder */
643 if (ctx->tx_remainder >= ctx->tx_modulus) {
Bjørn Morkae223cd2013-11-01 11:16:54 +0100644 dev_dbg(&dev->intf->dev, "Using default transmit remainder: 0 bytes\n");
Alexey Orishko900d4952010-11-29 23:23:28 +0000645 ctx->tx_remainder = 0;
646 }
647
648 /* adjust TX-remainder according to NCM specification. */
Bjørn Morkf8afb732014-05-16 21:48:19 +0200649 ctx->tx_remainder = ((ctx->tx_remainder - cdc_ncm_eth_hlen(dev)) &
Greg Suarez2d1c4312012-10-22 10:56:30 +0000650 (ctx->tx_modulus - 1));
Bjørn Morkf8afb732014-05-16 21:48:19 +0200651}
Alexey Orishko900d4952010-11-29 23:23:28 +0000652
Bjørn Morkf8afb732014-05-16 21:48:19 +0200653static int cdc_ncm_setup(struct usbnet *dev)
654{
655 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
Bjørn Mork50f1cb12014-05-16 21:48:26 +0200656 u32 def_rx, def_tx;
657
658 /* be conservative when selecting intial buffer size to
659 * increase the number of hosts this will work for
660 */
661 def_rx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_RX,
662 le32_to_cpu(ctx->ncm_parm.dwNtbInMaxSize));
663 def_tx = min_t(u32, CDC_NCM_NTB_DEF_SIZE_TX,
664 le32_to_cpu(ctx->ncm_parm.dwNtbOutMaxSize));
Alexey Orishko900d4952010-11-29 23:23:28 +0000665
Bjørn Morkf8afb732014-05-16 21:48:19 +0200666 /* clamp rx_max and tx_max and inform device */
Bjørn Mork50f1cb12014-05-16 21:48:26 +0200667 cdc_ncm_update_rxtx_max(dev, def_rx, def_tx);
Alexey Orishko84e77a82011-02-07 09:45:10 +0000668
Bjørn Morkf8afb732014-05-16 21:48:19 +0200669 /* sanitize the modulus and remainder values */
670 cdc_ncm_fix_modulus(dev);
Alexey Orishko900d4952010-11-29 23:23:28 +0000671
Bjørn Morkf8afb732014-05-16 21:48:19 +0200672 /* set max datagram size */
673 cdc_ncm_set_dgram_size(dev, cdc_ncm_max_dgram_size(dev));
Alexey Orishko900d4952010-11-29 23:23:28 +0000674 return 0;
675}
676
677static void
Bjørn Morkff1632a2013-11-01 11:16:41 +0100678cdc_ncm_find_endpoints(struct usbnet *dev, struct usb_interface *intf)
Alexey Orishko900d4952010-11-29 23:23:28 +0000679{
Bjørn Morkff1632a2013-11-01 11:16:41 +0100680 struct usb_host_endpoint *e, *in = NULL, *out = NULL;
Alexey Orishko900d4952010-11-29 23:23:28 +0000681 u8 ep;
682
683 for (ep = 0; ep < intf->cur_altsetting->desc.bNumEndpoints; ep++) {
684
685 e = intf->cur_altsetting->endpoint + ep;
686 switch (e->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) {
687 case USB_ENDPOINT_XFER_INT:
688 if (usb_endpoint_dir_in(&e->desc)) {
Bjørn Morkff1632a2013-11-01 11:16:41 +0100689 if (!dev->status)
690 dev->status = e;
Alexey Orishko900d4952010-11-29 23:23:28 +0000691 }
692 break;
693
694 case USB_ENDPOINT_XFER_BULK:
695 if (usb_endpoint_dir_in(&e->desc)) {
Bjørn Morkff1632a2013-11-01 11:16:41 +0100696 if (!in)
697 in = e;
Alexey Orishko900d4952010-11-29 23:23:28 +0000698 } else {
Bjørn Morkff1632a2013-11-01 11:16:41 +0100699 if (!out)
700 out = e;
Alexey Orishko900d4952010-11-29 23:23:28 +0000701 }
702 break;
703
704 default:
705 break;
706 }
707 }
Bjørn Morkff1632a2013-11-01 11:16:41 +0100708 if (in && !dev->in)
709 dev->in = usb_rcvbulkpipe(dev->udev,
710 in->desc.bEndpointAddress &
711 USB_ENDPOINT_NUMBER_MASK);
712 if (out && !dev->out)
713 dev->out = usb_sndbulkpipe(dev->udev,
714 out->desc.bEndpointAddress &
715 USB_ENDPOINT_NUMBER_MASK);
Alexey Orishko900d4952010-11-29 23:23:28 +0000716}
717
718static void cdc_ncm_free(struct cdc_ncm_ctx *ctx)
719{
720 if (ctx == NULL)
721 return;
722
Alexey Orishko900d4952010-11-29 23:23:28 +0000723 if (ctx->tx_rem_skb != NULL) {
724 dev_kfree_skb_any(ctx->tx_rem_skb);
725 ctx->tx_rem_skb = NULL;
726 }
727
728 if (ctx->tx_curr_skb != NULL) {
729 dev_kfree_skb_any(ctx->tx_curr_skb);
730 ctx->tx_curr_skb = NULL;
731 }
732
Enrico Mioso4a0e3e92015-07-08 13:05:57 +0200733 kfree(ctx->delayed_ndp16);
734
Alexey Orishko900d4952010-11-29 23:23:28 +0000735 kfree(ctx);
736}
737
Bjørn Mork1dfddff52015-12-23 13:42:43 +0100738/* we need to override the usbnet change_mtu ndo for two reasons:
739 * - respect the negotiated maximum datagram size
740 * - avoid unwanted changes to rx and tx buffers
741 */
742int cdc_ncm_change_mtu(struct net_device *net, int new_mtu)
743{
744 struct usbnet *dev = netdev_priv(net);
Rafal Redzimski05a56482016-05-19 11:56:09 +0200745
Bjørn Mork1dfddff52015-12-23 13:42:43 +0100746 net->mtu = new_mtu;
Rafal Redzimski05a56482016-05-19 11:56:09 +0200747 cdc_ncm_set_dgram_size(dev, new_mtu + cdc_ncm_eth_hlen(dev));
748
Bjørn Mork1dfddff52015-12-23 13:42:43 +0100749 return 0;
750}
751EXPORT_SYMBOL_GPL(cdc_ncm_change_mtu);
752
753static const struct net_device_ops cdc_ncm_netdev_ops = {
754 .ndo_open = usbnet_open,
755 .ndo_stop = usbnet_stop,
756 .ndo_start_xmit = usbnet_start_xmit,
757 .ndo_tx_timeout = usbnet_tx_timeout,
Greg Ungererc8b5d122017-04-03 15:50:03 +1000758 .ndo_get_stats64 = usbnet_get_stats64,
Bjørn Mork1dfddff52015-12-23 13:42:43 +0100759 .ndo_change_mtu = cdc_ncm_change_mtu,
760 .ndo_set_mac_address = eth_mac_addr,
761 .ndo_validate_addr = eth_validate_addr,
762};
763
Enrico Mioso4a0e3e92015-07-08 13:05:57 +0200764int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting, int drvflags)
Alexey Orishko900d4952010-11-29 23:23:28 +0000765{
766 struct cdc_ncm_ctx *ctx;
767 struct usb_driver *driver;
768 u8 *buf;
769 int len;
770 int temp;
Enrico Mioso2b02c202017-07-11 17:21:52 +0200771 int err;
Alexey Orishko900d4952010-11-29 23:23:28 +0000772 u8 iface_no;
Oliver Neukum77b0a092015-09-07 16:05:39 +0200773 struct usb_cdc_parsed_header hdr;
Bjørn Mork6314dab2017-11-15 09:35:02 +0100774 __le16 curr_ntb_format;
Alexey Orishko900d4952010-11-29 23:23:28 +0000775
Thomas Meyerc7969842011-11-17 12:43:40 +0000776 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
Devendra Naga8f0923c2013-03-29 23:03:22 +0000777 if (!ctx)
778 return -ENOMEM;
Alexey Orishko900d4952010-11-29 23:23:28 +0000779
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +0000780 hrtimer_init(&ctx->tx_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
781 ctx->tx_timer.function = &cdc_ncm_tx_timer_cb;
Bjørn Morkbed6f762013-11-01 11:16:42 +0100782 ctx->bh.data = (unsigned long)dev;
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +0000783 ctx->bh.func = cdc_ncm_txpath_bh;
784 atomic_set(&ctx->stop, 0);
Alexey Orishko900d4952010-11-29 23:23:28 +0000785 spin_lock_init(&ctx->mtx);
Alexey Orishko900d4952010-11-29 23:23:28 +0000786
787 /* store ctx pointer in device data field */
788 dev->data[0] = (unsigned long)ctx;
789
Bjørn Mork9fe02342013-11-01 11:16:48 +0100790 /* only the control interface can be successfully probed */
791 ctx->control = intf;
792
Alexey Orishko900d4952010-11-29 23:23:28 +0000793 /* get some pointers */
794 driver = driver_of(intf);
795 buf = intf->cur_altsetting->extra;
796 len = intf->cur_altsetting->extralen;
797
Alexey Orishko900d4952010-11-29 23:23:28 +0000798 /* parse through descriptors associated with control interface */
Oliver Neukum77b0a092015-09-07 16:05:39 +0200799 cdc_parse_cdc_header(&hdr, intf, buf, len);
Alexey Orishko900d4952010-11-29 23:23:28 +0000800
Bjørn Mork6527f832015-11-23 14:32:10 +0100801 if (hdr.usb_cdc_union_desc)
802 ctx->data = usb_ifnum_to_if(dev->udev,
803 hdr.usb_cdc_union_desc->bSlaveInterface0);
Oliver Neukum77b0a092015-09-07 16:05:39 +0200804 ctx->ether_desc = hdr.usb_cdc_ether_desc;
805 ctx->func_desc = hdr.usb_cdc_ncm_desc;
806 ctx->mbim_desc = hdr.usb_cdc_mbim_desc;
807 ctx->mbim_extended_desc = hdr.usb_cdc_mbim_extended_desc;
Alexey Orishko900d4952010-11-29 23:23:28 +0000808
Bjørn Mork9992c2e2013-01-21 05:50:38 +0000809 /* some buggy devices have an IAD but no CDC Union */
Bjørn Mork6527f832015-11-23 14:32:10 +0100810 if (!hdr.usb_cdc_union_desc && intf->intf_assoc && intf->intf_assoc->bInterfaceCount == 2) {
Bjørn Mork56a666d2013-01-25 23:36:59 +0000811 ctx->data = usb_ifnum_to_if(dev->udev, intf->cur_altsetting->desc.bInterfaceNumber + 1);
812 dev_dbg(&intf->dev, "CDC Union missing - got slave from IAD\n");
Bjørn Mork9992c2e2013-01-21 05:50:38 +0000813 }
814
Alexey Orishko900d4952010-11-29 23:23:28 +0000815 /* check if we got everything */
Bjørn Morkf8afb732014-05-16 21:48:19 +0200816 if (!ctx->data) {
817 dev_dbg(&intf->dev, "CDC Union missing and no IAD found\n");
Alexey Orishko900d4952010-11-29 23:23:28 +0000818 goto error;
Bjørn Mork296e81f2013-11-01 11:17:00 +0100819 }
Bjørn Morkf8afb732014-05-16 21:48:19 +0200820 if (cdc_ncm_comm_intf_is_mbim(intf->cur_altsetting)) {
821 if (!ctx->mbim_desc) {
822 dev_dbg(&intf->dev, "MBIM functional descriptor missing\n");
823 goto error;
824 }
825 } else {
826 if (!ctx->ether_desc || !ctx->func_desc) {
827 dev_dbg(&intf->dev, "NCM or ECM functional descriptors missing\n");
828 goto error;
829 }
830 }
Alexey Orishko900d4952010-11-29 23:23:28 +0000831
Bjørn Morkbbc8d922012-11-13 03:19:43 +0000832 /* claim data interface, if different from control */
833 if (ctx->data != ctx->control) {
834 temp = usb_driver_claim_interface(driver, ctx->data, dev);
Bjørn Mork296e81f2013-11-01 11:17:00 +0100835 if (temp) {
836 dev_dbg(&intf->dev, "failed to claim data intf\n");
Bjørn Morkbbc8d922012-11-13 03:19:43 +0000837 goto error;
Bjørn Mork296e81f2013-11-01 11:17:00 +0100838 }
Bjørn Morkbbc8d922012-11-13 03:19:43 +0000839 }
Alexey Orishko900d4952010-11-29 23:23:28 +0000840
841 iface_no = ctx->data->cur_altsetting->desc.bInterfaceNumber;
842
Daniele Palmas7b8076c2016-12-07 14:07:48 +0100843 /* Device-specific flags */
844 ctx->drvflags = drvflags;
845
Bjørn Mork48906f62016-03-03 22:20:53 +0100846 /* Reset data interface. Some devices will not reset properly
847 * unless they are configured first. Toggle the altsetting to
Daniele Palmas7b8076c2016-12-07 14:07:48 +0100848 * force a reset.
849 * Some other devices do not work properly with this procedure
850 * that can be avoided using quirk CDC_MBIM_FLAG_AVOID_ALTSETTING_TOGGLE
Bjørn Mork48906f62016-03-03 22:20:53 +0100851 */
Daniele Palmas7b8076c2016-12-07 14:07:48 +0100852 if (!(ctx->drvflags & CDC_MBIM_FLAG_AVOID_ALTSETTING_TOGGLE))
853 usb_set_interface(dev->udev, iface_no, data_altsetting);
854
Alexey Orishko900d4952010-11-29 23:23:28 +0000855 temp = usb_set_interface(dev->udev, iface_no, 0);
Bjørn Mork296e81f2013-11-01 11:17:00 +0100856 if (temp) {
857 dev_dbg(&intf->dev, "set interface failed\n");
Alexey Orishko19694ac2011-05-24 05:26:13 +0000858 goto error2;
Bjørn Mork296e81f2013-11-01 11:17:00 +0100859 }
Alexey Orishko900d4952010-11-29 23:23:28 +0000860
Bjørn Mork08c74fc2014-05-16 21:48:20 +0200861 /* initialize basic device settings */
862 if (cdc_ncm_init(dev))
Bjørn Morkff0992e2014-03-17 16:25:18 +0100863 goto error2;
864
Bjørn Morkc086e702016-07-03 22:24:50 +0200865 /* Some firmwares need a pause here or they will silently fail
866 * to set up the interface properly. This value was decided
867 * empirically on a Sierra Wireless MC7455 running 02.08.02.00
868 * firmware.
869 */
870 usleep_range(10000, 20000);
871
Alexey Orishko900d4952010-11-29 23:23:28 +0000872 /* configure data interface */
Greg Suarez38396e42012-10-22 10:56:31 +0000873 temp = usb_set_interface(dev->udev, iface_no, data_altsetting);
Bjørn Mork296e81f2013-11-01 11:17:00 +0100874 if (temp) {
875 dev_dbg(&intf->dev, "set interface failed\n");
Alexey Orishko19694ac2011-05-24 05:26:13 +0000876 goto error2;
Bjørn Mork296e81f2013-11-01 11:17:00 +0100877 }
Alexey Orishko900d4952010-11-29 23:23:28 +0000878
Enrico Mioso2b02c202017-07-11 17:21:52 +0200879 /*
880 * Some Huawei devices have been observed to come out of reset in NDP32 mode.
881 * Let's check if this is the case, and set the device to NDP16 mode again if
882 * needed.
883 */
884 if (ctx->drvflags & CDC_NCM_FLAG_RESET_NTB16) {
885 err = usbnet_read_cmd(dev, USB_CDC_GET_NTB_FORMAT,
886 USB_TYPE_CLASS | USB_DIR_IN | USB_RECIP_INTERFACE,
887 0, iface_no, &curr_ntb_format, 2);
888 if (err < 0) {
889 goto error2;
890 }
891
Bjørn Mork6314dab2017-11-15 09:35:02 +0100892 if (curr_ntb_format == cpu_to_le16(USB_CDC_NCM_NTB32_FORMAT)) {
Enrico Mioso2b02c202017-07-11 17:21:52 +0200893 dev_info(&intf->dev, "resetting NTB format to 16-bit");
894 err = usbnet_write_cmd(dev, USB_CDC_SET_NTB_FORMAT,
895 USB_TYPE_CLASS | USB_DIR_OUT
896 | USB_RECIP_INTERFACE,
897 USB_CDC_NCM_NTB16_FORMAT,
898 iface_no, NULL, 0);
899
900 if (err < 0)
901 goto error2;
902 }
903 }
904
Bjørn Morkff1632a2013-11-01 11:16:41 +0100905 cdc_ncm_find_endpoints(dev, ctx->data);
906 cdc_ncm_find_endpoints(dev, ctx->control);
Bjørn Mork296e81f2013-11-01 11:17:00 +0100907 if (!dev->in || !dev->out || !dev->status) {
908 dev_dbg(&intf->dev, "failed to collect endpoints\n");
Alexey Orishko19694ac2011-05-24 05:26:13 +0000909 goto error2;
Bjørn Mork296e81f2013-11-01 11:17:00 +0100910 }
Alexey Orishko900d4952010-11-29 23:23:28 +0000911
Alexey Orishko900d4952010-11-29 23:23:28 +0000912 usb_set_intfdata(ctx->data, dev);
913 usb_set_intfdata(ctx->control, dev);
Alexey Orishko900d4952010-11-29 23:23:28 +0000914
Greg Suarez38396e42012-10-22 10:56:31 +0000915 if (ctx->ether_desc) {
916 temp = usbnet_get_ethernet_addr(dev, ctx->ether_desc->iMACAddress);
Bjørn Mork296e81f2013-11-01 11:17:00 +0100917 if (temp) {
918 dev_dbg(&intf->dev, "failed to get mac address\n");
Greg Suarez38396e42012-10-22 10:56:31 +0000919 goto error2;
Bjørn Mork296e81f2013-11-01 11:17:00 +0100920 }
921 dev_info(&intf->dev, "MAC-Address: %pM\n", dev->net->dev_addr);
Greg Suarez38396e42012-10-22 10:56:31 +0000922 }
Alexey Orishko900d4952010-11-29 23:23:28 +0000923
Bjørn Mork08c74fc2014-05-16 21:48:20 +0200924 /* finish setting up the device specific data */
925 cdc_ncm_setup(dev);
Bjørn Morkff0992e2014-03-17 16:25:18 +0100926
Enrico Mioso4a0e3e92015-07-08 13:05:57 +0200927 /* Allocate the delayed NDP if needed. */
928 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
929 ctx->delayed_ndp16 = kzalloc(ctx->max_ndp_size, GFP_KERNEL);
930 if (!ctx->delayed_ndp16)
931 goto error2;
932 dev_info(&intf->dev, "NDP will be placed at end of frame for this device.");
933 }
934
Bjørn Mork6c4e5482014-05-16 21:48:22 +0200935 /* override ethtool_ops */
936 dev->net->ethtool_ops = &cdc_ncm_ethtool_ops;
937
Bjørn Mork289507d2014-05-30 09:31:06 +0200938 /* add our sysfs attrs */
939 dev->net->sysfs_groups[0] = &cdc_ncm_sysfs_attr_group;
940
Bjørn Mork1dfddff52015-12-23 13:42:43 +0100941 /* must handle MTU changes */
942 dev->net->netdev_ops = &cdc_ncm_netdev_ops;
Jarod Wilsonf77f0ae2016-10-20 13:55:17 -0400943 dev->net->max_mtu = cdc_ncm_max_dgram_size(dev) - cdc_ncm_eth_hlen(dev);
Bjørn Mork1dfddff52015-12-23 13:42:43 +0100944
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
Daniel Lezcano2aee1672018-06-19 16:14:30 +0200970 hrtimer_cancel(&ctx->tx_timer);
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +0000971
972 tasklet_kill(&ctx->bh);
973
Bjørn Morkbbc8d922012-11-13 03:19:43 +0000974 /* handle devices with combined control and data interface */
975 if (ctx->control == ctx->data)
976 ctx->data = NULL;
977
Alexey Orishko19694ac2011-05-24 05:26:13 +0000978 /* disconnect master --> disconnect slave */
979 if (intf == ctx->control && ctx->data) {
980 usb_set_intfdata(ctx->data, NULL);
Alexey Orishko900d4952010-11-29 23:23:28 +0000981 usb_driver_release_interface(driver, ctx->data);
Alexey Orishko19694ac2011-05-24 05:26:13 +0000982 ctx->data = NULL;
Alexey Orishko900d4952010-11-29 23:23:28 +0000983
Alexey Orishko19694ac2011-05-24 05:26:13 +0000984 } else if (intf == ctx->data && ctx->control) {
985 usb_set_intfdata(ctx->control, NULL);
Alexey Orishko900d4952010-11-29 23:23:28 +0000986 usb_driver_release_interface(driver, ctx->control);
Alexey Orishko19694ac2011-05-24 05:26:13 +0000987 ctx->control = NULL;
Alexey Orishko900d4952010-11-29 23:23:28 +0000988 }
989
Bjørn Mork3e515662013-11-01 11:16:40 +0100990 usb_set_intfdata(intf, NULL);
Alexey Orishko900d4952010-11-29 23:23:28 +0000991 cdc_ncm_free(ctx);
992}
Bjørn Morkc91ce3b2012-10-22 10:56:35 +0000993EXPORT_SYMBOL_GPL(cdc_ncm_unbind);
Alexey Orishko900d4952010-11-29 23:23:28 +0000994
Bjørn Mork50a0ffa2014-05-11 10:47:15 +0200995/* Return the number of the MBIM control interface altsetting iff it
996 * is preferred and available,
Bjørn Mork1e8bbe62013-03-14 01:05:13 +0000997 */
Bjørn Mork50a0ffa2014-05-11 10:47:15 +0200998u8 cdc_ncm_select_altsetting(struct usb_interface *intf)
Greg Suarez38396e42012-10-22 10:56:31 +0000999{
Bjørn Mork1e8bbe62013-03-14 01:05:13 +00001000 struct usb_host_interface *alt;
Greg Suarez38396e42012-10-22 10:56:31 +00001001
Bjørn Morkbd329e12012-10-22 10:56:38 +00001002 /* The MBIM spec defines a NCM compatible default altsetting,
1003 * which we may have matched:
1004 *
1005 * "Functions that implement both NCM 1.0 and MBIM (an
1006 * “NCM/MBIM function”) according to this recommendation
1007 * shall provide two alternate settings for the
1008 * Communication Interface. Alternate setting 0, and the
1009 * associated class and endpoint descriptors, shall be
1010 * constructed according to the rules given for the
1011 * Communication Interface in section 5 of [USBNCM10].
1012 * Alternate setting 1, and the associated class and
1013 * endpoint descriptors, shall be constructed according to
1014 * the rules given in section 6 (USB Device Model) of this
1015 * specification."
Bjørn Morkbd329e12012-10-22 10:56:38 +00001016 */
Bjørn Mork50a0ffa2014-05-11 10:47:15 +02001017 if (intf->num_altsetting < 2)
1018 return intf->cur_altsetting->desc.bAlternateSetting;
1019
1020 if (prefer_mbim) {
Bjørn Mork1e8bbe62013-03-14 01:05:13 +00001021 alt = usb_altnum_to_altsetting(intf, CDC_NCM_COMM_ALTSETTING_MBIM);
Bjørn Mork50a0ffa2014-05-11 10:47:15 +02001022 if (alt && cdc_ncm_comm_intf_is_mbim(alt))
1023 return CDC_NCM_COMM_ALTSETTING_MBIM;
Bjørn Morkf350ca02013-02-13 12:09:52 +00001024 }
Bjørn Mork50a0ffa2014-05-11 10:47:15 +02001025 return CDC_NCM_COMM_ALTSETTING_NCM;
Bjørn Mork1e8bbe62013-03-14 01:05:13 +00001026}
1027EXPORT_SYMBOL_GPL(cdc_ncm_select_altsetting);
1028
1029static int cdc_ncm_bind(struct usbnet *dev, struct usb_interface *intf)
1030{
Bjørn Mork1e8bbe62013-03-14 01:05:13 +00001031 /* MBIM backwards compatible function? */
Bjørn Mork50a0ffa2014-05-11 10:47:15 +02001032 if (cdc_ncm_select_altsetting(intf) != CDC_NCM_COMM_ALTSETTING_NCM)
Bjørn Mork1e8bbe62013-03-14 01:05:13 +00001033 return -ENODEV;
Bjørn Morkbd329e12012-10-22 10:56:38 +00001034
Enrico Mioso4a0e3e92015-07-08 13:05:57 +02001035 /* The NCM data altsetting is fixed, so we hard-coded it.
1036 * Additionally, generic NCM devices are assumed to accept arbitrarily
1037 * placed NDP.
1038 */
Bjørn Mork4d06dd52016-03-07 21:15:36 +01001039 return cdc_ncm_bind_common(dev, intf, CDC_NCM_DATA_ALTSETTING_NCM, 0);
Greg Suarez38396e42012-10-22 10:56:31 +00001040}
1041
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001042static 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 +00001043{
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001044 size_t align = ALIGN(skb->len, modulus) - skb->len + remainder;
1045
1046 if (skb->len + align > max)
1047 align = max - skb->len;
1048 if (align && skb_tailroom(skb) >= align)
Johannes Bergb080db52017-06-16 14:29:19 +02001049 skb_put_zero(skb, align);
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001050}
1051
1052/* return a pointer to a valid struct usb_cdc_ncm_ndp16 of type sign, possibly
1053 * allocating a new one within skb
1054 */
1055static struct usb_cdc_ncm_ndp16 *cdc_ncm_ndp(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign, size_t reserve)
1056{
1057 struct usb_cdc_ncm_ndp16 *ndp16 = NULL;
1058 struct usb_cdc_ncm_nth16 *nth16 = (void *)skb->data;
1059 size_t ndpoffset = le16_to_cpu(nth16->wNdpIndex);
1060
Enrico Mioso4a0e3e92015-07-08 13:05:57 +02001061 /* If NDP should be moved to the end of the NCM package, we can't follow the
1062 * NTH16 header as we would normally do. NDP isn't written to the SKB yet, and
1063 * the wNdpIndex field in the header is actually not consistent with reality. It will be later.
1064 */
Bjørn Morkf8c0cfa2015-12-05 13:01:50 +01001065 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
Enrico Mioso4a0e3e92015-07-08 13:05:57 +02001066 if (ctx->delayed_ndp16->dwSignature == sign)
1067 return ctx->delayed_ndp16;
1068
Bjørn Morkf8c0cfa2015-12-05 13:01:50 +01001069 /* We can only push a single NDP to the end. Return
1070 * NULL to send what we've already got and queue this
1071 * skb for later.
1072 */
1073 else if (ctx->delayed_ndp16->dwSignature)
1074 return NULL;
1075 }
1076
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001077 /* follow the chain of NDPs, looking for a match */
1078 while (ndpoffset) {
1079 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb->data + ndpoffset);
1080 if (ndp16->dwSignature == sign)
1081 return ndp16;
1082 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1083 }
1084
1085 /* align new NDP */
Enrico Mioso4a0e3e92015-07-08 13:05:57 +02001086 if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
Jim Baxtere1069bb2017-06-28 21:35:29 +01001087 cdc_ncm_align_tail(skb, ctx->tx_ndp_modulus, 0, ctx->tx_curr_size);
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001088
1089 /* verify that there is room for the NDP and the datagram (reserve) */
Jim Baxtere1069bb2017-06-28 21:35:29 +01001090 if ((ctx->tx_curr_size - skb->len - reserve) < ctx->max_ndp_size)
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001091 return NULL;
1092
1093 /* link to it */
1094 if (ndp16)
1095 ndp16->wNextNdpIndex = cpu_to_le16(skb->len);
1096 else
1097 nth16->wNdpIndex = cpu_to_le16(skb->len);
1098
1099 /* push a new empty NDP */
Enrico Mioso4a0e3e92015-07-08 13:05:57 +02001100 if (!(ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END))
yuan linyuad941e62017-06-18 22:49:30 +08001101 ndp16 = skb_put_zero(skb, ctx->max_ndp_size);
Enrico Mioso4a0e3e92015-07-08 13:05:57 +02001102 else
1103 ndp16 = ctx->delayed_ndp16;
1104
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001105 ndp16->dwSignature = sign;
1106 ndp16->wLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_ndp16) + sizeof(struct usb_cdc_ncm_dpe16));
1107 return ndp16;
Alexey Orishko900d4952010-11-29 23:23:28 +00001108}
1109
Bjørn Morkc91ce3b2012-10-22 10:56:35 +00001110struct sk_buff *
Bjørn Morkbed6f762013-11-01 11:16:42 +01001111cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign)
Alexey Orishko900d4952010-11-29 23:23:28 +00001112{
Bjørn Morkbed6f762013-11-01 11:16:42 +01001113 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001114 struct usb_cdc_ncm_nth16 *nth16;
1115 struct usb_cdc_ncm_ndp16 *ndp16;
Alexey Orishko900d4952010-11-29 23:23:28 +00001116 struct sk_buff *skb_out;
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001117 u16 n = 0, index, ndplen;
Alexey Orishko84e77a82011-02-07 09:45:10 +00001118 u8 ready2send = 0;
Enrico Mioso4a0e3e92015-07-08 13:05:57 +02001119 u32 delayed_ndp_size;
Jim Baxteraeca3a72017-05-08 13:49:57 +01001120 size_t padding_count;
Enrico Mioso4a0e3e92015-07-08 13:05:57 +02001121
1122 /* When our NDP gets written in cdc_ncm_ndp(), then skb_out->len gets updated
1123 * accordingly. Otherwise, we should check here.
1124 */
1125 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END)
Bjørn Mork49c2c3f2018-06-08 09:15:24 +02001126 delayed_ndp_size = ALIGN(ctx->max_ndp_size, ctx->tx_ndp_modulus);
Enrico Mioso4a0e3e92015-07-08 13:05:57 +02001127 else
1128 delayed_ndp_size = 0;
Alexey Orishko900d4952010-11-29 23:23:28 +00001129
1130 /* if there is a remaining skb, it gets priority */
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001131 if (skb != NULL) {
Alexey Orishko900d4952010-11-29 23:23:28 +00001132 swap(skb, ctx->tx_rem_skb);
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001133 swap(sign, ctx->tx_rem_sign);
1134 } else {
Alexey Orishko84e77a82011-02-07 09:45:10 +00001135 ready2send = 1;
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001136 }
Alexey Orishko900d4952010-11-29 23:23:28 +00001137
1138 /* check if we are resuming an OUT skb */
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001139 skb_out = ctx->tx_curr_skb;
Alexey Orishko900d4952010-11-29 23:23:28 +00001140
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001141 /* allocate a new OUT skb */
1142 if (!skb_out) {
Jim Baxtere1069bb2017-06-28 21:35:29 +01001143 if (ctx->tx_low_mem_val == 0) {
1144 ctx->tx_curr_size = ctx->tx_max;
1145 skb_out = alloc_skb(ctx->tx_curr_size, GFP_ATOMIC);
1146 /* If the memory allocation fails we will wait longer
1147 * each time before attempting another full size
1148 * allocation again to not overload the system
1149 * further.
1150 */
1151 if (skb_out == NULL) {
1152 ctx->tx_low_mem_max_cnt = min(ctx->tx_low_mem_max_cnt + 1,
1153 (unsigned)CDC_NCM_LOW_MEM_MAX_CNT);
1154 ctx->tx_low_mem_val = ctx->tx_low_mem_max_cnt;
Alexey Orishko900d4952010-11-29 23:23:28 +00001155 }
Jim Baxtere1069bb2017-06-28 21:35:29 +01001156 }
1157 if (skb_out == NULL) {
1158 /* See if a very small allocation is possible.
1159 * We will send this packet immediately and hope
1160 * that there is more memory available later.
1161 */
1162 if (skb)
1163 ctx->tx_curr_size = max(skb->len,
1164 (u32)USB_CDC_NCM_NTB_MIN_OUT_SIZE);
1165 else
1166 ctx->tx_curr_size = USB_CDC_NCM_NTB_MIN_OUT_SIZE;
1167 skb_out = alloc_skb(ctx->tx_curr_size, GFP_ATOMIC);
1168
1169 /* No allocation possible so we will abort */
1170 if (skb_out == NULL) {
1171 if (skb != NULL) {
1172 dev_kfree_skb_any(skb);
1173 dev->net->stats.tx_dropped++;
1174 }
1175 goto exit_no_skb;
1176 }
1177 ctx->tx_low_mem_val--;
Alexey Orishko900d4952010-11-29 23:23:28 +00001178 }
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001179 /* fill out the initial 16-bit NTB header */
yuan linyuad941e62017-06-18 22:49:30 +08001180 nth16 = skb_put_zero(skb_out, sizeof(struct usb_cdc_ncm_nth16));
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001181 nth16->dwSignature = cpu_to_le32(USB_CDC_NCM_NTH16_SIGN);
1182 nth16->wHeaderLength = cpu_to_le16(sizeof(struct usb_cdc_ncm_nth16));
1183 nth16->wSequence = cpu_to_le16(ctx->tx_seq++);
Alexey Orishko900d4952010-11-29 23:23:28 +00001184
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001185 /* count total number of frames in this NTB */
Alexey Orishko900d4952010-11-29 23:23:28 +00001186 ctx->tx_curr_frame_num = 0;
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001187
1188 /* recent payload counter for this skb_out */
1189 ctx->tx_curr_frame_payload = 0;
Alexey Orishko900d4952010-11-29 23:23:28 +00001190 }
1191
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001192 for (n = ctx->tx_curr_frame_num; n < ctx->tx_max_datagrams; n++) {
1193 /* send any remaining skb first */
Alexey Orishko900d4952010-11-29 23:23:28 +00001194 if (skb == NULL) {
1195 skb = ctx->tx_rem_skb;
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001196 sign = ctx->tx_rem_sign;
Alexey Orishko900d4952010-11-29 23:23:28 +00001197 ctx->tx_rem_skb = NULL;
1198
1199 /* check for end of skb */
1200 if (skb == NULL)
1201 break;
1202 }
1203
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001204 /* get the appropriate NDP for this skb */
1205 ndp16 = cdc_ncm_ndp(ctx, skb_out, sign, skb->len + ctx->tx_modulus + ctx->tx_remainder);
1206
1207 /* align beginning of next frame */
Jim Baxtere1069bb2017-06-28 21:35:29 +01001208 cdc_ncm_align_tail(skb_out, ctx->tx_modulus, ctx->tx_remainder, ctx->tx_curr_size);
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001209
1210 /* check if we had enough room left for both NDP and frame */
Jim Baxtere1069bb2017-06-28 21:35:29 +01001211 if (!ndp16 || skb_out->len + skb->len + delayed_ndp_size > ctx->tx_curr_size) {
Alexey Orishko900d4952010-11-29 23:23:28 +00001212 if (n == 0) {
1213 /* won't fit, MTU problem? */
1214 dev_kfree_skb_any(skb);
1215 skb = NULL;
Bjørn Morkbed6f762013-11-01 11:16:42 +01001216 dev->net->stats.tx_dropped++;
Alexey Orishko900d4952010-11-29 23:23:28 +00001217 } else {
1218 /* no room for skb - store for later */
1219 if (ctx->tx_rem_skb != NULL) {
1220 dev_kfree_skb_any(ctx->tx_rem_skb);
Bjørn Morkbed6f762013-11-01 11:16:42 +01001221 dev->net->stats.tx_dropped++;
Alexey Orishko900d4952010-11-29 23:23:28 +00001222 }
1223 ctx->tx_rem_skb = skb;
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001224 ctx->tx_rem_sign = sign;
Alexey Orishko900d4952010-11-29 23:23:28 +00001225 skb = NULL;
Alexey Orishko84e77a82011-02-07 09:45:10 +00001226 ready2send = 1;
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001227 ctx->tx_reason_ntb_full++; /* count reason for transmitting */
Alexey Orishko900d4952010-11-29 23:23:28 +00001228 }
1229 break;
1230 }
1231
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001232 /* calculate frame number withing this NDP */
1233 ndplen = le16_to_cpu(ndp16->wLength);
1234 index = (ndplen - sizeof(struct usb_cdc_ncm_ndp16)) / sizeof(struct usb_cdc_ncm_dpe16) - 1;
Alexey Orishko900d4952010-11-29 23:23:28 +00001235
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001236 /* OK, add this skb */
1237 ndp16->dpe16[index].wDatagramLength = cpu_to_le16(skb->len);
1238 ndp16->dpe16[index].wDatagramIndex = cpu_to_le16(skb_out->len);
1239 ndp16->wLength = cpu_to_le16(ndplen + sizeof(struct usb_cdc_ncm_dpe16));
Johannes Berg59ae1d12017-06-16 14:29:20 +02001240 skb_put_data(skb_out, skb->data, skb->len);
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001241 ctx->tx_curr_frame_payload += skb->len; /* count real tx payload data */
Alexey Orishko900d4952010-11-29 23:23:28 +00001242 dev_kfree_skb_any(skb);
1243 skb = NULL;
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001244
1245 /* send now if this NDP is full */
1246 if (index >= CDC_NCM_DPT_DATAGRAMS_MAX) {
1247 ready2send = 1;
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001248 ctx->tx_reason_ndp_full++; /* count reason for transmitting */
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001249 break;
1250 }
Alexey Orishko900d4952010-11-29 23:23:28 +00001251 }
1252
1253 /* free up any dangling skb */
1254 if (skb != NULL) {
1255 dev_kfree_skb_any(skb);
1256 skb = NULL;
Bjørn Morkbed6f762013-11-01 11:16:42 +01001257 dev->net->stats.tx_dropped++;
Alexey Orishko900d4952010-11-29 23:23:28 +00001258 }
1259
1260 ctx->tx_curr_frame_num = n;
1261
1262 if (n == 0) {
1263 /* wait for more frames */
1264 /* push variables */
1265 ctx->tx_curr_skb = skb_out;
Alexey Orishko900d4952010-11-29 23:23:28 +00001266 goto exit_no_skb;
1267
Bjørn Mork6c4e5482014-05-16 21:48:22 +02001268 } else if ((n < ctx->tx_max_datagrams) && (ready2send == 0) && (ctx->timer_interval > 0)) {
Alexey Orishko900d4952010-11-29 23:23:28 +00001269 /* wait for more frames */
1270 /* push variables */
1271 ctx->tx_curr_skb = skb_out;
Alexey Orishko900d4952010-11-29 23:23:28 +00001272 /* set the pending count */
1273 if (n < CDC_NCM_RESTART_TIMER_DATAGRAM_CNT)
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001274 ctx->tx_timer_pending = CDC_NCM_TIMER_PENDING_CNT;
Alexey Orishko900d4952010-11-29 23:23:28 +00001275 goto exit_no_skb;
1276
1277 } else {
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001278 if (n == ctx->tx_max_datagrams)
1279 ctx->tx_reason_max_datagram++; /* count reason for transmitting */
Alexey Orishko900d4952010-11-29 23:23:28 +00001280 /* frame goes out */
1281 /* variables will be reset at next call */
1282 }
1283
Enrico Mioso4a0e3e92015-07-08 13:05:57 +02001284 /* If requested, put NDP at end of frame. */
1285 if (ctx->drvflags & CDC_NCM_FLAG_NDP_TO_END) {
1286 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
Bjørn Mork49c2c3f2018-06-08 09:15:24 +02001287 cdc_ncm_align_tail(skb_out, ctx->tx_ndp_modulus, 0, ctx->tx_curr_size - ctx->max_ndp_size);
Enrico Mioso4a0e3e92015-07-08 13:05:57 +02001288 nth16->wNdpIndex = cpu_to_le16(skb_out->len);
Johannes Berg59ae1d12017-06-16 14:29:20 +02001289 skb_put_data(skb_out, ctx->delayed_ndp16, ctx->max_ndp_size);
Enrico Mioso4a0e3e92015-07-08 13:05:57 +02001290
1291 /* Zero out delayed NDP - signature checking will naturally fail. */
1292 ndp16 = memset(ctx->delayed_ndp16, 0, ctx->max_ndp_size);
1293 }
1294
Bjørn Mork43e4c6d2014-05-16 21:48:24 +02001295 /* If collected data size is less or equal ctx->min_tx_pkt
Bjørn Mork20572222013-11-01 11:16:38 +01001296 * bytes, we send buffers as it is. If we get more data, it
1297 * would be more efficient for USB HS mobile device with DMA
1298 * engine to receive a full size NTB, than canceling DMA
1299 * transfer and receiving a short packet.
Bjørn Mork4d619f62013-11-01 11:16:49 +01001300 *
1301 * This optimization support is pointless if we end up sending
1302 * a ZLP after full sized NTBs.
Alexey Orishko900d4952010-11-29 23:23:28 +00001303 */
Bjørn Mork4d619f62013-11-01 11:16:49 +01001304 if (!(dev->driver_info->flags & FLAG_SEND_ZLP) &&
Jim Baxteraeca3a72017-05-08 13:49:57 +01001305 skb_out->len > ctx->min_tx_pkt) {
Jim Baxtere1069bb2017-06-28 21:35:29 +01001306 padding_count = ctx->tx_curr_size - skb_out->len;
Johannes Bergb080db52017-06-16 14:29:19 +02001307 skb_put_zero(skb_out, padding_count);
Jim Baxtere1069bb2017-06-28 21:35:29 +01001308 } else if (skb_out->len < ctx->tx_curr_size &&
Jim Baxteraeca3a72017-05-08 13:49:57 +01001309 (skb_out->len % dev->maxpacket) == 0) {
Johannes Berg634fef62017-06-16 14:29:24 +02001310 skb_put_u8(skb_out, 0); /* force short packet */
Jim Baxteraeca3a72017-05-08 13:49:57 +01001311 }
Alexey Orishko900d4952010-11-29 23:23:28 +00001312
Bjørn Morkc78b7c52012-10-22 10:56:34 +00001313 /* set final frame length */
1314 nth16 = (struct usb_cdc_ncm_nth16 *)skb_out->data;
1315 nth16->wBlockLength = cpu_to_le16(skb_out->len);
Alexey Orishko900d4952010-11-29 23:23:28 +00001316
1317 /* return skb */
1318 ctx->tx_curr_skb = NULL;
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001319
1320 /* keep private stats: framing overhead and number of NTBs */
1321 ctx->tx_overhead += skb_out->len - ctx->tx_curr_frame_payload;
1322 ctx->tx_ntbs++;
1323
Ben Hutchings7a1e8902015-03-25 21:41:33 +01001324 /* usbnet will count all the framing overhead by default.
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001325 * Adjust the stats so that the tx_bytes counter show real
1326 * payload data instead.
1327 */
Ben Hutchings7a1e8902015-03-25 21:41:33 +01001328 usbnet_set_skb_tx_stats(skb_out, n,
Bjørn Mork44f67312015-05-22 13:15:22 +02001329 (long)ctx->tx_curr_frame_payload - skb_out->len);
Ben Hutchings1e9e39f2015-02-26 19:34:37 +00001330
Alexey Orishko900d4952010-11-29 23:23:28 +00001331 return skb_out;
1332
1333exit_no_skb:
Bjørn Mork046c6592014-05-16 21:48:29 +02001334 /* Start timer, if there is a remaining non-empty skb */
1335 if (ctx->tx_curr_skb != NULL && n > 0)
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001336 cdc_ncm_tx_timeout_start(ctx);
Alexey Orishko900d4952010-11-29 23:23:28 +00001337 return NULL;
1338}
Bjørn Morkc91ce3b2012-10-22 10:56:35 +00001339EXPORT_SYMBOL_GPL(cdc_ncm_fill_tx_frame);
Alexey Orishko900d4952010-11-29 23:23:28 +00001340
1341static void cdc_ncm_tx_timeout_start(struct cdc_ncm_ctx *ctx)
1342{
1343 /* start timer, if not already started */
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001344 if (!(hrtimer_active(&ctx->tx_timer) || atomic_read(&ctx->stop)))
1345 hrtimer_start(&ctx->tx_timer,
Thomas Gleixner8b0e1952016-12-25 12:30:41 +01001346 ctx->timer_interval,
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001347 HRTIMER_MODE_REL);
Alexey Orishko900d4952010-11-29 23:23:28 +00001348}
1349
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001350static enum hrtimer_restart cdc_ncm_tx_timer_cb(struct hrtimer *timer)
Alexey Orishko900d4952010-11-29 23:23:28 +00001351{
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001352 struct cdc_ncm_ctx *ctx =
1353 container_of(timer, struct cdc_ncm_ctx, tx_timer);
Alexey Orishko900d4952010-11-29 23:23:28 +00001354
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001355 if (!atomic_read(&ctx->stop))
1356 tasklet_schedule(&ctx->bh);
1357 return HRTIMER_NORESTART;
1358}
1359
1360static void cdc_ncm_txpath_bh(unsigned long param)
1361{
Bjørn Morkbed6f762013-11-01 11:16:42 +01001362 struct usbnet *dev = (struct usbnet *)param;
1363 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001364
1365 spin_lock_bh(&ctx->mtx);
Alexey Orishko900d4952010-11-29 23:23:28 +00001366 if (ctx->tx_timer_pending != 0) {
1367 ctx->tx_timer_pending--;
Alexey Orishko900d4952010-11-29 23:23:28 +00001368 cdc_ncm_tx_timeout_start(ctx);
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001369 spin_unlock_bh(&ctx->mtx);
Bjørn Morkbed6f762013-11-01 11:16:42 +01001370 } else if (dev->net != NULL) {
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001371 ctx->tx_reason_timeout++; /* count reason for transmitting */
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001372 spin_unlock_bh(&ctx->mtx);
Bjørn Morkbed6f762013-11-01 11:16:42 +01001373 netif_tx_lock_bh(dev->net);
1374 usbnet_start_xmit(NULL, dev->net);
1375 netif_tx_unlock_bh(dev->net);
Bjørn Mork7b1e0cb2012-10-25 21:44:09 +00001376 } else {
1377 spin_unlock_bh(&ctx->mtx);
Alexey Orishkof742aa82011-01-17 07:07:25 +00001378 }
Alexey Orishko900d4952010-11-29 23:23:28 +00001379}
1380
Enrico Mioso2f69702c2013-11-04 09:50:47 +01001381struct sk_buff *
Alexey Orishko900d4952010-11-29 23:23:28 +00001382cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
1383{
1384 struct sk_buff *skb_out;
1385 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
Alexey Orishko900d4952010-11-29 23:23:28 +00001386
1387 /*
1388 * The Ethernet API we are using does not support transmitting
1389 * multiple Ethernet frames in a single call. This driver will
1390 * accumulate multiple Ethernet frames and send out a larger
1391 * USB frame when the USB buffer is full or when a single jiffies
1392 * timeout happens.
1393 */
1394 if (ctx == NULL)
1395 goto error;
1396
Alexey Orishkoc84ff1d2012-03-14 11:26:10 +00001397 spin_lock_bh(&ctx->mtx);
Bjørn Morkbed6f762013-11-01 11:16:42 +01001398 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 +00001399 spin_unlock_bh(&ctx->mtx);
Alexey Orishko900d4952010-11-29 23:23:28 +00001400 return skb_out;
1401
1402error:
1403 if (skb != NULL)
1404 dev_kfree_skb_any(skb);
1405
1406 return NULL;
1407}
Enrico Mioso2f69702c2013-11-04 09:50:47 +01001408EXPORT_SYMBOL_GPL(cdc_ncm_tx_fixup);
Alexey Orishko900d4952010-11-29 23:23:28 +00001409
Bjørn Morkff06ab12012-10-22 10:56:33 +00001410/* verify NTB header and return offset of first NDP, or negative error */
Bjørn Morkc91ce3b2012-10-22 10:56:35 +00001411int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in)
Alexey Orishko900d4952010-11-29 23:23:28 +00001412{
Bjørn Morkae223cd2013-11-01 11:16:54 +01001413 struct usbnet *dev = netdev_priv(skb_in->dev);
Alexey Orishkod5ddb4a2012-03-14 11:26:12 +00001414 struct usb_cdc_ncm_nth16 *nth16;
Bjørn Morkff06ab12012-10-22 10:56:33 +00001415 int len;
1416 int ret = -EINVAL;
Alexey Orishko900d4952010-11-29 23:23:28 +00001417
Alexey Orishko900d4952010-11-29 23:23:28 +00001418 if (ctx == NULL)
1419 goto error;
1420
Alexey Orishkod5ddb4a2012-03-14 11:26:12 +00001421 if (skb_in->len < (sizeof(struct usb_cdc_ncm_nth16) +
1422 sizeof(struct usb_cdc_ncm_ndp16))) {
Bjørn Morkae223cd2013-11-01 11:16:54 +01001423 netif_dbg(dev, rx_err, dev->net, "frame too short\n");
Alexey Orishko900d4952010-11-29 23:23:28 +00001424 goto error;
1425 }
1426
Alexey Orishkod5ddb4a2012-03-14 11:26:12 +00001427 nth16 = (struct usb_cdc_ncm_nth16 *)skb_in->data;
Alexey Orishko900d4952010-11-29 23:23:28 +00001428
Bjørn Mork986e10d2013-11-01 11:16:56 +01001429 if (nth16->dwSignature != cpu_to_le32(USB_CDC_NCM_NTH16_SIGN)) {
Bjørn Mork5448d752013-11-01 11:16:55 +01001430 netif_dbg(dev, rx_err, dev->net,
1431 "invalid NTH16 signature <%#010x>\n",
1432 le32_to_cpu(nth16->dwSignature));
Alexey Orishko900d4952010-11-29 23:23:28 +00001433 goto error;
1434 }
1435
Alexey Orishkod5ddb4a2012-03-14 11:26:12 +00001436 len = le16_to_cpu(nth16->wBlockLength);
1437 if (len > ctx->rx_max) {
Bjørn Morkae223cd2013-11-01 11:16:54 +01001438 netif_dbg(dev, rx_err, dev->net,
1439 "unsupported NTB block length %u/%u\n", len,
1440 ctx->rx_max);
Alexey Orishko900d4952010-11-29 23:23:28 +00001441 goto error;
1442 }
1443
Alexey Orishkod5ddb4a2012-03-14 11:26:12 +00001444 if ((ctx->rx_seq + 1) != le16_to_cpu(nth16->wSequence) &&
Bjørn Morkae223cd2013-11-01 11:16:54 +01001445 (ctx->rx_seq || le16_to_cpu(nth16->wSequence)) &&
1446 !((ctx->rx_seq == 0xffff) && !le16_to_cpu(nth16->wSequence))) {
1447 netif_dbg(dev, rx_err, dev->net,
1448 "sequence number glitch prev=%d curr=%d\n",
1449 ctx->rx_seq, le16_to_cpu(nth16->wSequence));
Alexey Orishkod5ddb4a2012-03-14 11:26:12 +00001450 }
1451 ctx->rx_seq = le16_to_cpu(nth16->wSequence);
1452
Bjørn Morkff06ab12012-10-22 10:56:33 +00001453 ret = le16_to_cpu(nth16->wNdpIndex);
1454error:
1455 return ret;
1456}
Bjørn Morkc91ce3b2012-10-22 10:56:35 +00001457EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_nth16);
Bjørn Morkff06ab12012-10-22 10:56:33 +00001458
1459/* verify NDP header and return number of datagrams, or negative error */
Bjørn Morkc91ce3b2012-10-22 10:56:35 +00001460int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset)
Bjørn Morkff06ab12012-10-22 10:56:33 +00001461{
Bjørn Morkae223cd2013-11-01 11:16:54 +01001462 struct usbnet *dev = netdev_priv(skb_in->dev);
Bjørn Morkff06ab12012-10-22 10:56:33 +00001463 struct usb_cdc_ncm_ndp16 *ndp16;
1464 int ret = -EINVAL;
1465
Bjørn Mork75d67d32012-10-22 10:56:32 +00001466 if ((ndpoffset + sizeof(struct usb_cdc_ncm_ndp16)) > skb_in->len) {
Bjørn Morkae223cd2013-11-01 11:16:54 +01001467 netif_dbg(dev, rx_err, dev->net, "invalid NDP offset <%u>\n",
1468 ndpoffset);
Alexey Orishko900d4952010-11-29 23:23:28 +00001469 goto error;
1470 }
Bjørn Mork75d67d32012-10-22 10:56:32 +00001471 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
Alexey Orishko900d4952010-11-29 23:23:28 +00001472
Alexey Orishkod5ddb4a2012-03-14 11:26:12 +00001473 if (le16_to_cpu(ndp16->wLength) < USB_CDC_NCM_NDP16_LENGTH_MIN) {
Bjørn Morkae223cd2013-11-01 11:16:54 +01001474 netif_dbg(dev, rx_err, dev->net, "invalid DPT16 length <%u>\n",
1475 le16_to_cpu(ndp16->wLength));
Bjørn Morkff06ab12012-10-22 10:56:33 +00001476 goto error;
Alexey Orishko900d4952010-11-29 23:23:28 +00001477 }
1478
Bjørn Morkff06ab12012-10-22 10:56:33 +00001479 ret = ((le16_to_cpu(ndp16->wLength) -
Alexey Orishko900d4952010-11-29 23:23:28 +00001480 sizeof(struct usb_cdc_ncm_ndp16)) /
1481 sizeof(struct usb_cdc_ncm_dpe16));
Bjørn Morkff06ab12012-10-22 10:56:33 +00001482 ret--; /* we process NDP entries except for the last one */
Alexey Orishko900d4952010-11-29 23:23:28 +00001483
Bjørn Morkae223cd2013-11-01 11:16:54 +01001484 if ((sizeof(struct usb_cdc_ncm_ndp16) +
1485 ret * (sizeof(struct usb_cdc_ncm_dpe16))) > skb_in->len) {
1486 netif_dbg(dev, rx_err, dev->net, "Invalid nframes = %d\n", ret);
Bjørn Morkff06ab12012-10-22 10:56:33 +00001487 ret = -EINVAL;
Alexey Orishko900d4952010-11-29 23:23:28 +00001488 }
1489
Bjørn Morkff06ab12012-10-22 10:56:33 +00001490error:
1491 return ret;
1492}
Bjørn Morkc91ce3b2012-10-22 10:56:35 +00001493EXPORT_SYMBOL_GPL(cdc_ncm_rx_verify_ndp16);
Bjørn Morkff06ab12012-10-22 10:56:33 +00001494
Enrico Mioso2f69702c2013-11-04 09:50:47 +01001495int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in)
Bjørn Morkff06ab12012-10-22 10:56:33 +00001496{
1497 struct sk_buff *skb;
1498 struct cdc_ncm_ctx *ctx = (struct cdc_ncm_ctx *)dev->data[0];
1499 int len;
1500 int nframes;
1501 int x;
1502 int offset;
1503 struct usb_cdc_ncm_ndp16 *ndp16;
1504 struct usb_cdc_ncm_dpe16 *dpe16;
1505 int ndpoffset;
1506 int loopcount = 50; /* arbitrary max preventing infinite loop */
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001507 u32 payload = 0;
Bjørn Morkff06ab12012-10-22 10:56:33 +00001508
1509 ndpoffset = cdc_ncm_rx_verify_nth16(ctx, skb_in);
1510 if (ndpoffset < 0)
1511 goto error;
1512
1513next_ndp:
1514 nframes = cdc_ncm_rx_verify_ndp16(skb_in, ndpoffset);
1515 if (nframes < 0)
1516 goto error;
1517
1518 ndp16 = (struct usb_cdc_ncm_ndp16 *)(skb_in->data + ndpoffset);
1519
Bjørn Mork986e10d2013-11-01 11:16:56 +01001520 if (ndp16->dwSignature != cpu_to_le32(USB_CDC_NCM_NDP16_NOCRC_SIGN)) {
Bjørn Mork5448d752013-11-01 11:16:55 +01001521 netif_dbg(dev, rx_err, dev->net,
1522 "invalid DPT16 signature <%#010x>\n",
1523 le32_to_cpu(ndp16->dwSignature));
Bjørn Morkff06ab12012-10-22 10:56:33 +00001524 goto err_ndp;
1525 }
1526 dpe16 = ndp16->dpe16;
Alexey Orishko900d4952010-11-29 23:23:28 +00001527
Alexey Orishkod5ddb4a2012-03-14 11:26:12 +00001528 for (x = 0; x < nframes; x++, dpe16++) {
1529 offset = le16_to_cpu(dpe16->wDatagramIndex);
1530 len = le16_to_cpu(dpe16->wDatagramLength);
Alexey Orishko900d4952010-11-29 23:23:28 +00001531
1532 /*
1533 * CDC NCM ch. 3.7
1534 * All entries after first NULL entry are to be ignored
1535 */
Alexey Orishkod5ddb4a2012-03-14 11:26:12 +00001536 if ((offset == 0) || (len == 0)) {
Alexey Orishko900d4952010-11-29 23:23:28 +00001537 if (!x)
Bjørn Mork75d67d32012-10-22 10:56:32 +00001538 goto err_ndp; /* empty NTB */
Alexey Orishko900d4952010-11-29 23:23:28 +00001539 break;
1540 }
1541
1542 /* sanity checking */
Alexey Orishkod5ddb4a2012-03-14 11:26:12 +00001543 if (((offset + len) > skb_in->len) ||
1544 (len > ctx->rx_max) || (len < ETH_HLEN)) {
Bjørn Morkae223cd2013-11-01 11:16:54 +01001545 netif_dbg(dev, rx_err, dev->net,
1546 "invalid frame detected (ignored) offset[%u]=%u, length=%u, skb=%p\n",
1547 x, offset, len, skb_in);
Alexey Orishko900d4952010-11-29 23:23:28 +00001548 if (!x)
Bjørn Mork75d67d32012-10-22 10:56:32 +00001549 goto err_ndp;
Alexey Orishko900d4952010-11-29 23:23:28 +00001550 break;
1551
1552 } else {
Bjørn Mork1e2c6112014-05-30 09:31:03 +02001553 /* create a fresh copy to reduce truesize */
1554 skb = netdev_alloc_skb_ip_align(dev->net, len);
Jesper Juhl9e567902011-01-13 11:40:11 +00001555 if (!skb)
1556 goto error;
Johannes Berg59ae1d12017-06-16 14:29:20 +02001557 skb_put_data(skb, skb_in->data + offset, len);
Alexey Orishko900d4952010-11-29 23:23:28 +00001558 usbnet_skb_return(dev, skb);
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001559 payload += len; /* count payload bytes in this NTB */
Alexey Orishko900d4952010-11-29 23:23:28 +00001560 }
1561 }
Bjørn Mork75d67d32012-10-22 10:56:32 +00001562err_ndp:
1563 /* are there more NDPs to process? */
1564 ndpoffset = le16_to_cpu(ndp16->wNextNdpIndex);
1565 if (ndpoffset && loopcount--)
1566 goto next_ndp;
1567
Bjørn Morkbeeecd42014-05-16 21:48:25 +02001568 /* update stats */
1569 ctx->rx_overhead += skb_in->len - payload;
1570 ctx->rx_ntbs++;
1571
Alexey Orishko900d4952010-11-29 23:23:28 +00001572 return 1;
1573error:
1574 return 0;
1575}
Enrico Mioso2f69702c2013-11-04 09:50:47 +01001576EXPORT_SYMBOL_GPL(cdc_ncm_rx_fixup);
Alexey Orishko900d4952010-11-29 23:23:28 +00001577
1578static void
Bjørn Morkbed6f762013-11-01 11:16:42 +01001579cdc_ncm_speed_change(struct usbnet *dev,
Alexey Orishko84e77a82011-02-07 09:45:10 +00001580 struct usb_cdc_speed_change *data)
Alexey Orishko900d4952010-11-29 23:23:28 +00001581{
Alexey Orishko84e77a82011-02-07 09:45:10 +00001582 uint32_t rx_speed = le32_to_cpu(data->DLBitRRate);
1583 uint32_t tx_speed = le32_to_cpu(data->ULBitRate);
Alexey Orishko900d4952010-11-29 23:23:28 +00001584
1585 /*
1586 * Currently the USB-NET API does not support reporting the actual
1587 * device speed. Do print it instead.
1588 */
Bjørn Morkf3028c52013-11-01 11:16:44 +01001589 if ((tx_speed > 1000000) && (rx_speed > 1000000)) {
Bjørn Morkae223cd2013-11-01 11:16:54 +01001590 netif_info(dev, link, dev->net,
Bjørn Mork916f7642014-05-16 21:48:27 +02001591 "%u mbit/s downlink %u mbit/s uplink\n",
1592 (unsigned int)(rx_speed / 1000000U),
1593 (unsigned int)(tx_speed / 1000000U));
Bjørn Morkf3028c52013-11-01 11:16:44 +01001594 } else {
Bjørn Morkae223cd2013-11-01 11:16:54 +01001595 netif_info(dev, link, dev->net,
Bjørn Mork916f7642014-05-16 21:48:27 +02001596 "%u kbit/s downlink %u kbit/s uplink\n",
1597 (unsigned int)(rx_speed / 1000U),
1598 (unsigned int)(tx_speed / 1000U));
Alexey Orishko900d4952010-11-29 23:23:28 +00001599 }
1600}
1601
1602static void cdc_ncm_status(struct usbnet *dev, struct urb *urb)
1603{
1604 struct cdc_ncm_ctx *ctx;
1605 struct usb_cdc_notification *event;
1606
1607 ctx = (struct cdc_ncm_ctx *)dev->data[0];
1608
1609 if (urb->actual_length < sizeof(*event))
1610 return;
1611
1612 /* test for split data in 8-byte chunks */
1613 if (test_and_clear_bit(EVENT_STS_SPLIT, &dev->flags)) {
Bjørn Morkbed6f762013-11-01 11:16:42 +01001614 cdc_ncm_speed_change(dev,
Alexey Orishko84e77a82011-02-07 09:45:10 +00001615 (struct usb_cdc_speed_change *)urb->transfer_buffer);
Alexey Orishko900d4952010-11-29 23:23:28 +00001616 return;
1617 }
1618
1619 event = urb->transfer_buffer;
1620
1621 switch (event->bNotificationType) {
1622 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
1623 /*
1624 * According to the CDC NCM specification ch.7.1
1625 * USB_CDC_NOTIFY_NETWORK_CONNECTION notification shall be
1626 * sent by device after USB_CDC_NOTIFY_SPEED_CHANGE.
1627 */
Bjørn Morkae223cd2013-11-01 11:16:54 +01001628 netif_info(dev, link, dev->net,
1629 "network connection: %sconnected\n",
Bjørn Morkfa83dbe2014-05-16 21:48:28 +02001630 !!event->wValue ? "" : "dis");
1631 usbnet_link_change(dev, !!event->wValue, 0);
Alexey Orishko900d4952010-11-29 23:23:28 +00001632 break;
1633
1634 case USB_CDC_NOTIFY_SPEED_CHANGE:
Alexey Orishko84e77a82011-02-07 09:45:10 +00001635 if (urb->actual_length < (sizeof(*event) +
1636 sizeof(struct usb_cdc_speed_change)))
Alexey Orishko900d4952010-11-29 23:23:28 +00001637 set_bit(EVENT_STS_SPLIT, &dev->flags);
1638 else
Bjørn Morkbed6f762013-11-01 11:16:42 +01001639 cdc_ncm_speed_change(dev,
1640 (struct usb_cdc_speed_change *)&event[1]);
Alexey Orishko900d4952010-11-29 23:23:28 +00001641 break;
1642
1643 default:
Bjørn Mork67a36602013-04-08 08:26:23 +00001644 dev_dbg(&dev->udev->dev,
1645 "NCM: unexpected notification 0x%02x!\n",
1646 event->bNotificationType);
Alexey Orishko900d4952010-11-29 23:23:28 +00001647 break;
1648 }
1649}
1650
Alexey Orishko900d4952010-11-29 23:23:28 +00001651static const struct driver_info cdc_ncm_info = {
1652 .description = "CDC NCM",
Bjørn Mork4d06dd52016-03-07 21:15:36 +01001653 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
1654 | FLAG_LINK_INTR,
Alexey Orishko900d4952010-11-29 23:23:28 +00001655 .bind = cdc_ncm_bind,
1656 .unbind = cdc_ncm_unbind,
Oliver Neukuma5e40702012-12-18 04:46:12 +00001657 .manage_power = usbnet_manage_power,
Alexey Orishko900d4952010-11-29 23:23:28 +00001658 .status = cdc_ncm_status,
1659 .rx_fixup = cdc_ncm_rx_fixup,
1660 .tx_fixup = cdc_ncm_tx_fixup,
1661};
1662
Dan Williamsf94898e2012-07-24 08:43:22 +00001663/* Same as cdc_ncm_info, but with FLAG_WWAN */
1664static const struct driver_info wwan_info = {
1665 .description = "Mobile Broadband Network Device",
1666 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
Bjørn Mork4d06dd52016-03-07 21:15:36 +01001667 | FLAG_LINK_INTR | FLAG_WWAN,
Dan Williamsf94898e2012-07-24 08:43:22 +00001668 .bind = cdc_ncm_bind,
1669 .unbind = cdc_ncm_unbind,
Oliver Neukuma5e40702012-12-18 04:46:12 +00001670 .manage_power = usbnet_manage_power,
Dan Williamsf94898e2012-07-24 08:43:22 +00001671 .status = cdc_ncm_status,
1672 .rx_fixup = cdc_ncm_rx_fixup,
1673 .tx_fixup = cdc_ncm_tx_fixup,
1674};
1675
Wei Shuai2f62d5a2013-01-21 06:00:32 +00001676/* Same as wwan_info, but with FLAG_NOARP */
1677static const struct driver_info wwan_noarp_info = {
1678 .description = "Mobile Broadband Network Device (NO ARP)",
1679 .flags = FLAG_POINTTOPOINT | FLAG_NO_SETINT | FLAG_MULTI_PACKET
Bjørn Mork4d06dd52016-03-07 21:15:36 +01001680 | FLAG_LINK_INTR | FLAG_WWAN | FLAG_NOARP,
Wei Shuai2f62d5a2013-01-21 06:00:32 +00001681 .bind = cdc_ncm_bind,
1682 .unbind = cdc_ncm_unbind,
Wei Shuai2f62d5a2013-01-21 06:00:32 +00001683 .manage_power = usbnet_manage_power,
1684 .status = cdc_ncm_status,
1685 .rx_fixup = cdc_ncm_rx_fixup,
1686 .tx_fixup = cdc_ncm_tx_fixup,
1687};
1688
Dan Williamsf94898e2012-07-24 08:43:22 +00001689static const struct usb_device_id cdc_devs[] = {
1690 /* Ericsson MBM devices like F5521gw */
1691 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1692 | USB_DEVICE_ID_MATCH_VENDOR,
1693 .idVendor = 0x0bdb,
1694 .bInterfaceClass = USB_CLASS_COMM,
1695 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1696 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1697 .driver_info = (unsigned long) &wwan_info,
1698 },
1699
Daniele Palmas79f42232016-03-31 15:16:47 +02001700 /* Telit LE910 V2 */
1701 { USB_DEVICE_AND_INTERFACE_INFO(0x1bc7, 0x0036,
1702 USB_CLASS_COMM,
1703 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1704 .driver_info = (unsigned long)&wwan_noarp_info,
1705 },
1706
Daniele Palmas670c0d62015-12-18 14:43:33 +01001707 /* DW5812 LTE Verizon Mobile Broadband Card
1708 * Unlike DW5550 this device requires FLAG_NOARP
1709 */
1710 { USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x81bb,
1711 USB_CLASS_COMM,
1712 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1713 .driver_info = (unsigned long)&wwan_noarp_info,
1714 },
1715
Daniele Palmasfb83d5f2015-12-18 14:43:34 +01001716 /* DW5813 LTE AT&T Mobile Broadband Card
1717 * Unlike DW5550 this device requires FLAG_NOARP
1718 */
1719 { USB_DEVICE_AND_INTERFACE_INFO(0x413c, 0x81bc,
1720 USB_CLASS_COMM,
1721 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1722 .driver_info = (unsigned long)&wwan_noarp_info,
1723 },
1724
Peter Meiserf3a1ef92012-08-02 02:30:20 +00001725 /* Dell branded MBM devices like DW5550 */
1726 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1727 | USB_DEVICE_ID_MATCH_VENDOR,
1728 .idVendor = 0x413c,
1729 .bInterfaceClass = USB_CLASS_COMM,
1730 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1731 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1732 .driver_info = (unsigned long) &wwan_info,
1733 },
1734
1735 /* Toshiba branded MBM devices */
1736 { .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
1737 | USB_DEVICE_ID_MATCH_VENDOR,
1738 .idVendor = 0x0930,
1739 .bInterfaceClass = USB_CLASS_COMM,
1740 .bInterfaceSubClass = USB_CDC_SUBCLASS_NCM,
1741 .bInterfaceProtocol = USB_CDC_PROTO_NONE,
1742 .driver_info = (unsigned long) &wwan_info,
1743 },
1744
Bjørn Mork1f84eab2013-02-27 03:08:58 +00001745 /* tag Huawei devices as wwan */
1746 { USB_VENDOR_AND_INTERFACE_INFO(0x12d1,
1747 USB_CLASS_COMM,
1748 USB_CDC_SUBCLASS_NCM,
1749 USB_CDC_PROTO_NONE),
1750 .driver_info = (unsigned long)&wwan_info,
1751 },
1752
Wei Shuai2f62d5a2013-01-21 06:00:32 +00001753 /* Infineon(now Intel) HSPA Modem platform */
1754 { USB_DEVICE_AND_INTERFACE_INFO(0x1519, 0x0443,
1755 USB_CLASS_COMM,
1756 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1757 .driver_info = (unsigned long)&wwan_noarp_info,
1758 },
1759
Aleksander Morgado3b638f02017-08-25 15:39:16 +02001760 /* u-blox TOBY-L4 */
1761 { USB_DEVICE_AND_INTERFACE_INFO(0x1546, 0x1010,
1762 USB_CLASS_COMM,
1763 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1764 .driver_info = (unsigned long)&wwan_info,
1765 },
1766
Dan Williamsf94898e2012-07-24 08:43:22 +00001767 /* Generic CDC-NCM devices */
1768 { USB_INTERFACE_INFO(USB_CLASS_COMM,
1769 USB_CDC_SUBCLASS_NCM, USB_CDC_PROTO_NONE),
1770 .driver_info = (unsigned long)&cdc_ncm_info,
1771 },
1772 {
1773 },
1774};
1775MODULE_DEVICE_TABLE(usb, cdc_devs);
1776
Alexey Orishko900d4952010-11-29 23:23:28 +00001777static struct usb_driver cdc_ncm_driver = {
1778 .name = "cdc_ncm",
1779 .id_table = cdc_devs,
Bjørn Mork085e50e2013-11-01 11:16:50 +01001780 .probe = usbnet_probe,
1781 .disconnect = usbnet_disconnect,
Alexey Orishko900d4952010-11-29 23:23:28 +00001782 .suspend = usbnet_suspend,
1783 .resume = usbnet_resume,
Stefan Metzmacher85e3c652011-06-01 02:01:41 +00001784 .reset_resume = usbnet_resume,
Alexey Orishko900d4952010-11-29 23:23:28 +00001785 .supports_autosuspend = 1,
Sarah Sharpe1f12eb2012-04-23 10:08:51 -07001786 .disable_hub_initiated_lpm = 1,
Alexey Orishko900d4952010-11-29 23:23:28 +00001787};
1788
Greg Kroah-Hartmand632eb12011-11-18 09:44:20 -08001789module_usb_driver(cdc_ncm_driver);
Alexey Orishko900d4952010-11-29 23:23:28 +00001790
1791MODULE_AUTHOR("Hans Petter Selasky");
1792MODULE_DESCRIPTION("USB CDC NCM host driver");
1793MODULE_LICENSE("Dual BSD/GPL");