drivers/net/wireless/ath/ath6kl/htc.h

   1 /*
   2  * Copyright (c) 2004-2011 Atheros Communications Inc.
   3  * Copyright (c) 2011 Qualcomm Atheros, Inc.
   4  *
   5  * Permission to use, copy, modify, and/or distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 #ifndef HTC_H
  19 #define HTC_H
  20
  21 #include "common.h"
  22
  23 /* frame header flags */
  24
  25 /* send direction */
  26 #define HTC_FLAGS_NEED_CREDIT_UPDATE (1 << 0)
  27 #define HTC_FLAGS_SEND_BUNDLE        (1 << 1)
  28
  29 /* receive direction */
  30 #define HTC_FLG_RX_UNUSED        (1 << 0)
  31 #define HTC_FLG_RX_TRAILER       (1 << 1)
  32 /* Bundle count maske and shift */
  33 #define HTC_FLG_RX_BNDL_CNT      (0xF0)
  34 #define HTC_FLG_RX_BNDL_CNT_S    4
  35
  36 #define HTC_HDR_LENGTH  (sizeof(struct htc_frame_hdr))
  37 #define HTC_MAX_PAYLOAD_LENGTH   (4096 - sizeof(struct htc_frame_hdr))
  38
  39 /* HTC control message IDs */
  40
  41 #define HTC_MSG_READY_ID                1
  42 #define HTC_MSG_CONN_SVC_ID             2
  43 #define HTC_MSG_CONN_SVC_RESP_ID        3
  44 #define HTC_MSG_SETUP_COMPLETE_ID       4
  45 #define HTC_MSG_SETUP_COMPLETE_EX_ID    5
  46
  47 #define HTC_MAX_CTRL_MSG_LEN  256
  48
  49 #define HTC_VERSION_2P0  0x00
  50 #define HTC_VERSION_2P1  0x01
  51
  52 #define HTC_SERVICE_META_DATA_MAX_LENGTH 128
  53
  54 #define HTC_CONN_FLGS_THRESH_LVL_QUAT           0x0
  55 #define HTC_CONN_FLGS_THRESH_LVL_HALF           0x1
  56 #define HTC_CONN_FLGS_THRESH_LVL_THREE_QUAT     0x2
  57 #define HTC_CONN_FLGS_REDUCE_CRED_DRIB          0x4
  58 #define HTC_CONN_FLGS_THRESH_MASK               0x3
  59
  60 /* connect response status codes */
  61 #define HTC_SERVICE_SUCCESS      0
  62 #define HTC_SERVICE_NOT_FOUND    1
  63 #define HTC_SERVICE_FAILED       2
  64
  65 /* no resources (i.e. no more endpoints) */
  66 #define HTC_SERVICE_NO_RESOURCES 3
  67
  68 /* specific service is not allowing any more endpoints */
  69 #define HTC_SERVICE_NO_MORE_EP   4
  70
  71 /* report record IDs */
  72 #define HTC_RECORD_NULL             0
  73 #define HTC_RECORD_CREDITS          1
  74 #define HTC_RECORD_LOOKAHEAD        2
  75 #define HTC_RECORD_LOOKAHEAD_BUNDLE 3
  76
  77 #define HTC_SETUP_COMP_FLG_RX_BNDL_EN     (1 << 0)
  78
  79 #define MAKE_SERVICE_ID(group, index) \
  80         (int)(((int)group << 8) | (int)(index))
  81
  82 /* NOTE: service ID of 0x0000 is reserved and should never be used */
  83 #define HTC_CTRL_RSVD_SVC MAKE_SERVICE_ID(RSVD_SERVICE_GROUP, 1)
  84 #define WMI_CONTROL_SVC   MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 0)
  85 #define WMI_DATA_BE_SVC   MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 1)
  86 #define WMI_DATA_BK_SVC   MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 2)
  87 #define WMI_DATA_VI_SVC   MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 3)
  88 #define WMI_DATA_VO_SVC   MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 4)
  89 #define WMI_MAX_SERVICES  5
  90
  91 #define WMM_NUM_AC  4
  92
  93 /* reserved and used to flush ALL packets */
  94 #define HTC_TX_PACKET_TAG_ALL          0
  95 #define HTC_SERVICE_TX_PACKET_TAG      1
  96 #define HTC_TX_PACKET_TAG_USER_DEFINED (HTC_SERVICE_TX_PACKET_TAG + 9)
  97
  98 /* more packets on this endpoint are being fetched */
  99 #define HTC_RX_FLAGS_INDICATE_MORE_PKTS  (1 << 0)
 100
 101 /* TODO.. for BMI */
 102 #define ENDPOINT1 0
 103 /* TODO -remove me, but we have to fix BMI first */
 104 #define HTC_MAILBOX_NUM_MAX    4
 105
 106 /* enable send bundle padding for this endpoint */
 107 #define HTC_FLGS_TX_BNDL_PAD_EN  (1 << 0)
 108 #define HTC_EP_ACTIVE                            ((u32) (1u << 31))
 109
 110 /* HTC operational parameters */
 111 #define HTC_TARGET_RESPONSE_TIMEOUT        2000 /* in ms */
 112 #define HTC_TARGET_DEBUG_INTR_MASK         0x01
 113 #define HTC_TARGET_CREDIT_INTR_MASK        0xF0
 114
 115 #define HTC_HOST_MAX_MSG_PER_BUNDLE        8
 116 #define HTC_MIN_HTC_MSGS_TO_BUNDLE         2
 117
 118 /* packet flags */
 119
 120 #define HTC_RX_PKT_IGNORE_LOOKAHEAD      (1 << 0)
 121 #define HTC_RX_PKT_REFRESH_HDR           (1 << 1)
 122 #define HTC_RX_PKT_PART_OF_BUNDLE        (1 << 2)
 123 #define HTC_RX_PKT_NO_RECYCLE            (1 << 3)
 124
 125 #define NUM_CONTROL_BUFFERS     8
 126 #define NUM_CONTROL_TX_BUFFERS  2
 127 #define NUM_CONTROL_RX_BUFFERS  (NUM_CONTROL_BUFFERS - NUM_CONTROL_TX_BUFFERS)
 128
 129 #define HTC_RECV_WAIT_BUFFERS        (1 << 0)
 130 #define HTC_OP_STATE_STOPPING        (1 << 0)
 131
 132 /*
 133  * The frame header length and message formats defined herein were selected
 134  * to accommodate optimal alignment for target processing. This reduces
 135  * code size and improves performance. Any changes to the header length may
 136  * alter the alignment and cause exceptions on the target. When adding to
 137  * the messagestructures insure that fields are properly aligned.
 138  */
 139
 140 /* HTC frame header
 141  *
 142  * NOTE: do not remove or re-arrange the fields, these are minimally
 143  * required to take advantage of 4-byte lookaheads in some hardware
 144  * implementations.
 145  */
 146 struct htc_frame_hdr {
 147         u8 eid;
 148         u8 flags;
 149
 150         /* length of data (including trailer) that follows the header */
 151         __le16 payld_len;
 152
 153         /* end of 4-byte lookahead */
 154
 155         u8 ctrl[2];
 156 } __packed;
 157
 158 /* HTC ready message */
 159 struct htc_ready_msg {
 160         __le16 msg_id;
 161         __le16 cred_cnt;
 162         __le16 cred_sz;
 163         u8 max_ep;
 164         u8 pad;
 165 } __packed;
 166
 167 /* extended HTC ready message */
 168 struct htc_ready_ext_msg {
 169         struct htc_ready_msg ver2_0_info;
 170         u8 htc_ver;
 171         u8 msg_per_htc_bndl;
 172 } __packed;
 173
 174 /* connect service */
 175 struct htc_conn_service_msg {
 176         __le16 msg_id;
 177         __le16 svc_id;
 178         __le16 conn_flags;
 179         u8 svc_meta_len;
 180         u8 pad;
 181 } __packed;
 182
 183 /* connect response */
 184 struct htc_conn_service_resp {
 185         __le16 msg_id;
 186         __le16 svc_id;
 187         u8 status;
 188         u8 eid;
 189         __le16 max_msg_sz;
 190         u8 svc_meta_len;
 191         u8 pad;
 192 } __packed;
 193
 194 struct htc_setup_comp_msg {
 195         __le16 msg_id;
 196 } __packed;
 197
 198 /* extended setup completion message */
 199 struct htc_setup_comp_ext_msg {
 200         __le16 msg_id;
 201         __le32 flags;
 202         u8 msg_per_rxbndl;
 203         u8 Rsvd[3];
 204 } __packed;
 205
 206 struct htc_record_hdr {
 207         u8 rec_id;
 208         u8 len;
 209 } __packed;
 210
 211 struct htc_credit_report {
 212         u8 eid;
 213         u8 credits;
 214 } __packed;
 215
 216 /*
 217  * NOTE: The lk_ahd array is guarded by a pre_valid
 218  * and Post Valid guard bytes. The pre_valid bytes must
 219  * equal the inverse of the post_valid byte.
 220  */
 221 struct htc_lookahead_report {
 222         u8 pre_valid;
 223         u8 lk_ahd[4];
 224         u8 post_valid;
 225 } __packed;
 226
 227 struct htc_bundle_lkahd_rpt {
 228         u8 lk_ahd[4];
 229 } __packed;
 230
 231 /* Current service IDs */
 232
 233 enum htc_service_grp_ids {
 234         RSVD_SERVICE_GROUP = 0,
 235         WMI_SERVICE_GROUP = 1,
 236
 237         HTC_TEST_GROUP = 254,
 238         HTC_SERVICE_GROUP_LAST = 255
 239 };
 240
 241 /* ------ endpoint IDS ------ */
 242
 243 enum htc_endpoint_id {
 244         ENDPOINT_UNUSED = -1,
 245         ENDPOINT_0 = 0,
 246         ENDPOINT_1 = 1,
 247         ENDPOINT_2 = 2,
 248         ENDPOINT_3,
 249         ENDPOINT_4,
 250         ENDPOINT_5,
 251         ENDPOINT_6,
 252         ENDPOINT_7,
 253         ENDPOINT_8,
 254         ENDPOINT_MAX,
 255 };
 256
 257 struct htc_tx_packet_info {
 258         u16 tag;
 259         int cred_used;
 260         u8 flags;
 261         int seqno;
 262 };
 263
 264 struct htc_rx_packet_info {
 265         u32 exp_hdr;
 266         u32 rx_flags;
 267         u32 indicat_flags;
 268 };
 269
 270 struct htc_target;
 271
 272 /* wrapper around endpoint-specific packets */
 273 struct htc_packet {
 274         struct list_head list;
 275
 276         /* caller's per packet specific context */
 277         void *pkt_cntxt;
 278
 279         /*
 280          * the true buffer start , the caller can store the real
 281          * buffer start here.  In receive callbacks, the HTC layer
 282          * sets buf to the start of the payload past the header.
 283          * This field allows the caller to reset buf when it recycles
 284          * receive packets back to HTC.
 285          */
 286         u8 *buf_start;
 287
 288         /*
 289          * Pointer to the start of the buffer. In the transmit
 290          * direction this points to the start of the payload. In the
 291          * receive direction, however, the buffer when queued up
 292          * points to the start of the HTC header but when returned
 293          * to the caller points to the start of the payload
 294          */
 295         u8 *buf;
 296         u32 buf_len;
 297
 298         /* actual length of payload */
 299         u32 act_len;
 300
 301         /* endpoint that this packet was sent/recv'd from */
 302         enum htc_endpoint_id endpoint;
 303
 304         /* completion status */
 305
 306         int status;
 307         union {
 308                 struct htc_tx_packet_info tx;
 309                 struct htc_rx_packet_info rx;
 310         } info;
 311
 312         void (*completion) (struct htc_target *, struct htc_packet *);
 313         struct htc_target *context;
 314 };
 315
 316 enum htc_send_full_action {
 317         HTC_SEND_FULL_KEEP = 0,
 318         HTC_SEND_FULL_DROP = 1,
 319 };
 320
 321 struct htc_ep_callbacks {
 322         void (*tx_complete) (struct htc_target *, struct htc_packet *);
 323         void (*rx) (struct htc_target *, struct htc_packet *);
 324         void (*rx_refill) (struct htc_target *, enum htc_endpoint_id endpoint);
 325         enum htc_send_full_action (*tx_full) (struct htc_target *,
 326                                               struct htc_packet *);
 327         struct htc_packet *(*rx_allocthresh) (struct htc_target *,
 328                                               enum htc_endpoint_id, int);
 329         int rx_alloc_thresh;
 330         int rx_refill_thresh;
 331 };
 332
 333 /* service connection information */
 334 struct htc_service_connect_req {
 335         u16 svc_id;
 336         u16 conn_flags;
 337         struct htc_ep_callbacks ep_cb;
 338         int max_txq_depth;
 339         u32 flags;
 340         unsigned int max_rxmsg_sz;
 341 };
 342
 343 /* service connection response information */
 344 struct htc_service_connect_resp {
 345         u8 buf_len;
 346         u8 act_len;
 347         enum htc_endpoint_id endpoint;
 348         unsigned int len_max;
 349         u8 resp_code;
 350 };
 351
 352 /* endpoint distributionstructure */
 353 struct htc_endpoint_credit_dist {
 354         struct list_head list;
 355
 356         /* Service ID (set by HTC) */
 357         u16 svc_id;
 358
 359         /* endpoint for this distributionstruct (set by HTC) */
 360         enum htc_endpoint_id endpoint;
 361
 362         u32 dist_flags;
 363
 364         /*
 365          * credits for normal operation, anything above this
 366          * indicates the endpoint is over-subscribed.
 367          */
 368         int cred_norm;
 369
 370         /* floor for credit distribution */
 371         int cred_min;
 372
 373         int cred_assngd;
 374
 375         /* current credits available */
 376         int credits;
 377
 378         /*
 379          * pending credits to distribute on this endpoint, this
 380          * is set by HTC when credit reports arrive.  The credit
 381          * distribution functions sets this to zero when it distributes
 382          * the credits.
 383          */
 384         int cred_to_dist;
 385
 386         /*
 387          * the number of credits that the current pending TX packet needs
 388          * to transmit. This is set by HTC when endpoint needs credits in
 389          * order to transmit.
 390          */
 391         int seek_cred;
 392
 393         /* size in bytes of each credit */
 394         int cred_sz;
 395
 396         /* credits required for a maximum sized messages */
 397         int cred_per_msg;
 398
 399         /* reserved for HTC use */
 400         struct htc_endpoint *htc_ep;
 401
 402         /*
 403          * current depth of TX queue , i.e. messages waiting for credits
 404          * This field is valid only when HTC_CREDIT_DIST_ACTIVITY_CHANGE
 405          * or HTC_CREDIT_DIST_SEND_COMPLETE is indicated on an endpoint
 406          * that has non-zero credits to recover.
 407          */
 408         int txq_depth;
 409 };
 410
 411 /*
 412  * credit distibution code that is passed into the distrbution function,
 413  * there are mandatory and optional codes that must be handled
 414  */
 415 enum htc_credit_dist_reason {
 416         HTC_CREDIT_DIST_SEND_COMPLETE = 0,
 417         HTC_CREDIT_DIST_ACTIVITY_CHANGE = 1,
 418         HTC_CREDIT_DIST_SEEK_CREDITS,
 419 };
 420
 421 struct ath6kl_htc_credit_info {
 422         int total_avail_credits;
 423         int cur_free_credits;
 424
 425         /* list of lowest priority endpoints */
 426         struct list_head lowestpri_ep_dist;
 427 };
 428
 429 /* endpoint statistics */
 430 struct htc_endpoint_stats {
 431         /*
 432          * number of times the host set the credit-low flag in a send
 433          * message on this endpoint
 434          */
 435         u32 cred_low_indicate;
 436
 437         u32 tx_issued;
 438         u32 tx_pkt_bundled;
 439         u32 tx_bundles;
 440         u32 tx_dropped;
 441
 442         /* running count of total credit reports received for this endpoint */
 443         u32 tx_cred_rpt;
 444
 445         /* credit reports received from this endpoint's RX packets */
 446         u32 cred_rpt_from_rx;
 447
 448         /* credit reports received from RX packets of other endpoints */
 449         u32 cred_rpt_from_other;
 450
 451         /* credit reports received from endpoint 0 RX packets */
 452         u32 cred_rpt_ep0;
 453
 454         /* count of credits received via Rx packets on this endpoint */
 455         u32 cred_from_rx;
 456
 457         /* count of credits received via another endpoint */
 458         u32 cred_from_other;
 459
 460         /* count of credits received via another endpoint */
 461         u32 cred_from_ep0;
 462
 463         /* count of consummed credits */
 464         u32 cred_cosumd;
 465
 466         /* count of credits returned */
 467         u32 cred_retnd;
 468
 469         u32 rx_pkts;
 470
 471         /* count of lookahead records found in Rx msg */
 472         u32 rx_lkahds;
 473
 474         /* count of recv packets received in a bundle */
 475         u32 rx_bundl;
 476
 477         /* count of number of bundled lookaheads */
 478         u32 rx_bundle_lkahd;
 479
 480         /* count of the number of bundle indications from the HTC header */
 481         u32 rx_bundle_from_hdr;
 482
 483         /* the number of times the recv allocation threshold was hit */
 484         u32 rx_alloc_thresh_hit;
 485
 486         /* total number of bytes */
 487         u32 rxalloc_thresh_byte;
 488 };
 489
 490 struct htc_endpoint {
 491         enum htc_endpoint_id eid;
 492         u16 svc_id;
 493         struct list_head txq;
 494         struct list_head rx_bufq;
 495         struct htc_endpoint_credit_dist cred_dist;
 496         struct htc_ep_callbacks ep_cb;
 497         int max_txq_depth;
 498         int len_max;
 499         int tx_proc_cnt;
 500         int rx_proc_cnt;
 501         struct htc_target *target;
 502         u8 seqno;
 503         u32 conn_flags;
 504         struct htc_endpoint_stats ep_st;
 505         u16 tx_drop_packet_threshold;
 506 };
 507
 508 struct htc_control_buffer {
 509         struct htc_packet packet;
 510         u8 *buf;
 511 };
 512
 513 struct ath6kl_device;
 514
 515 /* our HTC target state */
 516 struct htc_target {
 517         struct htc_endpoint endpoint[ENDPOINT_MAX];
 518
 519         /* contains struct htc_endpoint_credit_dist */
 520         struct list_head cred_dist_list;
 521
 522         struct list_head free_ctrl_txbuf;
 523         struct list_head free_ctrl_rxbuf;
 524         struct ath6kl_htc_credit_info *credit_info;
 525         int tgt_creds;
 526         unsigned int tgt_cred_sz;
 527
 528         /* protects free_ctrl_txbuf and free_ctrl_rxbuf */
 529         spinlock_t htc_lock;
 530
 531         /* FIXME: does this protext rx_bufq and endpoint structures or what? */
 532         spinlock_t rx_lock;
 533
 534         /* protects endpoint->txq */
 535         spinlock_t tx_lock;
 536
 537         struct ath6kl_device *dev;
 538         u32 htc_flags;
 539         u32 rx_st_flags;
 540         enum htc_endpoint_id ep_waiting;
 541         u8 htc_tgt_ver;
 542
 543         /* max messages per bundle for HTC */
 544         int msg_per_bndl_max;
 545
 546         u32 tx_bndl_mask;
 547         int rx_bndl_enable;
 548         int max_rx_bndl_sz;
 549         int max_tx_bndl_sz;
 550
 551         u32 block_sz;
 552         u32 block_mask;
 553
 554         int max_scat_entries;
 555         int max_xfer_szper_scatreq;
 556
 557         int chk_irq_status_cnt;
 558
 559         /* counts the number of Tx without bundling continously per AC */
 560         u32 ac_tx_count[WMM_NUM_AC];
 561 };
 562
 563 void *ath6kl_htc_create(struct ath6kl *ar);
 564 void ath6kl_htc_set_credit_dist(struct htc_target *target,
 565                                 struct ath6kl_htc_credit_info *cred_info,
 566                                 u16 svc_pri_order[], int len);
 567 int ath6kl_htc_wait_target(struct htc_target *target);
 568 int ath6kl_htc_start(struct htc_target *target);
 569 int ath6kl_htc_conn_service(struct htc_target *target,
 570                             struct htc_service_connect_req *req,
 571                             struct htc_service_connect_resp *resp);
 572 int ath6kl_htc_tx(struct htc_target *target, struct htc_packet *packet);
 573 void ath6kl_htc_stop(struct htc_target *target);
 574 void ath6kl_htc_cleanup(struct htc_target *target);
 575 void ath6kl_htc_flush_txep(struct htc_target *target,
 576                            enum htc_endpoint_id endpoint, u16 tag);
 577 void ath6kl_htc_flush_rx_buf(struct htc_target *target);
 578 void ath6kl_htc_indicate_activity_change(struct htc_target *target,
 579                                          enum htc_endpoint_id endpoint,
 580                                          bool active);
 581 int ath6kl_htc_get_rxbuf_num(struct htc_target *target,
 582                              enum htc_endpoint_id endpoint);
 583 int ath6kl_htc_add_rxbuf_multiple(struct htc_target *target,
 584                                   struct list_head *pktq);
 585 int ath6kl_htc_rxmsg_pending_handler(struct htc_target *target,
 586                                      u32 msg_look_ahead, int *n_pkts);
 587
 588 int ath6kl_credit_setup(void *htc_handle,
 589                         struct ath6kl_htc_credit_info *cred_info);
 590
 591 static inline void set_htc_pkt_info(struct htc_packet *packet, void *context,
 592                                     u8 *buf, unsigned int len,
 593                                     enum htc_endpoint_id eid, u16 tag)
 594 {
 595         packet->pkt_cntxt = context;
 596         packet->buf = buf;
 597         packet->act_len = len;
 598         packet->endpoint = eid;
 599         packet->info.tx.tag = tag;
 600 }
 601
 602 static inline void htc_rxpkt_reset(struct htc_packet *packet)
 603 {
 604         packet->buf = packet->buf_start;
 605         packet->act_len = 0;
 606 }
 607
 608 static inline void set_htc_rxpkt_info(struct htc_packet *packet, void *context,
 609                                       u8 *buf, unsigned long len,
 610                                       enum htc_endpoint_id eid)
 611 {
 612         packet->pkt_cntxt = context;
 613         packet->buf = buf;
 614         packet->buf_start = buf;
 615         packet->buf_len = len;
 616         packet->endpoint = eid;
 617 }
 618
 619 static inline int get_queue_depth(struct list_head *queue)
 620 {
 621         struct list_head *tmp_list;
 622         int depth = 0;
 623
 624         list_for_each(tmp_list, queue)
 625             depth++;
 626
 627         return depth;
 628 }
 629
 630 #endif