1 /******************************************************************************
2 *
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.
5 *
6 * GPL LICENSE SUMMARY
7 *
8 * Copyright(c) 2007 - 2014 Intel Corporation. All rights reserved.
9 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of version 2 of the GNU General Public License as
13 * published by the Free Software Foundation.
14 *
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
23 * USA
24 *
25 * The full GNU General Public License is included in this distribution
26 * in the file called COPYING.
27 *
28 * Contact Information:
29 * Intel Linux Wireless <ilw@linux.intel.com>
30 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
31 *
32 * BSD LICENSE
33 *
34 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
35 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
36 * All rights reserved.
37 *
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
40 * are met:
41 *
42 * * Redistributions of source code must retain the above copyright
43 * notice, this list of conditions and the following disclaimer.
44 * * Redistributions in binary form must reproduce the above copyright
45 * notice, this list of conditions and the following disclaimer in
46 * the documentation and/or other materials provided with the
47 * distribution.
48 * * Neither the name Intel Corporation nor the names of its
49 * contributors may be used to endorse or promote products derived
50 * from this software without specific prior written permission.
51 *
52 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
53 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
54 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
55 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
56 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
57 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
58 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
59 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
60 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
61 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
62 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
63 *
64 *****************************************************************************/
65 #ifndef __iwl_trans_h__
66 #define __iwl_trans_h__
67
68 #include <linux/ieee80211.h>
69 #include <linux/mm.h> /* for page_address */
70 #include <linux/lockdep.h>
71
72 #include "iwl-debug.h"
73 #include "iwl-config.h"
74 #include "iwl-fw.h"
75 #include "iwl-op-mode.h"
76
77 /**
78 * DOC: Transport layer - what is it ?
79 *
80 * The transport layer is the layer that deals with the HW directly. It provides
81 * an abstraction of the underlying HW to the upper layer. The transport layer
82 * doesn't provide any policy, algorithm or anything of this kind, but only
83 * mechanisms to make the HW do something. It is not completely stateless but
84 * close to it.
85 * We will have an implementation for each different supported bus.
86 */
87
88 /**
89 * DOC: Life cycle of the transport layer
90 *
91 * The transport layer has a very precise life cycle.
92 *
93 * 1) A helper function is called during the module initialization and
94 * registers the bus driver's ops with the transport's alloc function.
95 * 2) Bus's probe calls to the transport layer's allocation functions.
96 * Of course this function is bus specific.
97 * 3) This allocation functions will spawn the upper layer which will
98 * register mac80211.
99 *
100 * 4) At some point (i.e. mac80211's start call), the op_mode will call
101 * the following sequence:
102 * start_hw
103 * start_fw
104 *
105 * 5) Then when finished (or reset):
106 * stop_device
107 *
108 * 6) Eventually, the free function will be called.
109 */
110
111 /**
112 * DOC: Host command section
113 *
114 * A host command is a command issued by the upper layer to the fw. There are
115 * several versions of fw that have several APIs. The transport layer is
116 * completely agnostic to these differences.
117 * The transport does provide helper functionality (i.e. SYNC / ASYNC mode),
118 */
119 #define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f)
120 #define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8)
121 #define SEQ_TO_INDEX(s) ((s) & 0xff)
122 #define INDEX_TO_SEQ(i) ((i) & 0xff)
123 #define SEQ_RX_FRAME cpu_to_le16(0x8000)
124
125 /**
126 * struct iwl_cmd_header
127 *
128 * This header format appears in the beginning of each command sent from the
129 * driver, and each response/notification received from uCode.
130 */
131 struct iwl_cmd_header {
132 u8 cmd; /* Command ID: REPLY_RXON, etc. */
133 u8 flags; /* 0:5 reserved, 6 abort, 7 internal */
134 /*
135 * The driver sets up the sequence number to values of its choosing.
136 * uCode does not use this value, but passes it back to the driver
137 * when sending the response to each driver-originated command, so
138 * the driver can match the response to the command. Since the values
139 * don't get used by uCode, the driver may set up an arbitrary format.
140 *
141 * There is one exception: uCode sets bit 15 when it originates
142 * the response/notification, i.e. when the response/notification
143 * is not a direct response to a command sent by the driver. For
144 * example, uCode issues REPLY_RX when it sends a received frame
145 * to the driver; it is not a direct response to any driver command.
146 *
147 * The Linux driver uses the following format:
148 *
149 * 0:7 tfd index - position within TX queue
150 * 8:12 TX queue id
151 * 13:14 reserved
152 * 15 unsolicited RX or uCode-originated notification
153 */
154 __le16 sequence;
155 } __packed;
156
157 /* iwl_cmd_header flags value */
158 #define IWL_CMD_FAILED_MSK 0x40
159
160
161 #define FH_RSCSR_FRAME_SIZE_MSK 0x00003FFF /* bits 0-13 */
162 #define FH_RSCSR_FRAME_INVALID 0x55550000
163 #define FH_RSCSR_FRAME_ALIGN 0x40
164
165 struct iwl_rx_packet {
166 /*
167 * The first 4 bytes of the RX frame header contain both the RX frame
168 * size and some flags.
169 * Bit fields:
170 * 31: flag flush RB request
171 * 30: flag ignore TC (terminal counter) request
172 * 29: flag fast IRQ request
173 * 28-14: Reserved
174 * 13-00: RX frame size
175 */
176 __le32 len_n_flags;
177 struct iwl_cmd_header hdr;
178 u8 data[];
179 } __packed;
180
iwl_rx_packet_len(const struct iwl_rx_packet * pkt)181 static inline u32 iwl_rx_packet_len(const struct iwl_rx_packet *pkt)
182 {
183 return le32_to_cpu(pkt->len_n_flags) & FH_RSCSR_FRAME_SIZE_MSK;
184 }
185
iwl_rx_packet_payload_len(const struct iwl_rx_packet * pkt)186 static inline u32 iwl_rx_packet_payload_len(const struct iwl_rx_packet *pkt)
187 {
188 return iwl_rx_packet_len(pkt) - sizeof(pkt->hdr);
189 }
190
191 /**
192 * enum CMD_MODE - how to send the host commands ?
193 *
194 * @CMD_ASYNC: Return right away and don't wait for the response
195 * @CMD_WANT_SKB: Not valid with CMD_ASYNC. The caller needs the buffer of
196 * the response. The caller needs to call iwl_free_resp when done.
197 * @CMD_HIGH_PRIO: The command is high priority - it goes to the front of the
198 * command queue, but after other high priority commands. Valid only
199 * with CMD_ASYNC.
200 * @CMD_SEND_IN_IDLE: The command should be sent even when the trans is idle.
201 * @CMD_MAKE_TRANS_IDLE: The command response should mark the trans as idle.
202 * @CMD_WAKE_UP_TRANS: The command response should wake up the trans
203 * (i.e. mark it as non-idle).
204 */
205 enum CMD_MODE {
206 CMD_ASYNC = BIT(0),
207 CMD_WANT_SKB = BIT(1),
208 CMD_SEND_IN_RFKILL = BIT(2),
209 CMD_HIGH_PRIO = BIT(3),
210 CMD_SEND_IN_IDLE = BIT(4),
211 CMD_MAKE_TRANS_IDLE = BIT(5),
212 CMD_WAKE_UP_TRANS = BIT(6),
213 };
214
215 #define DEF_CMD_PAYLOAD_SIZE 320
216
217 /**
218 * struct iwl_device_cmd
219 *
220 * For allocation of the command and tx queues, this establishes the overall
221 * size of the largest command we send to uCode, except for commands that
222 * aren't fully copied and use other TFD space.
223 */
224 struct iwl_device_cmd {
225 struct iwl_cmd_header hdr; /* uCode API */
226 u8 payload[DEF_CMD_PAYLOAD_SIZE];
227 } __packed;
228
229 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
230
231 /*
232 * number of transfer buffers (fragments) per transmit frame descriptor;
233 * this is just the driver's idea, the hardware supports 20
234 */
235 #define IWL_MAX_CMD_TBS_PER_TFD 2
236
237 /**
238 * struct iwl_hcmd_dataflag - flag for each one of the chunks of the command
239 *
240 * @IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's
241 * ring. The transport layer doesn't map the command's buffer to DMA, but
242 * rather copies it to a previously allocated DMA buffer. This flag tells
243 * the transport layer not to copy the command, but to map the existing
244 * buffer (that is passed in) instead. This saves the memcpy and allows
245 * commands that are bigger than the fixed buffer to be submitted.
246 * Note that a TFD entry after a NOCOPY one cannot be a normal copied one.
247 * @IWL_HCMD_DFL_DUP: Only valid without NOCOPY, duplicate the memory for this
248 * chunk internally and free it again after the command completes. This
249 * can (currently) be used only once per command.
250 * Note that a TFD entry after a DUP one cannot be a normal copied one.
251 */
252 enum iwl_hcmd_dataflag {
253 IWL_HCMD_DFL_NOCOPY = BIT(0),
254 IWL_HCMD_DFL_DUP = BIT(1),
255 };
256
257 /**
258 * struct iwl_host_cmd - Host command to the uCode
259 *
260 * @data: array of chunks that composes the data of the host command
261 * @resp_pkt: response packet, if %CMD_WANT_SKB was set
262 * @_rx_page_order: (internally used to free response packet)
263 * @_rx_page_addr: (internally used to free response packet)
264 * @handler_status: return value of the handler of the command
265 * (put in setup_rx_handlers) - valid for SYNC mode only
266 * @flags: can be CMD_*
267 * @len: array of the lengths of the chunks in data
268 * @dataflags: IWL_HCMD_DFL_*
269 * @id: id of the host command
270 */
271 struct iwl_host_cmd {
272 const void *data[IWL_MAX_CMD_TBS_PER_TFD];
273 struct iwl_rx_packet *resp_pkt;
274 unsigned long _rx_page_addr;
275 u32 _rx_page_order;
276 int handler_status;
277
278 u32 flags;
279 u16 len[IWL_MAX_CMD_TBS_PER_TFD];
280 u8 dataflags[IWL_MAX_CMD_TBS_PER_TFD];
281 u8 id;
282 };
283
iwl_free_resp(struct iwl_host_cmd * cmd)284 static inline void iwl_free_resp(struct iwl_host_cmd *cmd)
285 {
286 free_pages(cmd->_rx_page_addr, cmd->_rx_page_order);
287 }
288
289 struct iwl_rx_cmd_buffer {
290 struct page *_page;
291 int _offset;
292 bool _page_stolen;
293 u32 _rx_page_order;
294 unsigned int truesize;
295 };
296
rxb_addr(struct iwl_rx_cmd_buffer * r)297 static inline void *rxb_addr(struct iwl_rx_cmd_buffer *r)
298 {
299 return (void *)((unsigned long)page_address(r->_page) + r->_offset);
300 }
301
rxb_offset(struct iwl_rx_cmd_buffer * r)302 static inline int rxb_offset(struct iwl_rx_cmd_buffer *r)
303 {
304 return r->_offset;
305 }
306
rxb_steal_page(struct iwl_rx_cmd_buffer * r)307 static inline struct page *rxb_steal_page(struct iwl_rx_cmd_buffer *r)
308 {
309 r->_page_stolen = true;
310 get_page(r->_page);
311 return r->_page;
312 }
313
iwl_free_rxb(struct iwl_rx_cmd_buffer * r)314 static inline void iwl_free_rxb(struct iwl_rx_cmd_buffer *r)
315 {
316 __free_pages(r->_page, r->_rx_page_order);
317 }
318
319 #define MAX_NO_RECLAIM_CMDS 6
320
321 #define IWL_MASK(lo, hi) ((1 << (hi)) | ((1 << (hi)) - (1 << (lo))))
322
323 /*
324 * Maximum number of HW queues the transport layer
325 * currently supports
326 */
327 #define IWL_MAX_HW_QUEUES 32
328 #define IWL_MAX_TID_COUNT 8
329 #define IWL_FRAME_LIMIT 64
330
331 /**
332 * enum iwl_wowlan_status - WoWLAN image/device status
333 * @IWL_D3_STATUS_ALIVE: firmware is still running after resume
334 * @IWL_D3_STATUS_RESET: device was reset while suspended
335 */
336 enum iwl_d3_status {
337 IWL_D3_STATUS_ALIVE,
338 IWL_D3_STATUS_RESET,
339 };
340
341 /**
342 * enum iwl_trans_status: transport status flags
343 * @STATUS_SYNC_HCMD_ACTIVE: a SYNC command is being processed
344 * @STATUS_DEVICE_ENABLED: APM is enabled
345 * @STATUS_TPOWER_PMI: the device might be asleep (need to wake it up)
346 * @STATUS_INT_ENABLED: interrupts are enabled
347 * @STATUS_RFKILL: the HW RFkill switch is in KILL position
348 * @STATUS_FW_ERROR: the fw is in error state
349 * @STATUS_TRANS_GOING_IDLE: shutting down the trans, only special commands
350 * are sent
351 * @STATUS_TRANS_IDLE: the trans is idle - general commands are not to be sent
352 */
353 enum iwl_trans_status {
354 STATUS_SYNC_HCMD_ACTIVE,
355 STATUS_DEVICE_ENABLED,
356 STATUS_TPOWER_PMI,
357 STATUS_INT_ENABLED,
358 STATUS_RFKILL,
359 STATUS_FW_ERROR,
360 STATUS_TRANS_GOING_IDLE,
361 STATUS_TRANS_IDLE,
362 };
363
364 /**
365 * struct iwl_trans_config - transport configuration
366 *
367 * @op_mode: pointer to the upper layer.
368 * @cmd_queue: the index of the command queue.
369 * Must be set before start_fw.
370 * @cmd_fifo: the fifo for host commands
371 * @cmd_q_wdg_timeout: the timeout of the watchdog timer for the command queue.
372 * @no_reclaim_cmds: Some devices erroneously don't set the
373 * SEQ_RX_FRAME bit on some notifications, this is the
374 * list of such notifications to filter. Max length is
375 * %MAX_NO_RECLAIM_CMDS.
376 * @n_no_reclaim_cmds: # of commands in list
377 * @rx_buf_size_8k: 8 kB RX buffer size needed for A-MSDUs,
378 * if unset 4k will be the RX buffer size
379 * @bc_table_dword: set to true if the BC table expects the byte count to be
380 * in DWORD (as opposed to bytes)
381 * @scd_set_active: should the transport configure the SCD for HCMD queue
382 * @command_names: array of command names, must be 256 entries
383 * (one for each command); for debugging only
384 * @sdio_adma_addr: the default address to set for the ADMA in SDIO mode until
385 * we get the ALIVE from the uCode
386 */
387 struct iwl_trans_config {
388 struct iwl_op_mode *op_mode;
389
390 u8 cmd_queue;
391 u8 cmd_fifo;
392 unsigned int cmd_q_wdg_timeout;
393 const u8 *no_reclaim_cmds;
394 unsigned int n_no_reclaim_cmds;
395
396 bool rx_buf_size_8k;
397 bool bc_table_dword;
398 bool scd_set_active;
399 const char *const *command_names;
400
401 u32 sdio_adma_addr;
402 };
403
404 struct iwl_trans_dump_data {
405 u32 len;
406 u8 data[];
407 };
408
409 struct iwl_trans;
410
411 struct iwl_trans_txq_scd_cfg {
412 u8 fifo;
413 s8 sta_id;
414 u8 tid;
415 bool aggregate;
416 int frame_limit;
417 };
418
419 /**
420 * struct iwl_trans_ops - transport specific operations
421 *
422 * All the handlers MUST be implemented
423 *
424 * @start_hw: starts the HW. If low_power is true, the NIC needs to be taken
425 * out of a low power state. From that point on, the HW can send
426 * interrupts. May sleep.
427 * @op_mode_leave: Turn off the HW RF kill indication if on
428 * May sleep
429 * @start_fw: allocates and inits all the resources for the transport
430 * layer. Also kick a fw image.
431 * May sleep
432 * @fw_alive: called when the fw sends alive notification. If the fw provides
433 * the SCD base address in SRAM, then provide it here, or 0 otherwise.
434 * May sleep
435 * @stop_device: stops the whole device (embedded CPU put to reset) and stops
436 * the HW. If low_power is true, the NIC will be put in low power state.
437 * From that point on, the HW will be stopped but will still issue an
438 * interrupt if the HW RF kill switch is triggered.
439 * This callback must do the right thing and not crash even if %start_hw()
440 * was called but not &start_fw(). May sleep.
441 * @d3_suspend: put the device into the correct mode for WoWLAN during
442 * suspend. This is optional, if not implemented WoWLAN will not be
443 * supported. This callback may sleep.
444 * @d3_resume: resume the device after WoWLAN, enabling the opmode to
445 * talk to the WoWLAN image to get its status. This is optional, if not
446 * implemented WoWLAN will not be supported. This callback may sleep.
447 * @send_cmd:send a host command. Must return -ERFKILL if RFkill is asserted.
448 * If RFkill is asserted in the middle of a SYNC host command, it must
449 * return -ERFKILL straight away.
450 * May sleep only if CMD_ASYNC is not set
451 * @tx: send an skb
452 * Must be atomic
453 * @reclaim: free packet until ssn. Returns a list of freed packets.
454 * Must be atomic
455 * @txq_enable: setup a queue. To setup an AC queue, use the
456 * iwl_trans_ac_txq_enable wrapper. fw_alive must have been called before
457 * this one. The op_mode must not configure the HCMD queue. The scheduler
458 * configuration may be %NULL, in which case the hardware will not be
459 * configured. May sleep.
460 * @txq_disable: de-configure a Tx queue to send AMPDUs
461 * Must be atomic
462 * @wait_tx_queue_empty: wait until tx queues are empty. May sleep.
463 * @freeze_txq_timer: prevents the timer of the queue from firing until the
464 * queue is set to awake. Must be atomic.
465 * @dbgfs_register: add the dbgfs files under this directory. Files will be
466 * automatically deleted.
467 * @write8: write a u8 to a register at offset ofs from the BAR
468 * @write32: write a u32 to a register at offset ofs from the BAR
469 * @read32: read a u32 register at offset ofs from the BAR
470 * @read_prph: read a DWORD from a periphery register
471 * @write_prph: write a DWORD to a periphery register
472 * @read_mem: read device's SRAM in DWORD
473 * @write_mem: write device's SRAM in DWORD. If %buf is %NULL, then the memory
474 * will be zeroed.
475 * @configure: configure parameters required by the transport layer from
476 * the op_mode. May be called several times before start_fw, can't be
477 * called after that.
478 * @set_pmi: set the power pmi state
479 * @grab_nic_access: wake the NIC to be able to access non-HBUS regs.
480 * Sleeping is not allowed between grab_nic_access and
481 * release_nic_access.
482 * @release_nic_access: let the NIC go to sleep. The "flags" parameter
483 * must be the same one that was sent before to the grab_nic_access.
484 * @set_bits_mask - set SRAM register according to value and mask.
485 * @ref: grab a reference to the transport/FW layers, disallowing
486 * certain low power states
487 * @unref: release a reference previously taken with @ref. Note that
488 * initially the reference count is 1, making an initial @unref
489 * necessary to allow low power states.
490 * @dump_data: return a vmalloc'ed buffer with debug data, maybe containing last
491 * TX'ed commands and similar. The buffer will be vfree'd by the caller.
492 * Note that the transport must fill in the proper file headers.
493 */
494 struct iwl_trans_ops {
495
496 int (*start_hw)(struct iwl_trans *iwl_trans, bool low_power);
497 void (*op_mode_leave)(struct iwl_trans *iwl_trans);
498 int (*start_fw)(struct iwl_trans *trans, const struct fw_img *fw,
499 bool run_in_rfkill);
500 int (*update_sf)(struct iwl_trans *trans,
501 struct iwl_sf_region *st_fwrd_space);
502 void (*fw_alive)(struct iwl_trans *trans, u32 scd_addr);
503 void (*stop_device)(struct iwl_trans *trans, bool low_power);
504
505 void (*d3_suspend)(struct iwl_trans *trans, bool test);
506 int (*d3_resume)(struct iwl_trans *trans, enum iwl_d3_status *status,
507 bool test);
508
509 int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
510
511 int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
512 struct iwl_device_cmd *dev_cmd, int queue);
513 void (*reclaim)(struct iwl_trans *trans, int queue, int ssn,
514 struct sk_buff_head *skbs);
515
516 void (*txq_enable)(struct iwl_trans *trans, int queue, u16 ssn,
517 const struct iwl_trans_txq_scd_cfg *cfg,
518 unsigned int queue_wdg_timeout);
519 void (*txq_disable)(struct iwl_trans *trans, int queue,
520 bool configure_scd);
521
522 int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir);
523 int (*wait_tx_queue_empty)(struct iwl_trans *trans, u32 txq_bm);
524 void (*freeze_txq_timer)(struct iwl_trans *trans, unsigned long txqs,
525 bool freeze);
526
527 void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val);
528 void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val);
529 u32 (*read32)(struct iwl_trans *trans, u32 ofs);
530 u32 (*read_prph)(struct iwl_trans *trans, u32 ofs);
531 void (*write_prph)(struct iwl_trans *trans, u32 ofs, u32 val);
532 int (*read_mem)(struct iwl_trans *trans, u32 addr,
533 void *buf, int dwords);
534 int (*write_mem)(struct iwl_trans *trans, u32 addr,
535 const void *buf, int dwords);
536 void (*configure)(struct iwl_trans *trans,
537 const struct iwl_trans_config *trans_cfg);
538 void (*set_pmi)(struct iwl_trans *trans, bool state);
539 bool (*grab_nic_access)(struct iwl_trans *trans, bool silent,
540 unsigned long *flags);
541 void (*release_nic_access)(struct iwl_trans *trans,
542 unsigned long *flags);
543 void (*set_bits_mask)(struct iwl_trans *trans, u32 reg, u32 mask,
544 u32 value);
545 void (*ref)(struct iwl_trans *trans);
546 void (*unref)(struct iwl_trans *trans);
547 void (*suspend)(struct iwl_trans *trans);
548 void (*resume)(struct iwl_trans *trans);
549
550 struct iwl_trans_dump_data *(*dump_data)(struct iwl_trans *trans);
551 };
552
553 /**
554 * enum iwl_trans_state - state of the transport layer
555 *
556 * @IWL_TRANS_NO_FW: no fw has sent an alive response
557 * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
558 */
559 enum iwl_trans_state {
560 IWL_TRANS_NO_FW = 0,
561 IWL_TRANS_FW_ALIVE = 1,
562 };
563
564 /**
565 * enum iwl_d0i3_mode - d0i3 mode
566 *
567 * @IWL_D0I3_MODE_OFF - d0i3 is disabled
568 * @IWL_D0I3_MODE_ON_IDLE - enter d0i3 when device is idle
569 * (e.g. no active references)
570 * @IWL_D0I3_MODE_ON_SUSPEND - enter d0i3 only on suspend
571 * (in case of 'any' trigger)
572 */
573 enum iwl_d0i3_mode {
574 IWL_D0I3_MODE_OFF = 0,
575 IWL_D0I3_MODE_ON_IDLE,
576 IWL_D0I3_MODE_ON_SUSPEND,
577 };
578
579 /**
580 * struct iwl_trans - transport common data
581 *
582 * @ops - pointer to iwl_trans_ops
583 * @op_mode - pointer to the op_mode
584 * @cfg - pointer to the configuration
585 * @status: a bit-mask of transport status flags
586 * @dev - pointer to struct device * that represents the device
587 * @hw_id: a u32 with the ID of the device / sub-device.
588 * Set during transport allocation.
589 * @hw_id_str: a string with info about HW ID. Set during transport allocation.
590 * @pm_support: set to true in start_hw if link pm is supported
591 * @ltr_enabled: set to true if the LTR is enabled
592 * @dev_cmd_pool: pool for Tx cmd allocation - for internal use only.
593 * The user should use iwl_trans_{alloc,free}_tx_cmd.
594 * @dev_cmd_headroom: room needed for the transport's private use before the
595 * device_cmd for Tx - for internal use only
596 * The user should use iwl_trans_{alloc,free}_tx_cmd.
597 * @rx_mpdu_cmd: MPDU RX command ID, must be assigned by opmode before
598 * starting the firmware, used for tracing
599 * @rx_mpdu_cmd_hdr_size: used for tracing, amount of data before the
600 * start of the 802.11 header in the @rx_mpdu_cmd
601 * @dflt_pwr_limit: default power limit fetched from the platform (ACPI)
602 * @dbg_dest_tlv: points to the destination TLV for debug
603 * @dbg_conf_tlv: array of pointers to configuration TLVs for debug
604 * @dbg_trigger_tlv: array of pointers to triggers TLVs for debug
605 * @dbg_dest_reg_num: num of reg_ops in %dbg_dest_tlv
606 */
607 struct iwl_trans {
608 const struct iwl_trans_ops *ops;
609 struct iwl_op_mode *op_mode;
610 const struct iwl_cfg *cfg;
611 enum iwl_trans_state state;
612 unsigned long status;
613
614 struct device *dev;
615 u32 hw_rev;
616 u32 hw_id;
617 char hw_id_str[52];
618
619 u8 rx_mpdu_cmd, rx_mpdu_cmd_hdr_size;
620
621 bool pm_support;
622 bool ltr_enabled;
623
624 /* The following fields are internal only */
625 struct kmem_cache *dev_cmd_pool;
626 size_t dev_cmd_headroom;
627 char dev_cmd_pool_name[50];
628
629 struct dentry *dbgfs_dir;
630
631 #ifdef CONFIG_LOCKDEP
632 struct lockdep_map sync_cmd_lockdep_map;
633 #endif
634
635 u64 dflt_pwr_limit;
636
637 const struct iwl_fw_dbg_dest_tlv *dbg_dest_tlv;
638 const struct iwl_fw_dbg_conf_tlv *dbg_conf_tlv[FW_DBG_CONF_MAX];
639 struct iwl_fw_dbg_trigger_tlv * const *dbg_trigger_tlv;
640 u8 dbg_dest_reg_num;
641
642 enum iwl_d0i3_mode d0i3_mode;
643
644 /* pointer to trans specific struct */
645 /*Ensure that this pointer will always be aligned to sizeof pointer */
646 char trans_specific[0] __aligned(sizeof(void *));
647 };
648
iwl_trans_configure(struct iwl_trans * trans,const struct iwl_trans_config * trans_cfg)649 static inline void iwl_trans_configure(struct iwl_trans *trans,
650 const struct iwl_trans_config *trans_cfg)
651 {
652 trans->op_mode = trans_cfg->op_mode;
653
654 trans->ops->configure(trans, trans_cfg);
655 }
656
_iwl_trans_start_hw(struct iwl_trans * trans,bool low_power)657 static inline int _iwl_trans_start_hw(struct iwl_trans *trans, bool low_power)
658 {
659 might_sleep();
660
661 return trans->ops->start_hw(trans, low_power);
662 }
663
iwl_trans_start_hw(struct iwl_trans * trans)664 static inline int iwl_trans_start_hw(struct iwl_trans *trans)
665 {
666 return trans->ops->start_hw(trans, true);
667 }
668
iwl_trans_op_mode_leave(struct iwl_trans * trans)669 static inline void iwl_trans_op_mode_leave(struct iwl_trans *trans)
670 {
671 might_sleep();
672
673 if (trans->ops->op_mode_leave)
674 trans->ops->op_mode_leave(trans);
675
676 trans->op_mode = NULL;
677
678 trans->state = IWL_TRANS_NO_FW;
679 }
680
iwl_trans_fw_alive(struct iwl_trans * trans,u32 scd_addr)681 static inline void iwl_trans_fw_alive(struct iwl_trans *trans, u32 scd_addr)
682 {
683 might_sleep();
684
685 trans->state = IWL_TRANS_FW_ALIVE;
686
687 trans->ops->fw_alive(trans, scd_addr);
688 }
689
iwl_trans_start_fw(struct iwl_trans * trans,const struct fw_img * fw,bool run_in_rfkill)690 static inline int iwl_trans_start_fw(struct iwl_trans *trans,
691 const struct fw_img *fw,
692 bool run_in_rfkill)
693 {
694 might_sleep();
695
696 WARN_ON_ONCE(!trans->rx_mpdu_cmd);
697
698 clear_bit(STATUS_FW_ERROR, &trans->status);
699 return trans->ops->start_fw(trans, fw, run_in_rfkill);
700 }
701
iwl_trans_update_sf(struct iwl_trans * trans,struct iwl_sf_region * st_fwrd_space)702 static inline int iwl_trans_update_sf(struct iwl_trans *trans,
703 struct iwl_sf_region *st_fwrd_space)
704 {
705 might_sleep();
706
707 if (trans->ops->update_sf)
708 return trans->ops->update_sf(trans, st_fwrd_space);
709
710 return 0;
711 }
712
_iwl_trans_stop_device(struct iwl_trans * trans,bool low_power)713 static inline void _iwl_trans_stop_device(struct iwl_trans *trans,
714 bool low_power)
715 {
716 might_sleep();
717
718 trans->ops->stop_device(trans, low_power);
719
720 trans->state = IWL_TRANS_NO_FW;
721 }
722
iwl_trans_stop_device(struct iwl_trans * trans)723 static inline void iwl_trans_stop_device(struct iwl_trans *trans)
724 {
725 _iwl_trans_stop_device(trans, true);
726 }
727
iwl_trans_d3_suspend(struct iwl_trans * trans,bool test)728 static inline void iwl_trans_d3_suspend(struct iwl_trans *trans, bool test)
729 {
730 might_sleep();
731 trans->ops->d3_suspend(trans, test);
732 }
733
iwl_trans_d3_resume(struct iwl_trans * trans,enum iwl_d3_status * status,bool test)734 static inline int iwl_trans_d3_resume(struct iwl_trans *trans,
735 enum iwl_d3_status *status,
736 bool test)
737 {
738 might_sleep();
739 return trans->ops->d3_resume(trans, status, test);
740 }
741
iwl_trans_ref(struct iwl_trans * trans)742 static inline void iwl_trans_ref(struct iwl_trans *trans)
743 {
744 if (trans->ops->ref)
745 trans->ops->ref(trans);
746 }
747
iwl_trans_unref(struct iwl_trans * trans)748 static inline void iwl_trans_unref(struct iwl_trans *trans)
749 {
750 if (trans->ops->unref)
751 trans->ops->unref(trans);
752 }
753
iwl_trans_suspend(struct iwl_trans * trans)754 static inline void iwl_trans_suspend(struct iwl_trans *trans)
755 {
756 if (trans->ops->suspend)
757 trans->ops->suspend(trans);
758 }
759
iwl_trans_resume(struct iwl_trans * trans)760 static inline void iwl_trans_resume(struct iwl_trans *trans)
761 {
762 if (trans->ops->resume)
763 trans->ops->resume(trans);
764 }
765
766 static inline struct iwl_trans_dump_data *
iwl_trans_dump_data(struct iwl_trans * trans)767 iwl_trans_dump_data(struct iwl_trans *trans)
768 {
769 if (!trans->ops->dump_data)
770 return NULL;
771 return trans->ops->dump_data(trans);
772 }
773
iwl_trans_send_cmd(struct iwl_trans * trans,struct iwl_host_cmd * cmd)774 static inline int iwl_trans_send_cmd(struct iwl_trans *trans,
775 struct iwl_host_cmd *cmd)
776 {
777 int ret;
778
779 if (unlikely(!(cmd->flags & CMD_SEND_IN_RFKILL) &&
780 test_bit(STATUS_RFKILL, &trans->status)))
781 return -ERFKILL;
782
783 if (unlikely(test_bit(STATUS_FW_ERROR, &trans->status)))
784 return -EIO;
785
786 if (unlikely(trans->state != IWL_TRANS_FW_ALIVE)) {
787 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
788 return -EIO;
789 }
790
791 if (!(cmd->flags & CMD_ASYNC))
792 lock_map_acquire_read(&trans->sync_cmd_lockdep_map);
793
794 ret = trans->ops->send_cmd(trans, cmd);
795
796 if (!(cmd->flags & CMD_ASYNC))
797 lock_map_release(&trans->sync_cmd_lockdep_map);
798
799 return ret;
800 }
801
802 static inline struct iwl_device_cmd *
iwl_trans_alloc_tx_cmd(struct iwl_trans * trans)803 iwl_trans_alloc_tx_cmd(struct iwl_trans *trans)
804 {
805 u8 *dev_cmd_ptr = kmem_cache_alloc(trans->dev_cmd_pool, GFP_ATOMIC);
806
807 if (unlikely(dev_cmd_ptr == NULL))
808 return NULL;
809
810 return (struct iwl_device_cmd *)
811 (dev_cmd_ptr + trans->dev_cmd_headroom);
812 }
813
iwl_trans_free_tx_cmd(struct iwl_trans * trans,struct iwl_device_cmd * dev_cmd)814 static inline void iwl_trans_free_tx_cmd(struct iwl_trans *trans,
815 struct iwl_device_cmd *dev_cmd)
816 {
817 u8 *dev_cmd_ptr = (u8 *)dev_cmd - trans->dev_cmd_headroom;
818
819 kmem_cache_free(trans->dev_cmd_pool, dev_cmd_ptr);
820 }
821
iwl_trans_tx(struct iwl_trans * trans,struct sk_buff * skb,struct iwl_device_cmd * dev_cmd,int queue)822 static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
823 struct iwl_device_cmd *dev_cmd, int queue)
824 {
825 if (unlikely(test_bit(STATUS_FW_ERROR, &trans->status)))
826 return -EIO;
827
828 if (unlikely(trans->state != IWL_TRANS_FW_ALIVE))
829 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
830
831 return trans->ops->tx(trans, skb, dev_cmd, queue);
832 }
833
iwl_trans_reclaim(struct iwl_trans * trans,int queue,int ssn,struct sk_buff_head * skbs)834 static inline void iwl_trans_reclaim(struct iwl_trans *trans, int queue,
835 int ssn, struct sk_buff_head *skbs)
836 {
837 if (unlikely(trans->state != IWL_TRANS_FW_ALIVE))
838 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
839
840 trans->ops->reclaim(trans, queue, ssn, skbs);
841 }
842
iwl_trans_txq_disable(struct iwl_trans * trans,int queue,bool configure_scd)843 static inline void iwl_trans_txq_disable(struct iwl_trans *trans, int queue,
844 bool configure_scd)
845 {
846 trans->ops->txq_disable(trans, queue, configure_scd);
847 }
848
849 static inline void
iwl_trans_txq_enable_cfg(struct iwl_trans * trans,int queue,u16 ssn,const struct iwl_trans_txq_scd_cfg * cfg,unsigned int queue_wdg_timeout)850 iwl_trans_txq_enable_cfg(struct iwl_trans *trans, int queue, u16 ssn,
851 const struct iwl_trans_txq_scd_cfg *cfg,
852 unsigned int queue_wdg_timeout)
853 {
854 might_sleep();
855
856 if (unlikely((trans->state != IWL_TRANS_FW_ALIVE)))
857 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
858
859 trans->ops->txq_enable(trans, queue, ssn, cfg, queue_wdg_timeout);
860 }
861
iwl_trans_txq_enable(struct iwl_trans * trans,int queue,int fifo,int sta_id,int tid,int frame_limit,u16 ssn,unsigned int queue_wdg_timeout)862 static inline void iwl_trans_txq_enable(struct iwl_trans *trans, int queue,
863 int fifo, int sta_id, int tid,
864 int frame_limit, u16 ssn,
865 unsigned int queue_wdg_timeout)
866 {
867 struct iwl_trans_txq_scd_cfg cfg = {
868 .fifo = fifo,
869 .sta_id = sta_id,
870 .tid = tid,
871 .frame_limit = frame_limit,
872 .aggregate = sta_id >= 0,
873 };
874
875 iwl_trans_txq_enable_cfg(trans, queue, ssn, &cfg, queue_wdg_timeout);
876 }
877
878 static inline
iwl_trans_ac_txq_enable(struct iwl_trans * trans,int queue,int fifo,unsigned int queue_wdg_timeout)879 void iwl_trans_ac_txq_enable(struct iwl_trans *trans, int queue, int fifo,
880 unsigned int queue_wdg_timeout)
881 {
882 struct iwl_trans_txq_scd_cfg cfg = {
883 .fifo = fifo,
884 .sta_id = -1,
885 .tid = IWL_MAX_TID_COUNT,
886 .frame_limit = IWL_FRAME_LIMIT,
887 .aggregate = false,
888 };
889
890 iwl_trans_txq_enable_cfg(trans, queue, 0, &cfg, queue_wdg_timeout);
891 }
892
iwl_trans_freeze_txq_timer(struct iwl_trans * trans,unsigned long txqs,bool freeze)893 static inline void iwl_trans_freeze_txq_timer(struct iwl_trans *trans,
894 unsigned long txqs,
895 bool freeze)
896 {
897 if (unlikely(trans->state != IWL_TRANS_FW_ALIVE))
898 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
899
900 if (trans->ops->freeze_txq_timer)
901 trans->ops->freeze_txq_timer(trans, txqs, freeze);
902 }
903
iwl_trans_wait_tx_queue_empty(struct iwl_trans * trans,u32 txqs)904 static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans,
905 u32 txqs)
906 {
907 if (unlikely(trans->state != IWL_TRANS_FW_ALIVE))
908 IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
909
910 return trans->ops->wait_tx_queue_empty(trans, txqs);
911 }
912
iwl_trans_dbgfs_register(struct iwl_trans * trans,struct dentry * dir)913 static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans,
914 struct dentry *dir)
915 {
916 return trans->ops->dbgfs_register(trans, dir);
917 }
918
iwl_trans_write8(struct iwl_trans * trans,u32 ofs,u8 val)919 static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val)
920 {
921 trans->ops->write8(trans, ofs, val);
922 }
923
iwl_trans_write32(struct iwl_trans * trans,u32 ofs,u32 val)924 static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val)
925 {
926 trans->ops->write32(trans, ofs, val);
927 }
928
iwl_trans_read32(struct iwl_trans * trans,u32 ofs)929 static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs)
930 {
931 return trans->ops->read32(trans, ofs);
932 }
933
iwl_trans_read_prph(struct iwl_trans * trans,u32 ofs)934 static inline u32 iwl_trans_read_prph(struct iwl_trans *trans, u32 ofs)
935 {
936 return trans->ops->read_prph(trans, ofs);
937 }
938
iwl_trans_write_prph(struct iwl_trans * trans,u32 ofs,u32 val)939 static inline void iwl_trans_write_prph(struct iwl_trans *trans, u32 ofs,
940 u32 val)
941 {
942 return trans->ops->write_prph(trans, ofs, val);
943 }
944
iwl_trans_read_mem(struct iwl_trans * trans,u32 addr,void * buf,int dwords)945 static inline int iwl_trans_read_mem(struct iwl_trans *trans, u32 addr,
946 void *buf, int dwords)
947 {
948 return trans->ops->read_mem(trans, addr, buf, dwords);
949 }
950
951 #define iwl_trans_read_mem_bytes(trans, addr, buf, bufsize) \
952 do { \
953 if (__builtin_constant_p(bufsize)) \
954 BUILD_BUG_ON((bufsize) % sizeof(u32)); \
955 iwl_trans_read_mem(trans, addr, buf, (bufsize) / sizeof(u32));\
956 } while (0)
957
iwl_trans_read_mem32(struct iwl_trans * trans,u32 addr)958 static inline u32 iwl_trans_read_mem32(struct iwl_trans *trans, u32 addr)
959 {
960 u32 value;
961
962 if (WARN_ON(iwl_trans_read_mem(trans, addr, &value, 1)))
963 return 0xa5a5a5a5;
964
965 return value;
966 }
967
iwl_trans_write_mem(struct iwl_trans * trans,u32 addr,const void * buf,int dwords)968 static inline int iwl_trans_write_mem(struct iwl_trans *trans, u32 addr,
969 const void *buf, int dwords)
970 {
971 return trans->ops->write_mem(trans, addr, buf, dwords);
972 }
973
iwl_trans_write_mem32(struct iwl_trans * trans,u32 addr,u32 val)974 static inline u32 iwl_trans_write_mem32(struct iwl_trans *trans, u32 addr,
975 u32 val)
976 {
977 return iwl_trans_write_mem(trans, addr, &val, 1);
978 }
979
iwl_trans_set_pmi(struct iwl_trans * trans,bool state)980 static inline void iwl_trans_set_pmi(struct iwl_trans *trans, bool state)
981 {
982 if (trans->ops->set_pmi)
983 trans->ops->set_pmi(trans, state);
984 }
985
986 static inline void
iwl_trans_set_bits_mask(struct iwl_trans * trans,u32 reg,u32 mask,u32 value)987 iwl_trans_set_bits_mask(struct iwl_trans *trans, u32 reg, u32 mask, u32 value)
988 {
989 trans->ops->set_bits_mask(trans, reg, mask, value);
990 }
991
992 #define iwl_trans_grab_nic_access(trans, silent, flags) \
993 __cond_lock(nic_access, \
994 likely((trans)->ops->grab_nic_access(trans, silent, flags)))
995
__releases(nic_access)996 static inline void __releases(nic_access)
997 iwl_trans_release_nic_access(struct iwl_trans *trans, unsigned long *flags)
998 {
999 trans->ops->release_nic_access(trans, flags);
1000 __release(nic_access);
1001 }
1002
iwl_trans_fw_error(struct iwl_trans * trans)1003 static inline void iwl_trans_fw_error(struct iwl_trans *trans)
1004 {
1005 if (WARN_ON_ONCE(!trans->op_mode))
1006 return;
1007
1008 /* prevent double restarts due to the same erroneous FW */
1009 if (!test_and_set_bit(STATUS_FW_ERROR, &trans->status))
1010 iwl_op_mode_nic_error(trans->op_mode);
1011 }
1012
1013 /*****************************************************
1014 * driver (transport) register/unregister functions
1015 ******************************************************/
1016 int __must_check iwl_pci_register_driver(void);
1017 void iwl_pci_unregister_driver(void);
1018
trans_lockdep_init(struct iwl_trans * trans)1019 static inline void trans_lockdep_init(struct iwl_trans *trans)
1020 {
1021 #ifdef CONFIG_LOCKDEP
1022 static struct lock_class_key __key;
1023
1024 lockdep_init_map(&trans->sync_cmd_lockdep_map, "sync_cmd_lockdep_map",
1025 &__key, 0);
1026 #endif
1027 }
1028
1029 #endif /* __iwl_trans_h__ */
1030