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. This calls i2400m_dev_start() to
121 * load firmware, setup communication with the device and configure it
124 * At this point, control and data communications are possible.
126 * On disconnect/driver unload, the bus-specific disconnect function
127 * calls i2400m_release() to undo i2400m_setup(). i2400m_dev_stop()
128 * shuts the firmware down and releases resources uses to communicate
131 * While the device is up, it might reset. The bus-specific driver has
132 * to catch that situation and call i2400m_dev_reset_handle() to deal
133 * with it (reset the internal driver structures and go back to square
140 #include <linux/usb.h>
141 #include <linux/netdevice.h>
142 #include <linux/completion.h>
143 #include <linux/rwsem.h>
144 #include <asm/atomic.h>
145 #include <net/wimax.h>
146 #include <linux/wimax/i2400m.h>
147 #include <asm/byteorder.h>
151 /* Firmware uploading */
152 I2400M_BOOT_RETRIES = 3,
153 /* Size of the Boot Mode Command buffer */
154 I2400M_BM_CMD_BUF_SIZE = 16 * 1024,
155 I2400M_BM_ACK_BUF_SIZE = 256,
160 * i2400m_reset_type - methods to reset a device
162 * @I2400M_RT_WARM: Reset without device disconnection, device handles
163 * are kept valid but state is back to power on, with firmware
165 * @I2400M_RT_COLD: Tell the device to disconnect itself from the bus
166 * and reconnect. Renders all device handles invalid.
167 * @I2400M_RT_BUS: Tells the bus to reset the device; last measure
168 * used when both types above don't work.
170 enum i2400m_reset_type {
171 I2400M_RT_WARM, /* first measure */
172 I2400M_RT_COLD, /* second measure */
173 I2400M_RT_BUS, /* call in artillery */
176 struct i2400m_reset_ctx;
180 * struct i2400m - descriptor for an Intel 2400m
182 * Members marked with [fill] must be filled out/initialized before
183 * calling i2400m_setup().
185 * @bus_tx_block_size: [fill] SDIO imposes a 256 block size, USB 16,
186 * so we have a tx_blk_size variable that the bus layer sets to
187 * tell the engine how much of that we need.
189 * @bus_pl_size_max: [fill] Maximum payload size.
191 * @bus_dev_start: [fill] Function called by the bus-generic code
192 * [i2400m_dev_start()] to setup the bus-specific communications
193 * to the the device. See LIFE CYCLE above.
195 * NOTE: Doesn't need to upload the firmware, as that is taken
196 * care of by the bus-generic code.
198 * @bus_dev_stop: [fill] Function called by the bus-generic code
199 * [i2400m_dev_stop()] to shutdown the bus-specific communications
200 * to the the device. See LIFE CYCLE above.
202 * This function does not need to reset the device, just tear down
203 * all the host resources created to handle communication with
206 * @bus_tx_kick: [fill] Function called by the bus-generic code to let
207 * the bus-specific code know that there is data available in the
208 * TX FIFO for transmission to the device.
210 * This function cannot sleep.
212 * @bus_reset: [fill] Function called by the bus-generic code to reset
213 * the device in in various ways. Doesn't need to wait for the
216 * If warm or cold reset fail, this function is expected to do a
217 * bus-specific reset (eg: USB reset) to get the device to a
218 * working state (even if it implies device disconecction).
220 * Note the warm reset is used by the firmware uploader to
221 * reinitialize the device.
223 * IMPORTANT: this is called very early in the device setup
224 * process, so it cannot rely on common infrastructure being laid
227 * @bus_bm_cmd_send: [fill] Function called to send a boot-mode
228 * command. Flags are defined in 'enum i2400m_bm_cmd_flags'. This
229 * is synchronous and has to return 0 if ok or < 0 errno code in
230 * any error condition.
232 * @bus_bm_wait_for_ack: [fill] Function called to wait for a
233 * boot-mode notification (that can be a response to a previously
234 * issued command or an asynchronous one). Will read until all the
235 * indicated size is read or timeout. Reading more or less data
236 * than asked for is an error condition. Return 0 if ok, < 0 errno
239 * The caller to this function will check if the response is a
240 * barker that indicates the device going into reset mode.
242 * @bus_fw_names: [fill] a NULL-terminated array with the names of the
243 * firmware images to try loading. This is made a list so we can
244 * support backward compatibility of firmware releases (eg: if we
245 * can't find the default v1.4, we try v1.3). In general, the name
246 * should be i2400m-fw-X-VERSION.sbcf, where X is the bus name.
247 * The list is tried in order and the first one that loads is
248 * used. The fw loader will set i2400m->fw_name to point to the
249 * active firmware image.
251 * @bus_bm_mac_addr_impaired: [fill] Set to true if the device's MAC
252 * address provided in boot mode is kind of broken and needs to
253 * be re-read later on.
256 * @wimax_dev: WiMAX generic device for linkage into the kernel WiMAX
257 * stack. Due to the way a net_device is allocated, we need to
258 * force this to be the first field so that we can get from
259 * netdev_priv() the right pointer.
261 * @rx_reorder: 1 if RX reordering is enabled; this can only be
264 * @state: device's state (as reported by it)
266 * @state_wq: waitqueue that is woken up whenever the state changes
268 * @tx_lock: spinlock to protect TX members
270 * @tx_buf: FIFO buffer for TX; we queue data here
272 * @tx_in: FIFO index for incoming data. Note this doesn't wrap around
273 * and it is always greater than @tx_out.
275 * @tx_out: FIFO index for outgoing data
277 * @tx_msg: current TX message that is active in the FIFO for
278 * appending payloads.
280 * @tx_sequence: current sequence number for TX messages from the
281 * device to the host.
283 * @tx_msg_size: size of the current message being transmitted by the
286 * @tx_pl_num: total number of payloads sent
288 * @tx_pl_max: maximum number of payloads sent in a TX message
290 * @tx_pl_min: minimum number of payloads sent in a TX message
292 * @tx_num: number of TX messages sent
294 * @tx_size_acc: number of bytes in all TX messages sent
295 * (this is different to net_dev's statistics as it also counts
298 * @tx_size_min: smallest TX message sent.
300 * @tx_size_max: biggest TX message sent.
302 * @rx_lock: spinlock to protect RX members
304 * @rx_pl_num: total number of payloads received
306 * @rx_pl_max: maximum number of payloads received in a RX message
308 * @rx_pl_min: minimum number of payloads received in a RX message
310 * @rx_num: number of RX messages received
312 * @rx_size_acc: number of bytes in all RX messages received
313 * (this is different to net_dev's statistics as it also counts
316 * @rx_size_min: smallest RX message received.
318 * @rx_size_max: buggest RX message received.
320 * @rx_roq: RX ReOrder queues. (fw >= v1.4) When packets are received
321 * out of order, the device will ask the driver to hold certain
322 * packets until the ones that are received out of order can be
323 * delivered. Then the driver can release them to the host. See
324 * drivers/net/i2400m/rx.c for details.
326 * @init_mutex: Mutex used for serializing the device bringup
327 * sequence; this way if the device reboots in the middle, we
328 * don't try to do a bringup again while we are tearing down the
331 * Can't reuse @msg_mutex because from within the bringup sequence
332 * we need to send messages to the device and thus use @msg_mutex.
334 * @msg_mutex: mutex used to send control commands to the device (we
335 * only allow one at a time, per host-device interface design).
337 * @msg_completion: used to wait for an ack to a control command sent
340 * @ack_skb: used to store the actual ack to a control command if the
341 * reception of the command was successful. Otherwise, a ERR_PTR()
342 * errno code that indicates what failed with the ack reception.
344 * Only valid after @msg_completion is woken up. Only updateable
345 * if @msg_completion is armed. Only touched by
346 * i2400m_msg_to_dev().
348 * Protected by @rx_lock. In theory the command execution flow is
349 * sequential, but in case the device sends an out-of-phase or
350 * very delayed response, we need to avoid it trampling current
353 * @bm_cmd_buf: boot mode command buffer for composing firmware upload
356 * USB can't r/w to stack, vmalloc, etc...as well, we end up
357 * having to alloc/free a lot to compose commands, so we use these
358 * for stagging and not having to realloc all the time.
360 * This assumes the code always runs serialized. Only one thread
361 * can call i2400m_bm_cmd() at the same time.
363 * @bm_ack_buf: boot mode acknoledge buffer for staging reception of
364 * responses to commands.
368 * @work_queue: work queue for processing device reports. This
369 * workqueue cannot be used for processing TX or RX to the device,
370 * as from it we'll process device reports, which might require
371 * further communication with the device.
373 * @debugfs_dentry: hookup for debugfs files.
374 * These have to be in a separate directory, a child of
375 * (wimax_dev->debugfs_dentry) so they can be removed when the
376 * module unloads, as we don't keep each dentry.
378 * @fw_name: name of the firmware image that is currently being used.
380 * @fw_version: version of the firmware interface, Major.minor,
381 * encoded in the high word and low word (major << 16 | minor).
384 struct wimax_dev wimax_dev; /* FIRST! See doc */
386 unsigned updown:1; /* Network device is up or down */
387 unsigned boot_mode:1; /* is the device in boot mode? */
388 unsigned sboot:1; /* signed or unsigned fw boot */
389 unsigned ready:1; /* all probing steps done */
390 unsigned rx_reorder:1; /* RX reorder is enabled */
391 u8 trace_msg_from_user; /* echo rx msgs to 'trace' pipe */
392 /* typed u8 so debugfs/u8 can tweak */
393 enum i2400m_system_state state;
394 wait_queue_head_t state_wq; /* Woken up when on state updates */
396 size_t bus_tx_block_size;
397 size_t bus_pl_size_max;
398 int (*bus_dev_start)(struct i2400m *);
399 void (*bus_dev_stop)(struct i2400m *);
400 void (*bus_tx_kick)(struct i2400m *);
401 int (*bus_reset)(struct i2400m *, enum i2400m_reset_type);
402 ssize_t (*bus_bm_cmd_send)(struct i2400m *,
403 const struct i2400m_bootrom_header *,
405 ssize_t (*bus_bm_wait_for_ack)(struct i2400m *,
406 struct i2400m_bootrom_header *, size_t);
407 const char **bus_fw_names;
408 unsigned bus_bm_mac_addr_impaired:1;
410 spinlock_t tx_lock; /* protect TX state */
412 size_t tx_in, tx_out;
413 struct i2400m_msg_hdr *tx_msg;
414 size_t tx_sequence, tx_msg_size;
416 unsigned tx_pl_num, tx_pl_max, tx_pl_min,
417 tx_num, tx_size_acc, tx_size_min, tx_size_max;
420 spinlock_t rx_lock; /* protect RX state */
421 unsigned rx_pl_num, rx_pl_max, rx_pl_min,
422 rx_num, rx_size_acc, rx_size_min, rx_size_max;
423 struct i2400m_roq *rx_roq; /* not under rx_lock! */
425 struct mutex msg_mutex; /* serialize command execution */
426 struct completion msg_completion;
427 struct sk_buff *ack_skb; /* protected by rx_lock */
429 void *bm_ack_buf; /* for receiving acks over USB */
430 void *bm_cmd_buf; /* for issuing commands over USB */
432 struct workqueue_struct *work_queue;
434 struct mutex init_mutex; /* protect bringup seq */
435 struct i2400m_reset_ctx *reset_ctx; /* protected by init_mutex */
437 struct work_struct wake_tx_ws;
438 struct sk_buff *wake_tx_skb;
440 struct dentry *debugfs_dentry;
441 const char *fw_name; /* name of the current firmware image */
442 unsigned long fw_version; /* version of the firmware interface */
447 * Initialize a 'struct i2400m' from all zeroes
449 * This is a bus-generic API call.
452 void i2400m_init(struct i2400m *i2400m)
454 wimax_dev_init(&i2400m->wimax_dev);
456 i2400m->boot_mode = 1;
457 i2400m->rx_reorder = 1;
458 init_waitqueue_head(&i2400m->state_wq);
460 spin_lock_init(&i2400m->tx_lock);
461 i2400m->tx_pl_min = UINT_MAX;
462 i2400m->tx_size_min = UINT_MAX;
464 spin_lock_init(&i2400m->rx_lock);
465 i2400m->rx_pl_min = UINT_MAX;
466 i2400m->rx_size_min = UINT_MAX;
468 mutex_init(&i2400m->msg_mutex);
469 init_completion(&i2400m->msg_completion);
471 mutex_init(&i2400m->init_mutex);
472 /* wake_tx_ws is initialized in i2400m_tx_setup() */
477 * Bus-generic internal APIs
478 * -------------------------
482 struct i2400m *wimax_dev_to_i2400m(struct wimax_dev *wimax_dev)
484 return container_of(wimax_dev, struct i2400m, wimax_dev);
488 struct i2400m *net_dev_to_i2400m(struct net_device *net_dev)
490 return wimax_dev_to_i2400m(netdev_priv(net_dev));
498 * i2400m_bm_cmd_flags - flags to i2400m_bm_cmd()
500 * @I2400M_BM_CMD_RAW: send the command block as-is, without doing any
501 * extra processing for adding CRC.
503 enum i2400m_bm_cmd_flags {
504 I2400M_BM_CMD_RAW = 1 << 2,
508 * i2400m_bri - Boot-ROM indicators
510 * Flags for i2400m_bootrom_init() and i2400m_dev_bootstrap() [which
511 * are passed from things like i2400m_setup()]. Can be combined with
514 * @I2400M_BRI_SOFT: The device rebooted already and a reboot
515 * barker received, proceed directly to ack the boot sequence.
516 * @I2400M_BRI_NO_REBOOT: Do not reboot the device and proceed
517 * directly to wait for a reboot barker from the device.
518 * @I2400M_BRI_MAC_REINIT: We need to reinitialize the boot
519 * rom after reading the MAC adress. This is quite a dirty hack,
520 * if you ask me -- the device requires the bootrom to be
521 * intialized after reading the MAC address.
524 I2400M_BRI_SOFT = 1 << 1,
525 I2400M_BRI_NO_REBOOT = 1 << 2,
526 I2400M_BRI_MAC_REINIT = 1 << 3,
529 extern void i2400m_bm_cmd_prepare(struct i2400m_bootrom_header *);
530 extern int i2400m_dev_bootstrap(struct i2400m *, enum i2400m_bri);
531 extern int i2400m_read_mac_addr(struct i2400m *);
532 extern int i2400m_bootrom_init(struct i2400m *, enum i2400m_bri);
534 /* Make/grok boot-rom header commands */
537 __le32 i2400m_brh_command(enum i2400m_brh_opcode opcode, unsigned use_checksum,
538 unsigned direct_access)
542 | (direct_access ? I2400M_BRH_DIRECT_ACCESS : 0)
543 | I2400M_BRH_RESPONSE_REQUIRED /* response always required */
544 | (use_checksum ? I2400M_BRH_USE_CHECKSUM : 0)
545 | (opcode & I2400M_BRH_OPCODE_MASK));
549 void i2400m_brh_set_opcode(struct i2400m_bootrom_header *hdr,
550 enum i2400m_brh_opcode opcode)
552 hdr->command = cpu_to_le32(
553 (le32_to_cpu(hdr->command) & ~I2400M_BRH_OPCODE_MASK)
554 | (opcode & I2400M_BRH_OPCODE_MASK));
558 unsigned i2400m_brh_get_opcode(const struct i2400m_bootrom_header *hdr)
560 return le32_to_cpu(hdr->command) & I2400M_BRH_OPCODE_MASK;
564 unsigned i2400m_brh_get_response(const struct i2400m_bootrom_header *hdr)
566 return (le32_to_cpu(hdr->command) & I2400M_BRH_RESPONSE_MASK)
567 >> I2400M_BRH_RESPONSE_SHIFT;
571 unsigned i2400m_brh_get_use_checksum(const struct i2400m_bootrom_header *hdr)
573 return le32_to_cpu(hdr->command) & I2400M_BRH_USE_CHECKSUM;
577 unsigned i2400m_brh_get_response_required(
578 const struct i2400m_bootrom_header *hdr)
580 return le32_to_cpu(hdr->command) & I2400M_BRH_RESPONSE_REQUIRED;
584 unsigned i2400m_brh_get_direct_access(const struct i2400m_bootrom_header *hdr)
586 return le32_to_cpu(hdr->command) & I2400M_BRH_DIRECT_ACCESS;
590 unsigned i2400m_brh_get_signature(const struct i2400m_bootrom_header *hdr)
592 return (le32_to_cpu(hdr->command) & I2400M_BRH_SIGNATURE_MASK)
593 >> I2400M_BRH_SIGNATURE_SHIFT;
598 * Driver / device setup and internal functions
600 extern void i2400m_netdev_setup(struct net_device *net_dev);
601 extern int i2400m_sysfs_setup(struct device_driver *);
602 extern void i2400m_sysfs_release(struct device_driver *);
603 extern int i2400m_tx_setup(struct i2400m *);
604 extern void i2400m_wake_tx_work(struct work_struct *);
605 extern void i2400m_tx_release(struct i2400m *);
607 extern int i2400m_rx_setup(struct i2400m *);
608 extern void i2400m_rx_release(struct i2400m *);
610 extern void i2400m_net_rx(struct i2400m *, struct sk_buff *, unsigned,
612 extern void i2400m_net_erx(struct i2400m *, struct sk_buff *,
615 extern int i2400m_tx(struct i2400m *, const void *, size_t, enum i2400m_pt);
617 #ifdef CONFIG_DEBUG_FS
618 extern int i2400m_debugfs_add(struct i2400m *);
619 extern void i2400m_debugfs_rm(struct i2400m *);
621 static inline int i2400m_debugfs_add(struct i2400m *i2400m)
625 static inline void i2400m_debugfs_rm(struct i2400m *i2400m) {}
628 /* Called by _dev_start()/_dev_stop() to initialize the device itself */
629 extern int i2400m_dev_initialize(struct i2400m *);
630 extern void i2400m_dev_shutdown(struct i2400m *);
632 extern struct attribute_group i2400m_dev_attr_group;
634 extern int i2400m_schedule_work(struct i2400m *,
635 void (*)(struct work_struct *), gfp_t);
637 /* HDI message's payload description handling */
640 size_t i2400m_pld_size(const struct i2400m_pld *pld)
642 return I2400M_PLD_SIZE_MASK & le32_to_cpu(pld->val);
646 enum i2400m_pt i2400m_pld_type(const struct i2400m_pld *pld)
648 return (I2400M_PLD_TYPE_MASK & le32_to_cpu(pld->val))
649 >> I2400M_PLD_TYPE_SHIFT;
653 void i2400m_pld_set(struct i2400m_pld *pld, size_t size,
656 pld->val = cpu_to_le32(
657 ((type << I2400M_PLD_TYPE_SHIFT) & I2400M_PLD_TYPE_MASK)
658 | (size & I2400M_PLD_SIZE_MASK));
663 * API for the bus-specific drivers
664 * --------------------------------
668 struct i2400m *i2400m_get(struct i2400m *i2400m)
670 dev_hold(i2400m->wimax_dev.net_dev);
675 void i2400m_put(struct i2400m *i2400m)
677 dev_put(i2400m->wimax_dev.net_dev);
680 extern int i2400m_dev_reset_handle(struct i2400m *);
683 * _setup()/_release() are called by the probe/disconnect functions of
684 * the bus-specific drivers.
686 extern int i2400m_setup(struct i2400m *, enum i2400m_bri bm_flags);
687 extern void i2400m_release(struct i2400m *);
689 extern int i2400m_rx(struct i2400m *, struct sk_buff *);
690 extern struct i2400m_msg_hdr *i2400m_tx_msg_get(struct i2400m *, size_t *);
691 extern void i2400m_tx_msg_sent(struct i2400m *);
693 static const __le32 i2400m_NBOOT_BARKER[4] = {
694 cpu_to_le32(I2400M_NBOOT_BARKER),
695 cpu_to_le32(I2400M_NBOOT_BARKER),
696 cpu_to_le32(I2400M_NBOOT_BARKER),
697 cpu_to_le32(I2400M_NBOOT_BARKER)
700 static const __le32 i2400m_SBOOT_BARKER[4] = {
701 cpu_to_le32(I2400M_SBOOT_BARKER),
702 cpu_to_le32(I2400M_SBOOT_BARKER),
703 cpu_to_le32(I2400M_SBOOT_BARKER),
704 cpu_to_le32(I2400M_SBOOT_BARKER)
713 struct device *i2400m_dev(struct i2400m *i2400m)
715 return i2400m->wimax_dev.net_dev->dev.parent;
719 * Helper for scheduling simple work functions
721 * This struct can get any kind of payload attached (normally in the
722 * form of a struct where you pack the stuff you want to pass to the
726 struct work_struct ws;
727 struct i2400m *i2400m;
730 extern int i2400m_queue_work(struct i2400m *,
731 void (*)(struct work_struct *), gfp_t,
732 const void *, size_t);
734 extern int i2400m_msg_check_status(const struct i2400m_l3l4_hdr *,
736 extern int i2400m_msg_size_check(struct i2400m *,
737 const struct i2400m_l3l4_hdr *, size_t);
738 extern struct sk_buff *i2400m_msg_to_dev(struct i2400m *, const void *, size_t);
739 extern void i2400m_msg_to_dev_cancel_wait(struct i2400m *, int);
740 extern void i2400m_msg_ack_hook(struct i2400m *,
741 const struct i2400m_l3l4_hdr *, size_t);
742 extern void i2400m_report_hook(struct i2400m *,
743 const struct i2400m_l3l4_hdr *, size_t);
744 extern int i2400m_cmd_enter_powersave(struct i2400m *);
745 extern int i2400m_cmd_get_state(struct i2400m *);
746 extern int i2400m_cmd_exit_idle(struct i2400m *);
747 extern struct sk_buff *i2400m_get_device_info(struct i2400m *);
748 extern int i2400m_firmware_check(struct i2400m *);
749 extern int i2400m_set_init_config(struct i2400m *,
750 const struct i2400m_tlv_hdr **, size_t);
751 extern int i2400m_set_idle_timeout(struct i2400m *, unsigned);
754 struct usb_endpoint_descriptor *usb_get_epd(struct usb_interface *iface, int ep)
756 return &iface->cur_altsetting->endpoint[ep].desc;
759 extern int i2400m_op_rfkill_sw_toggle(struct wimax_dev *,
760 enum wimax_rf_state);
761 extern void i2400m_report_tlv_rf_switches_status(
762 struct i2400m *, const struct i2400m_tlv_rf_switches_status *);
765 * Helpers for firmware backwards compability
767 * As we aim to support at least the firmware version that was
768 * released with the previous kernel/driver release, some code will be
769 * conditionally executed depending on the firmware version. On each
770 * release, the code to support fw releases past the last two ones
773 * By making it depend on this macros, it is easier to keep it a tab
774 * on what has to go and what not.
777 unsigned i2400m_le_v1_3(struct i2400m *i2400m)
779 /* running fw is lower or v1.3 */
780 return i2400m->fw_version <= 0x00090001;
784 unsigned i2400m_ge_v1_4(struct i2400m *i2400m)
786 /* running fw is higher or v1.4 */
787 return i2400m->fw_version >= 0x00090002;
792 * Do a millisecond-sleep for allowing wireshark to dump all the data
793 * packets. Used only for debugging.
796 void __i2400m_msleep(unsigned ms)
804 /* Module parameters */
806 extern int i2400m_idle_mode_disabled;
807 extern int i2400m_rx_reorder_disabled;
810 #endif /* #ifndef __I2400M_H__ */