1 /* 2 * Copyright (c) 2014 Qualcomm Atheros, Inc. 3 * 4 * Permission to use, copy, modify, and/or distribute this software for any 5 * purpose with or without fee is hereby granted, provided that the above 6 * copyright notice and this permission notice appear in all copies. 7 * 8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 15 */ 16 17 #include "testmode.h" 18 19 #include <net/netlink.h> 20 #include <linux/firmware.h> 21 22 #include "debug.h" 23 #include "wmi.h" 24 #include "hif.h" 25 #include "hw.h" 26 #include "core.h" 27 28 #include "testmode_i.h" 29 30 static const struct nla_policy ath10k_tm_policy[ATH10K_TM_ATTR_MAX + 1] = { 31 [ATH10K_TM_ATTR_CMD] = { .type = NLA_U32 }, 32 [ATH10K_TM_ATTR_DATA] = { .type = NLA_BINARY, 33 .len = ATH10K_TM_DATA_MAX_LEN }, 34 [ATH10K_TM_ATTR_WMI_CMDID] = { .type = NLA_U32 }, 35 [ATH10K_TM_ATTR_VERSION_MAJOR] = { .type = NLA_U32 }, 36 [ATH10K_TM_ATTR_VERSION_MINOR] = { .type = NLA_U32 }, 37 }; 38 39 /* Returns true if callee consumes the skb and the skb should be discarded. 40 * Returns false if skb is not used. Does not sleep. 41 */ 42 bool ath10k_tm_event_wmi(struct ath10k *ar, u32 cmd_id, struct sk_buff *skb) 43 { 44 struct sk_buff *nl_skb; 45 bool consumed; 46 int ret; 47 48 ath10k_dbg(ar, ATH10K_DBG_TESTMODE, 49 "testmode event wmi cmd_id %d skb %pK skb->len %d\n", 50 cmd_id, skb, skb->len); 51 52 ath10k_dbg_dump(ar, ATH10K_DBG_TESTMODE, NULL, "", skb->data, skb->len); 53 54 spin_lock_bh(&ar->data_lock); 55 56 if (!ar->testmode.utf_monitor) { 57 consumed = false; 58 goto out; 59 } 60 61 /* Only testmode.c should be handling events from utf firmware, 62 * otherwise all sort of problems will arise as mac80211 operations 63 * are not initialised. 64 */ 65 consumed = true; 66 67 nl_skb = cfg80211_testmode_alloc_event_skb(ar->hw->wiphy, 68 2 * sizeof(u32) + skb->len, 69 GFP_ATOMIC); 70 if (!nl_skb) { 71 ath10k_warn(ar, 72 "failed to allocate skb for testmode wmi event\n"); 73 goto out; 74 } 75 76 ret = nla_put_u32(nl_skb, ATH10K_TM_ATTR_CMD, ATH10K_TM_CMD_WMI); 77 if (ret) { 78 ath10k_warn(ar, 79 "failed to to put testmode wmi event cmd attribute: %d\n", 80 ret); 81 kfree_skb(nl_skb); 82 goto out; 83 } 84 85 ret = nla_put_u32(nl_skb, ATH10K_TM_ATTR_WMI_CMDID, cmd_id); 86 if (ret) { 87 ath10k_warn(ar, 88 "failed to to put testmode wmi even cmd_id: %d\n", 89 ret); 90 kfree_skb(nl_skb); 91 goto out; 92 } 93 94 ret = nla_put(nl_skb, ATH10K_TM_ATTR_DATA, skb->len, skb->data); 95 if (ret) { 96 ath10k_warn(ar, 97 "failed to copy skb to testmode wmi event: %d\n", 98 ret); 99 kfree_skb(nl_skb); 100 goto out; 101 } 102 103 cfg80211_testmode_event(nl_skb, GFP_ATOMIC); 104 105 out: 106 spin_unlock_bh(&ar->data_lock); 107 108 return consumed; 109 } 110 111 static int ath10k_tm_cmd_get_version(struct ath10k *ar, struct nlattr *tb[]) 112 { 113 struct sk_buff *skb; 114 int ret; 115 116 ath10k_dbg(ar, ATH10K_DBG_TESTMODE, 117 "testmode cmd get version_major %d version_minor %d\n", 118 ATH10K_TESTMODE_VERSION_MAJOR, 119 ATH10K_TESTMODE_VERSION_MINOR); 120 121 skb = cfg80211_testmode_alloc_reply_skb(ar->hw->wiphy, 122 nla_total_size(sizeof(u32))); 123 if (!skb) 124 return -ENOMEM; 125 126 ret = nla_put_u32(skb, ATH10K_TM_ATTR_VERSION_MAJOR, 127 ATH10K_TESTMODE_VERSION_MAJOR); 128 if (ret) { 129 kfree_skb(skb); 130 return ret; 131 } 132 133 ret = nla_put_u32(skb, ATH10K_TM_ATTR_VERSION_MINOR, 134 ATH10K_TESTMODE_VERSION_MINOR); 135 if (ret) { 136 kfree_skb(skb); 137 return ret; 138 } 139 140 return cfg80211_testmode_reply(skb); 141 } 142 143 static int ath10k_tm_fetch_utf_firmware_api_1(struct ath10k *ar, 144 struct ath10k_fw_file *fw_file) 145 { 146 char filename[100]; 147 int ret; 148 149 snprintf(filename, sizeof(filename), "%s/%s", 150 ar->hw_params.fw.dir, ATH10K_FW_UTF_FILE); 151 152 /* load utf firmware image */ 153 ret = request_firmware(&fw_file->firmware, filename, ar->dev); 154 if (ret) { 155 ath10k_warn(ar, "failed to retrieve utf firmware '%s': %d\n", 156 filename, ret); 157 return ret; 158 } 159 160 /* We didn't find FW UTF API 1 ("utf.bin") does not advertise 161 * firmware features. Do an ugly hack where we force the firmware 162 * features to match with 10.1 branch so that wmi.c will use the 163 * correct WMI interface. 164 */ 165 166 fw_file->wmi_op_version = ATH10K_FW_WMI_OP_VERSION_10_1; 167 fw_file->htt_op_version = ATH10K_FW_HTT_OP_VERSION_10_1; 168 fw_file->firmware_data = fw_file->firmware->data; 169 fw_file->firmware_len = fw_file->firmware->size; 170 171 return 0; 172 } 173 174 static int ath10k_tm_fetch_firmware(struct ath10k *ar) 175 { 176 struct ath10k_fw_components *utf_mode_fw; 177 int ret; 178 179 ret = ath10k_core_fetch_firmware_api_n(ar, ATH10K_FW_UTF_API2_FILE, 180 &ar->testmode.utf_mode_fw.fw_file); 181 if (ret == 0) { 182 ath10k_dbg(ar, ATH10K_DBG_TESTMODE, "testmode using fw utf api 2"); 183 goto out; 184 } 185 186 ret = ath10k_tm_fetch_utf_firmware_api_1(ar, &ar->testmode.utf_mode_fw.fw_file); 187 if (ret) { 188 ath10k_err(ar, "failed to fetch utf firmware binary: %d", ret); 189 return ret; 190 } 191 192 ath10k_dbg(ar, ATH10K_DBG_TESTMODE, "testmode using utf api 1"); 193 194 out: 195 utf_mode_fw = &ar->testmode.utf_mode_fw; 196 197 /* Use the same board data file as the normal firmware uses (but 198 * it's still "owned" by normal_mode_fw so we shouldn't free it. 199 */ 200 utf_mode_fw->board_data = ar->normal_mode_fw.board_data; 201 utf_mode_fw->board_len = ar->normal_mode_fw.board_len; 202 203 if (!utf_mode_fw->fw_file.otp_data) { 204 ath10k_info(ar, "utf.bin didn't contain otp binary, taking it from the normal mode firmware"); 205 utf_mode_fw->fw_file.otp_data = ar->normal_mode_fw.fw_file.otp_data; 206 utf_mode_fw->fw_file.otp_len = ar->normal_mode_fw.fw_file.otp_len; 207 } 208 209 return 0; 210 } 211 212 static int ath10k_tm_cmd_utf_start(struct ath10k *ar, struct nlattr *tb[]) 213 { 214 const char *ver; 215 int ret; 216 217 ath10k_dbg(ar, ATH10K_DBG_TESTMODE, "testmode cmd utf start\n"); 218 219 mutex_lock(&ar->conf_mutex); 220 221 if (ar->state == ATH10K_STATE_UTF) { 222 ret = -EALREADY; 223 goto err; 224 } 225 226 /* start utf only when the driver is not in use */ 227 if (ar->state != ATH10K_STATE_OFF) { 228 ret = -EBUSY; 229 goto err; 230 } 231 232 if (WARN_ON(ar->testmode.utf_mode_fw.fw_file.firmware != NULL)) { 233 /* utf image is already downloaded, it shouldn't be */ 234 ret = -EEXIST; 235 goto err; 236 } 237 238 ret = ath10k_tm_fetch_firmware(ar); 239 if (ret) { 240 ath10k_err(ar, "failed to fetch UTF firmware: %d", ret); 241 goto err; 242 } 243 244 if (ar->testmode.utf_mode_fw.fw_file.codeswap_data && 245 ar->testmode.utf_mode_fw.fw_file.codeswap_len) { 246 ret = ath10k_swap_code_seg_init(ar, 247 &ar->testmode.utf_mode_fw.fw_file); 248 if (ret) { 249 ath10k_warn(ar, 250 "failed to init utf code swap segment: %d\n", 251 ret); 252 goto err_release_utf_mode_fw; 253 } 254 } 255 256 spin_lock_bh(&ar->data_lock); 257 ar->testmode.utf_monitor = true; 258 spin_unlock_bh(&ar->data_lock); 259 260 ath10k_dbg(ar, ATH10K_DBG_TESTMODE, "testmode wmi version %d\n", 261 ar->testmode.utf_mode_fw.fw_file.wmi_op_version); 262 263 ret = ath10k_hif_power_up(ar); 264 if (ret) { 265 ath10k_err(ar, "failed to power up hif (testmode): %d\n", ret); 266 ar->state = ATH10K_STATE_OFF; 267 goto err_release_utf_mode_fw; 268 } 269 270 ret = ath10k_core_start(ar, ATH10K_FIRMWARE_MODE_UTF, 271 &ar->testmode.utf_mode_fw); 272 if (ret) { 273 ath10k_err(ar, "failed to start core (testmode): %d\n", ret); 274 ar->state = ATH10K_STATE_OFF; 275 goto err_power_down; 276 } 277 278 ar->state = ATH10K_STATE_UTF; 279 280 if (strlen(ar->testmode.utf_mode_fw.fw_file.fw_version) > 0) 281 ver = ar->testmode.utf_mode_fw.fw_file.fw_version; 282 else 283 ver = "API 1"; 284 285 ath10k_info(ar, "UTF firmware %s started\n", ver); 286 287 mutex_unlock(&ar->conf_mutex); 288 289 return 0; 290 291 err_power_down: 292 ath10k_hif_power_down(ar); 293 294 err_release_utf_mode_fw: 295 if (ar->testmode.utf_mode_fw.fw_file.codeswap_data && 296 ar->testmode.utf_mode_fw.fw_file.codeswap_len) 297 ath10k_swap_code_seg_release(ar, 298 &ar->testmode.utf_mode_fw.fw_file); 299 300 release_firmware(ar->testmode.utf_mode_fw.fw_file.firmware); 301 ar->testmode.utf_mode_fw.fw_file.firmware = NULL; 302 303 err: 304 mutex_unlock(&ar->conf_mutex); 305 306 return ret; 307 } 308 309 static void __ath10k_tm_cmd_utf_stop(struct ath10k *ar) 310 { 311 lockdep_assert_held(&ar->conf_mutex); 312 313 ath10k_core_stop(ar); 314 ath10k_hif_power_down(ar); 315 316 spin_lock_bh(&ar->data_lock); 317 318 ar->testmode.utf_monitor = false; 319 320 spin_unlock_bh(&ar->data_lock); 321 322 if (ar->testmode.utf_mode_fw.fw_file.codeswap_data && 323 ar->testmode.utf_mode_fw.fw_file.codeswap_len) 324 ath10k_swap_code_seg_release(ar, 325 &ar->testmode.utf_mode_fw.fw_file); 326 327 release_firmware(ar->testmode.utf_mode_fw.fw_file.firmware); 328 ar->testmode.utf_mode_fw.fw_file.firmware = NULL; 329 330 ar->state = ATH10K_STATE_OFF; 331 } 332 333 static int ath10k_tm_cmd_utf_stop(struct ath10k *ar, struct nlattr *tb[]) 334 { 335 int ret; 336 337 ath10k_dbg(ar, ATH10K_DBG_TESTMODE, "testmode cmd utf stop\n"); 338 339 mutex_lock(&ar->conf_mutex); 340 341 if (ar->state != ATH10K_STATE_UTF) { 342 ret = -ENETDOWN; 343 goto out; 344 } 345 346 __ath10k_tm_cmd_utf_stop(ar); 347 348 ret = 0; 349 350 ath10k_info(ar, "UTF firmware stopped\n"); 351 352 out: 353 mutex_unlock(&ar->conf_mutex); 354 return ret; 355 } 356 357 static int ath10k_tm_cmd_wmi(struct ath10k *ar, struct nlattr *tb[]) 358 { 359 struct sk_buff *skb; 360 int ret, buf_len; 361 u32 cmd_id; 362 void *buf; 363 364 mutex_lock(&ar->conf_mutex); 365 366 if (ar->state != ATH10K_STATE_UTF) { 367 ret = -ENETDOWN; 368 goto out; 369 } 370 371 if (!tb[ATH10K_TM_ATTR_DATA]) { 372 ret = -EINVAL; 373 goto out; 374 } 375 376 if (!tb[ATH10K_TM_ATTR_WMI_CMDID]) { 377 ret = -EINVAL; 378 goto out; 379 } 380 381 buf = nla_data(tb[ATH10K_TM_ATTR_DATA]); 382 buf_len = nla_len(tb[ATH10K_TM_ATTR_DATA]); 383 cmd_id = nla_get_u32(tb[ATH10K_TM_ATTR_WMI_CMDID]); 384 385 ath10k_dbg(ar, ATH10K_DBG_TESTMODE, 386 "testmode cmd wmi cmd_id %d buf %pK buf_len %d\n", 387 cmd_id, buf, buf_len); 388 389 ath10k_dbg_dump(ar, ATH10K_DBG_TESTMODE, NULL, "", buf, buf_len); 390 391 skb = ath10k_wmi_alloc_skb(ar, buf_len); 392 if (!skb) { 393 ret = -ENOMEM; 394 goto out; 395 } 396 397 memcpy(skb->data, buf, buf_len); 398 399 ret = ath10k_wmi_cmd_send(ar, skb, cmd_id); 400 if (ret) { 401 ath10k_warn(ar, "failed to transmit wmi command (testmode): %d\n", 402 ret); 403 goto out; 404 } 405 406 ret = 0; 407 408 out: 409 mutex_unlock(&ar->conf_mutex); 410 return ret; 411 } 412 413 int ath10k_tm_cmd(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 414 void *data, int len) 415 { 416 struct ath10k *ar = hw->priv; 417 struct nlattr *tb[ATH10K_TM_ATTR_MAX + 1]; 418 int ret; 419 420 ret = nla_parse(tb, ATH10K_TM_ATTR_MAX, data, len, 421 ath10k_tm_policy); 422 if (ret) 423 return ret; 424 425 if (!tb[ATH10K_TM_ATTR_CMD]) 426 return -EINVAL; 427 428 switch (nla_get_u32(tb[ATH10K_TM_ATTR_CMD])) { 429 case ATH10K_TM_CMD_GET_VERSION: 430 return ath10k_tm_cmd_get_version(ar, tb); 431 case ATH10K_TM_CMD_UTF_START: 432 return ath10k_tm_cmd_utf_start(ar, tb); 433 case ATH10K_TM_CMD_UTF_STOP: 434 return ath10k_tm_cmd_utf_stop(ar, tb); 435 case ATH10K_TM_CMD_WMI: 436 return ath10k_tm_cmd_wmi(ar, tb); 437 default: 438 return -EOPNOTSUPP; 439 } 440 } 441 442 void ath10k_testmode_destroy(struct ath10k *ar) 443 { 444 mutex_lock(&ar->conf_mutex); 445 446 if (ar->state != ATH10K_STATE_UTF) { 447 /* utf firmware is not running, nothing to do */ 448 goto out; 449 } 450 451 __ath10k_tm_cmd_utf_stop(ar); 452 453 out: 454 mutex_unlock(&ar->conf_mutex); 455 } 456