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 (*rx) (struct htc_target *, struct htc_packet *); 323 void (*rx_refill) (struct htc_target *, enum htc_endpoint_id endpoint); 324 enum htc_send_full_action (*tx_full) (struct htc_target *, 325 struct htc_packet *); 326 struct htc_packet *(*rx_allocthresh) (struct htc_target *, 327 enum htc_endpoint_id, int); 328 int rx_alloc_thresh; 329 int rx_refill_thresh; 330 }; 331 332 /* service connection information */ 333 struct htc_service_connect_req { 334 u16 svc_id; 335 u16 conn_flags; 336 struct htc_ep_callbacks ep_cb; 337 int max_txq_depth; 338 u32 flags; 339 unsigned int max_rxmsg_sz; 340 }; 341 342 /* service connection response information */ 343 struct htc_service_connect_resp { 344 u8 buf_len; 345 u8 act_len; 346 enum htc_endpoint_id endpoint; 347 unsigned int len_max; 348 u8 resp_code; 349 }; 350 351 /* endpoint distributionstructure */ 352 struct htc_endpoint_credit_dist { 353 struct list_head list; 354 355 /* Service ID (set by HTC) */ 356 u16 svc_id; 357 358 /* endpoint for this distributionstruct (set by HTC) */ 359 enum htc_endpoint_id endpoint; 360 361 u32 dist_flags; 362 363 /* 364 * credits for normal operation, anything above this 365 * indicates the endpoint is over-subscribed. 366 */ 367 int cred_norm; 368 369 /* floor for credit distribution */ 370 int cred_min; 371 372 int cred_assngd; 373 374 /* current credits available */ 375 int credits; 376 377 /* 378 * pending credits to distribute on this endpoint, this 379 * is set by HTC when credit reports arrive. The credit 380 * distribution functions sets this to zero when it distributes 381 * the credits. 382 */ 383 int cred_to_dist; 384 385 /* 386 * the number of credits that the current pending TX packet needs 387 * to transmit. This is set by HTC when endpoint needs credits in 388 * order to transmit. 389 */ 390 int seek_cred; 391 392 /* size in bytes of each credit */ 393 int cred_sz; 394 395 /* credits required for a maximum sized messages */ 396 int cred_per_msg; 397 398 /* reserved for HTC use */ 399 struct htc_endpoint *htc_ep; 400 401 /* 402 * current depth of TX queue , i.e. messages waiting for credits 403 * This field is valid only when HTC_CREDIT_DIST_ACTIVITY_CHANGE 404 * or HTC_CREDIT_DIST_SEND_COMPLETE is indicated on an endpoint 405 * that has non-zero credits to recover. 406 */ 407 int txq_depth; 408 }; 409 410 /* 411 * credit distibution code that is passed into the distrbution function, 412 * there are mandatory and optional codes that must be handled 413 */ 414 enum htc_credit_dist_reason { 415 HTC_CREDIT_DIST_SEND_COMPLETE = 0, 416 HTC_CREDIT_DIST_ACTIVITY_CHANGE = 1, 417 HTC_CREDIT_DIST_SEEK_CREDITS, 418 }; 419 420 struct ath6kl_htc_credit_info { 421 int total_avail_credits; 422 int cur_free_credits; 423 424 /* list of lowest priority endpoints */ 425 struct list_head lowestpri_ep_dist; 426 }; 427 428 /* endpoint statistics */ 429 struct htc_endpoint_stats { 430 /* 431 * number of times the host set the credit-low flag in a send 432 * message on this endpoint 433 */ 434 u32 cred_low_indicate; 435 436 u32 tx_issued; 437 u32 tx_pkt_bundled; 438 u32 tx_bundles; 439 u32 tx_dropped; 440 441 /* running count of total credit reports received for this endpoint */ 442 u32 tx_cred_rpt; 443 444 /* credit reports received from this endpoint's RX packets */ 445 u32 cred_rpt_from_rx; 446 447 /* credit reports received from RX packets of other endpoints */ 448 u32 cred_rpt_from_other; 449 450 /* credit reports received from endpoint 0 RX packets */ 451 u32 cred_rpt_ep0; 452 453 /* count of credits received via Rx packets on this endpoint */ 454 u32 cred_from_rx; 455 456 /* count of credits received via another endpoint */ 457 u32 cred_from_other; 458 459 /* count of credits received via another endpoint */ 460 u32 cred_from_ep0; 461 462 /* count of consummed credits */ 463 u32 cred_cosumd; 464 465 /* count of credits returned */ 466 u32 cred_retnd; 467 468 u32 rx_pkts; 469 470 /* count of lookahead records found in Rx msg */ 471 u32 rx_lkahds; 472 473 /* count of recv packets received in a bundle */ 474 u32 rx_bundl; 475 476 /* count of number of bundled lookaheads */ 477 u32 rx_bundle_lkahd; 478 479 /* count of the number of bundle indications from the HTC header */ 480 u32 rx_bundle_from_hdr; 481 482 /* the number of times the recv allocation threshold was hit */ 483 u32 rx_alloc_thresh_hit; 484 485 /* total number of bytes */ 486 u32 rxalloc_thresh_byte; 487 }; 488 489 struct htc_endpoint { 490 enum htc_endpoint_id eid; 491 u16 svc_id; 492 struct list_head txq; 493 struct list_head rx_bufq; 494 struct htc_endpoint_credit_dist cred_dist; 495 struct htc_ep_callbacks ep_cb; 496 int max_txq_depth; 497 int len_max; 498 int tx_proc_cnt; 499 int rx_proc_cnt; 500 struct htc_target *target; 501 u8 seqno; 502 u32 conn_flags; 503 struct htc_endpoint_stats ep_st; 504 }; 505 506 struct htc_control_buffer { 507 struct htc_packet packet; 508 u8 *buf; 509 }; 510 511 struct ath6kl_device; 512 513 /* our HTC target state */ 514 struct htc_target { 515 struct htc_endpoint endpoint[ENDPOINT_MAX]; 516 517 /* contains struct htc_endpoint_credit_dist */ 518 struct list_head cred_dist_list; 519 520 struct list_head free_ctrl_txbuf; 521 struct list_head free_ctrl_rxbuf; 522 struct ath6kl_htc_credit_info *credit_info; 523 int tgt_creds; 524 unsigned int tgt_cred_sz; 525 spinlock_t htc_lock; 526 spinlock_t rx_lock; 527 spinlock_t tx_lock; 528 struct ath6kl_device *dev; 529 u32 htc_flags; 530 u32 rx_st_flags; 531 enum htc_endpoint_id ep_waiting; 532 u8 htc_tgt_ver; 533 534 /* max messages per bundle for HTC */ 535 int msg_per_bndl_max; 536 537 u32 tx_bndl_mask; 538 int rx_bndl_enable; 539 int max_rx_bndl_sz; 540 int max_tx_bndl_sz; 541 542 u32 block_sz; 543 u32 block_mask; 544 545 int max_scat_entries; 546 int max_xfer_szper_scatreq; 547 548 int chk_irq_status_cnt; 549 550 /* counts the number of Tx without bundling continously per AC */ 551 u32 ac_tx_count[WMM_NUM_AC]; 552 }; 553 554 void *ath6kl_htc_create(struct ath6kl *ar); 555 void ath6kl_htc_set_credit_dist(struct htc_target *target, 556 struct ath6kl_htc_credit_info *cred_info, 557 u16 svc_pri_order[], int len); 558 int ath6kl_htc_wait_target(struct htc_target *target); 559 int ath6kl_htc_start(struct htc_target *target); 560 int ath6kl_htc_conn_service(struct htc_target *target, 561 struct htc_service_connect_req *req, 562 struct htc_service_connect_resp *resp); 563 int ath6kl_htc_tx(struct htc_target *target, struct htc_packet *packet); 564 void ath6kl_htc_stop(struct htc_target *target); 565 void ath6kl_htc_cleanup(struct htc_target *target); 566 void ath6kl_htc_flush_txep(struct htc_target *target, 567 enum htc_endpoint_id endpoint, u16 tag); 568 void ath6kl_htc_flush_rx_buf(struct htc_target *target); 569 void ath6kl_htc_indicate_activity_change(struct htc_target *target, 570 enum htc_endpoint_id endpoint, 571 bool active); 572 int ath6kl_htc_get_rxbuf_num(struct htc_target *target, 573 enum htc_endpoint_id endpoint); 574 int ath6kl_htc_add_rxbuf_multiple(struct htc_target *target, 575 struct list_head *pktq); 576 int ath6kl_htc_rxmsg_pending_handler(struct htc_target *target, 577 u32 msg_look_ahead, int *n_pkts); 578 579 int ath6kl_credit_setup(void *htc_handle, 580 struct ath6kl_htc_credit_info *cred_info); 581 582 static inline void set_htc_pkt_info(struct htc_packet *packet, void *context, 583 u8 *buf, unsigned int len, 584 enum htc_endpoint_id eid, u16 tag) 585 { 586 packet->pkt_cntxt = context; 587 packet->buf = buf; 588 packet->act_len = len; 589 packet->endpoint = eid; 590 packet->info.tx.tag = tag; 591 } 592 593 static inline void htc_rxpkt_reset(struct htc_packet *packet) 594 { 595 packet->buf = packet->buf_start; 596 packet->act_len = 0; 597 } 598 599 static inline void set_htc_rxpkt_info(struct htc_packet *packet, void *context, 600 u8 *buf, unsigned long len, 601 enum htc_endpoint_id eid) 602 { 603 packet->pkt_cntxt = context; 604 packet->buf = buf; 605 packet->buf_start = buf; 606 packet->buf_len = len; 607 packet->endpoint = eid; 608 } 609 610 static inline int get_queue_depth(struct list_head *queue) 611 { 612 struct list_head *tmp_list; 613 int depth = 0; 614 615 list_for_each(tmp_list, queue) 616 depth++; 617 618 return depth; 619 } 620 621 #endif 622