b0568ad592
Provide generic yaml description for i2c-devices such as sensors New yaml binding category 'parent/child' is added. It aims at binding two types of related node such as bus master and bus slave. In case of i2c-device object, parent property is 'bus' with value 'i2c'. In the mean time, i2c node gets child property bus. Master and slave bus values should match. As such, 'i2c' node is bus master and 'i2c-devices' nodes are bus slaves Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
61 lines
1.8 KiB
Plaintext
61 lines
1.8 KiB
Plaintext
---
|
|
title: <Title should describe what node you are describing>
|
|
version: 0.1
|
|
|
|
description: >
|
|
Describe in free form text w/ spanning lines what you
|
|
are describing
|
|
|
|
|
|
< parent | child >:
|
|
# parent/child is used to document implicit relation between nodes.
|
|
# This information is required to generate parent related bits in child
|
|
# attributes.
|
|
# In case parent has 'bus', slave inherits some information from master.
|
|
# parent and child should share same bus-type value.
|
|
bus: <bus-type>
|
|
|
|
# properties will be the contents of the device tree node
|
|
# property names must match the property names in the DT
|
|
|
|
properties:
|
|
|
|
# A typical property entry will look like the following
|
|
# <name of property as it is in device tree>
|
|
# category: <required | optional>
|
|
# type: <string | int | array>
|
|
# description: <description of property>
|
|
# generation: <define | structure>
|
|
|
|
# At a minimum, the compatible is required for matching nodes
|
|
compatible: <list of string compatible matches>
|
|
category: required
|
|
type: string
|
|
description: compatible of node
|
|
|
|
# reg is used to denote mmio registers
|
|
reg:
|
|
type: array
|
|
description: mmio register space
|
|
generation: define
|
|
category: required
|
|
|
|
# interrupts specifies the interrupts that the driver may utilize
|
|
interrupts:
|
|
type: array
|
|
category: required
|
|
description: required interrupts
|
|
generation: define
|
|
|
|
# If a node is a interrupt controller, gpio controller, pinmux device
|
|
# or any device which is referenced via phandle plus some number of cells
|
|
# then the cell fiels below must be present.
|
|
cell_string: <cell string prefix>
|
|
|
|
"#cells":
|
|
- cell0 # name of first cell
|
|
- cell1 # name of second cell
|
|
- cell2 # name of third cell
|
|
- and so on and so forth
|
|
...
|