]> err.no Git - linux-2.6/blobdiff - drivers/net/wireless/iwlwifi/iwl4965-base.c
iwlwifi: document 4965 Tx scheduler
[linux-2.6] / drivers / net / wireless / iwlwifi / iwl4965-base.c
index 24dc40f2f4c8c870eea0692769adf3459768e363..e15986c33d0be901db55f018124f6a8d9cb2d022 100644 (file)
  *
  *****************************************************************************/
 
-/*
- * NOTE:  This file (iwl-base.c) is used to build to multiple hardware targets
- * by defining IWL to either 3945 or 4965.  The Makefile used when building
- * the base targets will create base-3945.o and base-4965.o
- *
- * The eventual goal is to move as many of the #if IWL / #endif blocks out of
- * this file and into the hardware specific implementation files (iwl-XXXX.c)
- * and leave only the common (non #ifdef sprinkled) code in this file
- */
-
 #include <linux/kernel.h>
 #include <linux/module.h>
 #include <linux/version.h>
@@ -73,13 +63,13 @@ static int iwl4965_tx_queue_update_write_ptr(struct iwl4965_priv *priv,
  ******************************************************************************/
 
 /* module parameters */
-static int iwl4965_param_disable_hw_scan;
-static int iwl4965_param_debug;
-static int iwl4965_param_disable;      /* def: enable radio */
-static int iwl4965_param_antenna;      /* def: 0 = both antennas (use diversity) */
-int iwl4965_param_hwcrypto;     /* def: using software encryption */
-static int iwl4965_param_qos_enable = 1;
-int iwl4965_param_queues_num = IWL_MAX_NUM_QUEUES;
+static int iwl4965_param_disable_hw_scan; /* def: 0 = use 4965's h/w scan */
+static int iwl4965_param_debug;    /* def: 0 = minimal debug log messages */
+static int iwl4965_param_disable;  /* def: enable radio */
+static int iwl4965_param_antenna;  /* def: 0 = both antennas (use diversity) */
+int iwl4965_param_hwcrypto;        /* def: using software encryption */
+static int iwl4965_param_qos_enable = 1; /* def: 1 = use quality of service */
+int iwl4965_param_queues_num = IWL_MAX_NUM_QUEUES; /* def: 16 Tx queues */
 
 /*
  * module name, copyright, version, etc.
@@ -193,17 +183,26 @@ static void iwl4965_print_hex_dump(int level, void *p, u32 len)
  *
  * Theory of operation
  *
- * A queue is a circular buffers with 'Read' and 'Write' pointers.
- * 2 empty entries always kept in the buffer to protect from overflow.
+ * A Tx or Rx queue resides in host DRAM, and is comprised of a circular buffer
+ * of buffer descriptors, each of which points to one or more data buffers for
+ * the device to read from or fill.  Driver and device exchange status of each
+ * queue via "read" and "write" pointers.  Driver keeps minimum of 2 empty
+ * entries in each circular buffer, to protect against confusing empty and full
+ * queue states.
+ *
+ * The device reads or writes the data in the queues via the device's several
+ * DMA/FIFO channels.  Each queue is mapped to a single DMA channel.
  *
  * For Tx queue, there are low mark and high mark limits. If, after queuing
  * the packet for Tx, free space become < low mark, Tx queue stopped. When
  * reclaiming packets (on 'tx done IRQ), if free space become > high mark,
  * Tx queue resumed.
  *
- * The IWL operates with six queues, one receive queue in the device's
- * sram, one transmit queue for sending commands to the device firmware,
- * and four transmit queues for data.
+ * The 4965 operates with up to 17 queues:  One receive queue, one transmit
+ * queue (#4) for sending commands to the device firmware, and 15 other
+ * Tx queues that may be mapped to prioritized Tx DMA/FIFO channels.
+ *
+ * See more detailed info in iwl-4965-hw.h.
  ***************************************************/
 
 static int iwl4965_queue_space(const struct iwl4965_queue *q)
@@ -222,13 +221,21 @@ static int iwl4965_queue_space(const struct iwl4965_queue *q)
        return s;
 }
 
-/* XXX: n_bd must be power-of-two size */
+/**
+ * iwl4965_queue_inc_wrap - increment queue index, wrap back to beginning
+ * @index -- current index
+ * @n_bd -- total number of entries in queue (must be power of 2)
+ */
 static inline int iwl4965_queue_inc_wrap(int index, int n_bd)
 {
        return ++index & (n_bd - 1);
 }
 
-/* XXX: n_bd must be power-of-two size */
+/**
+ * iwl4965_queue_dec_wrap - decrement queue index, wrap back to end
+ * @index -- current index
+ * @n_bd -- total number of entries in queue (must be power of 2)
+ */
 static inline int iwl4965_queue_dec_wrap(int index, int n_bd)
 {
        return --index & (n_bd - 1);
@@ -243,12 +250,17 @@ static inline int x2_queue_used(const struct iwl4965_queue *q, int i)
 
 static inline u8 get_cmd_index(struct iwl4965_queue *q, u32 index, int is_huge)
 {
+       /* This is for scan command, the big buffer at end of command array */
        if (is_huge)
-               return q->n_window;
+               return q->n_window;     /* must be power of 2 */
 
+       /* Otherwise, use normal size buffers */
        return index & (q->n_window - 1);
 }
 
+/**
+ * iwl4965_queue_init - Initialize queue's high/low-water and read/write indexes
+ */
 static int iwl4965_queue_init(struct iwl4965_priv *priv, struct iwl4965_queue *q,
                          int count, int slots_num, u32 id)
 {
@@ -277,11 +289,16 @@ static int iwl4965_queue_init(struct iwl4965_priv *priv, struct iwl4965_queue *q
        return 0;
 }
 
+/**
+ * iwl4965_tx_queue_alloc - Alloc driver data and TFD CB for one Tx/cmd queue
+ */
 static int iwl4965_tx_queue_alloc(struct iwl4965_priv *priv,
                              struct iwl4965_tx_queue *txq, u32 id)
 {
        struct pci_dev *dev = priv->pci_dev;
 
+       /* Driver private data, only for Tx (not command) queues,
+        * not shared with device. */
        if (id != IWL_CMD_QUEUE_NUM) {
                txq->txb = kmalloc(sizeof(txq->txb[0]) *
                                   TFD_QUEUE_SIZE_MAX, GFP_KERNEL);
@@ -293,6 +310,8 @@ static int iwl4965_tx_queue_alloc(struct iwl4965_priv *priv,
        } else
                txq->txb = NULL;
 
+       /* Circular buffer of transmit frame descriptors (TFDs),
+        * shared with device */
        txq->bd = pci_alloc_consistent(dev,
                        sizeof(txq->bd[0]) * TFD_QUEUE_SIZE_MAX,
                        &txq->q.dma_addr);
@@ -315,6 +334,9 @@ static int iwl4965_tx_queue_alloc(struct iwl4965_priv *priv,
        return -ENOMEM;
 }
 
+/**
+ * iwl4965_tx_queue_init - Allocate and initialize one tx/cmd queue
+ */
 int iwl4965_tx_queue_init(struct iwl4965_priv *priv,
                      struct iwl4965_tx_queue *txq, int slots_num, u32 txq_id)
 {
@@ -322,9 +344,14 @@ int iwl4965_tx_queue_init(struct iwl4965_priv *priv,
        int len;
        int rc = 0;
 
-       /* allocate command space + one big command for scan since scan
-        * command is very huge the system will not have two scan at the
-        * same time */
+       /*
+        * Alloc buffer array for commands (Tx or other types of commands).
+        * For the command queue (#4), allocate command space + one big
+        * command for scan, since scan command is very huge; the system will
+        * not have two scans at the same time, so only one is needed.
+        * For data Tx queues (all other queues), no super-size command
+        * space is needed.
+        */
        len = sizeof(struct iwl4965_cmd) * slots_num;
        if (txq_id == IWL_CMD_QUEUE_NUM)
                len +=  IWL_MAX_SCAN_SIZE;
@@ -332,6 +359,7 @@ int iwl4965_tx_queue_init(struct iwl4965_priv *priv,
        if (!txq->cmd)
                return -ENOMEM;
 
+       /* Alloc driver data array and TFD circular buffer */
        rc = iwl4965_tx_queue_alloc(priv, txq, txq_id);
        if (rc) {
                pci_free_consistent(dev, len, txq->cmd, txq->dma_addr_cmd);
@@ -343,8 +371,11 @@ int iwl4965_tx_queue_init(struct iwl4965_priv *priv,
        /* TFD_QUEUE_SIZE_MAX must be power-of-two size, otherwise
         * iwl4965_queue_inc_wrap and iwl4965_queue_dec_wrap are broken. */
        BUILD_BUG_ON(TFD_QUEUE_SIZE_MAX & (TFD_QUEUE_SIZE_MAX - 1));
+
+       /* Initialize queue's high/low-water marks, and head/tail indexes */
        iwl4965_queue_init(priv, &txq->q, TFD_QUEUE_SIZE_MAX, slots_num, txq_id);
 
+       /* Tell device where to find queue */
        iwl4965_hw_tx_queue_init(priv, txq);
 
        return 0;
@@ -355,8 +386,8 @@ int iwl4965_tx_queue_init(struct iwl4965_priv *priv,
  * @txq: Transmit queue to deallocate.
  *
  * Empty queue by removing and destroying all BD's.
- * Free all buffers.  txq itself is not freed.
- *
+ * Free all buffers.
+ * 0-fill, but do not free "txq" descriptor structure.
  */
 void iwl4965_tx_queue_free(struct iwl4965_priv *priv, struct iwl4965_tx_queue *txq)
 {
@@ -376,36 +407,39 @@ void iwl4965_tx_queue_free(struct iwl4965_priv *priv, struct iwl4965_tx_queue *t
        if (q->id == IWL_CMD_QUEUE_NUM)
                len += IWL_MAX_SCAN_SIZE;
 
+       /* De-alloc array of command/tx buffers */
        pci_free_consistent(dev, len, txq->cmd, txq->dma_addr_cmd);
 
-       /* free buffers belonging to queue itself */
+       /* De-alloc circular buffer of TFDs */
        if (txq->q.n_bd)
                pci_free_consistent(dev, sizeof(struct iwl4965_tfd_frame) *
                                    txq->q.n_bd, txq->bd, txq->q.dma_addr);
 
+       /* De-alloc array of per-TFD driver data */
        if (txq->txb) {
                kfree(txq->txb);
                txq->txb = NULL;
        }
 
-       /* 0 fill whole structure */
+       /* 0-fill queue descriptor structure */
        memset(txq, 0, sizeof(*txq));
 }
 
 const u8 iwl4965_broadcast_addr[ETH_ALEN] = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
 
 /*************** STATION TABLE MANAGEMENT ****
- *
- * NOTE:  This needs to be overhauled to better synchronize between
- * how the iwl-4965.c is using iwl4965_hw_find_station vs. iwl-3945.c
- *
- * mac80211 should also be examined to determine if sta_info is duplicating
+ * mac80211 should be examined to determine if sta_info is duplicating
  * the functionality provided here
  */
 
 /**************************************************************/
 
 #if 0 /* temporary disable till we add real remove station */
+/**
+ * iwl4965_remove_station - Remove driver's knowledge of station.
+ *
+ * NOTE:  This does not remove station from device's station table.
+ */
 static u8 iwl4965_remove_station(struct iwl4965_priv *priv, const u8 *addr, int is_ap)
 {
        int index = IWL_INVALID_STATION;
@@ -443,6 +477,11 @@ out:
 }
 #endif
 
+/**
+ * iwl4965_clear_stations_table - Clear the driver's station table
+ *
+ * NOTE:  This does not clear or otherwise alter the device's station table.
+ */
 static void iwl4965_clear_stations_table(struct iwl4965_priv *priv)
 {
        unsigned long flags;
@@ -455,6 +494,9 @@ static void iwl4965_clear_stations_table(struct iwl4965_priv *priv)
        spin_unlock_irqrestore(&priv->sta_lock, flags);
 }
 
+/**
+ * iwl4965_add_station_flags - Add station to tables in driver and device
+ */
 u8 iwl4965_add_station_flags(struct iwl4965_priv *priv, const u8 *addr, int is_ap, u8 flags)
 {
        int i;
@@ -482,8 +524,8 @@ u8 iwl4965_add_station_flags(struct iwl4965_priv *priv, const u8 *addr, int is_a
                }
 
 
-       /* These two conditions has the same outcome but keep them separate
-         since they have different meaning */
+       /* These two conditions have the same outcome, but keep them separate
+         since they have different meanings */
        if (unlikely(index == IWL_INVALID_STATION)) {
                spin_unlock_irqrestore(&priv->sta_lock, flags_spin);
                return index;
@@ -501,6 +543,7 @@ u8 iwl4965_add_station_flags(struct iwl4965_priv *priv, const u8 *addr, int is_a
        station->used = 1;
        priv->num_stations++;
 
+       /* Set up the REPLY_ADD_STA command to send to device */
        memset(&station->sta, 0, sizeof(struct iwl4965_addsta_cmd));
        memcpy(station->sta.sta.addr, addr, ETH_ALEN);
        station->sta.mode = 0;
@@ -515,6 +558,8 @@ u8 iwl4965_add_station_flags(struct iwl4965_priv *priv, const u8 *addr, int is_a
 #endif /*CONFIG_IWL4965_HT*/
 
        spin_unlock_irqrestore(&priv->sta_lock, flags_spin);
+
+       /* Add station to device's station table */
        iwl4965_send_add_station(priv, &station->sta, flags);
        return index;
 
@@ -684,7 +729,11 @@ static int iwl4965_enqueue_hcmd(struct iwl4965_priv *priv, struct iwl4965_host_c
                     fix_size, q->write_ptr, idx, IWL_CMD_QUEUE_NUM);
 
        txq->need_update = 1;
+
+       /* Set up entry in queue's byte count circular buffer */
        ret = iwl4965_tx_queue_update_wr_ptr(priv, txq, 0);
+
+       /* Increment and update queue's write index */
        q->write_ptr = iwl4965_queue_inc_wrap(q->write_ptr, q->n_bd);
        iwl4965_tx_queue_update_write_ptr(priv, txq);
 
@@ -843,14 +892,17 @@ int iwl4965_send_statistics_request(struct iwl4965_priv *priv)
  * iwl4965_rxon_add_station - add station into station table.
  *
  * there is only one AP station with id= IWL_AP_ID
- * NOTE: mutex must be held before calling the this fnction
-*/
+ * NOTE: mutex must be held before calling this fnction
+ */
 static int iwl4965_rxon_add_station(struct iwl4965_priv *priv,
                                const u8 *addr, int is_ap)
 {
        u8 sta_id;
 
+       /* Add station to device's station table */
        sta_id = iwl4965_add_station_flags(priv, addr, is_ap, 0);
+
+       /* Set up default rate scaling table in device's station table */
        iwl4965_add_station(priv, addr, is_ap);
 
        return sta_id;
@@ -866,7 +918,8 @@ static int iwl4965_rxon_add_station(struct iwl4965_priv *priv,
  * NOTE:  Does not commit to the hardware; it sets appropriate bit fields
  * in the staging RXON flag structure based on the phymode
  */
-static int iwl4965_set_rxon_channel(struct iwl4965_priv *priv, u8 phymode, u16 channel)
+static int iwl4965_set_rxon_channel(struct iwl4965_priv *priv, u8 phymode,
+                                u16 channel)
 {
        if (!iwl4965_get_channel_info(priv, phymode, channel)) {
                IWL_DEBUG_INFO("Could not set channel to %d [%d]\n",
@@ -965,12 +1018,12 @@ static int iwl4965_check_rxon_cmd(struct iwl4965_rxon_cmd *rxon)
 }
 
 /**
- * iwl4965_full_rxon_required - determine if RXON_ASSOC can be used in RXON commit
+ * iwl4965_full_rxon_required - check if full RXON (vs RXON_ASSOC) cmd is needed
  * @priv: staging_rxon is compared to active_rxon
  *
- * If the RXON structure is changing sufficient to require a new
- * tune or to clear and reset the RXON_FILTER_ASSOC_MSK then return 1
- * to indicate a new tune is required.
+ * If the RXON structure is changing enough to require a new tune,
+ * or is clearing the RXON_FILTER_ASSOC_MSK, then return 1 to indicate that
+ * a new tune (full RXON command, rather than RXON_ASSOC cmd) is required.
  */
 static int iwl4965_full_rxon_required(struct iwl4965_priv *priv)
 {
@@ -1267,7 +1320,7 @@ static int iwl4965_card_state_sync_callback(struct iwl4965_priv *priv,
 /*
  * CARD_STATE_CMD
  *
- * Use: Sets the internal card state to enable, disable, or halt
+ * Use: Sets the device's internal card state to enable, disable, or halt
  *
  * When in the 'enable' state the card operates as normal.
  * When in the 'disable' state, the card enters into a low power mode.
@@ -1488,6 +1541,7 @@ int iwl4965_rate_index_from_plcp(int plcp)
 {
        int i = 0;
 
+       /* 4965 HT rate format */
        if (plcp & RATE_MCS_HT_MSK) {
                i = (plcp & 0xff);
 
@@ -1501,6 +1555,8 @@ int iwl4965_rate_index_from_plcp(int plcp)
                if ((i >= IWL_FIRST_OFDM_RATE) &&
                    (i <= IWL_LAST_OFDM_RATE))
                        return i;
+
+       /* 4965 legacy rate format, search for match in table */
        } else {
                for (i = 0; i < ARRAY_SIZE(iwl4965_rates); i++)
                        if (iwl4965_rates[i].plcp == (plcp &0xFF))
@@ -1572,7 +1628,7 @@ static void get_eeprom_mac(struct iwl4965_priv *priv, u8 *mac)
 /**
  * iwl4965_eeprom_init - read EEPROM contents
  *
- * Load the EEPROM from adapter into priv->eeprom
+ * Load the EEPROM contents from adapter into priv->eeprom
  *
  * NOTE:  This routine uses the non-debug IO access functions.
  */
@@ -1597,6 +1653,7 @@ int iwl4965_eeprom_init(struct iwl4965_priv *priv)
                return -ENOENT;
        }
 
+       /* Make sure driver (instead of uCode) is allowed to read EEPROM */
        rc = iwl4965_eeprom_acquire_semaphore(priv);
        if (rc < 0) {
                IWL_ERROR("Failed to acquire EEPROM semaphore.\n");
@@ -1640,14 +1697,12 @@ done:
 /**
  * iwl4965_report_frame - dump frame to syslog during debug sessions
  *
- * hack this function to show different aspects of received frames,
+ * You may hack this function to show different aspects of received frames,
  * including selective frame dumps.
  * group100 parameter selects whether to show 1 out of 100 good frames.
  *
- * TODO:  ieee80211_hdr stuff is common to 3945 and 4965, so frame type
- *        info output is okay, but some of this stuff (e.g. iwl4965_rx_frame_stats)
- *        is 3945-specific and gives bad output for 4965.  Need to split the
- *        functionality, keep common stuff here.
+ * TODO:  This was originally written for 3945, need to audit for
+ *        proper operation with 4965.
  */
 void iwl4965_report_frame(struct iwl4965_priv *priv,
                      struct iwl4965_rx_packet *pkt,
@@ -2218,7 +2273,7 @@ static int iwl4965_update_power_cmd(struct iwl4965_priv *priv,
 
 static int iwl4965_send_power_mode(struct iwl4965_priv *priv, u32 mode)
 {
-       u32 final_mode = mode;
+       u32 uninitialized_var(final_mode);
        int rc;
        struct iwl4965_powertable_cmd cmd;
 
@@ -2739,22 +2794,27 @@ static void iwl4965_build_tx_cmd_basic(struct iwl4965_priv *priv,
        cmd->cmd.tx.next_frame_len = 0;
 }
 
-static int iwl4965_get_sta_id(struct iwl4965_priv *priv, struct ieee80211_hdr *hdr)
+/**
+ * iwl4965_get_sta_id - Find station's index within station table
+ *
+ * If new IBSS station, create new entry in station table
+ */
+static int iwl4965_get_sta_id(struct iwl4965_priv *priv,
+                               struct ieee80211_hdr *hdr)
 {
        int sta_id;
        u16 fc = le16_to_cpu(hdr->frame_control);
        DECLARE_MAC_BUF(mac);
 
-       /* If this frame is broadcast or not data then use the broadcast
-        * station id */
+       /* If this frame is broadcast or management, use broadcast station id */
        if (((fc & IEEE80211_FCTL_FTYPE) != IEEE80211_FTYPE_DATA) ||
            is_multicast_ether_addr(hdr->addr1))
                return priv->hw_setting.bcast_sta_id;
 
        switch (priv->iw_mode) {
 
-       /* If this frame is part of a BSS network (we're a station), then
-        * we use the AP's station id */
+       /* If we are a client station in a BSS network, use the special
+        * AP station entry (that's the only station we communicate with) */
        case IEEE80211_IF_TYPE_STA:
                return IWL_AP_ID;
 
@@ -2765,13 +2825,14 @@ static int iwl4965_get_sta_id(struct iwl4965_priv *priv, struct ieee80211_hdr *h
                        return sta_id;
                return priv->hw_setting.bcast_sta_id;
 
-       /* If this frame is part of a IBSS network, then we use the
-        * target specific station id */
+       /* If this frame is going out to an IBSS network, find the station,
+        * or create a new station table entry */
        case IEEE80211_IF_TYPE_IBSS:
                sta_id = iwl4965_hw_find_station(priv, hdr->addr1);
                if (sta_id != IWL_INVALID_STATION)
                        return sta_id;
 
+               /* Create new station table entry */
                sta_id = iwl4965_add_station_flags(priv, hdr->addr1, 0, CMD_ASYNC);
 
                if (sta_id != IWL_INVALID_STATION)
@@ -2853,6 +2914,8 @@ static int iwl4965_tx_skb(struct iwl4965_priv *priv,
        spin_unlock_irqrestore(&priv->lock, flags);
 
        hdr_len = ieee80211_get_hdrlen(fc);
+
+       /* Find (or create) index into station table for destination station */
        sta_id = iwl4965_get_sta_id(priv, hdr);
        if (sta_id == IWL_INVALID_STATION) {
                DECLARE_MAC_BUF(mac);
@@ -2881,30 +2944,52 @@ static int iwl4965_tx_skb(struct iwl4965_priv *priv,
 #endif /* CONFIG_IWL4965_HT_AGG */
 #endif /* CONFIG_IWL4965_HT */
        }
+
+       /* Descriptor for chosen Tx queue */
        txq = &priv->txq[txq_id];
        q = &txq->q;
 
        spin_lock_irqsave(&priv->lock, flags);
 
+       /* Set up first empty TFD within this queue's circular TFD buffer */
        tfd = &txq->bd[q->write_ptr];
        memset(tfd, 0, sizeof(*tfd));
        control_flags = (u32 *) tfd;
        idx = get_cmd_index(q, q->write_ptr, 0);
 
+       /* Set up driver data for this TFD */
        memset(&(txq->txb[q->write_ptr]), 0, sizeof(struct iwl4965_tx_info));
        txq->txb[q->write_ptr].skb[0] = skb;
        memcpy(&(txq->txb[q->write_ptr].status.control),
               ctl, sizeof(struct ieee80211_tx_control));
+
+       /* Set up first empty entry in queue's array of Tx/cmd buffers */
        out_cmd = &txq->cmd[idx];
        memset(&out_cmd->hdr, 0, sizeof(out_cmd->hdr));
        memset(&out_cmd->cmd.tx, 0, sizeof(out_cmd->cmd.tx));
+
+       /*
+        * Set up the Tx-command (not MAC!) header.
+        * Store the chosen Tx queue and TFD index within the sequence field;
+        * after Tx, uCode's Tx response will return this value so driver can
+        * locate the frame within the tx queue and do post-tx processing.
+        */
        out_cmd->hdr.cmd = REPLY_TX;
        out_cmd->hdr.sequence = cpu_to_le16((u16)(QUEUE_TO_SEQ(txq_id) |
                                INDEX_TO_SEQ(q->write_ptr)));
-       /* copy frags header */
+
+       /* Copy MAC header from skb into command buffer */
        memcpy(out_cmd->cmd.tx.hdr, hdr, hdr_len);
 
-       /* hdr = (struct ieee80211_hdr *)out_cmd->cmd.tx.hdr; */
+       /*
+        * Use the first empty entry in this queue's command buffer array
+        * to contain the Tx command and MAC header concatenated together
+        * (payload data will be in another buffer).
+        * Size of this varies, due to varying MAC header length.
+        * If end is not dword aligned, we'll have 2 extra bytes at the end
+        * of the MAC header (device reads on dword boundaries).
+        * We'll tell device about this padding later.
+        */
        len = priv->hw_setting.tx_cmd_len +
                sizeof(struct iwl4965_cmd_header) + hdr_len;
 
@@ -2916,15 +3001,20 @@ static int iwl4965_tx_skb(struct iwl4965_priv *priv,
        else
                len_org = 0;
 
+       /* Physical address of this Tx command's header (not MAC header!),
+        * within command buffer array. */
        txcmd_phys = txq->dma_addr_cmd + sizeof(struct iwl4965_cmd) * idx +
                     offsetof(struct iwl4965_cmd, hdr);
 
+       /* Add buffer containing Tx command and MAC(!) header to TFD's
+        * first entry */
        iwl4965_hw_txq_attach_buf_to_tfd(priv, tfd, txcmd_phys, len);
 
        if (!(ctl->flags & IEEE80211_TXCTL_DO_NOT_ENCRYPT))
                iwl4965_build_tx_cmd_hwcrypto(priv, ctl, out_cmd, skb, 0);
 
-       /* 802.11 null functions have no payload... */
+       /* Set up TFD's 2nd entry to point directly to remainder of skb,
+        * if any (802.11 null frames have no payload). */
        len = skb->len - hdr_len;
        if (len) {
                phys_addr = pci_map_single(priv->pci_dev, skb->data + hdr_len,
@@ -2932,9 +3022,11 @@ static int iwl4965_tx_skb(struct iwl4965_priv *priv,
                iwl4965_hw_txq_attach_buf_to_tfd(priv, tfd, phys_addr, len);
        }
 
+       /* Tell 4965 about any 2-byte padding after MAC header */
        if (len_org)
                out_cmd->cmd.tx.tx_flags |= TX_CMD_FLG_MH_PAD_MSK;
 
+       /* Total # bytes to be transmitted */
        len = (u16)skb->len;
        out_cmd->cmd.tx.len = cpu_to_le16(len);
 
@@ -2964,8 +3056,10 @@ static int iwl4965_tx_skb(struct iwl4965_priv *priv,
        iwl4965_print_hex_dump(IWL_DL_TX, (u8 *)out_cmd->cmd.tx.hdr,
                           ieee80211_get_hdrlen(fc));
 
+       /* Set up entry for this TFD in Tx byte-count array */
        iwl4965_tx_queue_update_wr_ptr(priv, txq, len);
 
+       /* Tell device the write index *just past* this latest filled TFD */
        q->write_ptr = iwl4965_queue_inc_wrap(q->write_ptr, q->n_bd);
        rc = iwl4965_tx_queue_update_write_ptr(priv, txq);
        spin_unlock_irqrestore(&priv->lock, flags);
@@ -3442,11 +3536,11 @@ static void iwl4965_txstatus_to_ieee(struct iwl4965_priv *priv,
 }
 
 /**
- * iwl4965_tx_queue_reclaim - Reclaim Tx queue entries no more used by NIC.
+ * iwl4965_tx_queue_reclaim - Reclaim Tx queue entries already Tx'd
  *
- * When FW advances 'R' index, all entries between old and
- * new 'R' index need to be reclaimed. As result, some free space
- * forms. If there is enough free space (> low mark), wake Tx queue.
+ * When FW advances 'R' index, all entries between old and new 'R' index
+ * need to be reclaimed. As result, some free space forms.  If there is
+ * enough free space (> low mark), wake the stack that feeds us.
  */
 int iwl4965_tx_queue_reclaim(struct iwl4965_priv *priv, int txq_id, int index)
 {
@@ -3527,6 +3621,10 @@ static inline u32 iwl4965_get_scd_ssn(struct iwl4965_tx_resp *tx_resp)
        return le32_to_cpu(*scd_ssn) & MAX_SN;
 
 }
+
+/**
+ * iwl4965_tx_status_reply_tx - Handle Tx rspnse for frames in aggregation queue
+ */
 static int iwl4965_tx_status_reply_tx(struct iwl4965_priv *priv,
                                      struct iwl4965_ht_agg *agg,
                                      struct iwl4965_tx_resp *tx_resp,
@@ -3541,14 +3639,16 @@ static int iwl4965_tx_status_reply_tx(struct iwl4965_priv *priv,
        u16 seq;
 
        if (agg->wait_for_ba)
-               IWL_DEBUG_TX_REPLY("got tx repsons w/o back\n");
+               IWL_DEBUG_TX_REPLY("got tx response w/o block-ack\n");
 
        agg->frame_count = tx_resp->frame_count;
        agg->start_idx = start_idx;
        agg->rate_n_flags = le32_to_cpu(tx_resp->rate_n_flags);
        agg->bitmap0 = agg->bitmap1 = 0;
 
+       /* # frames attempted by Tx command */
        if (agg->frame_count == 1) {
+               /* Only one frame was attempted; no block-ack will arrive */
                struct iwl4965_tx_queue *txq ;
                status = le32_to_cpu(frame_status[0]);
 
@@ -3577,9 +3677,11 @@ static int iwl4965_tx_status_reply_tx(struct iwl4965_priv *priv,
 
                agg->wait_for_ba = 0;
        } else {
+               /* Two or more frames were attempted; expect block-ack */
                u64 bitmap = 0;
                int start = agg->start_idx;
 
+               /* Construct bit-map of pending frames within Tx window */
                for (i = 0; i < agg->frame_count; i++) {
                        u16 sc;
                        status = le32_to_cpu(frame_status[i]);
@@ -3643,6 +3745,9 @@ static int iwl4965_tx_status_reply_tx(struct iwl4965_priv *priv,
 #endif
 #endif
 
+/**
+ * iwl4965_rx_reply_tx - Handle standard (non-aggregation) Tx response
+ */
 static void iwl4965_rx_reply_tx(struct iwl4965_priv *priv,
                            struct iwl4965_rx_mem_buffer *rxb)
 {
@@ -4101,13 +4206,10 @@ static void iwl4965_setup_rx_handlers(struct iwl4965_priv *priv)
            iwl4965_rx_pm_debug_statistics_notif;
        priv->rx_handlers[BEACON_NOTIFICATION] = iwl4965_rx_beacon_notif;
 
-       /* NOTE:  iwl4965_rx_statistics is different based on whether
-        * the build is for the 3945 or the 4965.  See the
-        * corresponding implementation in iwl-XXXX.c
-        *
-        * The same handler is used for both the REPLY to a
-        * discrete statistics request from the host as well as
-        * for the periodic statistics notification from the uCode
+       /*
+        * The same handler is used for both the REPLY to a discrete
+        * statistics request from the host as well as for the periodic
+        * statistics notifications (after received beacons) from the uCode.
         */
        priv->rx_handlers[REPLY_STATISTICS_CMD] = iwl4965_hw_rx_statistics;
        priv->rx_handlers[STATISTICS_NOTIFICATION] = iwl4965_hw_rx_statistics;
@@ -4121,7 +4223,7 @@ static void iwl4965_setup_rx_handlers(struct iwl4965_priv *priv)
        priv->rx_handlers[CARD_STATE_NOTIFICATION] = iwl4965_rx_card_state_notif;
        priv->rx_handlers[REPLY_TX] = iwl4965_rx_reply_tx;
 
-       /* Setup hardware specific Rx handlers */
+       /* Set up hardware specific Rx handlers */
        iwl4965_hw_rx_handler_setup(priv);
 }
 
@@ -4175,9 +4277,11 @@ static void iwl4965_tx_cmd_complete(struct iwl4965_priv *priv,
 /*
  * Rx theory of operation
  *
- * The host allocates 32 DMA target addresses and passes the host address
- * to the firmware at register IWL_RFDS_TABLE_LOWER + N * RFD_SIZE where N is
- * 0 to 31
+ * Driver allocates a circular buffer of Receive Buffer Descriptors (RBDs),
+ * each of which point to Receive Buffers to be filled by 4965.  These get
+ * used not only for Rx frames, but for any command response or notification
+ * from the 4965.  The driver and 4965 manage the Rx buffers by means
+ * of indexes into the circular buffer.
  *
  * Rx Queue Indexes
  * The host/firmware share two index registers for managing the Rx buffers.
@@ -4193,10 +4297,10 @@ static void iwl4965_tx_cmd_complete(struct iwl4965_priv *priv,
  * The queue is empty (no good data) if WRITE = READ - 1, and is full if
  * WRITE = READ.
  *
- * During initialization the host sets up the READ queue position to the first
+ * During initialization, the host sets up the READ queue position to the first
  * INDEX position, and WRITE to the last (READ - 1 wrapped)
  *
- * When the firmware places a packet in a buffer it will advance the READ index
+ * When the firmware places a packet in a buffer, it will advance the READ index
  * and fire the RX interrupt.  The driver can then query the READ index and
  * process as many packets as possible, moving the WRITE index forward as it
  * resets the Rx queue buffers with new memory.
@@ -4218,16 +4322,16 @@ static void iwl4965_tx_cmd_complete(struct iwl4965_priv *priv,
  *
  * Driver sequence:
  *
- * iwl4965_rx_queue_alloc()       Allocates rx_free
- * iwl4965_rx_replenish()         Replenishes rx_free list from rx_used, and calls
+ * iwl4965_rx_queue_alloc()   Allocates rx_free
+ * iwl4965_rx_replenish()     Replenishes rx_free list from rx_used, and calls
  *                            iwl4965_rx_queue_restock
- * iwl4965_rx_queue_restock()     Moves available buffers from rx_free into Rx
+ * iwl4965_rx_queue_restock() Moves available buffers from rx_free into Rx
  *                            queue, updates firmware pointers, and updates
  *                            the WRITE index.  If insufficient rx_free buffers
  *                            are available, schedules iwl4965_rx_replenish
  *
  * -- enable interrupts --
- * ISR - iwl4965_rx()             Detach iwl4965_rx_mem_buffers from pool up to the
+ * ISR - iwl4965_rx()         Detach iwl4965_rx_mem_buffers from pool up to the
  *                            READ INDEX, detaching the SKB from the pool.
  *                            Moves the packet buffer from queue to rx_used.
  *                            Calls iwl4965_rx_queue_restock to refill any empty
@@ -4253,12 +4357,6 @@ static int iwl4965_rx_queue_space(const struct iwl4965_rx_queue *q)
 
 /**
  * iwl4965_rx_queue_update_write_ptr - Update the write pointer for the RX queue
- *
- * NOTE: This function has 3945 and 4965 specific code sections
- * but is declared in base due to the majority of the
- * implementation being the same (only a numeric constant is
- * different)
- *
  */
 int iwl4965_rx_queue_update_write_ptr(struct iwl4965_priv *priv, struct iwl4965_rx_queue *q)
 {
@@ -4271,6 +4369,7 @@ int iwl4965_rx_queue_update_write_ptr(struct iwl4965_priv *priv, struct iwl4965_
        if (q->need_update == 0)
                goto exit_unlock;
 
+       /* If power-saving is in use, make sure device is awake */
        if (test_bit(STATUS_POWER_PMI, &priv->status)) {
                reg = iwl4965_read32(priv, CSR_UCODE_DRV_GP1);
 
@@ -4284,10 +4383,14 @@ int iwl4965_rx_queue_update_write_ptr(struct iwl4965_priv *priv, struct iwl4965_
                if (rc)
                        goto exit_unlock;
 
+               /* Device expects a multiple of 8 */
                iwl4965_write_direct32(priv, FH_RSCSR_CHNL0_WPTR,
                                     q->write & ~0x7);
                iwl4965_release_nic_access(priv);
+
+       /* Else device is assumed to be awake */
        } else
+               /* Device expects a multiple of 8 */
                iwl4965_write32(priv, FH_RSCSR_CHNL0_WPTR, q->write & ~0x7);
 
 
@@ -4299,9 +4402,7 @@ int iwl4965_rx_queue_update_write_ptr(struct iwl4965_priv *priv, struct iwl4965_
 }
 
 /**
- * iwl4965_dma_addr2rbd_ptr - convert a DMA address to a uCode read buffer pointer.
- *
- * NOTE: This function has 3945 and 4965 specific code paths in it.
+ * iwl4965_dma_addr2rbd_ptr - convert a DMA address to a uCode read buffer ptr
  */
 static inline __le32 iwl4965_dma_addr2rbd_ptr(struct iwl4965_priv *priv,
                                          dma_addr_t dma_addr)
@@ -4313,9 +4414,9 @@ static inline __le32 iwl4965_dma_addr2rbd_ptr(struct iwl4965_priv *priv,
 /**
  * iwl4965_rx_queue_restock - refill RX queue from pre-allocated pool
  *
- * If there are slots in the RX queue that  need to be restocked,
+ * If there are slots in the RX queue that need to be restocked,
  * and we have free pre-allocated buffers, fill the ranks as much
- * as we can pulling from rx_free.
+ * as we can, pulling from rx_free.
  *
  * This moves the 'write' index forward to catch up with 'processed', and
  * also updates the memory address in the firmware to reference the new
@@ -4332,9 +4433,12 @@ static int iwl4965_rx_queue_restock(struct iwl4965_priv *priv)
        spin_lock_irqsave(&rxq->lock, flags);
        write = rxq->write & ~0x7;
        while ((iwl4965_rx_queue_space(rxq) > 0) && (rxq->free_count)) {
+               /* Get next free Rx buffer, remove from free list */
                element = rxq->rx_free.next;
                rxb = list_entry(element, struct iwl4965_rx_mem_buffer, list);
                list_del(element);
+
+               /* Point to Rx buffer via next RBD in circular buffer */
                rxq->bd[rxq->write] = iwl4965_dma_addr2rbd_ptr(priv, rxb->dma_addr);
                rxq->queue[rxq->write] = rxb;
                rxq->write = (rxq->write + 1) & RX_QUEUE_MASK;
@@ -4347,7 +4451,8 @@ static int iwl4965_rx_queue_restock(struct iwl4965_priv *priv)
                queue_work(priv->workqueue, &priv->rx_replenish);
 
 
-       /* If we've added more space for the firmware to place data, tell it */
+       /* If we've added more space for the firmware to place data, tell it.
+        * Increment device's write pointer in multiples of 8. */
        if ((write != (rxq->write & ~0x7))
            || (abs(rxq->write - rxq->read) > 7)) {
                spin_lock_irqsave(&rxq->lock, flags);
@@ -4380,6 +4485,8 @@ void iwl4965_rx_replenish(void *data)
        while (!list_empty(&rxq->rx_used)) {
                element = rxq->rx_used.next;
                rxb = list_entry(element, struct iwl4965_rx_mem_buffer, list);
+
+               /* Alloc a new receive buffer */
                rxb->skb =
                    alloc_skb(IWL_RX_BUF_SIZE, __GFP_NOWARN | GFP_ATOMIC);
                if (!rxb->skb) {
@@ -4393,6 +4500,8 @@ void iwl4965_rx_replenish(void *data)
                }
                priv->alloc_rxb_skb++;
                list_del(element);
+
+               /* Get physical address of RB/SKB */
                rxb->dma_addr =
                    pci_map_single(priv->pci_dev, rxb->skb->data,
                                   IWL_RX_BUF_SIZE, PCI_DMA_FROMDEVICE);
@@ -4407,7 +4516,7 @@ void iwl4965_rx_replenish(void *data)
 }
 
 /* Assumes that the skb field of the buffers in 'pool' is kept accurate.
- * If an SKB has been detached, the POOL needs to have it's SKB set to NULL
+ * If an SKB has been detached, the POOL needs to have its SKB set to NULL
  * This free routine walks the list of POOL entries and if SKB is set to
  * non NULL it is unmapped and freed
  */
@@ -4437,12 +4546,16 @@ int iwl4965_rx_queue_alloc(struct iwl4965_priv *priv)
        spin_lock_init(&rxq->lock);
        INIT_LIST_HEAD(&rxq->rx_free);
        INIT_LIST_HEAD(&rxq->rx_used);
+
+       /* Alloc the circular buffer of Read Buffer Descriptors (RBDs) */
        rxq->bd = pci_alloc_consistent(dev, 4 * RX_QUEUE_SIZE, &rxq->dma_addr);
        if (!rxq->bd)
                return -ENOMEM;
+
        /* Fill the rx_used queue with _all_ of the Rx buffers */
        for (i = 0; i < RX_FREE_BUFFERS + RX_QUEUE_SIZE; i++)
                list_add_tail(&rxq->pool[i].list, &rxq->rx_used);
+
        /* Set us so that we have processed and used all buffers, but have
         * not restocked the Rx queue with fresh buffers */
        rxq->read = rxq->write = 0;
@@ -4559,7 +4672,7 @@ int iwl4965_calc_sig_qual(int rssi_dbm, int noise_dbm)
 }
 
 /**
- * iwl4965_rx_handle - Main entry function for receiving responses from the uCode
+ * iwl4965_rx_handle - Main entry function for receiving responses from uCode
  *
  * Uses the priv->rx_handlers callback function array to invoke
  * the appropriate handlers, including command responses,
@@ -4574,6 +4687,8 @@ static void iwl4965_rx_handle(struct iwl4965_priv *priv)
        int reclaim;
        unsigned long flags;
 
+       /* uCode's read index (stored in shared DRAM) indicates the last Rx
+        * buffer that the driver may process (last buffer filled by ucode). */
        r = iwl4965_hw_get_rx_read(priv);
        i = rxq->read;
 
@@ -4584,7 +4699,7 @@ static void iwl4965_rx_handle(struct iwl4965_priv *priv)
        while (i != r) {
                rxb = rxq->queue[i];
 
-               /* If an RXB doesn't have a queue slot associated with it
+               /* If an RXB doesn't have a Rx queue slot associated with it,
                 * then a bug has been introduced in the queue refilling
                 * routines -- catch it here */
                BUG_ON(rxb == NULL);
@@ -4626,8 +4741,8 @@ static void iwl4965_rx_handle(struct iwl4965_priv *priv)
                }
 
                if (reclaim) {
-                       /* Invoke any callbacks, transfer the skb to caller,
-                        * and fire off the (possibly) blocking iwl4965_send_cmd()
+                       /* Invoke any callbacks, transfer the skb to caller, and
+                        * fire off the (possibly) blocking iwl4965_send_cmd()
                         * as we reclaim the driver command queue */
                        if (rxb && rxb->skb)
                                iwl4965_tx_cmd_complete(priv, rxb);
@@ -4657,6 +4772,9 @@ static void iwl4965_rx_handle(struct iwl4965_priv *priv)
        iwl4965_rx_queue_restock(priv);
 }
 
+/**
+ * iwl4965_tx_queue_update_write_ptr - Send new write index to hardware
+ */
 static int iwl4965_tx_queue_update_write_ptr(struct iwl4965_priv *priv,
                                  struct iwl4965_tx_queue *txq)
 {
@@ -4993,7 +5111,8 @@ static void iwl4965_irq_tasklet(struct iwl4965_priv *priv)
 
 #ifdef CONFIG_IWL4965_DEBUG
        if (iwl4965_debug_level & IWL_DL_ISR) {
-               inta_mask = iwl4965_read32(priv, CSR_INT_MASK); /* just for debug */
+               /* just for debug */
+               inta_mask = iwl4965_read32(priv, CSR_INT_MASK);
                IWL_DEBUG_ISR("inta 0x%08x, enabled 0x%08x, fh 0x%08x\n",
                              inta, inta_mask, inta_fh);
        }
@@ -5038,7 +5157,7 @@ static void iwl4965_irq_tasklet(struct iwl4965_priv *priv)
        /* Safely ignore these bits for debug checks below */
        inta &= ~(CSR_INT_BIT_MAC_CLK_ACTV | CSR_INT_BIT_ALIVE);
 
-       /* HW RF KILL switch toggled (4965 only) */
+       /* HW RF KILL switch toggled */
        if (inta & CSR_INT_BIT_RF_KILL) {
                int hw_rf_kill = 0;
                if (!(iwl4965_read32(priv, CSR_GP_CNTRL) &
@@ -5061,7 +5180,7 @@ static void iwl4965_irq_tasklet(struct iwl4965_priv *priv)
                handled |= CSR_INT_BIT_RF_KILL;
        }
 
-       /* Chip got too hot and stopped itself (4965 only) */
+       /* Chip got too hot and stopped itself */
        if (inta & CSR_INT_BIT_CT_KILL) {
                IWL_ERROR("Microcode CT kill error detected.\n");
                handled |= CSR_INT_BIT_CT_KILL;
@@ -5216,11 +5335,11 @@ static const u8 iwl4965_eeprom_band_1[14] = {
 };
 
 /* 5.2 GHz bands */
-static const u8 iwl4965_eeprom_band_2[] = {
+static const u8 iwl4965_eeprom_band_2[] = {    /* 4915-5080MHz */
        183, 184, 185, 187, 188, 189, 192, 196, 7, 8, 11, 12, 16
 };
 
-static const u8 iwl4965_eeprom_band_3[] = {    /* 5205-5320MHz */
+static const u8 iwl4965_eeprom_band_3[] = {    /* 5170-5320MHz */
        34, 36, 38, 40, 42, 44, 46, 48, 52, 56, 60, 64
 };
 
@@ -5240,7 +5359,8 @@ static u8 iwl4965_eeprom_band_7[] = {       /* 5.2 FAT channel */
        36, 44, 52, 60, 100, 108, 116, 124, 132, 149, 157
 };
 
-static void iwl4965_init_band_reference(const struct iwl4965_priv *priv, int band,
+static void iwl4965_init_band_reference(const struct iwl4965_priv *priv,
+                                   int band,
                                    int *eeprom_ch_count,
                                    const struct iwl4965_eeprom_channel
                                    **eeprom_ch_info,
@@ -5252,7 +5372,7 @@ static void iwl4965_init_band_reference(const struct iwl4965_priv *priv, int ban
                *eeprom_ch_info = priv->eeprom.band_1_channels;
                *eeprom_ch_index = iwl4965_eeprom_band_1;
                break;
-       case 2:         /* 5.2GHz band */
+       case 2:         /* 4.9GHz band */
                *eeprom_ch_count = ARRAY_SIZE(iwl4965_eeprom_band_2);
                *eeprom_ch_info = priv->eeprom.band_2_channels;
                *eeprom_ch_index = iwl4965_eeprom_band_2;
@@ -5262,22 +5382,22 @@ static void iwl4965_init_band_reference(const struct iwl4965_priv *priv, int ban
                *eeprom_ch_info = priv->eeprom.band_3_channels;
                *eeprom_ch_index = iwl4965_eeprom_band_3;
                break;
-       case 4:         /* 5.2GHz band */
+       case 4:         /* 5.5GHz band */
                *eeprom_ch_count = ARRAY_SIZE(iwl4965_eeprom_band_4);
                *eeprom_ch_info = priv->eeprom.band_4_channels;
                *eeprom_ch_index = iwl4965_eeprom_band_4;
                break;
-       case 5:         /* 5.2GHz band */
+       case 5:         /* 5.7GHz band */
                *eeprom_ch_count = ARRAY_SIZE(iwl4965_eeprom_band_5);
                *eeprom_ch_info = priv->eeprom.band_5_channels;
                *eeprom_ch_index = iwl4965_eeprom_band_5;
                break;
-       case 6:
+       case 6:         /* 2.4GHz FAT channels */
                *eeprom_ch_count = ARRAY_SIZE(iwl4965_eeprom_band_6);
                *eeprom_ch_info = priv->eeprom.band_24_channels;
                *eeprom_ch_index = iwl4965_eeprom_band_6;
                break;
-       case 7:
+       case 7:         /* 5 GHz FAT channels */
                *eeprom_ch_count = ARRAY_SIZE(iwl4965_eeprom_band_7);
                *eeprom_ch_info = priv->eeprom.band_52_channels;
                *eeprom_ch_index = iwl4965_eeprom_band_7;
@@ -5288,6 +5408,11 @@ static void iwl4965_init_band_reference(const struct iwl4965_priv *priv, int ban
        }
 }
 
+/**
+ * iwl4965_get_channel_info - Find driver's private channel info
+ *
+ * Based on band and channel number.
+ */
 const struct iwl4965_channel_info *iwl4965_get_channel_info(const struct iwl4965_priv *priv,
                                                    int phymode, u16 channel)
 {
@@ -5315,6 +5440,9 @@ const struct iwl4965_channel_info *iwl4965_get_channel_info(const struct iwl4965
 #define CHECK_AND_PRINT(x) ((eeprom_ch_info[ch].flags & EEPROM_CHANNEL_##x) \
                            ? # x " " : "")
 
+/**
+ * iwl4965_init_channel_map - Set up driver's info for all possible channels
+ */
 static int iwl4965_init_channel_map(struct iwl4965_priv *priv)
 {
        int eeprom_ch_count = 0;
@@ -5424,6 +5552,7 @@ static int iwl4965_init_channel_map(struct iwl4965_priv *priv)
                }
        }
 
+       /* Two additional EEPROM bands for 2.4 and 5 GHz FAT channels */
        for (band = 6; band <= 7; band++) {
                int phymode;
                u8 fat_extension_chan;
@@ -5431,7 +5560,9 @@ static int iwl4965_init_channel_map(struct iwl4965_priv *priv)
                iwl4965_init_band_reference(priv, band, &eeprom_ch_count,
                                        &eeprom_ch_info, &eeprom_ch_index);
 
+               /* EEPROM band 6 is 2.4, band 7 is 5 GHz */
                phymode = (band == 6) ? MODE_IEEE80211B : MODE_IEEE80211A;
+
                /* Loop through each band adding each of the channels */
                for (ch = 0; ch < eeprom_ch_count; ch++) {
 
@@ -5443,11 +5574,13 @@ static int iwl4965_init_channel_map(struct iwl4965_priv *priv)
                        else
                                fat_extension_chan = HT_IE_EXT_CHANNEL_ABOVE;
 
+                       /* Set up driver's info for lower half */
                        iwl4965_set_fat_chan_info(priv, phymode,
                                                  eeprom_ch_index[ch],
                                                  &(eeprom_ch_info[ch]),
                                                  fat_extension_chan);
 
+                       /* Set up driver's info for upper half */
                        iwl4965_set_fat_chan_info(priv, phymode,
                                                  (eeprom_ch_index[ch] + 4),
                                                  &(eeprom_ch_info[ch]),
@@ -5546,7 +5679,8 @@ static int iwl4965_get_channels_for_scan(struct iwl4965_priv *priv, int phymode,
 
                scan_ch->channel = channels[i].chan;
 
-               ch_info = iwl4965_get_channel_info(priv, phymode, scan_ch->channel);
+               ch_info = iwl4965_get_channel_info(priv, phymode,
+                                        scan_ch->channel);
                if (!is_channel_valid(ch_info)) {
                        IWL_DEBUG_SCAN("Channel %d is INVALID for this SKU.\n",
                                       scan_ch->channel);
@@ -5568,7 +5702,7 @@ static int iwl4965_get_channels_for_scan(struct iwl4965_priv *priv, int phymode,
                scan_ch->active_dwell = cpu_to_le16(active_dwell);
                scan_ch->passive_dwell = cpu_to_le16(passive_dwell);
 
-               /* Set power levels to defaults */
+               /* Set txpower levels to defaults */
                scan_ch->tpc.dsp_atten = 110;
                /* scan_pwr_info->tpc.dsp_atten; */
 
@@ -5578,8 +5712,8 @@ static int iwl4965_get_channels_for_scan(struct iwl4965_priv *priv, int phymode,
                else {
                        scan_ch->tpc.tx_gain = ((1 << 5) | (5 << 3));
                        /* NOTE: if we were doing 6Mb OFDM for scans we'd use
-                        * power level
-                        scan_ch->tpc.tx_gain = ((1<<5) | (2 << 3)) | 3;
+                        * power level:
+                        scan_ch->tpc.tx_gain = ((1<<5) | (2 << 3)) | 3;
                         */
                }
 
@@ -5856,7 +5990,8 @@ static void iwl4965_dealloc_ucode_pci(struct iwl4965_priv *priv)
  * iwl4965_verify_inst_full - verify runtime uCode image in card vs. host,
  *     looking at all data.
  */
-static int iwl4965_verify_inst_full(struct iwl4965_priv *priv, __le32 * image, u32 len)
+static int iwl4965_verify_inst_full(struct iwl4965_priv *priv, __le32 * image,
+                                u32 len)
 {
        u32 val;
        u32 save_len = len;
@@ -5981,8 +6116,9 @@ static int iwl4965_verify_ucode(struct iwl4965_priv *priv)
 
        IWL_ERROR("NO VALID UCODE IMAGE IN INSTRUCTION SRAM!!\n");
 
-       /* Show first several data entries in instruction SRAM.
-        * Selection of bootstrap image is arbitrary. */
+       /* Since nothing seems to match, show first several data entries in
+        * instruction SRAM, so maybe visual inspection will give a clue.
+        * Selection of bootstrap image (vs. other images) is arbitrary. */
        image = (__le32 *)priv->ucode_boot.v_addr;
        len = priv->ucode_boot.len;
        rc = iwl4965_verify_inst_full(priv, image, len);
@@ -6074,7 +6210,7 @@ static int iwl4965_load_bsm(struct iwl4965_priv *priv)
                return -EINVAL;
 
        /* Tell bootstrap uCode where to find the "Initialize" uCode
-        *   in host DRAM ... bits 31:0 for 3945, bits 35:4 for 4965.
+        *   in host DRAM ... host DRAM physical address bits 35:4 for 4965.
         * NOTE:  iwl4965_initialize_alive_start() will replace these values,
         *        after the "initialize" uCode has run, to point to
         *        runtime/protocol instructions and backup data cache. */
@@ -6146,6 +6282,12 @@ static void iwl4965_nic_start(struct iwl4965_priv *priv)
        iwl4965_write32(priv, CSR_RESET, 0);
 }
 
+static int iwl4965_alloc_fw_desc(struct pci_dev *pci_dev, struct fw_desc *desc)
+{
+       desc->v_addr = pci_alloc_consistent(pci_dev, desc->len, &desc->p_addr);
+       return (desc->v_addr != NULL) ? 0 : -ENOMEM;
+}
+
 /**
  * iwl4965_read_ucode - Read uCode images from disk file.
  *
@@ -6154,7 +6296,7 @@ static void iwl4965_nic_start(struct iwl4965_priv *priv)
 static int iwl4965_read_ucode(struct iwl4965_priv *priv)
 {
        struct iwl4965_ucode *ucode;
-       int rc = 0;
+       int ret;
        const struct firmware *ucode_raw;
        const char *name = "iwlwifi-4965" IWL4965_UCODE_API ".ucode";
        u8 *src;
@@ -6163,9 +6305,10 @@ static int iwl4965_read_ucode(struct iwl4965_priv *priv)
 
        /* Ask kernel firmware_class module to get the boot firmware off disk.
         * request_firmware() is synchronous, file is in memory on return. */
-       rc = request_firmware(&ucode_raw, name, &priv->pci_dev->dev);
-       if (rc < 0) {
-               IWL_ERROR("%s firmware file req failed: Reason %d\n", name, rc);
+       ret = request_firmware(&ucode_raw, name, &priv->pci_dev->dev);
+       if (ret < 0) {
+               IWL_ERROR("%s firmware file req failed: Reason %d\n",
+                                       name, ret);
                goto error;
        }
 
@@ -6175,7 +6318,7 @@ static int iwl4965_read_ucode(struct iwl4965_priv *priv)
        /* Make sure that we got at least our header! */
        if (ucode_raw->size < sizeof(*ucode)) {
                IWL_ERROR("File size way too small!\n");
-               rc = -EINVAL;
+               ret = -EINVAL;
                goto err_release;
        }
 
@@ -6208,43 +6351,43 @@ static int iwl4965_read_ucode(struct iwl4965_priv *priv)
 
                IWL_DEBUG_INFO("uCode file size %d too small\n",
                               (int)ucode_raw->size);
-               rc = -EINVAL;
+               ret = -EINVAL;
                goto err_release;
        }
 
        /* Verify that uCode images will fit in card's SRAM */
        if (inst_size > IWL_MAX_INST_SIZE) {
-               IWL_DEBUG_INFO("uCode instr len %d too large to fit in card\n",
-                              (int)inst_size);
-               rc = -EINVAL;
+               IWL_DEBUG_INFO("uCode instr len %d too large to fit in\n",
+                              inst_size);
+               ret = -EINVAL;
                goto err_release;
        }
 
        if (data_size > IWL_MAX_DATA_SIZE) {
-               IWL_DEBUG_INFO("uCode data len %d too large to fit in card\n",
-                              (int)data_size);
-               rc = -EINVAL;
+               IWL_DEBUG_INFO("uCode data len %d too large to fit in\n",
+                               data_size);
+               ret = -EINVAL;
                goto err_release;
        }
        if (init_size > IWL_MAX_INST_SIZE) {
                IWL_DEBUG_INFO
-                   ("uCode init instr len %d too large to fit in card\n",
-                    (int)init_size);
-               rc = -EINVAL;
+                   ("uCode init instr len %d too large to fit in\n",
+                     init_size);
+               ret = -EINVAL;
                goto err_release;
        }
        if (init_data_size > IWL_MAX_DATA_SIZE) {
                IWL_DEBUG_INFO
-                   ("uCode init data len %d too large to fit in card\n",
-                    (int)init_data_size);
-               rc = -EINVAL;
+                   ("uCode init data len %d too large to fit in\n",
+                     init_data_size);
+               ret = -EINVAL;
                goto err_release;
        }
        if (boot_size > IWL_MAX_BSM_SIZE) {
                IWL_DEBUG_INFO
-                   ("uCode boot instr len %d too large to fit in bsm\n",
-                    (int)boot_size);
-               rc = -EINVAL;
+                   ("uCode boot instr len %d too large to fit in\n",
+                     boot_size);
+               ret = -EINVAL;
                goto err_release;
        }
 
@@ -6254,56 +6397,41 @@ static int iwl4965_read_ucode(struct iwl4965_priv *priv)
         * 1) unmodified from disk
         * 2) backup cache for save/restore during power-downs */
        priv->ucode_code.len = inst_size;
-       priv->ucode_code.v_addr =
-           pci_alloc_consistent(priv->pci_dev,
-                                priv->ucode_code.len,
-                                &(priv->ucode_code.p_addr));
+       iwl4965_alloc_fw_desc(priv->pci_dev, &priv->ucode_code);
 
        priv->ucode_data.len = data_size;
-       priv->ucode_data.v_addr =
-           pci_alloc_consistent(priv->pci_dev,
-                                priv->ucode_data.len,
-                                &(priv->ucode_data.p_addr));
+       iwl4965_alloc_fw_desc(priv->pci_dev, &priv->ucode_data);
 
        priv->ucode_data_backup.len = data_size;
-       priv->ucode_data_backup.v_addr =
-           pci_alloc_consistent(priv->pci_dev,
-                                priv->ucode_data_backup.len,
-                                &(priv->ucode_data_backup.p_addr));
-
+       iwl4965_alloc_fw_desc(priv->pci_dev, &priv->ucode_data_backup);
 
        /* Initialization instructions and data */
-       priv->ucode_init.len = init_size;
-       priv->ucode_init.v_addr =
-           pci_alloc_consistent(priv->pci_dev,
-                                priv->ucode_init.len,
-                                &(priv->ucode_init.p_addr));
-
-       priv->ucode_init_data.len = init_data_size;
-       priv->ucode_init_data.v_addr =
-           pci_alloc_consistent(priv->pci_dev,
-                                priv->ucode_init_data.len,
-                                &(priv->ucode_init_data.p_addr));
+       if (init_size && init_data_size) {
+               priv->ucode_init.len = init_size;
+               iwl4965_alloc_fw_desc(priv->pci_dev, &priv->ucode_init);
+
+               priv->ucode_init_data.len = init_data_size;
+               iwl4965_alloc_fw_desc(priv->pci_dev, &priv->ucode_init_data);
+
+               if (!priv->ucode_init.v_addr || !priv->ucode_init_data.v_addr)
+                       goto err_pci_alloc;
+       }
 
        /* Bootstrap (instructions only, no data) */
-       priv->ucode_boot.len = boot_size;
-       priv->ucode_boot.v_addr =
-           pci_alloc_consistent(priv->pci_dev,
-                                priv->ucode_boot.len,
-                                &(priv->ucode_boot.p_addr));
+       if (boot_size) {
+               priv->ucode_boot.len = boot_size;
+               iwl4965_alloc_fw_desc(priv->pci_dev, &priv->ucode_boot);
 
-       if (!priv->ucode_code.v_addr || !priv->ucode_data.v_addr ||
-           !priv->ucode_init.v_addr || !priv->ucode_init_data.v_addr ||
-           !priv->ucode_boot.v_addr || !priv->ucode_data_backup.v_addr)
-               goto err_pci_alloc;
+               if (!priv->ucode_boot.v_addr)
+                       goto err_pci_alloc;
+       }
 
        /* Copy images into buffers for card's bus-master reads ... */
 
        /* Runtime instructions (first block of data in file) */
        src = &ucode->data[0];
        len = priv->ucode_code.len;
-       IWL_DEBUG_INFO("Copying (but not loading) uCode instr len %d\n",
-                      (int)len);
+       IWL_DEBUG_INFO("Copying (but not loading) uCode instr len %Zd\n", len);
        memcpy(priv->ucode_code.v_addr, src, len);
        IWL_DEBUG_INFO("uCode instr buf vaddr = 0x%p, paddr = 0x%08x\n",
                priv->ucode_code.v_addr, (u32)priv->ucode_code.p_addr);
@@ -6312,8 +6440,7 @@ static int iwl4965_read_ucode(struct iwl4965_priv *priv)
         * NOTE:  Copy into backup buffer will be done in iwl4965_up()  */
        src = &ucode->data[inst_size];
        len = priv->ucode_data.len;
-       IWL_DEBUG_INFO("Copying (but not loading) uCode data len %d\n",
-                      (int)len);
+       IWL_DEBUG_INFO("Copying (but not loading) uCode data len %Zd\n", len);
        memcpy(priv->ucode_data.v_addr, src, len);
        memcpy(priv->ucode_data_backup.v_addr, src, len);
 
@@ -6321,8 +6448,8 @@ static int iwl4965_read_ucode(struct iwl4965_priv *priv)
        if (init_size) {
                src = &ucode->data[inst_size + data_size];
                len = priv->ucode_init.len;
-               IWL_DEBUG_INFO("Copying (but not loading) init instr len %d\n",
-                              (int)len);
+               IWL_DEBUG_INFO("Copying (but not loading) init instr len %Zd\n",
+                               len);
                memcpy(priv->ucode_init.v_addr, src, len);
        }
 
@@ -6330,16 +6457,15 @@ static int iwl4965_read_ucode(struct iwl4965_priv *priv)
        if (init_data_size) {
                src = &ucode->data[inst_size + data_size + init_size];
                len = priv->ucode_init_data.len;
-               IWL_DEBUG_INFO("Copying (but not loading) init data len %d\n",
-                              (int)len);
+               IWL_DEBUG_INFO("Copying (but not loading) init data len %Zd\n",
+                              len);
                memcpy(priv->ucode_init_data.v_addr, src, len);
        }
 
        /* Bootstrap instructions (5th block) */
        src = &ucode->data[inst_size + data_size + init_size + init_data_size];
        len = priv->ucode_boot.len;
-       IWL_DEBUG_INFO("Copying (but not loading) boot instr len %d\n",
-                      (int)len);
+       IWL_DEBUG_INFO("Copying (but not loading) boot instr len %Zd\n", len);
        memcpy(priv->ucode_boot.v_addr, src, len);
 
        /* We have our copies now, allow OS release its copies */
@@ -6348,14 +6474,14 @@ static int iwl4965_read_ucode(struct iwl4965_priv *priv)
 
  err_pci_alloc:
        IWL_ERROR("failed to allocate pci memory\n");
-       rc = -ENOMEM;
+       ret = -ENOMEM;
        iwl4965_dealloc_ucode_pci(priv);
 
  err_release:
        release_firmware(ucode_raw);
 
  error:
-       return rc;
+       return ret;
 }
 
 
@@ -6494,7 +6620,7 @@ static void iwl4965_alive_start(struct iwl4965_priv *priv)
                goto restart;
        }
 
-       /* After the ALIVE response, we can process host commands */
+       /* After the ALIVE response, we can send host commands to 4965 uCode */
        set_bit(STATUS_ALIVE, &priv->status);
 
        /* Clear out the uCode error bit if it is set */
@@ -6551,7 +6677,7 @@ static void iwl4965_alive_start(struct iwl4965_priv *priv)
                memcpy(priv->staging_rxon.node_addr, priv->mac_addr, ETH_ALEN);
        }
 
-       /* Configure BT coexistence */
+       /* Configure Bluetooth device coexistence support */
        iwl4965_send_bt_config(priv);
 
        /* Configure the adapter for unassociated operation */
@@ -6631,7 +6757,8 @@ static void __iwl4965_down(struct iwl4965_priv *priv)
                                STATUS_FW_ERROR;
 
        spin_lock_irqsave(&priv->lock, flags);
-       iwl4965_clear_bit(priv, CSR_GP_CNTRL, CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ);
+       iwl4965_clear_bit(priv, CSR_GP_CNTRL,
+                        CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ);
        spin_unlock_irqrestore(&priv->lock, flags);
 
        iwl4965_hw_txq_ctx_stop(priv);
@@ -6751,7 +6878,7 @@ static int __iwl4965_up(struct iwl4965_priv *priv)
                /* start card; "initialize" will load runtime ucode */
                iwl4965_nic_start(priv);
 
-               /* MAC Address location in EEPROM same for 3945/4965 */
+               /* MAC Address location in EEPROM is same for 3945/4965 */
                get_eeprom_mac(priv, priv->mac_addr);
                IWL_DEBUG_INFO("MAC address: %s\n",
                               print_mac(mac, priv->mac_addr));
@@ -7805,7 +7932,7 @@ static int iwl4965_mac_conf_tx(struct ieee80211_hw *hw, int queue,
 #ifdef CONFIG_IWL4965_QOS
        unsigned long flags;
        int q;
-#endif /* CONFIG_IWL_QOS */
+#endif /* CONFIG_IWL4965_QOS */
 
        IWL_DEBUG_MAC80211("enter\n");
 
@@ -8963,6 +9090,8 @@ static int iwl4965_pci_probe(struct pci_dev *pdev, const struct pci_device_id *e
        struct ieee80211_hw *hw;
        int i;
 
+       /* Disabling hardware scan means that mac80211 will perform scans
+        * "the hard way", rather than using device's scan. */
        if (iwl4965_param_disable_hw_scan) {
                IWL_DEBUG_INFO("Disabling hw_scan\n");
                iwl4965_hw_ops.hw_scan = NULL;
@@ -9014,9 +9143,11 @@ static int iwl4965_pci_probe(struct pci_dev *pdev, const struct pci_device_id *e
        /* Tell mac80211 our Tx characteristics */
        hw->flags = IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE;
 
+       /* Default value; 4 EDCA QOS priorities */
        hw->queues = 4;
 #ifdef CONFIG_IWL4965_HT
 #ifdef CONFIG_IWL4965_HT_AGG
+       /* Enhanced value; more queues, to support 11n aggregation */
        hw->queues = 16;
 #endif /* CONFIG_IWL4965_HT_AGG */
 #endif /* CONFIG_IWL4965_HT */
@@ -9040,6 +9171,7 @@ static int iwl4965_pci_probe(struct pci_dev *pdev, const struct pci_device_id *e
 
        pci_set_master(pdev);
 
+       /* Clear the driver's (not device's) station table */
        iwl4965_clear_stations_table(priv);
 
        priv->data_retry_limit = -1;
@@ -9059,9 +9191,11 @@ static int iwl4965_pci_probe(struct pci_dev *pdev, const struct pci_device_id *e
        err = pci_request_regions(pdev, DRV_NAME);
        if (err)
                goto out_pci_disable_device;
+
        /* We disable the RETRY_TIMEOUT register (0x41) to keep
         * PCI Tx retries from interfering with C3 CPU state */
        pci_write_config_byte(pdev, 0x41, 0x00);
+
        priv->hw_base = pci_iomap(pdev, 0, 0);
        if (!priv->hw_base) {
                err = -ENODEV;
@@ -9074,6 +9208,7 @@ static int iwl4965_pci_probe(struct pci_dev *pdev, const struct pci_device_id *e
 
        /* Initialize module parameter values here */
 
+       /* Disable radio (SW RF KILL) via parameter when loading driver */
        if (iwl4965_param_disable) {
                set_bit(STATUS_RF_KILL_SW, &priv->status);
                IWL_DEBUG_INFO("Radio disabled.\n");
@@ -9088,6 +9223,7 @@ static int iwl4965_pci_probe(struct pci_dev *pdev, const struct pci_device_id *e
        priv->valid_antenna = 0x7;      /* assume all 3 connected */
        priv->ps_mode = IWL_MIMO_PS_NONE;
 
+       /* Choose which receivers/antennas to use */
        iwl4965_set_rxon_chain(priv);
 
        printk(KERN_INFO DRV_NAME