drivers/bus/fslmc/portal/dpaa2_hw_pvt.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright (c) 2016 Freescale Semiconductor, Inc. All rights reserved.
   5  *   Copyright (c) 2016 NXP. All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Freescale Semiconductor, Inc nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _DPAA2_HW_PVT_H_
  35 #define _DPAA2_HW_PVT_H_
  36
  37 #include <rte_eventdev.h>
  38
  39 #include <mc/fsl_mc_sys.h>
  40 #include <fsl_qbman_portal.h>
  41
  42 #ifndef false
  43 #define false      0
  44 #endif
  45 #ifndef true
  46 #define true       1
  47 #endif
  48 #define lower_32_bits(x) ((uint32_t)(x))
  49 #define upper_32_bits(x) ((uint32_t)(((x) >> 16) >> 16))
  50
  51 #define SVR_LS1080A             0x87030000
  52 #define SVR_LS2080A             0x87010000
  53 #define SVR_LS2088A             0x87090000
  54
  55 #ifndef ETH_VLAN_HLEN
  56 #define ETH_VLAN_HLEN   4 /** < Vlan Header Length */
  57 #endif
  58
  59 #define MAX_TX_RING_SLOTS       8
  60         /** <Maximum number of slots available in TX ring*/
  61
  62 #define DPAA2_DQRR_RING_SIZE    16
  63         /** <Maximum number of slots available in RX ring*/
  64
  65 #define MC_PORTAL_INDEX         0
  66 #define NUM_DPIO_REGIONS        2
  67 #define NUM_DQS_PER_QUEUE       2
  68
  69 /* Maximum release/acquire from QBMAN */
  70 #define DPAA2_MBUF_MAX_ACQ_REL  7
  71
  72 #define MAX_BPID 256
  73 #define DPAA2_MBUF_HW_ANNOTATION        64
  74 #define DPAA2_FD_PTA_SIZE               0
  75
  76 #if (DPAA2_MBUF_HW_ANNOTATION + DPAA2_FD_PTA_SIZE) > RTE_PKTMBUF_HEADROOM
  77 #error "Annotation requirement is more than RTE_PKTMBUF_HEADROOM"
  78 #endif
  79
  80 /* we will re-use the HEADROOM for annotation in RX */
  81 #define DPAA2_HW_BUF_RESERVE    0
  82 #define DPAA2_PACKET_LAYOUT_ALIGN       64 /*changing from 256 */
  83
  84 #define DPAA2_DPCI_MAX_QUEUES 2
  85
  86 struct dpaa2_dpio_dev {
  87         TAILQ_ENTRY(dpaa2_dpio_dev) next;
  88                 /**< Pointer to Next device instance */
  89         uint16_t index; /**< Index of a instance in the list */
  90         rte_atomic16_t ref_count;
  91                 /**< How many thread contexts are sharing this.*/
  92         struct fsl_mc_io *dpio; /** handle to DPIO portal object */
  93         uint16_t token;
  94         struct qbman_swp *sw_portal; /** SW portal object */
  95         const struct qbman_result *dqrr[4];
  96                 /**< DQRR Entry for this SW portal */
  97         void *mc_portal; /**< MC Portal for configuring this device */
  98         uintptr_t qbman_portal_ce_paddr;
  99                 /**< Physical address of Cache Enabled Area */
 100         uintptr_t ce_size; /**< Size of the CE region */
 101         uintptr_t qbman_portal_ci_paddr;
 102                 /**< Physical address of Cache Inhibit Area */
 103         uintptr_t ci_size; /**< Size of the CI region */
 104         int32_t vfio_fd; /**< File descriptor received via VFIO */
 105         int32_t hw_id; /**< An unique ID of this DPIO device instance */
 106         uint64_t dqrr_held;
 107         uint8_t dqrr_size;
 108 };
 109
 110 struct dpaa2_dpbp_dev {
 111         TAILQ_ENTRY(dpaa2_dpbp_dev) next;
 112                 /**< Pointer to Next device instance */
 113         struct fsl_mc_io dpbp;  /** handle to DPBP portal object */
 114         uint16_t token;
 115         rte_atomic16_t in_use;
 116         uint32_t dpbp_id; /*HW ID for DPBP object */
 117 };
 118
 119 struct queue_storage_info_t {
 120         struct qbman_result *dq_storage[NUM_DQS_PER_QUEUE];
 121         struct qbman_result *active_dqs;
 122         int active_dpio_id;
 123         int toggle;
 124 };
 125
 126 typedef void (dpaa2_queue_cb_dqrr_t)(struct qbman_swp *swp,
 127                 const struct qbman_fd *fd,
 128                 const struct qbman_result *dq,
 129                 struct rte_event *ev);
 130
 131 struct dpaa2_queue {
 132         struct rte_mempool *mb_pool; /**< mbuf pool to populate RX ring. */
 133         void *dev;
 134         int32_t eventfd;        /*!< Event Fd of this queue */
 135         uint32_t fqid;          /*!< Unique ID of this queue */
 136         uint8_t tc_index;       /*!< traffic class identifier */
 137         uint16_t flow_id;       /*!< To be used by DPAA2 frmework */
 138         uint64_t rx_pkts;
 139         uint64_t tx_pkts;
 140         uint64_t err_pkts;
 141         union {
 142                 struct queue_storage_info_t *q_storage;
 143                 struct qbman_result *cscn;
 144         };
 145         dpaa2_queue_cb_dqrr_t *cb;
 146 };
 147
 148 struct swp_active_dqs {
 149         struct qbman_result *global_active_dqs;
 150         uint64_t reserved[7];
 151 };
 152
 153 #define NUM_MAX_SWP 64
 154
 155 extern struct swp_active_dqs rte_global_active_dqs_list[NUM_MAX_SWP];
 156
 157 struct dpaa2_dpci_dev {
 158         TAILQ_ENTRY(dpaa2_dpci_dev) next;
 159                 /**< Pointer to Next device instance */
 160         struct fsl_mc_io dpci;  /** handle to DPCI portal object */
 161         uint16_t token;
 162         rte_atomic16_t in_use;
 163         uint32_t dpci_id; /*HW ID for DPCI object */
 164         struct dpaa2_queue queue[DPAA2_DPCI_MAX_QUEUES];
 165 };
 166
 167 /*! Global MCP list */
 168 extern void *(*rte_mcp_ptr_list);
 169
 170 /* Refer to Table 7-3 in SEC BG */
 171 struct qbman_fle {
 172         uint32_t addr_lo;
 173         uint32_t addr_hi;
 174         uint32_t length;
 175         /* FMT must be 00, MSB is final bit  */
 176         uint32_t fin_bpid_offset;
 177         uint32_t frc;
 178         uint32_t reserved[3]; /* Not used currently */
 179 };
 180
 181 struct qbman_sge {
 182         uint32_t addr_lo;
 183         uint32_t addr_hi;
 184         uint32_t length;
 185         uint32_t fin_bpid_offset;
 186 };
 187
 188 /* There are three types of frames: Single, Scatter Gather and Frame Lists */
 189 enum qbman_fd_format {
 190         qbman_fd_single = 0,
 191         qbman_fd_list,
 192         qbman_fd_sg
 193 };
 194 /*Macros to define operations on FD*/
 195 #define DPAA2_SET_FD_ADDR(fd, addr) do {                        \
 196         fd->simple.addr_lo = lower_32_bits((uint64_t)(addr));   \
 197         fd->simple.addr_hi = upper_32_bits((uint64_t)(addr));   \
 198 } while (0)
 199 #define DPAA2_SET_FD_LEN(fd, length)    (fd)->simple.len = length
 200 #define DPAA2_SET_FD_BPID(fd, bpid)     ((fd)->simple.bpid_offset |= bpid)
 201 #define DPAA2_SET_FD_IVP(fd)   ((fd->simple.bpid_offset |= 0x00004000))
 202 #define DPAA2_SET_FD_OFFSET(fd, offset) \
 203         ((fd->simple.bpid_offset |= (uint32_t)(offset) << 16))
 204 #define DPAA2_SET_FD_INTERNAL_JD(fd, len) fd->simple.frc = (0x80000000 | (len))
 205 #define DPAA2_SET_FD_FRC(fd, frc)       fd->simple.frc = frc
 206 #define DPAA2_RESET_FD_CTRL(fd) (fd)->simple.ctrl = 0
 207
 208 #define DPAA2_SET_FD_ASAL(fd, asal)     ((fd)->simple.ctrl |= (asal << 16))
 209 #define DPAA2_SET_FD_FLC(fd, addr)      do { \
 210         fd->simple.flc_lo = lower_32_bits((uint64_t)(addr));    \
 211         fd->simple.flc_hi = upper_32_bits((uint64_t)(addr));    \
 212 } while (0)
 213 #define DPAA2_SET_FLE_INTERNAL_JD(fle, len) (fle->frc = (0x80000000 | (len)))
 214 #define DPAA2_GET_FLE_ADDR(fle)                                 \
 215         (uint64_t)((((uint64_t)(fle->addr_hi)) << 32) + fle->addr_lo)
 216 #define DPAA2_SET_FLE_ADDR(fle, addr) do { \
 217         fle->addr_lo = lower_32_bits((uint64_t)addr);     \
 218         fle->addr_hi = upper_32_bits((uint64_t)addr);     \
 219 } while (0)
 220 #define DPAA2_GET_FLE_CTXT(fle)                                 \
 221         (uint64_t)((((uint64_t)((fle)->reserved[1])) << 32) + \
 222                         (fle)->reserved[0])
 223 #define DPAA2_FLE_SAVE_CTXT(fle, addr) do { \
 224         fle->reserved[0] = lower_32_bits((uint64_t)addr);     \
 225         fle->reserved[1] = upper_32_bits((uint64_t)addr);         \
 226 } while (0)
 227 #define DPAA2_SET_FLE_OFFSET(fle, offset) \
 228         ((fle)->fin_bpid_offset |= (uint32_t)(offset) << 16)
 229 #define DPAA2_SET_FLE_BPID(fle, bpid) ((fle)->fin_bpid_offset |= (uint64_t)bpid)
 230 #define DPAA2_GET_FLE_BPID(fle) ((fle)->fin_bpid_offset & 0x000000ff)
 231 #define DPAA2_SET_FLE_FIN(fle)  (fle->fin_bpid_offset |= (uint64_t)1 << 31)
 232 #define DPAA2_SET_FLE_IVP(fle)   (((fle)->fin_bpid_offset |= 0x00004000))
 233 #define DPAA2_SET_FD_COMPOUND_FMT(fd)   \
 234         (fd->simple.bpid_offset |= (uint32_t)1 << 28)
 235 #define DPAA2_GET_FD_ADDR(fd)   \
 236 ((uint64_t)((((uint64_t)((fd)->simple.addr_hi)) << 32) + (fd)->simple.addr_lo))
 237
 238 #define DPAA2_GET_FD_LEN(fd)    ((fd)->simple.len)
 239 #define DPAA2_GET_FD_BPID(fd)   (((fd)->simple.bpid_offset & 0x00003FFF))
 240 #define DPAA2_GET_FD_IVP(fd)   ((fd->simple.bpid_offset & 0x00004000) >> 14)
 241 #define DPAA2_GET_FD_OFFSET(fd) (((fd)->simple.bpid_offset & 0x0FFF0000) >> 16)
 242 #define DPAA2_GET_FLE_OFFSET(fle) (((fle)->fin_bpid_offset & 0x0FFF0000) >> 16)
 243 #define DPAA2_SET_FLE_SG_EXT(fle) (fle->fin_bpid_offset |= (uint64_t)1 << 29)
 244 #define DPAA2_IS_SET_FLE_SG_EXT(fle)    \
 245         ((fle->fin_bpid_offset & ((uint64_t)1 << 29)) ? 1 : 0)
 246
 247 #define DPAA2_INLINE_MBUF_FROM_BUF(buf, meta_data_size) \
 248         ((struct rte_mbuf *)((uint64_t)(buf) - (meta_data_size)))
 249
 250 #define DPAA2_ASAL_VAL (DPAA2_MBUF_HW_ANNOTATION / 64)
 251
 252 #define DPAA2_FD_SET_FORMAT(fd, format) do {                            \
 253                 (fd)->simple.bpid_offset &= 0xCFFFFFFF;                 \
 254                 (fd)->simple.bpid_offset |= (uint32_t)format << 28;     \
 255 } while (0)
 256 #define DPAA2_FD_GET_FORMAT(fd) (((fd)->simple.bpid_offset >> 28) & 0x3)
 257
 258 #define DPAA2_SG_SET_FINAL(sg, fin)     do {                            \
 259                 (sg)->fin_bpid_offset &= 0x7FFFFFFF;                    \
 260                 (sg)->fin_bpid_offset |= (uint32_t)fin << 31;           \
 261 } while (0)
 262 #define DPAA2_SG_IS_FINAL(sg) (!!((sg)->fin_bpid_offset >> 31))
 263 /* Only Enqueue Error responses will be
 264  * pushed on FQID_ERR of Enqueue FQ
 265  */
 266 #define DPAA2_EQ_RESP_ERR_FQ            0
 267 /* All Enqueue responses will be pushed on address
 268  * set with qbman_eq_desc_set_response
 269  */
 270 #define DPAA2_EQ_RESP_ALWAYS            1
 271
 272 #ifdef RTE_LIBRTE_DPAA2_USE_PHYS_IOVA
 273 static void *dpaa2_mem_ptov(phys_addr_t paddr) __attribute__((unused));
 274 /* todo - this is costly, need to write a fast coversion routine */
 275 static void *dpaa2_mem_ptov(phys_addr_t paddr)
 276 {
 277         const struct rte_memseg *memseg = rte_eal_get_physmem_layout();
 278         int i;
 279
 280         for (i = 0; i < RTE_MAX_MEMSEG && memseg[i].addr_64 != 0; i++) {
 281                 if (paddr >= memseg[i].phys_addr &&
 282                    (char *)paddr < (char *)memseg[i].phys_addr + memseg[i].len)
 283                         return (void *)(memseg[i].addr_64
 284                                 + (paddr - memseg[i].phys_addr));
 285         }
 286         return NULL;
 287 }
 288
 289 static phys_addr_t dpaa2_mem_vtop(uint64_t vaddr) __attribute__((unused));
 290 static phys_addr_t dpaa2_mem_vtop(uint64_t vaddr)
 291 {
 292         const struct rte_memseg *memseg = rte_eal_get_physmem_layout();
 293         int i;
 294
 295         for (i = 0; i < RTE_MAX_MEMSEG && memseg[i].addr_64 != 0; i++) {
 296                 if (vaddr >= memseg[i].addr_64 &&
 297                     vaddr < memseg[i].addr_64 + memseg[i].len)
 298                         return memseg[i].phys_addr
 299                                 + (vaddr - memseg[i].addr_64);
 300         }
 301         return (phys_addr_t)(NULL);
 302 }
 303
 304 /**
 305  * When we are using Physical addresses as IO Virtual Addresses,
 306  * Need to call conversion routines dpaa2_mem_vtop & dpaa2_mem_ptov
 307  * wherever required.
 308  * These routines are called with help of below MACRO's
 309  */
 310
 311 #define DPAA2_MBUF_VADDR_TO_IOVA(mbuf) ((mbuf)->buf_physaddr)
 312 #define DPAA2_OP_VADDR_TO_IOVA(op) (op->phys_addr)
 313
 314 /**
 315  * macro to convert Virtual address to IOVA
 316  */
 317 #define DPAA2_VADDR_TO_IOVA(_vaddr) dpaa2_mem_vtop((uint64_t)(_vaddr))
 318
 319 /**
 320  * macro to convert IOVA to Virtual address
 321  */
 322 #define DPAA2_IOVA_TO_VADDR(_iova) dpaa2_mem_ptov((phys_addr_t)(_iova))
 323
 324 /**
 325  * macro to convert modify the memory containing IOVA to Virtual address
 326  */
 327 #define DPAA2_MODIFY_IOVA_TO_VADDR(_mem, _type) \
 328         {_mem = (_type)(dpaa2_mem_ptov((phys_addr_t)(_mem))); }
 329
 330 #else   /* RTE_LIBRTE_DPAA2_USE_PHYS_IOVA */
 331
 332 #define DPAA2_MBUF_VADDR_TO_IOVA(mbuf) ((mbuf)->buf_addr)
 333 #define DPAA2_OP_VADDR_TO_IOVA(op) (op)
 334 #define DPAA2_VADDR_TO_IOVA(_vaddr) (_vaddr)
 335 #define DPAA2_IOVA_TO_VADDR(_iova) (_iova)
 336 #define DPAA2_MODIFY_IOVA_TO_VADDR(_mem, _type)
 337
 338 #endif /* RTE_LIBRTE_DPAA2_USE_PHYS_IOVA */
 339
 340 static inline
 341 int check_swp_active_dqs(uint16_t dpio_index)
 342 {
 343         if (rte_global_active_dqs_list[dpio_index].global_active_dqs != NULL)
 344                 return 1;
 345         return 0;
 346 }
 347
 348 static inline
 349 void clear_swp_active_dqs(uint16_t dpio_index)
 350 {
 351         rte_global_active_dqs_list[dpio_index].global_active_dqs = NULL;
 352 }
 353
 354 static inline
 355 struct qbman_result *get_swp_active_dqs(uint16_t dpio_index)
 356 {
 357         return rte_global_active_dqs_list[dpio_index].global_active_dqs;
 358 }
 359
 360 static inline
 361 void set_swp_active_dqs(uint16_t dpio_index, struct qbman_result *dqs)
 362 {
 363         rte_global_active_dqs_list[dpio_index].global_active_dqs = dqs;
 364 }
 365 struct dpaa2_dpbp_dev *dpaa2_alloc_dpbp_dev(void);
 366 void dpaa2_free_dpbp_dev(struct dpaa2_dpbp_dev *dpbp);
 367
 368 struct dpaa2_dpci_dev *rte_dpaa2_alloc_dpci_dev(void);
 369 void rte_dpaa2_free_dpci_dev(struct dpaa2_dpci_dev *dpci);
 370
 371 #endif