gpio-104-idi-48.c 8.28 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0-only
2 3 4 5
/*
 * GPIO driver for the ACCES 104-IDI-48 family
 * Copyright (C) 2015 William Breathitt Gray
 *
6 7
 * This driver supports the following ACCES devices: 104-IDI-48A,
 * 104-IDI-48AC, 104-IDI-48B, and 104-IDI-48BC.
8
 */
9
#include <linux/bitmap.h>
10 11 12 13 14 15 16 17
#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>
18
#include <linux/isa.h>
19 20 21 22 23
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/spinlock.h>

24 25 26 27 28
#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;
29
module_param_hw_array(base, uint, ioport, &num_idi_48, 0);
30 31 32
MODULE_PARM_DESC(base, "ACCES 104-IDI-48 base addresses");

static unsigned int irq[MAX_NUM_IDI_48];
33
module_param_hw_array(irq, uint, irq, NULL, 0);
34
MODULE_PARM_DESC(irq, "ACCES 104-IDI-48 interrupt line numbers");
35 36 37 38 39

/**
 * struct idi_48_gpio - GPIO device private data structure
 * @chip:	instance of the gpio_chip
 * @lock:	synchronization lock to prevent I/O race conditions
40
 * @ack_lock:	synchronization lock to prevent IRQ handler race conditions
41 42 43 44 45 46
 * @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;
47
	raw_spinlock_t lock;
48
	spinlock_t ack_lock;
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
	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)
{
66
	struct idi_48_gpio *const idi48gpio = gpiochip_get_data(chip);
67
	unsigned i;
68
	static const unsigned int register_offset[6] = { 0, 1, 2, 4, 5, 6 };
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
	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;
}

84 85 86 87
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);
88 89
	unsigned long offset;
	unsigned long gpio_mask;
90
	static const size_t ports[] = { 0, 1, 2, 4, 5, 6 };
91
	unsigned int port_addr;
92 93 94 95 96
	unsigned long port_state;

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

97 98 99
	for_each_set_clump8(offset, gpio_mask, mask, ARRAY_SIZE(ports) * 8) {
		port_addr = idi48gpio->base + ports[offset / 8];
		port_state = inb(port_addr) & gpio_mask;
100

101
		bitmap_set_value8(bits, port_state, offset);
102 103 104 105 106
	}

	return 0;
}

107 108 109 110 111 112 113
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);
114
	struct idi_48_gpio *const idi48gpio = gpiochip_get_data(chip);
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
	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);

131
				raw_spin_lock_irqsave(&idi48gpio->lock, flags);
132 133 134

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

135 136
				raw_spin_unlock_irqrestore(&idi48gpio->lock,
						           flags);
137 138 139 140 141 142 143 144 145
			}

			return;
		}
}

static void idi_48_irq_unmask(struct irq_data *data)
{
	struct gpio_chip *chip = irq_data_get_irq_chip_data(data);
146
	struct idi_48_gpio *const idi48gpio = gpiochip_get_data(chip);
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
	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);

165
				raw_spin_lock_irqsave(&idi48gpio->lock, flags);
166 167 168

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

169 170
				raw_spin_unlock_irqrestore(&idi48gpio->lock,
						           flags);
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
			}

			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;

205 206
	spin_lock(&idi48gpio->ack_lock);

207
	raw_spin_lock(&idi48gpio->lock);
208 209 210

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

211
	raw_spin_unlock(&idi48gpio->lock);
212 213

	/* IRQ Status (bit 6) is active low (0 = IRQ generated by device) */
214 215
	if (cos_status & BIT(6)) {
		spin_unlock(&idi48gpio->ack_lock);
216
		return IRQ_NONE;
217
	}
218 219 220 221 222 223 224 225 226 227

	/* 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;

228
			generic_handle_irq(irq_find_mapping(chip->irq.domain,
229 230 231 232
				gpio));
		}
	}

233 234
	spin_unlock(&idi48gpio->ack_lock);

235 236 237
	return IRQ_HANDLED;
}

238 239 240 241 242 243 244 245 246 247 248 249
#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"
};

250
static int idi_48_probe(struct device *dev, unsigned int id)
251 252 253 254 255 256 257 258 259
{
	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;

260
	if (!devm_request_region(dev, base[id], IDI_48_EXTENT, name)) {
261
		dev_err(dev, "Unable to lock port addresses (0x%X-0x%X)\n",
262
			base[id], base[id] + IDI_48_EXTENT);
263
		return -EBUSY;
264 265 266 267 268 269
	}

	idi48gpio->chip.label = name;
	idi48gpio->chip.parent = dev;
	idi48gpio->chip.owner = THIS_MODULE;
	idi48gpio->chip.base = -1;
270 271
	idi48gpio->chip.ngpio = IDI48_NGPIO;
	idi48gpio->chip.names = idi48_names;
272 273 274
	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;
275
	idi48gpio->chip.get_multiple = idi_48_gpio_get_multiple;
276
	idi48gpio->base = base[id];
277

278
	raw_spin_lock_init(&idi48gpio->lock);
279
	spin_lock_init(&idi48gpio->ack_lock);
280

281
	err = devm_gpiochip_add_data(dev, &idi48gpio->chip, idi48gpio);
282 283
	if (err) {
		dev_err(dev, "GPIO registering failed (%d)\n", err);
284
		return err;
285 286 287
	}

	/* Disable IRQ by default */
288 289
	outb(0, base[id] + 7);
	inb(base[id] + 7);
290 291 292 293 294

	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);
295
		return err;
296 297
	}

298 299
	err = devm_request_irq(dev, irq[id], idi_48_irq_handler, IRQF_SHARED,
		name, idi48gpio);
300 301
	if (err) {
		dev_err(dev, "IRQ handler registering failed (%d)\n", err);
302
		return err;
303 304 305 306 307
	}

	return 0;
}

308 309
static struct isa_driver idi_48_driver = {
	.probe = idi_48_probe,
310 311 312 313
	.driver = {
		.name = "104-idi-48"
	},
};
314
module_isa_driver(idi_48_driver, num_idi_48);
315 316 317

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