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