Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
To:     Mark Rutland <mark.rutland@arm.com>,
        Matthias Kaehlcke <mka@chromium.org>,
        Rob Herring <robh+dt@kernel.org>
From:   Stephen Boyd <swboyd@chromium.org>
In-Reply-To: <20180925210255.172734-1-mka@chromium.org>
Cc:     devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
        Brian Norris <briannorris@chromium.org>,
        Matthias Kaehlcke <mka@chromium.org>
References: <20180925210255.172734-1-mka@chromium.org>
Message-ID: <153906464468.119890.12038987094612660933@swboyd.mtv.corp.google.com>
User-Agent: alot/0.7
Subject: Re: [PATCH] dt-bindings: Add bindings for aliases node
Date:   Mon, 08 Oct 2018 22:57:24 -0700
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

Quoting Matthias Kaehlcke (2018-09-25 14:02:55)
> 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 +++++++++++++++++++

Any chance we can get a documentation update for the devicetree spec as
well?

>  1 file changed, 47 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/aliases.txt
> =

> diff --git a/Documentation/devicetree/bindings/aliases.txt b/Documentatio=
n/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 tr=
ee
> +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

s/a //

> +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.

Indicate the numeric ID is a u32 or something like that?

> +
> +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

Can we use syntax like:

	bluetooth<N>

to indicate that <N> is an unsigned integer?

> +  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.
> +