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)
76 priv->media_connected = false;
77 memset(priv->curr_addr, 0xff, ETH_ALEN);
79 priv->pkt_tx_ctrl = 0;
80 priv->bss_mode = NL80211_IFTYPE_STATION;
81 priv->data_rate = 0; /* Initially indicate the rate as auto */
82 priv->is_data_rate_auto = true;
83 priv->bcn_avg_factor = DEFAULT_BCN_AVG_FACTOR;
84 priv->data_avg_factor = DEFAULT_DATA_AVG_FACTOR;
86 priv->sec_info.wep_status = MWIFIEX_802_11_WEP_DISABLED;
87 priv->sec_info.authentication_mode = NL80211_AUTHTYPE_OPEN_SYSTEM;
88 priv->sec_info.encryption_mode = 0;
89 for (i = 0; i < ARRAY_SIZE(priv->wep_key); i++)
90 memset(&priv->wep_key[i], 0, sizeof(struct mwifiex_wep_key));
91 priv->wep_key_curr_index = 0;
92 priv->curr_pkt_filter = HostCmd_ACT_MAC_RX_ON | HostCmd_ACT_MAC_TX_ON |
93 HostCmd_ACT_MAC_ETHERNETII_ENABLE;
95 priv->beacon_period = 100; /* beacon interval */ ;
96 priv->attempted_bss_desc = NULL;
97 memset(&priv->curr_bss_params, 0, sizeof(priv->curr_bss_params));
98 priv->listen_interval = MWIFIEX_DEFAULT_LISTEN_INTERVAL;
100 memset(&priv->prev_ssid, 0, sizeof(priv->prev_ssid));
101 memset(&priv->prev_bssid, 0, sizeof(priv->prev_bssid));
102 memset(&priv->assoc_rsp_buf, 0, sizeof(priv->assoc_rsp_buf));
103 priv->assoc_rsp_size = 0;
104 priv->adhoc_channel = DEFAULT_AD_HOC_CHANNEL;
105 priv->atim_window = 0;
106 priv->adhoc_state = ADHOC_IDLE;
107 priv->tx_power_level = 0;
108 priv->max_tx_power_level = 0;
109 priv->min_tx_power_level = 0;
111 priv->rxpd_htinfo = 0;
113 priv->rate_bitmap = 0;
114 priv->data_rssi_last = 0;
115 priv->data_rssi_avg = 0;
116 priv->data_nf_avg = 0;
117 priv->data_nf_last = 0;
118 priv->bcn_rssi_last = 0;
119 priv->bcn_rssi_avg = 0;
120 priv->bcn_nf_avg = 0;
121 priv->bcn_nf_last = 0;
122 memset(&priv->wpa_ie, 0, sizeof(priv->wpa_ie));
123 memset(&priv->aes_key, 0, sizeof(priv->aes_key));
124 priv->wpa_ie_len = 0;
125 priv->wpa_is_gtk_set = false;
127 memset(&priv->assoc_tlv_buf, 0, sizeof(priv->assoc_tlv_buf));
128 priv->assoc_tlv_buf_len = 0;
129 memset(&priv->wps, 0, sizeof(priv->wps));
130 memset(&priv->gen_ie_buf, 0, sizeof(priv->gen_ie_buf));
131 priv->gen_ie_buf_len = 0;
132 memset(priv->vs_ie, 0, sizeof(priv->vs_ie));
134 priv->wmm_required = true;
135 priv->wmm_enabled = false;
136 priv->wmm_qosinfo = 0;
137 priv->curr_bcn_buf = NULL;
138 priv->curr_bcn_size = 0;
140 priv->scan_block = false;
142 ret = mwifiex_add_bss_prio_tbl(priv);
148 * This function allocates buffers for members of the adapter
151 * The memory allocated includes scan table, command buffers, and
152 * sleep confirm command buffer. In addition, the queues are
155 static int mwifiex_allocate_adapter(struct mwifiex_adapter *adapter)
159 struct mwifiex_bssdescriptor *temp_scan_table;
161 /* Allocate buffer to store the BSSID list */
162 buf_size = sizeof(struct mwifiex_bssdescriptor) * IW_MAX_AP;
163 temp_scan_table = kzalloc(buf_size, GFP_KERNEL);
164 if (!temp_scan_table) {
165 dev_err(adapter->dev, "%s: failed to alloc temp_scan_table\n",
170 adapter->scan_table = temp_scan_table;
172 /* Allocate command buffer */
173 ret = mwifiex_alloc_cmd_buffer(adapter);
175 dev_err(adapter->dev, "%s: failed to alloc cmd buffer\n",
181 dev_alloc_skb(sizeof(struct mwifiex_opt_sleep_confirm_buffer)
184 if (!adapter->sleep_cfm) {
185 dev_err(adapter->dev, "%s: failed to alloc sleep cfm"
186 " cmd buffer\n", __func__);
189 skb_reserve(adapter->sleep_cfm, INTF_HEADER_LEN);
195 * This function initializes the adapter structure and sets default
196 * values to the members of adapter.
198 * This also initializes the WMM related parameters in the driver private
201 static void mwifiex_init_adapter(struct mwifiex_adapter *adapter)
203 struct mwifiex_opt_sleep_confirm_buffer *sleep_cfm_buf = NULL;
205 skb_put(adapter->sleep_cfm, sizeof(sleep_cfm_buf->ps_cfm_sleep));
206 sleep_cfm_buf = (struct mwifiex_opt_sleep_confirm_buffer *)
207 (adapter->sleep_cfm->data);
209 adapter->cmd_sent = false;
210 adapter->data_sent = true;
211 adapter->cmd_resp_received = false;
212 adapter->event_received = false;
213 adapter->data_received = false;
215 adapter->surprise_removed = false;
217 adapter->hw_status = MWIFIEX_HW_STATUS_INITIALIZING;
219 adapter->ps_mode = MWIFIEX_802_11_POWER_MODE_CAM;
220 adapter->ps_state = PS_STATE_AWAKE;
221 adapter->need_to_wakeup = false;
223 adapter->scan_mode = HostCmd_BSS_MODE_ANY;
224 adapter->specific_scan_time = MWIFIEX_SPECIFIC_SCAN_CHAN_TIME;
225 adapter->active_scan_time = MWIFIEX_ACTIVE_SCAN_CHAN_TIME;
226 adapter->passive_scan_time = MWIFIEX_PASSIVE_SCAN_CHAN_TIME;
228 adapter->num_in_scan_table = 0;
229 memset(adapter->scan_table, 0,
230 (sizeof(struct mwifiex_bssdescriptor) * IW_MAX_AP));
231 adapter->scan_probes = 1;
233 memset(adapter->bcn_buf, 0, sizeof(adapter->bcn_buf));
234 adapter->bcn_buf_end = adapter->bcn_buf;
236 adapter->multiple_dtim = 1;
238 adapter->local_listen_interval = 0; /* default value in firmware
241 adapter->is_deep_sleep = false;
243 adapter->delay_null_pkt = false;
244 adapter->delay_to_ps = 1000;
245 adapter->enhanced_ps_mode = PS_MODE_AUTO;
247 adapter->gen_null_pkt = false; /* Disable NULL Pkg generation by
249 adapter->pps_uapsd_mode = false; /* Disable pps/uapsd mode by
251 adapter->pm_wakeup_card_req = false;
253 adapter->pm_wakeup_fw_try = false;
255 adapter->max_tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_2K;
256 adapter->tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_2K;
257 adapter->curr_tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_2K;
259 adapter->is_hs_configured = false;
260 adapter->hs_cfg.conditions = cpu_to_le32(HOST_SLEEP_CFG_COND_DEF);
261 adapter->hs_cfg.gpio = HOST_SLEEP_CFG_GPIO_DEF;
262 adapter->hs_cfg.gap = HOST_SLEEP_CFG_GAP_DEF;
263 adapter->hs_activated = false;
265 memset(adapter->event_body, 0, sizeof(adapter->event_body));
266 adapter->hw_dot_11n_dev_cap = 0;
267 adapter->hw_dev_mcs_support = 0;
268 adapter->chan_offset = 0;
269 adapter->adhoc_11n_enabled = false;
271 mwifiex_wmm_init(adapter);
273 if (adapter->sleep_cfm) {
274 memset(&sleep_cfm_buf->ps_cfm_sleep, 0,
275 adapter->sleep_cfm->len);
276 sleep_cfm_buf->ps_cfm_sleep.command =
277 cpu_to_le16(HostCmd_CMD_802_11_PS_MODE_ENH);
278 sleep_cfm_buf->ps_cfm_sleep.size =
279 cpu_to_le16(adapter->sleep_cfm->len);
280 sleep_cfm_buf->ps_cfm_sleep.result = 0;
281 sleep_cfm_buf->ps_cfm_sleep.action = cpu_to_le16(SLEEP_CONFIRM);
282 sleep_cfm_buf->ps_cfm_sleep.resp_ctrl =
283 cpu_to_le16(RESP_NEEDED);
285 memset(&adapter->sleep_params, 0, sizeof(adapter->sleep_params));
286 memset(&adapter->sleep_period, 0, sizeof(adapter->sleep_period));
287 adapter->tx_lock_flag = false;
288 adapter->null_pkt_interval = 0;
289 adapter->fw_bands = 0;
290 adapter->config_bands = 0;
291 adapter->adhoc_start_band = 0;
292 adapter->scan_channels = NULL;
293 adapter->fw_release_number = 0;
294 adapter->fw_cap_info = 0;
295 memset(&adapter->upld_buf, 0, sizeof(adapter->upld_buf));
296 adapter->event_cause = 0;
297 adapter->region_code = 0;
298 adapter->bcn_miss_time_out = DEFAULT_BCN_MISS_TIMEOUT;
299 adapter->adhoc_awake_period = 0;
300 memset(&adapter->arp_filter, 0, sizeof(adapter->arp_filter));
301 adapter->arp_filter_size = 0;
305 * This function frees the adapter structure.
307 * The freeing operation is done recursively, by canceling all
308 * pending commands, freeing the member buffers previously
309 * allocated (command buffers, scan table buffer, sleep confirm
310 * command buffer), stopping the timers and calling the cleanup
311 * routines for every interface, before the actual adapter
312 * structure is freed.
315 mwifiex_free_adapter(struct mwifiex_adapter *adapter)
318 pr_err("%s: adapter is NULL\n", __func__);
322 mwifiex_cancel_all_pending_cmd(adapter);
324 /* Free lock variables */
325 mwifiex_free_lock_list(adapter);
327 /* Free command buffer */
328 dev_dbg(adapter->dev, "info: free cmd buffer\n");
329 mwifiex_free_cmd_buffer(adapter);
331 del_timer(&adapter->cmd_timer);
333 dev_dbg(adapter->dev, "info: free scan table\n");
334 kfree(adapter->scan_table);
335 adapter->scan_table = NULL;
337 adapter->if_ops.cleanup_if(adapter);
339 dev_kfree_skb_any(adapter->sleep_cfm);
343 * This function intializes the lock variables and
346 int mwifiex_init_lock_list(struct mwifiex_adapter *adapter)
348 struct mwifiex_private *priv = NULL;
352 spin_lock_init(&adapter->mwifiex_lock);
353 spin_lock_init(&adapter->int_lock);
354 spin_lock_init(&adapter->main_proc_lock);
355 spin_lock_init(&adapter->mwifiex_cmd_lock);
356 for (i = 0; i < adapter->priv_num; i++) {
357 if (adapter->priv[i]) {
358 priv = adapter->priv[i];
359 spin_lock_init(&priv->rx_pkt_lock);
360 spin_lock_init(&priv->wmm.ra_list_spinlock);
361 spin_lock_init(&priv->curr_bcn_buf_lock);
365 /* Initialize cmd_free_q */
366 INIT_LIST_HEAD(&adapter->cmd_free_q);
367 /* Initialize cmd_pending_q */
368 INIT_LIST_HEAD(&adapter->cmd_pending_q);
369 /* Initialize scan_pending_q */
370 INIT_LIST_HEAD(&adapter->scan_pending_q);
372 spin_lock_init(&adapter->cmd_free_q_lock);
373 spin_lock_init(&adapter->cmd_pending_q_lock);
374 spin_lock_init(&adapter->scan_pending_q_lock);
376 for (i = 0; i < adapter->priv_num; ++i) {
377 INIT_LIST_HEAD(&adapter->bss_prio_tbl[i].bss_prio_head);
378 adapter->bss_prio_tbl[i].bss_prio_cur = NULL;
379 spin_lock_init(&adapter->bss_prio_tbl[i].bss_prio_lock);
382 for (i = 0; i < adapter->priv_num; i++) {
383 if (!adapter->priv[i])
385 priv = adapter->priv[i];
386 for (j = 0; j < MAX_NUM_TID; ++j) {
387 INIT_LIST_HEAD(&priv->wmm.tid_tbl_ptr[j].ra_list);
388 spin_lock_init(&priv->wmm.tid_tbl_ptr[j].tid_tbl_lock);
390 INIT_LIST_HEAD(&priv->tx_ba_stream_tbl_ptr);
391 INIT_LIST_HEAD(&priv->rx_reorder_tbl_ptr);
393 spin_lock_init(&priv->tx_ba_stream_tbl_lock);
394 spin_lock_init(&priv->rx_reorder_tbl_lock);
401 * This function releases the lock variables and frees the locks and
404 void mwifiex_free_lock_list(struct mwifiex_adapter *adapter)
406 struct mwifiex_private *priv = NULL;
411 list_del(&adapter->cmd_free_q);
412 list_del(&adapter->cmd_pending_q);
413 list_del(&adapter->scan_pending_q);
415 for (i = 0; i < adapter->priv_num; i++)
416 list_del(&adapter->bss_prio_tbl[i].bss_prio_head);
418 for (i = 0; i < adapter->priv_num; i++) {
419 if (adapter->priv[i]) {
420 priv = adapter->priv[i];
421 for (j = 0; j < MAX_NUM_TID; ++j)
422 list_del(&priv->wmm.tid_tbl_ptr[j].ra_list);
423 list_del(&priv->tx_ba_stream_tbl_ptr);
424 list_del(&priv->rx_reorder_tbl_ptr);
430 * This function initializes the firmware.
432 * The following operations are performed sequentially -
433 * - Allocate adapter structure
434 * - Initialize the adapter structure
435 * - Initialize the private structure
436 * - Add BSS priority tables to the adapter structure
437 * - For each interface, send the init commands to firmware
438 * - Send the first command in command pending queue, if available
440 int mwifiex_init_fw(struct mwifiex_adapter *adapter)
443 struct mwifiex_private *priv = NULL;
446 int is_cmd_pend_q_empty;
449 adapter->hw_status = MWIFIEX_HW_STATUS_INITIALIZING;
451 /* Allocate memory for member of adapter structure */
452 ret = mwifiex_allocate_adapter(adapter);
456 /* Initialize adapter structure */
457 mwifiex_init_adapter(adapter);
459 for (i = 0; i < adapter->priv_num; i++) {
460 if (adapter->priv[i]) {
461 priv = adapter->priv[i];
463 /* Initialize private structure */
464 ret = mwifiex_init_priv(priv);
469 for (i = 0; i < adapter->priv_num; i++) {
470 if (adapter->priv[i]) {
471 ret = mwifiex_sta_init_cmd(adapter->priv[i], first_sta);
479 spin_lock_irqsave(&adapter->cmd_pending_q_lock, flags);
480 is_cmd_pend_q_empty = list_empty(&adapter->cmd_pending_q);
481 spin_unlock_irqrestore(&adapter->cmd_pending_q_lock, flags);
482 if (!is_cmd_pend_q_empty) {
483 /* Send the first command in queue and return */
484 if (mwifiex_main_process(adapter) != -1)
487 adapter->hw_status = MWIFIEX_HW_STATUS_READY;
494 * This function deletes the BSS priority tables.
496 * The function traverses through all the allocated BSS priority nodes
497 * in every BSS priority table and frees them.
499 static void mwifiex_delete_bss_prio_tbl(struct mwifiex_private *priv)
502 struct mwifiex_adapter *adapter = priv->adapter;
503 struct mwifiex_bss_prio_node *bssprio_node = NULL, *tmp_node = NULL,
505 struct list_head *head;
509 for (i = 0; i < adapter->priv_num; ++i) {
510 head = &adapter->bss_prio_tbl[i].bss_prio_head;
511 cur = &adapter->bss_prio_tbl[i].bss_prio_cur;
512 lock = &adapter->bss_prio_tbl[i].bss_prio_lock;
513 dev_dbg(adapter->dev, "info: delete BSS priority table,"
514 " index = %d, i = %d, head = %p, cur = %p\n",
515 priv->bss_index, i, head, *cur);
517 spin_lock_irqsave(lock, flags);
518 if (list_empty(head)) {
519 spin_unlock_irqrestore(lock, flags);
522 bssprio_node = list_first_entry(head,
523 struct mwifiex_bss_prio_node, list);
524 spin_unlock_irqrestore(lock, flags);
526 list_for_each_entry_safe(bssprio_node, tmp_node, head,
528 if (bssprio_node->priv == priv) {
529 dev_dbg(adapter->dev, "info: Delete "
530 "node %p, next = %p\n",
531 bssprio_node, tmp_node);
532 spin_lock_irqsave(lock, flags);
533 list_del(&bssprio_node->list);
534 spin_unlock_irqrestore(lock, flags);
538 *cur = (struct mwifiex_bss_prio_node *)head;
544 * This function is used to shutdown the driver.
546 * The following operations are performed sequentially -
547 * - Check if already shut down
548 * - Make sure the main process has stopped
549 * - Clean up the Tx and Rx queues
550 * - Delete BSS priority tables
552 * - Notify completion
555 mwifiex_shutdown_drv(struct mwifiex_adapter *adapter)
557 int ret = -EINPROGRESS;
558 struct mwifiex_private *priv = NULL;
562 /* mwifiex already shutdown */
563 if (adapter->hw_status == MWIFIEX_HW_STATUS_NOT_READY)
566 adapter->hw_status = MWIFIEX_HW_STATUS_CLOSING;
567 /* wait for mwifiex_process to complete */
568 if (adapter->mwifiex_processing) {
569 dev_warn(adapter->dev, "main process is still running\n");
573 /* shut down mwifiex */
574 dev_dbg(adapter->dev, "info: shutdown mwifiex...\n");
576 /* Clean up Tx/Rx queues and delete BSS priority table */
577 for (i = 0; i < adapter->priv_num; i++) {
578 if (adapter->priv[i]) {
579 priv = adapter->priv[i];
581 mwifiex_clean_txrx(priv);
582 mwifiex_delete_bss_prio_tbl(priv);
586 spin_lock_irqsave(&adapter->mwifiex_lock, flags);
588 /* Free adapter structure */
589 mwifiex_free_adapter(adapter);
591 spin_unlock_irqrestore(&adapter->mwifiex_lock, flags);
593 /* Notify completion */
594 ret = mwifiex_shutdown_fw_complete(adapter);
600 * This function downloads the firmware to the card.
602 * The actual download is preceded by two sanity checks -
603 * - Check if firmware is already running
604 * - Check if the interface is the winner to download the firmware
606 * ...and followed by another -
607 * - Check if the firmware is downloaded successfully
609 * After download is successfully completed, the host interrupts are enabled.
611 int mwifiex_dnld_fw(struct mwifiex_adapter *adapter,
612 struct mwifiex_fw_image *pmfw)
618 /* Check if firmware is already running */
619 ret = adapter->if_ops.check_fw_status(adapter, poll_num, &winner);
621 dev_notice(adapter->dev,
622 "WLAN FW already running! Skip FW download\n");
625 poll_num = MAX_FIRMWARE_POLL_TRIES;
627 /* Check if we are the winner for downloading FW */
629 dev_notice(adapter->dev,
630 "Other interface already running!"
631 " Skip FW download\n");
632 poll_num = MAX_MULTI_INTERFACE_POLL_TRIES;
636 /* Download firmware with helper */
637 ret = adapter->if_ops.prog_fw(adapter, pmfw);
639 dev_err(adapter->dev, "prog_fw failed ret=%#x\n", ret);
645 /* Check if the firmware is downloaded successfully or not */
646 ret = adapter->if_ops.check_fw_status(adapter, poll_num, NULL);
648 dev_err(adapter->dev, "FW failed to be active in time\n");
652 /* re-enable host interrupt for mwifiex after fw dnld is successful */
653 adapter->if_ops.enable_int(adapter);