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