2 * Copyright (c) 2014 Qualcomm Atheros, Inc.
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.
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.
19 #include <net/netlink.h>
20 #include <linux/firmware.h>
27 #include "testmode_i.h"
29 static const struct nla_policy ath10k_tm_policy[ATH10K_TM_ATTR_MAX + 1] = {
30 [ATH10K_TM_ATTR_CMD] = { .type = NLA_U32 },
31 [ATH10K_TM_ATTR_DATA] = { .type = NLA_BINARY,
32 .len = ATH10K_TM_DATA_MAX_LEN },
33 [ATH10K_TM_ATTR_WMI_CMDID] = { .type = NLA_U32 },
34 [ATH10K_TM_ATTR_VERSION_MAJOR] = { .type = NLA_U32 },
35 [ATH10K_TM_ATTR_VERSION_MINOR] = { .type = NLA_U32 },
38 /* Returns true if callee consumes the skb and the skb should be discarded.
39 * Returns false if skb is not used. Does not sleep.
41 bool ath10k_tm_event_wmi(struct ath10k *ar, u32 cmd_id, struct sk_buff *skb)
43 struct sk_buff *nl_skb;
47 ath10k_dbg(ar, ATH10K_DBG_TESTMODE,
48 "testmode event wmi cmd_id %d skb %p skb->len %d\n",
49 cmd_id, skb, skb->len);
51 ath10k_dbg_dump(ar, ATH10K_DBG_TESTMODE, NULL, "", skb->data, skb->len);
53 spin_lock_bh(&ar->data_lock);
55 if (!ar->testmode.utf_monitor) {
60 /* Only testmode.c should be handling events from utf firmware,
61 * otherwise all sort of problems will arise as mac80211 operations
62 * are not initialised.
66 nl_skb = cfg80211_testmode_alloc_event_skb(ar->hw->wiphy,
67 2 * sizeof(u32) + skb->len,
71 "failed to allocate skb for testmode wmi event\n");
75 ret = nla_put_u32(nl_skb, ATH10K_TM_ATTR_CMD, ATH10K_TM_CMD_WMI);
78 "failed to to put testmode wmi event cmd attribute: %d\n",
84 ret = nla_put_u32(nl_skb, ATH10K_TM_ATTR_WMI_CMDID, cmd_id);
87 "failed to to put testmode wmi even cmd_id: %d\n",
93 ret = nla_put(nl_skb, ATH10K_TM_ATTR_DATA, skb->len, skb->data);
96 "failed to copy skb to testmode wmi event: %d\n",
102 cfg80211_testmode_event(nl_skb, GFP_ATOMIC);
105 spin_unlock_bh(&ar->data_lock);
110 static int ath10k_tm_cmd_get_version(struct ath10k *ar, struct nlattr *tb[])
115 ath10k_dbg(ar, ATH10K_DBG_TESTMODE,
116 "testmode cmd get version_major %d version_minor %d\n",
117 ATH10K_TESTMODE_VERSION_MAJOR,
118 ATH10K_TESTMODE_VERSION_MINOR);
120 skb = cfg80211_testmode_alloc_reply_skb(ar->hw->wiphy,
121 nla_total_size(sizeof(u32)));
125 ret = nla_put_u32(skb, ATH10K_TM_ATTR_VERSION_MAJOR,
126 ATH10K_TESTMODE_VERSION_MAJOR);
132 ret = nla_put_u32(skb, ATH10K_TM_ATTR_VERSION_MINOR,
133 ATH10K_TESTMODE_VERSION_MINOR);
139 return cfg80211_testmode_reply(skb);
142 static int ath10k_tm_fetch_utf_firmware_api_2(struct ath10k *ar)
144 size_t len, magic_len, ie_len;
145 struct ath10k_fw_ie *hdr;
151 snprintf(filename, sizeof(filename), "%s/%s",
152 ar->hw_params.fw.dir, ATH10K_FW_UTF_API2_FILE);
154 /* load utf firmware image */
155 ret = reject_firmware(&ar->testmode.utf, filename, ar->dev);
157 ath10k_warn(ar, "failed to retrieve utf firmware '%s': %d\n",
162 data = ar->testmode.utf->data;
163 len = ar->testmode.utf->size;
165 /* FIXME: call release_firmware() in error cases */
167 /* magic also includes the null byte, check that as well */
168 magic_len = strlen(ATH10K_FIRMWARE_MAGIC) + 1;
170 if (len < magic_len) {
171 ath10k_err(ar, "utf firmware file is too small to contain magic\n");
176 if (memcmp(data, ATH10K_FIRMWARE_MAGIC, magic_len) != 0) {
177 ath10k_err(ar, "invalid firmware magic\n");
182 /* jump over the padding */
183 magic_len = ALIGN(magic_len, 4);
189 while (len > sizeof(struct ath10k_fw_ie)) {
190 hdr = (struct ath10k_fw_ie *)data;
192 ie_id = le32_to_cpu(hdr->id);
193 ie_len = le32_to_cpu(hdr->len);
196 data += sizeof(*hdr);
199 ath10k_err(ar, "invalid length for FW IE %d (%zu < %zu)\n",
206 case ATH10K_FW_IE_FW_VERSION:
207 if (ie_len > sizeof(ar->testmode.utf_version) - 1)
210 memcpy(ar->testmode.utf_version, data, ie_len);
211 ar->testmode.utf_version[ie_len] = '\0';
213 ath10k_dbg(ar, ATH10K_DBG_TESTMODE,
214 "testmode found fw utf version %s\n",
215 ar->testmode.utf_version);
217 case ATH10K_FW_IE_TIMESTAMP:
218 /* ignore timestamp, but don't warn about it either */
220 case ATH10K_FW_IE_FW_IMAGE:
221 ath10k_dbg(ar, ATH10K_DBG_TESTMODE,
222 "testmode found fw image ie (%zd B)\n",
225 ar->testmode.utf_firmware_data = data;
226 ar->testmode.utf_firmware_len = ie_len;
228 case ATH10K_FW_IE_WMI_OP_VERSION:
229 if (ie_len != sizeof(u32))
231 version = (__le32 *)data;
232 ar->testmode.op_version = le32_to_cpup(version);
233 ath10k_dbg(ar, ATH10K_DBG_TESTMODE, "testmode found fw ie wmi op version %d\n",
234 ar->testmode.op_version);
237 ath10k_warn(ar, "Unknown testmode FW IE: %u\n",
238 le32_to_cpu(hdr->id));
241 /* jump over the padding */
242 ie_len = ALIGN(ie_len, 4);
248 if (!ar->testmode.utf_firmware_data || !ar->testmode.utf_firmware_len) {
249 ath10k_err(ar, "No ATH10K_FW_IE_FW_IMAGE found\n");
257 release_firmware(ar->testmode.utf);
262 static int ath10k_tm_fetch_utf_firmware_api_1(struct ath10k *ar)
267 snprintf(filename, sizeof(filename), "%s/%s",
268 ar->hw_params.fw.dir, ATH10K_FW_UTF_FILE);
270 /* load utf firmware image */
271 ret = reject_firmware(&ar->testmode.utf, filename, ar->dev);
273 ath10k_warn(ar, "failed to retrieve utf firmware '%s': %d\n",
278 /* We didn't find FW UTF API 1 *//*(DEBLOBBED)*//* does not advertise
279 * firmware features. Do an ugly hack where we force the firmware
280 * features to match with 10.1 branch so that wmi.c will use the
281 * correct WMI interface.
284 ar->testmode.op_version = ATH10K_FW_WMI_OP_VERSION_10_1;
285 ar->testmode.utf_firmware_data = ar->testmode.utf->data;
286 ar->testmode.utf_firmware_len = ar->testmode.utf->size;
291 static int ath10k_tm_fetch_firmware(struct ath10k *ar)
295 ret = ath10k_tm_fetch_utf_firmware_api_2(ar);
297 ath10k_dbg(ar, ATH10K_DBG_TESTMODE, "testmode using fw utf api 2");
301 ret = ath10k_tm_fetch_utf_firmware_api_1(ar);
303 ath10k_err(ar, "failed to fetch utf firmware binary: %d", ret);
307 ath10k_dbg(ar, ATH10K_DBG_TESTMODE, "testmode using utf api 1");
312 static int ath10k_tm_cmd_utf_start(struct ath10k *ar, struct nlattr *tb[])
317 ath10k_dbg(ar, ATH10K_DBG_TESTMODE, "testmode cmd utf start\n");
319 mutex_lock(&ar->conf_mutex);
321 if (ar->state == ATH10K_STATE_UTF) {
326 /* start utf only when the driver is not in use */
327 if (ar->state != ATH10K_STATE_OFF) {
332 if (WARN_ON(ar->testmode.utf != NULL)) {
333 /* utf image is already downloaded, it shouldn't be */
338 ret = ath10k_tm_fetch_firmware(ar);
340 ath10k_err(ar, "failed to fetch UTF firmware: %d", ret);
344 spin_lock_bh(&ar->data_lock);
345 ar->testmode.utf_monitor = true;
346 spin_unlock_bh(&ar->data_lock);
347 BUILD_BUG_ON(sizeof(ar->fw_features) !=
348 sizeof(ar->testmode.orig_fw_features));
350 memcpy(ar->testmode.orig_fw_features, ar->fw_features,
351 sizeof(ar->fw_features));
352 ar->testmode.orig_wmi_op_version = ar->wmi.op_version;
353 memset(ar->fw_features, 0, sizeof(ar->fw_features));
355 ar->wmi.op_version = ar->testmode.op_version;
357 ath10k_dbg(ar, ATH10K_DBG_TESTMODE, "testmode wmi version %d\n",
360 ret = ath10k_hif_power_up(ar);
362 ath10k_err(ar, "failed to power up hif (testmode): %d\n", ret);
363 ar->state = ATH10K_STATE_OFF;
364 goto err_fw_features;
367 ret = ath10k_core_start(ar, ATH10K_FIRMWARE_MODE_UTF);
369 ath10k_err(ar, "failed to start core (testmode): %d\n", ret);
370 ar->state = ATH10K_STATE_OFF;
374 ar->state = ATH10K_STATE_UTF;
376 if (strlen(ar->testmode.utf_version) > 0)
377 ver = ar->testmode.utf_version;
381 ath10k_info(ar, "UTF firmware %s started\n", ver);
383 mutex_unlock(&ar->conf_mutex);
388 ath10k_hif_power_down(ar);
391 /* return the original firmware features */
392 memcpy(ar->fw_features, ar->testmode.orig_fw_features,
393 sizeof(ar->fw_features));
394 ar->wmi.op_version = ar->testmode.orig_wmi_op_version;
396 release_firmware(ar->testmode.utf);
397 ar->testmode.utf = NULL;
400 mutex_unlock(&ar->conf_mutex);
405 static void __ath10k_tm_cmd_utf_stop(struct ath10k *ar)
407 lockdep_assert_held(&ar->conf_mutex);
409 ath10k_core_stop(ar);
410 ath10k_hif_power_down(ar);
412 spin_lock_bh(&ar->data_lock);
414 ar->testmode.utf_monitor = false;
416 spin_unlock_bh(&ar->data_lock);
418 /* return the original firmware features */
419 memcpy(ar->fw_features, ar->testmode.orig_fw_features,
420 sizeof(ar->fw_features));
421 ar->wmi.op_version = ar->testmode.orig_wmi_op_version;
423 release_firmware(ar->testmode.utf);
424 ar->testmode.utf = NULL;
426 ar->state = ATH10K_STATE_OFF;
429 static int ath10k_tm_cmd_utf_stop(struct ath10k *ar, struct nlattr *tb[])
433 ath10k_dbg(ar, ATH10K_DBG_TESTMODE, "testmode cmd utf stop\n");
435 mutex_lock(&ar->conf_mutex);
437 if (ar->state != ATH10K_STATE_UTF) {
442 __ath10k_tm_cmd_utf_stop(ar);
446 ath10k_info(ar, "UTF firmware stopped\n");
449 mutex_unlock(&ar->conf_mutex);
453 static int ath10k_tm_cmd_wmi(struct ath10k *ar, struct nlattr *tb[])
460 mutex_lock(&ar->conf_mutex);
462 if (ar->state != ATH10K_STATE_UTF) {
467 if (!tb[ATH10K_TM_ATTR_DATA]) {
472 if (!tb[ATH10K_TM_ATTR_WMI_CMDID]) {
477 buf = nla_data(tb[ATH10K_TM_ATTR_DATA]);
478 buf_len = nla_len(tb[ATH10K_TM_ATTR_DATA]);
479 cmd_id = nla_get_u32(tb[ATH10K_TM_ATTR_WMI_CMDID]);
481 ath10k_dbg(ar, ATH10K_DBG_TESTMODE,
482 "testmode cmd wmi cmd_id %d buf %p buf_len %d\n",
483 cmd_id, buf, buf_len);
485 ath10k_dbg_dump(ar, ATH10K_DBG_TESTMODE, NULL, "", buf, buf_len);
487 skb = ath10k_wmi_alloc_skb(ar, buf_len);
493 memcpy(skb->data, buf, buf_len);
495 ret = ath10k_wmi_cmd_send(ar, skb, cmd_id);
497 ath10k_warn(ar, "failed to transmit wmi command (testmode): %d\n",
505 mutex_unlock(&ar->conf_mutex);
509 int ath10k_tm_cmd(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
512 struct ath10k *ar = hw->priv;
513 struct nlattr *tb[ATH10K_TM_ATTR_MAX + 1];
516 ret = nla_parse(tb, ATH10K_TM_ATTR_MAX, data, len,
521 if (!tb[ATH10K_TM_ATTR_CMD])
524 switch (nla_get_u32(tb[ATH10K_TM_ATTR_CMD])) {
525 case ATH10K_TM_CMD_GET_VERSION:
526 return ath10k_tm_cmd_get_version(ar, tb);
527 case ATH10K_TM_CMD_UTF_START:
528 return ath10k_tm_cmd_utf_start(ar, tb);
529 case ATH10K_TM_CMD_UTF_STOP:
530 return ath10k_tm_cmd_utf_stop(ar, tb);
531 case ATH10K_TM_CMD_WMI:
532 return ath10k_tm_cmd_wmi(ar, tb);
538 void ath10k_testmode_destroy(struct ath10k *ar)
540 mutex_lock(&ar->conf_mutex);
542 if (ar->state != ATH10K_STATE_UTF) {
543 /* utf firmware is not running, nothing to do */
547 __ath10k_tm_cmd_utf_stop(ar);
550 mutex_unlock(&ar->conf_mutex);