History

drm/cma-helper: Pass GEM CMA object in public interfaces

Change all GEM CMA object functions that receive a GEM object of type struct drm_gem_object to expect an object of type struct drm_gem_cma_object instead. This change reduces the number of upcasts from struct drm_gem_object by moving them into callers. The C compiler can now verify that the GEM CMA functions are called with the correct type. For consistency, the patch also renames drm_gem_cma_free_object to drm_gem_cma_free. It further updates documentation for a number of functions.

Thomas Zimmermann committed 5 years ago

Commit e580ea21 parent 05b1de53 files · +48 −47Browse files

Unified · Split

3 files
  1. drivers/gpu/drm/drm_gem_cma_helper.c +24 −28
  2. drivers/gpu/drm/vc4/vc4_bo.c +2 −2
  3. include/drm/drm_gem_cma_helper.h +22 −17
drivers/gpu/drm/drm_gem_cma_helper.c+24−28
@@ -32,6 +32,10 @@ · 31 unmodified lines
32 * The DRM GEM/CMA helpers use this allocator as a means to provide buffer32 * The DRM GEM/CMA helpers use this allocator as a means to provide buffer
33 * objects that are physically contiguous in memory. This is useful for33 * objects that are physically contiguous in memory. This is useful for
34 * display drivers that are unable to map scattered buffers via an IOMMU.34 * display drivers that are unable to map scattered buffers via an IOMMU.
35 *
36 * For GEM callback helpers in struct &drm_gem_object functions, see likewise
37 * named functions with an _object_ infix (e.g., drm_gem_cma_object_vmap() wraps
38 * drm_gem_cma_vmap()). These helpers perform the necessary type conversion.
35 */39 */
36 40
37static const struct drm_gem_object_funcs drm_gem_cma_default_funcs = {41static const struct drm_gem_object_funcs drm_gem_cma_default_funcs = {
@@ -192,16 +196,16 @@ drm_gem_cma_create_with_handle(struct drm_file *file_priv, · 154 unmodified lines
192}196}
193 197
194/**198/**
195 * drm_gem_cma_free_object - free resources associated with a CMA GEM object199 * drm_gem_cma_free - free resources associated with a CMA GEM object
196 * @gem_obj: GEM object to free200 * @cma_obj: CMA GEM object to free
197 *201 *
198 * This function frees the backing memory of the CMA GEM object, cleans up the202 * This function frees the backing memory of the CMA GEM object, cleans up the
199 * GEM object state and frees the memory used to store the object itself.203 * GEM object state and frees the memory used to store the object itself.
200 * If the buffer is imported and the virtual address is set, it is released.204 * If the buffer is imported and the virtual address is set, it is released.
201 */205 */
202void drm_gem_cma_free_object(struct drm_gem_object *gem_obj)206void drm_gem_cma_free(struct drm_gem_cma_object *cma_obj)
203{207{
204 struct drm_gem_cma_object *cma_obj = to_drm_gem_cma_obj(gem_obj);208 struct drm_gem_object *gem_obj = &cma_obj->base;
205 struct dma_buf_map map = DMA_BUF_MAP_INIT_VADDR(cma_obj->vaddr);209 struct dma_buf_map map = DMA_BUF_MAP_INIT_VADDR(cma_obj->vaddr);
206 210
207 if (gem_obj->import_attach) {211 if (gem_obj->import_attach) {
@@ -217,7 +221,7 @@ void drm_gem_cma_free_object(struct drm_gem_object *gem_obj) · 9 unmodified lines
217 221
218 kfree(cma_obj);222 kfree(cma_obj);
219}223}
220EXPORT_SYMBOL_GPL(drm_gem_cma_free_object);224EXPORT_SYMBOL_GPL(drm_gem_cma_free);
221 225
222/**226/**
223 * drm_gem_cma_dumb_create_internal - create a dumb buffer object227 * drm_gem_cma_dumb_create_internal - create a dumb buffer object
@@ -364,18 +368,15 @@ EXPORT_SYMBOL_GPL(drm_gem_cma_get_unmapped_area); · 140 unmodified lines
364 368
365/**369/**
366 * drm_gem_cma_print_info() - Print &drm_gem_cma_object info for debugfs370 * drm_gem_cma_print_info() - Print &drm_gem_cma_object info for debugfs
371 * @cma_obj: CMA GEM object
367 * @p: DRM printer372 * @p: DRM printer
368 * @indent: Tab indentation level373 * @indent: Tab indentation level
369 * @obj: GEM object
370 *374 *
371 * This function can be used as the &drm_driver->gem_print_info callback.375 * This function prints paddr and vaddr for use in e.g. debugfs output.
372 * It prints paddr and vaddr for use in e.g. debugfs output.
373 */376 */
374void drm_gem_cma_print_info(struct drm_printer *p, unsigned int indent,377void drm_gem_cma_print_info(const struct drm_gem_cma_object *cma_obj,
375 const struct drm_gem_object *obj)378 struct drm_printer *p, unsigned int indent)
376{379{
377 const struct drm_gem_cma_object *cma_obj = to_drm_gem_cma_obj(obj);
378
379 drm_printf_indent(p, indent, "paddr=%pad\n", &cma_obj->paddr);380 drm_printf_indent(p, indent, "paddr=%pad\n", &cma_obj->paddr);
380 drm_printf_indent(p, indent, "vaddr=%p\n", cma_obj->vaddr);381 drm_printf_indent(p, indent, "vaddr=%p\n", cma_obj->vaddr);
381}382}
@@ -384,7 +385,7 @@ EXPORT_SYMBOL(drm_gem_cma_print_info); · 2 unmodified lines
384/**385/**
385 * drm_gem_cma_get_sg_table - provide a scatter/gather table of pinned386 * drm_gem_cma_get_sg_table - provide a scatter/gather table of pinned
386 * pages for a CMA GEM object387 * pages for a CMA GEM object
387 * @obj: GEM object388 * @cma_obj: CMA GEM object
388 *389 *
389 * This function exports a scatter/gather table by calling the standard390 * This function exports a scatter/gather table by calling the standard
390 * DMA mapping API.391 * DMA mapping API.
@@ -392,9 +393,9 @@ EXPORT_SYMBOL(drm_gem_cma_print_info); · 1 unmodified line
392 * Returns:393 * Returns:
393 * A pointer to the scatter/gather table of pinned pages or NULL on failure.394 * A pointer to the scatter/gather table of pinned pages or NULL on failure.
394 */395 */
395struct sg_table *drm_gem_cma_get_sg_table(struct drm_gem_object *obj)396struct sg_table *drm_gem_cma_get_sg_table(struct drm_gem_cma_object *cma_obj)
396{397{
397 struct drm_gem_cma_object *cma_obj = to_drm_gem_cma_obj(obj);398 struct drm_gem_object *obj = &cma_obj->base;
398 struct sg_table *sgt;399 struct sg_table *sgt;
399 int ret;400 int ret;
400 401
@@ -460,22 +461,19 @@ EXPORT_SYMBOL_GPL(drm_gem_cma_prime_import_sg_table); · 59 unmodified lines
460/**461/**
461 * drm_gem_cma_vmap - map a CMA GEM object into the kernel's virtual462 * drm_gem_cma_vmap - map a CMA GEM object into the kernel's virtual
462 * address space463 * address space
463 * @obj: GEM object464 * @cma_obj: CMA GEM object
464 * @map: Returns the kernel virtual address of the CMA GEM object's backing465 * @map: Returns the kernel virtual address of the CMA GEM object's backing
465 * store.466 * store.
466 *467 *
467 * This function maps a buffer into the kernel's468 * This function maps a buffer into the kernel's virtual address space.
468 * virtual address space. Since the CMA buffers are already mapped into the469 * Since the CMA buffers are already mapped into the kernel virtual address
469 * kernel virtual address space this simply returns the cached virtual470 * space this simply returns the cached virtual address.
470 * address.
471 *471 *
472 * Returns:472 * Returns:
473 * 0 on success, or a negative error code otherwise.473 * 0 on success, or a negative error code otherwise.
474 */474 */
475int drm_gem_cma_vmap(struct drm_gem_object *obj, struct dma_buf_map *map)475int drm_gem_cma_vmap(struct drm_gem_cma_object *cma_obj, struct dma_buf_map *map)
476{476{
477 struct drm_gem_cma_object *cma_obj = to_drm_gem_cma_obj(obj);
478
479 dma_buf_map_set_vaddr(map, cma_obj->vaddr);477 dma_buf_map_set_vaddr(map, cma_obj->vaddr);
480 478
481 return 0;479 return 0;
@@ -484,7 +482,7 @@ EXPORT_SYMBOL_GPL(drm_gem_cma_vmap); · 2 unmodified lines
484 482
485/**483/**
486 * drm_gem_cma_mmap - memory-map an exported CMA GEM object484 * drm_gem_cma_mmap - memory-map an exported CMA GEM object
487 * @obj: GEM object485 * @cma_obj: CMA GEM object
488 * @vma: VMA for the area to be mapped486 * @vma: VMA for the area to be mapped
489 *487 *
490 * This function maps a buffer into a userspace process's address space.488 * This function maps a buffer into a userspace process's address space.
@@ -494,9 +492,9 @@ EXPORT_SYMBOL_GPL(drm_gem_cma_vmap); · 3 unmodified lines
494 * Returns:492 * Returns:
495 * 0 on success or a negative error code on failure.493 * 0 on success or a negative error code on failure.
496 */494 */
497int drm_gem_cma_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma)495int drm_gem_cma_mmap(struct drm_gem_cma_object *cma_obj, struct vm_area_struct *vma)
498{496{
499 struct drm_gem_cma_object *cma_obj;497 struct drm_gem_object *obj = &cma_obj->base;
500 int ret;498 int ret;
501 499
502 /*500 /*
@@ -507,8 +505,6 @@ int drm_gem_cma_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma) · 4 unmodified lines
507 vma->vm_pgoff -= drm_vma_node_start(&obj->vma_node);505 vma->vm_pgoff -= drm_vma_node_start(&obj->vma_node);
508 vma->vm_flags &= ~VM_PFNMAP;506 vma->vm_flags &= ~VM_PFNMAP;
509 507
510 cma_obj = to_drm_gem_cma_obj(obj);
511
512 if (cma_obj->map_noncoherent) {508 if (cma_obj->map_noncoherent) {
513 vma->vm_page_prot = vm_get_page_prot(vma->vm_flags);509 vma->vm_page_prot = vm_get_page_prot(vma->vm_flags);
514 510
drivers/gpu/drm/vc4/vc4_bo.c+2−2
@@ -177,7 +177,7 @@ static void vc4_bo_destroy(struct vc4_bo *bo) · 176 unmodified lines
177 bo->validated_shader = NULL;177 bo->validated_shader = NULL;
178 }178 }
179 179
180 drm_gem_cma_free_object(obj);180 drm_gem_cma_free(&bo->base);
181}181}
182 182
183static void vc4_bo_remove_from_cache(struct vc4_bo *bo)183static void vc4_bo_remove_from_cache(struct vc4_bo *bo)
@@ -720,7 +720,7 @@ static int vc4_gem_object_mmap(struct drm_gem_object *obj, struct vm_area_struct · 536 unmodified lines
720 return -EINVAL;720 return -EINVAL;
721 }721 }
722 722
723 return drm_gem_cma_mmap(obj, vma);723 return drm_gem_cma_mmap(&bo->base, vma);
724}724}
725 725
726static const struct vm_operations_struct vc4_vm_ops = {726static const struct vm_operations_struct vc4_vm_ops = {
include/drm/drm_gem_cma_helper.h+22−17
@@ -32,28 +32,23 @@ struct drm_gem_cma_object { · 31 unmodified lines
32#define to_drm_gem_cma_obj(gem_obj) \32#define to_drm_gem_cma_obj(gem_obj) \
33 container_of(gem_obj, struct drm_gem_cma_object, base)33 container_of(gem_obj, struct drm_gem_cma_object, base)
34 34
35/* free GEM object */
36void drm_gem_cma_free_object(struct drm_gem_object *gem_obj);
37
38/* allocate physical memory */
39struct drm_gem_cma_object *drm_gem_cma_create(struct drm_device *drm,35struct drm_gem_cma_object *drm_gem_cma_create(struct drm_device *drm,
40 size_t size);36 size_t size);
37void drm_gem_cma_free(struct drm_gem_cma_object *cma_obj);
38void drm_gem_cma_print_info(const struct drm_gem_cma_object *cma_obj,
39 struct drm_printer *p, unsigned int indent);
40struct sg_table *drm_gem_cma_get_sg_table(struct drm_gem_cma_object *cma_obj);
41int drm_gem_cma_vmap(struct drm_gem_cma_object *cma_obj, struct dma_buf_map *map);
42int drm_gem_cma_mmap(struct drm_gem_cma_object *cma_obj, struct vm_area_struct *vma);
41 43
42extern const struct vm_operations_struct drm_gem_cma_vm_ops;44extern const struct vm_operations_struct drm_gem_cma_vm_ops;
43 45
44void drm_gem_cma_print_info(struct drm_printer *p, unsigned int indent,
45 const struct drm_gem_object *obj);
46
47struct sg_table *drm_gem_cma_get_sg_table(struct drm_gem_object *obj);
48int drm_gem_cma_vmap(struct drm_gem_object *obj, struct dma_buf_map *map);
49int drm_gem_cma_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma);
50
51/*46/*
52 * GEM object functions47 * GEM object functions
53 */48 */
54 49
55/**50/**
56 * drm_gem_cma_object_free - GEM object function for drm_gem_cma_free_object()51 * drm_gem_cma_object_free - GEM object function for drm_gem_cma_free()
57 * @obj: GEM object to free52 * @obj: GEM object to free
58 *53 *
59 * This function wraps drm_gem_cma_free_object(). Drivers that employ the CMA helpers54 * This function wraps drm_gem_cma_free_object(). Drivers that employ the CMA helpers
@@ -61,7 +56,9 @@ int drm_gem_cma_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma); · 1 unmodified line
61 */56 */
62static inline void drm_gem_cma_object_free(struct drm_gem_object *obj)57static inline void drm_gem_cma_object_free(struct drm_gem_object *obj)
63{58{
64 drm_gem_cma_free_object(obj);59 struct drm_gem_cma_object *cma_obj = to_drm_gem_cma_obj(obj);
60
61 drm_gem_cma_free(cma_obj);
65}62}
66 63
67/**64/**
@@ -76,7 +73,9 @@ static inline void drm_gem_cma_object_free(struct drm_gem_object *obj) · 8 unmodified lines
76static inline void drm_gem_cma_object_print_info(struct drm_printer *p, unsigned int indent,73static inline void drm_gem_cma_object_print_info(struct drm_printer *p, unsigned int indent,
77 const struct drm_gem_object *obj)74 const struct drm_gem_object *obj)
78{75{
79 drm_gem_cma_print_info(p, indent, obj);76 const struct drm_gem_cma_object *cma_obj = to_drm_gem_cma_obj(obj);
77
78 drm_gem_cma_print_info(cma_obj, p, indent);
80}79}
81 80
82/**81/**
@@ -91,7 +90,9 @@ static inline void drm_gem_cma_object_print_info(struct drm_printer *p, unsigned · 8 unmodified lines
91 */90 */
92static inline struct sg_table *drm_gem_cma_object_get_sg_table(struct drm_gem_object *obj)91static inline struct sg_table *drm_gem_cma_object_get_sg_table(struct drm_gem_object *obj)
93{92{
94 return drm_gem_cma_get_sg_table(obj);93 struct drm_gem_cma_object *cma_obj = to_drm_gem_cma_obj(obj);
94
95 return drm_gem_cma_get_sg_table(cma_obj);
95}96}
96 97
97/*98/*
@@ -107,7 +108,9 @@ static inline struct sg_table *drm_gem_cma_object_get_sg_table(struct drm_gem_ob · 9 unmodified lines
107 */108 */
108static inline int drm_gem_cma_object_vmap(struct drm_gem_object *obj, struct dma_buf_map *map)109static inline int drm_gem_cma_object_vmap(struct drm_gem_object *obj, struct dma_buf_map *map)
109{110{
110 return drm_gem_cma_vmap(obj, map);111 struct drm_gem_cma_object *cma_obj = to_drm_gem_cma_obj(obj);
112
113 return drm_gem_cma_vmap(cma_obj, map);
111}114}
112 115
113/**116/**
@@ -123,7 +126,9 @@ static inline int drm_gem_cma_object_vmap(struct drm_gem_object *obj, struct dma · 9 unmodified lines
123 */126 */
124static inline int drm_gem_cma_object_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma)127static inline int drm_gem_cma_object_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma)
125{128{
126 return drm_gem_cma_mmap(obj, vma);129 struct drm_gem_cma_object *cma_obj = to_drm_gem_cma_obj(obj);
130
131 return drm_gem_cma_mmap(cma_obj, vma);
127}132}
128 133
129/*134/*

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t