xref: /openbmc/linux/drivers/net/wireless/ath/ath9k/wmi.c (revision 82df5b73)
1 /*
2  * Copyright (c) 2010-2011 Atheros Communications 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 "htc.h"
18 
19 static const char *wmi_cmd_to_name(enum wmi_cmd_id wmi_cmd)
20 {
21 	switch (wmi_cmd) {
22 	case WMI_ECHO_CMDID:
23 		return "WMI_ECHO_CMDID";
24 	case WMI_ACCESS_MEMORY_CMDID:
25 		return "WMI_ACCESS_MEMORY_CMDID";
26 	case WMI_GET_FW_VERSION:
27 		return "WMI_GET_FW_VERSION";
28 	case WMI_DISABLE_INTR_CMDID:
29 		return "WMI_DISABLE_INTR_CMDID";
30 	case WMI_ENABLE_INTR_CMDID:
31 		return "WMI_ENABLE_INTR_CMDID";
32 	case WMI_ATH_INIT_CMDID:
33 		return "WMI_ATH_INIT_CMDID";
34 	case WMI_ABORT_TXQ_CMDID:
35 		return "WMI_ABORT_TXQ_CMDID";
36 	case WMI_STOP_TX_DMA_CMDID:
37 		return "WMI_STOP_TX_DMA_CMDID";
38 	case WMI_ABORT_TX_DMA_CMDID:
39 		return "WMI_ABORT_TX_DMA_CMDID";
40 	case WMI_DRAIN_TXQ_CMDID:
41 		return "WMI_DRAIN_TXQ_CMDID";
42 	case WMI_DRAIN_TXQ_ALL_CMDID:
43 		return "WMI_DRAIN_TXQ_ALL_CMDID";
44 	case WMI_START_RECV_CMDID:
45 		return "WMI_START_RECV_CMDID";
46 	case WMI_STOP_RECV_CMDID:
47 		return "WMI_STOP_RECV_CMDID";
48 	case WMI_FLUSH_RECV_CMDID:
49 		return "WMI_FLUSH_RECV_CMDID";
50 	case WMI_SET_MODE_CMDID:
51 		return "WMI_SET_MODE_CMDID";
52 	case WMI_NODE_CREATE_CMDID:
53 		return "WMI_NODE_CREATE_CMDID";
54 	case WMI_NODE_REMOVE_CMDID:
55 		return "WMI_NODE_REMOVE_CMDID";
56 	case WMI_VAP_REMOVE_CMDID:
57 		return "WMI_VAP_REMOVE_CMDID";
58 	case WMI_VAP_CREATE_CMDID:
59 		return "WMI_VAP_CREATE_CMDID";
60 	case WMI_REG_READ_CMDID:
61 		return "WMI_REG_READ_CMDID";
62 	case WMI_REG_WRITE_CMDID:
63 		return "WMI_REG_WRITE_CMDID";
64 	case WMI_REG_RMW_CMDID:
65 		return "WMI_REG_RMW_CMDID";
66 	case WMI_RC_STATE_CHANGE_CMDID:
67 		return "WMI_RC_STATE_CHANGE_CMDID";
68 	case WMI_RC_RATE_UPDATE_CMDID:
69 		return "WMI_RC_RATE_UPDATE_CMDID";
70 	case WMI_TARGET_IC_UPDATE_CMDID:
71 		return "WMI_TARGET_IC_UPDATE_CMDID";
72 	case WMI_TX_AGGR_ENABLE_CMDID:
73 		return "WMI_TX_AGGR_ENABLE_CMDID";
74 	case WMI_TGT_DETACH_CMDID:
75 		return "WMI_TGT_DETACH_CMDID";
76 	case WMI_NODE_UPDATE_CMDID:
77 		return "WMI_NODE_UPDATE_CMDID";
78 	case WMI_INT_STATS_CMDID:
79 		return "WMI_INT_STATS_CMDID";
80 	case WMI_TX_STATS_CMDID:
81 		return "WMI_TX_STATS_CMDID";
82 	case WMI_RX_STATS_CMDID:
83 		return "WMI_RX_STATS_CMDID";
84 	case WMI_BITRATE_MASK_CMDID:
85 		return "WMI_BITRATE_MASK_CMDID";
86 	}
87 
88 	return "Bogus";
89 }
90 
91 struct wmi *ath9k_init_wmi(struct ath9k_htc_priv *priv)
92 {
93 	struct wmi *wmi;
94 
95 	wmi = kzalloc(sizeof(struct wmi), GFP_KERNEL);
96 	if (!wmi)
97 		return NULL;
98 
99 	wmi->drv_priv = priv;
100 	wmi->stopped = false;
101 	skb_queue_head_init(&wmi->wmi_event_queue);
102 	spin_lock_init(&wmi->wmi_lock);
103 	spin_lock_init(&wmi->event_lock);
104 	mutex_init(&wmi->op_mutex);
105 	mutex_init(&wmi->multi_write_mutex);
106 	mutex_init(&wmi->multi_rmw_mutex);
107 	init_completion(&wmi->cmd_wait);
108 	INIT_LIST_HEAD(&wmi->pending_tx_events);
109 	tasklet_init(&wmi->wmi_event_tasklet, ath9k_wmi_event_tasklet,
110 		     (unsigned long)wmi);
111 
112 	return wmi;
113 }
114 
115 void ath9k_stop_wmi(struct ath9k_htc_priv *priv)
116 {
117 	struct wmi *wmi = priv->wmi;
118 
119 	mutex_lock(&wmi->op_mutex);
120 	wmi->stopped = true;
121 	mutex_unlock(&wmi->op_mutex);
122 }
123 
124 void ath9k_destoy_wmi(struct ath9k_htc_priv *priv)
125 {
126 	kfree(priv->wmi);
127 }
128 
129 void ath9k_wmi_event_drain(struct ath9k_htc_priv *priv)
130 {
131 	unsigned long flags;
132 
133 	tasklet_kill(&priv->wmi->wmi_event_tasklet);
134 	spin_lock_irqsave(&priv->wmi->wmi_lock, flags);
135 	__skb_queue_purge(&priv->wmi->wmi_event_queue);
136 	spin_unlock_irqrestore(&priv->wmi->wmi_lock, flags);
137 }
138 
139 void ath9k_wmi_event_tasklet(unsigned long data)
140 {
141 	struct wmi *wmi = (struct wmi *)data;
142 	struct ath9k_htc_priv *priv = wmi->drv_priv;
143 	struct wmi_cmd_hdr *hdr;
144 	void *wmi_event;
145 	struct wmi_event_swba *swba;
146 	struct sk_buff *skb = NULL;
147 	unsigned long flags;
148 	u16 cmd_id;
149 
150 	do {
151 		spin_lock_irqsave(&wmi->wmi_lock, flags);
152 		skb = __skb_dequeue(&wmi->wmi_event_queue);
153 		if (!skb) {
154 			spin_unlock_irqrestore(&wmi->wmi_lock, flags);
155 			return;
156 		}
157 		spin_unlock_irqrestore(&wmi->wmi_lock, flags);
158 
159 		hdr = (struct wmi_cmd_hdr *) skb->data;
160 		cmd_id = be16_to_cpu(hdr->command_id);
161 		wmi_event = skb_pull(skb, sizeof(struct wmi_cmd_hdr));
162 
163 		switch (cmd_id) {
164 		case WMI_SWBA_EVENTID:
165 			swba = wmi_event;
166 			ath9k_htc_swba(priv, swba);
167 			break;
168 		case WMI_FATAL_EVENTID:
169 			ieee80211_queue_work(wmi->drv_priv->hw,
170 					     &wmi->drv_priv->fatal_work);
171 			break;
172 		case WMI_TXSTATUS_EVENTID:
173 			spin_lock_bh(&priv->tx.tx_lock);
174 			if (priv->tx.flags & ATH9K_HTC_OP_TX_DRAIN) {
175 				spin_unlock_bh(&priv->tx.tx_lock);
176 				break;
177 			}
178 			spin_unlock_bh(&priv->tx.tx_lock);
179 
180 			ath9k_htc_txstatus(priv, wmi_event);
181 			break;
182 		default:
183 			break;
184 		}
185 
186 		kfree_skb(skb);
187 	} while (1);
188 }
189 
190 void ath9k_fatal_work(struct work_struct *work)
191 {
192 	struct ath9k_htc_priv *priv = container_of(work, struct ath9k_htc_priv,
193 						   fatal_work);
194 	struct ath_common *common = ath9k_hw_common(priv->ah);
195 
196 	ath_dbg(common, FATAL, "FATAL Event received, resetting device\n");
197 	ath9k_htc_reset(priv);
198 }
199 
200 static void ath9k_wmi_rsp_callback(struct wmi *wmi, struct sk_buff *skb)
201 {
202 	skb_pull(skb, sizeof(struct wmi_cmd_hdr));
203 
204 	if (wmi->cmd_rsp_buf != NULL && wmi->cmd_rsp_len != 0)
205 		memcpy(wmi->cmd_rsp_buf, skb->data, wmi->cmd_rsp_len);
206 
207 	complete(&wmi->cmd_wait);
208 }
209 
210 static void ath9k_wmi_ctrl_rx(void *priv, struct sk_buff *skb,
211 			      enum htc_endpoint_id epid)
212 {
213 	struct wmi *wmi = priv;
214 	struct wmi_cmd_hdr *hdr;
215 	unsigned long flags;
216 	u16 cmd_id;
217 
218 	if (unlikely(wmi->stopped))
219 		goto free_skb;
220 
221 	hdr = (struct wmi_cmd_hdr *) skb->data;
222 	cmd_id = be16_to_cpu(hdr->command_id);
223 
224 	if (cmd_id & 0x1000) {
225 		spin_lock_irqsave(&wmi->wmi_lock, flags);
226 		__skb_queue_tail(&wmi->wmi_event_queue, skb);
227 		spin_unlock_irqrestore(&wmi->wmi_lock, flags);
228 		tasklet_schedule(&wmi->wmi_event_tasklet);
229 		return;
230 	}
231 
232 	/* Check if there has been a timeout. */
233 	spin_lock_irqsave(&wmi->wmi_lock, flags);
234 	if (be16_to_cpu(hdr->seq_no) != wmi->last_seq_id) {
235 		spin_unlock_irqrestore(&wmi->wmi_lock, flags);
236 		goto free_skb;
237 	}
238 	spin_unlock_irqrestore(&wmi->wmi_lock, flags);
239 
240 	/* WMI command response */
241 	ath9k_wmi_rsp_callback(wmi, skb);
242 
243 free_skb:
244 	kfree_skb(skb);
245 }
246 
247 static void ath9k_wmi_ctrl_tx(void *priv, struct sk_buff *skb,
248 			      enum htc_endpoint_id epid, bool txok)
249 {
250 	kfree_skb(skb);
251 }
252 
253 int ath9k_wmi_connect(struct htc_target *htc, struct wmi *wmi,
254 		      enum htc_endpoint_id *wmi_ctrl_epid)
255 {
256 	struct htc_service_connreq connect;
257 	int ret;
258 
259 	wmi->htc = htc;
260 
261 	memset(&connect, 0, sizeof(connect));
262 
263 	connect.ep_callbacks.priv = wmi;
264 	connect.ep_callbacks.tx = ath9k_wmi_ctrl_tx;
265 	connect.ep_callbacks.rx = ath9k_wmi_ctrl_rx;
266 	connect.service_id = WMI_CONTROL_SVC;
267 
268 	ret = htc_connect_service(htc, &connect, &wmi->ctrl_epid);
269 	if (ret)
270 		return ret;
271 
272 	*wmi_ctrl_epid = wmi->ctrl_epid;
273 
274 	return 0;
275 }
276 
277 static int ath9k_wmi_cmd_issue(struct wmi *wmi,
278 			       struct sk_buff *skb,
279 			       enum wmi_cmd_id cmd, u16 len)
280 {
281 	struct wmi_cmd_hdr *hdr;
282 	unsigned long flags;
283 
284 	hdr = skb_push(skb, sizeof(struct wmi_cmd_hdr));
285 	hdr->command_id = cpu_to_be16(cmd);
286 	hdr->seq_no = cpu_to_be16(++wmi->tx_seq_id);
287 
288 	spin_lock_irqsave(&wmi->wmi_lock, flags);
289 	wmi->last_seq_id = wmi->tx_seq_id;
290 	spin_unlock_irqrestore(&wmi->wmi_lock, flags);
291 
292 	return htc_send_epid(wmi->htc, skb, wmi->ctrl_epid);
293 }
294 
295 int ath9k_wmi_cmd(struct wmi *wmi, enum wmi_cmd_id cmd_id,
296 		  u8 *cmd_buf, u32 cmd_len,
297 		  u8 *rsp_buf, u32 rsp_len,
298 		  u32 timeout)
299 {
300 	struct ath_hw *ah = wmi->drv_priv->ah;
301 	struct ath_common *common = ath9k_hw_common(ah);
302 	u16 headroom = sizeof(struct htc_frame_hdr) +
303 		       sizeof(struct wmi_cmd_hdr);
304 	struct sk_buff *skb;
305 	unsigned long time_left;
306 	int ret = 0;
307 
308 	if (ah->ah_flags & AH_UNPLUGGED)
309 		return 0;
310 
311 	skb = alloc_skb(headroom + cmd_len, GFP_ATOMIC);
312 	if (!skb)
313 		return -ENOMEM;
314 
315 	skb_reserve(skb, headroom);
316 
317 	if (cmd_len != 0 && cmd_buf != NULL) {
318 		skb_put_data(skb, cmd_buf, cmd_len);
319 	}
320 
321 	mutex_lock(&wmi->op_mutex);
322 
323 	/* check if wmi stopped flag is set */
324 	if (unlikely(wmi->stopped)) {
325 		ret = -EPROTO;
326 		goto out;
327 	}
328 
329 	/* record the rsp buffer and length */
330 	wmi->cmd_rsp_buf = rsp_buf;
331 	wmi->cmd_rsp_len = rsp_len;
332 
333 	ret = ath9k_wmi_cmd_issue(wmi, skb, cmd_id, cmd_len);
334 	if (ret)
335 		goto out;
336 
337 	time_left = wait_for_completion_timeout(&wmi->cmd_wait, timeout);
338 	if (!time_left) {
339 		ath_dbg(common, WMI, "Timeout waiting for WMI command: %s\n",
340 			wmi_cmd_to_name(cmd_id));
341 		mutex_unlock(&wmi->op_mutex);
342 		return -ETIMEDOUT;
343 	}
344 
345 	mutex_unlock(&wmi->op_mutex);
346 
347 	return 0;
348 
349 out:
350 	ath_dbg(common, WMI, "WMI failure for: %s\n", wmi_cmd_to_name(cmd_id));
351 	mutex_unlock(&wmi->op_mutex);
352 	kfree_skb(skb);
353 
354 	return ret;
355 }
356