Re: [PATCH v2 2/4] dt-bindings: remoteproc: qcom: Convert wcnss documentation to YAML

["Sireesh Kodali" <sireeshkodali1@gmail.com>]

On Fri Sep 9, 2022 at 1:29 PM IST, Krzysztof Kozlowski wrote:
> On 08/09/2022 20:49, Sireesh Kodali wrote:
> > This is a direct conversion of the existing txt documentation to YAML.
> > It is in preparation for the addition of pronto-v3 to the docs. This
> > patch doesn't document any of the existing subnodes/properties that are
> > not documented in the existing txt file. That is done in a separate
> > patch.
> > 
> > Signed-off-by: Sireesh Kodali <sireeshkodali1@gmail.com>
> > ---
> >  .../bindings/remoteproc/qcom,wcnss-pil.yaml   | 263 ++++++++++++++++++
> >  1 file changed, 263 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/remoteproc/qcom,wcnss-pil.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/remoteproc/qcom,wcnss-pil.yaml b/Documentation/devicetree/bindings/remoteproc/qcom,wcnss-pil.yaml
> > new file mode 100644
> > index 000000000000..bc18139fdb91
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/remoteproc/qcom,wcnss-pil.yaml
> > @@ -0,0 +1,263 @@
> > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/remoteproc/qcom,wcnss-pil.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Qualcomm WCNSS Peripheral Image Loader
> > +
> > +maintainers:
> > +  - Bjorn Andersson <bjorn.andersson@linaro.org>
>
> Use email from maintainers entry.

I didn't notice the entry had changed from since v1, will be fixed in v3
>
> > +
> > +description:
> > +  This document defines the binding for a component that loads and boots
> > +  firmware on the Qualcomm WCNSS core.
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - qcom,riva-pil
> > +      - qcom,pronto-v1-pil
> > +      - qcom,pronto-v2-pil
> > +
> > +  reg:
> > +    maxItems: 3
> > +    description:
> > +      The base address and size of the CCU, DXE and PMU register blocks
> > +
> > +  reg-names:
> > +    items:
> > +      - const: ccu
> > +      - const: dxe
> > +      - const: pmu
> > +
> > +  interrupts:
> > +    minItems: 2
> > +    maxItems: 5
> > +
> > +  interrupt-names:
> > +    minItems: 2
> > +    items:
> > +      - const: wdog
> > +      - const: fatal
> > +      - const: ready
> > +      - const: handover
> > +      - const: stop-ack
> > +
> > +  firmware-name:
> > +    $ref: /schemas/types.yaml#/definitions/string
> > +    description:
> > +      Relative firmware image path for the WCNSS core. Defaults to
> > +      "wcnss.mdt".
> > +
> > +  vddpx-supply:
> > +    description:
> > +      PX regulator to be held on behalf of the booting of the WCNSS core
> > +
> > +  vddmx-supply:
> > +    description:
> > +      MX regulator to be held on behalf of the booting of the WCNSS core.
> > +
> > +  vddcx-supply:
> > +    description:
> > +      CX regulator to be held on behalf of the booting of the WCNSS core.
> > +
> > +  power-domains:
> > +    maxItems: 2
> > +
> > +  power-domain-names:
> > +    items:
> > +      - const: cx
> > +      - const: mx
> > +
> > +  qcom,smem-states:
> > +    $ref: /schemas/types.yaml#/definitions/phandle-array
> > +    description:
> > +      States used by the AP to signal the WCNSS core that it should shutdown
> > +    items:
> > +      - description: Stop the modem
> > +
> > +  qcom,smem-state-names:
> > +    description: The names of the state bits used for SMP2P output
> > +    items:
> > +      - const: stop
> > +
> > +  memory-region:
> > +    maxItems: 1
> > +    description: reserved-memory for the WCNSS core
> > +
> > +  smd-edge:
> > +    $ref: /schemas/remoteproc/qcom,smd-edge.yaml#
> > +    description:
> > +      Qualcomm Shared Memory subnode which represents communication edge,
> > +      channels and devices related to the ADSP.
> > +
> > +  iris:
> > +    type: object
> > +    description:
> > +      The iris subnode of the WCNSS PIL is used to describe the attached RF module
> > +      and its resource dependencies.
> > +
> additionalProperties false on this level.

Will be added in v3

Regards,
Sireesh
>
> > +    properties:
> > +      compatible:
> > +        enum:
> > +          - qcom,wcn3620
> > +          - qcom,wcn3660
> > +          - qcom,wcn3660b
> > +          - qcom,wcn3680
> > +
> > +      clocks:
> > +        minItems: 1
> > +        items:
> > +          - description: XO clock
> > +          - description: RF clock
> > +
> > +      clock-names:
> > +        minItems: 1
> > +        items:
> > +          - const: xo
> > +          - const: rf
> > +
> > +      vddxo-supply:
> > +        description:
> > +          Reference to the regulator to be held on behalf of the booting WCNSS
> > +          core
> > +
> > +      vddrfa-supply:
> > +        description:
> > +          Reference to the regulator to be held on behalf of the booting WCNSS
> > +          core
> > +
> > +      vddpa-supply:
> > +        description:
> > +          Reference to the regulator to be held on behalf of the booting WCNSS
> > +          core
> > +
> > +      vdddig-supply:
>
> Best regards,
> Krzysztof