[PATCH v9 -next 00/12] Add support for RaspberryPi RP1 PCI device using a DT overlay

Andrea della Porta
2025-04-22T18:52:04Z

RP1 is an MFD chipset that acts as a south-bridge PCIe endpoint sporting
a pletora of subdevices (i.e. Ethernet, USB host controller, I2C, PWM,
etc.) whose registers are all reachable starting from an offset from the
BAR address. The main point here is that while the RP1 as an endpoint
itself is discoverable via usual PCI enumeraiton, the devices it contains
are not discoverable and must be declared e.g. via the devicetree.

This patchset is an attempt to provide a minimum infrastructure to allow
the RP1 chipset to be discovered and perpherals it contains to be added
from a devictree overlay loaded during RP1 PCI endpoint enumeration. To
ensure compatibility with downstream, a devicetree already comprising the
RP1 node is also provided, so it's not strictly necessary to use the
dynamically loaded overlay if the devicetree is already fully defined at
the origin.
To achieve this modularity, the RP1 node DT definitions are arranged by
file inclusion as per following schema (the arrow points to the includer,
see also [9]):

rp1-pci.dtso rp1.dtso
^ ^
| |
rp1-common.dtsi ----> rp1-nexus.dtsi ----> bcm2712-rpi-5-b.dts
^
|
bcm2712-rpi-5-b-ovl-rp1.dts

Followup patches should add support for the several peripherals contained
in RP1.

This work is based upon dowstream drivers code and the proposal from RH
et al. (see [1] and [2]). A similar approach is also pursued in [3].

The patches are ordered as follows:

-PATCHES 1 to 3: add binding schemas for clock, gpio and RP1 peripherals.
They are needed to support the other peripherals, e.g. the ethernet mac
depends on a clock generated by RP1 and the phy is reset through the
on-board gpio controller.

-PATCH 4 and 5: add clock and gpio device drivers.

-PATCH 6: the devicetree node describing the RP1 chipset. Please
note that this patch should be taken by the same maintainer that will
also take patch 8, since the definition it contains is possibly used
by the dtso compiled in as binary blob and is closely coupled to the
driver.

-PATCH 7: this is the main patch to support RP1 chipset. It can work
either with a fully defined devicetree (i.e. one that already included
the rp1 node since boot time) or with a runtime loaded dtb overlay
which is linked as binary blob in the driver obj. This duality is
useful to comply with both downstream and upstream needs (see [9]).
The real dtso is in devicetree folder while the dtso in driver folder is
just a placeholder to include the real dtso.
In this way it is possible to check the dtso against dt-bindings.
The reason why drivers/misc has been selected as containing folder
for this driver can be seen in [6], [7] and [8].

-PATCH 8: add the external clock node (used by RP1) to the main dts.

-PATCH 9: the fully fledged devictree containing also the rp1 node.
This devicetree is functionally similar to the one downstream is using.

-PATCH 10 (OPTIONAL): this patch introduces a new scenario about how
the rp1 node is specified and loaded in DT. On top of the base DT
(without rp1 node), the fw loads this overlay and the end result is
the same devicetree as in patch 9, which is then passed to the next
stage (either the kernel or u-boot/bootloader).
While this patch is not strictly necessary and can therefore be dropped
(see [10]), it's not introducing much extra work and maybe can come
in handy while debugging.

-PATCH 11: add the relevant kernel CONFIG_ options to defconfig.

-PATCH 12: enable CONFIG_OF_OVERLAY in order for 'make defconfig'
to produce a configuration valid for the RP1 driver. Without this
patch, the user has to explicitly enable it since the misc driver
depends on OF_OVERLAY.

This patchset is also a first attempt to be more agnostic wrt hardware
description standards such as OF devicetree and ACPI, where 'agnostic'
means "using DT in coexistence with ACPI", as been already promoted
by e.g. AL (see [4]). Although there's currently no evidence it will also
run out of the box on purely ACPI system, it is a first step towards
that direction.

Many thanks,
Andrea della Porta

Links:
- [1]: https://lpc.events/event/17/contributions/1421/attachments/1337/2680/LPC2023%20Non-discoverable%20devices%20in%20PCI.pdf
- [2]: https://lore.kernel.org/lkml/20230419231155.GA899497-robh@kernel.org/t/
- [3]: https://lore.kernel.org/all/20240808154658.247873-1-herve.codina@bootlin.com/#t
- [4]: https://lore.kernel.org/all/73e05c77-6d53-4aae-95ac-415456ff0ae4@lunn.ch/
- [5]: https://lore.kernel.org/all/20240626104544.14233-1-svarbanov@suse.de/
- [6]: https://lore.kernel.org/all/20240612140208.GC1504919@google.com/
- [7]: https://lore.kernel.org/all/83f7fa09-d0e6-4f36-a27d-cee08979be2a@app.fastmail.com/
- [8]: https://lore.kernel.org/all/2024081356-mutable-everyday-6f9d@gregkh/
- [9]: https://lore.kernel.org/all/Z87wTfChRC5Ruwc0@apocalypse/
- [10]: https://lore.kernel.org/all/CAMEGJJ0f4YUgdWBhxvQ_dquZHztve9KO7pvQjoDWJ3=zd3cgcg@mail.gmail.com/#t

CHANGES IN V9

PATCH RELATED -------------------------------------------------

- Rebased on next-20250422 to avoid errors while compiling the DTBs
against v6.15-rcX.

- Dropped patch 3 from V8 ("Add common schema for devices accessible
through PCI BARs") because it's already accepted in upstream tree.
The cover letter has been adjusted accordingly.

- Patch 6: Style change: added a blank line in the commit comment.

- Patch 7: Added: Acked-by: Bjorn Helgaas <bhelgaas@google.com> # quirks.c, pci_ids.h

- Patch 9 and 10: added 'broadcom' to the subject.

- Current patch 9 is now in front of every other dts related patches
since it's functionally required for later patches to work.

- Patch 12: Added: Reviewed-by: Stefan Wahren <wahrenst@gmx.net>

BINDINGS ------------------------------------------------------

- File renaming: bcm2712-rpi-5-b.dts is now the fully populated board dts
(i.e. the one that includes rp1 node), while the overlay-ready
one is now bcm2712-rpi-5-b-ovl-rp1.dts.

- bcm2712-rpi-5-b.dts: Added an explanatory comment about the usage
of this file.

RP1 CLOCK DRIVER ------------------------------------

- Implemented the delay needed to ensure the pll vco is stable (was
a TODO comment).

RP1 MISC DRIVER -----------------------------------

- rp1_pci.c: Capitalized any IRQ occurrences in message strings.

Andrea della Porta (12):
dt-bindings: clock: Add RaspberryPi RP1 clock bindings
dt-bindings: pinctrl: Add RaspberryPi RP1 gpio/pinctrl/pinmux bindings
dt-bindings: misc: Add device specific bindings for RaspberryPi RP1
clk: rp1: Add support for clocks provided by RP1
pinctrl: rp1: Implement RaspberryPi RP1 gpio support
arm64: dts: rp1: Add support for RaspberryPi's RP1 device
misc: rp1: RaspberryPi RP1 misc driver
arm64: dts: bcm2712: Add external clock for RP1 chipset on Rpi5
arm64: dts: broadcom: Add board DTS for Rpi5 which includes RP1 node
arm64: dts: broadcom: Add overlay for RP1 device
arm64: defconfig: Enable RP1 misc/clock/gpio drivers
arm64: defconfig: Enable OF_OVERLAY option

.../clock/raspberrypi,rp1-clocks.yaml | 58 +
.../devicetree/bindings/misc/pci1de4,1.yaml | 137 ++
.../pinctrl/raspberrypi,rp1-gpio.yaml | 198 +++
MAINTAINERS | 8 +
arch/arm64/boot/dts/broadcom/Makefile | 4 +-
.../dts/broadcom/bcm2712-rpi-5-b-ovl-rp1.dts | 121 ++
.../boot/dts/broadcom/bcm2712-rpi-5-b.dts | 117 +-
arch/arm64/boot/dts/broadcom/rp1-common.dtsi | 42 +
arch/arm64/boot/dts/broadcom/rp1-nexus.dtsi | 14 +
arch/arm64/boot/dts/broadcom/rp1.dtso | 11 +
arch/arm64/configs/defconfig | 4 +
drivers/clk/Kconfig | 9 +
drivers/clk/Makefile | 1 +
drivers/clk/clk-rp1.c | 1510 +++++++++++++++++
drivers/misc/Kconfig | 1 +
drivers/misc/Makefile | 1 +
drivers/misc/rp1/Kconfig | 20 +
drivers/misc/rp1/Makefile | 3 +
drivers/misc/rp1/rp1-pci.dtso | 25 +
drivers/misc/rp1/rp1_pci.c | 333 ++++
drivers/pci/quirks.c | 1 +
drivers/pinctrl/Kconfig | 11 +
drivers/pinctrl/Makefile | 1 +
drivers/pinctrl/pinctrl-rp1.c | 790 +++++++++
.../clock/raspberrypi,rp1-clocks.h | 61 +
include/linux/pci_ids.h | 3 +
26 files changed, 3376 insertions(+), 108 deletions(-)
create mode 100644 Documentation/devicetree/bindings/clock/raspberrypi,rp1-clocks.yaml
create mode 100644 Documentation/devicetree/bindings/misc/pci1de4,1.yaml
create mode 100644 Documentation/devicetree/bindings/pinctrl/raspberrypi,rp1-gpio.yaml
create mode 100644 arch/arm64/boot/dts/broadcom/bcm2712-rpi-5-b-ovl-rp1.dts
create mode 100644 arch/arm64/boot/dts/broadcom/rp1-common.dtsi
create mode 100644 arch/arm64/boot/dts/broadcom/rp1-nexus.dtsi
create mode 100644 arch/arm64/boot/dts/broadcom/rp1.dtso
create mode 100644 drivers/clk/clk-rp1.c
create mode 100644 drivers/misc/rp1/Kconfig
create mode 100644 drivers/misc/rp1/Makefile
create mode 100644 drivers/misc/rp1/rp1-pci.dtso
create mode 100644 drivers/misc/rp1/rp1_pci.c
create mode 100644 drivers/pinctrl/pinctrl-rp1.c
create mode 100644 include/dt-bindings/clock/raspberrypi,rp1-clocks.h

--
2.35.3