drivers/bus/fslmc/portal/dpaa2_hw_pvt.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  *
   3  *   Copyright (c) 2016 Freescale Semiconductor, Inc. All rights reserved.
   4  *   Copyright 2016-2018 NXP
   5  *
   6  */
   7
   8 #ifndef _DPAA2_HW_PVT_H_
   9 #define _DPAA2_HW_PVT_H_
  10
  11 #include <rte_eventdev.h>
  12 #include <dpaax_iova_table.h>
  13
  14 #include <mc/fsl_mc_sys.h>
  15 #include <fsl_qbman_portal.h>
  16
  17 #ifndef false
  18 #define false      0
  19 #endif
  20 #ifndef true
  21 #define true       1
  22 #endif
  23 #define lower_32_bits(x) ((uint32_t)(x))
  24 #define upper_32_bits(x) ((uint32_t)(((x) >> 16) >> 16))
  25
  26 #ifndef VLAN_TAG_SIZE
  27 #define VLAN_TAG_SIZE   4 /** < Vlan Header Length */
  28 #endif
  29
  30 /* Maximum number of slots available in TX ring */
  31 #define MAX_TX_RING_SLOTS                       32
  32 #define MAX_EQ_RESP_ENTRIES                     (MAX_TX_RING_SLOTS + 1)
  33
  34 /* Maximum number of slots available in RX ring */
  35 #define DPAA2_EQCR_RING_SIZE            8
  36 /* Maximum number of slots available in RX ring on LX2 */
  37 #define DPAA2_LX2_EQCR_RING_SIZE        32
  38
  39 /* Maximum number of slots available in RX ring */
  40 #define DPAA2_DQRR_RING_SIZE            16
  41 /* Maximum number of slots available in RX ring on LX2 */
  42 #define DPAA2_LX2_DQRR_RING_SIZE        32
  43
  44 /* EQCR shift to get EQCR size (2 >> 3) = 8 for LS2/LS2 */
  45 #define DPAA2_EQCR_SHIFT                3
  46 /* EQCR shift to get EQCR size for LX2 (2 >> 5) = 32 for LX2 */
  47 #define DPAA2_LX2_EQCR_SHIFT            5
  48
  49 /* Flag to determine an ordered queue mbuf */
  50 #define DPAA2_ENQUEUE_FLAG_ORP          (1ULL << 30)
  51 /* ORP ID shift and mask */
  52 #define DPAA2_EQCR_OPRID_SHIFT          16
  53 #define DPAA2_EQCR_OPRID_MASK           0x3FFF0000
  54 /* Sequence number shift and mask */
  55 #define DPAA2_EQCR_SEQNUM_SHIFT         0
  56 #define DPAA2_EQCR_SEQNUM_MASK          0x0000FFFF
  57
  58 #define DPAA2_SWP_CENA_REGION           0
  59 #define DPAA2_SWP_CINH_REGION           1
  60 #define DPAA2_SWP_CENA_MEM_REGION       2
  61
  62 #define MC_PORTAL_INDEX         0
  63 #define NUM_DPIO_REGIONS        2
  64 #define NUM_DQS_PER_QUEUE       2
  65
  66 /* Maximum release/acquire from QBMAN */
  67 #define DPAA2_MBUF_MAX_ACQ_REL  7
  68
  69 #define DPAA2_MEMPOOL_OPS_NAME          "dpaa2"
  70
  71 #define MAX_BPID 256
  72 #define DPAA2_MBUF_HW_ANNOTATION        64
  73 #define DPAA2_FD_PTA_SIZE               0
  74
  75 /* we will re-use the HEADROOM for annotation in RX */
  76 #define DPAA2_HW_BUF_RESERVE    0
  77 #define DPAA2_PACKET_LAYOUT_ALIGN       64 /*changing from 256 */
  78
  79 #define DPAA2_DPCI_MAX_QUEUES 2
  80
  81 struct dpaa2_queue;
  82
  83 struct eqresp_metadata {
  84         struct dpaa2_queue *dpaa2_q;
  85         struct rte_mempool *mp;
  86 };
  87
  88 struct dpaa2_dpio_dev {
  89         TAILQ_ENTRY(dpaa2_dpio_dev) next;
  90                 /**< Pointer to Next device instance */
  91         uint16_t index; /**< Index of a instance in the list */
  92         rte_atomic16_t ref_count;
  93                 /**< How many thread contexts are sharing this.*/
  94         uint16_t eqresp_ci;
  95         uint16_t eqresp_pi;
  96         struct qbman_result *eqresp;
  97         struct eqresp_metadata *eqresp_meta;
  98         struct fsl_mc_io *dpio; /** handle to DPIO portal object */
  99         uint16_t token;
 100         struct qbman_swp *sw_portal; /** SW portal object */
 101         const struct qbman_result *dqrr[4];
 102                 /**< DQRR Entry for this SW portal */
 103         void *mc_portal; /**< MC Portal for configuring this device */
 104         uintptr_t qbman_portal_ce_paddr;
 105                 /**< Physical address of Cache Enabled Area */
 106         uintptr_t ce_size; /**< Size of the CE region */
 107         uintptr_t qbman_portal_ci_paddr;
 108                 /**< Physical address of Cache Inhibit Area */
 109         uintptr_t ci_size; /**< Size of the CI region */
 110         struct rte_intr_handle intr_handle; /* Interrupt related info */
 111         int32_t epoll_fd; /**< File descriptor created for interrupt polling */
 112         int32_t hw_id; /**< An unique ID of this DPIO device instance */
 113 };
 114
 115 struct dpaa2_dpbp_dev {
 116         TAILQ_ENTRY(dpaa2_dpbp_dev) next;
 117                 /**< Pointer to Next device instance */
 118         struct fsl_mc_io dpbp;  /** handle to DPBP portal object */
 119         uint16_t token;
 120         rte_atomic16_t in_use;
 121         uint32_t dpbp_id; /*HW ID for DPBP object */
 122 };
 123
 124 struct queue_storage_info_t {
 125         struct qbman_result *dq_storage[NUM_DQS_PER_QUEUE];
 126         struct qbman_result *active_dqs;
 127         uint8_t active_dpio_id;
 128         uint8_t toggle;
 129         uint8_t last_num_pkts;
 130 };
 131
 132 struct dpaa2_queue;
 133
 134 typedef void (dpaa2_queue_cb_dqrr_t)(struct qbman_swp *swp,
 135                 const struct qbman_fd *fd,
 136                 const struct qbman_result *dq,
 137                 struct dpaa2_queue *rxq,
 138                 struct rte_event *ev);
 139
 140 typedef void (dpaa2_queue_cb_eqresp_free_t)(uint16_t eqresp_ci);
 141
 142 struct dpaa2_queue {
 143         struct rte_mempool *mb_pool; /**< mbuf pool to populate RX ring. */
 144         union {
 145                 struct rte_eth_dev_data *eth_data;
 146                 struct rte_cryptodev_data *crypto_data;
 147         };
 148         uint32_t fqid;          /*!< Unique ID of this queue */
 149         uint16_t flow_id;       /*!< To be used by DPAA2 frmework */
 150         uint8_t tc_index;       /*!< traffic class identifier */
 151         uint8_t cgid;           /*! < Congestion Group id for this queue */
 152         uint64_t rx_pkts;
 153         uint64_t tx_pkts;
 154         uint64_t err_pkts;
 155         union {
 156                 struct queue_storage_info_t *q_storage;
 157                 struct qbman_result *cscn;
 158         };
 159         struct rte_event ev;
 160         int32_t eventfd;        /*!< Event Fd of this queue */
 161         dpaa2_queue_cb_dqrr_t *cb;
 162         dpaa2_queue_cb_eqresp_free_t *cb_eqresp_free;
 163         struct dpaa2_bp_info *bp_array;
 164 };
 165
 166 struct swp_active_dqs {
 167         struct qbman_result *global_active_dqs;
 168         uint64_t reserved[7];
 169 };
 170
 171 #define NUM_MAX_SWP 64
 172
 173 extern struct swp_active_dqs rte_global_active_dqs_list[NUM_MAX_SWP];
 174
 175 struct dpaa2_dpci_dev {
 176         TAILQ_ENTRY(dpaa2_dpci_dev) next;
 177                 /**< Pointer to Next device instance */
 178         struct fsl_mc_io dpci;  /** handle to DPCI portal object */
 179         uint16_t token;
 180         rte_atomic16_t in_use;
 181         uint32_t dpci_id; /*HW ID for DPCI object */
 182         struct dpaa2_queue rx_queue[DPAA2_DPCI_MAX_QUEUES];
 183         struct dpaa2_queue tx_queue[DPAA2_DPCI_MAX_QUEUES];
 184 };
 185
 186 /*! Global MCP list */
 187 extern void *(*rte_mcp_ptr_list);
 188
 189 /* Refer to Table 7-3 in SEC BG */
 190 struct qbman_fle {
 191         uint32_t addr_lo;
 192         uint32_t addr_hi;
 193         uint32_t length;
 194         /* FMT must be 00, MSB is final bit  */
 195         uint32_t fin_bpid_offset;
 196         uint32_t frc;
 197         uint32_t reserved[3]; /* Not used currently */
 198 };
 199
 200 struct qbman_sge {
 201         uint32_t addr_lo;
 202         uint32_t addr_hi;
 203         uint32_t length;
 204         uint32_t fin_bpid_offset;
 205 };
 206
 207 /* There are three types of frames: Single, Scatter Gather and Frame Lists */
 208 enum qbman_fd_format {
 209         qbman_fd_single = 0,
 210         qbman_fd_list,
 211         qbman_fd_sg
 212 };
 213 /*Macros to define operations on FD*/
 214 #define DPAA2_SET_FD_ADDR(fd, addr) do {                        \
 215         (fd)->simple.addr_lo = lower_32_bits((size_t)(addr));   \
 216         (fd)->simple.addr_hi = upper_32_bits((uint64_t)(addr)); \
 217 } while (0)
 218 #define DPAA2_SET_FD_LEN(fd, length)    ((fd)->simple.len = length)
 219 #define DPAA2_SET_FD_BPID(fd, bpid)     ((fd)->simple.bpid_offset |= bpid)
 220 #define DPAA2_SET_ONLY_FD_BPID(fd, bpid) \
 221         ((fd)->simple.bpid_offset = bpid)
 222 #define DPAA2_SET_FD_IVP(fd)   (((fd)->simple.bpid_offset |= 0x00004000))
 223 #define DPAA2_SET_FD_OFFSET(fd, offset) \
 224         (((fd)->simple.bpid_offset |= (uint32_t)(offset) << 16))
 225 #define DPAA2_SET_FD_INTERNAL_JD(fd, len) \
 226         ((fd)->simple.frc = (0x80000000 | (len)))
 227 #define DPAA2_GET_FD_FRC_PARSE_SUM(fd)  \
 228                         ((uint16_t)(((fd)->simple.frc & 0xffff0000) >> 16))
 229 #define DPAA2_RESET_FD_FRC(fd)          ((fd)->simple.frc = 0)
 230 #define DPAA2_SET_FD_FRC(fd, _frc)      ((fd)->simple.frc = _frc)
 231 #define DPAA2_RESET_FD_CTRL(fd)  ((fd)->simple.ctrl = 0)
 232
 233 #define DPAA2_SET_FD_ASAL(fd, asal)     ((fd)->simple.ctrl |= (asal << 16))
 234
 235 #define DPAA2_RESET_FD_FLC(fd)  do {    \
 236         (fd)->simple.flc_lo = 0;        \
 237         (fd)->simple.flc_hi = 0;        \
 238 } while (0)
 239
 240 #define DPAA2_SET_FD_FLC(fd, addr)      do { \
 241         (fd)->simple.flc_lo = lower_32_bits((size_t)(addr));    \
 242         (fd)->simple.flc_hi = upper_32_bits((uint64_t)(addr));  \
 243 } while (0)
 244 #define DPAA2_SET_FLE_INTERNAL_JD(fle, len) ((fle)->frc = (0x80000000 | (len)))
 245 #define DPAA2_GET_FLE_ADDR(fle)                                 \
 246         (size_t)((((uint64_t)((fle)->addr_hi)) << 32) + (fle)->addr_lo)
 247 #define DPAA2_SET_FLE_ADDR(fle, addr) do { \
 248         (fle)->addr_lo = lower_32_bits((size_t)addr);           \
 249         (fle)->addr_hi = upper_32_bits((uint64_t)addr);         \
 250 } while (0)
 251 #define DPAA2_GET_FLE_CTXT(fle)                                 \
 252         ((((uint64_t)((fle)->reserved[1])) << 32) + (fle)->reserved[0])
 253 #define DPAA2_FLE_SAVE_CTXT(fle, addr) do { \
 254         (fle)->reserved[0] = lower_32_bits((size_t)addr);       \
 255         (fle)->reserved[1] = upper_32_bits((uint64_t)addr);     \
 256 } while (0)
 257 #define DPAA2_SET_FLE_OFFSET(fle, offset) \
 258         ((fle)->fin_bpid_offset |= (uint32_t)(offset) << 16)
 259 #define DPAA2_SET_FLE_LEN(fle, len)    ((fle)->length = len)
 260 #define DPAA2_SET_FLE_BPID(fle, bpid) ((fle)->fin_bpid_offset |= (size_t)bpid)
 261 #define DPAA2_GET_FLE_BPID(fle) ((fle)->fin_bpid_offset & 0x000000ff)
 262 #define DPAA2_SET_FLE_FIN(fle)  ((fle)->fin_bpid_offset |= 1 << 31)
 263 #define DPAA2_SET_FLE_IVP(fle)   (((fle)->fin_bpid_offset |= 0x00004000))
 264 #define DPAA2_SET_FLE_BMT(fle)   (((fle)->fin_bpid_offset |= 0x00008000))
 265 #define DPAA2_SET_FD_COMPOUND_FMT(fd)   \
 266         ((fd)->simple.bpid_offset |= (uint32_t)1 << 28)
 267 #define DPAA2_GET_FD_ADDR(fd)   \
 268 (((((uint64_t)((fd)->simple.addr_hi)) << 32) + (fd)->simple.addr_lo))
 269
 270 #define DPAA2_GET_FD_LEN(fd)    ((fd)->simple.len)
 271 #define DPAA2_GET_FD_BPID(fd)   (((fd)->simple.bpid_offset & 0x00003FFF))
 272 #define DPAA2_GET_FD_IVP(fd)   (((fd)->simple.bpid_offset & 0x00004000) >> 14)
 273 #define DPAA2_GET_FD_OFFSET(fd) (((fd)->simple.bpid_offset & 0x0FFF0000) >> 16)
 274 #define DPAA2_GET_FD_FRC(fd)   ((fd)->simple.frc)
 275 #define DPAA2_GET_FD_FLC(fd) \
 276         (((uint64_t)((fd)->simple.flc_hi) << 32) + (fd)->simple.flc_lo)
 277 #define DPAA2_GET_FD_ERR(fd)   ((fd)->simple.bpid_offset & 0x000000FF)
 278 #define DPAA2_GET_FLE_OFFSET(fle) (((fle)->fin_bpid_offset & 0x0FFF0000) >> 16)
 279 #define DPAA2_SET_FLE_SG_EXT(fle) ((fle)->fin_bpid_offset |= (uint64_t)1 << 29)
 280 #define DPAA2_IS_SET_FLE_SG_EXT(fle)    \
 281         (((fle)->fin_bpid_offset & ((uint64_t)1 << 29)) ? 1 : 0)
 282
 283 #define DPAA2_INLINE_MBUF_FROM_BUF(buf, meta_data_size) \
 284         ((struct rte_mbuf *)((size_t)(buf) - (meta_data_size)))
 285
 286 #define DPAA2_ASAL_VAL (DPAA2_MBUF_HW_ANNOTATION / 64)
 287
 288 #define DPAA2_FD_SET_FORMAT(fd, format) do {                            \
 289                 (fd)->simple.bpid_offset &= 0xCFFFFFFF;                 \
 290                 (fd)->simple.bpid_offset |= (uint32_t)format << 28;     \
 291 } while (0)
 292 #define DPAA2_FD_GET_FORMAT(fd) (((fd)->simple.bpid_offset >> 28) & 0x3)
 293
 294 #define DPAA2_SG_SET_FINAL(sg, fin)     do {                            \
 295                 (sg)->fin_bpid_offset &= 0x7FFFFFFF;                    \
 296                 (sg)->fin_bpid_offset |= (uint32_t)fin << 31;           \
 297 } while (0)
 298 #define DPAA2_SG_IS_FINAL(sg) (!!((sg)->fin_bpid_offset >> 31))
 299 /* Only Enqueue Error responses will be
 300  * pushed on FQID_ERR of Enqueue FQ
 301  */
 302 #define DPAA2_EQ_RESP_ERR_FQ            0
 303 /* All Enqueue responses will be pushed on address
 304  * set with qbman_eq_desc_set_response
 305  */
 306 #define DPAA2_EQ_RESP_ALWAYS            1
 307
 308 /* Various structures representing contiguous memory maps */
 309 struct dpaa2_memseg {
 310         TAILQ_ENTRY(dpaa2_memseg) next;
 311         char *vaddr;
 312         rte_iova_t iova;
 313         size_t len;
 314 };
 315
 316 TAILQ_HEAD(dpaa2_memseg_list, dpaa2_memseg);
 317 extern struct dpaa2_memseg_list rte_dpaa2_memsegs;
 318
 319 #ifdef RTE_LIBRTE_DPAA2_USE_PHYS_IOVA
 320 extern uint8_t dpaa2_virt_mode;
 321 static void *dpaa2_mem_ptov(phys_addr_t paddr) __attribute__((unused));
 322
 323 static void *dpaa2_mem_ptov(phys_addr_t paddr)
 324 {
 325         void *va;
 326
 327         if (dpaa2_virt_mode)
 328                 return (void *)(size_t)paddr;
 329
 330         va = (void *)dpaax_iova_table_get_va(paddr);
 331         if (likely(va != NULL))
 332                 return va;
 333
 334         /* If not, Fallback to full memseg list searching */
 335         va = rte_mem_iova2virt(paddr);
 336
 337         return va;
 338 }
 339
 340 static phys_addr_t dpaa2_mem_vtop(uint64_t vaddr) __attribute__((unused));
 341
 342 static phys_addr_t dpaa2_mem_vtop(uint64_t vaddr)
 343 {
 344         const struct rte_memseg *memseg;
 345
 346         if (dpaa2_virt_mode)
 347                 return vaddr;
 348
 349         memseg = rte_mem_virt2memseg((void *)(uintptr_t)vaddr, NULL);
 350         if (memseg)
 351                 return memseg->phys_addr + RTE_PTR_DIFF(vaddr, memseg->addr);
 352         return (size_t)NULL;
 353 }
 354
 355 /**
 356  * When we are using Physical addresses as IO Virtual Addresses,
 357  * Need to call conversion routines dpaa2_mem_vtop & dpaa2_mem_ptov
 358  * wherever required.
 359  * These routines are called with help of below MACRO's
 360  */
 361
 362 #define DPAA2_MBUF_VADDR_TO_IOVA(mbuf) ((mbuf)->buf_iova)
 363
 364 /**
 365  * macro to convert Virtual address to IOVA
 366  */
 367 #define DPAA2_VADDR_TO_IOVA(_vaddr) dpaa2_mem_vtop((size_t)(_vaddr))
 368
 369 /**
 370  * macro to convert IOVA to Virtual address
 371  */
 372 #define DPAA2_IOVA_TO_VADDR(_iova) dpaa2_mem_ptov((size_t)(_iova))
 373
 374 /**
 375  * macro to convert modify the memory containing IOVA to Virtual address
 376  */
 377 #define DPAA2_MODIFY_IOVA_TO_VADDR(_mem, _type) \
 378         {_mem = (_type)(dpaa2_mem_ptov((size_t)(_mem))); }
 379
 380 #else   /* RTE_LIBRTE_DPAA2_USE_PHYS_IOVA */
 381
 382 #define DPAA2_MBUF_VADDR_TO_IOVA(mbuf) ((mbuf)->buf_addr)
 383 #define DPAA2_VADDR_TO_IOVA(_vaddr) (_vaddr)
 384 #define DPAA2_IOVA_TO_VADDR(_iova) (_iova)
 385 #define DPAA2_MODIFY_IOVA_TO_VADDR(_mem, _type)
 386
 387 #endif /* RTE_LIBRTE_DPAA2_USE_PHYS_IOVA */
 388
 389 static inline
 390 int check_swp_active_dqs(uint16_t dpio_index)
 391 {
 392         if (rte_global_active_dqs_list[dpio_index].global_active_dqs != NULL)
 393                 return 1;
 394         return 0;
 395 }
 396
 397 static inline
 398 void clear_swp_active_dqs(uint16_t dpio_index)
 399 {
 400         rte_global_active_dqs_list[dpio_index].global_active_dqs = NULL;
 401 }
 402
 403 static inline
 404 struct qbman_result *get_swp_active_dqs(uint16_t dpio_index)
 405 {
 406         return rte_global_active_dqs_list[dpio_index].global_active_dqs;
 407 }
 408
 409 static inline
 410 void set_swp_active_dqs(uint16_t dpio_index, struct qbman_result *dqs)
 411 {
 412         rte_global_active_dqs_list[dpio_index].global_active_dqs = dqs;
 413 }
 414 struct dpaa2_dpbp_dev *dpaa2_alloc_dpbp_dev(void);
 415 void dpaa2_free_dpbp_dev(struct dpaa2_dpbp_dev *dpbp);
 416 int dpaa2_dpbp_supported(void);
 417
 418 struct dpaa2_dpci_dev *rte_dpaa2_alloc_dpci_dev(void);
 419 void rte_dpaa2_free_dpci_dev(struct dpaa2_dpci_dev *dpci);
 420
 421 #endif