2 * Marvell Wireless LAN device driver: HW/FW Initialization
4 * Copyright (C) 2011, Marvell International Ltd.
6 * This software file (the "File") is distributed by Marvell International
7 * Ltd. under the terms of the GNU General Public License Version 2, June 1991
8 * (the "License"). You may use, redistribute and/or modify this File in
9 * accordance with the terms and conditions of the License, a copy of which
10 * is available by writing to the Free Software Foundation, Inc.,
11 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or on the
12 * worldwide web at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
14 * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
16 * ARE EXPRESSLY DISCLAIMED. The License provides additional details about
17 * this warranty disclaimer.
29 * This function adds a BSS priority table to the table list.
31 * The function allocates a new BSS priority table node and adds it to
32 * the end of BSS priority table list, kept in driver memory.
34 static int mwifiex_add_bss_prio_tbl(struct mwifiex_private *priv)
36 struct mwifiex_adapter *adapter = priv->adapter;
37 struct mwifiex_bss_prio_node *bss_prio;
38 struct mwifiex_bss_prio_tbl *tbl = adapter->bss_prio_tbl;
41 bss_prio = kzalloc(sizeof(struct mwifiex_bss_prio_node), GFP_KERNEL);
43 dev_err(adapter->dev, "%s: failed to alloc bss_prio\n",
48 bss_prio->priv = priv;
49 INIT_LIST_HEAD(&bss_prio->list);
50 if (!tbl[priv->bss_priority].bss_prio_cur)
51 tbl[priv->bss_priority].bss_prio_cur = bss_prio;
53 spin_lock_irqsave(&tbl[priv->bss_priority].bss_prio_lock, flags);
54 list_add_tail(&bss_prio->list, &tbl[priv->bss_priority].bss_prio_head);
55 spin_unlock_irqrestore(&tbl[priv->bss_priority].bss_prio_lock, flags);
61 * This function initializes the private structure and sets default
62 * values to the members.
64 * Additionally, it also initializes all the locks and sets up all the
67 static int mwifiex_init_priv(struct mwifiex_private *priv)
71 priv->media_connected = false;
72 memset(priv->curr_addr, 0xff, ETH_ALEN);
74 priv->pkt_tx_ctrl = 0;
75 priv->bss_mode = NL80211_IFTYPE_UNSPECIFIED;
76 priv->data_rate = 0; /* Initially indicate the rate as auto */
77 priv->is_data_rate_auto = true;
78 priv->bcn_avg_factor = DEFAULT_BCN_AVG_FACTOR;
79 priv->data_avg_factor = DEFAULT_DATA_AVG_FACTOR;
81 priv->sec_info.wep_enabled = 0;
82 priv->sec_info.authentication_mode = NL80211_AUTHTYPE_OPEN_SYSTEM;
83 priv->sec_info.encryption_mode = 0;
84 for (i = 0; i < ARRAY_SIZE(priv->wep_key); i++)
85 memset(&priv->wep_key[i], 0, sizeof(struct mwifiex_wep_key));
86 priv->wep_key_curr_index = 0;
87 priv->curr_pkt_filter = HostCmd_ACT_MAC_RX_ON | HostCmd_ACT_MAC_TX_ON |
88 HostCmd_ACT_MAC_ETHERNETII_ENABLE;
90 priv->beacon_period = 100; /* beacon interval */ ;
91 priv->attempted_bss_desc = NULL;
92 memset(&priv->curr_bss_params, 0, sizeof(priv->curr_bss_params));
93 priv->listen_interval = MWIFIEX_DEFAULT_LISTEN_INTERVAL;
95 memset(&priv->prev_ssid, 0, sizeof(priv->prev_ssid));
96 memset(&priv->prev_bssid, 0, sizeof(priv->prev_bssid));
97 memset(&priv->assoc_rsp_buf, 0, sizeof(priv->assoc_rsp_buf));
98 priv->assoc_rsp_size = 0;
99 priv->adhoc_channel = DEFAULT_AD_HOC_CHANNEL;
100 priv->atim_window = 0;
101 priv->adhoc_state = ADHOC_IDLE;
102 priv->tx_power_level = 0;
103 priv->max_tx_power_level = 0;
104 priv->min_tx_power_level = 0;
106 priv->rxpd_htinfo = 0;
108 priv->rate_bitmap = 0;
109 priv->data_rssi_last = 0;
110 priv->data_rssi_avg = 0;
111 priv->data_nf_avg = 0;
112 priv->data_nf_last = 0;
113 priv->bcn_rssi_last = 0;
114 priv->bcn_rssi_avg = 0;
115 priv->bcn_nf_avg = 0;
116 priv->bcn_nf_last = 0;
117 memset(&priv->wpa_ie, 0, sizeof(priv->wpa_ie));
118 memset(&priv->aes_key, 0, sizeof(priv->aes_key));
119 priv->wpa_ie_len = 0;
120 priv->wpa_is_gtk_set = false;
122 memset(&priv->assoc_tlv_buf, 0, sizeof(priv->assoc_tlv_buf));
123 priv->assoc_tlv_buf_len = 0;
124 memset(&priv->wps, 0, sizeof(priv->wps));
125 memset(&priv->gen_ie_buf, 0, sizeof(priv->gen_ie_buf));
126 priv->gen_ie_buf_len = 0;
127 memset(priv->vs_ie, 0, sizeof(priv->vs_ie));
129 priv->wmm_required = true;
130 priv->wmm_enabled = false;
131 priv->wmm_qosinfo = 0;
132 priv->curr_bcn_buf = NULL;
133 priv->curr_bcn_size = 0;
135 priv->wps_ie_len = 0;
137 priv->scan_block = false;
139 return mwifiex_add_bss_prio_tbl(priv);
143 * This function allocates buffers for members of the adapter
146 * The memory allocated includes scan table, command buffers, and
147 * sleep confirm command buffer. In addition, the queues are
150 static int mwifiex_allocate_adapter(struct mwifiex_adapter *adapter)
154 /* Allocate command buffer */
155 ret = mwifiex_alloc_cmd_buffer(adapter);
157 dev_err(adapter->dev, "%s: failed to alloc cmd buffer\n",
163 dev_alloc_skb(sizeof(struct mwifiex_opt_sleep_confirm)
166 if (!adapter->sleep_cfm) {
167 dev_err(adapter->dev, "%s: failed to alloc sleep cfm"
168 " cmd buffer\n", __func__);
171 skb_reserve(adapter->sleep_cfm, INTF_HEADER_LEN);
177 * This function initializes the adapter structure and sets default
178 * values to the members of adapter.
180 * This also initializes the WMM related parameters in the driver private
183 static void mwifiex_init_adapter(struct mwifiex_adapter *adapter)
185 struct mwifiex_opt_sleep_confirm *sleep_cfm_buf = NULL;
187 skb_put(adapter->sleep_cfm, sizeof(struct mwifiex_opt_sleep_confirm));
189 adapter->cmd_sent = false;
191 if (adapter->iface_type == MWIFIEX_SDIO)
192 adapter->data_sent = true;
194 adapter->data_sent = false;
196 adapter->cmd_resp_received = false;
197 adapter->event_received = false;
198 adapter->data_received = false;
200 adapter->surprise_removed = false;
202 adapter->hw_status = MWIFIEX_HW_STATUS_INITIALIZING;
204 adapter->ps_mode = MWIFIEX_802_11_POWER_MODE_CAM;
205 adapter->ps_state = PS_STATE_AWAKE;
206 adapter->need_to_wakeup = false;
208 adapter->scan_mode = HostCmd_BSS_MODE_ANY;
209 adapter->specific_scan_time = MWIFIEX_SPECIFIC_SCAN_CHAN_TIME;
210 adapter->active_scan_time = MWIFIEX_ACTIVE_SCAN_CHAN_TIME;
211 adapter->passive_scan_time = MWIFIEX_PASSIVE_SCAN_CHAN_TIME;
213 adapter->scan_probes = 1;
215 adapter->multiple_dtim = 1;
217 adapter->local_listen_interval = 0; /* default value in firmware
220 adapter->is_deep_sleep = false;
222 adapter->delay_null_pkt = false;
223 adapter->delay_to_ps = 1000;
224 adapter->enhanced_ps_mode = PS_MODE_AUTO;
226 adapter->gen_null_pkt = false; /* Disable NULL Pkg generation by
228 adapter->pps_uapsd_mode = false; /* Disable pps/uapsd mode by
230 adapter->pm_wakeup_card_req = false;
232 adapter->pm_wakeup_fw_try = false;
234 adapter->max_tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_2K;
235 adapter->tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_2K;
236 adapter->curr_tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_2K;
238 adapter->is_hs_configured = false;
239 adapter->hs_cfg.conditions = cpu_to_le32(HOST_SLEEP_CFG_COND_DEF);
240 adapter->hs_cfg.gpio = HOST_SLEEP_CFG_GPIO_DEF;
241 adapter->hs_cfg.gap = HOST_SLEEP_CFG_GAP_DEF;
242 adapter->hs_activated = false;
244 memset(adapter->event_body, 0, sizeof(adapter->event_body));
245 adapter->hw_dot_11n_dev_cap = 0;
246 adapter->hw_dev_mcs_support = 0;
247 adapter->sec_chan_offset = 0;
248 adapter->adhoc_11n_enabled = false;
250 mwifiex_wmm_init(adapter);
252 if (adapter->sleep_cfm) {
253 sleep_cfm_buf = (struct mwifiex_opt_sleep_confirm *)
254 adapter->sleep_cfm->data;
255 memset(sleep_cfm_buf, 0, adapter->sleep_cfm->len);
256 sleep_cfm_buf->command =
257 cpu_to_le16(HostCmd_CMD_802_11_PS_MODE_ENH);
258 sleep_cfm_buf->size =
259 cpu_to_le16(adapter->sleep_cfm->len);
260 sleep_cfm_buf->result = 0;
261 sleep_cfm_buf->action = cpu_to_le16(SLEEP_CONFIRM);
262 sleep_cfm_buf->resp_ctrl = cpu_to_le16(RESP_NEEDED);
264 memset(&adapter->sleep_params, 0, sizeof(adapter->sleep_params));
265 memset(&adapter->sleep_period, 0, sizeof(adapter->sleep_period));
266 adapter->tx_lock_flag = false;
267 adapter->null_pkt_interval = 0;
268 adapter->fw_bands = 0;
269 adapter->config_bands = 0;
270 adapter->adhoc_start_band = 0;
271 adapter->scan_channels = NULL;
272 adapter->fw_release_number = 0;
273 adapter->fw_cap_info = 0;
274 memset(&adapter->upld_buf, 0, sizeof(adapter->upld_buf));
275 adapter->event_cause = 0;
276 adapter->region_code = 0;
277 adapter->bcn_miss_time_out = DEFAULT_BCN_MISS_TIMEOUT;
278 adapter->adhoc_awake_period = 0;
279 memset(&adapter->arp_filter, 0, sizeof(adapter->arp_filter));
280 adapter->arp_filter_size = 0;
281 adapter->channel_type = NL80211_CHAN_HT20;
282 adapter->max_mgmt_ie_index = MAX_MGMT_IE_INDEX;
286 * This function sets trans_start per tx_queue
288 void mwifiex_set_trans_start(struct net_device *dev)
292 for (i = 0; i < dev->num_tx_queues; i++)
293 netdev_get_tx_queue(dev, i)->trans_start = jiffies;
295 dev->trans_start = jiffies;
299 * This function wakes up all queues in net_device
301 void mwifiex_wake_up_net_dev_queue(struct net_device *netdev,
302 struct mwifiex_adapter *adapter)
304 unsigned long dev_queue_flags;
306 spin_lock_irqsave(&adapter->queue_lock, dev_queue_flags);
307 netif_tx_wake_all_queues(netdev);
308 spin_unlock_irqrestore(&adapter->queue_lock, dev_queue_flags);
312 * This function stops all queues in net_device
314 void mwifiex_stop_net_dev_queue(struct net_device *netdev,
315 struct mwifiex_adapter *adapter)
317 unsigned long dev_queue_flags;
319 spin_lock_irqsave(&adapter->queue_lock, dev_queue_flags);
320 netif_tx_stop_all_queues(netdev);
321 spin_unlock_irqrestore(&adapter->queue_lock, dev_queue_flags);
325 * This function releases the lock variables and frees the locks and
328 static void mwifiex_free_lock_list(struct mwifiex_adapter *adapter)
330 struct mwifiex_private *priv;
334 list_del(&adapter->cmd_free_q);
335 list_del(&adapter->cmd_pending_q);
336 list_del(&adapter->scan_pending_q);
338 for (i = 0; i < adapter->priv_num; i++)
339 list_del(&adapter->bss_prio_tbl[i].bss_prio_head);
341 for (i = 0; i < adapter->priv_num; i++) {
342 if (adapter->priv[i]) {
343 priv = adapter->priv[i];
344 for (j = 0; j < MAX_NUM_TID; ++j)
345 list_del(&priv->wmm.tid_tbl_ptr[j].ra_list);
346 list_del(&priv->tx_ba_stream_tbl_ptr);
347 list_del(&priv->rx_reorder_tbl_ptr);
353 * This function frees the adapter structure.
355 * The freeing operation is done recursively, by canceling all
356 * pending commands, freeing the member buffers previously
357 * allocated (command buffers, scan table buffer, sleep confirm
358 * command buffer), stopping the timers and calling the cleanup
359 * routines for every interface, before the actual adapter
360 * structure is freed.
363 mwifiex_free_adapter(struct mwifiex_adapter *adapter)
366 pr_err("%s: adapter is NULL\n", __func__);
370 mwifiex_cancel_all_pending_cmd(adapter);
372 /* Free lock variables */
373 mwifiex_free_lock_list(adapter);
375 /* Free command buffer */
376 dev_dbg(adapter->dev, "info: free cmd buffer\n");
377 mwifiex_free_cmd_buffer(adapter);
379 del_timer(&adapter->cmd_timer);
381 dev_dbg(adapter->dev, "info: free scan table\n");
383 if (adapter->if_ops.cleanup_if)
384 adapter->if_ops.cleanup_if(adapter);
386 if (adapter->sleep_cfm)
387 dev_kfree_skb_any(adapter->sleep_cfm);
391 * This function intializes the lock variables and
394 int mwifiex_init_lock_list(struct mwifiex_adapter *adapter)
396 struct mwifiex_private *priv;
399 spin_lock_init(&adapter->mwifiex_lock);
400 spin_lock_init(&adapter->int_lock);
401 spin_lock_init(&adapter->main_proc_lock);
402 spin_lock_init(&adapter->mwifiex_cmd_lock);
403 spin_lock_init(&adapter->queue_lock);
404 for (i = 0; i < adapter->priv_num; i++) {
405 if (adapter->priv[i]) {
406 priv = adapter->priv[i];
407 spin_lock_init(&priv->rx_pkt_lock);
408 spin_lock_init(&priv->wmm.ra_list_spinlock);
409 spin_lock_init(&priv->curr_bcn_buf_lock);
413 /* Initialize cmd_free_q */
414 INIT_LIST_HEAD(&adapter->cmd_free_q);
415 /* Initialize cmd_pending_q */
416 INIT_LIST_HEAD(&adapter->cmd_pending_q);
417 /* Initialize scan_pending_q */
418 INIT_LIST_HEAD(&adapter->scan_pending_q);
420 spin_lock_init(&adapter->cmd_free_q_lock);
421 spin_lock_init(&adapter->cmd_pending_q_lock);
422 spin_lock_init(&adapter->scan_pending_q_lock);
424 skb_queue_head_init(&adapter->usb_rx_data_q);
426 for (i = 0; i < adapter->priv_num; ++i) {
427 INIT_LIST_HEAD(&adapter->bss_prio_tbl[i].bss_prio_head);
428 adapter->bss_prio_tbl[i].bss_prio_cur = NULL;
429 spin_lock_init(&adapter->bss_prio_tbl[i].bss_prio_lock);
432 for (i = 0; i < adapter->priv_num; i++) {
433 if (!adapter->priv[i])
435 priv = adapter->priv[i];
436 for (j = 0; j < MAX_NUM_TID; ++j) {
437 INIT_LIST_HEAD(&priv->wmm.tid_tbl_ptr[j].ra_list);
438 spin_lock_init(&priv->wmm.tid_tbl_ptr[j].tid_tbl_lock);
440 INIT_LIST_HEAD(&priv->tx_ba_stream_tbl_ptr);
441 INIT_LIST_HEAD(&priv->rx_reorder_tbl_ptr);
443 spin_lock_init(&priv->tx_ba_stream_tbl_lock);
444 spin_lock_init(&priv->rx_reorder_tbl_lock);
451 * This function initializes the firmware.
453 * The following operations are performed sequentially -
454 * - Allocate adapter structure
455 * - Initialize the adapter structure
456 * - Initialize the private structure
457 * - Add BSS priority tables to the adapter structure
458 * - For each interface, send the init commands to firmware
459 * - Send the first command in command pending queue, if available
461 int mwifiex_init_fw(struct mwifiex_adapter *adapter)
464 struct mwifiex_private *priv;
465 u8 i, first_sta = true;
466 int is_cmd_pend_q_empty;
469 adapter->hw_status = MWIFIEX_HW_STATUS_INITIALIZING;
471 /* Allocate memory for member of adapter structure */
472 ret = mwifiex_allocate_adapter(adapter);
476 /* Initialize adapter structure */
477 mwifiex_init_adapter(adapter);
479 for (i = 0; i < adapter->priv_num; i++) {
480 if (adapter->priv[i]) {
481 priv = adapter->priv[i];
483 /* Initialize private structure */
484 ret = mwifiex_init_priv(priv);
489 for (i = 0; i < adapter->priv_num; i++) {
490 if (adapter->priv[i]) {
491 ret = mwifiex_sta_init_cmd(adapter->priv[i], first_sta);
499 spin_lock_irqsave(&adapter->cmd_pending_q_lock, flags);
500 is_cmd_pend_q_empty = list_empty(&adapter->cmd_pending_q);
501 spin_unlock_irqrestore(&adapter->cmd_pending_q_lock, flags);
502 if (!is_cmd_pend_q_empty) {
503 /* Send the first command in queue and return */
504 if (mwifiex_main_process(adapter) != -1)
507 adapter->hw_status = MWIFIEX_HW_STATUS_READY;
514 * This function deletes the BSS priority tables.
516 * The function traverses through all the allocated BSS priority nodes
517 * in every BSS priority table and frees them.
519 static void mwifiex_delete_bss_prio_tbl(struct mwifiex_private *priv)
522 struct mwifiex_adapter *adapter = priv->adapter;
523 struct mwifiex_bss_prio_node *bssprio_node, *tmp_node, **cur;
524 struct list_head *head;
525 spinlock_t *lock; /* bss priority lock */
528 for (i = 0; i < adapter->priv_num; ++i) {
529 head = &adapter->bss_prio_tbl[i].bss_prio_head;
530 cur = &adapter->bss_prio_tbl[i].bss_prio_cur;
531 lock = &adapter->bss_prio_tbl[i].bss_prio_lock;
532 dev_dbg(adapter->dev, "info: delete BSS priority table,"
533 " bss_type = %d, bss_num = %d, i = %d,"
534 " head = %p, cur = %p\n",
535 priv->bss_type, priv->bss_num, i, head, *cur);
537 spin_lock_irqsave(lock, flags);
538 if (list_empty(head)) {
539 spin_unlock_irqrestore(lock, flags);
542 bssprio_node = list_first_entry(head,
543 struct mwifiex_bss_prio_node, list);
544 spin_unlock_irqrestore(lock, flags);
546 list_for_each_entry_safe(bssprio_node, tmp_node, head,
548 if (bssprio_node->priv == priv) {
549 dev_dbg(adapter->dev, "info: Delete "
550 "node %p, next = %p\n",
551 bssprio_node, tmp_node);
552 spin_lock_irqsave(lock, flags);
553 list_del(&bssprio_node->list);
554 spin_unlock_irqrestore(lock, flags);
558 *cur = (struct mwifiex_bss_prio_node *)head;
564 * This function is used to shutdown the driver.
566 * The following operations are performed sequentially -
567 * - Check if already shut down
568 * - Make sure the main process has stopped
569 * - Clean up the Tx and Rx queues
570 * - Delete BSS priority tables
572 * - Notify completion
575 mwifiex_shutdown_drv(struct mwifiex_adapter *adapter)
577 int ret = -EINPROGRESS;
578 struct mwifiex_private *priv;
583 /* mwifiex already shutdown */
584 if (adapter->hw_status == MWIFIEX_HW_STATUS_NOT_READY)
587 adapter->hw_status = MWIFIEX_HW_STATUS_CLOSING;
588 /* wait for mwifiex_process to complete */
589 if (adapter->mwifiex_processing) {
590 dev_warn(adapter->dev, "main process is still running\n");
594 /* shut down mwifiex */
595 dev_dbg(adapter->dev, "info: shutdown mwifiex...\n");
597 /* Clean up Tx/Rx queues and delete BSS priority table */
598 for (i = 0; i < adapter->priv_num; i++) {
599 if (adapter->priv[i]) {
600 priv = adapter->priv[i];
602 mwifiex_clean_txrx(priv);
603 mwifiex_delete_bss_prio_tbl(priv);
607 spin_lock_irqsave(&adapter->mwifiex_lock, flags);
609 if (adapter->if_ops.data_complete) {
610 while ((skb = skb_dequeue(&adapter->usb_rx_data_q))) {
611 struct mwifiex_rxinfo *rx_info = MWIFIEX_SKB_RXCB(skb);
613 priv = adapter->priv[rx_info->bss_num];
615 priv->stats.rx_dropped++;
617 adapter->if_ops.data_complete(adapter, skb);
621 /* Free adapter structure */
622 mwifiex_free_adapter(adapter);
624 spin_unlock_irqrestore(&adapter->mwifiex_lock, flags);
626 /* Notify completion */
627 ret = mwifiex_shutdown_fw_complete(adapter);
633 * This function downloads the firmware to the card.
635 * The actual download is preceded by two sanity checks -
636 * - Check if firmware is already running
637 * - Check if the interface is the winner to download the firmware
639 * ...and followed by another -
640 * - Check if the firmware is downloaded successfully
642 * After download is successfully completed, the host interrupts are enabled.
644 int mwifiex_dnld_fw(struct mwifiex_adapter *adapter,
645 struct mwifiex_fw_image *pmfw)
650 if (adapter->if_ops.check_fw_status) {
653 /* check if firmware is already running */
654 ret = adapter->if_ops.check_fw_status(adapter, poll_num);
656 dev_notice(adapter->dev,
657 "WLAN FW already running! Skip FW dnld\n");
661 poll_num = MAX_FIRMWARE_POLL_TRIES;
663 /* check if we are the winner for downloading FW */
664 if (!adapter->winner) {
665 dev_notice(adapter->dev,
666 "FW already running! Skip FW dnld\n");
667 poll_num = MAX_MULTI_INTERFACE_POLL_TRIES;
673 /* Download firmware with helper */
674 ret = adapter->if_ops.prog_fw(adapter, pmfw);
676 dev_err(adapter->dev, "prog_fw failed ret=%#x\n", ret);
682 /* Check if the firmware is downloaded successfully or not */
683 ret = adapter->if_ops.check_fw_status(adapter, poll_num);
685 dev_err(adapter->dev, "FW failed to be active in time\n");
689 /* re-enable host interrupt for mwifiex after fw dnld is successful */
690 if (adapter->if_ops.enable_int)
691 adapter->if_ops.enable_int(adapter);