Re: [PATCH v2 06/34] dt-bindings: Add bindings for Keem Bay VPU IPC driver

[Alessandrelli, Daniele]

Hi Rob,

Thanks for your review.

On Mon, 2021-01-11 at 13:24 -0600, Rob Herring wrote:
> On Fri, Jan 08, 2021 at 01:25:32PM -0800, mgross@xxxxxxxxxxxxxxx
> wrote:
> > From: Paul Murphy <paul.j.murphy@xxxxxxxxx>
> > 
> > Add DT bindings documentation for the Keem Bay VPU IPC driver.
> > 
> > Cc: Rob Herring <robh+dt@xxxxxxxxxx>
> > Cc: devicetree@xxxxxxxxxxxxxxx
> > Reviewed-by: Mark Gross <mgross@xxxxxxxxxxxxxxx>
> > Signed-off-by: Paul Murphy <paul.j.murphy@xxxxxxxxx>
> > Co-developed-by: Daniele Alessandrelli <
> > daniele.alessandrelli@xxxxxxxxx>
> > Signed-off-by: Daniele Alessandrelli <
> > daniele.alessandrelli@xxxxxxxxx>
> 
> Needs your Sob.
> 
> > ---
> >  .../soc/intel/intel,keembay-vpu-ipc.yaml      | 153
> > ++++++++++++++++++
> 
> This doesn't fit somewhere else?

It's quite a SoC-specific driver, designed to control (start, stop,
monitor, etc) the Vision Processing Unit (VPU) integrated in the Keem
Bay SoC.

Do you think it would fit better somewhere else?

> 
> >  1 file changed, 153 insertions(+)
> >  create mode 100644
> > Documentation/devicetree/bindings/soc/intel/intel,keembay-vpu-
> > ipc.yaml
> > 
> > diff --git
> > a/Documentation/devicetree/bindings/soc/intel/intel,keembay-vpu-
> > ipc.yaml
> > b/Documentation/devicetree/bindings/soc/intel/intel,keembay-vpu-
> > ipc.yaml
> > new file mode 100644
> > index 000000000000..cd1c4abe8bc9
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/soc/intel/intel,keembay-
> > vpu-ipc.yaml
> > @@ -0,0 +1,153 @@
> > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> > +# Copyright (c) Intel Corporation. All rights reserved.
> > +%YAML 1.2
> > +---
> > +$id: "
> > http://devicetree.org/schemas/soc/intel/intel,keembay-vpu-ipc.yaml#
> > "
> > +$schema: "http://devicetree.org/meta-schemas/core.yaml#";
> > +
> > +title: Intel Keem Bay VPU IPC
> > +
> > +maintainers:
> > +  - Paul Murphy <paul.j.murphy@xxxxxxxxx>
> > +
> > +description:
> > +  The VPU IPC driver facilitates loading of firmware, control, and
> > communication
> > +  with the VPU over the IPC FIFO in the Intel Keem Bay SoC.
> 
> VPU is never defined. 

We'll spell out the acronym in v3.

Anyway, VPU = Vision Processing Unit


> 
> Bindings are for h/w blocks, not drivers.

Will be fixed in v3

> 
> > +
> > +properties:
> > +  compatible:
> > +    oneOf:
> > +      - items:
> > +        - const: intel,keembay-vpu-ipc
> > +
> > +  reg:
> > +    items:
> > +      - description: NCE WDT registers
> > +      - description: NCE TIM_GEN_CONFIG registers
> > +      - description: MSS WDT registers
> > +      - description: MSS TIM_GEN_CONFIG registers
> > +
> > +  reg-names:
> > +    items:
> > +      - const: nce_wdt
> > +      - const: nce_tim_cfg
> > +      - const: mss_wdt
> > +      - const: mss_tim_cfg
> > +
> > +  memory-region:
> > +    items:
> > +      - description: reference to the VPU reserved memory region
> > +      - description: reference to the X509 reserved memory region
> > +      - description: reference to the MSS IPC area
> > +
> > +  clocks:
> > +    items:
> > +      - description: cpu clock
> > +      - description: pll 0 out 0 rate
> > +      - description: pll 0 out 1 rate
> > +      - description: pll 0 out 2 rate
> > +      - description: pll 0 out 3 rate
> > +      - description: pll 1 out 0 rate
> > +      - description: pll 1 out 1 rate
> > +      - description: pll 1 out 2 rate
> > +      - description: pll 1 out 3 rate
> > +      - description: pll 2 out 0 rate
> > +      - description: pll 2 out 1 rate
> > +      - description: pll 2 out 2 rate
> > +      - description: pll 2 out 3 rate
> > +
> > +  clock-names:
> > +    items:
> > +      - const: cpu_clock
> > +      - const: pll_0_out_0
> > +      - const: pll_0_out_1
> > +      - const: pll_0_out_2
> > +      - const: pll_0_out_3
> > +      - const: pll_1_out_0
> > +      - const: pll_1_out_1
> > +      - const: pll_1_out_2
> > +      - const: pll_1_out_3
> > +      - const: pll_2_out_0
> > +      - const: pll_2_out_1
> > +      - const: pll_2_out_2
> > +      - const: pll_2_out_3
> > +
> > +  interrupts:
> > +    items:
> > +      - description: number of NCE sub-system WDT timeout IRQ
> > +      - description: number of MSS sub-system WDT timeout IRQ
> > +
> > +  interrupt-names:
> > +    items:
> > +      - const: nce_wdt
> > +      - const: mss_wdt
> > +
> > +  intel,keembay-vpu-ipc-nce-wdt-redirect:
> > +    $ref: "/schemas/types.yaml#/definitions/uint32"
> > +    description:
> > +      Number to which we will request that the NCE sub-system
> > +      re-directs it's WDT timeout IRQ
> > +
> > +  intel,keembay-vpu-ipc-mss-wdt-redirect:
> > +    $ref: "/schemas/types.yaml#/definitions/uint32"
> > +    description:
> > +      Number to which we will request that the MSS sub-system
> > +      re-directs it's WDT timeout IRQ
> 
> These look like the same value as the interrupt numbers?

That's a very good point. We'll drop these additional properties and
re-use the interrupt numbers.

> 
> > +
> > +  intel,keembay-vpu-ipc-imr:
> > +    $ref: "/schemas/types.yaml#/definitions/uint32"
> > +    description:
> > +      IMR (isolated memory region) number which we will request
> > +      the runtime service uses to protect the VPU memory region
> > +      before authentication
> > +
> > +  intel,keembay-vpu-ipc-id:
> > +    $ref: "/schemas/types.yaml#/definitions/uint32"
> > +    description: The VPU ID to be passed to the VPU firmware.
> > +
> > +additionalProperties: False
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> > +    vpu-ipc@3f00209c {
> > +        compatible = "intel,keembay-vpu-ipc";
> > +        reg = <0x3f00209c 0x10>,
> > +              <0x3f003008 0x4>,
> > +              <0x2082009c 0x10>,
> > +              <0x20821008 0x4>;
> > +        reg-names = "nce_wdt",
> > +                    "nce_tim_cfg",
> > +                    "mss_wdt",
> > +                    "mss_tim_cfg";
> > +        memory-region = <&vpu_reserved>,
> > +                        <&vpu_x509_reserved>,
> > +                        <&mss_ipc_reserved>;
> > +        clocks = <&scmi_clk 0>,
> > +                 <&scmi_clk 0>,
> > +                 <&scmi_clk 1>,
> > +                 <&scmi_clk 2>,
> > +                 <&scmi_clk 3>,
> > +                 <&scmi_clk 4>,
> > +                 <&scmi_clk 5>,
> > +                 <&scmi_clk 6>,
> > +                 <&scmi_clk 7>,
> > +                 <&scmi_clk 8>,
> > +                 <&scmi_clk 9>,
> > +                 <&scmi_clk 10>,
> > +                 <&scmi_clk 11>;
> > +        clock-names = "cpu_clock",
> > +                      "pll_0_out_0", "pll_0_out_1",
> > +                      "pll_0_out_2", "pll_0_out_3",
> > +                      "pll_1_out_0", "pll_1_out_1",
> > +                      "pll_1_out_2", "pll_1_out_3",
> > +                      "pll_2_out_0", "pll_2_out_1",
> > +                      "pll_2_out_2", "pll_2_out_3";
> > +        interrupts = <GIC_SPI 63 IRQ_TYPE_LEVEL_HIGH>,
> > +                     <GIC_SPI 47 IRQ_TYPE_LEVEL_HIGH>;
> > +        interrupt-names = "nce_wdt", "mss_wdt";
> > +        intel,keembay-vpu-ipc-nce-wdt-redirect = <63>;
> > +        intel,keembay-vpu-ipc-mss-wdt-redirect = <47>;
> > +        intel,keembay-vpu-ipc-imr = <9>;
> > +        intel,keembay-vpu-ipc-id = <0>;
> > +    };
> > -- 
> > 2.17.1
> >