[PATCH 1/6] ASoC: tegra: Add binding doc for OPE module

[Sameer Pujar]

Thanks Krzysztof for review.


On 19-05-2022 17:10, Krzysztof Kozlowski wrote:
> On 18/05/2022 19:36, Sameer Pujar wrote:
>> +description: |
>> +  The Multi Band Dynamic Range Compressor (MBDRC) is part of Output
>> +  Processing Engine (OPE) which interfaces with Audio Hub (AHUB) via
>> +  Audio Client Interface (ACIF). MBDRC can be used as a traditional
>> +  single full band or a dual band or a multi band dynamic processor.
>> +
>> +maintainers:
>> +  - Jon Hunter <jonathanh at nvidia.com>
>> +  - Mohan Kumar <mkumard at nvidia.com>
>> +  - Sameer Pujar <spujar at nvidia.com>
>> +
>> +properties:
>> +  $nodename:
>> +    pattern: "^mbdrc@[0-9a-f]*$"
> Why? We enforce only generic names in shared schemas and this is neither
> shared schema nor is it generic name.

Idea was to keep these node names consistent across DT files and parent 
node can allow a given list of child nodes with strict checks. Does name 
like "dynamic-range-compressor at xxx"

>
>> +
>> +  compatible:
>> +    oneOf:
>> +      - const: nvidia,tegra210-mbdrc
>> +      - items:
>> +          - enum:
>> +              - nvidia,tegra234-mbdrc
>> +              - nvidia,tegra194-mbdrc
>> +              - nvidia,tegra186-mbdrc
>> +          - const: nvidia,tegra210-mbdrc
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +
>> +additionalProperties: false
>> +
>> +examples:
>> +  - |
>> +
> No need for space

will remove


>> +
>> +  compatible:
>> +    oneOf:
>> +      - const: nvidia,tegra210-ope
>> +      - items:
>> +          - enum:
>> +              - nvidia,tegra234-ope
>> +              - nvidia,tegra194-ope
>> +              - nvidia,tegra186-ope
>> +          - const: nvidia,tegra210-ope
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  "#address-cells":
>> +    const: 1
>> +
>> +  "#size-cells":
>> +    const: 1
>> +
>> +  ranges: true
>> +
>> +  sound-name-prefix:
>> +    pattern: "^OPE[1-9]$"
>> +
>> +  ports:
>> +    $ref: /schemas/graph.yaml#/properties/ports
>> +    properties:
>> +      port at 0:
>> +        $ref: audio-graph-port.yaml#
>> +        unevaluatedProperties: false
>> +        description: |
> No need for |

will remove.


>
>> +    ope at 702d8000 {
> I would suggest generic node name, if it is possible.

May be "processing-engine at xxx" ?


> peq at 702d8100 {
> Generic node name, so this is "equalizer", I guess?

Yes, I can use this name.