blob: 60330f313f2781ea65630a484564ef7750011487 [file] [log] [blame]
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -08001/*
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 */
150enum {
151 /* Firmware uploading */
152 I2400M_BOOT_RETRIES = 3,
Inaky Perez-Gonzalezecddfd52009-06-03 16:13:14 +0800153 I3200_BOOT_RETRIES = 3,
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800154 /* Size of the Boot Mode Command buffer */
155 I2400M_BM_CMD_BUF_SIZE = 16 * 1024,
156 I2400M_BM_ACK_BUF_SIZE = 256,
157};
158
Dirk Brandewie7308a0c2009-05-21 11:56:34 -0700159/**
160 * struct i2400m_poke_table - Hardware poke table for the Intel 2400m
161 *
162 * This structure will be used to create a device specific poke table
163 * to put the device in a consistant state at boot time.
164 *
165 * @address: The device address to poke
166 *
167 * @data: The data value to poke to the device address
168 *
169 */
170struct i2400m_poke_table{
171 __le32 address;
172 __le32 data;
173};
174
175#define I2400M_FW_POKE(a, d) { \
176 .address = cpu_to_le32(a), \
177 .data = cpu_to_le32(d) \
178}
179
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800180
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800181/**
182 * i2400m_reset_type - methods to reset a device
183 *
184 * @I2400M_RT_WARM: Reset without device disconnection, device handles
185 * are kept valid but state is back to power on, with firmware
186 * re-uploaded.
187 * @I2400M_RT_COLD: Tell the device to disconnect itself from the bus
188 * and reconnect. Renders all device handles invalid.
189 * @I2400M_RT_BUS: Tells the bus to reset the device; last measure
190 * used when both types above don't work.
191 */
192enum i2400m_reset_type {
193 I2400M_RT_WARM, /* first measure */
194 I2400M_RT_COLD, /* second measure */
195 I2400M_RT_BUS, /* call in artillery */
196};
197
198struct i2400m_reset_ctx;
Inaky Perez-Gonzalezc7475832009-02-28 23:42:54 +0000199struct i2400m_roq;
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800200
201/**
202 * struct i2400m - descriptor for an Intel 2400m
203 *
204 * Members marked with [fill] must be filled out/initialized before
205 * calling i2400m_setup().
206 *
207 * @bus_tx_block_size: [fill] SDIO imposes a 256 block size, USB 16,
208 * so we have a tx_blk_size variable that the bus layer sets to
209 * tell the engine how much of that we need.
210 *
211 * @bus_pl_size_max: [fill] Maximum payload size.
212 *
213 * @bus_dev_start: [fill] Function called by the bus-generic code
214 * [i2400m_dev_start()] to setup the bus-specific communications
215 * to the the device. See LIFE CYCLE above.
216 *
217 * NOTE: Doesn't need to upload the firmware, as that is taken
218 * care of by the bus-generic code.
219 *
220 * @bus_dev_stop: [fill] Function called by the bus-generic code
221 * [i2400m_dev_stop()] to shutdown the bus-specific communications
222 * to the the device. See LIFE CYCLE above.
223 *
224 * This function does not need to reset the device, just tear down
225 * all the host resources created to handle communication with
226 * the device.
227 *
228 * @bus_tx_kick: [fill] Function called by the bus-generic code to let
229 * the bus-specific code know that there is data available in the
230 * TX FIFO for transmission to the device.
231 *
232 * This function cannot sleep.
233 *
234 * @bus_reset: [fill] Function called by the bus-generic code to reset
235 * the device in in various ways. Doesn't need to wait for the
236 * reset to finish.
237 *
238 * If warm or cold reset fail, this function is expected to do a
239 * bus-specific reset (eg: USB reset) to get the device to a
240 * working state (even if it implies device disconecction).
241 *
242 * Note the warm reset is used by the firmware uploader to
243 * reinitialize the device.
244 *
245 * IMPORTANT: this is called very early in the device setup
246 * process, so it cannot rely on common infrastructure being laid
247 * out.
248 *
Inaky Perez-Gonzalezecddfd52009-06-03 16:13:14 +0800249 * @bus_bm_retries: [fill] How many times shall a firmware upload /
250 * device initialization be retried? Different models of the same
251 * device might need different values, hence it is set by the
252 * bus-specific driver. Note this value is used in two places,
253 * i2400m_fw_dnload() and __i2400m_dev_start(); they won't become
254 * multiplicative (__i2400m_dev_start() calling N times
255 * i2400m_fw_dnload() and this trying N times to download the
256 * firmware), as if __i2400m_dev_start() only retries if the
257 * firmware crashed while initializing the device (not in a
258 * general case).
259 *
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800260 * @bus_bm_cmd_send: [fill] Function called to send a boot-mode
261 * command. Flags are defined in 'enum i2400m_bm_cmd_flags'. This
262 * is synchronous and has to return 0 if ok or < 0 errno code in
263 * any error condition.
264 *
265 * @bus_bm_wait_for_ack: [fill] Function called to wait for a
266 * boot-mode notification (that can be a response to a previously
267 * issued command or an asynchronous one). Will read until all the
268 * indicated size is read or timeout. Reading more or less data
269 * than asked for is an error condition. Return 0 if ok, < 0 errno
270 * code on error.
271 *
272 * The caller to this function will check if the response is a
273 * barker that indicates the device going into reset mode.
274 *
Inaky Perez-Gonzalez1039abb2009-02-28 23:42:47 +0000275 * @bus_fw_names: [fill] a NULL-terminated array with the names of the
276 * firmware images to try loading. This is made a list so we can
277 * support backward compatibility of firmware releases (eg: if we
278 * can't find the default v1.4, we try v1.3). In general, the name
279 * should be i2400m-fw-X-VERSION.sbcf, where X is the bus name.
280 * The list is tried in order and the first one that loads is
281 * used. The fw loader will set i2400m->fw_name to point to the
282 * active firmware image.
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800283 *
284 * @bus_bm_mac_addr_impaired: [fill] Set to true if the device's MAC
285 * address provided in boot mode is kind of broken and needs to
286 * be re-read later on.
287 *
Dirk Brandewie7308a0c2009-05-21 11:56:34 -0700288 * @bus_bm_pokes_table: [fill/optional] A table of device addresses
289 * and values that will be poked at device init time to move the
290 * device to the correct state for the type of boot/firmware being
291 * used. This table MUST be terminated with (0x000000,
292 * 0x00000000) or bad things will happen.
293 *
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800294 *
295 * @wimax_dev: WiMAX generic device for linkage into the kernel WiMAX
296 * stack. Due to the way a net_device is allocated, we need to
297 * force this to be the first field so that we can get from
298 * netdev_priv() the right pointer.
299 *
Inaky Perez-Gonzalezc7475832009-02-28 23:42:54 +0000300 * @rx_reorder: 1 if RX reordering is enabled; this can only be
301 * set at probe time.
302 *
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800303 * @state: device's state (as reported by it)
304 *
305 * @state_wq: waitqueue that is woken up whenever the state changes
306 *
307 * @tx_lock: spinlock to protect TX members
308 *
309 * @tx_buf: FIFO buffer for TX; we queue data here
310 *
311 * @tx_in: FIFO index for incoming data. Note this doesn't wrap around
312 * and it is always greater than @tx_out.
313 *
314 * @tx_out: FIFO index for outgoing data
315 *
316 * @tx_msg: current TX message that is active in the FIFO for
317 * appending payloads.
318 *
319 * @tx_sequence: current sequence number for TX messages from the
320 * device to the host.
321 *
322 * @tx_msg_size: size of the current message being transmitted by the
323 * bus-specific code.
324 *
325 * @tx_pl_num: total number of payloads sent
326 *
327 * @tx_pl_max: maximum number of payloads sent in a TX message
328 *
329 * @tx_pl_min: minimum number of payloads sent in a TX message
330 *
331 * @tx_num: number of TX messages sent
332 *
333 * @tx_size_acc: number of bytes in all TX messages sent
334 * (this is different to net_dev's statistics as it also counts
335 * control messages).
336 *
337 * @tx_size_min: smallest TX message sent.
338 *
339 * @tx_size_max: biggest TX message sent.
340 *
341 * @rx_lock: spinlock to protect RX members
342 *
343 * @rx_pl_num: total number of payloads received
344 *
345 * @rx_pl_max: maximum number of payloads received in a RX message
346 *
347 * @rx_pl_min: minimum number of payloads received in a RX message
348 *
349 * @rx_num: number of RX messages received
350 *
351 * @rx_size_acc: number of bytes in all RX messages received
352 * (this is different to net_dev's statistics as it also counts
353 * control messages).
354 *
355 * @rx_size_min: smallest RX message received.
356 *
357 * @rx_size_max: buggest RX message received.
358 *
Inaky Perez-Gonzalezc7475832009-02-28 23:42:54 +0000359 * @rx_roq: RX ReOrder queues. (fw >= v1.4) When packets are received
360 * out of order, the device will ask the driver to hold certain
361 * packets until the ones that are received out of order can be
362 * delivered. Then the driver can release them to the host. See
363 * drivers/net/i2400m/rx.c for details.
364 *
Inaky Perez-Gonzalezfe442682009-04-22 16:53:08 -0700365 * @src_mac_addr: MAC address used to make ethernet packets be coming
366 * from. This is generated at i2400m_setup() time and used during
367 * the life cycle of the instance. See i2400m_fake_eth_header().
368 *
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800369 * @init_mutex: Mutex used for serializing the device bringup
370 * sequence; this way if the device reboots in the middle, we
371 * don't try to do a bringup again while we are tearing down the
372 * one that failed.
373 *
374 * Can't reuse @msg_mutex because from within the bringup sequence
375 * we need to send messages to the device and thus use @msg_mutex.
376 *
377 * @msg_mutex: mutex used to send control commands to the device (we
378 * only allow one at a time, per host-device interface design).
379 *
380 * @msg_completion: used to wait for an ack to a control command sent
381 * to the device.
382 *
383 * @ack_skb: used to store the actual ack to a control command if the
384 * reception of the command was successful. Otherwise, a ERR_PTR()
385 * errno code that indicates what failed with the ack reception.
386 *
387 * Only valid after @msg_completion is woken up. Only updateable
388 * if @msg_completion is armed. Only touched by
389 * i2400m_msg_to_dev().
390 *
391 * Protected by @rx_lock. In theory the command execution flow is
392 * sequential, but in case the device sends an out-of-phase or
393 * very delayed response, we need to avoid it trampling current
394 * execution.
395 *
396 * @bm_cmd_buf: boot mode command buffer for composing firmware upload
397 * commands.
398 *
399 * USB can't r/w to stack, vmalloc, etc...as well, we end up
400 * having to alloc/free a lot to compose commands, so we use these
401 * for stagging and not having to realloc all the time.
402 *
403 * This assumes the code always runs serialized. Only one thread
404 * can call i2400m_bm_cmd() at the same time.
405 *
406 * @bm_ack_buf: boot mode acknoledge buffer for staging reception of
407 * responses to commands.
408 *
409 * See @bm_cmd_buf.
410 *
411 * @work_queue: work queue for processing device reports. This
412 * workqueue cannot be used for processing TX or RX to the device,
413 * as from it we'll process device reports, which might require
414 * further communication with the device.
415 *
416 * @debugfs_dentry: hookup for debugfs files.
417 * These have to be in a separate directory, a child of
418 * (wimax_dev->debugfs_dentry) so they can be removed when the
419 * module unloads, as we don't keep each dentry.
Inaky Perez-Gonzalez1039abb2009-02-28 23:42:47 +0000420 *
421 * @fw_name: name of the firmware image that is currently being used.
Inaky Perez-Gonzalez6a0f7ab2009-02-28 23:42:49 +0000422 *
423 * @fw_version: version of the firmware interface, Major.minor,
424 * encoded in the high word and low word (major << 16 | minor).
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800425 */
426struct i2400m {
427 struct wimax_dev wimax_dev; /* FIRST! See doc */
428
429 unsigned updown:1; /* Network device is up or down */
430 unsigned boot_mode:1; /* is the device in boot mode? */
431 unsigned sboot:1; /* signed or unsigned fw boot */
432 unsigned ready:1; /* all probing steps done */
Inaky Perez-Gonzalezc7475832009-02-28 23:42:54 +0000433 unsigned rx_reorder:1; /* RX reorder is enabled */
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800434 u8 trace_msg_from_user; /* echo rx msgs to 'trace' pipe */
GeunSik Lim156f5a72009-06-02 15:01:37 +0900435 /* typed u8 so /sys/kernel/debug/u8 can tweak */
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800436 enum i2400m_system_state state;
437 wait_queue_head_t state_wq; /* Woken up when on state updates */
438
439 size_t bus_tx_block_size;
440 size_t bus_pl_size_max;
Inaky Perez-Gonzalezecddfd52009-06-03 16:13:14 +0800441 unsigned bus_bm_retries;
442
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800443 int (*bus_dev_start)(struct i2400m *);
444 void (*bus_dev_stop)(struct i2400m *);
445 void (*bus_tx_kick)(struct i2400m *);
446 int (*bus_reset)(struct i2400m *, enum i2400m_reset_type);
447 ssize_t (*bus_bm_cmd_send)(struct i2400m *,
448 const struct i2400m_bootrom_header *,
449 size_t, int flags);
450 ssize_t (*bus_bm_wait_for_ack)(struct i2400m *,
451 struct i2400m_bootrom_header *, size_t);
Inaky Perez-Gonzalez1039abb2009-02-28 23:42:47 +0000452 const char **bus_fw_names;
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800453 unsigned bus_bm_mac_addr_impaired:1;
Dirk Brandewie7308a0c2009-05-21 11:56:34 -0700454 const struct i2400m_poke_table *bus_bm_pokes_table;
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800455
456 spinlock_t tx_lock; /* protect TX state */
457 void *tx_buf;
458 size_t tx_in, tx_out;
459 struct i2400m_msg_hdr *tx_msg;
460 size_t tx_sequence, tx_msg_size;
461 /* TX stats */
462 unsigned tx_pl_num, tx_pl_max, tx_pl_min,
463 tx_num, tx_size_acc, tx_size_min, tx_size_max;
464
Inaky Perez-Gonzalezc7475832009-02-28 23:42:54 +0000465 /* RX stuff */
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800466 spinlock_t rx_lock; /* protect RX state */
467 unsigned rx_pl_num, rx_pl_max, rx_pl_min,
468 rx_num, rx_size_acc, rx_size_min, rx_size_max;
Inaky Perez-Gonzalezc7475832009-02-28 23:42:54 +0000469 struct i2400m_roq *rx_roq; /* not under rx_lock! */
Inaky Perez-Gonzalezfe442682009-04-22 16:53:08 -0700470 u8 src_mac_addr[ETH_HLEN];
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800471
472 struct mutex msg_mutex; /* serialize command execution */
473 struct completion msg_completion;
474 struct sk_buff *ack_skb; /* protected by rx_lock */
475
476 void *bm_ack_buf; /* for receiving acks over USB */
477 void *bm_cmd_buf; /* for issuing commands over USB */
478
479 struct workqueue_struct *work_queue;
480
481 struct mutex init_mutex; /* protect bringup seq */
482 struct i2400m_reset_ctx *reset_ctx; /* protected by init_mutex */
483
484 struct work_struct wake_tx_ws;
485 struct sk_buff *wake_tx_skb;
486
487 struct dentry *debugfs_dentry;
Inaky Perez-Gonzalez1039abb2009-02-28 23:42:47 +0000488 const char *fw_name; /* name of the current firmware image */
Inaky Perez-Gonzalez6a0f7ab2009-02-28 23:42:49 +0000489 unsigned long fw_version; /* version of the firmware interface */
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800490};
491
492
493/*
494 * Initialize a 'struct i2400m' from all zeroes
495 *
496 * This is a bus-generic API call.
497 */
498static inline
499void i2400m_init(struct i2400m *i2400m)
500{
501 wimax_dev_init(&i2400m->wimax_dev);
502
503 i2400m->boot_mode = 1;
Inaky Perez-Gonzalezc7475832009-02-28 23:42:54 +0000504 i2400m->rx_reorder = 1;
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800505 init_waitqueue_head(&i2400m->state_wq);
506
507 spin_lock_init(&i2400m->tx_lock);
508 i2400m->tx_pl_min = UINT_MAX;
509 i2400m->tx_size_min = UINT_MAX;
510
511 spin_lock_init(&i2400m->rx_lock);
512 i2400m->rx_pl_min = UINT_MAX;
513 i2400m->rx_size_min = UINT_MAX;
514
515 mutex_init(&i2400m->msg_mutex);
516 init_completion(&i2400m->msg_completion);
517
518 mutex_init(&i2400m->init_mutex);
519 /* wake_tx_ws is initialized in i2400m_tx_setup() */
520}
521
522
523/*
524 * Bus-generic internal APIs
525 * -------------------------
526 */
527
528static inline
529struct i2400m *wimax_dev_to_i2400m(struct wimax_dev *wimax_dev)
530{
531 return container_of(wimax_dev, struct i2400m, wimax_dev);
532}
533
534static inline
535struct i2400m *net_dev_to_i2400m(struct net_device *net_dev)
536{
537 return wimax_dev_to_i2400m(netdev_priv(net_dev));
538}
539
540/*
541 * Boot mode support
542 */
543
544/**
545 * i2400m_bm_cmd_flags - flags to i2400m_bm_cmd()
546 *
547 * @I2400M_BM_CMD_RAW: send the command block as-is, without doing any
548 * extra processing for adding CRC.
549 */
550enum i2400m_bm_cmd_flags {
551 I2400M_BM_CMD_RAW = 1 << 2,
552};
553
554/**
555 * i2400m_bri - Boot-ROM indicators
556 *
557 * Flags for i2400m_bootrom_init() and i2400m_dev_bootstrap() [which
558 * are passed from things like i2400m_setup()]. Can be combined with
559 * |.
560 *
561 * @I2400M_BRI_SOFT: The device rebooted already and a reboot
562 * barker received, proceed directly to ack the boot sequence.
563 * @I2400M_BRI_NO_REBOOT: Do not reboot the device and proceed
564 * directly to wait for a reboot barker from the device.
565 * @I2400M_BRI_MAC_REINIT: We need to reinitialize the boot
566 * rom after reading the MAC adress. This is quite a dirty hack,
567 * if you ask me -- the device requires the bootrom to be
568 * intialized after reading the MAC address.
569 */
570enum i2400m_bri {
571 I2400M_BRI_SOFT = 1 << 1,
572 I2400M_BRI_NO_REBOOT = 1 << 2,
573 I2400M_BRI_MAC_REINIT = 1 << 3,
574};
575
576extern void i2400m_bm_cmd_prepare(struct i2400m_bootrom_header *);
577extern int i2400m_dev_bootstrap(struct i2400m *, enum i2400m_bri);
578extern int i2400m_read_mac_addr(struct i2400m *);
579extern int i2400m_bootrom_init(struct i2400m *, enum i2400m_bri);
580
581/* Make/grok boot-rom header commands */
582
583static inline
584__le32 i2400m_brh_command(enum i2400m_brh_opcode opcode, unsigned use_checksum,
585 unsigned direct_access)
586{
587 return cpu_to_le32(
588 I2400M_BRH_SIGNATURE
589 | (direct_access ? I2400M_BRH_DIRECT_ACCESS : 0)
590 | I2400M_BRH_RESPONSE_REQUIRED /* response always required */
591 | (use_checksum ? I2400M_BRH_USE_CHECKSUM : 0)
592 | (opcode & I2400M_BRH_OPCODE_MASK));
593}
594
595static inline
596void i2400m_brh_set_opcode(struct i2400m_bootrom_header *hdr,
597 enum i2400m_brh_opcode opcode)
598{
599 hdr->command = cpu_to_le32(
600 (le32_to_cpu(hdr->command) & ~I2400M_BRH_OPCODE_MASK)
601 | (opcode & I2400M_BRH_OPCODE_MASK));
602}
603
604static inline
605unsigned i2400m_brh_get_opcode(const struct i2400m_bootrom_header *hdr)
606{
607 return le32_to_cpu(hdr->command) & I2400M_BRH_OPCODE_MASK;
608}
609
610static inline
611unsigned i2400m_brh_get_response(const struct i2400m_bootrom_header *hdr)
612{
613 return (le32_to_cpu(hdr->command) & I2400M_BRH_RESPONSE_MASK)
614 >> I2400M_BRH_RESPONSE_SHIFT;
615}
616
617static inline
618unsigned i2400m_brh_get_use_checksum(const struct i2400m_bootrom_header *hdr)
619{
620 return le32_to_cpu(hdr->command) & I2400M_BRH_USE_CHECKSUM;
621}
622
623static inline
624unsigned i2400m_brh_get_response_required(
625 const struct i2400m_bootrom_header *hdr)
626{
627 return le32_to_cpu(hdr->command) & I2400M_BRH_RESPONSE_REQUIRED;
628}
629
630static inline
631unsigned i2400m_brh_get_direct_access(const struct i2400m_bootrom_header *hdr)
632{
633 return le32_to_cpu(hdr->command) & I2400M_BRH_DIRECT_ACCESS;
634}
635
636static inline
637unsigned i2400m_brh_get_signature(const struct i2400m_bootrom_header *hdr)
638{
639 return (le32_to_cpu(hdr->command) & I2400M_BRH_SIGNATURE_MASK)
640 >> I2400M_BRH_SIGNATURE_SHIFT;
641}
642
643
644/*
645 * Driver / device setup and internal functions
646 */
647extern void i2400m_netdev_setup(struct net_device *net_dev);
Inaky Perez-Gonzalez89876912009-02-28 23:42:50 +0000648extern int i2400m_sysfs_setup(struct device_driver *);
649extern void i2400m_sysfs_release(struct device_driver *);
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800650extern int i2400m_tx_setup(struct i2400m *);
651extern void i2400m_wake_tx_work(struct work_struct *);
652extern void i2400m_tx_release(struct i2400m *);
653
Inaky Perez-Gonzalezc7475832009-02-28 23:42:54 +0000654extern int i2400m_rx_setup(struct i2400m *);
655extern void i2400m_rx_release(struct i2400m *);
656
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800657extern void i2400m_net_rx(struct i2400m *, struct sk_buff *, unsigned,
658 const void *, int);
Inaky Perez-Gonzalezfd5c5652009-02-28 23:42:52 +0000659extern void i2400m_net_erx(struct i2400m *, struct sk_buff *,
660 enum i2400m_cs);
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800661enum i2400m_pt;
662extern int i2400m_tx(struct i2400m *, const void *, size_t, enum i2400m_pt);
663
664#ifdef CONFIG_DEBUG_FS
665extern int i2400m_debugfs_add(struct i2400m *);
666extern void i2400m_debugfs_rm(struct i2400m *);
667#else
668static inline int i2400m_debugfs_add(struct i2400m *i2400m)
669{
670 return 0;
671}
672static inline void i2400m_debugfs_rm(struct i2400m *i2400m) {}
673#endif
674
675/* Called by _dev_start()/_dev_stop() to initialize the device itself */
676extern int i2400m_dev_initialize(struct i2400m *);
677extern void i2400m_dev_shutdown(struct i2400m *);
678
679extern struct attribute_group i2400m_dev_attr_group;
680
681extern int i2400m_schedule_work(struct i2400m *,
682 void (*)(struct work_struct *), gfp_t);
683
684/* HDI message's payload description handling */
685
686static inline
687size_t i2400m_pld_size(const struct i2400m_pld *pld)
688{
689 return I2400M_PLD_SIZE_MASK & le32_to_cpu(pld->val);
690}
691
692static inline
693enum i2400m_pt i2400m_pld_type(const struct i2400m_pld *pld)
694{
695 return (I2400M_PLD_TYPE_MASK & le32_to_cpu(pld->val))
696 >> I2400M_PLD_TYPE_SHIFT;
697}
698
699static inline
700void i2400m_pld_set(struct i2400m_pld *pld, size_t size,
701 enum i2400m_pt type)
702{
703 pld->val = cpu_to_le32(
704 ((type << I2400M_PLD_TYPE_SHIFT) & I2400M_PLD_TYPE_MASK)
705 | (size & I2400M_PLD_SIZE_MASK));
706}
707
708
709/*
710 * API for the bus-specific drivers
711 * --------------------------------
712 */
713
714static inline
715struct i2400m *i2400m_get(struct i2400m *i2400m)
716{
717 dev_hold(i2400m->wimax_dev.net_dev);
718 return i2400m;
719}
720
721static inline
722void i2400m_put(struct i2400m *i2400m)
723{
724 dev_put(i2400m->wimax_dev.net_dev);
725}
726
727extern int i2400m_dev_reset_handle(struct i2400m *);
728
729/*
730 * _setup()/_release() are called by the probe/disconnect functions of
731 * the bus-specific drivers.
732 */
733extern int i2400m_setup(struct i2400m *, enum i2400m_bri bm_flags);
734extern void i2400m_release(struct i2400m *);
735
736extern int i2400m_rx(struct i2400m *, struct sk_buff *);
737extern struct i2400m_msg_hdr *i2400m_tx_msg_get(struct i2400m *, size_t *);
738extern void i2400m_tx_msg_sent(struct i2400m *);
739
740static const __le32 i2400m_NBOOT_BARKER[4] = {
Harvey Harrisonee437772009-02-01 00:43:54 -0800741 cpu_to_le32(I2400M_NBOOT_BARKER),
742 cpu_to_le32(I2400M_NBOOT_BARKER),
743 cpu_to_le32(I2400M_NBOOT_BARKER),
744 cpu_to_le32(I2400M_NBOOT_BARKER)
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800745};
746
747static const __le32 i2400m_SBOOT_BARKER[4] = {
Harvey Harrisonee437772009-02-01 00:43:54 -0800748 cpu_to_le32(I2400M_SBOOT_BARKER),
749 cpu_to_le32(I2400M_SBOOT_BARKER),
750 cpu_to_le32(I2400M_SBOOT_BARKER),
751 cpu_to_le32(I2400M_SBOOT_BARKER)
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800752};
753
Inaky Perez-Gonzalezfb101672009-05-07 10:27:42 -0700754extern int i2400m_power_save_disabled;
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800755
756/*
757 * Utility functions
758 */
759
760static inline
761struct device *i2400m_dev(struct i2400m *i2400m)
762{
763 return i2400m->wimax_dev.net_dev->dev.parent;
764}
765
766/*
767 * Helper for scheduling simple work functions
768 *
769 * This struct can get any kind of payload attached (normally in the
770 * form of a struct where you pack the stuff you want to pass to the
771 * _work function).
772 */
773struct i2400m_work {
774 struct work_struct ws;
775 struct i2400m *i2400m;
776 u8 pl[0];
777};
778extern int i2400m_queue_work(struct i2400m *,
779 void (*)(struct work_struct *), gfp_t,
780 const void *, size_t);
781
782extern int i2400m_msg_check_status(const struct i2400m_l3l4_hdr *,
783 char *, size_t);
784extern int i2400m_msg_size_check(struct i2400m *,
785 const struct i2400m_l3l4_hdr *, size_t);
786extern struct sk_buff *i2400m_msg_to_dev(struct i2400m *, const void *, size_t);
787extern void i2400m_msg_to_dev_cancel_wait(struct i2400m *, int);
788extern void i2400m_msg_ack_hook(struct i2400m *,
789 const struct i2400m_l3l4_hdr *, size_t);
790extern void i2400m_report_hook(struct i2400m *,
791 const struct i2400m_l3l4_hdr *, size_t);
792extern int i2400m_cmd_enter_powersave(struct i2400m *);
793extern int i2400m_cmd_get_state(struct i2400m *);
794extern int i2400m_cmd_exit_idle(struct i2400m *);
795extern struct sk_buff *i2400m_get_device_info(struct i2400m *);
796extern int i2400m_firmware_check(struct i2400m *);
797extern int i2400m_set_init_config(struct i2400m *,
798 const struct i2400m_tlv_hdr **, size_t);
Inaky Perez-Gonzalez89876912009-02-28 23:42:50 +0000799extern int i2400m_set_idle_timeout(struct i2400m *, unsigned);
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800800
801static inline
802struct usb_endpoint_descriptor *usb_get_epd(struct usb_interface *iface, int ep)
803{
804 return &iface->cur_altsetting->endpoint[ep].desc;
805}
806
807extern int i2400m_op_rfkill_sw_toggle(struct wimax_dev *,
808 enum wimax_rf_state);
809extern void i2400m_report_tlv_rf_switches_status(
810 struct i2400m *, const struct i2400m_tlv_rf_switches_status *);
811
Inaky Perez-Gonzalez89876912009-02-28 23:42:50 +0000812/*
813 * Helpers for firmware backwards compability
814 *
815 * As we aim to support at least the firmware version that was
816 * released with the previous kernel/driver release, some code will be
817 * conditionally executed depending on the firmware version. On each
818 * release, the code to support fw releases past the last two ones
819 * will be purged.
820 *
821 * By making it depend on this macros, it is easier to keep it a tab
822 * on what has to go and what not.
823 */
824static inline
825unsigned i2400m_le_v1_3(struct i2400m *i2400m)
826{
827 /* running fw is lower or v1.3 */
828 return i2400m->fw_version <= 0x00090001;
829}
830
831static inline
832unsigned i2400m_ge_v1_4(struct i2400m *i2400m)
833{
834 /* running fw is higher or v1.4 */
835 return i2400m->fw_version >= 0x00090002;
836}
837
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800838
839/*
840 * Do a millisecond-sleep for allowing wireshark to dump all the data
841 * packets. Used only for debugging.
842 */
843static inline
844void __i2400m_msleep(unsigned ms)
845{
846#if 1
847#else
848 msleep(ms);
849#endif
850}
851
852/* Module parameters */
853
854extern int i2400m_idle_mode_disabled;
Inaky Perez-Gonzalezc7475832009-02-28 23:42:54 +0000855extern int i2400m_rx_reorder_disabled;
Inaky Perez-Gonzalezea246522008-12-20 16:57:43 -0800856
857
858#endif /* #ifndef __I2400M_H__ */