[linux.git] / drivers / uio / uio_pci_generic.c

// SPDX-License-Identifier: GPL-2.0
/* uio_pci_generic - generic UIO driver for PCI 2.3 devices
 *
 * Copyright (C) 2009 Red Hat, Inc.
 * Author: Michael S. Tsirkin <[email protected]>
 *
 * Since the driver does not declare any device ids, you must allocate
 * id and bind the device to the driver yourself.  For example:
 *
 * # echo "8086 10f5" > /sys/bus/pci/drivers/uio_pci_generic/new_id
 * # echo -n 0000:00:19.0 > /sys/bus/pci/drivers/e1000e/unbind
 * # echo -n 0000:00:19.0 > /sys/bus/pci/drivers/uio_pci_generic/bind
 * # ls -l /sys/bus/pci/devices/0000:00:19.0/driver
 * .../0000:00:19.0/driver -> ../../../bus/pci/drivers/uio_pci_generic
 *
 * Driver won't bind to devices which do not support the Interrupt Disable Bit
 * in the command register. All devices compliant to PCI 2.3 (circa 2002) and
 * all compliant PCI Express devices should support this bit.
 */

#include <linux/device.h>
#include <linux/module.h>
#include <linux/pci.h>
#include <linux/slab.h>
#include <linux/uio_driver.h>

#define DRIVER_VERSION	"0.01.0"
#define DRIVER_AUTHOR	"Michael S. Tsirkin <[email protected]>"
#define DRIVER_DESC	"Generic UIO driver for PCI 2.3 devices"

struct uio_pci_generic_dev {
	struct uio_info info;
	struct pci_dev *pdev;
};

static inline struct uio_pci_generic_dev *
to_uio_pci_generic_dev(struct uio_info *info)
{
	return container_of(info, struct uio_pci_generic_dev, info);
}

/* Interrupt handler. Read/modify/write the command register to disable
 * the interrupt. */
static irqreturn_t irqhandler(int irq, struct uio_info *info)
{
	struct uio_pci_generic_dev *gdev = to_uio_pci_generic_dev(info);

	if (!pci_check_and_mask_intx(gdev->pdev))
		return IRQ_NONE;

	/* UIO core will signal the user process. */
	return IRQ_HANDLED;
}

static int probe(struct pci_dev *pdev,
			   const struct pci_device_id *id)
{
	struct uio_pci_generic_dev *gdev;
	int err;

	err = pci_enable_device(pdev);
	if (err) {
		dev_err(&pdev->dev, "%s: pci_enable_device failed: %d\n",
			__func__, err);
		return err;
	}

	if (pdev->irq && !pci_intx_mask_supported(pdev)) {
		err = -ENODEV;
		goto err_verify;
	}

	gdev = kzalloc(sizeof(struct uio_pci_generic_dev), GFP_KERNEL);
	if (!gdev) {
		err = -ENOMEM;
		goto err_alloc;
	}

	gdev->info.name = "uio_pci_generic";
	gdev->info.version = DRIVER_VERSION;
	gdev->pdev = pdev;
	if (pdev->irq) {
		gdev->info.irq = pdev->irq;
		gdev->info.irq_flags = IRQF_SHARED;
		gdev->info.handler = irqhandler;
	} else {
		dev_warn(&pdev->dev, "No IRQ assigned to device: "
			 "no support for interrupts?\n");
	}

	err = uio_register_device(&pdev->dev, &gdev->info);
	if (err)
		goto err_register;
	pci_set_drvdata(pdev, gdev);

	return 0;
err_register:
	kfree(gdev);
err_alloc:
err_verify:
	pci_disable_device(pdev);
	return err;
}

static void remove(struct pci_dev *pdev)
{
	struct uio_pci_generic_dev *gdev = pci_get_drvdata(pdev);

	uio_unregister_device(&gdev->info);
	pci_disable_device(pdev);
	kfree(gdev);
}

static struct pci_driver uio_pci_driver = {
	.name = "uio_pci_generic",
	.id_table = NULL, /* only dynamic id's */
	.probe = probe,
	.remove = remove,
};

module_pci_driver(uio_pci_driver);
MODULE_VERSION(DRIVER_VERSION);
MODULE_LICENSE("GPL v2");
MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
Commit	Line	Data
bce5c2ea	1	// SPDX-License-Identifier: GPL-2.0
ccb86a69 MT	2	/* uio_pci_generic - generic UIO driver for PCI 2.3 devices
	3	*
	4	* Copyright (C) 2009 Red Hat, Inc.
	5	* Author: Michael S. Tsirkin <[email protected]>
	6	*
ccb86a69 MT	7	* Since the driver does not declare any device ids, you must allocate
	8	* id and bind the device to the driver yourself. For example:
	9	*
	10	* # echo "8086 10f5" > /sys/bus/pci/drivers/uio_pci_generic/new_id
	11	* # echo -n 0000:00:19.0 > /sys/bus/pci/drivers/e1000e/unbind
	12	* # echo -n 0000:00:19.0 > /sys/bus/pci/drivers/uio_pci_generic/bind
	13	* # ls -l /sys/bus/pci/devices/0000:00:19.0/driver
	14	* .../0000:00:19.0/driver -> ../../../bus/pci/drivers/uio_pci_generic
	15	*
	16	* Driver won't bind to devices which do not support the Interrupt Disable Bit
	17	* in the command register. All devices compliant to PCI 2.3 (circa 2002) and
	18	* all compliant PCI Express devices should support this bit.
	19	*/
	20
	21	#include <linux/device.h>
	22	#include <linux/module.h>
	23	#include <linux/pci.h>
5a0e3ad6	24	#include <linux/slab.h>
ccb86a69	25	#include <linux/uio_driver.h>
ccb86a69 MT	26
	27	#define DRIVER_VERSION "0.01.0"
	28	#define DRIVER_AUTHOR "Michael S. Tsirkin <[email protected]>"
	29	#define DRIVER_DESC "Generic UIO driver for PCI 2.3 devices"
	30
	31	struct uio_pci_generic_dev {
	32	struct uio_info info;
	33	struct pci_dev *pdev;
ccb86a69 MT	34	};
	35
	36	static inline struct uio_pci_generic_dev *
	37	to_uio_pci_generic_dev(struct uio_info *info)
	38	{
	39	return container_of(info, struct uio_pci_generic_dev, info);
	40	}
	41
	42	/* Interrupt handler. Read/modify/write the command register to disable
	43	* the interrupt. */
	44	static irqreturn_t irqhandler(int irq, struct uio_info *info)
	45	{
	46	struct uio_pci_generic_dev *gdev = to_uio_pci_generic_dev(info);
ccb86a69	47
2502dbdf JK	48	if (!pci_check_and_mask_intx(gdev->pdev))
2502dbdf JK	49	return IRQ_NONE;
ccb86a69 MT	50
ccb86a69 MT	51	/* UIO core will signal the user process. */
2502dbdf	52	return IRQ_HANDLED;
ccb86a69 MT	53	}
ccb86a69 MT	54
b17b75bb	55	static int probe(struct pci_dev *pdev,
ccb86a69 MT	56	const struct pci_device_id *id)
	57	{
	58	struct uio_pci_generic_dev *gdev;
	59	int err;
	60
ccb86a69 MT	61	err = pci_enable_device(pdev);
	62	if (err) {
	63	dev_err(&pdev->dev, "%s: pci_enable_device failed: %d\n",
	64	__func__, err);
	65	return err;
	66	}
	67
acec09e6	68	if (pdev->irq && !pci_intx_mask_supported(pdev)) {
2502dbdf	69	err = -ENODEV;
ccb86a69	70	goto err_verify;
2502dbdf	71	}
ccb86a69 MT	72
	73	gdev = kzalloc(sizeof(struct uio_pci_generic_dev), GFP_KERNEL);
	74	if (!gdev) {
	75	err = -ENOMEM;
	76	goto err_alloc;
	77	}
	78
	79	gdev->info.name = "uio_pci_generic";
	80	gdev->info.version = DRIVER_VERSION;
ccb86a69	81	gdev->pdev = pdev;
acec09e6 JH	82	if (pdev->irq) {
	83	gdev->info.irq = pdev->irq;
	84	gdev->info.irq_flags = IRQF_SHARED;
	85	gdev->info.handler = irqhandler;
	86	} else {
	87	dev_warn(&pdev->dev, "No IRQ assigned to device: "
	88	"no support for interrupts?\n");
	89	}
ccb86a69	90
c4277e9e AK	91	err = uio_register_device(&pdev->dev, &gdev->info);
c4277e9e AK	92	if (err)
ccb86a69 MT	93	goto err_register;
	94	pci_set_drvdata(pdev, gdev);
	95
	96	return 0;
	97	err_register:
	98	kfree(gdev);
	99	err_alloc:
	100	err_verify:
	101	pci_disable_device(pdev);
	102	return err;
	103	}
	104
	105	static void remove(struct pci_dev *pdev)
	106	{
	107	struct uio_pci_generic_dev *gdev = pci_get_drvdata(pdev);
	108
	109	uio_unregister_device(&gdev->info);
	110	pci_disable_device(pdev);
	111	kfree(gdev);
	112	}
	113
cd437398	114	static struct pci_driver uio_pci_driver = {
ccb86a69 MT	115	.name = "uio_pci_generic",
	116	.id_table = NULL, /* only dynamic id's */
	117	.probe = probe,
	118	.remove = remove,
	119	};
	120
cd437398	121	module_pci_driver(uio_pci_driver);
ccb86a69 MT	122	MODULE_VERSION(DRIVER_VERSION);
	123	MODULE_LICENSE("GPL v2");
	124	MODULE_AUTHOR(DRIVER_AUTHOR);
	125	MODULE_DESCRIPTION(DRIVER_DESC);