linux/drivers/gpio/gpio-i8255.c

// SPDX-License-Identifier: GPL-2.0
/*
 * Intel 8255 Programmable Peripheral Interface
 * Copyright (C) 2022 William Breathitt Gray
 */
#include <linux/bitmap.h>
#include <linux/device.h>
#include <linux/err.h>
#include <linux/export.h>
#include <linux/gpio/regmap.h>
#include <linux/io.h>
#include <linux/module.h>
#include <linux/regmap.h>
#include <linux/spinlock.h>
#include <linux/types.h>

#include "gpio-i8255.h"

#define I8255_NGPIO 24
#define I8255_NGPIO_PER_REG 8
#define I8255_CONTROL_PORTC_LOWER_DIRECTION BIT(0)
#define I8255_CONTROL_PORTB_DIRECTION BIT(1)
#define I8255_CONTROL_PORTC_UPPER_DIRECTION BIT(3)
#define I8255_CONTROL_PORTA_DIRECTION BIT(4)
#define I8255_CONTROL_MODE_SET BIT(7)
#define I8255_PORTA 0x0
#define I8255_PORTB 0x1
#define I8255_PORTC 0x2
#define I8255_CONTROL 0x3
#define I8255_REG_DAT_BASE I8255_PORTA
#define I8255_REG_DIR_IN_BASE I8255_CONTROL

static int i8255_get_port(struct i8255 __iomem *const ppi,
			  const unsigned long io_port, const unsigned long mask)
{
	const unsigned long bank = io_port / 3;
	const unsigned long ppi_port = io_port % 3;

	return ioread8(&ppi[bank].port[ppi_port]) & mask;
}

static int i8255_direction_mask(const unsigned int offset)
{
	const unsigned int stride = offset / I8255_NGPIO_PER_REG;
	const unsigned int line = offset % I8255_NGPIO_PER_REG;

	switch (stride) {
	case I8255_PORTA:
		return I8255_CONTROL_PORTA_DIRECTION;
	case I8255_PORTB:
		return I8255_CONTROL_PORTB_DIRECTION;
	case I8255_PORTC:
		/* Port C can be configured by nibble */
		if (line >= 4)
			return I8255_CONTROL_PORTC_UPPER_DIRECTION;
		return I8255_CONTROL_PORTC_LOWER_DIRECTION;
	default:
		/* Should never reach this path */
		return 0;
	}
}

static int i8255_ppi_init(struct regmap *const map, const unsigned int base)
{
	int err;

	/* Configure all ports to MODE 0 output mode */
	err = regmap_write(map, base + I8255_CONTROL, I8255_CONTROL_MODE_SET);
	if (err)
		return err;

	/* Initialize all GPIO to output 0 */
	err = regmap_write(map, base + I8255_PORTA, 0x00);
	if (err)
		return err;
	err = regmap_write(map, base + I8255_PORTB, 0x00);
	if (err)
		return err;
	return regmap_write(map, base + I8255_PORTC, 0x00);
}

static int i8255_reg_mask_xlate(struct gpio_regmap *gpio, unsigned int base,
				unsigned int offset, unsigned int *reg,
				unsigned int *mask)
{
	const unsigned int ppi = offset / I8255_NGPIO;
	const unsigned int ppi_offset = offset % I8255_NGPIO;
	const unsigned int stride = ppi_offset / I8255_NGPIO_PER_REG;
	const unsigned int line = ppi_offset % I8255_NGPIO_PER_REG;

	switch (base) {
	case I8255_REG_DAT_BASE:
		*reg = base + stride + ppi * 4;
		*mask = BIT(line);
		return 0;
	case I8255_REG_DIR_IN_BASE:
		*reg = base + ppi * 4;
		*mask = i8255_direction_mask(ppi_offset);
		return 0;
	default:
		/* Should never reach this path */
		return -EINVAL;
	}
}

static void i8255_set_port(struct i8255 __iomem *const ppi,
			   struct i8255_state *const state,
			   const unsigned long io_port,
			   const unsigned long mask, const unsigned long bits)
{
	const unsigned long bank = io_port / 3;
	const unsigned long ppi_port = io_port % 3;
	unsigned long flags;
	unsigned long out_state;

	spin_lock_irqsave(&state[bank].lock, flags);

	out_state = ioread8(&ppi[bank].port[ppi_port]);
	out_state = (out_state & ~mask) | (bits & mask);
	iowrite8(out_state, &ppi[bank].port[ppi_port]);

	spin_unlock_irqrestore(&state[bank].lock, flags);
}

/**
 * i8255_direction_input - configure signal offset as input
 * @ppi:	Intel 8255 Programmable Peripheral Interface banks
 * @state:	devices states of the respective PPI banks
 * @offset:	signal offset to configure as input
 *
 * Configures a signal @offset as input for the respective Intel 8255
 * Programmable Peripheral Interface (@ppi) banks. The @state control_state
 * values are updated to reflect the new configuration.
 */
void i8255_direction_input(struct i8255 __iomem *const ppi,
			   struct i8255_state *const state,
			   const unsigned long offset)
{
	const unsigned long io_port = offset / 8;
	const unsigned long bank = io_port / 3;
	unsigned long flags;

	spin_lock_irqsave(&state[bank].lock, flags);

	state[bank].control_state |= I8255_CONTROL_MODE_SET;
	state[bank].control_state |= i8255_direction_mask(offset % 24);

	iowrite8(state[bank].control_state, &ppi[bank].control);

	spin_unlock_irqrestore(&state[bank].lock, flags);
}
EXPORT_SYMBOL_NS_GPL(i8255_direction_input, I8255);

/**
 * i8255_direction_output - configure signal offset as output
 * @ppi:	Intel 8255 Programmable Peripheral Interface banks
 * @state:	devices states of the respective PPI banks
 * @offset:	signal offset to configure as output
 * @value:	signal value to output
 *
 * Configures a signal @offset as output for the respective Intel 8255
 * Programmable Peripheral Interface (@ppi) banks and sets the respective signal
 * output to the desired @value. The @state control_state values are updated to
 * reflect the new configuration.
 */
void i8255_direction_output(struct i8255 __iomem *const ppi,
			    struct i8255_state *const state,
			    const unsigned long offset,
			    const unsigned long value)
{
	const unsigned long io_port = offset / 8;
	const unsigned long bank = io_port / 3;
	unsigned long flags;

	spin_lock_irqsave(&state[bank].lock, flags);

	state[bank].control_state |= I8255_CONTROL_MODE_SET;
	state[bank].control_state &= ~i8255_direction_mask(offset % 24);

	iowrite8(state[bank].control_state, &ppi[bank].control);

	spin_unlock_irqrestore(&state[bank].lock, flags);

	i8255_set(ppi, state, offset, value);
}
EXPORT_SYMBOL_NS_GPL(i8255_direction_output, I8255);

/**
 * i8255_get - get signal value at signal offset
 * @ppi:	Intel 8255 Programmable Peripheral Interface banks
 * @offset:	offset of signal to get
 *
 * Returns the signal value (0=low, 1=high) for the signal at @offset for the
 * respective Intel 8255 Programmable Peripheral Interface (@ppi) banks.
 */
int i8255_get(struct i8255 __iomem *const ppi, const unsigned long offset)
{
	const unsigned long io_port = offset / 8;
	const unsigned long offset_mask = BIT(offset % 8);

	return !!i8255_get_port(ppi, io_port, offset_mask);
}
EXPORT_SYMBOL_NS_GPL(i8255_get, I8255);

/**
 * i8255_get_direction - get the I/O direction for a signal offset
 * @state:	devices states of the respective PPI banks
 * @offset:	offset of signal to get direction
 *
 * Returns the signal direction (0=output, 1=input) for the signal at @offset.
 */
int i8255_get_direction(const struct i8255_state *const state,
			const unsigned long offset)
{
	const unsigned long io_port = offset / 8;
	const unsigned long bank = io_port / 3;

	return !!(state[bank].control_state & i8255_direction_mask(offset % 24));
}
EXPORT_SYMBOL_NS_GPL(i8255_get_direction, I8255);

/**
 * i8255_get_multiple - get multiple signal values at multiple signal offsets
 * @ppi:	Intel 8255 Programmable Peripheral Interface banks
 * @mask:	mask of signals to get
 * @bits:	bitmap to store signal values
 * @ngpio:	number of GPIO signals of the respective PPI banks
 *
 * Stores in @bits the values (0=low, 1=high) for the signals defined by @mask
 * for the respective Intel 8255 Programmable Peripheral Interface (@ppi) banks.
 */
void i8255_get_multiple(struct i8255 __iomem *const ppi,
			const unsigned long *const mask,
			unsigned long *const bits, const unsigned long ngpio)
{
	unsigned long offset;
	unsigned long port_mask;
	unsigned long io_port;
	unsigned long port_state;

	bitmap_zero(bits, ngpio);

	for_each_set_clump8(offset, port_mask, mask, ngpio) {
		io_port = offset / 8;
		port_state = i8255_get_port(ppi, io_port, port_mask);

		bitmap_set_value8(bits, port_state, offset);
	}
}
EXPORT_SYMBOL_NS_GPL(i8255_get_multiple, I8255);

/**
 * i8255_mode0_output - configure all PPI ports to MODE 0 output mode
 * @ppi:	Intel 8255 Programmable Peripheral Interface bank
 *
 * Configures all Intel 8255 Programmable Peripheral Interface (@ppi) ports to
 * MODE 0 (Basic Input/Output) output mode.
 */
void i8255_mode0_output(struct i8255 __iomem *const ppi)
{
	iowrite8(I8255_CONTROL_MODE_SET, &ppi->control);
}
EXPORT_SYMBOL_NS_GPL(i8255_mode0_output, I8255);

/**
 * i8255_set - set signal value at signal offset
 * @ppi:	Intel 8255 Programmable Peripheral Interface banks
 * @state:	devices states of the respective PPI banks
 * @offset:	offset of signal to set
 * @value:	value of signal to set
 *
 * Assigns output @value for the signal at @offset for the respective Intel 8255
 * Programmable Peripheral Interface (@ppi) banks.
 */
void i8255_set(struct i8255 __iomem *const ppi, struct i8255_state *const state,
	       const unsigned long offset, const unsigned long value)
{
	const unsigned long io_port = offset / 8;
	const unsigned long port_offset = offset % 8;
	const unsigned long mask = BIT(port_offset);
	const unsigned long bits = value << port_offset;

	i8255_set_port(ppi, state, io_port, mask, bits);
}
EXPORT_SYMBOL_NS_GPL(i8255_set, I8255);

/**
 * i8255_set_multiple - set signal values at multiple signal offsets
 * @ppi:	Intel 8255 Programmable Peripheral Interface banks
 * @state:	devices states of the respective PPI banks
 * @mask:	mask of signals to set
 * @bits:	bitmap of signal output values
 * @ngpio:	number of GPIO signals of the respective PPI banks
 *
 * Assigns output values defined by @bits for the signals defined by @mask for
 * the respective Intel 8255 Programmable Peripheral Interface (@ppi) banks.
 */
void i8255_set_multiple(struct i8255 __iomem *const ppi,
			struct i8255_state *const state,
			const unsigned long *const mask,
			const unsigned long *const bits,
			const unsigned long ngpio)
{
	unsigned long offset;
	unsigned long port_mask;
	unsigned long io_port;
	unsigned long value;

	for_each_set_clump8(offset, port_mask, mask, ngpio) {
		io_port = offset / 8;
		value = bitmap_get_value8(bits, offset);
		i8255_set_port(ppi, state, io_port, port_mask, value);
	}
}
EXPORT_SYMBOL_NS_GPL(i8255_set_multiple, I8255);

/**
 * i8255_state_init - initialize i8255_state structure
 * @state:	devices states of the respective PPI banks
 * @nbanks:	number of Intel 8255 Programmable Peripheral Interface banks
 *
 * Initializes the @state of each Intel 8255 Programmable Peripheral Interface
 * bank for use in i8255 library functions.
 */
void i8255_state_init(struct i8255_state *const state,
		      const unsigned long nbanks)
{
	unsigned long bank;

	for (bank = 0; bank < nbanks; bank++)
		spin_lock_init(&state[bank].lock);
}
EXPORT_SYMBOL_NS_GPL(i8255_state_init, I8255);

/**
 * devm_i8255_regmap_register - Register an i8255 GPIO controller
 * @dev:	device that is registering this i8255 GPIO device
 * @config:	configuration for i8255_regmap_config
 *
 * Registers an Intel 8255 Programmable Peripheral Interface GPIO controller.
 * Returns 0 on success and negative error number on failure.
 */
int devm_i8255_regmap_register(struct device *const dev,
			       const struct i8255_regmap_config *const config)
{
	struct gpio_regmap_config gpio_config = {0};
	unsigned long i;
	int err;

	if (!config->parent)
		return -EINVAL;

	if (!config->map)
		return -EINVAL;

	if (!config->num_ppi)
		return -EINVAL;

	for (i = 0; i < config->num_ppi; i++) {
		err = i8255_ppi_init(config->map, i * 4);
		if (err)
			return err;
	}

	gpio_config.parent = config->parent;
	gpio_config.regmap = config->map;
	gpio_config.ngpio = I8255_NGPIO * config->num_ppi;
	gpio_config.names = config->names;
	gpio_config.reg_dat_base = GPIO_REGMAP_ADDR(I8255_REG_DAT_BASE);
	gpio_config.reg_set_base = GPIO_REGMAP_ADDR(I8255_REG_DAT_BASE);
	gpio_config.reg_dir_in_base = GPIO_REGMAP_ADDR(I8255_REG_DIR_IN_BASE);
	gpio_config.ngpio_per_reg = I8255_NGPIO_PER_REG;
	gpio_config.irq_domain = config->domain;
	gpio_config.reg_mask_xlate = i8255_reg_mask_xlate;

	return PTR_ERR_OR_ZERO(devm_gpio_regmap_register(dev, &gpio_config));
}
EXPORT_SYMBOL_NS_GPL(devm_i8255_regmap_register, I8255);

MODULE_AUTHOR("William Breathitt Gray");
MODULE_DESCRIPTION("Intel 8255 Programmable Peripheral Interface");
MODULE_LICENSE("GPL");