iwlwifi: move ucode loading to op_mode
[linux-2.6/btrfs-unstable.git] / drivers / net / wireless / iwlwifi / iwl-trans.h
blob6fa0c860a5e2b66c8f74b8d1bace69cc897f6a4d
1 /******************************************************************************
3 * This file is provided under a dual BSD/GPLv2 license. When using or
4 * redistributing this file, you may do so under either license.
6 * GPL LICENSE SUMMARY
8 * Copyright(c) 2007 - 2012 Intel Corporation. All rights reserved.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of version 2 of the GNU General Public License as
12 * published by the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
22 * USA
24 * The full GNU General Public License is included in this distribution
25 * in the file called LICENSE.GPL.
27 * Contact Information:
28 * Intel Linux Wireless <ilw@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
31 * BSD LICENSE
33 * Copyright(c) 2005 - 2012 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
38 * are met:
40 * * Redistributions of source code must retain the above copyright
41 * notice, this list of conditions and the following disclaimer.
42 * * Redistributions in binary form must reproduce the above copyright
43 * notice, this list of conditions and the following disclaimer in
44 * the documentation and/or other materials provided with the
45 * distribution.
46 * * Neither the name Intel Corporation nor the names of its
47 * contributors may be used to endorse or promote products derived
48 * from this software without specific prior written permission.
50 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
54 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
56 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
57 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
58 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
59 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
60 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62 *****************************************************************************/
63 #ifndef __iwl_trans_h__
64 #define __iwl_trans_h__
66 #include <linux/ieee80211.h>
67 #include <linux/mm.h> /* for page_address */
69 #include "iwl-shared.h"
70 #include "iwl-debug.h"
72 /**
73 * DOC: Transport layer - what is it ?
75 * The tranport layer is the layer that deals with the HW directly. It provides
76 * an abstraction of the underlying HW to the upper layer. The transport layer
77 * doesn't provide any policy, algorithm or anything of this kind, but only
78 * mechanisms to make the HW do something.It is not completely stateless but
79 * close to it.
80 * We will have an implementation for each different supported bus.
83 /**
84 * DOC: Life cycle of the transport layer
86 * The transport layer has a very precise life cycle.
88 * 1) A helper function is called during the module initialization and
89 * registers the bus driver's ops with the transport's alloc function.
90 * 2) Bus's probe calls to the transport layer's allocation functions.
91 * Of course this function is bus specific.
92 * 3) This allocation functions will spawn the upper layer which will
93 * register mac80211.
95 * 4) At some point (i.e. mac80211's start call), the op_mode will call
96 * the following sequence:
97 * start_hw
98 * start_fw
100 * 5) Then when finished (or reset):
101 * stop_fw (a.k.a. stop device for the moment)
102 * stop_hw
104 * 6) Eventually, the free function will be called.
107 struct iwl_priv;
108 struct iwl_shared;
109 struct iwl_op_mode;
110 struct fw_img;
111 struct sk_buff;
112 struct dentry;
115 * DOC: Host command section
117 * A host command is a commaned issued by the upper layer to the fw. There are
118 * several versions of fw that have several APIs. The transport layer is
119 * completely agnostic to these differences.
120 * The transport does provide helper functionnality (i.e. SYNC / ASYNC mode),
122 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
123 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
124 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
127 * enum CMD_MODE - how to send the host commands ?
129 * @CMD_SYNC: The caller will be stalled until the fw responds to the command
130 * @CMD_ASYNC: Return right away and don't want for the response
131 * @CMD_WANT_SKB: valid only with CMD_SYNC. The caller needs the buffer of the
132 * response.
133 * @CMD_ON_DEMAND: This command is sent by the test mode pipe.
135 enum CMD_MODE {
136 CMD_SYNC = 0,
137 CMD_ASYNC = BIT(0),
138 CMD_WANT_SKB = BIT(1),
139 CMD_ON_DEMAND = BIT(2),
142 #define DEF_CMD_PAYLOAD_SIZE 320
145 * struct iwl_device_cmd
147 * For allocation of the command and tx queues, this establishes the overall
148 * size of the largest command we send to uCode, except for commands that
149 * aren't fully copied and use other TFD space.
151 struct iwl_device_cmd {
152 struct iwl_cmd_header hdr; /* uCode API */
153 u8 payload[DEF_CMD_PAYLOAD_SIZE];
154 } __packed;
156 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
158 #define IWL_MAX_CMD_TFDS 2
161 * struct iwl_hcmd_dataflag - flag for each one of the chunks of the command
163 * IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's
164 * ring. The transport layer doesn't map the command's buffer to DMA, but
165 * rather copies it to an previously allocated DMA buffer. This flag tells
166 * the transport layer not to copy the command, but to map the existing
167 * buffer. This can save memcpy and is worth with very big comamnds.
169 enum iwl_hcmd_dataflag {
170 IWL_HCMD_DFL_NOCOPY = BIT(0),
174 * struct iwl_host_cmd - Host command to the uCode
176 * @data: array of chunks that composes the data of the host command
177 * @resp_pkt: response packet, if %CMD_WANT_SKB was set
178 * @_rx_page_order: (internally used to free response packet)
179 * @_rx_page_addr: (internally used to free response packet)
180 * @handler_status: return value of the handler of the command
181 * (put in setup_rx_handlers) - valid for SYNC mode only
182 * @flags: can be CMD_*
183 * @len: array of the lenths of the chunks in data
184 * @dataflags: IWL_HCMD_DFL_*
185 * @id: id of the host command
187 struct iwl_host_cmd {
188 const void *data[IWL_MAX_CMD_TFDS];
189 struct iwl_rx_packet *resp_pkt;
190 unsigned long _rx_page_addr;
191 u32 _rx_page_order;
192 int handler_status;
194 u32 flags;
195 u16 len[IWL_MAX_CMD_TFDS];
196 u8 dataflags[IWL_MAX_CMD_TFDS];
197 u8 id;
200 static inline void iwl_free_resp(struct iwl_host_cmd *cmd)
202 free_pages(cmd->_rx_page_addr, cmd->_rx_page_order);
205 struct iwl_rx_cmd_buffer {
206 struct page *_page;
209 static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r)
211 return page_address(r->_page);
214 static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r)
216 struct page *p = r->_page;
217 r->_page = NULL;
218 return p;
222 * struct iwl_trans_ops - transport specific operations
224 * All the handlers MUST be implemented
226 * @start_hw: starts the HW- from that point on, the HW can send interrupts
227 * May sleep
228 * @stop_hw: stops the HW- from that point on, the HW will be in low power but
229 * will still issue interrupt if the HW RF kill is triggered.
230 * May sleep
231 * @start_fw: allocates and inits all the resources for the transport
232 * layer. Also kick a fw image.
233 * May sleep
234 * @fw_alive: called when the fw sends alive notification
235 * May sleep
236 * @wake_any_queue: wake all the queues of a specfic context IWL_RXON_CTX_*
237 * @stop_device:stops the whole device (embedded CPU put to reset)
238 * May sleep
239 * @wowlan_suspend: put the device into the correct mode for WoWLAN during
240 * suspend. This is optional, if not implemented WoWLAN will not be
241 * supported. This callback may sleep.
242 * @send_cmd:send a host command
243 * May sleep only if CMD_SYNC is set
244 * @tx: send an skb
245 * Must be atomic
246 * @reclaim: free packet until ssn. Returns a list of freed packets.
247 * Must be atomic
248 * @tx_agg_alloc: allocate resources for a TX BA session
249 * Must be atomic
250 * @tx_agg_setup: setup a tx queue for AMPDU - will be called once the HW is
251 * ready and a successful ADDBA response has been received.
252 * May sleep
253 * @tx_agg_disable: de-configure a Tx queue to send AMPDUs
254 * May sleep
255 * @free: release all the ressource for the transport layer itself such as
256 * irq, tasklet etc... From this point on, the device may not issue
257 * any interrupt (incl. RFKILL).
258 * May sleep
259 * @stop_queue: stop a specific queue
260 * @check_stuck_queue: check if a specific queue is stuck
261 * @wait_tx_queue_empty: wait until all tx queues are empty
262 * May sleep
263 * @dbgfs_register: add the dbgfs files under this directory. Files will be
264 * automatically deleted.
265 * @suspend: stop the device unless WoWLAN is configured
266 * @resume: resume activity of the device
267 * @write8: write a u8 to a register at offset ofs from the BAR
268 * @write32: write a u32 to a register at offset ofs from the BAR
269 * @read32: read a u32 register at offset ofs from the BAR
271 struct iwl_trans_ops {
273 int (*start_hw)(struct iwl_trans *iwl_trans);
274 void (*stop_hw)(struct iwl_trans *iwl_trans);
275 int (*start_fw)(struct iwl_trans *trans, struct fw_img *fw);
276 void (*fw_alive)(struct iwl_trans *trans);
277 void (*stop_device)(struct iwl_trans *trans);
279 void (*wowlan_suspend)(struct iwl_trans *trans);
281 void (*wake_any_queue)(struct iwl_trans *trans,
282 enum iwl_rxon_context_id ctx,
283 const char *msg);
285 int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
287 int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
288 struct iwl_device_cmd *dev_cmd, enum iwl_rxon_context_id ctx,
289 u8 sta_id, u8 tid);
290 int (*reclaim)(struct iwl_trans *trans, int sta_id, int tid,
291 int txq_id, int ssn, u32 status,
292 struct sk_buff_head *skbs);
294 int (*tx_agg_disable)(struct iwl_trans *trans,
295 int sta_id, int tid);
296 int (*tx_agg_alloc)(struct iwl_trans *trans,
297 int sta_id, int tid);
298 void (*tx_agg_setup)(struct iwl_trans *trans,
299 enum iwl_rxon_context_id ctx, int sta_id, int tid,
300 int frame_limit, u16 ssn);
302 void (*free)(struct iwl_trans *trans);
304 void (*stop_queue)(struct iwl_trans *trans, int q, const char *msg);
306 int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir);
307 int (*check_stuck_queue)(struct iwl_trans *trans, int q);
308 int (*wait_tx_queue_empty)(struct iwl_trans *trans);
309 #ifdef CONFIG_PM_SLEEP
310 int (*suspend)(struct iwl_trans *trans);
311 int (*resume)(struct iwl_trans *trans);
312 #endif
313 void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val);
314 void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val);
315 u32 (*read32)(struct iwl_trans *trans, u32 ofs);
319 * enum iwl_trans_state - state of the transport layer
321 * @IWL_TRANS_NO_FW: no fw has sent an alive response
322 * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
324 enum iwl_trans_state {
325 IWL_TRANS_NO_FW = 0,
326 IWL_TRANS_FW_ALIVE = 1,
330 * struct iwl_trans - transport common data
332 * @ops - pointer to iwl_trans_ops
333 * @op_mode - pointer to the op_mode
334 * @shrd - pointer to iwl_shared which holds shared data from the upper layer
335 * @reg_lock - protect hw register access
336 * @dev - pointer to struct device * that represents the device
337 * @irq - the irq number for the device
338 * @hw_id: a u32 with the ID of the device / subdevice.
339 * Set during transport allocation.
340 * @hw_id_str: a string with info about HW ID. Set during transport allocation.
341 * @ucode_write_complete: indicates that the ucode has been copied.
342 * @nvm_device_type: indicates OTP or eeprom
343 * @pm_support: set to true in start_hw if link pm is supported
345 struct iwl_trans {
346 const struct iwl_trans_ops *ops;
347 struct iwl_op_mode *op_mode;
348 struct iwl_shared *shrd;
349 enum iwl_trans_state state;
350 spinlock_t reg_lock;
352 struct device *dev;
353 unsigned int irq;
354 u32 hw_rev;
355 u32 hw_id;
356 char hw_id_str[52];
358 u8 ucode_write_complete;
360 int nvm_device_type;
361 bool pm_support;
363 /* pointer to trans specific struct */
364 /*Ensure that this pointer will always be aligned to sizeof pointer */
365 char trans_specific[0] __aligned(sizeof(void *));
368 static inline void iwl_trans_configure(struct iwl_trans *trans,
369 struct iwl_op_mode *op_mode)
372 * only set the op_mode for the moment. Later on, this function will do
373 * more
375 trans->op_mode = op_mode;
378 static inline int iwl_trans_start_hw(struct iwl_trans *trans)
380 might_sleep();
382 return trans->ops->start_hw(trans);
385 static inline void iwl_trans_stop_hw(struct iwl_trans *trans)
387 might_sleep();
389 trans->ops->stop_hw(trans);
391 trans->state = IWL_TRANS_NO_FW;
394 static inline void iwl_trans_fw_alive(struct iwl_trans *trans)
396 might_sleep();
398 trans->ops->fw_alive(trans);
400 trans->state = IWL_TRANS_FW_ALIVE;
403 static inline int iwl_trans_start_fw(struct iwl_trans *trans, struct fw_img *fw)
405 might_sleep();
407 return trans->ops->start_fw(trans, fw);
410 static inline void iwl_trans_stop_device(struct iwl_trans *trans)
412 might_sleep();
414 trans->ops->stop_device(trans);
416 trans->state = IWL_TRANS_NO_FW;
419 static inline void iwl_trans_wowlan_suspend(struct iwl_trans *trans)
421 might_sleep();
422 trans->ops->wowlan_suspend(trans);
425 static inline void iwl_trans_wake_any_queue(struct iwl_trans *trans,
426 enum iwl_rxon_context_id ctx,
427 const char *msg)
429 if (trans->state != IWL_TRANS_FW_ALIVE)
430 IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);
432 trans->ops->wake_any_queue(trans, ctx, msg);
436 static inline int iwl_trans_send_cmd(struct iwl_trans *trans,
437 struct iwl_host_cmd *cmd)
439 if (trans->state != IWL_TRANS_FW_ALIVE)
440 IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);
442 return trans->ops->send_cmd(trans, cmd);
445 int iwl_trans_send_cmd_pdu(struct iwl_trans *trans, u8 id,
446 u32 flags, u16 len, const void *data);
448 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
449 struct iwl_device_cmd *dev_cmd, enum iwl_rxon_context_id ctx,
450 u8 sta_id, u8 tid)
452 if (trans->state != IWL_TRANS_FW_ALIVE)
453 IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);
455 return trans->ops->tx(trans, skb, dev_cmd, ctx, sta_id, tid);
458 static inline int iwl_trans_reclaim(struct iwl_trans *trans, int sta_id,
459 int tid, int txq_id, int ssn, u32 status,
460 struct sk_buff_head *skbs)
462 if (trans->state != IWL_TRANS_FW_ALIVE)
463 IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);
465 return trans->ops->reclaim(trans, sta_id, tid, txq_id, ssn,
466 status, skbs);
469 static inline int iwl_trans_tx_agg_disable(struct iwl_trans *trans,
470 int sta_id, int tid)
472 might_sleep();
474 if (trans->state != IWL_TRANS_FW_ALIVE)
475 IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);
477 return trans->ops->tx_agg_disable(trans, sta_id, tid);
480 static inline int iwl_trans_tx_agg_alloc(struct iwl_trans *trans,
481 int sta_id, int tid)
483 if (trans->state != IWL_TRANS_FW_ALIVE)
484 IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);
486 return trans->ops->tx_agg_alloc(trans, sta_id, tid);
490 static inline void iwl_trans_tx_agg_setup(struct iwl_trans *trans,
491 enum iwl_rxon_context_id ctx,
492 int sta_id, int tid,
493 int frame_limit, u16 ssn)
495 might_sleep();
497 if (trans->state != IWL_TRANS_FW_ALIVE)
498 IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);
500 trans->ops->tx_agg_setup(trans, ctx, sta_id, tid, frame_limit, ssn);
503 static inline void iwl_trans_free(struct iwl_trans *trans)
505 trans->ops->free(trans);
508 static inline void iwl_trans_stop_queue(struct iwl_trans *trans, int q,
509 const char *msg)
511 if (trans->state != IWL_TRANS_FW_ALIVE)
512 IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);
514 trans->ops->stop_queue(trans, q, msg);
517 static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans)
519 if (trans->state != IWL_TRANS_FW_ALIVE)
520 IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);
522 return trans->ops->wait_tx_queue_empty(trans);
525 static inline int iwl_trans_check_stuck_queue(struct iwl_trans *trans, int q)
527 if (trans->state != IWL_TRANS_FW_ALIVE)
528 IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);
530 return trans->ops->check_stuck_queue(trans, q);
532 static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans,
533 struct dentry *dir)
535 return trans->ops->dbgfs_register(trans, dir);
538 #ifdef CONFIG_PM_SLEEP
539 static inline int iwl_trans_suspend(struct iwl_trans *trans)
541 return trans->ops->suspend(trans);
544 static inline int iwl_trans_resume(struct iwl_trans *trans)
546 return trans->ops->resume(trans);
548 #endif
550 static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val)
552 trans->ops->write8(trans, ofs, val);
555 static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val)
557 trans->ops->write32(trans, ofs, val);
560 static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs)
562 return trans->ops->read32(trans, ofs);
565 /*****************************************************
566 * Transport layers implementations + their allocation function
567 ******************************************************/
568 struct pci_dev;
569 struct pci_device_id;
570 extern const struct iwl_trans_ops trans_ops_pcie;
571 struct iwl_trans *iwl_trans_pcie_alloc(struct iwl_shared *shrd,
572 struct pci_dev *pdev,
573 const struct pci_device_id *ent);
574 int __must_check iwl_pci_register_driver(void);
575 void iwl_pci_unregister_driver(void);
577 extern const struct iwl_trans_ops trans_ops_idi;
578 struct iwl_trans *iwl_trans_idi_alloc(struct iwl_shared *shrd,
579 void *pdev_void,
580 const void *ent_void);
581 #endif /* __iwl_trans_h__ */