2 * This file is part of wl1271
4 * Copyright (C) 2009-2010 Nokia Corporation
6 * Contact: Luciano Coelho <luciano.coelho@nokia.com>
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * version 2 as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
24 #include <linux/module.h>
25 #include <linux/platform_device.h>
26 #include <linux/crc7.h>
27 #include <linux/spi/spi.h>
28 #include <linux/etherdevice.h>
29 #include <linux/ieee80211.h>
30 #include <linux/slab.h>
33 #include "wl1271_reg.h"
34 #include "wl1271_io.h"
35 #include "wl1271_acx.h"
36 #include "wl12xx_80211.h"
37 #include "wl1271_cmd.h"
38 #include "wl1271_event.h"
40 #define WL1271_CMD_FAST_POLL_COUNT 50
43 * send command to firmware
47 * @buf: buffer containing the command, must work with dma
48 * @len: length of the buffer
50 int wl1271_cmd_send(struct wl1271 *wl, u16 id, void *buf, size_t len,
53 struct wl1271_cmd_header *cmd;
54 unsigned long timeout;
61 cmd->id = cpu_to_le16(id);
64 WARN_ON(len % 4 != 0);
66 wl1271_write(wl, wl->cmd_box_addr, buf, len, false);
68 wl1271_write32(wl, ACX_REG_INTERRUPT_TRIG, INTR_TRIG_CMD);
70 timeout = jiffies + msecs_to_jiffies(WL1271_COMMAND_TIMEOUT);
72 intr = wl1271_read32(wl, ACX_REG_INTERRUPT_NO_CLEAR);
73 while (!(intr & WL1271_ACX_INTR_CMD_COMPLETE)) {
74 if (time_after(jiffies, timeout)) {
75 wl1271_error("command complete timeout");
81 if (poll_count < WL1271_CMD_FAST_POLL_COUNT)
86 intr = wl1271_read32(wl, ACX_REG_INTERRUPT_NO_CLEAR);
89 /* read back the status code of the command */
91 res_len = sizeof(struct wl1271_cmd_header);
92 wl1271_read(wl, wl->cmd_box_addr, cmd, res_len, false);
94 status = le16_to_cpu(cmd->status);
95 if (status != CMD_STATUS_SUCCESS) {
96 wl1271_error("command execute failure %d", status);
100 wl1271_write32(wl, ACX_REG_INTERRUPT_ACK,
101 WL1271_ACX_INTR_CMD_COMPLETE);
107 int wl1271_cmd_general_parms(struct wl1271 *wl)
109 struct wl1271_general_parms_cmd *gen_parms;
115 gen_parms = kzalloc(sizeof(*gen_parms), GFP_KERNEL);
119 gen_parms->test.id = TEST_CMD_INI_FILE_GENERAL_PARAM;
121 memcpy(&gen_parms->general_params, &wl->nvs->general_params,
122 sizeof(struct wl1271_ini_general_params));
124 ret = wl1271_cmd_test(wl, gen_parms, sizeof(*gen_parms), 0);
126 wl1271_warning("CMD_INI_FILE_GENERAL_PARAM failed");
132 int wl1271_cmd_radio_parms(struct wl1271 *wl)
134 struct wl1271_radio_parms_cmd *radio_parms;
135 struct wl1271_ini_general_params *gp = &wl->nvs->general_params;
141 radio_parms = kzalloc(sizeof(*radio_parms), GFP_KERNEL);
145 radio_parms->test.id = TEST_CMD_INI_FILE_RADIO_PARAM;
147 /* 2.4GHz parameters */
148 memcpy(&radio_parms->static_params_2, &wl->nvs->stat_radio_params_2,
149 sizeof(struct wl1271_ini_band_params_2));
150 memcpy(&radio_parms->dyn_params_2,
151 &wl->nvs->dyn_radio_params_2[gp->tx_bip_fem_manufacturer].params,
152 sizeof(struct wl1271_ini_fem_params_2));
154 /* 5GHz parameters */
155 memcpy(&radio_parms->static_params_5,
156 &wl->nvs->stat_radio_params_5,
157 sizeof(struct wl1271_ini_band_params_5));
158 memcpy(&radio_parms->dyn_params_5,
159 &wl->nvs->dyn_radio_params_5[gp->tx_bip_fem_manufacturer].params,
160 sizeof(struct wl1271_ini_fem_params_5));
162 wl1271_dump(DEBUG_CMD, "TEST_CMD_INI_FILE_RADIO_PARAM: ",
163 radio_parms, sizeof(*radio_parms));
165 ret = wl1271_cmd_test(wl, radio_parms, sizeof(*radio_parms), 0);
167 wl1271_warning("CMD_INI_FILE_RADIO_PARAM failed");
174 * Poll the mailbox event field until any of the bits in the mask is set or a
175 * timeout occurs (WL1271_EVENT_TIMEOUT in msecs)
177 static int wl1271_cmd_wait_for_event(struct wl1271 *wl, u32 mask)
179 u32 events_vector, event;
180 unsigned long timeout;
182 timeout = jiffies + msecs_to_jiffies(WL1271_EVENT_TIMEOUT);
185 if (time_after(jiffies, timeout))
190 /* read from both event fields */
191 wl1271_read(wl, wl->mbox_ptr[0], &events_vector,
192 sizeof(events_vector), false);
193 event = events_vector & mask;
194 wl1271_read(wl, wl->mbox_ptr[1], &events_vector,
195 sizeof(events_vector), false);
196 event |= events_vector & mask;
202 int wl1271_cmd_join(struct wl1271 *wl, u8 bss_type)
204 struct wl1271_cmd_join *join;
208 join = kzalloc(sizeof(*join), GFP_KERNEL);
214 wl1271_debug(DEBUG_CMD, "cmd join");
216 /* Reverse order BSSID */
217 bssid = (u8 *) &join->bssid_lsb;
218 for (i = 0; i < ETH_ALEN; i++)
219 bssid[i] = wl->bssid[ETH_ALEN - i - 1];
221 join->rx_config_options = cpu_to_le32(wl->rx_config);
222 join->rx_filter_options = cpu_to_le32(wl->rx_filter);
223 join->bss_type = bss_type;
224 join->basic_rate_set = cpu_to_le32(wl->basic_rate_set);
226 if (wl->band == IEEE80211_BAND_5GHZ)
227 join->bss_type |= WL1271_JOIN_CMD_BSS_TYPE_5GHZ;
229 join->beacon_interval = cpu_to_le16(wl->beacon_int);
230 join->dtim_interval = WL1271_DEFAULT_DTIM_PERIOD;
232 join->channel = wl->channel;
233 join->ssid_len = wl->ssid_len;
234 memcpy(join->ssid, wl->ssid, wl->ssid_len);
236 join->ctrl |= wl->session_counter << WL1271_JOIN_CMD_TX_SESSION_OFFSET;
238 /* reset TX security counters */
239 wl->tx_security_last_seq = 0;
240 wl->tx_security_seq = 0;
242 ret = wl1271_cmd_send(wl, CMD_START_JOIN, join, sizeof(*join), 0);
244 wl1271_error("failed to initiate cmd join");
248 ret = wl1271_cmd_wait_for_event(wl, JOIN_EVENT_COMPLETE_ID);
250 wl1271_error("cmd join event completion error");
260 * send test command to firmware
263 * @buf: buffer containing the command, with all headers, must work with dma
264 * @len: length of the buffer
265 * @answer: is answer needed
267 int wl1271_cmd_test(struct wl1271 *wl, void *buf, size_t buf_len, u8 answer)
272 wl1271_debug(DEBUG_CMD, "cmd test");
277 ret = wl1271_cmd_send(wl, CMD_TEST, buf, buf_len, res_len);
280 wl1271_warning("TEST command failed");
288 * read acx from firmware
292 * @buf: buffer for the response, including all headers, must work with dma
293 * @len: lenght of buf
295 int wl1271_cmd_interrogate(struct wl1271 *wl, u16 id, void *buf, size_t len)
297 struct acx_header *acx = buf;
300 wl1271_debug(DEBUG_CMD, "cmd interrogate");
302 acx->id = cpu_to_le16(id);
304 /* payload length, does not include any headers */
305 acx->len = cpu_to_le16(len - sizeof(*acx));
307 ret = wl1271_cmd_send(wl, CMD_INTERROGATE, acx, sizeof(*acx), len);
309 wl1271_error("INTERROGATE command failed");
315 * write acx value to firmware
319 * @buf: buffer containing acx, including all headers, must work with dma
320 * @len: length of buf
322 int wl1271_cmd_configure(struct wl1271 *wl, u16 id, void *buf, size_t len)
324 struct acx_header *acx = buf;
327 wl1271_debug(DEBUG_CMD, "cmd configure");
329 acx->id = cpu_to_le16(id);
331 /* payload length, does not include any headers */
332 acx->len = cpu_to_le16(len - sizeof(*acx));
334 ret = wl1271_cmd_send(wl, CMD_CONFIGURE, acx, len, 0);
336 wl1271_warning("CONFIGURE command NOK");
343 int wl1271_cmd_data_path(struct wl1271 *wl, bool enable)
345 struct cmd_enabledisable_path *cmd;
349 wl1271_debug(DEBUG_CMD, "cmd data path");
351 cmd = kzalloc(sizeof(*cmd), GFP_KERNEL);
357 /* the channel here is only used for calibration, so hardcoded to 1 */
361 cmd_rx = CMD_ENABLE_RX;
362 cmd_tx = CMD_ENABLE_TX;
364 cmd_rx = CMD_DISABLE_RX;
365 cmd_tx = CMD_DISABLE_TX;
368 ret = wl1271_cmd_send(wl, cmd_rx, cmd, sizeof(*cmd), 0);
370 wl1271_error("rx %s cmd for channel %d failed",
371 enable ? "start" : "stop", cmd->channel);
375 wl1271_debug(DEBUG_BOOT, "rx %s cmd channel %d",
376 enable ? "start" : "stop", cmd->channel);
378 ret = wl1271_cmd_send(wl, cmd_tx, cmd, sizeof(*cmd), 0);
380 wl1271_error("tx %s cmd for channel %d failed",
381 enable ? "start" : "stop", cmd->channel);
385 wl1271_debug(DEBUG_BOOT, "tx %s cmd channel %d",
386 enable ? "start" : "stop", cmd->channel);
393 int wl1271_cmd_ps_mode(struct wl1271 *wl, u8 ps_mode, bool send)
395 struct wl1271_cmd_ps_params *ps_params = NULL;
398 /* FIXME: this should be in ps.c */
399 ret = wl1271_acx_wake_up_conditions(wl);
401 wl1271_error("couldn't set wake up conditions");
405 wl1271_debug(DEBUG_CMD, "cmd set ps mode");
407 ps_params = kzalloc(sizeof(*ps_params), GFP_KERNEL);
413 ps_params->ps_mode = ps_mode;
414 ps_params->send_null_data = send;
415 ps_params->retries = 5;
416 ps_params->hang_over_period = 1;
417 ps_params->null_data_rate = cpu_to_le32(wl->basic_rate_set);
419 ret = wl1271_cmd_send(wl, CMD_SET_PS_MODE, ps_params,
420 sizeof(*ps_params), 0);
422 wl1271_error("cmd set_ps_mode failed");
431 int wl1271_cmd_read_memory(struct wl1271 *wl, u32 addr, void *answer,
434 struct cmd_read_write_memory *cmd;
437 wl1271_debug(DEBUG_CMD, "cmd read memory");
439 cmd = kzalloc(sizeof(*cmd), GFP_KERNEL);
445 WARN_ON(len > MAX_READ_SIZE);
446 len = min_t(size_t, len, MAX_READ_SIZE);
448 cmd->addr = cpu_to_le32(addr);
449 cmd->size = cpu_to_le32(len);
451 ret = wl1271_cmd_send(wl, CMD_READ_MEMORY, cmd, sizeof(*cmd),
454 wl1271_error("read memory command failed: %d", ret);
458 /* the read command got in */
459 memcpy(answer, cmd->value, len);
466 int wl1271_cmd_template_set(struct wl1271 *wl, u16 template_id,
467 void *buf, size_t buf_len, int index, u32 rates)
469 struct wl1271_cmd_template_set *cmd;
472 wl1271_debug(DEBUG_CMD, "cmd template_set %d", template_id);
474 WARN_ON(buf_len > WL1271_CMD_TEMPL_MAX_SIZE);
475 buf_len = min_t(size_t, buf_len, WL1271_CMD_TEMPL_MAX_SIZE);
477 cmd = kzalloc(sizeof(*cmd), GFP_KERNEL);
483 cmd->len = cpu_to_le16(buf_len);
484 cmd->template_type = template_id;
485 cmd->enabled_rates = cpu_to_le32(rates);
486 cmd->short_retry_limit = wl->conf.tx.rc_conf.short_retry_limit;
487 cmd->long_retry_limit = wl->conf.tx.rc_conf.long_retry_limit;
491 memcpy(cmd->template_data, buf, buf_len);
493 ret = wl1271_cmd_send(wl, CMD_SET_TEMPLATE, cmd, sizeof(*cmd), 0);
495 wl1271_warning("cmd set_template failed: %d", ret);
506 int wl1271_cmd_build_null_data(struct wl1271 *wl)
508 struct sk_buff *skb = NULL;
514 if (wl->bss_type == BSS_TYPE_IBSS) {
515 size = sizeof(struct wl12xx_null_data_template);
518 skb = ieee80211_nullfunc_get(wl->hw, wl->vif);
525 ret = wl1271_cmd_template_set(wl, CMD_TEMPL_NULL_DATA, ptr, size, 0,
526 WL1271_RATE_AUTOMATIC);
531 wl1271_warning("cmd buld null data failed %d", ret);
537 int wl1271_cmd_build_klv_null_data(struct wl1271 *wl)
539 struct sk_buff *skb = NULL;
542 skb = ieee80211_nullfunc_get(wl->hw, wl->vif);
546 ret = wl1271_cmd_template_set(wl, CMD_TEMPL_KLV,
548 CMD_TEMPL_KLV_IDX_NULL_DATA,
549 WL1271_RATE_AUTOMATIC);
554 wl1271_warning("cmd build klv null data failed %d", ret);
560 int wl1271_cmd_build_ps_poll(struct wl1271 *wl, u16 aid)
565 skb = ieee80211_pspoll_get(wl->hw, wl->vif);
569 ret = wl1271_cmd_template_set(wl, CMD_TEMPL_PS_POLL, skb->data,
570 skb->len, 0, wl->basic_rate_set);
577 int wl1271_cmd_build_probe_req(struct wl1271 *wl,
578 const u8 *ssid, size_t ssid_len,
579 const u8 *ie, size_t ie_len, u8 band)
584 skb = ieee80211_probereq_get(wl->hw, wl->vif, ssid, ssid_len,
591 wl1271_dump(DEBUG_SCAN, "PROBE REQ: ", skb->data, skb->len);
593 if (band == IEEE80211_BAND_2GHZ)
594 ret = wl1271_cmd_template_set(wl, CMD_TEMPL_CFG_PROBE_REQ_2_4,
595 skb->data, skb->len, 0,
596 wl->conf.tx.basic_rate);
598 ret = wl1271_cmd_template_set(wl, CMD_TEMPL_CFG_PROBE_REQ_5,
599 skb->data, skb->len, 0,
600 wl->conf.tx.basic_rate_5);
607 int wl1271_build_qos_null_data(struct wl1271 *wl)
609 struct ieee80211_qos_hdr template;
611 memset(&template, 0, sizeof(template));
613 memcpy(template.addr1, wl->bssid, ETH_ALEN);
614 memcpy(template.addr2, wl->mac_addr, ETH_ALEN);
615 memcpy(template.addr3, wl->bssid, ETH_ALEN);
617 template.frame_control = cpu_to_le16(IEEE80211_FTYPE_DATA |
618 IEEE80211_STYPE_QOS_NULLFUNC |
619 IEEE80211_FCTL_TODS);
621 /* FIXME: not sure what priority to use here */
622 template.qos_ctrl = cpu_to_le16(0);
624 return wl1271_cmd_template_set(wl, CMD_TEMPL_QOS_NULL_DATA, &template,
626 WL1271_RATE_AUTOMATIC);
629 int wl1271_cmd_set_default_wep_key(struct wl1271 *wl, u8 id)
631 struct wl1271_cmd_set_keys *cmd;
634 wl1271_debug(DEBUG_CMD, "cmd set_default_wep_key %d", id);
636 cmd = kzalloc(sizeof(*cmd), GFP_KERNEL);
643 cmd->key_action = cpu_to_le16(KEY_SET_ID);
644 cmd->key_type = KEY_WEP;
646 ret = wl1271_cmd_send(wl, CMD_SET_KEYS, cmd, sizeof(*cmd), 0);
648 wl1271_warning("cmd set_default_wep_key failed: %d", ret);
658 int wl1271_cmd_set_key(struct wl1271 *wl, u16 action, u8 id, u8 key_type,
659 u8 key_size, const u8 *key, const u8 *addr,
660 u32 tx_seq_32, u16 tx_seq_16)
662 struct wl1271_cmd_set_keys *cmd;
665 cmd = kzalloc(sizeof(*cmd), GFP_KERNEL);
671 if (key_type != KEY_WEP)
672 memcpy(cmd->addr, addr, ETH_ALEN);
674 cmd->key_action = cpu_to_le16(action);
675 cmd->key_size = key_size;
676 cmd->key_type = key_type;
678 cmd->ac_seq_num16[0] = cpu_to_le16(tx_seq_16);
679 cmd->ac_seq_num32[0] = cpu_to_le32(tx_seq_32);
681 /* we have only one SSID profile */
682 cmd->ssid_profile = 0;
686 if (key_type == KEY_TKIP) {
688 * We get the key in the following form:
689 * TKIP (16 bytes) - TX MIC (8 bytes) - RX MIC (8 bytes)
690 * but the target is expecting:
691 * TKIP - RX MIC - TX MIC
693 memcpy(cmd->key, key, 16);
694 memcpy(cmd->key + 16, key + 24, 8);
695 memcpy(cmd->key + 24, key + 16, 8);
698 memcpy(cmd->key, key, key_size);
701 wl1271_dump(DEBUG_CRYPT, "TARGET KEY: ", cmd, sizeof(*cmd));
703 ret = wl1271_cmd_send(wl, CMD_SET_KEYS, cmd, sizeof(*cmd), 0);
705 wl1271_warning("could not set keys");
715 int wl1271_cmd_disconnect(struct wl1271 *wl)
717 struct wl1271_cmd_disconnect *cmd;
720 wl1271_debug(DEBUG_CMD, "cmd disconnect");
722 cmd = kzalloc(sizeof(*cmd), GFP_KERNEL);
728 cmd->rx_config_options = cpu_to_le32(wl->rx_config);
729 cmd->rx_filter_options = cpu_to_le32(wl->rx_filter);
730 /* disconnect reason is not used in immediate disconnections */
731 cmd->type = DISCONNECT_IMMEDIATE;
733 ret = wl1271_cmd_send(wl, CMD_DISCONNECT, cmd, sizeof(*cmd), 0);
735 wl1271_error("failed to send disconnect command");
739 ret = wl1271_cmd_wait_for_event(wl, DISCONNECT_EVENT_COMPLETE_ID);
741 wl1271_error("cmd disconnect event completion error");
750 int wl1271_cmd_set_sta_state(struct wl1271 *wl)
752 struct wl1271_cmd_set_sta_state *cmd;
755 wl1271_debug(DEBUG_CMD, "cmd set sta state");
757 cmd = kzalloc(sizeof(*cmd), GFP_KERNEL);
763 cmd->state = WL1271_CMD_STA_STATE_CONNECTED;
765 ret = wl1271_cmd_send(wl, CMD_SET_STA_STATE, cmd, sizeof(*cmd), 0);
767 wl1271_error("failed to send set STA state command");