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,
143 struct ath10k_fw_file *fw_file)
145 size_t len, magic_len, ie_len;
146 struct ath10k_fw_ie *hdr;
152 snprintf(filename, sizeof(filename), "%s/%s",
153 ar->hw_params.fw.dir, ATH10K_FW_UTF_API2_FILE);
155 /* load utf firmware image */
156 ret = request_firmware(&fw_file->firmware, filename, ar->dev);
158 ath10k_warn(ar, "failed to retrieve utf firmware '%s': %d\n",
163 data = fw_file->firmware->data;
164 len = fw_file->firmware->size;
166 /* FIXME: call release_firmware() in error cases */
168 /* magic also includes the null byte, check that as well */
169 magic_len = strlen(ATH10K_FIRMWARE_MAGIC) + 1;
171 if (len < magic_len) {
172 ath10k_err(ar, "utf firmware file is too small to contain magic\n");
177 if (memcmp(data, ATH10K_FIRMWARE_MAGIC, magic_len) != 0) {
178 ath10k_err(ar, "invalid firmware magic\n");
183 /* jump over the padding */
184 magic_len = ALIGN(magic_len, 4);
190 while (len > sizeof(struct ath10k_fw_ie)) {
191 hdr = (struct ath10k_fw_ie *)data;
193 ie_id = le32_to_cpu(hdr->id);
194 ie_len = le32_to_cpu(hdr->len);
197 data += sizeof(*hdr);
200 ath10k_err(ar, "invalid length for FW IE %d (%zu < %zu)\n",
207 case ATH10K_FW_IE_FW_VERSION:
208 if (ie_len > sizeof(fw_file->fw_version) - 1)
211 memcpy(fw_file->fw_version, data, ie_len);
212 fw_file->fw_version[ie_len] = '\0';
214 ath10k_dbg(ar, ATH10K_DBG_TESTMODE,
215 "testmode found fw utf version %s\n",
216 fw_file->fw_version);
218 case ATH10K_FW_IE_TIMESTAMP:
219 /* ignore timestamp, but don't warn about it either */
221 case ATH10K_FW_IE_FW_IMAGE:
222 ath10k_dbg(ar, ATH10K_DBG_TESTMODE,
223 "testmode found fw image ie (%zd B)\n",
226 fw_file->firmware_data = data;
227 fw_file->firmware_len = ie_len;
229 case ATH10K_FW_IE_WMI_OP_VERSION:
230 if (ie_len != sizeof(u32))
232 version = (__le32 *)data;
233 fw_file->wmi_op_version = le32_to_cpup(version);
234 ath10k_dbg(ar, ATH10K_DBG_TESTMODE, "testmode found fw ie wmi op version %d\n",
235 fw_file->wmi_op_version);
238 ath10k_warn(ar, "Unknown testmode FW IE: %u\n",
239 le32_to_cpu(hdr->id));
242 /* jump over the padding */
243 ie_len = ALIGN(ie_len, 4);
249 if (!fw_file->firmware_data || !fw_file->firmware_len) {
250 ath10k_err(ar, "No ATH10K_FW_IE_FW_IMAGE found\n");
258 release_firmware(fw_file->firmware);
263 static int ath10k_tm_fetch_utf_firmware_api_1(struct ath10k *ar,
264 struct ath10k_fw_file *fw_file)
269 snprintf(filename, sizeof(filename), "%s/%s",
270 ar->hw_params.fw.dir, ATH10K_FW_UTF_FILE);
272 /* load utf firmware image */
273 ret = request_firmware(&fw_file->firmware, filename, ar->dev);
275 ath10k_warn(ar, "failed to retrieve utf firmware '%s': %d\n",
280 /* We didn't find FW UTF API 1 ("utf.bin") does not advertise
281 * firmware features. Do an ugly hack where we force the firmware
282 * features to match with 10.1 branch so that wmi.c will use the
283 * correct WMI interface.
286 fw_file->wmi_op_version = ATH10K_FW_WMI_OP_VERSION_10_1;
287 fw_file->firmware_data = fw_file->firmware->data;
288 fw_file->firmware_len = fw_file->firmware->size;
293 static int ath10k_tm_fetch_firmware(struct ath10k *ar)
295 struct ath10k_fw_components *utf_mode_fw;
298 ret = ath10k_tm_fetch_utf_firmware_api_2(ar, &ar->testmode.utf_mode_fw.fw_file);
300 ath10k_dbg(ar, ATH10K_DBG_TESTMODE, "testmode using fw utf api 2");
304 ret = ath10k_tm_fetch_utf_firmware_api_1(ar, &ar->testmode.utf_mode_fw.fw_file);
306 ath10k_err(ar, "failed to fetch utf firmware binary: %d", ret);
310 ath10k_dbg(ar, ATH10K_DBG_TESTMODE, "testmode using utf api 1");
313 utf_mode_fw = &ar->testmode.utf_mode_fw;
315 /* Use the same board data file as the normal firmware uses (but
316 * it's still "owned" by normal_mode_fw so we shouldn't free it.
318 utf_mode_fw->board_data = ar->normal_mode_fw.board_data;
319 utf_mode_fw->board_len = ar->normal_mode_fw.board_len;
321 if (!utf_mode_fw->fw_file.otp_data) {
322 ath10k_info(ar, "utf.bin didn't contain otp binary, taking it from the normal mode firmware");
323 utf_mode_fw->fw_file.otp_data = ar->normal_mode_fw.fw_file.otp_data;
324 utf_mode_fw->fw_file.otp_len = ar->normal_mode_fw.fw_file.otp_len;
330 static int ath10k_tm_cmd_utf_start(struct ath10k *ar, struct nlattr *tb[])
335 ath10k_dbg(ar, ATH10K_DBG_TESTMODE, "testmode cmd utf start\n");
337 mutex_lock(&ar->conf_mutex);
339 if (ar->state == ATH10K_STATE_UTF) {
344 /* start utf only when the driver is not in use */
345 if (ar->state != ATH10K_STATE_OFF) {
350 if (WARN_ON(ar->testmode.utf_mode_fw.fw_file.firmware != NULL)) {
351 /* utf image is already downloaded, it shouldn't be */
356 ret = ath10k_tm_fetch_firmware(ar);
358 ath10k_err(ar, "failed to fetch UTF firmware: %d", ret);
362 spin_lock_bh(&ar->data_lock);
363 ar->testmode.utf_monitor = true;
364 spin_unlock_bh(&ar->data_lock);
366 ath10k_dbg(ar, ATH10K_DBG_TESTMODE, "testmode wmi version %d\n",
367 ar->testmode.utf_mode_fw.fw_file.wmi_op_version);
369 ret = ath10k_hif_power_up(ar);
371 ath10k_err(ar, "failed to power up hif (testmode): %d\n", ret);
372 ar->state = ATH10K_STATE_OFF;
373 goto err_release_utf_mode_fw;
376 ret = ath10k_core_start(ar, ATH10K_FIRMWARE_MODE_UTF,
377 &ar->testmode.utf_mode_fw);
379 ath10k_err(ar, "failed to start core (testmode): %d\n", ret);
380 ar->state = ATH10K_STATE_OFF;
384 ar->state = ATH10K_STATE_UTF;
386 if (strlen(ar->testmode.utf_mode_fw.fw_file.fw_version) > 0)
387 ver = ar->testmode.utf_mode_fw.fw_file.fw_version;
391 ath10k_info(ar, "UTF firmware %s started\n", ver);
393 mutex_unlock(&ar->conf_mutex);
398 ath10k_hif_power_down(ar);
400 err_release_utf_mode_fw:
401 release_firmware(ar->testmode.utf_mode_fw.fw_file.firmware);
402 ar->testmode.utf_mode_fw.fw_file.firmware = NULL;
405 mutex_unlock(&ar->conf_mutex);
410 static void __ath10k_tm_cmd_utf_stop(struct ath10k *ar)
412 lockdep_assert_held(&ar->conf_mutex);
414 ath10k_core_stop(ar);
415 ath10k_hif_power_down(ar);
417 spin_lock_bh(&ar->data_lock);
419 ar->testmode.utf_monitor = false;
421 spin_unlock_bh(&ar->data_lock);
423 release_firmware(ar->testmode.utf_mode_fw.fw_file.firmware);
424 ar->testmode.utf_mode_fw.fw_file.firmware = 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);