iwl-trans.h 17.5 KB
Newer Older
1 2 3 4 5 6 7
/******************************************************************************
 *
 * This file is provided under a dual BSD/GPLv2 license.  When using or
 * redistributing this file, you may do so under either license.
 *
 * GPL LICENSE SUMMARY
 *
W
Wey-Yi Guy 已提交
8
 * Copyright(c) 2007 - 2012 Intel Corporation. All rights reserved.
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
 * USA
 *
 * The full GNU General Public License is included in this distribution
 * in the file called LICENSE.GPL.
 *
 * Contact Information:
 *  Intel Linux Wireless <ilw@linux.intel.com>
 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 *
 * BSD LICENSE
 *
W
Wey-Yi Guy 已提交
33
 * Copyright(c) 2005 - 2012 Intel Corporation. All rights reserved.
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name Intel Corporation nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/
63 64
#ifndef __iwl_trans_h__
#define __iwl_trans_h__
65

66
#include <linux/ieee80211.h>
E
Emmanuel Grumbach 已提交
67 68

#include "iwl-shared.h"
69
#include "iwl-debug.h"
70

71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
/**
 * DOC: Transport layer - what is it ?
 *
 * The tranport layer is the layer that deals with the HW directly. It provides
 * an abstraction of the underlying HW to the upper layer. The transport layer
 * doesn't provide any policy, algorithm or anything of this kind, but only
 * mechanisms to make the HW do something.It is not completely stateless but
 * close to it.
 * We will have an implementation for each different supported bus.
 */

/**
 * DOC: Life cycle of the transport layer
 *
 * The transport layer has a very precise life cycle.
 *
 *	1) A helper function is called during the module initialization and
 *	   registers the bus driver's ops with the transport's alloc function.
 *	2) Bus's probe calls to the transport layer's allocation functions.
 *	   Of course this function is bus specific.
 *	3) This allocation functions will spawn the upper layer which will
 *	   register mac80211.
 *
 *	4) At some point (i.e. mac80211's start call), the op_mode will call
 *	   the following sequence:
 *	   start_hw
 *	   start_fw
 *
 *	5) Then when finished (or reset):
 *	   stop_fw (a.k.a. stop device for the moment)
 *	   stop_hw
 *
 *	6) Eventually, the free function will be called.
 */

106
struct iwl_priv;
107
struct iwl_shared;
108
struct iwl_op_mode;
109 110 111
struct fw_img;
struct sk_buff;
struct dentry;
112

113 114 115 116 117 118 119 120
/**
 * DOC: Host command section
 *
 * A host command is a commaned issued by the upper layer to the fw. There are
 * several versions of fw that have several APIs. The transport layer is
 * completely agnostic to these differences.
 * The transport does provide helper functionnality (i.e. SYNC / ASYNC mode),
 */
121 122 123 124
#define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
#define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
#define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)

125 126 127 128 129 130 131 132 133 134
/**
 * enum CMD_MODE - how to send the host commands ?
 *
 * @CMD_SYNC: The caller will be stalled until the fw responds to the command
 * @CMD_ASYNC: Return right away and don't want for the response
 * @CMD_WANT_SKB: valid only with CMD_SYNC. The caller needs the buffer of the
 *	response.
 * @CMD_ON_DEMAND: This command is sent by the test mode pipe.
 */
enum CMD_MODE {
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
	CMD_SYNC = 0,
	CMD_ASYNC = BIT(0),
	CMD_WANT_SKB = BIT(1),
	CMD_ON_DEMAND = BIT(2),
};

#define DEF_CMD_PAYLOAD_SIZE 320

/**
 * struct iwl_device_cmd
 *
 * For allocation of the command and tx queues, this establishes the overall
 * size of the largest command we send to uCode, except for commands that
 * aren't fully copied and use other TFD space.
 */
struct iwl_device_cmd {
	struct iwl_cmd_header hdr;	/* uCode API */
152
	u8 payload[DEF_CMD_PAYLOAD_SIZE];
153 154 155 156 157 158
} __packed;

#define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))

#define IWL_MAX_CMD_TFDS	2

159 160 161 162 163 164 165 166 167
/**
 * struct iwl_hcmd_dataflag - flag for each one of the chunks of the command
 *
 * IWL_HCMD_DFL_NOCOPY: By default, the command is copied to the host command's
 *	ring. The transport layer doesn't map the command's buffer to DMA, but
 *	rather copies it to an previously allocated DMA buffer. This flag tells
 *	the transport layer not to copy the command, but to map the existing
 *	buffer. This can save memcpy and is worth with very big comamnds.
 */
168 169 170 171 172 173
enum iwl_hcmd_dataflag {
	IWL_HCMD_DFL_NOCOPY	= BIT(0),
};

/**
 * struct iwl_host_cmd - Host command to the uCode
174
 *
175 176
 * @data: array of chunks that composes the data of the host command
 * @reply_page: pointer to the page that holds the response to the host command
177 178
 * @handler_status: return value of the handler of the command
 *	(put in setup_rx_handlers) - valid for SYNC mode only
179
 * @flags: can be CMD_*
180
 * @len: array of the lenths of the chunks in data
181
 * @dataflags: IWL_HCMD_DFL_*
182 183 184 185 186
 * @id: id of the host command
 */
struct iwl_host_cmd {
	const void *data[IWL_MAX_CMD_TFDS];
	unsigned long reply_page;
187 188
	int handler_status;

189 190 191 192 193
	u32 flags;
	u16 len[IWL_MAX_CMD_TFDS];
	u8 dataflags[IWL_MAX_CMD_TFDS];
	u8 id;
};
194 195 196

/**
 * struct iwl_trans_ops - transport specific operations
197 198 199
 *
 * All the handlers MUST be implemented
 *
200
 * @start_hw: starts the HW- from that point on, the HW can send interrupts
201
 *	May sleep
202 203
 * @stop_hw: stops the HW- from that point on, the HW will be in low power but
 *	will still issue interrupt if the HW RF kill is triggered.
204
 *	May sleep
205
 * @start_fw: allocates and inits all the resources for the transport
206 207
 *	layer. Also kick a fw image.
 *	May sleep
208
 * @fw_alive: called when the fw sends alive notification
209
 *	May sleep
210
 * @wake_any_queue: wake all the queues of a specfic context IWL_RXON_CTX_*
211
 * @stop_device:stops the whole device (embedded CPU put to reset)
212
 *	May sleep
213
 * @send_cmd:send a host command
214
 *	May sleep only if CMD_SYNC is set
215
 * @tx: send an skb
216
 *	Must be atomic
217
 * @reclaim: free packet until ssn. Returns a list of freed packets.
218
 *	Must be atomic
219
 * @tx_agg_alloc: allocate resources for a TX BA session
220
 *	May sleep
221
 * @tx_agg_setup: setup a tx queue for AMPDU - will be called once the HW is
222 223
 *	ready and a successful ADDBA response has been received.
 *	May sleep
224
 * @tx_agg_disable: de-configure a Tx queue to send AMPDUs
225
 *	May sleep
226
 * @free: release all the ressource for the transport layer itself such as
227 228 229
 *	irq, tasklet etc... From this point on, the device may not issue
 *	any interrupt (incl. RFKILL).
 *	May sleep
230
 * @stop_queue: stop a specific queue
231
 * @check_stuck_queue: check if a specific queue is stuck
232
 * @wait_tx_queue_empty: wait until all tx queues are empty
233
 *	May sleep
234 235
 * @dbgfs_register: add the dbgfs files under this directory. Files will be
 *	automatically deleted.
236 237
 * @suspend: stop the device unless WoWLAN is configured
 * @resume: resume activity of the device
238 239 240
 * @write8: write a u8 to a register at offset ofs from the BAR
 * @write32: write a u32 to a register at offset ofs from the BAR
 * @read32: read a u32 register at offset ofs from the BAR
241 242 243
 */
struct iwl_trans_ops {

244
	int (*start_hw)(struct iwl_trans *iwl_trans);
245
	void (*stop_hw)(struct iwl_trans *iwl_trans);
246
	int (*start_fw)(struct iwl_trans *trans, struct fw_img *fw);
247
	void (*fw_alive)(struct iwl_trans *trans);
248
	void (*stop_device)(struct iwl_trans *trans);
249

250
	void (*wake_any_queue)(struct iwl_trans *trans,
251 252
			       enum iwl_rxon_context_id ctx,
			       const char *msg);
253

254
	int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
255

256
	int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
257
		struct iwl_device_cmd *dev_cmd, enum iwl_rxon_context_id ctx,
258
		u8 sta_id, u8 tid);
259
	int (*reclaim)(struct iwl_trans *trans, int sta_id, int tid,
260 261
			int txq_id, int ssn, u32 status,
			struct sk_buff_head *skbs);
262

263
	int (*tx_agg_disable)(struct iwl_trans *trans,
264
			      int sta_id, int tid);
265
	int (*tx_agg_alloc)(struct iwl_trans *trans,
266
			    int sta_id, int tid);
267 268
	void (*tx_agg_setup)(struct iwl_trans *trans,
			     enum iwl_rxon_context_id ctx, int sta_id, int tid,
269
			     int frame_limit, u16 ssn);
270

271
	void (*free)(struct iwl_trans *trans);
272

273
	void (*stop_queue)(struct iwl_trans *trans, int q, const char *msg);
274

275
	int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir);
276
	int (*check_stuck_queue)(struct iwl_trans *trans, int q);
277
	int (*wait_tx_queue_empty)(struct iwl_trans *trans);
J
Johannes Berg 已提交
278
#ifdef CONFIG_PM_SLEEP
279 280
	int (*suspend)(struct iwl_trans *trans);
	int (*resume)(struct iwl_trans *trans);
J
Johannes Berg 已提交
281
#endif
282 283 284
	void (*write8)(struct iwl_trans *trans, u32 ofs, u8 val);
	void (*write32)(struct iwl_trans *trans, u32 ofs, u32 val);
	u32 (*read32)(struct iwl_trans *trans, u32 ofs);
285 286
};

287 288 289 290 291 292 293 294
/* Opaque calibration results */
struct iwl_calib_result {
	struct list_head list;
	size_t cmd_len;
	struct iwl_calib_hdr hdr;
	/* data follows */
};

295 296 297 298 299 300 301 302 303 304 305
/**
 * enum iwl_trans_state - state of the transport layer
 *
 * @IWL_TRANS_NO_FW: no fw has sent an alive response
 * @IWL_TRANS_FW_ALIVE: a fw has sent an alive response
 */
enum iwl_trans_state {
	IWL_TRANS_NO_FW = 0,
	IWL_TRANS_FW_ALIVE	= 1,
};

306 307
/**
 * struct iwl_trans - transport common data
308
 *
309
 * @ops - pointer to iwl_trans_ops
310
 * @op_mode - pointer to the op_mode
311
 * @shrd - pointer to iwl_shared which holds shared data from the upper layer
312
 * @reg_lock - protect hw register access
313 314
 * @dev - pointer to struct device * that represents the device
 * @irq - the irq number for the device
E
Emmanuel Grumbach 已提交
315
 * @hw_id: a u32 with the ID of the device / subdevice.
316
 *	Set during transport allocation.
317
 * @hw_id_str: a string with info about HW ID. Set during transport allocation.
318
 * @ucode_write_complete: indicates that the ucode has been copied.
319
 * @nvm_device_type: indicates OTP or eeprom
320
 * @pm_support: set to true in start_hw if link pm is supported
321
 * @calib_results: list head for init calibration results
322
 */
323 324
struct iwl_trans {
	const struct iwl_trans_ops *ops;
325
	struct iwl_op_mode *op_mode;
326
	struct iwl_shared *shrd;
327
	enum iwl_trans_state state;
328
	spinlock_t reg_lock;
329

330 331
	struct device *dev;
	unsigned int irq;
332
	u32 hw_rev;
E
Emmanuel Grumbach 已提交
333
	u32 hw_id;
334
	char hw_id_str[52];
335

336
	u8 ucode_write_complete;
337

338
	int    nvm_device_type;
339
	bool pm_support;
340

341 342
	struct list_head calib_results;

343 344
	/* pointer to trans specific struct */
	/*Ensure that this pointer will always be aligned to sizeof pointer */
345
	char trans_specific[0] __aligned(sizeof(void *));
346 347
};

348 349 350 351 352 353 354 355 356 357
static inline void iwl_trans_configure(struct iwl_trans *trans,
				       struct iwl_op_mode *op_mode)
{
	/*
	 * only set the op_mode for the moment. Later on, this function will do
	 * more
	 */
	trans->op_mode = op_mode;
}

358
static inline int iwl_trans_start_hw(struct iwl_trans *trans)
359
{
360 361
	might_sleep();

362
	return trans->ops->start_hw(trans);
363 364
}

365 366
static inline void iwl_trans_stop_hw(struct iwl_trans *trans)
{
367 368
	might_sleep();

369
	trans->ops->stop_hw(trans);
370 371

	trans->state = IWL_TRANS_NO_FW;
372 373
}

374 375
static inline void iwl_trans_fw_alive(struct iwl_trans *trans)
{
376 377
	might_sleep();

378
	trans->ops->fw_alive(trans);
379 380

	trans->state = IWL_TRANS_FW_ALIVE;
381 382
}

383
static inline int iwl_trans_start_fw(struct iwl_trans *trans, struct fw_img *fw)
384
{
385 386 387
	might_sleep();

	return trans->ops->start_fw(trans, fw);
388 389
}

390
static inline void iwl_trans_stop_device(struct iwl_trans *trans)
391
{
392 393
	might_sleep();

394
	trans->ops->stop_device(trans);
395 396

	trans->state = IWL_TRANS_NO_FW;
397 398
}

399
static inline void iwl_trans_wake_any_queue(struct iwl_trans *trans,
400 401
					    enum iwl_rxon_context_id ctx,
					    const char *msg)
402
{
403 404 405
	if (trans->state != IWL_TRANS_FW_ALIVE)
		IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);

406
	trans->ops->wake_any_queue(trans, ctx, msg);
407 408 409
}


410
static inline int iwl_trans_send_cmd(struct iwl_trans *trans,
411 412
				struct iwl_host_cmd *cmd)
{
413 414 415
	if (trans->state != IWL_TRANS_FW_ALIVE)
		IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);

416
	return trans->ops->send_cmd(trans, cmd);
417 418
}

419 420
int iwl_trans_send_cmd_pdu(struct iwl_trans *trans, u8 id,
			   u32 flags, u16 len, const void *data);
421

422
static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
423
		struct iwl_device_cmd *dev_cmd, enum iwl_rxon_context_id ctx,
424
		u8 sta_id, u8 tid)
425
{
426 427 428
	if (trans->state != IWL_TRANS_FW_ALIVE)
		IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);

429
	return trans->ops->tx(trans, skb, dev_cmd, ctx, sta_id, tid);
430 431
}

432
static inline int iwl_trans_reclaim(struct iwl_trans *trans, int sta_id,
433
				 int tid, int txq_id, int ssn, u32 status,
434 435
				 struct sk_buff_head *skbs)
{
436 437 438
	if (trans->state != IWL_TRANS_FW_ALIVE)
		IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);

439 440
	return trans->ops->reclaim(trans, sta_id, tid, txq_id, ssn,
				   status, skbs);
441 442
}

443 444
static inline int iwl_trans_tx_agg_disable(struct iwl_trans *trans,
					    int sta_id, int tid)
445
{
446 447
	might_sleep();

448 449 450
	if (trans->state != IWL_TRANS_FW_ALIVE)
		IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);

451
	return trans->ops->tx_agg_disable(trans, sta_id, tid);
452 453
}

454
static inline int iwl_trans_tx_agg_alloc(struct iwl_trans *trans,
455
					 int sta_id, int tid)
456
{
457 458
	might_sleep();

459 460 461
	if (trans->state != IWL_TRANS_FW_ALIVE)
		IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);

462
	return trans->ops->tx_agg_alloc(trans, sta_id, tid);
463 464 465
}


466
static inline void iwl_trans_tx_agg_setup(struct iwl_trans *trans,
467 468
					   enum iwl_rxon_context_id ctx,
					   int sta_id, int tid,
469
					   int frame_limit, u16 ssn)
470
{
471 472
	might_sleep();

473 474 475
	if (trans->state != IWL_TRANS_FW_ALIVE)
		IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);

476
	trans->ops->tx_agg_setup(trans, ctx, sta_id, tid, frame_limit, ssn);
477 478
}

479
static inline void iwl_trans_free(struct iwl_trans *trans)
480
{
481
	trans->ops->free(trans);
482 483
}

484 485
static inline void iwl_trans_stop_queue(struct iwl_trans *trans, int q,
					const char *msg)
486
{
487 488 489
	if (trans->state != IWL_TRANS_FW_ALIVE)
		IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);

490
	trans->ops->stop_queue(trans, q, msg);
491 492
}

493 494
static inline int iwl_trans_wait_tx_queue_empty(struct iwl_trans *trans)
{
495 496 497
	if (trans->state != IWL_TRANS_FW_ALIVE)
		IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);

498 499 500
	return trans->ops->wait_tx_queue_empty(trans);
}

501 502
static inline int iwl_trans_check_stuck_queue(struct iwl_trans *trans, int q)
{
503 504 505
	if (trans->state != IWL_TRANS_FW_ALIVE)
		IWL_ERR(trans, "%s bad state = %d", __func__, trans->state);

506 507
	return trans->ops->check_stuck_queue(trans, q);
}
508 509 510 511 512 513
static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans,
					    struct dentry *dir)
{
	return trans->ops->dbgfs_register(trans, dir);
}

J
Johannes Berg 已提交
514
#ifdef CONFIG_PM_SLEEP
515 516 517 518 519 520 521 522 523
static inline int iwl_trans_suspend(struct iwl_trans *trans)
{
	return trans->ops->suspend(trans);
}

static inline int iwl_trans_resume(struct iwl_trans *trans)
{
	return trans->ops->resume(trans);
}
J
Johannes Berg 已提交
524
#endif
525

526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
static inline void iwl_trans_write8(struct iwl_trans *trans, u32 ofs, u8 val)
{
	trans->ops->write8(trans, ofs, val);
}

static inline void iwl_trans_write32(struct iwl_trans *trans, u32 ofs, u32 val)
{
	trans->ops->write32(trans, ofs, val);
}

static inline u32 iwl_trans_read32(struct iwl_trans *trans, u32 ofs)
{
	return trans->ops->read32(trans, ofs);
}

541
/*****************************************************
542
* Utils functions
543
******************************************************/
544 545 546 547 548
int iwl_send_calib_results(struct iwl_trans *trans);
int iwl_calib_set(struct iwl_trans *trans,
		  const struct iwl_calib_hdr *cmd, int len);
void iwl_calib_free_results(struct iwl_trans *trans);

549 550 551 552 553 554 555 556 557
/*****************************************************
* Transport layers implementations + their allocation function
******************************************************/
struct pci_dev;
struct pci_device_id;
extern const struct iwl_trans_ops trans_ops_pcie;
struct iwl_trans *iwl_trans_pcie_alloc(struct iwl_shared *shrd,
				       struct pci_dev *pdev,
				       const struct pci_device_id *ent);
E
Emmanuel Grumbach 已提交
558 559
int __must_check iwl_pci_register_driver(void);
void iwl_pci_unregister_driver(void);
560 561 562 563 564

extern const struct iwl_trans_ops trans_ops_idi;
struct iwl_trans *iwl_trans_idi_alloc(struct iwl_shared *shrd,
				      void *pdev_void,
				      const void *ent_void);
565
#endif /* __iwl_trans_h__ */