1 /* exynos_drm_gem.h
2  *
3  * Copyright (c) 2011 Samsung Electronics Co., Ltd.
4  * Authoer: Inki Dae <inki.dae@samsung.com>
5  *
6  * This program is free software; you can redistribute  it and/or modify it
7  * under  the terms of  the GNU General  Public License as published by the
8  * Free Software Foundation;  either version 2 of the  License, or (at your
9  * option) any later version.
10  */
11 
12 #ifndef _EXYNOS_DRM_GEM_H_
13 #define _EXYNOS_DRM_GEM_H_
14 
15 #include <drm/drm_gem.h>
16 
17 #define to_exynos_gem(x)	container_of(x, struct exynos_drm_gem, base)
18 
19 #define IS_NONCONTIG_BUFFER(f)		(f & EXYNOS_BO_NONCONTIG)
20 
21 /*
22  * exynos drm buffer structure.
23  *
24  * @base: a gem object.
25  *	- a new handle to this gem object would be created
26  *	by drm_gem_handle_create().
27  * @buffer: a pointer to exynos_drm_gem_buffer object.
28  *	- contain the information to memory region allocated
29  *	by user request or at framebuffer creation.
30  *	continuous memory region allocated by user request
31  *	or at framebuffer creation.
32  * @flags: indicate memory type to allocated buffer and cache attruibute.
33  * @size: size requested from user, in bytes and this size is aligned
34  *	in page unit.
35  * @cookie: cookie returned by dma_alloc_attrs
36  * @kvaddr: kernel virtual address to allocated memory region.
37  * @dma_addr: bus address(accessed by dma) to allocated memory region.
38  *	- this address could be physical address without IOMMU and
39  *	device address with IOMMU.
40  * @pages: Array of backing pages.
41  * @sgt: Imported sg_table.
42  *
43  * P.S. this object would be transferred to user as kms_bo.handle so
44  *	user can access the buffer through kms_bo.handle.
45  */
46 struct exynos_drm_gem {
47 	struct drm_gem_object	base;
48 	unsigned int		flags;
49 	unsigned long		size;
50 	void			*cookie;
51 	void __iomem		*kvaddr;
52 	dma_addr_t		dma_addr;
53 	struct dma_attrs	dma_attrs;
54 	struct page		**pages;
55 	struct sg_table		*sgt;
56 };
57 
58 /* destroy a buffer with gem object */
59 void exynos_drm_gem_destroy(struct exynos_drm_gem *exynos_gem);
60 
61 /* create a new buffer with gem object */
62 struct exynos_drm_gem *exynos_drm_gem_create(struct drm_device *dev,
63 					     unsigned int flags,
64 					     unsigned long size);
65 
66 /*
67  * request gem object creation and buffer allocation as the size
68  * that it is calculated with framebuffer information such as width,
69  * height and bpp.
70  */
71 int exynos_drm_gem_create_ioctl(struct drm_device *dev, void *data,
72 				struct drm_file *file_priv);
73 
74 /*
75  * get dma address from gem handle and this function could be used for
76  * other drivers such as 2d/3d acceleration drivers.
77  * with this function call, gem object reference count would be increased.
78  */
79 dma_addr_t *exynos_drm_gem_get_dma_addr(struct drm_device *dev,
80 					unsigned int gem_handle,
81 					struct drm_file *filp);
82 
83 /*
84  * put dma address from gem handle and this function could be used for
85  * other drivers such as 2d/3d acceleration drivers.
86  * with this function call, gem object reference count would be decreased.
87  */
88 void exynos_drm_gem_put_dma_addr(struct drm_device *dev,
89 					unsigned int gem_handle,
90 					struct drm_file *filp);
91 
92 /* get buffer information to memory region allocated by gem. */
93 int exynos_drm_gem_get_ioctl(struct drm_device *dev, void *data,
94 				      struct drm_file *file_priv);
95 
96 /* get buffer size to gem handle. */
97 unsigned long exynos_drm_gem_get_size(struct drm_device *dev,
98 						unsigned int gem_handle,
99 						struct drm_file *file_priv);
100 
101 /* free gem object. */
102 void exynos_drm_gem_free_object(struct drm_gem_object *obj);
103 
104 /* create memory region for drm framebuffer. */
105 int exynos_drm_gem_dumb_create(struct drm_file *file_priv,
106 			       struct drm_device *dev,
107 			       struct drm_mode_create_dumb *args);
108 
109 /* map memory region for drm framebuffer to user space. */
110 int exynos_drm_gem_dumb_map_offset(struct drm_file *file_priv,
111 				   struct drm_device *dev, uint32_t handle,
112 				   uint64_t *offset);
113 
114 /* page fault handler and mmap fault address(virtual) to physical memory. */
115 int exynos_drm_gem_fault(struct vm_area_struct *vma, struct vm_fault *vmf);
116 
117 /* set vm_flags and we can change the vm attribute to other one at here. */
118 int exynos_drm_gem_mmap(struct file *filp, struct vm_area_struct *vma);
119 
120 /* map sgt with dma region. */
121 int exynos_gem_map_sgt_with_dma(struct drm_device *drm_dev,
122 				struct sg_table *sgt,
123 				enum dma_data_direction dir);
124 
125 /* unmap sgt from dma region. */
126 void exynos_gem_unmap_sgt_from_dma(struct drm_device *drm_dev,
127 				struct sg_table *sgt,
128 				enum dma_data_direction dir);
129 
130 /* low-level interface prime helpers */
131 struct sg_table *exynos_drm_gem_prime_get_sg_table(struct drm_gem_object *obj);
132 struct drm_gem_object *
133 exynos_drm_gem_prime_import_sg_table(struct drm_device *dev,
134 				     struct dma_buf_attachment *attach,
135 				     struct sg_table *sgt);
136 void *exynos_drm_gem_prime_vmap(struct drm_gem_object *obj);
137 void exynos_drm_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr);
138 
139 #endif
140