[v2,1/2] dt-bindings: arm: qcom: document qcom,msm-id and qcom,board-id

Commit Message

Krzysztof Kozlowski June 21, 2022, 6:56 p.m. UTC

The top level qcom,msm-id and qcom,board-id properties are utilized by
bootloaders on Qualcomm MSM platforms to determine which device tree
should be used and passed to the kernel.

The commit b32e592d3c28 ("devicetree: bindings: Document qcom board
compatible format") from 2015 was a consensus during discussion about
upstreaming qcom,msm-id and qcom,board-id fields.  There are however still
problems with that consensus:
1. It was reached 7 years ago but it turned out its implementation did
   not reach all possible products.

2. Initially additional tool (dtbTool) was needed for parsing these
   fields to create a QCDT image consisting of multiple DTBs, later the
   bootloaders were improved and they use these qcom,msm-id and
   qcom,board-id properties directly.

3. Extracting relevant information from the board compatible requires
   this additional tool (dtbTool), which makes the build process more
   complicated and not easily reproducible (DTBs are modified after the
   kernel build).

4. Some versions of Qualcomm bootloaders expect these properties even
   when booting with a single DTB.  The community is stuck with these
   bootloaders thus they require properties in the DTBs.

Since several upstreamed Qualcomm SoC-based boards require these
properties to properly boot and the properties are reportedly used by
bootloaders, document them.

Link: https://lore.kernel.org/r/[e-mail]/
Co-developed-by: Kumar Gala <[e-mail]>
Signed-off-by: Kumar Gala <[e-mail]>
Signed-off-by: Krzysztof Kozlowski <[e-mail]>
---
 .../devicetree/bindings/arm/qcom.yaml         | 123 ++++++++++++++++++
 include/dt-bindings/arm/qcom,ids.h            |  30 +++++
 2 files changed, 153 insertions(+)
 create mode 100644 include/dt-bindings/arm/qcom,ids.h

Comments

Dmitry Baryshkov June 21, 2022, 7:26 p.m. UTC | #1

On 21/06/2022 21:56, Krzysztof Kozlowski wrote:
> The top level qcom,msm-id and qcom,board-id properties are utilized by
> bootloaders on Qualcomm MSM platforms to determine which device tree
> should be used and passed to the kernel.
> 
> The commit b32e592d3c28 ("devicetree: bindings: Document qcom board
> compatible format") from 2015 was a consensus during discussion about
> upstreaming qcom,msm-id and qcom,board-id fields.  There are however still
> problems with that consensus:
> 1. It was reached 7 years ago but it turned out its implementation did
>     not reach all possible products.
> 
> 2. Initially additional tool (dtbTool) was needed for parsing these
>     fields to create a QCDT image consisting of multiple DTBs, later the
>     bootloaders were improved and they use these qcom,msm-id and
>     qcom,board-id properties directly.

I might be mistaken here. I think it was expected that dtbTool would use 
board compat strings to generate qcom,msm-id and qcom,board-id 
properties. It's not that the bootloaders were improved.

> 
> 3. Extracting relevant information from the board compatible requires
>     this additional tool (dtbTool), which makes the build process more
>     complicated and not easily reproducible (DTBs are modified after the
>     kernel build).
> 
> 4. Some versions of Qualcomm bootloaders expect these properties even
>     when booting with a single DTB.  The community is stuck with these
>     bootloaders thus they require properties in the DTBs.
> 
> Since several upstreamed Qualcomm SoC-based boards require these
> properties to properly boot and the properties are reportedly used by
> bootloaders, document them.
> 
> Link: https://lore.kernel.org/r/[e-mail]/
> Co-developed-by: Kumar Gala <[e-mail]>
> Signed-off-by: Kumar Gala <[e-mail]>
> Signed-off-by: Krzysztof Kozlowski <[e-mail]>
> ---
>   .../devicetree/bindings/arm/qcom.yaml         | 123 ++++++++++++++++++
>   include/dt-bindings/arm/qcom,ids.h            |  30 +++++
>   2 files changed, 153 insertions(+)
>   create mode 100644 include/dt-bindings/arm/qcom,ids.h
> 
> diff --git a/Documentation/devicetree/bindings/arm/qcom.yaml b/Documentation/devicetree/bindings/arm/qcom.yaml
> index 6c38c1387afd..05b98cde4653 100644
> --- a/Documentation/devicetree/bindings/arm/qcom.yaml
> +++ b/Documentation/devicetree/bindings/arm/qcom.yaml
> @@ -403,6 +403,129 @@ properties:
>                 - qcom,sm8450-qrd
>             - const: qcom,sm8450
>   
> +  # Board compatibles go above
> +
> +  qcom,msm-id:
> +    $ref: /schemas/types.yaml#/definitions/uint32-matrix
> +    minItems: 1
> +    maxItems: 8
> +    items:
> +      items:
> +        - description: |
> +            MSM chipset ID - an exact match value consisting of three bitfields::

two bitfields

> +             - bits 0-15  - The unique MSM chipset ID
> +             - bits 16-31 - Reserved; should be 0
> +        - description: |
> +            Hardware revision ID - a chipset specific 32-bit ID representing
> +            the version of the chipset.  It is best a match value - the
> +            bootloader will look for the closest possible match.
> +    deprecated: true
> +    description:
> +      The MSM chipset and hardware revision use by Qualcomm bootloaders.  It
> +      can optionally be an array of these to indicate multiple hardware that
> +      use the same device tree.  It is expected that the bootloader will use
> +      this information at boot-up to decide which device tree to use when given
> +      multiple device trees, some of which may not be compatible with the
> +      actual hardware.  It is the bootloader's responsibility to pass the
> +      correct device tree to the kernel.
> +      The property is deprecated - it is not expected on newer boards
> +      (starting with SM8350).

Could you please elaborate this? If the AOSP team were to add e.g. 
SM8350-HDK to their single RB3+RB5 images, they would still need the 
qcom,board-id/qcom,msm-id properties to let the bootloader choose proper 
DTB.

> +
> +  qcom,board-id:
> +    $ref: /schemas/types.yaml#/definitions/uint32-matrix
> +    minItems: 1
> +    maxItems: 8
> +    items:
> +      oneOf:
> +        - maxItems: 2
> +          items:
> +            - description: |
> +                Board ID consisting of three bitfields::
> +                  - bits 31-24 - Unused
> +                  - bits 23-16 - Platform Version Major
> +                  - bits 15-8  - Platform Version Minor
> +                  - bits 7-0   - Platform Type
> +                Platform Type field is an exact match value.  The
> +                Platform Major/Minor field is a best match.  The bootloader will
> +                look for the closest possible match.
> +            - description: |
> +                Subtype ID unique to a Platform Type/Chipset ID.  For a given
> +                Platform Type, there will typically only be a single board and the
> +                subtype_id will be 0.  However in some cases board variants may
> +                need to be distinguished by different subtype_id values.
> +        # OnePlus uses a variant of board-id with four elements:
> +        - minItems: 4
> +          items:
> +            - const: 8
> +            - const: 0
> +            - description: OnePlus board ID
> +            - description: OnePlus subtype ID
> +    deprecated: true
> +    description:
> +      The board type and revision information.  It can optionally be an array
> +      of these to indicate multiple boards that use the same device tree.  It
> +      is expected that the bootloader will use this information at boot-up to
> +      decide which device tree to use when given multiple device trees, some of
> +      which may not be compatible with the actual hardware.  It is the
> +      bootloader's responsibility to pass the correct device tree to the
> +      kernel
> +      The property is deprecated - it is not expected on newer boards
> +      (starting with SM8350).
> +
> +allOf:
> +  # Explicit allow-list for older SoCs. The legacy properties are not allowed
> +  # on newer SoCs.
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +            enum:
> +              - qcom,apq8026
> +              - qcom,apq8094
> +              - qcom,apq8096
> +              - qcom,msm8992
> +              - qcom,msm8994
> +              - qcom,msm8996
> +              - qcom,msm8998
> +              - qcom,sdm630
> +              - qcom,sdm632
> +              - qcom,sdm845
> +              - qcom,sdx55
> +              - qcom,sdx65
> +              - qcom,sm6125
> +              - qcom,sm6350
> +              - qcom,sm7225
> +              - qcom,sm8150
> +              - qcom,sm8250
> +    then:
> +      properties:
> +        qcom,board-id: true
> +        qcom,msm-id: true
> +    else:
> +      properties:
> +        qcom,board-id: false
> +        qcom,msm-id: false
> +
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +            enum:
> +              - oneplus,cheeseburger
> +              - oneplus,dumpling
> +              - oneplus,enchilada
> +              - oneplus,fajita
> +    then:
> +      properties:
> +        qcom,board-id:
> +          items:
> +            minItems: 4
> +    else:
> +      properties:
> +        qcom,board-id:
> +          items:
> +            maxItems: 2
> +
>   additionalProperties: true
>   
>   ...
> diff --git a/include/dt-bindings/arm/qcom,ids.h b/include/dt-bindings/arm/qcom,ids.h
> new file mode 100644
> index 000000000000..eaf86c18650f
> --- /dev/null
> +++ b/include/dt-bindings/arm/qcom,ids.h
> @@ -0,0 +1,30 @@
> +/* SPDX-License-Identifier: GPL-2.0-only */
> +/*
> + * Copyright (c) 2015, The Linux Foundation. All rights reserved.
> + * Copyright (c) 2022 Linaro Ltd
> + * Author: Krzysztof Kozlowski <[e-mail]> based on previous work of Kumar Gala.
> + */
> +#ifndef _DT_BINDINGS_ARM_QCOM_IDS_H
> +#define _DT_BINDINGS_ARM_QCOM_IDS_H
> +
> +/* qcom,msm-id */
> +#define QCOM_ID_APQ8026				199
> +#define QCOM_ID_MSM8916				206
> +#define QCOM_ID_MSM8994				207
> +#define QCOM_ID_MSM8996_3_0			246

2_0 too.
And then (according to 3.18):
8996-pro 305
8996-pro-auto 315
8996-auto 310

> +#define QCOM_ID_APQ8016				247
> +#define QCOM_ID_MSM8216				248
> +#define QCOM_ID_MSM8116				249
> +#define QCOM_ID_MSM8616				250
> +#define QCOM_ID_MSM8998				292
> +#define QCOM_ID_SDM845				321

sdm845-v2.1-rb3.dts:	qcom,msm-id = <341 0x20001>;
But this might be a typo

> +
> +/* qcom,board-id */
> +#define QCOM_BOARD_ID(a, major, minor) \
> +	(((major & 0xff) << 16) | ((minor & 0xff) << 8) | QCOM_BOARD_ID_##a)
> +
> +#define QCOM_BOARD_ID_MTP			8
> +#define QCOM_BOARD_ID_DRAGONBOARD		10
> +#define QCOM_BOARD_ID_SBC			24
> +
> +#endif /* _DT_BINDINGS_ARM_QCOM_IDS_H */

Krzysztof Kozlowski June 21, 2022, 7:32 p.m. UTC | #2

On 21/06/2022 21:26, Dmitry Baryshkov wrote:
> On 21/06/2022 21:56, Krzysztof Kozlowski wrote:
>> The top level qcom,msm-id and qcom,board-id properties are utilized by
>> bootloaders on Qualcomm MSM platforms to determine which device tree
>> should be used and passed to the kernel.
>>
>> The commit b32e592d3c28 ("devicetree: bindings: Document qcom board
>> compatible format") from 2015 was a consensus during discussion about
>> upstreaming qcom,msm-id and qcom,board-id fields.  There are however still
>> problems with that consensus:
>> 1. It was reached 7 years ago but it turned out its implementation did
>>     not reach all possible products.
>>
>> 2. Initially additional tool (dtbTool) was needed for parsing these
>>     fields to create a QCDT image consisting of multiple DTBs, later the
>>     bootloaders were improved and they use these qcom,msm-id and
>>     qcom,board-id properties directly.
> 
> I might be mistaken here. I think it was expected that dtbTool would use 
> board compat strings to generate qcom,msm-id and qcom,board-id 
> properties. It's not that the bootloaders were improved.

Don't ask me, I am new to this.

https://lore.kernel.org/all/[e-mail]/

> 
>>
>> 3. Extracting relevant information from the board compatible requires
>>     this additional tool (dtbTool), which makes the build process more
>>     complicated and not easily reproducible (DTBs are modified after the
>>     kernel build).
>>
>> 4. Some versions of Qualcomm bootloaders expect these properties even
>>     when booting with a single DTB.  The community is stuck with these
>>     bootloaders thus they require properties in the DTBs.
>>
>> Since several upstreamed Qualcomm SoC-based boards require these
>> properties to properly boot and the properties are reportedly used by
>> bootloaders, document them.
>>
>> Link: https://lore.kernel.org/r/[e-mail]/
>> Co-developed-by: Kumar Gala <[e-mail]>
>> Signed-off-by: Kumar Gala <[e-mail]>
>> Signed-off-by: Krzysztof Kozlowski <[e-mail]>
>> ---
>>   .../devicetree/bindings/arm/qcom.yaml         | 123 ++++++++++++++++++
>>   include/dt-bindings/arm/qcom,ids.h            |  30 +++++
>>   2 files changed, 153 insertions(+)
>>   create mode 100644 include/dt-bindings/arm/qcom,ids.h
>>
>> diff --git a/Documentation/devicetree/bindings/arm/qcom.yaml b/Documentation/devicetree/bindings/arm/qcom.yaml
>> index 6c38c1387afd..05b98cde4653 100644
>> --- a/Documentation/devicetree/bindings/arm/qcom.yaml
>> +++ b/Documentation/devicetree/bindings/arm/qcom.yaml
>> @@ -403,6 +403,129 @@ properties:
>>                 - qcom,sm8450-qrd
>>             - const: qcom,sm8450
>>   
>> +  # Board compatibles go above
>> +
>> +  qcom,msm-id:
>> +    $ref: /schemas/types.yaml#/definitions/uint32-matrix
>> +    minItems: 1
>> +    maxItems: 8
>> +    items:
>> +      items:
>> +        - description: |
>> +            MSM chipset ID - an exact match value consisting of three bitfields::
> 
> two bitfields

Right, thanks.

> 
>> +             - bits 0-15  - The unique MSM chipset ID
>> +             - bits 16-31 - Reserved; should be 0
>> +        - description: |
>> +            Hardware revision ID - a chipset specific 32-bit ID representing
>> +            the version of the chipset.  It is best a match value - the
>> +            bootloader will look for the closest possible match.
>> +    deprecated: true
>> +    description:
>> +      The MSM chipset and hardware revision use by Qualcomm bootloaders.  It
>> +      can optionally be an array of these to indicate multiple hardware that
>> +      use the same device tree.  It is expected that the bootloader will use
>> +      this information at boot-up to decide which device tree to use when given
>> +      multiple device trees, some of which may not be compatible with the
>> +      actual hardware.  It is the bootloader's responsibility to pass the
>> +      correct device tree to the kernel.
>> +      The property is deprecated - it is not expected on newer boards
>> +      (starting with SM8350).
> 
> Could you please elaborate this? 

Second paragraph:
https://lore.kernel.org/all/[e-mail]/

Plus consensus with Rob:
https://lore.kernel.org/all/[e-mail]/

> If the AOSP team were to add e.g. 
> SM8350-HDK to their single RB3+RB5 images, they would still need the 
> qcom,board-id/qcom,msm-id properties to let the bootloader choose proper 
> DTB.

If you have any email addresses in mind, please Cc them to invite in
discussions. Otherwise I am afraid it won't be allowed. The feedback I
got before was that SM8350 and newer do not require this property. Feel
free to propose other way to solve comments (see "consensus with Rob"
above).

> 
>> +
>> +  qcom,board-id:
>> +    $ref: /schemas/types.yaml#/definitions/uint32-matrix
>> +    minItems: 1
>> +    maxItems: 8
>> +    items:
>> +      oneOf:
>> +        - maxItems: 2
>> +          items:
>> +            - description: |
>> +                Board ID consisting of three bitfields::
>> +                  - bits 31-24 - Unused
>> +                  - bits 23-16 - Platform Version Major
>> +                  - bits 15-8  - Platform Version Minor
>> +                  - bits 7-0   - Platform Type
>> +                Platform Type field is an exact match value.  The
>> +                Platform Major/Minor field is a best match.  The bootloader will
>> +                look for the closest possible match.
>> +            - description: |
>> +                Subtype ID unique to a Platform Type/Chipset ID.  For a given
>> +                Platform Type, there will typically only be a single board and the
>> +                subtype_id will be 0.  However in some cases board variants may
>> +                need to be distinguished by different subtype_id values.
>> +        # OnePlus uses a variant of board-id with four elements:
>> +        - minItems: 4
>> +          items:
>> +            - const: 8
>> +            - const: 0
>> +            - description: OnePlus board ID
>> +            - description: OnePlus subtype ID
>> +    deprecated: true
>> +    description:
>> +      The board type and revision information.  It can optionally be an array
>> +      of these to indicate multiple boards that use the same device tree.  It
>> +      is expected that the bootloader will use this information at boot-up to
>> +      decide which device tree to use when given multiple device trees, some of
>> +      which may not be compatible with the actual hardware.  It is the
>> +      bootloader's responsibility to pass the correct device tree to the
>> +      kernel
>> +      The property is deprecated - it is not expected on newer boards
>> +      (starting with SM8350).
>> +
>> +allOf:
>> +  # Explicit allow-list for older SoCs. The legacy properties are not allowed
>> +  # on newer SoCs.
>> +  - if:
>> +      properties:
>> +        compatible:
>> +          contains:
>> +            enum:
>> +              - qcom,apq8026
>> +              - qcom,apq8094
>> +              - qcom,apq8096
>> +              - qcom,msm8992
>> +              - qcom,msm8994
>> +              - qcom,msm8996
>> +              - qcom,msm8998
>> +              - qcom,sdm630
>> +              - qcom,sdm632
>> +              - qcom,sdm845
>> +              - qcom,sdx55
>> +              - qcom,sdx65
>> +              - qcom,sm6125
>> +              - qcom,sm6350
>> +              - qcom,sm7225
>> +              - qcom,sm8150
>> +              - qcom,sm8250
>> +    then:
>> +      properties:
>> +        qcom,board-id: true
>> +        qcom,msm-id: true
>> +    else:
>> +      properties:
>> +        qcom,board-id: false
>> +        qcom,msm-id: false
>> +
>> +  - if:
>> +      properties:
>> +        compatible:
>> +          contains:
>> +            enum:
>> +              - oneplus,cheeseburger
>> +              - oneplus,dumpling
>> +              - oneplus,enchilada
>> +              - oneplus,fajita
>> +    then:
>> +      properties:
>> +        qcom,board-id:
>> +          items:
>> +            minItems: 4
>> +    else:
>> +      properties:
>> +        qcom,board-id:
>> +          items:
>> +            maxItems: 2
>> +
>>   additionalProperties: true
>>   
>>   ...
>> diff --git a/include/dt-bindings/arm/qcom,ids.h b/include/dt-bindings/arm/qcom,ids.h
>> new file mode 100644
>> index 000000000000..eaf86c18650f
>> --- /dev/null
>> +++ b/include/dt-bindings/arm/qcom,ids.h
>> @@ -0,0 +1,30 @@
>> +/* SPDX-License-Identifier: GPL-2.0-only */
>> +/*
>> + * Copyright (c) 2015, The Linux Foundation. All rights reserved.
>> + * Copyright (c) 2022 Linaro Ltd
>> + * Author: Krzysztof Kozlowski <[e-mail]> based on previous work of Kumar Gala.
>> + */
>> +#ifndef _DT_BINDINGS_ARM_QCOM_IDS_H
>> +#define _DT_BINDINGS_ARM_QCOM_IDS_H
>> +
>> +/* qcom,msm-id */
>> +#define QCOM_ID_APQ8026				199
>> +#define QCOM_ID_MSM8916				206
>> +#define QCOM_ID_MSM8994				207
>> +#define QCOM_ID_MSM8996_3_0			246
> 
> 2_0 too.
> And then (according to 3.18):
> 8996-pro 305
> 8996-pro-auto 315
> 8996-auto 310

Sure, I can add these.

> 
>> +#define QCOM_ID_APQ8016				247
>> +#define QCOM_ID_MSM8216				248
>> +#define QCOM_ID_MSM8116				249
>> +#define QCOM_ID_MSM8616				250
>> +#define QCOM_ID_MSM8998				292
>> +#define QCOM_ID_SDM845				321
> 
> sdm845-v2.1-rb3.dts:	qcom,msm-id = <341 0x20001>;
> But this might be a typo

Yeah, that's an interesting one. I did not fill the list to all possible
options, rather to some subset of more reasonable sources.

> 
>> +
>> +/* qcom,board-id */
>> +#define QCOM_BOARD_ID(a, major, minor) \
>> +	(((major & 0xff) << 16) | ((minor & 0xff) << 8) | QCOM_BOARD_ID_##a)
>> +
>> +#define QCOM_BOARD_ID_MTP			8
>> +#define QCOM_BOARD_ID_DRAGONBOARD		10
>> +#define QCOM_BOARD_ID_SBC			24
>> +
>> +#endif /* _DT_BINDINGS_ARM_QCOM_IDS_H */
> 
> 


Best regards,
Krzysztof

Dmitry Baryshkov June 21, 2022, 7:49 p.m. UTC | #3

On Tue, 21 Jun 2022 at 22:32, Krzysztof Kozlowski
<[e-mail]> wrote:
>
> On 21/06/2022 21:26, Dmitry Baryshkov wrote:
> > On 21/06/2022 21:56, Krzysztof Kozlowski wrote:
> >> The top level qcom,msm-id and qcom,board-id properties are utilized by
> >> bootloaders on Qualcomm MSM platforms to determine which device tree
> >> should be used and passed to the kernel.
> >>
> >> The commit b32e592d3c28 ("devicetree: bindings: Document qcom board
> >> compatible format") from 2015 was a consensus during discussion about
> >> upstreaming qcom,msm-id and qcom,board-id fields.  There are however still
> >> problems with that consensus:
> >> 1. It was reached 7 years ago but it turned out its implementation did
> >>     not reach all possible products.
> >>
> >> 2. Initially additional tool (dtbTool) was needed for parsing these
> >>     fields to create a QCDT image consisting of multiple DTBs, later the
> >>     bootloaders were improved and they use these qcom,msm-id and
> >>     qcom,board-id properties directly.
> >
> > I might be mistaken here. I think it was expected that dtbTool would use
> > board compat strings to generate qcom,msm-id and qcom,board-id
> > properties. It's not that the bootloaders were improved.
>
> Don't ask me, I am new to this.
>
> https://lore.kernel.org/all/[e-mail]/




>
> >
> >>
> >> 3. Extracting relevant information from the board compatible requires
> >>     this additional tool (dtbTool), which makes the build process more
> >>     complicated and not easily reproducible (DTBs are modified after the
> >>     kernel build).
> >>
> >> 4. Some versions of Qualcomm bootloaders expect these properties even
> >>     when booting with a single DTB.  The community is stuck with these
> >>     bootloaders thus they require properties in the DTBs.
> >>
> >> Since several upstreamed Qualcomm SoC-based boards require these
> >> properties to properly boot and the properties are reportedly used by
> >> bootloaders, document them.
> >>
> >> Link: https://lore.kernel.org/r/[e-mail]/
> >> Co-developed-by: Kumar Gala <[e-mail]>
> >> Signed-off-by: Kumar Gala <[e-mail]>
> >> Signed-off-by: Krzysztof Kozlowski <[e-mail]>
> >> ---
> >>   .../devicetree/bindings/arm/qcom.yaml         | 123 ++++++++++++++++++
> >>   include/dt-bindings/arm/qcom,ids.h            |  30 +++++
> >>   2 files changed, 153 insertions(+)
> >>   create mode 100644 include/dt-bindings/arm/qcom,ids.h
> >>
> >> diff --git a/Documentation/devicetree/bindings/arm/qcom.yaml b/Documentation/devicetree/bindings/arm/qcom.yaml
> >> index 6c38c1387afd..05b98cde4653 100644
> >> --- a/Documentation/devicetree/bindings/arm/qcom.yaml
> >> +++ b/Documentation/devicetree/bindings/arm/qcom.yaml
> >> @@ -403,6 +403,129 @@ properties:
> >>                 - qcom,sm8450-qrd
> >>             - const: qcom,sm8450
> >>
> >> +  # Board compatibles go above
> >> +
> >> +  qcom,msm-id:
> >> +    $ref: /schemas/types.yaml#/definitions/uint32-matrix
> >> +    minItems: 1
> >> +    maxItems: 8
> >> +    items:
> >> +      items:
> >> +        - description: |
> >> +            MSM chipset ID - an exact match value consisting of three bitfields::
> >
> > two bitfields
>
> Right, thanks.
>
> >
> >> +             - bits 0-15  - The unique MSM chipset ID
> >> +             - bits 16-31 - Reserved; should be 0
> >> +        - description: |
> >> +            Hardware revision ID - a chipset specific 32-bit ID representing
> >> +            the version of the chipset.  It is best a match value - the
> >> +            bootloader will look for the closest possible match.
> >> +    deprecated: true
> >> +    description:
> >> +      The MSM chipset and hardware revision use by Qualcomm bootloaders.  It
> >> +      can optionally be an array of these to indicate multiple hardware that
> >> +      use the same device tree.  It is expected that the bootloader will use
> >> +      this information at boot-up to decide which device tree to use when given
> >> +      multiple device trees, some of which may not be compatible with the
> >> +      actual hardware.  It is the bootloader's responsibility to pass the
> >> +      correct device tree to the kernel.
> >> +      The property is deprecated - it is not expected on newer boards
> >> +      (starting with SM8350).
> >
> > Could you please elaborate this?
>
> Second paragraph:
> https://lore.kernel.org/all/[e-mail]/

I think this is something peculiar to Sony. Public lahaina (sm8350)
dts files contain both these properties:

https://github.com/MiCode/kernel_devicetree/blob/zeus-s-oss/qcom/lahaina-hdk.dts
https://github.com/MiCode/kernel_devicetree/blob/zeus-s-oss/qcom/lahaina-v2.1.dtsi

>
> Plus consensus with Rob:
> https://lore.kernel.org/all/[e-mail]/

I'm not sure here. But sm8350 and sm8450 dtsi files use these
properties. I've linked lahaina files above.
The waiptio dtsi (sm8450) are present at the same URL.

>
> > If the AOSP team were to add e.g.
> > SM8350-HDK to their single RB3+RB5 images, they would still need the
> > qcom,board-id/qcom,msm-id properties to let the bootloader choose proper
> > DTB.
>
> If you have any email addresses in mind, please Cc them to invite in
> discussions. Otherwise I am afraid it won't be allowed. The feedback I
> got before was that SM8350 and newer do not require this property. Feel
> free to propose other way to solve comments (see "consensus with Rob"
> above).

Amit is in CC list. In the past he used these properties to allow
single-image booting of RB3 and RB5.
In fact I might prefer adding more of these properties to the dts
files, where it makes sense, to allow adding more dt files to the
images we create.
I'd really like to be able to boot a single image on all my boards
(rb3, rb5, db410c, db820, ifc6560, etc).

>
> >
> >> +
> >> +  qcom,board-id:
> >> +    $ref: /schemas/types.yaml#/definitions/uint32-matrix
> >> +    minItems: 1
> >> +    maxItems: 8
> >> +    items:
> >> +      oneOf:
> >> +        - maxItems: 2
> >> +          items:
> >> +            - description: |
> >> +                Board ID consisting of three bitfields::
> >> +                  - bits 31-24 - Unused
> >> +                  - bits 23-16 - Platform Version Major
> >> +                  - bits 15-8  - Platform Version Minor
> >> +                  - bits 7-0   - Platform Type
> >> +                Platform Type field is an exact match value.  The
> >> +                Platform Major/Minor field is a best match.  The bootloader will
> >> +                look for the closest possible match.
> >> +            - description: |
> >> +                Subtype ID unique to a Platform Type/Chipset ID.  For a given
> >> +                Platform Type, there will typically only be a single board and the
> >> +                subtype_id will be 0.  However in some cases board variants may
> >> +                need to be distinguished by different subtype_id values.
> >> +        # OnePlus uses a variant of board-id with four elements:
> >> +        - minItems: 4
> >> +          items:
> >> +            - const: 8
> >> +            - const: 0
> >> +            - description: OnePlus board ID
> >> +            - description: OnePlus subtype ID
> >> +    deprecated: true
> >> +    description:
> >> +      The board type and revision information.  It can optionally be an array
> >> +      of these to indicate multiple boards that use the same device tree.  It
> >> +      is expected that the bootloader will use this information at boot-up to
> >> +      decide which device tree to use when given multiple device trees, some of
> >> +      which may not be compatible with the actual hardware.  It is the
> >> +      bootloader's responsibility to pass the correct device tree to the
> >> +      kernel
> >> +      The property is deprecated - it is not expected on newer boards
> >> +      (starting with SM8350).
> >> +
> >> +allOf:
> >> +  # Explicit allow-list for older SoCs. The legacy properties are not allowed
> >> +  # on newer SoCs.
> >> +  - if:
> >> +      properties:
> >> +        compatible:
> >> +          contains:
> >> +            enum:
> >> +              - qcom,apq8026
> >> +              - qcom,apq8094
> >> +              - qcom,apq8096
> >> +              - qcom,msm8992
> >> +              - qcom,msm8994
> >> +              - qcom,msm8996
> >> +              - qcom,msm8998
> >> +              - qcom,sdm630
> >> +              - qcom,sdm632
> >> +              - qcom,sdm845
> >> +              - qcom,sdx55
> >> +              - qcom,sdx65
> >> +              - qcom,sm6125
> >> +              - qcom,sm6350
> >> +              - qcom,sm7225
> >> +              - qcom,sm8150
> >> +              - qcom,sm8250
> >> +    then:
> >> +      properties:
> >> +        qcom,board-id: true
> >> +        qcom,msm-id: true
> >> +    else:
> >> +      properties:
> >> +        qcom,board-id: false
> >> +        qcom,msm-id: false
> >> +
> >> +  - if:
> >> +      properties:
> >> +        compatible:
> >> +          contains:
> >> +            enum:
> >> +              - oneplus,cheeseburger
> >> +              - oneplus,dumpling
> >> +              - oneplus,enchilada
> >> +              - oneplus,fajita
> >> +    then:
> >> +      properties:
> >> +        qcom,board-id:
> >> +          items:
> >> +            minItems: 4
> >> +    else:
> >> +      properties:
> >> +        qcom,board-id:
> >> +          items:
> >> +            maxItems: 2
> >> +
> >>   additionalProperties: true
> >>
> >>   ...
> >> diff --git a/include/dt-bindings/arm/qcom,ids.h b/include/dt-bindings/arm/qcom,ids.h
> >> new file mode 100644
> >> index 000000000000..eaf86c18650f
> >> --- /dev/null
> >> +++ b/include/dt-bindings/arm/qcom,ids.h
> >> @@ -0,0 +1,30 @@
> >> +/* SPDX-License-Identifier: GPL-2.0-only */
> >> +/*
> >> + * Copyright (c) 2015, The Linux Foundation. All rights reserved.
> >> + * Copyright (c) 2022 Linaro Ltd
> >> + * Author: Krzysztof Kozlowski <[e-mail]> based on previous work of Kumar Gala.
> >> + */
> >> +#ifndef _DT_BINDINGS_ARM_QCOM_IDS_H
> >> +#define _DT_BINDINGS_ARM_QCOM_IDS_H
> >> +
> >> +/* qcom,msm-id */
> >> +#define QCOM_ID_APQ8026                             199
> >> +#define QCOM_ID_MSM8916                             206
> >> +#define QCOM_ID_MSM8994                             207
> >> +#define QCOM_ID_MSM8996_3_0                 246
> >
> > 2_0 too.
> > And then (according to 3.18):
> > 8996-pro 305
> > 8996-pro-auto 315
> > 8996-auto 310
>
> Sure, I can add these.

Nah, it was just to complete the picture.

I'd just suggest dropping the _3_0 part of the define. Let's add more
ids if one needs them.

>
> >
> >> +#define QCOM_ID_APQ8016                             247
> >> +#define QCOM_ID_MSM8216                             248
> >> +#define QCOM_ID_MSM8116                             249
> >> +#define QCOM_ID_MSM8616                             250
> >> +#define QCOM_ID_MSM8998                             292
> >> +#define QCOM_ID_SDM845                              321
> >
> > sdm845-v2.1-rb3.dts:  qcom,msm-id = <341 0x20001>;
> > But this might be a typo
>
> Yeah, that's an interesting one. I did not fill the list to all possible
> options, rather to some subset of more reasonable sources.

Checked the msm-4.9. sdm845 is 321, sda845 is 341. sdm845-v2.1-rb3 is
341 because it uses the SDA845 SoC.

> >> +
> >> +/* qcom,board-id */
> >> +#define QCOM_BOARD_ID(a, major, minor) \
> >> +    (((major & 0xff) << 16) | ((minor & 0xff) << 8) | QCOM_BOARD_ID_##a)
> >> +
> >> +#define QCOM_BOARD_ID_MTP                   8
> >> +#define QCOM_BOARD_ID_DRAGONBOARD           10
> >> +#define QCOM_BOARD_ID_SBC                   24
> >> +
> >> +#endif /* _DT_BINDINGS_ARM_QCOM_IDS_H */
> >
> >
>
>
> Best regards,
> Krzysztof

Krzysztof Kozlowski June 22, 2022, 7 a.m. UTC | #4

On 21/06/2022 21:49, Dmitry Baryshkov wrote:
> On Tue, 21 Jun 2022 at 22:32, Krzysztof Kozlowski
> <[e-mail]> wrote:
>>
>> On 21/06/2022 21:26, Dmitry Baryshkov wrote:
>>> On 21/06/2022 21:56, Krzysztof Kozlowski wrote:
>>>> The top level qcom,msm-id and qcom,board-id properties are utilized by
>>>> bootloaders on Qualcomm MSM platforms to determine which device tree
>>>> should be used and passed to the kernel.
>>>>
>>>> The commit b32e592d3c28 ("devicetree: bindings: Document qcom board
>>>> compatible format") from 2015 was a consensus during discussion about
>>>> upstreaming qcom,msm-id and qcom,board-id fields.  There are however still
>>>> problems with that consensus:
>>>> 1. It was reached 7 years ago but it turned out its implementation did
>>>>     not reach all possible products.
>>>>
>>>> 2. Initially additional tool (dtbTool) was needed for parsing these
>>>>     fields to create a QCDT image consisting of multiple DTBs, later the
>>>>     bootloaders were improved and they use these qcom,msm-id and
>>>>     qcom,board-id properties directly.
>>>
>>> I might be mistaken here. I think it was expected that dtbTool would use
>>> board compat strings to generate qcom,msm-id and qcom,board-id
>>> properties. It's not that the bootloaders were improved.
>>
>> Don't ask me, I am new to this.
>>
>> https://lore.kernel.org/all/[e-mail]/
> 
> 
> 
> 
>>
>>>
>>>>
>>>> 3. Extracting relevant information from the board compatible requires
>>>>     this additional tool (dtbTool), which makes the build process more
>>>>     complicated and not easily reproducible (DTBs are modified after the
>>>>     kernel build).
>>>>
>>>> 4. Some versions of Qualcomm bootloaders expect these properties even
>>>>     when booting with a single DTB.  The community is stuck with these
>>>>     bootloaders thus they require properties in the DTBs.
>>>>
>>>> Since several upstreamed Qualcomm SoC-based boards require these
>>>> properties to properly boot and the properties are reportedly used by
>>>> bootloaders, document them.
>>>>
>>>> Link: https://lore.kernel.org/r/[e-mail]/
>>>> Co-developed-by: Kumar Gala <[e-mail]>
>>>> Signed-off-by: Kumar Gala <[e-mail]>
>>>> Signed-off-by: Krzysztof Kozlowski <[e-mail]>
>>>> ---
>>>>   .../devicetree/bindings/arm/qcom.yaml         | 123 ++++++++++++++++++
>>>>   include/dt-bindings/arm/qcom,ids.h            |  30 +++++
>>>>   2 files changed, 153 insertions(+)
>>>>   create mode 100644 include/dt-bindings/arm/qcom,ids.h
>>>>
>>>> diff --git a/Documentation/devicetree/bindings/arm/qcom.yaml b/Documentation/devicetree/bindings/arm/qcom.yaml
>>>> index 6c38c1387afd..05b98cde4653 100644
>>>> --- a/Documentation/devicetree/bindings/arm/qcom.yaml
>>>> +++ b/Documentation/devicetree/bindings/arm/qcom.yaml
>>>> @@ -403,6 +403,129 @@ properties:
>>>>                 - qcom,sm8450-qrd
>>>>             - const: qcom,sm8450
>>>>
>>>> +  # Board compatibles go above
>>>> +
>>>> +  qcom,msm-id:
>>>> +    $ref: /schemas/types.yaml#/definitions/uint32-matrix
>>>> +    minItems: 1
>>>> +    maxItems: 8
>>>> +    items:
>>>> +      items:
>>>> +        - description: |
>>>> +            MSM chipset ID - an exact match value consisting of three bitfields::
>>>
>>> two bitfields
>>
>> Right, thanks.
>>
>>>
>>>> +             - bits 0-15  - The unique MSM chipset ID
>>>> +             - bits 16-31 - Reserved; should be 0
>>>> +        - description: |
>>>> +            Hardware revision ID - a chipset specific 32-bit ID representing
>>>> +            the version of the chipset.  It is best a match value - the
>>>> +            bootloader will look for the closest possible match.
>>>> +    deprecated: true
>>>> +    description:
>>>> +      The MSM chipset and hardware revision use by Qualcomm bootloaders.  It
>>>> +      can optionally be an array of these to indicate multiple hardware that
>>>> +      use the same device tree.  It is expected that the bootloader will use
>>>> +      this information at boot-up to decide which device tree to use when given
>>>> +      multiple device trees, some of which may not be compatible with the
>>>> +      actual hardware.  It is the bootloader's responsibility to pass the
>>>> +      correct device tree to the kernel.
>>>> +      The property is deprecated - it is not expected on newer boards
>>>> +      (starting with SM8350).
>>>
>>> Could you please elaborate this?
>>
>> Second paragraph:
>> https://lore.kernel.org/all/[e-mail]/
> 
> I think this is something peculiar to Sony. Public lahaina (sm8350)
> dts files contain both these properties:
> 
> https://github.com/MiCode/kernel_devicetree/blob/zeus-s-oss/qcom/lahaina-hdk.dts
> https://github.com/MiCode/kernel_devicetree/blob/zeus-s-oss/qcom/lahaina-v2.1.dtsi
> 
>>
>> Plus consensus with Rob:
>> https://lore.kernel.org/all/[e-mail]/
> 
> I'm not sure here. But sm8350 and sm8450 dtsi files use these
> properties. I've linked lahaina files above.
> The waiptio dtsi (sm8450) are present at the same URL.

If you did not like where the consensus is going during the discussion
last week, I would expect to join the discussion. Not to comment after I
implement it.

> 
>>
>>> If the AOSP team were to add e.g.
>>> SM8350-HDK to their single RB3+RB5 images, they would still need the
>>> qcom,board-id/qcom,msm-id properties to let the bootloader choose proper
>>> DTB.
>>
>> If you have any email addresses in mind, please Cc them to invite in
>> discussions. Otherwise I am afraid it won't be allowed. The feedback I
>> got before was that SM8350 and newer do not require this property. Feel
>> free to propose other way to solve comments (see "consensus with Rob"
>> above).
> 
> Amit is in CC list. In the past he used these properties to allow
> single-image booting of RB3 and RB5.
> In fact I might prefer adding more of these properties to the dts
> files, where it makes sense, to allow adding more dt files to the
> images we create.
> I'd really like to be able to boot a single image on all my boards
> (rb3, rb5, db410c, db820, ifc6560, etc).

You have several options here. Use the board-compatible-encoded-scheme,
which was merged like 6 years ago or something. Bootloader could parse
it, dtbTool as well. Add a generic property, like Rob wanted (and
probably fix bootloader). Or find any other way to satisfy Rob's
comments. These properties were not accepted 6 years ago and the board
compatible approach was merged instead. If 6 years is not enough to
change the bootloaders, nothing will happen here ever, so we need to
make some statement.


Best regards,
Krzysztof

Dmitry Baryshkov June 22, 2022, 7:31 a.m. UTC | #5

On 22/06/2022 10:00, Krzysztof Kozlowski wrote:
> On 21/06/2022 21:49, Dmitry Baryshkov wrote:
>> On Tue, 21 Jun 2022 at 22:32, Krzysztof Kozlowski
>> <[e-mail]> wrote:
>>>
>>> On 21/06/2022 21:26, Dmitry Baryshkov wrote:
>>>> On 21/06/2022 21:56, Krzysztof Kozlowski wrote:
>>>>> The top level qcom,msm-id and qcom,board-id properties are utilized by
>>>>> bootloaders on Qualcomm MSM platforms to determine which device tree
>>>>> should be used and passed to the kernel.
>>>>>
>>>>> The commit b32e592d3c28 ("devicetree: bindings: Document qcom board
>>>>> compatible format") from 2015 was a consensus during discussion about
>>>>> upstreaming qcom,msm-id and qcom,board-id fields.  There are however still
>>>>> problems with that consensus:
>>>>> 1. It was reached 7 years ago but it turned out its implementation did
>>>>>      not reach all possible products.
>>>>>
>>>>> 2. Initially additional tool (dtbTool) was needed for parsing these
>>>>>      fields to create a QCDT image consisting of multiple DTBs, later the
>>>>>      bootloaders were improved and they use these qcom,msm-id and
>>>>>      qcom,board-id properties directly.
>>>>
>>>> I might be mistaken here. I think it was expected that dtbTool would use
>>>> board compat strings to generate qcom,msm-id and qcom,board-id
>>>> properties. It's not that the bootloaders were improved.
>>>
>>> Don't ask me, I am new to this.
>>>
>>> https://lore.kernel.org/all/[e-mail]/
>>
>>
>>
>>
>>>
>>>>
>>>>>
>>>>> 3. Extracting relevant information from the board compatible requires
>>>>>      this additional tool (dtbTool), which makes the build process more
>>>>>      complicated and not easily reproducible (DTBs are modified after the
>>>>>      kernel build).
>>>>>
>>>>> 4. Some versions of Qualcomm bootloaders expect these properties even
>>>>>      when booting with a single DTB.  The community is stuck with these
>>>>>      bootloaders thus they require properties in the DTBs.
>>>>>
>>>>> Since several upstreamed Qualcomm SoC-based boards require these
>>>>> properties to properly boot and the properties are reportedly used by
>>>>> bootloaders, document them.
>>>>>
>>>>> Link: https://lore.kernel.org/r/[e-mail]/
>>>>> Co-developed-by: Kumar Gala <[e-mail]>
>>>>> Signed-off-by: Kumar Gala <[e-mail]>
>>>>> Signed-off-by: Krzysztof Kozlowski <[e-mail]>
>>>>> ---
>>>>>    .../devicetree/bindings/arm/qcom.yaml         | 123 ++++++++++++++++++
>>>>>    include/dt-bindings/arm/qcom,ids.h            |  30 +++++
>>>>>    2 files changed, 153 insertions(+)
>>>>>    create mode 100644 include/dt-bindings/arm/qcom,ids.h
>>>>>
>>>>> diff --git a/Documentation/devicetree/bindings/arm/qcom.yaml b/Documentation/devicetree/bindings/arm/qcom.yaml
>>>>> index 6c38c1387afd..05b98cde4653 100644
>>>>> --- a/Documentation/devicetree/bindings/arm/qcom.yaml
>>>>> +++ b/Documentation/devicetree/bindings/arm/qcom.yaml
>>>>> @@ -403,6 +403,129 @@ properties:
>>>>>                  - qcom,sm8450-qrd
>>>>>              - const: qcom,sm8450
>>>>>
>>>>> +  # Board compatibles go above
>>>>> +
>>>>> +  qcom,msm-id:
>>>>> +    $ref: /schemas/types.yaml#/definitions/uint32-matrix
>>>>> +    minItems: 1
>>>>> +    maxItems: 8
>>>>> +    items:
>>>>> +      items:
>>>>> +        - description: |
>>>>> +            MSM chipset ID - an exact match value consisting of three bitfields::
>>>>
>>>> two bitfields
>>>
>>> Right, thanks.
>>>
>>>>
>>>>> +             - bits 0-15  - The unique MSM chipset ID
>>>>> +             - bits 16-31 - Reserved; should be 0
>>>>> +        - description: |
>>>>> +            Hardware revision ID - a chipset specific 32-bit ID representing
>>>>> +            the version of the chipset.  It is best a match value - the
>>>>> +            bootloader will look for the closest possible match.
>>>>> +    deprecated: true
>>>>> +    description:
>>>>> +      The MSM chipset and hardware revision use by Qualcomm bootloaders.  It
>>>>> +      can optionally be an array of these to indicate multiple hardware that
>>>>> +      use the same device tree.  It is expected that the bootloader will use
>>>>> +      this information at boot-up to decide which device tree to use when given
>>>>> +      multiple device trees, some of which may not be compatible with the
>>>>> +      actual hardware.  It is the bootloader's responsibility to pass the
>>>>> +      correct device tree to the kernel.
>>>>> +      The property is deprecated - it is not expected on newer boards
>>>>> +      (starting with SM8350).
>>>>
>>>> Could you please elaborate this?
>>>
>>> Second paragraph:
>>> https://lore.kernel.org/all/[e-mail]/
>>
>> I think this is something peculiar to Sony. Public lahaina (sm8350)
>> dts files contain both these properties:
>>
>> https://github.com/MiCode/kernel_devicetree/blob/zeus-s-oss/qcom/lahaina-hdk.dts
>> https://github.com/MiCode/kernel_devicetree/blob/zeus-s-oss/qcom/lahaina-v2.1.dtsi
>>
>>>
>>> Plus consensus with Rob:
>>> https://lore.kernel.org/all/[e-mail]/
>>
>> I'm not sure here. But sm8350 and sm8450 dtsi files use these
>> properties. I've linked lahaina files above.
>> The waiptio dtsi (sm8450) are present at the same URL.
> 
> If you did not like where the consensus is going during the discussion
> last week, I would expect to join the discussion. Not to comment after I
> implement it.

Please excuse me. I probably missed that part of the discussion. Yes, it 
was my fault.

>>>> If the AOSP team were to add e.g.
>>>> SM8350-HDK to their single RB3+RB5 images, they would still need the
>>>> qcom,board-id/qcom,msm-id properties to let the bootloader choose proper
>>>> DTB.
>>>
>>> If you have any email addresses in mind, please Cc them to invite in
>>> discussions. Otherwise I am afraid it won't be allowed. The feedback I
>>> got before was that SM8350 and newer do not require this property. Feel
>>> free to propose other way to solve comments (see "consensus with Rob"
>>> above).
>>
>> Amit is in CC list. In the past he used these properties to allow
>> single-image booting of RB3 and RB5.
>> In fact I might prefer adding more of these properties to the dts
>> files, where it makes sense, to allow adding more dt files to the
>> images we create.
>> I'd really like to be able to boot a single image on all my boards
>> (rb3, rb5, db410c, db820, ifc6560, etc).
> 
> You have several options here. Use the board-compatible-encoded-scheme,
> which was merged like 6 years ago or something. Bootloader could parse
> it, dtbTool as well. Add a generic property, like Rob wanted (and
> probably fix bootloader). Or find any other way to satisfy Rob's
> comments. These properties were not accepted 6 years ago and the board
> compatible approach was merged instead. If 6 years is not enough to
> change the bootloaders, nothing will happen here ever, so we need to
> make some statement.

Let me respond to his email. Amit, you might have something to add there 
too.

Basically I think we should allow these properties to be used for all 
the Qcom boards. Marking them as 'deprecated' is fine to me, thus we 
would not endorse them. But we would still be able to use them when 
needed/wanted (like AOSP requirements for the single boot image).

Dmitry Baryshkov June 22, 2022, 9:44 a.m. UTC | #6

On 21/06/2022 21:56, Krzysztof Kozlowski wrote:
> The top level qcom,msm-id and qcom,board-id properties are utilized by
> bootloaders on Qualcomm MSM platforms to determine which device tree
> should be used and passed to the kernel.
> 
> The commit b32e592d3c28 ("devicetree: bindings: Document qcom board
> compatible format") from 2015 was a consensus during discussion about
> upstreaming qcom,msm-id and qcom,board-id fields.  There are however still
> problems with that consensus:
> 1. It was reached 7 years ago but it turned out its implementation did
>     not reach all possible products.
> 
> 2. Initially additional tool (dtbTool) was needed for parsing these
>     fields to create a QCDT image consisting of multiple DTBs, later the
>     bootloaders were improved and they use these qcom,msm-id and
>     qcom,board-id properties directly.
> 
> 3. Extracting relevant information from the board compatible requires
>     this additional tool (dtbTool), which makes the build process more
>     complicated and not easily reproducible (DTBs are modified after the
>     kernel build).
> 
> 4. Some versions of Qualcomm bootloaders expect these properties even
>     when booting with a single DTB.  The community is stuck with these
>     bootloaders thus they require properties in the DTBs.
> 
> Since several upstreamed Qualcomm SoC-based boards require these
> properties to properly boot and the properties are reportedly used by
> bootloaders, document them.
> 
> Link: https://lore.kernel.org/r/[e-mail]/
> Co-developed-by: Kumar Gala <[e-mail]>
> Signed-off-by: Kumar Gala <[e-mail]>
> Signed-off-by: Krzysztof Kozlowski <[e-mail]>
> ---
>   .../devicetree/bindings/arm/qcom.yaml         | 123 ++++++++++++++++++
>   include/dt-bindings/arm/qcom,ids.h            |  30 +++++
>   2 files changed, 153 insertions(+)
>   create mode 100644 include/dt-bindings/arm/qcom,ids.h
> 
> diff --git a/Documentation/devicetree/bindings/arm/qcom.yaml b/Documentation/devicetree/bindings/arm/qcom.yaml
> index 6c38c1387afd..05b98cde4653 100644
> --- a/Documentation/devicetree/bindings/arm/qcom.yaml
> +++ b/Documentation/devicetree/bindings/arm/qcom.yaml
> @@ -403,6 +403,129 @@ properties:
>                 - qcom,sm8450-qrd
>             - const: qcom,sm8450
>   
> +  # Board compatibles go above
> +
> +  qcom,msm-id:
> +    $ref: /schemas/types.yaml#/definitions/uint32-matrix
> +    minItems: 1
> +    maxItems: 8
> +    items:
> +      items:
> +        - description: |
> +            MSM chipset ID - an exact match value consisting of three bitfields::
> +             - bits 0-15  - The unique MSM chipset ID
> +             - bits 16-31 - Reserved; should be 0
> +        - description: |
> +            Hardware revision ID - a chipset specific 32-bit ID representing
> +            the version of the chipset.  It is best a match value - the
> +            bootloader will look for the closest possible match.
> +    deprecated: true
> +    description:
> +      The MSM chipset and hardware revision use by Qualcomm bootloaders.  It
> +      can optionally be an array of these to indicate multiple hardware that
> +      use the same device tree.  It is expected that the bootloader will use
> +      this information at boot-up to decide which device tree to use when given
> +      multiple device trees, some of which may not be compatible with the
> +      actual hardware.  It is the bootloader's responsibility to pass the
> +      correct device tree to the kernel.
> +      The property is deprecated - it is not expected on newer boards
> +      (starting with SM8350).

I have been thinking about this for quite a while. I think this patch is 
good.

With this paragraph (and the corresponding paragraph from the next item) 
rephrased to remove references to 'newer boards':

Reviewed-by: Dmitry Baryshkov <[e-mail]>

> +
> +  qcom,board-id:
> +    $ref: /schemas/types.yaml#/definitions/uint32-matrix
> +    minItems: 1
> +    maxItems: 8
> +    items:
> +      oneOf:
> +        - maxItems: 2
> +          items:
> +            - description: |
> +                Board ID consisting of three bitfields::
> +                  - bits 31-24 - Unused
> +                  - bits 23-16 - Platform Version Major
> +                  - bits 15-8  - Platform Version Minor
> +                  - bits 7-0   - Platform Type
> +                Platform Type field is an exact match value.  The
> +                Platform Major/Minor field is a best match.  The bootloader will
> +                look for the closest possible match.
> +            - description: |
> +                Subtype ID unique to a Platform Type/Chipset ID.  For a given
> +                Platform Type, there will typically only be a single board and the
> +                subtype_id will be 0.  However in some cases board variants may
> +                need to be distinguished by different subtype_id values.
> +        # OnePlus uses a variant of board-id with four elements:
> +        - minItems: 4
> +          items:
> +            - const: 8
> +            - const: 0
> +            - description: OnePlus board ID
> +            - description: OnePlus subtype ID
> +    deprecated: true
> +    description:
> +      The board type and revision information.  It can optionally be an array
> +      of these to indicate multiple boards that use the same device tree.  It
> +      is expected that the bootloader will use this information at boot-up to
> +      decide which device tree to use when given multiple device trees, some of
> +      which may not be compatible with the actual hardware.  It is the
> +      bootloader's responsibility to pass the correct device tree to the
> +      kernel
> +      The property is deprecated - it is not expected on newer boards
> +      (starting with SM8350).
> +
> +allOf:
> +  # Explicit allow-list for older SoCs. The legacy properties are not allowed
> +  # on newer SoCs.
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +            enum:
> +              - qcom,apq8026
> +              - qcom,apq8094
> +              - qcom,apq8096
> +              - qcom,msm8992
> +              - qcom,msm8994
> +              - qcom,msm8996
> +              - qcom,msm8998
> +              - qcom,sdm630
> +              - qcom,sdm632
> +              - qcom,sdm845
> +              - qcom,sdx55
> +              - qcom,sdx65
> +              - qcom,sm6125
> +              - qcom,sm6350
> +              - qcom,sm7225
> +              - qcom,sm8150
> +              - qcom,sm8250
> +    then:
> +      properties:
> +        qcom,board-id: true
> +        qcom,msm-id: true
> +    else:
> +      properties:
> +        qcom,board-id: false
> +        qcom,msm-id: false
> +
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +            enum:
> +              - oneplus,cheeseburger
> +              - oneplus,dumpling
> +              - oneplus,enchilada
> +              - oneplus,fajita
> +    then:
> +      properties:
> +        qcom,board-id:
> +          items:
> +            minItems: 4
> +    else:
> +      properties:
> +        qcom,board-id:
> +          items:
> +            maxItems: 2
> +
>   additionalProperties: true
>   
>   ...
> diff --git a/include/dt-bindings/arm/qcom,ids.h b/include/dt-bindings/arm/qcom,ids.h
> new file mode 100644
> index 000000000000..eaf86c18650f
> --- /dev/null
> +++ b/include/dt-bindings/arm/qcom,ids.h
> @@ -0,0 +1,30 @@
> +/* SPDX-License-Identifier: GPL-2.0-only */
> +/*
> + * Copyright (c) 2015, The Linux Foundation. All rights reserved.
> + * Copyright (c) 2022 Linaro Ltd
> + * Author: Krzysztof Kozlowski <[e-mail]> based on previous work of Kumar Gala.
> + */
> +#ifndef _DT_BINDINGS_ARM_QCOM_IDS_H
> +#define _DT_BINDINGS_ARM_QCOM_IDS_H
> +
> +/* qcom,msm-id */
> +#define QCOM_ID_APQ8026				199
> +#define QCOM_ID_MSM8916				206
> +#define QCOM_ID_MSM8994				207
> +#define QCOM_ID_MSM8996_3_0			246
> +#define QCOM_ID_APQ8016				247
> +#define QCOM_ID_MSM8216				248
> +#define QCOM_ID_MSM8116				249
> +#define QCOM_ID_MSM8616				250
> +#define QCOM_ID_MSM8998				292
> +#define QCOM_ID_SDM845				321
> +
> +/* qcom,board-id */
> +#define QCOM_BOARD_ID(a, major, minor) \
> +	(((major & 0xff) << 16) | ((minor & 0xff) << 8) | QCOM_BOARD_ID_##a)
> +
> +#define QCOM_BOARD_ID_MTP			8
> +#define QCOM_BOARD_ID_DRAGONBOARD		10
> +#define QCOM_BOARD_ID_SBC			24
> +
> +#endif /* _DT_BINDINGS_ARM_QCOM_IDS_H */

Krzysztof Kozlowski June 22, 2022, 9:49 a.m. UTC | #7

On 22/06/2022 11:44, Dmitry Baryshkov wrote:
> On 21/06/2022 21:56, Krzysztof Kozlowski wrote:
>> The top level qcom,msm-id and qcom,board-id properties are utilized by
>> bootloaders on Qualcomm MSM platforms to determine which device tree
>> should be used and passed to the kernel.
>>
>> The commit b32e592d3c28 ("devicetree: bindings: Document qcom board
>> compatible format") from 2015 was a consensus during discussion about
>> upstreaming qcom,msm-id and qcom,board-id fields.  There are however still
>> problems with that consensus:
>> 1. It was reached 7 years ago but it turned out its implementation did
>>     not reach all possible products.
>>
>> 2. Initially additional tool (dtbTool) was needed for parsing these
>>     fields to create a QCDT image consisting of multiple DTBs, later the
>>     bootloaders were improved and they use these qcom,msm-id and
>>     qcom,board-id properties directly.
>>
>> 3. Extracting relevant information from the board compatible requires
>>     this additional tool (dtbTool), which makes the build process more
>>     complicated and not easily reproducible (DTBs are modified after the
>>     kernel build).
>>
>> 4. Some versions of Qualcomm bootloaders expect these properties even
>>     when booting with a single DTB.  The community is stuck with these
>>     bootloaders thus they require properties in the DTBs.
>>
>> Since several upstreamed Qualcomm SoC-based boards require these
>> properties to properly boot and the properties are reportedly used by
>> bootloaders, document them.
>>
>> Link: https://lore.kernel.org/r/[e-mail]/
>> Co-developed-by: Kumar Gala <[e-mail]>
>> Signed-off-by: Kumar Gala <[e-mail]>
>> Signed-off-by: Krzysztof Kozlowski <[e-mail]>
>> ---
>>   .../devicetree/bindings/arm/qcom.yaml         | 123 ++++++++++++++++++
>>   include/dt-bindings/arm/qcom,ids.h            |  30 +++++
>>   2 files changed, 153 insertions(+)
>>   create mode 100644 include/dt-bindings/arm/qcom,ids.h
>>
>> diff --git a/Documentation/devicetree/bindings/arm/qcom.yaml b/Documentation/devicetree/bindings/arm/qcom.yaml
>> index 6c38c1387afd..05b98cde4653 100644
>> --- a/Documentation/devicetree/bindings/arm/qcom.yaml
>> +++ b/Documentation/devicetree/bindings/arm/qcom.yaml
>> @@ -403,6 +403,129 @@ properties:
>>                 - qcom,sm8450-qrd
>>             - const: qcom,sm8450
>>   
>> +  # Board compatibles go above
>> +
>> +  qcom,msm-id:
>> +    $ref: /schemas/types.yaml#/definitions/uint32-matrix
>> +    minItems: 1
>> +    maxItems: 8
>> +    items:
>> +      items:
>> +        - description: |
>> +            MSM chipset ID - an exact match value consisting of three bitfields::
>> +             - bits 0-15  - The unique MSM chipset ID
>> +             - bits 16-31 - Reserved; should be 0
>> +        - description: |
>> +            Hardware revision ID - a chipset specific 32-bit ID representing
>> +            the version of the chipset.  It is best a match value - the
>> +            bootloader will look for the closest possible match.
>> +    deprecated: true
>> +    description:
>> +      The MSM chipset and hardware revision use by Qualcomm bootloaders.  It
>> +      can optionally be an array of these to indicate multiple hardware that
>> +      use the same device tree.  It is expected that the bootloader will use
>> +      this information at boot-up to decide which device tree to use when given
>> +      multiple device trees, some of which may not be compatible with the
>> +      actual hardware.  It is the bootloader's responsibility to pass the
>> +      correct device tree to the kernel.
>> +      The property is deprecated - it is not expected on newer boards
>> +      (starting with SM8350).
> 
> I have been thinking about this for quite a while. I think this patch is 
> good.
> 
> With this paragraph (and the corresponding paragraph from the next item) 
> rephrased to remove references to 'newer boards':
> 
> Reviewed-by: Dmitry Baryshkov <[e-mail]>

Great, thanks! And thank you for responding in previous discussions.

I'll remove entire "newer boards ..." part, fix the "two bitfields" and
change the name of the define QCOM_ID_MSM8996. I won't add more board
IDs yet, this can be in following up patches (not only my me).

Best regards,
Krzysztof

Dmitry Baryshkov June 22, 2022, 9:50 a.m. UTC | #8

On 22/06/2022 12:49, Krzysztof Kozlowski wrote:
> On 22/06/2022 11:44, Dmitry Baryshkov wrote:
>> On 21/06/2022 21:56, Krzysztof Kozlowski wrote:
>>> The top level qcom,msm-id and qcom,board-id properties are utilized by
>>> bootloaders on Qualcomm MSM platforms to determine which device tree
>>> should be used and passed to the kernel.
>>>
>>> The commit b32e592d3c28 ("devicetree: bindings: Document qcom board
>>> compatible format") from 2015 was a consensus during discussion about
>>> upstreaming qcom,msm-id and qcom,board-id fields.  There are however still
>>> problems with that consensus:
>>> 1. It was reached 7 years ago but it turned out its implementation did
>>>      not reach all possible products.
>>>
>>> 2. Initially additional tool (dtbTool) was needed for parsing these
>>>      fields to create a QCDT image consisting of multiple DTBs, later the
>>>      bootloaders were improved and they use these qcom,msm-id and
>>>      qcom,board-id properties directly.
>>>
>>> 3. Extracting relevant information from the board compatible requires
>>>      this additional tool (dtbTool), which makes the build process more
>>>      complicated and not easily reproducible (DTBs are modified after the
>>>      kernel build).
>>>
>>> 4. Some versions of Qualcomm bootloaders expect these properties even
>>>      when booting with a single DTB.  The community is stuck with these
>>>      bootloaders thus they require properties in the DTBs.
>>>
>>> Since several upstreamed Qualcomm SoC-based boards require these
>>> properties to properly boot and the properties are reportedly used by
>>> bootloaders, document them.
>>>
>>> Link: https://lore.kernel.org/r/[e-mail]/
>>> Co-developed-by: Kumar Gala <[e-mail]>
>>> Signed-off-by: Kumar Gala <[e-mail]>
>>> Signed-off-by: Krzysztof Kozlowski <[e-mail]>
>>> ---
>>>    .../devicetree/bindings/arm/qcom.yaml         | 123 ++++++++++++++++++
>>>    include/dt-bindings/arm/qcom,ids.h            |  30 +++++
>>>    2 files changed, 153 insertions(+)
>>>    create mode 100644 include/dt-bindings/arm/qcom,ids.h
>>>
>>> diff --git a/Documentation/devicetree/bindings/arm/qcom.yaml b/Documentation/devicetree/bindings/arm/qcom.yaml
>>> index 6c38c1387afd..05b98cde4653 100644
>>> --- a/Documentation/devicetree/bindings/arm/qcom.yaml
>>> +++ b/Documentation/devicetree/bindings/arm/qcom.yaml
>>> @@ -403,6 +403,129 @@ properties:
>>>                  - qcom,sm8450-qrd
>>>              - const: qcom,sm8450
>>>    
>>> +  # Board compatibles go above
>>> +
>>> +  qcom,msm-id:
>>> +    $ref: /schemas/types.yaml#/definitions/uint32-matrix
>>> +    minItems: 1
>>> +    maxItems: 8
>>> +    items:
>>> +      items:
>>> +        - description: |
>>> +            MSM chipset ID - an exact match value consisting of three bitfields::
>>> +             - bits 0-15  - The unique MSM chipset ID
>>> +             - bits 16-31 - Reserved; should be 0
>>> +        - description: |
>>> +            Hardware revision ID - a chipset specific 32-bit ID representing
>>> +            the version of the chipset.  It is best a match value - the
>>> +            bootloader will look for the closest possible match.
>>> +    deprecated: true
>>> +    description:
>>> +      The MSM chipset and hardware revision use by Qualcomm bootloaders.  It
>>> +      can optionally be an array of these to indicate multiple hardware that
>>> +      use the same device tree.  It is expected that the bootloader will use
>>> +      this information at boot-up to decide which device tree to use when given
>>> +      multiple device trees, some of which may not be compatible with the
>>> +      actual hardware.  It is the bootloader's responsibility to pass the
>>> +      correct device tree to the kernel.
>>> +      The property is deprecated - it is not expected on newer boards
>>> +      (starting with SM8350).
>>
>> I have been thinking about this for quite a while. I think this patch is
>> good.
>>
>> With this paragraph (and the corresponding paragraph from the next item)
>> rephrased to remove references to 'newer boards':
>>
>> Reviewed-by: Dmitry Baryshkov <[e-mail]>
> 
> Great, thanks! And thank you for responding in previous discussions.
> 
> I'll remove entire "newer boards ..." part, fix the "two bitfields" and
> change the name of the define QCOM_ID_MSM8996. I won't add more board
> IDs yet, this can be in following up patches (not only my me).

This sounds perfect to me. Thanks a lot for your work on sorting this out!

Patch

diff --git a/Documentation/devicetree/bindings/arm/qcom.yaml b/Documentation/devicetree/bindings/arm/qcom.yaml
index 6c38c1387afd..05b98cde4653 100644
--- a/Documentation/devicetree/bindings/arm/qcom.yaml
+++ b/Documentation/devicetree/bindings/arm/qcom.yaml
@@ -403,6 +403,129 @@  properties:
               - qcom,sm8450-qrd
           - const: qcom,sm8450
 
+  # Board compatibles go above
+
+  qcom,msm-id:
+    $ref: /schemas/types.yaml#/definitions/uint32-matrix
+    minItems: 1
+    maxItems: 8
+    items:
+      items:
+        - description: |
+            MSM chipset ID - an exact match value consisting of three bitfields::
+             - bits 0-15  - The unique MSM chipset ID
+             - bits 16-31 - Reserved; should be 0
+        - description: |
+            Hardware revision ID - a chipset specific 32-bit ID representing
+            the version of the chipset.  It is best a match value - the
+            bootloader will look for the closest possible match.
+    deprecated: true
+    description:
+      The MSM chipset and hardware revision use by Qualcomm bootloaders.  It
+      can optionally be an array of these to indicate multiple hardware that
+      use the same device tree.  It is expected that the bootloader will use
+      this information at boot-up to decide which device tree to use when given
+      multiple device trees, some of which may not be compatible with the
+      actual hardware.  It is the bootloader's responsibility to pass the
+      correct device tree to the kernel.
+      The property is deprecated - it is not expected on newer boards
+      (starting with SM8350).
+
+  qcom,board-id:
+    $ref: /schemas/types.yaml#/definitions/uint32-matrix
+    minItems: 1
+    maxItems: 8
+    items:
+      oneOf:
+        - maxItems: 2
+          items:
+            - description: |
+                Board ID consisting of three bitfields::
+                  - bits 31-24 - Unused
+                  - bits 23-16 - Platform Version Major
+                  - bits 15-8  - Platform Version Minor
+                  - bits 7-0   - Platform Type
+                Platform Type field is an exact match value.  The
+                Platform Major/Minor field is a best match.  The bootloader will
+                look for the closest possible match.
+            - description: |
+                Subtype ID unique to a Platform Type/Chipset ID.  For a given
+                Platform Type, there will typically only be a single board and the
+                subtype_id will be 0.  However in some cases board variants may
+                need to be distinguished by different subtype_id values.
+        # OnePlus uses a variant of board-id with four elements:
+        - minItems: 4
+          items:
+            - const: 8
+            - const: 0
+            - description: OnePlus board ID
+            - description: OnePlus subtype ID
+    deprecated: true
+    description:
+      The board type and revision information.  It can optionally be an array
+      of these to indicate multiple boards that use the same device tree.  It
+      is expected that the bootloader will use this information at boot-up to
+      decide which device tree to use when given multiple device trees, some of
+      which may not be compatible with the actual hardware.  It is the
+      bootloader's responsibility to pass the correct device tree to the
+      kernel
+      The property is deprecated - it is not expected on newer boards
+      (starting with SM8350).
+
+allOf:
+  # Explicit allow-list for older SoCs. The legacy properties are not allowed
+  # on newer SoCs.
+  - if:
+      properties:
+        compatible:
+          contains:
+            enum:
+              - qcom,apq8026
+              - qcom,apq8094
+              - qcom,apq8096
+              - qcom,msm8992
+              - qcom,msm8994
+              - qcom,msm8996
+              - qcom,msm8998
+              - qcom,sdm630
+              - qcom,sdm632
+              - qcom,sdm845
+              - qcom,sdx55
+              - qcom,sdx65
+              - qcom,sm6125
+              - qcom,sm6350
+              - qcom,sm7225
+              - qcom,sm8150
+              - qcom,sm8250
+    then:
+      properties:
+        qcom,board-id: true
+        qcom,msm-id: true
+    else:
+      properties:
+        qcom,board-id: false
+        qcom,msm-id: false
+
+  - if:
+      properties:
+        compatible:
+          contains:
+            enum:
+              - oneplus,cheeseburger
+              - oneplus,dumpling
+              - oneplus,enchilada
+              - oneplus,fajita
+    then:
+      properties:
+        qcom,board-id:
+          items:
+            minItems: 4
+    else:
+      properties:
+        qcom,board-id:
+          items:
+            maxItems: 2
+
 additionalProperties: true
 
 ...
diff --git a/include/dt-bindings/arm/qcom,ids.h b/include/dt-bindings/arm/qcom,ids.h
new file mode 100644
index 000000000000..eaf86c18650f
--- /dev/null
+++ b/include/dt-bindings/arm/qcom,ids.h
@@ -0,0 +1,30 @@ 
+/* SPDX-License-Identifier: GPL-2.0-only */
+/*
+ * Copyright (c) 2015, The Linux Foundation. All rights reserved.
+ * Copyright (c) 2022 Linaro Ltd
+ * Author: Krzysztof Kozlowski <[e-mail]> based on previous work of Kumar Gala.
+ */
+#ifndef _DT_BINDINGS_ARM_QCOM_IDS_H
+#define _DT_BINDINGS_ARM_QCOM_IDS_H
+
+/* qcom,msm-id */
+#define QCOM_ID_APQ8026				199
+#define QCOM_ID_MSM8916				206
+#define QCOM_ID_MSM8994				207
+#define QCOM_ID_MSM8996_3_0			246
+#define QCOM_ID_APQ8016				247
+#define QCOM_ID_MSM8216				248
+#define QCOM_ID_MSM8116				249
+#define QCOM_ID_MSM8616				250
+#define QCOM_ID_MSM8998				292
+#define QCOM_ID_SDM845				321
+
+/* qcom,board-id */
+#define QCOM_BOARD_ID(a, major, minor) \
+	(((major & 0xff) << 16) | ((minor & 0xff) << 8) | QCOM_BOARD_ID_##a)
+
+#define QCOM_BOARD_ID_MTP			8
+#define QCOM_BOARD_ID_DRAGONBOARD		10
+#define QCOM_BOARD_ID_SBC			24
+
+#endif /* _DT_BINDINGS_ARM_QCOM_IDS_H */