HS Files added for IVI ARM release
[adaptation/panda/libdrm.git] / libdrm-2.4.39 / exynos / 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 #include "drm.h"
33
34 /**
35  * User-desired buffer creation information structure.
36  *
37  * @size: user-desired memory allocation size.
38  *      - this size value would be page-aligned internally.
39  * @flags: user request for setting memory type or cache attributes.
40  * @handle: returned a handle to created gem object.
41  *      - this handle will be set by gem module of kernel side.
42  */
43 struct drm_exynos_gem_create {
44         uint64_t size;
45         unsigned int flags;
46         unsigned int handle;
47 };
48
49 /**
50  * A structure for getting buffer offset.
51  *
52  * @handle: a pointer to gem object created.
53  * @pad: just padding to be 64-bit aligned.
54  * @offset: relatived offset value of the memory region allocated.
55  *      - this value should be set by user.
56  */
57 struct drm_exynos_gem_map_off {
58         unsigned int handle;
59         unsigned int pad;
60         uint64_t offset;
61 };
62
63 /**
64  * A structure for mapping buffer.
65  *
66  * @handle: a handle to gem object created.
67  * @pad: just padding to be 64-bit aligned.
68  * @size: memory size to be mapped.
69  * @mapped: having user virtual address mmaped.
70  *      - this variable would be filled by exynos gem module
71  *      of kernel side with user virtual address which is allocated
72  *      by do_mmap().
73  */
74 struct drm_exynos_gem_mmap {
75         unsigned int handle;
76         unsigned int pad;
77         uint64_t size;
78         uint64_t mapped;
79 };
80
81 /**
82  * A structure to gem information.
83  *
84  * @handle: a handle to gem object created.
85  * @flags: flag value including memory type and cache attribute and
86  *      this value would be set by driver.
87  * @size: size to memory region allocated by gem and this size would
88  *      be set by driver.
89  */
90 struct drm_exynos_gem_info {
91         unsigned int handle;
92         unsigned int flags;
93         uint64_t size;
94 };
95
96 /**
97  * A structure for user connection request of virtual display.
98  *
99  * @connection: indicate whether doing connetion or not by user.
100  * @extensions: if this value is 1 then the vidi driver would need additional
101  *      128bytes edid data.
102  * @edid: the edid data pointer from user side.
103  */
104 struct drm_exynos_vidi_connection {
105         unsigned int connection;
106         unsigned int extensions;
107         uint64_t edid;
108 };
109
110 /* memory type definitions. */
111 enum e_drm_exynos_gem_mem_type {
112         /* Physically Continuous memory and used as default. */
113         EXYNOS_BO_CONTIG        = 0 << 0,
114         /* Physically Non-Continuous memory. */
115         EXYNOS_BO_NONCONTIG     = 1 << 0,
116         /* non-cachable mapping and used as default. */
117         EXYNOS_BO_NONCACHABLE   = 0 << 1,
118         /* cachable mapping. */
119         EXYNOS_BO_CACHABLE      = 1 << 1,
120         /* write-combine mapping. */
121         EXYNOS_BO_WC            = 1 << 2,
122         EXYNOS_BO_MASK          = EXYNOS_BO_NONCONTIG | EXYNOS_BO_CACHABLE |
123                                         EXYNOS_BO_WC
124 };
125
126 #define DRM_EXYNOS_GEM_CREATE           0x00
127 #define DRM_EXYNOS_GEM_MAP_OFFSET       0x01
128 #define DRM_EXYNOS_GEM_MMAP             0x02
129 /* Reserved 0x04 ~ 0x05 for exynos specific gem ioctl */
130 #define DRM_EXYNOS_GEM_GET              0x04
131 #define DRM_EXYNOS_VIDI_CONNECTION      0x07
132
133 #define DRM_IOCTL_EXYNOS_GEM_CREATE             DRM_IOWR(DRM_COMMAND_BASE + \
134                 DRM_EXYNOS_GEM_CREATE, struct drm_exynos_gem_create)
135
136 #define DRM_IOCTL_EXYNOS_GEM_MAP_OFFSET DRM_IOWR(DRM_COMMAND_BASE + \
137                 DRM_EXYNOS_GEM_MAP_OFFSET, struct drm_exynos_gem_map_off)
138
139 #define DRM_IOCTL_EXYNOS_GEM_MMAP       DRM_IOWR(DRM_COMMAND_BASE + \
140                 DRM_EXYNOS_GEM_MMAP, struct drm_exynos_gem_mmap)
141
142 #define DRM_IOCTL_EXYNOS_GEM_GET        DRM_IOWR(DRM_COMMAND_BASE + \
143                 DRM_EXYNOS_GEM_GET,     struct drm_exynos_gem_info)
144
145 #define DRM_IOCTL_EXYNOS_VIDI_CONNECTION        DRM_IOWR(DRM_COMMAND_BASE + \
146                 DRM_EXYNOS_VIDI_CONNECTION, struct drm_exynos_vidi_connection)
147
148 #endif