1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright (c) 2021 NVIDIA Corporation & Affiliates
6 * This header file must be included only by drivers.
7 * It is considered internal, i.e. hidden for the application.
8 * The prefix rte_ is used to avoid namespace clash in drivers.
11 #ifndef RTE_GPUDEV_DRIVER_H
12 #define RTE_GPUDEV_DRIVER_H
15 #include <sys/queue.h>
19 #include "rte_gpudev.h"
21 /* Flags indicate current state of device. */
23 RTE_GPU_STATE_UNUSED, /* not initialized */
24 RTE_GPU_STATE_INITIALIZED, /* initialized */
28 typedef int (rte_gpu_close_t)(struct rte_gpu *dev);
29 typedef int (rte_gpu_info_get_t)(struct rte_gpu *dev, struct rte_gpu_info *info);
30 typedef int (rte_gpu_mem_alloc_t)(struct rte_gpu *dev, size_t size, unsigned int align, void **ptr);
31 typedef int (rte_gpu_mem_free_t)(struct rte_gpu *dev, void *ptr);
32 typedef int (rte_gpu_mem_register_t)(struct rte_gpu *dev, size_t size, void *ptr);
33 typedef int (rte_gpu_mem_unregister_t)(struct rte_gpu *dev, void *ptr);
34 typedef int (rte_gpu_mem_cpu_map_t)(struct rte_gpu *dev, size_t size, void *ptr_in, void **ptr_out);
35 typedef int (rte_gpu_mem_cpu_unmap_t)(struct rte_gpu *dev, void *ptr);
36 typedef int (rte_gpu_wmb_t)(struct rte_gpu *dev);
39 /* Get device info. If NULL, info is just copied. */
40 rte_gpu_info_get_t *dev_info_get;
41 /* Close device or child context. */
42 rte_gpu_close_t *dev_close;
43 /* Allocate memory in device. */
44 rte_gpu_mem_alloc_t *mem_alloc;
45 /* Free memory allocated in device. */
46 rte_gpu_mem_free_t *mem_free;
47 /* Register CPU memory in device. */
48 rte_gpu_mem_register_t *mem_register;
49 /* Unregister CPU memory from device. */
50 rte_gpu_mem_unregister_t *mem_unregister;
51 /* Map GPU memory for CPU visibility. */
52 rte_gpu_mem_cpu_map_t *mem_cpu_map;
53 /* Unmap GPU memory for CPU visibility. */
54 rte_gpu_mem_cpu_unmap_t *mem_cpu_unmap;
55 /* Enforce GPU write memory barrier. */
59 struct rte_gpu_mpshared {
60 /* Unique identifier name. */
61 char name[RTE_DEV_NAME_MAX_LEN]; /* Updated by this library. */
62 /* Driver-specific private data shared in multi-process. */
64 /* Device info structure. */
65 struct rte_gpu_info info;
66 /* Counter of processes using the device. */
67 uint16_t process_refcnt; /* Updated by this library. */
72 struct rte_device *device;
73 /* Data shared between processes. */
74 struct rte_gpu_mpshared *mpshared;
75 /* Driver functions. */
76 struct rte_gpu_ops ops;
77 /* Event callback list. */
78 TAILQ_HEAD(rte_gpu_callback_list, rte_gpu_callback) callbacks;
79 /* Current state (used or not) in the running process. */
80 enum rte_gpu_state process_state; /* Updated by this library. */
81 /* Driver-specific private data for the running process. */
82 void *process_private;
83 } __rte_cache_aligned;
86 struct rte_gpu *rte_gpu_get_by_name(const char *name);
88 /* First step of initialization in primary process. */
90 struct rte_gpu *rte_gpu_allocate(const char *name);
92 /* First step of initialization in secondary process. */
94 struct rte_gpu *rte_gpu_attach(const char *name);
96 /* Last step of initialization. */
98 void rte_gpu_complete_new(struct rte_gpu *dev);
100 /* Last step of removal (primary or secondary process). */
102 int rte_gpu_release(struct rte_gpu *dev);
104 /* Call registered callbacks. No multi-process event. */
106 void rte_gpu_notify(struct rte_gpu *dev, enum rte_gpu_event);
108 #endif /* RTE_GPUDEV_DRIVER_H */