Skip to content

drivers: gpio_rpi_pico: Extend the driver API #84548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 14, 2025
Merged

drivers: gpio_rpi_pico: Extend the driver API #84548

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
47bd3b8
drivers: gpio_rpi_pico: Support GPIO_DISCONNECTED flag
ajf58 Feb 2, 2025
a755082
drivers: gpio_rpi_pico: Disable inputs when not in use
ajf58 Feb 2, 2025
8e56bfc
drivers: gpio_rpi_pico: Add gpio_get_pending_int API
ajf58 Jan 23, 2025
5fb06d4
drivers: gpio_rpi_pico: Add gpio_port_get_direction API
ajf58 Jan 30, 2025
c39f6f3
drivers: gpio_rpi_pico: Add gpio_get_config API
ajf58 Jan 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 93 additions & 4 deletions drivers/gpio/gpio_rpi_pico.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/*
* Copyright (c) 2021, Yonatan Schachter
* Copyright (c) 2025, Andrew Featherstone
*
* SPDX-License-Identifier: Apache-2.0
*/
Expand Down Expand Up @@ -39,8 +40,15 @@ static int gpio_rpi_configure(const struct device *dev,
{
struct gpio_rpi_data *data = dev->data;

if ((flags & GPIO_DIR_MASK) == GPIO_DISCONNECTED) {
return -ENOTSUP;
if (flags == GPIO_DISCONNECTED) {
gpio_disable_pulls(pin);
/* This is almost the opposite of the Pico SDK's gpio_set_function. */
hw_write_masked(&pads_bank0_hw->io[pin], PADS_BANK0_GPIO0_OD_BITS,
PADS_BANK0_GPIO0_IE_BITS | PADS_BANK0_GPIO0_OD_BITS);
#ifdef SOC_SERIES_RP2350
hw_set_bits(&pads_bank0_hw->io[gpio], PADS_BANK0_GPIO0_ISO_BITS);
#endif
return 0;
}

gpio_set_pulls(pin,
Expand All @@ -50,6 +58,12 @@ static int gpio_rpi_configure(const struct device *dev,
/* Avoid gpio_init, since that also clears previously set direction/high/low */
gpio_set_function(pin, GPIO_FUNC_SIO);

if (flags & GPIO_INPUT) {
gpio_set_dir(pin, GPIO_IN);
} else {
gpio_set_input_enabled(pin, false);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given that the RP2xxx series is documented as supporting reading from input pins at any time, does it make sense to disable the pad here? It seems to me that the pad should only be disabled if the application explicitly requests. (Of course, that leaves the question of should there be a Zephyr way to explicitly disable an input ...)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a a good question. Zephyr's unit tests for gpio_pin_get_config require that pin config is explicit, i.e. if gpio_pin_get_config set GPIO_INPUT on every pin, the test will fail.

Of course, that leaves the question of should there be a Zephyr way to explicitly disable an input

I think it is explicit already: if someone wants an output that's also an input, they should use GPIO_INPUT | GPIO_OUTPUT.

}

if (flags & GPIO_OUTPUT) {
if (flags & GPIO_SINGLE_ENDED) {
data->single_ended_mask |= BIT(pin);
Expand Down Expand Up @@ -77,13 +91,42 @@ static int gpio_rpi_configure(const struct device *dev,
}
gpio_set_dir(pin, GPIO_OUT);
}
} else if (flags & GPIO_INPUT) {
gpio_set_dir(pin, GPIO_IN);
}

return 0;
}

#ifdef CONFIG_GPIO_GET_CONFIG
static int gpio_rpi_get_config(const struct device *dev, gpio_pin_t pin, gpio_flags_t *flags)
{
struct gpio_rpi_data *data = dev->data;

*flags = 0;

/* RP2xxxx supports Bus Keeper mode where both pull-up and pull-down are enabled. */
if (gpio_is_pulled_up(pin)) {
*flags |= GPIO_PULL_UP;
}
if (gpio_is_pulled_down(pin)) {
*flags |= GPIO_PULL_DOWN;
}

if (gpio_get_dir(pin)) {
*flags |= gpio_get_out_level(pin) ? GPIO_OUTPUT_HIGH : GPIO_OUTPUT_LOW;
if (data->single_ended_mask & BIT(pin)) {
*flags |=
data->open_drain_mask & BIT(pin) ? GPIO_OPEN_DRAIN : GPIO_PUSH_PULL;
}
}

if (pads_bank0_hw->io[pin] & PADS_BANK0_GPIO0_IE_BITS) {
*flags |= GPIO_INPUT;
}

return 0;
}
#endif

static int gpio_rpi_port_get_raw(const struct device *dev, uint32_t *value)
{
*value = gpio_get_all();
Expand Down Expand Up @@ -182,15 +225,61 @@ static int gpio_rpi_manage_callback(const struct device *dev,
return gpio_manage_callback(&data->callbacks, callback, set);
}

static uint32_t gpio_rpi_get_pending_int(const struct device *dev)
{
io_bank0_irq_ctrl_hw_t *irq_ctrl_base =
get_core_num() ? &io_bank0_hw->proc1_irq_ctrl : &io_bank0_hw->proc0_irq_ctrl;
ARRAY_FOR_EACH_PTR(irq_ctrl_base->ints, p) {
if (*p) {
return 1;
}
}

return 0;
}

#ifdef CONFIG_GPIO_GET_DIRECTION
static int gpio_rpi_port_get_direction(const struct device *port, gpio_port_pins_t map,
gpio_port_pins_t *inputs, gpio_port_pins_t *outputs)
{
/* The Zephyr API considers a disconnected pin to be neither an input nor output.
* Since we disable both OE and IE for disconnected pins clear the mask bits.
*/
for (int pin = 0; pin < NUM_BANK0_GPIOS; pin++) {
if (pads_bank0_hw->io[pin] & PADS_BANK0_GPIO0_OD_BITS) {
map &= ~BIT(pin);
}
if (inputs && (pads_bank0_hw->io[pin] & PADS_BANK0_GPIO0_IE_BITS)) {
*inputs |= BIT(pin);
}
}
if (inputs) {
*inputs &= map;
}
if (outputs) {
*outputs = sio_hw->gpio_oe & map;
}

return 0;
}
#endif

static DEVICE_API(gpio, gpio_rpi_driver_api) = {
.pin_configure = gpio_rpi_configure,
#ifdef CONFIG_GPIO_GET_CONFIG
.pin_get_config = gpio_rpi_get_config,
#endif
.port_get_raw = gpio_rpi_port_get_raw,
.port_set_masked_raw = gpio_rpi_port_set_masked_raw,
.port_set_bits_raw = gpio_rpi_port_set_bits_raw,
.port_clear_bits_raw = gpio_rpi_port_clear_bits_raw,
.port_toggle_bits = gpio_rpi_port_toggle_bits,
.pin_interrupt_configure = gpio_rpi_pin_interrupt_configure,
.manage_callback = gpio_rpi_manage_callback,
.get_pending_int = gpio_rpi_get_pending_int,
#ifdef CONFIG_GPIO_GET_DIRECTION
.port_get_direction = gpio_rpi_port_get_direction,
#endif
};

static void gpio_rpi_isr(const struct device *dev)
Expand Down
Loading