1d5c65159SKalle Valo /* SPDX-License-Identifier: BSD-3-Clause-Clear */ 2d5c65159SKalle Valo /* 3d5c65159SKalle Valo * Copyright (c) 2018-2019 The Linux Foundation. All rights reserved. 4d5c65159SKalle Valo */ 5d5c65159SKalle Valo 6d5c65159SKalle Valo #ifndef ATH11K_HTC_H 7d5c65159SKalle Valo #define ATH11K_HTC_H 8d5c65159SKalle Valo 9d5c65159SKalle Valo #include <linux/kernel.h> 10d5c65159SKalle Valo #include <linux/list.h> 11d5c65159SKalle Valo #include <linux/bug.h> 12d5c65159SKalle Valo #include <linux/skbuff.h> 13d5c65159SKalle Valo #include <linux/timer.h> 14d5c65159SKalle Valo 15d5c65159SKalle Valo struct ath11k_base; 16d5c65159SKalle Valo 17d5c65159SKalle Valo #define HTC_HDR_ENDPOINTID GENMASK(7, 0) 18d5c65159SKalle Valo #define HTC_HDR_FLAGS GENMASK(15, 8) 19d5c65159SKalle Valo #define HTC_HDR_PAYLOADLEN GENMASK(31, 16) 20d5c65159SKalle Valo #define HTC_HDR_CONTROLBYTES0 GENMASK(7, 0) 21d5c65159SKalle Valo #define HTC_HDR_CONTROLBYTES1 GENMASK(15, 8) 22d5c65159SKalle Valo #define HTC_HDR_RESERVED GENMASK(31, 16) 23d5c65159SKalle Valo 24d5c65159SKalle Valo #define HTC_SVC_MSG_SERVICE_ID GENMASK(31, 16) 25d5c65159SKalle Valo #define HTC_SVC_MSG_CONNECTIONFLAGS GENMASK(15, 0) 26d5c65159SKalle Valo #define HTC_SVC_MSG_SERVICEMETALENGTH GENMASK(23, 16) 27d5c65159SKalle Valo #define HTC_READY_MSG_CREDITCOUNT GENMASK(31, 16) 28d5c65159SKalle Valo #define HTC_READY_MSG_CREDITSIZE GENMASK(15, 0) 29d5c65159SKalle Valo #define HTC_READY_MSG_MAXENDPOINTS GENMASK(23, 16) 30d5c65159SKalle Valo 31d5c65159SKalle Valo #define HTC_READY_EX_MSG_HTCVERSION GENMASK(7, 0) 32d5c65159SKalle Valo #define HTC_READY_EX_MSG_MAXMSGSPERHTCBUNDLE GENMASK(15, 8) 33d5c65159SKalle Valo 34d5c65159SKalle Valo #define HTC_SVC_RESP_MSG_SERVICEID GENMASK(31, 16) 35d5c65159SKalle Valo #define HTC_SVC_RESP_MSG_STATUS GENMASK(7, 0) 36d5c65159SKalle Valo #define HTC_SVC_RESP_MSG_ENDPOINTID GENMASK(15, 8) 37d5c65159SKalle Valo #define HTC_SVC_RESP_MSG_MAXMSGSIZE GENMASK(31, 16) 38d5c65159SKalle Valo #define HTC_SVC_RESP_MSG_SERVICEMETALENGTH GENMASK(7, 0) 39d5c65159SKalle Valo 40d5c65159SKalle Valo #define HTC_MSG_MESSAGEID GENMASK(15, 0) 41d5c65159SKalle Valo #define HTC_SETUP_COMPLETE_EX_MSG_SETUPFLAGS GENMASK(31, 0) 42d5c65159SKalle Valo #define HTC_SETUP_COMPLETE_EX_MSG_MAXMSGSPERBUNDLEDRECV GENMASK(7, 0) 43d5c65159SKalle Valo #define HTC_SETUP_COMPLETE_EX_MSG_RSVD0 GENMASK(15, 8) 44d5c65159SKalle Valo #define HTC_SETUP_COMPLETE_EX_MSG_RSVD1 GENMASK(23, 16) 45d5c65159SKalle Valo #define HTC_SETUP_COMPLETE_EX_MSG_RSVD2 GENMASK(31, 24) 46d5c65159SKalle Valo 47d5c65159SKalle Valo enum ath11k_htc_tx_flags { 48d5c65159SKalle Valo ATH11K_HTC_FLAG_NEED_CREDIT_UPDATE = 0x01, 49d5c65159SKalle Valo ATH11K_HTC_FLAG_SEND_BUNDLE = 0x02 50d5c65159SKalle Valo }; 51d5c65159SKalle Valo 52d5c65159SKalle Valo enum ath11k_htc_rx_flags { 53d5c65159SKalle Valo ATH11K_HTC_FLAG_TRAILER_PRESENT = 0x02, 54d5c65159SKalle Valo ATH11K_HTC_FLAG_BUNDLE_MASK = 0xF0 55d5c65159SKalle Valo }; 56d5c65159SKalle Valo 57d5c65159SKalle Valo struct ath11k_htc_hdr { 58d5c65159SKalle Valo u32 htc_info; 59d5c65159SKalle Valo u32 ctrl_info; 60d5c65159SKalle Valo } __packed __aligned(4); 61d5c65159SKalle Valo 62d5c65159SKalle Valo enum ath11k_htc_msg_id { 63d5c65159SKalle Valo ATH11K_HTC_MSG_READY_ID = 1, 64d5c65159SKalle Valo ATH11K_HTC_MSG_CONNECT_SERVICE_ID = 2, 65d5c65159SKalle Valo ATH11K_HTC_MSG_CONNECT_SERVICE_RESP_ID = 3, 66d5c65159SKalle Valo ATH11K_HTC_MSG_SETUP_COMPLETE_ID = 4, 67d5c65159SKalle Valo ATH11K_HTC_MSG_SETUP_COMPLETE_EX_ID = 5, 688733d835SCarl Huang ATH11K_HTC_MSG_SEND_SUSPEND_COMPLETE = 6, 698733d835SCarl Huang ATH11K_HTC_MSG_NACK_SUSPEND = 7, 708733d835SCarl Huang ATH11K_HTC_MSG_WAKEUP_FROM_SUSPEND_ID = 8, 71d5c65159SKalle Valo }; 72d5c65159SKalle Valo 73d5c65159SKalle Valo enum ath11k_htc_version { 74d5c65159SKalle Valo ATH11K_HTC_VERSION_2P0 = 0x00, /* 2.0 */ 75d5c65159SKalle Valo ATH11K_HTC_VERSION_2P1 = 0x01, /* 2.1 */ 76d5c65159SKalle Valo }; 77d5c65159SKalle Valo 78d5c65159SKalle Valo #define ATH11K_HTC_CONN_FLAGS_THRESHOLD_LEVEL_MASK GENMASK(1, 0) 79d5c65159SKalle Valo #define ATH11K_HTC_CONN_FLAGS_RECV_ALLOC GENMASK(15, 8) 80d5c65159SKalle Valo 81d5c65159SKalle Valo enum ath11k_htc_conn_flags { 82d5c65159SKalle Valo ATH11K_HTC_CONN_FLAGS_THRESHOLD_LEVEL_ONE_FOURTH = 0x0, 83d5c65159SKalle Valo ATH11K_HTC_CONN_FLAGS_THRESHOLD_LEVEL_ONE_HALF = 0x1, 84d5c65159SKalle Valo ATH11K_HTC_CONN_FLAGS_THRESHOLD_LEVEL_THREE_FOURTHS = 0x2, 85d5c65159SKalle Valo ATH11K_HTC_CONN_FLAGS_THRESHOLD_LEVEL_UNITY = 0x3, 86*f951380aSP Praneesh ATH11K_HTC_CONN_FLAGS_REDUCE_CREDIT_DRIBBLE = 0x4, 87*f951380aSP Praneesh ATH11K_HTC_CONN_FLAGS_DISABLE_CREDIT_FLOW_CTRL = 0x8, 88d5c65159SKalle Valo }; 89d5c65159SKalle Valo 90d5c65159SKalle Valo enum ath11k_htc_conn_svc_status { 91d5c65159SKalle Valo ATH11K_HTC_CONN_SVC_STATUS_SUCCESS = 0, 92d5c65159SKalle Valo ATH11K_HTC_CONN_SVC_STATUS_NOT_FOUND = 1, 93d5c65159SKalle Valo ATH11K_HTC_CONN_SVC_STATUS_FAILED = 2, 94d5c65159SKalle Valo ATH11K_HTC_CONN_SVC_STATUS_NO_RESOURCES = 3, 95d5c65159SKalle Valo ATH11K_HTC_CONN_SVC_STATUS_NO_MORE_EP = 4 96d5c65159SKalle Valo }; 97d5c65159SKalle Valo 98d5c65159SKalle Valo struct ath11k_htc_ready { 99d5c65159SKalle Valo u32 id_credit_count; 100d5c65159SKalle Valo u32 size_ep; 101d5c65159SKalle Valo } __packed; 102d5c65159SKalle Valo 103d5c65159SKalle Valo struct ath11k_htc_ready_extended { 104d5c65159SKalle Valo struct ath11k_htc_ready base; 105d5c65159SKalle Valo u32 ver_bundle; 106d5c65159SKalle Valo } __packed; 107d5c65159SKalle Valo 108d5c65159SKalle Valo struct ath11k_htc_conn_svc { 109d5c65159SKalle Valo u32 msg_svc_id; 110d5c65159SKalle Valo u32 flags_len; 111d5c65159SKalle Valo } __packed; 112d5c65159SKalle Valo 113d5c65159SKalle Valo struct ath11k_htc_conn_svc_resp { 114d5c65159SKalle Valo u32 msg_svc_id; 115d5c65159SKalle Valo u32 flags_len; 116d5c65159SKalle Valo u32 svc_meta_pad; 117d5c65159SKalle Valo } __packed; 118d5c65159SKalle Valo 119*f951380aSP Praneesh #define ATH11K_GLOBAL_DISABLE_CREDIT_FLOW BIT(1) 120*f951380aSP Praneesh 121d5c65159SKalle Valo struct ath11k_htc_setup_complete_extended { 122d5c65159SKalle Valo u32 msg_id; 123d5c65159SKalle Valo u32 flags; 124d5c65159SKalle Valo u32 max_msgs_per_bundled_recv; 125d5c65159SKalle Valo } __packed; 126d5c65159SKalle Valo 127d5c65159SKalle Valo struct ath11k_htc_msg { 128d5c65159SKalle Valo u32 msg_svc_id; 129d5c65159SKalle Valo u32 flags_len; 130d5c65159SKalle Valo } __packed __aligned(4); 131d5c65159SKalle Valo 132d5c65159SKalle Valo enum ath11k_htc_record_id { 133d5c65159SKalle Valo ATH11K_HTC_RECORD_NULL = 0, 134d5c65159SKalle Valo ATH11K_HTC_RECORD_CREDITS = 1 135d5c65159SKalle Valo }; 136d5c65159SKalle Valo 137d5c65159SKalle Valo struct ath11k_htc_record_hdr { 138d5c65159SKalle Valo u8 id; /* @enum ath11k_htc_record_id */ 139d5c65159SKalle Valo u8 len; 140d5c65159SKalle Valo u8 pad0; 141d5c65159SKalle Valo u8 pad1; 142d5c65159SKalle Valo } __packed; 143d5c65159SKalle Valo 144d5c65159SKalle Valo struct ath11k_htc_credit_report { 145d5c65159SKalle Valo u8 eid; /* @enum ath11k_htc_ep_id */ 146d5c65159SKalle Valo u8 credits; 147d5c65159SKalle Valo u8 pad0; 148d5c65159SKalle Valo u8 pad1; 149d5c65159SKalle Valo } __packed; 150d5c65159SKalle Valo 151d5c65159SKalle Valo struct ath11k_htc_record { 152d5c65159SKalle Valo struct ath11k_htc_record_hdr hdr; 153d5c65159SKalle Valo union { 154d5c65159SKalle Valo struct ath11k_htc_credit_report credit_report[0]; 155d5c65159SKalle Valo u8 pauload[0]; 156d5c65159SKalle Valo }; 157d5c65159SKalle Valo } __packed __aligned(4); 158d5c65159SKalle Valo 159d5c65159SKalle Valo /* note: the trailer offset is dynamic depending 160d5c65159SKalle Valo * on payload length. this is only a struct layout draft 161d5c65159SKalle Valo */ 162d5c65159SKalle Valo struct ath11k_htc_frame { 163d5c65159SKalle Valo struct ath11k_htc_hdr hdr; 164d5c65159SKalle Valo union { 165d5c65159SKalle Valo struct ath11k_htc_msg msg; 166d5c65159SKalle Valo u8 payload[0]; 167d5c65159SKalle Valo }; 168d5c65159SKalle Valo struct ath11k_htc_record trailer[0]; 169d5c65159SKalle Valo } __packed __aligned(4); 170d5c65159SKalle Valo 171d5c65159SKalle Valo enum ath11k_htc_svc_gid { 172d5c65159SKalle Valo ATH11K_HTC_SVC_GRP_RSVD = 0, 173d5c65159SKalle Valo ATH11K_HTC_SVC_GRP_WMI = 1, 174d5c65159SKalle Valo ATH11K_HTC_SVC_GRP_NMI = 2, 175d5c65159SKalle Valo ATH11K_HTC_SVC_GRP_HTT = 3, 176d5c65159SKalle Valo ATH11K_HTC_SVC_GRP_CFG = 4, 177d5c65159SKalle Valo ATH11K_HTC_SVC_GRP_IPA = 5, 178d5c65159SKalle Valo ATH11K_HTC_SVC_GRP_PKTLOG = 6, 179d5c65159SKalle Valo 180d5c65159SKalle Valo ATH11K_HTC_SVC_GRP_TEST = 254, 181d5c65159SKalle Valo ATH11K_HTC_SVC_GRP_LAST = 255, 182d5c65159SKalle Valo }; 183d5c65159SKalle Valo 184d5c65159SKalle Valo #define SVC(group, idx) \ 185d5c65159SKalle Valo (int)(((int)(group) << 8) | (int)(idx)) 186d5c65159SKalle Valo 187d5c65159SKalle Valo enum ath11k_htc_svc_id { 188d5c65159SKalle Valo /* NOTE: service ID of 0x0000 is reserved and should never be used */ 189d5c65159SKalle Valo ATH11K_HTC_SVC_ID_RESERVED = 0x0000, 190d5c65159SKalle Valo ATH11K_HTC_SVC_ID_UNUSED = ATH11K_HTC_SVC_ID_RESERVED, 191d5c65159SKalle Valo 192d5c65159SKalle Valo ATH11K_HTC_SVC_ID_RSVD_CTRL = SVC(ATH11K_HTC_SVC_GRP_RSVD, 1), 193d5c65159SKalle Valo ATH11K_HTC_SVC_ID_WMI_CONTROL = SVC(ATH11K_HTC_SVC_GRP_WMI, 0), 194d5c65159SKalle Valo ATH11K_HTC_SVC_ID_WMI_DATA_BE = SVC(ATH11K_HTC_SVC_GRP_WMI, 1), 195d5c65159SKalle Valo ATH11K_HTC_SVC_ID_WMI_DATA_BK = SVC(ATH11K_HTC_SVC_GRP_WMI, 2), 196d5c65159SKalle Valo ATH11K_HTC_SVC_ID_WMI_DATA_VI = SVC(ATH11K_HTC_SVC_GRP_WMI, 3), 197d5c65159SKalle Valo ATH11K_HTC_SVC_ID_WMI_DATA_VO = SVC(ATH11K_HTC_SVC_GRP_WMI, 4), 198d5c65159SKalle Valo ATH11K_HTC_SVC_ID_WMI_CONTROL_MAC1 = SVC(ATH11K_HTC_SVC_GRP_WMI, 5), 199d5c65159SKalle Valo ATH11K_HTC_SVC_ID_WMI_CONTROL_MAC2 = SVC(ATH11K_HTC_SVC_GRP_WMI, 6), 200d5c65159SKalle Valo 201d5c65159SKalle Valo ATH11K_HTC_SVC_ID_NMI_CONTROL = SVC(ATH11K_HTC_SVC_GRP_NMI, 0), 202d5c65159SKalle Valo ATH11K_HTC_SVC_ID_NMI_DATA = SVC(ATH11K_HTC_SVC_GRP_NMI, 1), 203d5c65159SKalle Valo 204d5c65159SKalle Valo ATH11K_HTC_SVC_ID_HTT_DATA_MSG = SVC(ATH11K_HTC_SVC_GRP_HTT, 0), 205d5c65159SKalle Valo 206d5c65159SKalle Valo /* raw stream service (i.e. flash, tcmd, calibration apps) */ 207d5c65159SKalle Valo ATH11K_HTC_SVC_ID_TEST_RAW_STREAMS = SVC(ATH11K_HTC_SVC_GRP_TEST, 0), 208d5c65159SKalle Valo ATH11K_HTC_SVC_ID_IPA_TX = SVC(ATH11K_HTC_SVC_GRP_IPA, 0), 209d5c65159SKalle Valo ATH11K_HTC_SVC_ID_PKT_LOG = SVC(ATH11K_HTC_SVC_GRP_PKTLOG, 0), 210d5c65159SKalle Valo }; 211d5c65159SKalle Valo 212d5c65159SKalle Valo #undef SVC 213d5c65159SKalle Valo 214d5c65159SKalle Valo enum ath11k_htc_ep_id { 215d5c65159SKalle Valo ATH11K_HTC_EP_UNUSED = -1, 216d5c65159SKalle Valo ATH11K_HTC_EP_0 = 0, 217d5c65159SKalle Valo ATH11K_HTC_EP_1 = 1, 218d5c65159SKalle Valo ATH11K_HTC_EP_2, 219d5c65159SKalle Valo ATH11K_HTC_EP_3, 220d5c65159SKalle Valo ATH11K_HTC_EP_4, 221d5c65159SKalle Valo ATH11K_HTC_EP_5, 222d5c65159SKalle Valo ATH11K_HTC_EP_6, 223d5c65159SKalle Valo ATH11K_HTC_EP_7, 224d5c65159SKalle Valo ATH11K_HTC_EP_8, 225d5c65159SKalle Valo ATH11K_HTC_EP_COUNT, 226d5c65159SKalle Valo }; 227d5c65159SKalle Valo 228d5c65159SKalle Valo struct ath11k_htc_ep_ops { 229d5c65159SKalle Valo void (*ep_tx_complete)(struct ath11k_base *, struct sk_buff *); 230d5c65159SKalle Valo void (*ep_rx_complete)(struct ath11k_base *, struct sk_buff *); 231d5c65159SKalle Valo void (*ep_tx_credits)(struct ath11k_base *); 232d5c65159SKalle Valo }; 233d5c65159SKalle Valo 234d5c65159SKalle Valo /* service connection information */ 235d5c65159SKalle Valo struct ath11k_htc_svc_conn_req { 236d5c65159SKalle Valo u16 service_id; 237d5c65159SKalle Valo struct ath11k_htc_ep_ops ep_ops; 238d5c65159SKalle Valo int max_send_queue_depth; 239d5c65159SKalle Valo }; 240d5c65159SKalle Valo 241d5c65159SKalle Valo /* service connection response information */ 242d5c65159SKalle Valo struct ath11k_htc_svc_conn_resp { 243d5c65159SKalle Valo u8 buffer_len; 244d5c65159SKalle Valo u8 actual_len; 245d5c65159SKalle Valo enum ath11k_htc_ep_id eid; 246d5c65159SKalle Valo unsigned int max_msg_len; 247d5c65159SKalle Valo u8 connect_resp_code; 248d5c65159SKalle Valo }; 249d5c65159SKalle Valo 250d5c65159SKalle Valo #define ATH11K_NUM_CONTROL_TX_BUFFERS 2 251d5c65159SKalle Valo #define ATH11K_HTC_MAX_LEN 4096 252d5c65159SKalle Valo #define ATH11K_HTC_MAX_CTRL_MSG_LEN 256 253d5c65159SKalle Valo #define ATH11K_HTC_WAIT_TIMEOUT_HZ (1 * HZ) 254d5c65159SKalle Valo #define ATH11K_HTC_CONTROL_BUFFER_SIZE (ATH11K_HTC_MAX_CTRL_MSG_LEN + \ 255d5c65159SKalle Valo sizeof(struct ath11k_htc_hdr)) 256d5c65159SKalle Valo #define ATH11K_HTC_CONN_SVC_TIMEOUT_HZ (1 * HZ) 257d5c65159SKalle Valo #define ATH11K_HTC_MAX_SERVICE_ALLOC_ENTRIES 8 258d5c65159SKalle Valo 259d5c65159SKalle Valo struct ath11k_htc_ep { 260d5c65159SKalle Valo struct ath11k_htc *htc; 261d5c65159SKalle Valo enum ath11k_htc_ep_id eid; 262d5c65159SKalle Valo enum ath11k_htc_svc_id service_id; 263d5c65159SKalle Valo struct ath11k_htc_ep_ops ep_ops; 264d5c65159SKalle Valo 265d5c65159SKalle Valo int max_tx_queue_depth; 266d5c65159SKalle Valo int max_ep_message_len; 267d5c65159SKalle Valo u8 ul_pipe_id; 268d5c65159SKalle Valo u8 dl_pipe_id; 269d5c65159SKalle Valo 270d5c65159SKalle Valo u8 seq_no; /* for debugging */ 271d5c65159SKalle Valo int tx_credits; 272d5c65159SKalle Valo bool tx_credit_flow_enabled; 273d5c65159SKalle Valo }; 274d5c65159SKalle Valo 275d5c65159SKalle Valo struct ath11k_htc_svc_tx_credits { 276d5c65159SKalle Valo u16 service_id; 277d5c65159SKalle Valo u8 credit_allocation; 278d5c65159SKalle Valo }; 279d5c65159SKalle Valo 280d5c65159SKalle Valo struct ath11k_htc { 281d5c65159SKalle Valo struct ath11k_base *ab; 282d5c65159SKalle Valo struct ath11k_htc_ep endpoint[ATH11K_HTC_EP_COUNT]; 283d5c65159SKalle Valo 284d5c65159SKalle Valo /* protects endpoints */ 285d5c65159SKalle Valo spinlock_t tx_lock; 286d5c65159SKalle Valo 287d5c65159SKalle Valo u8 control_resp_buffer[ATH11K_HTC_MAX_CTRL_MSG_LEN]; 288d5c65159SKalle Valo int control_resp_len; 289d5c65159SKalle Valo 290d5c65159SKalle Valo struct completion ctl_resp; 291d5c65159SKalle Valo 292d5c65159SKalle Valo int total_transmit_credits; 293d5c65159SKalle Valo struct ath11k_htc_svc_tx_credits 294d5c65159SKalle Valo service_alloc_table[ATH11K_HTC_MAX_SERVICE_ALLOC_ENTRIES]; 295d5c65159SKalle Valo int target_credit_size; 296d5c65159SKalle Valo u8 wmi_ep_count; 297d5c65159SKalle Valo }; 298d5c65159SKalle Valo 299d5c65159SKalle Valo int ath11k_htc_init(struct ath11k_base *ar); 300d5c65159SKalle Valo int ath11k_htc_wait_target(struct ath11k_htc *htc); 301d5c65159SKalle Valo int ath11k_htc_start(struct ath11k_htc *htc); 302d5c65159SKalle Valo int ath11k_htc_connect_service(struct ath11k_htc *htc, 303d5c65159SKalle Valo struct ath11k_htc_svc_conn_req *conn_req, 304d5c65159SKalle Valo struct ath11k_htc_svc_conn_resp *conn_resp); 305d5c65159SKalle Valo int ath11k_htc_send(struct ath11k_htc *htc, enum ath11k_htc_ep_id eid, 306d5c65159SKalle Valo struct sk_buff *packet); 307d5c65159SKalle Valo struct sk_buff *ath11k_htc_alloc_skb(struct ath11k_base *ar, int size); 308d5c65159SKalle Valo void ath11k_htc_rx_completion_handler(struct ath11k_base *ar, 309d5c65159SKalle Valo struct sk_buff *skb); 310*f951380aSP Praneesh void ath11k_htc_tx_completion_handler(struct ath11k_base *ab, 311*f951380aSP Praneesh struct sk_buff *skb); 312d5c65159SKalle Valo #endif 313