lkml.org 
[lkml]   [2023]   [Mar]   [16]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
SubjectRe: [PATCH 08/15] dt-bindings: clock: Document ma35d1 clock controller bindings
From
Dear Krzysztof,

Thanks for your advice.


On 2023/3/16 下午 03:35, Krzysztof Kozlowski wrote:
> On 15/03/2023 08:28, Jacky Huang wrote:
>> From: Jacky Huang <ychuang3@nuvoton.com>
>>
>> Add documentation to describe nuvoton ma35d1 clock driver bindings.
> Subject: drop second/last, redundant "bindings". The "dt-bindings"
> prefix is already stating that these are bindings.

Got it, thanks.

>> Signed-off-by: Jacky Huang <ychuang3@nuvoton.com>
>> ---
>> .../bindings/clock/nuvoton,ma35d1-clk.yaml | 83 +++++++++++++++++++
>> 1 file changed, 83 insertions(+)
>> create mode 100644 Documentation/devicetree/bindings/clock/nuvoton,ma35d1-clk.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/clock/nuvoton,ma35d1-clk.yaml b/Documentation/devicetree/bindings/clock/nuvoton,ma35d1-clk.yaml
>> new file mode 100644
>> index 000000000000..5c2dea071b38
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/clock/nuvoton,ma35d1-clk.yaml
>> @@ -0,0 +1,83 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/clock/nuvoton,ma35d1-clk.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Nuvoton MA35D1 Clock Controller Module Binding
>> +
>> +maintainers:
>> + - Chi-Fang Li <cfli0@nuvoton.com>
>> + - Jacky Huang <ychuang3@nuvoton.com>
>> +
>> +description: |
>> + The MA35D1 clock controller generates clocks for the whole chip,
>> + including system clocks and all peripheral clocks.
>> +
>> + See also:
>> + include/dt-bindings/clock/ma35d1-clk.h
>> +
>> +properties:
>> + compatible:
>> + items:
>> + - const: nuvoton,ma35d1-clk
>> + - const: syscon
>> +
>> + reg:
>> + maxItems: 1
>> +
>> + "#clock-cells":
>> + const: 1
>> +
>> + clocks:
>> + maxItems: 1
>> +
>> + clock-names:
>> + const: clk_hxt
> Drop clock-names. You do not need it for one clock.

I will remove it.

>
>
>> +
>> + assigned-clocks:
>> + maxItems: 5
>> +
>> + assigned-clock-rates:
>> + maxItems: 5
> Drop both properties, you do not need them in the binding.

I will drop them.

>
>> +
>> + nuvoton,pll-mode:
>> + description:
>> + A list of PLL operation mode corresponding to CAPLL, DDRPLL, APLL,
>> + EPLL, and VPLL in sequential. The operation mode value 0 is for
>> + integer mode, 1 is for fractional mode, and 2 is for spread
>> + spectrum mode.
>> + $ref: /schemas/types.yaml#/definitions/uint32-array
>> + maxItems: 5
>> + items:
>> + minimum: 0
>> + maximum: 2
> Why exactly this is suitable for DT?

I will use strings instead.

>
>> +
>> + nuvoton,sys:
>> + description:
>> + Phandle to the system management controller.
>> + $ref: "/schemas/types.yaml#/definitions/phandle-array"
> Drop quotes.
>
> You need here constraints, look for existing examples.
>

I would like to modify this as:


  nuvoton,sys:
    description:
      Use to unlock and lock some clock controller registers. The lock
      control register is in system controller.
    $ref: /schemas/types.yaml#/definitions/phandle-array
    items:
      - items:
          - description: phandle to the system controller.


>
> Best regards,
> Krzysztof
>

Best regards,

Jacky Huang

\
 
 \ /
  Last update: 2023-03-27 01:04    [W:0.094 / U:0.688 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site