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