Merge tag 'v3.3.7' into 3.3/master
[zen-stable.git] / drivers / net / wireless / wl1251 / main.c
blob40c1574ce1df7a9a3f9780f4838c029e0523ec73
1 /*
2 * This file is part of wl1251
4 * Copyright (C) 2008-2009 Nokia Corporation
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * version 2 as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18 * 02110-1301 USA
22 #include <linux/module.h>
23 #include <linux/interrupt.h>
24 #include <linux/firmware.h>
25 #include <linux/delay.h>
26 #include <linux/irq.h>
27 #include <linux/crc32.h>
28 #include <linux/etherdevice.h>
29 #include <linux/vmalloc.h>
30 #include <linux/slab.h>
32 #include "wl1251.h"
33 #include "wl12xx_80211.h"
34 #include "reg.h"
35 #include "io.h"
36 #include "cmd.h"
37 #include "event.h"
38 #include "tx.h"
39 #include "rx.h"
40 #include "ps.h"
41 #include "init.h"
42 #include "debugfs.h"
43 #include "boot.h"
45 void wl1251_enable_interrupts(struct wl1251 *wl)
47 wl->if_ops->enable_irq(wl);
50 void wl1251_disable_interrupts(struct wl1251 *wl)
52 wl->if_ops->disable_irq(wl);
55 static int wl1251_power_off(struct wl1251 *wl)
57 return wl->if_ops->power(wl, false);
60 static int wl1251_power_on(struct wl1251 *wl)
62 return wl->if_ops->power(wl, true);
65 static int wl1251_fetch_firmware(struct wl1251 *wl)
67 const struct firmware *fw;
68 struct device *dev = wiphy_dev(wl->hw->wiphy);
69 int ret;
71 ret = request_firmware(&fw, WL1251_FW_NAME, dev);
73 if (ret < 0) {
74 wl1251_error("could not get firmware: %d", ret);
75 return ret;
78 if (fw->size % 4) {
79 wl1251_error("firmware size is not multiple of 32 bits: %zu",
80 fw->size);
81 ret = -EILSEQ;
82 goto out;
85 wl->fw_len = fw->size;
86 wl->fw = vmalloc(wl->fw_len);
88 if (!wl->fw) {
89 wl1251_error("could not allocate memory for the firmware");
90 ret = -ENOMEM;
91 goto out;
94 memcpy(wl->fw, fw->data, wl->fw_len);
96 ret = 0;
98 out:
99 release_firmware(fw);
101 return ret;
104 static int wl1251_fetch_nvs(struct wl1251 *wl)
106 const struct firmware *fw;
107 struct device *dev = wiphy_dev(wl->hw->wiphy);
108 int ret;
110 ret = request_firmware(&fw, WL1251_NVS_NAME, dev);
112 if (ret < 0) {
113 wl1251_error("could not get nvs file: %d", ret);
114 return ret;
117 if (fw->size % 4) {
118 wl1251_error("nvs size is not multiple of 32 bits: %zu",
119 fw->size);
120 ret = -EILSEQ;
121 goto out;
124 wl->nvs_len = fw->size;
125 wl->nvs = kmemdup(fw->data, wl->nvs_len, GFP_KERNEL);
127 if (!wl->nvs) {
128 wl1251_error("could not allocate memory for the nvs file");
129 ret = -ENOMEM;
130 goto out;
133 ret = 0;
135 out:
136 release_firmware(fw);
138 return ret;
141 static void wl1251_fw_wakeup(struct wl1251 *wl)
143 u32 elp_reg;
145 elp_reg = ELPCTRL_WAKE_UP;
146 wl1251_write_elp(wl, HW_ACCESS_ELP_CTRL_REG_ADDR, elp_reg);
147 elp_reg = wl1251_read_elp(wl, HW_ACCESS_ELP_CTRL_REG_ADDR);
149 if (!(elp_reg & ELPCTRL_WLAN_READY))
150 wl1251_warning("WLAN not ready");
153 static int wl1251_chip_wakeup(struct wl1251 *wl)
155 int ret;
157 ret = wl1251_power_on(wl);
158 if (ret < 0)
159 return ret;
161 msleep(WL1251_POWER_ON_SLEEP);
162 wl->if_ops->reset(wl);
164 /* We don't need a real memory partition here, because we only want
165 * to use the registers at this point. */
166 wl1251_set_partition(wl,
167 0x00000000,
168 0x00000000,
169 REGISTERS_BASE,
170 REGISTERS_DOWN_SIZE);
172 /* ELP module wake up */
173 wl1251_fw_wakeup(wl);
175 /* whal_FwCtrl_BootSm() */
177 /* 0. read chip id from CHIP_ID */
178 wl->chip_id = wl1251_reg_read32(wl, CHIP_ID_B);
180 /* 1. check if chip id is valid */
182 switch (wl->chip_id) {
183 case CHIP_ID_1251_PG12:
184 wl1251_debug(DEBUG_BOOT, "chip id 0x%x (1251 PG12)",
185 wl->chip_id);
186 break;
187 case CHIP_ID_1251_PG11:
188 wl1251_debug(DEBUG_BOOT, "chip id 0x%x (1251 PG11)",
189 wl->chip_id);
190 break;
191 case CHIP_ID_1251_PG10:
192 default:
193 wl1251_error("unsupported chip id: 0x%x", wl->chip_id);
194 ret = -ENODEV;
195 goto out;
198 if (wl->fw == NULL) {
199 ret = wl1251_fetch_firmware(wl);
200 if (ret < 0)
201 goto out;
204 if (wl->nvs == NULL && !wl->use_eeprom) {
205 /* No NVS from netlink, try to get it from the filesystem */
206 ret = wl1251_fetch_nvs(wl);
207 if (ret < 0)
208 goto out;
211 out:
212 return ret;
215 #define WL1251_IRQ_LOOP_COUNT 10
216 static void wl1251_irq_work(struct work_struct *work)
218 u32 intr, ctr = WL1251_IRQ_LOOP_COUNT;
219 struct wl1251 *wl =
220 container_of(work, struct wl1251, irq_work);
221 int ret;
223 mutex_lock(&wl->mutex);
225 wl1251_debug(DEBUG_IRQ, "IRQ work");
227 if (wl->state == WL1251_STATE_OFF)
228 goto out;
230 ret = wl1251_ps_elp_wakeup(wl);
231 if (ret < 0)
232 goto out;
234 wl1251_reg_write32(wl, ACX_REG_INTERRUPT_MASK, WL1251_ACX_INTR_ALL);
236 intr = wl1251_reg_read32(wl, ACX_REG_INTERRUPT_CLEAR);
237 wl1251_debug(DEBUG_IRQ, "intr: 0x%x", intr);
239 do {
240 if (wl->data_path) {
241 wl->rx_counter = wl1251_mem_read32(
242 wl, wl->data_path->rx_control_addr);
244 /* We handle a frmware bug here */
245 switch ((wl->rx_counter - wl->rx_handled) & 0xf) {
246 case 0:
247 wl1251_debug(DEBUG_IRQ,
248 "RX: FW and host in sync");
249 intr &= ~WL1251_ACX_INTR_RX0_DATA;
250 intr &= ~WL1251_ACX_INTR_RX1_DATA;
251 break;
252 case 1:
253 wl1251_debug(DEBUG_IRQ, "RX: FW +1");
254 intr |= WL1251_ACX_INTR_RX0_DATA;
255 intr &= ~WL1251_ACX_INTR_RX1_DATA;
256 break;
257 case 2:
258 wl1251_debug(DEBUG_IRQ, "RX: FW +2");
259 intr |= WL1251_ACX_INTR_RX0_DATA;
260 intr |= WL1251_ACX_INTR_RX1_DATA;
261 break;
262 default:
263 wl1251_warning(
264 "RX: FW and host out of sync: %d",
265 wl->rx_counter - wl->rx_handled);
266 break;
269 wl->rx_handled = wl->rx_counter;
271 wl1251_debug(DEBUG_IRQ, "RX counter: %d",
272 wl->rx_counter);
275 intr &= wl->intr_mask;
277 if (intr == 0) {
278 wl1251_debug(DEBUG_IRQ, "INTR is 0");
279 goto out_sleep;
282 if (intr & WL1251_ACX_INTR_RX0_DATA) {
283 wl1251_debug(DEBUG_IRQ, "WL1251_ACX_INTR_RX0_DATA");
284 wl1251_rx(wl);
287 if (intr & WL1251_ACX_INTR_RX1_DATA) {
288 wl1251_debug(DEBUG_IRQ, "WL1251_ACX_INTR_RX1_DATA");
289 wl1251_rx(wl);
292 if (intr & WL1251_ACX_INTR_TX_RESULT) {
293 wl1251_debug(DEBUG_IRQ, "WL1251_ACX_INTR_TX_RESULT");
294 wl1251_tx_complete(wl);
297 if (intr & WL1251_ACX_INTR_EVENT_A) {
298 wl1251_debug(DEBUG_IRQ, "WL1251_ACX_INTR_EVENT_A");
299 wl1251_event_handle(wl, 0);
302 if (intr & WL1251_ACX_INTR_EVENT_B) {
303 wl1251_debug(DEBUG_IRQ, "WL1251_ACX_INTR_EVENT_B");
304 wl1251_event_handle(wl, 1);
307 if (intr & WL1251_ACX_INTR_INIT_COMPLETE)
308 wl1251_debug(DEBUG_IRQ,
309 "WL1251_ACX_INTR_INIT_COMPLETE");
311 if (--ctr == 0)
312 break;
314 intr = wl1251_reg_read32(wl, ACX_REG_INTERRUPT_CLEAR);
315 } while (intr);
317 out_sleep:
318 wl1251_reg_write32(wl, ACX_REG_INTERRUPT_MASK, ~(wl->intr_mask));
319 wl1251_ps_elp_sleep(wl);
321 out:
322 mutex_unlock(&wl->mutex);
325 static int wl1251_join(struct wl1251 *wl, u8 bss_type, u8 channel,
326 u16 beacon_interval, u8 dtim_period)
328 int ret;
330 ret = wl1251_acx_frame_rates(wl, DEFAULT_HW_GEN_TX_RATE,
331 DEFAULT_HW_GEN_MODULATION_TYPE,
332 wl->tx_mgmt_frm_rate,
333 wl->tx_mgmt_frm_mod);
334 if (ret < 0)
335 goto out;
338 ret = wl1251_cmd_join(wl, bss_type, channel, beacon_interval,
339 dtim_period);
340 if (ret < 0)
341 goto out;
343 ret = wl1251_event_wait(wl, JOIN_EVENT_COMPLETE_ID, 100);
344 if (ret < 0)
345 wl1251_warning("join timeout");
347 out:
348 return ret;
351 static void wl1251_filter_work(struct work_struct *work)
353 struct wl1251 *wl =
354 container_of(work, struct wl1251, filter_work);
355 int ret;
357 mutex_lock(&wl->mutex);
359 if (wl->state == WL1251_STATE_OFF)
360 goto out;
362 ret = wl1251_ps_elp_wakeup(wl);
363 if (ret < 0)
364 goto out;
366 ret = wl1251_join(wl, wl->bss_type, wl->channel, wl->beacon_int,
367 wl->dtim_period);
368 if (ret < 0)
369 goto out_sleep;
371 out_sleep:
372 wl1251_ps_elp_sleep(wl);
374 out:
375 mutex_unlock(&wl->mutex);
378 static void wl1251_op_tx(struct ieee80211_hw *hw, struct sk_buff *skb)
380 struct wl1251 *wl = hw->priv;
381 unsigned long flags;
383 skb_queue_tail(&wl->tx_queue, skb);
386 * The chip specific setup must run before the first TX packet -
387 * before that, the tx_work will not be initialized!
390 ieee80211_queue_work(wl->hw, &wl->tx_work);
393 * The workqueue is slow to process the tx_queue and we need stop
394 * the queue here, otherwise the queue will get too long.
396 if (skb_queue_len(&wl->tx_queue) >= WL1251_TX_QUEUE_HIGH_WATERMARK) {
397 wl1251_debug(DEBUG_TX, "op_tx: tx_queue full, stop queues");
399 spin_lock_irqsave(&wl->wl_lock, flags);
400 ieee80211_stop_queues(wl->hw);
401 wl->tx_queue_stopped = true;
402 spin_unlock_irqrestore(&wl->wl_lock, flags);
406 static int wl1251_op_start(struct ieee80211_hw *hw)
408 struct wl1251 *wl = hw->priv;
409 struct wiphy *wiphy = hw->wiphy;
410 int ret = 0;
412 wl1251_debug(DEBUG_MAC80211, "mac80211 start");
414 mutex_lock(&wl->mutex);
416 if (wl->state != WL1251_STATE_OFF) {
417 wl1251_error("cannot start because not in off state: %d",
418 wl->state);
419 ret = -EBUSY;
420 goto out;
423 ret = wl1251_chip_wakeup(wl);
424 if (ret < 0)
425 goto out;
427 ret = wl1251_boot(wl);
428 if (ret < 0)
429 goto out;
431 ret = wl1251_hw_init(wl);
432 if (ret < 0)
433 goto out;
435 ret = wl1251_acx_station_id(wl);
436 if (ret < 0)
437 goto out;
439 wl->state = WL1251_STATE_ON;
441 wl1251_info("firmware booted (%s)", wl->fw_ver);
443 /* update hw/fw version info in wiphy struct */
444 wiphy->hw_version = wl->chip_id;
445 strncpy(wiphy->fw_version, wl->fw_ver, sizeof(wiphy->fw_version));
447 out:
448 if (ret < 0)
449 wl1251_power_off(wl);
451 mutex_unlock(&wl->mutex);
453 return ret;
456 static void wl1251_op_stop(struct ieee80211_hw *hw)
458 struct wl1251 *wl = hw->priv;
460 wl1251_info("down");
462 wl1251_debug(DEBUG_MAC80211, "mac80211 stop");
464 mutex_lock(&wl->mutex);
466 WARN_ON(wl->state != WL1251_STATE_ON);
468 if (wl->scanning) {
469 ieee80211_scan_completed(wl->hw, true);
470 wl->scanning = false;
473 wl->state = WL1251_STATE_OFF;
475 wl1251_disable_interrupts(wl);
477 mutex_unlock(&wl->mutex);
479 cancel_work_sync(&wl->irq_work);
480 cancel_work_sync(&wl->tx_work);
481 cancel_work_sync(&wl->filter_work);
482 cancel_delayed_work_sync(&wl->elp_work);
484 mutex_lock(&wl->mutex);
486 /* let's notify MAC80211 about the remaining pending TX frames */
487 wl1251_tx_flush(wl);
488 wl1251_power_off(wl);
490 memset(wl->bssid, 0, ETH_ALEN);
491 wl->listen_int = 1;
492 wl->bss_type = MAX_BSS_TYPE;
494 wl->data_in_count = 0;
495 wl->rx_counter = 0;
496 wl->rx_handled = 0;
497 wl->rx_current_buffer = 0;
498 wl->rx_last_id = 0;
499 wl->next_tx_complete = 0;
500 wl->elp = false;
501 wl->station_mode = STATION_ACTIVE_MODE;
502 wl->tx_queue_stopped = false;
503 wl->power_level = WL1251_DEFAULT_POWER_LEVEL;
504 wl->rssi_thold = 0;
505 wl->channel = WL1251_DEFAULT_CHANNEL;
507 wl1251_debugfs_reset(wl);
509 mutex_unlock(&wl->mutex);
512 static int wl1251_op_add_interface(struct ieee80211_hw *hw,
513 struct ieee80211_vif *vif)
515 struct wl1251 *wl = hw->priv;
516 int ret = 0;
518 wl1251_debug(DEBUG_MAC80211, "mac80211 add interface type %d mac %pM",
519 vif->type, vif->addr);
521 mutex_lock(&wl->mutex);
522 if (wl->vif) {
523 ret = -EBUSY;
524 goto out;
527 wl->vif = vif;
529 switch (vif->type) {
530 case NL80211_IFTYPE_STATION:
531 wl->bss_type = BSS_TYPE_STA_BSS;
532 break;
533 case NL80211_IFTYPE_ADHOC:
534 wl->bss_type = BSS_TYPE_IBSS;
535 break;
536 default:
537 ret = -EOPNOTSUPP;
538 goto out;
541 if (memcmp(wl->mac_addr, vif->addr, ETH_ALEN)) {
542 memcpy(wl->mac_addr, vif->addr, ETH_ALEN);
543 SET_IEEE80211_PERM_ADDR(wl->hw, wl->mac_addr);
544 ret = wl1251_acx_station_id(wl);
545 if (ret < 0)
546 goto out;
549 out:
550 mutex_unlock(&wl->mutex);
551 return ret;
554 static void wl1251_op_remove_interface(struct ieee80211_hw *hw,
555 struct ieee80211_vif *vif)
557 struct wl1251 *wl = hw->priv;
559 mutex_lock(&wl->mutex);
560 wl1251_debug(DEBUG_MAC80211, "mac80211 remove interface");
561 wl->vif = NULL;
562 mutex_unlock(&wl->mutex);
565 static int wl1251_build_qos_null_data(struct wl1251 *wl)
567 struct ieee80211_qos_hdr template;
569 memset(&template, 0, sizeof(template));
571 memcpy(template.addr1, wl->bssid, ETH_ALEN);
572 memcpy(template.addr2, wl->mac_addr, ETH_ALEN);
573 memcpy(template.addr3, wl->bssid, ETH_ALEN);
575 template.frame_control = cpu_to_le16(IEEE80211_FTYPE_DATA |
576 IEEE80211_STYPE_QOS_NULLFUNC |
577 IEEE80211_FCTL_TODS);
579 /* FIXME: not sure what priority to use here */
580 template.qos_ctrl = cpu_to_le16(0);
582 return wl1251_cmd_template_set(wl, CMD_QOS_NULL_DATA, &template,
583 sizeof(template));
586 static int wl1251_op_config(struct ieee80211_hw *hw, u32 changed)
588 struct wl1251 *wl = hw->priv;
589 struct ieee80211_conf *conf = &hw->conf;
590 int channel, ret = 0;
592 channel = ieee80211_frequency_to_channel(conf->channel->center_freq);
594 wl1251_debug(DEBUG_MAC80211, "mac80211 config ch %d psm %s power %d",
595 channel,
596 conf->flags & IEEE80211_CONF_PS ? "on" : "off",
597 conf->power_level);
599 mutex_lock(&wl->mutex);
601 ret = wl1251_ps_elp_wakeup(wl);
602 if (ret < 0)
603 goto out;
605 if (channel != wl->channel) {
606 wl->channel = channel;
608 ret = wl1251_join(wl, wl->bss_type, wl->channel,
609 wl->beacon_int, wl->dtim_period);
610 if (ret < 0)
611 goto out_sleep;
614 if (conf->flags & IEEE80211_CONF_PS && !wl->psm_requested) {
615 wl1251_debug(DEBUG_PSM, "psm enabled");
617 wl->psm_requested = true;
619 wl->dtim_period = conf->ps_dtim_period;
621 ret = wl1251_acx_wr_tbtt_and_dtim(wl, wl->beacon_int,
622 wl->dtim_period);
625 * mac80211 enables PSM only if we're already associated.
627 ret = wl1251_ps_set_mode(wl, STATION_POWER_SAVE_MODE);
628 if (ret < 0)
629 goto out_sleep;
630 } else if (!(conf->flags & IEEE80211_CONF_PS) &&
631 wl->psm_requested) {
632 wl1251_debug(DEBUG_PSM, "psm disabled");
634 wl->psm_requested = false;
636 if (wl->station_mode != STATION_ACTIVE_MODE) {
637 ret = wl1251_ps_set_mode(wl, STATION_ACTIVE_MODE);
638 if (ret < 0)
639 goto out_sleep;
643 if (changed & IEEE80211_CONF_CHANGE_IDLE) {
644 if (conf->flags & IEEE80211_CONF_IDLE) {
645 ret = wl1251_ps_set_mode(wl, STATION_IDLE);
646 if (ret < 0)
647 goto out_sleep;
648 } else {
649 ret = wl1251_ps_set_mode(wl, STATION_ACTIVE_MODE);
650 if (ret < 0)
651 goto out_sleep;
652 ret = wl1251_join(wl, wl->bss_type, wl->channel,
653 wl->beacon_int, wl->dtim_period);
654 if (ret < 0)
655 goto out_sleep;
659 if (conf->power_level != wl->power_level) {
660 ret = wl1251_acx_tx_power(wl, conf->power_level);
661 if (ret < 0)
662 goto out_sleep;
664 wl->power_level = conf->power_level;
667 out_sleep:
668 wl1251_ps_elp_sleep(wl);
670 out:
671 mutex_unlock(&wl->mutex);
673 return ret;
676 #define WL1251_SUPPORTED_FILTERS (FIF_PROMISC_IN_BSS | \
677 FIF_ALLMULTI | \
678 FIF_FCSFAIL | \
679 FIF_BCN_PRBRESP_PROMISC | \
680 FIF_CONTROL | \
681 FIF_OTHER_BSS)
683 static void wl1251_op_configure_filter(struct ieee80211_hw *hw,
684 unsigned int changed,
685 unsigned int *total,u64 multicast)
687 struct wl1251 *wl = hw->priv;
689 wl1251_debug(DEBUG_MAC80211, "mac80211 configure filter");
691 *total &= WL1251_SUPPORTED_FILTERS;
692 changed &= WL1251_SUPPORTED_FILTERS;
694 if (changed == 0)
695 /* no filters which we support changed */
696 return;
698 /* FIXME: wl->rx_config and wl->rx_filter are not protected */
700 wl->rx_config = WL1251_DEFAULT_RX_CONFIG;
701 wl->rx_filter = WL1251_DEFAULT_RX_FILTER;
703 if (*total & FIF_PROMISC_IN_BSS) {
704 wl->rx_config |= CFG_BSSID_FILTER_EN;
705 wl->rx_config |= CFG_RX_ALL_GOOD;
707 if (*total & FIF_ALLMULTI)
709 * CFG_MC_FILTER_EN in rx_config needs to be 0 to receive
710 * all multicast frames
712 wl->rx_config &= ~CFG_MC_FILTER_EN;
713 if (*total & FIF_FCSFAIL)
714 wl->rx_filter |= CFG_RX_FCS_ERROR;
715 if (*total & FIF_BCN_PRBRESP_PROMISC) {
716 wl->rx_config &= ~CFG_BSSID_FILTER_EN;
717 wl->rx_config &= ~CFG_SSID_FILTER_EN;
719 if (*total & FIF_CONTROL)
720 wl->rx_filter |= CFG_RX_CTL_EN;
721 if (*total & FIF_OTHER_BSS)
722 wl->rx_filter &= ~CFG_BSSID_FILTER_EN;
725 * FIXME: workqueues need to be properly cancelled on stop(), for
726 * now let's just disable changing the filter settings. They will
727 * be updated any on config().
729 /* schedule_work(&wl->filter_work); */
732 /* HW encryption */
733 static int wl1251_set_key_type(struct wl1251 *wl,
734 struct wl1251_cmd_set_keys *key,
735 enum set_key_cmd cmd,
736 struct ieee80211_key_conf *mac80211_key,
737 const u8 *addr)
739 switch (mac80211_key->cipher) {
740 case WLAN_CIPHER_SUITE_WEP40:
741 case WLAN_CIPHER_SUITE_WEP104:
742 if (is_broadcast_ether_addr(addr))
743 key->key_type = KEY_WEP_DEFAULT;
744 else
745 key->key_type = KEY_WEP_ADDR;
747 mac80211_key->hw_key_idx = mac80211_key->keyidx;
748 break;
749 case WLAN_CIPHER_SUITE_TKIP:
750 if (is_broadcast_ether_addr(addr))
751 key->key_type = KEY_TKIP_MIC_GROUP;
752 else
753 key->key_type = KEY_TKIP_MIC_PAIRWISE;
755 mac80211_key->hw_key_idx = mac80211_key->keyidx;
756 break;
757 case WLAN_CIPHER_SUITE_CCMP:
758 if (is_broadcast_ether_addr(addr))
759 key->key_type = KEY_AES_GROUP;
760 else
761 key->key_type = KEY_AES_PAIRWISE;
762 mac80211_key->flags |= IEEE80211_KEY_FLAG_GENERATE_IV;
763 break;
764 default:
765 wl1251_error("Unknown key cipher 0x%x", mac80211_key->cipher);
766 return -EOPNOTSUPP;
769 return 0;
772 static int wl1251_op_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd,
773 struct ieee80211_vif *vif,
774 struct ieee80211_sta *sta,
775 struct ieee80211_key_conf *key)
777 struct wl1251 *wl = hw->priv;
778 struct wl1251_cmd_set_keys *wl_cmd;
779 const u8 *addr;
780 int ret;
782 static const u8 bcast_addr[ETH_ALEN] =
783 { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
785 wl1251_debug(DEBUG_MAC80211, "mac80211 set key");
787 wl_cmd = kzalloc(sizeof(*wl_cmd), GFP_KERNEL);
788 if (!wl_cmd) {
789 ret = -ENOMEM;
790 goto out;
793 addr = sta ? sta->addr : bcast_addr;
795 wl1251_debug(DEBUG_CRYPT, "CMD: 0x%x", cmd);
796 wl1251_dump(DEBUG_CRYPT, "ADDR: ", addr, ETH_ALEN);
797 wl1251_debug(DEBUG_CRYPT, "Key: algo:0x%x, id:%d, len:%d flags 0x%x",
798 key->cipher, key->keyidx, key->keylen, key->flags);
799 wl1251_dump(DEBUG_CRYPT, "KEY: ", key->key, key->keylen);
801 if (is_zero_ether_addr(addr)) {
802 /* We dont support TX only encryption */
803 ret = -EOPNOTSUPP;
804 goto out;
807 mutex_lock(&wl->mutex);
809 ret = wl1251_ps_elp_wakeup(wl);
810 if (ret < 0)
811 goto out_unlock;
813 switch (cmd) {
814 case SET_KEY:
815 wl_cmd->key_action = KEY_ADD_OR_REPLACE;
816 break;
817 case DISABLE_KEY:
818 wl_cmd->key_action = KEY_REMOVE;
819 break;
820 default:
821 wl1251_error("Unsupported key cmd 0x%x", cmd);
822 break;
825 ret = wl1251_set_key_type(wl, wl_cmd, cmd, key, addr);
826 if (ret < 0) {
827 wl1251_error("Set KEY type failed");
828 goto out_sleep;
831 if (wl_cmd->key_type != KEY_WEP_DEFAULT)
832 memcpy(wl_cmd->addr, addr, ETH_ALEN);
834 if ((wl_cmd->key_type == KEY_TKIP_MIC_GROUP) ||
835 (wl_cmd->key_type == KEY_TKIP_MIC_PAIRWISE)) {
837 * We get the key in the following form:
838 * TKIP (16 bytes) - TX MIC (8 bytes) - RX MIC (8 bytes)
839 * but the target is expecting:
840 * TKIP - RX MIC - TX MIC
842 memcpy(wl_cmd->key, key->key, 16);
843 memcpy(wl_cmd->key + 16, key->key + 24, 8);
844 memcpy(wl_cmd->key + 24, key->key + 16, 8);
846 } else {
847 memcpy(wl_cmd->key, key->key, key->keylen);
849 wl_cmd->key_size = key->keylen;
851 wl_cmd->id = key->keyidx;
852 wl_cmd->ssid_profile = 0;
854 wl1251_dump(DEBUG_CRYPT, "TARGET KEY: ", wl_cmd, sizeof(*wl_cmd));
856 ret = wl1251_cmd_send(wl, CMD_SET_KEYS, wl_cmd, sizeof(*wl_cmd));
857 if (ret < 0) {
858 wl1251_warning("could not set keys");
859 goto out_sleep;
862 out_sleep:
863 wl1251_ps_elp_sleep(wl);
865 out_unlock:
866 mutex_unlock(&wl->mutex);
868 out:
869 kfree(wl_cmd);
871 return ret;
874 static int wl1251_op_hw_scan(struct ieee80211_hw *hw,
875 struct ieee80211_vif *vif,
876 struct cfg80211_scan_request *req)
878 struct wl1251 *wl = hw->priv;
879 struct sk_buff *skb;
880 size_t ssid_len = 0;
881 u8 *ssid = NULL;
882 int ret;
884 wl1251_debug(DEBUG_MAC80211, "mac80211 hw scan");
886 if (req->n_ssids) {
887 ssid = req->ssids[0].ssid;
888 ssid_len = req->ssids[0].ssid_len;
891 mutex_lock(&wl->mutex);
893 if (wl->scanning) {
894 wl1251_debug(DEBUG_SCAN, "scan already in progress");
895 ret = -EINVAL;
896 goto out;
899 ret = wl1251_ps_elp_wakeup(wl);
900 if (ret < 0)
901 goto out;
903 skb = ieee80211_probereq_get(wl->hw, wl->vif, ssid, ssid_len,
904 req->ie, req->ie_len);
905 if (!skb) {
906 ret = -ENOMEM;
907 goto out;
910 ret = wl1251_cmd_template_set(wl, CMD_PROBE_REQ, skb->data,
911 skb->len);
912 dev_kfree_skb(skb);
913 if (ret < 0)
914 goto out_sleep;
916 ret = wl1251_cmd_trigger_scan_to(wl, 0);
917 if (ret < 0)
918 goto out_sleep;
920 wl->scanning = true;
922 ret = wl1251_cmd_scan(wl, ssid, ssid_len, req->channels,
923 req->n_channels, WL1251_SCAN_NUM_PROBES);
924 if (ret < 0) {
925 wl->scanning = false;
926 goto out_sleep;
929 out_sleep:
930 wl1251_ps_elp_sleep(wl);
932 out:
933 mutex_unlock(&wl->mutex);
935 return ret;
938 static int wl1251_op_set_rts_threshold(struct ieee80211_hw *hw, u32 value)
940 struct wl1251 *wl = hw->priv;
941 int ret;
943 mutex_lock(&wl->mutex);
945 ret = wl1251_ps_elp_wakeup(wl);
946 if (ret < 0)
947 goto out;
949 ret = wl1251_acx_rts_threshold(wl, (u16) value);
950 if (ret < 0)
951 wl1251_warning("wl1251_op_set_rts_threshold failed: %d", ret);
953 wl1251_ps_elp_sleep(wl);
955 out:
956 mutex_unlock(&wl->mutex);
958 return ret;
961 static void wl1251_op_bss_info_changed(struct ieee80211_hw *hw,
962 struct ieee80211_vif *vif,
963 struct ieee80211_bss_conf *bss_conf,
964 u32 changed)
966 struct wl1251 *wl = hw->priv;
967 struct sk_buff *beacon, *skb;
968 int ret;
970 wl1251_debug(DEBUG_MAC80211, "mac80211 bss info changed");
972 mutex_lock(&wl->mutex);
974 ret = wl1251_ps_elp_wakeup(wl);
975 if (ret < 0)
976 goto out;
978 if (changed & BSS_CHANGED_CQM) {
979 ret = wl1251_acx_low_rssi(wl, bss_conf->cqm_rssi_thold,
980 WL1251_DEFAULT_LOW_RSSI_WEIGHT,
981 WL1251_DEFAULT_LOW_RSSI_DEPTH,
982 WL1251_ACX_LOW_RSSI_TYPE_EDGE);
983 if (ret < 0)
984 goto out;
985 wl->rssi_thold = bss_conf->cqm_rssi_thold;
988 if (changed & BSS_CHANGED_BSSID) {
989 memcpy(wl->bssid, bss_conf->bssid, ETH_ALEN);
991 skb = ieee80211_nullfunc_get(wl->hw, wl->vif);
992 if (!skb)
993 goto out_sleep;
995 ret = wl1251_cmd_template_set(wl, CMD_NULL_DATA,
996 skb->data, skb->len);
997 dev_kfree_skb(skb);
998 if (ret < 0)
999 goto out_sleep;
1001 ret = wl1251_build_qos_null_data(wl);
1002 if (ret < 0)
1003 goto out;
1005 if (wl->bss_type != BSS_TYPE_IBSS) {
1006 ret = wl1251_join(wl, wl->bss_type, wl->channel,
1007 wl->beacon_int, wl->dtim_period);
1008 if (ret < 0)
1009 goto out_sleep;
1013 if (changed & BSS_CHANGED_ASSOC) {
1014 if (bss_conf->assoc) {
1015 wl->beacon_int = bss_conf->beacon_int;
1017 skb = ieee80211_pspoll_get(wl->hw, wl->vif);
1018 if (!skb)
1019 goto out_sleep;
1021 ret = wl1251_cmd_template_set(wl, CMD_PS_POLL,
1022 skb->data,
1023 skb->len);
1024 dev_kfree_skb(skb);
1025 if (ret < 0)
1026 goto out_sleep;
1028 ret = wl1251_acx_aid(wl, bss_conf->aid);
1029 if (ret < 0)
1030 goto out_sleep;
1031 } else {
1032 /* use defaults when not associated */
1033 wl->beacon_int = WL1251_DEFAULT_BEACON_INT;
1034 wl->dtim_period = WL1251_DEFAULT_DTIM_PERIOD;
1037 if (changed & BSS_CHANGED_ERP_SLOT) {
1038 if (bss_conf->use_short_slot)
1039 ret = wl1251_acx_slot(wl, SLOT_TIME_SHORT);
1040 else
1041 ret = wl1251_acx_slot(wl, SLOT_TIME_LONG);
1042 if (ret < 0) {
1043 wl1251_warning("Set slot time failed %d", ret);
1044 goto out_sleep;
1048 if (changed & BSS_CHANGED_ERP_PREAMBLE) {
1049 if (bss_conf->use_short_preamble)
1050 wl1251_acx_set_preamble(wl, ACX_PREAMBLE_SHORT);
1051 else
1052 wl1251_acx_set_preamble(wl, ACX_PREAMBLE_LONG);
1055 if (changed & BSS_CHANGED_ERP_CTS_PROT) {
1056 if (bss_conf->use_cts_prot)
1057 ret = wl1251_acx_cts_protect(wl, CTSPROTECT_ENABLE);
1058 else
1059 ret = wl1251_acx_cts_protect(wl, CTSPROTECT_DISABLE);
1060 if (ret < 0) {
1061 wl1251_warning("Set ctsprotect failed %d", ret);
1062 goto out_sleep;
1066 if (changed & BSS_CHANGED_BEACON) {
1067 beacon = ieee80211_beacon_get(hw, vif);
1068 if (!beacon)
1069 goto out_sleep;
1071 ret = wl1251_cmd_template_set(wl, CMD_BEACON, beacon->data,
1072 beacon->len);
1074 if (ret < 0) {
1075 dev_kfree_skb(beacon);
1076 goto out_sleep;
1079 ret = wl1251_cmd_template_set(wl, CMD_PROBE_RESP, beacon->data,
1080 beacon->len);
1082 dev_kfree_skb(beacon);
1084 if (ret < 0)
1085 goto out_sleep;
1087 ret = wl1251_join(wl, wl->bss_type, wl->beacon_int,
1088 wl->channel, wl->dtim_period);
1090 if (ret < 0)
1091 goto out_sleep;
1094 out_sleep:
1095 wl1251_ps_elp_sleep(wl);
1097 out:
1098 mutex_unlock(&wl->mutex);
1102 /* can't be const, mac80211 writes to this */
1103 static struct ieee80211_rate wl1251_rates[] = {
1104 { .bitrate = 10,
1105 .hw_value = 0x1,
1106 .hw_value_short = 0x1, },
1107 { .bitrate = 20,
1108 .hw_value = 0x2,
1109 .hw_value_short = 0x2,
1110 .flags = IEEE80211_RATE_SHORT_PREAMBLE },
1111 { .bitrate = 55,
1112 .hw_value = 0x4,
1113 .hw_value_short = 0x4,
1114 .flags = IEEE80211_RATE_SHORT_PREAMBLE },
1115 { .bitrate = 110,
1116 .hw_value = 0x20,
1117 .hw_value_short = 0x20,
1118 .flags = IEEE80211_RATE_SHORT_PREAMBLE },
1119 { .bitrate = 60,
1120 .hw_value = 0x8,
1121 .hw_value_short = 0x8, },
1122 { .bitrate = 90,
1123 .hw_value = 0x10,
1124 .hw_value_short = 0x10, },
1125 { .bitrate = 120,
1126 .hw_value = 0x40,
1127 .hw_value_short = 0x40, },
1128 { .bitrate = 180,
1129 .hw_value = 0x80,
1130 .hw_value_short = 0x80, },
1131 { .bitrate = 240,
1132 .hw_value = 0x200,
1133 .hw_value_short = 0x200, },
1134 { .bitrate = 360,
1135 .hw_value = 0x400,
1136 .hw_value_short = 0x400, },
1137 { .bitrate = 480,
1138 .hw_value = 0x800,
1139 .hw_value_short = 0x800, },
1140 { .bitrate = 540,
1141 .hw_value = 0x1000,
1142 .hw_value_short = 0x1000, },
1145 /* can't be const, mac80211 writes to this */
1146 static struct ieee80211_channel wl1251_channels[] = {
1147 { .hw_value = 1, .center_freq = 2412},
1148 { .hw_value = 2, .center_freq = 2417},
1149 { .hw_value = 3, .center_freq = 2422},
1150 { .hw_value = 4, .center_freq = 2427},
1151 { .hw_value = 5, .center_freq = 2432},
1152 { .hw_value = 6, .center_freq = 2437},
1153 { .hw_value = 7, .center_freq = 2442},
1154 { .hw_value = 8, .center_freq = 2447},
1155 { .hw_value = 9, .center_freq = 2452},
1156 { .hw_value = 10, .center_freq = 2457},
1157 { .hw_value = 11, .center_freq = 2462},
1158 { .hw_value = 12, .center_freq = 2467},
1159 { .hw_value = 13, .center_freq = 2472},
1162 static int wl1251_op_conf_tx(struct ieee80211_hw *hw,
1163 struct ieee80211_vif *vif, u16 queue,
1164 const struct ieee80211_tx_queue_params *params)
1166 enum wl1251_acx_ps_scheme ps_scheme;
1167 struct wl1251 *wl = hw->priv;
1168 int ret;
1170 mutex_lock(&wl->mutex);
1172 wl1251_debug(DEBUG_MAC80211, "mac80211 conf tx %d", queue);
1174 ret = wl1251_ps_elp_wakeup(wl);
1175 if (ret < 0)
1176 goto out;
1178 /* mac80211 uses units of 32 usec */
1179 ret = wl1251_acx_ac_cfg(wl, wl1251_tx_get_queue(queue),
1180 params->cw_min, params->cw_max,
1181 params->aifs, params->txop * 32);
1182 if (ret < 0)
1183 goto out_sleep;
1185 if (params->uapsd)
1186 ps_scheme = WL1251_ACX_PS_SCHEME_UPSD_TRIGGER;
1187 else
1188 ps_scheme = WL1251_ACX_PS_SCHEME_LEGACY;
1190 ret = wl1251_acx_tid_cfg(wl, wl1251_tx_get_queue(queue),
1191 CHANNEL_TYPE_EDCF,
1192 wl1251_tx_get_queue(queue), ps_scheme,
1193 WL1251_ACX_ACK_POLICY_LEGACY);
1194 if (ret < 0)
1195 goto out_sleep;
1197 out_sleep:
1198 wl1251_ps_elp_sleep(wl);
1200 out:
1201 mutex_unlock(&wl->mutex);
1203 return ret;
1206 static int wl1251_op_get_survey(struct ieee80211_hw *hw, int idx,
1207 struct survey_info *survey)
1209 struct wl1251 *wl = hw->priv;
1210 struct ieee80211_conf *conf = &hw->conf;
1212 if (idx != 0)
1213 return -ENOENT;
1215 survey->channel = conf->channel;
1216 survey->filled = SURVEY_INFO_NOISE_DBM;
1217 survey->noise = wl->noise;
1219 return 0;
1222 /* can't be const, mac80211 writes to this */
1223 static struct ieee80211_supported_band wl1251_band_2ghz = {
1224 .channels = wl1251_channels,
1225 .n_channels = ARRAY_SIZE(wl1251_channels),
1226 .bitrates = wl1251_rates,
1227 .n_bitrates = ARRAY_SIZE(wl1251_rates),
1230 static const struct ieee80211_ops wl1251_ops = {
1231 .start = wl1251_op_start,
1232 .stop = wl1251_op_stop,
1233 .add_interface = wl1251_op_add_interface,
1234 .remove_interface = wl1251_op_remove_interface,
1235 .config = wl1251_op_config,
1236 .configure_filter = wl1251_op_configure_filter,
1237 .tx = wl1251_op_tx,
1238 .set_key = wl1251_op_set_key,
1239 .hw_scan = wl1251_op_hw_scan,
1240 .bss_info_changed = wl1251_op_bss_info_changed,
1241 .set_rts_threshold = wl1251_op_set_rts_threshold,
1242 .conf_tx = wl1251_op_conf_tx,
1243 .get_survey = wl1251_op_get_survey,
1246 static int wl1251_read_eeprom_byte(struct wl1251 *wl, off_t offset, u8 *data)
1248 unsigned long timeout;
1250 wl1251_reg_write32(wl, EE_ADDR, offset);
1251 wl1251_reg_write32(wl, EE_CTL, EE_CTL_READ);
1253 /* EE_CTL_READ clears when data is ready */
1254 timeout = jiffies + msecs_to_jiffies(100);
1255 while (1) {
1256 if (!(wl1251_reg_read32(wl, EE_CTL) & EE_CTL_READ))
1257 break;
1259 if (time_after(jiffies, timeout))
1260 return -ETIMEDOUT;
1262 msleep(1);
1265 *data = wl1251_reg_read32(wl, EE_DATA);
1266 return 0;
1269 static int wl1251_read_eeprom(struct wl1251 *wl, off_t offset,
1270 u8 *data, size_t len)
1272 size_t i;
1273 int ret;
1275 wl1251_reg_write32(wl, EE_START, 0);
1277 for (i = 0; i < len; i++) {
1278 ret = wl1251_read_eeprom_byte(wl, offset + i, &data[i]);
1279 if (ret < 0)
1280 return ret;
1283 return 0;
1286 static int wl1251_read_eeprom_mac(struct wl1251 *wl)
1288 u8 mac[ETH_ALEN];
1289 int i, ret;
1291 wl1251_set_partition(wl, 0, 0, REGISTERS_BASE, REGISTERS_DOWN_SIZE);
1293 ret = wl1251_read_eeprom(wl, 0x1c, mac, sizeof(mac));
1294 if (ret < 0) {
1295 wl1251_warning("failed to read MAC address from EEPROM");
1296 return ret;
1299 /* MAC is stored in reverse order */
1300 for (i = 0; i < ETH_ALEN; i++)
1301 wl->mac_addr[i] = mac[ETH_ALEN - i - 1];
1303 return 0;
1306 static int wl1251_register_hw(struct wl1251 *wl)
1308 int ret;
1310 if (wl->mac80211_registered)
1311 return 0;
1313 SET_IEEE80211_PERM_ADDR(wl->hw, wl->mac_addr);
1315 ret = ieee80211_register_hw(wl->hw);
1316 if (ret < 0) {
1317 wl1251_error("unable to register mac80211 hw: %d", ret);
1318 return ret;
1321 wl->mac80211_registered = true;
1323 wl1251_notice("loaded");
1325 return 0;
1328 int wl1251_init_ieee80211(struct wl1251 *wl)
1330 int ret;
1332 /* The tx descriptor buffer and the TKIP space */
1333 wl->hw->extra_tx_headroom = sizeof(struct tx_double_buffer_desc)
1334 + WL1251_TKIP_IV_SPACE;
1336 /* unit us */
1337 /* FIXME: find a proper value */
1338 wl->hw->channel_change_time = 10000;
1340 wl->hw->flags = IEEE80211_HW_SIGNAL_DBM |
1341 IEEE80211_HW_SUPPORTS_PS |
1342 IEEE80211_HW_BEACON_FILTER |
1343 IEEE80211_HW_SUPPORTS_UAPSD |
1344 IEEE80211_HW_SUPPORTS_CQM_RSSI;
1346 wl->hw->wiphy->interface_modes = BIT(NL80211_IFTYPE_STATION) |
1347 BIT(NL80211_IFTYPE_ADHOC);
1348 wl->hw->wiphy->max_scan_ssids = 1;
1349 wl->hw->wiphy->bands[IEEE80211_BAND_2GHZ] = &wl1251_band_2ghz;
1351 wl->hw->queues = 4;
1353 if (wl->use_eeprom)
1354 wl1251_read_eeprom_mac(wl);
1356 ret = wl1251_register_hw(wl);
1357 if (ret)
1358 goto out;
1360 wl1251_debugfs_init(wl);
1361 wl1251_notice("initialized");
1363 ret = 0;
1365 out:
1366 return ret;
1368 EXPORT_SYMBOL_GPL(wl1251_init_ieee80211);
1370 struct ieee80211_hw *wl1251_alloc_hw(void)
1372 struct ieee80211_hw *hw;
1373 struct wl1251 *wl;
1374 int i;
1375 static const u8 nokia_oui[3] = {0x00, 0x1f, 0xdf};
1377 hw = ieee80211_alloc_hw(sizeof(*wl), &wl1251_ops);
1378 if (!hw) {
1379 wl1251_error("could not alloc ieee80211_hw");
1380 return ERR_PTR(-ENOMEM);
1383 wl = hw->priv;
1384 memset(wl, 0, sizeof(*wl));
1386 wl->hw = hw;
1388 wl->data_in_count = 0;
1390 skb_queue_head_init(&wl->tx_queue);
1392 INIT_WORK(&wl->filter_work, wl1251_filter_work);
1393 INIT_DELAYED_WORK(&wl->elp_work, wl1251_elp_work);
1394 wl->channel = WL1251_DEFAULT_CHANNEL;
1395 wl->scanning = false;
1396 wl->default_key = 0;
1397 wl->listen_int = 1;
1398 wl->rx_counter = 0;
1399 wl->rx_handled = 0;
1400 wl->rx_current_buffer = 0;
1401 wl->rx_last_id = 0;
1402 wl->rx_config = WL1251_DEFAULT_RX_CONFIG;
1403 wl->rx_filter = WL1251_DEFAULT_RX_FILTER;
1404 wl->elp = false;
1405 wl->station_mode = STATION_ACTIVE_MODE;
1406 wl->psm_requested = false;
1407 wl->tx_queue_stopped = false;
1408 wl->power_level = WL1251_DEFAULT_POWER_LEVEL;
1409 wl->rssi_thold = 0;
1410 wl->beacon_int = WL1251_DEFAULT_BEACON_INT;
1411 wl->dtim_period = WL1251_DEFAULT_DTIM_PERIOD;
1412 wl->vif = NULL;
1414 for (i = 0; i < FW_TX_CMPLT_BLOCK_SIZE; i++)
1415 wl->tx_frames[i] = NULL;
1417 wl->next_tx_complete = 0;
1419 INIT_WORK(&wl->irq_work, wl1251_irq_work);
1420 INIT_WORK(&wl->tx_work, wl1251_tx_work);
1423 * In case our MAC address is not correctly set,
1424 * we use a random but Nokia MAC.
1426 memcpy(wl->mac_addr, nokia_oui, 3);
1427 get_random_bytes(wl->mac_addr + 3, 3);
1429 wl->state = WL1251_STATE_OFF;
1430 mutex_init(&wl->mutex);
1432 wl->tx_mgmt_frm_rate = DEFAULT_HW_GEN_TX_RATE;
1433 wl->tx_mgmt_frm_mod = DEFAULT_HW_GEN_MODULATION_TYPE;
1435 wl->rx_descriptor = kmalloc(sizeof(*wl->rx_descriptor), GFP_KERNEL);
1436 if (!wl->rx_descriptor) {
1437 wl1251_error("could not allocate memory for rx descriptor");
1438 ieee80211_free_hw(hw);
1439 return ERR_PTR(-ENOMEM);
1442 return hw;
1444 EXPORT_SYMBOL_GPL(wl1251_alloc_hw);
1446 int wl1251_free_hw(struct wl1251 *wl)
1448 ieee80211_unregister_hw(wl->hw);
1450 wl1251_debugfs_exit(wl);
1452 kfree(wl->target_mem_map);
1453 kfree(wl->data_path);
1454 vfree(wl->fw);
1455 wl->fw = NULL;
1456 kfree(wl->nvs);
1457 wl->nvs = NULL;
1459 kfree(wl->rx_descriptor);
1460 wl->rx_descriptor = NULL;
1462 ieee80211_free_hw(wl->hw);
1464 return 0;
1466 EXPORT_SYMBOL_GPL(wl1251_free_hw);
1468 MODULE_DESCRIPTION("TI wl1251 Wireles LAN Driver Core");
1469 MODULE_LICENSE("GPL");
1470 MODULE_AUTHOR("Kalle Valo <kvalo@adurom.com>");
1471 MODULE_FIRMWARE(WL1251_FW_NAME);