2 * Intel Wireless WiMAX Connection 2400m
3 * Declarations for bus-generic internal APIs
6 * Copyright (C) 2007-2008 Intel Corporation. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * * Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
18 * * Neither the name of Intel Corporation nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 * Intel Corporation <linux-wimax@intel.com>
36 * Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
37 * Yanir Lubetkin <yanirx.lubetkin@intel.com>
38 * - Initial implementation
41 * GENERAL DRIVER ARCHITECTURE
43 * The i2400m driver is split in the following two major parts:
45 * - bus specific driver
46 * - bus generic driver (this part)
48 * The bus specific driver sets up stuff specific to the bus the
49 * device is connected to (USB, SDIO, PCI, tam-tam...non-authoritative
50 * nor binding list) which is basically the device-model management
51 * (probe/disconnect, etc), moving data from device to kernel and
52 * back, doing the power saving details and reseting the device.
54 * For details on each bus-specific driver, see it's include file,
57 * The bus-generic functionality break up is:
59 * - Firmware upload: fw.c - takes care of uploading firmware to the
60 * device. bus-specific driver just needs to provides a way to
61 * execute boot-mode commands and to reset the device.
63 * - RX handling: rx.c - receives data from the bus-specific code and
64 * feeds it to the network or WiMAX stack or uses it to modify
65 * the driver state. bus-specific driver only has to receive
66 * frames and pass them to this module.
68 * - TX handling: tx.c - manages the TX FIFO queue and provides means
69 * for the bus-specific TX code to pull data from the FIFO
70 * queue. bus-specific code just pulls frames from this module
71 * to sends them to the device.
73 * - netdev glue: netdev.c - interface with Linux networking
74 * stack. Pass around data frames, and configure when the
75 * device is up and running or shutdown (through ifconfig up /
76 * down). Bus-generic only.
78 * - control ops: control.c - implements various commmands for
79 * controlling the device. bus-generic only.
81 * - device model glue: driver.c - implements helpers for the
82 * device-model glue done by the bus-specific layer
83 * (setup/release the driver resources), turning the device on
84 * and off, handling the device reboots/resets and a few simple
87 * Code is also broken up in linux-glue / device-glue.
89 * Linux glue contains functions that deal mostly with gluing with the
90 * rest of the Linux kernel.
92 * Device-glue are functions that deal mostly with the way the device
93 * does things and talk the device's language.
95 * device-glue code is licensed BSD so other open source OSes can take
96 * it to implement their drivers.
99 * APIs AND HEADER FILES
101 * This bus generic code exports three APIs:
103 * - HDI (host-device interface) definitions common to all busses
104 * (include/linux/wimax/i2400m.h); these can be also used by user
106 * - internal API for the bus-generic code
107 * - external API for the bus-specific drivers
112 * When the bus-specific driver probes, it allocates a network device
113 * with enough space for it's data structue, that must contain a
114 * &struct i2400m at the top.
116 * On probe, it needs to fill the i2400m members marked as [fill], as
117 * well as i2400m->wimax_dev.net_dev and call i2400m_setup(). The
118 * i2400m driver will only register with the WiMAX and network stacks;
119 * the only access done to the device is to read the MAC address so we
120 * can register a network device.
122 * The high-level call flow is:
126 * i2400m->bus_setup()
127 * boot rom initialization / read mac addr
128 * network / WiMAX stacks registration
130 * i2400m->bus_dev_start()
131 * i2400m_dev_initialize()
133 * The reverse applies for a disconnect() call:
138 * i2400m_dev_shutdown()
139 * i2400m->bus_dev_stop()
140 * network / WiMAX stack unregistration
141 * i2400m->bus_release()
143 * At this point, control and data communications are possible.
145 * While the device is up, it might reset. The bus-specific driver has
146 * to catch that situation and call i2400m_dev_reset_handle() to deal
147 * with it (reset the internal driver structures and go back to square
154 #include <linux/usb.h>
155 #include <linux/netdevice.h>
156 #include <linux/completion.h>
157 #include <linux/rwsem.h>
158 #include <asm/atomic.h>
159 #include <net/wimax.h>
160 #include <linux/wimax/i2400m.h>
161 #include <asm/byteorder.h>
164 /* netdev interface */
166 * Out of NWG spec (R1_v1.2.2), 3.3.3 ASN Bearer Plane MTU Size
168 * The MTU is 1400 or less
170 I2400M_MAX_MTU = 1400,
175 /* Size of the Boot Mode Command buffer */
176 I2400M_BM_CMD_BUF_SIZE = 16 * 1024,
177 I2400M_BM_ACK_BUF_SIZE = 256,
181 * struct i2400m_poke_table - Hardware poke table for the Intel 2400m
183 * This structure will be used to create a device specific poke table
184 * to put the device in a consistant state at boot time.
186 * @address: The device address to poke
188 * @data: The data value to poke to the device address
191 struct i2400m_poke_table{
196 #define I2400M_FW_POKE(a, d) { \
197 .address = cpu_to_le32(a), \
198 .data = cpu_to_le32(d) \
203 * i2400m_reset_type - methods to reset a device
205 * @I2400M_RT_WARM: Reset without device disconnection, device handles
206 * are kept valid but state is back to power on, with firmware
208 * @I2400M_RT_COLD: Tell the device to disconnect itself from the bus
209 * and reconnect. Renders all device handles invalid.
210 * @I2400M_RT_BUS: Tells the bus to reset the device; last measure
211 * used when both types above don't work.
213 enum i2400m_reset_type {
214 I2400M_RT_WARM, /* first measure */
215 I2400M_RT_COLD, /* second measure */
216 I2400M_RT_BUS, /* call in artillery */
219 struct i2400m_reset_ctx;
221 struct i2400m_barker_db;
224 * struct i2400m - descriptor for an Intel 2400m
226 * Members marked with [fill] must be filled out/initialized before
227 * calling i2400m_setup().
229 * Note the @bus_setup/@bus_release, @bus_dev_start/@bus_dev_release
230 * call pairs are very much doing almost the same, and depending on
231 * the underlying bus, some stuff has to be put in one or the
232 * other. The idea of setup/release is that they setup the minimal
233 * amount needed for loading firmware, where us dev_start/stop setup
234 * the rest needed to do full data/control traffic.
236 * @bus_tx_block_size: [fill] SDIO imposes a 256 block size, USB 16,
237 * so we have a tx_blk_size variable that the bus layer sets to
238 * tell the engine how much of that we need.
240 * @bus_pl_size_max: [fill] Maximum payload size.
242 * @bus_setup: [optional fill] Function called by the bus-generic code
243 * [i2400m_setup()] to setup the basic bus-specific communications
244 * to the the device needed to load firmware. See LIFE CYCLE above.
246 * NOTE: Doesn't need to upload the firmware, as that is taken
247 * care of by the bus-generic code.
249 * @bus_release: [optional fill] Function called by the bus-generic
250 * code [i2400m_release()] to shutdown the basic bus-specific
251 * communications to the the device needed to load firmware. See
254 * This function does not need to reset the device, just tear down
255 * all the host resources created to handle communication with
258 * @bus_dev_start: [optional fill] Function called by the bus-generic
259 * code [i2400m_dev_start()] to do things needed to start the
260 * device. See LIFE CYCLE above.
262 * NOTE: Doesn't need to upload the firmware, as that is taken
263 * care of by the bus-generic code.
265 * @bus_dev_stop: [optional fill] Function called by the bus-generic
266 * code [i2400m_dev_stop()] to do things needed for stopping the
267 * device. See LIFE CYCLE above.
269 * This function does not need to reset the device, just tear down
270 * all the host resources created to handle communication with
273 * @bus_tx_kick: [fill] Function called by the bus-generic code to let
274 * the bus-specific code know that there is data available in the
275 * TX FIFO for transmission to the device.
277 * This function cannot sleep.
279 * @bus_reset: [fill] Function called by the bus-generic code to reset
280 * the device in in various ways. Doesn't need to wait for the
283 * If warm or cold reset fail, this function is expected to do a
284 * bus-specific reset (eg: USB reset) to get the device to a
285 * working state (even if it implies device disconecction).
287 * Note the warm reset is used by the firmware uploader to
288 * reinitialize the device.
290 * IMPORTANT: this is called very early in the device setup
291 * process, so it cannot rely on common infrastructure being laid
294 * IMPORTANT: don't call reset on RT_BUS with i2400m->init_mutex
295 * held, as the .pre/.post reset handlers will deadlock.
297 * @bus_bm_retries: [fill] How many times shall a firmware upload /
298 * device initialization be retried? Different models of the same
299 * device might need different values, hence it is set by the
300 * bus-specific driver. Note this value is used in two places,
301 * i2400m_fw_dnload() and __i2400m_dev_start(); they won't become
302 * multiplicative (__i2400m_dev_start() calling N times
303 * i2400m_fw_dnload() and this trying N times to download the
304 * firmware), as if __i2400m_dev_start() only retries if the
305 * firmware crashed while initializing the device (not in a
308 * @bus_bm_cmd_send: [fill] Function called to send a boot-mode
309 * command. Flags are defined in 'enum i2400m_bm_cmd_flags'. This
310 * is synchronous and has to return 0 if ok or < 0 errno code in
311 * any error condition.
313 * @bus_bm_wait_for_ack: [fill] Function called to wait for a
314 * boot-mode notification (that can be a response to a previously
315 * issued command or an asynchronous one). Will read until all the
316 * indicated size is read or timeout. Reading more or less data
317 * than asked for is an error condition. Return 0 if ok, < 0 errno
320 * The caller to this function will check if the response is a
321 * barker that indicates the device going into reset mode.
323 * @bus_fw_names: [fill] a NULL-terminated array with the names of the
324 * firmware images to try loading. This is made a list so we can
325 * support backward compatibility of firmware releases (eg: if we
326 * can't find the default v1.4, we try v1.3). In general, the name
327 * should be i2400m-fw-X-VERSION.sbcf, where X is the bus name.
328 * The list is tried in order and the first one that loads is
329 * used. The fw loader will set i2400m->fw_name to point to the
330 * active firmware image.
332 * @bus_bm_mac_addr_impaired: [fill] Set to true if the device's MAC
333 * address provided in boot mode is kind of broken and needs to
334 * be re-read later on.
336 * @bus_bm_pokes_table: [fill/optional] A table of device addresses
337 * and values that will be poked at device init time to move the
338 * device to the correct state for the type of boot/firmware being
339 * used. This table MUST be terminated with (0x000000,
340 * 0x00000000) or bad things will happen.
343 * @wimax_dev: WiMAX generic device for linkage into the kernel WiMAX
344 * stack. Due to the way a net_device is allocated, we need to
345 * force this to be the first field so that we can get from
346 * netdev_priv() the right pointer.
348 * @updown: the device is up and ready for transmitting control and
349 * data packets. This implies @ready (communication infrastructure
350 * with the device is ready) and the device's firmware has been
351 * loaded and the device initialized.
353 * Write to it only inside a i2400m->init_mutex protected area
354 * followed with a wmb(); rmb() before accesing (unless locked
355 * inside i2400m->init_mutex). Read access can be loose like that
356 * [just using rmb()] because the paths that use this also do
357 * other error checks later on.
359 * @ready: Communication infrastructure with the device is ready, data
360 * frames can start to be passed around (this is lighter than
361 * using the WiMAX state for certain hot paths).
363 * Write to it only inside a i2400m->init_mutex protected area
364 * followed with a wmb(); rmb() before accesing (unless locked
365 * inside i2400m->init_mutex). Read access can be loose like that
366 * [just using rmb()] because the paths that use this also do
367 * other error checks later on.
369 * @rx_reorder: 1 if RX reordering is enabled; this can only be
372 * @state: device's state (as reported by it)
374 * @state_wq: waitqueue that is woken up whenever the state changes
376 * @tx_lock: spinlock to protect TX members
378 * @tx_buf: FIFO buffer for TX; we queue data here
380 * @tx_in: FIFO index for incoming data. Note this doesn't wrap around
381 * and it is always greater than @tx_out.
383 * @tx_out: FIFO index for outgoing data
385 * @tx_msg: current TX message that is active in the FIFO for
386 * appending payloads.
388 * @tx_sequence: current sequence number for TX messages from the
389 * device to the host.
391 * @tx_msg_size: size of the current message being transmitted by the
394 * @tx_pl_num: total number of payloads sent
396 * @tx_pl_max: maximum number of payloads sent in a TX message
398 * @tx_pl_min: minimum number of payloads sent in a TX message
400 * @tx_num: number of TX messages sent
402 * @tx_size_acc: number of bytes in all TX messages sent
403 * (this is different to net_dev's statistics as it also counts
406 * @tx_size_min: smallest TX message sent.
408 * @tx_size_max: biggest TX message sent.
410 * @rx_lock: spinlock to protect RX members
412 * @rx_pl_num: total number of payloads received
414 * @rx_pl_max: maximum number of payloads received in a RX message
416 * @rx_pl_min: minimum number of payloads received in a RX message
418 * @rx_num: number of RX messages received
420 * @rx_size_acc: number of bytes in all RX messages received
421 * (this is different to net_dev's statistics as it also counts
424 * @rx_size_min: smallest RX message received.
426 * @rx_size_max: buggest RX message received.
428 * @rx_roq: RX ReOrder queues. (fw >= v1.4) When packets are received
429 * out of order, the device will ask the driver to hold certain
430 * packets until the ones that are received out of order can be
431 * delivered. Then the driver can release them to the host. See
432 * drivers/net/i2400m/rx.c for details.
434 * @rx_reports: reports received from the device that couldn't be
435 * processed because the driver wasn't still ready; when ready,
436 * they are pulled from here and chewed.
438 * @rx_reports_ws: Work struct used to kick a scan of the RX reports
439 * list and to process each.
441 * @src_mac_addr: MAC address used to make ethernet packets be coming
442 * from. This is generated at i2400m_setup() time and used during
443 * the life cycle of the instance. See i2400m_fake_eth_header().
445 * @init_mutex: Mutex used for serializing the device bringup
446 * sequence; this way if the device reboots in the middle, we
447 * don't try to do a bringup again while we are tearing down the
450 * Can't reuse @msg_mutex because from within the bringup sequence
451 * we need to send messages to the device and thus use @msg_mutex.
453 * @msg_mutex: mutex used to send control commands to the device (we
454 * only allow one at a time, per host-device interface design).
456 * @msg_completion: used to wait for an ack to a control command sent
459 * @ack_skb: used to store the actual ack to a control command if the
460 * reception of the command was successful. Otherwise, a ERR_PTR()
461 * errno code that indicates what failed with the ack reception.
463 * Only valid after @msg_completion is woken up. Only updateable
464 * if @msg_completion is armed. Only touched by
465 * i2400m_msg_to_dev().
467 * Protected by @rx_lock. In theory the command execution flow is
468 * sequential, but in case the device sends an out-of-phase or
469 * very delayed response, we need to avoid it trampling current
472 * @bm_cmd_buf: boot mode command buffer for composing firmware upload
475 * USB can't r/w to stack, vmalloc, etc...as well, we end up
476 * having to alloc/free a lot to compose commands, so we use these
477 * for stagging and not having to realloc all the time.
479 * This assumes the code always runs serialized. Only one thread
480 * can call i2400m_bm_cmd() at the same time.
482 * @bm_ack_buf: boot mode acknoledge buffer for staging reception of
483 * responses to commands.
487 * @work_queue: work queue for processing device reports. This
488 * workqueue cannot be used for processing TX or RX to the device,
489 * as from it we'll process device reports, which might require
490 * further communication with the device.
492 * @debugfs_dentry: hookup for debugfs files.
493 * These have to be in a separate directory, a child of
494 * (wimax_dev->debugfs_dentry) so they can be removed when the
495 * module unloads, as we don't keep each dentry.
497 * @fw_name: name of the firmware image that is currently being used.
499 * @fw_version: version of the firmware interface, Major.minor,
500 * encoded in the high word and low word (major << 16 | minor).
502 * @fw_hdrs: NULL terminated array of pointers to the firmware
503 * headers. This is only available during firmware load time.
505 * @fw_cached: Used to cache firmware when the system goes to
506 * suspend/standby/hibernation (as on resume we can't read it). If
507 * NULL, no firmware was cached, read it. If ~0, you can't read
508 * any firmware files (the system still didn't come out of suspend
509 * and failed to cache one), so abort; otherwise, a valid cached
510 * firmware to be used. Access to this variable is protected by
511 * the spinlock i2400m->rx_lock.
513 * @barker: barker type that the device uses; this is initialized by
514 * i2400m_is_boot_barker() the first time it is called. Then it
515 * won't change during the life cycle of the device and everytime
516 * a boot barker is received, it is just verified for it being the
519 * @pm_notifier: used to register for PM events
522 struct wimax_dev wimax_dev; /* FIRST! See doc */
524 unsigned updown:1; /* Network device is up or down */
525 unsigned boot_mode:1; /* is the device in boot mode? */
526 unsigned sboot:1; /* signed or unsigned fw boot */
527 unsigned ready:1; /* Device comm infrastructure ready */
528 unsigned rx_reorder:1; /* RX reorder is enabled */
529 u8 trace_msg_from_user; /* echo rx msgs to 'trace' pipe */
530 /* typed u8 so /sys/kernel/debug/u8 can tweak */
531 enum i2400m_system_state state;
532 wait_queue_head_t state_wq; /* Woken up when on state updates */
534 size_t bus_tx_block_size;
535 size_t bus_pl_size_max;
536 unsigned bus_bm_retries;
538 int (*bus_setup)(struct i2400m *);
539 int (*bus_dev_start)(struct i2400m *);
540 void (*bus_dev_stop)(struct i2400m *);
541 void (*bus_release)(struct i2400m *);
542 void (*bus_tx_kick)(struct i2400m *);
543 int (*bus_reset)(struct i2400m *, enum i2400m_reset_type);
544 ssize_t (*bus_bm_cmd_send)(struct i2400m *,
545 const struct i2400m_bootrom_header *,
547 ssize_t (*bus_bm_wait_for_ack)(struct i2400m *,
548 struct i2400m_bootrom_header *, size_t);
549 const char **bus_fw_names;
550 unsigned bus_bm_mac_addr_impaired:1;
551 const struct i2400m_poke_table *bus_bm_pokes_table;
553 spinlock_t tx_lock; /* protect TX state */
555 size_t tx_in, tx_out;
556 struct i2400m_msg_hdr *tx_msg;
557 size_t tx_sequence, tx_msg_size;
559 unsigned tx_pl_num, tx_pl_max, tx_pl_min,
560 tx_num, tx_size_acc, tx_size_min, tx_size_max;
563 spinlock_t rx_lock; /* protect RX state */
564 unsigned rx_pl_num, rx_pl_max, rx_pl_min,
565 rx_num, rx_size_acc, rx_size_min, rx_size_max;
566 struct i2400m_roq *rx_roq; /* not under rx_lock! */
567 u8 src_mac_addr[ETH_HLEN];
568 struct list_head rx_reports; /* under rx_lock! */
569 struct work_struct rx_report_ws;
571 struct mutex msg_mutex; /* serialize command execution */
572 struct completion msg_completion;
573 struct sk_buff *ack_skb; /* protected by rx_lock */
575 void *bm_ack_buf; /* for receiving acks over USB */
576 void *bm_cmd_buf; /* for issuing commands over USB */
578 struct workqueue_struct *work_queue;
580 struct mutex init_mutex; /* protect bringup seq */
581 struct i2400m_reset_ctx *reset_ctx; /* protected by init_mutex */
583 struct work_struct wake_tx_ws;
584 struct sk_buff *wake_tx_skb;
586 struct dentry *debugfs_dentry;
587 const char *fw_name; /* name of the current firmware image */
588 unsigned long fw_version; /* version of the firmware interface */
589 const struct i2400m_bcf_hdr **fw_hdrs;
590 struct i2400m_fw *fw_cached; /* protected by rx_lock */
591 struct i2400m_barker_db *barker;
593 struct notifier_block pm_notifier;
598 * Bus-generic internal APIs
599 * -------------------------
603 struct i2400m *wimax_dev_to_i2400m(struct wimax_dev *wimax_dev)
605 return container_of(wimax_dev, struct i2400m, wimax_dev);
609 struct i2400m *net_dev_to_i2400m(struct net_device *net_dev)
611 return wimax_dev_to_i2400m(netdev_priv(net_dev));
619 * i2400m_bm_cmd_flags - flags to i2400m_bm_cmd()
621 * @I2400M_BM_CMD_RAW: send the command block as-is, without doing any
622 * extra processing for adding CRC.
624 enum i2400m_bm_cmd_flags {
625 I2400M_BM_CMD_RAW = 1 << 2,
629 * i2400m_bri - Boot-ROM indicators
631 * Flags for i2400m_bootrom_init() and i2400m_dev_bootstrap() [which
632 * are passed from things like i2400m_setup()]. Can be combined with
635 * @I2400M_BRI_SOFT: The device rebooted already and a reboot
636 * barker received, proceed directly to ack the boot sequence.
637 * @I2400M_BRI_NO_REBOOT: Do not reboot the device and proceed
638 * directly to wait for a reboot barker from the device.
639 * @I2400M_BRI_MAC_REINIT: We need to reinitialize the boot
640 * rom after reading the MAC address. This is quite a dirty hack,
641 * if you ask me -- the device requires the bootrom to be
642 * intialized after reading the MAC address.
645 I2400M_BRI_SOFT = 1 << 1,
646 I2400M_BRI_NO_REBOOT = 1 << 2,
647 I2400M_BRI_MAC_REINIT = 1 << 3,
650 extern void i2400m_bm_cmd_prepare(struct i2400m_bootrom_header *);
651 extern int i2400m_dev_bootstrap(struct i2400m *, enum i2400m_bri);
652 extern int i2400m_read_mac_addr(struct i2400m *);
653 extern int i2400m_bootrom_init(struct i2400m *, enum i2400m_bri);
654 extern int i2400m_is_boot_barker(struct i2400m *, const void *, size_t);
656 int i2400m_is_d2h_barker(const void *buf)
658 const __le32 *barker = buf;
659 return le32_to_cpu(*barker) == I2400M_D2H_MSG_BARKER;
661 extern void i2400m_unknown_barker(struct i2400m *, const void *, size_t);
663 /* Make/grok boot-rom header commands */
666 __le32 i2400m_brh_command(enum i2400m_brh_opcode opcode, unsigned use_checksum,
667 unsigned direct_access)
671 | (direct_access ? I2400M_BRH_DIRECT_ACCESS : 0)
672 | I2400M_BRH_RESPONSE_REQUIRED /* response always required */
673 | (use_checksum ? I2400M_BRH_USE_CHECKSUM : 0)
674 | (opcode & I2400M_BRH_OPCODE_MASK));
678 void i2400m_brh_set_opcode(struct i2400m_bootrom_header *hdr,
679 enum i2400m_brh_opcode opcode)
681 hdr->command = cpu_to_le32(
682 (le32_to_cpu(hdr->command) & ~I2400M_BRH_OPCODE_MASK)
683 | (opcode & I2400M_BRH_OPCODE_MASK));
687 unsigned i2400m_brh_get_opcode(const struct i2400m_bootrom_header *hdr)
689 return le32_to_cpu(hdr->command) & I2400M_BRH_OPCODE_MASK;
693 unsigned i2400m_brh_get_response(const struct i2400m_bootrom_header *hdr)
695 return (le32_to_cpu(hdr->command) & I2400M_BRH_RESPONSE_MASK)
696 >> I2400M_BRH_RESPONSE_SHIFT;
700 unsigned i2400m_brh_get_use_checksum(const struct i2400m_bootrom_header *hdr)
702 return le32_to_cpu(hdr->command) & I2400M_BRH_USE_CHECKSUM;
706 unsigned i2400m_brh_get_response_required(
707 const struct i2400m_bootrom_header *hdr)
709 return le32_to_cpu(hdr->command) & I2400M_BRH_RESPONSE_REQUIRED;
713 unsigned i2400m_brh_get_direct_access(const struct i2400m_bootrom_header *hdr)
715 return le32_to_cpu(hdr->command) & I2400M_BRH_DIRECT_ACCESS;
719 unsigned i2400m_brh_get_signature(const struct i2400m_bootrom_header *hdr)
721 return (le32_to_cpu(hdr->command) & I2400M_BRH_SIGNATURE_MASK)
722 >> I2400M_BRH_SIGNATURE_SHIFT;
727 * Driver / device setup and internal functions
729 extern void i2400m_init(struct i2400m *);
730 extern int i2400m_reset(struct i2400m *, enum i2400m_reset_type);
731 extern void i2400m_netdev_setup(struct net_device *net_dev);
732 extern int i2400m_sysfs_setup(struct device_driver *);
733 extern void i2400m_sysfs_release(struct device_driver *);
734 extern int i2400m_tx_setup(struct i2400m *);
735 extern void i2400m_wake_tx_work(struct work_struct *);
736 extern void i2400m_tx_release(struct i2400m *);
738 extern int i2400m_rx_setup(struct i2400m *);
739 extern void i2400m_rx_release(struct i2400m *);
741 extern void i2400m_fw_cache(struct i2400m *);
742 extern void i2400m_fw_uncache(struct i2400m *);
744 extern void i2400m_net_rx(struct i2400m *, struct sk_buff *, unsigned,
746 extern void i2400m_net_erx(struct i2400m *, struct sk_buff *,
748 extern void i2400m_net_wake_stop(struct i2400m *);
750 extern int i2400m_tx(struct i2400m *, const void *, size_t, enum i2400m_pt);
752 #ifdef CONFIG_DEBUG_FS
753 extern int i2400m_debugfs_add(struct i2400m *);
754 extern void i2400m_debugfs_rm(struct i2400m *);
756 static inline int i2400m_debugfs_add(struct i2400m *i2400m)
760 static inline void i2400m_debugfs_rm(struct i2400m *i2400m) {}
763 /* Initialize/shutdown the device */
764 extern int i2400m_dev_initialize(struct i2400m *);
765 extern void i2400m_dev_shutdown(struct i2400m *);
767 extern struct attribute_group i2400m_dev_attr_group;
770 /* HDI message's payload description handling */
773 size_t i2400m_pld_size(const struct i2400m_pld *pld)
775 return I2400M_PLD_SIZE_MASK & le32_to_cpu(pld->val);
779 enum i2400m_pt i2400m_pld_type(const struct i2400m_pld *pld)
781 return (I2400M_PLD_TYPE_MASK & le32_to_cpu(pld->val))
782 >> I2400M_PLD_TYPE_SHIFT;
786 void i2400m_pld_set(struct i2400m_pld *pld, size_t size,
789 pld->val = cpu_to_le32(
790 ((type << I2400M_PLD_TYPE_SHIFT) & I2400M_PLD_TYPE_MASK)
791 | (size & I2400M_PLD_SIZE_MASK));
796 * API for the bus-specific drivers
797 * --------------------------------
801 struct i2400m *i2400m_get(struct i2400m *i2400m)
803 dev_hold(i2400m->wimax_dev.net_dev);
808 void i2400m_put(struct i2400m *i2400m)
810 dev_put(i2400m->wimax_dev.net_dev);
813 extern int i2400m_dev_reset_handle(struct i2400m *, const char *);
814 extern int i2400m_pre_reset(struct i2400m *);
815 extern int i2400m_post_reset(struct i2400m *);
818 * _setup()/_release() are called by the probe/disconnect functions of
819 * the bus-specific drivers.
821 extern int i2400m_setup(struct i2400m *, enum i2400m_bri bm_flags);
822 extern void i2400m_release(struct i2400m *);
824 extern int i2400m_rx(struct i2400m *, struct sk_buff *);
825 extern struct i2400m_msg_hdr *i2400m_tx_msg_get(struct i2400m *, size_t *);
826 extern void i2400m_tx_msg_sent(struct i2400m *);
828 extern int i2400m_power_save_disabled;
835 struct device *i2400m_dev(struct i2400m *i2400m)
837 return i2400m->wimax_dev.net_dev->dev.parent;
841 * Helper for scheduling simple work functions
843 * This struct can get any kind of payload attached (normally in the
844 * form of a struct where you pack the stuff you want to pass to the
848 struct work_struct ws;
849 struct i2400m *i2400m;
854 extern int i2400m_schedule_work(struct i2400m *,
855 void (*)(struct work_struct *), gfp_t,
856 const void *, size_t);
858 extern int i2400m_msg_check_status(const struct i2400m_l3l4_hdr *,
860 extern int i2400m_msg_size_check(struct i2400m *,
861 const struct i2400m_l3l4_hdr *, size_t);
862 extern struct sk_buff *i2400m_msg_to_dev(struct i2400m *, const void *, size_t);
863 extern void i2400m_msg_to_dev_cancel_wait(struct i2400m *, int);
864 extern void i2400m_msg_ack_hook(struct i2400m *,
865 const struct i2400m_l3l4_hdr *, size_t);
866 extern void i2400m_report_hook(struct i2400m *,
867 const struct i2400m_l3l4_hdr *, size_t);
868 extern void i2400m_report_hook_work(struct work_struct *);
869 extern int i2400m_cmd_enter_powersave(struct i2400m *);
870 extern int i2400m_cmd_get_state(struct i2400m *);
871 extern int i2400m_cmd_exit_idle(struct i2400m *);
872 extern struct sk_buff *i2400m_get_device_info(struct i2400m *);
873 extern int i2400m_firmware_check(struct i2400m *);
874 extern int i2400m_set_init_config(struct i2400m *,
875 const struct i2400m_tlv_hdr **, size_t);
876 extern int i2400m_set_idle_timeout(struct i2400m *, unsigned);
879 struct usb_endpoint_descriptor *usb_get_epd(struct usb_interface *iface, int ep)
881 return &iface->cur_altsetting->endpoint[ep].desc;
884 extern int i2400m_op_rfkill_sw_toggle(struct wimax_dev *,
885 enum wimax_rf_state);
886 extern void i2400m_report_tlv_rf_switches_status(
887 struct i2400m *, const struct i2400m_tlv_rf_switches_status *);
890 * Helpers for firmware backwards compability
892 * As we aim to support at least the firmware version that was
893 * released with the previous kernel/driver release, some code will be
894 * conditionally executed depending on the firmware version. On each
895 * release, the code to support fw releases past the last two ones
898 * By making it depend on this macros, it is easier to keep it a tab
899 * on what has to go and what not.
902 unsigned i2400m_le_v1_3(struct i2400m *i2400m)
904 /* running fw is lower or v1.3 */
905 return i2400m->fw_version <= 0x00090001;
909 unsigned i2400m_ge_v1_4(struct i2400m *i2400m)
911 /* running fw is higher or v1.4 */
912 return i2400m->fw_version >= 0x00090002;
917 * Do a millisecond-sleep for allowing wireshark to dump all the data
918 * packets. Used only for debugging.
921 void __i2400m_msleep(unsigned ms)
930 /* module initialization helpers */
931 extern int i2400m_barker_db_init(const char *);
932 extern void i2400m_barker_db_exit(void);
935 /* Module parameters */
937 extern int i2400m_idle_mode_disabled;
938 extern int i2400m_rx_reorder_disabled;
941 #endif /* #ifndef __I2400M_H__ */