Re: [PATCH 1/2] dt-bindings: fsi: Document the IBM I2C Responder virtual FSI master

[Andrew Jeffery]

On Fri, 20 Jan 2023, at 04:17, Eddie James wrote:
> The I2C Responder translates I2C commands to CFAM or SCOM operations,
> effectively implementing an FSI master.
>
> Signed-off-by: Eddie James <eajames@xxxxxxxxxxxxx>
> ---
>  .../devicetree/bindings/fsi/ibm,i2cr.yaml     | 42 +++++++++++++++++++
>  1 file changed, 42 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/fsi/ibm,i2cr.yaml
>
> diff --git a/Documentation/devicetree/bindings/fsi/ibm,i2cr.yaml 
> b/Documentation/devicetree/bindings/fsi/ibm,i2cr.yaml
> new file mode 100644
> index 000000000000..929ca10988f9
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/fsi/ibm,i2cr.yaml
> @@ -0,0 +1,42 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/fsi/ibm,i2cr.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: IBM I2C Responder virtual FSI master
> +
> +maintainers:
> +  - Eddie James <eajames@xxxxxxxxxxxxx>
> +
> +description: |
> +  This binding describes an I2C device called the I2C Responder 
> (I2CR). The
> +  I2CR translates commands sent over I2C bus to FSI CFAM reads and 
> writes or
> +  SCOM operations. The CFAM access means that the I2CR can act as an 
> FSI
> +  master.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - ibm,i2cr


I think this should be a bit more descriptive and at least mention that
it's FSI-related, e.g. `ibm,fsi-i2cr`? Thoughts?

> +
> +   reg:
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> +    i2c {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +
> +      i2cr@20 {
> +        compatible = "ibm,i2cr";

Change this in accordance with the above.

Andrew