1 /*
2  * Copyright (c) 2004-2011 Atheros Communications Inc.
3  * Copyright (c) 2011-2012 Qualcomm Atheros, Inc.
4  *
5  * Permission to use, copy, modify, and/or distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  */
17 
18 #include "core.h"
19 
20 #include <linux/module.h>
21 #include <linux/moduleparam.h>
22 #include <linux/export.h>
23 #include <linux/vmalloc.h>
24 
25 #include "debug.h"
26 #include "hif-ops.h"
27 #include "htc-ops.h"
28 #include "cfg80211.h"
29 
30 unsigned int debug_mask;
31 static unsigned int suspend_mode;
32 static unsigned int wow_mode;
33 static unsigned int uart_debug;
34 static unsigned int ath6kl_p2p;
35 static unsigned int testmode;
36 static unsigned int recovery_enable;
37 static unsigned int heart_beat_poll;
38 
39 module_param(debug_mask, uint, 0644);
40 module_param(suspend_mode, uint, 0644);
41 module_param(wow_mode, uint, 0644);
42 module_param(uart_debug, uint, 0644);
43 module_param(ath6kl_p2p, uint, 0644);
44 module_param(testmode, uint, 0644);
45 module_param(recovery_enable, uint, 0644);
46 module_param(heart_beat_poll, uint, 0644);
47 MODULE_PARM_DESC(recovery_enable, "Enable recovery from firmware error");
48 MODULE_PARM_DESC(heart_beat_poll,
49 		 "Enable fw error detection periodic polling in msecs - Also set recovery_enable for this to be effective");
50 
51 
52 void ath6kl_core_tx_complete(struct ath6kl *ar, struct sk_buff *skb)
53 {
54 	ath6kl_htc_tx_complete(ar, skb);
55 }
56 EXPORT_SYMBOL(ath6kl_core_tx_complete);
57 
58 void ath6kl_core_rx_complete(struct ath6kl *ar, struct sk_buff *skb, u8 pipe)
59 {
60 	ath6kl_htc_rx_complete(ar, skb, pipe);
61 }
62 EXPORT_SYMBOL(ath6kl_core_rx_complete);
63 
64 int ath6kl_core_init(struct ath6kl *ar, enum ath6kl_htc_type htc_type)
65 {
66 	struct ath6kl_bmi_target_info targ_info;
67 	struct wireless_dev *wdev;
68 	int ret = 0, i;
69 
70 	switch (htc_type) {
71 	case ATH6KL_HTC_TYPE_MBOX:
72 		ath6kl_htc_mbox_attach(ar);
73 		break;
74 	case ATH6KL_HTC_TYPE_PIPE:
75 		ath6kl_htc_pipe_attach(ar);
76 		break;
77 	default:
78 		WARN_ON(1);
79 		return -ENOMEM;
80 	}
81 
82 	ar->ath6kl_wq = create_singlethread_workqueue("ath6kl");
83 	if (!ar->ath6kl_wq)
84 		return -ENOMEM;
85 
86 	ret = ath6kl_bmi_init(ar);
87 	if (ret)
88 		goto err_wq;
89 
90 	/*
91 	 * Turn on power to get hardware (target) version and leave power
92 	 * on delibrately as we will boot the hardware anyway within few
93 	 * seconds.
94 	 */
95 	ret = ath6kl_hif_power_on(ar);
96 	if (ret)
97 		goto err_bmi_cleanup;
98 
99 	ret = ath6kl_bmi_get_target_info(ar, &targ_info);
100 	if (ret)
101 		goto err_power_off;
102 
103 	ar->version.target_ver = le32_to_cpu(targ_info.version);
104 	ar->target_type = le32_to_cpu(targ_info.type);
105 	ar->wiphy->hw_version = le32_to_cpu(targ_info.version);
106 
107 	ret = ath6kl_init_hw_params(ar);
108 	if (ret)
109 		goto err_power_off;
110 
111 	ar->htc_target = ath6kl_htc_create(ar);
112 
113 	if (!ar->htc_target) {
114 		ret = -ENOMEM;
115 		goto err_power_off;
116 	}
117 
118 	ar->testmode = testmode;
119 
120 	ret = ath6kl_init_fetch_firmwares(ar);
121 	if (ret)
122 		goto err_htc_cleanup;
123 
124 	/* FIXME: we should free all firmwares in the error cases below */
125 
126 	/*
127 	 * Backwards compatibility support for older ar6004 firmware images
128 	 * which do not set these feature flags.
129 	 */
130 	if (ar->target_type == TARGET_TYPE_AR6004 &&
131 	    ar->fw_api <= 4) {
132 		__set_bit(ATH6KL_FW_CAPABILITY_64BIT_RATES,
133 			  ar->fw_capabilities);
134 		__set_bit(ATH6KL_FW_CAPABILITY_AP_INACTIVITY_MINS,
135 			  ar->fw_capabilities);
136 
137 		if (ar->hw.id == AR6004_HW_1_3_VERSION)
138 			__set_bit(ATH6KL_FW_CAPABILITY_MAP_LP_ENDPOINT,
139 				  ar->fw_capabilities);
140 	}
141 
142 	/* Indicate that WMI is enabled (although not ready yet) */
143 	set_bit(WMI_ENABLED, &ar->flag);
144 	ar->wmi = ath6kl_wmi_init(ar);
145 	if (!ar->wmi) {
146 		ath6kl_err("failed to initialize wmi\n");
147 		ret = -EIO;
148 		goto err_htc_cleanup;
149 	}
150 
151 	ath6kl_dbg(ATH6KL_DBG_TRC, "%s: got wmi @ 0x%p.\n", __func__, ar->wmi);
152 
153 	/* setup access class priority mappings */
154 	ar->ac_stream_pri_map[WMM_AC_BK] = 0; /* lowest  */
155 	ar->ac_stream_pri_map[WMM_AC_BE] = 1;
156 	ar->ac_stream_pri_map[WMM_AC_VI] = 2;
157 	ar->ac_stream_pri_map[WMM_AC_VO] = 3; /* highest */
158 
159 	/* allocate some buffers that handle larger AMSDU frames */
160 	ath6kl_refill_amsdu_rxbufs(ar, ATH6KL_MAX_AMSDU_RX_BUFFERS);
161 
162 	ath6kl_cookie_init(ar);
163 
164 	ar->conf_flags = ATH6KL_CONF_IGNORE_ERP_BARKER |
165 			 ATH6KL_CONF_ENABLE_11N | ATH6KL_CONF_ENABLE_TX_BURST;
166 
167 	if (suspend_mode &&
168 	    suspend_mode >= WLAN_POWER_STATE_CUT_PWR &&
169 	    suspend_mode <= WLAN_POWER_STATE_WOW)
170 		ar->suspend_mode = suspend_mode;
171 	else
172 		ar->suspend_mode = 0;
173 
174 	if (suspend_mode == WLAN_POWER_STATE_WOW &&
175 	    (wow_mode == WLAN_POWER_STATE_CUT_PWR ||
176 	     wow_mode == WLAN_POWER_STATE_DEEP_SLEEP))
177 		ar->wow_suspend_mode = wow_mode;
178 	else
179 		ar->wow_suspend_mode = 0;
180 
181 	if (uart_debug)
182 		ar->conf_flags |= ATH6KL_CONF_UART_DEBUG;
183 
184 	set_bit(FIRST_BOOT, &ar->flag);
185 
186 	ath6kl_debug_init(ar);
187 
188 	ret = ath6kl_init_hw_start(ar);
189 	if (ret) {
190 		ath6kl_err("Failed to start hardware: %d\n", ret);
191 		goto err_rxbuf_cleanup;
192 	}
193 
194 	/* give our connected endpoints some buffers */
195 	ath6kl_rx_refill(ar->htc_target, ar->ctrl_ep);
196 	ath6kl_rx_refill(ar->htc_target, ar->ac2ep_map[WMM_AC_BE]);
197 
198 	ret = ath6kl_cfg80211_init(ar);
199 	if (ret)
200 		goto err_rxbuf_cleanup;
201 
202 	ret = ath6kl_debug_init_fs(ar);
203 	if (ret) {
204 		wiphy_unregister(ar->wiphy);
205 		goto err_rxbuf_cleanup;
206 	}
207 
208 	for (i = 0; i < ar->vif_max; i++)
209 		ar->avail_idx_map |= BIT(i);
210 
211 	rtnl_lock();
212 
213 	/* Add an initial station interface */
214 	wdev = ath6kl_interface_add(ar, "wlan%d", NL80211_IFTYPE_STATION, 0,
215 				    INFRA_NETWORK);
216 
217 	rtnl_unlock();
218 
219 	if (!wdev) {
220 		ath6kl_err("Failed to instantiate a network device\n");
221 		ret = -ENOMEM;
222 		wiphy_unregister(ar->wiphy);
223 		goto err_rxbuf_cleanup;
224 	}
225 
226 	ath6kl_dbg(ATH6KL_DBG_TRC, "%s: name=%s dev=0x%p, ar=0x%p\n",
227 		   __func__, wdev->netdev->name, wdev->netdev, ar);
228 
229 	ar->fw_recovery.enable = !!recovery_enable;
230 	if (!ar->fw_recovery.enable)
231 		return ret;
232 
233 	if (heart_beat_poll &&
234 	    test_bit(ATH6KL_FW_CAPABILITY_HEART_BEAT_POLL,
235 		     ar->fw_capabilities))
236 		ar->fw_recovery.hb_poll = heart_beat_poll;
237 
238 	ath6kl_recovery_init(ar);
239 
240 	return ret;
241 
242 err_rxbuf_cleanup:
243 	ath6kl_debug_cleanup(ar);
244 	ath6kl_htc_flush_rx_buf(ar->htc_target);
245 	ath6kl_cleanup_amsdu_rxbufs(ar);
246 	ath6kl_wmi_shutdown(ar->wmi);
247 	clear_bit(WMI_ENABLED, &ar->flag);
248 	ar->wmi = NULL;
249 err_htc_cleanup:
250 	ath6kl_htc_cleanup(ar->htc_target);
251 err_power_off:
252 	ath6kl_hif_power_off(ar);
253 err_bmi_cleanup:
254 	ath6kl_bmi_cleanup(ar);
255 err_wq:
256 	destroy_workqueue(ar->ath6kl_wq);
257 
258 	return ret;
259 }
260 EXPORT_SYMBOL(ath6kl_core_init);
261 
262 struct ath6kl *ath6kl_core_create(struct device *dev)
263 {
264 	struct ath6kl *ar;
265 	u8 ctr;
266 
267 	ar = ath6kl_cfg80211_create();
268 	if (!ar)
269 		return NULL;
270 
271 	ar->p2p = !!ath6kl_p2p;
272 	ar->dev = dev;
273 
274 	ar->vif_max = 1;
275 
276 	ar->max_norm_iface = 1;
277 
278 	spin_lock_init(&ar->lock);
279 	spin_lock_init(&ar->mcastpsq_lock);
280 	spin_lock_init(&ar->list_lock);
281 
282 	init_waitqueue_head(&ar->event_wq);
283 	sema_init(&ar->sem, 1);
284 
285 	INIT_LIST_HEAD(&ar->amsdu_rx_buffer_queue);
286 	INIT_LIST_HEAD(&ar->vif_list);
287 
288 	clear_bit(WMI_ENABLED, &ar->flag);
289 	clear_bit(SKIP_SCAN, &ar->flag);
290 	clear_bit(DESTROY_IN_PROGRESS, &ar->flag);
291 
292 	ar->tx_pwr = 0;
293 	ar->intra_bss = 1;
294 	ar->lrssi_roam_threshold = DEF_LRSSI_ROAM_THRESHOLD;
295 
296 	ar->state = ATH6KL_STATE_OFF;
297 
298 	memset((u8 *)ar->sta_list, 0,
299 	       AP_MAX_NUM_STA * sizeof(struct ath6kl_sta));
300 
301 	/* Init the PS queues */
302 	for (ctr = 0; ctr < AP_MAX_NUM_STA; ctr++) {
303 		spin_lock_init(&ar->sta_list[ctr].psq_lock);
304 		skb_queue_head_init(&ar->sta_list[ctr].psq);
305 		skb_queue_head_init(&ar->sta_list[ctr].apsdq);
306 		ar->sta_list[ctr].mgmt_psq_len = 0;
307 		INIT_LIST_HEAD(&ar->sta_list[ctr].mgmt_psq);
308 		ar->sta_list[ctr].aggr_conn =
309 			kzalloc(sizeof(struct aggr_info_conn), GFP_KERNEL);
310 		if (!ar->sta_list[ctr].aggr_conn) {
311 			ath6kl_err("Failed to allocate memory for sta aggregation information\n");
312 			ath6kl_core_destroy(ar);
313 			return NULL;
314 		}
315 	}
316 
317 	skb_queue_head_init(&ar->mcastpsq);
318 
319 	memcpy(ar->ap_country_code, DEF_AP_COUNTRY_CODE, 3);
320 
321 	return ar;
322 }
323 EXPORT_SYMBOL(ath6kl_core_create);
324 
325 void ath6kl_core_cleanup(struct ath6kl *ar)
326 {
327 	ath6kl_hif_power_off(ar);
328 
329 	ath6kl_recovery_cleanup(ar);
330 
331 	destroy_workqueue(ar->ath6kl_wq);
332 
333 	if (ar->htc_target)
334 		ath6kl_htc_cleanup(ar->htc_target);
335 
336 	ath6kl_cookie_cleanup(ar);
337 
338 	ath6kl_cleanup_amsdu_rxbufs(ar);
339 
340 	ath6kl_bmi_cleanup(ar);
341 
342 	ath6kl_debug_cleanup(ar);
343 
344 	kfree(ar->fw_board);
345 	kfree(ar->fw_otp);
346 	vfree(ar->fw);
347 	kfree(ar->fw_patch);
348 	kfree(ar->fw_testscript);
349 
350 	ath6kl_cfg80211_cleanup(ar);
351 }
352 EXPORT_SYMBOL(ath6kl_core_cleanup);
353 
354 void ath6kl_core_destroy(struct ath6kl *ar)
355 {
356 	ath6kl_cfg80211_destroy(ar);
357 }
358 EXPORT_SYMBOL(ath6kl_core_destroy);
359 
360 MODULE_AUTHOR("Qualcomm Atheros");
361 MODULE_DESCRIPTION("Core module for AR600x SDIO and USB devices.");
362 MODULE_LICENSE("Dual BSD/GPL");
363