drivers/net/wireless/iwlwifi/iwl-hcmd.c

   1 /******************************************************************************
   2  *
   3  * GPL LICENSE SUMMARY
   4  *
   5  * Copyright(c) 2008 Intel Corporation. All rights reserved.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of version 2 of the GNU General Public License as
   9  * published by the Free Software Foundation.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  19  * USA
  20  *
  21  * The full GNU General Public License is included in this distribution
  22  * in the file called LICENSE.GPL.
  23  *
  24  * Contact Information:
  25  *  Intel Linux Wireless <ilw@linux.intel.com>
  26  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  27  *****************************************************************************/
  28
  29 #include <linux/kernel.h>
  30 #include <linux/module.h>
  31 #include <net/mac80211.h>
  32
  33 #include "iwl-dev.h" /* FIXME: remove */
  34 #include "iwl-debug.h"
  35 #include "iwl-eeprom.h"
  36 #include "iwl-core.h"
  37
  38
  39 #define IWL_CMD(x) case x: return #x
  40
  41 const char *get_cmd_string(u8 cmd)
  42 {
  43         switch (cmd) {
  44                 IWL_CMD(REPLY_ALIVE);
  45                 IWL_CMD(REPLY_ERROR);
  46                 IWL_CMD(REPLY_RXON);
  47                 IWL_CMD(REPLY_RXON_ASSOC);
  48                 IWL_CMD(REPLY_QOS_PARAM);
  49                 IWL_CMD(REPLY_RXON_TIMING);
  50                 IWL_CMD(REPLY_ADD_STA);
  51                 IWL_CMD(REPLY_REMOVE_STA);
  52                 IWL_CMD(REPLY_REMOVE_ALL_STA);
  53                 IWL_CMD(REPLY_WEPKEY);
  54                 IWL_CMD(REPLY_3945_RX);
  55                 IWL_CMD(REPLY_TX);
  56                 IWL_CMD(REPLY_RATE_SCALE);
  57                 IWL_CMD(REPLY_LEDS_CMD);
  58                 IWL_CMD(REPLY_TX_LINK_QUALITY_CMD);
  59                 IWL_CMD(COEX_PRIORITY_TABLE_CMD);
  60                 IWL_CMD(RADAR_NOTIFICATION);
  61                 IWL_CMD(REPLY_QUIET_CMD);
  62                 IWL_CMD(REPLY_CHANNEL_SWITCH);
  63                 IWL_CMD(CHANNEL_SWITCH_NOTIFICATION);
  64                 IWL_CMD(REPLY_SPECTRUM_MEASUREMENT_CMD);
  65                 IWL_CMD(SPECTRUM_MEASURE_NOTIFICATION);
  66                 IWL_CMD(POWER_TABLE_CMD);
  67                 IWL_CMD(PM_SLEEP_NOTIFICATION);
  68                 IWL_CMD(PM_DEBUG_STATISTIC_NOTIFIC);
  69                 IWL_CMD(REPLY_SCAN_CMD);
  70                 IWL_CMD(REPLY_SCAN_ABORT_CMD);
  71                 IWL_CMD(SCAN_START_NOTIFICATION);
  72                 IWL_CMD(SCAN_RESULTS_NOTIFICATION);
  73                 IWL_CMD(SCAN_COMPLETE_NOTIFICATION);
  74                 IWL_CMD(BEACON_NOTIFICATION);
  75                 IWL_CMD(REPLY_TX_BEACON);
  76                 IWL_CMD(WHO_IS_AWAKE_NOTIFICATION);
  77                 IWL_CMD(QUIET_NOTIFICATION);
  78                 IWL_CMD(REPLY_TX_PWR_TABLE_CMD);
  79                 IWL_CMD(MEASURE_ABORT_NOTIFICATION);
  80                 IWL_CMD(REPLY_BT_CONFIG);
  81                 IWL_CMD(REPLY_STATISTICS_CMD);
  82                 IWL_CMD(STATISTICS_NOTIFICATION);
  83                 IWL_CMD(REPLY_CARD_STATE_CMD);
  84                 IWL_CMD(CARD_STATE_NOTIFICATION);
  85                 IWL_CMD(MISSED_BEACONS_NOTIFICATION);
  86                 IWL_CMD(REPLY_CT_KILL_CONFIG_CMD);
  87                 IWL_CMD(SENSITIVITY_CMD);
  88                 IWL_CMD(REPLY_PHY_CALIBRATION_CMD);
  89                 IWL_CMD(REPLY_RX_PHY_CMD);
  90                 IWL_CMD(REPLY_RX_MPDU_CMD);
  91                 IWL_CMD(REPLY_RX);
  92                 IWL_CMD(REPLY_COMPRESSED_BA);
  93                 IWL_CMD(CALIBRATION_CFG_CMD);
  94                 IWL_CMD(CALIBRATION_RES_NOTIFICATION);
  95                 IWL_CMD(CALIBRATION_COMPLETE_NOTIFICATION);
  96                 IWL_CMD(REPLY_TX_POWER_DBM_CMD);
  97         default:
  98                 return "UNKNOWN";
  99
 100         }
 101 }
 102 EXPORT_SYMBOL(get_cmd_string);
 103
 104 #define HOST_COMPLETE_TIMEOUT (HZ / 2)
 105
 106 static int iwl_generic_cmd_callback(struct iwl_priv *priv,
 107                                     struct iwl_cmd *cmd, struct sk_buff *skb)
 108 {
 109         struct iwl_rx_packet *pkt = NULL;
 110
 111         if (!skb) {
 112                 IWL_ERR(priv, "Error: Response NULL in %s.\n",
 113                                 get_cmd_string(cmd->hdr.cmd));
 114                 return 1;
 115         }
 116
 117         pkt = (struct iwl_rx_packet *)skb->data;
 118         if (pkt->hdr.flags & IWL_CMD_FAILED_MSK) {
 119                 IWL_ERR(priv, "Bad return from %s (0x%08X)\n",
 120                         get_cmd_string(cmd->hdr.cmd), pkt->hdr.flags);
 121                 return 1;
 122         }
 123
 124 #ifdef CONFIG_IWLWIFI_DEBUG
 125         switch (cmd->hdr.cmd) {
 126         case REPLY_TX_LINK_QUALITY_CMD:
 127         case SENSITIVITY_CMD:
 128                 IWL_DEBUG_HC_DUMP("back from %s (0x%08X)\n",
 129                                 get_cmd_string(cmd->hdr.cmd), pkt->hdr.flags);
 130                                 break;
 131         default:
 132                 IWL_DEBUG_HC("back from %s (0x%08X)\n",
 133                                 get_cmd_string(cmd->hdr.cmd), pkt->hdr.flags);
 134         }
 135 #endif
 136
 137         /* Let iwl_tx_complete free the response skb */
 138         return 1;
 139 }
 140
 141 static int iwl_send_cmd_async(struct iwl_priv *priv, struct iwl_host_cmd *cmd)
 142 {
 143         int ret;
 144
 145         BUG_ON(!(cmd->meta.flags & CMD_ASYNC));
 146
 147         /* An asynchronous command can not expect an SKB to be set. */
 148         BUG_ON(cmd->meta.flags & CMD_WANT_SKB);
 149
 150         /* Assign a generic callback if one is not provided */
 151         if (!cmd->meta.u.callback)
 152                 cmd->meta.u.callback = iwl_generic_cmd_callback;
 153
 154         if (test_bit(STATUS_EXIT_PENDING, &priv->status))
 155                 return -EBUSY;
 156
 157         ret = iwl_enqueue_hcmd(priv, cmd);
 158         if (ret < 0) {
 159                 IWL_ERR(priv, "Error sending %s: enqueue_hcmd failed: %d\n",
 160                           get_cmd_string(cmd->id), ret);
 161                 return ret;
 162         }
 163         return 0;
 164 }
 165
 166 int iwl_send_cmd_sync(struct iwl_priv *priv, struct iwl_host_cmd *cmd)
 167 {
 168         int cmd_idx;
 169         int ret;
 170
 171         BUG_ON(cmd->meta.flags & CMD_ASYNC);
 172
 173          /* A synchronous command can not have a callback set. */
 174         BUG_ON(cmd->meta.u.callback != NULL);
 175
 176         if (test_and_set_bit(STATUS_HCMD_SYNC_ACTIVE, &priv->status)) {
 177                 IWL_ERR(priv,
 178                         "Error sending %s: Already sending a host command\n",
 179                         get_cmd_string(cmd->id));
 180                 ret = -EBUSY;
 181                 goto out;
 182         }
 183
 184         set_bit(STATUS_HCMD_ACTIVE, &priv->status);
 185
 186         if (cmd->meta.flags & CMD_WANT_SKB)
 187                 cmd->meta.source = &cmd->meta;
 188
 189         cmd_idx = iwl_enqueue_hcmd(priv, cmd);
 190         if (cmd_idx < 0) {
 191                 ret = cmd_idx;
 192                 IWL_ERR(priv, "Error sending %s: enqueue_hcmd failed: %d\n",
 193                           get_cmd_string(cmd->id), ret);
 194                 goto out;
 195         }
 196
 197         ret = wait_event_interruptible_timeout(priv->wait_command_queue,
 198                         !test_bit(STATUS_HCMD_ACTIVE, &priv->status),
 199                         HOST_COMPLETE_TIMEOUT);
 200         if (!ret) {
 201                 if (test_bit(STATUS_HCMD_ACTIVE, &priv->status)) {
 202                         IWL_ERR(priv,
 203                                 "Error sending %s: time out after %dms.\n",
 204                                 get_cmd_string(cmd->id),
 205                                 jiffies_to_msecs(HOST_COMPLETE_TIMEOUT));
 206
 207                         clear_bit(STATUS_HCMD_ACTIVE, &priv->status);
 208                         ret = -ETIMEDOUT;
 209                         goto cancel;
 210                 }
 211         }
 212
 213         if (test_bit(STATUS_RF_KILL_HW, &priv->status)) {
 214                 IWL_DEBUG_INFO("Command %s aborted: RF KILL Switch\n",
 215                                get_cmd_string(cmd->id));
 216                 ret = -ECANCELED;
 217                 goto fail;
 218         }
 219         if (test_bit(STATUS_FW_ERROR, &priv->status)) {
 220                 IWL_DEBUG_INFO("Command %s failed: FW Error\n",
 221                                get_cmd_string(cmd->id));
 222                 ret = -EIO;
 223                 goto fail;
 224         }
 225         if ((cmd->meta.flags & CMD_WANT_SKB) && !cmd->meta.u.skb) {
 226                 IWL_ERR(priv, "Error: Response NULL in '%s'\n",
 227                           get_cmd_string(cmd->id));
 228                 ret = -EIO;
 229                 goto cancel;
 230         }
 231
 232         ret = 0;
 233         goto out;
 234
 235 cancel:
 236         if (cmd->meta.flags & CMD_WANT_SKB) {
 237                 struct iwl_cmd *qcmd;
 238
 239                 /* Cancel the CMD_WANT_SKB flag for the cmd in the
 240                  * TX cmd queue. Otherwise in case the cmd comes
 241                  * in later, it will possibly set an invalid
 242                  * address (cmd->meta.source). */
 243                 qcmd = priv->txq[IWL_CMD_QUEUE_NUM].cmd[cmd_idx];
 244                 qcmd->meta.flags &= ~CMD_WANT_SKB;
 245         }
 246 fail:
 247         if (cmd->meta.u.skb) {
 248                 dev_kfree_skb_any(cmd->meta.u.skb);
 249                 cmd->meta.u.skb = NULL;
 250         }
 251 out:
 252         clear_bit(STATUS_HCMD_SYNC_ACTIVE, &priv->status);
 253         return ret;
 254 }
 255 EXPORT_SYMBOL(iwl_send_cmd_sync);
 256
 257 int iwl_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd)
 258 {
 259         if (cmd->meta.flags & CMD_ASYNC)
 260                 return iwl_send_cmd_async(priv, cmd);
 261
 262         return iwl_send_cmd_sync(priv, cmd);
 263 }
 264 EXPORT_SYMBOL(iwl_send_cmd);
 265
 266 int iwl_send_cmd_pdu(struct iwl_priv *priv, u8 id, u16 len, const void *data)
 267 {
 268         struct iwl_host_cmd cmd = {
 269                 .id = id,
 270                 .len = len,
 271                 .data = data,
 272         };
 273
 274         return iwl_send_cmd_sync(priv, &cmd);
 275 }
 276 EXPORT_SYMBOL(iwl_send_cmd_pdu);
 277
 278 int iwl_send_cmd_pdu_async(struct iwl_priv *priv,
 279                            u8 id, u16 len, const void *data,
 280                            int (*callback)(struct iwl_priv *priv,
 281                                            struct iwl_cmd *cmd,
 282                                            struct sk_buff *skb))
 283 {
 284         struct iwl_host_cmd cmd = {
 285                 .id = id,
 286                 .len = len,
 287                 .data = data,
 288         };
 289
 290         cmd.meta.flags |= CMD_ASYNC;
 291         cmd.meta.u.callback = callback;
 292
 293         return iwl_send_cmd_async(priv, &cmd);
 294 }
 295 EXPORT_SYMBOL(iwl_send_cmd_pdu_async);