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