2 * Intel Wireless WiMAX Connection 2400m
3 * Glue with the networking stack
6 * Copyright (C) 2007 Intel Corporation <linux-wimax@intel.com>
7 * Yanir Lubetkin <yanirx.lubetkin@intel.com>
8 * Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License version
12 * 2 as published by the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
25 * This implements an ethernet device for the i2400m.
27 * We fake being an ethernet device to simplify the support from user
28 * space and from the other side. The world is (sadly) configured to
29 * take in only Ethernet devices...
31 * Because of this, when using firmwares <= v1.3, there is an
32 * copy-each-rxed-packet overhead on the RX path. Each IP packet has
33 * to be reallocated to add an ethernet header (as there is no space
34 * in what we get from the device). This is a known drawback and
35 * firmwares >= 1.4 add header space that can be used to insert the
36 * ethernet header without having to reallocate and copy.
38 * TX error handling is tricky; because we have to FIFO/queue the
39 * buffers for transmission (as the hardware likes it aggregated), we
40 * just give the skb to the TX subsystem and by the time it is
41 * transmitted, we have long forgotten about it. So we just don't care
44 * Note that when the device is in idle mode with the basestation, we
45 * need to negotiate coming back up online. That involves negotiation
46 * and possible user space interaction. Thus, we defer to a workqueue
47 * to do all that. By default, we only queue a single packet and drop
48 * the rest, as potentially the time to go back from idle to normal is
53 * i2400m_open Called on ifconfig up
54 * i2400m_stop Called on ifconfig down
56 * i2400m_hard_start_xmit Called by the network stack to send a packet
57 * i2400m_net_wake_tx Wake up device from basestation-IDLE & TX
59 * i2400m_cmd_exit_idle
61 * i2400m_net_tx TX a data frame
64 * i2400m_change_mtu Called on ifconfig mtu XXX
66 * i2400m_tx_timeout Called when the device times out
68 * i2400m_net_rx Called by the RX code when a data frame is
69 * available (firmware <= 1.3)
70 * i2400m_net_erx Called by the RX code when a data frame is
71 * available (firmware >= 1.4).
72 * i2400m_netdev_setup Called to setup all the netdev stuff from
75 #include <linux/if_arp.h>
76 #include <linux/netdevice.h>
77 #include <linux/ethtool.h>
81 #define D_SUBMODULE netdev
82 #include "debug-levels.h"
85 /* netdev interface */
87 * Out of NWG spec (R1_v1.2.2), 3.3.3 ASN Bearer Plane MTU Size
89 * The MTU is 1400 or less
91 I2400M_MAX_MTU = 1400,
92 I2400M_TX_TIMEOUT = HZ,
98 int i2400m_open(struct net_device *net_dev)
101 struct i2400m *i2400m = net_dev_to_i2400m(net_dev);
102 struct device *dev = i2400m_dev(i2400m);
104 d_fnstart(3, dev, "(net_dev %p [i2400m %p])\n", net_dev, i2400m);
105 if (i2400m->ready == 0) {
106 dev_err(dev, "Device is still initializing\n");
110 d_fnend(3, dev, "(net_dev %p [i2400m %p]) = %d\n",
111 net_dev, i2400m, result);
117 int i2400m_stop(struct net_device *net_dev)
119 struct i2400m *i2400m = net_dev_to_i2400m(net_dev);
120 struct device *dev = i2400m_dev(i2400m);
122 d_fnstart(3, dev, "(net_dev %p [i2400m %p])\n", net_dev, i2400m);
123 i2400m_net_wake_stop(i2400m);
124 d_fnend(3, dev, "(net_dev %p [i2400m %p]) = 0\n", net_dev, i2400m);
130 * Wake up the device and transmit a held SKB, then restart the net queue
132 * When the device goes into basestation-idle mode, we need to tell it
133 * to exit that mode; it will negotiate with the base station, user
134 * space may have to intervene to rehandshake crypto and then tell us
135 * when it is ready to transmit the packet we have "queued". Still we
136 * need to give it sometime after it reports being ok.
138 * On error, there is not much we can do. If the error was on TX, we
139 * still wake the queue up to see if the next packet will be luckier.
141 * If _cmd_exit_idle() fails...well, it could be many things; most
142 * commonly it is that something else took the device out of IDLE mode
143 * (for example, the base station). In that case we get an -EILSEQ and
144 * we are just going to ignore that one. If the device is back to
145 * connected, then fine -- if it is someother state, the packet will
148 void i2400m_wake_tx_work(struct work_struct *ws)
151 struct i2400m *i2400m = container_of(ws, struct i2400m, wake_tx_ws);
152 struct device *dev = i2400m_dev(i2400m);
153 struct sk_buff *skb = i2400m->wake_tx_skb;
156 spin_lock_irqsave(&i2400m->tx_lock, flags);
157 skb = i2400m->wake_tx_skb;
158 i2400m->wake_tx_skb = NULL;
159 spin_unlock_irqrestore(&i2400m->tx_lock, flags);
161 d_fnstart(3, dev, "(ws %p i2400m %p skb %p)\n", ws, i2400m, skb);
164 dev_err(dev, "WAKE&TX: skb dissapeared!\n");
167 result = i2400m_cmd_exit_idle(i2400m);
168 if (result == -EILSEQ)
171 dev_err(dev, "WAKE&TX: device didn't get out of idle: "
175 result = wait_event_timeout(i2400m->state_wq,
176 i2400m->state != I2400M_SS_IDLE, 5 * HZ);
180 dev_err(dev, "WAKE&TX: error waiting for device to exit IDLE: "
184 msleep(20); /* device still needs some time or it drops it */
185 result = i2400m_tx(i2400m, skb->data, skb->len, I2400M_PT_DATA);
186 netif_wake_queue(i2400m->wimax_dev.net_dev);
188 kfree_skb(skb); /* refcount transferred by _hard_start_xmit() */
191 d_fnend(3, dev, "(ws %p i2400m %p skb %p) = void [%d]\n",
192 ws, i2400m, skb, result);
197 * Prepare the data payload TX header
199 * The i2400m expects a 4 byte header in front of a data packet.
201 * Because we pretend to be an ethernet device, this packet comes with
202 * an ethernet header. Pull it and push our header.
205 void i2400m_tx_prep_header(struct sk_buff *skb)
207 struct i2400m_pl_data_hdr *pl_hdr;
208 skb_pull(skb, ETH_HLEN);
209 pl_hdr = (struct i2400m_pl_data_hdr *) skb_push(skb, sizeof(*pl_hdr));
210 pl_hdr->reserved = 0;
216 * Cleanup resources acquired during i2400m_net_wake_tx()
218 * This is called by __i2400m_dev_stop and means we have to make sure
219 * the workqueue is flushed from any pending work.
221 void i2400m_net_wake_stop(struct i2400m *i2400m)
223 struct device *dev = i2400m_dev(i2400m);
225 d_fnstart(3, dev, "(i2400m %p)\n", i2400m);
226 /* See i2400m_hard_start_xmit(), references are taken there
227 * and here we release them if the work was still
228 * pending. Note we can't differentiate work not pending vs
229 * never scheduled, so the NULL check does that. */
230 if (cancel_work_sync(&i2400m->wake_tx_ws) == 0
231 && i2400m->wake_tx_skb != NULL) {
233 struct sk_buff *wake_tx_skb;
234 spin_lock_irqsave(&i2400m->tx_lock, flags);
235 wake_tx_skb = i2400m->wake_tx_skb; /* compat help */
236 i2400m->wake_tx_skb = NULL; /* compat help */
237 spin_unlock_irqrestore(&i2400m->tx_lock, flags);
239 kfree_skb(wake_tx_skb);
241 d_fnend(3, dev, "(i2400m %p) = void\n", i2400m);
247 * TX an skb to an idle device
249 * When the device is in basestation-idle mode, we need to wake it up
250 * and then TX. So we queue a work_struct for doing so.
252 * We need to get an extra ref for the skb (so it is not dropped), as
253 * well as be careful not to queue more than one request (won't help
254 * at all). If more than one request comes or there are errors, we
255 * just drop the packets (see i2400m_hard_start_xmit()).
258 int i2400m_net_wake_tx(struct i2400m *i2400m, struct net_device *net_dev,
262 struct device *dev = i2400m_dev(i2400m);
265 d_fnstart(3, dev, "(skb %p net_dev %p)\n", skb, net_dev);
266 if (net_ratelimit()) {
267 d_printf(3, dev, "WAKE&NETTX: "
268 "skb %p sending %d bytes to radio\n",
270 d_dump(4, dev, skb->data, skb->len);
272 /* We hold a ref count for i2400m and skb, so when
273 * stopping() the device, we need to cancel that work
274 * and if pending, release those resources. */
276 spin_lock_irqsave(&i2400m->tx_lock, flags);
277 if (!work_pending(&i2400m->wake_tx_ws)) {
278 netif_stop_queue(net_dev);
280 i2400m->wake_tx_skb = skb_get(skb); /* transfer ref count */
281 i2400m_tx_prep_header(skb);
282 result = schedule_work(&i2400m->wake_tx_ws);
283 WARN_ON(result == 0);
285 spin_unlock_irqrestore(&i2400m->tx_lock, flags);
287 /* Yes, this happens even if we stopped the
288 * queue -- blame the queue disciplines that
289 * queue without looking -- I guess there is a reason
292 d_printf(1, dev, "NETTX: device exiting idle, "
293 "dropping skb %p, queue running %d\n",
294 skb, netif_queue_stopped(net_dev));
297 d_fnend(3, dev, "(skb %p net_dev %p) = %d\n", skb, net_dev, result);
303 * Transmit a packet to the base station on behalf of the network stack.
305 * Returns: 0 if ok, < 0 errno code on error.
307 * We need to pull the ethernet header and add the hardware header,
308 * which is currently set to all zeroes and reserved.
311 int i2400m_net_tx(struct i2400m *i2400m, struct net_device *net_dev,
315 struct device *dev = i2400m_dev(i2400m);
317 d_fnstart(3, dev, "(i2400m %p net_dev %p skb %p)\n",
318 i2400m, net_dev, skb);
319 /* FIXME: check eth hdr, only IPv4 is routed by the device as of now */
320 net_dev->trans_start = jiffies;
321 i2400m_tx_prep_header(skb);
322 d_printf(3, dev, "NETTX: skb %p sending %d bytes to radio\n",
324 d_dump(4, dev, skb->data, skb->len);
325 result = i2400m_tx(i2400m, skb->data, skb->len, I2400M_PT_DATA);
326 d_fnend(3, dev, "(i2400m %p net_dev %p skb %p) = %d\n",
327 i2400m, net_dev, skb, result);
333 * Transmit a packet to the base station on behalf of the network stack
336 * Returns: NETDEV_TX_OK (always, even in case of error)
338 * In case of error, we just drop it. Reasons:
340 * - we add a hw header to each skb, and if the network stack
341 * retries, we have no way to know if that skb has it or not.
343 * - network protocols have their own drop-recovery mechanisms
345 * - there is not much else we can do
347 * If the device is idle, we need to wake it up; that is an operation
348 * that will sleep. See i2400m_net_wake_tx() for details.
351 netdev_tx_t i2400m_hard_start_xmit(struct sk_buff *skb,
352 struct net_device *net_dev)
354 struct i2400m *i2400m = net_dev_to_i2400m(net_dev);
355 struct device *dev = i2400m_dev(i2400m);
358 d_fnstart(3, dev, "(skb %p net_dev %p)\n", skb, net_dev);
359 if (i2400m->state == I2400M_SS_IDLE)
360 result = i2400m_net_wake_tx(i2400m, net_dev, skb);
362 result = i2400m_net_tx(i2400m, net_dev, skb);
364 net_dev->stats.tx_dropped++;
366 net_dev->stats.tx_packets++;
367 net_dev->stats.tx_bytes += skb->len;
371 d_fnend(3, dev, "(skb %p net_dev %p)\n", skb, net_dev);
377 int i2400m_change_mtu(struct net_device *net_dev, int new_mtu)
380 struct i2400m *i2400m = net_dev_to_i2400m(net_dev);
381 struct device *dev = i2400m_dev(i2400m);
383 if (new_mtu >= I2400M_MAX_MTU) {
384 dev_err(dev, "Cannot change MTU to %d (max is %d)\n",
385 new_mtu, I2400M_MAX_MTU);
388 net_dev->mtu = new_mtu;
396 void i2400m_tx_timeout(struct net_device *net_dev)
399 * We might want to kick the device
401 * There is not much we can do though, as the device requires
402 * that we send the data aggregated. By the time we receive
403 * this, there might be data pending to be sent or not...
405 net_dev->stats.tx_errors++;
411 * Create a fake ethernet header
413 * For emulating an ethernet device, every received IP header has to
414 * be prefixed with an ethernet header. Fake it with the given
418 void i2400m_rx_fake_eth_header(struct net_device *net_dev,
419 void *_eth_hdr, __be16 protocol)
421 struct i2400m *i2400m = net_dev_to_i2400m(net_dev);
422 struct ethhdr *eth_hdr = _eth_hdr;
424 memcpy(eth_hdr->h_dest, net_dev->dev_addr, sizeof(eth_hdr->h_dest));
425 memcpy(eth_hdr->h_source, i2400m->src_mac_addr,
426 sizeof(eth_hdr->h_source));
427 eth_hdr->h_proto = protocol;
432 * i2400m_net_rx - pass a network packet to the stack
434 * @i2400m: device instance
435 * @skb_rx: the skb where the buffer pointed to by @buf is
436 * @i: 1 if payload is the only one
437 * @buf: pointer to the buffer containing the data
438 * @len: buffer's length
440 * This is only used now for the v1.3 firmware. It will be deprecated
443 * Note that due to firmware limitations, we don't have space to add
444 * an ethernet header, so we need to copy each packet. Firmware
445 * versions >= v1.4 fix this [see i2400m_net_erx()].
447 * We just clone the skb and set it up so that it's skb->data pointer
448 * points to "buf" and it's length.
450 * Note that if the payload is the last (or the only one) in a
451 * multi-payload message, we don't clone the SKB but just reuse it.
453 * This function is normally run from a thread context. However, we
454 * still use netif_rx() instead of netif_receive_skb() as was
455 * recommended in the mailing list. Reason is in some stress tests
456 * when sending/receiving a lot of data we seem to hit a softlock in
457 * the kernel's TCP implementation [aroudn tcp_delay_timer()]. Using
458 * netif_rx() took care of the issue.
460 * This is, of course, still open to do more research on why running
461 * with netif_receive_skb() hits this softlock. FIXME.
463 * FIXME: currently we don't do any efforts at distinguishing if what
464 * we got was an IPv4 or IPv6 header, to setup the protocol field
467 void i2400m_net_rx(struct i2400m *i2400m, struct sk_buff *skb_rx,
468 unsigned i, const void *buf, int buf_len)
470 struct net_device *net_dev = i2400m->wimax_dev.net_dev;
471 struct device *dev = i2400m_dev(i2400m);
474 d_fnstart(2, dev, "(i2400m %p buf %p buf_len %d)\n",
475 i2400m, buf, buf_len);
477 skb = skb_get(skb_rx);
478 d_printf(2, dev, "RX: reusing first payload skb %p\n", skb);
479 skb_pull(skb, buf - (void *) skb->data);
480 skb_trim(skb, (void *) skb_end_pointer(skb) - buf);
482 /* Yes, this is bad -- a lot of overhead -- see
483 * comments at the top of the file */
484 skb = __netdev_alloc_skb(net_dev, buf_len, GFP_KERNEL);
486 dev_err(dev, "NETRX: no memory to realloc skb\n");
487 net_dev->stats.rx_dropped++;
488 goto error_skb_realloc;
490 memcpy(skb_put(skb, buf_len), buf, buf_len);
492 i2400m_rx_fake_eth_header(i2400m->wimax_dev.net_dev,
493 skb->data - ETH_HLEN,
494 cpu_to_be16(ETH_P_IP));
495 skb_set_mac_header(skb, -ETH_HLEN);
496 skb->dev = i2400m->wimax_dev.net_dev;
497 skb->protocol = htons(ETH_P_IP);
498 net_dev->stats.rx_packets++;
499 net_dev->stats.rx_bytes += buf_len;
500 d_printf(3, dev, "NETRX: receiving %d bytes to network stack\n",
502 d_dump(4, dev, buf, buf_len);
503 netif_rx_ni(skb); /* see notes in function header */
505 d_fnend(2, dev, "(i2400m %p buf %p buf_len %d) = void\n",
506 i2400m, buf, buf_len);
511 * i2400m_net_erx - pass a network packet to the stack (extended version)
513 * @i2400m: device descriptor
514 * @skb: the skb where the packet is - the skb should be set to point
515 * at the IP packet; this function will add ethernet headers if
519 * This is only used now for firmware >= v1.4. Note it is quite
520 * similar to i2400m_net_rx() (used only for v1.3 firmware).
522 * This function is normally run from a thread context. However, we
523 * still use netif_rx() instead of netif_receive_skb() as was
524 * recommended in the mailing list. Reason is in some stress tests
525 * when sending/receiving a lot of data we seem to hit a softlock in
526 * the kernel's TCP implementation [aroudn tcp_delay_timer()]. Using
527 * netif_rx() took care of the issue.
529 * This is, of course, still open to do more research on why running
530 * with netif_receive_skb() hits this softlock. FIXME.
532 void i2400m_net_erx(struct i2400m *i2400m, struct sk_buff *skb,
535 struct net_device *net_dev = i2400m->wimax_dev.net_dev;
536 struct device *dev = i2400m_dev(i2400m);
539 d_fnstart(2, dev, "(i2400m %p skb %p [%u] cs %d)\n",
540 i2400m, skb, skb->len, cs);
542 case I2400M_CS_IPV4_0:
545 i2400m_rx_fake_eth_header(i2400m->wimax_dev.net_dev,
546 skb->data - ETH_HLEN,
547 cpu_to_be16(ETH_P_IP));
548 skb_set_mac_header(skb, -ETH_HLEN);
549 skb->dev = i2400m->wimax_dev.net_dev;
550 skb->protocol = htons(ETH_P_IP);
551 net_dev->stats.rx_packets++;
552 net_dev->stats.rx_bytes += skb->len;
555 dev_err(dev, "ERX: BUG? CS type %u unsupported\n", cs);
559 d_printf(3, dev, "ERX: receiving %d bytes to the network stack\n",
561 d_dump(4, dev, skb->data, skb->len);
562 netif_rx_ni(skb); /* see notes in function header */
564 d_fnend(2, dev, "(i2400m %p skb %p [%u] cs %d) = void\n",
565 i2400m, skb, skb->len, cs);
568 static const struct net_device_ops i2400m_netdev_ops = {
569 .ndo_open = i2400m_open,
570 .ndo_stop = i2400m_stop,
571 .ndo_start_xmit = i2400m_hard_start_xmit,
572 .ndo_tx_timeout = i2400m_tx_timeout,
573 .ndo_change_mtu = i2400m_change_mtu,
576 static void i2400m_get_drvinfo(struct net_device *net_dev,
577 struct ethtool_drvinfo *info)
579 struct i2400m *i2400m = net_dev_to_i2400m(net_dev);
581 strncpy(info->driver, KBUILD_MODNAME, sizeof(info->driver) - 1);
582 strncpy(info->fw_version, i2400m->fw_name, sizeof(info->fw_version) - 1);
583 if (net_dev->dev.parent)
584 strncpy(info->bus_info, dev_name(net_dev->dev.parent),
585 sizeof(info->bus_info) - 1);
588 static const struct ethtool_ops i2400m_ethtool_ops = {
589 .get_drvinfo = i2400m_get_drvinfo,
590 .get_link = ethtool_op_get_link,
594 * i2400m_netdev_setup - Setup setup @net_dev's i2400m private data
596 * Called by alloc_netdev()
598 void i2400m_netdev_setup(struct net_device *net_dev)
600 d_fnstart(3, NULL, "(net_dev %p)\n", net_dev);
601 ether_setup(net_dev);
602 net_dev->mtu = I2400M_MAX_MTU;
603 net_dev->tx_queue_len = I2400M_TX_QLEN;
605 NETIF_F_VLAN_CHALLENGED
608 IFF_NOARP /* i2400m is apure IP device */
609 & (~IFF_BROADCAST /* i2400m is P2P */
611 net_dev->watchdog_timeo = I2400M_TX_TIMEOUT;
612 net_dev->netdev_ops = &i2400m_netdev_ops;
613 net_dev->ethtool_ops = &i2400m_ethtool_ops;
614 d_fnend(3, NULL, "(net_dev %p) = void\n", net_dev);
616 EXPORT_SYMBOL_GPL(i2400m_netdev_setup);