drm/doc: Add GEM/CMA helpers to kerneldoc
[deliverable/linux.git] / include / drm / drm_gem_cma_helper.h
CommitLineData
b9d47450
SH
1#ifndef __DRM_GEM_CMA_HELPER_H__
2#define __DRM_GEM_CMA_HELPER_H__
3
740c22ae 4#include <drm/drmP.h>
d9fc9413 5#include <drm/drm_gem.h>
740c22ae 6
d7883f87
TR
7/**
8 * struct drm_gem_cma_object - GEM object backed by CMA memory allocations
9 * @base: base GEM object
10 * @paddr: physical address of the backing memory
11 * @sgt: scatter/gather table for imported PRIME buffers
12 * @vaddr: kernel virtual address of the backing memory
13 */
b9d47450
SH
14struct drm_gem_cma_object {
15 struct drm_gem_object base;
16 dma_addr_t paddr;
71d7282a
LP
17 struct sg_table *sgt;
18
19 /* For objects with DMA memory allocated by GEM CMA */
b9d47450
SH
20 void *vaddr;
21};
22
23static inline struct drm_gem_cma_object *
24to_drm_gem_cma_obj(struct drm_gem_object *gem_obj)
25{
26 return container_of(gem_obj, struct drm_gem_cma_object, base);
27}
28
d7883f87 29/* free GEM object */
b9d47450
SH
30void drm_gem_cma_free_object(struct drm_gem_object *gem_obj);
31
d7883f87 32/* create memory region for DRM framebuffer */
b9d47450 33int drm_gem_cma_dumb_create(struct drm_file *file_priv,
d7883f87
TR
34 struct drm_device *drm,
35 struct drm_mode_create_dumb *args);
b9d47450 36
d7883f87 37/* map memory region for DRM framebuffer to user space */
b9d47450 38int drm_gem_cma_dumb_map_offset(struct drm_file *file_priv,
d7883f87
TR
39 struct drm_device *drm, u32 handle,
40 u64 *offset);
b9d47450 41
d7883f87 42/* set vm_flags and we can change the VM attribute to other one at here */
b9d47450
SH
43int drm_gem_cma_mmap(struct file *filp, struct vm_area_struct *vma);
44
d7883f87 45/* allocate physical memory */
b9d47450 46struct drm_gem_cma_object *drm_gem_cma_create(struct drm_device *drm,
d7883f87 47 size_t size);
b9d47450
SH
48
49extern const struct vm_operations_struct drm_gem_cma_vm_ops;
50
6f646095
RC
51#ifdef CONFIG_DEBUG_FS
52void drm_gem_cma_describe(struct drm_gem_cma_object *obj, struct seq_file *m);
53#endif
54
78467dc5
JS
55struct sg_table *drm_gem_cma_prime_get_sg_table(struct drm_gem_object *obj);
56struct drm_gem_object *
b5e9c1a2
ML
57drm_gem_cma_prime_import_sg_table(struct drm_device *dev,
58 struct dma_buf_attachment *attach,
78467dc5
JS
59 struct sg_table *sgt);
60int drm_gem_cma_prime_mmap(struct drm_gem_object *obj,
61 struct vm_area_struct *vma);
62void *drm_gem_cma_prime_vmap(struct drm_gem_object *obj);
63void drm_gem_cma_prime_vunmap(struct drm_gem_object *obj, void *vaddr);
64
b9d47450 65#endif /* __DRM_GEM_CMA_HELPER_H__ */
This page took 0.118795 seconds and 5 git commands to generate.