1 /******************************************************************************
3 * This file is provided under a dual BSD/GPLv2 license. When using or
4 * redistributing this file, you may do so under either license.
8 * Copyright(c) 2010 - 2011 Intel Corporation. All rights reserved.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of version 2 of the GNU General Public License as
12 * published by the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
24 * The full GNU General Public License is included in this distribution
25 * in the file called LICENSE.GPL.
27 * Contact Information:
28 * Intel Linux Wireless <ilw@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2010 - 2011 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
40 * * Redistributions of source code must retain the above copyright
41 * notice, this list of conditions and the following disclaimer.
42 * * Redistributions in binary form must reproduce the above copyright
43 * notice, this list of conditions and the following disclaimer in
44 * the documentation and/or other materials provided with the
46 * * Neither the name Intel Corporation nor the names of its
47 * contributors may be used to endorse or promote products derived
48 * from this software without specific prior written permission.
50 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
54 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
56 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
57 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
58 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
59 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
60 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62 *****************************************************************************/
63 #include <linux/init.h>
64 #include <linux/kernel.h>
65 #include <linux/module.h>
66 #include <net/net_namespace.h>
67 #include <linux/netdevice.h>
68 #include <net/cfg80211.h>
69 #include <net/mac80211.h>
70 #include <net/netlink.h>
75 #include "iwl-debug.h"
79 #include "iwl-testmode.h"
82 /* The TLVs used in the gnl message policy between the kernel module and
83 * user space application. iwl_testmode_gnl_msg_policy is to be carried
84 * through the NL80211_CMD_TESTMODE channel regulated by nl80211.
88 struct nla_policy iwl_testmode_gnl_msg_policy[IWL_TM_ATTR_MAX] = {
89 [IWL_TM_ATTR_COMMAND] = { .type = NLA_U32, },
91 [IWL_TM_ATTR_UCODE_CMD_ID] = { .type = NLA_U8, },
92 [IWL_TM_ATTR_UCODE_CMD_DATA] = { .type = NLA_UNSPEC, },
94 [IWL_TM_ATTR_REG_OFFSET] = { .type = NLA_U32, },
95 [IWL_TM_ATTR_REG_VALUE8] = { .type = NLA_U8, },
96 [IWL_TM_ATTR_REG_VALUE32] = { .type = NLA_U32, },
98 [IWL_TM_ATTR_SYNC_RSP] = { .type = NLA_UNSPEC, },
99 [IWL_TM_ATTR_UCODE_RX_PKT] = { .type = NLA_UNSPEC, },
101 [IWL_TM_ATTR_EEPROM] = { .type = NLA_UNSPEC, },
103 [IWL_TM_ATTR_TRACE_ADDR] = { .type = NLA_UNSPEC, },
104 [IWL_TM_ATTR_TRACE_DATA] = { .type = NLA_UNSPEC, },
106 [IWL_TM_ATTR_FIXRATE] = { .type = NLA_U32, },
110 * See the struct iwl_rx_packet in iwl-commands.h for the format of the
111 * received events from the device
113 static inline int get_event_length(struct iwl_rx_mem_buffer *rxb)
115 struct iwl_rx_packet *pkt = rxb_addr(rxb);
117 return le32_to_cpu(pkt->len_n_flags) & FH_RSCSR_FRAME_SIZE_MSK;
124 * This function multicasts the spontaneous messages from the device to the
125 * user space. It is invoked whenever there is a received messages
126 * from the device. This function is called within the ISR of the rx handlers
129 * The parsing of the message content is left to the user space application,
130 * The message content is treated as unattacked raw data and is encapsulated
131 * with IWL_TM_ATTR_UCODE_RX_PKT multicasting to the user space.
133 * @priv: the instance of iwlwifi device
134 * @rxb: pointer to rx data content received by the ISR
136 * See the message policies and TLVs in iwl_testmode_gnl_msg_policy[].
137 * For the messages multicasting to the user application, the mandatory
139 * IWL_TM_ATTR_COMMAND must be IWL_TM_CMD_DEV2APP_UCODE_RX_PKT
140 * IWL_TM_ATTR_UCODE_RX_PKT for carrying the message content
143 static void iwl_testmode_ucode_rx_pkt(struct iwl_priv *priv,
144 struct iwl_rx_mem_buffer *rxb)
146 struct ieee80211_hw *hw = priv->hw;
151 data = (void *)rxb_addr(rxb);
152 length = get_event_length(rxb);
154 if (!data || length == 0)
157 skb = cfg80211_testmode_alloc_event_skb(hw->wiphy, 20 + length,
161 "Run out of memory for messages to user space ?\n");
164 NLA_PUT_U32(skb, IWL_TM_ATTR_COMMAND, IWL_TM_CMD_DEV2APP_UCODE_RX_PKT);
165 NLA_PUT(skb, IWL_TM_ATTR_UCODE_RX_PKT, length, data);
166 cfg80211_testmode_event(skb, GFP_ATOMIC);
171 IWL_DEBUG_INFO(priv, "Ouch, overran buffer, check allocation!\n");
174 void iwl_testmode_init(struct iwl_priv *priv)
176 priv->pre_rx_handler = iwl_testmode_ucode_rx_pkt;
177 priv->testmode_trace.trace_enabled = false;
180 static void iwl_trace_cleanup(struct iwl_priv *priv)
182 struct device *dev = &priv->pci_dev->dev;
184 if (priv->testmode_trace.trace_enabled) {
185 if (priv->testmode_trace.cpu_addr &&
186 priv->testmode_trace.dma_addr)
187 dma_free_coherent(dev,
189 priv->testmode_trace.cpu_addr,
190 priv->testmode_trace.dma_addr);
191 priv->testmode_trace.trace_enabled = false;
192 priv->testmode_trace.cpu_addr = NULL;
193 priv->testmode_trace.trace_addr = NULL;
194 priv->testmode_trace.dma_addr = 0;
199 void iwl_testmode_cleanup(struct iwl_priv *priv)
201 iwl_trace_cleanup(priv);
205 * This function handles the user application commands to the ucode.
207 * It retrieves the mandatory fields IWL_TM_ATTR_UCODE_CMD_ID and
208 * IWL_TM_ATTR_UCODE_CMD_DATA and calls to the handler to send the
209 * host command to the ucode.
211 * If any mandatory field is missing, -ENOMSG is replied to the user space
212 * application; otherwise, the actual execution result of the host command to
215 * @hw: ieee80211_hw object that represents the device
216 * @tb: gnl message fields from the user space
218 static int iwl_testmode_ucode(struct ieee80211_hw *hw, struct nlattr **tb)
220 struct iwl_priv *priv = hw->priv;
221 struct iwl_host_cmd cmd;
223 memset(&cmd, 0, sizeof(struct iwl_host_cmd));
225 if (!tb[IWL_TM_ATTR_UCODE_CMD_ID] ||
226 !tb[IWL_TM_ATTR_UCODE_CMD_DATA]) {
228 "Error finding ucode command mandatory fields\n");
232 cmd.id = nla_get_u8(tb[IWL_TM_ATTR_UCODE_CMD_ID]);
233 cmd.data[0] = nla_data(tb[IWL_TM_ATTR_UCODE_CMD_DATA]);
234 cmd.len[0] = nla_len(tb[IWL_TM_ATTR_UCODE_CMD_DATA]);
235 cmd.dataflags[0] = IWL_HCMD_DFL_NOCOPY;
236 IWL_INFO(priv, "testmode ucode command ID 0x%x, flags 0x%x,"
237 " len %d\n", cmd.id, cmd.flags, cmd.len[0]);
238 /* ok, let's submit the command to ucode */
239 return iwl_send_cmd(priv, &cmd);
244 * This function handles the user application commands for register access.
246 * It retrieves command ID carried with IWL_TM_ATTR_COMMAND and calls to the
247 * handlers respectively.
249 * If it's an unknown commdn ID, -ENOSYS is returned; or -ENOMSG if the
250 * mandatory fields(IWL_TM_ATTR_REG_OFFSET,IWL_TM_ATTR_REG_VALUE32,
251 * IWL_TM_ATTR_REG_VALUE8) are missing; Otherwise 0 is replied indicating
252 * the success of the command execution.
254 * If IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_REG_READ32, the register read
255 * value is returned with IWL_TM_ATTR_REG_VALUE32.
257 * @hw: ieee80211_hw object that represents the device
258 * @tb: gnl message fields from the user space
260 static int iwl_testmode_reg(struct ieee80211_hw *hw, struct nlattr **tb)
262 struct iwl_priv *priv = hw->priv;
268 if (!tb[IWL_TM_ATTR_REG_OFFSET]) {
269 IWL_DEBUG_INFO(priv, "Error finding register offset\n");
272 ofs = nla_get_u32(tb[IWL_TM_ATTR_REG_OFFSET]);
273 IWL_INFO(priv, "testmode register access command offset 0x%x\n", ofs);
275 switch (nla_get_u32(tb[IWL_TM_ATTR_COMMAND])) {
276 case IWL_TM_CMD_APP2DEV_REG_READ32:
277 val32 = iwl_read32(priv, ofs);
278 IWL_INFO(priv, "32bit value to read 0x%x\n", val32);
280 skb = cfg80211_testmode_alloc_reply_skb(hw->wiphy, 20);
282 IWL_DEBUG_INFO(priv, "Error allocating memory\n");
285 NLA_PUT_U32(skb, IWL_TM_ATTR_REG_VALUE32, val32);
286 status = cfg80211_testmode_reply(skb);
289 "Error sending msg : %d\n", status);
291 case IWL_TM_CMD_APP2DEV_REG_WRITE32:
292 if (!tb[IWL_TM_ATTR_REG_VALUE32]) {
294 "Error finding value to write\n");
297 val32 = nla_get_u32(tb[IWL_TM_ATTR_REG_VALUE32]);
298 IWL_INFO(priv, "32bit value to write 0x%x\n", val32);
299 iwl_write32(priv, ofs, val32);
302 case IWL_TM_CMD_APP2DEV_REG_WRITE8:
303 if (!tb[IWL_TM_ATTR_REG_VALUE8]) {
304 IWL_DEBUG_INFO(priv, "Error finding value to write\n");
307 val8 = nla_get_u8(tb[IWL_TM_ATTR_REG_VALUE8]);
308 IWL_INFO(priv, "8bit value to write 0x%x\n", val8);
309 iwl_write8(priv, ofs, val8);
313 IWL_DEBUG_INFO(priv, "Unknown testmode register command ID\n");
325 static int iwl_testmode_cfg_init_calib(struct iwl_priv *priv)
327 struct iwl_notification_wait calib_wait;
330 iwlagn_init_notification_wait(priv, &calib_wait,
331 CALIBRATION_COMPLETE_NOTIFICATION,
333 ret = iwlagn_init_alive_start(priv);
336 "Error configuring init calibration: %d\n", ret);
337 goto cfg_init_calib_error;
340 ret = iwlagn_wait_notification(priv, &calib_wait, 2 * HZ);
342 IWL_DEBUG_INFO(priv, "Error detecting"
343 " CALIBRATION_COMPLETE_NOTIFICATION: %d\n", ret);
346 cfg_init_calib_error:
347 iwlagn_remove_notification(priv, &calib_wait);
352 * This function handles the user application commands for driver.
354 * It retrieves command ID carried with IWL_TM_ATTR_COMMAND and calls to the
355 * handlers respectively.
357 * If it's an unknown commdn ID, -ENOSYS is replied; otherwise, the returned
358 * value of the actual command execution is replied to the user application.
360 * If there's any message responding to the user space, IWL_TM_ATTR_SYNC_RSP
361 * is used for carry the message while IWL_TM_ATTR_COMMAND must set to
362 * IWL_TM_CMD_DEV2APP_SYNC_RSP.
364 * @hw: ieee80211_hw object that represents the device
365 * @tb: gnl message fields from the user space
367 static int iwl_testmode_driver(struct ieee80211_hw *hw, struct nlattr **tb)
369 struct iwl_priv *priv = hw->priv;
371 unsigned char *rsp_data_ptr = NULL;
372 int status = 0, rsp_data_len = 0;
374 switch (nla_get_u32(tb[IWL_TM_ATTR_COMMAND])) {
375 case IWL_TM_CMD_APP2DEV_GET_DEVICENAME:
376 rsp_data_ptr = (unsigned char *)priv->cfg->name;
377 rsp_data_len = strlen(priv->cfg->name);
378 skb = cfg80211_testmode_alloc_reply_skb(hw->wiphy,
382 "Error allocating memory\n");
385 NLA_PUT_U32(skb, IWL_TM_ATTR_COMMAND,
386 IWL_TM_CMD_DEV2APP_SYNC_RSP);
387 NLA_PUT(skb, IWL_TM_ATTR_SYNC_RSP,
388 rsp_data_len, rsp_data_ptr);
389 status = cfg80211_testmode_reply(skb);
391 IWL_DEBUG_INFO(priv, "Error sending msg : %d\n",
395 case IWL_TM_CMD_APP2DEV_LOAD_INIT_FW:
396 status = iwlagn_load_ucode_wait_alive(priv, &priv->ucode_init,
397 UCODE_SUBTYPE_INIT, -1);
400 "Error loading init ucode: %d\n", status);
403 case IWL_TM_CMD_APP2DEV_CFG_INIT_CALIB:
404 iwl_testmode_cfg_init_calib(priv);
405 iwlagn_stop_device(priv);
408 case IWL_TM_CMD_APP2DEV_LOAD_RUNTIME_FW:
409 status = iwlagn_load_ucode_wait_alive(priv,
411 UCODE_SUBTYPE_REGULAR,
412 UCODE_SUBTYPE_REGULAR_NEW);
415 "Error loading runtime ucode: %d\n", status);
418 status = iwl_alive_start(priv);
421 "Error starting the device: %d\n", status);
424 case IWL_TM_CMD_APP2DEV_GET_EEPROM:
426 skb = cfg80211_testmode_alloc_reply_skb(hw->wiphy,
427 priv->cfg->base_params->eeprom_size + 20);
430 "Error allocating memory\n");
433 NLA_PUT_U32(skb, IWL_TM_ATTR_COMMAND,
434 IWL_TM_CMD_DEV2APP_EEPROM_RSP);
435 NLA_PUT(skb, IWL_TM_ATTR_EEPROM,
436 priv->cfg->base_params->eeprom_size,
438 status = cfg80211_testmode_reply(skb);
441 "Error sending msg : %d\n",
447 case IWL_TM_CMD_APP2DEV_FIXRATE_REQ:
448 if (!tb[IWL_TM_ATTR_FIXRATE]) {
450 "Error finding fixrate setting\n");
453 priv->dbg_fixed_rate = nla_get_u32(tb[IWL_TM_ATTR_FIXRATE]);
457 IWL_DEBUG_INFO(priv, "Unknown testmode driver command ID\n");
469 * This function handles the user application commands for uCode trace
471 * It retrieves command ID carried with IWL_TM_ATTR_COMMAND and calls to the
472 * handlers respectively.
474 * If it's an unknown commdn ID, -ENOSYS is replied; otherwise, the returned
475 * value of the actual command execution is replied to the user application.
477 * @hw: ieee80211_hw object that represents the device
478 * @tb: gnl message fields from the user space
480 static int iwl_testmode_trace(struct ieee80211_hw *hw, struct nlattr **tb)
482 struct iwl_priv *priv = hw->priv;
485 struct device *dev = &priv->pci_dev->dev;
487 switch (nla_get_u32(tb[IWL_TM_ATTR_COMMAND])) {
488 case IWL_TM_CMD_APP2DEV_BEGIN_TRACE:
489 if (priv->testmode_trace.trace_enabled)
492 priv->testmode_trace.cpu_addr =
493 dma_alloc_coherent(dev,
495 &priv->testmode_trace.dma_addr,
497 if (!priv->testmode_trace.cpu_addr)
499 priv->testmode_trace.trace_enabled = true;
500 priv->testmode_trace.trace_addr = (u8 *)PTR_ALIGN(
501 priv->testmode_trace.cpu_addr, 0x100);
502 memset(priv->testmode_trace.trace_addr, 0x03B,
504 skb = cfg80211_testmode_alloc_reply_skb(hw->wiphy,
505 sizeof(priv->testmode_trace.dma_addr) + 20);
508 "Error allocating memory\n");
509 iwl_trace_cleanup(priv);
512 NLA_PUT(skb, IWL_TM_ATTR_TRACE_ADDR,
513 sizeof(priv->testmode_trace.dma_addr),
514 (u64 *)&priv->testmode_trace.dma_addr);
515 status = cfg80211_testmode_reply(skb);
518 "Error sending msg : %d\n",
523 case IWL_TM_CMD_APP2DEV_END_TRACE:
524 iwl_trace_cleanup(priv);
527 case IWL_TM_CMD_APP2DEV_READ_TRACE:
528 if (priv->testmode_trace.trace_enabled &&
529 priv->testmode_trace.trace_addr) {
530 skb = cfg80211_testmode_alloc_reply_skb(hw->wiphy,
531 20 + TRACE_BUFF_SIZE);
534 "Error allocating memory\n");
537 NLA_PUT(skb, IWL_TM_ATTR_TRACE_DATA,
539 priv->testmode_trace.trace_addr);
540 status = cfg80211_testmode_reply(skb);
543 "Error sending msg : %d\n", status);
550 IWL_DEBUG_INFO(priv, "Unknown testmode mem command ID\n");
557 if (nla_get_u32(tb[IWL_TM_ATTR_COMMAND]) ==
558 IWL_TM_CMD_APP2DEV_BEGIN_TRACE)
559 iwl_trace_cleanup(priv);
563 /* The testmode gnl message handler that takes the gnl message from the
564 * user space and parses it per the policy iwl_testmode_gnl_msg_policy, then
565 * invoke the corresponding handlers.
567 * This function is invoked when there is user space application sending
568 * gnl message through the testmode tunnel NL80211_CMD_TESTMODE regulated
571 * It retrieves the mandatory field, IWL_TM_ATTR_COMMAND, before
572 * dispatching it to the corresponding handler.
574 * If IWL_TM_ATTR_COMMAND is missing, -ENOMSG is replied to user application;
575 * -ENOSYS is replied to the user application if the command is unknown;
576 * Otherwise, the command is dispatched to the respective handler.
578 * @hw: ieee80211_hw object that represents the device
579 * @data: pointer to user space message
580 * @len: length in byte of @data
582 int iwl_testmode_cmd(struct ieee80211_hw *hw, void *data, int len)
584 struct nlattr *tb[IWL_TM_ATTR_MAX - 1];
585 struct iwl_priv *priv = hw->priv;
588 result = nla_parse(tb, IWL_TM_ATTR_MAX - 1, data, len,
589 iwl_testmode_gnl_msg_policy);
592 "Error parsing the gnl message : %d\n", result);
596 /* IWL_TM_ATTR_COMMAND is absolutely mandatory */
597 if (!tb[IWL_TM_ATTR_COMMAND]) {
598 IWL_DEBUG_INFO(priv, "Error finding testmode command type\n");
601 /* in case multiple accesses to the device happens */
602 mutex_lock(&priv->mutex);
604 switch (nla_get_u32(tb[IWL_TM_ATTR_COMMAND])) {
605 case IWL_TM_CMD_APP2DEV_UCODE:
606 IWL_DEBUG_INFO(priv, "testmode cmd to uCode\n");
607 result = iwl_testmode_ucode(hw, tb);
609 case IWL_TM_CMD_APP2DEV_REG_READ32:
610 case IWL_TM_CMD_APP2DEV_REG_WRITE32:
611 case IWL_TM_CMD_APP2DEV_REG_WRITE8:
612 IWL_DEBUG_INFO(priv, "testmode cmd to register\n");
613 result = iwl_testmode_reg(hw, tb);
615 case IWL_TM_CMD_APP2DEV_GET_DEVICENAME:
616 case IWL_TM_CMD_APP2DEV_LOAD_INIT_FW:
617 case IWL_TM_CMD_APP2DEV_CFG_INIT_CALIB:
618 case IWL_TM_CMD_APP2DEV_LOAD_RUNTIME_FW:
619 case IWL_TM_CMD_APP2DEV_GET_EEPROM:
620 case IWL_TM_CMD_APP2DEV_FIXRATE_REQ:
621 IWL_DEBUG_INFO(priv, "testmode cmd to driver\n");
622 result = iwl_testmode_driver(hw, tb);
625 case IWL_TM_CMD_APP2DEV_BEGIN_TRACE:
626 case IWL_TM_CMD_APP2DEV_END_TRACE:
627 case IWL_TM_CMD_APP2DEV_READ_TRACE:
628 IWL_DEBUG_INFO(priv, "testmode uCode trace cmd to driver\n");
629 result = iwl_testmode_trace(hw, tb);
633 IWL_DEBUG_INFO(priv, "Unknown testmode command\n");
638 mutex_unlock(&priv->mutex);