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