[PATCH 1/3] dt-bindings: clock: Add bindings for Canaan K230 clock controller

[Xukai Wang]

On 2024/12/30 15:54, Krzysztof Kozlowski wrote:
> On Sun, Dec 29, 2024 at 09:21:08PM +0800, Xukai Wang wrote:
>> This patch adds the Device Tree binding for the clock controller
>> on Canaan k230. The binding defines the new clocks available and
>> the required properties to configure them correctly.
>>
>> Signed-off-by: Xukai Wang <kingxukai at zohomail.com>
>> ---
>>  .../devicetree/bindings/clock/canaan,k230-clk.yaml | 41 ++++++++++++++++++
>>  include/dt-bindings/clock/k230-clk.h               | 49 ++++++++++++++++++++++
>>  2 files changed, 90 insertions(+)
> Please run scripts/checkpatch.pl and fix reported warnings. After that,
> run also 'scripts/checkpatch.pl --strict' and (probably) fix more
> warnings. Some warnings can be ignored, especially from --strict run,
> but the code here looks like it needs a fix. Feel free to get in touch
> if the warning is not clear.
Apologies for forgetting to use `--strict` with `checkpatch.pl`. I will
run it and address the warnings accordingly before next submission.
>> diff --git a/Documentation/devicetree/bindings/clock/canaan,k230-clk.yaml b/Documentation/devicetree/bindings/clock/canaan,k230-clk.yaml
>> new file mode 100644
>> index 0000000000000000000000000000000000000000..ffd4e0b052455bf3dcedd9355d93764119df3d68
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/clock/canaan,k230-clk.yaml
>> @@ -0,0 +1,41 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/clock/canaan,k230-clk.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Canaan Kendryte K230 Clock
>> +
>> +maintainers:
>> +  - Xukai Wang <kingxukai at zohomail.com>
>> +
>> +properties:
>> +  compatible:
>> +    const: canaan,k230-clk
>> +
>> +  clocks: 
>> +    const: 1
>> +
>> +  reg:
>> +    maxItems: 2
>> +    minItems: 1
> List and describe the items instead.

OK, thank you for the suggestion. I've addressed the feedback and listed
the items under reg with detailed descriptions.

Here's the update version:

reg:
  description: |
    The `reg` property specifies the base address and size of the
device's registers.
    - The first address corresponds to the base address of the PLL
control registers.
    - The second address corresponds to the base address of the sysclk
control registers.
  minItems: 1
  items:
    - description: Base address and size of the PLL control registers.
    - description: Base address and size of the sysclk control registers.

Does this content look appropriate?

>> +
>> +  '#clock-cells':
>> +    const: 1
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - clocks
>> +  - '#clock-cells'
>> +
>> +additionalProperties: false
>> +
>> +examples:
>> +  - |
>> +    clock-controller at 91102000 {
>> +        compatible = "canaan,k230-clk";
>> +        reg = <0x91102000 0x1000>, <0x91100000 0x1000>;
>> +        #clock-cells = <1>;
>> +        clocks = <&osc24m>;
>> +    };
>> diff --git a/include/dt-bindings/clock/k230-clk.h b/include/dt-bindings/clock/k230-clk.h
>> new file mode 100644
>> index 0000000000000000000000000000000000000000..31d1f82fbcff654072ef1a8985a884377d801e72
>> --- /dev/null
>> +++ b/include/dt-bindings/clock/k230-clk.h
>> @@ -0,0 +1,49 @@
>> +/* SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) */
>> +/*
>> + * Kendryte Canaan K230 Clock Drivers
>> + *
>> + * Author: Xukai Wang <kingxukai at zohomail.com>
>> + */
>> +
>> +#ifndef CLOCK_K230_CLK_H
>> +#define CLOCK_K230_CLK_H
>> +
>> +/* Kendryte K230 SoC clock identifiers (arbitrary values). */
>> +#define	K230_CPU0_SRC			0
> Drop the indentation after '#define'
Thank you for your feedback. I have removed the indentation after #define.
> Best regards,
> Krzysztof
>