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) 28636f8288SKalle Valo #define HTC_FLAGS_TX_FIXUP_NETBUF (1 << 2) 29bdcd8170SKalle Valo 30bdcd8170SKalle Valo /* receive direction */ 31bdcd8170SKalle Valo #define HTC_FLG_RX_UNUSED (1 << 0) 32bdcd8170SKalle Valo #define HTC_FLG_RX_TRAILER (1 << 1) 33bdcd8170SKalle Valo /* Bundle count maske and shift */ 34bdcd8170SKalle Valo #define HTC_FLG_RX_BNDL_CNT (0xF0) 35bdcd8170SKalle Valo #define HTC_FLG_RX_BNDL_CNT_S 4 36bdcd8170SKalle Valo 37bdcd8170SKalle Valo #define HTC_HDR_LENGTH (sizeof(struct htc_frame_hdr)) 38bdcd8170SKalle Valo #define HTC_MAX_PAYLOAD_LENGTH (4096 - sizeof(struct htc_frame_hdr)) 39bdcd8170SKalle Valo 40bdcd8170SKalle Valo /* HTC control message IDs */ 41bdcd8170SKalle Valo 42bdcd8170SKalle Valo #define HTC_MSG_READY_ID 1 43bdcd8170SKalle Valo #define HTC_MSG_CONN_SVC_ID 2 44bdcd8170SKalle Valo #define HTC_MSG_CONN_SVC_RESP_ID 3 45bdcd8170SKalle Valo #define HTC_MSG_SETUP_COMPLETE_ID 4 46bdcd8170SKalle Valo #define HTC_MSG_SETUP_COMPLETE_EX_ID 5 47bdcd8170SKalle Valo 48bdcd8170SKalle Valo #define HTC_MAX_CTRL_MSG_LEN 256 49bdcd8170SKalle Valo 50bdcd8170SKalle Valo #define HTC_VERSION_2P0 0x00 51bdcd8170SKalle Valo #define HTC_VERSION_2P1 0x01 52bdcd8170SKalle Valo 53bdcd8170SKalle Valo #define HTC_SERVICE_META_DATA_MAX_LENGTH 128 54bdcd8170SKalle Valo 55bdcd8170SKalle Valo #define HTC_CONN_FLGS_THRESH_LVL_QUAT 0x0 56bdcd8170SKalle Valo #define HTC_CONN_FLGS_THRESH_LVL_HALF 0x1 57bdcd8170SKalle Valo #define HTC_CONN_FLGS_THRESH_LVL_THREE_QUAT 0x2 58bdcd8170SKalle Valo #define HTC_CONN_FLGS_REDUCE_CRED_DRIB 0x4 59bdcd8170SKalle Valo #define HTC_CONN_FLGS_THRESH_MASK 0x3 60636f8288SKalle Valo /* disable credit flow control on a specific service */ 61636f8288SKalle Valo #define HTC_CONN_FLGS_DISABLE_CRED_FLOW_CTRL (1 << 3) 62636f8288SKalle Valo #define HTC_CONN_FLGS_SET_RECV_ALLOC_SHIFT 8 63636f8288SKalle Valo #define HTC_CONN_FLGS_SET_RECV_ALLOC_MASK 0xFF00 64bdcd8170SKalle Valo 65bdcd8170SKalle Valo /* connect response status codes */ 66bdcd8170SKalle Valo #define HTC_SERVICE_SUCCESS 0 67bdcd8170SKalle Valo #define HTC_SERVICE_NOT_FOUND 1 68bdcd8170SKalle Valo #define HTC_SERVICE_FAILED 2 69bdcd8170SKalle Valo 70bdcd8170SKalle Valo /* no resources (i.e. no more endpoints) */ 71bdcd8170SKalle Valo #define HTC_SERVICE_NO_RESOURCES 3 72bdcd8170SKalle Valo 73bdcd8170SKalle Valo /* specific service is not allowing any more endpoints */ 74bdcd8170SKalle Valo #define HTC_SERVICE_NO_MORE_EP 4 75bdcd8170SKalle Valo 76bdcd8170SKalle Valo /* report record IDs */ 77bdcd8170SKalle Valo #define HTC_RECORD_NULL 0 78bdcd8170SKalle Valo #define HTC_RECORD_CREDITS 1 79bdcd8170SKalle Valo #define HTC_RECORD_LOOKAHEAD 2 80bdcd8170SKalle Valo #define HTC_RECORD_LOOKAHEAD_BUNDLE 3 81bdcd8170SKalle Valo 82bdcd8170SKalle Valo #define HTC_SETUP_COMP_FLG_RX_BNDL_EN (1 << 0) 83636f8288SKalle Valo #define HTC_SETUP_COMP_FLG_DISABLE_TX_CREDIT_FLOW (1 << 1) 84bdcd8170SKalle Valo 85bdcd8170SKalle Valo #define MAKE_SERVICE_ID(group, index) \ 86bdcd8170SKalle Valo (int)(((int)group << 8) | (int)(index)) 87bdcd8170SKalle Valo 88bdcd8170SKalle Valo /* NOTE: service ID of 0x0000 is reserved and should never be used */ 89bdcd8170SKalle Valo #define HTC_CTRL_RSVD_SVC MAKE_SERVICE_ID(RSVD_SERVICE_GROUP, 1) 90bdcd8170SKalle Valo #define WMI_CONTROL_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 0) 91bdcd8170SKalle Valo #define WMI_DATA_BE_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 1) 92bdcd8170SKalle Valo #define WMI_DATA_BK_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 2) 93bdcd8170SKalle Valo #define WMI_DATA_VI_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 3) 94bdcd8170SKalle Valo #define WMI_DATA_VO_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 4) 95bdcd8170SKalle Valo #define WMI_MAX_SERVICES 5 96bdcd8170SKalle Valo 97b29072ccSChilam Ng #define WMM_NUM_AC 4 98b29072ccSChilam Ng 99bdcd8170SKalle Valo /* reserved and used to flush ALL packets */ 100bdcd8170SKalle Valo #define HTC_TX_PACKET_TAG_ALL 0 101bdcd8170SKalle Valo #define HTC_SERVICE_TX_PACKET_TAG 1 102bdcd8170SKalle Valo #define HTC_TX_PACKET_TAG_USER_DEFINED (HTC_SERVICE_TX_PACKET_TAG + 9) 103bdcd8170SKalle Valo 104bdcd8170SKalle Valo /* more packets on this endpoint are being fetched */ 105bdcd8170SKalle Valo #define HTC_RX_FLAGS_INDICATE_MORE_PKTS (1 << 0) 106bdcd8170SKalle Valo 107bdcd8170SKalle Valo /* TODO.. for BMI */ 108bdcd8170SKalle Valo #define ENDPOINT1 0 109bdcd8170SKalle Valo /* TODO -remove me, but we have to fix BMI first */ 110bdcd8170SKalle Valo #define HTC_MAILBOX_NUM_MAX 4 111bdcd8170SKalle Valo 112bdcd8170SKalle Valo /* enable send bundle padding for this endpoint */ 113bdcd8170SKalle Valo #define HTC_FLGS_TX_BNDL_PAD_EN (1 << 0) 114bdcd8170SKalle Valo #define HTC_EP_ACTIVE ((u32) (1u << 31)) 115bdcd8170SKalle Valo 116bdcd8170SKalle Valo /* HTC operational parameters */ 117bdcd8170SKalle Valo #define HTC_TARGET_RESPONSE_TIMEOUT 2000 /* in ms */ 118636f8288SKalle Valo #define HTC_TARGET_RESPONSE_POLL_WAIT 10 119636f8288SKalle Valo #define HTC_TARGET_RESPONSE_POLL_COUNT 200 120bdcd8170SKalle Valo #define HTC_TARGET_DEBUG_INTR_MASK 0x01 121bdcd8170SKalle Valo #define HTC_TARGET_CREDIT_INTR_MASK 0xF0 122bdcd8170SKalle Valo 123bdcd8170SKalle Valo #define HTC_HOST_MAX_MSG_PER_BUNDLE 8 124bdcd8170SKalle Valo #define HTC_MIN_HTC_MSGS_TO_BUNDLE 2 125bdcd8170SKalle Valo 126bdcd8170SKalle Valo /* packet flags */ 127bdcd8170SKalle Valo 128bdcd8170SKalle Valo #define HTC_RX_PKT_IGNORE_LOOKAHEAD (1 << 0) 129bdcd8170SKalle Valo #define HTC_RX_PKT_REFRESH_HDR (1 << 1) 130bdcd8170SKalle Valo #define HTC_RX_PKT_PART_OF_BUNDLE (1 << 2) 131bdcd8170SKalle Valo #define HTC_RX_PKT_NO_RECYCLE (1 << 3) 132bdcd8170SKalle Valo 133bdcd8170SKalle Valo #define NUM_CONTROL_BUFFERS 8 134bdcd8170SKalle Valo #define NUM_CONTROL_TX_BUFFERS 2 135bdcd8170SKalle Valo #define NUM_CONTROL_RX_BUFFERS (NUM_CONTROL_BUFFERS - NUM_CONTROL_TX_BUFFERS) 136bdcd8170SKalle Valo 137bdcd8170SKalle Valo #define HTC_RECV_WAIT_BUFFERS (1 << 0) 138bdcd8170SKalle Valo #define HTC_OP_STATE_STOPPING (1 << 0) 139636f8288SKalle Valo #define HTC_OP_STATE_SETUP_COMPLETE (1 << 1) 140bdcd8170SKalle Valo 141bdcd8170SKalle Valo /* 142bdcd8170SKalle Valo * The frame header length and message formats defined herein were selected 143bdcd8170SKalle Valo * to accommodate optimal alignment for target processing. This reduces 144bdcd8170SKalle Valo * code size and improves performance. Any changes to the header length may 145bdcd8170SKalle Valo * alter the alignment and cause exceptions on the target. When adding to 146bdcd8170SKalle Valo * the messagestructures insure that fields are properly aligned. 147bdcd8170SKalle Valo */ 148bdcd8170SKalle Valo 149bdcd8170SKalle Valo /* HTC frame header 150bdcd8170SKalle Valo * 151bdcd8170SKalle Valo * NOTE: do not remove or re-arrange the fields, these are minimally 152bdcd8170SKalle Valo * required to take advantage of 4-byte lookaheads in some hardware 153bdcd8170SKalle Valo * implementations. 154bdcd8170SKalle Valo */ 155bdcd8170SKalle Valo struct htc_frame_hdr { 156bdcd8170SKalle Valo u8 eid; 157bdcd8170SKalle Valo u8 flags; 158bdcd8170SKalle Valo 159bdcd8170SKalle Valo /* length of data (including trailer) that follows the header */ 160bdcd8170SKalle Valo __le16 payld_len; 161bdcd8170SKalle Valo 162bdcd8170SKalle Valo /* end of 4-byte lookahead */ 163bdcd8170SKalle Valo 164bdcd8170SKalle Valo u8 ctrl[2]; 165bdcd8170SKalle Valo } __packed; 166bdcd8170SKalle Valo 167bdcd8170SKalle Valo /* HTC ready message */ 168bdcd8170SKalle Valo struct htc_ready_msg { 169bdcd8170SKalle Valo __le16 msg_id; 170bdcd8170SKalle Valo __le16 cred_cnt; 171bdcd8170SKalle Valo __le16 cred_sz; 172bdcd8170SKalle Valo u8 max_ep; 173bdcd8170SKalle Valo u8 pad; 174bdcd8170SKalle Valo } __packed; 175bdcd8170SKalle Valo 176bdcd8170SKalle Valo /* extended HTC ready message */ 177bdcd8170SKalle Valo struct htc_ready_ext_msg { 178bdcd8170SKalle Valo struct htc_ready_msg ver2_0_info; 179bdcd8170SKalle Valo u8 htc_ver; 180bdcd8170SKalle Valo u8 msg_per_htc_bndl; 181bdcd8170SKalle Valo } __packed; 182bdcd8170SKalle Valo 183bdcd8170SKalle Valo /* connect service */ 184bdcd8170SKalle Valo struct htc_conn_service_msg { 185bdcd8170SKalle Valo __le16 msg_id; 186bdcd8170SKalle Valo __le16 svc_id; 187bdcd8170SKalle Valo __le16 conn_flags; 188bdcd8170SKalle Valo u8 svc_meta_len; 189bdcd8170SKalle Valo u8 pad; 190bdcd8170SKalle Valo } __packed; 191bdcd8170SKalle Valo 192bdcd8170SKalle Valo /* connect response */ 193bdcd8170SKalle Valo struct htc_conn_service_resp { 194bdcd8170SKalle Valo __le16 msg_id; 195bdcd8170SKalle Valo __le16 svc_id; 196bdcd8170SKalle Valo u8 status; 197bdcd8170SKalle Valo u8 eid; 198bdcd8170SKalle Valo __le16 max_msg_sz; 199bdcd8170SKalle Valo u8 svc_meta_len; 200bdcd8170SKalle Valo u8 pad; 201bdcd8170SKalle Valo } __packed; 202bdcd8170SKalle Valo 203bdcd8170SKalle Valo struct htc_setup_comp_msg { 204bdcd8170SKalle Valo __le16 msg_id; 205bdcd8170SKalle Valo } __packed; 206bdcd8170SKalle Valo 207bdcd8170SKalle Valo /* extended setup completion message */ 208bdcd8170SKalle Valo struct htc_setup_comp_ext_msg { 209bdcd8170SKalle Valo __le16 msg_id; 210bdcd8170SKalle Valo __le32 flags; 211bdcd8170SKalle Valo u8 msg_per_rxbndl; 212bdcd8170SKalle Valo u8 Rsvd[3]; 213bdcd8170SKalle Valo } __packed; 214bdcd8170SKalle Valo 215bdcd8170SKalle Valo struct htc_record_hdr { 216bdcd8170SKalle Valo u8 rec_id; 217bdcd8170SKalle Valo u8 len; 218bdcd8170SKalle Valo } __packed; 219bdcd8170SKalle Valo 220bdcd8170SKalle Valo struct htc_credit_report { 221bdcd8170SKalle Valo u8 eid; 222bdcd8170SKalle Valo u8 credits; 223bdcd8170SKalle Valo } __packed; 224bdcd8170SKalle Valo 225bdcd8170SKalle Valo /* 226bdcd8170SKalle Valo * NOTE: The lk_ahd array is guarded by a pre_valid 227bdcd8170SKalle Valo * and Post Valid guard bytes. The pre_valid bytes must 228bdcd8170SKalle Valo * equal the inverse of the post_valid byte. 229bdcd8170SKalle Valo */ 230bdcd8170SKalle Valo struct htc_lookahead_report { 231bdcd8170SKalle Valo u8 pre_valid; 232bdcd8170SKalle Valo u8 lk_ahd[4]; 233bdcd8170SKalle Valo u8 post_valid; 234bdcd8170SKalle Valo } __packed; 235bdcd8170SKalle Valo 236bdcd8170SKalle Valo struct htc_bundle_lkahd_rpt { 237bdcd8170SKalle Valo u8 lk_ahd[4]; 238bdcd8170SKalle Valo } __packed; 239bdcd8170SKalle Valo 240bdcd8170SKalle Valo /* Current service IDs */ 241bdcd8170SKalle Valo 242bdcd8170SKalle Valo enum htc_service_grp_ids { 243bdcd8170SKalle Valo RSVD_SERVICE_GROUP = 0, 244bdcd8170SKalle Valo WMI_SERVICE_GROUP = 1, 245bdcd8170SKalle Valo 246bdcd8170SKalle Valo HTC_TEST_GROUP = 254, 247bdcd8170SKalle Valo HTC_SERVICE_GROUP_LAST = 255 248bdcd8170SKalle Valo }; 249bdcd8170SKalle Valo 250bdcd8170SKalle Valo /* ------ endpoint IDS ------ */ 251bdcd8170SKalle Valo 252bdcd8170SKalle Valo enum htc_endpoint_id { 253bdcd8170SKalle Valo ENDPOINT_UNUSED = -1, 254bdcd8170SKalle Valo ENDPOINT_0 = 0, 255bdcd8170SKalle Valo ENDPOINT_1 = 1, 256bdcd8170SKalle Valo ENDPOINT_2 = 2, 257bdcd8170SKalle Valo ENDPOINT_3, 258bdcd8170SKalle Valo ENDPOINT_4, 259bdcd8170SKalle Valo ENDPOINT_5, 260bdcd8170SKalle Valo ENDPOINT_6, 261bdcd8170SKalle Valo ENDPOINT_7, 262bdcd8170SKalle Valo ENDPOINT_8, 263bdcd8170SKalle Valo ENDPOINT_MAX, 264bdcd8170SKalle Valo }; 265bdcd8170SKalle Valo 266bdcd8170SKalle Valo struct htc_tx_packet_info { 267bdcd8170SKalle Valo u16 tag; 268bdcd8170SKalle Valo int cred_used; 269bdcd8170SKalle Valo u8 flags; 270bdcd8170SKalle Valo int seqno; 271bdcd8170SKalle Valo }; 272bdcd8170SKalle Valo 273bdcd8170SKalle Valo struct htc_rx_packet_info { 274bdcd8170SKalle Valo u32 exp_hdr; 275bdcd8170SKalle Valo u32 rx_flags; 276bdcd8170SKalle Valo u32 indicat_flags; 277bdcd8170SKalle Valo }; 278bdcd8170SKalle Valo 279bdcd8170SKalle Valo struct htc_target; 280bdcd8170SKalle Valo 281bdcd8170SKalle Valo /* wrapper around endpoint-specific packets */ 282bdcd8170SKalle Valo struct htc_packet { 283bdcd8170SKalle Valo struct list_head list; 284bdcd8170SKalle Valo 285bdcd8170SKalle Valo /* caller's per packet specific context */ 286bdcd8170SKalle Valo void *pkt_cntxt; 287bdcd8170SKalle Valo 288bdcd8170SKalle Valo /* 289bdcd8170SKalle Valo * the true buffer start , the caller can store the real 290bdcd8170SKalle Valo * buffer start here. In receive callbacks, the HTC layer 291bdcd8170SKalle Valo * sets buf to the start of the payload past the header. 292bdcd8170SKalle Valo * This field allows the caller to reset buf when it recycles 293bdcd8170SKalle Valo * receive packets back to HTC. 294bdcd8170SKalle Valo */ 295bdcd8170SKalle Valo u8 *buf_start; 296bdcd8170SKalle Valo 297bdcd8170SKalle Valo /* 298bdcd8170SKalle Valo * Pointer to the start of the buffer. In the transmit 299bdcd8170SKalle Valo * direction this points to the start of the payload. In the 300bdcd8170SKalle Valo * receive direction, however, the buffer when queued up 301bdcd8170SKalle Valo * points to the start of the HTC header but when returned 302bdcd8170SKalle Valo * to the caller points to the start of the payload 303bdcd8170SKalle Valo */ 304bdcd8170SKalle Valo u8 *buf; 305bdcd8170SKalle Valo u32 buf_len; 306bdcd8170SKalle Valo 307bdcd8170SKalle Valo /* actual length of payload */ 308bdcd8170SKalle Valo u32 act_len; 309bdcd8170SKalle Valo 310bdcd8170SKalle Valo /* endpoint that this packet was sent/recv'd from */ 311bdcd8170SKalle Valo enum htc_endpoint_id endpoint; 312bdcd8170SKalle Valo 313bdcd8170SKalle Valo /* completion status */ 314bdcd8170SKalle Valo 315bdcd8170SKalle Valo int status; 316bdcd8170SKalle Valo union { 317bdcd8170SKalle Valo struct htc_tx_packet_info tx; 318bdcd8170SKalle Valo struct htc_rx_packet_info rx; 319bdcd8170SKalle Valo } info; 320bdcd8170SKalle Valo 321bdcd8170SKalle Valo void (*completion) (struct htc_target *, struct htc_packet *); 322bdcd8170SKalle Valo struct htc_target *context; 323cfc10f24SKalle Valo 324cfc10f24SKalle Valo /* 325cfc10f24SKalle Valo * optimization for network-oriented data, the HTC packet 326cfc10f24SKalle Valo * can pass the network buffer corresponding to the HTC packet 327cfc10f24SKalle Valo * lower layers may optimized the transfer knowing this is 328cfc10f24SKalle Valo * a network buffer 329cfc10f24SKalle Valo */ 330cfc10f24SKalle Valo struct sk_buff *skb; 331bdcd8170SKalle Valo }; 332bdcd8170SKalle Valo 333bdcd8170SKalle Valo enum htc_send_full_action { 334bdcd8170SKalle Valo HTC_SEND_FULL_KEEP = 0, 335bdcd8170SKalle Valo HTC_SEND_FULL_DROP = 1, 336bdcd8170SKalle Valo }; 337bdcd8170SKalle Valo 338bdcd8170SKalle Valo struct htc_ep_callbacks { 33963de1112SKalle Valo void (*tx_complete) (struct htc_target *, struct htc_packet *); 340bdcd8170SKalle Valo void (*rx) (struct htc_target *, struct htc_packet *); 341bdcd8170SKalle Valo void (*rx_refill) (struct htc_target *, enum htc_endpoint_id endpoint); 342bdcd8170SKalle Valo enum htc_send_full_action (*tx_full) (struct htc_target *, 343bdcd8170SKalle Valo struct htc_packet *); 344bdcd8170SKalle Valo struct htc_packet *(*rx_allocthresh) (struct htc_target *, 345bdcd8170SKalle Valo enum htc_endpoint_id, int); 346900d6b3fSKalle Valo void (*tx_comp_multi) (struct htc_target *, struct list_head *); 347bdcd8170SKalle Valo int rx_alloc_thresh; 348bdcd8170SKalle Valo int rx_refill_thresh; 349bdcd8170SKalle Valo }; 350bdcd8170SKalle Valo 351bdcd8170SKalle Valo /* service connection information */ 352bdcd8170SKalle Valo struct htc_service_connect_req { 353bdcd8170SKalle Valo u16 svc_id; 354bdcd8170SKalle Valo u16 conn_flags; 355bdcd8170SKalle Valo struct htc_ep_callbacks ep_cb; 356bdcd8170SKalle Valo int max_txq_depth; 357bdcd8170SKalle Valo u32 flags; 358bdcd8170SKalle Valo unsigned int max_rxmsg_sz; 359bdcd8170SKalle Valo }; 360bdcd8170SKalle Valo 361bdcd8170SKalle Valo /* service connection response information */ 362bdcd8170SKalle Valo struct htc_service_connect_resp { 363bdcd8170SKalle Valo u8 buf_len; 364bdcd8170SKalle Valo u8 act_len; 365bdcd8170SKalle Valo enum htc_endpoint_id endpoint; 366bdcd8170SKalle Valo unsigned int len_max; 367bdcd8170SKalle Valo u8 resp_code; 368bdcd8170SKalle Valo }; 369bdcd8170SKalle Valo 370bdcd8170SKalle Valo /* endpoint distributionstructure */ 371bdcd8170SKalle Valo struct htc_endpoint_credit_dist { 372bdcd8170SKalle Valo struct list_head list; 373bdcd8170SKalle Valo 374bdcd8170SKalle Valo /* Service ID (set by HTC) */ 375bdcd8170SKalle Valo u16 svc_id; 376bdcd8170SKalle Valo 377bdcd8170SKalle Valo /* endpoint for this distributionstruct (set by HTC) */ 378bdcd8170SKalle Valo enum htc_endpoint_id endpoint; 379bdcd8170SKalle Valo 380bdcd8170SKalle Valo u32 dist_flags; 381bdcd8170SKalle Valo 382bdcd8170SKalle Valo /* 383bdcd8170SKalle Valo * credits for normal operation, anything above this 384bdcd8170SKalle Valo * indicates the endpoint is over-subscribed. 385bdcd8170SKalle Valo */ 386bdcd8170SKalle Valo int cred_norm; 387bdcd8170SKalle Valo 388bdcd8170SKalle Valo /* floor for credit distribution */ 389bdcd8170SKalle Valo int cred_min; 390bdcd8170SKalle Valo 391bdcd8170SKalle Valo int cred_assngd; 392bdcd8170SKalle Valo 393bdcd8170SKalle Valo /* current credits available */ 394bdcd8170SKalle Valo int credits; 395bdcd8170SKalle Valo 396bdcd8170SKalle Valo /* 397bdcd8170SKalle Valo * pending credits to distribute on this endpoint, this 398bdcd8170SKalle Valo * is set by HTC when credit reports arrive. The credit 399bdcd8170SKalle Valo * distribution functions sets this to zero when it distributes 400bdcd8170SKalle Valo * the credits. 401bdcd8170SKalle Valo */ 402bdcd8170SKalle Valo int cred_to_dist; 403bdcd8170SKalle Valo 404bdcd8170SKalle Valo /* 405bdcd8170SKalle Valo * the number of credits that the current pending TX packet needs 406bdcd8170SKalle Valo * to transmit. This is set by HTC when endpoint needs credits in 407bdcd8170SKalle Valo * order to transmit. 408bdcd8170SKalle Valo */ 409bdcd8170SKalle Valo int seek_cred; 410bdcd8170SKalle Valo 411bdcd8170SKalle Valo /* size in bytes of each credit */ 412bdcd8170SKalle Valo int cred_sz; 413bdcd8170SKalle Valo 414bdcd8170SKalle Valo /* credits required for a maximum sized messages */ 415bdcd8170SKalle Valo int cred_per_msg; 416bdcd8170SKalle Valo 417bdcd8170SKalle Valo /* reserved for HTC use */ 418e8c39790SKalle Valo struct htc_endpoint *htc_ep; 419bdcd8170SKalle Valo 420bdcd8170SKalle Valo /* 421bdcd8170SKalle Valo * current depth of TX queue , i.e. messages waiting for credits 422bdcd8170SKalle Valo * This field is valid only when HTC_CREDIT_DIST_ACTIVITY_CHANGE 423bdcd8170SKalle Valo * or HTC_CREDIT_DIST_SEND_COMPLETE is indicated on an endpoint 424bdcd8170SKalle Valo * that has non-zero credits to recover. 425bdcd8170SKalle Valo */ 426bdcd8170SKalle Valo int txq_depth; 427bdcd8170SKalle Valo }; 428bdcd8170SKalle Valo 429bdcd8170SKalle Valo /* 430bdcd8170SKalle Valo * credit distibution code that is passed into the distrbution function, 431bdcd8170SKalle Valo * there are mandatory and optional codes that must be handled 432bdcd8170SKalle Valo */ 433bdcd8170SKalle Valo enum htc_credit_dist_reason { 434bdcd8170SKalle Valo HTC_CREDIT_DIST_SEND_COMPLETE = 0, 435bdcd8170SKalle Valo HTC_CREDIT_DIST_ACTIVITY_CHANGE = 1, 436bdcd8170SKalle Valo HTC_CREDIT_DIST_SEEK_CREDITS, 437bdcd8170SKalle Valo }; 438bdcd8170SKalle Valo 4393c370398SKalle Valo struct ath6kl_htc_credit_info { 440bdcd8170SKalle Valo int total_avail_credits; 441bdcd8170SKalle Valo int cur_free_credits; 4423c370398SKalle Valo 4433c370398SKalle Valo /* list of lowest priority endpoints */ 444bdcd8170SKalle Valo struct list_head lowestpri_ep_dist; 445bdcd8170SKalle Valo }; 446bdcd8170SKalle Valo 447bdcd8170SKalle Valo /* endpoint statistics */ 448bdcd8170SKalle Valo struct htc_endpoint_stats { 449bdcd8170SKalle Valo /* 450bdcd8170SKalle Valo * number of times the host set the credit-low flag in a send 451bdcd8170SKalle Valo * message on this endpoint 452bdcd8170SKalle Valo */ 453bdcd8170SKalle Valo u32 cred_low_indicate; 454bdcd8170SKalle Valo 455bdcd8170SKalle Valo u32 tx_issued; 456bdcd8170SKalle Valo u32 tx_pkt_bundled; 457bdcd8170SKalle Valo u32 tx_bundles; 458bdcd8170SKalle Valo u32 tx_dropped; 459bdcd8170SKalle Valo 460bdcd8170SKalle Valo /* running count of total credit reports received for this endpoint */ 461bdcd8170SKalle Valo u32 tx_cred_rpt; 462bdcd8170SKalle Valo 463bdcd8170SKalle Valo /* credit reports received from this endpoint's RX packets */ 464bdcd8170SKalle Valo u32 cred_rpt_from_rx; 465bdcd8170SKalle Valo 466bdcd8170SKalle Valo /* credit reports received from RX packets of other endpoints */ 467bdcd8170SKalle Valo u32 cred_rpt_from_other; 468bdcd8170SKalle Valo 469bdcd8170SKalle Valo /* credit reports received from endpoint 0 RX packets */ 470bdcd8170SKalle Valo u32 cred_rpt_ep0; 471bdcd8170SKalle Valo 472bdcd8170SKalle Valo /* count of credits received via Rx packets on this endpoint */ 473bdcd8170SKalle Valo u32 cred_from_rx; 474bdcd8170SKalle Valo 475bdcd8170SKalle Valo /* count of credits received via another endpoint */ 476bdcd8170SKalle Valo u32 cred_from_other; 477bdcd8170SKalle Valo 478bdcd8170SKalle Valo /* count of credits received via another endpoint */ 479bdcd8170SKalle Valo u32 cred_from_ep0; 480bdcd8170SKalle Valo 481bdcd8170SKalle Valo /* count of consummed credits */ 482bdcd8170SKalle Valo u32 cred_cosumd; 483bdcd8170SKalle Valo 484bdcd8170SKalle Valo /* count of credits returned */ 485bdcd8170SKalle Valo u32 cred_retnd; 486bdcd8170SKalle Valo 487bdcd8170SKalle Valo u32 rx_pkts; 488bdcd8170SKalle Valo 489bdcd8170SKalle Valo /* count of lookahead records found in Rx msg */ 490bdcd8170SKalle Valo u32 rx_lkahds; 491bdcd8170SKalle Valo 492bdcd8170SKalle Valo /* count of recv packets received in a bundle */ 493bdcd8170SKalle Valo u32 rx_bundl; 494bdcd8170SKalle Valo 495bdcd8170SKalle Valo /* count of number of bundled lookaheads */ 496bdcd8170SKalle Valo u32 rx_bundle_lkahd; 497bdcd8170SKalle Valo 498bdcd8170SKalle Valo /* count of the number of bundle indications from the HTC header */ 499bdcd8170SKalle Valo u32 rx_bundle_from_hdr; 500bdcd8170SKalle Valo 501bdcd8170SKalle Valo /* the number of times the recv allocation threshold was hit */ 502bdcd8170SKalle Valo u32 rx_alloc_thresh_hit; 503bdcd8170SKalle Valo 504bdcd8170SKalle Valo /* total number of bytes */ 505bdcd8170SKalle Valo u32 rxalloc_thresh_byte; 506bdcd8170SKalle Valo }; 507bdcd8170SKalle Valo 508bdcd8170SKalle Valo struct htc_endpoint { 509bdcd8170SKalle Valo enum htc_endpoint_id eid; 510bdcd8170SKalle Valo u16 svc_id; 511bdcd8170SKalle Valo struct list_head txq; 512bdcd8170SKalle Valo struct list_head rx_bufq; 513bdcd8170SKalle Valo struct htc_endpoint_credit_dist cred_dist; 514bdcd8170SKalle Valo struct htc_ep_callbacks ep_cb; 515bdcd8170SKalle Valo int max_txq_depth; 516bdcd8170SKalle Valo int len_max; 517bdcd8170SKalle Valo int tx_proc_cnt; 518bdcd8170SKalle Valo int rx_proc_cnt; 519bdcd8170SKalle Valo struct htc_target *target; 520bdcd8170SKalle Valo u8 seqno; 521bdcd8170SKalle Valo u32 conn_flags; 522bdcd8170SKalle Valo struct htc_endpoint_stats ep_st; 5230ea10f2bSChilam Ng u16 tx_drop_packet_threshold; 524636f8288SKalle Valo 525636f8288SKalle Valo struct { 526636f8288SKalle Valo u8 pipeid_ul; 527636f8288SKalle Valo u8 pipeid_dl; 528636f8288SKalle Valo struct list_head tx_lookup_queue; 529636f8288SKalle Valo bool tx_credit_flow_enabled; 530636f8288SKalle Valo } pipe; 531bdcd8170SKalle Valo }; 532bdcd8170SKalle Valo 533bdcd8170SKalle Valo struct htc_control_buffer { 534bdcd8170SKalle Valo struct htc_packet packet; 535bdcd8170SKalle Valo u8 *buf; 536bdcd8170SKalle Valo }; 537bdcd8170SKalle Valo 538636f8288SKalle Valo struct htc_pipe_txcredit_alloc { 539636f8288SKalle Valo u16 service_id; 540636f8288SKalle Valo u8 credit_alloc; 541636f8288SKalle Valo }; 542636f8288SKalle Valo 543636f8288SKalle Valo enum htc_send_queue_result { 544636f8288SKalle Valo HTC_SEND_QUEUE_OK = 0, /* packet was queued */ 545636f8288SKalle Valo HTC_SEND_QUEUE_DROP = 1, /* this packet should be dropped */ 546636f8288SKalle Valo }; 547636f8288SKalle Valo 548e76ac2bfSKalle Valo struct ath6kl_htc_ops { 549e76ac2bfSKalle Valo void* (*create)(struct ath6kl *ar); 550e76ac2bfSKalle Valo int (*wait_target)(struct htc_target *target); 551e76ac2bfSKalle Valo int (*start)(struct htc_target *target); 552e76ac2bfSKalle Valo int (*conn_service)(struct htc_target *target, 553e76ac2bfSKalle Valo struct htc_service_connect_req *req, 554e76ac2bfSKalle Valo struct htc_service_connect_resp *resp); 555e76ac2bfSKalle Valo int (*tx)(struct htc_target *target, struct htc_packet *packet); 556e76ac2bfSKalle Valo void (*stop)(struct htc_target *target); 557e76ac2bfSKalle Valo void (*cleanup)(struct htc_target *target); 558e76ac2bfSKalle Valo void (*flush_txep)(struct htc_target *target, 559e76ac2bfSKalle Valo enum htc_endpoint_id endpoint, u16 tag); 560e76ac2bfSKalle Valo void (*flush_rx_buf)(struct htc_target *target); 561e76ac2bfSKalle Valo void (*activity_changed)(struct htc_target *target, 562e76ac2bfSKalle Valo enum htc_endpoint_id endpoint, 563e76ac2bfSKalle Valo bool active); 564e76ac2bfSKalle Valo int (*get_rxbuf_num)(struct htc_target *target, 565e76ac2bfSKalle Valo enum htc_endpoint_id endpoint); 566e76ac2bfSKalle Valo int (*add_rxbuf_multiple)(struct htc_target *target, 567e76ac2bfSKalle Valo struct list_head *pktq); 568e76ac2bfSKalle Valo int (*credit_setup)(struct htc_target *target, 569e76ac2bfSKalle Valo struct ath6kl_htc_credit_info *cred_info); 570e76ac2bfSKalle Valo int (*tx_complete)(struct ath6kl *ar, struct sk_buff *skb); 571e76ac2bfSKalle Valo int (*rx_complete)(struct ath6kl *ar, struct sk_buff *skb, u8 pipe); 572e76ac2bfSKalle Valo }; 573e76ac2bfSKalle Valo 574bdcd8170SKalle Valo struct ath6kl_device; 575bdcd8170SKalle Valo 576bdcd8170SKalle Valo /* our HTC target state */ 577bdcd8170SKalle Valo struct htc_target { 578bdcd8170SKalle Valo struct htc_endpoint endpoint[ENDPOINT_MAX]; 5793c370398SKalle Valo 5803c370398SKalle Valo /* contains struct htc_endpoint_credit_dist */ 581bdcd8170SKalle Valo struct list_head cred_dist_list; 5823c370398SKalle Valo 583bdcd8170SKalle Valo struct list_head free_ctrl_txbuf; 584bdcd8170SKalle Valo struct list_head free_ctrl_rxbuf; 5853c370398SKalle Valo struct ath6kl_htc_credit_info *credit_info; 586bdcd8170SKalle Valo int tgt_creds; 587bdcd8170SKalle Valo unsigned int tgt_cred_sz; 58812eb9444SKalle Valo 58912eb9444SKalle Valo /* protects free_ctrl_txbuf and free_ctrl_rxbuf */ 590bdcd8170SKalle Valo spinlock_t htc_lock; 59112eb9444SKalle Valo 59212eb9444SKalle Valo /* FIXME: does this protext rx_bufq and endpoint structures or what? */ 593bdcd8170SKalle Valo spinlock_t rx_lock; 59412eb9444SKalle Valo 59512eb9444SKalle Valo /* protects endpoint->txq */ 596bdcd8170SKalle Valo spinlock_t tx_lock; 59712eb9444SKalle Valo 598bdcd8170SKalle Valo struct ath6kl_device *dev; 599bdcd8170SKalle Valo u32 htc_flags; 600bdcd8170SKalle Valo u32 rx_st_flags; 601bdcd8170SKalle Valo enum htc_endpoint_id ep_waiting; 602bdcd8170SKalle Valo u8 htc_tgt_ver; 603bdcd8170SKalle Valo 604bdcd8170SKalle Valo /* max messages per bundle for HTC */ 605bdcd8170SKalle Valo int msg_per_bndl_max; 606bdcd8170SKalle Valo 607b29072ccSChilam Ng u32 tx_bndl_mask; 608bdcd8170SKalle Valo int rx_bndl_enable; 6093b2f5e51SVasanthakumar Thiagarajan int max_rx_bndl_sz; 6103b2f5e51SVasanthakumar Thiagarajan int max_tx_bndl_sz; 6115be8824fSVasanthakumar Thiagarajan 6125be8824fSVasanthakumar Thiagarajan u32 block_sz; 6135be8824fSVasanthakumar Thiagarajan u32 block_mask; 61450745af7SVasanthakumar Thiagarajan 61550745af7SVasanthakumar Thiagarajan int max_scat_entries; 61650745af7SVasanthakumar Thiagarajan int max_xfer_szper_scatreq; 617fcb82058SVasanthakumar Thiagarajan 618fcb82058SVasanthakumar Thiagarajan int chk_irq_status_cnt; 619b29072ccSChilam Ng 620b29072ccSChilam Ng /* counts the number of Tx without bundling continously per AC */ 621b29072ccSChilam Ng u32 ac_tx_count[WMM_NUM_AC]; 622636f8288SKalle Valo 623636f8288SKalle Valo struct { 624636f8288SKalle Valo struct htc_packet *htc_packet_pool; 625636f8288SKalle Valo u8 ctrl_response_buf[HTC_MAX_CTRL_MSG_LEN]; 626636f8288SKalle Valo int ctrl_response_len; 627636f8288SKalle Valo bool ctrl_response_valid; 628636f8288SKalle Valo struct htc_pipe_txcredit_alloc txcredit_alloc[ENDPOINT_MAX]; 629636f8288SKalle Valo } pipe; 630bdcd8170SKalle Valo }; 631bdcd8170SKalle Valo 632ad226ec2SKalle Valo int ath6kl_htc_rxmsg_pending_handler(struct htc_target *target, 6334533d901SVasanthakumar Thiagarajan u32 msg_look_ahead, int *n_pkts); 634bdcd8170SKalle Valo 635bdcd8170SKalle Valo static inline void set_htc_pkt_info(struct htc_packet *packet, void *context, 636bdcd8170SKalle Valo u8 *buf, unsigned int len, 637bdcd8170SKalle Valo enum htc_endpoint_id eid, u16 tag) 638bdcd8170SKalle Valo { 639bdcd8170SKalle Valo packet->pkt_cntxt = context; 640bdcd8170SKalle Valo packet->buf = buf; 641bdcd8170SKalle Valo packet->act_len = len; 642bdcd8170SKalle Valo packet->endpoint = eid; 643bdcd8170SKalle Valo packet->info.tx.tag = tag; 644bdcd8170SKalle Valo } 645bdcd8170SKalle Valo 646bdcd8170SKalle Valo static inline void htc_rxpkt_reset(struct htc_packet *packet) 647bdcd8170SKalle Valo { 648bdcd8170SKalle Valo packet->buf = packet->buf_start; 649bdcd8170SKalle Valo packet->act_len = 0; 650bdcd8170SKalle Valo } 651bdcd8170SKalle Valo 652bdcd8170SKalle Valo static inline void set_htc_rxpkt_info(struct htc_packet *packet, void *context, 653bdcd8170SKalle Valo u8 *buf, unsigned long len, 654bdcd8170SKalle Valo enum htc_endpoint_id eid) 655bdcd8170SKalle Valo { 656bdcd8170SKalle Valo packet->pkt_cntxt = context; 657bdcd8170SKalle Valo packet->buf = buf; 658bdcd8170SKalle Valo packet->buf_start = buf; 659bdcd8170SKalle Valo packet->buf_len = len; 660bdcd8170SKalle Valo packet->endpoint = eid; 661bdcd8170SKalle Valo } 662bdcd8170SKalle Valo 663bdcd8170SKalle Valo static inline int get_queue_depth(struct list_head *queue) 664bdcd8170SKalle Valo { 665bdcd8170SKalle Valo struct list_head *tmp_list; 666bdcd8170SKalle Valo int depth = 0; 667bdcd8170SKalle Valo 668bdcd8170SKalle Valo list_for_each(tmp_list, queue) 669bdcd8170SKalle Valo depth++; 670bdcd8170SKalle Valo 671bdcd8170SKalle Valo return depth; 672bdcd8170SKalle Valo } 673bdcd8170SKalle Valo 674636f8288SKalle Valo void ath6kl_htc_pipe_attach(struct ath6kl *ar); 675e76ac2bfSKalle Valo void ath6kl_htc_mbox_attach(struct ath6kl *ar); 676e76ac2bfSKalle Valo 677bdcd8170SKalle Valo #endif 678