From: Samuel Holland <samuel@sholland.org>
To: Maxime Ripard <mripard@kernel.org>
Cc: Chen-Yu Tsai <wens@csie.org>,
Jassi Brar <jassisinghbrar@gmail.com>,
Michael Turquette <mturquette@baylibre.com>,
Stephen Boyd <sboyd@kernel.org>, Rob Herring <robh+dt@kernel.org>,
Mark Rutland <mark.rutland@arm.com>,
Sudeep Holla <sudeep.holla@arm.com>,
Philipp Zabel <p.zabel@pengutronix.de>,
Ondrej Jirman <megous@megous.com>,
Vasily Khoruzhick <anarsoul@gmail.com>,
devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
linux-clk@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-sunxi@googlegroups.com
Subject: Re: [PATCH v5 2/8] dt-bindings: mailbox: Add a sun6i message box binding
Date: Mon, 16 Dec 2019 13:45:08 -0600 [thread overview]
Message-ID: <d3a1c7c2-953a-cbfe-970e-c00f9a9f5742@sholland.org> (raw)
In-Reply-To: <20191216140422.on4bredklgdxywbw@gilmour.lan>
Hi,
On 12/16/19 8:04 AM, Maxime Ripard wrote:
> Hi,
>
> On Sat, Dec 14, 2019 at 10:24:49PM -0600, Samuel Holland wrote:
>> This mailbox hardware is present in Allwinner sun6i, sun8i, sun9i, and
>> sun50i SoCs. Add a device tree binding for it. As it has only been
>> tested on the A83T, A64, H3/H5, and H6 SoCs, only those compatibles are
>> included.
>>
>> Signed-off-by: Samuel Holland <samuel@sholland.org>
>> ---
>> .../mailbox/allwinner,sun6i-a31-msgbox.yaml | 78 +++++++++++++++++++
>> 1 file changed, 78 insertions(+)
>> create mode 100644 Documentation/devicetree/bindings/mailbox/allwinner,sun6i-a31-msgbox.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/mailbox/allwinner,sun6i-a31-msgbox.yaml b/Documentation/devicetree/bindings/mailbox/allwinner,sun6i-a31-msgbox.yaml
>> new file mode 100644
>> index 000000000000..dd746e07acfd
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/mailbox/allwinner,sun6i-a31-msgbox.yaml
>> @@ -0,0 +1,78 @@
>> +# SPDX-License-Identifier: GPL-2.0
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/mailbox/allwinner,sun6i-a31-msgbox.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Allwinner sunxi Message Box
>> +
>> +maintainers:
>> + - Samuel Holland <samuel@sholland.org>
>> +
>> +description: |
>> + The hardware message box on sun6i, sun8i, sun9i, and sun50i SoCs is a
>> + two-user mailbox controller containing 8 unidirectional FIFOs. An interrupt
>> + is raised for received messages, but software must poll to know when a
>> + transmitted message has been acknowledged by the remote user. Each FIFO can
>> + hold four 32-bit messages; when a FIFO is full, clients must wait before
>> + attempting more transmissions.
>> +
>> + Refer to ./mailbox.txt for generic information about mailbox device-tree
>> + bindings.
>> +
>> +properties:
>> + compatible:
>> + items:
>> + - enum:
>> + - allwinner,sun8i-a83t-msgbox
>> + - allwinner,sun8i-h3-msgbox
>> + - allwinner,sun50i-a64-msgbox
>> + - allwinner,sun50i-h6-msgbox
>> + - const: allwinner,sun6i-a31-msgbox
>
> This will fail for the A31, since it won't have two compatibles but
> just one.
You asked me earlier to only include compatibles that had been tested, so I did.
This hasn't been tested on the A31, so there's no A31-only compatible.
> You can have something like this if you want to do it with an enum:
>
> compatible:
> oneOf:
> - const: allwinner,sun6i-a31-msgbox
> - items:
> - enum:
> - allwinner,sun8i-a83t-msgbox
> - allwinner,sun8i-h3-msgbox
> - allwinner,sun50i-a64-msgbox
> - allwinner,sun50i-h6-msgbox
> - const: allwinner,sun6i-a31-msgbox
>
>> + reg:
>> + items:
>> + - description: MMIO register range
>
> There's no need for an obvious description like this.
> Just set it to maxItems: 1
Will do for v6.
>> +
>> + clocks:
>> + maxItems: 1
>> + description: bus clock
>> +
>> + resets:
>> + maxItems: 1
>> + description: bus reset
>> +
>> + interrupts:
>> + maxItems: 1
>> + description: controller interrupt
>
> Ditto, you can drop the description here.
Will do for v6.
>> + '#mbox-cells':
>> + const: 1
>
> However, you should document what the argument is about?
Ok. "Number of cells used to encode a mailbox specifier" should work.
>> +required:
>> + - compatible
>> + - reg
>> + - clocks
>> + - resets
>> + - interrupts
>> + - '#mbox-cells'
>> +
>> +additionalProperties: false
>> +
>> +examples:
>> + - |
>> + #include <dt-bindings/clock/sun8i-h3-ccu.h>
>> + #include <dt-bindings/interrupt-controller/arm-gic.h>
>> + #include <dt-bindings/reset/sun8i-h3-ccu.h>
>> +
>> + msgbox: mailbox@1c17000 {
>> + compatible = "allwinner,sun8i-h3-msgbox",
>> + "allwinner,sun6i-a31-msgbox";
>> + reg = <0x01c17000 0x1000>;
>> + clocks = <&ccu CLK_BUS_MSGBOX>;
>> + resets = <&ccu RST_BUS_MSGBOX>;
>> + interrupts = <GIC_SPI 49 IRQ_TYPE_LEVEL_HIGH>;
>> + #mbox-cells = <1>;
>> + };
>
> Look good otherwise, thanks!
> Maxime
>
Thanks,
Samuel
next prev parent reply other threads:[~2019-12-16 19:45 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-12-15 4:24 [PATCH v5 0/8] Allwinner sun6i message box support Samuel Holland
2019-12-15 4:24 ` [PATCH v5 1/8] clk: sunxi-ng: Mark msgbox clocks as critical Samuel Holland
2019-12-16 14:00 ` Maxime Ripard
2019-12-15 4:24 ` [PATCH v5 2/8] dt-bindings: mailbox: Add a sun6i message box binding Samuel Holland
2019-12-16 14:04 ` Maxime Ripard
2019-12-16 19:45 ` Samuel Holland [this message]
2019-12-26 10:14 ` Maxime Ripard
2019-12-15 4:24 ` [PATCH v5 3/8] mailbox: sun6i-msgbox: Add a new mailbox driver Samuel Holland
2020-01-02 12:06 ` Philipp Zabel
2019-12-15 4:24 ` [PATCH v5 4/8] ARM: dts: sunxi: a83t: Add msgbox node Samuel Holland
2019-12-15 4:24 ` [PATCH v5 5/8] ARM: dts: sunxi: h3/h5: " Samuel Holland
2019-12-15 4:24 ` [PATCH v5 6/8] arm64: dts: allwinner: a64: " Samuel Holland
2019-12-15 4:24 ` [PATCH v5 7/8] arm64: dts: allwinner: h6: " Samuel Holland
2019-12-15 4:24 ` [PATCH v5 8/8] firmware: arm_scpi: Support unidirectional mailbox channels Samuel Holland
2019-12-18 18:48 ` Sudeep Holla
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=d3a1c7c2-953a-cbfe-970e-c00f9a9f5742@sholland.org \
--to=samuel@sholland.org \
--cc=anarsoul@gmail.com \
--cc=devicetree@vger.kernel.org \
--cc=jassisinghbrar@gmail.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-clk@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-sunxi@googlegroups.com \
--cc=mark.rutland@arm.com \
--cc=megous@megous.com \
--cc=mripard@kernel.org \
--cc=mturquette@baylibre.com \
--cc=p.zabel@pengutronix.de \
--cc=robh+dt@kernel.org \
--cc=sboyd@kernel.org \
--cc=sudeep.holla@arm.com \
--cc=wens@csie.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).