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