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_STATION
;
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 struct mwifiex_bssdescriptor
*temp_scan_table
;
158 /* Allocate buffer to store the BSSID list */
159 buf_size
= sizeof(struct mwifiex_bssdescriptor
) * IW_MAX_AP
;
160 temp_scan_table
= kzalloc(buf_size
, GFP_KERNEL
);
161 if (!temp_scan_table
) {
162 dev_err(adapter
->dev
, "%s: failed to alloc temp_scan_table\n",
167 adapter
->scan_table
= temp_scan_table
;
169 /* Allocate command buffer */
170 ret
= mwifiex_alloc_cmd_buffer(adapter
);
172 dev_err(adapter
->dev
, "%s: failed to alloc cmd buffer\n",
178 dev_alloc_skb(sizeof(struct mwifiex_opt_sleep_confirm_buffer
)
181 if (!adapter
->sleep_cfm
) {
182 dev_err(adapter
->dev
, "%s: failed to alloc sleep cfm"
183 " cmd buffer\n", __func__
);
186 skb_reserve(adapter
->sleep_cfm
, INTF_HEADER_LEN
);
192 * This function initializes the adapter structure and sets default
193 * values to the members of adapter.
195 * This also initializes the WMM related parameters in the driver private
198 static void mwifiex_init_adapter(struct mwifiex_adapter
*adapter
)
200 struct mwifiex_opt_sleep_confirm_buffer
*sleep_cfm_buf
= NULL
;
202 skb_put(adapter
->sleep_cfm
, sizeof(sleep_cfm_buf
->ps_cfm_sleep
));
203 sleep_cfm_buf
= (struct mwifiex_opt_sleep_confirm_buffer
*)
204 (adapter
->sleep_cfm
->data
);
206 adapter
->cmd_sent
= false;
207 adapter
->data_sent
= true;
208 adapter
->cmd_resp_received
= false;
209 adapter
->event_received
= false;
210 adapter
->data_received
= false;
212 adapter
->surprise_removed
= false;
214 adapter
->hw_status
= MWIFIEX_HW_STATUS_INITIALIZING
;
216 adapter
->ps_mode
= MWIFIEX_802_11_POWER_MODE_CAM
;
217 adapter
->ps_state
= PS_STATE_AWAKE
;
218 adapter
->need_to_wakeup
= false;
220 adapter
->scan_mode
= HostCmd_BSS_MODE_ANY
;
221 adapter
->specific_scan_time
= MWIFIEX_SPECIFIC_SCAN_CHAN_TIME
;
222 adapter
->active_scan_time
= MWIFIEX_ACTIVE_SCAN_CHAN_TIME
;
223 adapter
->passive_scan_time
= MWIFIEX_PASSIVE_SCAN_CHAN_TIME
;
225 adapter
->num_in_scan_table
= 0;
226 memset(adapter
->scan_table
, 0,
227 (sizeof(struct mwifiex_bssdescriptor
) * IW_MAX_AP
));
228 adapter
->scan_probes
= 1;
230 memset(adapter
->bcn_buf
, 0, sizeof(adapter
->bcn_buf
));
231 adapter
->bcn_buf_end
= adapter
->bcn_buf
;
233 adapter
->multiple_dtim
= 1;
235 adapter
->local_listen_interval
= 0; /* default value in firmware
238 adapter
->is_deep_sleep
= false;
240 adapter
->delay_null_pkt
= false;
241 adapter
->delay_to_ps
= 1000;
242 adapter
->enhanced_ps_mode
= PS_MODE_AUTO
;
244 adapter
->gen_null_pkt
= false; /* Disable NULL Pkg generation by
246 adapter
->pps_uapsd_mode
= false; /* Disable pps/uapsd mode by
248 adapter
->pm_wakeup_card_req
= false;
250 adapter
->pm_wakeup_fw_try
= false;
252 adapter
->max_tx_buf_size
= MWIFIEX_TX_DATA_BUF_SIZE_2K
;
253 adapter
->tx_buf_size
= MWIFIEX_TX_DATA_BUF_SIZE_2K
;
254 adapter
->curr_tx_buf_size
= MWIFIEX_TX_DATA_BUF_SIZE_2K
;
256 adapter
->is_hs_configured
= false;
257 adapter
->hs_cfg
.conditions
= cpu_to_le32(HOST_SLEEP_CFG_COND_DEF
);
258 adapter
->hs_cfg
.gpio
= HOST_SLEEP_CFG_GPIO_DEF
;
259 adapter
->hs_cfg
.gap
= HOST_SLEEP_CFG_GAP_DEF
;
260 adapter
->hs_activated
= false;
262 memset(adapter
->event_body
, 0, sizeof(adapter
->event_body
));
263 adapter
->hw_dot_11n_dev_cap
= 0;
264 adapter
->hw_dev_mcs_support
= 0;
265 adapter
->chan_offset
= 0;
266 adapter
->adhoc_11n_enabled
= false;
268 mwifiex_wmm_init(adapter
);
270 if (adapter
->sleep_cfm
) {
271 memset(&sleep_cfm_buf
->ps_cfm_sleep
, 0,
272 adapter
->sleep_cfm
->len
);
273 sleep_cfm_buf
->ps_cfm_sleep
.command
=
274 cpu_to_le16(HostCmd_CMD_802_11_PS_MODE_ENH
);
275 sleep_cfm_buf
->ps_cfm_sleep
.size
=
276 cpu_to_le16(adapter
->sleep_cfm
->len
);
277 sleep_cfm_buf
->ps_cfm_sleep
.result
= 0;
278 sleep_cfm_buf
->ps_cfm_sleep
.action
= cpu_to_le16(SLEEP_CONFIRM
);
279 sleep_cfm_buf
->ps_cfm_sleep
.resp_ctrl
=
280 cpu_to_le16(RESP_NEEDED
);
282 memset(&adapter
->sleep_params
, 0, sizeof(adapter
->sleep_params
));
283 memset(&adapter
->sleep_period
, 0, sizeof(adapter
->sleep_period
));
284 adapter
->tx_lock_flag
= false;
285 adapter
->null_pkt_interval
= 0;
286 adapter
->fw_bands
= 0;
287 adapter
->config_bands
= 0;
288 adapter
->adhoc_start_band
= 0;
289 adapter
->scan_channels
= NULL
;
290 adapter
->fw_release_number
= 0;
291 adapter
->fw_cap_info
= 0;
292 memset(&adapter
->upld_buf
, 0, sizeof(adapter
->upld_buf
));
293 adapter
->event_cause
= 0;
294 adapter
->region_code
= 0;
295 adapter
->bcn_miss_time_out
= DEFAULT_BCN_MISS_TIMEOUT
;
296 adapter
->adhoc_awake_period
= 0;
297 memset(&adapter
->arp_filter
, 0, sizeof(adapter
->arp_filter
));
298 adapter
->arp_filter_size
= 0;
302 * This function frees the adapter structure.
304 * The freeing operation is done recursively, by canceling all
305 * pending commands, freeing the member buffers previously
306 * allocated (command buffers, scan table buffer, sleep confirm
307 * command buffer), stopping the timers and calling the cleanup
308 * routines for every interface, before the actual adapter
309 * structure is freed.
312 mwifiex_free_adapter(struct mwifiex_adapter
*adapter
)
315 pr_err("%s: adapter is NULL\n", __func__
);
319 mwifiex_cancel_all_pending_cmd(adapter
);
321 /* Free lock variables */
322 mwifiex_free_lock_list(adapter
);
324 /* Free command buffer */
325 dev_dbg(adapter
->dev
, "info: free cmd buffer\n");
326 mwifiex_free_cmd_buffer(adapter
);
328 del_timer(&adapter
->cmd_timer
);
330 dev_dbg(adapter
->dev
, "info: free scan table\n");
331 kfree(adapter
->scan_table
);
332 adapter
->scan_table
= NULL
;
334 adapter
->if_ops
.cleanup_if(adapter
);
336 dev_kfree_skb_any(adapter
->sleep_cfm
);
340 * This function intializes the lock variables and
343 int mwifiex_init_lock_list(struct mwifiex_adapter
*adapter
)
345 struct mwifiex_private
*priv
= NULL
;
349 spin_lock_init(&adapter
->mwifiex_lock
);
350 spin_lock_init(&adapter
->int_lock
);
351 spin_lock_init(&adapter
->main_proc_lock
);
352 spin_lock_init(&adapter
->mwifiex_cmd_lock
);
353 for (i
= 0; i
< adapter
->priv_num
; i
++) {
354 if (adapter
->priv
[i
]) {
355 priv
= adapter
->priv
[i
];
356 spin_lock_init(&priv
->rx_pkt_lock
);
357 spin_lock_init(&priv
->wmm
.ra_list_spinlock
);
358 spin_lock_init(&priv
->curr_bcn_buf_lock
);
362 /* Initialize cmd_free_q */
363 INIT_LIST_HEAD(&adapter
->cmd_free_q
);
364 /* Initialize cmd_pending_q */
365 INIT_LIST_HEAD(&adapter
->cmd_pending_q
);
366 /* Initialize scan_pending_q */
367 INIT_LIST_HEAD(&adapter
->scan_pending_q
);
369 spin_lock_init(&adapter
->cmd_free_q_lock
);
370 spin_lock_init(&adapter
->cmd_pending_q_lock
);
371 spin_lock_init(&adapter
->scan_pending_q_lock
);
373 for (i
= 0; i
< adapter
->priv_num
; ++i
) {
374 INIT_LIST_HEAD(&adapter
->bss_prio_tbl
[i
].bss_prio_head
);
375 adapter
->bss_prio_tbl
[i
].bss_prio_cur
= NULL
;
376 spin_lock_init(&adapter
->bss_prio_tbl
[i
].bss_prio_lock
);
379 for (i
= 0; i
< adapter
->priv_num
; i
++) {
380 if (!adapter
->priv
[i
])
382 priv
= adapter
->priv
[i
];
383 for (j
= 0; j
< MAX_NUM_TID
; ++j
) {
384 INIT_LIST_HEAD(&priv
->wmm
.tid_tbl_ptr
[j
].ra_list
);
385 spin_lock_init(&priv
->wmm
.tid_tbl_ptr
[j
].tid_tbl_lock
);
387 INIT_LIST_HEAD(&priv
->tx_ba_stream_tbl_ptr
);
388 INIT_LIST_HEAD(&priv
->rx_reorder_tbl_ptr
);
390 spin_lock_init(&priv
->tx_ba_stream_tbl_lock
);
391 spin_lock_init(&priv
->rx_reorder_tbl_lock
);
398 * This function releases the lock variables and frees the locks and
401 void mwifiex_free_lock_list(struct mwifiex_adapter
*adapter
)
403 struct mwifiex_private
*priv
= NULL
;
408 list_del(&adapter
->cmd_free_q
);
409 list_del(&adapter
->cmd_pending_q
);
410 list_del(&adapter
->scan_pending_q
);
412 for (i
= 0; i
< adapter
->priv_num
; i
++)
413 list_del(&adapter
->bss_prio_tbl
[i
].bss_prio_head
);
415 for (i
= 0; i
< adapter
->priv_num
; i
++) {
416 if (adapter
->priv
[i
]) {
417 priv
= adapter
->priv
[i
];
418 for (j
= 0; j
< MAX_NUM_TID
; ++j
)
419 list_del(&priv
->wmm
.tid_tbl_ptr
[j
].ra_list
);
420 list_del(&priv
->tx_ba_stream_tbl_ptr
);
421 list_del(&priv
->rx_reorder_tbl_ptr
);
427 * This function initializes the firmware.
429 * The following operations are performed sequentially -
430 * - Allocate adapter structure
431 * - Initialize the adapter structure
432 * - Initialize the private structure
433 * - Add BSS priority tables to the adapter structure
434 * - For each interface, send the init commands to firmware
435 * - Send the first command in command pending queue, if available
437 int mwifiex_init_fw(struct mwifiex_adapter
*adapter
)
440 struct mwifiex_private
*priv
= NULL
;
443 int is_cmd_pend_q_empty
;
446 adapter
->hw_status
= MWIFIEX_HW_STATUS_INITIALIZING
;
448 /* Allocate memory for member of adapter structure */
449 ret
= mwifiex_allocate_adapter(adapter
);
453 /* Initialize adapter structure */
454 mwifiex_init_adapter(adapter
);
456 for (i
= 0; i
< adapter
->priv_num
; i
++) {
457 if (adapter
->priv
[i
]) {
458 priv
= adapter
->priv
[i
];
460 /* Initialize private structure */
461 ret
= mwifiex_init_priv(priv
);
466 for (i
= 0; i
< adapter
->priv_num
; i
++) {
467 if (adapter
->priv
[i
]) {
468 ret
= mwifiex_sta_init_cmd(adapter
->priv
[i
], first_sta
);
476 spin_lock_irqsave(&adapter
->cmd_pending_q_lock
, flags
);
477 is_cmd_pend_q_empty
= list_empty(&adapter
->cmd_pending_q
);
478 spin_unlock_irqrestore(&adapter
->cmd_pending_q_lock
, flags
);
479 if (!is_cmd_pend_q_empty
) {
480 /* Send the first command in queue and return */
481 if (mwifiex_main_process(adapter
) != -1)
484 adapter
->hw_status
= MWIFIEX_HW_STATUS_READY
;
491 * This function deletes the BSS priority tables.
493 * The function traverses through all the allocated BSS priority nodes
494 * in every BSS priority table and frees them.
496 static void mwifiex_delete_bss_prio_tbl(struct mwifiex_private
*priv
)
499 struct mwifiex_adapter
*adapter
= priv
->adapter
;
500 struct mwifiex_bss_prio_node
*bssprio_node
= NULL
, *tmp_node
= NULL
,
502 struct list_head
*head
;
506 for (i
= 0; i
< adapter
->priv_num
; ++i
) {
507 head
= &adapter
->bss_prio_tbl
[i
].bss_prio_head
;
508 cur
= &adapter
->bss_prio_tbl
[i
].bss_prio_cur
;
509 lock
= &adapter
->bss_prio_tbl
[i
].bss_prio_lock
;
510 dev_dbg(adapter
->dev
, "info: delete BSS priority table,"
511 " index = %d, i = %d, head = %p, cur = %p\n",
512 priv
->bss_index
, i
, head
, *cur
);
514 spin_lock_irqsave(lock
, flags
);
515 if (list_empty(head
)) {
516 spin_unlock_irqrestore(lock
, flags
);
519 bssprio_node
= list_first_entry(head
,
520 struct mwifiex_bss_prio_node
, list
);
521 spin_unlock_irqrestore(lock
, flags
);
523 list_for_each_entry_safe(bssprio_node
, tmp_node
, head
,
525 if (bssprio_node
->priv
== priv
) {
526 dev_dbg(adapter
->dev
, "info: Delete "
527 "node %p, next = %p\n",
528 bssprio_node
, tmp_node
);
529 spin_lock_irqsave(lock
, flags
);
530 list_del(&bssprio_node
->list
);
531 spin_unlock_irqrestore(lock
, flags
);
535 *cur
= (struct mwifiex_bss_prio_node
*)head
;
541 * This function is used to shutdown the driver.
543 * The following operations are performed sequentially -
544 * - Check if already shut down
545 * - Make sure the main process has stopped
546 * - Clean up the Tx and Rx queues
547 * - Delete BSS priority tables
549 * - Notify completion
552 mwifiex_shutdown_drv(struct mwifiex_adapter
*adapter
)
554 int ret
= -EINPROGRESS
;
555 struct mwifiex_private
*priv
= NULL
;
559 /* mwifiex already shutdown */
560 if (adapter
->hw_status
== MWIFIEX_HW_STATUS_NOT_READY
)
563 adapter
->hw_status
= MWIFIEX_HW_STATUS_CLOSING
;
564 /* wait for mwifiex_process to complete */
565 if (adapter
->mwifiex_processing
) {
566 dev_warn(adapter
->dev
, "main process is still running\n");
570 /* shut down mwifiex */
571 dev_dbg(adapter
->dev
, "info: shutdown mwifiex...\n");
573 /* Clean up Tx/Rx queues and delete BSS priority table */
574 for (i
= 0; i
< adapter
->priv_num
; i
++) {
575 if (adapter
->priv
[i
]) {
576 priv
= adapter
->priv
[i
];
578 mwifiex_clean_txrx(priv
);
579 mwifiex_delete_bss_prio_tbl(priv
);
583 spin_lock_irqsave(&adapter
->mwifiex_lock
, flags
);
585 /* Free adapter structure */
586 mwifiex_free_adapter(adapter
);
588 spin_unlock_irqrestore(&adapter
->mwifiex_lock
, flags
);
590 /* Notify completion */
591 ret
= mwifiex_shutdown_fw_complete(adapter
);
597 * This function downloads the firmware to the card.
599 * The actual download is preceded by two sanity checks -
600 * - Check if firmware is already running
601 * - Check if the interface is the winner to download the firmware
603 * ...and followed by another -
604 * - Check if the firmware is downloaded successfully
606 * After download is successfully completed, the host interrupts are enabled.
608 int mwifiex_dnld_fw(struct mwifiex_adapter
*adapter
,
609 struct mwifiex_fw_image
*pmfw
)
615 /* Check if firmware is already running */
616 ret
= adapter
->if_ops
.check_fw_status(adapter
, poll_num
, &winner
);
618 dev_notice(adapter
->dev
,
619 "WLAN FW already running! Skip FW download\n");
622 poll_num
= MAX_FIRMWARE_POLL_TRIES
;
624 /* Check if we are the winner for downloading FW */
626 dev_notice(adapter
->dev
,
627 "Other interface already running!"
628 " Skip FW download\n");
629 poll_num
= MAX_MULTI_INTERFACE_POLL_TRIES
;
633 /* Download firmware with helper */
634 ret
= adapter
->if_ops
.prog_fw(adapter
, pmfw
);
636 dev_err(adapter
->dev
, "prog_fw failed ret=%#x\n", ret
);
642 /* Check if the firmware is downloaded successfully or not */
643 ret
= adapter
->if_ops
.check_fw_status(adapter
, poll_num
, NULL
);
645 dev_err(adapter
->dev
, "FW failed to be active in time\n");
649 /* re-enable host interrupt for mwifiex after fw dnld is successful */
650 adapter
->if_ops
.enable_int(adapter
);