Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 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 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 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 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 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 | /*
* Copyright (c) 2017 Jean-Paul Etienne <fractalclone@gmail.com>
*
* SPDX-License-Identifier: Apache-2.0
*/
#define DT_DRV_COMPAT sifive_gpio0
/**
* @file GPIO driver for the SiFive Freedom Processor
*/
#include <errno.h>
#include <zephyr/kernel.h>
#include <zephyr/device.h>
#include <soc.h>
#include <zephyr/drivers/gpio.h>
#include <zephyr/sys/util.h>
#include "gpio_utils.h"
typedef void (*sifive_cfg_func_t)(void);
/* sifive GPIO register-set structure */
struct gpio_sifive_t {
unsigned int in_val;
unsigned int in_en;
unsigned int out_en;
unsigned int out_val;
unsigned int pue;
unsigned int ds;
unsigned int rise_ie;
unsigned int rise_ip;
unsigned int fall_ie;
unsigned int fall_ip;
unsigned int high_ie;
unsigned int high_ip;
unsigned int low_ie;
unsigned int low_ip;
unsigned int iof_en;
unsigned int iof_sel;
unsigned int invert;
};
struct gpio_sifive_config {
/* gpio_driver_config needs to be first */
struct gpio_driver_config common;
uintptr_t gpio_base_addr;
/* multi-level encoded interrupt corresponding to pin 0 */
uint32_t gpio_irq_base;
sifive_cfg_func_t gpio_cfg_func;
};
struct gpio_sifive_data {
/* gpio_driver_data needs to be first */
struct gpio_driver_data common;
/* list of callbacks */
sys_slist_t cb;
};
/* Helper Macros for GPIO */
#define DEV_GPIO_CFG(dev) \
((const struct gpio_sifive_config * const)(dev)->config)
#define DEV_GPIO(dev) \
((volatile struct gpio_sifive_t *)(DEV_GPIO_CFG(dev))->gpio_base_addr)
#define DEV_GPIO_DATA(dev) \
((struct gpio_sifive_data *)(dev)->data)
/* _irq_level and _level2_irq are copied from
* soc/riscv/riscv-privileged/common/soc_common_irq.c
* Ideally this kind of thing should be made available in include/irq.h or
* somewhere similar since the multi-level IRQ format is generic to
Zephyr, and then both this copy and the one in riscv-privileged
* be removed for the shared implementation
*/
static inline unsigned int _irq_level(unsigned int irq)
{
return ((irq >> 8) && 0xff) == 0U ? 1 : 2;
}
static inline unsigned int _level2_irq(unsigned int irq)
{
return (irq >> 8) - 1;
}
/* Given gpio_irq_base and the pin number, return the IRQ number for the pin */
static inline unsigned int gpio_sifive_pin_irq(unsigned int base_irq, int pin)
{
unsigned int level = _irq_level(base_irq);
unsigned int pin_irq = 0;
if (level == 1) {
pin_irq = base_irq + pin;
} else if (level == 2) {
pin_irq = base_irq + (pin << 8);
}
return pin_irq;
}
/* Given the PLIC source number, return the number of the GPIO pin associated
* with the interrupt
*/
static inline int gpio_sifive_plic_to_pin(unsigned int base_irq, int plic_irq)
{
unsigned int level = _irq_level(base_irq);
if (level == 2) {
base_irq = _level2_irq(base_irq);
}
return (plic_irq - base_irq);
}
static void gpio_sifive_irq_handler(const struct device *dev)
{
struct gpio_sifive_data *data = DEV_GPIO_DATA(dev);
volatile struct gpio_sifive_t *gpio = DEV_GPIO(dev);
const struct gpio_sifive_config *cfg = DEV_GPIO_CFG(dev);
/* Calculate pin and mask from base level 2 line */
uint8_t pin = 1 + (riscv_plic_get_irq() - (uint8_t)(cfg->gpio_irq_base >> 8));
/* This peripheral tracks each condition separately: a
* transition from low to high will mark the pending bit for
* both rise and high, while low will probably be set from the
* previous state.
*
* It is certainly possible, especially on double-edge, that
* multiple conditions are present. However, there is no way
* to tell which one occurred first, and no provision to
* indicate which one occurred in the callback.
*
* Clear all the conditions so we only invoke the callback
* once. Level conditions will remain set after clear.
*/
gpio->rise_ip = BIT(pin);
gpio->fall_ip = BIT(pin);
gpio->high_ip = BIT(pin);
gpio->low_ip = BIT(pin);
/* Call the corresponding callback registered for the pin */
gpio_fire_callbacks(&data->cb, dev, BIT(pin));
}
/**
* @brief Configure pin
*
* @param dev Device structure
* @param pin The pin number
* @param flags Flags of pin or port
*
* @return 0 if successful, failed otherwise
*/
static int gpio_sifive_config(const struct device *dev,
gpio_pin_t pin,
gpio_flags_t flags)
{
volatile struct gpio_sifive_t *gpio = DEV_GPIO(dev);
if (pin >= SIFIVE_PINMUX_PINS) {
return -EINVAL;
}
/* We cannot support open-source open-drain configuration */
if ((flags & GPIO_SINGLE_ENDED) != 0) {
return -ENOTSUP;
}
/* We only support pull-ups, not pull-downs */
if ((flags & GPIO_PULL_DOWN) != 0) {
return -ENOTSUP;
}
/* Set pull-up if requested */
WRITE_BIT(gpio->pue, pin, flags & GPIO_PULL_UP);
/* Set the initial output value before enabling output to avoid
* glitches
*/
if ((flags & GPIO_OUTPUT_INIT_HIGH) != 0) {
gpio->out_val |= BIT(pin);
}
if ((flags & GPIO_OUTPUT_INIT_LOW) != 0) {
gpio->out_val &= ~BIT(pin);
}
/* Enable input/output */
WRITE_BIT(gpio->out_en, pin, flags & GPIO_OUTPUT);
WRITE_BIT(gpio->in_en, pin, flags & GPIO_INPUT);
return 0;
}
static int gpio_sifive_port_get_raw(const struct device *dev,
gpio_port_value_t *value)
{
volatile struct gpio_sifive_t *gpio = DEV_GPIO(dev);
*value = gpio->in_val;
return 0;
}
static int gpio_sifive_port_set_masked_raw(const struct device *dev,
gpio_port_pins_t mask,
gpio_port_value_t value)
{
volatile struct gpio_sifive_t *gpio = DEV_GPIO(dev);
gpio->out_val = (gpio->out_val & ~mask) | (value & mask);
return 0;
}
static int gpio_sifive_port_set_bits_raw(const struct device *dev,
gpio_port_pins_t mask)
{
volatile struct gpio_sifive_t *gpio = DEV_GPIO(dev);
gpio->out_val |= mask;
return 0;
}
static int gpio_sifive_port_clear_bits_raw(const struct device *dev,
gpio_port_pins_t mask)
{
volatile struct gpio_sifive_t *gpio = DEV_GPIO(dev);
gpio->out_val &= ~mask;
return 0;
}
static int gpio_sifive_port_toggle_bits(const struct device *dev,
gpio_port_pins_t mask)
{
volatile struct gpio_sifive_t *gpio = DEV_GPIO(dev);
gpio->out_val ^= mask;
return 0;
}
static int gpio_sifive_pin_interrupt_configure(const struct device *dev,
gpio_pin_t pin,
enum gpio_int_mode mode,
enum gpio_int_trig trig)
{
volatile struct gpio_sifive_t *gpio = DEV_GPIO(dev);
const struct gpio_sifive_config *cfg = DEV_GPIO_CFG(dev);
gpio->rise_ie &= ~BIT(pin);
gpio->fall_ie &= ~BIT(pin);
gpio->high_ie &= ~BIT(pin);
gpio->low_ie &= ~BIT(pin);
switch (mode) {
case GPIO_INT_MODE_DISABLED:
irq_disable(gpio_sifive_pin_irq(cfg->gpio_irq_base, pin));
break;
case GPIO_INT_MODE_LEVEL:
/* Board supports both levels, but Zephyr does not. */
if (trig == GPIO_INT_TRIG_HIGH) {
gpio->high_ip = BIT(pin);
gpio->high_ie |= BIT(pin);
} else {
__ASSERT_NO_MSG(trig == GPIO_INT_TRIG_LOW);
gpio->low_ip = BIT(pin);
gpio->low_ie |= BIT(pin);
}
irq_enable(gpio_sifive_pin_irq(cfg->gpio_irq_base, pin));
break;
case GPIO_INT_MODE_EDGE:
__ASSERT_NO_MSG(GPIO_INT_TRIG_BOTH ==
(GPIO_INT_LOW_0 | GPIO_INT_HIGH_1));
if ((trig & GPIO_INT_HIGH_1) != 0) {
gpio->rise_ip = BIT(pin);
gpio->rise_ie |= BIT(pin);
}
if ((trig & GPIO_INT_LOW_0) != 0) {
gpio->fall_ip = BIT(pin);
gpio->fall_ie |= BIT(pin);
}
irq_enable(gpio_sifive_pin_irq(cfg->gpio_irq_base, pin));
break;
default:
__ASSERT(false, "Invalid MODE %d passed to driver", mode);
return -ENOTSUP;
}
return 0;
}
static int gpio_sifive_manage_callback(const struct device *dev,
struct gpio_callback *callback,
bool set)
{
struct gpio_sifive_data *data = DEV_GPIO_DATA(dev);
return gpio_manage_callback(&data->cb, callback, set);
}
#ifdef CONFIG_GPIO_GET_DIRECTION
static int gpio_sifive_port_get_dir(const struct device *dev, gpio_port_pins_t map,
gpio_port_pins_t *inputs, gpio_port_pins_t *outputs)
{
const struct gpio_sifive_config *cfg = DEV_GPIO_CFG(dev);
map &= cfg->common.port_pin_mask;
if (inputs != NULL) {
*inputs = map & DEV_GPIO(dev)->in_en;
}
if (outputs != NULL) {
*outputs = map & DEV_GPIO(dev)->out_en;
}
return 0;
}
#endif /* CONFIG_GPIO_GET_DIRECTION */
static const struct gpio_driver_api gpio_sifive_driver = {
.pin_configure = gpio_sifive_config,
.port_get_raw = gpio_sifive_port_get_raw,
.port_set_masked_raw = gpio_sifive_port_set_masked_raw,
.port_set_bits_raw = gpio_sifive_port_set_bits_raw,
.port_clear_bits_raw = gpio_sifive_port_clear_bits_raw,
.port_toggle_bits = gpio_sifive_port_toggle_bits,
.pin_interrupt_configure = gpio_sifive_pin_interrupt_configure,
.manage_callback = gpio_sifive_manage_callback,
#ifdef CONFIG_GPIO_GET_DIRECTION
.port_get_direction = gpio_sifive_port_get_dir,
#endif /* CONFIG_GPIO_GET_DIRECTION */
};
/**
* @brief Initialize a GPIO controller
*
* Perform basic initialization of a GPIO controller
*
* @param dev GPIO device struct
*
* @return 0
*/
static int gpio_sifive_init(const struct device *dev)
{
volatile struct gpio_sifive_t *gpio = DEV_GPIO(dev);
const struct gpio_sifive_config *cfg = DEV_GPIO_CFG(dev);
/* Ensure that all gpio registers are reset to 0 initially */
gpio->in_en = 0U;
gpio->out_en = 0U;
gpio->pue = 0U;
gpio->rise_ie = 0U;
gpio->fall_ie = 0U;
gpio->high_ie = 0U;
gpio->low_ie = 0U;
gpio->invert = 0U;
/* Setup IRQ handler for each gpio pin */
cfg->gpio_cfg_func();
return 0;
}
static void gpio_sifive_cfg_0(void);
static const struct gpio_sifive_config gpio_sifive_config0 = {
.common = {
.port_pin_mask = GPIO_PORT_PIN_MASK_FROM_DT_INST(0),
},
.gpio_base_addr = DT_INST_REG_ADDR(0),
.gpio_irq_base = DT_INST_IRQN(0),
.gpio_cfg_func = gpio_sifive_cfg_0,
};
static struct gpio_sifive_data gpio_sifive_data0;
DEVICE_DT_INST_DEFINE(0,
gpio_sifive_init,
NULL,
&gpio_sifive_data0, &gpio_sifive_config0,
PRE_KERNEL_1, CONFIG_GPIO_INIT_PRIORITY,
&gpio_sifive_driver);
#define IRQ_INIT(n) \
IRQ_CONNECT(DT_INST_IRQ_BY_IDX(0, n, irq), \
DT_INST_IRQ_BY_IDX(0, n, priority), \
gpio_sifive_irq_handler, \
DEVICE_DT_INST_GET(0), \
0);
static void gpio_sifive_cfg_0(void)
{
#if DT_INST_IRQ_HAS_IDX(0, 0)
IRQ_INIT(0);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 1)
IRQ_INIT(1);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 2)
IRQ_INIT(2);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 3)
IRQ_INIT(3);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 4)
IRQ_INIT(4);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 5)
IRQ_INIT(5);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 6)
IRQ_INIT(6);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 7)
IRQ_INIT(7);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 8)
IRQ_INIT(8);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 9)
IRQ_INIT(9);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 10)
IRQ_INIT(10);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 11)
IRQ_INIT(11);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 12)
IRQ_INIT(12);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 13)
IRQ_INIT(13);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 14)
IRQ_INIT(14);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 15)
IRQ_INIT(15);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 16)
IRQ_INIT(16);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 17)
IRQ_INIT(17);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 18)
IRQ_INIT(18);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 19)
IRQ_INIT(19);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 20)
IRQ_INIT(20);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 21)
IRQ_INIT(21);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 22)
IRQ_INIT(22);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 23)
IRQ_INIT(23);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 24)
IRQ_INIT(24);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 25)
IRQ_INIT(25);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 26)
IRQ_INIT(26);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 27)
IRQ_INIT(27);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 28)
IRQ_INIT(28);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 29)
IRQ_INIT(29);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 30)
IRQ_INIT(30);
#endif
#if DT_INST_IRQ_HAS_IDX(0, 31)
IRQ_INIT(31);
#endif
}
|