wl1271.h 12.2 KB
Newer Older
L
Luciano Coelho 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
/*
 * This file is part of wl1271
 *
 * Copyright (C) 1998-2009 Texas Instruments. All rights reserved.
 * Copyright (C) 2008-2009 Nokia Corporation
 *
 * Contact: Luciano Coelho <luciano.coelho@nokia.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 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 St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

#ifndef __WL1271_H__
#define __WL1271_H__

#include <linux/mutex.h>
#include <linux/completion.h>
#include <linux/spinlock.h>
#include <linux/list.h>
#include <linux/bitops.h>
#include <net/mac80211.h>

35
#include "wl1271_conf.h"
36
#include "wl1271_ini.h"
37

L
Luciano Coelho 已提交
38 39 40 41 42 43 44 45 46
#define DRIVER_NAME "wl1271"
#define DRIVER_PREFIX DRIVER_NAME ": "

enum {
	DEBUG_NONE	= 0,
	DEBUG_IRQ	= BIT(0),
	DEBUG_SPI	= BIT(1),
	DEBUG_BOOT	= BIT(2),
	DEBUG_MAILBOX	= BIT(3),
K
Kalle Valo 已提交
47
	DEBUG_TESTMODE	= BIT(4),
L
Luciano Coelho 已提交
48 49 50 51 52 53 54 55 56
	DEBUG_EVENT	= BIT(5),
	DEBUG_TX	= BIT(6),
	DEBUG_RX	= BIT(7),
	DEBUG_SCAN	= BIT(8),
	DEBUG_CRYPT	= BIT(9),
	DEBUG_PSM	= BIT(10),
	DEBUG_MAC80211	= BIT(11),
	DEBUG_CMD	= BIT(12),
	DEBUG_ACX	= BIT(13),
T
Teemu Paasikivi 已提交
57
	DEBUG_SDIO	= BIT(14),
58
	DEBUG_FILTERS   = BIT(15),
59
	DEBUG_ADHOC     = BIT(16),
L
Luciano Coelho 已提交
60 61 62 63 64 65 66 67 68 69 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
	DEBUG_ALL	= ~0,
};

#define DEBUG_LEVEL (DEBUG_NONE)

#define DEBUG_DUMP_LIMIT 1024

#define wl1271_error(fmt, arg...) \
	printk(KERN_ERR DRIVER_PREFIX "ERROR " fmt "\n", ##arg)

#define wl1271_warning(fmt, arg...) \
	printk(KERN_WARNING DRIVER_PREFIX "WARNING " fmt "\n", ##arg)

#define wl1271_notice(fmt, arg...) \
	printk(KERN_INFO DRIVER_PREFIX fmt "\n", ##arg)

#define wl1271_info(fmt, arg...) \
	printk(KERN_DEBUG DRIVER_PREFIX fmt "\n", ##arg)

#define wl1271_debug(level, fmt, arg...) \
	do { \
		if (level & DEBUG_LEVEL) \
			printk(KERN_DEBUG DRIVER_PREFIX fmt "\n", ##arg); \
	} while (0)

#define wl1271_dump(level, prefix, buf, len)	\
	do { \
		if (level & DEBUG_LEVEL) \
			print_hex_dump(KERN_DEBUG, DRIVER_PREFIX prefix, \
				       DUMP_PREFIX_OFFSET, 16, 1,	\
				       buf,				\
				       min_t(size_t, len, DEBUG_DUMP_LIMIT), \
				       0);				\
	} while (0)

#define wl1271_dump_ascii(level, prefix, buf, len)	\
	do { \
		if (level & DEBUG_LEVEL) \
			print_hex_dump(KERN_DEBUG, DRIVER_PREFIX prefix, \
				       DUMP_PREFIX_OFFSET, 16, 1,	\
				       buf,				\
				       min_t(size_t, len, DEBUG_DUMP_LIMIT), \
				       true);				\
	} while (0)

#define WL1271_DEFAULT_RX_CONFIG (CFG_UNI_FILTER_EN |	\
106 107
				  CFG_BSSID_FILTER_EN | \
				  CFG_MC_FILTER_EN)
L
Luciano Coelho 已提交
108 109 110 111 112 113 114 115

#define WL1271_DEFAULT_RX_FILTER (CFG_RX_RCTS_ACK | CFG_RX_PRSP_EN |  \
				  CFG_RX_MGMT_EN | CFG_RX_DATA_EN |   \
				  CFG_RX_CTL_EN | CFG_RX_BCN_EN |     \
				  CFG_RX_AUTH_EN | CFG_RX_ASSOC_EN)

#define WL1271_FW_NAME "wl1271-fw.bin"
#define WL1271_NVS_NAME "wl1271-nvs.bin"
116

117 118 119
#define WL1271_TX_SECURITY_LO16(s) ((u16)((s) & 0xffff))
#define WL1271_TX_SECURITY_HI32(s) ((u32)(((s) >> 16) & 0xffffffff))

120 121
#define WL1271_CIPHER_SUITE_GEM 0x00147201

122
#define WL1271_BUSY_WORD_CNT 1
123
#define WL1271_BUSY_WORD_LEN (WL1271_BUSY_WORD_CNT * sizeof(u32))
L
Luciano Coelho 已提交
124 125 126 127

#define WL1271_ELP_HW_STATE_ASLEEP 0
#define WL1271_ELP_HW_STATE_IRQ    1

J
Juuso Oikarinen 已提交
128 129 130
#define WL1271_DEFAULT_BEACON_INT  100
#define WL1271_DEFAULT_DTIM_PERIOD 1

131
#define ACX_TX_DESCRIPTORS         32
J
Juuso Oikarinen 已提交
132

L
Luciano Coelho 已提交
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
enum wl1271_state {
	WL1271_STATE_OFF,
	WL1271_STATE_ON,
	WL1271_STATE_PLT,
};

enum wl1271_partition_type {
	PART_DOWN,
	PART_WORK,
	PART_DRPW,

	PART_TABLE_LEN
};

struct wl1271_partition {
	u32 size;
	u32 start;
};

struct wl1271_partition_set {
	struct wl1271_partition mem;
	struct wl1271_partition reg;
155 156
	struct wl1271_partition mem2;
	struct wl1271_partition mem3;
L
Luciano Coelho 已提交
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
};

struct wl1271;

/* FIXME: I'm not sure about this structure name */
struct wl1271_chip {
	u32 id;
	char fw_ver[21];
};

struct wl1271_stats {
	struct acx_statistics *fw_stats;
	unsigned long fw_stats_update;

	unsigned int retry_count;
	unsigned int excessive_retries;
};

struct wl1271_debugfs {
	struct dentry *rootdir;
	struct dentry *fw_statistics;

	struct dentry *tx_internal_desc_overflow;

	struct dentry *rx_out_of_mem;
	struct dentry *rx_hdr_overflow;
	struct dentry *rx_hw_stuck;
	struct dentry *rx_dropped;
	struct dentry *rx_fcs_err;
	struct dentry *rx_xfr_hint_trig;
	struct dentry *rx_path_reset;
	struct dentry *rx_reset_counter;

	struct dentry *dma_rx_requested;
	struct dentry *dma_rx_errors;
	struct dentry *dma_tx_requested;
	struct dentry *dma_tx_errors;

	struct dentry *isr_cmd_cmplt;
	struct dentry *isr_fiqs;
	struct dentry *isr_rx_headers;
	struct dentry *isr_rx_mem_overflow;
	struct dentry *isr_rx_rdys;
	struct dentry *isr_irqs;
	struct dentry *isr_tx_procs;
	struct dentry *isr_decrypt_done;
	struct dentry *isr_dma0_done;
	struct dentry *isr_dma1_done;
	struct dentry *isr_tx_exch_complete;
	struct dentry *isr_commands;
	struct dentry *isr_rx_procs;
	struct dentry *isr_hw_pm_mode_changes;
	struct dentry *isr_host_acknowledges;
	struct dentry *isr_pci_pm;
	struct dentry *isr_wakeups;
	struct dentry *isr_low_rssi;

	struct dentry *wep_addr_key_count;
	struct dentry *wep_default_key_count;
	/* skipping wep.reserved */
	struct dentry *wep_key_not_found;
	struct dentry *wep_decrypt_fail;
	struct dentry *wep_packets;
	struct dentry *wep_interrupt;

	struct dentry *pwr_ps_enter;
	struct dentry *pwr_elp_enter;
	struct dentry *pwr_missing_bcns;
	struct dentry *pwr_wake_on_host;
	struct dentry *pwr_wake_on_timer_exp;
	struct dentry *pwr_tx_with_ps;
	struct dentry *pwr_tx_without_ps;
	struct dentry *pwr_rcvd_beacons;
	struct dentry *pwr_power_save_off;
	struct dentry *pwr_enable_ps;
	struct dentry *pwr_disable_ps;
	struct dentry *pwr_fix_tsf_ps;
	/* skipping cont_miss_bcns_spread for now */
	struct dentry *pwr_rcvd_awake_beacons;

	struct dentry *mic_rx_pkts;
	struct dentry *mic_calc_failure;

	struct dentry *aes_encrypt_fail;
	struct dentry *aes_decrypt_fail;
	struct dentry *aes_encrypt_packets;
	struct dentry *aes_decrypt_packets;
	struct dentry *aes_encrypt_interrupt;
	struct dentry *aes_decrypt_interrupt;

	struct dentry *event_heart_beat;
	struct dentry *event_calibration;
	struct dentry *event_rx_mismatch;
	struct dentry *event_rx_mem_empty;
	struct dentry *event_rx_pool;
	struct dentry *event_oom_late;
	struct dentry *event_phy_transmit_error;
	struct dentry *event_tx_stuck;

	struct dentry *ps_pspoll_timeouts;
	struct dentry *ps_upsd_timeouts;
	struct dentry *ps_upsd_max_sptime;
	struct dentry *ps_upsd_max_apturn;
	struct dentry *ps_pspoll_max_apturn;
	struct dentry *ps_pspoll_utilization;
	struct dentry *ps_upsd_utilization;

	struct dentry *rxpipe_rx_prep_beacon_drop;
	struct dentry *rxpipe_descr_host_int_trig_rx_data;
	struct dentry *rxpipe_beacon_buffer_thres_host_int_trig_rx_data;
	struct dentry *rxpipe_missed_beacon_host_int_trig_rx_data;
	struct dentry *rxpipe_tx_xfr_host_int_trig_rx_data;

	struct dentry *tx_queue_len;

	struct dentry *retry_count;
	struct dentry *excessive_retries;
274
	struct dentry *gpio_power;
L
Luciano Coelho 已提交
275 276 277 278 279 280 281
};

#define NUM_TX_QUEUES              4
#define NUM_RX_PKT_DESC            8

/* FW status registers */
struct wl1271_fw_status {
L
Luciano Coelho 已提交
282
	__le32 intr;
L
Luciano Coelho 已提交
283 284 285 286
	u8  fw_rx_counter;
	u8  drv_rx_counter;
	u8  reserved;
	u8  tx_results_counter;
L
Luciano Coelho 已提交
287 288 289 290
	__le32 rx_pkt_descs[NUM_RX_PKT_DESC];
	__le32 tx_released_blks[NUM_TX_QUEUES];
	__le32 fw_localtime;
	__le32 padding[2];
291
} __packed;
L
Luciano Coelho 已提交
292 293 294 295 296 297

struct wl1271_rx_mem_pool_addr {
	u32 addr;
	u32 addr_extra;
};

298
struct wl1271_scan {
299
	struct cfg80211_scan_request *req;
L
Luciano Coelho 已提交
300
	bool *scanned_ch;
301
	bool failed;
302 303 304 305 306
	u8 state;
	u8 ssid[IW_ESSID_MAX_SIZE+1];
	size_t ssid_len;
};

307 308 309 310 311 312 313
struct wl1271_if_operations {
	void (*read)(struct wl1271 *wl, int addr, void *buf, size_t len,
		     bool fixed);
	void (*write)(struct wl1271 *wl, int addr, void *buf, size_t len,
		     bool fixed);
	void (*reset)(struct wl1271 *wl);
	void (*init)(struct wl1271 *wl);
314
	int (*power)(struct wl1271 *wl, bool enable);
315 316 317 318 319
	struct device* (*dev)(struct wl1271 *wl);
	void (*enable_irq)(struct wl1271 *wl);
	void (*disable_irq)(struct wl1271 *wl);
};

L
Luciano Coelho 已提交
320
struct wl1271 {
321
	struct platform_device *plat_dev;
L
Luciano Coelho 已提交
322 323 324
	struct ieee80211_hw *hw;
	bool mac80211_registered;

325 326 327
	void *if_priv;

	struct wl1271_if_operations *if_ops;
L
Luciano Coelho 已提交
328 329 330

	void (*set_power)(bool enable);
	int irq;
331
	int ref_clock;
L
Luciano Coelho 已提交
332 333 334 335 336 337

	spinlock_t wl_lock;

	enum wl1271_state state;
	struct mutex mutex;

338 339
#define WL1271_FLAG_STA_RATES_CHANGED  (0)
#define WL1271_FLAG_STA_ASSOCIATED     (1)
340 341 342
#define WL1271_FLAG_JOINED             (2)
#define WL1271_FLAG_GPIO_POWER         (3)
#define WL1271_FLAG_TX_QUEUE_STOPPED   (4)
L
Luciano Coelho 已提交
343 344 345 346 347 348 349 350
#define WL1271_FLAG_IN_ELP             (5)
#define WL1271_FLAG_PSM                (6)
#define WL1271_FLAG_PSM_REQUESTED      (7)
#define WL1271_FLAG_IRQ_PENDING        (8)
#define WL1271_FLAG_IRQ_RUNNING        (9)
#define WL1271_FLAG_IDLE              (10)
#define WL1271_FLAG_IDLE_REQUESTED    (11)
#define WL1271_FLAG_PSPOLL_FAILURE    (12)
351
#define WL1271_FLAG_STA_STATE_SENT    (13)
352 353
	unsigned long flags;

354
	struct wl1271_partition_set part;
L
Luciano Coelho 已提交
355 356 357 358 359 360 361 362

	struct wl1271_chip chip;

	int cmd_box_addr;
	int event_box_addr;

	u8 *fw;
	size_t fw_len;
363
	struct wl1271_nvs_file *nvs;
364
	size_t nvs_len;
L
Luciano Coelho 已提交
365

366 367
	s8 hw_pg_ver;

L
Luciano Coelho 已提交
368 369 370
	u8 bssid[ETH_ALEN];
	u8 mac_addr[ETH_ALEN];
	u8 bss_type;
371
	u8 set_bss_type;
L
Luciano Coelho 已提交
372 373 374 375 376 377 378 379 380
	u8 ssid[IW_ESSID_MAX_SIZE + 1];
	u8 ssid_len;
	int channel;

	struct wl1271_acx_mem_map *target_mem_map;

	/* Accounting for allocated / available TX blocks on HW */
	u32 tx_blocks_freed[NUM_TX_QUEUES];
	u32 tx_blocks_available;
381
	u32 tx_results_count;
L
Luciano Coelho 已提交
382 383

	/* Transmitted TX packets counter for chipset interface */
384
	u32 tx_packets_count;
L
Luciano Coelho 已提交
385 386

	/* Time-offset between host and chipset clocks */
387
	s64 time_offset;
L
Luciano Coelho 已提交
388 389 390 391 392 393 394 395

	/* Session counter for the chipset */
	int session_counter;

	/* Frames scheduled for transmission, not handled yet */
	struct sk_buff_head tx_queue;

	struct work_struct tx_work;
396

L
Luciano Coelho 已提交
397
	/* Pending TX frames */
J
Juuso Oikarinen 已提交
398
	struct sk_buff *tx_frames[ACX_TX_DESCRIPTORS];
399
	int tx_frames_cnt;
L
Luciano Coelho 已提交
400

401 402
	/* Security sequence number counters */
	u8 tx_security_last_seq;
403
	s64 tx_security_seq;
404

L
Luciano Coelho 已提交
405 406 407 408 409 410 411 412 413
	/* FW Rx counter */
	u32 rx_counter;

	/* Rx memory pool address */
	struct wl1271_rx_mem_pool_addr rx_mem_pool_addr;

	/* The target interrupt mask */
	struct work_struct irq_work;

414 415 416
	/* Hardware recovery work */
	struct work_struct recovery_work;

L
Luciano Coelho 已提交
417 418 419 420 421 422 423
	/* The mbox event mask */
	u32 event_mask;

	/* Mailbox pointers */
	u32 mbox_ptr[2];

	/* Are we currently scanning */
424
	struct wl1271_scan scan;
425
	struct delayed_work scan_complete_work;
L
Luciano Coelho 已提交
426 427 428 429

	/* Our association ID */
	u16 aid;

J
Juuso Oikarinen 已提交
430
	/* currently configured rate set */
431
	u32 sta_rate_set;
J
Juuso Oikarinen 已提交
432
	u32 basic_rate_set;
433
	u32 basic_rate;
434
	u32 rate_set;
J
Juuso Oikarinen 已提交
435

436 437 438
	/* The current band */
	enum ieee80211_band band;

439 440 441
	/* Beaconing interval (needed for ad-hoc) */
	u32 beacon_int;

L
Luciano Coelho 已提交
442 443 444
	/* Default key (for WEP) */
	u32 default_key;

445
	unsigned int filters;
L
Luciano Coelho 已提交
446 447 448 449
	unsigned int rx_config;
	unsigned int rx_filter;

	struct completion *elp_compl;
450
	struct delayed_work elp_work;
451 452 453 454
	struct delayed_work pspoll_work;

	/* counter for ps-poll delivery failures */
	int ps_poll_failures;
L
Luciano Coelho 已提交
455

456 457 458
	/* retry counter for PSM entries */
	u8 psm_entry_retry;

L
Luciano Coelho 已提交
459 460 461
	/* in dBm */
	int power_level;

462 463 464
	int rssi_thold;
	int last_rssi_event;

L
Luciano Coelho 已提交
465 466 467
	struct wl1271_stats stats;
	struct wl1271_debugfs debugfs;

468
	__le32 buffer_32;
L
Luciano Coelho 已提交
469
	u32 buffer_cmd;
470
	u32 buffer_busyword[WL1271_BUSY_WORD_CNT];
L
Luciano Coelho 已提交
471 472 473

	struct wl1271_fw_status *fw_status;
	struct wl1271_tx_hw_res_if *tx_res_if;
474 475

	struct ieee80211_vif *vif;
476

477 478
	/* Current chipset configuration */
	struct conf_drv_settings conf;
479

480 481
	bool sg_enabled;

482 483
	bool enable_11a;

484
	struct list_head list;
485 486 487

	/* Most recently reported noise in dBm */
	s8 noise;
L
Luciano Coelho 已提交
488 489 490 491 492 493 494 495 496 497 498
};

int wl1271_plt_start(struct wl1271 *wl);
int wl1271_plt_stop(struct wl1271 *wl);

#define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */

#define SESSION_COUNTER_MAX 7 /* maximum value for the session counter */

#define WL1271_DEFAULT_POWER_LEVEL 0

499 500
#define WL1271_TX_QUEUE_LOW_WATERMARK  10
#define WL1271_TX_QUEUE_HIGH_WATERMARK 25
L
Luciano Coelho 已提交
501

J
Juuso Oikarinen 已提交
502 503 504
/* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
   on in case is has been shut down shortly before */
#define WL1271_PRE_POWER_ON_SLEEP 20 /* in miliseconds */
L
Luciano Coelho 已提交
505 506 507
#define WL1271_POWER_ON_SLEEP 200 /* in miliseconds */

#endif