[mirror_ubuntu-bionic-kernel.git] / drivers / gpu / drm / drm_irq.c

/*
 * drm_irq.c IRQ and vblank support
 *
 * \author Rickard E. (Rik) Faith <faith@valinux.com>
 * \author Gareth Hughes <gareth@valinux.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */

/*
 * Created: Fri Mar 19 14:30:16 1999 by faith@valinux.com
 *
 * Copyright 1999, 2000 Precision Insight, Inc., Cedar Park, Texas.
 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
 * All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */

#include <drm/drm_irq.h>
#include <drm/drmP.h>

#include <linux/interrupt.h>	/* For task queue support */

#include <linux/vgaarb.h>
#include <linux/export.h>

#include "drm_internal.h"

/**
 * DOC: irq helpers
 *
 * The DRM core provides very simple support helpers to enable IRQ handling on a
 * device through the drm_irq_install() and drm_irq_uninstall() functions. This
 * only supports devices with a single interrupt on the main device stored in
 * &drm_device.dev and set as the device paramter in drm_dev_alloc().
 *
 * These IRQ helpers are strictly optional. Drivers which roll their own only
 * need to set &drm_device.irq_enabled to signal the DRM core that vblank
 * interrupts are working. Since these helpers don't automatically clean up the
 * requested interrupt like e.g. devm_request_irq() they're not really
 * recommended.
 */

/**
 * drm_irq_install - install IRQ handler
 * @dev: DRM device
 * @irq: IRQ number to install the handler for
 *
 * Initializes the IRQ related data. Installs the handler, calling the driver
 * &drm_driver.irq_preinstall and &drm_driver.irq_postinstall functions before
 * and after the installation.
 *
 * This is the simplified helper interface provided for drivers with no special
 * needs. Drivers which need to install interrupt handlers for multiple
 * interrupts must instead set &drm_device.irq_enabled to signal the DRM core
 * that vblank interrupts are available.
 *
 * @irq must match the interrupt number that would be passed to request_irq(),
 * if called directly instead of using this helper function.
 *
 * &drm_driver.irq_handler is called to handle the registered interrupt.
 *
 * Returns:
 * Zero on success or a negative error code on failure.
 */
int drm_irq_install(struct drm_device *dev, int irq)
{
	int ret;
	unsigned long sh_flags = 0;

	if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
		return -EINVAL;

	if (irq == 0)
		return -EINVAL;

	/* Driver must have been initialized */
	if (!dev->dev_private)
		return -EINVAL;

	if (dev->irq_enabled)
		return -EBUSY;
	dev->irq_enabled = true;

	DRM_DEBUG("irq=%d\n", irq);

	/* Before installing handler */
	if (dev->driver->irq_preinstall)
		dev->driver->irq_preinstall(dev);

	/* Install handler */
	if (drm_core_check_feature(dev, DRIVER_IRQ_SHARED))
		sh_flags = IRQF_SHARED;

	ret = request_irq(irq, dev->driver->irq_handler,
			  sh_flags, dev->driver->name, dev);

	if (ret < 0) {
		dev->irq_enabled = false;
		return ret;
	}

	/* After installing handler */
	if (dev->driver->irq_postinstall)
		ret = dev->driver->irq_postinstall(dev);

	if (ret < 0) {
		dev->irq_enabled = false;
		if (drm_core_check_feature(dev, DRIVER_LEGACY))
			vga_client_register(dev->pdev, NULL, NULL, NULL);
		free_irq(irq, dev);
	} else {
		dev->irq = irq;
	}

	return ret;
}
EXPORT_SYMBOL(drm_irq_install);

/**
 * drm_irq_uninstall - uninstall the IRQ handler
 * @dev: DRM device
 *
 * Calls the driver's &drm_driver.irq_uninstall function and unregisters the IRQ
 * handler.  This should only be called by drivers which used drm_irq_install()
 * to set up their interrupt handler. Other drivers must only reset
 * &drm_device.irq_enabled to false.
 *
 * Note that for kernel modesetting drivers it is a bug if this function fails.
 * The sanity checks are only to catch buggy user modesetting drivers which call
 * the same function through an ioctl.
 *
 * Returns:
 * Zero on success or a negative error code on failure.
 */
int drm_irq_uninstall(struct drm_device *dev)
{
	unsigned long irqflags;
	bool irq_enabled;
	int i;

	if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
		return -EINVAL;

	irq_enabled = dev->irq_enabled;
	dev->irq_enabled = false;

	/*
	 * Wake up any waiters so they don't hang. This is just to paper over
	 * issues for UMS drivers which aren't in full control of their
	 * vblank/irq handling. KMS drivers must ensure that vblanks are all
	 * disabled when uninstalling the irq handler.
	 */
	if (dev->num_crtcs) {
		spin_lock_irqsave(&dev->vbl_lock, irqflags);
		for (i = 0; i < dev->num_crtcs; i++) {
			struct drm_vblank_crtc *vblank = &dev->vblank[i];

			if (!vblank->enabled)
				continue;

			WARN_ON(drm_core_check_feature(dev, DRIVER_MODESET));

			drm_vblank_disable_and_save(dev, i);
			wake_up(&vblank->queue);
		}
		spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
	}

	if (!irq_enabled)
		return -EINVAL;

	DRM_DEBUG("irq=%d\n", dev->irq);

	if (drm_core_check_feature(dev, DRIVER_LEGACY))
		vga_client_register(dev->pdev, NULL, NULL, NULL);

	if (dev->driver->irq_uninstall)
		dev->driver->irq_uninstall(dev);

	free_irq(dev->irq, dev);

	return 0;
}
EXPORT_SYMBOL(drm_irq_uninstall);

int drm_legacy_irq_control(struct drm_device *dev, void *data,
			   struct drm_file *file_priv)
{
	struct drm_control *ctl = data;
	int ret = 0, irq;

	/* if we haven't irq we fallback for compatibility reasons -
	 * this used to be a separate function in drm_dma.h
	 */

	if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
		return 0;
	if (!drm_core_check_feature(dev, DRIVER_LEGACY))
		return 0;
	/* UMS was only ever supported on pci devices. */
	if (WARN_ON(!dev->pdev))
		return -EINVAL;

	switch (ctl->func) {
	case DRM_INST_HANDLER:
		irq = dev->pdev->irq;

		if (dev->if_version < DRM_IF_VERSION(1, 2) &&
		    ctl->irq != irq)
			return -EINVAL;
		mutex_lock(&dev->struct_mutex);
		ret = drm_irq_install(dev, irq);
		mutex_unlock(&dev->struct_mutex);

		return ret;
	case DRM_UNINST_HANDLER:
		mutex_lock(&dev->struct_mutex);
		ret = drm_irq_uninstall(dev);
		mutex_unlock(&dev->struct_mutex);

		return ret;
	default:
		return -EINVAL;
	}
}
Commit	Line	Data
f5752b38 DV	1	/*
f5752b38 DV	2	* drm_irq.c IRQ and vblank support
1da177e4 LT	3	*
	4	* \author Rickard E. (Rik) Faith <faith@valinux.com>
	5	* \author Gareth Hughes <gareth@valinux.com>
3ed4351a DV	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.
1da177e4 LT	25	*/
	26
	27	/*
	28	* Created: Fri Mar 19 14:30:16 1999 by faith@valinux.com
	29	*
	30	* Copyright 1999, 2000 Precision Insight, Inc., Cedar Park, Texas.
	31	* Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
	32	* All Rights Reserved.
	33	*
	34	* Permission is hereby granted, free of charge, to any person obtaining a
	35	* copy of this software and associated documentation files (the "Software"),
	36	* to deal in the Software without restriction, including without limitation
	37	* the rights to use, copy, modify, merge, publish, distribute, sublicense,
	38	* and/or sell copies of the Software, and to permit persons to whom the
	39	* Software is furnished to do so, subject to the following conditions:
	40	*
	41	* The above copyright notice and this permission notice (including the next
	42	* paragraph) shall be included in all copies or substantial portions of the
	43	* Software.
	44	*
	45	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	46	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	47	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	48	* VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
	49	* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
	50	* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
	51	* OTHER DEALINGS IN THE SOFTWARE.
	52	*/
	53
3ed4351a	54	#include <drm/drm_irq.h>
760285e7	55	#include <drm/drmP.h>
1da177e4 LT	56
	57	#include <linux/interrupt.h> /* For task queue support */
	58
28d52043	59	#include <linux/vgaarb.h>
2d1a8a48	60	#include <linux/export.h>
27641c3f	61
3ed4351a	62	#include "drm_internal.h"
0a3e67a4	63
16584b20 DV	64	/**
	65	* DOC: irq helpers
	66	*
	67	* The DRM core provides very simple support helpers to enable IRQ handling on a
	68	* device through the drm_irq_install() and drm_irq_uninstall() functions. This
	69	* only supports devices with a single interrupt on the main device stored in
	70	* &drm_device.dev and set as the device paramter in drm_dev_alloc().
	71	*
	72	* These IRQ helpers are strictly optional. Drivers which roll their own only
	73	* need to set &drm_device.irq_enabled to signal the DRM core that vblank
	74	* interrupts are working. Since these helpers don't automatically clean up the
	75	* requested interrupt like e.g. devm_request_irq() they're not really
	76	* recommended.
	77	*/
	78
1da177e4	79	/**
f5752b38 DV	80	* drm_irq_install - install IRQ handler
	81	* @dev: DRM device
	82	* @irq: IRQ number to install the handler for
1da177e4	83	*
0a3e67a4	84	* Initializes the IRQ related data. Installs the handler, calling the driver
16584b20 DV	85	* &drm_driver.irq_preinstall and &drm_driver.irq_postinstall functions before
16584b20 DV	86	* and after the installation.
f5752b38 DV	87	*
	88	* This is the simplified helper interface provided for drivers with no special
	89	* needs. Drivers which need to install interrupt handlers for multiple
ef40cbf9	90	* interrupts must instead set &drm_device.irq_enabled to signal the DRM core
f5752b38 DV	91	* that vblank interrupts are available.
f5752b38 DV	92	*
16584b20 DV	93	* @irq must match the interrupt number that would be passed to request_irq(),
	94	* if called directly instead of using this helper function.
	95	*
	96	* &drm_driver.irq_handler is called to handle the registered interrupt.
	97	*
f5752b38 DV	98	* Returns:
f5752b38 DV	99	* Zero on success or a negative error code on failure.
1da177e4	100	*/
bb0f1b5c	101	int drm_irq_install(struct drm_device *dev, int irq)
1da177e4	102	{
4a1b0714	103	int ret;
b5e89ed5	104	unsigned long sh_flags = 0;
1da177e4 LT	105
	106	if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
	107	return -EINVAL;
	108
7c1a38e3	109	if (irq == 0)
1da177e4 LT	110	return -EINVAL;
1da177e4 LT	111
1da177e4	112	/* Driver must have been initialized */
e090c53b	113	if (!dev->dev_private)
1da177e4	114	return -EINVAL;
1da177e4	115
e090c53b	116	if (dev->irq_enabled)
1da177e4	117	return -EBUSY;
4423843c	118	dev->irq_enabled = true;
1da177e4	119
7c1a38e3	120	DRM_DEBUG("irq=%d\n", irq);
1da177e4	121
b5e89ed5	122	/* Before installing handler */
5037f8ac JS	123	if (dev->driver->irq_preinstall)
5037f8ac JS	124	dev->driver->irq_preinstall(dev);
1da177e4	125
b5e89ed5	126	/* Install handler */
1da177e4	127	if (drm_core_check_feature(dev, DRIVER_IRQ_SHARED))
935f6e3a	128	sh_flags = IRQF_SHARED;
b5e89ed5	129
7c1a38e3	130	ret = request_irq(irq, dev->driver->irq_handler,
5829d183	131	sh_flags, dev->driver->name, dev);
9bfbd5cb	132
b5e89ed5	133	if (ret < 0) {
4423843c	134	dev->irq_enabled = false;
1da177e4 LT	135	return ret;
	136	}
	137
b5e89ed5	138	/* After installing handler */
5037f8ac JS	139	if (dev->driver->irq_postinstall)
	140	ret = dev->driver->irq_postinstall(dev);
	141
0a3e67a4	142	if (ret < 0) {
4423843c	143	dev->irq_enabled = false;
fa538645	144	if (drm_core_check_feature(dev, DRIVER_LEGACY))
e1c44acc	145	vga_client_register(dev->pdev, NULL, NULL, NULL);
7c1a38e3 DV	146	free_irq(irq, dev);
	147	} else {
	148	dev->irq = irq;
0a3e67a4	149	}
1da177e4	150
0a3e67a4	151	return ret;
1da177e4	152	}
0a3e67a4	153	EXPORT_SYMBOL(drm_irq_install);
1da177e4 LT	154
1da177e4 LT	155	/**
f5752b38 DV	156	* drm_irq_uninstall - uninstall the IRQ handler
	157	* @dev: DRM device
	158	*
16584b20 DV	159	* Calls the driver's &drm_driver.irq_uninstall function and unregisters the IRQ
	160	* handler. This should only be called by drivers which used drm_irq_install()
	161	* to set up their interrupt handler. Other drivers must only reset
ef40cbf9	162	* &drm_device.irq_enabled to false.
1da177e4	163	*
f5752b38 DV	164	* Note that for kernel modesetting drivers it is a bug if this function fails.
	165	* The sanity checks are only to catch buggy user modesetting drivers which call
	166	* the same function through an ioctl.
1da177e4	167	*
f5752b38 DV	168	* Returns:
f5752b38 DV	169	* Zero on success or a negative error code on failure.
1da177e4	170	*/
27641c3f	171	int drm_irq_uninstall(struct drm_device *dev)
1da177e4	172	{
dc1336ff	173	unsigned long irqflags;
4423843c VS	174	bool irq_enabled;
4423843c VS	175	int i;
1da177e4 LT	176
	177	if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
	178	return -EINVAL;
	179
1da177e4	180	irq_enabled = dev->irq_enabled;
4423843c	181	dev->irq_enabled = false;
1da177e4	182
dc1336ff	183	/*
3bff93d6	184	* Wake up any waiters so they don't hang. This is just to paper over
c78d1ca2	185	* issues for UMS drivers which aren't in full control of their
3bff93d6 DV	186	* vblank/irq handling. KMS drivers must ensure that vblanks are all
3bff93d6 DV	187	* disabled when uninstalling the irq handler.
dc1336ff	188	*/
bde4889a BS	189	if (dev->num_crtcs) {
	190	spin_lock_irqsave(&dev->vbl_lock, irqflags);
	191	for (i = 0; i < dev->num_crtcs; i++) {
8a51d5be VS	192	struct drm_vblank_crtc *vblank = &dev->vblank[i];
8a51d5be VS	193
3bff93d6 DV	194	if (!vblank->enabled)
	195	continue;
	196
	197	WARN_ON(drm_core_check_feature(dev, DRIVER_MODESET));
	198
3ed4351a	199	drm_vblank_disable_and_save(dev, i);
8a51d5be	200	wake_up(&vblank->queue);
bde4889a BS	201	}
bde4889a BS	202	spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
dc1336ff	203	}
dc1336ff	204
b5e89ed5	205	if (!irq_enabled)
1da177e4 LT	206	return -EINVAL;
1da177e4 LT	207
7c1a38e3	208	DRM_DEBUG("irq=%d\n", dev->irq);
1da177e4	209
fa538645	210	if (drm_core_check_feature(dev, DRIVER_LEGACY))
28d52043 DA	211	vga_client_register(dev->pdev, NULL, NULL, NULL);
28d52043 DA	212
5037f8ac JS	213	if (dev->driver->irq_uninstall)
5037f8ac JS	214	dev->driver->irq_uninstall(dev);
1da177e4	215
7c1a38e3	216	free_irq(dev->irq, dev);
1da177e4 LT	217
	218	return 0;
	219	}
	220	EXPORT_SYMBOL(drm_irq_uninstall);
	221
25a9939c DV	222	int drm_legacy_irq_control(struct drm_device dev, void data,
25a9939c DV	223	struct drm_file *file_priv)
1da177e4	224	{
c153f45f	225	struct drm_control *ctl = data;
a319c1a4	226	int ret = 0, irq;
b5e89ed5	227
27641c3f MK	228	/* if we haven't irq we fallback for compatibility reasons -
	229	* this used to be a separate function in drm_dma.h
	230	*/
1da177e4	231
22471cf6 DV	232	if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
22471cf6 DV	233	return 0;
fa538645	234	if (!drm_core_check_feature(dev, DRIVER_LEGACY))
22471cf6	235	return 0;
c78d1ca2	236	/* UMS was only ever supported on pci devices. */
22471cf6 DV	237	if (WARN_ON(!dev->pdev))
22471cf6 DV	238	return -EINVAL;
1da177e4	239
c153f45f	240	switch (ctl->func) {
1da177e4	241	case DRM_INST_HANDLER:
a319c1a4 DV	242	irq = dev->pdev->irq;
a319c1a4 DV	243
1da177e4	244	if (dev->if_version < DRM_IF_VERSION(1, 2) &&
a319c1a4	245	ctl->irq != irq)
1da177e4	246	return -EINVAL;
e090c53b	247	mutex_lock(&dev->struct_mutex);
bb0f1b5c	248	ret = drm_irq_install(dev, irq);
e090c53b DV	249	mutex_unlock(&dev->struct_mutex);
	250
	251	return ret;
1da177e4	252	case DRM_UNINST_HANDLER:
e090c53b DV	253	mutex_lock(&dev->struct_mutex);
	254	ret = drm_irq_uninstall(dev);
	255	mutex_unlock(&dev->struct_mutex);
	256
	257	return ret;
1da177e4 LT	258	default:
	259	return -EINVAL;
	260	}
	261	}