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