1 
2 /*
3  * Copyright (c) 2011 Atheros Communications 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 <linux/moduleparam.h>
19 #include <linux/errno.h>
20 #include <linux/of.h>
21 #include <linux/mmc/sdio_func.h>
22 #include "core.h"
23 #include "cfg80211.h"
24 #include "target.h"
25 #include "debug.h"
26 #include "hif-ops.h"
27 
28 unsigned int debug_mask;
29 static unsigned int testmode;
30 static bool suspend_cutpower;
31 
32 module_param(debug_mask, uint, 0644);
33 module_param(testmode, uint, 0644);
34 module_param(suspend_cutpower, bool, 0444);
35 
36 static const struct ath6kl_hw hw_list[] = {
37 	{
38 		.id				= AR6003_HW_2_0_VERSION,
39 		.name				= "ar6003 hw 2.0",
40 		.dataset_patch_addr		= 0x57e884,
41 		.app_load_addr			= 0x543180,
42 		.board_ext_data_addr		= 0x57e500,
43 		.reserved_ram_size		= 6912,
44 
45 		/* hw2.0 needs override address hardcoded */
46 		.app_start_override_addr	= 0x944C00,
47 
48 		.fw_otp			= AR6003_HW_2_0_OTP_FILE,
49 		.fw			= AR6003_HW_2_0_FIRMWARE_FILE,
50 		.fw_tcmd		= AR6003_HW_2_0_TCMD_FIRMWARE_FILE,
51 		.fw_patch		= AR6003_HW_2_0_PATCH_FILE,
52 		.fw_api2		= AR6003_HW_2_0_FIRMWARE_2_FILE,
53 		.fw_board		= AR6003_HW_2_0_BOARD_DATA_FILE,
54 		.fw_default_board	= AR6003_HW_2_0_DEFAULT_BOARD_DATA_FILE,
55 	},
56 	{
57 		.id				= AR6003_HW_2_1_1_VERSION,
58 		.name				= "ar6003 hw 2.1.1",
59 		.dataset_patch_addr		= 0x57ff74,
60 		.app_load_addr			= 0x1234,
61 		.board_ext_data_addr		= 0x542330,
62 		.reserved_ram_size		= 512,
63 
64 		.fw_otp			= AR6003_HW_2_1_1_OTP_FILE,
65 		.fw			= AR6003_HW_2_1_1_FIRMWARE_FILE,
66 		.fw_tcmd		= AR6003_HW_2_1_1_TCMD_FIRMWARE_FILE,
67 		.fw_patch		= AR6003_HW_2_1_1_PATCH_FILE,
68 		.fw_api2		= AR6003_HW_2_1_1_FIRMWARE_2_FILE,
69 		.fw_board		= AR6003_HW_2_1_1_BOARD_DATA_FILE,
70 		.fw_default_board	= AR6003_HW_2_1_1_DEFAULT_BOARD_DATA_FILE,
71 	},
72 	{
73 		.id				= AR6004_HW_1_0_VERSION,
74 		.name				= "ar6004 hw 1.0",
75 		.dataset_patch_addr		= 0x57e884,
76 		.app_load_addr			= 0x1234,
77 		.board_ext_data_addr		= 0x437000,
78 		.reserved_ram_size		= 19456,
79 		.board_addr			= 0x433900,
80 
81 		.fw			= AR6004_HW_1_0_FIRMWARE_FILE,
82 		.fw_api2		= AR6004_HW_1_0_FIRMWARE_2_FILE,
83 		.fw_board		= AR6004_HW_1_0_BOARD_DATA_FILE,
84 		.fw_default_board	= AR6004_HW_1_0_DEFAULT_BOARD_DATA_FILE,
85 	},
86 	{
87 		.id				= AR6004_HW_1_1_VERSION,
88 		.name				= "ar6004 hw 1.1",
89 		.dataset_patch_addr		= 0x57e884,
90 		.app_load_addr			= 0x1234,
91 		.board_ext_data_addr		= 0x437000,
92 		.reserved_ram_size		= 11264,
93 		.board_addr			= 0x43d400,
94 
95 		.fw			= AR6004_HW_1_1_FIRMWARE_FILE,
96 		.fw_api2		= AR6004_HW_1_1_FIRMWARE_2_FILE,
97 		.fw_board		= AR6004_HW_1_1_BOARD_DATA_FILE,
98 		.fw_default_board	= AR6004_HW_1_1_DEFAULT_BOARD_DATA_FILE,
99 	},
100 };
101 
102 /*
103  * Include definitions here that can be used to tune the WLAN module
104  * behavior. Different customers can tune the behavior as per their needs,
105  * here.
106  */
107 
108 /*
109  * This configuration item enable/disable keepalive support.
110  * Keepalive support: In the absence of any data traffic to AP, null
111  * frames will be sent to the AP at periodic interval, to keep the association
112  * active. This configuration item defines the periodic interval.
113  * Use value of zero to disable keepalive support
114  * Default: 60 seconds
115  */
116 #define WLAN_CONFIG_KEEP_ALIVE_INTERVAL 60
117 
118 /*
119  * This configuration item sets the value of disconnect timeout
120  * Firmware delays sending the disconnec event to the host for this
121  * timeout after is gets disconnected from the current AP.
122  * If the firmware successly roams within the disconnect timeout
123  * it sends a new connect event
124  */
125 #define WLAN_CONFIG_DISCONNECT_TIMEOUT 10
126 
127 #define CONFIG_AR600x_DEBUG_UART_TX_PIN 8
128 
129 #define ATH6KL_DATA_OFFSET    64
130 struct sk_buff *ath6kl_buf_alloc(int size)
131 {
132 	struct sk_buff *skb;
133 	u16 reserved;
134 
135 	/* Add chacheline space at front and back of buffer */
136 	reserved = (2 * L1_CACHE_BYTES) + ATH6KL_DATA_OFFSET +
137 		   sizeof(struct htc_packet) + ATH6KL_HTC_ALIGN_BYTES;
138 	skb = dev_alloc_skb(size + reserved);
139 
140 	if (skb)
141 		skb_reserve(skb, reserved - L1_CACHE_BYTES);
142 	return skb;
143 }
144 
145 void ath6kl_init_profile_info(struct ath6kl_vif *vif)
146 {
147 	vif->ssid_len = 0;
148 	memset(vif->ssid, 0, sizeof(vif->ssid));
149 
150 	vif->dot11_auth_mode = OPEN_AUTH;
151 	vif->auth_mode = NONE_AUTH;
152 	vif->prwise_crypto = NONE_CRYPT;
153 	vif->prwise_crypto_len = 0;
154 	vif->grp_crypto = NONE_CRYPT;
155 	vif->grp_crypto_len = 0;
156 	memset(vif->wep_key_list, 0, sizeof(vif->wep_key_list));
157 	memset(vif->req_bssid, 0, sizeof(vif->req_bssid));
158 	memset(vif->bssid, 0, sizeof(vif->bssid));
159 	vif->bss_ch = 0;
160 }
161 
162 static int ath6kl_set_host_app_area(struct ath6kl *ar)
163 {
164 	u32 address, data;
165 	struct host_app_area host_app_area;
166 
167 	/* Fetch the address of the host_app_area_s
168 	 * instance in the host interest area */
169 	address = ath6kl_get_hi_item_addr(ar, HI_ITEM(hi_app_host_interest));
170 	address = TARG_VTOP(ar->target_type, address);
171 
172 	if (ath6kl_diag_read32(ar, address, &data))
173 		return -EIO;
174 
175 	address = TARG_VTOP(ar->target_type, data);
176 	host_app_area.wmi_protocol_ver = cpu_to_le32(WMI_PROTOCOL_VERSION);
177 	if (ath6kl_diag_write(ar, address, (u8 *) &host_app_area,
178 			      sizeof(struct host_app_area)))
179 		return -EIO;
180 
181 	return 0;
182 }
183 
184 static inline void set_ac2_ep_map(struct ath6kl *ar,
185 				  u8 ac,
186 				  enum htc_endpoint_id ep)
187 {
188 	ar->ac2ep_map[ac] = ep;
189 	ar->ep2ac_map[ep] = ac;
190 }
191 
192 /* connect to a service */
193 static int ath6kl_connectservice(struct ath6kl *ar,
194 				 struct htc_service_connect_req  *con_req,
195 				 char *desc)
196 {
197 	int status;
198 	struct htc_service_connect_resp response;
199 
200 	memset(&response, 0, sizeof(response));
201 
202 	status = ath6kl_htc_conn_service(ar->htc_target, con_req, &response);
203 	if (status) {
204 		ath6kl_err("failed to connect to %s service status:%d\n",
205 			   desc, status);
206 		return status;
207 	}
208 
209 	switch (con_req->svc_id) {
210 	case WMI_CONTROL_SVC:
211 		if (test_bit(WMI_ENABLED, &ar->flag))
212 			ath6kl_wmi_set_control_ep(ar->wmi, response.endpoint);
213 		ar->ctrl_ep = response.endpoint;
214 		break;
215 	case WMI_DATA_BE_SVC:
216 		set_ac2_ep_map(ar, WMM_AC_BE, response.endpoint);
217 		break;
218 	case WMI_DATA_BK_SVC:
219 		set_ac2_ep_map(ar, WMM_AC_BK, response.endpoint);
220 		break;
221 	case WMI_DATA_VI_SVC:
222 		set_ac2_ep_map(ar, WMM_AC_VI, response.endpoint);
223 		break;
224 	case WMI_DATA_VO_SVC:
225 		set_ac2_ep_map(ar, WMM_AC_VO, response.endpoint);
226 		break;
227 	default:
228 		ath6kl_err("service id is not mapped %d\n", con_req->svc_id);
229 		return -EINVAL;
230 	}
231 
232 	return 0;
233 }
234 
235 static int ath6kl_init_service_ep(struct ath6kl *ar)
236 {
237 	struct htc_service_connect_req connect;
238 
239 	memset(&connect, 0, sizeof(connect));
240 
241 	/* these fields are the same for all service endpoints */
242 	connect.ep_cb.rx = ath6kl_rx;
243 	connect.ep_cb.rx_refill = ath6kl_rx_refill;
244 	connect.ep_cb.tx_full = ath6kl_tx_queue_full;
245 
246 	/*
247 	 * Set the max queue depth so that our ath6kl_tx_queue_full handler
248 	 * gets called.
249 	*/
250 	connect.max_txq_depth = MAX_DEFAULT_SEND_QUEUE_DEPTH;
251 	connect.ep_cb.rx_refill_thresh = ATH6KL_MAX_RX_BUFFERS / 4;
252 	if (!connect.ep_cb.rx_refill_thresh)
253 		connect.ep_cb.rx_refill_thresh++;
254 
255 	/* connect to control service */
256 	connect.svc_id = WMI_CONTROL_SVC;
257 	if (ath6kl_connectservice(ar, &connect, "WMI CONTROL"))
258 		return -EIO;
259 
260 	connect.flags |= HTC_FLGS_TX_BNDL_PAD_EN;
261 
262 	/*
263 	 * Limit the HTC message size on the send path, although e can
264 	 * receive A-MSDU frames of 4K, we will only send ethernet-sized
265 	 * (802.3) frames on the send path.
266 	 */
267 	connect.max_rxmsg_sz = WMI_MAX_TX_DATA_FRAME_LENGTH;
268 
269 	/*
270 	 * To reduce the amount of committed memory for larger A_MSDU
271 	 * frames, use the recv-alloc threshold mechanism for larger
272 	 * packets.
273 	 */
274 	connect.ep_cb.rx_alloc_thresh = ATH6KL_BUFFER_SIZE;
275 	connect.ep_cb.rx_allocthresh = ath6kl_alloc_amsdu_rxbuf;
276 
277 	/*
278 	 * For the remaining data services set the connection flag to
279 	 * reduce dribbling, if configured to do so.
280 	 */
281 	connect.conn_flags |= HTC_CONN_FLGS_REDUCE_CRED_DRIB;
282 	connect.conn_flags &= ~HTC_CONN_FLGS_THRESH_MASK;
283 	connect.conn_flags |= HTC_CONN_FLGS_THRESH_LVL_HALF;
284 
285 	connect.svc_id = WMI_DATA_BE_SVC;
286 
287 	if (ath6kl_connectservice(ar, &connect, "WMI DATA BE"))
288 		return -EIO;
289 
290 	/* connect to back-ground map this to WMI LOW_PRI */
291 	connect.svc_id = WMI_DATA_BK_SVC;
292 	if (ath6kl_connectservice(ar, &connect, "WMI DATA BK"))
293 		return -EIO;
294 
295 	/* connect to Video service, map this to to HI PRI */
296 	connect.svc_id = WMI_DATA_VI_SVC;
297 	if (ath6kl_connectservice(ar, &connect, "WMI DATA VI"))
298 		return -EIO;
299 
300 	/*
301 	 * Connect to VO service, this is currently not mapped to a WMI
302 	 * priority stream due to historical reasons. WMI originally
303 	 * defined 3 priorities over 3 mailboxes We can change this when
304 	 * WMI is reworked so that priorities are not dependent on
305 	 * mailboxes.
306 	 */
307 	connect.svc_id = WMI_DATA_VO_SVC;
308 	if (ath6kl_connectservice(ar, &connect, "WMI DATA VO"))
309 		return -EIO;
310 
311 	return 0;
312 }
313 
314 void ath6kl_init_control_info(struct ath6kl_vif *vif)
315 {
316 	ath6kl_init_profile_info(vif);
317 	vif->def_txkey_index = 0;
318 	memset(vif->wep_key_list, 0, sizeof(vif->wep_key_list));
319 	vif->ch_hint = 0;
320 }
321 
322 /*
323  * Set HTC/Mbox operational parameters, this can only be called when the
324  * target is in the BMI phase.
325  */
326 static int ath6kl_set_htc_params(struct ath6kl *ar, u32 mbox_isr_yield_val,
327 				 u8 htc_ctrl_buf)
328 {
329 	int status;
330 	u32 blk_size;
331 
332 	blk_size = ar->mbox_info.block_size;
333 
334 	if (htc_ctrl_buf)
335 		blk_size |=  ((u32)htc_ctrl_buf) << 16;
336 
337 	/* set the host interest area for the block size */
338 	status = ath6kl_bmi_write(ar,
339 			ath6kl_get_hi_item_addr(ar,
340 			HI_ITEM(hi_mbox_io_block_sz)),
341 			(u8 *)&blk_size,
342 			4);
343 	if (status) {
344 		ath6kl_err("bmi_write_memory for IO block size failed\n");
345 		goto out;
346 	}
347 
348 	ath6kl_dbg(ATH6KL_DBG_TRC, "block size set: %d (target addr:0x%X)\n",
349 		   blk_size,
350 		   ath6kl_get_hi_item_addr(ar, HI_ITEM(hi_mbox_io_block_sz)));
351 
352 	if (mbox_isr_yield_val) {
353 		/* set the host interest area for the mbox ISR yield limit */
354 		status = ath6kl_bmi_write(ar,
355 				ath6kl_get_hi_item_addr(ar,
356 				HI_ITEM(hi_mbox_isr_yield_limit)),
357 				(u8 *)&mbox_isr_yield_val,
358 				4);
359 		if (status) {
360 			ath6kl_err("bmi_write_memory for yield limit failed\n");
361 			goto out;
362 		}
363 	}
364 
365 out:
366 	return status;
367 }
368 
369 static int ath6kl_target_config_wlan_params(struct ath6kl *ar, int idx)
370 {
371 	int status = 0;
372 	int ret;
373 
374 	/*
375 	 * Configure the device for rx dot11 header rules. "0,0" are the
376 	 * default values. Required if checksum offload is needed. Set
377 	 * RxMetaVersion to 2.
378 	 */
379 	if (ath6kl_wmi_set_rx_frame_format_cmd(ar->wmi, idx,
380 					       ar->rx_meta_ver, 0, 0)) {
381 		ath6kl_err("unable to set the rx frame format\n");
382 		status = -EIO;
383 	}
384 
385 	if (ar->conf_flags & ATH6KL_CONF_IGNORE_PS_FAIL_EVT_IN_SCAN)
386 		if ((ath6kl_wmi_pmparams_cmd(ar->wmi, idx, 0, 1, 0, 0, 1,
387 		     IGNORE_POWER_SAVE_FAIL_EVENT_DURING_SCAN)) != 0) {
388 			ath6kl_err("unable to set power save fail event policy\n");
389 			status = -EIO;
390 		}
391 
392 	if (!(ar->conf_flags & ATH6KL_CONF_IGNORE_ERP_BARKER))
393 		if ((ath6kl_wmi_set_lpreamble_cmd(ar->wmi, idx, 0,
394 		     WMI_DONOT_IGNORE_BARKER_IN_ERP)) != 0) {
395 			ath6kl_err("unable to set barker preamble policy\n");
396 			status = -EIO;
397 		}
398 
399 	if (ath6kl_wmi_set_keepalive_cmd(ar->wmi, idx,
400 			WLAN_CONFIG_KEEP_ALIVE_INTERVAL)) {
401 		ath6kl_err("unable to set keep alive interval\n");
402 		status = -EIO;
403 	}
404 
405 	if (ath6kl_wmi_disctimeout_cmd(ar->wmi, idx,
406 			WLAN_CONFIG_DISCONNECT_TIMEOUT)) {
407 		ath6kl_err("unable to set disconnect timeout\n");
408 		status = -EIO;
409 	}
410 
411 	if (!(ar->conf_flags & ATH6KL_CONF_ENABLE_TX_BURST))
412 		if (ath6kl_wmi_set_wmm_txop(ar->wmi, idx, WMI_TXOP_DISABLED)) {
413 			ath6kl_err("unable to set txop bursting\n");
414 			status = -EIO;
415 		}
416 
417 	/*
418 	 * FIXME: Make sure p2p configurations are not applied to
419 	 * non-p2p capable interfaces when multivif support is enabled.
420 	 */
421 	if (ar->p2p) {
422 		ret = ath6kl_wmi_info_req_cmd(ar->wmi, idx,
423 					      P2P_FLAG_CAPABILITIES_REQ |
424 					      P2P_FLAG_MACADDR_REQ |
425 					      P2P_FLAG_HMODEL_REQ);
426 		if (ret) {
427 			ath6kl_dbg(ATH6KL_DBG_TRC, "failed to request P2P "
428 				   "capabilities (%d) - assuming P2P not "
429 				   "supported\n", ret);
430 			ar->p2p = 0;
431 		}
432 	}
433 
434 	/*
435 	 * FIXME: Make sure p2p configurations are not applied to
436 	 * non-p2p capable interfaces when multivif support is enabled.
437 	 */
438 	if (ar->p2p) {
439 		/* Enable Probe Request reporting for P2P */
440 		ret = ath6kl_wmi_probe_report_req_cmd(ar->wmi, idx, true);
441 		if (ret) {
442 			ath6kl_dbg(ATH6KL_DBG_TRC, "failed to enable Probe "
443 				   "Request reporting (%d)\n", ret);
444 		}
445 	}
446 
447 	return status;
448 }
449 
450 int ath6kl_configure_target(struct ath6kl *ar)
451 {
452 	u32 param, ram_reserved_size;
453 	u8 fw_iftype, fw_mode = 0, fw_submode = 0;
454 	int i;
455 
456 	/*
457 	 * Note: Even though the firmware interface type is
458 	 * chosen as BSS_STA for all three interfaces, can
459 	 * be configured to IBSS/AP as long as the fw submode
460 	 * remains normal mode (0 - AP, STA and IBSS). But
461 	 * due to an target assert in firmware only one interface is
462 	 * configured for now.
463 	 */
464 	fw_iftype = HI_OPTION_FW_MODE_BSS_STA;
465 
466 	for (i = 0; i < ar->vif_max; i++)
467 		fw_mode |= fw_iftype << (i * HI_OPTION_FW_MODE_BITS);
468 
469 	/*
470 	 * By default, submodes :
471 	 *		vif[0] - AP/STA/IBSS
472 	 *		vif[1] - "P2P dev"/"P2P GO"/"P2P Client"
473 	 *		vif[2] - "P2P dev"/"P2P GO"/"P2P Client"
474 	 */
475 
476 	for (i = 0; i < ar->max_norm_iface; i++)
477 		fw_submode |= HI_OPTION_FW_SUBMODE_NONE <<
478 			      (i * HI_OPTION_FW_SUBMODE_BITS);
479 
480 	for (i = ar->max_norm_iface; i < ar->vif_max; i++)
481 		fw_submode |= HI_OPTION_FW_SUBMODE_P2PDEV <<
482 			      (i * HI_OPTION_FW_SUBMODE_BITS);
483 
484 	/*
485 	 * FIXME: This needs to be removed once the multivif
486 	 * support is enabled.
487 	 */
488 	if (ar->p2p)
489 		fw_submode = HI_OPTION_FW_SUBMODE_P2PDEV;
490 
491 	param = HTC_PROTOCOL_VERSION;
492 	if (ath6kl_bmi_write(ar,
493 			     ath6kl_get_hi_item_addr(ar,
494 			     HI_ITEM(hi_app_host_interest)),
495 			     (u8 *)&param, 4) != 0) {
496 		ath6kl_err("bmi_write_memory for htc version failed\n");
497 		return -EIO;
498 	}
499 
500 	/* set the firmware mode to STA/IBSS/AP */
501 	param = 0;
502 
503 	if (ath6kl_bmi_read(ar,
504 			    ath6kl_get_hi_item_addr(ar,
505 			    HI_ITEM(hi_option_flag)),
506 			    (u8 *)&param, 4) != 0) {
507 		ath6kl_err("bmi_read_memory for setting fwmode failed\n");
508 		return -EIO;
509 	}
510 
511 	param |= (ar->vif_max << HI_OPTION_NUM_DEV_SHIFT);
512 	param |= fw_mode << HI_OPTION_FW_MODE_SHIFT;
513 	param |= fw_submode << HI_OPTION_FW_SUBMODE_SHIFT;
514 
515 	param |= (0 << HI_OPTION_MAC_ADDR_METHOD_SHIFT);
516 	param |= (0 << HI_OPTION_FW_BRIDGE_SHIFT);
517 
518 	if (ath6kl_bmi_write(ar,
519 			     ath6kl_get_hi_item_addr(ar,
520 			     HI_ITEM(hi_option_flag)),
521 			     (u8 *)&param,
522 			     4) != 0) {
523 		ath6kl_err("bmi_write_memory for setting fwmode failed\n");
524 		return -EIO;
525 	}
526 
527 	ath6kl_dbg(ATH6KL_DBG_TRC, "firmware mode set\n");
528 
529 	/*
530 	 * Hardcode the address use for the extended board data
531 	 * Ideally this should be pre-allocate by the OS at boot time
532 	 * But since it is a new feature and board data is loaded
533 	 * at init time, we have to workaround this from host.
534 	 * It is difficult to patch the firmware boot code,
535 	 * but possible in theory.
536 	 */
537 
538 	param = ar->hw.board_ext_data_addr;
539 	ram_reserved_size = ar->hw.reserved_ram_size;
540 
541 	if (ath6kl_bmi_write(ar, ath6kl_get_hi_item_addr(ar,
542 					HI_ITEM(hi_board_ext_data)),
543 			     (u8 *)&param, 4) != 0) {
544 		ath6kl_err("bmi_write_memory for hi_board_ext_data failed\n");
545 		return -EIO;
546 	}
547 
548 	if (ath6kl_bmi_write(ar, ath6kl_get_hi_item_addr(ar,
549 					HI_ITEM(hi_end_ram_reserve_sz)),
550 			     (u8 *)&ram_reserved_size, 4) != 0) {
551 		ath6kl_err("bmi_write_memory for hi_end_ram_reserve_sz failed\n");
552 		return -EIO;
553 	}
554 
555 	/* set the block size for the target */
556 	if (ath6kl_set_htc_params(ar, MBOX_YIELD_LIMIT, 0))
557 		/* use default number of control buffers */
558 		return -EIO;
559 
560 	return 0;
561 }
562 
563 void ath6kl_core_free(struct ath6kl *ar)
564 {
565 	wiphy_free(ar->wiphy);
566 }
567 
568 void ath6kl_core_cleanup(struct ath6kl *ar)
569 {
570 	ath6kl_hif_power_off(ar);
571 
572 	destroy_workqueue(ar->ath6kl_wq);
573 
574 	if (ar->htc_target)
575 		ath6kl_htc_cleanup(ar->htc_target);
576 
577 	ath6kl_cookie_cleanup(ar);
578 
579 	ath6kl_cleanup_amsdu_rxbufs(ar);
580 
581 	ath6kl_bmi_cleanup(ar);
582 
583 	ath6kl_debug_cleanup(ar);
584 
585 	kfree(ar->fw_board);
586 	kfree(ar->fw_otp);
587 	kfree(ar->fw);
588 	kfree(ar->fw_patch);
589 
590 	ath6kl_deinit_ieee80211_hw(ar);
591 }
592 
593 /* firmware upload */
594 static int ath6kl_get_fw(struct ath6kl *ar, const char *filename,
595 			 u8 **fw, size_t *fw_len)
596 {
597 	const struct firmware *fw_entry;
598 	int ret;
599 
600 	ret = request_firmware(&fw_entry, filename, ar->dev);
601 	if (ret)
602 		return ret;
603 
604 	*fw_len = fw_entry->size;
605 	*fw = kmemdup(fw_entry->data, fw_entry->size, GFP_KERNEL);
606 
607 	if (*fw == NULL)
608 		ret = -ENOMEM;
609 
610 	release_firmware(fw_entry);
611 
612 	return ret;
613 }
614 
615 #ifdef CONFIG_OF
616 static const char *get_target_ver_dir(const struct ath6kl *ar)
617 {
618 	switch (ar->version.target_ver) {
619 	case AR6003_HW_1_0_VERSION:
620 		return "ath6k/AR6003/hw1.0";
621 	case AR6003_HW_2_0_VERSION:
622 		return "ath6k/AR6003/hw2.0";
623 	case AR6003_HW_2_1_1_VERSION:
624 		return "ath6k/AR6003/hw2.1.1";
625 	}
626 	ath6kl_warn("%s: unsupported target version 0x%x.\n", __func__,
627 		    ar->version.target_ver);
628 	return NULL;
629 }
630 
631 /*
632  * Check the device tree for a board-id and use it to construct
633  * the pathname to the firmware file.  Used (for now) to find a
634  * fallback to the "bdata.bin" file--typically a symlink to the
635  * appropriate board-specific file.
636  */
637 static bool check_device_tree(struct ath6kl *ar)
638 {
639 	static const char *board_id_prop = "atheros,board-id";
640 	struct device_node *node;
641 	char board_filename[64];
642 	const char *board_id;
643 	int ret;
644 
645 	for_each_compatible_node(node, NULL, "atheros,ath6kl") {
646 		board_id = of_get_property(node, board_id_prop, NULL);
647 		if (board_id == NULL) {
648 			ath6kl_warn("No \"%s\" property on %s node.\n",
649 				    board_id_prop, node->name);
650 			continue;
651 		}
652 		snprintf(board_filename, sizeof(board_filename),
653 			 "%s/bdata.%s.bin", get_target_ver_dir(ar), board_id);
654 
655 		ret = ath6kl_get_fw(ar, board_filename, &ar->fw_board,
656 				    &ar->fw_board_len);
657 		if (ret) {
658 			ath6kl_err("Failed to get DT board file %s: %d\n",
659 				   board_filename, ret);
660 			continue;
661 		}
662 		return true;
663 	}
664 	return false;
665 }
666 #else
667 static bool check_device_tree(struct ath6kl *ar)
668 {
669 	return false;
670 }
671 #endif /* CONFIG_OF */
672 
673 static int ath6kl_fetch_board_file(struct ath6kl *ar)
674 {
675 	const char *filename;
676 	int ret;
677 
678 	if (ar->fw_board != NULL)
679 		return 0;
680 
681 	if (WARN_ON(ar->hw.fw_board == NULL))
682 		return -EINVAL;
683 
684 	filename = ar->hw.fw_board;
685 
686 	ret = ath6kl_get_fw(ar, filename, &ar->fw_board,
687 			    &ar->fw_board_len);
688 	if (ret == 0) {
689 		/* managed to get proper board file */
690 		return 0;
691 	}
692 
693 	if (check_device_tree(ar)) {
694 		/* got board file from device tree */
695 		return 0;
696 	}
697 
698 	/* there was no proper board file, try to use default instead */
699 	ath6kl_warn("Failed to get board file %s (%d), trying to find default board file.\n",
700 		    filename, ret);
701 
702 	filename = ar->hw.fw_default_board;
703 
704 	ret = ath6kl_get_fw(ar, filename, &ar->fw_board,
705 			    &ar->fw_board_len);
706 	if (ret) {
707 		ath6kl_err("Failed to get default board file %s: %d\n",
708 			   filename, ret);
709 		return ret;
710 	}
711 
712 	ath6kl_warn("WARNING! No proper board file was not found, instead using a default board file.\n");
713 	ath6kl_warn("Most likely your hardware won't work as specified. Install correct board file!\n");
714 
715 	return 0;
716 }
717 
718 static int ath6kl_fetch_otp_file(struct ath6kl *ar)
719 {
720 	const char *filename;
721 	int ret;
722 
723 	if (ar->fw_otp != NULL)
724 		return 0;
725 
726 	if (ar->hw.fw_otp == NULL) {
727 		ath6kl_dbg(ATH6KL_DBG_BOOT,
728 			   "no OTP file configured for this hw\n");
729 		return 0;
730 	}
731 
732 	filename = ar->hw.fw_otp;
733 
734 	ret = ath6kl_get_fw(ar, filename, &ar->fw_otp,
735 			    &ar->fw_otp_len);
736 	if (ret) {
737 		ath6kl_err("Failed to get OTP file %s: %d\n",
738 			   filename, ret);
739 		return ret;
740 	}
741 
742 	return 0;
743 }
744 
745 static int ath6kl_fetch_fw_file(struct ath6kl *ar)
746 {
747 	const char *filename;
748 	int ret;
749 
750 	if (ar->fw != NULL)
751 		return 0;
752 
753 	if (testmode) {
754 		if (ar->hw.fw_tcmd == NULL) {
755 			ath6kl_warn("testmode not supported\n");
756 			return -EOPNOTSUPP;
757 		}
758 
759 		filename = ar->hw.fw_tcmd;
760 
761 		set_bit(TESTMODE, &ar->flag);
762 
763 		goto get_fw;
764 	}
765 
766 	if (WARN_ON(ar->hw.fw == NULL))
767 		return -EINVAL;
768 
769 	filename = ar->hw.fw;
770 
771 get_fw:
772 	ret = ath6kl_get_fw(ar, filename, &ar->fw, &ar->fw_len);
773 	if (ret) {
774 		ath6kl_err("Failed to get firmware file %s: %d\n",
775 			   filename, ret);
776 		return ret;
777 	}
778 
779 	return 0;
780 }
781 
782 static int ath6kl_fetch_patch_file(struct ath6kl *ar)
783 {
784 	const char *filename;
785 	int ret;
786 
787 	if (ar->fw_patch != NULL)
788 		return 0;
789 
790 	if (ar->hw.fw_patch == NULL)
791 		return 0;
792 
793 	filename = ar->hw.fw_patch;
794 
795 	ret = ath6kl_get_fw(ar, filename, &ar->fw_patch,
796 			    &ar->fw_patch_len);
797 	if (ret) {
798 		ath6kl_err("Failed to get patch file %s: %d\n",
799 			   filename, ret);
800 		return ret;
801 	}
802 
803 	return 0;
804 }
805 
806 static int ath6kl_fetch_fw_api1(struct ath6kl *ar)
807 {
808 	int ret;
809 
810 	ret = ath6kl_fetch_otp_file(ar);
811 	if (ret)
812 		return ret;
813 
814 	ret = ath6kl_fetch_fw_file(ar);
815 	if (ret)
816 		return ret;
817 
818 	ret = ath6kl_fetch_patch_file(ar);
819 	if (ret)
820 		return ret;
821 
822 	return 0;
823 }
824 
825 static int ath6kl_fetch_fw_api2(struct ath6kl *ar)
826 {
827 	size_t magic_len, len, ie_len;
828 	const struct firmware *fw;
829 	struct ath6kl_fw_ie *hdr;
830 	const char *filename;
831 	const u8 *data;
832 	int ret, ie_id, i, index, bit;
833 	__le32 *val;
834 
835 	if (ar->hw.fw_api2 == NULL)
836 		return -EOPNOTSUPP;
837 
838 	filename = ar->hw.fw_api2;
839 
840 	ret = request_firmware(&fw, filename, ar->dev);
841 	if (ret)
842 		return ret;
843 
844 	data = fw->data;
845 	len = fw->size;
846 
847 	/* magic also includes the null byte, check that as well */
848 	magic_len = strlen(ATH6KL_FIRMWARE_MAGIC) + 1;
849 
850 	if (len < magic_len) {
851 		ret = -EINVAL;
852 		goto out;
853 	}
854 
855 	if (memcmp(data, ATH6KL_FIRMWARE_MAGIC, magic_len) != 0) {
856 		ret = -EINVAL;
857 		goto out;
858 	}
859 
860 	len -= magic_len;
861 	data += magic_len;
862 
863 	/* loop elements */
864 	while (len > sizeof(struct ath6kl_fw_ie)) {
865 		/* hdr is unaligned! */
866 		hdr = (struct ath6kl_fw_ie *) data;
867 
868 		ie_id = le32_to_cpup(&hdr->id);
869 		ie_len = le32_to_cpup(&hdr->len);
870 
871 		len -= sizeof(*hdr);
872 		data += sizeof(*hdr);
873 
874 		if (len < ie_len) {
875 			ret = -EINVAL;
876 			goto out;
877 		}
878 
879 		switch (ie_id) {
880 		case ATH6KL_FW_IE_OTP_IMAGE:
881 			ath6kl_dbg(ATH6KL_DBG_BOOT, "found otp image ie (%zd B)\n",
882 				ie_len);
883 
884 			ar->fw_otp = kmemdup(data, ie_len, GFP_KERNEL);
885 
886 			if (ar->fw_otp == NULL) {
887 				ret = -ENOMEM;
888 				goto out;
889 			}
890 
891 			ar->fw_otp_len = ie_len;
892 			break;
893 		case ATH6KL_FW_IE_FW_IMAGE:
894 			ath6kl_dbg(ATH6KL_DBG_BOOT, "found fw image ie (%zd B)\n",
895 				ie_len);
896 
897 			ar->fw = kmemdup(data, ie_len, GFP_KERNEL);
898 
899 			if (ar->fw == NULL) {
900 				ret = -ENOMEM;
901 				goto out;
902 			}
903 
904 			ar->fw_len = ie_len;
905 			break;
906 		case ATH6KL_FW_IE_PATCH_IMAGE:
907 			ath6kl_dbg(ATH6KL_DBG_BOOT, "found patch image ie (%zd B)\n",
908 				ie_len);
909 
910 			ar->fw_patch = kmemdup(data, ie_len, GFP_KERNEL);
911 
912 			if (ar->fw_patch == NULL) {
913 				ret = -ENOMEM;
914 				goto out;
915 			}
916 
917 			ar->fw_patch_len = ie_len;
918 			break;
919 		case ATH6KL_FW_IE_RESERVED_RAM_SIZE:
920 			val = (__le32 *) data;
921 			ar->hw.reserved_ram_size = le32_to_cpup(val);
922 
923 			ath6kl_dbg(ATH6KL_DBG_BOOT,
924 				   "found reserved ram size ie 0x%d\n",
925 				   ar->hw.reserved_ram_size);
926 			break;
927 		case ATH6KL_FW_IE_CAPABILITIES:
928 			ath6kl_dbg(ATH6KL_DBG_BOOT,
929 				   "found firmware capabilities ie (%zd B)\n",
930 				   ie_len);
931 
932 			for (i = 0; i < ATH6KL_FW_CAPABILITY_MAX; i++) {
933 				index = ALIGN(i, 8) / 8;
934 				bit = i % 8;
935 
936 				if (data[index] & (1 << bit))
937 					__set_bit(i, ar->fw_capabilities);
938 			}
939 
940 			ath6kl_dbg_dump(ATH6KL_DBG_BOOT, "capabilities", "",
941 					ar->fw_capabilities,
942 					sizeof(ar->fw_capabilities));
943 			break;
944 		case ATH6KL_FW_IE_PATCH_ADDR:
945 			if (ie_len != sizeof(*val))
946 				break;
947 
948 			val = (__le32 *) data;
949 			ar->hw.dataset_patch_addr = le32_to_cpup(val);
950 
951 			ath6kl_dbg(ATH6KL_DBG_BOOT,
952 				   "found patch address ie 0x%x\n",
953 				   ar->hw.dataset_patch_addr);
954 			break;
955 		case ATH6KL_FW_IE_BOARD_ADDR:
956 			if (ie_len != sizeof(*val))
957 				break;
958 
959 			val = (__le32 *) data;
960 			ar->hw.board_addr = le32_to_cpup(val);
961 
962 			ath6kl_dbg(ATH6KL_DBG_BOOT,
963 				   "found board address ie 0x%x\n",
964 				   ar->hw.board_addr);
965 			break;
966 		case ATH6KL_FW_IE_VIF_MAX:
967 			if (ie_len != sizeof(*val))
968 				break;
969 
970 			val = (__le32 *) data;
971 			ar->vif_max = min_t(unsigned int, le32_to_cpup(val),
972 					    ATH6KL_VIF_MAX);
973 
974 			ath6kl_dbg(ATH6KL_DBG_BOOT,
975 				   "found vif max ie %d\n", ar->vif_max);
976 			break;
977 		default:
978 			ath6kl_dbg(ATH6KL_DBG_BOOT, "Unknown fw ie: %u\n",
979 				   le32_to_cpup(&hdr->id));
980 			break;
981 		}
982 
983 		len -= ie_len;
984 		data += ie_len;
985 	};
986 
987 	ret = 0;
988 out:
989 	release_firmware(fw);
990 
991 	return ret;
992 }
993 
994 static int ath6kl_fetch_firmwares(struct ath6kl *ar)
995 {
996 	int ret;
997 
998 	ret = ath6kl_fetch_board_file(ar);
999 	if (ret)
1000 		return ret;
1001 
1002 	ret = ath6kl_fetch_fw_api2(ar);
1003 	if (ret == 0) {
1004 		ath6kl_dbg(ATH6KL_DBG_BOOT, "using fw api 2\n");
1005 		return 0;
1006 	}
1007 
1008 	ret = ath6kl_fetch_fw_api1(ar);
1009 	if (ret)
1010 		return ret;
1011 
1012 	ath6kl_dbg(ATH6KL_DBG_BOOT, "using fw api 1\n");
1013 
1014 	return 0;
1015 }
1016 
1017 static int ath6kl_upload_board_file(struct ath6kl *ar)
1018 {
1019 	u32 board_address, board_ext_address, param;
1020 	u32 board_data_size, board_ext_data_size;
1021 	int ret;
1022 
1023 	if (WARN_ON(ar->fw_board == NULL))
1024 		return -ENOENT;
1025 
1026 	/*
1027 	 * Determine where in Target RAM to write Board Data.
1028 	 * For AR6004, host determine Target RAM address for
1029 	 * writing board data.
1030 	 */
1031 	if (ar->hw.board_addr != 0) {
1032 		board_address = ar->hw.board_addr;
1033 		ath6kl_bmi_write(ar,
1034 				ath6kl_get_hi_item_addr(ar,
1035 				HI_ITEM(hi_board_data)),
1036 				(u8 *) &board_address, 4);
1037 	} else {
1038 		ath6kl_bmi_read(ar,
1039 				ath6kl_get_hi_item_addr(ar,
1040 				HI_ITEM(hi_board_data)),
1041 				(u8 *) &board_address, 4);
1042 	}
1043 
1044 	/* determine where in target ram to write extended board data */
1045 	ath6kl_bmi_read(ar,
1046 			ath6kl_get_hi_item_addr(ar,
1047 			HI_ITEM(hi_board_ext_data)),
1048 			(u8 *) &board_ext_address, 4);
1049 
1050 	if (ar->target_type == TARGET_TYPE_AR6003 &&
1051 	    board_ext_address == 0) {
1052 		ath6kl_err("Failed to get board file target address.\n");
1053 		return -EINVAL;
1054 	}
1055 
1056 	switch (ar->target_type) {
1057 	case TARGET_TYPE_AR6003:
1058 		board_data_size = AR6003_BOARD_DATA_SZ;
1059 		board_ext_data_size = AR6003_BOARD_EXT_DATA_SZ;
1060 		break;
1061 	case TARGET_TYPE_AR6004:
1062 		board_data_size = AR6004_BOARD_DATA_SZ;
1063 		board_ext_data_size = AR6004_BOARD_EXT_DATA_SZ;
1064 		break;
1065 	default:
1066 		WARN_ON(1);
1067 		return -EINVAL;
1068 		break;
1069 	}
1070 
1071 	if (board_ext_address &&
1072 	    ar->fw_board_len == (board_data_size + board_ext_data_size)) {
1073 
1074 		/* write extended board data */
1075 		ath6kl_dbg(ATH6KL_DBG_BOOT,
1076 			   "writing extended board data to 0x%x (%d B)\n",
1077 			   board_ext_address, board_ext_data_size);
1078 
1079 		ret = ath6kl_bmi_write(ar, board_ext_address,
1080 				       ar->fw_board + board_data_size,
1081 				       board_ext_data_size);
1082 		if (ret) {
1083 			ath6kl_err("Failed to write extended board data: %d\n",
1084 				   ret);
1085 			return ret;
1086 		}
1087 
1088 		/* record that extended board data is initialized */
1089 		param = (board_ext_data_size << 16) | 1;
1090 
1091 		ath6kl_bmi_write(ar,
1092 				 ath6kl_get_hi_item_addr(ar,
1093 				 HI_ITEM(hi_board_ext_data_config)),
1094 				 (unsigned char *) &param, 4);
1095 	}
1096 
1097 	if (ar->fw_board_len < board_data_size) {
1098 		ath6kl_err("Too small board file: %zu\n", ar->fw_board_len);
1099 		ret = -EINVAL;
1100 		return ret;
1101 	}
1102 
1103 	ath6kl_dbg(ATH6KL_DBG_BOOT, "writing board file to 0x%x (%d B)\n",
1104 		   board_address, board_data_size);
1105 
1106 	ret = ath6kl_bmi_write(ar, board_address, ar->fw_board,
1107 			       board_data_size);
1108 
1109 	if (ret) {
1110 		ath6kl_err("Board file bmi write failed: %d\n", ret);
1111 		return ret;
1112 	}
1113 
1114 	/* record the fact that Board Data IS initialized */
1115 	param = 1;
1116 	ath6kl_bmi_write(ar,
1117 			 ath6kl_get_hi_item_addr(ar,
1118 			 HI_ITEM(hi_board_data_initialized)),
1119 			 (u8 *)&param, 4);
1120 
1121 	return ret;
1122 }
1123 
1124 static int ath6kl_upload_otp(struct ath6kl *ar)
1125 {
1126 	u32 address, param;
1127 	bool from_hw = false;
1128 	int ret;
1129 
1130 	if (ar->fw_otp == NULL)
1131 		return 0;
1132 
1133 	address = ar->hw.app_load_addr;
1134 
1135 	ath6kl_dbg(ATH6KL_DBG_BOOT, "writing otp to 0x%x (%zd B)\n", address,
1136 		   ar->fw_otp_len);
1137 
1138 	ret = ath6kl_bmi_fast_download(ar, address, ar->fw_otp,
1139 				       ar->fw_otp_len);
1140 	if (ret) {
1141 		ath6kl_err("Failed to upload OTP file: %d\n", ret);
1142 		return ret;
1143 	}
1144 
1145 	/* read firmware start address */
1146 	ret = ath6kl_bmi_read(ar,
1147 			      ath6kl_get_hi_item_addr(ar,
1148 						      HI_ITEM(hi_app_start)),
1149 			      (u8 *) &address, sizeof(address));
1150 
1151 	if (ret) {
1152 		ath6kl_err("Failed to read hi_app_start: %d\n", ret);
1153 		return ret;
1154 	}
1155 
1156 	if (ar->hw.app_start_override_addr == 0) {
1157 		ar->hw.app_start_override_addr = address;
1158 		from_hw = true;
1159 	}
1160 
1161 	ath6kl_dbg(ATH6KL_DBG_BOOT, "app_start_override_addr%s 0x%x\n",
1162 		   from_hw ? " (from hw)" : "",
1163 		   ar->hw.app_start_override_addr);
1164 
1165 	/* execute the OTP code */
1166 	ath6kl_dbg(ATH6KL_DBG_BOOT, "executing OTP at 0x%x\n",
1167 		   ar->hw.app_start_override_addr);
1168 	param = 0;
1169 	ath6kl_bmi_execute(ar, ar->hw.app_start_override_addr, &param);
1170 
1171 	return ret;
1172 }
1173 
1174 static int ath6kl_upload_firmware(struct ath6kl *ar)
1175 {
1176 	u32 address;
1177 	int ret;
1178 
1179 	if (WARN_ON(ar->fw == NULL))
1180 		return 0;
1181 
1182 	address = ar->hw.app_load_addr;
1183 
1184 	ath6kl_dbg(ATH6KL_DBG_BOOT, "writing firmware to 0x%x (%zd B)\n",
1185 		   address, ar->fw_len);
1186 
1187 	ret = ath6kl_bmi_fast_download(ar, address, ar->fw, ar->fw_len);
1188 
1189 	if (ret) {
1190 		ath6kl_err("Failed to write firmware: %d\n", ret);
1191 		return ret;
1192 	}
1193 
1194 	/*
1195 	 * Set starting address for firmware
1196 	 * Don't need to setup app_start override addr on AR6004
1197 	 */
1198 	if (ar->target_type != TARGET_TYPE_AR6004) {
1199 		address = ar->hw.app_start_override_addr;
1200 		ath6kl_bmi_set_app_start(ar, address);
1201 	}
1202 	return ret;
1203 }
1204 
1205 static int ath6kl_upload_patch(struct ath6kl *ar)
1206 {
1207 	u32 address, param;
1208 	int ret;
1209 
1210 	if (ar->fw_patch == NULL)
1211 		return 0;
1212 
1213 	address = ar->hw.dataset_patch_addr;
1214 
1215 	ath6kl_dbg(ATH6KL_DBG_BOOT, "writing patch to 0x%x (%zd B)\n",
1216 		   address, ar->fw_patch_len);
1217 
1218 	ret = ath6kl_bmi_write(ar, address, ar->fw_patch, ar->fw_patch_len);
1219 	if (ret) {
1220 		ath6kl_err("Failed to write patch file: %d\n", ret);
1221 		return ret;
1222 	}
1223 
1224 	param = address;
1225 	ath6kl_bmi_write(ar,
1226 			 ath6kl_get_hi_item_addr(ar,
1227 			 HI_ITEM(hi_dset_list_head)),
1228 			 (unsigned char *) &param, 4);
1229 
1230 	return 0;
1231 }
1232 
1233 static int ath6kl_init_upload(struct ath6kl *ar)
1234 {
1235 	u32 param, options, sleep, address;
1236 	int status = 0;
1237 
1238 	if (ar->target_type != TARGET_TYPE_AR6003 &&
1239 		ar->target_type != TARGET_TYPE_AR6004)
1240 		return -EINVAL;
1241 
1242 	/* temporarily disable system sleep */
1243 	address = MBOX_BASE_ADDRESS + LOCAL_SCRATCH_ADDRESS;
1244 	status = ath6kl_bmi_reg_read(ar, address, &param);
1245 	if (status)
1246 		return status;
1247 
1248 	options = param;
1249 
1250 	param |= ATH6KL_OPTION_SLEEP_DISABLE;
1251 	status = ath6kl_bmi_reg_write(ar, address, param);
1252 	if (status)
1253 		return status;
1254 
1255 	address = RTC_BASE_ADDRESS + SYSTEM_SLEEP_ADDRESS;
1256 	status = ath6kl_bmi_reg_read(ar, address, &param);
1257 	if (status)
1258 		return status;
1259 
1260 	sleep = param;
1261 
1262 	param |= SM(SYSTEM_SLEEP_DISABLE, 1);
1263 	status = ath6kl_bmi_reg_write(ar, address, param);
1264 	if (status)
1265 		return status;
1266 
1267 	ath6kl_dbg(ATH6KL_DBG_TRC, "old options: %d, old sleep: %d\n",
1268 		   options, sleep);
1269 
1270 	/* program analog PLL register */
1271 	/* no need to control 40/44MHz clock on AR6004 */
1272 	if (ar->target_type != TARGET_TYPE_AR6004) {
1273 		status = ath6kl_bmi_reg_write(ar, ATH6KL_ANALOG_PLL_REGISTER,
1274 					      0xF9104001);
1275 
1276 		if (status)
1277 			return status;
1278 
1279 		/* Run at 80/88MHz by default */
1280 		param = SM(CPU_CLOCK_STANDARD, 1);
1281 
1282 		address = RTC_BASE_ADDRESS + CPU_CLOCK_ADDRESS;
1283 		status = ath6kl_bmi_reg_write(ar, address, param);
1284 		if (status)
1285 			return status;
1286 	}
1287 
1288 	param = 0;
1289 	address = RTC_BASE_ADDRESS + LPO_CAL_ADDRESS;
1290 	param = SM(LPO_CAL_ENABLE, 1);
1291 	status = ath6kl_bmi_reg_write(ar, address, param);
1292 	if (status)
1293 		return status;
1294 
1295 	/* WAR to avoid SDIO CRC err */
1296 	if (ar->version.target_ver == AR6003_HW_2_0_VERSION) {
1297 		ath6kl_err("temporary war to avoid sdio crc error\n");
1298 
1299 		param = 0x20;
1300 
1301 		address = GPIO_BASE_ADDRESS + GPIO_PIN10_ADDRESS;
1302 		status = ath6kl_bmi_reg_write(ar, address, param);
1303 		if (status)
1304 			return status;
1305 
1306 		address = GPIO_BASE_ADDRESS + GPIO_PIN11_ADDRESS;
1307 		status = ath6kl_bmi_reg_write(ar, address, param);
1308 		if (status)
1309 			return status;
1310 
1311 		address = GPIO_BASE_ADDRESS + GPIO_PIN12_ADDRESS;
1312 		status = ath6kl_bmi_reg_write(ar, address, param);
1313 		if (status)
1314 			return status;
1315 
1316 		address = GPIO_BASE_ADDRESS + GPIO_PIN13_ADDRESS;
1317 		status = ath6kl_bmi_reg_write(ar, address, param);
1318 		if (status)
1319 			return status;
1320 	}
1321 
1322 	/* write EEPROM data to Target RAM */
1323 	status = ath6kl_upload_board_file(ar);
1324 	if (status)
1325 		return status;
1326 
1327 	/* transfer One time Programmable data */
1328 	status = ath6kl_upload_otp(ar);
1329 	if (status)
1330 		return status;
1331 
1332 	/* Download Target firmware */
1333 	status = ath6kl_upload_firmware(ar);
1334 	if (status)
1335 		return status;
1336 
1337 	status = ath6kl_upload_patch(ar);
1338 	if (status)
1339 		return status;
1340 
1341 	/* Restore system sleep */
1342 	address = RTC_BASE_ADDRESS + SYSTEM_SLEEP_ADDRESS;
1343 	status = ath6kl_bmi_reg_write(ar, address, sleep);
1344 	if (status)
1345 		return status;
1346 
1347 	address = MBOX_BASE_ADDRESS + LOCAL_SCRATCH_ADDRESS;
1348 	param = options | 0x20;
1349 	status = ath6kl_bmi_reg_write(ar, address, param);
1350 	if (status)
1351 		return status;
1352 
1353 	/* Configure GPIO AR6003 UART */
1354 	param = CONFIG_AR600x_DEBUG_UART_TX_PIN;
1355 	status = ath6kl_bmi_write(ar,
1356 				  ath6kl_get_hi_item_addr(ar,
1357 				  HI_ITEM(hi_dbg_uart_txpin)),
1358 				  (u8 *)&param, 4);
1359 
1360 	return status;
1361 }
1362 
1363 static int ath6kl_init_hw_params(struct ath6kl *ar)
1364 {
1365 	const struct ath6kl_hw *hw;
1366 	int i;
1367 
1368 	for (i = 0; i < ARRAY_SIZE(hw_list); i++) {
1369 		hw = &hw_list[i];
1370 
1371 		if (hw->id == ar->version.target_ver)
1372 			break;
1373 	}
1374 
1375 	if (i == ARRAY_SIZE(hw_list)) {
1376 		ath6kl_err("Unsupported hardware version: 0x%x\n",
1377 			   ar->version.target_ver);
1378 		return -EINVAL;
1379 	}
1380 
1381 	ar->hw = *hw;
1382 
1383 	ath6kl_dbg(ATH6KL_DBG_BOOT,
1384 		   "target_ver 0x%x target_type 0x%x dataset_patch 0x%x app_load_addr 0x%x\n",
1385 		   ar->version.target_ver, ar->target_type,
1386 		   ar->hw.dataset_patch_addr, ar->hw.app_load_addr);
1387 	ath6kl_dbg(ATH6KL_DBG_BOOT,
1388 		   "app_start_override_addr 0x%x board_ext_data_addr 0x%x reserved_ram_size 0x%x",
1389 		   ar->hw.app_start_override_addr, ar->hw.board_ext_data_addr,
1390 		   ar->hw.reserved_ram_size);
1391 
1392 	return 0;
1393 }
1394 
1395 static const char *ath6kl_init_get_hif_name(enum ath6kl_hif_type type)
1396 {
1397 	switch (type) {
1398 	case ATH6KL_HIF_TYPE_SDIO:
1399 		return "sdio";
1400 	case ATH6KL_HIF_TYPE_USB:
1401 		return "usb";
1402 	}
1403 
1404 	return NULL;
1405 }
1406 
1407 int ath6kl_init_hw_start(struct ath6kl *ar)
1408 {
1409 	long timeleft;
1410 	int ret, i;
1411 
1412 	ath6kl_dbg(ATH6KL_DBG_BOOT, "hw start\n");
1413 
1414 	ret = ath6kl_hif_power_on(ar);
1415 	if (ret)
1416 		return ret;
1417 
1418 	ret = ath6kl_configure_target(ar);
1419 	if (ret)
1420 		goto err_power_off;
1421 
1422 	ret = ath6kl_init_upload(ar);
1423 	if (ret)
1424 		goto err_power_off;
1425 
1426 	/* Do we need to finish the BMI phase */
1427 	/* FIXME: return error from ath6kl_bmi_done() */
1428 	if (ath6kl_bmi_done(ar)) {
1429 		ret = -EIO;
1430 		goto err_power_off;
1431 	}
1432 
1433 	/*
1434 	 * The reason we have to wait for the target here is that the
1435 	 * driver layer has to init BMI in order to set the host block
1436 	 * size.
1437 	 */
1438 	if (ath6kl_htc_wait_target(ar->htc_target)) {
1439 		ret = -EIO;
1440 		goto err_power_off;
1441 	}
1442 
1443 	if (ath6kl_init_service_ep(ar)) {
1444 		ret = -EIO;
1445 		goto err_cleanup_scatter;
1446 	}
1447 
1448 	/* setup credit distribution */
1449 	ath6kl_credit_setup(ar->htc_target, &ar->credit_state_info);
1450 
1451 	/* start HTC */
1452 	ret = ath6kl_htc_start(ar->htc_target);
1453 	if (ret) {
1454 		/* FIXME: call this */
1455 		ath6kl_cookie_cleanup(ar);
1456 		goto err_cleanup_scatter;
1457 	}
1458 
1459 	/* Wait for Wmi event to be ready */
1460 	timeleft = wait_event_interruptible_timeout(ar->event_wq,
1461 						    test_bit(WMI_READY,
1462 							     &ar->flag),
1463 						    WMI_TIMEOUT);
1464 
1465 	ath6kl_dbg(ATH6KL_DBG_BOOT, "firmware booted\n");
1466 
1467 
1468 	if (test_and_clear_bit(FIRST_BOOT, &ar->flag)) {
1469 		ath6kl_info("%s %s fw %s%s\n",
1470 			    ar->hw.name,
1471 			    ath6kl_init_get_hif_name(ar->hif_type),
1472 			    ar->wiphy->fw_version,
1473 			    test_bit(TESTMODE, &ar->flag) ? " testmode" : "");
1474 	}
1475 
1476 	if (ar->version.abi_ver != ATH6KL_ABI_VERSION) {
1477 		ath6kl_err("abi version mismatch: host(0x%x), target(0x%x)\n",
1478 			   ATH6KL_ABI_VERSION, ar->version.abi_ver);
1479 		ret = -EIO;
1480 		goto err_htc_stop;
1481 	}
1482 
1483 	if (!timeleft || signal_pending(current)) {
1484 		ath6kl_err("wmi is not ready or wait was interrupted\n");
1485 		ret = -EIO;
1486 		goto err_htc_stop;
1487 	}
1488 
1489 	ath6kl_dbg(ATH6KL_DBG_TRC, "%s: wmi is ready\n", __func__);
1490 
1491 	/* communicate the wmi protocol verision to the target */
1492 	/* FIXME: return error */
1493 	if ((ath6kl_set_host_app_area(ar)) != 0)
1494 		ath6kl_err("unable to set the host app area\n");
1495 
1496 	for (i = 0; i < ar->vif_max; i++) {
1497 		ret = ath6kl_target_config_wlan_params(ar, i);
1498 		if (ret)
1499 			goto err_htc_stop;
1500 	}
1501 
1502 	ar->state = ATH6KL_STATE_ON;
1503 
1504 	return 0;
1505 
1506 err_htc_stop:
1507 	ath6kl_htc_stop(ar->htc_target);
1508 err_cleanup_scatter:
1509 	ath6kl_hif_cleanup_scatter(ar);
1510 err_power_off:
1511 	ath6kl_hif_power_off(ar);
1512 
1513 	return ret;
1514 }
1515 
1516 int ath6kl_init_hw_stop(struct ath6kl *ar)
1517 {
1518 	int ret;
1519 
1520 	ath6kl_dbg(ATH6KL_DBG_BOOT, "hw stop\n");
1521 
1522 	ath6kl_htc_stop(ar->htc_target);
1523 
1524 	ath6kl_hif_stop(ar);
1525 
1526 	ath6kl_bmi_reset(ar);
1527 
1528 	ret = ath6kl_hif_power_off(ar);
1529 	if (ret)
1530 		ath6kl_warn("failed to power off hif: %d\n", ret);
1531 
1532 	ar->state = ATH6KL_STATE_OFF;
1533 
1534 	return 0;
1535 }
1536 
1537 int ath6kl_core_init(struct ath6kl *ar)
1538 {
1539 	struct ath6kl_bmi_target_info targ_info;
1540 	struct net_device *ndev;
1541 	int ret = 0, i;
1542 
1543 	ar->ath6kl_wq = create_singlethread_workqueue("ath6kl");
1544 	if (!ar->ath6kl_wq)
1545 		return -ENOMEM;
1546 
1547 	ret = ath6kl_bmi_init(ar);
1548 	if (ret)
1549 		goto err_wq;
1550 
1551 	/*
1552 	 * Turn on power to get hardware (target) version and leave power
1553 	 * on delibrately as we will boot the hardware anyway within few
1554 	 * seconds.
1555 	 */
1556 	ret = ath6kl_hif_power_on(ar);
1557 	if (ret)
1558 		goto err_bmi_cleanup;
1559 
1560 	ret = ath6kl_bmi_get_target_info(ar, &targ_info);
1561 	if (ret)
1562 		goto err_power_off;
1563 
1564 	ar->version.target_ver = le32_to_cpu(targ_info.version);
1565 	ar->target_type = le32_to_cpu(targ_info.type);
1566 	ar->wiphy->hw_version = le32_to_cpu(targ_info.version);
1567 
1568 	ret = ath6kl_init_hw_params(ar);
1569 	if (ret)
1570 		goto err_power_off;
1571 
1572 	ar->htc_target = ath6kl_htc_create(ar);
1573 
1574 	if (!ar->htc_target) {
1575 		ret = -ENOMEM;
1576 		goto err_power_off;
1577 	}
1578 
1579 	ret = ath6kl_fetch_firmwares(ar);
1580 	if (ret)
1581 		goto err_htc_cleanup;
1582 
1583 	/* FIXME: we should free all firmwares in the error cases below */
1584 
1585 	/* Indicate that WMI is enabled (although not ready yet) */
1586 	set_bit(WMI_ENABLED, &ar->flag);
1587 	ar->wmi = ath6kl_wmi_init(ar);
1588 	if (!ar->wmi) {
1589 		ath6kl_err("failed to initialize wmi\n");
1590 		ret = -EIO;
1591 		goto err_htc_cleanup;
1592 	}
1593 
1594 	ath6kl_dbg(ATH6KL_DBG_TRC, "%s: got wmi @ 0x%p.\n", __func__, ar->wmi);
1595 
1596 	ret = ath6kl_register_ieee80211_hw(ar);
1597 	if (ret)
1598 		goto err_node_cleanup;
1599 
1600 	ret = ath6kl_debug_init(ar);
1601 	if (ret) {
1602 		wiphy_unregister(ar->wiphy);
1603 		goto err_node_cleanup;
1604 	}
1605 
1606 	for (i = 0; i < ar->vif_max; i++)
1607 		ar->avail_idx_map |= BIT(i);
1608 
1609 	rtnl_lock();
1610 
1611 	/* Add an initial station interface */
1612 	ndev = ath6kl_interface_add(ar, "wlan%d", NL80211_IFTYPE_STATION, 0,
1613 				    INFRA_NETWORK);
1614 
1615 	rtnl_unlock();
1616 
1617 	if (!ndev) {
1618 		ath6kl_err("Failed to instantiate a network device\n");
1619 		ret = -ENOMEM;
1620 		wiphy_unregister(ar->wiphy);
1621 		goto err_debug_init;
1622 	}
1623 
1624 
1625 	ath6kl_dbg(ATH6KL_DBG_TRC, "%s: name=%s dev=0x%p, ar=0x%p\n",
1626 			__func__, ndev->name, ndev, ar);
1627 
1628 	/* setup access class priority mappings */
1629 	ar->ac_stream_pri_map[WMM_AC_BK] = 0; /* lowest  */
1630 	ar->ac_stream_pri_map[WMM_AC_BE] = 1;
1631 	ar->ac_stream_pri_map[WMM_AC_VI] = 2;
1632 	ar->ac_stream_pri_map[WMM_AC_VO] = 3; /* highest */
1633 
1634 	/* give our connected endpoints some buffers */
1635 	ath6kl_rx_refill(ar->htc_target, ar->ctrl_ep);
1636 	ath6kl_rx_refill(ar->htc_target, ar->ac2ep_map[WMM_AC_BE]);
1637 
1638 	/* allocate some buffers that handle larger AMSDU frames */
1639 	ath6kl_refill_amsdu_rxbufs(ar, ATH6KL_MAX_AMSDU_RX_BUFFERS);
1640 
1641 	ath6kl_cookie_init(ar);
1642 
1643 	ar->conf_flags = ATH6KL_CONF_IGNORE_ERP_BARKER |
1644 			 ATH6KL_CONF_ENABLE_11N | ATH6KL_CONF_ENABLE_TX_BURST;
1645 
1646 	if (suspend_cutpower)
1647 		ar->conf_flags |= ATH6KL_CONF_SUSPEND_CUTPOWER;
1648 
1649 	ar->wiphy->flags |= WIPHY_FLAG_SUPPORTS_FW_ROAM |
1650 			    WIPHY_FLAG_HAVE_AP_SME |
1651 			    WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD;
1652 
1653 	ar->wiphy->probe_resp_offload =
1654 		NL80211_PROBE_RESP_OFFLOAD_SUPPORT_WPS |
1655 		NL80211_PROBE_RESP_OFFLOAD_SUPPORT_WPS2 |
1656 		NL80211_PROBE_RESP_OFFLOAD_SUPPORT_P2P |
1657 		NL80211_PROBE_RESP_OFFLOAD_SUPPORT_80211U;
1658 
1659 	set_bit(FIRST_BOOT, &ar->flag);
1660 
1661 	ret = ath6kl_init_hw_start(ar);
1662 	if (ret) {
1663 		ath6kl_err("Failed to start hardware: %d\n", ret);
1664 		goto err_rxbuf_cleanup;
1665 	}
1666 
1667 	/*
1668 	 * Set mac address which is received in ready event
1669 	 * FIXME: Move to ath6kl_interface_add()
1670 	 */
1671 	memcpy(ndev->dev_addr, ar->mac_addr, ETH_ALEN);
1672 
1673 	return ret;
1674 
1675 err_rxbuf_cleanup:
1676 	ath6kl_htc_flush_rx_buf(ar->htc_target);
1677 	ath6kl_cleanup_amsdu_rxbufs(ar);
1678 	rtnl_lock();
1679 	ath6kl_deinit_if_data(netdev_priv(ndev));
1680 	rtnl_unlock();
1681 	wiphy_unregister(ar->wiphy);
1682 err_debug_init:
1683 	ath6kl_debug_cleanup(ar);
1684 err_node_cleanup:
1685 	ath6kl_wmi_shutdown(ar->wmi);
1686 	clear_bit(WMI_ENABLED, &ar->flag);
1687 	ar->wmi = NULL;
1688 err_htc_cleanup:
1689 	ath6kl_htc_cleanup(ar->htc_target);
1690 err_power_off:
1691 	ath6kl_hif_power_off(ar);
1692 err_bmi_cleanup:
1693 	ath6kl_bmi_cleanup(ar);
1694 err_wq:
1695 	destroy_workqueue(ar->ath6kl_wq);
1696 
1697 	return ret;
1698 }
1699 
1700 void ath6kl_cleanup_vif(struct ath6kl_vif *vif, bool wmi_ready)
1701 {
1702 	static u8 bcast_mac[] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
1703 	bool discon_issued;
1704 
1705 	netif_stop_queue(vif->ndev);
1706 
1707 	clear_bit(WLAN_ENABLED, &vif->flags);
1708 
1709 	if (wmi_ready) {
1710 		discon_issued = test_bit(CONNECTED, &vif->flags) ||
1711 				test_bit(CONNECT_PEND, &vif->flags);
1712 		ath6kl_disconnect(vif);
1713 		del_timer(&vif->disconnect_timer);
1714 
1715 		if (discon_issued)
1716 			ath6kl_disconnect_event(vif, DISCONNECT_CMD,
1717 						(vif->nw_type & AP_NETWORK) ?
1718 						bcast_mac : vif->bssid,
1719 						0, NULL, 0);
1720 	}
1721 
1722 	if (vif->scan_req) {
1723 		cfg80211_scan_done(vif->scan_req, true);
1724 		vif->scan_req = NULL;
1725 	}
1726 }
1727 
1728 void ath6kl_stop_txrx(struct ath6kl *ar)
1729 {
1730 	struct ath6kl_vif *vif, *tmp_vif;
1731 
1732 	set_bit(DESTROY_IN_PROGRESS, &ar->flag);
1733 
1734 	if (down_interruptible(&ar->sem)) {
1735 		ath6kl_err("down_interruptible failed\n");
1736 		return;
1737 	}
1738 
1739 	spin_lock_bh(&ar->list_lock);
1740 	list_for_each_entry_safe(vif, tmp_vif, &ar->vif_list, list) {
1741 		list_del(&vif->list);
1742 		spin_unlock_bh(&ar->list_lock);
1743 		ath6kl_cleanup_vif(vif, test_bit(WMI_READY, &ar->flag));
1744 		rtnl_lock();
1745 		ath6kl_deinit_if_data(vif);
1746 		rtnl_unlock();
1747 		spin_lock_bh(&ar->list_lock);
1748 	}
1749 	spin_unlock_bh(&ar->list_lock);
1750 
1751 	clear_bit(WMI_READY, &ar->flag);
1752 
1753 	/*
1754 	 * After wmi_shudown all WMI events will be dropped. We
1755 	 * need to cleanup the buffers allocated in AP mode and
1756 	 * give disconnect notification to stack, which usually
1757 	 * happens in the disconnect_event. Simulate the disconnect
1758 	 * event by calling the function directly. Sometimes
1759 	 * disconnect_event will be received when the debug logs
1760 	 * are collected.
1761 	 */
1762 	ath6kl_wmi_shutdown(ar->wmi);
1763 
1764 	clear_bit(WMI_ENABLED, &ar->flag);
1765 	if (ar->htc_target) {
1766 		ath6kl_dbg(ATH6KL_DBG_TRC, "%s: shut down htc\n", __func__);
1767 		ath6kl_htc_stop(ar->htc_target);
1768 	}
1769 
1770 	/*
1771 	 * Try to reset the device if we can. The driver may have been
1772 	 * configure NOT to reset the target during a debug session.
1773 	 */
1774 	ath6kl_dbg(ATH6KL_DBG_TRC,
1775 			"attempting to reset target on instance destroy\n");
1776 	ath6kl_reset_device(ar, ar->target_type, true, true);
1777 
1778 	clear_bit(WLAN_ENABLED, &ar->flag);
1779 }
1780