zephyr/drivers/gpio/gpio_mmio32.c

124 lines
3.3 KiB
C

/*
* Copyright (c) 2016 Linaro Ltd.
*
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @file
* @brief Driver to provide the GPIO API for a simple 32-bit i/o register
*
* This is a driver for accessing a simple, fixed purpose, 32-bit
* memory-mapped i/o register using the same APIs as GPIO drivers. This is
* useful when an SoC or board has registers that aren't part of a GPIO IP
* block and these registers are used to control things that Zephyr normaly
* expects to be specified using a GPIO pin, e.g. for driving an LED, or
* chip-select line for an SPI device.
*
* The implementation expects that all bits of the hardware register are both
* readable and writeable, and that for any bits that act as outputs, the value
* read will have the value that was last written to it. This requirement
* stems from the use of a read-modify-write method for all changes.
*
* It is possible to specify a restricted mask of bits that are valid for
* access, and whenever the register is written, the value of bits outside this
* mask will be preserved, even when the whole port is written to using
* gpio_port_write.
*/
#include <gpio/gpio_mmio32.h>
#include <errno.h>
static int gpio_mmio32_config(struct device *dev, int access_op,
uint32_t pin, int flags)
{
struct gpio_mmio32_context *context = dev->driver_data;
const struct gpio_mmio32_config *config = context->config;
if (access_op != GPIO_ACCESS_BY_PIN) {
return -ENOTSUP;
}
if ((config->mask & (1 << pin)) == 0) {
return -EINVAL; /* Pin not in our validity mask */
}
if (flags & ~(GPIO_DIR_MASK | GPIO_POL_MASK)) {
/* We ignore direction and fake polarity, rest is unsupported */
return -ENOTSUP;
}
if ((flags & GPIO_POL_MASK) == GPIO_POL_INV) {
context->invert |= (1 << pin);
} else {
context->invert &= ~(1 << pin);
}
return 0;
}
static int gpio_mmio32_write(struct device *dev, int access_op,
uint32_t pin, uint32_t value)
{
struct gpio_mmio32_context *context = dev->driver_data;
const struct gpio_mmio32_config *config = context->config;
volatile uint32_t *reg = config->reg;
uint32_t mask = config->mask;
uint32_t invert = context->invert;
unsigned int key;
if (access_op == GPIO_ACCESS_BY_PIN) {
mask &= 1 << pin;
if (!mask) {
return -EINVAL; /* Pin not in our validity mask */
}
value = value ? mask : 0;
}
value = (value ^ invert) & mask;
/* Update pin state atomically */
key = irq_lock();
*reg = (*reg & ~mask) | value;
irq_unlock(key);
return 0;
}
static int gpio_mmio32_read(struct device *dev, int access_op,
uint32_t pin, uint32_t *value)
{
struct gpio_mmio32_context *context = dev->driver_data;
const struct gpio_mmio32_config *config = context->config;
uint32_t bits;
bits = (*config->reg ^ context->invert) & config->mask;
if (access_op == GPIO_ACCESS_BY_PIN) {
*value = (bits >> pin) & 1;
if ((config->mask & (1 << pin)) == 0) {
return -EINVAL; /* Pin not in our validity mask */
}
} else {
*value = bits;
}
return 0;
}
static const struct gpio_driver_api gpio_mmio32_api = {
.config = gpio_mmio32_config,
.write = gpio_mmio32_write,
.read = gpio_mmio32_read,
};
int gpio_mmio32_init(struct device *dev)
{
struct gpio_mmio32_context *context = dev->driver_data;
const struct gpio_mmio32_config *config = dev->config->config_info;
context->config = config;
dev->driver_api = &gpio_mmio32_api;
return 0;
}