lkml.org 
[lkml]   [2020]   [Oct]   [12]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    /
    SubjectRe: [PATCH v3 02/24] dt-bindings: memory: mediatek: Convert SMI to DT schema
    From
    Date
    On Mon, 2020-10-12 at 09:18 +0200, Krzysztof Kozlowski wrote:
    > On Sat, Oct 10, 2020 at 02:18:11PM +0800, Yong Wu wrote:
    > > On Tue, 2020-10-06 at 09:15 +0200, Krzysztof Kozlowski wrote:
    > > > On Tue, 6 Oct 2020 at 06:27, Yong Wu <yong.wu@mediatek.com> wrote:
    > > > >
    > > > > On Fri, 2020-10-02 at 13:08 +0200, Krzysztof Kozlowski wrote:
    > > > > > On Wed, Sep 30, 2020 at 03:06:25PM +0800, Yong Wu wrote:
    > > > > > > Convert MediaTek SMI to DT schema.
    > > > > > >
    > > > > > > Signed-off-by: Yong Wu <yong.wu@mediatek.com>
    > > > > > > ---
    > > > > > > .../mediatek,smi-common.txt | 49 ---------
    > > > > > > .../mediatek,smi-common.yaml | 100 ++++++++++++++++++
    > > > > > > .../memory-controllers/mediatek,smi-larb.txt | 49 ---------
    > > > > > > .../memory-controllers/mediatek,smi-larb.yaml | 91 ++++++++++++++++
    > > > > > > 4 files changed, 191 insertions(+), 98 deletions(-)
    > > > > > > delete mode 100644 Documentation/devicetree/bindings/memory-controllers/mediatek,smi-common.txt
    > > > > > > create mode 100644 Documentation/devicetree/bindings/memory-controllers/mediatek,smi-common.yaml
    > > > > > > delete mode 100644 Documentation/devicetree/bindings/memory-controllers/mediatek,smi-larb.txt
    > > > > > > create mode 100644 Documentation/devicetree/bindings/memory-controllers/mediatek,smi-larb.yaml
    > > > > ...
    > > > > > > +properties:
    > > > > > > + compatible:
    > > > > > > + oneOf:
    > > > > > > + - enum:
    > > > > > > + - mediatek,mt2701-smi-common
    > > > > > > + - mediatek,mt2712-smi-common
    > > > > > > + - mediatek,mt6779-smi-common
    > > > > > > + - mediatek,mt8173-smi-common
    > > > > > > + - mediatek,mt8183-smi-common
    > > > > > > +
    > > > > > > + - description: for mt7623
    > > > > > > + items:
    > > > > > > + - const: mediatek,mt7623-smi-common
    > > > > > > + - const: mediatek,mt2701-smi-common
    > > > > > > +
    > > > > > > + reg:
    > > > > > > + maxItems: 1
    > > > > > > +
    > > > > > > + clocks:
    > > > > > > + description: |
    > > > > > > + apb and smi are mandatory. the async is only for generation 1 smi HW.
    > > > > > > + gals(global async local sync) also is optional, here is the list which
    > > > > > > + require gals: mt6779 and mt8183.
    > > > > > > + minItems: 2
    > > > > > > + maxItems: 4
    > > > > > > + items:
    > > > > > > + - description: apb is Advanced Peripheral Bus clock, It's the clock for
    > > > > > > + setting the register.
    > > > > > > + - description: smi is the clock for transfer data and command.
    > > > > > > + - description: async is asynchronous clock, it help transform the smi clock
    > > > > > > + into the emi clock domain.
    > > > > > > + - description: gals0 is the path0 clock of gals.
    > > > > > > + - description: gals1 is the path1 clock of gals.
    > > > > > > +
    > > > > > > + clock-names:
    > > > > > > + oneOf:
    > > > > > > + - items:
    > > > > > > + - const: apb
    > > > > > > + - const: smi
    > > > > > > + - items:
    > > > > > > + - const: apb
    > > > > > > + - const: smi
    > > > > > > + - const: async
    > > > > > > + - items:
    > > > > > > + - const: apb
    > > > > > > + - const: smi
    > > > > > > + - const: gals0
    > > > > > > + - const: gals1
    > > > > >
    > > > > > Similarly to my comment to other properties, this requirement per
    > > > > > compatible should be part of the schema within 'if-then'.
    > > > >
    > > > > I'm not so familiar with this format. Do this has "if-then-'else
    > > > > if'-then-else"?
    > > >
    > > > These are mutually exclusive conditions, so you can skip else:
    > > > - if-then
    > > > - if-then
    > > > - if-then
    > > > It will be more readable then stacking 'if' under 'else'
    > >
    > > Thanks. I will use something like this:
    > >
    > > anyOf:
    >
    > Then it should be oneOf as only one condition can be valid.

    I did do this at the beginning. But I get a warning log when
    dt_binding_check.


    Below is my schema and the detailed warning log:
    //=======================================
    clocks:
    description: |
    xxxxx
    minItems: 2
    maxItems: 4
    items:
    - description: apb is the clock for setting the register.
    - description: smi is the clock for transfer data and command.
    - description: async is asynchronous clock.
    - description: gals0 is the path0 clock of gals.
    - description: gals1 is the path1 clock of gals.

    clock-names:
    minItems: 2
    maxItems: 4

    required:
    - compatible
    - reg
    - power-domains
    - clocks
    - clock-names

    oneOf:
    - if: #only for gen1 HW
    properties:
    compatible:
    contains:
    enum:
    - mediatek,mt2701-smi-common
    then:
    properties:
    clock:
    items:
    minItems: 3
    maxItems: 3
    clock-names:
    items:
    - const: apb
    - const: smi
    - const: async

    - if: #for gen2 HW that have gals
    properties:
    compatible:
    enum:
    - mediatek,mt6779-smi-common
    - mediatek,mt8183-smi-common
    - mediatek,mt8192-smi-common

    then:
    properties:
    clock:
    items:
    minItems: 4
    maxItems: 4
    clock-names:
    items:
    - const: apb
    - const: smi
    - const: gals0
    - const: gals1

    else: #for gen2 HW that don't have gals
    properties:
    clock:
    items:
    minItems: 2
    maxItems: 2
    clock-names:
    items:
    - const: apb
    - const: smi

    additionalProperties: false


    //===========warning log=====================

    Documentation/devicetree/bindings/memory-controllers/mediatek,smi-common.example.dt.yaml
    .../Documentation/devicetree/bindings/memory-controllers/mediatek,smi-common.example.dt.yaml: smi@14022000: {'compatible': ['mediatek,mt8173-smi-common'], 'reg': [[335683584, 4096]], 'power-domains': [[4294967295, 3]], 'clocks': [[4294967295, 1], [4294967295, 1]], 'clock-names': ['apb', 'smi'], '$nodename': ['smi@14022000']} is valid under each of {'else': {'properties': {'clock': {'items': {'maxItems': 2, 'minItems': 2}, 'type': 'array'}, 'clock-names': {'additionalItems': False, 'items': [{'const': 'apb'}, {'const': 'smi'}], 'maxItems': 2, 'minItems': 2, 'type': 'array'}}}, 'if': {'properties': {'compatible': {'additionalItems': False, 'items': [{'enum': ['mediatek,mt6779-smi-common', 'mediatek,mt8183-smi-common', 'mediatek,mt8192-smi-common']}], 'maxItems': 1, 'minItems': 1, 'type': 'array'}}}, 'then': {'properties': {'clock': {'items': {'maxItems': 4, 'minItems': 4}, 'type': 'array'}, 'clock-names': {'additionalItems': False, 'items': [{'const': 'apb'}, {'const': 'smi'}, {'const': 'gals0'}, {'const': 'gals1'}], 'maxItems': 4, 'minItems': 4, 'type': 'array'}}}}, {'if': {'properties': {'compatible': {'contains': {'enum': ['mediatek,mt2701-smi-common']}}}}, 'then': {'properties': {'clock': {'items': {'maxItems': 3, 'minItems': 3}, 'type': 'array'}, 'clock-names': {'additionalItems': False, 'items': [{'const': 'apb'}, {'const': 'smi'}, {'const': 'async'}], 'maxItems': 3, 'minItems': 3, 'type': 'array'}}}}
    {'$filename':
    '.../Documentation/devicetree/bindings/memory-controllers/mediatek,smi-common.yaml',
    '$id':
    'http://devicetree.org/schemas/memory-controllers/mediatek,smi-common.yaml#',
    '$schema': 'http://devicetree.org/meta-schemas/core.yaml#',
    '$select_validator': <jsonschema.validators.create.<locals>.Validator
    object at 0x7fb3df378908>,
    'additionalProperties': False,
    'oneOf': [{'if': {'properties': {'compatible': {'contains': {'enum':
    ['mediatek,mt2701-smi-common']}}}},
    'then': {'properties': {'clock': {'items': {'maxItems': 3,
    'minItems': 3},
    'type': 'array'},
    'clock-names': {'additionalItems':
    False,
    'items': [{'const':
    'apb'},
    {'const':
    'smi'},
    {'const':
    'async'}],
    'maxItems': 3,
    'minItems': 3,
    'type': 'array'}}}},
    {'else': {'properties': {'clock': {'items': {'maxItems': 2,
    'minItems': 2},
    'type': 'array'},
    'clock-names': {'additionalItems':
    False,
    'items': [{'const':
    'apb'},
    {'const':
    'smi'}],
    'maxItems': 2,
    'minItems': 2,
    'type': 'array'}}},
    'if': {'properties': {'compatible': {'additionalItems':
    False,
    'items': [{'enum':
    ['mediatek,mt6779-smi-common',

    'mediatek,mt8183-smi-common',

    'mediatek,mt8192-smi-common']}],
    'maxItems': 1,
    'minItems': 1,
    'type': 'array'}}},
    'then': {'properties': {'clock': {'items': {'maxItems': 4,
    'minItems': 4},
    'type': 'array'},
    'clock-names': {'additionalItems':
    False,
    'items': [{'const':
    'apb'},
    {'const':
    'smi'},
    {'const':
    'gals0'},
    {'const':
    'gals1'}],
    'maxItems': 4,
    'minItems': 4,
    'type':
    'array'}}}}],
    'patternProperties': {'pinctrl-[0-9]+': True},
    'properties': {'$nodename': True,
    'clock-names': {'maxItems': 4, 'minItems': 2},
    'clocks': {'additionalItems': False,
    'items': [{}, {}, {}, {}, {}],
    'maxItems': 4,
    'minItems': 2,
    'type': 'array'},
    'compatible': {'oneOf': [{'additionalItems': False,
    'items': [{'enum':
    ['mediatek,mt2701-smi-common',

    'mediatek,mt2712-smi-common',

    'mediatek,mt6779-smi-common',

    'mediatek,mt8173-smi-common',

    'mediatek,mt8183-smi-common',

    'mediatek,mt8192-smi-common']}],
    'maxItems': 1,
    'minItems': 1,
    'type': 'array'},
    {'additionalItems': False,
    'items': [{'const':
    'mediatek,mt7623-smi-common'},
    {'const':
    'mediatek,mt2701-smi-common'}],
    'maxItems': 2,
    'minItems': 2,
    'type': 'array'}]},
    'phandle': True,
    'pinctrl-names': True,
    'power-domains': {'maxItems': 1, 'minItems': 1},
    'reg': {'maxItems': 1, 'minItems': 1},
    'status': True},
    'required': ['compatible',
    'reg',
    'power-domains',
    'clocks',
    'clock-names'],
    'select': {'properties': {'compatible': {'contains': {'enum':
    ['mediatek,mt2701-smi-common',

    'mediatek,mt2712-smi-common',

    'mediatek,mt6779-smi-common',

    'mediatek,mt7623-smi-common',

    'mediatek,mt8173-smi-common',

    'mediatek,mt8183-smi-common',

    'mediatek,mt8192-smi-common']}}},
    'required': ['compatible']},
    'title': 'SMI (Smart Multimedia Interface) Common'}
    From
    schema: .../Documentation/devicetree/bindings/memory-controllers/mediatek,smi-common.yaml

    =================================

    Sorry, I didn't find a example of multi "if-then" in oneOf and don't
    know how to fix this.

    From [1], "allOf" looks also is allowed... In this case, both allOf and
    anyOf have no warning when dt_binding_check. only oneOf has the warning
    log above.

    Any suggestion is appreciated.

    [1]
    https://elixir.bootlin.com/linux/v5.9-rc1/source/Documentation/devicetree/bindings/example-schema.yaml#L195

    >
    > Best regards,
    > Krzysztof
    >
    > > - if: #gen1 hw
    > > then:
    > > use apb/smi/async clocks
    > >
    > > - if: #gen2 hw that has gals.
    > > then:
    > > use apb/smi/gals0/gals1 clocks
    > > else: # gen2 hw that doesn't have gals.
    > > use apb/smi clocks.

    \
     
     \ /
      Last update: 2020-10-12 14:03    [W:3.191 / U:0.020 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site