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