File Manager

003 File Manager

Current Path: /usr/src/sys/contrib/device-tree/Bindings

usr / src / sys / contrib / device-tree / Bindings /

📁 ..
📄 .gitignore(77 B)
📄 ABI.rst(1.85 KB)
📄 Makefile(2.52 KB)
📁 arc
📁 arm
📁 ata
📁 auxdisplay
📁 board
📁 bus
📁 c6x
📄 chosen.txt(3.99 KB)
📁 chrome
📁 clock
📄 common-properties.txt(2.81 KB)
📁 connector
📁 counter
📁 cpu
📁 cpufreq
📁 crypto
📁 csky
📁 ddr
📁 devfreq
📁 display
📁 dma
📁 dsp
📁 edac
📁 eeprom
📄 example-schema.yaml(7.59 KB)
📁 extcon
📁 firmware
📁 fpga
📁 fsi
📁 fuse
📁 gnss
📁 goldfish
📁 gpio
📁 gpu
📄 graph.txt(4.04 KB)
📁 h8300
📁 hsi
📁 hwlock
📁 hwmon
📁 i2c
📁 i3c
📁 iio
📄 index.rst(153 B)
📁 infiniband
📁 input
📁 interconnect
📁 interrupt-controller
📁 iommu
📁 ipmi
📄 jailhouse.txt(284 B)
📁 leds
📁 mailbox
📁 media
📁 memory-controllers
📁 mfd
📁 mips
📁 misc
📁 mmc
📁 mtd
📁 mux
📁 nds32
📁 net
📁 nios2
📄 numa.txt(6.82 KB)
📁 nvmem
📁 openrisc
📁 opp
📁 pci
📁 perf
📁 phy
📁 pinctrl
📁 pmem
📁 power
📁 powerpc
📁 pps
📄 property-units.txt(1.23 KB)
📁 ptp
📁 pwm
📁 regmap
📁 regulator
📁 remoteproc
📁 reserved-memory
📁 reset
📄 resource-names.txt(1.44 KB)
📁 riscv
📁 rng
📁 rtc
📁 scsi
📁 security
📁 serial
📁 serio
📁 sifive
📁 siox
📁 slimbus
📁 soc
📁 sound
📁 soundwire
📁 spi
📁 spmi
📁 sram
📁 staging
📄 submitting-patches.rst(3.53 KB)
📁 thermal
📁 timer
📄 trivial-devices.yaml(16.3 KB)
📁 ufs
📄 unittest.txt(1.07 KB)
📁 usb
📄 vendor-prefixes.yaml(33.45 KB)
📁 virtio
📁 w1
📁 watchdog
📄 writing-bindings.rst(2.54 KB)
📁 x86
📄 xilinx.txt(6.52 KB)
📁 xillybus

Editing: writing-bindings.rst

.. SPDX-License-Identifier: GPL-2.0

============================================================
DOs and DON'Ts for designing and writing Devicetree bindings
============================================================

This is a list of common review feedback items focused on binding design. With
every rule, there are exceptions and bindings have many gray areas.

For guidelines related to patches, see
Documentation/devicetree/bindings/submitting-patches.rst

Overall design
==============

- DO attempt to make bindings complete even if a driver doesn't support some
  features. For example, if a device has an interrupt, then include the
  'interrupts' property even if the driver is only polled mode.

- DON'T refer to Linux or "device driver" in bindings. Bindings should be
  based on what the hardware has, not what an OS and driver currently support.

- DO use node names matching the class of the device. Many standard names are
  defined in the DT Spec. If there isn't one, consider adding it.

- DO check that the example matches the documentation especially after making
  review changes.

- DON'T create nodes just for the sake of instantiating drivers. Multi-function
  devices only need child nodes when the child nodes have their own DT
  resources. A single node can be multiple providers (e.g. clocks and resets).

- DON'T use 'syscon' alone without a specific compatible string. A 'syscon'
  hardware block should have a compatible string unique enough to infer the
  register layout of the entire block (at a minimum).

Properties
==========

- DO make 'compatible' properties specific. DON'T use wildcards in compatible
  strings. DO use fallback compatibles when devices are the same as or a subset
  of prior implementations. DO add new compatibles in case there are new
  features or bugs.

- DO use a vendor prefix on device specific property names. Consider if
  properties could be common among devices of the same class. Check other
  existing bindings for similar devices.

- DON'T redefine common properties. Just reference the definition and define
  constraints specific to the device.

- DO use common property unit suffixes for properties with scientific units.
  See property-units.txt.

- DO define properties in terms of constraints. How many entries? What are
  possible values? What is the order?

Board/SoC .dts Files
====================

- DO put all MMIO devices under a bus node and not at the top-level.

- DO use non-empty 'ranges' to limit the size of child buses/devices. 64-bit
  platforms don't need all devices to have 64-bit address and size.

003 File Manager

Editing: writing-bindings.rst

Upload File

Create Folder