1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2018 Intel Corporation
5 #ifndef _OPAE_HW_API_H_
6 #define _OPAE_HW_API_H_
11 #include <sys/queue.h>
13 #include "opae_osdep.h"
14 #include "opae_intel_max10.h"
16 #ifndef PCI_MAX_RESOURCE
17 #define PCI_MAX_RESOURCE 6
22 enum opae_adapter_type {
27 /* OPAE Manager Data Structure */
28 struct opae_manager_ops;
29 struct opae_manager_networking_ops;
32 * opae_manager has pointer to its parent adapter, as it could be able to manage
33 * all components on this FPGA device (adapter). If not the case, don't set this
34 * adapter, which limit opae_manager ops to manager itself.
38 struct opae_adapter *adapter;
39 struct opae_manager_ops *ops;
40 struct opae_manager_networking_ops *network_ops;
44 /* FIXME: add more management ops, e.g power/thermal and etc */
45 struct opae_manager_ops {
46 int (*flash)(struct opae_manager *mgr, int id, void *buffer,
47 u32 size, u64 *status);
50 /* networking management ops in FME */
51 struct opae_manager_networking_ops {
52 int (*read_mac_rom)(struct opae_manager *mgr, int offset, void *buf,
54 int (*write_mac_rom)(struct opae_manager *mgr, int offset, void *buf,
58 /* OPAE Manager APIs */
60 opae_manager_alloc(const char *name, struct opae_manager_ops *ops,
61 struct opae_manager_networking_ops *network_ops, void *data);
62 #define opae_manager_free(mgr) opae_free(mgr)
63 int opae_manager_flash(struct opae_manager *mgr, int acc_id, void *buf,
64 u32 size, u64 *status);
66 /* OPAE Bridge Data Structure */
67 struct opae_bridge_ops;
70 * opae_bridge only has pointer to its downstream accelerator.
75 struct opae_accelerator *acc;
76 struct opae_bridge_ops *ops;
80 struct opae_bridge_ops {
81 int (*reset)(struct opae_bridge *br);
84 /* OPAE Bridge APIs */
86 opae_bridge_alloc(const char *name, struct opae_bridge_ops *ops, void *data);
87 int opae_bridge_reset(struct opae_bridge *br);
88 #define opae_bridge_free(br) opae_free(br)
90 /* OPAE Acceleraotr Data Structure */
91 struct opae_accelerator_ops;
94 * opae_accelerator has pointer to its upstream bridge(port).
95 * In some cases, if we allow same user to do PR on its own accelerator, then
96 * set the manager pointer during the enumeration. But in other cases, the PR
97 * functions only could be done via manager in another module / thread / service
98 * / application for better protection.
100 struct opae_accelerator {
101 TAILQ_ENTRY(opae_accelerator) node;
104 struct opae_bridge *br;
105 struct opae_manager *mgr;
106 struct opae_accelerator_ops *ops;
110 struct opae_acc_info {
111 unsigned int num_regions;
112 unsigned int num_irqs;
115 struct opae_acc_region_info {
117 #define ACC_REGION_READ (1 << 0)
118 #define ACC_REGION_WRITE (1 << 1)
119 #define ACC_REGION_MMIO (1 << 2)
126 struct opae_accelerator_ops {
127 int (*read)(struct opae_accelerator *acc, unsigned int region_idx,
128 u64 offset, unsigned int byte, void *data);
129 int (*write)(struct opae_accelerator *acc, unsigned int region_idx,
130 u64 offset, unsigned int byte, void *data);
131 int (*get_info)(struct opae_accelerator *acc,
132 struct opae_acc_info *info);
133 int (*get_region_info)(struct opae_accelerator *acc,
134 struct opae_acc_region_info *info);
135 int (*set_irq)(struct opae_accelerator *acc,
136 u32 start, u32 count, s32 evtfds[]);
137 int (*get_uuid)(struct opae_accelerator *acc,
141 /* OPAE accelerator APIs */
142 struct opae_accelerator *
143 opae_accelerator_alloc(const char *name, struct opae_accelerator_ops *ops,
145 #define opae_accelerator_free(acc) opae_free(acc)
146 int opae_acc_get_info(struct opae_accelerator *acc, struct opae_acc_info *info);
147 int opae_acc_get_region_info(struct opae_accelerator *acc,
148 struct opae_acc_region_info *info);
149 int opae_acc_set_irq(struct opae_accelerator *acc,
150 u32 start, u32 count, s32 evtfds[]);
151 int opae_acc_get_uuid(struct opae_accelerator *acc,
154 static inline struct opae_bridge *
155 opae_acc_get_br(struct opae_accelerator *acc)
157 return acc ? acc->br : NULL;
160 static inline struct opae_manager *
161 opae_acc_get_mgr(struct opae_accelerator *acc)
163 return acc ? acc->mgr : NULL;
166 int opae_acc_reg_read(struct opae_accelerator *acc, unsigned int region_idx,
167 u64 offset, unsigned int byte, void *data);
168 int opae_acc_reg_write(struct opae_accelerator *acc, unsigned int region_idx,
169 u64 offset, unsigned int byte, void *data);
171 #define opae_acc_reg_read64(acc, region, offset, data) \
172 opae_acc_reg_read(acc, region, offset, 8, data)
173 #define opae_acc_reg_write64(acc, region, offset, data) \
174 opae_acc_reg_write(acc, region, offset, 8, data)
175 #define opae_acc_reg_read32(acc, region, offset, data) \
176 opae_acc_reg_read(acc, region, offset, 4, data)
177 #define opae_acc_reg_write32(acc, region, offset, data) \
178 opae_acc_reg_write(acc, region, offset, 4, data)
179 #define opae_acc_reg_read16(acc, region, offset, data) \
180 opae_acc_reg_read(acc, region, offset, 2, data)
181 #define opae_acc_reg_write16(acc, region, offset, data) \
182 opae_acc_reg_write(acc, region, offset, 2, data)
183 #define opae_acc_reg_read8(acc, region, offset, data) \
184 opae_acc_reg_read(acc, region, offset, 1, data)
185 #define opae_acc_reg_write8(acc, region, offset, data) \
186 opae_acc_reg_write(acc, region, offset, 1, data)
188 /*for data stream read/write*/
189 int opae_acc_data_read(struct opae_accelerator *acc, unsigned int flags,
190 u64 offset, unsigned int byte, void *data);
191 int opae_acc_data_write(struct opae_accelerator *acc, unsigned int flags,
192 u64 offset, unsigned int byte, void *data);
194 /* OPAE Adapter Data Structure */
195 struct opae_adapter_data {
196 enum opae_adapter_type type;
199 struct opae_reg_region {
205 struct opae_adapter_data_pci {
206 enum opae_adapter_type type;
209 struct opae_reg_region region[PCI_MAX_RESOURCE];
210 int vfio_dev_fd; /* VFIO device file descriptor */
213 /* FIXME: OPAE_FPGA_NET type */
214 struct opae_adapter_data_net {
215 enum opae_adapter_type type;
218 struct opae_adapter_ops {
219 int (*enumerate)(struct opae_adapter *adapter);
220 void (*destroy)(struct opae_adapter *adapter);
223 TAILQ_HEAD(opae_accelerator_list, opae_accelerator);
225 #define opae_adapter_for_each_acc(adatper, acc) \
226 TAILQ_FOREACH(acc, &adapter->acc_list, node)
228 struct opae_adapter {
230 struct opae_manager *mgr;
231 struct opae_accelerator_list acc_list;
232 struct opae_adapter_ops *ops;
236 /* OPAE Adapter APIs */
237 void *opae_adapter_data_alloc(enum opae_adapter_type type);
238 #define opae_adapter_data_free(data) opae_free(data)
240 int opae_adapter_init(struct opae_adapter *adapter,
241 const char *name, void *data);
242 #define opae_adapter_free(adapter) opae_free(adapter)
244 int opae_adapter_enumerate(struct opae_adapter *adapter);
245 void opae_adapter_destroy(struct opae_adapter *adapter);
246 static inline struct opae_manager *
247 opae_adapter_get_mgr(struct opae_adapter *adapter)
249 return adapter ? adapter->mgr : NULL;
252 struct opae_accelerator *
253 opae_adapter_get_acc(struct opae_adapter *adapter, int acc_id);
255 static inline void opae_adapter_add_acc(struct opae_adapter *adapter,
256 struct opae_accelerator *acc)
258 TAILQ_INSERT_TAIL(&adapter->acc_list, acc, node);
261 static inline void opae_adapter_remove_acc(struct opae_adapter *adapter,
262 struct opae_accelerator *acc)
264 TAILQ_REMOVE(&adapter->acc_list, acc, node);
267 /* OPAE vBNG network datastruct */
268 #define OPAE_ETHER_ADDR_LEN 6
270 struct opae_ether_addr {
271 unsigned char addr_bytes[OPAE_ETHER_ADDR_LEN];
272 } __attribute__((__packed__));
274 /* OPAE vBNG network API*/
275 int opae_manager_read_mac_rom(struct opae_manager *mgr, int port,
276 struct opae_ether_addr *addr);
277 int opae_manager_write_mac_rom(struct opae_manager *mgr, int port,
278 struct opae_ether_addr *addr);
279 #endif /* _OPAE_HW_API_H_*/