[PATCH linux 1/2] dt-bindings: misc: Add bindings for Aspeed ast2400/2500 LPC mbox registers

[Joel Stanley]

On Wed, Feb 21, 2018 at 1:55 PM, Cyril Bur <cyrilbur at gmail.com> wrote:
> Signed-off-by: Cyril Bur <cyrilbur at gmail.com>
> ---
> Before I attempt to upstream this again, I thought I would run it
> past this list.
> Joel: I'm quite sure what you're carrying in the tree at the moment
> is the same plus or minus some whitespace. I've made strong use of
> sed to remove any 'mailbox' reference.
> If you could double check, thanks.
>
> When I do upstream I'll have a cover-letter which will explain how
> Aspeed haven't made our naming lives easy by calling these registers
> 'mbox'. It makes it impossible to justify calling this driver
> anything else but it does expose us to the confusion as to why it
> isn't in drivers/mailbox, which really isn't the place for it.
>
>  .../bindings/misc/aspeed,ast2400-mbox.txt          | 35 ++++++++++++++++++++++
>  1 file changed, 35 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/misc/aspeed,ast2400-mbox.txt
>
> diff --git a/Documentation/devicetree/bindings/misc/aspeed,ast2400-mbox.txt b/Documentation/devicetree/bindings/misc/aspeed,ast2400-mbox.txt
> new file mode 100644
> index 000000000000..b33276e058d6
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/misc/aspeed,ast2400-mbox.txt

Please add this to
Documentation/devicetree/bindings/mfd/aspeed-lpc.txt under the Host
Node Children header. See this one for an example:

 https://patchwork.kernel.org/patch/10227223/

> @@ -0,0 +1,35 @@
> +* Aspeed MBOX Registers
> +
> +The Aspeed SOCs (AST2400 and AST2500) are commonly used as BMCs
> +(BaseBoard Management Controllers) and the MBOX registers can be used

You can lose the part before 'and'.

> +to perform in-band communication with their host.
> +
> +Required properties:
> +
> +- compatible : should be one of
> +       "aspeed,ast2400-mbox"
> +       "aspeed,ast2500-mbox"
> +- reg: physical address and size of the registers
> +- interrupts: interrupt number to use for the device

Make sure this matches the other examples.


> +
> +The mbox registers are attached to the LPC bus on AST2400 and AST2500
> +platforms, as such the mbox node should exist as a child of the LPC
> +node.

You can lose this paragraph too.

> +
> +Example:
> +
> +       lpc at 1e789000 {
> +               compatible = "aspeed,ast2500-lpc", "simple-mfd";
> +               reg = <0x1e789000 0x1000>;
> +
> +               #address-cells = <1>;
> +               #size-cells = <1>;
> +
> +               ...
> +
> +               mbox at 180 {
> +                       compatible = "aspeed,ast2400-mbox";
> +                       reg = <0x180 0x18>;
> +                       interrupts = <46>;
> +               };

Just include the mbox node, drop the lpc bit.

The bindings I have in the dev-4.13 tree have 0x5c as the size.
Looking at the datasheet it looks like 0x5c is correct.

Cheers,

Joel