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

   1 /*
   2  * Copyright (c) 2005-2011 Atheros Communications Inc.
   3  * Copyright (c) 2011-2013 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 _CE_H_
  19 #define _CE_H_
  20
  21 #include "hif.h"
  22
  23
  24 /* Maximum number of Copy Engine's supported */
  25 #define CE_COUNT_MAX 8
  26 #define CE_HTT_H2T_MSG_SRC_NENTRIES 2048
  27
  28 /* Descriptor rings must be aligned to this boundary */
  29 #define CE_DESC_RING_ALIGN      8
  30 #define CE_SEND_FLAG_GATHER     0x00010000
  31
  32 /*
  33  * Copy Engine support: low-level Target-side Copy Engine API.
  34  * This is a hardware access layer used by code that understands
  35  * how to use copy engines.
  36  */
  37
  38 struct ath10k_ce_pipe;
  39
  40
  41 #define CE_DESC_FLAGS_GATHER         (1 << 0)
  42 #define CE_DESC_FLAGS_BYTE_SWAP      (1 << 1)
  43 #define CE_DESC_FLAGS_META_DATA_MASK 0xFFFC
  44 #define CE_DESC_FLAGS_META_DATA_LSB  3
  45
  46 struct ce_desc {
  47         __le32 addr;
  48         __le16 nbytes;
  49         __le16 flags; /* %CE_DESC_FLAGS_ */
  50 };
  51
  52 struct ath10k_ce_ring {
  53         /* Number of entries in this ring; must be power of 2 */
  54         unsigned int nentries;
  55         unsigned int nentries_mask;
  56
  57         /*
  58          * For dest ring, this is the next index to be processed
  59          * by software after it was/is received into.
  60          *
  61          * For src ring, this is the last descriptor that was sent
  62          * and completion processed by software.
  63          *
  64          * Regardless of src or dest ring, this is an invariant
  65          * (modulo ring size):
  66          *     write index >= read index >= sw_index
  67          */
  68         unsigned int sw_index;
  69         /* cached copy */
  70         unsigned int write_index;
  71         /*
  72          * For src ring, this is the next index not yet processed by HW.
  73          * This is a cached copy of the real HW index (read index), used
  74          * for avoiding reading the HW index register more often than
  75          * necessary.
  76          * This extends the invariant:
  77          *     write index >= read index >= hw_index >= sw_index
  78          *
  79          * For dest ring, this is currently unused.
  80          */
  81         /* cached copy */
  82         unsigned int hw_index;
  83
  84         /* Start of DMA-coherent area reserved for descriptors */
  85         /* Host address space */
  86         void *base_addr_owner_space_unaligned;
  87         /* CE address space */
  88         u32 base_addr_ce_space_unaligned;
  89
  90         /*
  91          * Actual start of descriptors.
  92          * Aligned to descriptor-size boundary.
  93          * Points into reserved DMA-coherent area, above.
  94          */
  95         /* Host address space */
  96         void *base_addr_owner_space;
  97
  98         /* CE address space */
  99         u32 base_addr_ce_space;
 100         /*
 101          * Start of shadow copy of descriptors, within regular memory.
 102          * Aligned to descriptor-size boundary.
 103          */
 104         void *shadow_base_unaligned;
 105         struct ce_desc *shadow_base;
 106
 107         void **per_transfer_context;
 108 };
 109
 110 struct ath10k_ce_pipe {
 111         struct ath10k *ar;
 112         unsigned int id;
 113
 114         unsigned int attr_flags;
 115
 116         u32 ctrl_addr;
 117
 118         void (*send_cb)(struct ath10k_ce_pipe *);
 119         void (*recv_cb)(struct ath10k_ce_pipe *);
 120
 121         unsigned int src_sz_max;
 122         struct ath10k_ce_ring *src_ring;
 123         struct ath10k_ce_ring *dest_ring;
 124 };
 125
 126 /* Copy Engine settable attributes */
 127 struct ce_attr;
 128
 129 /*==================Send====================*/
 130
 131 /* ath10k_ce_send flags */
 132 #define CE_SEND_FLAG_BYTE_SWAP 1
 133
 134 /*
 135  * Queue a source buffer to be sent to an anonymous destination buffer.
 136  *   ce         - which copy engine to use
 137  *   buffer          - address of buffer
 138  *   nbytes          - number of bytes to send
 139  *   transfer_id     - arbitrary ID; reflected to destination
 140  *   flags           - CE_SEND_FLAG_* values
 141  * Returns 0 on success; otherwise an error status.
 142  *
 143  * Note: If no flags are specified, use CE's default data swap mode.
 144  *
 145  * Implementation note: pushes 1 buffer to Source ring
 146  */
 147 int ath10k_ce_send(struct ath10k_ce_pipe *ce_state,
 148                    void *per_transfer_send_context,
 149                    u32 buffer,
 150                    unsigned int nbytes,
 151                    /* 14 bits */
 152                    unsigned int transfer_id,
 153                    unsigned int flags);
 154
 155 void ath10k_ce_send_cb_register(struct ath10k_ce_pipe *ce_state,
 156                                 void (*send_cb)(struct ath10k_ce_pipe *),
 157                                 int disable_interrupts);
 158
 159 /*
 160  * Queue a "sendlist" of buffers to be sent using gather to a single
 161  * anonymous destination buffer
 162  *   ce         - which copy engine to use
 163  *   sendlist        - list of simple buffers to send using gather
 164  *   transfer_id     - arbitrary ID; reflected to destination
 165  * Returns 0 on success; otherwise an error status.
 166  *
 167  * Implemenation note: Pushes multiple buffers with Gather to Source ring.
 168  */
 169 int ath10k_ce_sendlist_send(struct ath10k_ce_pipe *ce_state,
 170                             void *per_transfer_context,
 171                             unsigned int transfer_id,
 172                             u32 paddr, unsigned int nbytes,
 173                             u32 flags);
 174
 175 /*==================Recv=======================*/
 176
 177 /*
 178  * Make a buffer available to receive. The buffer must be at least of a
 179  * minimal size appropriate for this copy engine (src_sz_max attribute).
 180  *   ce                    - which copy engine to use
 181  *   per_transfer_recv_context  - context passed back to caller's recv_cb
 182  *   buffer                     - address of buffer in CE space
 183  * Returns 0 on success; otherwise an error status.
 184  *
 185  * Implemenation note: Pushes a buffer to Dest ring.
 186  */
 187 int ath10k_ce_recv_buf_enqueue(struct ath10k_ce_pipe *ce_state,
 188                                void *per_transfer_recv_context,
 189                                u32 buffer);
 190
 191 void ath10k_ce_recv_cb_register(struct ath10k_ce_pipe *ce_state,
 192                                 void (*recv_cb)(struct ath10k_ce_pipe *));
 193
 194 /* recv flags */
 195 /* Data is byte-swapped */
 196 #define CE_RECV_FLAG_SWAPPED    1
 197
 198 /*
 199  * Supply data for the next completed unprocessed receive descriptor.
 200  * Pops buffer from Dest ring.
 201  */
 202 int ath10k_ce_completed_recv_next(struct ath10k_ce_pipe *ce_state,
 203                                   void **per_transfer_contextp,
 204                                   u32 *bufferp,
 205                                   unsigned int *nbytesp,
 206                                   unsigned int *transfer_idp,
 207                                   unsigned int *flagsp);
 208 /*
 209  * Supply data for the next completed unprocessed send descriptor.
 210  * Pops 1 completed send buffer from Source ring.
 211  */
 212 int ath10k_ce_completed_send_next(struct ath10k_ce_pipe *ce_state,
 213                            void **per_transfer_contextp,
 214                            u32 *bufferp,
 215                            unsigned int *nbytesp,
 216                            unsigned int *transfer_idp);
 217
 218 /*==================CE Engine Initialization=======================*/
 219
 220 /* Initialize an instance of a CE */
 221 struct ath10k_ce_pipe *ath10k_ce_init(struct ath10k *ar,
 222                                 unsigned int ce_id,
 223                                 const struct ce_attr *attr);
 224
 225 /*==================CE Engine Shutdown=======================*/
 226 /*
 227  * Support clean shutdown by allowing the caller to revoke
 228  * receive buffers.  Target DMA must be stopped before using
 229  * this API.
 230  */
 231 int ath10k_ce_revoke_recv_next(struct ath10k_ce_pipe *ce_state,
 232                                void **per_transfer_contextp,
 233                                u32 *bufferp);
 234
 235 /*
 236  * Support clean shutdown by allowing the caller to cancel
 237  * pending sends.  Target DMA must be stopped before using
 238  * this API.
 239  */
 240 int ath10k_ce_cancel_send_next(struct ath10k_ce_pipe *ce_state,
 241                                void **per_transfer_contextp,
 242                                u32 *bufferp,
 243                                unsigned int *nbytesp,
 244                                unsigned int *transfer_idp);
 245
 246 void ath10k_ce_deinit(struct ath10k_ce_pipe *ce_state);
 247
 248 /*==================CE Interrupt Handlers====================*/
 249 void ath10k_ce_per_engine_service_any(struct ath10k *ar);
 250 void ath10k_ce_per_engine_service(struct ath10k *ar, unsigned int ce_id);
 251 void ath10k_ce_disable_interrupts(struct ath10k *ar);
 252
 253 /* ce_attr.flags values */
 254 /* Use NonSnooping PCIe accesses? */
 255 #define CE_ATTR_NO_SNOOP                1
 256
 257 /* Byte swap data words */
 258 #define CE_ATTR_BYTE_SWAP_DATA          2
 259
 260 /* Swizzle descriptors? */
 261 #define CE_ATTR_SWIZZLE_DESCRIPTORS     4
 262
 263 /* no interrupt on copy completion */
 264 #define CE_ATTR_DIS_INTR                8
 265
 266 /* Attributes of an instance of a Copy Engine */
 267 struct ce_attr {
 268         /* CE_ATTR_* values */
 269         unsigned int flags;
 270
 271         /* #entries in source ring - Must be a power of 2 */
 272         unsigned int src_nentries;
 273
 274         /*
 275          * Max source send size for this CE.
 276          * This is also the minimum size of a destination buffer.
 277          */
 278         unsigned int src_sz_max;
 279
 280         /* #entries in destination ring - Must be a power of 2 */
 281         unsigned int dest_nentries;
 282 };
 283
 284 #define SR_BA_ADDRESS           0x0000
 285 #define SR_SIZE_ADDRESS         0x0004
 286 #define DR_BA_ADDRESS           0x0008
 287 #define DR_SIZE_ADDRESS         0x000c
 288 #define CE_CMD_ADDRESS          0x0018
 289
 290 #define CE_CTRL1_DST_RING_BYTE_SWAP_EN_MSB      17
 291 #define CE_CTRL1_DST_RING_BYTE_SWAP_EN_LSB      17
 292 #define CE_CTRL1_DST_RING_BYTE_SWAP_EN_MASK     0x00020000
 293 #define CE_CTRL1_DST_RING_BYTE_SWAP_EN_SET(x) \
 294         (((0 | (x)) << CE_CTRL1_DST_RING_BYTE_SWAP_EN_LSB) & \
 295         CE_CTRL1_DST_RING_BYTE_SWAP_EN_MASK)
 296
 297 #define CE_CTRL1_SRC_RING_BYTE_SWAP_EN_MSB      16
 298 #define CE_CTRL1_SRC_RING_BYTE_SWAP_EN_LSB      16
 299 #define CE_CTRL1_SRC_RING_BYTE_SWAP_EN_MASK     0x00010000
 300 #define CE_CTRL1_SRC_RING_BYTE_SWAP_EN_GET(x) \
 301         (((x) & CE_CTRL1_SRC_RING_BYTE_SWAP_EN_MASK) >> \
 302          CE_CTRL1_SRC_RING_BYTE_SWAP_EN_LSB)
 303 #define CE_CTRL1_SRC_RING_BYTE_SWAP_EN_SET(x) \
 304         (((0 | (x)) << CE_CTRL1_SRC_RING_BYTE_SWAP_EN_LSB) & \
 305          CE_CTRL1_SRC_RING_BYTE_SWAP_EN_MASK)
 306
 307 #define CE_CTRL1_DMAX_LENGTH_MSB                15
 308 #define CE_CTRL1_DMAX_LENGTH_LSB                0
 309 #define CE_CTRL1_DMAX_LENGTH_MASK               0x0000ffff
 310 #define CE_CTRL1_DMAX_LENGTH_GET(x) \
 311         (((x) & CE_CTRL1_DMAX_LENGTH_MASK) >> CE_CTRL1_DMAX_LENGTH_LSB)
 312 #define CE_CTRL1_DMAX_LENGTH_SET(x) \
 313         (((0 | (x)) << CE_CTRL1_DMAX_LENGTH_LSB) & CE_CTRL1_DMAX_LENGTH_MASK)
 314
 315 #define CE_CTRL1_ADDRESS                        0x0010
 316 #define CE_CTRL1_HW_MASK                        0x0007ffff
 317 #define CE_CTRL1_SW_MASK                        0x0007ffff
 318 #define CE_CTRL1_HW_WRITE_MASK                  0x00000000
 319 #define CE_CTRL1_SW_WRITE_MASK                  0x0007ffff
 320 #define CE_CTRL1_RSTMASK                        0xffffffff
 321 #define CE_CTRL1_RESET                          0x00000080
 322
 323 #define CE_CMD_HALT_STATUS_MSB                  3
 324 #define CE_CMD_HALT_STATUS_LSB                  3
 325 #define CE_CMD_HALT_STATUS_MASK                 0x00000008
 326 #define CE_CMD_HALT_STATUS_GET(x) \
 327         (((x) & CE_CMD_HALT_STATUS_MASK) >> CE_CMD_HALT_STATUS_LSB)
 328 #define CE_CMD_HALT_STATUS_SET(x) \
 329         (((0 | (x)) << CE_CMD_HALT_STATUS_LSB) & CE_CMD_HALT_STATUS_MASK)
 330 #define CE_CMD_HALT_STATUS_RESET                0
 331 #define CE_CMD_HALT_MSB                         0
 332 #define CE_CMD_HALT_MASK                        0x00000001
 333
 334 #define HOST_IE_COPY_COMPLETE_MSB               0
 335 #define HOST_IE_COPY_COMPLETE_LSB               0
 336 #define HOST_IE_COPY_COMPLETE_MASK              0x00000001
 337 #define HOST_IE_COPY_COMPLETE_GET(x) \
 338         (((x) & HOST_IE_COPY_COMPLETE_MASK) >> HOST_IE_COPY_COMPLETE_LSB)
 339 #define HOST_IE_COPY_COMPLETE_SET(x) \
 340         (((0 | (x)) << HOST_IE_COPY_COMPLETE_LSB) & HOST_IE_COPY_COMPLETE_MASK)
 341 #define HOST_IE_COPY_COMPLETE_RESET             0
 342 #define HOST_IE_ADDRESS                         0x002c
 343
 344 #define HOST_IS_DST_RING_LOW_WATERMARK_MASK     0x00000010
 345 #define HOST_IS_DST_RING_HIGH_WATERMARK_MASK    0x00000008
 346 #define HOST_IS_SRC_RING_LOW_WATERMARK_MASK     0x00000004
 347 #define HOST_IS_SRC_RING_HIGH_WATERMARK_MASK    0x00000002
 348 #define HOST_IS_COPY_COMPLETE_MASK              0x00000001
 349 #define HOST_IS_ADDRESS                         0x0030
 350
 351 #define MISC_IE_ADDRESS                         0x0034
 352
 353 #define MISC_IS_AXI_ERR_MASK                    0x00000400
 354
 355 #define MISC_IS_DST_ADDR_ERR_MASK               0x00000200
 356 #define MISC_IS_SRC_LEN_ERR_MASK                0x00000100
 357 #define MISC_IS_DST_MAX_LEN_VIO_MASK            0x00000080
 358 #define MISC_IS_DST_RING_OVERFLOW_MASK          0x00000040
 359 #define MISC_IS_SRC_RING_OVERFLOW_MASK          0x00000020
 360
 361 #define MISC_IS_ADDRESS                         0x0038
 362
 363 #define SR_WR_INDEX_ADDRESS                     0x003c
 364
 365 #define DST_WR_INDEX_ADDRESS                    0x0040
 366
 367 #define CURRENT_SRRI_ADDRESS                    0x0044
 368
 369 #define CURRENT_DRRI_ADDRESS                    0x0048
 370
 371 #define SRC_WATERMARK_LOW_MSB                   31
 372 #define SRC_WATERMARK_LOW_LSB                   16
 373 #define SRC_WATERMARK_LOW_MASK                  0xffff0000
 374 #define SRC_WATERMARK_LOW_GET(x) \
 375         (((x) & SRC_WATERMARK_LOW_MASK) >> SRC_WATERMARK_LOW_LSB)
 376 #define SRC_WATERMARK_LOW_SET(x) \
 377         (((0 | (x)) << SRC_WATERMARK_LOW_LSB) & SRC_WATERMARK_LOW_MASK)
 378 #define SRC_WATERMARK_LOW_RESET                 0
 379 #define SRC_WATERMARK_HIGH_MSB                  15
 380 #define SRC_WATERMARK_HIGH_LSB                  0
 381 #define SRC_WATERMARK_HIGH_MASK                 0x0000ffff
 382 #define SRC_WATERMARK_HIGH_GET(x) \
 383         (((x) & SRC_WATERMARK_HIGH_MASK) >> SRC_WATERMARK_HIGH_LSB)
 384 #define SRC_WATERMARK_HIGH_SET(x) \
 385         (((0 | (x)) << SRC_WATERMARK_HIGH_LSB) & SRC_WATERMARK_HIGH_MASK)
 386 #define SRC_WATERMARK_HIGH_RESET                0
 387 #define SRC_WATERMARK_ADDRESS                   0x004c
 388
 389 #define DST_WATERMARK_LOW_LSB                   16
 390 #define DST_WATERMARK_LOW_MASK                  0xffff0000
 391 #define DST_WATERMARK_LOW_SET(x) \
 392         (((0 | (x)) << DST_WATERMARK_LOW_LSB) & DST_WATERMARK_LOW_MASK)
 393 #define DST_WATERMARK_LOW_RESET                 0
 394 #define DST_WATERMARK_HIGH_MSB                  15
 395 #define DST_WATERMARK_HIGH_LSB                  0
 396 #define DST_WATERMARK_HIGH_MASK                 0x0000ffff
 397 #define DST_WATERMARK_HIGH_GET(x) \
 398         (((x) & DST_WATERMARK_HIGH_MASK) >> DST_WATERMARK_HIGH_LSB)
 399 #define DST_WATERMARK_HIGH_SET(x) \
 400         (((0 | (x)) << DST_WATERMARK_HIGH_LSB) & DST_WATERMARK_HIGH_MASK)
 401 #define DST_WATERMARK_HIGH_RESET                0
 402 #define DST_WATERMARK_ADDRESS                   0x0050
 403
 404
 405 static inline u32 ath10k_ce_base_address(unsigned int ce_id)
 406 {
 407         return CE0_BASE_ADDRESS + (CE1_BASE_ADDRESS - CE0_BASE_ADDRESS) * ce_id;
 408 }
 409
 410 #define CE_WATERMARK_MASK (HOST_IS_SRC_RING_LOW_WATERMARK_MASK  | \
 411                            HOST_IS_SRC_RING_HIGH_WATERMARK_MASK | \
 412                            HOST_IS_DST_RING_LOW_WATERMARK_MASK  | \
 413                            HOST_IS_DST_RING_HIGH_WATERMARK_MASK)
 414
 415 #define CE_ERROR_MASK   (MISC_IS_AXI_ERR_MASK           | \
 416                          MISC_IS_DST_ADDR_ERR_MASK      | \
 417                          MISC_IS_SRC_LEN_ERR_MASK       | \
 418                          MISC_IS_DST_MAX_LEN_VIO_MASK   | \
 419                          MISC_IS_DST_RING_OVERFLOW_MASK | \
 420                          MISC_IS_SRC_RING_OVERFLOW_MASK)
 421
 422 #define CE_SRC_RING_TO_DESC(baddr, idx) \
 423         (&(((struct ce_desc *)baddr)[idx]))
 424
 425 #define CE_DEST_RING_TO_DESC(baddr, idx) \
 426         (&(((struct ce_desc *)baddr)[idx]))
 427
 428 /* Ring arithmetic (modulus number of entries in ring, which is a pwr of 2). */
 429 #define CE_RING_DELTA(nentries_mask, fromidx, toidx) \
 430         (((int)(toidx)-(int)(fromidx)) & (nentries_mask))
 431
 432 #define CE_RING_IDX_INCR(nentries_mask, idx) (((idx) + 1) & (nentries_mask))
 433
 434 #define CE_WRAPPER_INTERRUPT_SUMMARY_HOST_MSI_LSB               8
 435 #define CE_WRAPPER_INTERRUPT_SUMMARY_HOST_MSI_MASK              0x0000ff00
 436 #define CE_WRAPPER_INTERRUPT_SUMMARY_HOST_MSI_GET(x) \
 437         (((x) & CE_WRAPPER_INTERRUPT_SUMMARY_HOST_MSI_MASK) >> \
 438                 CE_WRAPPER_INTERRUPT_SUMMARY_HOST_MSI_LSB)
 439 #define CE_WRAPPER_INTERRUPT_SUMMARY_ADDRESS                    0x0000
 440
 441 #define CE_INTERRUPT_SUMMARY(ar) \
 442         CE_WRAPPER_INTERRUPT_SUMMARY_HOST_MSI_GET( \
 443                 ath10k_pci_read32((ar), CE_WRAPPER_BASE_ADDRESS + \
 444                 CE_WRAPPER_INTERRUPT_SUMMARY_ADDRESS))
 445
 446 #endif /* _CE_H_ */