[PATCH 1/5] spi: atmel,quadspi: Document sam9x7 QSPI

Dharma Balasubiramani posted 5 patches 1 month ago
There is a newer version of this series
[PATCH 1/5] spi: atmel,quadspi: Document sam9x7 QSPI
Posted by Dharma Balasubiramani 1 month ago
Document the sam9x75 quad spi that supports interface to serial memories
operating in

- Single-bit SPI, Dual SPI, Quad SPI and Octal SPI
- Single Data Rate or Double Data Rate modes

Signed-off-by: Dharma Balasubiramani <dharma.b@microchip.com>
---
 Documentation/devicetree/bindings/spi/atmel,quadspi.yaml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/devicetree/bindings/spi/atmel,quadspi.yaml b/Documentation/devicetree/bindings/spi/atmel,quadspi.yaml
index b0d99bc10535..c17114123034 100644
--- a/Documentation/devicetree/bindings/spi/atmel,quadspi.yaml
+++ b/Documentation/devicetree/bindings/spi/atmel,quadspi.yaml
@@ -17,6 +17,7 @@ properties:
     enum:
       - atmel,sama5d2-qspi
       - microchip,sam9x60-qspi
+      - microchip,sam9x7-ospi
       - microchip,sama7g5-qspi
       - microchip,sama7g5-ospi
 

-- 
2.43.0
Re: [PATCH 1/5] spi: atmel,quadspi: Document sam9x7 QSPI
Posted by Krzysztof Kozlowski 1 month ago
On Tue, Sep 02, 2025 at 11:22:18AM +0530, Dharma Balasubiramani wrote:
> Document the sam9x75 quad spi that supports interface to serial memories
> operating in
> 
> - Single-bit SPI, Dual SPI, Quad SPI and Octal SPI
> - Single Data Rate or Double Data Rate modes

And I forgot - wrong subject prefixes.

Please use subject prefixes matching the subsystem. You can get them for
example with 'git log --oneline -- DIRECTORY_OR_FILE' on the directory
your patch is touching. For bindings, the preferred subjects are
explained here:
https://www.kernel.org/doc/html/latest/devicetree/bindings/submitting-patches.html#i-for-patch-submitters

Best regards,
Krzysztof
Re: [PATCH 1/5] spi: atmel,quadspi: Document sam9x7 QSPI
Posted by Dharma.B@microchip.com 3 weeks, 4 days ago
On 02/09/25 2:52 pm, Krzysztof Kozlowski wrote:
> EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe
> 
> On Tue, Sep 02, 2025 at 11:22:18AM +0530, Dharma Balasubiramani wrote:
>> Document the sam9x75 quad spi that supports interface to serial memories
>> operating in
>>
>> - Single-bit SPI, Dual SPI, Quad SPI and Octal SPI
>> - Single Data Rate or Double Data Rate modes
> 
> And I forgot - wrong subject prefixes.
> 
> Please use subject prefixes matching the subsystem. You can get them for
> example with 'git log --oneline -- DIRECTORY_OR_FILE' on the directory
> your patch is touching. For bindings, the preferred subjects are
> explained here:
> https://www.kernel.org/doc/html/latest/devicetree/bindings/submitting-patches.html#i-for-patch-submitters

I do exactly the same

$ git log --oneline -- 
Documentation/devicetree/bindings/spi/atmel,quadspi.yaml

c0f7ae27539f MAINTAINERS: Update email of Tudor Ambarus
77850bda360d spi: atmel,quadspi: Define sama7g5 QSPI
001a41d2a706 spi: atmel,quadspi: Convert to json-schema

I think the maintainer that merged these commits missed reviewing 
subject prefix.

and I see a mix of

spi: dt-bindings:
dt-bindings: spi:
dt-bindings:

prefixes for this dir.

I will use "dt-bindings: spi:".

Thanks.>
> Best regards,
> Krzysztof
> 


-- 
With Best Regards,
Dharma B.
Re: [PATCH 1/5] spi: atmel,quadspi: Document sam9x7 QSPI
Posted by Krzysztof Kozlowski 3 weeks, 4 days ago
On 08/09/2025 05:51, Dharma.B@microchip.com wrote:
> I think the maintainer that merged these commits missed reviewing 
> subject prefix.
> 
> and I see a mix of
> 
> spi: dt-bindings:
> dt-bindings: spi:
> dt-bindings:
> 
> prefixes for this dir.
> 
> I will use "dt-bindings: spi:".

Did you even bother to read the docs I pointed to?

Best regards,
Krzysztof
Re: [PATCH 1/5] spi: atmel,quadspi: Document sam9x7 QSPI
Posted by Dharma.B@microchip.com 3 weeks, 4 days ago
On 08/09/25 12:11 pm, Krzysztof Kozlowski wrote:
> EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe
> 
> On 08/09/2025 05:51, Dharma.B@microchip.com wrote:
>> I think the maintainer that merged these commits missed reviewing
>> subject prefix.
>>
>> and I see a mix of
>>
>> spi: dt-bindings:
>> dt-bindings: spi:
>> dt-bindings:
>>
>> prefixes for this dir.
>>
>> I will use "dt-bindings: spi:".
> 
> Did you even bother to read the docs I pointed to?

Sorry, I missed it..

Few subsystems, like ASoC, media, regulators and SPI, expect reverse 
order of the prefixes:

"<binding dir>: dt-bindings: ..."

should use spi: dt-bindings:add sam9x7 QSPI (should drop document as well)

"The 80 characters of the subject are precious. It is recommended to not 
use “Documentation”, “doc” or “YAML” because that is implied."

> 
> Best regards,
> Krzysztof


-- 
With Best Regards,
Dharma B.
Re: [PATCH 1/5] spi: atmel,quadspi: Document sam9x7 QSPI
Posted by Krzysztof Kozlowski 1 month ago
On Tue, Sep 02, 2025 at 11:22:18AM +0530, Dharma Balasubiramani wrote:
> Document the sam9x75 quad spi that supports interface to serial memories

9x75 here...

> operating in
> 
> - Single-bit SPI, Dual SPI, Quad SPI and Octal SPI
> - Single Data Rate or Double Data Rate modes
> 
> Signed-off-by: Dharma Balasubiramani <dharma.b@microchip.com>
> ---
>  Documentation/devicetree/bindings/spi/atmel,quadspi.yaml | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/devicetree/bindings/spi/atmel,quadspi.yaml b/Documentation/devicetree/bindings/spi/atmel,quadspi.yaml
> index b0d99bc10535..c17114123034 100644
> --- a/Documentation/devicetree/bindings/spi/atmel,quadspi.yaml
> +++ b/Documentation/devicetree/bindings/spi/atmel,quadspi.yaml
> @@ -17,6 +17,7 @@ properties:
>      enum:
>        - atmel,sama5d2-qspi
>        - microchip,sam9x60-qspi
> +      - microchip,sam9x7-ospi

... but 9x7 here. Confusing.

Best regards,
Krzysztof
Re: [PATCH 1/5] spi: atmel,quadspi: Document sam9x7 QSPI
Posted by Dharma.B@microchip.com 3 weeks, 4 days ago
On 02/09/25 2:51 pm, Krzysztof Kozlowski wrote:
> EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe
> 
> On Tue, Sep 02, 2025 at 11:22:18AM +0530, Dharma Balasubiramani wrote:
>> Document the sam9x75 quad spi that supports interface to serial memories
> 
> 9x75 here...
> 
>> operating in
>>
>> - Single-bit SPI, Dual SPI, Quad SPI and Octal SPI
>> - Single Data Rate or Double Data Rate modes
>>
>> Signed-off-by: Dharma Balasubiramani <dharma.b@microchip.com>
>> ---
>>   Documentation/devicetree/bindings/spi/atmel,quadspi.yaml | 1 +
>>   1 file changed, 1 insertion(+)
>>
>> diff --git a/Documentation/devicetree/bindings/spi/atmel,quadspi.yaml b/Documentation/devicetree/bindings/spi/atmel,quadspi.yaml
>> index b0d99bc10535..c17114123034 100644
>> --- a/Documentation/devicetree/bindings/spi/atmel,quadspi.yaml
>> +++ b/Documentation/devicetree/bindings/spi/atmel,quadspi.yaml
>> @@ -17,6 +17,7 @@ properties:
>>       enum:
>>         - atmel,sama5d2-qspi
>>         - microchip,sam9x60-qspi
>> +      - microchip,sam9x7-ospi
> 
> ... but 9x7 here. Confusing.

It should be 9x7 only (qspi is common for sam9x7x), I will change it.

> 
> Best regards,
> Krzysztof
> 


-- 
With Best Regards,
Dharma B.
Re: [PATCH 1/5] spi: atmel,quadspi: Document sam9x7 QSPI
Posted by Krzysztof Kozlowski 3 weeks, 4 days ago
On 08/09/2025 05:45, Dharma.B@microchip.com wrote:
>>> Signed-off-by: Dharma Balasubiramani <dharma.b@microchip.com>
>>> ---
>>>   Documentation/devicetree/bindings/spi/atmel,quadspi.yaml | 1 +
>>>   1 file changed, 1 insertion(+)
>>>
>>> diff --git a/Documentation/devicetree/bindings/spi/atmel,quadspi.yaml b/Documentation/devicetree/bindings/spi/atmel,quadspi.yaml
>>> index b0d99bc10535..c17114123034 100644
>>> --- a/Documentation/devicetree/bindings/spi/atmel,quadspi.yaml
>>> +++ b/Documentation/devicetree/bindings/spi/atmel,quadspi.yaml
>>> @@ -17,6 +17,7 @@ properties:
>>>       enum:
>>>         - atmel,sama5d2-qspi
>>>         - microchip,sam9x60-qspi
>>> +      - microchip,sam9x7-ospi
>>
>> ... but 9x7 here. Confusing.
> 
> It should be 9x7 only (qspi is common for sam9x7x), I will change it.
> 
Hm? That's wildcard then. See writing bindings.

Best regards,
Krzysztof
Re: [PATCH 1/5] spi: atmel,quadspi: Document sam9x7 QSPI
Posted by Dharma.B@microchip.com 3 weeks, 4 days ago
On 08/09/25 12:12 pm, Krzysztof Kozlowski wrote:
> EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe
> 
> On 08/09/2025 05:45, Dharma.B@microchip.com wrote:
>>>> Signed-off-by: Dharma Balasubiramani <dharma.b@microchip.com>
>>>> ---
>>>>    Documentation/devicetree/bindings/spi/atmel,quadspi.yaml | 1 +
>>>>    1 file changed, 1 insertion(+)
>>>>
>>>> diff --git a/Documentation/devicetree/bindings/spi/atmel,quadspi.yaml b/Documentation/devicetree/bindings/spi/atmel,quadspi.yaml
>>>> index b0d99bc10535..c17114123034 100644
>>>> --- a/Documentation/devicetree/bindings/spi/atmel,quadspi.yaml
>>>> +++ b/Documentation/devicetree/bindings/spi/atmel,quadspi.yaml
>>>> @@ -17,6 +17,7 @@ properties:
>>>>        enum:
>>>>          - atmel,sama5d2-qspi
>>>>          - microchip,sam9x60-qspi
>>>> +      - microchip,sam9x7-ospi
>>>
>>> ... but 9x7 here. Confusing.
>>
>> It should be 9x7 only (qspi is common for sam9x7x), I will change it.
>>
> Hm? That's wildcard then. See writing bindings.

It's mentioned
"DON’T use wildcards or device-family names in compatible strings."

https://www.kernel.org/doc/html/latest/devicetree/bindings/writing-bindings.html

Here, in sam9x7x, the first "x" is part of name itself and not a 
wildcard, so can I just stick to sam9x7?

we have previously followed the same in many bindings
"$ grep -nri sam9x7 Documentation/devicetree/bindings/"

> 
> Best regards,
> Krzysztof


-- 
With Best Regards,
Dharma B.