From: Matthias Kaehlcke <mka@chromium.org>
To: Rob Herring <robh+dt@kernel.org>, Mark Rutland <mark.rutland@arm.com>
Cc: devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
Brian Norris <briannorris@chromium.org>,
Matthias Kaehlcke <mka@chromium.org>
Subject: [PATCH] dt-bindings: Add bindings for aliases node
Date: Tue, 25 Sep 2018 14:02:55 -0700 [thread overview]
Message-ID: <20180925210255.172734-1-mka@chromium.org> (raw)
Add a global binding for the 'aliases' node. This includes an initial list
of standardized alias names for some hardware components that are commonly
found in 'aliases'.
Signed-off-by: Matthias Kaehlcke <mka@chromium.org>
---
Documentation/devicetree/bindings/aliases.txt | 47 +++++++++++++++++++
1 file changed, 47 insertions(+)
create mode 100644 Documentation/devicetree/bindings/aliases.txt
diff --git a/Documentation/devicetree/bindings/aliases.txt b/Documentation/devicetree/bindings/aliases.txt
new file mode 100644
index 000000000000..d64ed1c7eb34
--- /dev/null
+++ b/Documentation/devicetree/bindings/aliases.txt
@@ -0,0 +1,47 @@
+The aliases node
+----------------
+
+The aliases node contains properties that represent aliases to device tree
+nodes. The name of the property is the alias name, the value is the path of
+a the device tree node that corresponds to the alias. The path may be
+specified as a string or a phandle.
+
+Alias names are often suffixed with a numeric ID, especially when there may
+be multiple instances of the same type. The ID typically corresponds to the
+hardware layout, it may also be used by drivers for a stable mapping of
+device names and hardware entities.
+
+Alias names
+-----------
+
+The devicetree specification doesn't require the use of specific alias
+names to refer to hardware entities of a given type, however the Linux
+kernel aims for a certain level of consistency.
+
+The following standardized alias names shall be used for their
+corresponding hardware components:
+
+ bluetoothN Bluetooth controller
+ ethernetN Ethernet interface
+ gpioN GPIO controller
+ i2cN i2c bus
+ mmcN MMC bus
+ rtcN Real time clock
+ serialN UART port
+ spiN SPI bus
+ wifiN Wireless network interface
+
+The above list is not exhaustive and will be extended over time. Please
+send patches to devicetree@vger.kernel.org if you think a hardware
+component and its alias name should be on the list.
+
+Example
+-------
+
+aliases {
+ bluetooth0 = "/soc/serial@fdf01000/bluetooth";
+ rtc0 = &rtc0;
+ wifi0 = &wlcore;
+};
+
+(based on arch/arm64/boot/dts/hisilicon/hi3660-hikey960.dts)
--
2.19.0.605.g01d371f741-goog
next reply other threads:[~2018-09-25 21:03 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-09-25 21:02 Matthias Kaehlcke [this message]
2018-10-09 1:07 ` [PATCH] dt-bindings: Add bindings for aliases node Brian Norris
2018-10-09 7:22 ` Geert Uytterhoeven
2018-10-09 18:31 ` Brian Norris
2018-10-12 0:08 ` Matthias Kaehlcke
2018-10-12 16:31 ` Christian Lamparter
2018-10-15 18:00 ` Rob Herring
2018-10-09 5:57 ` Stephen Boyd
2018-10-11 23:50 ` Matthias Kaehlcke
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180925210255.172734-1-mka@chromium.org \
--to=mka@chromium.org \
--cc=briannorris@chromium.org \
--cc=devicetree@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mark.rutland@arm.com \
--cc=robh+dt@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).