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