[PATCH v2 1/3] dt-bindings: fsi: Document the IBM SBEFIFO engine

[Conor Dooley]

On Mon, Apr 15, 2024 at 10:39:05AM -0500, Eddie James wrote:
> The SBEFIFO engine provides an interface to the POWER processor
> Self Boot Engine (SBE).
> 
> Signed-off-by: Eddie James <eajames at linux.ibm.com>
> ---
> Changes since v1:
>  - Chance "ody" to "odyssey"
>  - Fix typo in commit message
>  - Reword description to describe the hardware only
> 
>  .../devicetree/bindings/fsi/ibm,sbefifo.yaml  | 39 +++++++++++++++++++
>  1 file changed, 39 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/fsi/ibm,sbefifo.yaml
> 
> diff --git a/Documentation/devicetree/bindings/fsi/ibm,sbefifo.yaml b/Documentation/devicetree/bindings/fsi/ibm,sbefifo.yaml
> new file mode 100644
> index 000000000000..69521b1cfb25
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/fsi/ibm,sbefifo.yaml

Filename matching a compatible please.

> @@ -0,0 +1,39 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/fsi/ibm,sbefifo.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: IBM FSI-attached SBEFIFO engine
> +
> +maintainers:
> +  - Eddie James <eajames at linux.ibm.com>
> +
> +description: |

This | should not be needed, there's no formatting to preserve.

> +  The SBEFIFO is an FSI CFAM engine that provides an interface to the
> +  POWER processor Self Boot Engine (SBE). This node will always be a child
> +  of an FSI CFAM node; see fsi.txt for details on FSI slave and CFAM
> +  nodes.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - ibm,p9-sbefifo
> +      - ibm,odyssey-sbefifo
> +
> +  reg:
> +    items:
> +      - description: FSI slave address
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    sbefifo at 2400 {

Per fsi.txt, the generic node name looks like it should be
"fsi-slave-engine"?

Cheers,
Conor.

> +        compatible = "ibm,p9-sbefifo";
> +        reg = <0x2400 0x400>;
> +    };
> -- 
> 2.39.3
> 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 228 bytes
Desc: not available
URL: <http://lists.ozlabs.org/pipermail/linux-fsi/attachments/20240416/10eb6b28/attachment-0001.sig>