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
;
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 (!adapter
->bss_prio_tbl
[priv
->bss_priority
].bss_prio_cur
)
51 adapter
->bss_prio_tbl
[priv
->bss_priority
].bss_prio_cur
=
54 spin_lock_irqsave(&adapter
->bss_prio_tbl
[priv
->bss_priority
]
55 .bss_prio_lock
, flags
);
56 list_add_tail(&bss_prio
->list
,
57 &adapter
->bss_prio_tbl
[priv
->bss_priority
]
59 spin_unlock_irqrestore(&adapter
->bss_prio_tbl
[priv
->bss_priority
]
60 .bss_prio_lock
, flags
);
66 * This function initializes the private structure and sets default
67 * values to the members.
69 * Additionally, it also initializes all the locks and sets up all the
72 static int mwifiex_init_priv(struct mwifiex_private
*priv
)
77 priv
->media_connected
= false;
78 memset(priv
->curr_addr
, 0xff, ETH_ALEN
);
80 priv
->pkt_tx_ctrl
= 0;
81 priv
->bss_mode
= NL80211_IFTYPE_STATION
;
82 priv
->data_rate
= 0; /* Initially indicate the rate as auto */
83 priv
->is_data_rate_auto
= true;
84 priv
->bcn_avg_factor
= DEFAULT_BCN_AVG_FACTOR
;
85 priv
->data_avg_factor
= DEFAULT_DATA_AVG_FACTOR
;
87 priv
->sec_info
.wep_status
= MWIFIEX_802_11_WEP_DISABLED
;
88 priv
->sec_info
.authentication_mode
= NL80211_AUTHTYPE_OPEN_SYSTEM
;
89 priv
->sec_info
.encryption_mode
= 0;
90 for (i
= 0; i
< ARRAY_SIZE(priv
->wep_key
); i
++)
91 memset(&priv
->wep_key
[i
], 0, sizeof(struct mwifiex_wep_key
));
92 priv
->wep_key_curr_index
= 0;
93 priv
->curr_pkt_filter
= HostCmd_ACT_MAC_RX_ON
| HostCmd_ACT_MAC_TX_ON
|
94 HostCmd_ACT_MAC_ETHERNETII_ENABLE
;
96 priv
->beacon_period
= 100; /* beacon interval */ ;
97 priv
->attempted_bss_desc
= NULL
;
98 memset(&priv
->curr_bss_params
, 0, sizeof(priv
->curr_bss_params
));
99 priv
->listen_interval
= MWIFIEX_DEFAULT_LISTEN_INTERVAL
;
101 memset(&priv
->prev_ssid
, 0, sizeof(priv
->prev_ssid
));
102 memset(&priv
->prev_bssid
, 0, sizeof(priv
->prev_bssid
));
103 memset(&priv
->assoc_rsp_buf
, 0, sizeof(priv
->assoc_rsp_buf
));
104 priv
->assoc_rsp_size
= 0;
105 priv
->adhoc_channel
= DEFAULT_AD_HOC_CHANNEL
;
106 priv
->atim_window
= 0;
107 priv
->adhoc_state
= ADHOC_IDLE
;
108 priv
->tx_power_level
= 0;
109 priv
->max_tx_power_level
= 0;
110 priv
->min_tx_power_level
= 0;
112 priv
->rxpd_htinfo
= 0;
114 priv
->rate_bitmap
= 0;
115 priv
->data_rssi_last
= 0;
116 priv
->data_rssi_avg
= 0;
117 priv
->data_nf_avg
= 0;
118 priv
->data_nf_last
= 0;
119 priv
->bcn_rssi_last
= 0;
120 priv
->bcn_rssi_avg
= 0;
121 priv
->bcn_nf_avg
= 0;
122 priv
->bcn_nf_last
= 0;
123 memset(&priv
->wpa_ie
, 0, sizeof(priv
->wpa_ie
));
124 memset(&priv
->aes_key
, 0, sizeof(priv
->aes_key
));
125 priv
->wpa_ie_len
= 0;
126 priv
->wpa_is_gtk_set
= false;
128 memset(&priv
->assoc_tlv_buf
, 0, sizeof(priv
->assoc_tlv_buf
));
129 priv
->assoc_tlv_buf_len
= 0;
130 memset(&priv
->wps
, 0, sizeof(priv
->wps
));
131 memset(&priv
->gen_ie_buf
, 0, sizeof(priv
->gen_ie_buf
));
132 priv
->gen_ie_buf_len
= 0;
133 memset(priv
->vs_ie
, 0, sizeof(priv
->vs_ie
));
135 priv
->wmm_required
= true;
136 priv
->wmm_enabled
= false;
137 priv
->wmm_qosinfo
= 0;
138 priv
->curr_bcn_buf
= NULL
;
139 priv
->curr_bcn_size
= 0;
141 priv
->scan_block
= false;
143 ret
= mwifiex_add_bss_prio_tbl(priv
);
149 * This function allocates buffers for members of the adapter
152 * The memory allocated includes scan table, command buffers, and
153 * sleep confirm command buffer. In addition, the queues are
156 static int mwifiex_allocate_adapter(struct mwifiex_adapter
*adapter
)
160 struct mwifiex_bssdescriptor
*temp_scan_table
;
162 /* Allocate buffer to store the BSSID list */
163 buf_size
= sizeof(struct mwifiex_bssdescriptor
) * IW_MAX_AP
;
164 temp_scan_table
= kzalloc(buf_size
, GFP_KERNEL
);
165 if (!temp_scan_table
) {
166 dev_err(adapter
->dev
, "%s: failed to alloc temp_scan_table\n",
171 adapter
->scan_table
= temp_scan_table
;
173 /* Allocate command buffer */
174 ret
= mwifiex_alloc_cmd_buffer(adapter
);
176 dev_err(adapter
->dev
, "%s: failed to alloc cmd buffer\n",
182 dev_alloc_skb(sizeof(struct mwifiex_opt_sleep_confirm_buffer
)
185 if (!adapter
->sleep_cfm
) {
186 dev_err(adapter
->dev
, "%s: failed to alloc sleep cfm"
187 " cmd buffer\n", __func__
);
190 skb_reserve(adapter
->sleep_cfm
, INTF_HEADER_LEN
);
196 * This function initializes the adapter structure and sets default
197 * values to the members of adapter.
199 * This also initializes the WMM related parameters in the driver private
202 static void mwifiex_init_adapter(struct mwifiex_adapter
*adapter
)
204 struct mwifiex_opt_sleep_confirm_buffer
*sleep_cfm_buf
= NULL
;
206 skb_put(adapter
->sleep_cfm
, sizeof(sleep_cfm_buf
->ps_cfm_sleep
));
207 sleep_cfm_buf
= (struct mwifiex_opt_sleep_confirm_buffer
*)
208 (adapter
->sleep_cfm
->data
);
210 adapter
->cmd_sent
= false;
211 adapter
->data_sent
= true;
212 adapter
->cmd_resp_received
= false;
213 adapter
->event_received
= false;
214 adapter
->data_received
= false;
216 adapter
->surprise_removed
= false;
218 adapter
->hw_status
= MWIFIEX_HW_STATUS_INITIALIZING
;
220 adapter
->ps_mode
= MWIFIEX_802_11_POWER_MODE_CAM
;
221 adapter
->ps_state
= PS_STATE_AWAKE
;
222 adapter
->need_to_wakeup
= false;
224 adapter
->scan_mode
= HostCmd_BSS_MODE_ANY
;
225 adapter
->specific_scan_time
= MWIFIEX_SPECIFIC_SCAN_CHAN_TIME
;
226 adapter
->active_scan_time
= MWIFIEX_ACTIVE_SCAN_CHAN_TIME
;
227 adapter
->passive_scan_time
= MWIFIEX_PASSIVE_SCAN_CHAN_TIME
;
229 adapter
->num_in_scan_table
= 0;
230 memset(adapter
->scan_table
, 0,
231 (sizeof(struct mwifiex_bssdescriptor
) * IW_MAX_AP
));
232 adapter
->scan_probes
= 1;
234 memset(adapter
->bcn_buf
, 0, sizeof(adapter
->bcn_buf
));
235 adapter
->bcn_buf_end
= adapter
->bcn_buf
;
237 adapter
->multiple_dtim
= 1;
239 adapter
->local_listen_interval
= 0; /* default value in firmware
242 adapter
->is_deep_sleep
= false;
244 adapter
->delay_null_pkt
= false;
245 adapter
->delay_to_ps
= 1000;
246 adapter
->enhanced_ps_mode
= PS_MODE_AUTO
;
248 adapter
->gen_null_pkt
= false; /* Disable NULL Pkg generation by
250 adapter
->pps_uapsd_mode
= false; /* Disable pps/uapsd mode by
252 adapter
->pm_wakeup_card_req
= false;
254 adapter
->pm_wakeup_fw_try
= false;
256 adapter
->max_tx_buf_size
= MWIFIEX_TX_DATA_BUF_SIZE_2K
;
257 adapter
->tx_buf_size
= MWIFIEX_TX_DATA_BUF_SIZE_2K
;
258 adapter
->curr_tx_buf_size
= MWIFIEX_TX_DATA_BUF_SIZE_2K
;
260 adapter
->is_hs_configured
= false;
261 adapter
->hs_cfg
.conditions
= cpu_to_le32(HOST_SLEEP_CFG_COND_DEF
);
262 adapter
->hs_cfg
.gpio
= HOST_SLEEP_CFG_GPIO_DEF
;
263 adapter
->hs_cfg
.gap
= HOST_SLEEP_CFG_GAP_DEF
;
264 adapter
->hs_activated
= false;
266 memset(adapter
->event_body
, 0, sizeof(adapter
->event_body
));
267 adapter
->hw_dot_11n_dev_cap
= 0;
268 adapter
->hw_dev_mcs_support
= 0;
269 adapter
->chan_offset
= 0;
270 adapter
->adhoc_11n_enabled
= false;
272 mwifiex_wmm_init(adapter
);
274 if (adapter
->sleep_cfm
) {
275 memset(&sleep_cfm_buf
->ps_cfm_sleep
, 0,
276 adapter
->sleep_cfm
->len
);
277 sleep_cfm_buf
->ps_cfm_sleep
.command
=
278 cpu_to_le16(HostCmd_CMD_802_11_PS_MODE_ENH
);
279 sleep_cfm_buf
->ps_cfm_sleep
.size
=
280 cpu_to_le16(adapter
->sleep_cfm
->len
);
281 sleep_cfm_buf
->ps_cfm_sleep
.result
= 0;
282 sleep_cfm_buf
->ps_cfm_sleep
.action
= cpu_to_le16(SLEEP_CONFIRM
);
283 sleep_cfm_buf
->ps_cfm_sleep
.resp_ctrl
=
284 cpu_to_le16(RESP_NEEDED
);
286 memset(&adapter
->sleep_params
, 0, sizeof(adapter
->sleep_params
));
287 memset(&adapter
->sleep_period
, 0, sizeof(adapter
->sleep_period
));
288 adapter
->tx_lock_flag
= false;
289 adapter
->null_pkt_interval
= 0;
290 adapter
->fw_bands
= 0;
291 adapter
->config_bands
= 0;
292 adapter
->adhoc_start_band
= 0;
293 adapter
->scan_channels
= NULL
;
294 adapter
->fw_release_number
= 0;
295 adapter
->fw_cap_info
= 0;
296 memset(&adapter
->upld_buf
, 0, sizeof(adapter
->upld_buf
));
297 adapter
->event_cause
= 0;
298 adapter
->region_code
= 0;
299 adapter
->bcn_miss_time_out
= DEFAULT_BCN_MISS_TIMEOUT
;
300 adapter
->adhoc_awake_period
= 0;
301 memset(&adapter
->arp_filter
, 0, sizeof(adapter
->arp_filter
));
302 adapter
->arp_filter_size
= 0;
308 * This function frees the adapter structure.
310 * The freeing operation is done recursively, by canceling all
311 * pending commands, freeing the member buffers previously
312 * allocated (command buffers, scan table buffer, sleep confirm
313 * command buffer), stopping the timers and calling the cleanup
314 * routines for every interface, before the actual adapter
315 * structure is freed.
318 mwifiex_free_adapter(struct mwifiex_adapter
*adapter
)
321 pr_err("%s: adapter is NULL\n", __func__
);
325 mwifiex_cancel_all_pending_cmd(adapter
);
327 /* Free lock variables */
328 mwifiex_free_lock_list(adapter
);
330 /* Free command buffer */
331 dev_dbg(adapter
->dev
, "info: free cmd buffer\n");
332 mwifiex_free_cmd_buffer(adapter
);
334 del_timer(&adapter
->cmd_timer
);
336 dev_dbg(adapter
->dev
, "info: free scan table\n");
337 kfree(adapter
->scan_table
);
338 adapter
->scan_table
= NULL
;
340 adapter
->if_ops
.cleanup_if(adapter
);
342 dev_kfree_skb_any(adapter
->sleep_cfm
);
348 * This function intializes the lock variables and
351 int mwifiex_init_lock_list(struct mwifiex_adapter
*adapter
)
353 struct mwifiex_private
*priv
= NULL
;
357 spin_lock_init(&adapter
->mwifiex_lock
);
358 spin_lock_init(&adapter
->int_lock
);
359 spin_lock_init(&adapter
->main_proc_lock
);
360 spin_lock_init(&adapter
->mwifiex_cmd_lock
);
361 for (i
= 0; i
< adapter
->priv_num
; i
++) {
362 if (adapter
->priv
[i
]) {
363 priv
= adapter
->priv
[i
];
364 spin_lock_init(&priv
->rx_pkt_lock
);
365 spin_lock_init(&priv
->wmm
.ra_list_spinlock
);
366 spin_lock_init(&priv
->curr_bcn_buf_lock
);
370 /* Initialize cmd_free_q */
371 INIT_LIST_HEAD(&adapter
->cmd_free_q
);
372 /* Initialize cmd_pending_q */
373 INIT_LIST_HEAD(&adapter
->cmd_pending_q
);
374 /* Initialize scan_pending_q */
375 INIT_LIST_HEAD(&adapter
->scan_pending_q
);
377 spin_lock_init(&adapter
->cmd_free_q_lock
);
378 spin_lock_init(&adapter
->cmd_pending_q_lock
);
379 spin_lock_init(&adapter
->scan_pending_q_lock
);
381 for (i
= 0; i
< adapter
->priv_num
; ++i
) {
382 INIT_LIST_HEAD(&adapter
->bss_prio_tbl
[i
].bss_prio_head
);
383 adapter
->bss_prio_tbl
[i
].bss_prio_cur
= NULL
;
384 spin_lock_init(&adapter
->bss_prio_tbl
[i
].bss_prio_lock
);
387 for (i
= 0; i
< adapter
->priv_num
; i
++) {
388 if (!adapter
->priv
[i
])
390 priv
= adapter
->priv
[i
];
391 for (j
= 0; j
< MAX_NUM_TID
; ++j
) {
392 INIT_LIST_HEAD(&priv
->wmm
.tid_tbl_ptr
[j
].ra_list
);
393 spin_lock_init(&priv
->wmm
.tid_tbl_ptr
[j
].tid_tbl_lock
);
395 INIT_LIST_HEAD(&priv
->tx_ba_stream_tbl_ptr
);
396 INIT_LIST_HEAD(&priv
->rx_reorder_tbl_ptr
);
398 spin_lock_init(&priv
->tx_ba_stream_tbl_lock
);
399 spin_lock_init(&priv
->rx_reorder_tbl_lock
);
406 * This function releases the lock variables and frees the locks and
409 void mwifiex_free_lock_list(struct mwifiex_adapter
*adapter
)
411 struct mwifiex_private
*priv
= NULL
;
416 list_del(&adapter
->cmd_free_q
);
417 list_del(&adapter
->cmd_pending_q
);
418 list_del(&adapter
->scan_pending_q
);
420 for (i
= 0; i
< adapter
->priv_num
; i
++)
421 list_del(&adapter
->bss_prio_tbl
[i
].bss_prio_head
);
423 for (i
= 0; i
< adapter
->priv_num
; i
++) {
424 if (adapter
->priv
[i
]) {
425 priv
= adapter
->priv
[i
];
426 for (j
= 0; j
< MAX_NUM_TID
; ++j
)
427 list_del(&priv
->wmm
.tid_tbl_ptr
[j
].ra_list
);
428 list_del(&priv
->tx_ba_stream_tbl_ptr
);
429 list_del(&priv
->rx_reorder_tbl_ptr
);
437 * This function initializes the firmware.
439 * The following operations are performed sequentially -
440 * - Allocate adapter structure
441 * - Initialize the adapter structure
442 * - Initialize the private structure
443 * - Add BSS priority tables to the adapter structure
444 * - For each interface, send the init commands to firmware
445 * - Send the first command in command pending queue, if available
447 int mwifiex_init_fw(struct mwifiex_adapter
*adapter
)
450 struct mwifiex_private
*priv
= NULL
;
453 int is_cmd_pend_q_empty
;
456 adapter
->hw_status
= MWIFIEX_HW_STATUS_INITIALIZING
;
458 /* Allocate memory for member of adapter structure */
459 ret
= mwifiex_allocate_adapter(adapter
);
463 /* Initialize adapter structure */
464 mwifiex_init_adapter(adapter
);
466 for (i
= 0; i
< adapter
->priv_num
; i
++) {
467 if (adapter
->priv
[i
]) {
468 priv
= adapter
->priv
[i
];
470 /* Initialize private structure */
471 ret
= mwifiex_init_priv(priv
);
476 for (i
= 0; i
< adapter
->priv_num
; i
++) {
477 if (adapter
->priv
[i
]) {
478 ret
= mwifiex_sta_init_cmd(adapter
->priv
[i
], first_sta
);
486 spin_lock_irqsave(&adapter
->cmd_pending_q_lock
, flags
);
487 is_cmd_pend_q_empty
= list_empty(&adapter
->cmd_pending_q
);
488 spin_unlock_irqrestore(&adapter
->cmd_pending_q_lock
, flags
);
489 if (!is_cmd_pend_q_empty
) {
490 /* Send the first command in queue and return */
491 if (mwifiex_main_process(adapter
) != -1)
494 adapter
->hw_status
= MWIFIEX_HW_STATUS_READY
;
501 * This function deletes the BSS priority tables.
503 * The function traverses through all the allocated BSS priority nodes
504 * in every BSS priority table and frees them.
506 static void mwifiex_delete_bss_prio_tbl(struct mwifiex_private
*priv
)
509 struct mwifiex_adapter
*adapter
= priv
->adapter
;
510 struct mwifiex_bss_prio_node
*bssprio_node
= NULL
, *tmp_node
= NULL
,
512 struct list_head
*head
;
516 for (i
= 0; i
< adapter
->priv_num
; ++i
) {
517 head
= &adapter
->bss_prio_tbl
[i
].bss_prio_head
;
518 cur
= &adapter
->bss_prio_tbl
[i
].bss_prio_cur
;
519 lock
= &adapter
->bss_prio_tbl
[i
].bss_prio_lock
;
520 dev_dbg(adapter
->dev
, "info: delete BSS priority table,"
521 " index = %d, i = %d, head = %p, cur = %p\n",
522 priv
->bss_index
, i
, head
, *cur
);
524 spin_lock_irqsave(lock
, flags
);
525 if (list_empty(head
)) {
526 spin_unlock_irqrestore(lock
, flags
);
529 bssprio_node
= list_first_entry(head
,
530 struct mwifiex_bss_prio_node
, list
);
531 spin_unlock_irqrestore(lock
, flags
);
533 list_for_each_entry_safe(bssprio_node
, tmp_node
, head
,
535 if (bssprio_node
->priv
== priv
) {
536 dev_dbg(adapter
->dev
, "info: Delete "
537 "node %p, next = %p\n",
538 bssprio_node
, tmp_node
);
539 spin_lock_irqsave(lock
, flags
);
540 list_del(&bssprio_node
->list
);
541 spin_unlock_irqrestore(lock
, flags
);
545 *cur
= (struct mwifiex_bss_prio_node
*)head
;
551 * This function is used to shutdown the driver.
553 * The following operations are performed sequentially -
554 * - Check if already shut down
555 * - Make sure the main process has stopped
556 * - Clean up the Tx and Rx queues
557 * - Delete BSS priority tables
559 * - Notify completion
562 mwifiex_shutdown_drv(struct mwifiex_adapter
*adapter
)
564 int ret
= -EINPROGRESS
;
565 struct mwifiex_private
*priv
= NULL
;
569 /* mwifiex already shutdown */
570 if (adapter
->hw_status
== MWIFIEX_HW_STATUS_NOT_READY
)
573 adapter
->hw_status
= MWIFIEX_HW_STATUS_CLOSING
;
574 /* wait for mwifiex_process to complete */
575 if (adapter
->mwifiex_processing
) {
576 dev_warn(adapter
->dev
, "main process is still running\n");
580 /* shut down mwifiex */
581 dev_dbg(adapter
->dev
, "info: shutdown mwifiex...\n");
583 /* Clean up Tx/Rx queues and delete BSS priority table */
584 for (i
= 0; i
< adapter
->priv_num
; i
++) {
585 if (adapter
->priv
[i
]) {
586 priv
= adapter
->priv
[i
];
588 mwifiex_clean_txrx(priv
);
589 mwifiex_delete_bss_prio_tbl(priv
);
593 spin_lock_irqsave(&adapter
->mwifiex_lock
, flags
);
595 /* Free adapter structure */
596 mwifiex_free_adapter(adapter
);
598 spin_unlock_irqrestore(&adapter
->mwifiex_lock
, flags
);
600 /* Notify completion */
601 ret
= mwifiex_shutdown_fw_complete(adapter
);
607 * This function downloads the firmware to the card.
609 * The actual download is preceded by two sanity checks -
610 * - Check if firmware is already running
611 * - Check if the interface is the winner to download the firmware
613 * ...and followed by another -
614 * - Check if the firmware is downloaded successfully
616 * After download is successfully completed, the host interrupts are enabled.
618 int mwifiex_dnld_fw(struct mwifiex_adapter
*adapter
,
619 struct mwifiex_fw_image
*pmfw
)
625 /* Check if firmware is already running */
626 ret
= adapter
->if_ops
.check_fw_status(adapter
, poll_num
, &winner
);
628 dev_notice(adapter
->dev
,
629 "WLAN FW already running! Skip FW download\n");
632 poll_num
= MAX_FIRMWARE_POLL_TRIES
;
634 /* Check if we are the winner for downloading FW */
636 dev_notice(adapter
->dev
,
637 "Other interface already running!"
638 " Skip FW download\n");
639 poll_num
= MAX_MULTI_INTERFACE_POLL_TRIES
;
643 /* Download firmware with helper */
644 ret
= adapter
->if_ops
.prog_fw(adapter
, pmfw
);
646 dev_err(adapter
->dev
, "prog_fw failed ret=%#x\n", ret
);
652 /* Check if the firmware is downloaded successfully or not */
653 ret
= adapter
->if_ops
.check_fw_status(adapter
, poll_num
, NULL
);
655 dev_err(adapter
->dev
, "FW failed to be active in time\n");
659 /* re-enable host interrupt for mwifiex after fw dnld is successful */
660 adapter
->if_ops
.enable_int(adapter
);