1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
|
/*
* Copyright (c) 2017-2018, NVIDIA CORPORATION. All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
#ifndef NVGPU_DMA_H
#define NVGPU_DMA_H
#include <nvgpu/types.h>
struct gk20a;
struct vm_gk20a;
struct nvgpu_mem;
/*
* Flags for the below nvgpu_dma_{alloc,alloc_map}_flags*
*/
/*
* Don't create a virtual kernel mapping for the buffer but only allocate it;
* this may save some resources. The buffer can be mapped later explicitly.
*/
#define NVGPU_DMA_NO_KERNEL_MAPPING (1 << 0)
/*
* Don't allow building the buffer from individual pages but require a
* physically contiguous block.
*/
#define NVGPU_DMA_FORCE_CONTIGUOUS (1 << 1)
/*
* Make the mapping read-only.
*/
#define NVGPU_DMA_READ_ONLY (1 << 2)
/**
* nvgpu_iommuable - Check if GPU is behind IOMMU
*
* @g - The GPU.
*
* Returns true if the passed GPU is behind an IOMMU; false otherwise. If the
* GPU is iommuable then the DMA address in nvgpu_mem_sgl is valid.
*
* Note that even if a GPU is behind an IOMMU that does not necessarily mean the
* GPU _must_ use DMA addresses. GPUs may still use physical addresses if it
* makes sense.
*/
bool nvgpu_iommuable(struct gk20a *g);
/**
* nvgpu_dma_alloc - Allocate DMA memory
*
* @g - The GPU.
* @size - Size of the allocation in bytes.
* @mem - Struct for storing the allocation information.
*
* Allocate memory suitable for doing DMA. Store the allocation info in @mem.
* Returns 0 on success and a suitable error code when there's an error. This
* memory can be either placed in VIDMEM or SYSMEM, which ever is more
* convenient for the driver.
*/
int nvgpu_dma_alloc(struct gk20a *g, size_t size, struct nvgpu_mem *mem);
/**
* nvgpu_dma_alloc_flags - Allocate DMA memory
*
* @g - The GPU.
* @flags - Flags modifying the operation of the DMA allocation.
* @size - Size of the allocation in bytes.
* @mem - Struct for storing the allocation information.
*
* Allocate memory suitable for doing DMA. Store the allocation info in @mem.
* Returns 0 on success and a suitable error code when there's an error. This
* memory can be either placed in VIDMEM or SYSMEM, which ever is more
* convenient for the driver.
*
* The following flags are accepted:
*
* %NVGPU_DMA_NO_KERNEL_MAPPING
* %NVGPU_DMA_FORCE_CONTIGUOUS
* %NVGPU_DMA_READ_ONLY
*/
int nvgpu_dma_alloc_flags(struct gk20a *g, unsigned long flags, size_t size,
struct nvgpu_mem *mem);
/**
* nvgpu_dma_alloc_sys - Allocate DMA memory
*
* @g - The GPU.
* @size - Size of the allocation in bytes.
* @mem - Struct for storing the allocation information.
*
* Allocate memory suitable for doing DMA. Store the allocation info in @mem.
* Returns 0 on success and a suitable error code when there's an error. This
* allocates memory specifically in SYSMEM.
*/
int nvgpu_dma_alloc_sys(struct gk20a *g, size_t size, struct nvgpu_mem *mem);
/**
* nvgpu_dma_alloc_flags_sys - Allocate DMA memory
*
* @g - The GPU.
* @flags - Flags modifying the operation of the DMA allocation.
* @size - Size of the allocation in bytes.
* @mem - Struct for storing the allocation information.
*
* Allocate memory suitable for doing DMA. Store the allocation info in @mem.
* Returns 0 on success and a suitable error code when there's an error. This
* allocates memory specifically in SYSMEM.
*
* The following flags are accepted:
*
* %NVGPU_DMA_NO_KERNEL_MAPPING
* %NVGPU_DMA_FORCE_CONTIGUOUS
* %NVGPU_DMA_READ_ONLY
*/
int nvgpu_dma_alloc_flags_sys(struct gk20a *g, unsigned long flags,
size_t size, struct nvgpu_mem *mem);
/**
* nvgpu_dma_alloc_vid - Allocate DMA memory
*
* @g - The GPU.
* @size - Size of the allocation in bytes.
* @mem - Struct for storing the allocation information.
*
* Allocate memory suitable for doing DMA. Store the allocation info in @mem.
* Returns 0 on success and a suitable error code when there's an error. This
* allocates memory specifically in VIDMEM.
*/
int nvgpu_dma_alloc_vid(struct gk20a *g, size_t size, struct nvgpu_mem *mem);
/**
* nvgpu_dma_alloc_flags_vid - Allocate DMA memory
*
* @g - The GPU.
* @flags - Flags modifying the operation of the DMA allocation.
* @size - Size of the allocation in bytes.
* @mem - Struct for storing the allocation information.
*
* Allocate memory suitable for doing DMA. Store the allocation info in @mem.
* Returns 0 on success and a suitable error code when there's an error. This
* allocates memory specifically in VIDMEM.
*
* Only the following flags are accepted:
*
* %NVGPU_DMA_NO_KERNEL_MAPPING
*
*/
int nvgpu_dma_alloc_flags_vid(struct gk20a *g, unsigned long flags,
size_t size, struct nvgpu_mem *mem);
/**
* nvgpu_dma_alloc_flags_vid_at - Allocate DMA memory
*
* @g - The GPU.
* @size - Size of the allocation in bytes.
* @mem - Struct for storing the allocation information.
* @at - A specific location to attempt to allocate memory from or 0 if the
* caller does not care what the address is.
*
* Allocate memory suitable for doing DMA. Store the allocation info in @mem.
* Returns 0 on success and a suitable error code when there's an error. This
* allocates memory specifically in VIDMEM.
*
*/
int nvgpu_dma_alloc_vid_at(struct gk20a *g,
size_t size, struct nvgpu_mem *mem, u64 at);
/**
* nvgpu_dma_alloc_flags_vid_at - Allocate DMA memory
*
* @g - The GPU.
* @flags - Flags modifying the operation of the DMA allocation.
* @size - Size of the allocation in bytes.
* @mem - Struct for storing the allocation information.
* @at - A specific location to attempt to allocate memory from or 0 if the
* caller does not care what the address is.
*
* Allocate memory suitable for doing DMA. Store the allocation info in @mem.
* Returns 0 on success and a suitable error code when there's an error. This
* allocates memory specifically in VIDMEM.
*
* Only the following flags are accepted:
*
* %NVGPU_DMA_NO_KERNEL_MAPPING
*/
int nvgpu_dma_alloc_flags_vid_at(struct gk20a *g, unsigned long flags,
size_t size, struct nvgpu_mem *mem, u64 at);
/**
* nvgpu_dma_free - Free a DMA allocation
*
* @g - The GPU.
* @mem - An allocation to free.
*
* Free memory created with any of:
*
* nvgpu_dma_alloc()
* nvgpu_dma_alloc_flags()
* nvgpu_dma_alloc_sys()
* nvgpu_dma_alloc_flags_sys()
* nvgpu_dma_alloc_vid()
* nvgpu_dma_alloc_flags_vid()
* nvgpu_dma_alloc_flags_vid_at()
*/
void nvgpu_dma_free(struct gk20a *g, struct nvgpu_mem *mem);
/**
* nvgpu_dma_alloc_map - Allocate DMA memory and map into GMMU.
*
* @vm - VM context for GMMU mapping.
* @size - Size of the allocation in bytes.
* @mem - Struct for storing the allocation information.
*
* Allocate memory suitable for doing DMA and map that memory into the GMMU.
* Note this is different than mapping it into the CPU. This memory can be
* either placed in VIDMEM or SYSMEM, which ever is more convenient for the
* driver.
*
* Note: currently a bug exists in the nvgpu_dma_alloc_map*() routines: you
* cannot use nvgpu_gmmu_map() on said buffer - it will overwrite the necessary
* information for the DMA unmap routines to actually unmap the buffer. You
* will either leak mappings or see GMMU faults.
*/
int nvgpu_dma_alloc_map(struct vm_gk20a *vm, size_t size,
struct nvgpu_mem *mem);
/**
* nvgpu_dma_alloc_map_flags - Allocate DMA memory and map into GMMU.
*
* @vm - VM context for GMMU mapping.
* @flags - Flags modifying the operation of the DMA allocation.
* @size - Size of the allocation in bytes.
* @mem - Struct for storing the allocation information.
*
* Allocate memory suitable for doing DMA and map that memory into the GMMU.
* Note this is different than mapping it into the CPU. This memory can be
* either placed in VIDMEM or SYSMEM, which ever is more convenient for the
* driver.
*
* This version passes @flags on to the underlying DMA allocation. The accepted
* flags are:
*
* %NVGPU_DMA_NO_KERNEL_MAPPING
* %NVGPU_DMA_FORCE_CONTIGUOUS
* %NVGPU_DMA_READ_ONLY
*/
int nvgpu_dma_alloc_map_flags(struct vm_gk20a *vm, unsigned long flags,
size_t size, struct nvgpu_mem *mem);
/**
* nvgpu_dma_alloc_map_sys - Allocate DMA memory and map into GMMU.
*
* @vm - VM context for GMMU mapping.
* @size - Size of the allocation in bytes.
* @mem - Struct for storing the allocation information.
*
* Allocate memory suitable for doing DMA and map that memory into the GMMU.
* This memory will be placed in SYSMEM.
*/
int nvgpu_dma_alloc_map_sys(struct vm_gk20a *vm, size_t size,
struct nvgpu_mem *mem);
/**
* nvgpu_dma_alloc_map_flags_sys - Allocate DMA memory and map into GMMU.
*
* @vm - VM context for GMMU mapping.
* @flags - Flags modifying the operation of the DMA allocation.
* @size - Size of the allocation in bytes.
* @mem - Struct for storing the allocation information.
*
* Allocate memory suitable for doing DMA and map that memory into the GMMU.
* This memory will be placed in SYSMEM.
*
* This version passes @flags on to the underlying DMA allocation. The accepted
* flags are:
*
* %NVGPU_DMA_NO_KERNEL_MAPPING
* %NVGPU_DMA_FORCE_CONTIGUOUS
* %NVGPU_DMA_READ_ONLY
*/
int nvgpu_dma_alloc_map_flags_sys(struct vm_gk20a *vm, unsigned long flags,
size_t size, struct nvgpu_mem *mem);
/**
* nvgpu_dma_alloc_map_vid - Allocate DMA memory and map into GMMU.
*
* @vm - VM context for GMMU mapping.
* @size - Size of the allocation in bytes.
* @mem - Struct for storing the allocation information.
*
* Allocate memory suitable for doing DMA and map that memory into the GMMU.
* This memory will be placed in VIDMEM.
*/
int nvgpu_dma_alloc_map_vid(struct vm_gk20a *vm, size_t size,
struct nvgpu_mem *mem);
/**
* nvgpu_dma_alloc_map_flags_vid - Allocate DMA memory and map into GMMU.
*
* @vm - VM context for GMMU mapping.
* @flags - Flags modifying the operation of the DMA allocation.
* @size - Size of the allocation in bytes.
* @mem - Struct for storing the allocation information.
*
* Allocate memory suitable for doing DMA and map that memory into the GMMU.
* This memory will be placed in VIDMEM.
*
* This version passes @flags on to the underlying DMA allocation. The accepted
* flags are:
*
* %NVGPU_DMA_NO_KERNEL_MAPPING
* %NVGPU_DMA_FORCE_CONTIGUOUS
* %NVGPU_DMA_READ_ONLY
*/
int nvgpu_dma_alloc_map_flags_vid(struct vm_gk20a *vm, unsigned long flags,
size_t size, struct nvgpu_mem *mem);
/**
* nvgpu_dma_unmap_free - Free a DMA allocation
*
* @g - The GPU.
* @mem - An allocation to free.
*
* Free memory created with any of:
*
* nvgpu_dma_alloc_map()
* nvgpu_dma_alloc_map_flags()
* nvgpu_dma_alloc_map_sys()
* nvgpu_dma_alloc_map_flags_sys()
* nvgpu_dma_alloc_map_vid()
* nvgpu_dma_alloc_map_flags_vid()
*/
void nvgpu_dma_unmap_free(struct vm_gk20a *vm, struct nvgpu_mem *mem);
/*
* Don't use these directly. Instead use nvgpu_dma_free().
*/
void nvgpu_dma_free_sys(struct gk20a *g, struct nvgpu_mem *mem);
void nvgpu_dma_free_vid(struct gk20a *g, struct nvgpu_mem *mem);
#endif /* NVGPU_DMA_H */
|