blob: 4ed842039505d5b6311b7252d5bdc514ec9df721 [file] [log] [blame]
Inki Dae1c248b72011-10-04 19:19:01 +09001/* exynos_drm_gem.h
2 *
3 * Copyright (c) 2011 Samsung Electronics Co., Ltd.
4 * Authoer: Inki Dae <inki.dae@samsung.com>
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice (including the next
14 * paragraph) shall be included in all copies or substantial portions of the
15 * Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
21 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
22 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
23 * OTHER DEALINGS IN THE SOFTWARE.
24 */
25
26#ifndef _EXYNOS_DRM_GEM_H_
27#define _EXYNOS_DRM_GEM_H_
28
29#define to_exynos_gem_obj(x) container_of(x,\
30 struct exynos_drm_gem_obj, base)
31
Inki Daedcf9af82012-04-03 21:27:58 +090032#define IS_NONCONTIG_BUFFER(f) (f & EXYNOS_BO_NONCONTIG)
33
Inki Dae1c248b72011-10-04 19:19:01 +090034/*
Inki Dae2c871122011-11-12 15:23:32 +090035 * exynos drm gem buffer structure.
36 *
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.
Inki Dae2b358922012-03-16 18:47:05 +090041 * @sgt: sg table to transfer page data.
42 * @pages: contain all pages to allocated memory region.
Inki Dae2c871122011-11-12 15:23:32 +090043 * @size: size of allocated memory region.
44 */
45struct exynos_drm_gem_buf {
46 void __iomem *kvaddr;
47 dma_addr_t dma_addr;
Inki Dae2b358922012-03-16 18:47:05 +090048 struct sg_table *sgt;
49 struct page **pages;
Inki Dae2c871122011-11-12 15:23:32 +090050 unsigned long size;
51};
52
53/*
Inki Dae1c248b72011-10-04 19:19:01 +090054 * exynos drm buffer structure.
55 *
56 * @base: a gem object.
57 * - a new handle to this gem object would be created
58 * by drm_gem_handle_create().
Inki Dae2c871122011-11-12 15:23:32 +090059 * @buffer: a pointer to exynos_drm_gem_buffer object.
60 * - contain the information to memory region allocated
61 * by user request or at framebuffer creation.
Inki Dae1c248b72011-10-04 19:19:01 +090062 * continuous memory region allocated by user request
63 * or at framebuffer creation.
Inki Dae2b358922012-03-16 18:47:05 +090064 * @size: total memory size to physically non-continuous memory region.
65 * @flags: indicate memory type to allocated buffer and cache attruibute.
Inki Dae1c248b72011-10-04 19:19:01 +090066 *
67 * P.S. this object would be transfered to user as kms_bo.handle so
68 * user can access the buffer through kms_bo.handle.
69 */
70struct exynos_drm_gem_obj {
Joonyoung Shimee5e7702011-12-13 14:20:23 +090071 struct drm_gem_object base;
72 struct exynos_drm_gem_buf *buffer;
Inki Dae2b358922012-03-16 18:47:05 +090073 unsigned long size;
74 unsigned int flags;
Inki Dae1c248b72011-10-04 19:19:01 +090075};
76
Joonyoung Shim23648392011-12-13 14:39:13 +090077/* destroy a buffer with gem object */
78void exynos_drm_gem_destroy(struct exynos_drm_gem_obj *exynos_gem_obj);
79
80/* create a new buffer with gem object */
Inki Daef088d5a2011-11-12 14:51:23 +090081struct exynos_drm_gem_obj *exynos_drm_gem_create(struct drm_device *dev,
Inki Dae2b358922012-03-16 18:47:05 +090082 unsigned int flags,
83 unsigned long size);
Inki Dae1c248b72011-10-04 19:19:01 +090084
85/*
86 * request gem object creation and buffer allocation as the size
87 * that it is calculated with framebuffer information such as width,
88 * height and bpp.
89 */
90int exynos_drm_gem_create_ioctl(struct drm_device *dev, void *data,
Joonyoung Shimee5e7702011-12-13 14:20:23 +090091 struct drm_file *file_priv);
Inki Dae1c248b72011-10-04 19:19:01 +090092
Inki Daef0b1bda2012-03-16 18:47:06 +090093/*
94 * get dma address from gem handle and this function could be used for
95 * other drivers such as 2d/3d acceleration drivers.
96 * with this function call, gem object reference count would be increased.
97 */
98void *exynos_drm_gem_get_dma_addr(struct drm_device *dev,
99 unsigned int gem_handle,
100 struct drm_file *file_priv);
101
102/*
103 * put dma address from gem handle and this function could be used for
104 * other drivers such as 2d/3d acceleration drivers.
105 * with this function call, gem object reference count would be decreased.
106 */
107void exynos_drm_gem_put_dma_addr(struct drm_device *dev,
108 unsigned int gem_handle,
109 struct drm_file *file_priv);
110
Inki Dae1c248b72011-10-04 19:19:01 +0900111/* get buffer offset to map to user space. */
112int exynos_drm_gem_map_offset_ioctl(struct drm_device *dev, void *data,
Joonyoung Shimee5e7702011-12-13 14:20:23 +0900113 struct drm_file *file_priv);
Inki Dae1c248b72011-10-04 19:19:01 +0900114
Joonyoung Shimee5e7702011-12-13 14:20:23 +0900115/*
116 * mmap the physically continuous memory that a gem object contains
117 * to user space.
118 */
119int exynos_drm_gem_mmap_ioctl(struct drm_device *dev, void *data,
120 struct drm_file *file_priv);
Inki Dae1c248b72011-10-04 19:19:01 +0900121
122/* initialize gem object. */
123int exynos_drm_gem_init_object(struct drm_gem_object *obj);
124
125/* free gem object. */
126void exynos_drm_gem_free_object(struct drm_gem_object *gem_obj);
127
128/* create memory region for drm framebuffer. */
129int exynos_drm_gem_dumb_create(struct drm_file *file_priv,
Joonyoung Shimee5e7702011-12-13 14:20:23 +0900130 struct drm_device *dev,
131 struct drm_mode_create_dumb *args);
Inki Dae1c248b72011-10-04 19:19:01 +0900132
133/* map memory region for drm framebuffer to user space. */
134int exynos_drm_gem_dumb_map_offset(struct drm_file *file_priv,
Joonyoung Shimee5e7702011-12-13 14:20:23 +0900135 struct drm_device *dev, uint32_t handle,
136 uint64_t *offset);
Inki Dae1c248b72011-10-04 19:19:01 +0900137
138/*
139 * destroy memory region allocated.
140 * - a gem handle and physical memory region pointed by a gem object
141 * would be released by drm_gem_handle_delete().
142 */
143int exynos_drm_gem_dumb_destroy(struct drm_file *file_priv,
Joonyoung Shimee5e7702011-12-13 14:20:23 +0900144 struct drm_device *dev,
145 unsigned int handle);
146
147/* page fault handler and mmap fault address(virtual) to physical memory. */
148int exynos_drm_gem_fault(struct vm_area_struct *vma, struct vm_fault *vmf);
149
150/* set vm_flags and we can change the vm attribute to other one at here. */
151int exynos_drm_gem_mmap(struct file *filp, struct vm_area_struct *vma);
Inki Dae1c248b72011-10-04 19:19:01 +0900152
153#endif