gpio-104-idi-48.c 9.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
/*
 * GPIO driver for the ACCES 104-IDI-48 family
 * Copyright (C) 2015 William Breathitt Gray
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2, as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
13 14 15
 *
 * This driver supports the following ACCES devices: 104-IDI-48A,
 * 104-IDI-48AC, 104-IDI-48B, and 104-IDI-48BC.
16
 */
17
#include <linux/bitmap.h>
18 19 20 21 22 23 24 25
#include <linux/bitops.h>
#include <linux/device.h>
#include <linux/errno.h>
#include <linux/gpio/driver.h>
#include <linux/io.h>
#include <linux/ioport.h>
#include <linux/interrupt.h>
#include <linux/irqdesc.h>
26
#include <linux/isa.h>
27 28 29 30 31
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/spinlock.h>

32 33 34 35 36
#define IDI_48_EXTENT 8
#define MAX_NUM_IDI_48 max_num_isa_dev(IDI_48_EXTENT)

static unsigned int base[MAX_NUM_IDI_48];
static unsigned int num_idi_48;
37
module_param_hw_array(base, uint, ioport, &num_idi_48, 0);
38 39 40
MODULE_PARM_DESC(base, "ACCES 104-IDI-48 base addresses");

static unsigned int irq[MAX_NUM_IDI_48];
41
module_param_hw_array(irq, uint, irq, NULL, 0);
42
MODULE_PARM_DESC(irq, "ACCES 104-IDI-48 interrupt line numbers");
43 44 45 46 47

/**
 * struct idi_48_gpio - GPIO device private data structure
 * @chip:	instance of the gpio_chip
 * @lock:	synchronization lock to prevent I/O race conditions
48
 * @ack_lock:	synchronization lock to prevent IRQ handler race conditions
49 50 51 52 53 54
 * @irq_mask:	input bits affected by interrupts
 * @base:	base port address of the GPIO device
 * @cos_enb:	Change-Of-State IRQ enable boundaries mask
 */
struct idi_48_gpio {
	struct gpio_chip chip;
55
	raw_spinlock_t lock;
56
	spinlock_t ack_lock;
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
	unsigned char irq_mask[6];
	unsigned base;
	unsigned char cos_enb;
};

static int idi_48_gpio_get_direction(struct gpio_chip *chip, unsigned offset)
{
	return 1;
}

static int idi_48_gpio_direction_input(struct gpio_chip *chip, unsigned offset)
{
	return 0;
}

static int idi_48_gpio_get(struct gpio_chip *chip, unsigned offset)
{
74
	struct idi_48_gpio *const idi48gpio = gpiochip_get_data(chip);
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
	unsigned i;
	const unsigned register_offset[6] = { 0, 1, 2, 4, 5, 6 };
	unsigned base_offset;
	unsigned mask;

	for (i = 0; i < 48; i += 8)
		if (offset < i + 8) {
			base_offset = register_offset[i / 8];
			mask = BIT(offset - i);

			return !!(inb(idi48gpio->base + base_offset) & mask);
		}

	/* The following line should never execute since offset < 48 */
	return 0;
}

92 93 94 95 96
static int idi_48_gpio_get_multiple(struct gpio_chip *chip, unsigned long *mask,
	unsigned long *bits)
{
	struct idi_48_gpio *const idi48gpio = gpiochip_get_data(chip);
	size_t i;
97
	static const size_t ports[] = { 0, 1, 2, 4, 5, 6 };
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
	const unsigned int gpio_reg_size = 8;
	unsigned int bits_offset;
	size_t word_index;
	unsigned int word_offset;
	unsigned long word_mask;
	const unsigned long port_mask = GENMASK(gpio_reg_size - 1, 0);
	unsigned long port_state;

	/* clear bits array to a clean slate */
	bitmap_zero(bits, chip->ngpio);

	/* get bits are evaluated a gpio port register at a time */
	for (i = 0; i < ARRAY_SIZE(ports); i++) {
		/* gpio offset in bits array */
		bits_offset = i * gpio_reg_size;

		/* word index for bits array */
		word_index = BIT_WORD(bits_offset);

		/* gpio offset within current word of bits array */
		word_offset = bits_offset % BITS_PER_LONG;

		/* mask of get bits for current gpio within current word */
		word_mask = mask[word_index] & (port_mask << word_offset);
		if (!word_mask) {
			/* no get bits in this port so skip to next one */
			continue;
		}

		/* read bits from current gpio port */
		port_state = inb(idi48gpio->base + ports[i]);

		/* store acquired bits at respective bits array offset */
		bits[word_index] |= port_state << word_offset;
	}

	return 0;
}

137 138 139 140 141 142 143
static void idi_48_irq_ack(struct irq_data *data)
{
}

static void idi_48_irq_mask(struct irq_data *data)
{
	struct gpio_chip *chip = irq_data_get_irq_chip_data(data);
144
	struct idi_48_gpio *const idi48gpio = gpiochip_get_data(chip);
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
	const unsigned offset = irqd_to_hwirq(data);
	unsigned i;
	unsigned mask;
	unsigned boundary;
	unsigned long flags;

	for (i = 0; i < 48; i += 8)
		if (offset < i + 8) {
			mask = BIT(offset - i);
			boundary = i / 8;

			idi48gpio->irq_mask[boundary] &= ~mask;

			if (!idi48gpio->irq_mask[boundary]) {
				idi48gpio->cos_enb &= ~BIT(boundary);

161
				raw_spin_lock_irqsave(&idi48gpio->lock, flags);
162 163 164

				outb(idi48gpio->cos_enb, idi48gpio->base + 7);

165 166
				raw_spin_unlock_irqrestore(&idi48gpio->lock,
						           flags);
167 168 169 170 171 172 173 174 175
			}

			return;
		}
}

static void idi_48_irq_unmask(struct irq_data *data)
{
	struct gpio_chip *chip = irq_data_get_irq_chip_data(data);
176
	struct idi_48_gpio *const idi48gpio = gpiochip_get_data(chip);
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
	const unsigned offset = irqd_to_hwirq(data);
	unsigned i;
	unsigned mask;
	unsigned boundary;
	unsigned prev_irq_mask;
	unsigned long flags;

	for (i = 0; i < 48; i += 8)
		if (offset < i + 8) {
			mask = BIT(offset - i);
			boundary = i / 8;
			prev_irq_mask = idi48gpio->irq_mask[boundary];

			idi48gpio->irq_mask[boundary] |= mask;

			if (!prev_irq_mask) {
				idi48gpio->cos_enb |= BIT(boundary);

195
				raw_spin_lock_irqsave(&idi48gpio->lock, flags);
196 197 198

				outb(idi48gpio->cos_enb, idi48gpio->base + 7);

199 200
				raw_spin_unlock_irqrestore(&idi48gpio->lock,
						           flags);
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
			}

			return;
		}
}

static int idi_48_irq_set_type(struct irq_data *data, unsigned flow_type)
{
	/* The only valid irq types are none and both-edges */
	if (flow_type != IRQ_TYPE_NONE &&
		(flow_type & IRQ_TYPE_EDGE_BOTH) != IRQ_TYPE_EDGE_BOTH)
		return -EINVAL;

	return 0;
}

static struct irq_chip idi_48_irqchip = {
	.name = "104-idi-48",
	.irq_ack = idi_48_irq_ack,
	.irq_mask = idi_48_irq_mask,
	.irq_unmask = idi_48_irq_unmask,
	.irq_set_type = idi_48_irq_set_type
};

static irqreturn_t idi_48_irq_handler(int irq, void *dev_id)
{
	struct idi_48_gpio *const idi48gpio = dev_id;
	unsigned long cos_status;
	unsigned long boundary;
	unsigned long irq_mask;
	unsigned long bit_num;
	unsigned long gpio;
	struct gpio_chip *const chip = &idi48gpio->chip;

235 236
	spin_lock(&idi48gpio->ack_lock);

237
	raw_spin_lock(&idi48gpio->lock);
238 239 240

	cos_status = inb(idi48gpio->base + 7);

241
	raw_spin_unlock(&idi48gpio->lock);
242 243

	/* IRQ Status (bit 6) is active low (0 = IRQ generated by device) */
244 245
	if (cos_status & BIT(6)) {
		spin_unlock(&idi48gpio->ack_lock);
246
		return IRQ_NONE;
247
	}
248 249 250 251 252 253 254 255 256 257

	/* Bit 0-5 indicate which Change-Of-State boundary triggered the IRQ */
	cos_status &= 0x3F;

	for_each_set_bit(boundary, &cos_status, 6) {
		irq_mask = idi48gpio->irq_mask[boundary];

		for_each_set_bit(bit_num, &irq_mask, 8) {
			gpio = bit_num + boundary * 8;

258
			generic_handle_irq(irq_find_mapping(chip->irq.domain,
259 260 261 262
				gpio));
		}
	}

263 264
	spin_unlock(&idi48gpio->ack_lock);

265 266 267
	return IRQ_HANDLED;
}

268 269 270 271 272 273 274 275 276 277 278 279
#define IDI48_NGPIO 48
static const char *idi48_names[IDI48_NGPIO] = {
	"Bit 0 A", "Bit 1 A", "Bit 2 A", "Bit 3 A", "Bit 4 A", "Bit 5 A",
	"Bit 6 A", "Bit 7 A", "Bit 8 A", "Bit 9 A", "Bit 10 A", "Bit 11 A",
	"Bit 12 A", "Bit 13 A", "Bit 14 A", "Bit 15 A",	"Bit 16 A", "Bit 17 A",
	"Bit 18 A", "Bit 19 A", "Bit 20 A", "Bit 21 A", "Bit 22 A", "Bit 23 A",
	"Bit 0 B", "Bit 1 B", "Bit 2 B", "Bit 3 B", "Bit 4 B", "Bit 5 B",
	"Bit 6 B", "Bit 7 B", "Bit 8 B", "Bit 9 B", "Bit 10 B", "Bit 11 B",
	"Bit 12 B", "Bit 13 B", "Bit 14 B", "Bit 15 B",	"Bit 16 B", "Bit 17 B",
	"Bit 18 B", "Bit 19 B", "Bit 20 B", "Bit 21 B", "Bit 22 B", "Bit 23 B"
};

280
static int idi_48_probe(struct device *dev, unsigned int id)
281 282 283 284 285 286 287 288 289
{
	struct idi_48_gpio *idi48gpio;
	const char *const name = dev_name(dev);
	int err;

	idi48gpio = devm_kzalloc(dev, sizeof(*idi48gpio), GFP_KERNEL);
	if (!idi48gpio)
		return -ENOMEM;

290
	if (!devm_request_region(dev, base[id], IDI_48_EXTENT, name)) {
291
		dev_err(dev, "Unable to lock port addresses (0x%X-0x%X)\n",
292
			base[id], base[id] + IDI_48_EXTENT);
293
		return -EBUSY;
294 295 296 297 298 299
	}

	idi48gpio->chip.label = name;
	idi48gpio->chip.parent = dev;
	idi48gpio->chip.owner = THIS_MODULE;
	idi48gpio->chip.base = -1;
300 301
	idi48gpio->chip.ngpio = IDI48_NGPIO;
	idi48gpio->chip.names = idi48_names;
302 303 304
	idi48gpio->chip.get_direction = idi_48_gpio_get_direction;
	idi48gpio->chip.direction_input = idi_48_gpio_direction_input;
	idi48gpio->chip.get = idi_48_gpio_get;
305
	idi48gpio->chip.get_multiple = idi_48_gpio_get_multiple;
306
	idi48gpio->base = base[id];
307

308
	raw_spin_lock_init(&idi48gpio->lock);
309
	spin_lock_init(&idi48gpio->ack_lock);
310

311
	err = devm_gpiochip_add_data(dev, &idi48gpio->chip, idi48gpio);
312 313
	if (err) {
		dev_err(dev, "GPIO registering failed (%d)\n", err);
314
		return err;
315 316 317
	}

	/* Disable IRQ by default */
318 319
	outb(0, base[id] + 7);
	inb(base[id] + 7);
320 321 322 323 324

	err = gpiochip_irqchip_add(&idi48gpio->chip, &idi_48_irqchip, 0,
		handle_edge_irq, IRQ_TYPE_NONE);
	if (err) {
		dev_err(dev, "Could not add irqchip (%d)\n", err);
325
		return err;
326 327
	}

328 329
	err = devm_request_irq(dev, irq[id], idi_48_irq_handler, IRQF_SHARED,
		name, idi48gpio);
330 331
	if (err) {
		dev_err(dev, "IRQ handler registering failed (%d)\n", err);
332
		return err;
333 334 335 336 337
	}

	return 0;
}

338 339
static struct isa_driver idi_48_driver = {
	.probe = idi_48_probe,
340 341 342 343
	.driver = {
		.name = "104-idi-48"
	},
};
344
module_isa_driver(idi_48_driver, num_idi_48);
345 346 347

MODULE_AUTHOR("William Breathitt Gray <vilhelm.gray@gmail.com>");
MODULE_DESCRIPTION("ACCES 104-IDI-48 GPIO driver");
348
MODULE_LICENSE("GPL v2");