drivers: gpio_rpi_pico: Extend the driver API #84548

ajf58 · 2025-01-25T08:53:45Z

Edit:

The original goal of this PR was to add just the gpio_get_config. This PR has now widened to include a lot more functionality, extending the both the existing APIs to be more feature-complete, and adding new APIs that were missing.

Tested locally using a physical test fixture supporting the GPIO loopback.

ajf58 · 2025-01-25T09:15:21Z

cc: @drensber

drivers/gpio/gpio_rpi_pico.c

tests/drivers/gpio/gpio_basic_api/boards/rpi_pico2_rp2350a_m33.conf

drivers/gpio/gpio_rpi_pico.c

ThreeEights · 2025-02-06T17:18:48Z

drivers/gpio/gpio_rpi_pico.c

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


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 ...)

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.

ThreeEights · 2025-02-06T17:22:54Z

drivers/gpio/gpio_rpi_pico.c

+	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;


Don't you hate that? :-)

That a tab is 8 characters wide and the column limit is 100? Yes on both fronts.

Everyone who learned how to properly use a keyboard knows that the correct setting for tabs is 5 spaces, adjusted as needed to suit the document. :-)

Out of reset the pads are input enabled, output disabled. Disconnect the pad's input and output buffers, as well as any pullups. This can reduce input leakage current. Signed-off-by: Andrew Featherstone <andrew.featherstone@gmail.com>

Reorder gpio_rpi_configure to disable input buffers when not in use. gpio_rpi_get_config can then determine whether a pin is configured as an input without requiring additional state variables, as well as reducing input leakage current. Signed-off-by: Andrew Featherstone <andrew.featherstone@gmail.com>

Implement `gpio_get_pending_int`. Signed-off-by: Andrew Featherstone <andrew.featherstone@gmail.com>

THe driver didn't implement this API, so add it. Signed-off-by: Andrew Featherstone <andrew.featherstone@gmail.com>

Implement the `gpio_get_config` N.b. adding this API results in a new test failure in `test_gpio_config_trigger`. This suggests that there is some kind of dependency between this and the now-enabled `pin_get_config` test cases. Note that this adds a read-only API, it is unlikely to be the cause of the failure. Signed-off-by: Andrew Featherstone <andrew.featherstone@gmail.com>

ajf58

This push:

Rebases onto a newer revision of main.
Applies whitespaces requested in the review (although I would like to understand their rationale).
Corrects compliance issues that came up under CI.

drivers/gpio/gpio_rpi_pico.c

ajf58 · 2025-02-08T08:35:01Z

drivers/gpio/gpio_rpi_pico.c

+	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;


That a tab is 8 characters wide and the column limit is 100? Yes on both fronts.

ajf58 · 2025-02-08T13:53:35Z

drivers/gpio/gpio_rpi_pico.c

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


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.

soburi · 2025-02-09T01:31:07Z

drivers/gpio/gpio_rpi_pico.c

+	}
+	if (inputs) {
+		*inputs &= map;
+	}


Here too, add a blank after }.

No.

256-258 is related to 259-261, See also 249-254, 107-112. These are logically grouped together, and that's represented by the code not have vertical whitespace between them.

ajf58 · 2025-02-09T09:57:48Z

At this point I think this PR it GTG.
@soburi , please take some time to read the reviewer guidelines at https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/contribute/reviewer_expectations.rst?plain=1#L39-L55 . I feel those 3 points are applicable.

soburi · 2025-02-09T11:27:49Z

At this point I think this PR it GTG. @soburi , please take some time to read the reviewer guidelines at https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/contribute/reviewer_expectations.rst?plain=1#L39-L55 . I feel those 3 points are applicable.

I believe there is no problem based on the following wording in the document you showed.

Style changes that the reviewer disagrees with but that are not documented as part of the project can be pointed out as non-blocking,

zephyrbot added area: GPIO platform: Raspberry Pi Pico Raspberry Pi Pico (RPi Pico) labels Jan 25, 2025

zephyrbot requested review from henrikbrixandersen, mnkp, soburi and yonsch January 25, 2025 08:54

zephyrbot assigned soburi Jan 25, 2025

ajf58 force-pushed the rpi-pico-add-gpio-get-config-api branch from 0b86b90 to 4416912 Compare January 25, 2025 09:08

soburi reviewed Jan 27, 2025

View reviewed changes

drivers/gpio/gpio_rpi_pico.c Show resolved Hide resolved

soburi reviewed Jan 27, 2025

View reviewed changes

tests/drivers/gpio/gpio_basic_api/boards/rpi_pico2_rp2350a_m33.conf Outdated Show resolved Hide resolved

soburi requested a review from ThreeEights January 31, 2025 08:23

soburi mentioned this pull request Jan 31, 2025

tests: drivers: gpio: gpio_basic_api: Enable test on rpi_pico #83427

Merged

ajf58 changed the title ~~drivers: gpio_rpi_pico: Add gpio_get_config API~~ drivers: gpio_rpi_pico: Extend the driver API Feb 4, 2025

ajf58 force-pushed the rpi-pico-add-gpio-get-config-api branch from 099ef80 to 2bfaa02 Compare February 4, 2025 22:21

soburi reviewed Feb 4, 2025

View reviewed changes

drivers/gpio/gpio_rpi_pico.c Show resolved Hide resolved

soburi reviewed Feb 4, 2025

View reviewed changes

drivers/gpio/gpio_rpi_pico.c Show resolved Hide resolved

ThreeEights reviewed Feb 6, 2025

View reviewed changes

ajf58 added 5 commits February 8, 2025 13:19

drivers: gpio_rpi_pico: Add gpio_get_pending_int API

8e56bfc

Implement `gpio_get_pending_int`. Signed-off-by: Andrew Featherstone <andrew.featherstone@gmail.com>

drivers: gpio_rpi_pico: Add gpio_port_get_direction API

5fb06d4

THe driver didn't implement this API, so add it. Signed-off-by: Andrew Featherstone <andrew.featherstone@gmail.com>

ajf58 force-pushed the rpi-pico-add-gpio-get-config-api branch from 2bfaa02 to c39f6f3 Compare February 8, 2025 14:06

ajf58 commented Feb 8, 2025

View reviewed changes

ajf58 requested review from soburi and ThreeEights February 8, 2025 19:34

soburi reviewed Feb 9, 2025

View reviewed changes

ajf58 requested a review from soburi February 9, 2025 12:32

ajf58 mentioned this pull request Feb 9, 2025

Nominate myself (ajf58) as Collaborator #85467

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

drivers: gpio_rpi_pico: Extend the driver API #84548

drivers: gpio_rpi_pico: Extend the driver API #84548

ajf58 commented Jan 25, 2025 •

edited

Loading

ajf58 commented Jan 25, 2025

ThreeEights Feb 6, 2025

ajf58 Feb 8, 2025

ThreeEights Feb 6, 2025

ajf58 Feb 8, 2025

ThreeEights Feb 12, 2025

ajf58 left a comment

ajf58 Feb 8, 2025

ajf58 Feb 8, 2025

soburi Feb 9, 2025

ajf58 Feb 9, 2025

ajf58 commented Feb 9, 2025

soburi commented Feb 9, 2025

drivers: gpio_rpi_pico: Extend the driver API #84548

Are you sure you want to change the base?

drivers: gpio_rpi_pico: Extend the driver API #84548

Conversation

ajf58 commented Jan 25, 2025 • edited Loading

ajf58 commented Jan 25, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ajf58 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ajf58 commented Feb 9, 2025

soburi commented Feb 9, 2025

ajf58 commented Jan 25, 2025 •

edited

Loading