drivers/bus/fslmc/fslmc_vfio.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright (c) 2015-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 _FSLMC_VFIO_H_
  35 #define _FSLMC_VFIO_H_
  36
  37 #include "eal_vfio.h"
  38
  39 #define DPAA2_VENDOR_ID         0x1957
  40 #define DPAA2_MC_DPNI_DEVID     7
  41 #define DPAA2_MC_DPSECI_DEVID   3
  42 #define DPAA2_MC_DPCON_DEVID    5
  43 #define DPAA2_MC_DPIO_DEVID     9
  44 #define DPAA2_MC_DPBP_DEVID     10
  45
  46 #define VFIO_MAX_GRP 1
  47
  48 typedef struct fslmc_vfio_device {
  49         int fd; /* fslmc root container device ?? */
  50         int index; /*index of child object */
  51         struct fslmc_vfio_device *child; /* Child object */
  52 } fslmc_vfio_device;
  53
  54 typedef struct fslmc_vfio_group {
  55         int fd; /* /dev/vfio/"groupid" */
  56         int groupid;
  57         struct fslmc_vfio_container *container;
  58         int object_index;
  59         struct fslmc_vfio_device *vfio_device;
  60 } fslmc_vfio_group;
  61
  62 typedef struct fslmc_vfio_container {
  63         int fd; /* /dev/vfio/vfio */
  64         int used;
  65         int index; /* index in group list */
  66         struct fslmc_vfio_group *group_list[VFIO_MAX_GRP];
  67 } fslmc_vfio_container;
  68
  69 struct rte_dpaa2_object;
  70
  71 TAILQ_HEAD(rte_fslmc_object_list, rte_dpaa2_object);
  72
  73 typedef int (*rte_fslmc_obj_create_t)(struct fslmc_vfio_device *vdev,
  74                                          struct vfio_device_info *obj_info,
  75                                          int object_id);
  76
  77 /**
  78  * A structure describing a DPAA2 driver.
  79  */
  80 struct rte_dpaa2_object {
  81         TAILQ_ENTRY(rte_dpaa2_object) next; /**< Next in list. */
  82         const char *name;            /**< Name of Object. */
  83         uint16_t object_id;             /**< DPAA2 Object ID */
  84         rte_fslmc_obj_create_t create;
  85 };
  86
  87 int vfio_dmamap_mem_region(
  88         uint64_t vaddr,
  89         uint64_t iova,
  90         uint64_t size);
  91
  92 int fslmc_vfio_setup_group(void);
  93 int fslmc_vfio_process_group(void);
  94 int rte_fslmc_vfio_dmamap(void);
  95
  96 /**
  97  * Register a DPAA2 MC Object driver.
  98  *
  99  * @param mc_object
 100  *   A pointer to a rte_dpaa_object structure describing the mc object
 101  *   to be registered.
 102  */
 103 void rte_fslmc_object_register(struct rte_dpaa2_object *object);
 104
 105 /** Helper for DPAA2 object registration */
 106 #define RTE_PMD_REGISTER_DPAA2_OBJECT(nm, dpaa2_obj) \
 107 RTE_INIT(dpaa2objinitfn_ ##nm); \
 108 static void dpaa2objinitfn_ ##nm(void) \
 109 {\
 110         (dpaa2_obj).name = RTE_STR(nm);\
 111         rte_fslmc_object_register(&dpaa2_obj); \
 112 } \
 113 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
 114
 115 #endif /* _FSLMC_VFIO_H_ */