xref: /linux/include/uapi/drm/omap_drm.h (revision 6a2cf60b3e6341a3163d3cac3f4bede126c2e894)
1 /*
2  * include/uapi/drm/omap_drm.h
3  *
4  * Copyright (C) 2011 Texas Instruments
5  * Author: Rob Clark <rob@ti.com>
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU General Public License version 2 as published by
9  * the Free Software Foundation.
10  *
11  * This program is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
14  * more details.
15  *
16  * You should have received a copy of the GNU General Public License along with
17  * this program.  If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef __OMAP_DRM_H__
21 #define __OMAP_DRM_H__
22 
23 #include "drm.h"
24 
25 #if defined(__cplusplus)
26 extern "C" {
27 #endif
28 
29 /* Please note that modifications to all structs defined here are
30  * subject to backwards-compatibility constraints.
31  */
32 
33 #define OMAP_PARAM_CHIPSET_ID	1	/* ie. 0x3430, 0x4430, etc */
34 
35 struct drm_omap_param {
36 	uint64_t param;			/* in */
37 	uint64_t value;			/* in (set_param), out (get_param) */
38 };
39 
40 #define OMAP_BO_SCANOUT		0x00000001	/* scanout capable (phys contiguous) */
41 #define OMAP_BO_CACHE_MASK	0x00000006	/* cache type mask, see cache modes */
42 #define OMAP_BO_TILED_MASK	0x00000f00	/* tiled mapping mask, see tiled modes */
43 
44 /* cache modes */
45 #define OMAP_BO_CACHED		0x00000000	/* default */
46 #define OMAP_BO_WC		0x00000002	/* write-combine */
47 #define OMAP_BO_UNCACHED	0x00000004	/* strongly-ordered (uncached) */
48 
49 /* tiled modes */
50 #define OMAP_BO_TILED_8		0x00000100
51 #define OMAP_BO_TILED_16	0x00000200
52 #define OMAP_BO_TILED_32	0x00000300
53 #define OMAP_BO_TILED		(OMAP_BO_TILED_8 | OMAP_BO_TILED_16 | OMAP_BO_TILED_32)
54 
55 union omap_gem_size {
56 	uint32_t bytes;		/* (for non-tiled formats) */
57 	struct {
58 		uint16_t width;
59 		uint16_t height;
60 	} tiled;		/* (for tiled formats) */
61 };
62 
63 struct drm_omap_gem_new {
64 	union omap_gem_size size;	/* in */
65 	uint32_t flags;			/* in */
66 	uint32_t handle;		/* out */
67 	uint32_t __pad;
68 };
69 
70 /* mask of operations: */
71 enum omap_gem_op {
72 	OMAP_GEM_READ = 0x01,
73 	OMAP_GEM_WRITE = 0x02,
74 };
75 
76 struct drm_omap_gem_cpu_prep {
77 	uint32_t handle;		/* buffer handle (in) */
78 	uint32_t op;			/* mask of omap_gem_op (in) */
79 };
80 
81 struct drm_omap_gem_cpu_fini {
82 	uint32_t handle;		/* buffer handle (in) */
83 	uint32_t op;			/* mask of omap_gem_op (in) */
84 	/* TODO maybe here we pass down info about what regions are touched
85 	 * by sw so we can be clever about cache ops?  For now a placeholder,
86 	 * set to zero and we just do full buffer flush..
87 	 */
88 	uint32_t nregions;
89 	uint32_t __pad;
90 };
91 
92 struct drm_omap_gem_info {
93 	uint32_t handle;		/* buffer handle (in) */
94 	uint32_t pad;
95 	uint64_t offset;		/* mmap offset (out) */
96 	/* note: in case of tiled buffers, the user virtual size can be
97 	 * different from the physical size (ie. how many pages are needed
98 	 * to back the object) which is returned in DRM_IOCTL_GEM_OPEN..
99 	 * This size here is the one that should be used if you want to
100 	 * mmap() the buffer:
101 	 */
102 	uint32_t size;			/* virtual size for mmap'ing (out) */
103 	uint32_t __pad;
104 };
105 
106 #define DRM_OMAP_GET_PARAM		0x00
107 #define DRM_OMAP_SET_PARAM		0x01
108 #define DRM_OMAP_GEM_NEW		0x03
109 #define DRM_OMAP_GEM_CPU_PREP		0x04
110 #define DRM_OMAP_GEM_CPU_FINI		0x05
111 #define DRM_OMAP_GEM_INFO		0x06
112 #define DRM_OMAP_NUM_IOCTLS		0x07
113 
114 #define DRM_IOCTL_OMAP_GET_PARAM	DRM_IOWR(DRM_COMMAND_BASE + DRM_OMAP_GET_PARAM, struct drm_omap_param)
115 #define DRM_IOCTL_OMAP_SET_PARAM	DRM_IOW (DRM_COMMAND_BASE + DRM_OMAP_SET_PARAM, struct drm_omap_param)
116 #define DRM_IOCTL_OMAP_GEM_NEW		DRM_IOWR(DRM_COMMAND_BASE + DRM_OMAP_GEM_NEW, struct drm_omap_gem_new)
117 #define DRM_IOCTL_OMAP_GEM_CPU_PREP	DRM_IOW (DRM_COMMAND_BASE + DRM_OMAP_GEM_CPU_PREP, struct drm_omap_gem_cpu_prep)
118 #define DRM_IOCTL_OMAP_GEM_CPU_FINI	DRM_IOW (DRM_COMMAND_BASE + DRM_OMAP_GEM_CPU_FINI, struct drm_omap_gem_cpu_fini)
119 #define DRM_IOCTL_OMAP_GEM_INFO		DRM_IOWR(DRM_COMMAND_BASE + DRM_OMAP_GEM_INFO, struct drm_omap_gem_info)
120 
121 #if defined(__cplusplus)
122 }
123 #endif
124 
125 #endif /* __OMAP_DRM_H__ */
126