[linux-2.6-block.git] / drivers / comedi / drivers / mf6x4.c

// SPDX-License-Identifier: GPL-2.0+
/*
 *  comedi/drivers/mf6x4.c
 *  Driver for Humusoft MF634 and MF624 Data acquisition cards
 *
 *  COMEDI - Linux Control and Measurement Device Interface
 *  Copyright (C) 2000 David A. Schleef <ds@schleef.org>
 */
/*
 * Driver: mf6x4
 * Description: Humusoft MF634 and MF624 Data acquisition card driver
 * Devices: [Humusoft] MF634 (mf634), MF624 (mf624)
 * Author: Rostislav Lisovy <lisovy@gmail.com>
 * Status: works
 * Updated:
 * Configuration Options: none
 */

#include <linux/module.h>
#include <linux/delay.h>
#include <linux/comedi/comedi_pci.h>

/* Registers present in BAR0 memory region */
#define MF624_GPIOC_REG		0x54

#define MF6X4_GPIOC_EOLC	BIT(17)	/* End Of Last Conversion */
#define MF6X4_GPIOC_LDAC	BIT(23)	/* Load DACs */
#define MF6X4_GPIOC_DACEN	BIT(26)

/* BAR1 registers */
#define MF6X4_ADDATA_REG	0x00
#define MF6X4_ADCTRL_REG	0x00
#define MF6X4_ADCTRL_CHAN(x)	BIT(chan)
#define MF6X4_DIN_REG		0x10
#define MF6X4_DIN_MASK		0xff
#define MF6X4_DOUT_REG		0x10
#define MF6X4_ADSTART_REG	0x20
#define MF6X4_DAC_REG(x)	(0x20 + ((x) * 2))

/* BAR2 registers */
#define MF634_GPIOC_REG		0x68

enum mf6x4_boardid {
	BOARD_MF634,
	BOARD_MF624,
};

struct mf6x4_board {
	const char *name;
	/* We need to keep track of the order of BARs used by the cards */
	unsigned int bar_nums[3];
};

static const struct mf6x4_board mf6x4_boards[] = {
	[BOARD_MF634] = {
		.name           = "mf634",
		.bar_nums	= {0, 2, 3},
	},
	[BOARD_MF624] = {
		.name           = "mf624",
		.bar_nums	= {0, 2, 4},
	},
};

struct mf6x4_private {
	/*
	 * Documentation for both MF634 and MF624 describes registers
	 * present in BAR0, 1 and 2 regions.
	 * The real (i.e. in HW) BAR numbers are different for MF624
	 * and MF634 yet we will call them 0, 1, 2
	 */
	void __iomem *bar0_mem;
	void __iomem *bar2_mem;

	/*
	 * This configuration register has the same function and fields
	 * for both cards however it lies in different BARs on different
	 * offsets -- this variable makes the access easier
	 */
	void __iomem *gpioc_reg;
};

static int mf6x4_di_insn_bits(struct comedi_device *dev,
			      struct comedi_subdevice *s,
			      struct comedi_insn *insn,
			      unsigned int *data)
{
	data[1] = ioread16(dev->mmio + MF6X4_DIN_REG) & MF6X4_DIN_MASK;

	return insn->n;
}

static int mf6x4_do_insn_bits(struct comedi_device *dev,
			      struct comedi_subdevice *s,
			      struct comedi_insn *insn,
			      unsigned int *data)
{
	if (comedi_dio_update_state(s, data))
		iowrite16(s->state, dev->mmio + MF6X4_DOUT_REG);

	data[1] = s->state;

	return insn->n;
}

static int mf6x4_ai_eoc(struct comedi_device *dev,
			struct comedi_subdevice *s,
			struct comedi_insn *insn,
			unsigned long context)
{
	struct mf6x4_private *devpriv = dev->private;
	unsigned int status;

	/* EOLC goes low at end of conversion. */
	status = ioread32(devpriv->gpioc_reg);
	if ((status & MF6X4_GPIOC_EOLC) == 0)
		return 0;
	return -EBUSY;
}

static int mf6x4_ai_insn_read(struct comedi_device *dev,
			      struct comedi_subdevice *s,
			      struct comedi_insn *insn,
			      unsigned int *data)
{
	unsigned int chan = CR_CHAN(insn->chanspec);
	unsigned int d;
	int ret;
	int i;

	/* Set the ADC channel number in the scan list */
	iowrite16(MF6X4_ADCTRL_CHAN(chan), dev->mmio + MF6X4_ADCTRL_REG);

	for (i = 0; i < insn->n; i++) {
		/* Trigger ADC conversion by reading ADSTART */
		ioread16(dev->mmio + MF6X4_ADSTART_REG);

		ret = comedi_timeout(dev, s, insn, mf6x4_ai_eoc, 0);
		if (ret)
			return ret;

		/* Read the actual value */
		d = ioread16(dev->mmio + MF6X4_ADDATA_REG);
		d &= s->maxdata;
		/* munge the 2's complement data to offset binary */
		data[i] = comedi_offset_munge(s, d);
	}

	iowrite16(0x0, dev->mmio + MF6X4_ADCTRL_REG);

	return insn->n;
}

static int mf6x4_ao_insn_write(struct comedi_device *dev,
			       struct comedi_subdevice *s,
			       struct comedi_insn *insn,
			       unsigned int *data)
{
	struct mf6x4_private *devpriv = dev->private;
	unsigned int chan = CR_CHAN(insn->chanspec);
	unsigned int val = s->readback[chan];
	unsigned int gpioc;
	int i;

	/* Enable instantaneous update of converters outputs + Enable DACs */
	gpioc = ioread32(devpriv->gpioc_reg);
	iowrite32((gpioc & ~MF6X4_GPIOC_LDAC) | MF6X4_GPIOC_DACEN,
		  devpriv->gpioc_reg);

	for (i = 0; i < insn->n; i++) {
		val = data[i];
		iowrite16(val, dev->mmio + MF6X4_DAC_REG(chan));
	}
	s->readback[chan] = val;

	return insn->n;
}

static int mf6x4_auto_attach(struct comedi_device *dev, unsigned long context)
{
	struct pci_dev *pcidev = comedi_to_pci_dev(dev);
	const struct mf6x4_board *board = NULL;
	struct mf6x4_private *devpriv;
	struct comedi_subdevice *s;
	int ret;

	if (context < ARRAY_SIZE(mf6x4_boards))
		board = &mf6x4_boards[context];
	else
		return -ENODEV;

	dev->board_ptr = board;
	dev->board_name = board->name;

	ret = comedi_pci_enable(dev);
	if (ret)
		return ret;

	devpriv = comedi_alloc_devpriv(dev, sizeof(*devpriv));
	if (!devpriv)
		return -ENOMEM;

	devpriv->bar0_mem = pci_ioremap_bar(pcidev, board->bar_nums[0]);
	if (!devpriv->bar0_mem)
		return -ENODEV;

	dev->mmio = pci_ioremap_bar(pcidev, board->bar_nums[1]);
	if (!dev->mmio)
		return -ENODEV;

	devpriv->bar2_mem = pci_ioremap_bar(pcidev, board->bar_nums[2]);
	if (!devpriv->bar2_mem)
		return -ENODEV;

	if (board == &mf6x4_boards[BOARD_MF634])
		devpriv->gpioc_reg = devpriv->bar2_mem + MF634_GPIOC_REG;
	else
		devpriv->gpioc_reg = devpriv->bar0_mem + MF624_GPIOC_REG;

	ret = comedi_alloc_subdevices(dev, 4);
	if (ret)
		return ret;

	/* Analog Input subdevice */
	s = &dev->subdevices[0];
	s->type		= COMEDI_SUBD_AI;
	s->subdev_flags	= SDF_READABLE | SDF_GROUND;
	s->n_chan	= 8;
	s->maxdata	= 0x3fff;
	s->range_table	= &range_bipolar10;
	s->insn_read	= mf6x4_ai_insn_read;

	/* Analog Output subdevice */
	s = &dev->subdevices[1];
	s->type		= COMEDI_SUBD_AO;
	s->subdev_flags	= SDF_WRITABLE;
	s->n_chan	= 8;
	s->maxdata	= 0x3fff;
	s->range_table	= &range_bipolar10;
	s->insn_write	= mf6x4_ao_insn_write;

	ret = comedi_alloc_subdev_readback(s);
	if (ret)
		return ret;

	/* Digital Input subdevice */
	s = &dev->subdevices[2];
	s->type		= COMEDI_SUBD_DI;
	s->subdev_flags	= SDF_READABLE;
	s->n_chan	= 8;
	s->maxdata	= 1;
	s->range_table	= &range_digital;
	s->insn_bits	= mf6x4_di_insn_bits;

	/* Digital Output subdevice */
	s = &dev->subdevices[3];
	s->type		= COMEDI_SUBD_DO;
	s->subdev_flags	= SDF_WRITABLE;
	s->n_chan	= 8;
	s->maxdata	= 1;
	s->range_table	= &range_digital;
	s->insn_bits	= mf6x4_do_insn_bits;

	return 0;
}

static void mf6x4_detach(struct comedi_device *dev)
{
	struct mf6x4_private *devpriv = dev->private;

	if (devpriv) {
		if (devpriv->bar0_mem)
			iounmap(devpriv->bar0_mem);
		if (devpriv->bar2_mem)
			iounmap(devpriv->bar2_mem);
	}
	comedi_pci_detach(dev);
}

static struct comedi_driver mf6x4_driver = {
	.driver_name    = "mf6x4",
	.module         = THIS_MODULE,
	.auto_attach    = mf6x4_auto_attach,
	.detach         = mf6x4_detach,
};

static int mf6x4_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
{
	return comedi_pci_auto_config(dev, &mf6x4_driver, id->driver_data);
}

static const struct pci_device_id mf6x4_pci_table[] = {
	{ PCI_VDEVICE(HUMUSOFT, 0x0634), BOARD_MF634 },
	{ PCI_VDEVICE(HUMUSOFT, 0x0624), BOARD_MF624 },
	{ 0 }
};
MODULE_DEVICE_TABLE(pci, mf6x4_pci_table);

static struct pci_driver mf6x4_pci_driver = {
	.name           = "mf6x4",
	.id_table       = mf6x4_pci_table,
	.probe          = mf6x4_pci_probe,
	.remove         = comedi_pci_auto_unconfig,
};

module_comedi_pci_driver(mf6x4_driver, mf6x4_pci_driver);

MODULE_AUTHOR("Rostislav Lisovy <lisovy@gmail.com>");
MODULE_DESCRIPTION("Comedi MF634 and MF624 DAQ cards driver");
MODULE_LICENSE("GPL");
Commit	Line	Data
e184e2be	1	// SPDX-License-Identifier: GPL-2.0+
04b56502 RL	2	/*
	3	* comedi/drivers/mf6x4.c
	4	* Driver for Humusoft MF634 and MF624 Data acquisition cards
	5	*
	6	* COMEDI - Linux Control and Measurement Device Interface
	7	* Copyright (C) 2000 David A. Schleef <ds@schleef.org>
04b56502 RL	8	*/
	9	/*
	10	* Driver: mf6x4
	11	* Description: Humusoft MF634 and MF624 Data acquisition card driver
63f9384f	12	* Devices: [Humusoft] MF634 (mf634), MF624 (mf624)
04b56502 RL	13	* Author: Rostislav Lisovy <lisovy@gmail.com>
	14	* Status: works
	15	* Updated:
	16	* Configuration Options: none
	17	*/
	18
	19	#include <linux/module.h>
04b56502	20	#include <linux/delay.h>
df0e68c1	21	#include <linux/comedi/comedi_pci.h>
04b56502 RL	22
04b56502 RL	23	/* Registers present in BAR0 memory region */
1df2abb3	24	#define MF624_GPIOC_REG 0x54
04b56502	25
0b7cbf14 HS	26	#define MF6X4_GPIOC_EOLC BIT(17) /* End Of Last Conversion */
	27	#define MF6X4_GPIOC_LDAC BIT(23) /* Load DACs */
	28	#define MF6X4_GPIOC_DACEN BIT(26)
04b56502 RL	29
04b56502 RL	30	/* BAR1 registers */
59706334	31	#define MF6X4_ADDATA_REG 0x00
c9ab3023 HS	32	#define MF6X4_ADCTRL_REG 0x00
c9ab3023 HS	33	#define MF6X4_ADCTRL_CHAN(x) BIT(chan)
b02530f5 HS	34	#define MF6X4_DIN_REG 0x10
b02530f5 HS	35	#define MF6X4_DIN_MASK 0xff
418c9713	36	#define MF6X4_DOUT_REG 0x10
19e02434 HS	37	#define MF6X4_ADSTART_REG 0x20
19e02434 HS	38	#define MF6X4_DAC_REG(x) (0x20 + ((x) * 2))
04b56502 RL	39
04b56502 RL	40	/* BAR2 registers */
1df2abb3	41	#define MF634_GPIOC_REG 0x68
04b56502 RL	42
	43	enum mf6x4_boardid {
	44	BOARD_MF634,
	45	BOARD_MF624,
	46	};
	47
	48	struct mf6x4_board {
	49	const char *name;
ae573713 HS	50	/* We need to keep track of the order of BARs used by the cards */
ae573713 HS	51	unsigned int bar_nums[3];
04b56502 RL	52	};
	53
	54	static const struct mf6x4_board mf6x4_boards[] = {
	55	[BOARD_MF634] = {
	56	.name = "mf634",
	57	.bar_nums = {0, 2, 3},
	58	},
	59	[BOARD_MF624] = {
	60	.name = "mf624",
	61	.bar_nums = {0, 2, 4},
	62	},
	63	};
	64
	65	struct mf6x4_private {
	66	/*
	67	* Documentation for both MF634 and MF624 describes registers
	68	* present in BAR0, 1 and 2 regions.
	69	* The real (i.e. in HW) BAR numbers are different for MF624
	70	* and MF634 yet we will call them 0, 1, 2
	71	*/
	72	void __iomem *bar0_mem;
04b56502 RL	73	void __iomem *bar2_mem;
	74
	75	/*
	76	* This configuration register has the same function and fields
	77	* for both cards however it lies in different BARs on different
	78	* offsets -- this variable makes the access easier
	79	*/
1df2abb3	80	void __iomem *gpioc_reg;
04b56502 RL	81	};
	82
	83	static int mf6x4_di_insn_bits(struct comedi_device *dev,
56570044 HS	84	struct comedi_subdevice *s,
	85	struct comedi_insn *insn,
	86	unsigned int *data)
04b56502	87	{
b02530f5	88	data[1] = ioread16(dev->mmio + MF6X4_DIN_REG) & MF6X4_DIN_MASK;
04b56502 RL	89
	90	return insn->n;
	91	}
	92
	93	static int mf6x4_do_insn_bits(struct comedi_device *dev,
56570044 HS	94	struct comedi_subdevice *s,
	95	struct comedi_insn *insn,
	96	unsigned int *data)
04b56502	97	{
04b56502	98	if (comedi_dio_update_state(s, data))
418c9713	99	iowrite16(s->state, dev->mmio + MF6X4_DOUT_REG);
04b56502 RL	100
	101	data[1] = s->state;
	102
	103	return insn->n;
	104	}
	105
acb069c0 HS	106	static int mf6x4_ai_eoc(struct comedi_device *dev,
	107	struct comedi_subdevice *s,
	108	struct comedi_insn *insn,
	109	unsigned long context)
04b56502 RL	110	{
04b56502 RL	111	struct mf6x4_private *devpriv = dev->private;
acb069c0	112	unsigned int status;
04b56502	113
56c90457	114	/* EOLC goes low at end of conversion. */
1df2abb3	115	status = ioread32(devpriv->gpioc_reg);
56c90457	116	if ((status & MF6X4_GPIOC_EOLC) == 0)
acb069c0 HS	117	return 0;
acb069c0 HS	118	return -EBUSY;
04b56502 RL	119	}
	120
	121	static int mf6x4_ai_insn_read(struct comedi_device *dev,
	122	struct comedi_subdevice *s,
56570044 HS	123	struct comedi_insn *insn,
56570044 HS	124	unsigned int *data)
04b56502	125	{
c9ab3023	126	unsigned int chan = CR_CHAN(insn->chanspec);
59706334	127	unsigned int d;
04b56502 RL	128	int ret;
04b56502 RL	129	int i;
04b56502 RL	130
04b56502 RL	131	/* Set the ADC channel number in the scan list */
c9ab3023	132	iowrite16(MF6X4_ADCTRL_CHAN(chan), dev->mmio + MF6X4_ADCTRL_REG);
04b56502 RL	133
	134	for (i = 0; i < insn->n; i++) {
	135	/* Trigger ADC conversion by reading ADSTART */
19e02434	136	ioread16(dev->mmio + MF6X4_ADSTART_REG);
04b56502	137
acb069c0	138	ret = comedi_timeout(dev, s, insn, mf6x4_ai_eoc, 0);
04b56502 RL	139	if (ret)
	140	return ret;
	141
	142	/* Read the actual value */
59706334	143	d = ioread16(dev->mmio + MF6X4_ADDATA_REG);
04b56502	144	d &= s->maxdata;
59706334 HS	145	/* munge the 2's complement data to offset binary */
59706334 HS	146	data[i] = comedi_offset_munge(s, d);
04b56502 RL	147	}
04b56502 RL	148
c9ab3023	149	iowrite16(0x0, dev->mmio + MF6X4_ADCTRL_REG);
04b56502 RL	150
	151	return insn->n;
	152	}
	153
	154	static int mf6x4_ao_insn_write(struct comedi_device *dev,
	155	struct comedi_subdevice *s,
56570044 HS	156	struct comedi_insn *insn,
56570044 HS	157	unsigned int *data)
04b56502 RL	158	{
	159	struct mf6x4_private *devpriv = dev->private;
	160	unsigned int chan = CR_CHAN(insn->chanspec);
0c8fb386	161	unsigned int val = s->readback[chan];
21cf4eed	162	unsigned int gpioc;
04b56502 RL	163	int i;
	164
	165	/* Enable instantaneous update of converters outputs + Enable DACs */
1df2abb3	166	gpioc = ioread32(devpriv->gpioc_reg);
04b56502	167	iowrite32((gpioc & ~MF6X4_GPIOC_LDAC) \| MF6X4_GPIOC_DACEN,
1df2abb3	168	devpriv->gpioc_reg);
04b56502 RL	169
04b56502 RL	170	for (i = 0; i < insn->n; i++) {
496e7cd9	171	val = data[i];
19e02434	172	iowrite16(val, dev->mmio + MF6X4_DAC_REG(chan));
04b56502	173	}
0c8fb386	174	s->readback[chan] = val;
04b56502 RL	175
	176	return insn->n;
	177	}
	178
	179	static int mf6x4_auto_attach(struct comedi_device *dev, unsigned long context)
	180	{
	181	struct pci_dev *pcidev = comedi_to_pci_dev(dev);
	182	const struct mf6x4_board *board = NULL;
	183	struct mf6x4_private *devpriv;
	184	struct comedi_subdevice *s;
	185	int ret;
	186
	187	if (context < ARRAY_SIZE(mf6x4_boards))
	188	board = &mf6x4_boards[context];
	189	else
	190	return -ENODEV;
	191
	192	dev->board_ptr = board;
	193	dev->board_name = board->name;
	194
	195	ret = comedi_pci_enable(dev);
	196	if (ret)
	197	return ret;
	198
	199	devpriv = comedi_alloc_devpriv(dev, sizeof(*devpriv));
	200	if (!devpriv)
	201	return -ENOMEM;
	202
	203	devpriv->bar0_mem = pci_ioremap_bar(pcidev, board->bar_nums[0]);
	204	if (!devpriv->bar0_mem)
	205	return -ENODEV;
	206
56570044 HS	207	dev->mmio = pci_ioremap_bar(pcidev, board->bar_nums[1]);
56570044 HS	208	if (!dev->mmio)
04b56502 RL	209	return -ENODEV;
	210
	211	devpriv->bar2_mem = pci_ioremap_bar(pcidev, board->bar_nums[2]);
	212	if (!devpriv->bar2_mem)
	213	return -ENODEV;
	214
	215	if (board == &mf6x4_boards[BOARD_MF634])
1df2abb3	216	devpriv->gpioc_reg = devpriv->bar2_mem + MF634_GPIOC_REG;
04b56502	217	else
1df2abb3	218	devpriv->gpioc_reg = devpriv->bar0_mem + MF624_GPIOC_REG;
04b56502	219
04b56502 RL	220	ret = comedi_alloc_subdevices(dev, 4);
	221	if (ret)
	222	return ret;
	223
fa7ac9c0	224	/* Analog Input subdevice */
04b56502	225	s = &dev->subdevices[0];
fa7ac9c0 HS	226	s->type = COMEDI_SUBD_AI;
	227	s->subdev_flags = SDF_READABLE \| SDF_GROUND;
	228	s->n_chan = 8;
	229	s->maxdata = 0x3fff;
	230	s->range_table = &range_bipolar10;
	231	s->insn_read = mf6x4_ai_insn_read;
	232
	233	/* Analog Output subdevice */
04b56502	234	s = &dev->subdevices[1];
fa7ac9c0 HS	235	s->type = COMEDI_SUBD_AO;
	236	s->subdev_flags = SDF_WRITABLE;
	237	s->n_chan = 8;
	238	s->maxdata = 0x3fff;
	239	s->range_table = &range_bipolar10;
	240	s->insn_write = mf6x4_ao_insn_write;
0c8fb386 HS	241
	242	ret = comedi_alloc_subdev_readback(s);
	243	if (ret)
	244	return ret;
04b56502	245
fa7ac9c0	246	/* Digital Input subdevice */
04b56502	247	s = &dev->subdevices[2];
fa7ac9c0 HS	248	s->type = COMEDI_SUBD_DI;
	249	s->subdev_flags = SDF_READABLE;
	250	s->n_chan = 8;
	251	s->maxdata = 1;
	252	s->range_table = &range_digital;
	253	s->insn_bits = mf6x4_di_insn_bits;
	254
	255	/* Digital Output subdevice */
04b56502	256	s = &dev->subdevices[3];
fa7ac9c0 HS	257	s->type = COMEDI_SUBD_DO;
	258	s->subdev_flags = SDF_WRITABLE;
	259	s->n_chan = 8;
	260	s->maxdata = 1;
	261	s->range_table = &range_digital;
	262	s->insn_bits = mf6x4_do_insn_bits;
04b56502 RL	263
	264	return 0;
	265	}
	266
	267	static void mf6x4_detach(struct comedi_device *dev)
	268	{
	269	struct mf6x4_private *devpriv = dev->private;
	270
aac307f9 HS	271	if (devpriv) {
	272	if (devpriv->bar0_mem)
	273	iounmap(devpriv->bar0_mem);
	274	if (devpriv->bar2_mem)
	275	iounmap(devpriv->bar2_mem);
	276	}
	277	comedi_pci_detach(dev);
04b56502 RL	278	}
	279
	280	static struct comedi_driver mf6x4_driver = {
	281	.driver_name = "mf6x4",
	282	.module = THIS_MODULE,
	283	.auto_attach = mf6x4_auto_attach,
	284	.detach = mf6x4_detach,
	285	};
	286
	287	static int mf6x4_pci_probe(struct pci_dev dev, const struct pci_device_id id)
	288	{
	289	return comedi_pci_auto_config(dev, &mf6x4_driver, id->driver_data);
	290	}
	291
	292	static const struct pci_device_id mf6x4_pci_table[] = {
	293	{ PCI_VDEVICE(HUMUSOFT, 0x0634), BOARD_MF634 },
	294	{ PCI_VDEVICE(HUMUSOFT, 0x0624), BOARD_MF624 },
	295	{ 0 }
	296	};
	297	MODULE_DEVICE_TABLE(pci, mf6x4_pci_table);
	298
	299	static struct pci_driver mf6x4_pci_driver = {
	300	.name = "mf6x4",
	301	.id_table = mf6x4_pci_table,
	302	.probe = mf6x4_pci_probe,
	303	.remove = comedi_pci_auto_unconfig,
	304	};
	305
	306	module_comedi_pci_driver(mf6x4_driver, mf6x4_pci_driver);
	307
	308	MODULE_AUTHOR("Rostislav Lisovy <lisovy@gmail.com>");
	309	MODULE_DESCRIPTION("Comedi MF634 and MF624 DAQ cards driver");
	310	MODULE_LICENSE("GPL");