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

source code of linux/include/drm/drm_drv.h