drivers/net/wireless/ath/ath10k/htc.h

   1 /*
   2  * Copyright (c) 2005-2011 Atheros Communications Inc.
   3  * Copyright (c) 2011-2016 Qualcomm Atheros, Inc.
   4  *
   5  * Permission to use, copy, modify, and/or distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 #ifndef _HTC_H_
  19 #define _HTC_H_
  20
  21 #include <linux/kernel.h>
  22 #include <linux/list.h>
  23 #include <linux/bug.h>
  24 #include <linux/skbuff.h>
  25 #include <linux/timer.h>
  26
  27 struct ath10k;
  28
  29 /****************/
  30 /* HTC protocol */
  31 /****************/
  32
  33 /*
  34  * HTC - host-target control protocol
  35  *
  36  * tx packets are generally <htc_hdr><payload>
  37  * rx packets are more complex: <htc_hdr><payload><trailer>
  38  *
  39  * The payload + trailer length is stored in len.
  40  * To get payload-only length one needs to payload - trailer_len.
  41  *
  42  * Trailer contains (possibly) multiple <htc_record>.
  43  * Each record is a id-len-value.
  44  *
  45  * HTC header flags, control_byte0, control_byte1
  46  * have different meaning depending whether its tx
  47  * or rx.
  48  *
  49  * Alignment: htc_hdr, payload and trailer are
  50  * 4-byte aligned.
  51  */
  52
  53 #define HTC_HOST_MAX_MSG_PER_RX_BUNDLE        8
  54
  55 enum ath10k_htc_tx_flags {
  56         ATH10K_HTC_FLAG_NEED_CREDIT_UPDATE = 0x01,
  57         ATH10K_HTC_FLAG_SEND_BUNDLE        = 0x02
  58 };
  59
  60 enum ath10k_htc_rx_flags {
  61         ATH10K_HTC_FLAGS_RECV_1MORE_BLOCK = 0x01,
  62         ATH10K_HTC_FLAG_TRAILER_PRESENT = 0x02,
  63         ATH10K_HTC_FLAG_BUNDLE_MASK     = 0xF0
  64 };
  65
  66 struct ath10k_htc_hdr {
  67         u8 eid; /* @enum ath10k_htc_ep_id */
  68         u8 flags; /* @enum ath10k_htc_tx_flags, ath10k_htc_rx_flags */
  69         __le16 len;
  70         union {
  71                 u8 trailer_len; /* for rx */
  72                 u8 control_byte0;
  73         } __packed;
  74         union {
  75                 u8 seq_no; /* for tx */
  76                 u8 control_byte1;
  77         } __packed;
  78         u8 pad0;
  79         u8 pad1;
  80 } __packed __aligned(4);
  81
  82 enum ath10k_ath10k_htc_msg_id {
  83         ATH10K_HTC_MSG_READY_ID                = 1,
  84         ATH10K_HTC_MSG_CONNECT_SERVICE_ID      = 2,
  85         ATH10K_HTC_MSG_CONNECT_SERVICE_RESP_ID = 3,
  86         ATH10K_HTC_MSG_SETUP_COMPLETE_ID       = 4,
  87         ATH10K_HTC_MSG_SETUP_COMPLETE_EX_ID    = 5,
  88         ATH10K_HTC_MSG_SEND_SUSPEND_COMPLETE   = 6
  89 };
  90
  91 enum ath10k_htc_version {
  92         ATH10K_HTC_VERSION_2P0 = 0x00, /* 2.0 */
  93         ATH10K_HTC_VERSION_2P1 = 0x01, /* 2.1 */
  94 };
  95
  96 enum ath10k_htc_conn_flags {
  97         ATH10K_HTC_CONN_FLAGS_THRESHOLD_LEVEL_ONE_FOURTH    = 0x0,
  98         ATH10K_HTC_CONN_FLAGS_THRESHOLD_LEVEL_ONE_HALF      = 0x1,
  99         ATH10K_HTC_CONN_FLAGS_THRESHOLD_LEVEL_THREE_FOURTHS = 0x2,
 100         ATH10K_HTC_CONN_FLAGS_THRESHOLD_LEVEL_UNITY         = 0x3,
 101 #define ATH10K_HTC_CONN_FLAGS_THRESHOLD_LEVEL_MASK 0x3
 102         ATH10K_HTC_CONN_FLAGS_REDUCE_CREDIT_DRIBBLE    = 1 << 2,
 103         ATH10K_HTC_CONN_FLAGS_DISABLE_CREDIT_FLOW_CTRL = 1 << 3
 104 #define ATH10K_HTC_CONN_FLAGS_RECV_ALLOC_MASK 0xFF00
 105 #define ATH10K_HTC_CONN_FLAGS_RECV_ALLOC_LSB  8
 106 };
 107
 108 enum ath10k_htc_conn_svc_status {
 109         ATH10K_HTC_CONN_SVC_STATUS_SUCCESS      = 0,
 110         ATH10K_HTC_CONN_SVC_STATUS_NOT_FOUND    = 1,
 111         ATH10K_HTC_CONN_SVC_STATUS_FAILED       = 2,
 112         ATH10K_HTC_CONN_SVC_STATUS_NO_RESOURCES = 3,
 113         ATH10K_HTC_CONN_SVC_STATUS_NO_MORE_EP   = 4
 114 };
 115
 116 enum ath10k_htc_setup_complete_flags {
 117         ATH10K_HTC_SETUP_COMPLETE_FLAGS_RX_BNDL_EN = 1
 118 };
 119
 120 struct ath10k_ath10k_htc_msg_hdr {
 121         __le16 message_id; /* @enum htc_message_id */
 122 } __packed;
 123
 124 struct ath10k_htc_unknown {
 125         u8 pad0;
 126         u8 pad1;
 127 } __packed;
 128
 129 struct ath10k_htc_ready {
 130         __le16 credit_count;
 131         __le16 credit_size;
 132         u8 max_endpoints;
 133         u8 pad0;
 134 } __packed;
 135
 136 struct ath10k_htc_ready_extended {
 137         struct ath10k_htc_ready base;
 138         u8 htc_version; /* @enum ath10k_htc_version */
 139         u8 max_msgs_per_htc_bundle;
 140         u8 pad0;
 141         u8 pad1;
 142 } __packed;
 143
 144 struct ath10k_htc_conn_svc {
 145         __le16 service_id;
 146         __le16 flags; /* @enum ath10k_htc_conn_flags */
 147         u8 pad0;
 148         u8 pad1;
 149 } __packed;
 150
 151 struct ath10k_htc_conn_svc_response {
 152         __le16 service_id;
 153         u8 status; /* @enum ath10k_htc_conn_svc_status */
 154         u8 eid;
 155         __le16 max_msg_size;
 156 } __packed;
 157
 158 struct ath10k_htc_setup_complete_extended {
 159         u8 pad0;
 160         u8 pad1;
 161         __le32 flags; /* @enum htc_setup_complete_flags */
 162         u8 max_msgs_per_bundled_recv;
 163         u8 pad2;
 164         u8 pad3;
 165         u8 pad4;
 166 } __packed;
 167
 168 struct ath10k_htc_msg {
 169         struct ath10k_ath10k_htc_msg_hdr hdr;
 170         union {
 171                 /* host-to-target */
 172                 struct ath10k_htc_conn_svc connect_service;
 173                 struct ath10k_htc_ready ready;
 174                 struct ath10k_htc_ready_extended ready_ext;
 175                 struct ath10k_htc_unknown unknown;
 176                 struct ath10k_htc_setup_complete_extended setup_complete_ext;
 177
 178                 /* target-to-host */
 179                 struct ath10k_htc_conn_svc_response connect_service_response;
 180         };
 181 } __packed __aligned(4);
 182
 183 enum ath10k_ath10k_htc_record_id {
 184         ATH10K_HTC_RECORD_NULL             = 0,
 185         ATH10K_HTC_RECORD_CREDITS          = 1,
 186         ATH10K_HTC_RECORD_LOOKAHEAD        = 2,
 187         ATH10K_HTC_RECORD_LOOKAHEAD_BUNDLE = 3,
 188 };
 189
 190 struct ath10k_ath10k_htc_record_hdr {
 191         u8 id; /* @enum ath10k_ath10k_htc_record_id */
 192         u8 len;
 193         u8 pad0;
 194         u8 pad1;
 195 } __packed;
 196
 197 struct ath10k_htc_credit_report {
 198         u8 eid; /* @enum ath10k_htc_ep_id */
 199         u8 credits;
 200         u8 pad0;
 201         u8 pad1;
 202 } __packed;
 203
 204 struct ath10k_htc_lookahead_report {
 205         u8 pre_valid;
 206         u8 pad0;
 207         u8 pad1;
 208         u8 pad2;
 209         u8 lookahead[4];
 210         u8 post_valid;
 211         u8 pad3;
 212         u8 pad4;
 213         u8 pad5;
 214 } __packed;
 215
 216 struct ath10k_htc_lookahead_bundle {
 217         u8 lookahead[4];
 218 } __packed;
 219
 220 struct ath10k_htc_record {
 221         struct ath10k_ath10k_htc_record_hdr hdr;
 222         union {
 223                 struct ath10k_htc_credit_report credit_report[0];
 224                 struct ath10k_htc_lookahead_report lookahead_report[0];
 225                 struct ath10k_htc_lookahead_bundle lookahead_bundle[0];
 226                 u8 pauload[0];
 227         };
 228 } __packed __aligned(4);
 229
 230 /*
 231  * note: the trailer offset is dynamic depending
 232  * on payload length. this is only a struct layout draft
 233  */
 234 struct ath10k_htc_frame {
 235         struct ath10k_htc_hdr hdr;
 236         union {
 237                 struct ath10k_htc_msg msg;
 238                 u8 payload[0];
 239         };
 240         struct ath10k_htc_record trailer[0];
 241 } __packed __aligned(4);
 242
 243 /*******************/
 244 /* Host-side stuff */
 245 /*******************/
 246
 247 enum ath10k_htc_svc_gid {
 248         ATH10K_HTC_SVC_GRP_RSVD = 0,
 249         ATH10K_HTC_SVC_GRP_WMI = 1,
 250         ATH10K_HTC_SVC_GRP_NMI = 2,
 251         ATH10K_HTC_SVC_GRP_HTT = 3,
 252         ATH10K_LOG_SERVICE_GROUP = 6,
 253
 254         ATH10K_HTC_SVC_GRP_TEST = 254,
 255         ATH10K_HTC_SVC_GRP_LAST = 255,
 256 };
 257
 258 #define SVC(group, idx) \
 259         (int)(((int)(group) << 8) | (int)(idx))
 260
 261 enum ath10k_htc_svc_id {
 262         /* NOTE: service ID of 0x0000 is reserved and should never be used */
 263         ATH10K_HTC_SVC_ID_RESERVED      = 0x0000,
 264         ATH10K_HTC_SVC_ID_UNUSED        = ATH10K_HTC_SVC_ID_RESERVED,
 265
 266         ATH10K_HTC_SVC_ID_RSVD_CTRL     = SVC(ATH10K_HTC_SVC_GRP_RSVD, 1),
 267         ATH10K_HTC_SVC_ID_WMI_CONTROL   = SVC(ATH10K_HTC_SVC_GRP_WMI, 0),
 268         ATH10K_HTC_SVC_ID_WMI_DATA_BE   = SVC(ATH10K_HTC_SVC_GRP_WMI, 1),
 269         ATH10K_HTC_SVC_ID_WMI_DATA_BK   = SVC(ATH10K_HTC_SVC_GRP_WMI, 2),
 270         ATH10K_HTC_SVC_ID_WMI_DATA_VI   = SVC(ATH10K_HTC_SVC_GRP_WMI, 3),
 271         ATH10K_HTC_SVC_ID_WMI_DATA_VO   = SVC(ATH10K_HTC_SVC_GRP_WMI, 4),
 272
 273         ATH10K_HTC_SVC_ID_NMI_CONTROL   = SVC(ATH10K_HTC_SVC_GRP_NMI, 0),
 274         ATH10K_HTC_SVC_ID_NMI_DATA      = SVC(ATH10K_HTC_SVC_GRP_NMI, 1),
 275
 276         ATH10K_HTC_SVC_ID_HTT_DATA_MSG  = SVC(ATH10K_HTC_SVC_GRP_HTT, 0),
 277
 278         ATH10K_HTC_SVC_ID_HTT_DATA2_MSG = SVC(ATH10K_HTC_SVC_GRP_HTT, 1),
 279         ATH10K_HTC_SVC_ID_HTT_DATA3_MSG = SVC(ATH10K_HTC_SVC_GRP_HTT, 2),
 280         ATH10K_HTC_SVC_ID_HTT_LOG_MSG = SVC(ATH10K_LOG_SERVICE_GROUP, 0),
 281         /* raw stream service (i.e. flash, tcmd, calibration apps) */
 282         ATH10K_HTC_SVC_ID_TEST_RAW_STREAMS = SVC(ATH10K_HTC_SVC_GRP_TEST, 0),
 283 };
 284
 285 #undef SVC
 286
 287 enum ath10k_htc_ep_id {
 288         ATH10K_HTC_EP_UNUSED = -1,
 289         ATH10K_HTC_EP_0 = 0,
 290         ATH10K_HTC_EP_1 = 1,
 291         ATH10K_HTC_EP_2,
 292         ATH10K_HTC_EP_3,
 293         ATH10K_HTC_EP_4,
 294         ATH10K_HTC_EP_5,
 295         ATH10K_HTC_EP_6,
 296         ATH10K_HTC_EP_7,
 297         ATH10K_HTC_EP_8,
 298         ATH10K_HTC_EP_COUNT,
 299 };
 300
 301 struct ath10k_htc_ops {
 302         void (*target_send_suspend_complete)(struct ath10k *ar);
 303 };
 304
 305 struct ath10k_htc_ep_ops {
 306         void (*ep_tx_complete)(struct ath10k *, struct sk_buff *);
 307         void (*ep_rx_complete)(struct ath10k *, struct sk_buff *);
 308         void (*ep_tx_credits)(struct ath10k *);
 309 };
 310
 311 /* service connection information */
 312 struct ath10k_htc_svc_conn_req {
 313         u16 service_id;
 314         struct ath10k_htc_ep_ops ep_ops;
 315         int max_send_queue_depth;
 316 };
 317
 318 /* service connection response information */
 319 struct ath10k_htc_svc_conn_resp {
 320         u8 buffer_len;
 321         u8 actual_len;
 322         enum ath10k_htc_ep_id eid;
 323         unsigned int max_msg_len;
 324         u8 connect_resp_code;
 325 };
 326
 327 #define ATH10K_NUM_CONTROL_TX_BUFFERS 2
 328 #define ATH10K_HTC_MAX_LEN 4096
 329 #define ATH10K_HTC_MAX_CTRL_MSG_LEN 256
 330 #define ATH10K_HTC_WAIT_TIMEOUT_HZ (1 * HZ)
 331 #define ATH10K_HTC_CONTROL_BUFFER_SIZE (ATH10K_HTC_MAX_CTRL_MSG_LEN + \
 332                                         sizeof(struct ath10k_htc_hdr))
 333 #define ATH10K_HTC_CONN_SVC_TIMEOUT_HZ (1 * HZ)
 334
 335 struct ath10k_htc_ep {
 336         struct ath10k_htc *htc;
 337         enum ath10k_htc_ep_id eid;
 338         enum ath10k_htc_svc_id service_id;
 339         struct ath10k_htc_ep_ops ep_ops;
 340
 341         int max_tx_queue_depth;
 342         int max_ep_message_len;
 343         u8 ul_pipe_id;
 344         u8 dl_pipe_id;
 345
 346         u8 seq_no; /* for debugging */
 347         int tx_credits;
 348         bool tx_credit_flow_enabled;
 349 };
 350
 351 struct ath10k_htc_svc_tx_credits {
 352         u16 service_id;
 353         u8  credit_allocation;
 354 };
 355
 356 struct ath10k_htc {
 357         struct ath10k *ar;
 358         struct ath10k_htc_ep endpoint[ATH10K_HTC_EP_COUNT];
 359
 360         /* protects endpoints */
 361         spinlock_t tx_lock;
 362
 363         struct ath10k_htc_ops htc_ops;
 364
 365         u8 control_resp_buffer[ATH10K_HTC_MAX_CTRL_MSG_LEN];
 366         int control_resp_len;
 367
 368         struct completion ctl_resp;
 369
 370         int total_transmit_credits;
 371         int target_credit_size;
 372         u8 max_msgs_per_htc_bundle;
 373 };
 374
 375 int ath10k_htc_init(struct ath10k *ar);
 376 int ath10k_htc_wait_target(struct ath10k_htc *htc);
 377 int ath10k_htc_start(struct ath10k_htc *htc);
 378 int ath10k_htc_connect_service(struct ath10k_htc *htc,
 379                                struct ath10k_htc_svc_conn_req  *conn_req,
 380                                struct ath10k_htc_svc_conn_resp *conn_resp);
 381 int ath10k_htc_send(struct ath10k_htc *htc, enum ath10k_htc_ep_id eid,
 382                     struct sk_buff *packet);
 383 struct sk_buff *ath10k_htc_alloc_skb(struct ath10k *ar, int size);
 384 void ath10k_htc_tx_completion_handler(struct ath10k *ar, struct sk_buff *skb);
 385 void ath10k_htc_rx_completion_handler(struct ath10k *ar, struct sk_buff *skb);
 386 void ath10k_htc_notify_tx_completion(struct ath10k_htc_ep *ep,
 387                                      struct sk_buff *skb);
 388 int ath10k_htc_process_trailer(struct ath10k_htc *htc,
 389                                u8 *buffer,
 390                                int length,
 391                                enum ath10k_htc_ep_id src_eid,
 392                                void *next_lookaheads,
 393                                int *next_lookaheads_len);
 394
 395 #endif