]>
Commit | Line | Data |
---|---|---|
ea24652d IPG |
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 | ||
ea24652d IPG |
159 | /** |
160 | * i2400m_reset_type - methods to reset a device | |
161 | * | |
162 | * @I2400M_RT_WARM: Reset without device disconnection, device handles | |
163 | * are kept valid but state is back to power on, with firmware | |
164 | * re-uploaded. | |
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. | |
169 | */ | |
170 | enum i2400m_reset_type { | |
171 | I2400M_RT_WARM, /* first measure */ | |
172 | I2400M_RT_COLD, /* second measure */ | |
173 | I2400M_RT_BUS, /* call in artillery */ | |
174 | }; | |
175 | ||
176 | struct i2400m_reset_ctx; | |
c747583d | 177 | struct i2400m_roq; |
ea24652d IPG |
178 | |
179 | /** | |
180 | * struct i2400m - descriptor for an Intel 2400m | |
181 | * | |
182 | * Members marked with [fill] must be filled out/initialized before | |
183 | * calling i2400m_setup(). | |
184 | * | |
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. | |
188 | * | |
189 | * @bus_pl_size_max: [fill] Maximum payload size. | |
190 | * | |
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. | |
194 | * | |
195 | * NOTE: Doesn't need to upload the firmware, as that is taken | |
196 | * care of by the bus-generic code. | |
197 | * | |
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. | |
201 | * | |
202 | * This function does not need to reset the device, just tear down | |
203 | * all the host resources created to handle communication with | |
204 | * the device. | |
205 | * | |
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. | |
209 | * | |
210 | * This function cannot sleep. | |
211 | * | |
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 | |
214 | * reset to finish. | |
215 | * | |
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). | |
219 | * | |
220 | * Note the warm reset is used by the firmware uploader to | |
221 | * reinitialize the device. | |
222 | * | |
223 | * IMPORTANT: this is called very early in the device setup | |
224 | * process, so it cannot rely on common infrastructure being laid | |
225 | * out. | |
226 | * | |
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. | |
231 | * | |
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 | |
237 | * code on error. | |
238 | * | |
239 | * The caller to this function will check if the response is a | |
240 | * barker that indicates the device going into reset mode. | |
241 | * | |
1039abbc IPG |
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. | |
ea24652d IPG |
250 | * |
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. | |
254 | * | |
255 | * | |
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. | |
260 | * | |
c747583d IPG |
261 | * @rx_reorder: 1 if RX reordering is enabled; this can only be |
262 | * set at probe time. | |
263 | * | |
ea24652d IPG |
264 | * @state: device's state (as reported by it) |
265 | * | |
266 | * @state_wq: waitqueue that is woken up whenever the state changes | |
267 | * | |
268 | * @tx_lock: spinlock to protect TX members | |
269 | * | |
270 | * @tx_buf: FIFO buffer for TX; we queue data here | |
271 | * | |
272 | * @tx_in: FIFO index for incoming data. Note this doesn't wrap around | |
273 | * and it is always greater than @tx_out. | |
274 | * | |
275 | * @tx_out: FIFO index for outgoing data | |
276 | * | |
277 | * @tx_msg: current TX message that is active in the FIFO for | |
278 | * appending payloads. | |
279 | * | |
280 | * @tx_sequence: current sequence number for TX messages from the | |
281 | * device to the host. | |
282 | * | |
283 | * @tx_msg_size: size of the current message being transmitted by the | |
284 | * bus-specific code. | |
285 | * | |
286 | * @tx_pl_num: total number of payloads sent | |
287 | * | |
288 | * @tx_pl_max: maximum number of payloads sent in a TX message | |
289 | * | |
290 | * @tx_pl_min: minimum number of payloads sent in a TX message | |
291 | * | |
292 | * @tx_num: number of TX messages sent | |
293 | * | |
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 | |
296 | * control messages). | |
297 | * | |
298 | * @tx_size_min: smallest TX message sent. | |
299 | * | |
300 | * @tx_size_max: biggest TX message sent. | |
301 | * | |
302 | * @rx_lock: spinlock to protect RX members | |
303 | * | |
304 | * @rx_pl_num: total number of payloads received | |
305 | * | |
306 | * @rx_pl_max: maximum number of payloads received in a RX message | |
307 | * | |
308 | * @rx_pl_min: minimum number of payloads received in a RX message | |
309 | * | |
310 | * @rx_num: number of RX messages received | |
311 | * | |
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 | |
314 | * control messages). | |
315 | * | |
316 | * @rx_size_min: smallest RX message received. | |
317 | * | |
318 | * @rx_size_max: buggest RX message received. | |
319 | * | |
c747583d IPG |
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. | |
325 | * | |
fe442683 IPG |
326 | * @src_mac_addr: MAC address used to make ethernet packets be coming |
327 | * from. This is generated at i2400m_setup() time and used during | |
328 | * the life cycle of the instance. See i2400m_fake_eth_header(). | |
329 | * | |
ea24652d IPG |
330 | * @init_mutex: Mutex used for serializing the device bringup |
331 | * sequence; this way if the device reboots in the middle, we | |
332 | * don't try to do a bringup again while we are tearing down the | |
333 | * one that failed. | |
334 | * | |
335 | * Can't reuse @msg_mutex because from within the bringup sequence | |
336 | * we need to send messages to the device and thus use @msg_mutex. | |
337 | * | |
338 | * @msg_mutex: mutex used to send control commands to the device (we | |
339 | * only allow one at a time, per host-device interface design). | |
340 | * | |
341 | * @msg_completion: used to wait for an ack to a control command sent | |
342 | * to the device. | |
343 | * | |
344 | * @ack_skb: used to store the actual ack to a control command if the | |
345 | * reception of the command was successful. Otherwise, a ERR_PTR() | |
346 | * errno code that indicates what failed with the ack reception. | |
347 | * | |
348 | * Only valid after @msg_completion is woken up. Only updateable | |
349 | * if @msg_completion is armed. Only touched by | |
350 | * i2400m_msg_to_dev(). | |
351 | * | |
352 | * Protected by @rx_lock. In theory the command execution flow is | |
353 | * sequential, but in case the device sends an out-of-phase or | |
354 | * very delayed response, we need to avoid it trampling current | |
355 | * execution. | |
356 | * | |
357 | * @bm_cmd_buf: boot mode command buffer for composing firmware upload | |
358 | * commands. | |
359 | * | |
360 | * USB can't r/w to stack, vmalloc, etc...as well, we end up | |
361 | * having to alloc/free a lot to compose commands, so we use these | |
362 | * for stagging and not having to realloc all the time. | |
363 | * | |
364 | * This assumes the code always runs serialized. Only one thread | |
365 | * can call i2400m_bm_cmd() at the same time. | |
366 | * | |
367 | * @bm_ack_buf: boot mode acknoledge buffer for staging reception of | |
368 | * responses to commands. | |
369 | * | |
370 | * See @bm_cmd_buf. | |
371 | * | |
372 | * @work_queue: work queue for processing device reports. This | |
373 | * workqueue cannot be used for processing TX or RX to the device, | |
374 | * as from it we'll process device reports, which might require | |
375 | * further communication with the device. | |
376 | * | |
377 | * @debugfs_dentry: hookup for debugfs files. | |
378 | * These have to be in a separate directory, a child of | |
379 | * (wimax_dev->debugfs_dentry) so they can be removed when the | |
380 | * module unloads, as we don't keep each dentry. | |
1039abbc IPG |
381 | * |
382 | * @fw_name: name of the firmware image that is currently being used. | |
6a0f7ab8 IPG |
383 | * |
384 | * @fw_version: version of the firmware interface, Major.minor, | |
385 | * encoded in the high word and low word (major << 16 | minor). | |
ea24652d IPG |
386 | */ |
387 | struct i2400m { | |
388 | struct wimax_dev wimax_dev; /* FIRST! See doc */ | |
389 | ||
390 | unsigned updown:1; /* Network device is up or down */ | |
391 | unsigned boot_mode:1; /* is the device in boot mode? */ | |
392 | unsigned sboot:1; /* signed or unsigned fw boot */ | |
393 | unsigned ready:1; /* all probing steps done */ | |
c747583d | 394 | unsigned rx_reorder:1; /* RX reorder is enabled */ |
ea24652d IPG |
395 | u8 trace_msg_from_user; /* echo rx msgs to 'trace' pipe */ |
396 | /* typed u8 so debugfs/u8 can tweak */ | |
397 | enum i2400m_system_state state; | |
398 | wait_queue_head_t state_wq; /* Woken up when on state updates */ | |
399 | ||
400 | size_t bus_tx_block_size; | |
401 | size_t bus_pl_size_max; | |
402 | int (*bus_dev_start)(struct i2400m *); | |
403 | void (*bus_dev_stop)(struct i2400m *); | |
404 | void (*bus_tx_kick)(struct i2400m *); | |
405 | int (*bus_reset)(struct i2400m *, enum i2400m_reset_type); | |
406 | ssize_t (*bus_bm_cmd_send)(struct i2400m *, | |
407 | const struct i2400m_bootrom_header *, | |
408 | size_t, int flags); | |
409 | ssize_t (*bus_bm_wait_for_ack)(struct i2400m *, | |
410 | struct i2400m_bootrom_header *, size_t); | |
1039abbc | 411 | const char **bus_fw_names; |
ea24652d IPG |
412 | unsigned bus_bm_mac_addr_impaired:1; |
413 | ||
414 | spinlock_t tx_lock; /* protect TX state */ | |
415 | void *tx_buf; | |
416 | size_t tx_in, tx_out; | |
417 | struct i2400m_msg_hdr *tx_msg; | |
418 | size_t tx_sequence, tx_msg_size; | |
419 | /* TX stats */ | |
420 | unsigned tx_pl_num, tx_pl_max, tx_pl_min, | |
421 | tx_num, tx_size_acc, tx_size_min, tx_size_max; | |
422 | ||
c747583d | 423 | /* RX stuff */ |
ea24652d IPG |
424 | spinlock_t rx_lock; /* protect RX state */ |
425 | unsigned rx_pl_num, rx_pl_max, rx_pl_min, | |
426 | rx_num, rx_size_acc, rx_size_min, rx_size_max; | |
c747583d | 427 | struct i2400m_roq *rx_roq; /* not under rx_lock! */ |
fe442683 | 428 | u8 src_mac_addr[ETH_HLEN]; |
ea24652d IPG |
429 | |
430 | struct mutex msg_mutex; /* serialize command execution */ | |
431 | struct completion msg_completion; | |
432 | struct sk_buff *ack_skb; /* protected by rx_lock */ | |
433 | ||
434 | void *bm_ack_buf; /* for receiving acks over USB */ | |
435 | void *bm_cmd_buf; /* for issuing commands over USB */ | |
436 | ||
437 | struct workqueue_struct *work_queue; | |
438 | ||
439 | struct mutex init_mutex; /* protect bringup seq */ | |
440 | struct i2400m_reset_ctx *reset_ctx; /* protected by init_mutex */ | |
441 | ||
442 | struct work_struct wake_tx_ws; | |
443 | struct sk_buff *wake_tx_skb; | |
444 | ||
445 | struct dentry *debugfs_dentry; | |
1039abbc | 446 | const char *fw_name; /* name of the current firmware image */ |
6a0f7ab8 | 447 | unsigned long fw_version; /* version of the firmware interface */ |
ea24652d IPG |
448 | }; |
449 | ||
450 | ||
451 | /* | |
452 | * Initialize a 'struct i2400m' from all zeroes | |
453 | * | |
454 | * This is a bus-generic API call. | |
455 | */ | |
456 | static inline | |
457 | void i2400m_init(struct i2400m *i2400m) | |
458 | { | |
459 | wimax_dev_init(&i2400m->wimax_dev); | |
460 | ||
461 | i2400m->boot_mode = 1; | |
c747583d | 462 | i2400m->rx_reorder = 1; |
ea24652d IPG |
463 | init_waitqueue_head(&i2400m->state_wq); |
464 | ||
465 | spin_lock_init(&i2400m->tx_lock); | |
466 | i2400m->tx_pl_min = UINT_MAX; | |
467 | i2400m->tx_size_min = UINT_MAX; | |
468 | ||
469 | spin_lock_init(&i2400m->rx_lock); | |
470 | i2400m->rx_pl_min = UINT_MAX; | |
471 | i2400m->rx_size_min = UINT_MAX; | |
472 | ||
473 | mutex_init(&i2400m->msg_mutex); | |
474 | init_completion(&i2400m->msg_completion); | |
475 | ||
476 | mutex_init(&i2400m->init_mutex); | |
477 | /* wake_tx_ws is initialized in i2400m_tx_setup() */ | |
478 | } | |
479 | ||
480 | ||
481 | /* | |
482 | * Bus-generic internal APIs | |
483 | * ------------------------- | |
484 | */ | |
485 | ||
486 | static inline | |
487 | struct i2400m *wimax_dev_to_i2400m(struct wimax_dev *wimax_dev) | |
488 | { | |
489 | return container_of(wimax_dev, struct i2400m, wimax_dev); | |
490 | } | |
491 | ||
492 | static inline | |
493 | struct i2400m *net_dev_to_i2400m(struct net_device *net_dev) | |
494 | { | |
495 | return wimax_dev_to_i2400m(netdev_priv(net_dev)); | |
496 | } | |
497 | ||
498 | /* | |
499 | * Boot mode support | |
500 | */ | |
501 | ||
502 | /** | |
503 | * i2400m_bm_cmd_flags - flags to i2400m_bm_cmd() | |
504 | * | |
505 | * @I2400M_BM_CMD_RAW: send the command block as-is, without doing any | |
506 | * extra processing for adding CRC. | |
507 | */ | |
508 | enum i2400m_bm_cmd_flags { | |
509 | I2400M_BM_CMD_RAW = 1 << 2, | |
510 | }; | |
511 | ||
512 | /** | |
513 | * i2400m_bri - Boot-ROM indicators | |
514 | * | |
515 | * Flags for i2400m_bootrom_init() and i2400m_dev_bootstrap() [which | |
516 | * are passed from things like i2400m_setup()]. Can be combined with | |
517 | * |. | |
518 | * | |
519 | * @I2400M_BRI_SOFT: The device rebooted already and a reboot | |
520 | * barker received, proceed directly to ack the boot sequence. | |
521 | * @I2400M_BRI_NO_REBOOT: Do not reboot the device and proceed | |
522 | * directly to wait for a reboot barker from the device. | |
523 | * @I2400M_BRI_MAC_REINIT: We need to reinitialize the boot | |
524 | * rom after reading the MAC adress. This is quite a dirty hack, | |
525 | * if you ask me -- the device requires the bootrom to be | |
526 | * intialized after reading the MAC address. | |
527 | */ | |
528 | enum i2400m_bri { | |
529 | I2400M_BRI_SOFT = 1 << 1, | |
530 | I2400M_BRI_NO_REBOOT = 1 << 2, | |
531 | I2400M_BRI_MAC_REINIT = 1 << 3, | |
532 | }; | |
533 | ||
534 | extern void i2400m_bm_cmd_prepare(struct i2400m_bootrom_header *); | |
535 | extern int i2400m_dev_bootstrap(struct i2400m *, enum i2400m_bri); | |
536 | extern int i2400m_read_mac_addr(struct i2400m *); | |
537 | extern int i2400m_bootrom_init(struct i2400m *, enum i2400m_bri); | |
538 | ||
539 | /* Make/grok boot-rom header commands */ | |
540 | ||
541 | static inline | |
542 | __le32 i2400m_brh_command(enum i2400m_brh_opcode opcode, unsigned use_checksum, | |
543 | unsigned direct_access) | |
544 | { | |
545 | return cpu_to_le32( | |
546 | I2400M_BRH_SIGNATURE | |
547 | | (direct_access ? I2400M_BRH_DIRECT_ACCESS : 0) | |
548 | | I2400M_BRH_RESPONSE_REQUIRED /* response always required */ | |
549 | | (use_checksum ? I2400M_BRH_USE_CHECKSUM : 0) | |
550 | | (opcode & I2400M_BRH_OPCODE_MASK)); | |
551 | } | |
552 | ||
553 | static inline | |
554 | void i2400m_brh_set_opcode(struct i2400m_bootrom_header *hdr, | |
555 | enum i2400m_brh_opcode opcode) | |
556 | { | |
557 | hdr->command = cpu_to_le32( | |
558 | (le32_to_cpu(hdr->command) & ~I2400M_BRH_OPCODE_MASK) | |
559 | | (opcode & I2400M_BRH_OPCODE_MASK)); | |
560 | } | |
561 | ||
562 | static inline | |
563 | unsigned i2400m_brh_get_opcode(const struct i2400m_bootrom_header *hdr) | |
564 | { | |
565 | return le32_to_cpu(hdr->command) & I2400M_BRH_OPCODE_MASK; | |
566 | } | |
567 | ||
568 | static inline | |
569 | unsigned i2400m_brh_get_response(const struct i2400m_bootrom_header *hdr) | |
570 | { | |
571 | return (le32_to_cpu(hdr->command) & I2400M_BRH_RESPONSE_MASK) | |
572 | >> I2400M_BRH_RESPONSE_SHIFT; | |
573 | } | |
574 | ||
575 | static inline | |
576 | unsigned i2400m_brh_get_use_checksum(const struct i2400m_bootrom_header *hdr) | |
577 | { | |
578 | return le32_to_cpu(hdr->command) & I2400M_BRH_USE_CHECKSUM; | |
579 | } | |
580 | ||
581 | static inline | |
582 | unsigned i2400m_brh_get_response_required( | |
583 | const struct i2400m_bootrom_header *hdr) | |
584 | { | |
585 | return le32_to_cpu(hdr->command) & I2400M_BRH_RESPONSE_REQUIRED; | |
586 | } | |
587 | ||
588 | static inline | |
589 | unsigned i2400m_brh_get_direct_access(const struct i2400m_bootrom_header *hdr) | |
590 | { | |
591 | return le32_to_cpu(hdr->command) & I2400M_BRH_DIRECT_ACCESS; | |
592 | } | |
593 | ||
594 | static inline | |
595 | unsigned i2400m_brh_get_signature(const struct i2400m_bootrom_header *hdr) | |
596 | { | |
597 | return (le32_to_cpu(hdr->command) & I2400M_BRH_SIGNATURE_MASK) | |
598 | >> I2400M_BRH_SIGNATURE_SHIFT; | |
599 | } | |
600 | ||
601 | ||
602 | /* | |
603 | * Driver / device setup and internal functions | |
604 | */ | |
605 | extern void i2400m_netdev_setup(struct net_device *net_dev); | |
8987691a IPG |
606 | extern int i2400m_sysfs_setup(struct device_driver *); |
607 | extern void i2400m_sysfs_release(struct device_driver *); | |
ea24652d IPG |
608 | extern int i2400m_tx_setup(struct i2400m *); |
609 | extern void i2400m_wake_tx_work(struct work_struct *); | |
610 | extern void i2400m_tx_release(struct i2400m *); | |
611 | ||
c747583d IPG |
612 | extern int i2400m_rx_setup(struct i2400m *); |
613 | extern void i2400m_rx_release(struct i2400m *); | |
614 | ||
ea24652d IPG |
615 | extern void i2400m_net_rx(struct i2400m *, struct sk_buff *, unsigned, |
616 | const void *, int); | |
fd5c565c IPG |
617 | extern void i2400m_net_erx(struct i2400m *, struct sk_buff *, |
618 | enum i2400m_cs); | |
ea24652d IPG |
619 | enum i2400m_pt; |
620 | extern int i2400m_tx(struct i2400m *, const void *, size_t, enum i2400m_pt); | |
621 | ||
622 | #ifdef CONFIG_DEBUG_FS | |
623 | extern int i2400m_debugfs_add(struct i2400m *); | |
624 | extern void i2400m_debugfs_rm(struct i2400m *); | |
625 | #else | |
626 | static inline int i2400m_debugfs_add(struct i2400m *i2400m) | |
627 | { | |
628 | return 0; | |
629 | } | |
630 | static inline void i2400m_debugfs_rm(struct i2400m *i2400m) {} | |
631 | #endif | |
632 | ||
633 | /* Called by _dev_start()/_dev_stop() to initialize the device itself */ | |
634 | extern int i2400m_dev_initialize(struct i2400m *); | |
635 | extern void i2400m_dev_shutdown(struct i2400m *); | |
636 | ||
637 | extern struct attribute_group i2400m_dev_attr_group; | |
638 | ||
639 | extern int i2400m_schedule_work(struct i2400m *, | |
640 | void (*)(struct work_struct *), gfp_t); | |
641 | ||
642 | /* HDI message's payload description handling */ | |
643 | ||
644 | static inline | |
645 | size_t i2400m_pld_size(const struct i2400m_pld *pld) | |
646 | { | |
647 | return I2400M_PLD_SIZE_MASK & le32_to_cpu(pld->val); | |
648 | } | |
649 | ||
650 | static inline | |
651 | enum i2400m_pt i2400m_pld_type(const struct i2400m_pld *pld) | |
652 | { | |
653 | return (I2400M_PLD_TYPE_MASK & le32_to_cpu(pld->val)) | |
654 | >> I2400M_PLD_TYPE_SHIFT; | |
655 | } | |
656 | ||
657 | static inline | |
658 | void i2400m_pld_set(struct i2400m_pld *pld, size_t size, | |
659 | enum i2400m_pt type) | |
660 | { | |
661 | pld->val = cpu_to_le32( | |
662 | ((type << I2400M_PLD_TYPE_SHIFT) & I2400M_PLD_TYPE_MASK) | |
663 | | (size & I2400M_PLD_SIZE_MASK)); | |
664 | } | |
665 | ||
666 | ||
667 | /* | |
668 | * API for the bus-specific drivers | |
669 | * -------------------------------- | |
670 | */ | |
671 | ||
672 | static inline | |
673 | struct i2400m *i2400m_get(struct i2400m *i2400m) | |
674 | { | |
675 | dev_hold(i2400m->wimax_dev.net_dev); | |
676 | return i2400m; | |
677 | } | |
678 | ||
679 | static inline | |
680 | void i2400m_put(struct i2400m *i2400m) | |
681 | { | |
682 | dev_put(i2400m->wimax_dev.net_dev); | |
683 | } | |
684 | ||
685 | extern int i2400m_dev_reset_handle(struct i2400m *); | |
686 | ||
687 | /* | |
688 | * _setup()/_release() are called by the probe/disconnect functions of | |
689 | * the bus-specific drivers. | |
690 | */ | |
691 | extern int i2400m_setup(struct i2400m *, enum i2400m_bri bm_flags); | |
692 | extern void i2400m_release(struct i2400m *); | |
693 | ||
694 | extern int i2400m_rx(struct i2400m *, struct sk_buff *); | |
695 | extern struct i2400m_msg_hdr *i2400m_tx_msg_get(struct i2400m *, size_t *); | |
696 | extern void i2400m_tx_msg_sent(struct i2400m *); | |
697 | ||
698 | static const __le32 i2400m_NBOOT_BARKER[4] = { | |
ee437770 HH |
699 | cpu_to_le32(I2400M_NBOOT_BARKER), |
700 | cpu_to_le32(I2400M_NBOOT_BARKER), | |
701 | cpu_to_le32(I2400M_NBOOT_BARKER), | |
702 | cpu_to_le32(I2400M_NBOOT_BARKER) | |
ea24652d IPG |
703 | }; |
704 | ||
705 | static const __le32 i2400m_SBOOT_BARKER[4] = { | |
ee437770 HH |
706 | cpu_to_le32(I2400M_SBOOT_BARKER), |
707 | cpu_to_le32(I2400M_SBOOT_BARKER), | |
708 | cpu_to_le32(I2400M_SBOOT_BARKER), | |
709 | cpu_to_le32(I2400M_SBOOT_BARKER) | |
ea24652d IPG |
710 | }; |
711 | ||
712 | ||
713 | /* | |
714 | * Utility functions | |
715 | */ | |
716 | ||
717 | static inline | |
718 | struct device *i2400m_dev(struct i2400m *i2400m) | |
719 | { | |
720 | return i2400m->wimax_dev.net_dev->dev.parent; | |
721 | } | |
722 | ||
723 | /* | |
724 | * Helper for scheduling simple work functions | |
725 | * | |
726 | * This struct can get any kind of payload attached (normally in the | |
727 | * form of a struct where you pack the stuff you want to pass to the | |
728 | * _work function). | |
729 | */ | |
730 | struct i2400m_work { | |
731 | struct work_struct ws; | |
732 | struct i2400m *i2400m; | |
733 | u8 pl[0]; | |
734 | }; | |
735 | extern int i2400m_queue_work(struct i2400m *, | |
736 | void (*)(struct work_struct *), gfp_t, | |
737 | const void *, size_t); | |
738 | ||
739 | extern int i2400m_msg_check_status(const struct i2400m_l3l4_hdr *, | |
740 | char *, size_t); | |
741 | extern int i2400m_msg_size_check(struct i2400m *, | |
742 | const struct i2400m_l3l4_hdr *, size_t); | |
743 | extern struct sk_buff *i2400m_msg_to_dev(struct i2400m *, const void *, size_t); | |
744 | extern void i2400m_msg_to_dev_cancel_wait(struct i2400m *, int); | |
745 | extern void i2400m_msg_ack_hook(struct i2400m *, | |
746 | const struct i2400m_l3l4_hdr *, size_t); | |
747 | extern void i2400m_report_hook(struct i2400m *, | |
748 | const struct i2400m_l3l4_hdr *, size_t); | |
749 | extern int i2400m_cmd_enter_powersave(struct i2400m *); | |
750 | extern int i2400m_cmd_get_state(struct i2400m *); | |
751 | extern int i2400m_cmd_exit_idle(struct i2400m *); | |
752 | extern struct sk_buff *i2400m_get_device_info(struct i2400m *); | |
753 | extern int i2400m_firmware_check(struct i2400m *); | |
754 | extern int i2400m_set_init_config(struct i2400m *, | |
755 | const struct i2400m_tlv_hdr **, size_t); | |
8987691a | 756 | extern int i2400m_set_idle_timeout(struct i2400m *, unsigned); |
ea24652d IPG |
757 | |
758 | static inline | |
759 | struct usb_endpoint_descriptor *usb_get_epd(struct usb_interface *iface, int ep) | |
760 | { | |
761 | return &iface->cur_altsetting->endpoint[ep].desc; | |
762 | } | |
763 | ||
764 | extern int i2400m_op_rfkill_sw_toggle(struct wimax_dev *, | |
765 | enum wimax_rf_state); | |
766 | extern void i2400m_report_tlv_rf_switches_status( | |
767 | struct i2400m *, const struct i2400m_tlv_rf_switches_status *); | |
768 | ||
8987691a IPG |
769 | /* |
770 | * Helpers for firmware backwards compability | |
771 | * | |
772 | * As we aim to support at least the firmware version that was | |
773 | * released with the previous kernel/driver release, some code will be | |
774 | * conditionally executed depending on the firmware version. On each | |
775 | * release, the code to support fw releases past the last two ones | |
776 | * will be purged. | |
777 | * | |
778 | * By making it depend on this macros, it is easier to keep it a tab | |
779 | * on what has to go and what not. | |
780 | */ | |
781 | static inline | |
782 | unsigned i2400m_le_v1_3(struct i2400m *i2400m) | |
783 | { | |
784 | /* running fw is lower or v1.3 */ | |
785 | return i2400m->fw_version <= 0x00090001; | |
786 | } | |
787 | ||
788 | static inline | |
789 | unsigned i2400m_ge_v1_4(struct i2400m *i2400m) | |
790 | { | |
791 | /* running fw is higher or v1.4 */ | |
792 | return i2400m->fw_version >= 0x00090002; | |
793 | } | |
794 | ||
ea24652d IPG |
795 | |
796 | /* | |
797 | * Do a millisecond-sleep for allowing wireshark to dump all the data | |
798 | * packets. Used only for debugging. | |
799 | */ | |
800 | static inline | |
801 | void __i2400m_msleep(unsigned ms) | |
802 | { | |
803 | #if 1 | |
804 | #else | |
805 | msleep(ms); | |
806 | #endif | |
807 | } | |
808 | ||
809 | /* Module parameters */ | |
810 | ||
811 | extern int i2400m_idle_mode_disabled; | |
c747583d | 812 | extern int i2400m_rx_reorder_disabled; |
ea24652d IPG |
813 | |
814 | ||
815 | #endif /* #ifndef __I2400M_H__ */ |