wimax/i2400m: driver loads firmware v1.4 instead of v1.3
[linux-2.6.git] / drivers / net / wimax / i2400m / i2400m.h
1 /*
2  * Intel Wireless WiMAX Connection 2400m
3  * Declarations for bus-generic internal APIs
4  *
5  *
6  * Copyright (C) 2007-2008 Intel Corporation. All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
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
17  *     distribution.
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.
21  *
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.
33  *
34  *
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
39  *
40  *
41  * GENERAL DRIVER ARCHITECTURE
42  *
43  * The i2400m driver is split in the following two major parts:
44  *
45  *  - bus specific driver
46  *  - bus generic driver (this part)
47  *
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.
53  *
54  * For details on each bus-specific driver, see it's include file,
55  * i2400m-BUSNAME.h
56  *
57  * The bus-generic functionality break up is:
58  *
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.
62  *
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.
67  *
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.
72  *
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.
77  *
78  *  - control ops: control.c - implements various commmands for
79  *        controlling the device. bus-generic only.
80  *
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
85  *        WiMAX stack ops.
86  *
87  * Code is also broken up in linux-glue / device-glue.
88  *
89  * Linux glue contains functions that deal mostly with gluing with the
90  * rest of the Linux kernel.
91  *
92  * Device-glue are functions that deal mostly with the way the device
93  * does things and talk the device's language.
94  *
95  * device-glue code is licensed BSD so other open source OSes can take
96  * it to implement their drivers.
97  *
98  *
99  * APIs AND HEADER FILES
100  *
101  * This bus generic code exports three APIs:
102  *
103  *  - HDI (host-device interface) definitions common to all busses
104  *    (include/linux/wimax/i2400m.h); these can be also used by user
105  *    space code.
106  *  - internal API for the bus-generic code
107  *  - external API for the bus-specific drivers
108  *
109  *
110  * LIFE CYCLE:
111  *
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.
115  *
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
122  * for operation.
123  *
124  * At this point, control and data communications are possible.
125  *
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
129  * with the device.
130  *
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
134  * one).
135  */
136
137 #ifndef __I2400M_H__
138 #define __I2400M_H__
139
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>
148
149 /* Misc constants */
150 enum {
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,
156 };
157
158
159 /* Firmware version we request when pulling the fw image file */
160 #define I2400M_FW_VERSION "1.4"
161
162
163 /**
164  * i2400m_reset_type - methods to reset a device
165  *
166  * @I2400M_RT_WARM: Reset without device disconnection, device handles
167  *     are kept valid but state is back to power on, with firmware
168  *     re-uploaded.
169  * @I2400M_RT_COLD: Tell the device to disconnect itself from the bus
170  *     and reconnect. Renders all device handles invalid.
171  * @I2400M_RT_BUS: Tells the bus to reset the device; last measure
172  *     used when both types above don't work.
173  */
174 enum i2400m_reset_type {
175         I2400M_RT_WARM, /* first measure */
176         I2400M_RT_COLD, /* second measure */
177         I2400M_RT_BUS,  /* call in artillery */
178 };
179
180 struct i2400m_reset_ctx;
181
182 /**
183  * struct i2400m - descriptor for an Intel 2400m
184  *
185  * Members marked with [fill] must be filled out/initialized before
186  * calling i2400m_setup().
187  *
188  * @bus_tx_block_size: [fill] SDIO imposes a 256 block size, USB 16,
189  *     so we have a tx_blk_size variable that the bus layer sets to
190  *     tell the engine how much of that we need.
191  *
192  * @bus_pl_size_max: [fill] Maximum payload size.
193  *
194  * @bus_dev_start: [fill] Function called by the bus-generic code
195  *     [i2400m_dev_start()] to setup the bus-specific communications
196  *     to the the device. See LIFE CYCLE above.
197  *
198  *     NOTE: Doesn't need to upload the firmware, as that is taken
199  *     care of by the bus-generic code.
200  *
201  * @bus_dev_stop: [fill] Function called by the bus-generic code
202  *     [i2400m_dev_stop()] to shutdown the bus-specific communications
203  *     to the the device. See LIFE CYCLE above.
204  *
205  *     This function does not need to reset the device, just tear down
206  *     all the host resources created to  handle communication with
207  *     the device.
208  *
209  * @bus_tx_kick: [fill] Function called by the bus-generic code to let
210  *     the bus-specific code know that there is data available in the
211  *     TX FIFO for transmission to the device.
212  *
213  *     This function cannot sleep.
214  *
215  * @bus_reset: [fill] Function called by the bus-generic code to reset
216  *     the device in in various ways. Doesn't need to wait for the
217  *     reset to finish.
218  *
219  *     If warm or cold reset fail, this function is expected to do a
220  *     bus-specific reset (eg: USB reset) to get the device to a
221  *     working state (even if it implies device disconecction).
222  *
223  *     Note the warm reset is used by the firmware uploader to
224  *     reinitialize the device.
225  *
226  *     IMPORTANT: this is called very early in the device setup
227  *     process, so it cannot rely on common infrastructure being laid
228  *     out.
229  *
230  * @bus_bm_cmd_send: [fill] Function called to send a boot-mode
231  *     command. Flags are defined in 'enum i2400m_bm_cmd_flags'. This
232  *     is synchronous and has to return 0 if ok or < 0 errno code in
233  *     any error condition.
234  *
235  * @bus_bm_wait_for_ack: [fill] Function called to wait for a
236  *     boot-mode notification (that can be a response to a previously
237  *     issued command or an asynchronous one). Will read until all the
238  *     indicated size is read or timeout. Reading more or less data
239  *     than asked for is an error condition. Return 0 if ok, < 0 errno
240  *     code on error.
241  *
242  *     The caller to this function will check if the response is a
243  *     barker that indicates the device going into reset mode.
244  *
245  * @bus_fw_name: [fill] name of the firmware image (in most cases,
246  *     they are all the same for a single release, except that they
247  *     have the type of the bus embedded in the name (eg:
248  *     i2400m-fw-X-VERSION.sbcf, where X is the bus name).
249  *
250  * @bus_bm_mac_addr_impaired: [fill] Set to true if the device's MAC
251  *     address provided in boot mode is kind of broken and needs to
252  *     be re-read later on.
253  *
254  *
255  * @wimax_dev: WiMAX generic device for linkage into the kernel WiMAX
256  *     stack. Due to the way a net_device is allocated, we need to
257  *     force this to be the first field so that we can get from
258  *     netdev_priv() the right pointer.
259  *
260  * @state: device's state (as reported by it)
261  *
262  * @state_wq: waitqueue that is woken up whenever the state changes
263  *
264  * @tx_lock: spinlock to protect TX members
265  *
266  * @tx_buf: FIFO buffer for TX; we queue data here
267  *
268  * @tx_in: FIFO index for incoming data. Note this doesn't wrap around
269  *     and it is always greater than @tx_out.
270  *
271  * @tx_out: FIFO index for outgoing data
272  *
273  * @tx_msg: current TX message that is active in the FIFO for
274  *     appending payloads.
275  *
276  * @tx_sequence: current sequence number for TX messages from the
277  *     device to the host.
278  *
279  * @tx_msg_size: size of the current message being transmitted by the
280  *     bus-specific code.
281  *
282  * @tx_pl_num: total number of payloads sent
283  *
284  * @tx_pl_max: maximum number of payloads sent in a TX message
285  *
286  * @tx_pl_min: minimum number of payloads sent in a TX message
287  *
288  * @tx_num: number of TX messages sent
289  *
290  * @tx_size_acc: number of bytes in all TX messages sent
291  *     (this is different to net_dev's statistics as it also counts
292  *     control messages).
293  *
294  * @tx_size_min: smallest TX message sent.
295  *
296  * @tx_size_max: biggest TX message sent.
297  *
298  * @rx_lock: spinlock to protect RX members
299  *
300  * @rx_pl_num: total number of payloads received
301  *
302  * @rx_pl_max: maximum number of payloads received in a RX message
303  *
304  * @rx_pl_min: minimum number of payloads received in a RX message
305  *
306  * @rx_num: number of RX messages received
307  *
308  * @rx_size_acc: number of bytes in all RX messages received
309  *     (this is different to net_dev's statistics as it also counts
310  *     control messages).
311  *
312  * @rx_size_min: smallest RX message received.
313  *
314  * @rx_size_max: buggest RX message received.
315  *
316  * @init_mutex: Mutex used for serializing the device bringup
317  *     sequence; this way if the device reboots in the middle, we
318  *     don't try to do a bringup again while we are tearing down the
319  *     one that failed.
320  *
321  *     Can't reuse @msg_mutex because from within the bringup sequence
322  *     we need to send messages to the device and thus use @msg_mutex.
323  *
324  * @msg_mutex: mutex used to send control commands to the device (we
325  *     only allow one at a time, per host-device interface design).
326  *
327  * @msg_completion: used to wait for an ack to a control command sent
328  *     to the device.
329  *
330  * @ack_skb: used to store the actual ack to a control command if the
331  *     reception of the command was successful. Otherwise, a ERR_PTR()
332  *     errno code that indicates what failed with the ack reception.
333  *
334  *     Only valid after @msg_completion is woken up. Only updateable
335  *     if @msg_completion is armed. Only touched by
336  *     i2400m_msg_to_dev().
337  *
338  *     Protected by @rx_lock. In theory the command execution flow is
339  *     sequential, but in case the device sends an out-of-phase or
340  *     very delayed response, we need to avoid it trampling current
341  *     execution.
342  *
343  * @bm_cmd_buf: boot mode command buffer for composing firmware upload
344  *     commands.
345  *
346  *     USB can't r/w to stack, vmalloc, etc...as well, we end up
347  *     having to alloc/free a lot to compose commands, so we use these
348  *     for stagging and not having to realloc all the time.
349  *
350  *     This assumes the code always runs serialized. Only one thread
351  *     can call i2400m_bm_cmd() at the same time.
352  *
353  * @bm_ack_buf: boot mode acknoledge buffer for staging reception of
354  *     responses to commands.
355  *
356  *     See @bm_cmd_buf.
357  *
358  * @work_queue: work queue for processing device reports. This
359  *     workqueue cannot be used for processing TX or RX to the device,
360  *     as from it we'll process device reports, which might require
361  *     further communication with the device.
362  *
363  * @debugfs_dentry: hookup for debugfs files.
364  *     These have to be in a separate directory, a child of
365  *     (wimax_dev->debugfs_dentry) so they can be removed when the
366  *     module unloads, as we don't keep each dentry.
367  */
368 struct i2400m {
369         struct wimax_dev wimax_dev;     /* FIRST! See doc */
370
371         unsigned updown:1;              /* Network device is up or down */
372         unsigned boot_mode:1;           /* is the device in boot mode? */
373         unsigned sboot:1;               /* signed or unsigned fw boot */
374         unsigned ready:1;               /* all probing steps done */
375         u8 trace_msg_from_user;         /* echo rx msgs to 'trace' pipe */
376                                         /* typed u8 so debugfs/u8 can tweak */
377         enum i2400m_system_state state;
378         wait_queue_head_t state_wq;     /* Woken up when on state updates */
379
380         size_t bus_tx_block_size;
381         size_t bus_pl_size_max;
382         int (*bus_dev_start)(struct i2400m *);
383         void (*bus_dev_stop)(struct i2400m *);
384         void (*bus_tx_kick)(struct i2400m *);
385         int (*bus_reset)(struct i2400m *, enum i2400m_reset_type);
386         ssize_t (*bus_bm_cmd_send)(struct i2400m *,
387                                    const struct i2400m_bootrom_header *,
388                                    size_t, int flags);
389         ssize_t (*bus_bm_wait_for_ack)(struct i2400m *,
390                                        struct i2400m_bootrom_header *, size_t);
391         const char *bus_fw_name;
392         unsigned bus_bm_mac_addr_impaired:1;
393
394         spinlock_t tx_lock;             /* protect TX state */
395         void *tx_buf;
396         size_t tx_in, tx_out;
397         struct i2400m_msg_hdr *tx_msg;
398         size_t tx_sequence, tx_msg_size;
399         /* TX stats */
400         unsigned tx_pl_num, tx_pl_max, tx_pl_min,
401                 tx_num, tx_size_acc, tx_size_min, tx_size_max;
402
403         /* RX stats */
404         spinlock_t rx_lock;             /* protect RX state */
405         unsigned rx_pl_num, rx_pl_max, rx_pl_min,
406                 rx_num, rx_size_acc, rx_size_min, rx_size_max;
407
408         struct mutex msg_mutex;         /* serialize command execution */
409         struct completion msg_completion;
410         struct sk_buff *ack_skb;        /* protected by rx_lock */
411
412         void *bm_ack_buf;               /* for receiving acks over USB */
413         void *bm_cmd_buf;               /* for issuing commands over USB */
414
415         struct workqueue_struct *work_queue;
416
417         struct mutex init_mutex;        /* protect bringup seq */
418         struct i2400m_reset_ctx *reset_ctx;     /* protected by init_mutex */
419
420         struct work_struct wake_tx_ws;
421         struct sk_buff *wake_tx_skb;
422
423         struct dentry *debugfs_dentry;
424 };
425
426
427 /*
428  * Initialize a 'struct i2400m' from all zeroes
429  *
430  * This is a bus-generic API call.
431  */
432 static inline
433 void i2400m_init(struct i2400m *i2400m)
434 {
435         wimax_dev_init(&i2400m->wimax_dev);
436
437         i2400m->boot_mode = 1;
438         init_waitqueue_head(&i2400m->state_wq);
439
440         spin_lock_init(&i2400m->tx_lock);
441         i2400m->tx_pl_min = UINT_MAX;
442         i2400m->tx_size_min = UINT_MAX;
443
444         spin_lock_init(&i2400m->rx_lock);
445         i2400m->rx_pl_min = UINT_MAX;
446         i2400m->rx_size_min = UINT_MAX;
447
448         mutex_init(&i2400m->msg_mutex);
449         init_completion(&i2400m->msg_completion);
450
451         mutex_init(&i2400m->init_mutex);
452         /* wake_tx_ws is initialized in i2400m_tx_setup() */
453 }
454
455
456 /*
457  * Bus-generic internal APIs
458  * -------------------------
459  */
460
461 static inline
462 struct i2400m *wimax_dev_to_i2400m(struct wimax_dev *wimax_dev)
463 {
464         return container_of(wimax_dev, struct i2400m, wimax_dev);
465 }
466
467 static inline
468 struct i2400m *net_dev_to_i2400m(struct net_device *net_dev)
469 {
470         return wimax_dev_to_i2400m(netdev_priv(net_dev));
471 }
472
473 /*
474  * Boot mode support
475  */
476
477 /**
478  * i2400m_bm_cmd_flags - flags to i2400m_bm_cmd()
479  *
480  * @I2400M_BM_CMD_RAW: send the command block as-is, without doing any
481  *     extra processing for adding CRC.
482  */
483 enum i2400m_bm_cmd_flags {
484         I2400M_BM_CMD_RAW       = 1 << 2,
485 };
486
487 /**
488  * i2400m_bri - Boot-ROM indicators
489  *
490  * Flags for i2400m_bootrom_init() and i2400m_dev_bootstrap() [which
491  * are passed from things like i2400m_setup()]. Can be combined with
492  * |.
493  *
494  * @I2400M_BRI_SOFT: The device rebooted already and a reboot
495  *     barker received, proceed directly to ack the boot sequence.
496  * @I2400M_BRI_NO_REBOOT: Do not reboot the device and proceed
497  *     directly to wait for a reboot barker from the device.
498  * @I2400M_BRI_MAC_REINIT: We need to reinitialize the boot
499  *     rom after reading the MAC adress. This is quite a dirty hack,
500  *     if you ask me -- the device requires the bootrom to be
501  *     intialized after reading the MAC address.
502  */
503 enum i2400m_bri {
504         I2400M_BRI_SOFT       = 1 << 1,
505         I2400M_BRI_NO_REBOOT  = 1 << 2,
506         I2400M_BRI_MAC_REINIT = 1 << 3,
507 };
508
509 extern void i2400m_bm_cmd_prepare(struct i2400m_bootrom_header *);
510 extern int i2400m_dev_bootstrap(struct i2400m *, enum i2400m_bri);
511 extern int i2400m_read_mac_addr(struct i2400m *);
512 extern int i2400m_bootrom_init(struct i2400m *, enum i2400m_bri);
513
514 /* Make/grok boot-rom header commands */
515
516 static inline
517 __le32 i2400m_brh_command(enum i2400m_brh_opcode opcode, unsigned use_checksum,
518                           unsigned direct_access)
519 {
520         return cpu_to_le32(
521                 I2400M_BRH_SIGNATURE
522                 | (direct_access ? I2400M_BRH_DIRECT_ACCESS : 0)
523                 | I2400M_BRH_RESPONSE_REQUIRED /* response always required */
524                 | (use_checksum ? I2400M_BRH_USE_CHECKSUM : 0)
525                 | (opcode & I2400M_BRH_OPCODE_MASK));
526 }
527
528 static inline
529 void i2400m_brh_set_opcode(struct i2400m_bootrom_header *hdr,
530                            enum i2400m_brh_opcode opcode)
531 {
532         hdr->command = cpu_to_le32(
533                 (le32_to_cpu(hdr->command) & ~I2400M_BRH_OPCODE_MASK)
534                 | (opcode & I2400M_BRH_OPCODE_MASK));
535 }
536
537 static inline
538 unsigned i2400m_brh_get_opcode(const struct i2400m_bootrom_header *hdr)
539 {
540         return le32_to_cpu(hdr->command) & I2400M_BRH_OPCODE_MASK;
541 }
542
543 static inline
544 unsigned i2400m_brh_get_response(const struct i2400m_bootrom_header *hdr)
545 {
546         return (le32_to_cpu(hdr->command) & I2400M_BRH_RESPONSE_MASK)
547                 >> I2400M_BRH_RESPONSE_SHIFT;
548 }
549
550 static inline
551 unsigned i2400m_brh_get_use_checksum(const struct i2400m_bootrom_header *hdr)
552 {
553         return le32_to_cpu(hdr->command) & I2400M_BRH_USE_CHECKSUM;
554 }
555
556 static inline
557 unsigned i2400m_brh_get_response_required(
558         const struct i2400m_bootrom_header *hdr)
559 {
560         return le32_to_cpu(hdr->command) & I2400M_BRH_RESPONSE_REQUIRED;
561 }
562
563 static inline
564 unsigned i2400m_brh_get_direct_access(const struct i2400m_bootrom_header *hdr)
565 {
566         return le32_to_cpu(hdr->command) & I2400M_BRH_DIRECT_ACCESS;
567 }
568
569 static inline
570 unsigned i2400m_brh_get_signature(const struct i2400m_bootrom_header *hdr)
571 {
572         return (le32_to_cpu(hdr->command) & I2400M_BRH_SIGNATURE_MASK)
573                 >> I2400M_BRH_SIGNATURE_SHIFT;
574 }
575
576
577 /*
578  * Driver / device setup and internal functions
579  */
580 extern void i2400m_netdev_setup(struct net_device *net_dev);
581 extern int i2400m_tx_setup(struct i2400m *);
582 extern void i2400m_wake_tx_work(struct work_struct *);
583 extern void i2400m_tx_release(struct i2400m *);
584
585 extern void i2400m_net_rx(struct i2400m *, struct sk_buff *, unsigned,
586                           const void *, int);
587 enum i2400m_pt;
588 extern int i2400m_tx(struct i2400m *, const void *, size_t, enum i2400m_pt);
589
590 #ifdef CONFIG_DEBUG_FS
591 extern int i2400m_debugfs_add(struct i2400m *);
592 extern void i2400m_debugfs_rm(struct i2400m *);
593 #else
594 static inline int i2400m_debugfs_add(struct i2400m *i2400m)
595 {
596         return 0;
597 }
598 static inline void i2400m_debugfs_rm(struct i2400m *i2400m) {}
599 #endif
600
601 /* Called by _dev_start()/_dev_stop() to initialize the device itself */
602 extern int i2400m_dev_initialize(struct i2400m *);
603 extern void i2400m_dev_shutdown(struct i2400m *);
604
605 extern struct attribute_group i2400m_dev_attr_group;
606
607 extern int i2400m_schedule_work(struct i2400m *,
608                                 void (*)(struct work_struct *), gfp_t);
609
610 /* HDI message's payload description handling */
611
612 static inline
613 size_t i2400m_pld_size(const struct i2400m_pld *pld)
614 {
615         return I2400M_PLD_SIZE_MASK & le32_to_cpu(pld->val);
616 }
617
618 static inline
619 enum i2400m_pt i2400m_pld_type(const struct i2400m_pld *pld)
620 {
621         return (I2400M_PLD_TYPE_MASK & le32_to_cpu(pld->val))
622                 >> I2400M_PLD_TYPE_SHIFT;
623 }
624
625 static inline
626 void i2400m_pld_set(struct i2400m_pld *pld, size_t size,
627                     enum i2400m_pt type)
628 {
629         pld->val = cpu_to_le32(
630                 ((type << I2400M_PLD_TYPE_SHIFT) & I2400M_PLD_TYPE_MASK)
631                 |  (size & I2400M_PLD_SIZE_MASK));
632 }
633
634
635 /*
636  * API for the bus-specific drivers
637  * --------------------------------
638  */
639
640 static inline
641 struct i2400m *i2400m_get(struct i2400m *i2400m)
642 {
643         dev_hold(i2400m->wimax_dev.net_dev);
644         return i2400m;
645 }
646
647 static inline
648 void i2400m_put(struct i2400m *i2400m)
649 {
650         dev_put(i2400m->wimax_dev.net_dev);
651 }
652
653 extern int i2400m_dev_reset_handle(struct i2400m *);
654
655 /*
656  * _setup()/_release() are called by the probe/disconnect functions of
657  * the bus-specific drivers.
658  */
659 extern int i2400m_setup(struct i2400m *, enum i2400m_bri bm_flags);
660 extern void i2400m_release(struct i2400m *);
661
662 extern int i2400m_rx(struct i2400m *, struct sk_buff *);
663 extern struct i2400m_msg_hdr *i2400m_tx_msg_get(struct i2400m *, size_t *);
664 extern void i2400m_tx_msg_sent(struct i2400m *);
665
666 static const __le32 i2400m_NBOOT_BARKER[4] = {
667         __constant_cpu_to_le32(I2400M_NBOOT_BARKER),
668         __constant_cpu_to_le32(I2400M_NBOOT_BARKER),
669         __constant_cpu_to_le32(I2400M_NBOOT_BARKER),
670         __constant_cpu_to_le32(I2400M_NBOOT_BARKER)
671 };
672
673 static const __le32 i2400m_SBOOT_BARKER[4] = {
674         __constant_cpu_to_le32(I2400M_SBOOT_BARKER),
675         __constant_cpu_to_le32(I2400M_SBOOT_BARKER),
676         __constant_cpu_to_le32(I2400M_SBOOT_BARKER),
677         __constant_cpu_to_le32(I2400M_SBOOT_BARKER)
678 };
679
680
681 /*
682  * Utility functions
683  */
684
685 static inline
686 struct device *i2400m_dev(struct i2400m *i2400m)
687 {
688         return i2400m->wimax_dev.net_dev->dev.parent;
689 }
690
691 /*
692  * Helper for scheduling simple work functions
693  *
694  * This struct can get any kind of payload attached (normally in the
695  * form of a struct where you pack the stuff you want to pass to the
696  * _work function).
697  */
698 struct i2400m_work {
699         struct work_struct ws;
700         struct i2400m *i2400m;
701         u8 pl[0];
702 };
703 extern int i2400m_queue_work(struct i2400m *,
704                              void (*)(struct work_struct *), gfp_t,
705                                 const void *, size_t);
706
707 extern int i2400m_msg_check_status(const struct i2400m_l3l4_hdr *,
708                                    char *, size_t);
709 extern int i2400m_msg_size_check(struct i2400m *,
710                                  const struct i2400m_l3l4_hdr *, size_t);
711 extern struct sk_buff *i2400m_msg_to_dev(struct i2400m *, const void *, size_t);
712 extern void i2400m_msg_to_dev_cancel_wait(struct i2400m *, int);
713 extern void i2400m_msg_ack_hook(struct i2400m *,
714                                 const struct i2400m_l3l4_hdr *, size_t);
715 extern void i2400m_report_hook(struct i2400m *,
716                                const struct i2400m_l3l4_hdr *, size_t);
717 extern int i2400m_cmd_enter_powersave(struct i2400m *);
718 extern int i2400m_cmd_get_state(struct i2400m *);
719 extern int i2400m_cmd_exit_idle(struct i2400m *);
720 extern struct sk_buff *i2400m_get_device_info(struct i2400m *);
721 extern int i2400m_firmware_check(struct i2400m *);
722 extern int i2400m_set_init_config(struct i2400m *,
723                                   const struct i2400m_tlv_hdr **, size_t);
724
725 static inline
726 struct usb_endpoint_descriptor *usb_get_epd(struct usb_interface *iface, int ep)
727 {
728         return &iface->cur_altsetting->endpoint[ep].desc;
729 }
730
731 extern int i2400m_op_rfkill_sw_toggle(struct wimax_dev *,
732                                       enum wimax_rf_state);
733 extern void i2400m_report_tlv_rf_switches_status(
734         struct i2400m *, const struct i2400m_tlv_rf_switches_status *);
735
736
737 /*
738  * Do a millisecond-sleep for allowing wireshark to dump all the data
739  * packets. Used only for debugging.
740  */
741 static inline
742 void __i2400m_msleep(unsigned ms)
743 {
744 #if 1
745 #else
746         msleep(ms);
747 #endif
748 }
749
750 /* Module parameters */
751
752 extern int i2400m_idle_mode_disabled;
753
754
755 #endif /* #ifndef __I2400M_H__ */