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;
40 bss_prio = kzalloc(sizeof(struct mwifiex_bss_prio_node), GFP_KERNEL);
42 dev_err(adapter->dev, "%s: failed to alloc bss_prio\n",
47 bss_prio->priv = priv;
48 INIT_LIST_HEAD(&bss_prio->list);
49 if (!adapter->bss_prio_tbl[priv->bss_priority].bss_prio_cur)
50 adapter->bss_prio_tbl[priv->bss_priority].bss_prio_cur =
53 spin_lock_irqsave(&adapter->bss_prio_tbl[priv->bss_priority]
54 .bss_prio_lock, flags);
55 list_add_tail(&bss_prio->list,
56 &adapter->bss_prio_tbl[priv->bss_priority]
58 spin_unlock_irqrestore(&adapter->bss_prio_tbl[priv->bss_priority]
59 .bss_prio_lock, flags);
65 * This function initializes the private structure and sets default
66 * values to the members.
68 * Additionally, it also initializes all the locks and sets up all the
71 static int mwifiex_init_priv(struct mwifiex_private *priv)
75 priv->media_connected = false;
76 memset(priv->curr_addr, 0xff, ETH_ALEN);
78 priv->pkt_tx_ctrl = 0;
79 priv->bss_mode = NL80211_IFTYPE_UNSPECIFIED;
80 priv->data_rate = 0; /* Initially indicate the rate as auto */
81 priv->is_data_rate_auto = true;
82 priv->bcn_avg_factor = DEFAULT_BCN_AVG_FACTOR;
83 priv->data_avg_factor = DEFAULT_DATA_AVG_FACTOR;
85 priv->sec_info.wep_status = MWIFIEX_802_11_WEP_DISABLED;
86 priv->sec_info.authentication_mode = NL80211_AUTHTYPE_OPEN_SYSTEM;
87 priv->sec_info.encryption_mode = 0;
88 for (i = 0; i < ARRAY_SIZE(priv->wep_key); i++)
89 memset(&priv->wep_key[i], 0, sizeof(struct mwifiex_wep_key));
90 priv->wep_key_curr_index = 0;
91 priv->curr_pkt_filter = HostCmd_ACT_MAC_RX_ON | HostCmd_ACT_MAC_TX_ON |
92 HostCmd_ACT_MAC_ETHERNETII_ENABLE;
94 priv->beacon_period = 100; /* beacon interval */ ;
95 priv->attempted_bss_desc = NULL;
96 memset(&priv->curr_bss_params, 0, sizeof(priv->curr_bss_params));
97 priv->listen_interval = MWIFIEX_DEFAULT_LISTEN_INTERVAL;
99 memset(&priv->prev_ssid, 0, sizeof(priv->prev_ssid));
100 memset(&priv->prev_bssid, 0, sizeof(priv->prev_bssid));
101 memset(&priv->assoc_rsp_buf, 0, sizeof(priv->assoc_rsp_buf));
102 priv->assoc_rsp_size = 0;
103 priv->adhoc_channel = DEFAULT_AD_HOC_CHANNEL;
104 priv->atim_window = 0;
105 priv->adhoc_state = ADHOC_IDLE;
106 priv->tx_power_level = 0;
107 priv->max_tx_power_level = 0;
108 priv->min_tx_power_level = 0;
110 priv->rxpd_htinfo = 0;
112 priv->rate_bitmap = 0;
113 priv->data_rssi_last = 0;
114 priv->data_rssi_avg = 0;
115 priv->data_nf_avg = 0;
116 priv->data_nf_last = 0;
117 priv->bcn_rssi_last = 0;
118 priv->bcn_rssi_avg = 0;
119 priv->bcn_nf_avg = 0;
120 priv->bcn_nf_last = 0;
121 memset(&priv->wpa_ie, 0, sizeof(priv->wpa_ie));
122 memset(&priv->aes_key, 0, sizeof(priv->aes_key));
123 priv->wpa_ie_len = 0;
124 priv->wpa_is_gtk_set = false;
126 memset(&priv->assoc_tlv_buf, 0, sizeof(priv->assoc_tlv_buf));
127 priv->assoc_tlv_buf_len = 0;
128 memset(&priv->wps, 0, sizeof(priv->wps));
129 memset(&priv->gen_ie_buf, 0, sizeof(priv->gen_ie_buf));
130 priv->gen_ie_buf_len = 0;
131 memset(priv->vs_ie, 0, sizeof(priv->vs_ie));
133 priv->wmm_required = true;
134 priv->wmm_enabled = false;
135 priv->wmm_qosinfo = 0;
136 priv->curr_bcn_buf = NULL;
137 priv->curr_bcn_size = 0;
139 priv->scan_block = false;
141 return mwifiex_add_bss_prio_tbl(priv);
145 * This function allocates buffers for members of the adapter
148 * The memory allocated includes scan table, command buffers, and
149 * sleep confirm command buffer. In addition, the queues are
152 static int mwifiex_allocate_adapter(struct mwifiex_adapter *adapter)
156 /* Allocate command buffer */
157 ret = mwifiex_alloc_cmd_buffer(adapter);
159 dev_err(adapter->dev, "%s: failed to alloc cmd buffer\n",
165 dev_alloc_skb(sizeof(struct mwifiex_opt_sleep_confirm)
168 if (!adapter->sleep_cfm) {
169 dev_err(adapter->dev, "%s: failed to alloc sleep cfm"
170 " cmd buffer\n", __func__);
173 skb_reserve(adapter->sleep_cfm, INTF_HEADER_LEN);
179 * This function initializes the adapter structure and sets default
180 * values to the members of adapter.
182 * This also initializes the WMM related parameters in the driver private
185 static void mwifiex_init_adapter(struct mwifiex_adapter *adapter)
187 struct mwifiex_opt_sleep_confirm *sleep_cfm_buf = NULL;
189 skb_put(adapter->sleep_cfm, sizeof(struct mwifiex_opt_sleep_confirm));
191 adapter->cmd_sent = false;
193 if (adapter->iface_type == MWIFIEX_PCIE)
194 adapter->data_sent = false;
196 adapter->data_sent = true;
198 adapter->cmd_resp_received = false;
199 adapter->event_received = false;
200 adapter->data_received = false;
202 adapter->surprise_removed = false;
204 adapter->hw_status = MWIFIEX_HW_STATUS_INITIALIZING;
206 adapter->ps_mode = MWIFIEX_802_11_POWER_MODE_CAM;
207 adapter->ps_state = PS_STATE_AWAKE;
208 adapter->need_to_wakeup = false;
210 adapter->scan_mode = HostCmd_BSS_MODE_ANY;
211 adapter->specific_scan_time = MWIFIEX_SPECIFIC_SCAN_CHAN_TIME;
212 adapter->active_scan_time = MWIFIEX_ACTIVE_SCAN_CHAN_TIME;
213 adapter->passive_scan_time = MWIFIEX_PASSIVE_SCAN_CHAN_TIME;
215 adapter->scan_probes = 1;
217 adapter->multiple_dtim = 1;
219 adapter->local_listen_interval = 0; /* default value in firmware
222 adapter->is_deep_sleep = false;
224 adapter->delay_null_pkt = false;
225 adapter->delay_to_ps = 1000;
226 adapter->enhanced_ps_mode = PS_MODE_AUTO;
228 adapter->gen_null_pkt = false; /* Disable NULL Pkg generation by
230 adapter->pps_uapsd_mode = false; /* Disable pps/uapsd mode by
232 adapter->pm_wakeup_card_req = false;
234 adapter->pm_wakeup_fw_try = false;
236 adapter->max_tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_2K;
237 adapter->tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_2K;
238 adapter->curr_tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_2K;
240 adapter->is_hs_configured = false;
241 adapter->hs_cfg.conditions = cpu_to_le32(HOST_SLEEP_CFG_COND_DEF);
242 adapter->hs_cfg.gpio = HOST_SLEEP_CFG_GPIO_DEF;
243 adapter->hs_cfg.gap = HOST_SLEEP_CFG_GAP_DEF;
244 adapter->hs_activated = false;
246 memset(adapter->event_body, 0, sizeof(adapter->event_body));
247 adapter->hw_dot_11n_dev_cap = 0;
248 adapter->hw_dev_mcs_support = 0;
249 adapter->sec_chan_offset = 0;
250 adapter->adhoc_11n_enabled = false;
252 mwifiex_wmm_init(adapter);
254 if (adapter->sleep_cfm) {
255 sleep_cfm_buf = (struct mwifiex_opt_sleep_confirm *)
256 adapter->sleep_cfm->data;
257 memset(sleep_cfm_buf, 0, adapter->sleep_cfm->len);
258 sleep_cfm_buf->command =
259 cpu_to_le16(HostCmd_CMD_802_11_PS_MODE_ENH);
260 sleep_cfm_buf->size =
261 cpu_to_le16(adapter->sleep_cfm->len);
262 sleep_cfm_buf->result = 0;
263 sleep_cfm_buf->action = cpu_to_le16(SLEEP_CONFIRM);
264 sleep_cfm_buf->resp_ctrl = cpu_to_le16(RESP_NEEDED);
266 memset(&adapter->sleep_params, 0, sizeof(adapter->sleep_params));
267 memset(&adapter->sleep_period, 0, sizeof(adapter->sleep_period));
268 adapter->tx_lock_flag = false;
269 adapter->null_pkt_interval = 0;
270 adapter->fw_bands = 0;
271 adapter->config_bands = 0;
272 adapter->adhoc_start_band = 0;
273 adapter->scan_channels = NULL;
274 adapter->fw_release_number = 0;
275 adapter->fw_cap_info = 0;
276 memset(&adapter->upld_buf, 0, sizeof(adapter->upld_buf));
277 adapter->event_cause = 0;
278 adapter->region_code = 0;
279 adapter->bcn_miss_time_out = DEFAULT_BCN_MISS_TIMEOUT;
280 adapter->adhoc_awake_period = 0;
281 memset(&adapter->arp_filter, 0, sizeof(adapter->arp_filter));
282 adapter->arp_filter_size = 0;
283 adapter->channel_type = NL80211_CHAN_HT20;
287 * This function sets trans_start per tx_queue
289 void mwifiex_set_trans_start(struct net_device *dev)
293 for (i = 0; i < dev->num_tx_queues; i++)
294 netdev_get_tx_queue(dev, i)->trans_start = jiffies;
296 dev->trans_start = jiffies;
300 * This function wakes up all queues in net_device
302 void mwifiex_wake_up_net_dev_queue(struct net_device *netdev,
303 struct mwifiex_adapter *adapter)
305 unsigned long dev_queue_flags;
307 spin_lock_irqsave(&adapter->queue_lock, dev_queue_flags);
308 netif_tx_wake_all_queues(netdev);
309 spin_unlock_irqrestore(&adapter->queue_lock, dev_queue_flags);
313 * This function stops all queues in net_device
315 void mwifiex_stop_net_dev_queue(struct net_device *netdev,
316 struct mwifiex_adapter *adapter)
318 unsigned long dev_queue_flags;
320 spin_lock_irqsave(&adapter->queue_lock, dev_queue_flags);
321 netif_tx_stop_all_queues(netdev);
322 spin_unlock_irqrestore(&adapter->queue_lock, dev_queue_flags);
326 * This function releases the lock variables and frees the locks and
329 static void mwifiex_free_lock_list(struct mwifiex_adapter *adapter)
331 struct mwifiex_private *priv;
335 list_del(&adapter->cmd_free_q);
336 list_del(&adapter->cmd_pending_q);
337 list_del(&adapter->scan_pending_q);
339 for (i = 0; i < adapter->priv_num; i++)
340 list_del(&adapter->bss_prio_tbl[i].bss_prio_head);
342 for (i = 0; i < adapter->priv_num; i++) {
343 if (adapter->priv[i]) {
344 priv = adapter->priv[i];
345 for (j = 0; j < MAX_NUM_TID; ++j)
346 list_del(&priv->wmm.tid_tbl_ptr[j].ra_list);
347 list_del(&priv->tx_ba_stream_tbl_ptr);
348 list_del(&priv->rx_reorder_tbl_ptr);
354 * This function frees the adapter structure.
356 * The freeing operation is done recursively, by canceling all
357 * pending commands, freeing the member buffers previously
358 * allocated (command buffers, scan table buffer, sleep confirm
359 * command buffer), stopping the timers and calling the cleanup
360 * routines for every interface, before the actual adapter
361 * structure is freed.
364 mwifiex_free_adapter(struct mwifiex_adapter *adapter)
367 pr_err("%s: adapter is NULL\n", __func__);
371 mwifiex_cancel_all_pending_cmd(adapter);
373 /* Free lock variables */
374 mwifiex_free_lock_list(adapter);
376 /* Free command buffer */
377 dev_dbg(adapter->dev, "info: free cmd buffer\n");
378 mwifiex_free_cmd_buffer(adapter);
380 del_timer(&adapter->cmd_timer);
382 dev_dbg(adapter->dev, "info: free scan table\n");
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 for (i = 0; i < adapter->priv_num; ++i) {
425 INIT_LIST_HEAD(&adapter->bss_prio_tbl[i].bss_prio_head);
426 adapter->bss_prio_tbl[i].bss_prio_cur = NULL;
427 spin_lock_init(&adapter->bss_prio_tbl[i].bss_prio_lock);
430 for (i = 0; i < adapter->priv_num; i++) {
431 if (!adapter->priv[i])
433 priv = adapter->priv[i];
434 for (j = 0; j < MAX_NUM_TID; ++j) {
435 INIT_LIST_HEAD(&priv->wmm.tid_tbl_ptr[j].ra_list);
436 spin_lock_init(&priv->wmm.tid_tbl_ptr[j].tid_tbl_lock);
438 INIT_LIST_HEAD(&priv->tx_ba_stream_tbl_ptr);
439 INIT_LIST_HEAD(&priv->rx_reorder_tbl_ptr);
441 spin_lock_init(&priv->tx_ba_stream_tbl_lock);
442 spin_lock_init(&priv->rx_reorder_tbl_lock);
449 * This function initializes the firmware.
451 * The following operations are performed sequentially -
452 * - Allocate adapter structure
453 * - Initialize the adapter structure
454 * - Initialize the private structure
455 * - Add BSS priority tables to the adapter structure
456 * - For each interface, send the init commands to firmware
457 * - Send the first command in command pending queue, if available
459 int mwifiex_init_fw(struct mwifiex_adapter *adapter)
462 struct mwifiex_private *priv;
463 u8 i, first_sta = true;
464 int is_cmd_pend_q_empty;
467 adapter->hw_status = MWIFIEX_HW_STATUS_INITIALIZING;
469 /* Allocate memory for member of adapter structure */
470 ret = mwifiex_allocate_adapter(adapter);
474 /* Initialize adapter structure */
475 mwifiex_init_adapter(adapter);
477 for (i = 0; i < adapter->priv_num; i++) {
478 if (adapter->priv[i]) {
479 priv = adapter->priv[i];
481 /* Initialize private structure */
482 ret = mwifiex_init_priv(priv);
487 for (i = 0; i < adapter->priv_num; i++) {
488 if (adapter->priv[i]) {
489 ret = mwifiex_sta_init_cmd(adapter->priv[i], first_sta);
497 spin_lock_irqsave(&adapter->cmd_pending_q_lock, flags);
498 is_cmd_pend_q_empty = list_empty(&adapter->cmd_pending_q);
499 spin_unlock_irqrestore(&adapter->cmd_pending_q_lock, flags);
500 if (!is_cmd_pend_q_empty) {
501 /* Send the first command in queue and return */
502 if (mwifiex_main_process(adapter) != -1)
505 adapter->hw_status = MWIFIEX_HW_STATUS_READY;
512 * This function deletes the BSS priority tables.
514 * The function traverses through all the allocated BSS priority nodes
515 * in every BSS priority table and frees them.
517 static void mwifiex_delete_bss_prio_tbl(struct mwifiex_private *priv)
520 struct mwifiex_adapter *adapter = priv->adapter;
521 struct mwifiex_bss_prio_node *bssprio_node, *tmp_node, **cur;
522 struct list_head *head;
526 for (i = 0; i < adapter->priv_num; ++i) {
527 head = &adapter->bss_prio_tbl[i].bss_prio_head;
528 cur = &adapter->bss_prio_tbl[i].bss_prio_cur;
529 lock = &adapter->bss_prio_tbl[i].bss_prio_lock;
530 dev_dbg(adapter->dev, "info: delete BSS priority table,"
531 " bss_type = %d, bss_num = %d, i = %d,"
532 " head = %p, cur = %p\n",
533 priv->bss_type, priv->bss_num, i, head, *cur);
535 spin_lock_irqsave(lock, flags);
536 if (list_empty(head)) {
537 spin_unlock_irqrestore(lock, flags);
540 bssprio_node = list_first_entry(head,
541 struct mwifiex_bss_prio_node, list);
542 spin_unlock_irqrestore(lock, flags);
544 list_for_each_entry_safe(bssprio_node, tmp_node, head,
546 if (bssprio_node->priv == priv) {
547 dev_dbg(adapter->dev, "info: Delete "
548 "node %p, next = %p\n",
549 bssprio_node, tmp_node);
550 spin_lock_irqsave(lock, flags);
551 list_del(&bssprio_node->list);
552 spin_unlock_irqrestore(lock, flags);
556 *cur = (struct mwifiex_bss_prio_node *)head;
562 * This function is used to shutdown the driver.
564 * The following operations are performed sequentially -
565 * - Check if already shut down
566 * - Make sure the main process has stopped
567 * - Clean up the Tx and Rx queues
568 * - Delete BSS priority tables
570 * - Notify completion
573 mwifiex_shutdown_drv(struct mwifiex_adapter *adapter)
575 int ret = -EINPROGRESS;
576 struct mwifiex_private *priv;
580 /* mwifiex already shutdown */
581 if (adapter->hw_status == MWIFIEX_HW_STATUS_NOT_READY)
584 adapter->hw_status = MWIFIEX_HW_STATUS_CLOSING;
585 /* wait for mwifiex_process to complete */
586 if (adapter->mwifiex_processing) {
587 dev_warn(adapter->dev, "main process is still running\n");
591 /* shut down mwifiex */
592 dev_dbg(adapter->dev, "info: shutdown mwifiex...\n");
594 /* Clean up Tx/Rx queues and delete BSS priority table */
595 for (i = 0; i < adapter->priv_num; i++) {
596 if (adapter->priv[i]) {
597 priv = adapter->priv[i];
599 mwifiex_clean_txrx(priv);
600 mwifiex_delete_bss_prio_tbl(priv);
604 spin_lock_irqsave(&adapter->mwifiex_lock, flags);
606 /* Free adapter structure */
607 mwifiex_free_adapter(adapter);
609 spin_unlock_irqrestore(&adapter->mwifiex_lock, flags);
611 /* Notify completion */
612 ret = mwifiex_shutdown_fw_complete(adapter);
618 * This function downloads the firmware to the card.
620 * The actual download is preceded by two sanity checks -
621 * - Check if firmware is already running
622 * - Check if the interface is the winner to download the firmware
624 * ...and followed by another -
625 * - Check if the firmware is downloaded successfully
627 * After download is successfully completed, the host interrupts are enabled.
629 int mwifiex_dnld_fw(struct mwifiex_adapter *adapter,
630 struct mwifiex_fw_image *pmfw)
637 /* Check if firmware is already running */
638 ret = adapter->if_ops.check_fw_status(adapter, poll_num);
640 dev_notice(adapter->dev,
641 "WLAN FW already running! Skip FW download\n");
644 poll_num = MAX_FIRMWARE_POLL_TRIES;
646 /* Check if we are the winner for downloading FW */
647 if (!adapter->winner) {
648 dev_notice(adapter->dev,
649 "Other interface already running!"
650 " Skip FW download\n");
651 poll_num = MAX_MULTI_INTERFACE_POLL_TRIES;
655 /* Download firmware with helper */
656 ret = adapter->if_ops.prog_fw(adapter, pmfw);
658 dev_err(adapter->dev, "prog_fw failed ret=%#x\n", ret);
664 /* Check if the firmware is downloaded successfully or not */
665 ret = adapter->if_ops.check_fw_status(adapter, poll_num);
667 dev_err(adapter->dev, "FW failed to be active in time\n");
671 /* re-enable host interrupt for mwifiex after fw dnld is successful */
672 adapter->if_ops.enable_int(adapter);