ath/ath11k/htc.h

0001 /* SPDX-License-Identifier: BSD-3-Clause-Clear */
0002 /*
0003  * Copyright (c) 2018-2019 The Linux Foundation. All rights reserved.
0004  */
0005
0006 #ifndef ATH11K_HTC_H
0007 #define ATH11K_HTC_H
0008
0009 #include <linux/kernel.h>
0010 #include <linux/list.h>
0011 #include <linux/bug.h>
0012 #include <linux/skbuff.h>
0013 #include <linux/timer.h>
0014
0015 struct ath11k_base;
0016
0017 #define HTC_HDR_ENDPOINTID                       GENMASK(7, 0)
0018 #define HTC_HDR_FLAGS                            GENMASK(15, 8)
0019 #define HTC_HDR_PAYLOADLEN                       GENMASK(31, 16)
0020 #define HTC_HDR_CONTROLBYTES0                    GENMASK(7, 0)
0021 #define HTC_HDR_CONTROLBYTES1                    GENMASK(15, 8)
0022 #define HTC_HDR_RESERVED                         GENMASK(31, 16)
0023
0024 #define HTC_SVC_MSG_SERVICE_ID                   GENMASK(31, 16)
0025 #define HTC_SVC_MSG_CONNECTIONFLAGS              GENMASK(15, 0)
0026 #define HTC_SVC_MSG_SERVICEMETALENGTH            GENMASK(23, 16)
0027 #define HTC_READY_MSG_CREDITCOUNT                GENMASK(31, 16)
0028 #define HTC_READY_MSG_CREDITSIZE                 GENMASK(15, 0)
0029 #define HTC_READY_MSG_MAXENDPOINTS               GENMASK(23, 16)
0030
0031 #define HTC_READY_EX_MSG_HTCVERSION              GENMASK(7, 0)
0032 #define HTC_READY_EX_MSG_MAXMSGSPERHTCBUNDLE     GENMASK(15, 8)
0033
0034 #define HTC_SVC_RESP_MSG_SERVICEID           GENMASK(31, 16)
0035 #define HTC_SVC_RESP_MSG_STATUS              GENMASK(7, 0)
0036 #define HTC_SVC_RESP_MSG_ENDPOINTID          GENMASK(15, 8)
0037 #define HTC_SVC_RESP_MSG_MAXMSGSIZE          GENMASK(31, 16)
0038 #define HTC_SVC_RESP_MSG_SERVICEMETALENGTH   GENMASK(7, 0)
0039
0040 #define HTC_MSG_MESSAGEID                        GENMASK(15, 0)
0041 #define HTC_SETUP_COMPLETE_EX_MSG_SETUPFLAGS     GENMASK(31, 0)
0042 #define HTC_SETUP_COMPLETE_EX_MSG_MAXMSGSPERBUNDLEDRECV      GENMASK(7, 0)
0043 #define HTC_SETUP_COMPLETE_EX_MSG_RSVD0          GENMASK(15, 8)
0044 #define HTC_SETUP_COMPLETE_EX_MSG_RSVD1          GENMASK(23, 16)
0045 #define HTC_SETUP_COMPLETE_EX_MSG_RSVD2          GENMASK(31, 24)
0046
0047 enum ath11k_htc_tx_flags {
0048     ATH11K_HTC_FLAG_NEED_CREDIT_UPDATE = 0x01,
0049     ATH11K_HTC_FLAG_SEND_BUNDLE        = 0x02
0050 };
0051
0052 enum ath11k_htc_rx_flags {
0053     ATH11K_HTC_FLAG_TRAILER_PRESENT = 0x02,
0054     ATH11K_HTC_FLAG_BUNDLE_MASK     = 0xF0
0055 };
0056
0057 struct ath11k_htc_hdr {
0058     u32 htc_info;
0059     u32 ctrl_info;
0060 } __packed __aligned(4);
0061
0062 enum ath11k_htc_msg_id {
0063     ATH11K_HTC_MSG_READY_ID                = 1,
0064     ATH11K_HTC_MSG_CONNECT_SERVICE_ID      = 2,
0065     ATH11K_HTC_MSG_CONNECT_SERVICE_RESP_ID = 3,
0066     ATH11K_HTC_MSG_SETUP_COMPLETE_ID       = 4,
0067     ATH11K_HTC_MSG_SETUP_COMPLETE_EX_ID    = 5,
0068     ATH11K_HTC_MSG_SEND_SUSPEND_COMPLETE   = 6,
0069     ATH11K_HTC_MSG_NACK_SUSPEND        = 7,
0070     ATH11K_HTC_MSG_WAKEUP_FROM_SUSPEND_ID  = 8,
0071 };
0072
0073 enum ath11k_htc_version {
0074     ATH11K_HTC_VERSION_2P0 = 0x00, /* 2.0 */
0075     ATH11K_HTC_VERSION_2P1 = 0x01, /* 2.1 */
0076 };
0077
0078 #define ATH11K_HTC_CONN_FLAGS_THRESHOLD_LEVEL_MASK GENMASK(1, 0)
0079 #define ATH11K_HTC_CONN_FLAGS_RECV_ALLOC GENMASK(15, 8)
0080
0081 enum ath11k_htc_conn_flags {
0082     ATH11K_HTC_CONN_FLAGS_THRESHOLD_LEVEL_ONE_FOURTH    = 0x0,
0083     ATH11K_HTC_CONN_FLAGS_THRESHOLD_LEVEL_ONE_HALF      = 0x1,
0084     ATH11K_HTC_CONN_FLAGS_THRESHOLD_LEVEL_THREE_FOURTHS = 0x2,
0085     ATH11K_HTC_CONN_FLAGS_THRESHOLD_LEVEL_UNITY         = 0x3,
0086     ATH11K_HTC_CONN_FLAGS_REDUCE_CREDIT_DRIBBLE     = 0x4,
0087     ATH11K_HTC_CONN_FLAGS_DISABLE_CREDIT_FLOW_CTRL      = 0x8,
0088 };
0089
0090 enum ath11k_htc_conn_svc_status {
0091     ATH11K_HTC_CONN_SVC_STATUS_SUCCESS      = 0,
0092     ATH11K_HTC_CONN_SVC_STATUS_NOT_FOUND    = 1,
0093     ATH11K_HTC_CONN_SVC_STATUS_FAILED       = 2,
0094     ATH11K_HTC_CONN_SVC_STATUS_NO_RESOURCES = 3,
0095     ATH11K_HTC_CONN_SVC_STATUS_NO_MORE_EP   = 4
0096 };
0097
0098 struct ath11k_htc_ready {
0099     u32 id_credit_count;
0100     u32 size_ep;
0101 } __packed;
0102
0103 struct ath11k_htc_ready_extended {
0104     struct ath11k_htc_ready base;
0105     u32 ver_bundle;
0106 } __packed;
0107
0108 struct ath11k_htc_conn_svc {
0109     u32 msg_svc_id;
0110     u32 flags_len;
0111 } __packed;
0112
0113 struct ath11k_htc_conn_svc_resp {
0114     u32 msg_svc_id;
0115     u32 flags_len;
0116     u32 svc_meta_pad;
0117 } __packed;
0118
0119 #define ATH11K_GLOBAL_DISABLE_CREDIT_FLOW BIT(1)
0120
0121 struct ath11k_htc_setup_complete_extended {
0122     u32 msg_id;
0123     u32 flags;
0124     u32 max_msgs_per_bundled_recv;
0125 } __packed;
0126
0127 struct ath11k_htc_msg {
0128     u32 msg_svc_id;
0129     u32 flags_len;
0130 } __packed __aligned(4);
0131
0132 enum ath11k_htc_record_id {
0133     ATH11K_HTC_RECORD_NULL    = 0,
0134     ATH11K_HTC_RECORD_CREDITS = 1
0135 };
0136
0137 struct ath11k_htc_record_hdr {
0138     u8 id; /* @enum ath11k_htc_record_id */
0139     u8 len;
0140     u8 pad0;
0141     u8 pad1;
0142 } __packed;
0143
0144 struct ath11k_htc_credit_report {
0145     u8 eid; /* @enum ath11k_htc_ep_id */
0146     u8 credits;
0147     u8 pad0;
0148     u8 pad1;
0149 } __packed;
0150
0151 struct ath11k_htc_record {
0152     struct ath11k_htc_record_hdr hdr;
0153     union {
0154         struct ath11k_htc_credit_report credit_report[0];
0155         u8 pauload[0];
0156     };
0157 } __packed __aligned(4);
0158
0159 /* note: the trailer offset is dynamic depending
0160  * on payload length. this is only a struct layout draft
0161  */
0162 struct ath11k_htc_frame {
0163     struct ath11k_htc_hdr hdr;
0164     union {
0165         struct ath11k_htc_msg msg;
0166         u8 payload[0];
0167     };
0168     struct ath11k_htc_record trailer[0];
0169 } __packed __aligned(4);
0170
0171 enum ath11k_htc_svc_gid {
0172     ATH11K_HTC_SVC_GRP_RSVD = 0,
0173     ATH11K_HTC_SVC_GRP_WMI = 1,
0174     ATH11K_HTC_SVC_GRP_NMI = 2,
0175     ATH11K_HTC_SVC_GRP_HTT = 3,
0176     ATH11K_HTC_SVC_GRP_CFG = 4,
0177     ATH11K_HTC_SVC_GRP_IPA = 5,
0178     ATH11K_HTC_SVC_GRP_PKTLOG = 6,
0179
0180     ATH11K_HTC_SVC_GRP_TEST = 254,
0181     ATH11K_HTC_SVC_GRP_LAST = 255,
0182 };
0183
0184 #define SVC(group, idx) \
0185     (int)(((int)(group) << 8) | (int)(idx))
0186
0187 enum ath11k_htc_svc_id {
0188     /* NOTE: service ID of 0x0000 is reserved and should never be used */
0189     ATH11K_HTC_SVC_ID_RESERVED  = 0x0000,
0190     ATH11K_HTC_SVC_ID_UNUSED    = ATH11K_HTC_SVC_ID_RESERVED,
0191
0192     ATH11K_HTC_SVC_ID_RSVD_CTRL = SVC(ATH11K_HTC_SVC_GRP_RSVD, 1),
0193     ATH11K_HTC_SVC_ID_WMI_CONTROL   = SVC(ATH11K_HTC_SVC_GRP_WMI, 0),
0194     ATH11K_HTC_SVC_ID_WMI_DATA_BE   = SVC(ATH11K_HTC_SVC_GRP_WMI, 1),
0195     ATH11K_HTC_SVC_ID_WMI_DATA_BK   = SVC(ATH11K_HTC_SVC_GRP_WMI, 2),
0196     ATH11K_HTC_SVC_ID_WMI_DATA_VI   = SVC(ATH11K_HTC_SVC_GRP_WMI, 3),
0197     ATH11K_HTC_SVC_ID_WMI_DATA_VO   = SVC(ATH11K_HTC_SVC_GRP_WMI, 4),
0198     ATH11K_HTC_SVC_ID_WMI_CONTROL_MAC1 = SVC(ATH11K_HTC_SVC_GRP_WMI, 5),
0199     ATH11K_HTC_SVC_ID_WMI_CONTROL_MAC2 = SVC(ATH11K_HTC_SVC_GRP_WMI, 6),
0200
0201     ATH11K_HTC_SVC_ID_NMI_CONTROL   = SVC(ATH11K_HTC_SVC_GRP_NMI, 0),
0202     ATH11K_HTC_SVC_ID_NMI_DATA  = SVC(ATH11K_HTC_SVC_GRP_NMI, 1),
0203
0204     ATH11K_HTC_SVC_ID_HTT_DATA_MSG  = SVC(ATH11K_HTC_SVC_GRP_HTT, 0),
0205
0206     /* raw stream service (i.e. flash, tcmd, calibration apps) */
0207     ATH11K_HTC_SVC_ID_TEST_RAW_STREAMS = SVC(ATH11K_HTC_SVC_GRP_TEST, 0),
0208     ATH11K_HTC_SVC_ID_IPA_TX = SVC(ATH11K_HTC_SVC_GRP_IPA, 0),
0209     ATH11K_HTC_SVC_ID_PKT_LOG = SVC(ATH11K_HTC_SVC_GRP_PKTLOG, 0),
0210 };
0211
0212 #undef SVC
0213
0214 enum ath11k_htc_ep_id {
0215     ATH11K_HTC_EP_UNUSED = -1,
0216     ATH11K_HTC_EP_0 = 0,
0217     ATH11K_HTC_EP_1 = 1,
0218     ATH11K_HTC_EP_2,
0219     ATH11K_HTC_EP_3,
0220     ATH11K_HTC_EP_4,
0221     ATH11K_HTC_EP_5,
0222     ATH11K_HTC_EP_6,
0223     ATH11K_HTC_EP_7,
0224     ATH11K_HTC_EP_8,
0225     ATH11K_HTC_EP_COUNT,
0226 };
0227
0228 struct ath11k_htc_ep_ops {
0229     void (*ep_tx_complete)(struct ath11k_base *, struct sk_buff *);
0230     void (*ep_rx_complete)(struct ath11k_base *, struct sk_buff *);
0231     void (*ep_tx_credits)(struct ath11k_base *);
0232 };
0233
0234 /* service connection information */
0235 struct ath11k_htc_svc_conn_req {
0236     u16 service_id;
0237     struct ath11k_htc_ep_ops ep_ops;
0238     int max_send_queue_depth;
0239 };
0240
0241 /* service connection response information */
0242 struct ath11k_htc_svc_conn_resp {
0243     u8 buffer_len;
0244     u8 actual_len;
0245     enum ath11k_htc_ep_id eid;
0246     unsigned int max_msg_len;
0247     u8 connect_resp_code;
0248 };
0249
0250 #define ATH11K_NUM_CONTROL_TX_BUFFERS 2
0251 #define ATH11K_HTC_MAX_LEN 4096
0252 #define ATH11K_HTC_MAX_CTRL_MSG_LEN 256
0253 #define ATH11K_HTC_WAIT_TIMEOUT_HZ (1 * HZ)
0254 #define ATH11K_HTC_CONTROL_BUFFER_SIZE (ATH11K_HTC_MAX_CTRL_MSG_LEN + \
0255                     sizeof(struct ath11k_htc_hdr))
0256 #define ATH11K_HTC_CONN_SVC_TIMEOUT_HZ (1 * HZ)
0257 #define ATH11K_HTC_MAX_SERVICE_ALLOC_ENTRIES 8
0258
0259 struct ath11k_htc_ep {
0260     struct ath11k_htc *htc;
0261     enum ath11k_htc_ep_id eid;
0262     enum ath11k_htc_svc_id service_id;
0263     struct ath11k_htc_ep_ops ep_ops;
0264
0265     int max_tx_queue_depth;
0266     int max_ep_message_len;
0267     u8 ul_pipe_id;
0268     u8 dl_pipe_id;
0269
0270     u8 seq_no; /* for debugging */
0271     int tx_credits;
0272     bool tx_credit_flow_enabled;
0273 };
0274
0275 struct ath11k_htc_svc_tx_credits {
0276     u16 service_id;
0277     u8  credit_allocation;
0278 };
0279
0280 struct ath11k_htc {
0281     struct ath11k_base *ab;
0282     struct ath11k_htc_ep endpoint[ATH11K_HTC_EP_COUNT];
0283
0284     /* protects endpoints */
0285     spinlock_t tx_lock;
0286
0287     u8 control_resp_buffer[ATH11K_HTC_MAX_CTRL_MSG_LEN];
0288     int control_resp_len;
0289
0290     struct completion ctl_resp;
0291
0292     int total_transmit_credits;
0293     struct ath11k_htc_svc_tx_credits
0294         service_alloc_table[ATH11K_HTC_MAX_SERVICE_ALLOC_ENTRIES];
0295     int target_credit_size;
0296     u8 wmi_ep_count;
0297 };
0298
0299 int ath11k_htc_init(struct ath11k_base *ar);
0300 int ath11k_htc_wait_target(struct ath11k_htc *htc);
0301 int ath11k_htc_start(struct ath11k_htc *htc);
0302 int ath11k_htc_connect_service(struct ath11k_htc *htc,
0303                    struct ath11k_htc_svc_conn_req  *conn_req,
0304                    struct ath11k_htc_svc_conn_resp *conn_resp);
0305 int ath11k_htc_send(struct ath11k_htc *htc, enum ath11k_htc_ep_id eid,
0306             struct sk_buff *packet);
0307 struct sk_buff *ath11k_htc_alloc_skb(struct ath11k_base *ar, int size);
0308 void ath11k_htc_rx_completion_handler(struct ath11k_base *ar,
0309                       struct sk_buff *skb);
0310 void ath11k_htc_tx_completion_handler(struct ath11k_base *ab,
0311                       struct sk_buff *skb);
0312 #endif