Skip to content

Generate device tree node for pci devices

Lizhi Hou linux-devicetree linux-pci lkml 16 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v13 Latest5 patches 27 repliesIn review
  2. v125 patches 1 replySuperseded
  3. v115 patches 2 repliesSuperseded
Earlier versions · 13
VersionPostedPatchesRepliesStatus
v105 patches11 repliesSuperseded
v9 posting 2/25 patches9 repliesSuperseded
v9 posting 1/26 patches4 repliesSuperseded
v83 patches4 repliesSuperseded
v73 patches31 repliesSuperseded
v63 patches0 repliesSuperseded
v5 posting 2/23 patches12 repliesSuperseded
v5 posting 1/23 patches0 repliesSuperseded
v4 RFC posting 2/23 patches8 repliesSuperseded
v4 RFC posting 1/23 patches0 repliesSuperseded
v3 RFC2 patches3 repliesSuperseded
v2 RFC3 patches4 repliesSuperseded
v1 RFC2 patches34 repliesSuperseded

Changes in v13 from the cover letter

- Minor fix for kernel test robot warning

Patches in v13 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/5of: dynamic: Add interfaces for creating device node dynamicallydrivers/of/dynamic.c drivers/of/unittest.c include/linux/of.h+205 -11 reply
2/5PCI: Create device tree node for bridgedrivers/pci/Kconfig drivers/pci/Makefile drivers/pci/bus.c +4 more+462 -012 replies
3/5PCI: Add quirks to generate device tree node for Xilinx Alveo U50drivers/pci/quirks.c+11 -00 replies
4/5of: overlay: Extend of_overlay_fdt_apply() to specify the target nodedrivers/of/overlay.c drivers/of/unittest.c include/linux/of.h+34 -135 replies
5/5of: unittest: Add pci_dt_testdrv pci driverdrivers/of/unittest-data/Makefile drivers/of/unittest-data/overlay_pci_node.dtso drivers/of/unittest.c +1 more+214 -10 replies

Reviews trailers per patch

2 of 5 patches have a Reviewed-by or Acked-by.

PatchBjorn HelgaasHerve Codina
1/5
2/5A-b
3/5A-b
4/5
5/5T-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v13 thread

Cover letter [PATCH V13 0/5] Generate device tree node for pci devices

This patch series introduces OF overlay support for PCI devices which primarily addresses two use cases. First, it provides a data driven method to describe hardware peripherals that are present in a PCI endpoint and hence can be accessed by the PCI host. Second, it allows reuse of a OF compatible driver -- often used in SoC platforms -- in a PCI host based system.

There are 2 series devices rely on this patch:

1) Xilinx Alveo Accelerator cards (FPGA based device)
2) Microchip LAN9662 Ethernet Controller

     Please see: https://lore.kernel.org/lkml/[email protected]/

Normally, the PCI core discovers PCI devices and their BARs using the PCI enumeration process. However, the process does not provide a way to discover the hardware peripherals that are present in a PCI device, and which can be accessed through the PCI BARs. Also, the enumeration process does not provide a way to associate MSI-X vectors of a PCI device with the hardware peripherals that are present in the device. PCI device drivers often use header files to describe the hardware peripherals and their resources as there is no standard data driven way to do so. This patch series proposes to use flattened device tree blob to describe the peripherals in a data driven way. Based on previous discussion, using device tree overlay is the best way to unflatten the blob and populate platform devices. To use device tree overlay, there are three obvious problems that need to be resolved.

First, we need to create a base tree for non-DT system such as x86_64. A patch series has been submitted for this:
https://lore.kernel.org/lkml/[email protected]/
https://lore.kernel.org/lkml/[email protected]/

Second, a device tree node corresponding to the PCI endpoint is required for overlaying the flattened device tree blob for that PCI endpoint. Because PCI is a self-discoverable bus, a device tree node is usually not created for PCI devices. This series adds support to generate a device tree node for a PCI device which advertises itself using PCI quirks infrastructure.

Third, we need to generate device tree nodes for PCI bridges since a child PCI endpoint may choose to have a device tree node created.

This patch series is made up of three patches.

The first patch is adding OF interface to create or destroy OF node dynamically.

The second patch introduces a kernel option, CONFIG_PCI_DYNAMIC_OF_NODES. When the option is turned on, the kernel will generate device tree nodes for all PCI bridges unconditionally. The patch also shows how to use the PCI quirks infrastructure, DECLARE_PCI_FIXUP_FINAL to generate a device tree node for a device. Specifically, the patch generates a device tree node for Xilinx Alveo U50 PCIe accelerator device. The generated device tree nodes do not have any property.

The third patch adds basic properties ('reg', 'compatible' and 'device_type') to the dynamically generated device tree nodes. More properties can be added in the future.

Here is the example of device tree nodes generated within the ARM64 QEMU.

# lspci -t
-[0000:00]-+-00.0
           +-01.0
           +-03.0-[01-03]----00.0-[02-03]----00.0-[03]----00.0
           +-03.1-[04]--
           \-04.0-[05-06]----00.0-[06]--

Without CONFIG_PCI_DYNAMIC_OF_NODES

# tree /sys/firmware/devicetree/base/pcie@10000000/
/sys/firmware/devicetree/base/pcie@10000000/
|-- #address-cells
|-- #interrupt-cells
|-- #size-cells
|-- bus-range
|-- compatible
|-- device_type
|-- dma-coherent
|-- interrupt-map
|-- interrupt-map-mask
|-- linux,pci-domain
|-- msi-map
|-- name
|-- ranges
`-- reg

With CONFIG_PCI_DYNAMIC_OF_NODES

# tree /sys/firmware/devicetree/base/pcie@10000000/
/sys/firmware/devicetree/base/pcie@10000000/
|-- #address-cells
|-- #interrupt-cells
|-- #size-cells
|-- bus-range
|-- compatible
|-- device_type
|-- dma-coherent
|-- interrupt-map
|-- interrupt-map-mask
|-- linux,pci-domain
|-- msi-map
|-- name
|-- pci@3,0
|   |-- #address-cells
|   |-- #interrupt-cells
|   |-- #size-cells
|   |-- bus-range
|   |-- compatible
|   |-- device_type
|   |-- interrupt-map
|   |-- interrupt-map-mask
|   |-- interrupts
|   |-- pci@0,0
|   |   |-- #address-cells
|   |   |-- #interrupt-cells
|   |   |-- #size-cells
|   |   |-- bus-range
|   |   |-- compatible
|   |   |-- device_type
|   |   |-- interrupt-map
|   |   |-- interrupt-map-mask
|   |   |-- pci@0,0
|   |   |   |-- #address-cells
|   |   |   |-- #interrupt-cells
|   |   |   |-- #size-cells
|   |   |   |-- bus-range
|   |   |   |-- compatible
|   |   |   |-- dev@0,0
|   |   |   |   |-- #address-cells
|   |   |   |   |-- #size-cells
|   |   |   |   |-- compatible
|   |   |   |   |-- ranges
|   |   |   |   `-- reg
|   |   |   |-- device_type
|   |   |   |-- interrupt-map
|   |   |   |-- interrupt-map-mask
|   |   |   |-- ranges
|   |   |   `-- reg
|   |   |-- ranges
|   |   `-- reg
|   |-- ranges
|   `-- reg
|-- pci@3,1
|   |-- #address-cells
|   |-- #interrupt-cells
|   |-- #size-cells
|   |-- bus-range
|   |-- compatible
|   |-- device_type
|   |-- interrupt-map
|   |-- interrupt-map-mask
|   |-- interrupts
|   |-- ranges
|   `-- reg
|-- pci@4,0
|   |-- #address-cells
|   |-- #interrupt-cells
|   |-- #size-cells
|   |-- bus-range
|   |-- compatible
|   |-- device_type
|   |-- interrupt-map
|   |-- interrupt-map-mask
|   |-- pci@0,0
|   |   |-- #address-cells
|   |   |-- #interrupt-cells
|   |   |-- #size-cells
|   |   |-- bus-range
|   |   |-- compatible
|   |   |-- device_type
|   |   |-- interrupt-map
|   |   |-- interrupt-map-mask
|   |   |-- interrupts
|   |   |-- ranges
|   |   `-- reg
|   |-- ranges
|   `-- reg
|-- ranges
`-- reg

Changes since v12:
- Minor fix for kernel test robot warning

Changes since v11:
- Create interrupt related properties

Changes since v10:
- Remove 'dynamic' property

Changes since v9:
- Introduce 'dynamic' property to identify dynamically generated device tree node for PCI device
- Added 'bus-range' property to remove dtc warnings
- Minor code review fixes

Changes since v8:
- Added patches to create unit test to verifying address translation The test relies on QEMU PCI Test Device, please see
https://github.com/houlz0507/xoclv2/blob/pci-dt-0329/pci-dt-patch-0329/README
for test setup
- Minor code review fixes

Changes since v7:
- Modified dynamic node creation interfaces
- Added unittest for new added interfaces

Changes since v6:
- Removed single line wrapper functions
- Added Signed-off-by Clément Léger <[email protected]>

Changes since v5:
- Fixed code review comments
- Fixed incorrect 'ranges' and 'reg' properties

Changes since RFC v4:
- Fixed code review comments

Changes since RFC v3:
- Split the Xilinx Alveo U50 PCI quirk to a separate patch
- Minor changes in commit description and code comment

Changes since RFC v2:
- Merged patch 3 with patch 2
- Added OF interfaces of_changeset_add_prop_* and use them to create properties.
- Added '#address-cells', '#size-cells' and 'ranges' properties.

Changes since RFC v1:
- Added one patch to create basic properties.
- To move DT related code out of PCI subsystem, replaced of_node_alloc() with of_create_node()/of_destroy_node()

Lizhi Hou (5):
of: dynamic: Add interfaces for creating device node dynamically
PCI: Create device tree node for bridge
PCI: Add quirks to generate device tree node for Xilinx Alveo U50
of: overlay: Extend of_overlay_fdt_apply() to specify the target node
of: unittest: Add pci_dt_testdrv pci driver

 drivers/of/dynamic.c                          | 164 ++++++++
 drivers/of/overlay.c                          |  42 ++-
 drivers/of/unittest-data/Makefile             |   3 +-
 .../of/unittest-data/overlay_pci_node.dtso    |  22 ++
 drivers/of/unittest.c                         | 211 ++++++++++-
 drivers/pci/Kconfig                           |  12 +
 drivers/pci/Makefile                          |   1 +
 drivers/pci/bus.c                             |   2 +
 drivers/pci/of.c                              |  79 ++++
 drivers/pci/of_property.c                     | 355 ++++++++++++++++++
 drivers/pci/pci.h                             |  12 +
 drivers/pci/quirks.c                          |  12 +
 drivers/pci/remove.c                          |   1 +
 include/linux/of.h                            |  25 +-
 14 files changed, 926 insertions(+), 15 deletions(-)
 create mode 100644 drivers/of/unittest-data/overlay_pci_node.dtso
 create mode 100644 drivers/pci/of_property.c
Signature · 1 line
2.34.1