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