drm/exynos: update gem and buffer framework.
[pandora-kernel.git] / include / drm / exynos_drm.h
1 /* exynos_drm.h
2  *
3  * Copyright (c) 2011 Samsung Electronics Co., Ltd.
4  * Authors:
5  *      Inki Dae <inki.dae@samsung.com>
6  *      Joonyoung Shim <jy0922.shim@samsung.com>
7  *      Seung-Woo Kim <sw0312.kim@samsung.com>
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining a
10  * copy of this software and associated documentation files (the "Software"),
11  * to deal in the Software without restriction, including without limitation
12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13  * and/or sell copies of the Software, and to permit persons to whom the
14  * Software is furnished to do so, subject to the following conditions:
15  *
16  * The above copyright notice and this permission notice (including the next
17  * paragraph) shall be included in all copies or substantial portions of the
18  * Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
23  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
24  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
25  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
26  * OTHER DEALINGS IN THE SOFTWARE.
27  */
28
29 #ifndef _EXYNOS_DRM_H_
30 #define _EXYNOS_DRM_H_
31
32 /**
33  * User-desired buffer creation information structure.
34  *
35  * @size: user-desired memory allocation size.
36  *      - this size value would be page-aligned internally.
37  * @flags: user request for setting memory type or cache attributes.
38  * @handle: returned a handle to created gem object.
39  *      - this handle will be set by gem module of kernel side.
40  */
41 struct drm_exynos_gem_create {
42         uint64_t size;
43         unsigned int flags;
44         unsigned int handle;
45 };
46
47 /**
48  * A structure for getting buffer offset.
49  *
50  * @handle: a pointer to gem object created.
51  * @pad: just padding to be 64-bit aligned.
52  * @offset: relatived offset value of the memory region allocated.
53  *      - this value should be set by user.
54  */
55 struct drm_exynos_gem_map_off {
56         unsigned int handle;
57         unsigned int pad;
58         uint64_t offset;
59 };
60
61 /**
62  * A structure for mapping buffer.
63  *
64  * @handle: a handle to gem object created.
65  * @size: memory size to be mapped.
66  * @mapped: having user virtual address mmaped.
67  *      - this variable would be filled by exynos gem module
68  *      of kernel side with user virtual address which is allocated
69  *      by do_mmap().
70  */
71 struct drm_exynos_gem_mmap {
72         unsigned int handle;
73         unsigned int size;
74         uint64_t mapped;
75 };
76
77 struct drm_exynos_plane_set_zpos {
78         __u32 plane_id;
79         __s32 zpos;
80 };
81
82 /* memory type definitions. */
83 enum e_drm_exynos_gem_mem_type {
84         /* Physically Non-Continuous memory. */
85         EXYNOS_BO_NONCONTIG     = 1 << 0
86 };
87
88 #define DRM_EXYNOS_GEM_CREATE           0x00
89 #define DRM_EXYNOS_GEM_MAP_OFFSET       0x01
90 #define DRM_EXYNOS_GEM_MMAP             0x02
91 /* Reserved 0x03 ~ 0x05 for exynos specific gem ioctl */
92 #define DRM_EXYNOS_PLANE_SET_ZPOS       0x06
93
94 #define DRM_IOCTL_EXYNOS_GEM_CREATE             DRM_IOWR(DRM_COMMAND_BASE + \
95                 DRM_EXYNOS_GEM_CREATE, struct drm_exynos_gem_create)
96
97 #define DRM_IOCTL_EXYNOS_GEM_MAP_OFFSET DRM_IOWR(DRM_COMMAND_BASE + \
98                 DRM_EXYNOS_GEM_MAP_OFFSET, struct drm_exynos_gem_map_off)
99
100 #define DRM_IOCTL_EXYNOS_GEM_MMAP       DRM_IOWR(DRM_COMMAND_BASE + \
101                 DRM_EXYNOS_GEM_MMAP, struct drm_exynos_gem_mmap)
102
103 #define DRM_IOCTL_EXYNOS_PLANE_SET_ZPOS DRM_IOWR(DRM_COMMAND_BASE + \
104                 DRM_EXYNOS_PLANE_SET_ZPOS, struct drm_exynos_plane_set_zpos)
105
106 #ifdef __KERNEL__
107
108 /**
109  * A structure for lcd panel information.
110  *
111  * @timing: default video mode for initializing
112  * @width_mm: physical size of lcd width.
113  * @height_mm: physical size of lcd height.
114  */
115 struct exynos_drm_panel_info {
116         struct fb_videomode timing;
117         u32 width_mm;
118         u32 height_mm;
119 };
120
121 /**
122  * Platform Specific Structure for DRM based FIMD.
123  *
124  * @panel: default panel info for initializing
125  * @default_win: default window layer number to be used for UI.
126  * @bpp: default bit per pixel.
127  */
128 struct exynos_drm_fimd_pdata {
129         struct exynos_drm_panel_info panel;
130         u32                             vidcon0;
131         u32                             vidcon1;
132         unsigned int                    default_win;
133         unsigned int                    bpp;
134 };
135
136 /**
137  * Platform Specific Structure for DRM based HDMI.
138  *
139  * @hdmi_dev: device point to specific hdmi driver.
140  * @mixer_dev: device point to specific mixer driver.
141  *
142  * this structure is used for common hdmi driver and each device object
143  * would be used to access specific device driver(hdmi or mixer driver)
144  */
145 struct exynos_drm_common_hdmi_pd {
146         struct device *hdmi_dev;
147         struct device *mixer_dev;
148 };
149
150 /**
151  * Platform Specific Structure for DRM based HDMI core.
152  *
153  * @timing: default video mode for initializing
154  * @default_win: default window layer number to be used for UI.
155  * @bpp: default bit per pixel.
156  * @is_v13: set if hdmi version 13 is.
157  */
158 struct exynos_drm_hdmi_pdata {
159         struct fb_videomode             timing;
160         unsigned int                    default_win;
161         unsigned int                    bpp;
162         unsigned int                    is_v13:1;
163 };
164
165 #endif  /* __KERNEL__ */
166 #endif  /* _EXYNOS_DRM_H_ */