aboutsummaryrefslogtreecommitdiffstats
path: root/include/nvgpu/vidmem.h
diff options
context:
space:
mode:
authorJoshua Bakita <bakitajoshua@gmail.com>2023-06-28 18:24:25 -0400
committerJoshua Bakita <bakitajoshua@gmail.com>2023-06-28 18:24:25 -0400
commit01e6fac4d61fdd7fff5433942ec93fc2ea1e4df1 (patch)
tree4ef34501728a087be24f4ba0af90f91486bf780b /include/nvgpu/vidmem.h
parent306a03d18b305e4e573be3b2931978fa10679eb9 (diff)
Include nvgpu headers
These are needed to build on NVIDIA's Jetson boards for the time being. Only a couple structs are required, so it should be fairly easy to remove this dependency at some point in the future.
Diffstat (limited to 'include/nvgpu/vidmem.h')
-rw-r--r--include/nvgpu/vidmem.h148
1 files changed, 148 insertions, 0 deletions
diff --git a/include/nvgpu/vidmem.h b/include/nvgpu/vidmem.h
new file mode 100644
index 0000000..4470232
--- /dev/null
+++ b/include/nvgpu/vidmem.h
@@ -0,0 +1,148 @@
1/*
2 * Copyright (c) 2017-2018, NVIDIA CORPORATION. All rights reserved.
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20 * DEALINGS IN THE SOFTWARE.
21 */
22
23#ifndef NVGPU_VIDMEM_H
24#define NVGPU_VIDMEM_H
25
26#include <nvgpu/types.h>
27#include <nvgpu/errno.h>
28
29struct gk20a;
30struct mm_gk20a;
31struct nvgpu_mem;
32
33struct nvgpu_vidmem_buf {
34 /*
35 * Must be a pointer since control of this mem is passed over to the
36 * vidmem background clearing thread when the vidmem buf is freed.
37 */
38 struct nvgpu_mem *mem;
39
40 struct gk20a *g;
41
42 /*
43 * Filled in by each OS - this holds the necessary data to export this
44 * buffer to userspace. This will eventually be replaced by a struct
45 * which shall be defined in the OS specific vidmem.h header file.
46 */
47 void *priv;
48};
49
50#if defined(CONFIG_GK20A_VIDMEM)
51
52/**
53 * nvgpu_vidmem_user_alloc - Allocates a vidmem buffer for userspace
54 *
55 * @g - The GPU.
56 * @bytes - Size of the buffer in bytes.
57 *
58 * Allocate a generic (OS agnostic) vidmem buffer. This does not allocate the OS
59 * specific interfacing for userspace sharing. Instead is is expected that the
60 * OS specific code will allocate that OS specific data and add it to this
61 * buffer.
62 *
63 * The buffer allocated here is intended to use used by userspace, hence the
64 * extra struct over nvgpu_mem. If a vidmem buffer is needed by the kernel
65 * driver only then a simple nvgpu_dma_alloc_vid() or the like is sufficient.
66 *
67 * Returns a pointer to a vidmem buffer on success, 0 otherwise.
68 */
69struct nvgpu_vidmem_buf *nvgpu_vidmem_user_alloc(struct gk20a *g, size_t bytes);
70
71void nvgpu_vidmem_buf_free(struct gk20a *g, struct nvgpu_vidmem_buf *buf);
72
73int nvgpu_vidmem_clear_list_enqueue(struct gk20a *g, struct nvgpu_mem *mem);
74
75bool nvgpu_addr_is_vidmem_page_alloc(u64 addr);
76int nvgpu_vidmem_get_space(struct gk20a *g, u64 *space);
77
78void nvgpu_vidmem_destroy(struct gk20a *g);
79int nvgpu_vidmem_init(struct mm_gk20a *mm);
80
81int nvgpu_vidmem_clear(struct gk20a *g, struct nvgpu_mem *mem);
82
83void nvgpu_vidmem_thread_pause_sync(struct mm_gk20a *mm);
84void nvgpu_vidmem_thread_unpause(struct mm_gk20a *mm);
85
86#else /* !defined(CONFIG_GK20A_VIDMEM) */
87
88/*
89 * When VIDMEM support is not present this interface is used.
90 */
91
92static inline bool nvgpu_addr_is_vidmem_page_alloc(u64 addr)
93{
94 return false;
95}
96
97static inline int nvgpu_vidmem_buf_alloc(struct gk20a *g, size_t bytes)
98{
99 return -ENOSYS;
100}
101
102static inline void nvgpu_vidmem_buf_free(struct gk20a *g,
103 struct nvgpu_vidmem_buf *buf)
104{
105}
106
107static inline int nvgpu_vidmem_get_space(struct gk20a *g, u64 *space)
108{
109 return -ENOSYS;
110}
111
112static inline void nvgpu_vidmem_destroy(struct gk20a *g)
113{
114}
115
116static inline int nvgpu_vidmem_init(struct mm_gk20a *mm)
117{
118 return 0;
119}
120
121static inline int nvgpu_vidmem_clear_all(struct gk20a *g)
122{
123 return -ENOSYS;
124}
125
126static inline int nvgpu_vidmem_clear(struct gk20a *g,
127 struct nvgpu_mem *mem)
128{
129 return -ENOSYS;
130}
131
132static inline void nvgpu_vidmem_thread_pause_sync(struct mm_gk20a *mm)
133{
134}
135
136static inline void nvgpu_vidmem_thread_unpause(struct mm_gk20a *mm)
137{
138}
139
140#endif /* !defined(CONFIG_GK20A_VIDMEM) */
141
142/*
143 * Simple macro for VIDMEM debugging.
144 */
145#define vidmem_dbg(g, fmt, args...) \
146 nvgpu_log(g, gpu_dbg_vidmem, fmt, ##args); \
147
148#endif /* NVGPU_VIDMEM_H */