1 /******************************************************************************
3 * Copyright(c) 2003 - 2008 Intel Corporation. All rights reserved.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of version 2 of the GNU General Public License as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
18 * The full GNU General Public License is included in this distribution in the
19 * file called LICENSE.
21 * Contact Information:
22 * Intel Linux Wireless <ilw@linux.intel.com>
23 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
25 *****************************************************************************/
27 * Please use this file (iwl-3945.h) for driver implementation definitions.
28 * Please use iwl-3945-commands.h for uCode API definitions.
29 * Please use iwl-3945-hw.h for hardware-related definitions.
32 #ifndef __iwl_3945_h__
33 #define __iwl_3945_h__
35 #include <linux/pci.h> /* for struct pci_device_id */
36 #include <linux/kernel.h>
37 #include <net/ieee80211_radiotap.h>
40 #include <linux/rfkill.h>
41 #include <linux/input.h>
43 /* Hardware specific file defines the PCI IDs table for that hardware module */
44 extern struct pci_device_id iwl3945_hw_card_ids[];
48 #include "iwl-3945-hw.h"
49 #include "iwl-debug.h"
50 #include "iwl-power.h"
52 #include "iwl-3945-led.h"
54 /* Highest firmware API version supported */
55 #define IWL3945_UCODE_API_MAX 2
57 /* Lowest firmware API version supported */
58 #define IWL3945_UCODE_API_MIN 1
60 #define IWL3945_FW_PRE "iwlwifi-3945-"
61 #define _IWL3945_MODULE_FIRMWARE(api) IWL3945_FW_PRE #api ".ucode"
62 #define IWL3945_MODULE_FIRMWARE(api) _IWL3945_MODULE_FIRMWARE(api)
64 /* Default noise level to report when noise measurement is not available.
65 * This may be because we're:
66 * 1) Not associated (4965, no beacon statistics being sent to driver)
67 * 2) Scanning (noise measurement does not apply to associated channel)
68 * 3) Receiving CCK (3945 delivers noise info only for OFDM frames)
69 * Use default noise value of -127 ... this is below the range of measurable
70 * Rx dBm for either 3945 or 4965, so it can indicate "unmeasurable" to user.
71 * Also, -127 works better than 0 when averaging frames with/without
72 * noise info (e.g. averaging might be done in app); measured dBm values are
73 * always negative ... using a negative value as the default keeps all
74 * averages within an s8's (used in some apps) range of negative values. */
75 #define IWL_NOISE_MEAS_NOT_AVAILABLE (-127)
77 /* Module parameters accessible from iwl-*.c */
78 extern int iwl3945_param_hwcrypto;
79 extern int iwl3945_param_queues_num;
81 struct iwl3945_sta_priv {
82 struct iwl3945_rs_sta *rs_sta;
85 enum iwl3945_antenna {
86 IWL_ANTENNA_DIVERSITY,
92 * RTS threshold here is total size [2347] minus 4 FCS bytes
94 * a value of 0 means RTS on all data/management packets
95 * a value > max MSDU size means no RTS
96 * else RTS for data/management frames where MPDU is larger
99 #define IWL_RX_BUF_SIZE 3000U
100 #define DEFAULT_RTS_THRESHOLD 2347U
101 #define MIN_RTS_THRESHOLD 0U
102 #define MAX_RTS_THRESHOLD 2347U
103 #define MAX_MSDU_SIZE 2304U
104 #define MAX_MPDU_SIZE 2346U
105 #define DEFAULT_BEACON_INTERVAL 100U
106 #define DEFAULT_SHORT_RETRY_LIMIT 7U
107 #define DEFAULT_LONG_RETRY_LIMIT 4U
109 struct iwl3945_rx_mem_buffer {
112 struct list_head list;
115 int iwl3945_x2_queue_used(const struct iwl_queue *q, int i);
117 #define MAX_NUM_OF_TBS (20)
119 /* One for each TFD */
120 struct iwl3945_tx_info {
121 struct sk_buff *skb[MAX_NUM_OF_TBS];
124 #include "iwl-agn-rs.h"
126 #define IWL_TX_FIFO_AC0 0
127 #define IWL_TX_FIFO_AC1 1
128 #define IWL_TX_FIFO_AC2 2
129 #define IWL_TX_FIFO_AC3 3
130 #define IWL_TX_FIFO_HCCA_1 5
131 #define IWL_TX_FIFO_HCCA_2 6
132 #define IWL_TX_FIFO_NONE 7
134 /* Minimum number of queues. MAX_NUM is defined in hw specific files */
135 #define IWL_MIN_NUM_QUEUES 4
137 #define IEEE80211_DATA_LEN 2304
138 #define IEEE80211_4ADDR_LEN 30
139 #define IEEE80211_HLEN (IEEE80211_4ADDR_LEN)
140 #define IEEE80211_FRAME_LEN (IEEE80211_DATA_LEN + IEEE80211_HLEN)
142 struct iwl3945_frame {
144 struct ieee80211_hdr frame;
145 struct iwl3945_tx_beacon_cmd beacon;
146 u8 raw[IEEE80211_FRAME_LEN];
149 struct list_head list;
152 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
153 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
154 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
159 struct iwl3945_cmd_meta {
160 struct iwl3945_cmd_meta *source;
163 int (*callback)(struct iwl3945_priv *priv,
164 struct iwl3945_cmd *cmd, struct sk_buff *skb);
165 } __attribute__ ((packed)) u;
167 /* The CMD_SIZE_HUGE flag bit indicates that the command
168 * structure is stored at the end of the shared queue memory. */
171 } __attribute__ ((packed));
176 * For allocation of the command and tx queues, this establishes the overall
177 * size of the largest command we send to uCode, except for a scan command
178 * (which is relatively huge; space is allocated separately).
181 struct iwl3945_cmd_meta meta;
182 struct iwl_cmd_header hdr;
184 struct iwl3945_addsta_cmd addsta;
185 struct iwl_led_cmd led;
190 struct iwl_bt_cmd bt;
191 struct iwl_rxon_time_cmd rxon_time;
192 struct iwl_powertable_cmd powertable;
193 struct iwl_qosparam_cmd qosparam;
194 struct iwl3945_tx_cmd tx;
195 struct iwl3945_tx_beacon_cmd tx_beacon;
196 struct iwl3945_rxon_assoc_cmd rxon_assoc;
199 } __attribute__ ((packed)) cmd;
200 } __attribute__ ((packed));
202 struct iwl3945_host_cmd {
205 struct iwl3945_cmd_meta meta;
209 #define TFD39_MAX_PAYLOAD_SIZE (sizeof(struct iwl3945_cmd) - \
210 sizeof(struct iwl3945_cmd_meta))
213 * RX related structures and functions
215 #define RX_FREE_BUFFERS 64
216 #define RX_LOW_WATERMARK 8
218 #define SUP_RATE_11A_MAX_NUM_CHANNELS 8
219 #define SUP_RATE_11B_MAX_NUM_CHANNELS 4
220 #define SUP_RATE_11G_MAX_NUM_CHANNELS 12
223 * struct iwl3945_rx_queue - Rx queue
224 * @processed: Internal index to last handled Rx packet
225 * @read: Shared index to newest available Rx buffer
226 * @write: Shared index to oldest written Rx packet
227 * @free_count: Number of pre-allocated buffers in rx_free
228 * @rx_free: list of free SKBs for use
229 * @rx_used: List of Rx buffers with no SKB
230 * @need_update: flag to indicate we need to update read/write index
232 * NOTE: rx_free and rx_used are used as a FIFO for iwl3945_rx_mem_buffers
234 struct iwl3945_rx_queue {
237 struct iwl3945_rx_mem_buffer pool[RX_QUEUE_SIZE + RX_FREE_BUFFERS];
238 struct iwl3945_rx_mem_buffer *queue[RX_QUEUE_SIZE];
243 struct list_head rx_free;
244 struct list_head rx_used;
249 #define IWL_SUPPORTED_RATES_IE_LEN 8
251 #define SCAN_INTERVAL 100
253 #define STATUS_HCMD_ACTIVE 0 /* host command in progress */
254 #define STATUS_HCMD_SYNC_ACTIVE 1 /* sync host command in progress */
255 #define STATUS_INT_ENABLED 2
256 #define STATUS_RF_KILL_HW 3
257 #define STATUS_RF_KILL_SW 4
258 #define STATUS_INIT 5
259 #define STATUS_ALIVE 6
260 #define STATUS_READY 7
261 #define STATUS_TEMPERATURE 8
262 #define STATUS_GEO_CONFIGURED 9
263 #define STATUS_EXIT_PENDING 10
264 #define STATUS_IN_SUSPEND 11
265 #define STATUS_STATISTICS 12
266 #define STATUS_SCANNING 13
267 #define STATUS_SCAN_ABORTING 14
268 #define STATUS_SCAN_HW 15
269 #define STATUS_POWER_PMI 16
270 #define STATUS_FW_ERROR 17
271 #define STATUS_CONF_PENDING 18
273 #define MAX_TID_COUNT 9
275 #define IWL_INVALID_RATE 0xFF
276 #define IWL_INVALID_VALUE -1
278 #define STA_PS_STATUS_WAKE 0
279 #define STA_PS_STATUS_SLEEP 1
281 struct iwl3945_ibss_seq {
285 unsigned long packet_time;
286 struct list_head list;
290 * struct iwl3945_driver_hw_info
291 * @max_txq_num: Max # Tx queues supported
292 * @tx_cmd_len: Size of Tx command (but not including frame itself)
293 * @tx_ant_num: Number of TX antennas
294 * @max_rxq_size: Max # Rx frames in Rx queue (must be power-of-2)
297 * @max_rxq_log: Log-base-2 of max_rxq_size
300 * @shared_virt: Pointer to driver/uCode shared Tx Byte Counts and Rx status
301 * @shared_phys: Physical Pointer to Tx Byte Counts and Rx status
303 struct iwl3945_driver_hw_info {
314 dma_addr_t shared_phys;
317 #define IWL_RX_HDR(x) ((struct iwl3945_rx_frame_hdr *)(\
318 x->u.rx_frame.stats.payload + \
319 x->u.rx_frame.stats.phy_count))
320 #define IWL_RX_END(x) ((struct iwl3945_rx_frame_end *)(\
321 IWL_RX_HDR(x)->payload + \
322 le16_to_cpu(IWL_RX_HDR(x)->len)))
323 #define IWL_RX_STATS(x) (&x->u.rx_frame.stats)
324 #define IWL_RX_DATA(x) (IWL_RX_HDR(x)->payload)
327 /******************************************************************************
329 * Functions implemented in iwl-base.c which are forward declared here
332 *****************************************************************************/
333 struct iwl3945_addsta_cmd;
334 extern int iwl3945_send_add_station(struct iwl3945_priv *priv,
335 struct iwl3945_addsta_cmd *sta, u8 flags);
336 extern u8 iwl3945_add_station(struct iwl3945_priv *priv, const u8 *bssid,
337 int is_ap, u8 flags);
338 extern int iwl3945_power_init_handle(struct iwl3945_priv *priv);
339 extern int iwl3945_eeprom_init(struct iwl3945_priv *priv);
340 extern int iwl3945_rx_queue_alloc(struct iwl3945_priv *priv);
341 extern void iwl3945_rx_queue_reset(struct iwl3945_priv *priv,
342 struct iwl3945_rx_queue *rxq);
343 extern int iwl3945_calc_db_from_ratio(int sig_ratio);
344 extern int iwl3945_calc_sig_qual(int rssi_dbm, int noise_dbm);
345 extern int iwl3945_tx_queue_init(struct iwl3945_priv *priv,
346 struct iwl3945_tx_queue *txq, int count, u32 id);
347 extern void iwl3945_rx_replenish(void *data);
348 extern void iwl3945_tx_queue_free(struct iwl3945_priv *priv, struct iwl3945_tx_queue *txq);
349 extern int iwl3945_send_cmd_pdu(struct iwl3945_priv *priv, u8 id, u16 len,
351 extern int __must_check iwl3945_send_cmd(struct iwl3945_priv *priv,
352 struct iwl3945_host_cmd *cmd);
353 extern unsigned int iwl3945_fill_beacon_frame(struct iwl3945_priv *priv,
354 struct ieee80211_hdr *hdr,int left);
355 extern int iwl3945_rx_queue_update_write_ptr(struct iwl3945_priv *priv,
356 struct iwl3945_rx_queue *q);
357 extern int iwl3945_send_statistics_request(struct iwl3945_priv *priv);
358 extern void iwl3945_set_decrypted_flag(struct iwl3945_priv *priv, struct sk_buff *skb,
360 struct ieee80211_rx_status *stats);
361 extern const u8 iwl3945_broadcast_addr[ETH_ALEN];
364 * Currently used by iwl-3945-rs... look at restructuring so that it doesn't
365 * call this... todo... fix that.
367 extern u8 iwl3945_sync_station(struct iwl3945_priv *priv, int sta_id,
368 u16 tx_rate, u8 flags);
370 /******************************************************************************
372 * Functions implemented in iwl-[34]*.c which are forward declared here
373 * for use by iwl-base.c
375 * NOTE: The implementation of these functions are hardware specific
376 * which is why they are in the hardware specific files (vs. iwl-base.c)
378 * Naming convention --
379 * iwl3945_ <-- Its part of iwlwifi (should be changed to iwl3945_)
380 * iwl3945_hw_ <-- Hardware specific (implemented in iwl-XXXX.c by all HW)
381 * iwlXXXX_ <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
382 * iwl3945_bg_ <-- Called from work queue context
383 * iwl3945_mac_ <-- mac80211 callback
385 ****************************************************************************/
386 extern void iwl3945_hw_rx_handler_setup(struct iwl3945_priv *priv);
387 extern void iwl3945_hw_setup_deferred_work(struct iwl3945_priv *priv);
388 extern void iwl3945_hw_cancel_deferred_work(struct iwl3945_priv *priv);
389 extern int iwl3945_hw_rxq_stop(struct iwl3945_priv *priv);
390 extern int iwl3945_hw_set_hw_setting(struct iwl3945_priv *priv);
391 extern int iwl3945_hw_nic_init(struct iwl3945_priv *priv);
392 extern int iwl3945_hw_nic_stop_master(struct iwl3945_priv *priv);
393 extern void iwl3945_hw_txq_ctx_free(struct iwl3945_priv *priv);
394 extern void iwl3945_hw_txq_ctx_stop(struct iwl3945_priv *priv);
395 extern int iwl3945_hw_nic_reset(struct iwl3945_priv *priv);
396 extern int iwl3945_hw_txq_attach_buf_to_tfd(struct iwl3945_priv *priv, void *tfd,
397 dma_addr_t addr, u16 len);
398 extern int iwl3945_hw_txq_free_tfd(struct iwl3945_priv *priv, struct iwl3945_tx_queue *txq);
399 extern int iwl3945_hw_get_temperature(struct iwl3945_priv *priv);
400 extern int iwl3945_hw_tx_queue_init(struct iwl3945_priv *priv,
401 struct iwl3945_tx_queue *txq);
402 extern unsigned int iwl3945_hw_get_beacon_cmd(struct iwl3945_priv *priv,
403 struct iwl3945_frame *frame, u8 rate);
404 extern int iwl3945_hw_get_rx_read(struct iwl3945_priv *priv);
405 extern void iwl3945_hw_build_tx_cmd_rate(struct iwl3945_priv *priv,
406 struct iwl3945_cmd *cmd,
407 struct ieee80211_tx_info *info,
408 struct ieee80211_hdr *hdr,
409 int sta_id, int tx_id);
410 extern int iwl3945_hw_reg_send_txpower(struct iwl3945_priv *priv);
411 extern int iwl3945_hw_reg_set_txpower(struct iwl3945_priv *priv, s8 power);
412 extern void iwl3945_hw_rx_statistics(struct iwl3945_priv *priv,
413 struct iwl3945_rx_mem_buffer *rxb);
414 extern void iwl3945_disable_events(struct iwl3945_priv *priv);
415 extern int iwl4965_get_temperature(const struct iwl3945_priv *priv);
418 * iwl3945_hw_find_station - Find station id for a given BSSID
419 * @bssid: MAC address of station ID to find
421 * NOTE: This should not be hardware specific but the code has
422 * not yet been merged into a single common layer for managing the
425 extern u8 iwl3945_hw_find_station(struct iwl3945_priv *priv, const u8 *bssid);
427 extern int iwl3945_hw_channel_switch(struct iwl3945_priv *priv, u16 channel);
430 * Forward declare iwl-3945.c functions for iwl-base.c
432 extern __le32 iwl3945_get_antenna_flags(const struct iwl3945_priv *priv);
433 extern int iwl3945_init_hw_rate_table(struct iwl3945_priv *priv);
434 extern void iwl3945_reg_txpower_periodic(struct iwl3945_priv *priv);
435 extern int iwl3945_txpower_set_from_eeprom(struct iwl3945_priv *priv);
436 extern u8 iwl3945_sync_sta(struct iwl3945_priv *priv, int sta_id,
437 u16 tx_rate, u8 flags);
439 #ifdef CONFIG_IWL3945_RFKILL
442 void iwl3945_rfkill_set_hw_state(struct iwl3945_priv *priv);
443 void iwl3945_rfkill_unregister(struct iwl3945_priv *priv);
444 int iwl3945_rfkill_init(struct iwl3945_priv *priv);
446 static inline void iwl3945_rfkill_set_hw_state(struct iwl3945_priv *priv) {}
447 static inline void iwl3945_rfkill_unregister(struct iwl3945_priv *priv) {}
448 static inline int iwl3945_rfkill_init(struct iwl3945_priv *priv) { return 0; }
452 struct iwl3945_priv {
454 /* ieee device used by generic ieee processing code */
455 struct ieee80211_hw *hw;
456 struct ieee80211_channel *ieee_channels;
457 struct ieee80211_rate *ieee_rates;
458 struct iwl_cfg *cfg; /* device configuration */
460 /* temporary frame storage list */
461 struct list_head free_frames;
464 enum ieee80211_band band;
467 void (*rx_handlers[REPLY_MAX])(struct iwl3945_priv *priv,
468 struct iwl3945_rx_mem_buffer *rxb);
470 struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
472 #ifdef CONFIG_IWL3945_SPECTRUM_MEASUREMENT
473 /* spectrum measurement report caching */
474 struct iwl_spectrum_notification measure_report;
475 u8 measurement_status;
477 /* ucode beacon time */
478 u32 ucode_beacon_time;
480 /* we allocate array of iwl3945_channel_info for NIC's valid channels.
481 * Access via channel # using indirect index array */
482 struct iwl_channel_info *channel_info; /* channel info array */
483 u8 channel_count; /* # of channels */
485 /* each calibration channel group in the EEPROM has a derived
486 * clip setting for each rate. */
487 const struct iwl3945_clip_group clip_groups[5];
489 /* thermal calibration */
490 s32 temperature; /* degrees Kelvin */
491 s32 last_temperature;
493 /* Scan related variables */
494 unsigned long last_scan_jiffies;
495 unsigned long next_scan_jiffies;
496 unsigned long scan_start;
497 unsigned long scan_pass_start;
498 unsigned long scan_start_tsf;
502 u8 direct_ssid[IW_ESSID_MAX_SIZE];
503 struct iwl3945_scan_cmd *scan;
506 spinlock_t lock; /* protect general shared data */
507 spinlock_t hcmd_lock; /* protect hcmd */
510 /* basic pci-network driver stuff */
511 struct pci_dev *pci_dev;
513 /* pci hardware address support */
514 void __iomem *hw_base;
516 /* uCode images, save to reload in case of failure */
517 u32 ucode_ver; /* ucode version, copy of
519 struct fw_desc ucode_code; /* runtime inst */
520 struct fw_desc ucode_data; /* runtime data original */
521 struct fw_desc ucode_data_backup; /* runtime data save/restore */
522 struct fw_desc ucode_init; /* initialization inst */
523 struct fw_desc ucode_init_data; /* initialization data */
524 struct fw_desc ucode_boot; /* bootstrap inst */
527 struct iwl_rxon_time_cmd rxon_timing;
529 /* We declare this const so it can only be
530 * changed via explicit cast within the
531 * routines that actually update the physical
533 const struct iwl3945_rxon_cmd active_rxon;
534 struct iwl3945_rxon_cmd staging_rxon;
536 int error_recovering;
537 struct iwl3945_rxon_cmd recovery_rxon;
539 /* 1st responses from initialize and runtime uCode images.
540 * 4965's initialize alive response contains some calibration data. */
541 /* FIXME: 4965 uses bigger structure for init */
542 struct iwl_alive_resp card_alive_init;
543 struct iwl_alive_resp card_alive;
545 #ifdef CONFIG_IWL3945_RFKILL
546 struct rfkill *rfkill;
549 #ifdef CONFIG_IWL3945_LEDS
550 struct iwl3945_led led[IWL_LED_TRG_MAX];
551 unsigned long last_blink_time;
554 unsigned int rxtxpackets;
560 u16 active_rate_basic;
564 u8 call_post_assoc_from_beacon;
565 /* Rate scaling data */
569 wait_queue_head_t wait_command_queue;
571 int activity_timer_active;
573 /* Rx and Tx DMA processing queues */
574 struct iwl3945_rx_queue rxq;
575 struct iwl3945_tx_queue txq[IWL39_MAX_NUM_QUEUES];
577 unsigned long status;
579 int last_rx_rssi; /* From Rx packet statisitics */
580 int last_rx_noise; /* From beacon statistics */
582 struct iwl3945_power_mgr power_data;
584 struct iwl3945_notif_statistics statistics;
585 unsigned long last_statistics_time;
587 /* context information */
594 u8 mac_addr[ETH_ALEN];
596 /*station table variables */
599 struct iwl3945_station_entry stations[IWL_STATION_COUNT];
601 /* Indication if ieee80211_ops->open has been called */
604 u8 mac80211_registered;
606 /* Rx'd packet timing information */
607 u32 last_beacon_time;
611 struct iwl3945_eeprom eeprom;
613 enum nl80211_iftype iw_mode;
615 struct sk_buff *ibss_beacon;
617 /* Last Rx'd beacon timestamp */
620 struct iwl3945_driver_hw_info hw_setting;
621 struct ieee80211_vif *vif;
623 /* Current association information needed to configure the
626 u16 assoc_capability;
629 struct iwl_qos_info qos_data;
631 struct workqueue_struct *workqueue;
633 struct work_struct up;
634 struct work_struct restart;
635 struct work_struct calibrated_work;
636 struct work_struct scan_completed;
637 struct work_struct rx_replenish;
638 struct work_struct rf_kill;
639 struct work_struct abort_scan;
640 struct work_struct update_link_led;
641 struct work_struct auth_work;
642 struct work_struct report_work;
643 struct work_struct request_scan;
644 struct work_struct beacon_update;
646 struct tasklet_struct irq_tasklet;
648 struct delayed_work init_alive_start;
649 struct delayed_work alive_start;
650 struct delayed_work activity_timer;
651 struct delayed_work thermal_periodic;
652 struct delayed_work gather_stats;
653 struct delayed_work scan_check;
655 #define IWL_DEFAULT_TX_POWER 0x0F
656 s8 user_txpower_limit;
657 s8 max_channel_txpower_limit;
660 #ifdef CONFIG_IWL3945_DEBUG
664 atomic_t restrict_refcnt;
668 static inline int iwl3945_is_associated(struct iwl3945_priv *priv)
670 return (priv->active_rxon.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
673 extern const struct iwl_channel_info *iwl3945_get_channel_info(
674 const struct iwl3945_priv *priv, enum ieee80211_band band, u16 channel);
676 extern int iwl3945_rs_next_rate(struct iwl3945_priv *priv, int rate);
678 /* Requires full declaration of iwl3945_priv before including */
679 #include "iwl-3945-io.h"