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 #include <linux/mm_types.h>
17 
18 #define to_exynos_gem(x)	container_of(x, struct exynos_drm_gem, base)
19 
20 #define IS_NONCONTIG_BUFFER(f)		(f & EXYNOS_BO_NONCONTIG)
21 
22 /*
23  * exynos drm buffer structure.
24  *
25  * @base: a gem object.
26  *	- a new handle to this gem object would be created
27  *	by drm_gem_handle_create().
28  * @buffer: a pointer to exynos_drm_gem_buffer object.
29  *	- contain the information to memory region allocated
30  *	by user request or at framebuffer creation.
31  *	continuous memory region allocated by user request
32  *	or at framebuffer creation.
33  * @flags: indicate memory type to allocated buffer and cache attruibute.
34  * @size: size requested from user, in bytes and this size is aligned
35  *	in page unit.
36  * @cookie: cookie returned by dma_alloc_attrs
37  * @kvaddr: kernel virtual address to allocated memory region.
38  * @dma_addr: bus address(accessed by dma) to allocated memory region.
39  *	- this address could be physical address without IOMMU and
40  *	device address with IOMMU.
41  * @pages: Array of backing pages.
42  * @sgt: Imported sg_table.
43  *
44  * P.S. this object would be transferred to user as kms_bo.handle so
45  *	user can access the buffer through kms_bo.handle.
46  */
47 struct exynos_drm_gem {
48 	struct drm_gem_object	base;
49 	unsigned int		flags;
50 	unsigned long		size;
51 	void			*cookie;
52 	void __iomem		*kvaddr;
53 	dma_addr_t		dma_addr;
54 	unsigned long		dma_attrs;
55 	struct page		**pages;
56 	struct sg_table		*sgt;
57 };
58 
59 /* destroy a buffer with gem object */
60 void exynos_drm_gem_destroy(struct exynos_drm_gem *exynos_gem);
61 
62 /* create a new buffer with gem object */
63 struct exynos_drm_gem *exynos_drm_gem_create(struct drm_device *dev,
64 					     unsigned int flags,
65 					     unsigned long size);
66 
67 /*
68  * request gem object creation and buffer allocation as the size
69  * that it is calculated with framebuffer information such as width,
70  * height and bpp.
71  */
72 int exynos_drm_gem_create_ioctl(struct drm_device *dev, void *data,
73 				struct drm_file *file_priv);
74 
75 /* get fake-offset of gem object that can be used with mmap. */
76 int exynos_drm_gem_map_ioctl(struct drm_device *dev, void *data,
77 			     struct drm_file *file_priv);
78 
79 /*
80  * get exynos drm object from gem handle, this function could be used for
81  * other drivers such as 2d/3d acceleration drivers.
82  * with this function call, gem object reference count would be increased.
83  */
84 struct exynos_drm_gem *exynos_drm_gem_get(struct drm_file *filp,
85 					  unsigned int gem_handle);
86 
87 /*
88  * put exynos drm object acquired from exynos_drm_gem_get(),
89  * gem object reference count would be decreased.
90  */
91 static inline void exynos_drm_gem_put(struct exynos_drm_gem *exynos_gem)
92 {
93 	drm_gem_object_put_unlocked(&exynos_gem->base);
94 }
95 
96 /* get buffer information to memory region allocated by gem. */
97 int exynos_drm_gem_get_ioctl(struct drm_device *dev, void *data,
98 				      struct drm_file *file_priv);
99 
100 /* free gem object. */
101 void exynos_drm_gem_free_object(struct drm_gem_object *obj);
102 
103 /* create memory region for drm framebuffer. */
104 int exynos_drm_gem_dumb_create(struct drm_file *file_priv,
105 			       struct drm_device *dev,
106 			       struct drm_mode_create_dumb *args);
107 
108 /* page fault handler and mmap fault address(virtual) to physical memory. */
109 vm_fault_t exynos_drm_gem_fault(struct vm_fault *vmf);
110 
111 /* set vm_flags and we can change the vm attribute to other one at here. */
112 int exynos_drm_gem_mmap(struct file *filp, struct vm_area_struct *vma);
113 
114 /* low-level interface prime helpers */
115 struct drm_gem_object *exynos_drm_gem_prime_import(struct drm_device *dev,
116 					    struct dma_buf *dma_buf);
117 struct sg_table *exynos_drm_gem_prime_get_sg_table(struct drm_gem_object *obj);
118 struct drm_gem_object *
119 exynos_drm_gem_prime_import_sg_table(struct drm_device *dev,
120 				     struct dma_buf_attachment *attach,
121 				     struct sg_table *sgt);
122 void *exynos_drm_gem_prime_vmap(struct drm_gem_object *obj);
123 void exynos_drm_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr);
124 int exynos_drm_gem_prime_mmap(struct drm_gem_object *obj,
125 			      struct vm_area_struct *vma);
126 
127 #endif
128