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