drivers/net/wireless/ath/ath9k/htc_hst.c

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