Device Tree Linux

Top Device Tree page

Device Tree Framework Source Code
The device tree framework source code is located in drivers/of/.

Code for manipulating the flattened device tree (FDT) is is scripts/dtc/libfdt.

libfdt is imported from the external project maintained in
 * https://git.kernel.org/cgit/utils/dtc/dtc.git
 * git clone git://git.kernel.org/pub/scm/utils/dtc/dtc.git

Linux Man pages
Linux man pages are a work in progress.

The current version of the pages can be downloaded or built locally.

Compiling dts source file
This is an example of compiling arch/arm/boot/dts/qcom-msm8960-cdp.dts

The make target is the name of the .dts file, with ".dts" changed to ".dtb".


 * Check that the config option that enables the dtb is set

arch/arm/boot/dts/Makefile: dtb-$(CONFIG_ARCH_QCOM) += \ ...        qcom-msm8960-cdp.dtb \ ...

$ grep CONFIG_ARCH_QCOM .config CONFIG_ARCH_QCOM=y


 * specify the correct architecture in the make command (or export the ARCH)

export ARCH="arm" make qcom-msm8960-cdp.dtb ARCH="arm" make qcom-msm8960-cdp.dtb

node name case sensitivity
Node names are supposed to be case sensitive. The function that checks whether a node name matches a string may be defined by an architecture or may be the generic implementation. Due to some issues with old Macs the generic implementation was case insensitive. There is an architecture defined version that is not case sensitive.

Expect this to change so that the generic node name compare function is case sensitive, and only a few select sub-architectures will not be case sensitive.

disabled nodes
Linux has widespread use of the "status" property to indicate that a node does not exist. This is used to create a generic .dtsi file that defines all of the potential components of a device which might contain many different functions. When the device is used in a system, many of the functions might not be routed to connectors or might not be usable due to needing pins that are multiplexed with other devices that are active. The convention is to set the "status" property of such functions to "disabled" in the .dtsi file, then the system .dts file that includes the .dtsi will change the "status" property of functions that should be enabled to "ok".

Some kernel code does not check the node "status" property before trying to configure, probe, or enable it.

Expect efforts to fix the kernel code to respect the "status" property.

Linux conventions

 * hex constants are lower case
 * use "0x" instead of "0X"
 * use a..f instead of A..F, eg 0xf instead of 0xF


 * node names
 * use "-" instead of "_"
 * unit-address does not have a leading "0x" (the number is assumed to be hexadecimal)
 * unit-address does not have a leading zeros
 * should begin with a character in the range 'a' to 'z', 'A' to 'Z'


 * property names
 * should be lower case
 * should begin with a character in the range 'a' to 'z'


 * maximum depth of device tree
 * #define FDT_MAX_DEPTH  64

Linux Preferences
Items in this section may be less firm or certain than items in "Linux Conventions".

If you can document or explain why any item should move to "Linux Conventions" please email frowand.list at gmail.com".

cpp
The Linux kernel build system preprocesses dts files with cpp before passing them to dtc. The dtc compileralso has an "/include/" directive.

Complex example 1
 * Files that are included via the "/include/" directive can not contain any cpp directives. This is because such files are not visible to cpp.
 * Although cpp can do conditional inclusion with features such as "#if" and "#ifdef" this is frowned upon.
 * Common use of cpp is for "#include" and simple "#defines" for symbolic names.
 * Bindings related include files are in include/dt-bindings/
 * More complex macros do exist, but are rare.

include/dt-bindings/pinctrl/omap.h:
 * 1) define OMAP_IOPAD_OFFSET(pa, offset)  (((pa) & 0xffff) - (offset))


 * 1) define OMAP2420_CORE_IOPAD(pa, val)   OMAP_IOPAD_OFFSET((pa), 0x0030) (val)

Complex example 2

include/dt-bindings/input/input.h:

((((row) & 0xFF) << 24) | (((col) & 0xFF) << 16) | ((code) & 0xFFFF))
 * 1) define MATRIX_KEY(row, col, code)     \

interrupts vs interrupts-extended
Should I use 1) the "interrupts" property in association with the "interrupt-parent" property or 2) the "interrupts-extended" property?

"Interrupts" is well understood and commonly used. It is ok to use that model.

The main purpose of "interrupts-extended" is to allow one device to have multiple interrupts that are handled by different controllers, without introducing a (more complex) "interrupt-map" property in the parent.

names
--- ePAPR

2.2.1 Node Names The node name follows the convention: node-name@unit-address Characters in node-name may be: 0-9        a-z A-Z ,._+-

--- Linux

dtc allows characters in node-name to be: 0-9     a-z A-Z ,._+-     *#? ---  ePAPR

2.2.4.1 Property Names Characters in the property name may be: 0-9        a-z A-Z ,._+-

--- Linux

dtc allows characters in property name to be: 0-9     a-z A-Z ,._+-     *#? ---  ePAPR

No information on characters in label names. --- Linux

dtc allows characters in label name to be: 0-9     a-z A-Z _  The label name may not begin with 0-9

status property
--- ePAPR

2.3.4 status Valid values for status are: "okay", "disabled", "fail", "fail-sss". "Refer to the device binding for details on what disabled means for     a given device."

3.7.1 General Properties of CPU nodes Valid values for status are: "okay", "disabled".

--- Linux

A node is enabled if: status == "ok" status == "okay" status property does not exist Convention for disabling a node: status == "disabled" Not all code checks whether a node is disabled. These cases are bugs.

#address-cells and #size-cells
--- ePAPR

2.3.5 #address-cells and #size-cells "The #address-cells and #size-cells properties are not     inherited from ancestors in the device tree. They shall be      explicitly defined."

--- Linux

#address-cells defaults to 2 #size-cells defaults to 1 dtc may warn that the default is being used.

"ABI" stability
Are device tree bindings stable?

Well.... Let me put this open jar full of gasoline on the floor and step away for a little while. Oh, can I loan you a lighter or a book of matches?


 * See slides 8 and following from the Grant Likely presentation at the Kernel Summit 2013 discussion: [[Media:DT_Binding_Process_glikely_ksummit_2013_10_28.pdf | It's Broken! Fixing the DT binding process (PDF)]]


 * Email thread: DT bindings as ABI [was: Do we have people interested in device tree janitoring / cleanup?]


 * [[Media:The_Device_Tree_as_a_Stable_ABI-_A_Fairy_Tale?.pdf | "The Device Tree as a Stable ABI: A Fairy Tale?", ELC 2015 by Thomas Petazzoni (PDF)]]

Bindings review process
devicetree/bindings/submitting-patches.txt was created following discussion at the 2013 Kernel Summit.

Email thread: [Ksummit-2013-discuss] [ATTEND] Handling of devicetree bindings

The slides that Grant Likely presented at the Kernel Summit discussion were in an email attachment that the mail list stripped. Here are the slides: [[Media:DT_Binding_Process_glikely_ksummit_2013_10_28.pdf | It's Broken! Fixing the DT binding process (PDF)]]

Slides 18 and 19 of [[Media:Rutland-presentation_3.pdf | [PDF] ]] "Device Tree, the Disaster so Far", ELC Europe 2013 by Mark Rutland.

Support of different hardware versions in a single driver
Examples of drivers that match more than one compatible string.

This list is not an endorsement of any particular technique. It is instead a (partial) list of some existing code in the Linux kernel.

The examples are not meant to capture each method entirely; they are instead meant to illustrate the basic concept.

Hardware Version in struct of_device_id.data
The hardware version is used throughout the driver to choose alternate actions.

drivers/iommu/arm-smmu.c:

static const struct of_device_id arm_smmu_of_match[] = { { .compatible = "arm,smmu-v1", .data = (void *)ARM_SMMU_V1 }, { .compatible = "arm,smmu-v2", .data = (void *)ARM_SMMU_V2 }, { .compatible = "arm,mmu-400", .data = (void *)ARM_SMMU_V1 }, { .compatible = "arm,mmu-401", .data = (void *)ARM_SMMU_V1 }, { .compatible = "arm,mmu-500", .data = (void *)ARM_SMMU_V2 }, { }, }; MODULE_DEVICE_TABLE(of, arm_smmu_of_match); static int arm_smmu_device_dt_probe(struct platform_device *pdev) {        const struct of_device_id *of_id; of_id = of_match_node(arm_smmu_of_match, dev->of_node); smmu->version = (enum arm_smmu_arch_version)of_id->data; ...        if (smmu->version > ARM_SMMU_V1) { ...        } } static struct platform_driver arm_smmu_driver = { .driver = { .name          = "arm-smmu", .of_match_table = of_match_ptr(arm_smmu_of_match), },        .probe  = arm_smmu_device_dt_probe, .remove = arm_smmu_device_remove, };

Function Call Table pointer in struct of_device_id.data
The function call table is used throughout the driver to choose alternate actions.

drivers/iio/adc/xilinx-xadc-core.c:

static const struct xadc_ops xadc_zynq_ops = { .read = xadc_zynq_read_adc_reg, .write = xadc_zynq_write_adc_reg, .setup = xadc_zynq_setup, .get_dclk_rate = xadc_zynq_get_dclk_rate, .interrupt_handler = xadc_zynq_interrupt_handler, .threaded_interrupt_handler = xadc_zynq_threaded_interrupt_handler, .update_alarm = xadc_zynq_update_alarm, }; static const struct of_device_id xadc_of_match_table[] = { { .compatible = "xlnx,zynq-xadc-1.00.a", (void *)&xadc_zynq_ops }, { .compatible = "xlnx,axi-xadc-1.00.a", (void *)&xadc_axi_ops }, { }, }; MODULE_DEVICE_TABLE(of, xadc_of_match_table); static int xadc_probe(struct platform_device *pdev) {        const struct of_device_id *id; id = of_match_node(xadc_of_match_table, pdev->dev.of_node); ...        indio_dev = devm_iio_device_alloc(&pdev->dev, sizeof(*xadc)); xadc = iio_priv(indio_dev); ...        xadc->ops = id->data; ...        ret = xadc->ops->setup(pdev, indio_dev, irq); ... } static struct platform_driver xadc_driver = { .probe = xadc_probe, .remove = xadc_remove, .driver = { .name = "xadc", .of_match_table = xadc_of_match_table, }, }; module_platform_driver(xadc_driver);

Hardware Description pointer in struct of_device_id.data
The hardware description data is used to configure the device.

This struct pointed to by struct of_device_id.data in this example includes a function call table in addition to the hardware description fields.

drivers/iio/adc/twl6030-gpadc.c:

static const struct twl6030_gpadc_platform_data twl6030_pdata = { .iio_channels = twl6030_gpadc_iio_channels, .nchannels = TWL6030_GPADC_USED_CHANNELS, .ideal = twl6030_ideal, .start_conversion = twl6030_start_conversion, .channel_to_reg = twl6030_channel_to_reg, .calibrate = twl6030_calibration, }; static const struct of_device_id of_twl6030_match_tbl[] = { {                .compatible = "ti,twl6030-gpadc", .data = &twl6030_pdata, },        {                 .compatible = "ti,twl6032-gpadc", .data = &twl6032_pdata, },        { /* end */ } }; static int twl6030_gpadc_probe(struct platform_device *pdev) {        const struct of_device_id *match; const struct twl6030_gpadc_platform_data *pdata; match = of_match_device(of_twl6030_match_tbl, dev); pdata = match->data; indio_dev = devm_iio_device_alloc(dev, sizeof(*gpadc)); gpadc = iio_priv(indio_dev); gpadc->pdata = pdata; platform_set_drvdata(pdev, indio_dev); ...        ret = pdata->calibrate(gpadc); ...        indio_dev->channels = pdata->iio_channels; indio_dev->num_channels = pdata->nchannels; }