New upstream version 18.11-rc1
[deb_dpdk.git] / drivers / bus / dpaa / rte_dpaa_bus.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  *
3  *   Copyright 2017 NXP
4  *
5  */
6 #ifndef __RTE_DPAA_BUS_H__
7 #define __RTE_DPAA_BUS_H__
8
9 #include <rte_bus.h>
10 #include <rte_mempool.h>
11 #include <dpaax_iova_table.h>
12
13 #include <fsl_usd.h>
14 #include <fsl_qman.h>
15 #include <fsl_bman.h>
16 #include <of.h>
17 #include <netcfg.h>
18
19 #define DPAA_MEMPOOL_OPS_NAME   "dpaa"
20
21 #define DEV_TO_DPAA_DEVICE(ptr) \
22                 container_of(ptr, struct rte_dpaa_device, device)
23
24 /* DPAA SoC identifier; If this is not available, it can be concluded
25  * that board is non-DPAA. Single slot is currently supported.
26  */
27 #define DPAA_SOC_ID_FILE        "/sys/devices/soc0/soc_id"
28
29 #define SVR_LS1043A_FAMILY      0x87920000
30 #define SVR_LS1046A_FAMILY      0x87070000
31 #define SVR_MASK                0xffff0000
32
33 extern unsigned int dpaa_svr_family;
34
35 extern RTE_DEFINE_PER_LCORE(bool, dpaa_io);
36
37 struct rte_dpaa_device;
38 struct rte_dpaa_driver;
39
40 /* DPAA Device and Driver lists for DPAA bus */
41 TAILQ_HEAD(rte_dpaa_device_list, rte_dpaa_device);
42 TAILQ_HEAD(rte_dpaa_driver_list, rte_dpaa_driver);
43
44 /* Configuration variables exported from DPAA bus */
45 extern struct netcfg_info *dpaa_netcfg;
46
47 enum rte_dpaa_type {
48         FSL_DPAA_ETH = 1,
49         FSL_DPAA_CRYPTO,
50 };
51
52 struct rte_dpaa_bus {
53         struct rte_bus bus;
54         struct rte_dpaa_device_list device_list;
55         struct rte_dpaa_driver_list driver_list;
56         int device_count;
57 };
58
59 struct dpaa_device_id {
60         uint8_t fman_id; /**< Fman interface ID, for ETH type device */
61         uint8_t mac_id; /**< Fman MAC interface ID, for ETH type device */
62         uint16_t dev_id; /**< Device Identifier from DPDK */
63 };
64
65 struct rte_dpaa_device {
66         TAILQ_ENTRY(rte_dpaa_device) next;
67         struct rte_device device;
68         union {
69                 struct rte_eth_dev *eth_dev;
70                 struct rte_cryptodev *crypto_dev;
71         };
72         struct rte_dpaa_driver *driver;
73         struct dpaa_device_id id;
74         enum rte_dpaa_type device_type; /**< Ethernet or crypto type device */
75         char name[RTE_ETH_NAME_MAX_LEN];
76 };
77
78 typedef int (*rte_dpaa_probe_t)(struct rte_dpaa_driver *dpaa_drv,
79                                 struct rte_dpaa_device *dpaa_dev);
80 typedef int (*rte_dpaa_remove_t)(struct rte_dpaa_device *dpaa_dev);
81
82 struct rte_dpaa_driver {
83         TAILQ_ENTRY(rte_dpaa_driver) next;
84         struct rte_driver driver;
85         struct rte_dpaa_bus *dpaa_bus;
86         enum rte_dpaa_type drv_type;
87         rte_dpaa_probe_t probe;
88         rte_dpaa_remove_t remove;
89 };
90
91 struct dpaa_portal {
92         uint32_t bman_idx; /**< BMAN Portal ID*/
93         uint32_t qman_idx; /**< QMAN Portal ID*/
94         uint64_t tid;/**< Parent Thread id for this portal */
95 };
96
97 /* Various structures representing contiguous memory maps */
98 struct dpaa_memseg {
99         TAILQ_ENTRY(dpaa_memseg) next;
100         char *vaddr;
101         rte_iova_t iova;
102         size_t len;
103 };
104
105 TAILQ_HEAD(dpaa_memseg_list, dpaa_memseg);
106 extern struct dpaa_memseg_list rte_dpaa_memsegs;
107
108 /* Either iterate over the list of internal memseg references or fallback to
109  * EAL memseg based iova2virt.
110  */
111 static inline void *rte_dpaa_mem_ptov(phys_addr_t paddr)
112 {
113         struct dpaa_memseg *ms;
114         void *va;
115
116         va = dpaax_iova_table_get_va(paddr);
117         if (likely(va != NULL))
118                 return va;
119
120         /* Check if the address is already part of the memseg list internally
121          * maintained by the dpaa driver.
122          */
123         TAILQ_FOREACH(ms, &rte_dpaa_memsegs, next) {
124                 if (paddr >= ms->iova && paddr <
125                         ms->iova + ms->len)
126                         return RTE_PTR_ADD(ms->vaddr, (uintptr_t)(paddr - ms->iova));
127         }
128
129         /* If not, Fallback to full memseg list searching */
130         return rte_mem_iova2virt(paddr);
131 }
132
133 /**
134  * Register a DPAA driver.
135  *
136  * @param driver
137  *   A pointer to a rte_dpaa_driver structure describing the driver
138  *   to be registered.
139  */
140 void rte_dpaa_driver_register(struct rte_dpaa_driver *driver);
141
142 /**
143  * Unregister a DPAA driver.
144  *
145  * @param driver
146  *      A pointer to a rte_dpaa_driver structure describing the driver
147  *      to be unregistered.
148  */
149 void rte_dpaa_driver_unregister(struct rte_dpaa_driver *driver);
150
151 /**
152  * Initialize a DPAA portal
153  *
154  * @param arg
155  *      Per thread ID
156  *
157  * @return
158  *      0 in case of success, error otherwise
159  */
160 int rte_dpaa_portal_init(void *arg);
161
162 int rte_dpaa_portal_fq_init(void *arg, struct qman_fq *fq);
163
164 int rte_dpaa_portal_fq_close(struct qman_fq *fq);
165
166 /**
167  * Cleanup a DPAA Portal
168  */
169 void dpaa_portal_finish(void *arg);
170
171 /** Helper for DPAA device registration from driver (eth, crypto) instance */
172 #define RTE_PMD_REGISTER_DPAA(nm, dpaa_drv) \
173 RTE_INIT(dpaainitfn_ ##nm) \
174 {\
175         (dpaa_drv).driver.name = RTE_STR(nm);\
176         rte_dpaa_driver_register(&dpaa_drv); \
177 } \
178 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
179
180 /* Create storage for dqrr entries per lcore */
181 #define DPAA_PORTAL_DEQUEUE_DEPTH       16
182 struct dpaa_portal_dqrr {
183         void *mbuf[DPAA_PORTAL_DEQUEUE_DEPTH];
184         uint64_t dqrr_held;
185         uint8_t dqrr_size;
186 };
187
188 RTE_DECLARE_PER_LCORE(struct dpaa_portal_dqrr, held_bufs);
189
190 #define DPAA_PER_LCORE_DQRR_SIZE       RTE_PER_LCORE(held_bufs).dqrr_size
191 #define DPAA_PER_LCORE_DQRR_HELD       RTE_PER_LCORE(held_bufs).dqrr_held
192 #define DPAA_PER_LCORE_DQRR_MBUF(i)    RTE_PER_LCORE(held_bufs).mbuf[i]
193
194 #ifdef __cplusplus
195 }
196 #endif
197
198 #endif /* __RTE_DPAA_BUS_H__ */