2 * Copyright (c) 2010-2011 Atheros Communications Inc.
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.
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.
17 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
21 static int htc_issue_send(struct htc_target *target, struct sk_buff* skb,
22 u16 len, u8 flags, u8 epid)
25 struct htc_frame_hdr *hdr;
26 struct htc_endpoint *endpoint = &target->endpoint[epid];
29 hdr = skb_push(skb, sizeof(struct htc_frame_hdr));
30 hdr->endpoint_id = epid;
32 hdr->payload_len = cpu_to_be16(len);
34 status = target->hif->send(target->hif_dev, endpoint->ul_pipeid, skb);
39 static struct htc_endpoint *get_next_avail_ep(struct htc_endpoint *endpoint)
41 enum htc_endpoint_id avail_epid;
43 for (avail_epid = (ENDPOINT_MAX - 1); avail_epid > ENDPOINT0; avail_epid--)
44 if (endpoint[avail_epid].service_id == 0)
45 return &endpoint[avail_epid];
49 static u8 service_to_ulpipe(u16 service_id)
68 static u8 service_to_dlpipe(u16 service_id)
87 static void htc_process_target_rdy(struct htc_target *target,
90 struct htc_endpoint *endpoint;
91 struct htc_ready_msg *htc_ready_msg = (struct htc_ready_msg *) buf;
93 target->credit_size = be16_to_cpu(htc_ready_msg->credit_size);
95 endpoint = &target->endpoint[ENDPOINT0];
96 endpoint->service_id = HTC_CTRL_RSVD_SVC;
97 endpoint->max_msglen = HTC_MAX_CONTROL_MESSAGE_LENGTH;
98 atomic_inc(&target->tgt_ready);
99 complete(&target->target_wait);
102 static void htc_process_conn_rsp(struct htc_target *target,
103 struct htc_frame_hdr *htc_hdr)
105 struct htc_conn_svc_rspmsg *svc_rspmsg;
106 struct htc_endpoint *endpoint, *tmp_endpoint = NULL;
109 enum htc_endpoint_id epid, tepid;
111 svc_rspmsg = (struct htc_conn_svc_rspmsg *)
112 ((void *) htc_hdr + sizeof(struct htc_frame_hdr));
114 if (svc_rspmsg->status == HTC_SERVICE_SUCCESS) {
115 epid = svc_rspmsg->endpoint_id;
116 if (epid < 0 || epid >= ENDPOINT_MAX)
119 service_id = be16_to_cpu(svc_rspmsg->service_id);
120 max_msglen = be16_to_cpu(svc_rspmsg->max_msg_len);
121 endpoint = &target->endpoint[epid];
123 for (tepid = (ENDPOINT_MAX - 1); tepid > ENDPOINT0; tepid--) {
124 tmp_endpoint = &target->endpoint[tepid];
125 if (tmp_endpoint->service_id == service_id) {
126 tmp_endpoint->service_id = 0;
131 if (tepid == ENDPOINT0)
134 endpoint->service_id = service_id;
135 endpoint->max_txqdepth = tmp_endpoint->max_txqdepth;
136 endpoint->ep_callbacks = tmp_endpoint->ep_callbacks;
137 endpoint->ul_pipeid = tmp_endpoint->ul_pipeid;
138 endpoint->dl_pipeid = tmp_endpoint->dl_pipeid;
139 endpoint->max_msglen = max_msglen;
140 target->conn_rsp_epid = epid;
141 complete(&target->cmd_wait);
143 target->conn_rsp_epid = ENDPOINT_UNUSED;
147 static int htc_config_pipe_credits(struct htc_target *target)
150 struct htc_config_pipe_msg *cp_msg;
152 unsigned long time_left;
154 skb = alloc_skb(50 + sizeof(struct htc_frame_hdr), GFP_ATOMIC);
156 dev_err(target->dev, "failed to allocate send buffer\n");
159 skb_reserve(skb, sizeof(struct htc_frame_hdr));
161 cp_msg = skb_put(skb, sizeof(struct htc_config_pipe_msg));
163 cp_msg->message_id = cpu_to_be16(HTC_MSG_CONFIG_PIPE_ID);
164 cp_msg->pipe_id = USB_WLAN_TX_PIPE;
165 cp_msg->credits = target->credits;
167 target->htc_flags |= HTC_OP_CONFIG_PIPE_CREDITS;
169 ret = htc_issue_send(target, skb, skb->len, 0, ENDPOINT0);
173 time_left = wait_for_completion_timeout(&target->cmd_wait, HZ);
175 dev_err(target->dev, "HTC credit config timeout\n");
185 static int htc_setup_complete(struct htc_target *target)
188 struct htc_comp_msg *comp_msg;
190 unsigned long time_left;
192 skb = alloc_skb(50 + sizeof(struct htc_frame_hdr), GFP_ATOMIC);
194 dev_err(target->dev, "failed to allocate send buffer\n");
197 skb_reserve(skb, sizeof(struct htc_frame_hdr));
199 comp_msg = skb_put(skb, sizeof(struct htc_comp_msg));
200 comp_msg->msg_id = cpu_to_be16(HTC_MSG_SETUP_COMPLETE_ID);
202 target->htc_flags |= HTC_OP_START_WAIT;
204 ret = htc_issue_send(target, skb, skb->len, 0, ENDPOINT0);
208 time_left = wait_for_completion_timeout(&target->cmd_wait, HZ);
210 dev_err(target->dev, "HTC start timeout\n");
223 int htc_init(struct htc_target *target)
227 ret = htc_config_pipe_credits(target);
231 return htc_setup_complete(target);
234 int htc_connect_service(struct htc_target *target,
235 struct htc_service_connreq *service_connreq,
236 enum htc_endpoint_id *conn_rsp_epid)
239 struct htc_endpoint *endpoint;
240 struct htc_conn_svc_msg *conn_msg;
242 unsigned long time_left;
244 /* Find an available endpoint */
245 endpoint = get_next_avail_ep(target->endpoint);
247 dev_err(target->dev, "Endpoint is not available for service %d\n",
248 service_connreq->service_id);
252 endpoint->service_id = service_connreq->service_id;
253 endpoint->max_txqdepth = service_connreq->max_send_qdepth;
254 endpoint->ul_pipeid = service_to_ulpipe(service_connreq->service_id);
255 endpoint->dl_pipeid = service_to_dlpipe(service_connreq->service_id);
256 endpoint->ep_callbacks = service_connreq->ep_callbacks;
258 skb = alloc_skb(sizeof(struct htc_conn_svc_msg) +
259 sizeof(struct htc_frame_hdr), GFP_ATOMIC);
261 dev_err(target->dev, "Failed to allocate buf to send"
262 "service connect req\n");
266 skb_reserve(skb, sizeof(struct htc_frame_hdr));
268 conn_msg = skb_put(skb, sizeof(struct htc_conn_svc_msg));
269 conn_msg->service_id = cpu_to_be16(service_connreq->service_id);
270 conn_msg->msg_id = cpu_to_be16(HTC_MSG_CONNECT_SERVICE_ID);
271 conn_msg->con_flags = cpu_to_be16(service_connreq->con_flags);
272 conn_msg->dl_pipeid = endpoint->dl_pipeid;
273 conn_msg->ul_pipeid = endpoint->ul_pipeid;
275 ret = htc_issue_send(target, skb, skb->len, 0, ENDPOINT0);
279 time_left = wait_for_completion_timeout(&target->cmd_wait, HZ);
281 dev_err(target->dev, "Service connection timeout for: %d\n",
282 service_connreq->service_id);
286 *conn_rsp_epid = target->conn_rsp_epid;
293 int htc_send(struct htc_target *target, struct sk_buff *skb)
295 struct ath9k_htc_tx_ctl *tx_ctl;
297 tx_ctl = HTC_SKB_CB(skb);
298 return htc_issue_send(target, skb, skb->len, 0, tx_ctl->epid);
301 int htc_send_epid(struct htc_target *target, struct sk_buff *skb,
302 enum htc_endpoint_id epid)
304 return htc_issue_send(target, skb, skb->len, 0, epid);
307 void htc_stop(struct htc_target *target)
309 target->hif->stop(target->hif_dev);
312 void htc_start(struct htc_target *target)
314 target->hif->start(target->hif_dev);
317 void htc_sta_drain(struct htc_target *target, u8 idx)
319 target->hif->sta_drain(target->hif_dev, idx);
322 void ath9k_htc_txcompletion_cb(struct htc_target *htc_handle,
323 struct sk_buff *skb, bool txok)
325 struct htc_endpoint *endpoint;
326 struct htc_frame_hdr *htc_hdr = NULL;
328 if (htc_handle->htc_flags & HTC_OP_CONFIG_PIPE_CREDITS) {
329 complete(&htc_handle->cmd_wait);
330 htc_handle->htc_flags &= ~HTC_OP_CONFIG_PIPE_CREDITS;
334 if (htc_handle->htc_flags & HTC_OP_START_WAIT) {
335 complete(&htc_handle->cmd_wait);
336 htc_handle->htc_flags &= ~HTC_OP_START_WAIT;
341 htc_hdr = (struct htc_frame_hdr *) skb->data;
342 if (htc_hdr->endpoint_id >= ARRAY_SIZE(htc_handle->endpoint))
344 endpoint = &htc_handle->endpoint[htc_hdr->endpoint_id];
345 skb_pull(skb, sizeof(struct htc_frame_hdr));
347 if (endpoint->ep_callbacks.tx) {
348 endpoint->ep_callbacks.tx(endpoint->ep_callbacks.priv,
349 skb, htc_hdr->endpoint_id,
361 static void ath9k_htc_fw_panic_report(struct htc_target *htc_handle,
364 uint32_t *pattern = (uint32_t *)skb->data;
369 struct htc_panic_bad_vaddr *htc_panic;
370 htc_panic = (struct htc_panic_bad_vaddr *) skb->data;
371 dev_err(htc_handle->dev, "ath: firmware panic! "
372 "exccause: 0x%08x; pc: 0x%08x; badvaddr: 0x%08x.\n",
373 htc_panic->exccause, htc_panic->pc,
374 htc_panic->badvaddr);
379 struct htc_panic_bad_epid *htc_panic;
380 htc_panic = (struct htc_panic_bad_epid *) skb->data;
381 dev_err(htc_handle->dev, "ath: firmware panic! "
382 "bad epid: 0x%08x\n", htc_panic->epid);
386 dev_err(htc_handle->dev, "ath: unknown panic pattern!\n");
392 * HTC Messages are handled directly here and the obtained SKB
395 * Service messages (Data, WMI) passed to the corresponding
396 * endpoint RX handlers, which have to free the SKB.
398 void ath9k_htc_rx_msg(struct htc_target *htc_handle,
399 struct sk_buff *skb, u32 len, u8 pipe_id)
401 struct htc_frame_hdr *htc_hdr;
402 enum htc_endpoint_id epid;
403 struct htc_endpoint *endpoint;
406 if (!htc_handle || !skb)
409 htc_hdr = (struct htc_frame_hdr *) skb->data;
410 epid = htc_hdr->endpoint_id;
413 ath9k_htc_fw_panic_report(htc_handle, skb);
418 if (epid < 0 || epid >= ENDPOINT_MAX) {
419 if (pipe_id != USB_REG_IN_PIPE)
420 dev_kfree_skb_any(skb);
426 if (epid == ENDPOINT0) {
429 if (htc_hdr->flags & HTC_FLAGS_RECV_TRAILER) {
430 if (be32_to_cpu(*(__be32 *) skb->data) == 0x00C60000)
431 /* Move past the Watchdog pattern */
432 htc_hdr = (struct htc_frame_hdr *)(skb->data + 4);
435 /* Get the message ID */
436 msg_id = (__be16 *) ((void *) htc_hdr +
437 sizeof(struct htc_frame_hdr));
439 /* Now process HTC messages */
440 switch (be16_to_cpu(*msg_id)) {
441 case HTC_MSG_READY_ID:
442 htc_process_target_rdy(htc_handle, htc_hdr);
444 case HTC_MSG_CONNECT_SERVICE_RESPONSE_ID:
445 htc_process_conn_rsp(htc_handle, htc_hdr);
454 if (htc_hdr->flags & HTC_FLAGS_RECV_TRAILER)
455 skb_trim(skb, len - htc_hdr->control[0]);
457 skb_pull(skb, sizeof(struct htc_frame_hdr));
459 endpoint = &htc_handle->endpoint[epid];
460 if (endpoint->ep_callbacks.rx)
461 endpoint->ep_callbacks.rx(endpoint->ep_callbacks.priv,
466 struct htc_target *ath9k_htc_hw_alloc(void *hif_handle,
467 struct ath9k_htc_hif *hif,
470 struct htc_endpoint *endpoint;
471 struct htc_target *target;
473 target = kzalloc(sizeof(struct htc_target), GFP_KERNEL);
477 init_completion(&target->target_wait);
478 init_completion(&target->cmd_wait);
481 target->hif_dev = hif_handle;
484 /* Assign control endpoint pipe IDs */
485 endpoint = &target->endpoint[ENDPOINT0];
486 endpoint->ul_pipeid = hif->control_ul_pipe;
487 endpoint->dl_pipeid = hif->control_dl_pipe;
489 atomic_set(&target->tgt_ready, 0);
494 void ath9k_htc_hw_free(struct htc_target *htc)
499 int ath9k_htc_hw_init(struct htc_target *target,
500 struct device *dev, u16 devid,
501 char *product, u32 drv_info)
503 if (ath9k_htc_probe_device(target, dev, devid, product, drv_info)) {
504 pr_err("Failed to initialize the device\n");
511 void ath9k_htc_hw_deinit(struct htc_target *target, bool hot_unplug)
514 ath9k_htc_disconnect_device(target, hot_unplug);