Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Nava kishore Manne <navam@xilinx.com>
To:     Rob Herring <robh@kernel.org>
CC:     Michal Simek <michals@xilinx.com>,
        "mdf@kernel.org" <mdf@kernel.org>,
        "trix@redhat.com" <trix@redhat.com>,
        "gregkh@linuxfoundation.org" <gregkh@linuxfoundation.org>,
        "arnd@arndb.de" <arnd@arndb.de>, Rajan Vaja <RAJANV@xilinx.com>,
        Amit Sunil Dhamne <amitsuni@xlnx.xilinx.com>,
        Manish Narani <MNARANI@xilinx.com>,
        "zou_wei@huawei.com" <zou_wei@huawei.com>,
        Sai Krishna Potthuri <lakshmis@xilinx.com>,
        "iwamatsu@nigauri.org" <iwamatsu@nigauri.org>,
        Jiaying Liang <jliang@xilinx.com>,
        "linus.walleij@linaro.org" <linus.walleij@linaro.org>,
        "devicetree@vger.kernel.org" <devicetree@vger.kernel.org>,
        "linux-arm-kernel@lists.infradead.org" 
        <linux-arm-kernel@lists.infradead.org>,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
        "linux-fpga@vger.kernel.org" <linux-fpga@vger.kernel.org>,
        "chinnikishore369@gmail.com" <chinnikishore369@gmail.com>,
        git <git@xilinx.com>
Subject: RE: [PATCH v4 1/4] dt-bindings: firmware: Add bindings for xilinx
 firmware
Thread-Topic: [PATCH v4 1/4] dt-bindings: firmware: Add bindings for xilinx
 firmware
Thread-Index: AQHXPQErV0G7SQw9VkmmikpPIEZooarNdzQAgAWeuSA=
Date:   Tue, 4 May 2021 09:34:39 +0000
Message-ID: <MWHPR02MB262372B79B43EC798C06F491C25A9@MWHPR02MB2623.namprd02.prod.outlook.com>
References: <20210429140408.23194-1-nava.manne@xilinx.com>
 <20210429140408.23194-2-nava.manne@xilinx.com>
 <20210430194000.GA3742101@robh.at.kernel.org>
In-Reply-To: <20210430194000.GA3742101@robh.at.kernel.org>
Accept-Language: en-US
Content-Language: en-US
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-MS-Exchange-CrossTenant-Network-Message-Id: 63870ab6-210e-492b-7345-08d90edfd6fc
X-MS-Exchange-CrossTenant-originalarrivaltime: 04 May 2021 09:34:39.6300
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 657af505-d5df-48d0-8300-c31994686c5c
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: iTEv7LjHNY5sLZPFkeblneMK1SPhQq2viHmXDTSyjV0TPzitMksuBrNq/LI41aEmBN0gE/IeCQQ6N6enMamlOA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MW4PR02MB7202
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Hi Rob,

	Please find my response inline.

> -----Original Message-----
> From: Rob Herring <robh@kernel.org>
> Sent: Saturday, May 1, 2021 1:10 AM
> To: Nava kishore Manne <navam@xilinx.com>
> Cc: Michal Simek <michals@xilinx.com>; mdf@kernel.org; trix@redhat.com;
> gregkh@linuxfoundation.org; arnd@arndb.de; Rajan Vaja
> <RAJANV@xilinx.com>; Amit Sunil Dhamne <amitsuni@xlnx.xilinx.com>;
> Manish Narani <MNARANI@xilinx.com>; zou_wei@huawei.com; Sai Krishna
> Potthuri <lakshmis@xilinx.com>; iwamatsu@nigauri.org; Jiaying Liang
> <jliang@xilinx.com>; linus.walleij@linaro.org; devicetree@vger.kernel.org=
;
> linux-arm-kernel@lists.infradead.org; linux-kernel@vger.kernel.org; linux=
-
> fpga@vger.kernel.org; chinnikishore369@gmail.com; git <git@xilinx.com>
> Subject: Re: [PATCH v4 1/4] dt-bindings: firmware: Add bindings for xilin=
x
> firmware
>=20
> On Thu, Apr 29, 2021 at 07:34:05PM +0530, Nava kishore Manne wrote:
> > Add documentation to describe Xilinx firmware driver bindings.
> > Firmware driver provides an interface to firmware APIs.
> > Interface APIs can be used by any driver to communicate to Platform
> > Management Unit.
> >
> > Signed-off-by: Nava kishore Manne <nava.manne@xilinx.com>
> > ---
> > Changes for v4:
> >                 -Added new yaml file for xilinx firmware
> >                  as suggested by Rob.
> >
> >  .../firmware/xilinx/xlnx,zynqmp-firmware.yaml | 63
> > +++++++++++++++++++
> >  1 file changed, 63 insertions(+)
> >  create mode 100644
> > Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-
> firmware
> > .yaml
>=20
> What about the old doc?:
>=20

As you suggested i have added only the fpga node relevant info here so it's=
 not representing the complete firmware file with other sub node like clk, =
Aes, ...etc.
Once it completely mature we can deprecate the Old doc.

> Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-
> firmware.txt
>=20
> >
> > diff --git
> > a/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-
> firmwa
> > re.yaml
> > b/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-
> firmwa
> > re.yaml
> > new file mode 100644
> > index 000000000000..4b97f005bed7
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-fi
> > +++ rmware.yaml
> > @@ -0,0 +1,63 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
> > +---
> > +$id:
> > +http://devicetree.org/schemas/firmware/xilinx/xlnx,zynqmp-firmware.ya
> > +ml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Xilinx firmware driver
> > +
> > +maintainers:
> > +  - Nava kishore Manne <nava.manne@xilinx.com>
> > +
> > +description:
> > +  The zynqmp-firmware node describes the interface to platform
> firmware.
> > +  ZynqMP has an interface to communicate with secure firmware.
> > +Firmware
> > +  driver provides an interface to firmware APIs. Interface APIs can
> > +be
> > +  used by any driver to communicate to PMUFW(Platform Management
> Unit).
> > +  These requests include clock management, pin control, device
> > +control,
> > +  power management service, FPGA service and other platform
> > +management
> > +  services.
> > +
> > +properties:
> > +  compatible:
> > +    oneOf:
> > +      - description:
> > +          For implementations complying for Zynq Ultrascale+ MPSoC.
> > +        const: xlnx,zynqmp-firmware
> > +
> > +      - description:
> > +          For implementations complying for Versal.
> > +        const: xlnx,versal-firmware
> > +
> > +  method:
> > +    description: The method of calling the PM-API firmware layer.
> > +                #  Permitted values are:
> > +                #  - "smc" : SMC #0, following the SMCCC
> > +                #  - "hvc" : HVC #0, following the SMCCC
>=20
> Drop the '#'. If you want to maintain the formatting, then use '|' after
> 'description:' for a literal block.
>=20

Will fix in v5.

> > +    $ref: /schemas/types.yaml#/definitions/string-array
> > +    enum:
> > +      - smc
> > +      - hvc
> > +
> > +patternProperties:
> > +  "fpga":
>=20
> So 'foofpgabar' is valid?
>=20

Yes, it's a valid for fpga node.

> > +    description: Compatible of the FPGA device.
> > +    type: object
> > +
> > +    required:
> > +      - compatible
>=20
> This belongs in the fpga schema which should have a $ref here. (Which
> means this patch needs to come 2nd.)
>=20

Will fix in v5.

Regards,
Navakishore.