xref: /linux/drivers/net/wireless/ath/wil6210/wmi.c (revision d0b73b488c55df905ea8faaad079f8535629ed26)
1 /*
2  * Copyright (c) 2012 Qualcomm Atheros, Inc.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 #include <linux/pci.h>
18 #include <linux/io.h>
19 #include <linux/list.h>
20 #include <linux/etherdevice.h>
21 
22 #include "wil6210.h"
23 #include "wmi.h"
24 
25 /**
26  * WMI event receiving - theory of operations
27  *
28  * When firmware about to report WMI event, it fills memory area
29  * in the mailbox and raises misc. IRQ. Thread interrupt handler invoked for
30  * the misc IRQ, function @wmi_recv_cmd called by thread IRQ handler.
31  *
32  * @wmi_recv_cmd reads event, allocates memory chunk  and attaches it to the
33  * event list @wil->pending_wmi_ev. Then, work queue @wil->wmi_wq wakes up
34  * and handles events within the @wmi_event_worker. Every event get detached
35  * from list, processed and deleted.
36  *
37  * Purpose for this mechanism is to release IRQ thread; otherwise,
38  * if WMI event handling involves another WMI command flow, this 2-nd flow
39  * won't be completed because of blocked IRQ thread.
40  */
41 
42 /**
43  * Addressing - theory of operations
44  *
45  * There are several buses present on the WIL6210 card.
46  * Same memory areas are visible at different address on
47  * the different busses. There are 3 main bus masters:
48  *  - MAC CPU (ucode)
49  *  - User CPU (firmware)
50  *  - AHB (host)
51  *
52  * On the PCI bus, there is one BAR (BAR0) of 2Mb size, exposing
53  * AHB addresses starting from 0x880000
54  *
55  * Internally, firmware uses addresses that allows faster access but
56  * are invisible from the host. To read from these addresses, alternative
57  * AHB address must be used.
58  *
59  * Memory mapping
60  * Linker address         PCI/Host address
61  *                        0x880000 .. 0xa80000  2Mb BAR0
62  * 0x800000 .. 0x807000   0x900000 .. 0x907000  28k DCCM
63  * 0x840000 .. 0x857000   0x908000 .. 0x91f000  92k PERIPH
64  */
65 
66 /**
67  * @fw_mapping provides memory remapping table
68  */
69 static const struct {
70 	u32 from; /* linker address - from, inclusive */
71 	u32 to;   /* linker address - to, exclusive */
72 	u32 host; /* PCI/Host address - BAR0 + 0x880000 */
73 } fw_mapping[] = {
74 	{0x000000, 0x040000, 0x8c0000}, /* FW code RAM 256k */
75 	{0x800000, 0x808000, 0x900000}, /* FW data RAM 32k */
76 	{0x840000, 0x860000, 0x908000}, /* peripheral data RAM 128k/96k used */
77 	{0x880000, 0x88a000, 0x880000}, /* various RGF */
78 	{0x8c0000, 0x932000, 0x8c0000}, /* trivial mapping for upper area */
79 	/*
80 	 * 920000..930000 ucode code RAM
81 	 * 930000..932000 ucode data RAM
82 	 */
83 };
84 
85 /**
86  * return AHB address for given firmware/ucode internal (linker) address
87  * @x - internal address
88  * If address have no valid AHB mapping, return 0
89  */
90 static u32 wmi_addr_remap(u32 x)
91 {
92 	uint i;
93 
94 	for (i = 0; i < ARRAY_SIZE(fw_mapping); i++) {
95 		if ((x >= fw_mapping[i].from) && (x < fw_mapping[i].to))
96 			return x + fw_mapping[i].host - fw_mapping[i].from;
97 	}
98 
99 	return 0;
100 }
101 
102 /**
103  * Check address validity for WMI buffer; remap if needed
104  * @ptr - internal (linker) fw/ucode address
105  *
106  * Valid buffer should be DWORD aligned
107  *
108  * return address for accessing buffer from the host;
109  * if buffer is not valid, return NULL.
110  */
111 void __iomem *wmi_buffer(struct wil6210_priv *wil, __le32 ptr_)
112 {
113 	u32 off;
114 	u32 ptr = le32_to_cpu(ptr_);
115 
116 	if (ptr % 4)
117 		return NULL;
118 
119 	ptr = wmi_addr_remap(ptr);
120 	if (ptr < WIL6210_FW_HOST_OFF)
121 		return NULL;
122 
123 	off = HOSTADDR(ptr);
124 	if (off > WIL6210_MEM_SIZE - 4)
125 		return NULL;
126 
127 	return wil->csr + off;
128 }
129 
130 /**
131  * Check address validity
132  */
133 void __iomem *wmi_addr(struct wil6210_priv *wil, u32 ptr)
134 {
135 	u32 off;
136 
137 	if (ptr % 4)
138 		return NULL;
139 
140 	if (ptr < WIL6210_FW_HOST_OFF)
141 		return NULL;
142 
143 	off = HOSTADDR(ptr);
144 	if (off > WIL6210_MEM_SIZE - 4)
145 		return NULL;
146 
147 	return wil->csr + off;
148 }
149 
150 int wmi_read_hdr(struct wil6210_priv *wil, __le32 ptr,
151 		 struct wil6210_mbox_hdr *hdr)
152 {
153 	void __iomem *src = wmi_buffer(wil, ptr);
154 	if (!src)
155 		return -EINVAL;
156 
157 	wil_memcpy_fromio_32(hdr, src, sizeof(*hdr));
158 
159 	return 0;
160 }
161 
162 static int __wmi_send(struct wil6210_priv *wil, u16 cmdid, void *buf, u16 len)
163 {
164 	struct {
165 		struct wil6210_mbox_hdr hdr;
166 		struct wil6210_mbox_hdr_wmi wmi;
167 	} __packed cmd = {
168 		.hdr = {
169 			.type = WIL_MBOX_HDR_TYPE_WMI,
170 			.flags = 0,
171 			.len = cpu_to_le16(sizeof(cmd.wmi) + len),
172 		},
173 		.wmi = {
174 			.id = cpu_to_le16(cmdid),
175 			.info1 = 0,
176 		},
177 	};
178 	struct wil6210_mbox_ring *r = &wil->mbox_ctl.tx;
179 	struct wil6210_mbox_ring_desc d_head;
180 	u32 next_head;
181 	void __iomem *dst;
182 	void __iomem *head = wmi_addr(wil, r->head);
183 	uint retry;
184 
185 	if (sizeof(cmd) + len > r->entry_size) {
186 		wil_err(wil, "WMI size too large: %d bytes, max is %d\n",
187 			(int)(sizeof(cmd) + len), r->entry_size);
188 		return -ERANGE;
189 
190 	}
191 
192 	might_sleep();
193 
194 	if (!test_bit(wil_status_fwready, &wil->status)) {
195 		wil_err(wil, "FW not ready\n");
196 		return -EAGAIN;
197 	}
198 
199 	if (!head) {
200 		wil_err(wil, "WMI head is garbage: 0x%08x\n", r->head);
201 		return -EINVAL;
202 	}
203 	/* read Tx head till it is not busy */
204 	for (retry = 5; retry > 0; retry--) {
205 		wil_memcpy_fromio_32(&d_head, head, sizeof(d_head));
206 		if (d_head.sync == 0)
207 			break;
208 		msleep(20);
209 	}
210 	if (d_head.sync != 0) {
211 		wil_err(wil, "WMI head busy\n");
212 		return -EBUSY;
213 	}
214 	/* next head */
215 	next_head = r->base + ((r->head - r->base + sizeof(d_head)) % r->size);
216 	wil_dbg_WMI(wil, "Head 0x%08x -> 0x%08x\n", r->head, next_head);
217 	/* wait till FW finish with previous command */
218 	for (retry = 5; retry > 0; retry--) {
219 		r->tail = ioread32(wil->csr + HOST_MBOX +
220 				   offsetof(struct wil6210_mbox_ctl, tx.tail));
221 		if (next_head != r->tail)
222 			break;
223 		msleep(20);
224 	}
225 	if (next_head == r->tail) {
226 		wil_err(wil, "WMI ring full\n");
227 		return -EBUSY;
228 	}
229 	dst = wmi_buffer(wil, d_head.addr);
230 	if (!dst) {
231 		wil_err(wil, "invalid WMI buffer: 0x%08x\n",
232 			le32_to_cpu(d_head.addr));
233 		return -EINVAL;
234 	}
235 	cmd.hdr.seq = cpu_to_le16(++wil->wmi_seq);
236 	/* set command */
237 	wil_dbg_WMI(wil, "WMI command 0x%04x [%d]\n", cmdid, len);
238 	wil_hex_dump_WMI("Cmd ", DUMP_PREFIX_OFFSET, 16, 1, &cmd,
239 			 sizeof(cmd), true);
240 	wil_hex_dump_WMI("cmd ", DUMP_PREFIX_OFFSET, 16, 1, buf,
241 			 len, true);
242 	wil_memcpy_toio_32(dst, &cmd, sizeof(cmd));
243 	wil_memcpy_toio_32(dst + sizeof(cmd), buf, len);
244 	/* mark entry as full */
245 	iowrite32(1, wil->csr + HOSTADDR(r->head) +
246 		  offsetof(struct wil6210_mbox_ring_desc, sync));
247 	/* advance next ptr */
248 	iowrite32(r->head = next_head, wil->csr + HOST_MBOX +
249 		  offsetof(struct wil6210_mbox_ctl, tx.head));
250 
251 	/* interrupt to FW */
252 	iowrite32(SW_INT_MBOX, wil->csr + HOST_SW_INT);
253 
254 	return 0;
255 }
256 
257 int wmi_send(struct wil6210_priv *wil, u16 cmdid, void *buf, u16 len)
258 {
259 	int rc;
260 
261 	mutex_lock(&wil->wmi_mutex);
262 	rc = __wmi_send(wil, cmdid, buf, len);
263 	mutex_unlock(&wil->wmi_mutex);
264 
265 	return rc;
266 }
267 
268 /*=== Event handlers ===*/
269 static void wmi_evt_ready(struct wil6210_priv *wil, int id, void *d, int len)
270 {
271 	struct net_device *ndev = wil_to_ndev(wil);
272 	struct wireless_dev *wdev = wil->wdev;
273 	struct wmi_ready_event *evt = d;
274 	u32 ver = le32_to_cpu(evt->sw_version);
275 
276 	wil_dbg_WMI(wil, "FW ver. %d; MAC %pM\n", ver, evt->mac);
277 
278 	if (!is_valid_ether_addr(ndev->dev_addr)) {
279 		memcpy(ndev->dev_addr, evt->mac, ETH_ALEN);
280 		memcpy(ndev->perm_addr, evt->mac, ETH_ALEN);
281 	}
282 	snprintf(wdev->wiphy->fw_version, sizeof(wdev->wiphy->fw_version),
283 		 "%d", ver);
284 }
285 
286 static void wmi_evt_fw_ready(struct wil6210_priv *wil, int id, void *d,
287 			     int len)
288 {
289 	wil_dbg_WMI(wil, "WMI: FW ready\n");
290 
291 	set_bit(wil_status_fwready, &wil->status);
292 	/* reuse wmi_ready for the firmware ready indication */
293 	complete(&wil->wmi_ready);
294 }
295 
296 static void wmi_evt_rx_mgmt(struct wil6210_priv *wil, int id, void *d, int len)
297 {
298 	struct wmi_rx_mgmt_packet_event *data = d;
299 	struct wiphy *wiphy = wil_to_wiphy(wil);
300 	struct ieee80211_mgmt *rx_mgmt_frame =
301 			(struct ieee80211_mgmt *)data->payload;
302 	int ch_no = data->info.channel+1;
303 	u32 freq = ieee80211_channel_to_frequency(ch_no,
304 			IEEE80211_BAND_60GHZ);
305 	struct ieee80211_channel *channel = ieee80211_get_channel(wiphy, freq);
306 	/* TODO convert LE to CPU */
307 	s32 signal = 0; /* TODO */
308 	__le16 fc = rx_mgmt_frame->frame_control;
309 	u32 d_len = le32_to_cpu(data->info.len);
310 	u16 d_status = le16_to_cpu(data->info.status);
311 
312 	wil_dbg_WMI(wil, "MGMT: channel %d MCS %d SNR %d\n",
313 		    data->info.channel, data->info.mcs, data->info.snr);
314 	wil_dbg_WMI(wil, "status 0x%04x len %d stype %04x\n", d_status, d_len,
315 		    le16_to_cpu(data->info.stype));
316 	wil_dbg_WMI(wil, "qid %d mid %d cid %d\n",
317 		    data->info.qid, data->info.mid, data->info.cid);
318 
319 	if (!channel) {
320 		wil_err(wil, "Frame on unsupported channel\n");
321 		return;
322 	}
323 
324 	if (ieee80211_is_beacon(fc) || ieee80211_is_probe_resp(fc)) {
325 		struct cfg80211_bss *bss;
326 		u64 tsf = le64_to_cpu(rx_mgmt_frame->u.beacon.timestamp);
327 		u16 cap = le16_to_cpu(rx_mgmt_frame->u.beacon.capab_info);
328 		u16 bi = le16_to_cpu(rx_mgmt_frame->u.beacon.beacon_int);
329 		const u8 *ie_buf = rx_mgmt_frame->u.beacon.variable;
330 		size_t ie_len = d_len - offsetof(struct ieee80211_mgmt,
331 						 u.beacon.variable);
332 		wil_dbg_WMI(wil, "Capability info : 0x%04x\n", cap);
333 
334 		bss = cfg80211_inform_bss(wiphy, channel, rx_mgmt_frame->bssid,
335 					  tsf, cap, bi, ie_buf, ie_len,
336 					  signal, GFP_KERNEL);
337 		if (bss) {
338 			wil_dbg_WMI(wil, "Added BSS %pM\n",
339 				    rx_mgmt_frame->bssid);
340 			cfg80211_put_bss(bss);
341 		} else {
342 			wil_err(wil, "cfg80211_inform_bss() failed\n");
343 		}
344 	}
345 }
346 
347 static void wmi_evt_scan_complete(struct wil6210_priv *wil, int id,
348 				  void *d, int len)
349 {
350 	if (wil->scan_request) {
351 		struct wmi_scan_complete_event *data = d;
352 		bool aborted = (data->status != 0);
353 
354 		wil_dbg_WMI(wil, "SCAN_COMPLETE(0x%08x)\n", data->status);
355 		cfg80211_scan_done(wil->scan_request, aborted);
356 		wil->scan_request = NULL;
357 	} else {
358 		wil_err(wil, "SCAN_COMPLETE while not scanning\n");
359 	}
360 }
361 
362 static void wmi_evt_connect(struct wil6210_priv *wil, int id, void *d, int len)
363 {
364 	struct net_device *ndev = wil_to_ndev(wil);
365 	struct wireless_dev *wdev = wil->wdev;
366 	struct wmi_connect_event *evt = d;
367 	int ch; /* channel number */
368 	struct station_info sinfo;
369 	u8 *assoc_req_ie, *assoc_resp_ie;
370 	size_t assoc_req_ielen, assoc_resp_ielen;
371 	/* capinfo(u16) + listen_interval(u16) + IEs */
372 	const size_t assoc_req_ie_offset = sizeof(u16) * 2;
373 	/* capinfo(u16) + status_code(u16) + associd(u16) + IEs */
374 	const size_t assoc_resp_ie_offset = sizeof(u16) * 3;
375 
376 	if (len < sizeof(*evt)) {
377 		wil_err(wil, "Connect event too short : %d bytes\n", len);
378 		return;
379 	}
380 	if (len != sizeof(*evt) + evt->beacon_ie_len + evt->assoc_req_len +
381 		   evt->assoc_resp_len) {
382 		wil_err(wil,
383 			"Connect event corrupted : %d != %d + %d + %d + %d\n",
384 			len, (int)sizeof(*evt), evt->beacon_ie_len,
385 			evt->assoc_req_len, evt->assoc_resp_len);
386 		return;
387 	}
388 	ch = evt->channel + 1;
389 	wil_dbg_WMI(wil, "Connect %pM channel [%d] cid %d\n",
390 		    evt->bssid, ch, evt->cid);
391 	wil_hex_dump_WMI("connect AI : ", DUMP_PREFIX_OFFSET, 16, 1,
392 			 evt->assoc_info, len - sizeof(*evt), true);
393 
394 	/* figure out IE's */
395 	assoc_req_ie = &evt->assoc_info[evt->beacon_ie_len +
396 					assoc_req_ie_offset];
397 	assoc_req_ielen = evt->assoc_req_len - assoc_req_ie_offset;
398 	if (evt->assoc_req_len <= assoc_req_ie_offset) {
399 		assoc_req_ie = NULL;
400 		assoc_req_ielen = 0;
401 	}
402 
403 	assoc_resp_ie = &evt->assoc_info[evt->beacon_ie_len +
404 					 evt->assoc_req_len +
405 					 assoc_resp_ie_offset];
406 	assoc_resp_ielen = evt->assoc_resp_len - assoc_resp_ie_offset;
407 	if (evt->assoc_resp_len <= assoc_resp_ie_offset) {
408 		assoc_resp_ie = NULL;
409 		assoc_resp_ielen = 0;
410 	}
411 
412 	if ((wdev->iftype == NL80211_IFTYPE_STATION) ||
413 	    (wdev->iftype == NL80211_IFTYPE_P2P_CLIENT)) {
414 		if (wdev->sme_state != CFG80211_SME_CONNECTING) {
415 			wil_err(wil, "Not in connecting state\n");
416 			return;
417 		}
418 		del_timer_sync(&wil->connect_timer);
419 		cfg80211_connect_result(ndev, evt->bssid,
420 					assoc_req_ie, assoc_req_ielen,
421 					assoc_resp_ie, assoc_resp_ielen,
422 					WLAN_STATUS_SUCCESS, GFP_KERNEL);
423 
424 	} else if ((wdev->iftype == NL80211_IFTYPE_AP) ||
425 		   (wdev->iftype == NL80211_IFTYPE_P2P_GO)) {
426 		memset(&sinfo, 0, sizeof(sinfo));
427 
428 		sinfo.generation = wil->sinfo_gen++;
429 
430 		if (assoc_req_ie) {
431 			sinfo.assoc_req_ies = assoc_req_ie;
432 			sinfo.assoc_req_ies_len = assoc_req_ielen;
433 			sinfo.filled |= STATION_INFO_ASSOC_REQ_IES;
434 		}
435 
436 		cfg80211_new_sta(ndev, evt->bssid, &sinfo, GFP_KERNEL);
437 	}
438 	set_bit(wil_status_fwconnected, &wil->status);
439 
440 	/* FIXME FW can transmit only ucast frames to peer */
441 	/* FIXME real ring_id instead of hard coded 0 */
442 	memcpy(wil->dst_addr[0], evt->bssid, ETH_ALEN);
443 
444 	wil->pending_connect_cid = evt->cid;
445 	queue_work(wil->wmi_wq_conn, &wil->wmi_connect_worker);
446 }
447 
448 static void wmi_evt_disconnect(struct wil6210_priv *wil, int id,
449 			       void *d, int len)
450 {
451 	struct wmi_disconnect_event *evt = d;
452 
453 	wil_dbg_WMI(wil, "Disconnect %pM reason %d proto %d wmi\n",
454 		    evt->bssid,
455 		    evt->protocol_reason_status, evt->disconnect_reason);
456 
457 	wil->sinfo_gen++;
458 
459 	wil6210_disconnect(wil, evt->bssid);
460 	clear_bit(wil_status_dontscan, &wil->status);
461 }
462 
463 static void wmi_evt_notify(struct wil6210_priv *wil, int id, void *d, int len)
464 {
465 	struct wmi_notify_req_done_event *evt = d;
466 
467 	if (len < sizeof(*evt)) {
468 		wil_err(wil, "Short NOTIFY event\n");
469 		return;
470 	}
471 
472 	wil->stats.tsf = le64_to_cpu(evt->tsf);
473 	wil->stats.snr = le32_to_cpu(evt->snr_val);
474 	wil->stats.bf_mcs = le16_to_cpu(evt->bf_mcs);
475 	wil->stats.my_rx_sector = le16_to_cpu(evt->my_rx_sector);
476 	wil->stats.my_tx_sector = le16_to_cpu(evt->my_tx_sector);
477 	wil->stats.peer_rx_sector = le16_to_cpu(evt->other_rx_sector);
478 	wil->stats.peer_tx_sector = le16_to_cpu(evt->other_tx_sector);
479 	wil_dbg_WMI(wil, "Link status, MCS %d TSF 0x%016llx\n"
480 		    "BF status 0x%08x SNR 0x%08x\n"
481 		    "Tx Tpt %d goodput %d Rx goodput %d\n"
482 		    "Sectors(rx:tx) my %d:%d peer %d:%d\n",
483 		    wil->stats.bf_mcs, wil->stats.tsf, evt->status,
484 		    wil->stats.snr, le32_to_cpu(evt->tx_tpt),
485 		    le32_to_cpu(evt->tx_goodput), le32_to_cpu(evt->rx_goodput),
486 		    wil->stats.my_rx_sector, wil->stats.my_tx_sector,
487 		    wil->stats.peer_rx_sector, wil->stats.peer_tx_sector);
488 }
489 
490 /*
491  * Firmware reports EAPOL frame using WME event.
492  * Reconstruct Ethernet frame and deliver it via normal Rx
493  */
494 static void wmi_evt_eapol_rx(struct wil6210_priv *wil, int id,
495 			     void *d, int len)
496 {
497 	struct net_device *ndev = wil_to_ndev(wil);
498 	struct wmi_eapol_rx_event *evt = d;
499 	u16 eapol_len = le16_to_cpu(evt->eapol_len);
500 	int sz = eapol_len + ETH_HLEN;
501 	struct sk_buff *skb;
502 	struct ethhdr *eth;
503 
504 	wil_dbg_WMI(wil, "EAPOL len %d from %pM\n", eapol_len,
505 		    evt->src_mac);
506 
507 	if (eapol_len > 196) { /* TODO: revisit size limit */
508 		wil_err(wil, "EAPOL too large\n");
509 		return;
510 	}
511 
512 	skb = alloc_skb(sz, GFP_KERNEL);
513 	if (!skb) {
514 		wil_err(wil, "Failed to allocate skb\n");
515 		return;
516 	}
517 	eth = (struct ethhdr *)skb_put(skb, ETH_HLEN);
518 	memcpy(eth->h_dest, ndev->dev_addr, ETH_ALEN);
519 	memcpy(eth->h_source, evt->src_mac, ETH_ALEN);
520 	eth->h_proto = cpu_to_be16(ETH_P_PAE);
521 	memcpy(skb_put(skb, eapol_len), evt->eapol, eapol_len);
522 	skb->protocol = eth_type_trans(skb, ndev);
523 	if (likely(netif_rx_ni(skb) == NET_RX_SUCCESS)) {
524 		ndev->stats.rx_packets++;
525 		ndev->stats.rx_bytes += skb->len;
526 	} else {
527 		ndev->stats.rx_dropped++;
528 	}
529 }
530 
531 static const struct {
532 	int eventid;
533 	void (*handler)(struct wil6210_priv *wil, int eventid,
534 			void *data, int data_len);
535 } wmi_evt_handlers[] = {
536 	{WMI_READY_EVENTID,		wmi_evt_ready},
537 	{WMI_FW_READY_EVENTID,		wmi_evt_fw_ready},
538 	{WMI_RX_MGMT_PACKET_EVENTID,	wmi_evt_rx_mgmt},
539 	{WMI_SCAN_COMPLETE_EVENTID,	wmi_evt_scan_complete},
540 	{WMI_CONNECT_EVENTID,		wmi_evt_connect},
541 	{WMI_DISCONNECT_EVENTID,	wmi_evt_disconnect},
542 	{WMI_NOTIFY_REQ_DONE_EVENTID,	wmi_evt_notify},
543 	{WMI_EAPOL_RX_EVENTID,		wmi_evt_eapol_rx},
544 };
545 
546 /*
547  * Run in IRQ context
548  * Extract WMI command from mailbox. Queue it to the @wil->pending_wmi_ev
549  * that will be eventually handled by the @wmi_event_worker in the thread
550  * context of thread "wil6210_wmi"
551  */
552 void wmi_recv_cmd(struct wil6210_priv *wil)
553 {
554 	struct wil6210_mbox_ring_desc d_tail;
555 	struct wil6210_mbox_hdr hdr;
556 	struct wil6210_mbox_ring *r = &wil->mbox_ctl.rx;
557 	struct pending_wmi_event *evt;
558 	u8 *cmd;
559 	void __iomem *src;
560 	ulong flags;
561 
562 	for (;;) {
563 		u16 len;
564 
565 		r->head = ioread32(wil->csr + HOST_MBOX +
566 				   offsetof(struct wil6210_mbox_ctl, rx.head));
567 		if (r->tail == r->head)
568 			return;
569 
570 		/* read cmd from tail */
571 		wil_memcpy_fromio_32(&d_tail, wil->csr + HOSTADDR(r->tail),
572 				     sizeof(struct wil6210_mbox_ring_desc));
573 		if (d_tail.sync == 0) {
574 			wil_err(wil, "Mbox evt not owned by FW?\n");
575 			return;
576 		}
577 
578 		if (0 != wmi_read_hdr(wil, d_tail.addr, &hdr)) {
579 			wil_err(wil, "Mbox evt at 0x%08x?\n",
580 				le32_to_cpu(d_tail.addr));
581 			return;
582 		}
583 
584 		len = le16_to_cpu(hdr.len);
585 		src = wmi_buffer(wil, d_tail.addr) +
586 		      sizeof(struct wil6210_mbox_hdr);
587 		evt = kmalloc(ALIGN(offsetof(struct pending_wmi_event,
588 					     event.wmi) + len, 4),
589 			      GFP_KERNEL);
590 		if (!evt) {
591 			wil_err(wil, "kmalloc for WMI event (%d) failed\n",
592 				len);
593 			return;
594 		}
595 		evt->event.hdr = hdr;
596 		cmd = (void *)&evt->event.wmi;
597 		wil_memcpy_fromio_32(cmd, src, len);
598 		/* mark entry as empty */
599 		iowrite32(0, wil->csr + HOSTADDR(r->tail) +
600 			  offsetof(struct wil6210_mbox_ring_desc, sync));
601 		/* indicate */
602 		wil_dbg_WMI(wil, "Mbox evt %04x %04x %04x %02x\n",
603 			    le16_to_cpu(hdr.seq), len, le16_to_cpu(hdr.type),
604 			    hdr.flags);
605 		if ((hdr.type == WIL_MBOX_HDR_TYPE_WMI) &&
606 		    (len >= sizeof(struct wil6210_mbox_hdr_wmi))) {
607 			wil_dbg_WMI(wil, "WMI event 0x%04x\n",
608 				    evt->event.wmi.id);
609 		}
610 		wil_hex_dump_WMI("evt ", DUMP_PREFIX_OFFSET, 16, 1,
611 				 &evt->event.hdr, sizeof(hdr) + len, true);
612 
613 		/* advance tail */
614 		r->tail = r->base + ((r->tail - r->base +
615 			  sizeof(struct wil6210_mbox_ring_desc)) % r->size);
616 		iowrite32(r->tail, wil->csr + HOST_MBOX +
617 			  offsetof(struct wil6210_mbox_ctl, rx.tail));
618 
619 		/* add to the pending list */
620 		spin_lock_irqsave(&wil->wmi_ev_lock, flags);
621 		list_add_tail(&evt->list, &wil->pending_wmi_ev);
622 		spin_unlock_irqrestore(&wil->wmi_ev_lock, flags);
623 		{
624 			int q =	queue_work(wil->wmi_wq,
625 					   &wil->wmi_event_worker);
626 			wil_dbg_WMI(wil, "queue_work -> %d\n", q);
627 		}
628 	}
629 }
630 
631 int wmi_call(struct wil6210_priv *wil, u16 cmdid, void *buf, u16 len,
632 	     u16 reply_id, void *reply, u8 reply_size, int to_msec)
633 {
634 	int rc;
635 	int remain;
636 
637 	mutex_lock(&wil->wmi_mutex);
638 
639 	rc = __wmi_send(wil, cmdid, buf, len);
640 	if (rc)
641 		goto out;
642 
643 	wil->reply_id = reply_id;
644 	wil->reply_buf = reply;
645 	wil->reply_size = reply_size;
646 	remain = wait_for_completion_timeout(&wil->wmi_ready,
647 			msecs_to_jiffies(to_msec));
648 	if (0 == remain) {
649 		wil_err(wil, "wmi_call(0x%04x->0x%04x) timeout %d msec\n",
650 			cmdid, reply_id, to_msec);
651 		rc = -ETIME;
652 	} else {
653 		wil_dbg_WMI(wil,
654 			    "wmi_call(0x%04x->0x%04x) completed in %d msec\n",
655 			    cmdid, reply_id,
656 			    to_msec - jiffies_to_msecs(remain));
657 	}
658 	wil->reply_id = 0;
659 	wil->reply_buf = NULL;
660 	wil->reply_size = 0;
661  out:
662 	mutex_unlock(&wil->wmi_mutex);
663 
664 	return rc;
665 }
666 
667 int wmi_echo(struct wil6210_priv *wil)
668 {
669 	struct wmi_echo_cmd cmd = {
670 		.value = cpu_to_le32(0x12345678),
671 	};
672 
673 	return wmi_call(wil, WMI_ECHO_CMDID, &cmd, sizeof(cmd),
674 			 WMI_ECHO_RSP_EVENTID, NULL, 0, 20);
675 }
676 
677 int wmi_set_mac_address(struct wil6210_priv *wil, void *addr)
678 {
679 	struct wmi_set_mac_address_cmd cmd;
680 
681 	memcpy(cmd.mac, addr, ETH_ALEN);
682 
683 	wil_dbg_WMI(wil, "Set MAC %pM\n", addr);
684 
685 	return wmi_send(wil, WMI_SET_MAC_ADDRESS_CMDID, &cmd, sizeof(cmd));
686 }
687 
688 int wmi_set_bcon(struct wil6210_priv *wil, int bi, u8 wmi_nettype)
689 {
690 	struct wmi_bcon_ctrl_cmd cmd = {
691 		.bcon_interval = cpu_to_le16(bi),
692 		.network_type = wmi_nettype,
693 		.disable_sec_offload = 1,
694 	};
695 
696 	if (!wil->secure_pcp)
697 		cmd.disable_sec = 1;
698 
699 	return wmi_send(wil, WMI_BCON_CTRL_CMDID, &cmd, sizeof(cmd));
700 }
701 
702 int wmi_set_ssid(struct wil6210_priv *wil, u8 ssid_len, const void *ssid)
703 {
704 	struct wmi_set_ssid_cmd cmd = {
705 		.ssid_len = cpu_to_le32(ssid_len),
706 	};
707 
708 	if (ssid_len > sizeof(cmd.ssid))
709 		return -EINVAL;
710 
711 	memcpy(cmd.ssid, ssid, ssid_len);
712 
713 	return wmi_send(wil, WMI_SET_SSID_CMDID, &cmd, sizeof(cmd));
714 }
715 
716 int wmi_get_ssid(struct wil6210_priv *wil, u8 *ssid_len, void *ssid)
717 {
718 	int rc;
719 	struct {
720 		struct wil6210_mbox_hdr_wmi wmi;
721 		struct wmi_set_ssid_cmd cmd;
722 	} __packed reply;
723 	int len; /* reply.cmd.ssid_len in CPU order */
724 
725 	rc = wmi_call(wil, WMI_GET_SSID_CMDID, NULL, 0, WMI_GET_SSID_EVENTID,
726 		      &reply, sizeof(reply), 20);
727 	if (rc)
728 		return rc;
729 
730 	len = le32_to_cpu(reply.cmd.ssid_len);
731 	if (len > sizeof(reply.cmd.ssid))
732 		return -EINVAL;
733 
734 	*ssid_len = len;
735 	memcpy(ssid, reply.cmd.ssid, len);
736 
737 	return 0;
738 }
739 
740 int wmi_set_channel(struct wil6210_priv *wil, int channel)
741 {
742 	struct wmi_set_pcp_channel_cmd cmd = {
743 		.channel = channel - 1,
744 	};
745 
746 	return wmi_send(wil, WMI_SET_PCP_CHANNEL_CMDID, &cmd, sizeof(cmd));
747 }
748 
749 int wmi_get_channel(struct wil6210_priv *wil, int *channel)
750 {
751 	int rc;
752 	struct {
753 		struct wil6210_mbox_hdr_wmi wmi;
754 		struct wmi_set_pcp_channel_cmd cmd;
755 	} __packed reply;
756 
757 	rc = wmi_call(wil, WMI_GET_PCP_CHANNEL_CMDID, NULL, 0,
758 		      WMI_GET_PCP_CHANNEL_EVENTID, &reply, sizeof(reply), 20);
759 	if (rc)
760 		return rc;
761 
762 	if (reply.cmd.channel > 3)
763 		return -EINVAL;
764 
765 	*channel = reply.cmd.channel + 1;
766 
767 	return 0;
768 }
769 
770 int wmi_tx_eapol(struct wil6210_priv *wil, struct sk_buff *skb)
771 {
772 	struct wmi_eapol_tx_cmd *cmd;
773 	struct ethhdr *eth;
774 	u16 eapol_len = skb->len - ETH_HLEN;
775 	void *eapol = skb->data + ETH_HLEN;
776 	uint i;
777 	int rc;
778 
779 	skb_set_mac_header(skb, 0);
780 	eth = eth_hdr(skb);
781 	wil_dbg_WMI(wil, "EAPOL %d bytes to %pM\n", eapol_len, eth->h_dest);
782 	for (i = 0; i < ARRAY_SIZE(wil->vring_tx); i++) {
783 		if (memcmp(wil->dst_addr[i], eth->h_dest, ETH_ALEN) == 0)
784 			goto found_dest;
785 	}
786 
787 	return -EINVAL;
788 
789  found_dest:
790 	/* find out eapol data & len */
791 	cmd = kzalloc(sizeof(*cmd) + eapol_len, GFP_KERNEL);
792 	if (!cmd)
793 		return -EINVAL;
794 
795 	memcpy(cmd->dst_mac, eth->h_dest, ETH_ALEN);
796 	cmd->eapol_len = cpu_to_le16(eapol_len);
797 	memcpy(cmd->eapol, eapol, eapol_len);
798 	rc = wmi_send(wil, WMI_EAPOL_TX_CMDID, cmd, sizeof(*cmd) + eapol_len);
799 	kfree(cmd);
800 
801 	return rc;
802 }
803 
804 int wmi_del_cipher_key(struct wil6210_priv *wil, u8 key_index,
805 		       const void *mac_addr)
806 {
807 	struct wmi_delete_cipher_key_cmd cmd = {
808 		.key_index = key_index,
809 	};
810 
811 	if (mac_addr)
812 		memcpy(cmd.mac, mac_addr, WMI_MAC_LEN);
813 
814 	return wmi_send(wil, WMI_DELETE_CIPHER_KEY_CMDID, &cmd, sizeof(cmd));
815 }
816 
817 int wmi_add_cipher_key(struct wil6210_priv *wil, u8 key_index,
818 		       const void *mac_addr, int key_len, const void *key)
819 {
820 	struct wmi_add_cipher_key_cmd cmd = {
821 		.key_index = key_index,
822 		.key_usage = WMI_KEY_USE_PAIRWISE,
823 		.key_len = key_len,
824 	};
825 
826 	if (!key || (key_len > sizeof(cmd.key)))
827 		return -EINVAL;
828 
829 	memcpy(cmd.key, key, key_len);
830 	if (mac_addr)
831 		memcpy(cmd.mac, mac_addr, WMI_MAC_LEN);
832 
833 	return wmi_send(wil, WMI_ADD_CIPHER_KEY_CMDID, &cmd, sizeof(cmd));
834 }
835 
836 int wmi_set_ie(struct wil6210_priv *wil, u8 type, u16 ie_len, const void *ie)
837 {
838 	int rc;
839 	u16 len = sizeof(struct wmi_set_appie_cmd) + ie_len;
840 	struct wmi_set_appie_cmd *cmd = kzalloc(len, GFP_KERNEL);
841 	if (!cmd) {
842 		wil_err(wil, "kmalloc(%d) failed\n", len);
843 		return -ENOMEM;
844 	}
845 
846 	cmd->mgmt_frm_type = type;
847 	/* BUG: FW API define ieLen as u8. Will fix FW */
848 	cmd->ie_len = cpu_to_le16(ie_len);
849 	memcpy(cmd->ie_info, ie, ie_len);
850 	rc = wmi_send(wil, WMI_SET_APPIE_CMDID, &cmd, len);
851 	kfree(cmd);
852 
853 	return rc;
854 }
855 
856 void wmi_event_flush(struct wil6210_priv *wil)
857 {
858 	struct pending_wmi_event *evt, *t;
859 
860 	wil_dbg_WMI(wil, "%s()\n", __func__);
861 
862 	list_for_each_entry_safe(evt, t, &wil->pending_wmi_ev, list) {
863 		list_del(&evt->list);
864 		kfree(evt);
865 	}
866 }
867 
868 static bool wmi_evt_call_handler(struct wil6210_priv *wil, int id,
869 				 void *d, int len)
870 {
871 	uint i;
872 
873 	for (i = 0; i < ARRAY_SIZE(wmi_evt_handlers); i++) {
874 		if (wmi_evt_handlers[i].eventid == id) {
875 			wmi_evt_handlers[i].handler(wil, id, d, len);
876 			return true;
877 		}
878 	}
879 
880 	return false;
881 }
882 
883 static void wmi_event_handle(struct wil6210_priv *wil,
884 			     struct wil6210_mbox_hdr *hdr)
885 {
886 	u16 len = le16_to_cpu(hdr->len);
887 
888 	if ((hdr->type == WIL_MBOX_HDR_TYPE_WMI) &&
889 	    (len >= sizeof(struct wil6210_mbox_hdr_wmi))) {
890 		struct wil6210_mbox_hdr_wmi *wmi = (void *)(&hdr[1]);
891 		void *evt_data = (void *)(&wmi[1]);
892 		u16 id = le16_to_cpu(wmi->id);
893 		/* check if someone waits for this event */
894 		if (wil->reply_id && wil->reply_id == id) {
895 			if (wil->reply_buf) {
896 				memcpy(wil->reply_buf, wmi,
897 				       min(len, wil->reply_size));
898 			} else {
899 				wmi_evt_call_handler(wil, id, evt_data,
900 						     len - sizeof(*wmi));
901 			}
902 			wil_dbg_WMI(wil, "Complete WMI 0x%04x\n", id);
903 			complete(&wil->wmi_ready);
904 			return;
905 		}
906 		/* unsolicited event */
907 		/* search for handler */
908 		if (!wmi_evt_call_handler(wil, id, evt_data,
909 					  len - sizeof(*wmi))) {
910 			wil_err(wil, "Unhandled event 0x%04x\n", id);
911 		}
912 	} else {
913 		wil_err(wil, "Unknown event type\n");
914 		print_hex_dump(KERN_ERR, "evt?? ", DUMP_PREFIX_OFFSET, 16, 1,
915 			       hdr, sizeof(*hdr) + len, true);
916 	}
917 }
918 
919 /*
920  * Retrieve next WMI event from the pending list
921  */
922 static struct list_head *next_wmi_ev(struct wil6210_priv *wil)
923 {
924 	ulong flags;
925 	struct list_head *ret = NULL;
926 
927 	spin_lock_irqsave(&wil->wmi_ev_lock, flags);
928 
929 	if (!list_empty(&wil->pending_wmi_ev)) {
930 		ret = wil->pending_wmi_ev.next;
931 		list_del(ret);
932 	}
933 
934 	spin_unlock_irqrestore(&wil->wmi_ev_lock, flags);
935 
936 	return ret;
937 }
938 
939 /*
940  * Handler for the WMI events
941  */
942 void wmi_event_worker(struct work_struct *work)
943 {
944 	struct wil6210_priv *wil = container_of(work, struct wil6210_priv,
945 						 wmi_event_worker);
946 	struct pending_wmi_event *evt;
947 	struct list_head *lh;
948 
949 	while ((lh = next_wmi_ev(wil)) != NULL) {
950 		evt = list_entry(lh, struct pending_wmi_event, list);
951 		wmi_event_handle(wil, &evt->event.hdr);
952 		kfree(evt);
953 	}
954 }
955 
956 void wmi_connect_worker(struct work_struct *work)
957 {
958 	int rc;
959 	struct wil6210_priv *wil = container_of(work, struct wil6210_priv,
960 						wmi_connect_worker);
961 
962 	if (wil->pending_connect_cid < 0) {
963 		wil_err(wil, "No connection pending\n");
964 		return;
965 	}
966 
967 	wil_dbg_WMI(wil, "Configure for connection CID %d\n",
968 		    wil->pending_connect_cid);
969 
970 	rc = wil_vring_init_tx(wil, 0, WIL6210_TX_RING_SIZE,
971 			       wil->pending_connect_cid, 0);
972 	wil->pending_connect_cid = -1;
973 	if (rc == 0)
974 		wil_link_on(wil);
975 }
976