1 /*
2 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
3 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
4 * Copyright (c) 2009-2010, Code Aurora Forum.
5 * Copyright 2016 Intel Corp.
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice (including the next
15 * paragraph) shall be included in all copies or substantial portions of the
16 * Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
22 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
23 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
24 * OTHER DEALINGS IN THE SOFTWARE.
25 */
26
27 #ifndef _DRM_DRV_H_
28 #define _DRM_DRV_H_
29
30 #include <linux/list.h>
31 #include <linux/irqreturn.h>
32
33 #include <video/nomodeset.h>
34
35 #include <drm/drm_device.h>
36
37 struct drm_fb_helper;
38 struct drm_fb_helper_surface_size;
39 struct drm_file;
40 struct drm_gem_object;
41 struct drm_master;
42 struct drm_minor;
43 struct dma_buf;
44 struct dma_buf_attachment;
45 struct drm_display_mode;
46 struct drm_mode_create_dumb;
47 struct drm_printer;
48 struct sg_table;
49
50 /**
51 * enum drm_driver_feature - feature flags
52 *
53 * See &drm_driver.driver_features, drm_device.driver_features and
54 * drm_core_check_feature().
55 */
56 enum drm_driver_feature {
57 /**
58 * @DRIVER_GEM:
59 *
60 * Driver use the GEM memory manager. This should be set for all modern
61 * drivers.
62 */
63 DRIVER_GEM = BIT(0),
64 /**
65 * @DRIVER_MODESET:
66 *
67 * Driver supports mode setting interfaces (KMS).
68 */
69 DRIVER_MODESET = BIT(1),
70 /**
71 * @DRIVER_RENDER:
72 *
73 * Driver supports dedicated render nodes. See also the :ref:`section on
74 * render nodes <drm_render_node>` for details.
75 */
76 DRIVER_RENDER = BIT(3),
77 /**
78 * @DRIVER_ATOMIC:
79 *
80 * Driver supports the full atomic modesetting userspace API. Drivers
81 * which only use atomic internally, but do not support the full
82 * userspace API (e.g. not all properties converted to atomic, or
83 * multi-plane updates are not guaranteed to be tear-free) should not
84 * set this flag.
85 */
86 DRIVER_ATOMIC = BIT(4),
87 /**
88 * @DRIVER_SYNCOBJ:
89 *
90 * Driver supports &drm_syncobj for explicit synchronization of command
91 * submission.
92 */
93 DRIVER_SYNCOBJ = BIT(5),
94 /**
95 * @DRIVER_SYNCOBJ_TIMELINE:
96 *
97 * Driver supports the timeline flavor of &drm_syncobj for explicit
98 * synchronization of command submission.
99 */
100 DRIVER_SYNCOBJ_TIMELINE = BIT(6),
101 /**
102 * @DRIVER_COMPUTE_ACCEL:
103 *
104 * Driver supports compute acceleration devices. This flag is mutually exclusive with
105 * @DRIVER_RENDER and @DRIVER_MODESET. Devices that support both graphics and compute
106 * acceleration should be handled by two drivers that are connected using auxiliary bus.
107 */
108 DRIVER_COMPUTE_ACCEL = BIT(7),
109 /**
110 * @DRIVER_GEM_GPUVA:
111 *
112 * Driver supports user defined GPU VA bindings for GEM objects.
113 */
114 DRIVER_GEM_GPUVA = BIT(8),
115 /**
116 * @DRIVER_CURSOR_HOTSPOT:
117 *
118 * Driver supports and requires cursor hotspot information in the
119 * cursor plane (e.g. cursor plane has to actually track the mouse
120 * cursor and the clients are required to set hotspot in order for
121 * the cursor planes to work correctly).
122 */
123 DRIVER_CURSOR_HOTSPOT = BIT(9),
124
125 /* IMPORTANT: Below are all the legacy flags, add new ones above. */
126
127 /**
128 * @DRIVER_USE_AGP:
129 *
130 * Set up DRM AGP support, see drm_agp_init(), the DRM core will manage
131 * AGP resources. New drivers don't need this.
132 */
133 DRIVER_USE_AGP = BIT(25),
134 /**
135 * @DRIVER_LEGACY:
136 *
137 * Denote a legacy driver using shadow attach. Do not use.
138 */
139 DRIVER_LEGACY = BIT(26),
140 /**
141 * @DRIVER_PCI_DMA:
142 *
143 * Driver is capable of PCI DMA, mapping of PCI DMA buffers to userspace
144 * will be enabled. Only for legacy drivers. Do not use.
145 */
146 DRIVER_PCI_DMA = BIT(27),
147 /**
148 * @DRIVER_SG:
149 *
150 * Driver can perform scatter/gather DMA, allocation and mapping of
151 * scatter/gather buffers will be enabled. Only for legacy drivers. Do
152 * not use.
153 */
154 DRIVER_SG = BIT(28),
155
156 /**
157 * @DRIVER_HAVE_DMA:
158 *
159 * Driver supports DMA, the userspace DMA API will be supported. Only
160 * for legacy drivers. Do not use.
161 */
162 DRIVER_HAVE_DMA = BIT(29),
163 /**
164 * @DRIVER_HAVE_IRQ:
165 *
166 * Legacy irq support. Only for legacy drivers. Do not use.
167 */
168 DRIVER_HAVE_IRQ = BIT(30),
169 };
170
171 /**
172 * struct drm_driver - DRM driver structure
173 *
174 * This structure represent the common code for a family of cards. There will be
175 * one &struct drm_device for each card present in this family. It contains lots
176 * of vfunc entries, and a pile of those probably should be moved to more
177 * appropriate places like &drm_mode_config_funcs or into a new operations
178 * structure for GEM drivers.
179 */
180 struct drm_driver {
181 /**
182 * @load:
183 *
184 * Backward-compatible driver callback to complete initialization steps
185 * after the driver is registered. For this reason, may suffer from
186 * race conditions and its use is deprecated for new drivers. It is
187 * therefore only supported for existing drivers not yet converted to
188 * the new scheme. See devm_drm_dev_alloc() and drm_dev_register() for
189 * proper and race-free way to set up a &struct drm_device.
190 *
191 * This is deprecated, do not use!
192 *
193 * Returns:
194 *
195 * Zero on success, non-zero value on failure.
196 */
197 int (*load) (struct drm_device *, unsigned long flags);
198
199 /**
200 * @open:
201 *
202 * Driver callback when a new &struct drm_file is opened. Useful for
203 * setting up driver-private data structures like buffer allocators,
204 * execution contexts or similar things. Such driver-private resources
205 * must be released again in @postclose.
206 *
207 * Since the display/modeset side of DRM can only be owned by exactly
208 * one &struct drm_file (see &drm_file.is_master and &drm_device.master)
209 * there should never be a need to set up any modeset related resources
210 * in this callback. Doing so would be a driver design bug.
211 *
212 * Returns:
213 *
214 * 0 on success, a negative error code on failure, which will be
215 * promoted to userspace as the result of the open() system call.
216 */
217 int (*open) (struct drm_device *, struct drm_file *);
218
219 /**
220 * @postclose:
221 *
222 * One of the driver callbacks when a new &struct drm_file is closed.
223 * Useful for tearing down driver-private data structures allocated in
224 * @open like buffer allocators, execution contexts or similar things.
225 *
226 * Since the display/modeset side of DRM can only be owned by exactly
227 * one &struct drm_file (see &drm_file.is_master and &drm_device.master)
228 * there should never be a need to tear down any modeset related
229 * resources in this callback. Doing so would be a driver design bug.
230 */
231 void (*postclose) (struct drm_device *, struct drm_file *);
232
233 /**
234 * @unload:
235 *
236 * Reverse the effects of the driver load callback. Ideally,
237 * the clean up performed by the driver should happen in the
238 * reverse order of the initialization. Similarly to the load
239 * hook, this handler is deprecated and its usage should be
240 * dropped in favor of an open-coded teardown function at the
241 * driver layer. See drm_dev_unregister() and drm_dev_put()
242 * for the proper way to remove a &struct drm_device.
243 *
244 * The unload() hook is called right after unregistering
245 * the device.
246 *
247 */
248 void (*unload) (struct drm_device *);
249
250 /**
251 * @release:
252 *
253 * Optional callback for destroying device data after the final
254 * reference is released, i.e. the device is being destroyed.
255 *
256 * This is deprecated, clean up all memory allocations associated with a
257 * &drm_device using drmm_add_action(), drmm_kmalloc() and related
258 * managed resources functions.
259 */
260 void (*release) (struct drm_device *);
261
262 /**
263 * @master_set:
264 *
265 * Called whenever the minor master is set. Only used by vmwgfx.
266 */
267 void (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
268 bool from_open);
269 /**
270 * @master_drop:
271 *
272 * Called whenever the minor master is dropped. Only used by vmwgfx.
273 */
274 void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv);
275
276 /**
277 * @debugfs_init:
278 *
279 * Allows drivers to create driver-specific debugfs files.
280 */
281 void (*debugfs_init)(struct drm_minor *minor);
282
283 /**
284 * @gem_create_object: constructor for gem objects
285 *
286 * Hook for allocating the GEM object struct, for use by the CMA
287 * and SHMEM GEM helpers. Returns a GEM object on success, or an
288 * ERR_PTR()-encoded error code otherwise.
289 */
290 struct drm_gem_object *(*gem_create_object)(struct drm_device *dev,
291 size_t size);
292
293 /**
294 * @prime_handle_to_fd:
295 *
296 * PRIME export function. Only used by vmwgfx.
297 */
298 int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
299 uint32_t handle, uint32_t flags, int *prime_fd);
300 /**
301 * @prime_fd_to_handle:
302 *
303 * PRIME import function. Only used by vmwgfx.
304 */
305 int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
306 int prime_fd, uint32_t *handle);
307
308 /**
309 * @gem_prime_import:
310 *
311 * Import hook for GEM drivers.
312 *
313 * This defaults to drm_gem_prime_import() if not set.
314 */
315 struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
316 struct dma_buf *dma_buf);
317 /**
318 * @gem_prime_import_sg_table:
319 *
320 * Optional hook used by the PRIME helper functions
321 * drm_gem_prime_import() respectively drm_gem_prime_import_dev().
322 */
323 struct drm_gem_object *(*gem_prime_import_sg_table)(
324 struct drm_device *dev,
325 struct dma_buf_attachment *attach,
326 struct sg_table *sgt);
327
328 /**
329 * @dumb_create:
330 *
331 * This creates a new dumb buffer in the driver's backing storage manager (GEM,
332 * TTM or something else entirely) and returns the resulting buffer handle. This
333 * handle can then be wrapped up into a framebuffer modeset object.
334 *
335 * Note that userspace is not allowed to use such objects for render
336 * acceleration - drivers must create their own private ioctls for such a use
337 * case.
338 *
339 * Width, height and depth are specified in the &drm_mode_create_dumb
340 * argument. The callback needs to fill the handle, pitch and size for
341 * the created buffer.
342 *
343 * Called by the user via ioctl.
344 *
345 * Returns:
346 *
347 * Zero on success, negative errno on failure.
348 */
349 int (*dumb_create)(struct drm_file *file_priv,
350 struct drm_device *dev,
351 struct drm_mode_create_dumb *args);
352 /**
353 * @dumb_map_offset:
354 *
355 * Allocate an offset in the drm device node's address space to be able to
356 * memory map a dumb buffer.
357 *
358 * The default implementation is drm_gem_create_mmap_offset(). GEM based
359 * drivers must not overwrite this.
360 *
361 * Called by the user via ioctl.
362 *
363 * Returns:
364 *
365 * Zero on success, negative errno on failure.
366 */
367 int (*dumb_map_offset)(struct drm_file *file_priv,
368 struct drm_device *dev, uint32_t handle,
369 uint64_t *offset);
370
371 /**
372 * @fbdev_probe:
373 *
374 * Allocates and initialize the fb_info structure for fbdev emulation.
375 * Furthermore it also needs to allocate the DRM framebuffer used to
376 * back the fbdev.
377 *
378 * This callback is mandatory for fbdev support.
379 *
380 * Returns:
381 *
382 * 0 on success ot a negative error code otherwise.
383 */
384 int (*fbdev_probe)(struct drm_fb_helper *fbdev_helper,
385 struct drm_fb_helper_surface_size *sizes);
386
387 /**
388 * @show_fdinfo:
389 *
390 * Print device specific fdinfo. See Documentation/gpu/drm-usage-stats.rst.
391 */
392 void (*show_fdinfo)(struct drm_printer *p, struct drm_file *f);
393
394 /** @major: driver major number */
395 int major;
396 /** @minor: driver minor number */
397 int minor;
398 /** @patchlevel: driver patch level */
399 int patchlevel;
400 /** @name: driver name */
401 char *name;
402 /** @desc: driver description */
403 char *desc;
404 /** @date: driver date, unused, to be removed */
405 char *date;
406
407 /**
408 * @driver_features:
409 * Driver features, see &enum drm_driver_feature. Drivers can disable
410 * some features on a per-instance basis using
411 * &drm_device.driver_features.
412 */
413 u32 driver_features;
414
415 /**
416 * @ioctls:
417 *
418 * Array of driver-private IOCTL description entries. See the chapter on
419 * :ref:`IOCTL support in the userland interfaces
420 * chapter<drm_driver_ioctl>` for the full details.
421 */
422
423 const struct drm_ioctl_desc *ioctls;
424 /** @num_ioctls: Number of entries in @ioctls. */
425 int num_ioctls;
426
427 /**
428 * @fops:
429 *
430 * File operations for the DRM device node. See the discussion in
431 * :ref:`file operations<drm_driver_fops>` for in-depth coverage and
432 * some examples.
433 */
434 const struct file_operations *fops;
435 };
436
437 void *__devm_drm_dev_alloc(struct device *parent,
438 const struct drm_driver *driver,
439 size_t size, size_t offset);
440
441 /**
442 * devm_drm_dev_alloc - Resource managed allocation of a &drm_device instance
443 * @parent: Parent device object
444 * @driver: DRM driver
445 * @type: the type of the struct which contains struct &drm_device
446 * @member: the name of the &drm_device within @type.
447 *
448 * This allocates and initialize a new DRM device. No device registration is done.
449 * Call drm_dev_register() to advertice the device to user space and register it
450 * with other core subsystems. This should be done last in the device
451 * initialization sequence to make sure userspace can't access an inconsistent
452 * state.
453 *
454 * The initial ref-count of the object is 1. Use drm_dev_get() and
455 * drm_dev_put() to take and drop further ref-counts.
456 *
457 * It is recommended that drivers embed &struct drm_device into their own device
458 * structure.
459 *
460 * Note that this manages the lifetime of the resulting &drm_device
461 * automatically using devres. The DRM device initialized with this function is
462 * automatically put on driver detach using drm_dev_put().
463 *
464 * RETURNS:
465 * Pointer to new DRM device, or ERR_PTR on failure.
466 */
467 #define devm_drm_dev_alloc(parent, driver, type, member) \
468 ((type *) __devm_drm_dev_alloc(parent, driver, sizeof(type), \
469 offsetof(type, member)))
470
471 struct drm_device *drm_dev_alloc(const struct drm_driver *driver,
472 struct device *parent);
473 int drm_dev_register(struct drm_device *dev, unsigned long flags);
474 void drm_dev_unregister(struct drm_device *dev);
475
476 void drm_dev_get(struct drm_device *dev);
477 void drm_dev_put(struct drm_device *dev);
478 void drm_put_dev(struct drm_device *dev);
479 bool drm_dev_enter(struct drm_device *dev, int *idx);
480 void drm_dev_exit(int idx);
481 void drm_dev_unplug(struct drm_device *dev);
482
483 /**
484 * drm_dev_is_unplugged - is a DRM device unplugged
485 * @dev: DRM device
486 *
487 * This function can be called to check whether a hotpluggable is unplugged.
488 * Unplugging itself is singalled through drm_dev_unplug(). If a device is
489 * unplugged, these two functions guarantee that any store before calling
490 * drm_dev_unplug() is visible to callers of this function after it completes
491 *
492 * WARNING: This function fundamentally races against drm_dev_unplug(). It is
493 * recommended that drivers instead use the underlying drm_dev_enter() and
494 * drm_dev_exit() function pairs.
495 */
drm_dev_is_unplugged(struct drm_device * dev)496 static inline bool drm_dev_is_unplugged(struct drm_device *dev)
497 {
498 int idx;
499
500 if (drm_dev_enter(dev, &idx)) {
501 drm_dev_exit(idx);
502 return false;
503 }
504
505 return true;
506 }
507
508 /**
509 * drm_core_check_all_features - check driver feature flags mask
510 * @dev: DRM device to check
511 * @features: feature flag(s) mask
512 *
513 * This checks @dev for driver features, see &drm_driver.driver_features,
514 * &drm_device.driver_features, and the various &enum drm_driver_feature flags.
515 *
516 * Returns true if all features in the @features mask are supported, false
517 * otherwise.
518 */
drm_core_check_all_features(const struct drm_device * dev,u32 features)519 static inline bool drm_core_check_all_features(const struct drm_device *dev,
520 u32 features)
521 {
522 u32 supported = dev->driver->driver_features & dev->driver_features;
523
524 return features && (supported & features) == features;
525 }
526
527 /**
528 * drm_core_check_feature - check driver feature flags
529 * @dev: DRM device to check
530 * @feature: feature flag
531 *
532 * This checks @dev for driver features, see &drm_driver.driver_features,
533 * &drm_device.driver_features, and the various &enum drm_driver_feature flags.
534 *
535 * Returns true if the @feature is supported, false otherwise.
536 */
drm_core_check_feature(const struct drm_device * dev,enum drm_driver_feature feature)537 static inline bool drm_core_check_feature(const struct drm_device *dev,
538 enum drm_driver_feature feature)
539 {
540 return drm_core_check_all_features(dev, feature);
541 }
542
543 /**
544 * drm_drv_uses_atomic_modeset - check if the driver implements
545 * atomic_commit()
546 * @dev: DRM device
547 *
548 * This check is useful if drivers do not have DRIVER_ATOMIC set but
549 * have atomic modesetting internally implemented.
550 */
drm_drv_uses_atomic_modeset(struct drm_device * dev)551 static inline bool drm_drv_uses_atomic_modeset(struct drm_device *dev)
552 {
553 return drm_core_check_feature(dev, DRIVER_ATOMIC) ||
554 (dev->mode_config.funcs && dev->mode_config.funcs->atomic_commit != NULL);
555 }
556
557
558 /* TODO: Inline drm_firmware_drivers_only() in all its callers. */
drm_firmware_drivers_only(void)559 static inline bool drm_firmware_drivers_only(void)
560 {
561 return video_firmware_drivers_only();
562 }
563
564 #if defined(CONFIG_DEBUG_FS)
565 void drm_debugfs_dev_init(struct drm_device *dev, struct dentry *root);
566 #else
drm_debugfs_dev_init(struct drm_device * dev,struct dentry * root)567 static inline void drm_debugfs_dev_init(struct drm_device *dev, struct dentry *root)
568 {
569 }
570 #endif
571
572 #endif
573