1 /*
2 * Internal Header for the Direct Rendering Manager
3 *
4 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
5 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
6 * Copyright (c) 2009-2010, Code Aurora Forum.
7 * All rights reserved.
8 *
9 * Author: Rickard E. (Rik) Faith <faith@valinux.com>
10 * Author: Gareth Hughes <gareth@valinux.com>
11 *
12 * Permission is hereby granted, free of charge, to any person obtaining a
13 * copy of this software and associated documentation files (the "Software"),
14 * to deal in the Software without restriction, including without limitation
15 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
16 * and/or sell copies of the Software, and to permit persons to whom the
17 * Software is furnished to do so, subject to the following conditions:
18 *
19 * The above copyright notice and this permission notice (including the next
20 * paragraph) shall be included in all copies or substantial portions of the
21 * Software.
22 *
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
27 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
28 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
29 * OTHER DEALINGS IN THE SOFTWARE.
30 */
31
32 #ifndef _DRM_P_H_
33 #define _DRM_P_H_
34
35 #include <linux/agp_backend.h>
36 #include <linux/cdev.h>
37 #include <linux/dma-mapping.h>
38 #include <linux/file.h>
39 #include <linux/fs.h>
40 #include <linux/highmem.h>
41 #include <linux/idr.h>
42 #include <linux/init.h>
43 #include <linux/io.h>
44 #include <linux/jiffies.h>
45 #include <linux/kernel.h>
46 #include <linux/kref.h>
47 #include <linux/miscdevice.h>
48 #include <linux/mm.h>
49 #include <linux/mutex.h>
50 #include <linux/platform_device.h>
51 #include <linux/poll.h>
52 #include <linux/ratelimit.h>
53 #include <linux/sched.h>
54 #include <linux/slab.h>
55 #include <linux/types.h>
56 #include <linux/vmalloc.h>
57 #include <linux/workqueue.h>
58 #include <linux/dma-fence.h>
59 #include <linux/module.h>
60
61 #include <asm/mman.h>
62 #include <asm/pgalloc.h>
63 #include <linux/uaccess.h>
64
65 #include <uapi/drm/drm.h>
66 #include <uapi/drm/drm_mode.h>
67
68 #include <drm/drm_agpsupport.h>
69 #include <drm/drm_crtc.h>
70 #include <drm/drm_fourcc.h>
71 #include <drm/drm_global.h>
72 #include <drm/drm_hashtab.h>
73 #include <drm/drm_mm.h>
74 #include <drm/drm_os_linux.h>
75 #include <drm/drm_sarea.h>
76 #include <drm/drm_drv.h>
77 #include <drm/drm_prime.h>
78 #include <drm/drm_pci.h>
79 #include <drm/drm_file.h>
80 #include <drm/drm_debugfs.h>
81 #include <drm/drm_ioctl.h>
82 #include <drm/drm_sysfs.h>
83 #include <drm/drm_vblank.h>
84 #include <drm/drm_irq.h>
85 #include <drm/drm_device.h>
86
87 struct module;
88
89 struct device_node;
90 struct videomode;
91 struct reservation_object;
92 struct dma_buf_attachment;
93
94 struct pci_dev;
95 struct pci_controller;
96
97 /*
98 * The following categories are defined:
99 *
100 * CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, drm_memory.c, ...
101 * This is the category used by the DRM_DEBUG() macro.
102 *
103 * DRIVER: Used in the vendor specific part of the driver: i915, radeon, ...
104 * This is the category used by the DRM_DEBUG_DRIVER() macro.
105 *
106 * KMS: used in the modesetting code.
107 * This is the category used by the DRM_DEBUG_KMS() macro.
108 *
109 * PRIME: used in the prime code.
110 * This is the category used by the DRM_DEBUG_PRIME() macro.
111 *
112 * ATOMIC: used in the atomic code.
113 * This is the category used by the DRM_DEBUG_ATOMIC() macro.
114 *
115 * VBL: used for verbose debug message in the vblank code
116 * This is the category used by the DRM_DEBUG_VBL() macro.
117 *
118 * Enabling verbose debug messages is done through the drm.debug parameter,
119 * each category being enabled by a bit.
120 *
121 * drm.debug=0x1 will enable CORE messages
122 * drm.debug=0x2 will enable DRIVER messages
123 * drm.debug=0x3 will enable CORE and DRIVER messages
124 * ...
125 * drm.debug=0x3f will enable all messages
126 *
127 * An interesting feature is that it's possible to enable verbose logging at
128 * run-time by echoing the debug value in its sysfs node:
129 * # echo 0xf > /sys/module/drm/parameters/debug
130 */
131 #define DRM_UT_NONE 0x00
132 #define DRM_UT_CORE 0x01
133 #define DRM_UT_DRIVER 0x02
134 #define DRM_UT_KMS 0x04
135 #define DRM_UT_PRIME 0x08
136 #define DRM_UT_ATOMIC 0x10
137 #define DRM_UT_VBL 0x20
138 #define DRM_UT_STATE 0x40
139
140 /***********************************************************************/
141 /** \name DRM template customization defaults */
142 /*@{*/
143
144 /***********************************************************************/
145 /** \name Macros to make printk easier */
146 /*@{*/
147
148 #define _DRM_PRINTK(once, level, fmt, ...) \
149 do { \
150 printk##once(KERN_##level "[" DRM_NAME "] " fmt, \
151 ##__VA_ARGS__); \
152 } while (0)
153
154 #define DRM_INFO(fmt, ...) \
155 _DRM_PRINTK(, INFO, fmt, ##__VA_ARGS__)
156 #define DRM_NOTE(fmt, ...) \
157 _DRM_PRINTK(, NOTICE, fmt, ##__VA_ARGS__)
158 #define DRM_WARN(fmt, ...) \
159 _DRM_PRINTK(, WARNING, fmt, ##__VA_ARGS__)
160
161 #define DRM_INFO_ONCE(fmt, ...) \
162 _DRM_PRINTK(_once, INFO, fmt, ##__VA_ARGS__)
163 #define DRM_NOTE_ONCE(fmt, ...) \
164 _DRM_PRINTK(_once, NOTICE, fmt, ##__VA_ARGS__)
165 #define DRM_WARN_ONCE(fmt, ...) \
166 _DRM_PRINTK(_once, WARNING, fmt, ##__VA_ARGS__)
167
168 /**
169 * Error output.
170 *
171 * \param fmt printf() like format string.
172 * \param arg arguments
173 */
174 #define DRM_DEV_ERROR(dev, fmt, ...) \
175 drm_dev_printk(dev, KERN_ERR, DRM_UT_NONE, __func__, " *ERROR*",\
176 fmt, ##__VA_ARGS__)
177 #define DRM_ERROR(fmt, ...) \
178 drm_printk(KERN_ERR, DRM_UT_NONE, fmt, ##__VA_ARGS__)
179
180 /**
181 * Rate limited error output. Like DRM_ERROR() but won't flood the log.
182 *
183 * \param fmt printf() like format string.
184 * \param arg arguments
185 */
186 #define DRM_DEV_ERROR_RATELIMITED(dev, fmt, ...) \
187 ({ \
188 static DEFINE_RATELIMIT_STATE(_rs, \
189 DEFAULT_RATELIMIT_INTERVAL, \
190 DEFAULT_RATELIMIT_BURST); \
191 \
192 if (__ratelimit(&_rs)) \
193 DRM_DEV_ERROR(dev, fmt, ##__VA_ARGS__); \
194 })
195 #define DRM_ERROR_RATELIMITED(fmt, ...) \
196 DRM_DEV_ERROR_RATELIMITED(NULL, fmt, ##__VA_ARGS__)
197
198 #define DRM_DEV_INFO(dev, fmt, ...) \
199 drm_dev_printk(dev, KERN_INFO, DRM_UT_NONE, __func__, "", fmt, \
200 ##__VA_ARGS__)
201
202 #define DRM_DEV_INFO_ONCE(dev, fmt, ...) \
203 ({ \
204 static bool __print_once __read_mostly; \
205 if (!__print_once) { \
206 __print_once = true; \
207 DRM_DEV_INFO(dev, fmt, ##__VA_ARGS__); \
208 } \
209 })
210
211 /**
212 * Debug output.
213 *
214 * \param fmt printf() like format string.
215 * \param arg arguments
216 */
217 #define DRM_DEV_DEBUG(dev, fmt, args...) \
218 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_CORE, __func__, "", fmt, \
219 ##args)
220 #define DRM_DEBUG(fmt, ...) \
221 drm_printk(KERN_DEBUG, DRM_UT_CORE, fmt, ##__VA_ARGS__)
222
223 #define DRM_DEV_DEBUG_DRIVER(dev, fmt, args...) \
224 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_DRIVER, __func__, "", \
225 fmt, ##args)
226 #define DRM_DEBUG_DRIVER(fmt, ...) \
227 drm_printk(KERN_DEBUG, DRM_UT_DRIVER, fmt, ##__VA_ARGS__)
228
229 #define DRM_DEV_DEBUG_KMS(dev, fmt, args...) \
230 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_KMS, __func__, "", fmt, \
231 ##args)
232 #define DRM_DEBUG_KMS(fmt, ...) \
233 drm_printk(KERN_DEBUG, DRM_UT_KMS, fmt, ##__VA_ARGS__)
234
235 #define DRM_DEV_DEBUG_PRIME(dev, fmt, args...) \
236 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_PRIME, __func__, "", \
237 fmt, ##args)
238 #define DRM_DEBUG_PRIME(fmt, ...) \
239 drm_printk(KERN_DEBUG, DRM_UT_PRIME, fmt, ##__VA_ARGS__)
240
241 #define DRM_DEV_DEBUG_ATOMIC(dev, fmt, args...) \
242 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_ATOMIC, __func__, "", \
243 fmt, ##args)
244 #define DRM_DEBUG_ATOMIC(fmt, ...) \
245 drm_printk(KERN_DEBUG, DRM_UT_ATOMIC, fmt, ##__VA_ARGS__)
246
247 #define DRM_DEV_DEBUG_VBL(dev, fmt, args...) \
248 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_VBL, __func__, "", fmt, \
249 ##args)
250 #define DRM_DEBUG_VBL(fmt, ...) \
251 drm_printk(KERN_DEBUG, DRM_UT_VBL, fmt, ##__VA_ARGS__)
252
253 #define _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, level, fmt, args...) \
254 ({ \
255 static DEFINE_RATELIMIT_STATE(_rs, \
256 DEFAULT_RATELIMIT_INTERVAL, \
257 DEFAULT_RATELIMIT_BURST); \
258 if (__ratelimit(&_rs)) \
259 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_ ## level, \
260 __func__, "", fmt, ##args); \
261 })
262
263 /**
264 * Rate limited debug output. Like DRM_DEBUG() but won't flood the log.
265 *
266 * \param fmt printf() like format string.
267 * \param arg arguments
268 */
269 #define DRM_DEV_DEBUG_RATELIMITED(dev, fmt, args...) \
270 DEV__DRM_DEFINE_DEBUG_RATELIMITED(dev, CORE, fmt, ##args)
271 #define DRM_DEBUG_RATELIMITED(fmt, args...) \
272 DRM_DEV_DEBUG_RATELIMITED(NULL, fmt, ##args)
273 #define DRM_DEV_DEBUG_DRIVER_RATELIMITED(dev, fmt, args...) \
274 _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, DRIVER, fmt, ##args)
275 #define DRM_DEBUG_DRIVER_RATELIMITED(fmt, args...) \
276 DRM_DEV_DEBUG_DRIVER_RATELIMITED(NULL, fmt, ##args)
277 #define DRM_DEV_DEBUG_KMS_RATELIMITED(dev, fmt, args...) \
278 _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, KMS, fmt, ##args)
279 #define DRM_DEBUG_KMS_RATELIMITED(fmt, args...) \
280 DRM_DEV_DEBUG_KMS_RATELIMITED(NULL, fmt, ##args)
281 #define DRM_DEV_DEBUG_PRIME_RATELIMITED(dev, fmt, args...) \
282 _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, PRIME, fmt, ##args)
283 #define DRM_DEBUG_PRIME_RATELIMITED(fmt, args...) \
284 DRM_DEV_DEBUG_PRIME_RATELIMITED(NULL, fmt, ##args)
285
286 /* Format strings and argument splitters to simplify printing
287 * various "complex" objects
288 */
289
290 /*@}*/
291
292 /***********************************************************************/
293 /** \name Internal types and structures */
294 /*@{*/
295
296 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
297
298
299 /**
300 * drm_drv_uses_atomic_modeset - check if the driver implements
301 * atomic_commit()
302 * @dev: DRM device
303 *
304 * This check is useful if drivers do not have DRIVER_ATOMIC set but
305 * have atomic modesetting internally implemented.
306 */
drm_drv_uses_atomic_modeset(struct drm_device * dev)307 static inline bool drm_drv_uses_atomic_modeset(struct drm_device *dev)
308 {
309 return dev->mode_config.funcs->atomic_commit != NULL;
310 }
311
312 #define DRM_SWITCH_POWER_ON 0
313 #define DRM_SWITCH_POWER_OFF 1
314 #define DRM_SWITCH_POWER_CHANGING 2
315 #define DRM_SWITCH_POWER_DYNAMIC_OFF 3
316
drm_core_check_feature(struct drm_device * dev,int feature)317 static __inline__ int drm_core_check_feature(struct drm_device *dev,
318 int feature)
319 {
320 return ((dev->driver->driver_features & feature) ? 1 : 0);
321 }
322
323 /******************************************************************/
324 /** \name Internal function definitions */
325 /*@{*/
326
327 /* Driver support (drm_drv.h) */
328
329 /*
330 * These are exported to drivers so that they can implement fencing using
331 * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
332 */
333
334 /*@}*/
335
336 /* returns true if currently okay to sleep */
drm_can_sleep(void)337 static __inline__ bool drm_can_sleep(void)
338 {
339 if (in_atomic() || in_dbg_master() || irqs_disabled())
340 return false;
341 return true;
342 }
343
344 /* helper for handling conditionals in various for_each macros */
345 #define for_each_if(condition) if (!(condition)) {} else
346
347 #endif
348