diff mbox series

[1/1] dt-bindings: riscv: cpus: reg matches hart ID

Message ID 20240128180621.85686-1-heinrich.schuchardt@canonical.com (mailing list archive)
State Accepted
Headers show
Series [1/1] dt-bindings: riscv: cpus: reg matches hart ID | expand

Checks

Context Check Description
conchuod/vmtest-for-next-PR success PR summary
conchuod/patch-1-test-1 success .github/scripts/patches/tests/build_rv32_defconfig.sh
conchuod/patch-1-test-2 success .github/scripts/patches/tests/build_rv64_clang_allmodconfig.sh
conchuod/patch-1-test-3 success .github/scripts/patches/tests/build_rv64_gcc_allmodconfig.sh
conchuod/patch-1-test-4 success .github/scripts/patches/tests/build_rv64_nommu_k210_defconfig.sh
conchuod/patch-1-test-5 success .github/scripts/patches/tests/build_rv64_nommu_virt_defconfig.sh
conchuod/patch-1-test-6 success .github/scripts/patches/tests/checkpatch.sh
conchuod/patch-1-test-7 success .github/scripts/patches/tests/dtb_warn_rv64.sh
conchuod/patch-1-test-8 success .github/scripts/patches/tests/header_inline.sh
conchuod/patch-1-test-9 success .github/scripts/patches/tests/kdoc.sh
conchuod/patch-1-test-10 success .github/scripts/patches/tests/module_param.sh
conchuod/patch-1-test-11 success .github/scripts/patches/tests/verify_fixes.sh
conchuod/patch-1-test-12 success .github/scripts/patches/tests/verify_signedoff.sh

Commit Message

Heinrich Schuchardt Jan. 28, 2024, 6:06 p.m. UTC
Add a description to the CPU reg property to clarify that
the reg property must match the hart ID.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
---
 Documentation/devicetree/bindings/riscv/cpus.yaml | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Conor Dooley Jan. 28, 2024, 6:20 p.m. UTC | #1
On Sun, Jan 28, 2024 at 07:06:21PM +0100, Heinrich Schuchardt wrote:
> Add a description to the CPU reg property to clarify that
> the reg property must match the hart ID.

That is the expected usage alright. Did you come across something where
it was not being used in that way?

Acked-by: Conor Dooley <conor.dooley@microchip.com>

Cheers,
Conor.

> 
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
> ---
>  Documentation/devicetree/bindings/riscv/cpus.yaml | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/riscv/cpus.yaml b/Documentation/devicetree/bindings/riscv/cpus.yaml
> index f392e367d673..fa9da59d9316 100644
> --- a/Documentation/devicetree/bindings/riscv/cpus.yaml
> +++ b/Documentation/devicetree/bindings/riscv/cpus.yaml
> @@ -74,6 +74,10 @@ properties:
>        - riscv,sv57
>        - riscv,none
>  
> +  reg:
> +    description:
> +      The hart ID of this CPU node.
> +
>    riscv,cbom-block-size:
>      $ref: /schemas/types.yaml#/definitions/uint32
>      description:
> -- 
> 2.43.0
>
Heinrich Schuchardt Jan. 28, 2024, 6:23 p.m. UTC | #2
On 1/28/24 19:20, Conor Dooley wrote:
> On Sun, Jan 28, 2024 at 07:06:21PM +0100, Heinrich Schuchardt wrote:
>> Add a description to the CPU reg property to clarify that
>> the reg property must match the hart ID.
> 
> That is the expected usage alright. Did you come across something where
> it was not being used in that way?

No. I was simply missing it in the documentation.

There is a page 
https://www.kernel.org/doc/Documentation/devicetree/bindings/riscv/cpus.txt 
but that seems not to be generated from the kernel tree.

Best regards

Heinrich

> 
> Acked-by: Conor Dooley <conor.dooley@microchip.com>
> 
> Cheers,
> Conor.
> 
>>
>> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
>> ---
>>   Documentation/devicetree/bindings/riscv/cpus.yaml | 4 ++++
>>   1 file changed, 4 insertions(+)
>>
>> diff --git a/Documentation/devicetree/bindings/riscv/cpus.yaml b/Documentation/devicetree/bindings/riscv/cpus.yaml
>> index f392e367d673..fa9da59d9316 100644
>> --- a/Documentation/devicetree/bindings/riscv/cpus.yaml
>> +++ b/Documentation/devicetree/bindings/riscv/cpus.yaml
>> @@ -74,6 +74,10 @@ properties:
>>         - riscv,sv57
>>         - riscv,none
>>   
>> +  reg:
>> +    description:
>> +      The hart ID of this CPU node.
>> +
>>     riscv,cbom-block-size:
>>       $ref: /schemas/types.yaml#/definitions/uint32
>>       description:
>> -- 
>> 2.43.0
>>
Conor Dooley Jan. 28, 2024, 6:40 p.m. UTC | #3
On Sun, Jan 28, 2024 at 07:23:39PM +0100, Heinrich Schuchardt wrote:
> On 1/28/24 19:20, Conor Dooley wrote:
> > On Sun, Jan 28, 2024 at 07:06:21PM +0100, Heinrich Schuchardt wrote:
> > > Add a description to the CPU reg property to clarify that
> > > the reg property must match the hart ID.
> > 
> > That is the expected usage alright. Did you come across something where
> > it was not being used in that way?
> 
> No. I was simply missing it in the documentation.
> 
> There is a page
> https://www.kernel.org/doc/Documentation/devicetree/bindings/riscv/cpus.txt
> but that seems not to be generated from the kernel tree.

I think the hosted docs keep alive links files that were deleted in more
recent kernels. I have no idea about the details of that though...
The text binding was deleted back in 2019 in commit 4fd669a8c487
("dt-bindings: riscv: convert cpu binding to json-schema")
Conor Dooley Feb. 26, 2024, 9:46 a.m. UTC | #4
On Sun, Jan 28, 2024 at 06:20:46PM +0000, Conor Dooley wrote:
> On Sun, Jan 28, 2024 at 07:06:21PM +0100, Heinrich Schuchardt wrote:
> > Add a description to the CPU reg property to clarify that
> > the reg property must match the hart ID.
> 
> That is the expected usage alright. Did you come across something where
> it was not being used in that way?
> 
> Acked-by: Conor Dooley <conor.dooley@microchip.com>

I think I pinged Palmer to grab this, but since it's been a month and
not picked up, I've gone and applied this.

Thanks,
Conor.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/riscv/cpus.yaml b/Documentation/devicetree/bindings/riscv/cpus.yaml
index f392e367d673..fa9da59d9316 100644
--- a/Documentation/devicetree/bindings/riscv/cpus.yaml
+++ b/Documentation/devicetree/bindings/riscv/cpus.yaml
@@ -74,6 +74,10 @@  properties:
       - riscv,sv57
       - riscv,none
 
+  reg:
+    description:
+      The hart ID of this CPU node.
+
   riscv,cbom-block-size:
     $ref: /schemas/types.yaml#/definitions/uint32
     description: