[mirror_ubuntu-jammy-kernel.git] / drivers / misc / phantom.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 *  Copyright (C) 2005-2007 Jiri Slaby <jirislaby@gmail.com>
 *
 *  You need a userspace library to cooperate with this driver. It (and other
 *  info) may be obtained here:
 *  http://www.fi.muni.cz/~xslaby/phantom.html
 *  or alternatively, you might use OpenHaptics provided by Sensable.
 */

#include <linux/compat.h>
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/device.h>
#include <linux/pci.h>
#include <linux/fs.h>
#include <linux/poll.h>
#include <linux/interrupt.h>
#include <linux/cdev.h>
#include <linux/slab.h>
#include <linux/phantom.h>
#include <linux/sched.h>
#include <linux/mutex.h>

#include <linux/atomic.h>
#include <asm/io.h>

#define PHANTOM_VERSION		"n0.9.8"

#define PHANTOM_MAX_MINORS	8

#define PHN_IRQCTL		0x4c    /* irq control in caddr space */

#define PHB_RUNNING		1
#define PHB_NOT_OH		2

static DEFINE_MUTEX(phantom_mutex);
static struct class *phantom_class;
static int phantom_major;

struct phantom_device {
	unsigned int opened;
	void __iomem *caddr;
	u32 __iomem *iaddr;
	u32 __iomem *oaddr;
	unsigned long status;
	atomic_t counter;

	wait_queue_head_t wait;
	struct cdev cdev;

	struct mutex open_lock;
	spinlock_t regs_lock;

	/* used in NOT_OH mode */
	struct phm_regs oregs;
	u32 ctl_reg;
};

static unsigned char phantom_devices[PHANTOM_MAX_MINORS];

static int phantom_status(struct phantom_device *dev, unsigned long newstat)
{
	pr_debug("phantom_status %lx %lx\n", dev->status, newstat);

	if (!(dev->status & PHB_RUNNING) && (newstat & PHB_RUNNING)) {
		atomic_set(&dev->counter, 0);
		iowrite32(PHN_CTL_IRQ, dev->iaddr + PHN_CONTROL);
		iowrite32(0x43, dev->caddr + PHN_IRQCTL);
		ioread32(dev->caddr + PHN_IRQCTL); /* PCI posting */
	} else if ((dev->status & PHB_RUNNING) && !(newstat & PHB_RUNNING)) {
		iowrite32(0, dev->caddr + PHN_IRQCTL);
		ioread32(dev->caddr + PHN_IRQCTL); /* PCI posting */
	}

	dev->status = newstat;

	return 0;
}

/*
 * File ops
 */

static long phantom_ioctl(struct file *file, unsigned int cmd,
		unsigned long arg)
{
	struct phantom_device *dev = file->private_data;
	struct phm_regs rs;
	struct phm_reg r;
	void __user *argp = (void __user *)arg;
	unsigned long flags;
	unsigned int i;

	switch (cmd) {
	case PHN_SETREG:
	case PHN_SET_REG:
		if (copy_from_user(&r, argp, sizeof(r)))
			return -EFAULT;

		if (r.reg > 7)
			return -EINVAL;

		spin_lock_irqsave(&dev->regs_lock, flags);
		if (r.reg == PHN_CONTROL && (r.value & PHN_CTL_IRQ) &&
				phantom_status(dev, dev->status | PHB_RUNNING)){
			spin_unlock_irqrestore(&dev->regs_lock, flags);
			return -ENODEV;
		}

		pr_debug("phantom: writing %x to %u\n", r.value, r.reg);

		/* preserve amp bit (don't allow to change it when in NOT_OH) */
		if (r.reg == PHN_CONTROL && (dev->status & PHB_NOT_OH)) {
			r.value &= ~PHN_CTL_AMP;
			r.value |= dev->ctl_reg & PHN_CTL_AMP;
			dev->ctl_reg = r.value;
		}

		iowrite32(r.value, dev->iaddr + r.reg);
		ioread32(dev->iaddr); /* PCI posting */

		if (r.reg == PHN_CONTROL && !(r.value & PHN_CTL_IRQ))
			phantom_status(dev, dev->status & ~PHB_RUNNING);
		spin_unlock_irqrestore(&dev->regs_lock, flags);
		break;
	case PHN_SETREGS:
	case PHN_SET_REGS:
		if (copy_from_user(&rs, argp, sizeof(rs)))
			return -EFAULT;

		pr_debug("phantom: SRS %u regs %x\n", rs.count, rs.mask);
		spin_lock_irqsave(&dev->regs_lock, flags);
		if (dev->status & PHB_NOT_OH)
			memcpy(&dev->oregs, &rs, sizeof(rs));
		else {
			u32 m = min(rs.count, 8U);
			for (i = 0; i < m; i++)
				if (rs.mask & BIT(i))
					iowrite32(rs.values[i], dev->oaddr + i);
			ioread32(dev->iaddr); /* PCI posting */
		}
		spin_unlock_irqrestore(&dev->regs_lock, flags);
		break;
	case PHN_GETREG:
	case PHN_GET_REG:
		if (copy_from_user(&r, argp, sizeof(r)))
			return -EFAULT;

		if (r.reg > 7)
			return -EINVAL;

		r.value = ioread32(dev->iaddr + r.reg);

		if (copy_to_user(argp, &r, sizeof(r)))
			return -EFAULT;
		break;
	case PHN_GETREGS:
	case PHN_GET_REGS: {
		u32 m;

		if (copy_from_user(&rs, argp, sizeof(rs)))
			return -EFAULT;

		m = min(rs.count, 8U);

		pr_debug("phantom: GRS %u regs %x\n", rs.count, rs.mask);
		spin_lock_irqsave(&dev->regs_lock, flags);
		for (i = 0; i < m; i++)
			if (rs.mask & BIT(i))
				rs.values[i] = ioread32(dev->iaddr + i);
		atomic_set(&dev->counter, 0);
		spin_unlock_irqrestore(&dev->regs_lock, flags);

		if (copy_to_user(argp, &rs, sizeof(rs)))
			return -EFAULT;
		break;
	} case PHN_NOT_OH:
		spin_lock_irqsave(&dev->regs_lock, flags);
		if (dev->status & PHB_RUNNING) {
			printk(KERN_ERR "phantom: you need to set NOT_OH "
					"before you start the device!\n");
			spin_unlock_irqrestore(&dev->regs_lock, flags);
			return -EINVAL;
		}
		dev->status |= PHB_NOT_OH;
		spin_unlock_irqrestore(&dev->regs_lock, flags);
		break;
	default:
		return -ENOTTY;
	}

	return 0;
}

#ifdef CONFIG_COMPAT
static long phantom_compat_ioctl(struct file *filp, unsigned int cmd,
		unsigned long arg)
{
	if (_IOC_NR(cmd) <= 3 && _IOC_SIZE(cmd) == sizeof(compat_uptr_t)) {
		cmd &= ~(_IOC_SIZEMASK << _IOC_SIZESHIFT);
		cmd |= sizeof(void *) << _IOC_SIZESHIFT;
	}
	return phantom_ioctl(filp, cmd, (unsigned long)compat_ptr(arg));
}
#else
#define phantom_compat_ioctl NULL
#endif

static int phantom_open(struct inode *inode, struct file *file)
{
	struct phantom_device *dev = container_of(inode->i_cdev,
			struct phantom_device, cdev);

	mutex_lock(&phantom_mutex);
	nonseekable_open(inode, file);

	if (mutex_lock_interruptible(&dev->open_lock)) {
		mutex_unlock(&phantom_mutex);
		return -ERESTARTSYS;
	}

	if (dev->opened) {
		mutex_unlock(&dev->open_lock);
		mutex_unlock(&phantom_mutex);
		return -EINVAL;
	}

	WARN_ON(dev->status & PHB_NOT_OH);

	file->private_data = dev;

	atomic_set(&dev->counter, 0);
	dev->opened++;
	mutex_unlock(&dev->open_lock);
	mutex_unlock(&phantom_mutex);
	return 0;
}

static int phantom_release(struct inode *inode, struct file *file)
{
	struct phantom_device *dev = file->private_data;

	mutex_lock(&dev->open_lock);

	dev->opened = 0;
	phantom_status(dev, dev->status & ~PHB_RUNNING);
	dev->status &= ~PHB_NOT_OH;

	mutex_unlock(&dev->open_lock);

	return 0;
}

static __poll_t phantom_poll(struct file *file, poll_table *wait)
{
	struct phantom_device *dev = file->private_data;
	__poll_t mask = 0;

	pr_debug("phantom_poll: %d\n", atomic_read(&dev->counter));
	poll_wait(file, &dev->wait, wait);

	if (!(dev->status & PHB_RUNNING))
		mask = EPOLLERR;
	else if (atomic_read(&dev->counter))
		mask = EPOLLIN | EPOLLRDNORM;

	pr_debug("phantom_poll end: %x/%d\n", mask, atomic_read(&dev->counter));

	return mask;
}

static const struct file_operations phantom_file_ops = {
	.open = phantom_open,
	.release = phantom_release,
	.unlocked_ioctl = phantom_ioctl,
	.compat_ioctl = phantom_compat_ioctl,
	.poll = phantom_poll,
	.llseek = no_llseek,
};

static irqreturn_t phantom_isr(int irq, void *data)
{
	struct phantom_device *dev = data;
	unsigned int i;
	u32 ctl;

	spin_lock(&dev->regs_lock);
	ctl = ioread32(dev->iaddr + PHN_CONTROL);
	if (!(ctl & PHN_CTL_IRQ)) {
		spin_unlock(&dev->regs_lock);
		return IRQ_NONE;
	}

	iowrite32(0, dev->iaddr);
	iowrite32(0xc0, dev->iaddr);

	if (dev->status & PHB_NOT_OH) {
		struct phm_regs *r = &dev->oregs;
		u32 m = min(r->count, 8U);

		for (i = 0; i < m; i++)
			if (r->mask & BIT(i))
				iowrite32(r->values[i], dev->oaddr + i);

		dev->ctl_reg ^= PHN_CTL_AMP;
		iowrite32(dev->ctl_reg, dev->iaddr + PHN_CONTROL);
	}
	spin_unlock(&dev->regs_lock);

	ioread32(dev->iaddr); /* PCI posting */

	atomic_inc(&dev->counter);
	wake_up_interruptible(&dev->wait);

	return IRQ_HANDLED;
}

/*
 * Init and deinit driver
 */

static unsigned int phantom_get_free(void)
{
	unsigned int i;

	for (i = 0; i < PHANTOM_MAX_MINORS; i++)
		if (phantom_devices[i] == 0)
			break;

	return i;
}

static int phantom_probe(struct pci_dev *pdev,
	const struct pci_device_id *pci_id)
{
	struct phantom_device *pht;
	unsigned int minor;
	int retval;

	retval = pci_enable_device(pdev);
	if (retval) {
		dev_err(&pdev->dev, "pci_enable_device failed!\n");
		goto err;
	}

	minor = phantom_get_free();
	if (minor == PHANTOM_MAX_MINORS) {
		dev_err(&pdev->dev, "too many devices found!\n");
		retval = -EIO;
		goto err_dis;
	}

	phantom_devices[minor] = 1;

	retval = pci_request_regions(pdev, "phantom");
	if (retval) {
		dev_err(&pdev->dev, "pci_request_regions failed!\n");
		goto err_null;
	}

	retval = -ENOMEM;
	pht = kzalloc(sizeof(*pht), GFP_KERNEL);
	if (pht == NULL) {
		dev_err(&pdev->dev, "unable to allocate device\n");
		goto err_reg;
	}

	pht->caddr = pci_iomap(pdev, 0, 0);
	if (pht->caddr == NULL) {
		dev_err(&pdev->dev, "can't remap conf space\n");
		goto err_fr;
	}
	pht->iaddr = pci_iomap(pdev, 2, 0);
	if (pht->iaddr == NULL) {
		dev_err(&pdev->dev, "can't remap input space\n");
		goto err_unmc;
	}
	pht->oaddr = pci_iomap(pdev, 3, 0);
	if (pht->oaddr == NULL) {
		dev_err(&pdev->dev, "can't remap output space\n");
		goto err_unmi;
	}

	mutex_init(&pht->open_lock);
	spin_lock_init(&pht->regs_lock);
	init_waitqueue_head(&pht->wait);
	cdev_init(&pht->cdev, &phantom_file_ops);
	pht->cdev.owner = THIS_MODULE;

	iowrite32(0, pht->caddr + PHN_IRQCTL);
	ioread32(pht->caddr + PHN_IRQCTL); /* PCI posting */
	retval = request_irq(pdev->irq, phantom_isr,
			IRQF_SHARED, "phantom", pht);
	if (retval) {
		dev_err(&pdev->dev, "can't establish ISR\n");
		goto err_unmo;
	}

	retval = cdev_add(&pht->cdev, MKDEV(phantom_major, minor), 1);
	if (retval) {
		dev_err(&pdev->dev, "chardev registration failed\n");
		goto err_irq;
	}

	if (IS_ERR(device_create(phantom_class, &pdev->dev,
				 MKDEV(phantom_major, minor), NULL,
				 "phantom%u", minor)))
		dev_err(&pdev->dev, "can't create device\n");

	pci_set_drvdata(pdev, pht);

	return 0;
err_irq:
	free_irq(pdev->irq, pht);
err_unmo:
	pci_iounmap(pdev, pht->oaddr);
err_unmi:
	pci_iounmap(pdev, pht->iaddr);
err_unmc:
	pci_iounmap(pdev, pht->caddr);
err_fr:
	kfree(pht);
err_reg:
	pci_release_regions(pdev);
err_null:
	phantom_devices[minor] = 0;
err_dis:
	pci_disable_device(pdev);
err:
	return retval;
}

static void phantom_remove(struct pci_dev *pdev)
{
	struct phantom_device *pht = pci_get_drvdata(pdev);
	unsigned int minor = MINOR(pht->cdev.dev);

	device_destroy(phantom_class, MKDEV(phantom_major, minor));

	cdev_del(&pht->cdev);

	iowrite32(0, pht->caddr + PHN_IRQCTL);
	ioread32(pht->caddr + PHN_IRQCTL); /* PCI posting */
	free_irq(pdev->irq, pht);

	pci_iounmap(pdev, pht->oaddr);
	pci_iounmap(pdev, pht->iaddr);
	pci_iounmap(pdev, pht->caddr);

	kfree(pht);

	pci_release_regions(pdev);

	phantom_devices[minor] = 0;

	pci_disable_device(pdev);
}

static int __maybe_unused phantom_suspend(struct device *dev_d)
{
	struct phantom_device *dev = dev_get_drvdata(dev_d);

	iowrite32(0, dev->caddr + PHN_IRQCTL);
	ioread32(dev->caddr + PHN_IRQCTL); /* PCI posting */

	synchronize_irq(to_pci_dev(dev_d)->irq);

	return 0;
}

static int __maybe_unused phantom_resume(struct device *dev_d)
{
	struct phantom_device *dev = dev_get_drvdata(dev_d);

	iowrite32(0, dev->caddr + PHN_IRQCTL);

	return 0;
}

static struct pci_device_id phantom_pci_tbl[] = {
	{ .vendor = PCI_VENDOR_ID_PLX, .device = PCI_DEVICE_ID_PLX_9050,
	  .subvendor = PCI_VENDOR_ID_PLX, .subdevice = PCI_DEVICE_ID_PLX_9050,
	  .class = PCI_CLASS_BRIDGE_OTHER << 8, .class_mask = 0xffff00 },
	{ 0, }
};
MODULE_DEVICE_TABLE(pci, phantom_pci_tbl);

static SIMPLE_DEV_PM_OPS(phantom_pm_ops, phantom_suspend, phantom_resume);

static struct pci_driver phantom_pci_driver = {
	.name = "phantom",
	.id_table = phantom_pci_tbl,
	.probe = phantom_probe,
	.remove = phantom_remove,
	.driver.pm = &phantom_pm_ops,
};

static CLASS_ATTR_STRING(version, 0444, PHANTOM_VERSION);

static int __init phantom_init(void)
{
	int retval;
	dev_t dev;

	phantom_class = class_create(THIS_MODULE, "phantom");
	if (IS_ERR(phantom_class)) {
		retval = PTR_ERR(phantom_class);
		printk(KERN_ERR "phantom: can't register phantom class\n");
		goto err;
	}
	retval = class_create_file(phantom_class, &class_attr_version.attr);
	if (retval) {
		printk(KERN_ERR "phantom: can't create sysfs version file\n");
		goto err_class;
	}

	retval = alloc_chrdev_region(&dev, 0, PHANTOM_MAX_MINORS, "phantom");
	if (retval) {
		printk(KERN_ERR "phantom: can't register character device\n");
		goto err_attr;
	}
	phantom_major = MAJOR(dev);

	retval = pci_register_driver(&phantom_pci_driver);
	if (retval) {
		printk(KERN_ERR "phantom: can't register pci driver\n");
		goto err_unchr;
	}

	printk(KERN_INFO "Phantom Linux Driver, version " PHANTOM_VERSION ", "
			"init OK\n");

	return 0;
err_unchr:
	unregister_chrdev_region(dev, PHANTOM_MAX_MINORS);
err_attr:
	class_remove_file(phantom_class, &class_attr_version.attr);
err_class:
	class_destroy(phantom_class);
err:
	return retval;
}

static void __exit phantom_exit(void)
{
	pci_unregister_driver(&phantom_pci_driver);

	unregister_chrdev_region(MKDEV(phantom_major, 0), PHANTOM_MAX_MINORS);

	class_remove_file(phantom_class, &class_attr_version.attr);
	class_destroy(phantom_class);

	pr_debug("phantom: module successfully removed\n");
}

module_init(phantom_init);
module_exit(phantom_exit);

MODULE_AUTHOR("Jiri Slaby <jirislaby@gmail.com>");
MODULE_DESCRIPTION("Sensable Phantom driver (PCI devices)");
MODULE_LICENSE("GPL");
MODULE_VERSION(PHANTOM_VERSION);
Commit	Line	Data
2874c5fd	1	// SPDX-License-Identifier: GPL-2.0-or-later
cef2cf07 JS	2	/*
	3	* Copyright (C) 2005-2007 Jiri Slaby <jirislaby@gmail.com>
	4	*
0211a9c8	5	* You need a userspace library to cooperate with this driver. It (and other
cef2cf07 JS	6	* info) may be obtained here:
cef2cf07 JS	7	* http://www.fi.muni.cz/~xslaby/phantom.html
b2afe331	8	* or alternatively, you might use OpenHaptics provided by Sensable.
cef2cf07 JS	9	*/
cef2cf07 JS	10
7e4e8e68	11	#include <linux/compat.h>
cef2cf07 JS	12	#include <linux/kernel.h>
	13	#include <linux/module.h>
	14	#include <linux/device.h>
	15	#include <linux/pci.h>
	16	#include <linux/fs.h>
	17	#include <linux/poll.h>
	18	#include <linux/interrupt.h>
	19	#include <linux/cdev.h>
5a0e3ad6	20	#include <linux/slab.h>
cef2cf07	21	#include <linux/phantom.h>
d43c36dc	22	#include <linux/sched.h>
613655fa	23	#include <linux/mutex.h>
cef2cf07	24
60063497	25	#include <linux/atomic.h>
cef2cf07 JS	26	#include <asm/io.h>
cef2cf07 JS	27
82f56087	28	#define PHANTOM_VERSION "n0.9.8"
cef2cf07 JS	29
	30	#define PHANTOM_MAX_MINORS 8
	31
	32	#define PHN_IRQCTL 0x4c /* irq control in caddr space */
	33
	34	#define PHB_RUNNING 1
bc552f77	35	#define PHB_NOT_OH 2
cef2cf07	36
613655fa	37	static DEFINE_MUTEX(phantom_mutex);
cef2cf07 JS	38	static struct class *phantom_class;
	39	static int phantom_major;
	40
	41	struct phantom_device {
	42	unsigned int opened;
	43	void __iomem *caddr;
	44	u32 __iomem *iaddr;
	45	u32 __iomem *oaddr;
	46	unsigned long status;
	47	atomic_t counter;
	48
	49	wait_queue_head_t wait;
	50	struct cdev cdev;
	51
	52	struct mutex open_lock;
bc552f77 JS	53	spinlock_t regs_lock;
	54
	55	/* used in NOT_OH mode */
	56	struct phm_regs oregs;
	57	u32 ctl_reg;
cef2cf07 JS	58	};
	59
	60	static unsigned char phantom_devices[PHANTOM_MAX_MINORS];
	61
	62	static int phantom_status(struct phantom_device *dev, unsigned long newstat)
	63	{
	64	pr_debug("phantom_status %lx %lx\n", dev->status, newstat);
	65
	66	if (!(dev->status & PHB_RUNNING) && (newstat & PHB_RUNNING)) {
	67	atomic_set(&dev->counter, 0);
	68	iowrite32(PHN_CTL_IRQ, dev->iaddr + PHN_CONTROL);
	69	iowrite32(0x43, dev->caddr + PHN_IRQCTL);
c8511f94 JS	70	ioread32(dev->caddr + PHN_IRQCTL); /* PCI posting */
c8511f94 JS	71	} else if ((dev->status & PHB_RUNNING) && !(newstat & PHB_RUNNING)) {
cef2cf07	72	iowrite32(0, dev->caddr + PHN_IRQCTL);
c8511f94 JS	73	ioread32(dev->caddr + PHN_IRQCTL); /* PCI posting */
c8511f94 JS	74	}
cef2cf07 JS	75
	76	dev->status = newstat;
	77
	78	return 0;
	79	}
	80
	81	/*
	82	* File ops
	83	*/
	84
c15395c0 JS	85	static long phantom_ioctl(struct file *file, unsigned int cmd,
c15395c0 JS	86	unsigned long arg)
cef2cf07 JS	87	{
	88	struct phantom_device *dev = file->private_data;
	89	struct phm_regs rs;
	90	struct phm_reg r;
	91	void __user argp = (void __user )arg;
bc552f77	92	unsigned long flags;
cef2cf07 JS	93	unsigned int i;
cef2cf07 JS	94
cef2cf07	95	switch (cmd) {
7e4e8e68	96	case PHN_SETREG:
cef2cf07 JS	97	case PHN_SET_REG:
	98	if (copy_from_user(&r, argp, sizeof(r)))
	99	return -EFAULT;
	100
	101	if (r.reg > 7)
	102	return -EINVAL;
	103
bc552f77	104	spin_lock_irqsave(&dev->regs_lock, flags);
cef2cf07	105	if (r.reg == PHN_CONTROL && (r.value & PHN_CTL_IRQ) &&
c15395c0	106	phantom_status(dev, dev->status \| PHB_RUNNING)){
bc552f77	107	spin_unlock_irqrestore(&dev->regs_lock, flags);
cef2cf07	108	return -ENODEV;
c15395c0	109	}
cef2cf07 JS	110
cef2cf07 JS	111	pr_debug("phantom: writing %x to %u\n", r.value, r.reg);
bc552f77 JS	112
	113	/* preserve amp bit (don't allow to change it when in NOT_OH) */
	114	if (r.reg == PHN_CONTROL && (dev->status & PHB_NOT_OH)) {
	115	r.value &= ~PHN_CTL_AMP;
	116	r.value \|= dev->ctl_reg & PHN_CTL_AMP;
	117	dev->ctl_reg = r.value;
	118	}
	119
cef2cf07	120	iowrite32(r.value, dev->iaddr + r.reg);
c8511f94	121	ioread32(dev->iaddr); /* PCI posting */
cef2cf07 JS	122
	123	if (r.reg == PHN_CONTROL && !(r.value & PHN_CTL_IRQ))
	124	phantom_status(dev, dev->status & ~PHB_RUNNING);
bc552f77	125	spin_unlock_irqrestore(&dev->regs_lock, flags);
cef2cf07	126	break;
7e4e8e68	127	case PHN_SETREGS:
cef2cf07 JS	128	case PHN_SET_REGS:
	129	if (copy_from_user(&rs, argp, sizeof(rs)))
	130	return -EFAULT;
	131
	132	pr_debug("phantom: SRS %u regs %x\n", rs.count, rs.mask);
bc552f77 JS	133	spin_lock_irqsave(&dev->regs_lock, flags);
	134	if (dev->status & PHB_NOT_OH)
	135	memcpy(&dev->oregs, &rs, sizeof(rs));
	136	else {
	137	u32 m = min(rs.count, 8U);
	138	for (i = 0; i < m; i++)
	139	if (rs.mask & BIT(i))
	140	iowrite32(rs.values[i], dev->oaddr + i);
	141	ioread32(dev->iaddr); /* PCI posting */
	142	}
	143	spin_unlock_irqrestore(&dev->regs_lock, flags);
cef2cf07	144	break;
7e4e8e68	145	case PHN_GETREG:
cef2cf07 JS	146	case PHN_GET_REG:
	147	if (copy_from_user(&r, argp, sizeof(r)))
	148	return -EFAULT;
	149
	150	if (r.reg > 7)
	151	return -EINVAL;
	152
	153	r.value = ioread32(dev->iaddr + r.reg);
	154
	155	if (copy_to_user(argp, &r, sizeof(r)))
	156	return -EFAULT;
	157	break;
7e4e8e68	158	case PHN_GETREGS:
bc552f77 JS	159	case PHN_GET_REGS: {
	160	u32 m;
	161
cef2cf07 JS	162	if (copy_from_user(&rs, argp, sizeof(rs)))
	163	return -EFAULT;
	164
bc552f77 JS	165	m = min(rs.count, 8U);
bc552f77 JS	166
cef2cf07	167	pr_debug("phantom: GRS %u regs %x\n", rs.count, rs.mask);
bc552f77 JS	168	spin_lock_irqsave(&dev->regs_lock, flags);
	169	for (i = 0; i < m; i++)
	170	if (rs.mask & BIT(i))
cef2cf07	171	rs.values[i] = ioread32(dev->iaddr + i);
7d4f9f09	172	atomic_set(&dev->counter, 0);
bc552f77	173	spin_unlock_irqrestore(&dev->regs_lock, flags);
cef2cf07 JS	174
	175	if (copy_to_user(argp, &rs, sizeof(rs)))
	176	return -EFAULT;
	177	break;
bc552f77 JS	178	} case PHN_NOT_OH:
	179	spin_lock_irqsave(&dev->regs_lock, flags);
	180	if (dev->status & PHB_RUNNING) {
	181	printk(KERN_ERR "phantom: you need to set NOT_OH "
	182	"before you start the device!\n");
	183	spin_unlock_irqrestore(&dev->regs_lock, flags);
	184	return -EINVAL;
	185	}
	186	dev->status \|= PHB_NOT_OH;
	187	spin_unlock_irqrestore(&dev->regs_lock, flags);
	188	break;
cef2cf07 JS	189	default:
	190	return -ENOTTY;
	191	}
	192
	193	return 0;
	194	}
	195
7e4e8e68 JS	196	#ifdef CONFIG_COMPAT
	197	static long phantom_compat_ioctl(struct file *filp, unsigned int cmd,
	198	unsigned long arg)
	199	{
	200	if (_IOC_NR(cmd) <= 3 && _IOC_SIZE(cmd) == sizeof(compat_uptr_t)) {
	201	cmd &= ~(_IOC_SIZEMASK << _IOC_SIZESHIFT);
	202	cmd \|= sizeof(void *) << _IOC_SIZESHIFT;
	203	}
	204	return phantom_ioctl(filp, cmd, (unsigned long)compat_ptr(arg));
	205	}
	206	#else
	207	#define phantom_compat_ioctl NULL
	208	#endif
	209
cef2cf07 JS	210	static int phantom_open(struct inode inode, struct file file)
	211	{
	212	struct phantom_device *dev = container_of(inode->i_cdev,
	213	struct phantom_device, cdev);
	214
613655fa	215	mutex_lock(&phantom_mutex);
cef2cf07 JS	216	nonseekable_open(inode, file);
cef2cf07 JS	217
4541b5ec	218	if (mutex_lock_interruptible(&dev->open_lock)) {
613655fa	219	mutex_unlock(&phantom_mutex);
cef2cf07	220	return -ERESTARTSYS;
4541b5ec	221	}
cef2cf07 JS	222
	223	if (dev->opened) {
	224	mutex_unlock(&dev->open_lock);
613655fa	225	mutex_unlock(&phantom_mutex);
cef2cf07 JS	226	return -EINVAL;
	227	}
	228
bc552f77 JS	229	WARN_ON(dev->status & PHB_NOT_OH);
bc552f77 JS	230
cef2cf07 JS	231	file->private_data = dev;
cef2cf07 JS	232
bc552f77	233	atomic_set(&dev->counter, 0);
cef2cf07 JS	234	dev->opened++;
cef2cf07 JS	235	mutex_unlock(&dev->open_lock);
613655fa	236	mutex_unlock(&phantom_mutex);
cef2cf07 JS	237	return 0;
	238	}
	239
	240	static int phantom_release(struct inode inode, struct file file)
	241	{
	242	struct phantom_device *dev = file->private_data;
	243
	244	mutex_lock(&dev->open_lock);
	245
	246	dev->opened = 0;
	247	phantom_status(dev, dev->status & ~PHB_RUNNING);
bc552f77	248	dev->status &= ~PHB_NOT_OH;
cef2cf07 JS	249
	250	mutex_unlock(&dev->open_lock);
	251
	252	return 0;
	253	}
	254
afc9a42b	255	static __poll_t phantom_poll(struct file file, poll_table wait)
cef2cf07 JS	256	{
cef2cf07 JS	257	struct phantom_device *dev = file->private_data;
afc9a42b	258	__poll_t mask = 0;
cef2cf07 JS	259
	260	pr_debug("phantom_poll: %d\n", atomic_read(&dev->counter));
	261	poll_wait(file, &dev->wait, wait);
7d4f9f09 JS	262
7d4f9f09 JS	263	if (!(dev->status & PHB_RUNNING))
a9a08845	264	mask = EPOLLERR;
7d4f9f09	265	else if (atomic_read(&dev->counter))
a9a08845	266	mask = EPOLLIN \| EPOLLRDNORM;
7d4f9f09	267
cef2cf07 JS	268	pr_debug("phantom_poll end: %x/%d\n", mask, atomic_read(&dev->counter));
	269
	270	return mask;
	271	}
	272
828c0950	273	static const struct file_operations phantom_file_ops = {
cef2cf07 JS	274	.open = phantom_open,
cef2cf07 JS	275	.release = phantom_release,
c15395c0	276	.unlocked_ioctl = phantom_ioctl,
7e4e8e68	277	.compat_ioctl = phantom_compat_ioctl,
cef2cf07	278	.poll = phantom_poll,
6038f373	279	.llseek = no_llseek,
cef2cf07 JS	280	};
	281
	282	static irqreturn_t phantom_isr(int irq, void *data)
	283	{
	284	struct phantom_device *dev = data;
bc552f77 JS	285	unsigned int i;
bc552f77 JS	286	u32 ctl;
cef2cf07	287
bc552f77 JS	288	spin_lock(&dev->regs_lock);
	289	ctl = ioread32(dev->iaddr + PHN_CONTROL);
	290	if (!(ctl & PHN_CTL_IRQ)) {
	291	spin_unlock(&dev->regs_lock);
cef2cf07	292	return IRQ_NONE;
bc552f77	293	}
cef2cf07 JS	294
	295	iowrite32(0, dev->iaddr);
	296	iowrite32(0xc0, dev->iaddr);
bc552f77 JS	297
	298	if (dev->status & PHB_NOT_OH) {
	299	struct phm_regs *r = &dev->oregs;
	300	u32 m = min(r->count, 8U);
	301
	302	for (i = 0; i < m; i++)
	303	if (r->mask & BIT(i))
	304	iowrite32(r->values[i], dev->oaddr + i);
	305
	306	dev->ctl_reg ^= PHN_CTL_AMP;
	307	iowrite32(dev->ctl_reg, dev->iaddr + PHN_CONTROL);
	308	}
	309	spin_unlock(&dev->regs_lock);
	310
c8511f94	311	ioread32(dev->iaddr); /* PCI posting */
cef2cf07 JS	312
	313	atomic_inc(&dev->counter);
	314	wake_up_interruptible(&dev->wait);
	315
	316	return IRQ_HANDLED;
	317	}
	318
	319	/*
	320	* Init and deinit driver
	321	*/
	322
80c8ae28	323	static unsigned int phantom_get_free(void)
cef2cf07 JS	324	{
	325	unsigned int i;
	326
	327	for (i = 0; i < PHANTOM_MAX_MINORS; i++)
	328	if (phantom_devices[i] == 0)
	329	break;
	330
	331	return i;
	332	}
	333
80c8ae28	334	static int phantom_probe(struct pci_dev *pdev,
cef2cf07 JS	335	const struct pci_device_id *pci_id)
	336	{
	337	struct phantom_device *pht;
	338	unsigned int minor;
	339	int retval;
	340
	341	retval = pci_enable_device(pdev);
10ad5278 RR	342	if (retval) {
10ad5278 RR	343	dev_err(&pdev->dev, "pci_enable_device failed!\n");
cef2cf07	344	goto err;
10ad5278	345	}
cef2cf07 JS	346
	347	minor = phantom_get_free();
	348	if (minor == PHANTOM_MAX_MINORS) {
	349	dev_err(&pdev->dev, "too many devices found!\n");
	350	retval = -EIO;
	351	goto err_dis;
	352	}
	353
	354	phantom_devices[minor] = 1;
	355
	356	retval = pci_request_regions(pdev, "phantom");
10ad5278 RR	357	if (retval) {
10ad5278 RR	358	dev_err(&pdev->dev, "pci_request_regions failed!\n");
cef2cf07	359	goto err_null;
10ad5278	360	}
cef2cf07 JS	361
	362	retval = -ENOMEM;
	363	pht = kzalloc(sizeof(*pht), GFP_KERNEL);
	364	if (pht == NULL) {
	365	dev_err(&pdev->dev, "unable to allocate device\n");
	366	goto err_reg;
	367	}
	368
	369	pht->caddr = pci_iomap(pdev, 0, 0);
	370	if (pht->caddr == NULL) {
	371	dev_err(&pdev->dev, "can't remap conf space\n");
	372	goto err_fr;
	373	}
	374	pht->iaddr = pci_iomap(pdev, 2, 0);
	375	if (pht->iaddr == NULL) {
	376	dev_err(&pdev->dev, "can't remap input space\n");
	377	goto err_unmc;
	378	}
	379	pht->oaddr = pci_iomap(pdev, 3, 0);
	380	if (pht->oaddr == NULL) {
	381	dev_err(&pdev->dev, "can't remap output space\n");
	382	goto err_unmi;
	383	}
	384
	385	mutex_init(&pht->open_lock);
bc552f77	386	spin_lock_init(&pht->regs_lock);
cef2cf07 JS	387	init_waitqueue_head(&pht->wait);
	388	cdev_init(&pht->cdev, &phantom_file_ops);
	389	pht->cdev.owner = THIS_MODULE;
	390
	391	iowrite32(0, pht->caddr + PHN_IRQCTL);
c8511f94	392	ioread32(pht->caddr + PHN_IRQCTL); /* PCI posting */
cef2cf07	393	retval = request_irq(pdev->irq, phantom_isr,
bb9da88d	394	IRQF_SHARED, "phantom", pht);
cef2cf07 JS	395	if (retval) {
	396	dev_err(&pdev->dev, "can't establish ISR\n");
	397	goto err_unmo;
	398	}
	399
	400	retval = cdev_add(&pht->cdev, MKDEV(phantom_major, minor), 1);
	401	if (retval) {
	402	dev_err(&pdev->dev, "chardev registration failed\n");
	403	goto err_irq;
	404	}
	405
a9b12619 GKH	406	if (IS_ERR(device_create(phantom_class, &pdev->dev,
	407	MKDEV(phantom_major, minor), NULL,
	408	"phantom%u", minor)))
cef2cf07 JS	409	dev_err(&pdev->dev, "can't create device\n");
	410
	411	pci_set_drvdata(pdev, pht);
	412
	413	return 0;
	414	err_irq:
	415	free_irq(pdev->irq, pht);
	416	err_unmo:
	417	pci_iounmap(pdev, pht->oaddr);
	418	err_unmi:
	419	pci_iounmap(pdev, pht->iaddr);
	420	err_unmc:
	421	pci_iounmap(pdev, pht->caddr);
	422	err_fr:
	423	kfree(pht);
	424	err_reg:
	425	pci_release_regions(pdev);
	426	err_null:
	427	phantom_devices[minor] = 0;
	428	err_dis:
	429	pci_disable_device(pdev);
	430	err:
	431	return retval;
	432	}
	433
486a5c28	434	static void phantom_remove(struct pci_dev *pdev)
cef2cf07 JS	435	{
	436	struct phantom_device *pht = pci_get_drvdata(pdev);
	437	unsigned int minor = MINOR(pht->cdev.dev);
	438
	439	device_destroy(phantom_class, MKDEV(phantom_major, minor));
	440
	441	cdev_del(&pht->cdev);
	442
	443	iowrite32(0, pht->caddr + PHN_IRQCTL);
c8511f94	444	ioread32(pht->caddr + PHN_IRQCTL); /* PCI posting */
cef2cf07 JS	445	free_irq(pdev->irq, pht);
	446
	447	pci_iounmap(pdev, pht->oaddr);
	448	pci_iounmap(pdev, pht->iaddr);
	449	pci_iounmap(pdev, pht->caddr);
	450
	451	kfree(pht);
	452
	453	pci_release_regions(pdev);
	454
	455	phantom_devices[minor] = 0;
	456
	457	pci_disable_device(pdev);
	458	}
	459
6bbf5256	460	static int __maybe_unused phantom_suspend(struct device *dev_d)
cef2cf07	461	{
6bbf5256	462	struct phantom_device *dev = dev_get_drvdata(dev_d);
cef2cf07 JS	463
cef2cf07 JS	464	iowrite32(0, dev->caddr + PHN_IRQCTL);
c8511f94	465	ioread32(dev->caddr + PHN_IRQCTL); /* PCI posting */
cef2cf07	466
6bbf5256	467	synchronize_irq(to_pci_dev(dev_d)->irq);
aee8447c	468
cef2cf07 JS	469	return 0;
	470	}
	471
6bbf5256	472	static int __maybe_unused phantom_resume(struct device *dev_d)
cef2cf07	473	{
6bbf5256	474	struct phantom_device *dev = dev_get_drvdata(dev_d);
cef2cf07 JS	475
	476	iowrite32(0, dev->caddr + PHN_IRQCTL);
	477
	478	return 0;
	479	}
cef2cf07	480
2c685064	481	static struct pci_device_id phantom_pci_tbl[] = {
82f56087 JS	482	{ .vendor = PCI_VENDOR_ID_PLX, .device = PCI_DEVICE_ID_PLX_9050,
	483	.subvendor = PCI_VENDOR_ID_PLX, .subdevice = PCI_DEVICE_ID_PLX_9050,
	484	.class = PCI_CLASS_BRIDGE_OTHER << 8, .class_mask = 0xffff00 },
cef2cf07 JS	485	{ 0, }
	486	};
	487	MODULE_DEVICE_TABLE(pci, phantom_pci_tbl);
	488
6bbf5256 VG	489	static SIMPLE_DEV_PM_OPS(phantom_pm_ops, phantom_suspend, phantom_resume);
6bbf5256 VG	490
cef2cf07 JS	491	static struct pci_driver phantom_pci_driver = {
	492	.name = "phantom",
	493	.id_table = phantom_pci_tbl,
	494	.probe = phantom_probe,
2d6bed9c	495	.remove = phantom_remove,
6bbf5256	496	.driver.pm = &phantom_pm_ops,
cef2cf07 JS	497	};
cef2cf07 JS	498
0933e2d9	499	static CLASS_ATTR_STRING(version, 0444, PHANTOM_VERSION);
cef2cf07 JS	500
	501	static int __init phantom_init(void)
	502	{
	503	int retval;
	504	dev_t dev;
	505
	506	phantom_class = class_create(THIS_MODULE, "phantom");
	507	if (IS_ERR(phantom_class)) {
	508	retval = PTR_ERR(phantom_class);
	509	printk(KERN_ERR "phantom: can't register phantom class\n");
	510	goto err;
	511	}
0933e2d9	512	retval = class_create_file(phantom_class, &class_attr_version.attr);
cef2cf07 JS	513	if (retval) {
	514	printk(KERN_ERR "phantom: can't create sysfs version file\n");
	515	goto err_class;
	516	}
	517
	518	retval = alloc_chrdev_region(&dev, 0, PHANTOM_MAX_MINORS, "phantom");
	519	if (retval) {
	520	printk(KERN_ERR "phantom: can't register character device\n");
	521	goto err_attr;
	522	}
	523	phantom_major = MAJOR(dev);
	524
	525	retval = pci_register_driver(&phantom_pci_driver);
	526	if (retval) {
	527	printk(KERN_ERR "phantom: can't register pci driver\n");
	528	goto err_unchr;
	529	}
	530
	531	printk(KERN_INFO "Phantom Linux Driver, version " PHANTOM_VERSION ", "
	532	"init OK\n");
	533
	534	return 0;
	535	err_unchr:
	536	unregister_chrdev_region(dev, PHANTOM_MAX_MINORS);
	537	err_attr:
0933e2d9	538	class_remove_file(phantom_class, &class_attr_version.attr);
cef2cf07 JS	539	err_class:
	540	class_destroy(phantom_class);
	541	err:
	542	return retval;
	543	}
	544
	545	static void __exit phantom_exit(void)
	546	{
	547	pci_unregister_driver(&phantom_pci_driver);
	548
	549	unregister_chrdev_region(MKDEV(phantom_major, 0), PHANTOM_MAX_MINORS);
	550
0933e2d9	551	class_remove_file(phantom_class, &class_attr_version.attr);
cef2cf07 JS	552	class_destroy(phantom_class);
	553
	554	pr_debug("phantom: module successfully removed\n");
	555	}
	556
	557	module_init(phantom_init);
	558	module_exit(phantom_exit);
	559
	560	MODULE_AUTHOR("Jiri Slaby <jirislaby@gmail.com>");
ec905a18	561	MODULE_DESCRIPTION("Sensable Phantom driver (PCI devices)");
cef2cf07 JS	562	MODULE_LICENSE("GPL");
cef2cf07 JS	563	MODULE_VERSION(PHANTOM_VERSION);