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
htc_issue_send(struct htc_target * target,struct sk_buff * skb,u16 len,u8 flags,u8 epid)19 static int htc_issue_send(struct htc_target *target, struct sk_buff* skb,
20 u16 len, u8 flags, u8 epid)
21
22 {
23 struct htc_frame_hdr *hdr;
24 struct htc_endpoint *endpoint = &target->endpoint[epid];
25 int status;
26
27 hdr = (struct htc_frame_hdr *)
28 skb_push(skb, sizeof(struct htc_frame_hdr));
29 hdr->endpoint_id = epid;
30 hdr->flags = flags;
31 hdr->payload_len = cpu_to_be16(len);
32
33 status = target->hif->send(target->hif_dev, endpoint->ul_pipeid, skb);
34
35 return status;
36 }
37
get_next_avail_ep(struct htc_endpoint * endpoint)38 static struct htc_endpoint *get_next_avail_ep(struct htc_endpoint *endpoint)
39 {
40 enum htc_endpoint_id avail_epid;
41
42 for (avail_epid = (ENDPOINT_MAX - 1); avail_epid > ENDPOINT0; avail_epid--)
43 if (endpoint[avail_epid].service_id == 0)
44 return &endpoint[avail_epid];
45 return NULL;
46 }
47
service_to_ulpipe(u16 service_id)48 static u8 service_to_ulpipe(u16 service_id)
49 {
50 switch (service_id) {
51 case WMI_CONTROL_SVC:
52 return 4;
53 case WMI_BEACON_SVC:
54 case WMI_CAB_SVC:
55 case WMI_UAPSD_SVC:
56 case WMI_MGMT_SVC:
57 case WMI_DATA_VO_SVC:
58 case WMI_DATA_VI_SVC:
59 case WMI_DATA_BE_SVC:
60 case WMI_DATA_BK_SVC:
61 return 1;
62 default:
63 return 0;
64 }
65 }
66
service_to_dlpipe(u16 service_id)67 static u8 service_to_dlpipe(u16 service_id)
68 {
69 switch (service_id) {
70 case WMI_CONTROL_SVC:
71 return 3;
72 case WMI_BEACON_SVC:
73 case WMI_CAB_SVC:
74 case WMI_UAPSD_SVC:
75 case WMI_MGMT_SVC:
76 case WMI_DATA_VO_SVC:
77 case WMI_DATA_VI_SVC:
78 case WMI_DATA_BE_SVC:
79 case WMI_DATA_BK_SVC:
80 return 2;
81 default:
82 return 0;
83 }
84 }
85
htc_process_target_rdy(struct htc_target * target,void * buf)86 static void htc_process_target_rdy(struct htc_target *target,
87 void *buf)
88 {
89 struct htc_endpoint *endpoint;
90 struct htc_ready_msg *htc_ready_msg = (struct htc_ready_msg *) buf;
91
92 target->credit_size = be16_to_cpu(htc_ready_msg->credit_size);
93
94 endpoint = &target->endpoint[ENDPOINT0];
95 endpoint->service_id = HTC_CTRL_RSVD_SVC;
96 endpoint->max_msglen = HTC_MAX_CONTROL_MESSAGE_LENGTH;
97 atomic_inc(&target->tgt_ready);
98 complete(&target->target_wait);
99 }
100
htc_process_conn_rsp(struct htc_target * target,struct htc_frame_hdr * htc_hdr)101 static void htc_process_conn_rsp(struct htc_target *target,
102 struct htc_frame_hdr *htc_hdr)
103 {
104 struct htc_conn_svc_rspmsg *svc_rspmsg;
105 struct htc_endpoint *endpoint, *tmp_endpoint = NULL;
106 u16 service_id;
107 u16 max_msglen;
108 enum htc_endpoint_id epid, tepid;
109
110 svc_rspmsg = (struct htc_conn_svc_rspmsg *)
111 ((void *) htc_hdr + sizeof(struct htc_frame_hdr));
112
113 if (svc_rspmsg->status == HTC_SERVICE_SUCCESS) {
114 epid = svc_rspmsg->endpoint_id;
115 service_id = be16_to_cpu(svc_rspmsg->service_id);
116 max_msglen = be16_to_cpu(svc_rspmsg->max_msg_len);
117 endpoint = &target->endpoint[epid];
118
119 for (tepid = (ENDPOINT_MAX - 1); tepid > ENDPOINT0; tepid--) {
120 tmp_endpoint = &target->endpoint[tepid];
121 if (tmp_endpoint->service_id == service_id) {
122 tmp_endpoint->service_id = 0;
123 break;
124 }
125 }
126
127 if (tepid == ENDPOINT0)
128 return;
129
130 endpoint->service_id = service_id;
131 endpoint->max_txqdepth = tmp_endpoint->max_txqdepth;
132 endpoint->ep_callbacks = tmp_endpoint->ep_callbacks;
133 endpoint->ul_pipeid = tmp_endpoint->ul_pipeid;
134 endpoint->dl_pipeid = tmp_endpoint->dl_pipeid;
135 endpoint->max_msglen = max_msglen;
136 target->conn_rsp_epid = epid;
137 complete(&target->cmd_wait);
138 } else {
139 target->conn_rsp_epid = ENDPOINT_UNUSED;
140 }
141 }
142
htc_config_pipe_credits(struct htc_target * target)143 static int htc_config_pipe_credits(struct htc_target *target)
144 {
145 struct sk_buff *skb;
146 struct htc_config_pipe_msg *cp_msg;
147 int ret, time_left;
148
149 skb = alloc_skb(50 + sizeof(struct htc_frame_hdr), GFP_ATOMIC);
150 if (!skb) {
151 dev_err(target->dev, "failed to allocate send buffer\n");
152 return -ENOMEM;
153 }
154 skb_reserve(skb, sizeof(struct htc_frame_hdr));
155
156 cp_msg = (struct htc_config_pipe_msg *)
157 skb_put(skb, sizeof(struct htc_config_pipe_msg));
158
159 cp_msg->message_id = cpu_to_be16(HTC_MSG_CONFIG_PIPE_ID);
160 cp_msg->pipe_id = USB_WLAN_TX_PIPE;
161 cp_msg->credits = target->credits;
162
163 target->htc_flags |= HTC_OP_CONFIG_PIPE_CREDITS;
164
165 ret = htc_issue_send(target, skb, skb->len, 0, ENDPOINT0);
166 if (ret)
167 goto err;
168
169 time_left = wait_for_completion_timeout(&target->cmd_wait, HZ);
170 if (!time_left) {
171 dev_err(target->dev, "HTC credit config timeout\n");
172 return -ETIMEDOUT;
173 }
174
175 return 0;
176 err:
177 kfree_skb(skb);
178 return -EINVAL;
179 }
180
htc_setup_complete(struct htc_target * target)181 static int htc_setup_complete(struct htc_target *target)
182 {
183 struct sk_buff *skb;
184 struct htc_comp_msg *comp_msg;
185 int ret = 0, time_left;
186
187 skb = alloc_skb(50 + sizeof(struct htc_frame_hdr), GFP_ATOMIC);
188 if (!skb) {
189 dev_err(target->dev, "failed to allocate send buffer\n");
190 return -ENOMEM;
191 }
192 skb_reserve(skb, sizeof(struct htc_frame_hdr));
193
194 comp_msg = (struct htc_comp_msg *)
195 skb_put(skb, sizeof(struct htc_comp_msg));
196 comp_msg->msg_id = cpu_to_be16(HTC_MSG_SETUP_COMPLETE_ID);
197
198 target->htc_flags |= HTC_OP_START_WAIT;
199
200 ret = htc_issue_send(target, skb, skb->len, 0, ENDPOINT0);
201 if (ret)
202 goto err;
203
204 time_left = wait_for_completion_timeout(&target->cmd_wait, HZ);
205 if (!time_left) {
206 dev_err(target->dev, "HTC start timeout\n");
207 return -ETIMEDOUT;
208 }
209
210 return 0;
211
212 err:
213 kfree_skb(skb);
214 return -EINVAL;
215 }
216
217 /* HTC APIs */
218
htc_init(struct htc_target * target)219 int htc_init(struct htc_target *target)
220 {
221 int ret;
222
223 ret = htc_config_pipe_credits(target);
224 if (ret)
225 return ret;
226
227 return htc_setup_complete(target);
228 }
229
htc_connect_service(struct htc_target * target,struct htc_service_connreq * service_connreq,enum htc_endpoint_id * conn_rsp_epid)230 int htc_connect_service(struct htc_target *target,
231 struct htc_service_connreq *service_connreq,
232 enum htc_endpoint_id *conn_rsp_epid)
233 {
234 struct sk_buff *skb;
235 struct htc_endpoint *endpoint;
236 struct htc_conn_svc_msg *conn_msg;
237 int ret, time_left;
238
239 /* Find an available endpoint */
240 endpoint = get_next_avail_ep(target->endpoint);
241 if (!endpoint) {
242 dev_err(target->dev, "Endpoint is not available for"
243 "service %d\n", service_connreq->service_id);
244 return -EINVAL;
245 }
246
247 endpoint->service_id = service_connreq->service_id;
248 endpoint->max_txqdepth = service_connreq->max_send_qdepth;
249 endpoint->ul_pipeid = service_to_ulpipe(service_connreq->service_id);
250 endpoint->dl_pipeid = service_to_dlpipe(service_connreq->service_id);
251 endpoint->ep_callbacks = service_connreq->ep_callbacks;
252
253 skb = alloc_skb(sizeof(struct htc_conn_svc_msg) +
254 sizeof(struct htc_frame_hdr), GFP_ATOMIC);
255 if (!skb) {
256 dev_err(target->dev, "Failed to allocate buf to send"
257 "service connect req\n");
258 return -ENOMEM;
259 }
260
261 skb_reserve(skb, sizeof(struct htc_frame_hdr));
262
263 conn_msg = (struct htc_conn_svc_msg *)
264 skb_put(skb, sizeof(struct htc_conn_svc_msg));
265 conn_msg->service_id = cpu_to_be16(service_connreq->service_id);
266 conn_msg->msg_id = cpu_to_be16(HTC_MSG_CONNECT_SERVICE_ID);
267 conn_msg->con_flags = cpu_to_be16(service_connreq->con_flags);
268 conn_msg->dl_pipeid = endpoint->dl_pipeid;
269 conn_msg->ul_pipeid = endpoint->ul_pipeid;
270
271 ret = htc_issue_send(target, skb, skb->len, 0, ENDPOINT0);
272 if (ret)
273 goto err;
274
275 time_left = wait_for_completion_timeout(&target->cmd_wait, HZ);
276 if (!time_left) {
277 dev_err(target->dev, "Service connection timeout for: %d\n",
278 service_connreq->service_id);
279 return -ETIMEDOUT;
280 }
281
282 *conn_rsp_epid = target->conn_rsp_epid;
283 return 0;
284 err:
285 kfree_skb(skb);
286 return ret;
287 }
288
htc_send(struct htc_target * target,struct sk_buff * skb)289 int htc_send(struct htc_target *target, struct sk_buff *skb)
290 {
291 struct ath9k_htc_tx_ctl *tx_ctl;
292
293 tx_ctl = HTC_SKB_CB(skb);
294 return htc_issue_send(target, skb, skb->len, 0, tx_ctl->epid);
295 }
296
htc_send_epid(struct htc_target * target,struct sk_buff * skb,enum htc_endpoint_id epid)297 int htc_send_epid(struct htc_target *target, struct sk_buff *skb,
298 enum htc_endpoint_id epid)
299 {
300 return htc_issue_send(target, skb, skb->len, 0, epid);
301 }
302
htc_stop(struct htc_target * target)303 void htc_stop(struct htc_target *target)
304 {
305 target->hif->stop(target->hif_dev);
306 }
307
htc_start(struct htc_target * target)308 void htc_start(struct htc_target *target)
309 {
310 target->hif->start(target->hif_dev);
311 }
312
htc_sta_drain(struct htc_target * target,u8 idx)313 void htc_sta_drain(struct htc_target *target, u8 idx)
314 {
315 target->hif->sta_drain(target->hif_dev, idx);
316 }
317
ath9k_htc_txcompletion_cb(struct htc_target * htc_handle,struct sk_buff * skb,bool txok)318 void ath9k_htc_txcompletion_cb(struct htc_target *htc_handle,
319 struct sk_buff *skb, bool txok)
320 {
321 struct htc_endpoint *endpoint;
322 struct htc_frame_hdr *htc_hdr = NULL;
323
324 if (htc_handle->htc_flags & HTC_OP_CONFIG_PIPE_CREDITS) {
325 complete(&htc_handle->cmd_wait);
326 htc_handle->htc_flags &= ~HTC_OP_CONFIG_PIPE_CREDITS;
327 goto ret;
328 }
329
330 if (htc_handle->htc_flags & HTC_OP_START_WAIT) {
331 complete(&htc_handle->cmd_wait);
332 htc_handle->htc_flags &= ~HTC_OP_START_WAIT;
333 goto ret;
334 }
335
336 if (skb) {
337 htc_hdr = (struct htc_frame_hdr *) skb->data;
338 endpoint = &htc_handle->endpoint[htc_hdr->endpoint_id];
339 skb_pull(skb, sizeof(struct htc_frame_hdr));
340
341 if (endpoint->ep_callbacks.tx) {
342 endpoint->ep_callbacks.tx(endpoint->ep_callbacks.priv,
343 skb, htc_hdr->endpoint_id,
344 txok);
345 } else {
346 kfree_skb(skb);
347 }
348 }
349
350 return;
351 ret:
352 /* HTC-generated packets are freed here. */
353 if (htc_hdr && htc_hdr->endpoint_id != ENDPOINT0)
354 dev_kfree_skb_any(skb);
355 else
356 kfree_skb(skb);
357 }
358
359 /*
360 * HTC Messages are handled directly here and the obtained SKB
361 * is freed.
362 *
363 * Service messages (Data, WMI) passed to the corresponding
364 * endpoint RX handlers, which have to free the SKB.
365 */
ath9k_htc_rx_msg(struct htc_target * htc_handle,struct sk_buff * skb,u32 len,u8 pipe_id)366 void ath9k_htc_rx_msg(struct htc_target *htc_handle,
367 struct sk_buff *skb, u32 len, u8 pipe_id)
368 {
369 struct htc_frame_hdr *htc_hdr;
370 enum htc_endpoint_id epid;
371 struct htc_endpoint *endpoint;
372 __be16 *msg_id;
373
374 if (!htc_handle || !skb)
375 return;
376
377 htc_hdr = (struct htc_frame_hdr *) skb->data;
378 epid = htc_hdr->endpoint_id;
379
380 if (epid >= ENDPOINT_MAX) {
381 if (pipe_id != USB_REG_IN_PIPE)
382 dev_kfree_skb_any(skb);
383 else
384 kfree_skb(skb);
385 return;
386 }
387
388 if (epid == ENDPOINT0) {
389
390 /* Handle trailer */
391 if (htc_hdr->flags & HTC_FLAGS_RECV_TRAILER) {
392 if (be32_to_cpu(*(__be32 *) skb->data) == 0x00C60000)
393 /* Move past the Watchdog pattern */
394 htc_hdr = (struct htc_frame_hdr *)(skb->data + 4);
395 }
396
397 /* Get the message ID */
398 msg_id = (__be16 *) ((void *) htc_hdr +
399 sizeof(struct htc_frame_hdr));
400
401 /* Now process HTC messages */
402 switch (be16_to_cpu(*msg_id)) {
403 case HTC_MSG_READY_ID:
404 htc_process_target_rdy(htc_handle, htc_hdr);
405 break;
406 case HTC_MSG_CONNECT_SERVICE_RESPONSE_ID:
407 htc_process_conn_rsp(htc_handle, htc_hdr);
408 break;
409 default:
410 break;
411 }
412
413 kfree_skb(skb);
414
415 } else {
416 if (htc_hdr->flags & HTC_FLAGS_RECV_TRAILER)
417 skb_trim(skb, len - htc_hdr->control[0]);
418
419 skb_pull(skb, sizeof(struct htc_frame_hdr));
420
421 endpoint = &htc_handle->endpoint[epid];
422 if (endpoint->ep_callbacks.rx)
423 endpoint->ep_callbacks.rx(endpoint->ep_callbacks.priv,
424 skb, epid);
425 }
426 }
427
ath9k_htc_hw_alloc(void * hif_handle,struct ath9k_htc_hif * hif,struct device * dev)428 struct htc_target *ath9k_htc_hw_alloc(void *hif_handle,
429 struct ath9k_htc_hif *hif,
430 struct device *dev)
431 {
432 struct htc_endpoint *endpoint;
433 struct htc_target *target;
434
435 target = kzalloc(sizeof(struct htc_target), GFP_KERNEL);
436 if (!target)
437 return NULL;
438
439 init_completion(&target->target_wait);
440 init_completion(&target->cmd_wait);
441
442 target->hif = hif;
443 target->hif_dev = hif_handle;
444 target->dev = dev;
445
446 /* Assign control endpoint pipe IDs */
447 endpoint = &target->endpoint[ENDPOINT0];
448 endpoint->ul_pipeid = hif->control_ul_pipe;
449 endpoint->dl_pipeid = hif->control_dl_pipe;
450
451 atomic_set(&target->tgt_ready, 0);
452
453 return target;
454 }
455
ath9k_htc_hw_free(struct htc_target * htc)456 void ath9k_htc_hw_free(struct htc_target *htc)
457 {
458 kfree(htc);
459 }
460
ath9k_htc_hw_init(struct htc_target * target,struct device * dev,u16 devid,char * product,u32 drv_info)461 int ath9k_htc_hw_init(struct htc_target *target,
462 struct device *dev, u16 devid,
463 char *product, u32 drv_info)
464 {
465 if (ath9k_htc_probe_device(target, dev, devid, product, drv_info)) {
466 printk(KERN_ERR "Failed to initialize the device\n");
467 return -ENODEV;
468 }
469
470 return 0;
471 }
472
ath9k_htc_hw_deinit(struct htc_target * target,bool hot_unplug)473 void ath9k_htc_hw_deinit(struct htc_target *target, bool hot_unplug)
474 {
475 if (target)
476 ath9k_htc_disconnect_device(target, hot_unplug);
477 }
478