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