pinctrl: add nrf implementation #39429

gmarull · 2021-10-14T11:06:37Z

This PR adds an initial implementation of a pinctrl driver for nRF based on the pinctrl API proposal in #37572. The driver only supports the UART/E peripherals for now, but could be extended to cover the rest. A sample on how dynamic pinctrl can be used is also provided.

Note: it will be enabled and boards ported once all peripherals are ready.

drivers/pinctrl/pinctrl_nrf.c

include/dt-bindings/pinctrl/nrf-pinctrl.h

boards/arm/96b_carbon_nrf51/96b_carbon_nrf51-pinctrl.dtsi

mbolivar-nordic

Looking really awesome. A few random comments. This is great work.

soc/arm/nordic_nrf/common/pinctrl_soc.h

dts/bindings/pinctrl/nordic,nrf-pinctrl.yaml

soc/arm/nordic_nrf/common/CMakeLists.txt

scripts/utils/pinctrl_nrf_migrate.py

tests/drivers/pinctrl/nrf/boards/nrf52840dk_nrf52840.overlay

dts/bindings/pinctrl/nordic,nrf-pinctrl.yaml

tests/drivers/pinctrl/nrf/boards/nrf52840dk_nrf52840.overlay

drivers/pinctrl/pinctrl_nrf.c

dts/bindings/serial/nordic,nrf-uart-common.yaml

samples/boards/nrf/dynamic_pinctrl/README.rst

drivers/serial/uart_nrfx_uart.c

drivers/serial/uart_nrfx_uarte.c

drivers/serial/uart_nrfx_uart.c

dts/bindings/serial/nordic,nrf-uart-common.yaml

drivers/serial/uart_nrfx_uarte.c

drivers/serial/uart_nrfx_uart.c

drivers/serial/uart_nrfx_uarte.c

dts/bindings/pinctrl/nordic,nrf-pinctrl.yaml

dts/bindings/serial/nordic,nrf-uart-common.yaml

mbolivar-nordic · 2021-11-18T15:22:52Z

boards/arm/96b_carbon_nrf51/96b_carbon_nrf51-pinctrl.dtsi

Did we ever settle on the above style versus this one?

psels = <NRF_PSEL(UART_TX, 0, 29) NRF_PSEL(UART_RX, 0, 11)>;

I seem to recall @carlescufi had an opinion on this, but I can't remember what it was.

I think nothing was agreed, but Linux seems to use

psels = <NRF_PSEL(UART_TX, 0, 29)>, <NRF_PSEL(UART_RX, 0, 11)>;

Just to be clear since I am going on vacation, I don't care personally. I just wanted to bring it up.

doc/guides/pinctrl/index.rst

dts/bindings/pinctrl/nordic,nrf-pinctrl.yaml

include/dt-bindings/pinctrl/nrf-pinctrl.h

joerchan · 2021-11-19T17:10:44Z

@gmarull Can this be used so that the application core can get the GPIO pins assigned to the network on nrf53?
The application core needs to know these pins because it has to grant the network core access to these pins. At the moment the UART pins are now hardcoded instead of from the device tree.
https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/arm/nrf5340dk_nrf5340/nrf5340_cpunet_reset.c#L17

This becomes more complex when TFM is enabled since the MCU selection has to be done in the secure processing environment.

mbolivar-nordic

I would like to see 8e64dd0#r752354973 resolved at some point, but I don't consider it a blocker and it could be fixed in a follow-up PR.

I'm going on vacation so I'm going to approve this as from my perspective it looks great.

mbolivar-nordic · 2021-11-20T00:15:30Z

@gmarull Can this be used so that the application core can get the GPIO pins assigned to the network on nrf53?

This idea came from me, just for context (so if it's a bad one, please don't blame @joerchan 😉 ). I was thinking maybe dynamic pin control could be used for this purpose from the board files. That would potentially let us put the pinctrl nodes into BOARD.dts and let the user override them.

joerchan · 2021-11-22T16:22:30Z

The problem is really about getting the PIN assignment from the network core. For unique use-cases like MPSL FEM this is not so difficult, as the same DTS node can be included in both cores without issue. (for more context see here: #40513 (comment)).
The problem with UART0 is that there is a node for it in both cores.
Just a quick look it looks like it might be easier to group the pin assignments here, but put them under a different node, like net-uart0 for example.

Sorry if I'm causing noise in this PR. We can start a discussion about this in another place.

Add initial support for nRF pin controller driver. The implementation in this patch does not yet support any peripheral. Only states representation and basic driver functionality is introduced. Note: The nrf_pin_configure function has been marked as __unused since it may not be used in certain scenarios until all peripherals are supported by the pinctrl driver. For example, if only UART/E is supported but the board does not enable UART, the function will never get called. However, that board will likely have other peripherals that will gain support in the future. Thanks to Marti Bolivar for bindings documentation. Co-authored-by: Marti Bolivar <[email protected]> Signed-off-by: Gerard Marull-Paretas <[email protected]>

Add support for configuring UART/UARTE peripheral pins. Co-authored-by: Andrzej Głąbek <[email protected]> Signed-off-by: Gerard Marull-Paretas <[email protected]>

This patch adds support for the new pinctrl API to the UARTE driver. The old pin property based solution is still kept so that users have time to transition to the new model. Notes: - Some build assertions cannot be performed since the driver does not have direct access to pin settings anymore. As a result user will not be notified if HWFC is enabled but RTS/CTS pins are not configured. - Hardware flow control can be enabled regardless of pin configuration, it is now up to the user to configure RTS/CTS pins in DT. - Some RX enable checks that were performed using pin information has been replaced with a DT property that informs if RX is enabled or not. Signed-off-by: Gerard Marull-Paretas <[email protected]>

This patch adds support for the new pinctrl API to the UART driver. The old pin property based solution is still kept so that users have time to transition to the new model. Notes: - A new property to disable RX has been introduced: disable-rx. It is no longer possible to do it automatically depending on pin information, since it's not available when using pinctrl. Signed-off-by: Gerard Marull-Paretas <[email protected]>

This script can be used to automatically migrate the Devicetree files of nRF-based boards using the old <signal>-pin properties to select peripheral pins. The script will parse a board Devicetree file and will first adjust that file by removing old pin-related properties replacing them with pinctrl states. A board-pinctrl.dtsi file will be generated containing the configuration for all pinctrl states. Note that script will also work on files that have been partially ported. Signed-off-by: Gerard Marull-Paretas <[email protected]>

Add a unit test that allows to validate if pin control configuration stored in Devicetree is parsed correctly. nRF boards used to run this test should add the pinctrl:nrf tag. Signed-off-by: Gerard Marull-Paretas <[email protected]>

Make nrfx GPIO driver part of the PRE_KERNEL_1 initialization stage. As a result, the GPIO driver can now be initialized before UART if required, a device that is also initialized during PRE_KERNEL_1. Signed-off-by: Gerard Marull-Paretas <[email protected]>

Add a sample that shows how dynamic pin control can be useful to remap a peripheral to a different set of pins. NOTE: default pin configuration is provided for the nRF52840-DK board. Such configuration will be removed once all nRF-based boards are ported to pinctrl. Thanks to Francesco for documentation suggestions. Co-authored-by: Francesco D. Servidio <[email protected]> Signed-off-by: Gerard Marull-Paretas <[email protected]>

Since the addition of pinctrl the common folder is added to the Zephyr include path. This can be re-used to place the soc_nrf_common.h header in the common folder and include it directly, without the need of relative paths. Signed-off-by: Gerard Marull-Paretas <[email protected]>

carlescufi

Thank you for all the effort put into this PR.

github-actions bot added area: Boards area: Devicetree labels Oct 14, 2021

gmarull mentioned this pull request Oct 14, 2021

drivers: pinctrl: new state based API proposal #37572

Merged

gmarull requested review from anangl, carlescufi, mbolivar-nordic, nika-nordic and nordic-krch October 14, 2021 11:09

gmarull force-pushed the pinctrl-nrf branch 2 times, most recently from 15d8806 to 4229b35 Compare October 26, 2021 08:03

carlescufi mentioned this pull request Oct 26, 2021

Road from pinmux to pinctrl #39740

Closed

29 tasks

gmarull force-pushed the pinctrl-nrf branch from 4229b35 to c513998 Compare November 3, 2021 15:38

anangl reviewed Nov 10, 2021

View reviewed changes

drivers/pinctrl/pinctrl_nrf.c Outdated Show resolved Hide resolved

include/dt-bindings/pinctrl/nrf-pinctrl.h Outdated Show resolved Hide resolved

gmarull force-pushed the pinctrl-nrf branch from c513998 to 20becbf Compare November 10, 2021 14:12

gmarull requested a review from anangl November 10, 2021 14:13

gmarull commented Nov 10, 2021

View reviewed changes

boards/arm/96b_carbon_nrf51/96b_carbon_nrf51-pinctrl.dtsi Outdated Show resolved Hide resolved

mbolivar-nordic reviewed Nov 12, 2021

View reviewed changes

gmarull force-pushed the pinctrl-nrf branch 3 times, most recently from 77dc566 to e124ffc Compare November 12, 2021 14:39

mbolivar-nordic reviewed Nov 12, 2021

View reviewed changes

dts/bindings/pinctrl/nordic,nrf-pinctrl.yaml Outdated Show resolved Hide resolved

tests/drivers/pinctrl/nrf/boards/nrf52840dk_nrf52840.overlay Outdated Show resolved Hide resolved

gmarull force-pushed the pinctrl-nrf branch 2 times, most recently from d101181 to 8e5fc9e Compare November 15, 2021 10:27

anangl reviewed Nov 15, 2021

View reviewed changes

gmarull force-pushed the pinctrl-nrf branch 3 times, most recently from cbccaed to 67f3ba1 Compare November 15, 2021 11:54

anangl reviewed Nov 15, 2021

View reviewed changes

gmarull force-pushed the pinctrl-nrf branch from 67f3ba1 to e874be0 Compare November 15, 2021 13:25

gmarull requested a review from anangl November 15, 2021 13:27

gmarull force-pushed the pinctrl-nrf branch from 4b61aa5 to 41bbefb Compare November 18, 2021 12:49

gmarull requested a review from anangl November 18, 2021 13:05

anangl approved these changes Nov 18, 2021

View reviewed changes

mbolivar-nordic reviewed Nov 18, 2021

View reviewed changes

gmarull force-pushed the pinctrl-nrf branch 2 times, most recently from 2949a29 to 4d3bad0 Compare November 18, 2021 16:52

gmarull requested a review from mbolivar-nordic November 18, 2021 16:53

mbolivar-nordic approved these changes Nov 20, 2021

View reviewed changes

gmarull force-pushed the pinctrl-nrf branch from 4d3bad0 to 0a07587 Compare November 24, 2021 18:48

gmarull and others added 9 commits November 26, 2021 11:44

drivers: pinctrl: nrf: add support for uart/uarte peripheral

bf68e12

Add support for configuring UART/UARTE peripheral pins. Co-authored-by: Andrzej Głąbek <[email protected]> Signed-off-by: Gerard Marull-Paretas <[email protected]>

gmarull force-pushed the pinctrl-nrf branch from 0a07587 to feb5205 Compare November 26, 2021 10:54

github-actions bot added area: API Changes to public APIs area: Devicetree Binding PR modifies or adds a Device Tree binding area: Documentation area: Samples Samples labels Nov 26, 2021

carlescufi approved these changes Nov 26, 2021

View reviewed changes

carlescufi merged commit a8c9347 into zephyrproject-rtos:main Nov 26, 2021

gmarull mentioned this pull request Nov 29, 2021

boards: Add support for the raspberrypi pico #34835

Merged

gmarull deleted the pinctrl-nrf branch April 24, 2023 09:24

pinctrl: add nrf implementation #39429

pinctrl: add nrf implementation #39429

Uh oh!

Conversation

gmarull commented Oct 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mbolivar-nordic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mbolivar-nordic Nov 18, 2021

Choose a reason for hiding this comment

Uh oh!

gmarull Nov 18, 2021

Choose a reason for hiding this comment

Uh oh!

mbolivar-nordic Nov 20, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

joerchan commented Nov 19, 2021

Uh oh!

mbolivar-nordic left a comment

Choose a reason for hiding this comment

Uh oh!

mbolivar-nordic commented Nov 20, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

joerchan commented Nov 22, 2021

Uh oh!

carlescufi left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

gmarull commented Oct 14, 2021 •

edited

Loading

mbolivar-nordic commented Nov 20, 2021 •

edited

Loading