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.
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,
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
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
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
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"
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
80 * We will have an implementation for each different supported bus.
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
95 * 4) At some point (i.e. mac80211's start call), the op_mode will call
96 * the following sequence:
100 * 5) Then when finished (or reset):
101 * stop_fw (a.k.a. stop device for the moment)
104 * 6) Eventually, the free function will be called.
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)
125 #define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f)
126 #define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8)
127 #define SEQ_TO_INDEX(s) ((s) & 0xff)
128 #define INDEX_TO_SEQ(i) ((i) & 0xff)
129 #define SEQ_RX_FRAME cpu_to_le16(0x8000)
132 * struct iwl_cmd_header
134 * This header format appears in the beginning of each command sent from the
135 * driver, and each response/notification received from uCode.
137 struct iwl_cmd_header
{
138 u8 cmd
; /* Command ID: REPLY_RXON, etc. */
139 u8 flags
; /* 0:5 reserved, 6 abort, 7 internal */
141 * The driver sets up the sequence number to values of its choosing.
142 * uCode does not use this value, but passes it back to the driver
143 * when sending the response to each driver-originated command, so
144 * the driver can match the response to the command. Since the values
145 * don't get used by uCode, the driver may set up an arbitrary format.
147 * There is one exception: uCode sets bit 15 when it originates
148 * the response/notification, i.e. when the response/notification
149 * is not a direct response to a command sent by the driver. For
150 * example, uCode issues REPLY_RX when it sends a received frame
151 * to the driver; it is not a direct response to any driver command.
153 * The Linux driver uses the following format:
155 * 0:7 tfd index - position within TX queue
158 * 15 unsolicited RX or uCode-originated notification
164 #define FH_RSCSR_FRAME_SIZE_MSK 0x00003FFF /* bits 0-13 */
166 struct iwl_rx_packet
{
168 * The first 4 bytes of the RX frame header contain both the RX frame
169 * size and some flags.
171 * 31: flag flush RB request
172 * 30: flag ignore TC (terminal counter) request
173 * 29: flag fast IRQ request
175 * 13-00: RX frame size
178 struct iwl_cmd_header hdr
;
183 * enum CMD_MODE - how to send the host commands ?
185 * @CMD_SYNC: The caller will be stalled until the fw responds to the command
186 * @CMD_ASYNC: Return right away and don't want for the response
187 * @CMD_WANT_SKB: valid only with CMD_SYNC. The caller needs the buffer of the
189 * @CMD_ON_DEMAND: This command is sent by the test mode pipe.
194 CMD_WANT_SKB
= BIT(1),
195 CMD_ON_DEMAND
= BIT(2),
198 #define DEF_CMD_PAYLOAD_SIZE 320
201 * struct iwl_device_cmd
203 * For allocation of the command and tx queues, this establishes the overall
204 * size of the largest command we send to uCode, except for commands that
205 * aren't fully copied and use other TFD space.
207 struct iwl_device_cmd
{
208 struct iwl_cmd_header hdr
; /* uCode API */
209 u8 payload
[DEF_CMD_PAYLOAD_SIZE
];
212 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
214 #define IWL_MAX_CMD_TFDS 2
217 * struct iwl_hcmd_dataflag - flag for each one of the chunks of the command
219 * IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's
220 * ring. The transport layer doesn't map the command's buffer to DMA, but
221 * rather copies it to an previously allocated DMA buffer. This flag tells
222 * the transport layer not to copy the command, but to map the existing
223 * buffer. This can save memcpy and is worth with very big comamnds.
225 enum iwl_hcmd_dataflag
{
226 IWL_HCMD_DFL_NOCOPY
= BIT(0),
230 * struct iwl_host_cmd - Host command to the uCode
232 * @data: array of chunks that composes the data of the host command
233 * @resp_pkt: response packet, if %CMD_WANT_SKB was set
234 * @_rx_page_order: (internally used to free response packet)
235 * @_rx_page_addr: (internally used to free response packet)
236 * @handler_status: return value of the handler of the command
237 * (put in setup_rx_handlers) - valid for SYNC mode only
238 * @flags: can be CMD_*
239 * @len: array of the lenths of the chunks in data
240 * @dataflags: IWL_HCMD_DFL_*
241 * @id: id of the host command
243 struct iwl_host_cmd
{
244 const void *data
[IWL_MAX_CMD_TFDS
];
245 struct iwl_rx_packet
*resp_pkt
;
246 unsigned long _rx_page_addr
;
251 u16 len
[IWL_MAX_CMD_TFDS
];
252 u8 dataflags
[IWL_MAX_CMD_TFDS
];
256 static inline void iwl_free_resp(struct iwl_host_cmd
*cmd
)
258 free_pages(cmd
->_rx_page_addr
, cmd
->_rx_page_order
);
261 struct iwl_rx_cmd_buffer
{
265 static inline void *rxb_addr(struct iwl_rx_cmd_buffer
*r
)
267 return page_address(r
->_page
);
270 static inline struct page
*rxb_steal_page(struct iwl_rx_cmd_buffer
*r
)
272 struct page
*p
= r
->_page
;
278 * struct iwl_trans_config - transport configuration
280 * @op_mode: pointer to the upper layer.
281 * Must be set before any other call.
282 * @cmd_queue: the index of the command queue.
283 * Must be set before start_fw.
285 struct iwl_trans_config
{
286 struct iwl_op_mode
*op_mode
;
291 * struct iwl_trans_ops - transport specific operations
293 * All the handlers MUST be implemented
295 * @start_hw: starts the HW- from that point on, the HW can send interrupts
297 * @stop_hw: stops the HW- from that point on, the HW will be in low power but
298 * will still issue interrupt if the HW RF kill is triggered.
300 * @start_fw: allocates and inits all the resources for the transport
301 * layer. Also kick a fw image.
303 * @fw_alive: called when the fw sends alive notification
305 * @stop_device:stops the whole device (embedded CPU put to reset)
307 * @wowlan_suspend: put the device into the correct mode for WoWLAN during
308 * suspend. This is optional, if not implemented WoWLAN will not be
309 * supported. This callback may sleep.
310 * @send_cmd:send a host command
311 * May sleep only if CMD_SYNC is set
314 * @reclaim: free packet until ssn. Returns a list of freed packets.
316 * @tx_agg_alloc: allocate resources for a TX BA session
318 * @tx_agg_setup: setup a tx queue for AMPDU - will be called once the HW is
319 * ready and a successful ADDBA response has been received.
321 * @tx_agg_disable: de-configure a Tx queue to send AMPDUs
323 * @free: release all the ressource for the transport layer itself such as
324 * irq, tasklet etc... From this point on, the device may not issue
325 * any interrupt (incl. RFKILL).
327 * @check_stuck_queue: check if a specific queue is stuck
328 * @wait_tx_queue_empty: wait until all tx queues are empty
330 * @dbgfs_register: add the dbgfs files under this directory. Files will be
331 * automatically deleted.
332 * @suspend: stop the device unless WoWLAN is configured
333 * @resume: resume activity of the device
334 * @write8: write a u8 to a register at offset ofs from the BAR
335 * @write32: write a u32 to a register at offset ofs from the BAR
336 * @read32: read a u32 register at offset ofs from the BAR
337 * @configure: configure parameters required by the transport layer from
338 * the op_mode. May be called several times before start_fw, can't be
341 struct iwl_trans_ops
{
343 int (*start_hw
)(struct iwl_trans
*iwl_trans
);
344 void (*stop_hw
)(struct iwl_trans
*iwl_trans
);
345 int (*start_fw
)(struct iwl_trans
*trans
, const struct fw_img
*fw
);
346 void (*fw_alive
)(struct iwl_trans
*trans
);
347 void (*stop_device
)(struct iwl_trans
*trans
);
349 void (*wowlan_suspend
)(struct iwl_trans
*trans
);
351 int (*send_cmd
)(struct iwl_trans
*trans
, struct iwl_host_cmd
*cmd
);
353 int (*tx
)(struct iwl_trans
*trans
, struct sk_buff
*skb
,
354 struct iwl_device_cmd
*dev_cmd
, enum iwl_rxon_context_id ctx
,
356 int (*reclaim
)(struct iwl_trans
*trans
, int sta_id
, int tid
,
357 int txq_id
, int ssn
, struct sk_buff_head
*skbs
);
359 int (*tx_agg_disable
)(struct iwl_trans
*trans
,
360 int sta_id
, int tid
);
361 int (*tx_agg_alloc
)(struct iwl_trans
*trans
,
362 int sta_id
, int tid
);
363 void (*tx_agg_setup
)(struct iwl_trans
*trans
,
364 enum iwl_rxon_context_id ctx
, int sta_id
, int tid
,
365 int frame_limit
, u16 ssn
);
367 void (*free
)(struct iwl_trans
*trans
);
369 int (*dbgfs_register
)(struct iwl_trans
*trans
, struct dentry
* dir
);
370 int (*check_stuck_queue
)(struct iwl_trans
*trans
, int q
);
371 int (*wait_tx_queue_empty
)(struct iwl_trans
*trans
);
372 #ifdef CONFIG_PM_SLEEP
373 int (*suspend
)(struct iwl_trans
*trans
);
374 int (*resume
)(struct iwl_trans
*trans
);
376 void (*write8
)(struct iwl_trans
*trans
, u32 ofs
, u8 val
);
377 void (*write32
)(struct iwl_trans
*trans
, u32 ofs
, u32 val
);
378 u32 (*read32
)(struct iwl_trans
*trans
, u32 ofs
);
379 void (*configure
)(struct iwl_trans
*trans
,
380 const struct iwl_trans_config
*trans_cfg
);
384 * enum iwl_trans_state - state of the transport layer
386 * @IWL_TRANS_NO_FW: no fw has sent an alive response
387 * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
389 enum iwl_trans_state
{
391 IWL_TRANS_FW_ALIVE
= 1,
395 * struct iwl_trans - transport common data
397 * @ops - pointer to iwl_trans_ops
398 * @op_mode - pointer to the op_mode
399 * @shrd - pointer to iwl_shared which holds shared data from the upper layer
400 * @reg_lock - protect hw register access
401 * @dev - pointer to struct device * that represents the device
402 * @hw_id: a u32 with the ID of the device / subdevice.
403 * Set during transport allocation.
404 * @hw_id_str: a string with info about HW ID. Set during transport allocation.
405 * @nvm_device_type: indicates OTP or eeprom
406 * @pm_support: set to true in start_hw if link pm is supported
409 const struct iwl_trans_ops
*ops
;
410 struct iwl_op_mode
*op_mode
;
411 struct iwl_shared
*shrd
;
412 enum iwl_trans_state state
;
423 /* pointer to trans specific struct */
424 /*Ensure that this pointer will always be aligned to sizeof pointer */
425 char trans_specific
[0] __aligned(sizeof(void *));
428 static inline void iwl_trans_configure(struct iwl_trans
*trans
,
429 const struct iwl_trans_config
*trans_cfg
)
432 * only set the op_mode for the moment. Later on, this function will do
435 trans
->op_mode
= trans_cfg
->op_mode
;
437 trans
->ops
->configure(trans
, trans_cfg
);
440 static inline int iwl_trans_start_hw(struct iwl_trans
*trans
)
444 return trans
->ops
->start_hw(trans
);
447 static inline void iwl_trans_stop_hw(struct iwl_trans
*trans
)
451 trans
->ops
->stop_hw(trans
);
453 trans
->state
= IWL_TRANS_NO_FW
;
456 static inline void iwl_trans_fw_alive(struct iwl_trans
*trans
)
460 trans
->ops
->fw_alive(trans
);
462 trans
->state
= IWL_TRANS_FW_ALIVE
;
465 static inline int iwl_trans_start_fw(struct iwl_trans
*trans
,
466 const struct fw_img
*fw
)
470 return trans
->ops
->start_fw(trans
, fw
);
473 static inline void iwl_trans_stop_device(struct iwl_trans
*trans
)
477 trans
->ops
->stop_device(trans
);
479 trans
->state
= IWL_TRANS_NO_FW
;
482 static inline void iwl_trans_wowlan_suspend(struct iwl_trans
*trans
)
485 trans
->ops
->wowlan_suspend(trans
);
488 static inline int iwl_trans_send_cmd(struct iwl_trans
*trans
,
489 struct iwl_host_cmd
*cmd
)
491 if (trans
->state
!= IWL_TRANS_FW_ALIVE
)
492 IWL_ERR(trans
, "%s bad state = %d", __func__
, trans
->state
);
494 return trans
->ops
->send_cmd(trans
, cmd
);
497 static inline int iwl_trans_tx(struct iwl_trans
*trans
, struct sk_buff
*skb
,
498 struct iwl_device_cmd
*dev_cmd
, enum iwl_rxon_context_id ctx
,
501 if (trans
->state
!= IWL_TRANS_FW_ALIVE
)
502 IWL_ERR(trans
, "%s bad state = %d", __func__
, trans
->state
);
504 return trans
->ops
->tx(trans
, skb
, dev_cmd
, ctx
, sta_id
, tid
);
507 static inline int iwl_trans_reclaim(struct iwl_trans
*trans
, int sta_id
,
508 int tid
, int txq_id
, int ssn
,
509 struct sk_buff_head
*skbs
)
511 if (trans
->state
!= IWL_TRANS_FW_ALIVE
)
512 IWL_ERR(trans
, "%s bad state = %d", __func__
, trans
->state
);
514 return trans
->ops
->reclaim(trans
, sta_id
, tid
, txq_id
, ssn
, skbs
);
517 static inline int iwl_trans_tx_agg_disable(struct iwl_trans
*trans
,
520 if (trans
->state
!= IWL_TRANS_FW_ALIVE
)
521 IWL_ERR(trans
, "%s bad state = %d", __func__
, trans
->state
);
523 return trans
->ops
->tx_agg_disable(trans
, sta_id
, tid
);
526 static inline int iwl_trans_tx_agg_alloc(struct iwl_trans
*trans
,
529 if (trans
->state
!= IWL_TRANS_FW_ALIVE
)
530 IWL_ERR(trans
, "%s bad state = %d", __func__
, trans
->state
);
532 return trans
->ops
->tx_agg_alloc(trans
, sta_id
, tid
);
536 static inline void iwl_trans_tx_agg_setup(struct iwl_trans
*trans
,
537 enum iwl_rxon_context_id ctx
,
539 int frame_limit
, u16 ssn
)
543 if (trans
->state
!= IWL_TRANS_FW_ALIVE
)
544 IWL_ERR(trans
, "%s bad state = %d", __func__
, trans
->state
);
546 trans
->ops
->tx_agg_setup(trans
, ctx
, sta_id
, tid
, frame_limit
, ssn
);
549 static inline void iwl_trans_free(struct iwl_trans
*trans
)
551 trans
->ops
->free(trans
);
554 static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans
*trans
)
556 if (trans
->state
!= IWL_TRANS_FW_ALIVE
)
557 IWL_ERR(trans
, "%s bad state = %d", __func__
, trans
->state
);
559 return trans
->ops
->wait_tx_queue_empty(trans
);
562 static inline int iwl_trans_check_stuck_queue(struct iwl_trans
*trans
, int q
)
564 if (trans
->state
!= IWL_TRANS_FW_ALIVE
)
565 IWL_ERR(trans
, "%s bad state = %d", __func__
, trans
->state
);
567 return trans
->ops
->check_stuck_queue(trans
, q
);
569 static inline int iwl_trans_dbgfs_register(struct iwl_trans
*trans
,
572 return trans
->ops
->dbgfs_register(trans
, dir
);
575 #ifdef CONFIG_PM_SLEEP
576 static inline int iwl_trans_suspend(struct iwl_trans
*trans
)
578 return trans
->ops
->suspend(trans
);
581 static inline int iwl_trans_resume(struct iwl_trans
*trans
)
583 return trans
->ops
->resume(trans
);
587 static inline void iwl_trans_write8(struct iwl_trans
*trans
, u32 ofs
, u8 val
)
589 trans
->ops
->write8(trans
, ofs
, val
);
592 static inline void iwl_trans_write32(struct iwl_trans
*trans
, u32 ofs
, u32 val
)
594 trans
->ops
->write32(trans
, ofs
, val
);
597 static inline u32
iwl_trans_read32(struct iwl_trans
*trans
, u32 ofs
)
599 return trans
->ops
->read32(trans
, ofs
);
602 /*****************************************************
603 * Transport layers implementations + their allocation function
604 ******************************************************/
606 struct pci_device_id
;
607 extern const struct iwl_trans_ops trans_ops_pcie
;
608 struct iwl_trans
*iwl_trans_pcie_alloc(struct iwl_shared
*shrd
,
609 struct pci_dev
*pdev
,
610 const struct pci_device_id
*ent
);
611 int __must_check
iwl_pci_register_driver(void);
612 void iwl_pci_unregister_driver(void);
614 extern const struct iwl_trans_ops trans_ops_idi
;
615 struct iwl_trans
*iwl_trans_idi_alloc(struct iwl_shared
*shrd
,
617 const void *ent_void
);
618 #endif /* __iwl_trans_h__ */