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