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
3232 * The DRM GEM/CMA helpers use this allocator as a means to provide buffer
3333 * objects that are physically contiguous in memory. This is useful for
3434 * 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.
3539 */
3640
3741 static 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
192196 }
193197
194198 /**
195− * drm_gem_cma_free_object - free resources associated with a CMA GEM object
196− * @gem_obj: GEM object to free
199+ * drm_gem_cma_free - free resources associated with a CMA GEM object
200+ * @cma_obj: CMA GEM object to free
197201 *
198202 * This function frees the backing memory of the CMA GEM object, cleans up the
199203 * GEM object state and frees the memory used to store the object itself.
200204 * If the buffer is imported and the virtual address is set, it is released.
201205 */
202−void drm_gem_cma_free_object(struct drm_gem_object *gem_obj)
206+void drm_gem_cma_free(struct drm_gem_cma_object *cma_obj)
203207 {
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;
205209 struct dma_buf_map map = DMA_BUF_MAP_INIT_VADDR(cma_obj->vaddr);
206210
207211 if (gem_obj->import_attach) {
@@ -217,7 +221,7 @@ void drm_gem_cma_free_object(struct drm_gem_object *gem_obj) · 9 unmodified lines
217221
218222 kfree(cma_obj);
219223 }
220−EXPORT_SYMBOL_GPL(drm_gem_cma_free_object);
224+EXPORT_SYMBOL_GPL(drm_gem_cma_free);
221225
222226 /**
223227 * 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
364368
365369 /**
366370 * drm_gem_cma_print_info() - Print &drm_gem_cma_object info for debugfs
371+ * @cma_obj: CMA GEM object
367372 * @p: DRM printer
368373 * @indent: Tab indentation level
369− * @obj: GEM object
370374 *
371− * This function can be used as the &drm_driver->gem_print_info callback.
372− * It prints paddr and vaddr for use in e.g. debugfs output.
375+ * This function prints paddr and vaddr for use in e.g. debugfs output.
373376 */
374−void drm_gem_cma_print_info(struct drm_printer *p, unsigned int indent,
375− const struct drm_gem_object *obj)
377+void drm_gem_cma_print_info(const struct drm_gem_cma_object *cma_obj,
378+ struct drm_printer *p, unsigned int indent)
376379 {
377− const struct drm_gem_cma_object *cma_obj = to_drm_gem_cma_obj(obj);
378−
379380 drm_printf_indent(p, indent, "paddr=%pad\n", &cma_obj->paddr);
380381 drm_printf_indent(p, indent, "vaddr=%p\n", cma_obj->vaddr);
381382 }
@@ -384,7 +385,7 @@ EXPORT_SYMBOL(drm_gem_cma_print_info); · 2 unmodified lines
384385 /**
385386 * drm_gem_cma_get_sg_table - provide a scatter/gather table of pinned
386387 * pages for a CMA GEM object
387− * @obj: GEM object
388+ * @cma_obj: CMA GEM object
388389 *
389390 * This function exports a scatter/gather table by calling the standard
390391 * DMA mapping API.
@@ -392,9 +393,9 @@ EXPORT_SYMBOL(drm_gem_cma_print_info); · 1 unmodified line
392393 * Returns:
393394 * A pointer to the scatter/gather table of pinned pages or NULL on failure.
394395 */
395−struct sg_table *drm_gem_cma_get_sg_table(struct drm_gem_object *obj)
396+struct sg_table *drm_gem_cma_get_sg_table(struct drm_gem_cma_object *cma_obj)
396397 {
397− struct drm_gem_cma_object *cma_obj = to_drm_gem_cma_obj(obj);
398+ struct drm_gem_object *obj = &cma_obj->base;
398399 struct sg_table *sgt;
399400 int ret;
400401
@@ -460,22 +461,19 @@ EXPORT_SYMBOL_GPL(drm_gem_cma_prime_import_sg_table); · 59 unmodified lines
460461 /**
461462 * drm_gem_cma_vmap - map a CMA GEM object into the kernel's virtual
462463 * address space
463− * @obj: GEM object
464+ * @cma_obj: CMA GEM object
464465 * @map: Returns the kernel virtual address of the CMA GEM object's backing
465466 * store.
466467 *
467− * This function maps a buffer into the kernel's
468− * virtual address space. Since the CMA buffers are already mapped into the
469− * kernel virtual address space this simply returns the cached virtual
470− * address.
468+ * This function maps a buffer into the kernel's virtual address space.
469+ * Since the CMA buffers are already mapped into the kernel virtual address
470+ * space this simply returns the cached virtual address.
471471 *
472472 * Returns:
473473 * 0 on success, or a negative error code otherwise.
474474 */
475−int drm_gem_cma_vmap(struct drm_gem_object *obj, struct dma_buf_map *map)
475+int drm_gem_cma_vmap(struct drm_gem_cma_object *cma_obj, struct dma_buf_map *map)
476476 {
477− struct drm_gem_cma_object *cma_obj = to_drm_gem_cma_obj(obj);
478−
479477 dma_buf_map_set_vaddr(map, cma_obj->vaddr);
480478
481479 return 0;
@@ -484,7 +482,7 @@ EXPORT_SYMBOL_GPL(drm_gem_cma_vmap); · 2 unmodified lines
484482
485483 /**
486484 * drm_gem_cma_mmap - memory-map an exported CMA GEM object
487− * @obj: GEM object
485+ * @cma_obj: CMA GEM object
488486 * @vma: VMA for the area to be mapped
489487 *
490488 * 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
494492 * Returns:
495493 * 0 on success or a negative error code on failure.
496494 */
497−int drm_gem_cma_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma)
495+int drm_gem_cma_mmap(struct drm_gem_cma_object *cma_obj, struct vm_area_struct *vma)
498496 {
499− struct drm_gem_cma_object *cma_obj;
497+ struct drm_gem_object *obj = &cma_obj->base;
500498 int ret;
501499
502500 /*
@@ -507,8 +505,6 @@ int drm_gem_cma_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma) · 4 unmodified lines
507505 vma->vm_pgoff -= drm_vma_node_start(&obj->vma_node);
508506 vma->vm_flags &= ~VM_PFNMAP;
509507
510− cma_obj = to_drm_gem_cma_obj(obj);
511−
512508 if (cma_obj->map_noncoherent) {
513509 vma->vm_page_prot = vm_get_page_prot(vma->vm_flags);
514510
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
177177 bo->validated_shader = NULL;
178178 }
179179
180− drm_gem_cma_free_object(obj);
180+ drm_gem_cma_free(&bo->base);
181181 }
182182
183183 static 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
720720 return -EINVAL;
721721 }
722722
723− return drm_gem_cma_mmap(obj, vma);
723+ return drm_gem_cma_mmap(&bo->base, vma);
724724 }
725725
726726 static 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
3232 #define to_drm_gem_cma_obj(gem_obj) \
3333 container_of(gem_obj, struct drm_gem_cma_object, base)
3434
35−/* free GEM object */
36−void drm_gem_cma_free_object(struct drm_gem_object *gem_obj);
37−
38−/* allocate physical memory */
3935 struct drm_gem_cma_object *drm_gem_cma_create(struct drm_device *drm,
4036 size_t size);
37+void drm_gem_cma_free(struct drm_gem_cma_object *cma_obj);
38+void drm_gem_cma_print_info(const struct drm_gem_cma_object *cma_obj,
39+ struct drm_printer *p, unsigned int indent);
40+struct sg_table *drm_gem_cma_get_sg_table(struct drm_gem_cma_object *cma_obj);
41+int drm_gem_cma_vmap(struct drm_gem_cma_object *cma_obj, struct dma_buf_map *map);
42+int drm_gem_cma_mmap(struct drm_gem_cma_object *cma_obj, struct vm_area_struct *vma);
4143
4244 extern const struct vm_operations_struct drm_gem_cma_vm_ops;
4345
44−void drm_gem_cma_print_info(struct drm_printer *p, unsigned int indent,
45− const struct drm_gem_object *obj);
46−
47−struct sg_table *drm_gem_cma_get_sg_table(struct drm_gem_object *obj);
48−int drm_gem_cma_vmap(struct drm_gem_object *obj, struct dma_buf_map *map);
49−int drm_gem_cma_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma);
50−
5146 /*
5247 * GEM object functions
5348 */
5449
5550 /**
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()
5752 * @obj: GEM object to free
5853 *
5954 * 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
6156 */
6257 static inline void drm_gem_cma_object_free(struct drm_gem_object *obj)
6358 {
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);
6562 }
6663
6764 /**
@@ -76,7 +73,9 @@ static inline void drm_gem_cma_object_free(struct drm_gem_object *obj) · 8 unmodified lines
7673 static inline void drm_gem_cma_object_print_info(struct drm_printer *p, unsigned int indent,
7774 const struct drm_gem_object *obj)
7875 {
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);
8079 }
8180
8281 /**
@@ -91,7 +90,9 @@ static inline void drm_gem_cma_object_print_info(struct drm_printer *p, unsigned · 8 unmodified lines
9190 */
9291 static inline struct sg_table *drm_gem_cma_object_get_sg_table(struct drm_gem_object *obj)
9392 {
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);
9596 }
9697
9798 /*
@@ -107,7 +108,9 @@ static inline struct sg_table *drm_gem_cma_object_get_sg_table(struct drm_gem_ob · 9 unmodified lines
107108 */
108109 static inline int drm_gem_cma_object_vmap(struct drm_gem_object *obj, struct dma_buf_map *map)
109110 {
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);
111114 }
112115
113116 /**
@@ -123,7 +126,9 @@ static inline int drm_gem_cma_object_vmap(struct drm_gem_object *obj, struct dma · 9 unmodified lines
123126 */
124127 static inline int drm_gem_cma_object_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma)
125128 {
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);
127132 }
128133
129134 /*

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