diff mbox series

[1/3] dt-bindings: arm: qcom: Add sc7180 Chromebook board bindings

Message ID 20220512090429.1.I9804fcd5d6c8552ab25f598dd7a3ea71b15b55f0@changeid
State New
Headers show
Series [1/3] dt-bindings: arm: qcom: Add sc7180 Chromebook board bindings | expand

Commit Message

Doug Anderson May 12, 2022, 4:04 p.m. UTC
This copy-pastes compatibles from sc7180-based boards from the device
trees to the yaml file so that `make dtbs_check` will be happy.

NOTES:
- I make no attempt to try to share an "item" for all sc7180 based
  Chromebooks. Because of the revision matching scheme used by the
  Chromebook bootloader, at times we need a different number of
  revisions listed.
- Some of the odd entries in here (like google,homestar-rev23 or the
  fact that "Google Lazor Limozeen without Touchscreen" changed from
  sku5 to sku6) are not typos but simply reflect reality.
- Many revisions of boards here never actually went to consumers, but
  they are still in use within various companies that were involved in
  Chromebook development. Since Chromebooks are developed with an
  "upstream first" methodology, having these revisions supported with
  upstream Linux is important. Making it easy for Chromebooks to be
  developed with an "upstream first" methodology is valuable to the
  upstream community because it improves the quality of upstream and
  gets Chromebooks supported with vanilla upstream faster.

Signed-off-by: Douglas Anderson <dianders@chromium.org>
---

 .../devicetree/bindings/arm/qcom.yaml         | 180 ++++++++++++++++++
 1 file changed, 180 insertions(+)

Comments

Krzysztof Kozlowski May 13, 2022, 7:57 a.m. UTC | #1
On 12/05/2022 18:04, Douglas Anderson wrote:
> This copy-pastes compatibles from sc7180-based boards from the device
> trees to the yaml file so that `make dtbs_check` will be happy.
> 
> NOTES:
> - I make no attempt to try to share an "item" for all sc7180 based
>   Chromebooks. Because of the revision matching scheme used by the
>   Chromebook bootloader, at times we need a different number of
>   revisions listed.
> - Some of the odd entries in here (like google,homestar-rev23 or the
>   fact that "Google Lazor Limozeen without Touchscreen" changed from
>   sku5 to sku6) are not typos but simply reflect reality.
> - Many revisions of boards here never actually went to consumers, but
>   they are still in use within various companies that were involved in
>   Chromebook development. Since Chromebooks are developed with an
>   "upstream first" methodology, having these revisions supported with
>   upstream Linux is important. Making it easy for Chromebooks to be
>   developed with an "upstream first" methodology is valuable to the
>   upstream community because it improves the quality of upstream and
>   gets Chromebooks supported with vanilla upstream faster.
> 
> Signed-off-by: Douglas Anderson <dianders@chromium.org>
> ---
> 
>  .../devicetree/bindings/arm/qcom.yaml         | 180 ++++++++++++++++++
>  1 file changed, 180 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/arm/qcom.yaml b/Documentation/devicetree/bindings/arm/qcom.yaml
> index 5c06d1bfc046..399be67eb5d2 100644
> --- a/Documentation/devicetree/bindings/arm/qcom.yaml
> +++ b/Documentation/devicetree/bindings/arm/qcom.yaml
> @@ -214,11 +214,191 @@ properties:
>                - qcom,ipq8074-hk10-c2
>            - const: qcom,ipq8074
>  
> +      # Qualcomm Technologies, Inc. SC7180 IDP
>        - items:
>            - enum:
>                - qcom,sc7180-idp
>            - const: qcom,sc7180
>  
> +      # Google CoachZ (rev1 - 2)
> +      - items:
> +          - const: google,coachz-rev1
> +          - const: google,coachz-rev2

The inverted pattern of old revision being compatible with the new one,
is done on purpose? You claim here every rev1 is always compatible with
rev2 ...

I don't think we discussed such patterns in previous talk. I quickly
went through it and there were only skuX moving around, not rev1 being
newer then rev2.

Best regards,
Krzysztof
Krzysztof Kozlowski May 13, 2022, 9 a.m. UTC | #2
On 13/05/2022 09:57, Krzysztof Kozlowski wrote:
> On 12/05/2022 18:04, Douglas Anderson wrote:
>> This copy-pastes compatibles from sc7180-based boards from the device
>> trees to the yaml file so that `make dtbs_check` will be happy.
>>
>> NOTES:
>> - I make no attempt to try to share an "item" for all sc7180 based
>>   Chromebooks. Because of the revision matching scheme used by the
>>   Chromebook bootloader, at times we need a different number of
>>   revisions listed.
>> - Some of the odd entries in here (like google,homestar-rev23 or the
>>   fact that "Google Lazor Limozeen without Touchscreen" changed from
>>   sku5 to sku6) are not typos but simply reflect reality.
>> - Many revisions of boards here never actually went to consumers, but
>>   they are still in use within various companies that were involved in
>>   Chromebook development. Since Chromebooks are developed with an
>>   "upstream first" methodology, having these revisions supported with
>>   upstream Linux is important. Making it easy for Chromebooks to be
>>   developed with an "upstream first" methodology is valuable to the
>>   upstream community because it improves the quality of upstream and
>>   gets Chromebooks supported with vanilla upstream faster.
>>
>> Signed-off-by: Douglas Anderson <dianders@chromium.org>
>> ---
>>
>>  .../devicetree/bindings/arm/qcom.yaml         | 180 ++++++++++++++++++
>>  1 file changed, 180 insertions(+)
>>
>> diff --git a/Documentation/devicetree/bindings/arm/qcom.yaml b/Documentation/devicetree/bindings/arm/qcom.yaml
>> index 5c06d1bfc046..399be67eb5d2 100644
>> --- a/Documentation/devicetree/bindings/arm/qcom.yaml
>> +++ b/Documentation/devicetree/bindings/arm/qcom.yaml
>> @@ -214,11 +214,191 @@ properties:
>>                - qcom,ipq8074-hk10-c2
>>            - const: qcom,ipq8074
>>  
>> +      # Qualcomm Technologies, Inc. SC7180 IDP
>>        - items:
>>            - enum:
>>                - qcom,sc7180-idp
>>            - const: qcom,sc7180
>>  
>> +      # Google CoachZ (rev1 - 2)
>> +      - items:
>> +          - const: google,coachz-rev1
>> +          - const: google,coachz-rev2
> 
> The inverted pattern of old revision being compatible with the new one,
> is done on purpose? You claim here every rev1 is always compatible with
> rev2 ...
> 
> I don't think we discussed such patterns in previous talk. I quickly
> went through it and there were only skuX moving around, not rev1 being
> newer then rev2.

BTW, your other Chromebooks use logical order:

https://lore.kernel.org/all/20220512205602.158273-2-nfraprado@collabora.com/




Best regards,
Krzysztof
Doug Anderson May 13, 2022, 5 p.m. UTC | #3
Hi,

On Fri, May 13, 2022 at 2:01 AM Krzysztof Kozlowski
<krzysztof.kozlowski@linaro.org> wrote:
>
> On 13/05/2022 09:57, Krzysztof Kozlowski wrote:
> > On 12/05/2022 18:04, Douglas Anderson wrote:
> >> This copy-pastes compatibles from sc7180-based boards from the device
> >> trees to the yaml file so that `make dtbs_check` will be happy.
> >>
> >> NOTES:
> >> - I make no attempt to try to share an "item" for all sc7180 based
> >>   Chromebooks. Because of the revision matching scheme used by the
> >>   Chromebook bootloader, at times we need a different number of
> >>   revisions listed.
> >> - Some of the odd entries in here (like google,homestar-rev23 or the
> >>   fact that "Google Lazor Limozeen without Touchscreen" changed from
> >>   sku5 to sku6) are not typos but simply reflect reality.
> >> - Many revisions of boards here never actually went to consumers, but
> >>   they are still in use within various companies that were involved in
> >>   Chromebook development. Since Chromebooks are developed with an
> >>   "upstream first" methodology, having these revisions supported with
> >>   upstream Linux is important. Making it easy for Chromebooks to be
> >>   developed with an "upstream first" methodology is valuable to the
> >>   upstream community because it improves the quality of upstream and
> >>   gets Chromebooks supported with vanilla upstream faster.
> >>
> >> Signed-off-by: Douglas Anderson <dianders@chromium.org>
> >> ---
> >>
> >>  .../devicetree/bindings/arm/qcom.yaml         | 180 ++++++++++++++++++
> >>  1 file changed, 180 insertions(+)
> >>
> >> diff --git a/Documentation/devicetree/bindings/arm/qcom.yaml b/Documentation/devicetree/bindings/arm/qcom.yaml
> >> index 5c06d1bfc046..399be67eb5d2 100644
> >> --- a/Documentation/devicetree/bindings/arm/qcom.yaml
> >> +++ b/Documentation/devicetree/bindings/arm/qcom.yaml
> >> @@ -214,11 +214,191 @@ properties:
> >>                - qcom,ipq8074-hk10-c2
> >>            - const: qcom,ipq8074
> >>
> >> +      # Qualcomm Technologies, Inc. SC7180 IDP
> >>        - items:
> >>            - enum:
> >>                - qcom,sc7180-idp
> >>            - const: qcom,sc7180
> >>
> >> +      # Google CoachZ (rev1 - 2)
> >> +      - items:
> >> +          - const: google,coachz-rev1
> >> +          - const: google,coachz-rev2
> >
> > The inverted pattern of old revision being compatible with the new one,
> > is done on purpose? You claim here every rev1 is always compatible with
> > rev2 ...
> >
> > I don't think we discussed such patterns in previous talk. I quickly
> > went through it and there were only skuX moving around, not rev1 being
> > newer then rev2.

Isn't this what we just had a whole discussion about?

Oh, I see. You're objecting to the fact that the order here lists
"rev1" first and "rev2" second.

I think the issue here is that for the purposes of booting Chromebooks
the order here doesn't matter. Certainly we can pick a fixed order and
we can validate that the order in the yaml matches the order in the
device tree, but for all intents and purposes it doesn't matter to
anything. The same device tree is compatible with _both_ rev1 and rev2
coachz devices. Neither of those two devices is inherently better
supported by this device tree than the other.

We can reorder them if it's important for some reason, but it doesn't
change the facts of the matter. You can't tell whether you've booted a
"-rev1" Chromebook or a "-rev2" Chromebook based on the most specific
compatible string.

As per the other discussion, we could "solve" this by making two
device trees that were exactly the same but one of them had the
compatible "-rev1" the other "-rev2". This would result in a big
explosion in the number of device trees in our FIT Image for very
little gain. It also fails to solve the "newest rev" problem.


OK, so I've written up a description of the whole system. Maybe it
will be clearer with that and we can continue the discussion in my v2
if needed.

https://lore.kernel.org/r/20220513095722.v2.1.I71e42c6174f1cec17da3024c9f73ba373263b9b6@changeid

-Doug
Krzysztof Kozlowski May 16, 2022, 6:40 a.m. UTC | #4
On 13/05/2022 19:00, Doug Anderson wrote:
> Hi,
> 
> On Fri, May 13, 2022 at 2:01 AM Krzysztof Kozlowski
> <krzysztof.kozlowski@linaro.org> wrote:
>>
>> On 13/05/2022 09:57, Krzysztof Kozlowski wrote:
>>> On 12/05/2022 18:04, Douglas Anderson wrote:
>>>> This copy-pastes compatibles from sc7180-based boards from the device
>>>> trees to the yaml file so that `make dtbs_check` will be happy.
>>>>
>>>> NOTES:
>>>> - I make no attempt to try to share an "item" for all sc7180 based
>>>>   Chromebooks. Because of the revision matching scheme used by the
>>>>   Chromebook bootloader, at times we need a different number of
>>>>   revisions listed.
>>>> - Some of the odd entries in here (like google,homestar-rev23 or the
>>>>   fact that "Google Lazor Limozeen without Touchscreen" changed from
>>>>   sku5 to sku6) are not typos but simply reflect reality.
>>>> - Many revisions of boards here never actually went to consumers, but
>>>>   they are still in use within various companies that were involved in
>>>>   Chromebook development. Since Chromebooks are developed with an
>>>>   "upstream first" methodology, having these revisions supported with
>>>>   upstream Linux is important. Making it easy for Chromebooks to be
>>>>   developed with an "upstream first" methodology is valuable to the
>>>>   upstream community because it improves the quality of upstream and
>>>>   gets Chromebooks supported with vanilla upstream faster.
>>>>
>>>> Signed-off-by: Douglas Anderson <dianders@chromium.org>
>>>> ---
>>>>
>>>>  .../devicetree/bindings/arm/qcom.yaml         | 180 ++++++++++++++++++
>>>>  1 file changed, 180 insertions(+)
>>>>
>>>> diff --git a/Documentation/devicetree/bindings/arm/qcom.yaml b/Documentation/devicetree/bindings/arm/qcom.yaml
>>>> index 5c06d1bfc046..399be67eb5d2 100644
>>>> --- a/Documentation/devicetree/bindings/arm/qcom.yaml
>>>> +++ b/Documentation/devicetree/bindings/arm/qcom.yaml
>>>> @@ -214,11 +214,191 @@ properties:
>>>>                - qcom,ipq8074-hk10-c2
>>>>            - const: qcom,ipq8074
>>>>
>>>> +      # Qualcomm Technologies, Inc. SC7180 IDP
>>>>        - items:
>>>>            - enum:
>>>>                - qcom,sc7180-idp
>>>>            - const: qcom,sc7180
>>>>
>>>> +      # Google CoachZ (rev1 - 2)
>>>> +      - items:
>>>> +          - const: google,coachz-rev1
>>>> +          - const: google,coachz-rev2
>>>
>>> The inverted pattern of old revision being compatible with the new one,
>>> is done on purpose? You claim here every rev1 is always compatible with
>>> rev2 ...
>>>
>>> I don't think we discussed such patterns in previous talk. I quickly
>>> went through it and there were only skuX moving around, not rev1 being
>>> newer then rev2.
> 
> Isn't this what we just had a whole discussion about?
> 
> Oh, I see. You're objecting to the fact that the order here lists
> "rev1" first and "rev2" second.
> 
> I think the issue here is that for the purposes of booting Chromebooks
> the order here doesn't matter. Certainly we can pick a fixed order and
> we can validate that the order in the yaml matches the order in the
> device tree, but for all intents and purposes it doesn't matter to
> anything. The same device tree is compatible with _both_ rev1 and rev2
> coachz devices. Neither of those two devices is inherently better
> supported by this device tree than the other.

OK, thanks for explanation. Since these were not documented maybe fixing
existing DTS to more expected order (rev2 being the newest, rev1
following) would make sense. But certainly please use such new order
compatibles for new DTSes.

> 
> We can reorder them if it's important for some reason, but it doesn't
> change the facts of the matter. You can't tell whether you've booted a
> "-rev1" Chromebook or a "-rev2" Chromebook based on the most specific
> compatible string.

Of course you cannot, because DT is not for such case (when you can use
different DT for booting on different hardware...)

> 
> As per the other discussion, we could "solve" this by making two
> device trees that were exactly the same but one of them had the
> compatible "-rev1" the other "-rev2". This would result in a big
> explosion in the number of device trees in our FIT Image for very
> little gain. It also fails to solve the "newest rev" problem.
> 
> 
> OK, so I've written up a description of the whole system. Maybe it
> will be clearer with that and we can continue the discussion in my v2
> if needed.
> 
> https://lore.kernel.org/r/20220513095722.v2.1.I71e42c6174f1cec17da3024c9f73ba373263b9b6@changeid
> 
> -Doug


Best regards,
Krzysztof
Doug Anderson May 16, 2022, 3:11 p.m. UTC | #5
Hi,

On Sun, May 15, 2022 at 11:40 PM Krzysztof Kozlowski
<krzysztof.kozlowski@linaro.org> wrote:
>
> On 13/05/2022 19:00, Doug Anderson wrote:
> > Hi,
> >
> > On Fri, May 13, 2022 at 2:01 AM Krzysztof Kozlowski
> > <krzysztof.kozlowski@linaro.org> wrote:
> >>
> >> On 13/05/2022 09:57, Krzysztof Kozlowski wrote:
> >>> On 12/05/2022 18:04, Douglas Anderson wrote:
> >>>> This copy-pastes compatibles from sc7180-based boards from the device
> >>>> trees to the yaml file so that `make dtbs_check` will be happy.
> >>>>
> >>>> NOTES:
> >>>> - I make no attempt to try to share an "item" for all sc7180 based
> >>>>   Chromebooks. Because of the revision matching scheme used by the
> >>>>   Chromebook bootloader, at times we need a different number of
> >>>>   revisions listed.
> >>>> - Some of the odd entries in here (like google,homestar-rev23 or the
> >>>>   fact that "Google Lazor Limozeen without Touchscreen" changed from
> >>>>   sku5 to sku6) are not typos but simply reflect reality.
> >>>> - Many revisions of boards here never actually went to consumers, but
> >>>>   they are still in use within various companies that were involved in
> >>>>   Chromebook development. Since Chromebooks are developed with an
> >>>>   "upstream first" methodology, having these revisions supported with
> >>>>   upstream Linux is important. Making it easy for Chromebooks to be
> >>>>   developed with an "upstream first" methodology is valuable to the
> >>>>   upstream community because it improves the quality of upstream and
> >>>>   gets Chromebooks supported with vanilla upstream faster.
> >>>>
> >>>> Signed-off-by: Douglas Anderson <dianders@chromium.org>
> >>>> ---
> >>>>
> >>>>  .../devicetree/bindings/arm/qcom.yaml         | 180 ++++++++++++++++++
> >>>>  1 file changed, 180 insertions(+)
> >>>>
> >>>> diff --git a/Documentation/devicetree/bindings/arm/qcom.yaml b/Documentation/devicetree/bindings/arm/qcom.yaml
> >>>> index 5c06d1bfc046..399be67eb5d2 100644
> >>>> --- a/Documentation/devicetree/bindings/arm/qcom.yaml
> >>>> +++ b/Documentation/devicetree/bindings/arm/qcom.yaml
> >>>> @@ -214,11 +214,191 @@ properties:
> >>>>                - qcom,ipq8074-hk10-c2
> >>>>            - const: qcom,ipq8074
> >>>>
> >>>> +      # Qualcomm Technologies, Inc. SC7180 IDP
> >>>>        - items:
> >>>>            - enum:
> >>>>                - qcom,sc7180-idp
> >>>>            - const: qcom,sc7180
> >>>>
> >>>> +      # Google CoachZ (rev1 - 2)
> >>>> +      - items:
> >>>> +          - const: google,coachz-rev1
> >>>> +          - const: google,coachz-rev2
> >>>
> >>> The inverted pattern of old revision being compatible with the new one,
> >>> is done on purpose? You claim here every rev1 is always compatible with
> >>> rev2 ...
> >>>
> >>> I don't think we discussed such patterns in previous talk. I quickly
> >>> went through it and there were only skuX moving around, not rev1 being
> >>> newer then rev2.
> >
> > Isn't this what we just had a whole discussion about?
> >
> > Oh, I see. You're objecting to the fact that the order here lists
> > "rev1" first and "rev2" second.
> >
> > I think the issue here is that for the purposes of booting Chromebooks
> > the order here doesn't matter. Certainly we can pick a fixed order and
> > we can validate that the order in the yaml matches the order in the
> > device tree, but for all intents and purposes it doesn't matter to
> > anything. The same device tree is compatible with _both_ rev1 and rev2
> > coachz devices. Neither of those two devices is inherently better
> > supported by this device tree than the other.
>
> OK, thanks for explanation. Since these were not documented maybe fixing
> existing DTS to more expected order (rev2 being the newest, rev1
> following) would make sense. But certainly please use such new order
> compatibles for new DTSes.

I'm still not sure I understand: if the list of revisions is
effectively unordered, why does it matter which order they are listed
in? Certainly we can change the order, but I'm not sure how I justify
the extra churn in my patch description.

-Doug
Krzysztof Kozlowski May 16, 2022, 3:14 p.m. UTC | #6
On 16/05/2022 17:11, Doug Anderson wrote:
> Hi,
> 
> On Sun, May 15, 2022 at 11:40 PM Krzysztof Kozlowski
> <krzysztof.kozlowski@linaro.org> wrote:
>>
>> On 13/05/2022 19:00, Doug Anderson wrote:
>>> Hi,
>>>
>>> On Fri, May 13, 2022 at 2:01 AM Krzysztof Kozlowski
>>> <krzysztof.kozlowski@linaro.org> wrote:
>>>>
>>>> On 13/05/2022 09:57, Krzysztof Kozlowski wrote:
>>>>> On 12/05/2022 18:04, Douglas Anderson wrote:
>>>>>> This copy-pastes compatibles from sc7180-based boards from the device
>>>>>> trees to the yaml file so that `make dtbs_check` will be happy.
>>>>>>
>>>>>> NOTES:
>>>>>> - I make no attempt to try to share an "item" for all sc7180 based
>>>>>>   Chromebooks. Because of the revision matching scheme used by the
>>>>>>   Chromebook bootloader, at times we need a different number of
>>>>>>   revisions listed.
>>>>>> - Some of the odd entries in here (like google,homestar-rev23 or the
>>>>>>   fact that "Google Lazor Limozeen without Touchscreen" changed from
>>>>>>   sku5 to sku6) are not typos but simply reflect reality.
>>>>>> - Many revisions of boards here never actually went to consumers, but
>>>>>>   they are still in use within various companies that were involved in
>>>>>>   Chromebook development. Since Chromebooks are developed with an
>>>>>>   "upstream first" methodology, having these revisions supported with
>>>>>>   upstream Linux is important. Making it easy for Chromebooks to be
>>>>>>   developed with an "upstream first" methodology is valuable to the
>>>>>>   upstream community because it improves the quality of upstream and
>>>>>>   gets Chromebooks supported with vanilla upstream faster.
>>>>>>
>>>>>> Signed-off-by: Douglas Anderson <dianders@chromium.org>
>>>>>> ---
>>>>>>
>>>>>>  .../devicetree/bindings/arm/qcom.yaml         | 180 ++++++++++++++++++
>>>>>>  1 file changed, 180 insertions(+)
>>>>>>
>>>>>> diff --git a/Documentation/devicetree/bindings/arm/qcom.yaml b/Documentation/devicetree/bindings/arm/qcom.yaml
>>>>>> index 5c06d1bfc046..399be67eb5d2 100644
>>>>>> --- a/Documentation/devicetree/bindings/arm/qcom.yaml
>>>>>> +++ b/Documentation/devicetree/bindings/arm/qcom.yaml
>>>>>> @@ -214,11 +214,191 @@ properties:
>>>>>>                - qcom,ipq8074-hk10-c2
>>>>>>            - const: qcom,ipq8074
>>>>>>
>>>>>> +      # Qualcomm Technologies, Inc. SC7180 IDP
>>>>>>        - items:
>>>>>>            - enum:
>>>>>>                - qcom,sc7180-idp
>>>>>>            - const: qcom,sc7180
>>>>>>
>>>>>> +      # Google CoachZ (rev1 - 2)
>>>>>> +      - items:
>>>>>> +          - const: google,coachz-rev1
>>>>>> +          - const: google,coachz-rev2
>>>>>
>>>>> The inverted pattern of old revision being compatible with the new one,
>>>>> is done on purpose? You claim here every rev1 is always compatible with
>>>>> rev2 ...
>>>>>
>>>>> I don't think we discussed such patterns in previous talk. I quickly
>>>>> went through it and there were only skuX moving around, not rev1 being
>>>>> newer then rev2.
>>>
>>> Isn't this what we just had a whole discussion about?
>>>
>>> Oh, I see. You're objecting to the fact that the order here lists
>>> "rev1" first and "rev2" second.
>>>
>>> I think the issue here is that for the purposes of booting Chromebooks
>>> the order here doesn't matter. Certainly we can pick a fixed order and
>>> we can validate that the order in the yaml matches the order in the
>>> device tree, but for all intents and purposes it doesn't matter to
>>> anything. The same device tree is compatible with _both_ rev1 and rev2
>>> coachz devices. Neither of those two devices is inherently better
>>> supported by this device tree than the other.
>>
>> OK, thanks for explanation. Since these were not documented maybe fixing
>> existing DTS to more expected order (rev2 being the newest, rev1
>> following) would make sense. But certainly please use such new order
>> compatibles for new DTSes.
> 
> I'm still not sure I understand: if the list of revisions is
> effectively unordered, why does it matter which order they are listed
> in? Certainly we can change the order, but I'm not sure how I justify
> the extra churn in my patch description.

The list for the bindings (YAML), the toolset and for the Devicetree
spec is ordered. Even if it is not ordered for your bootloader
implementation. Your current order is a bit confusing:

compatible = "google,coachz-rev1", "google,coachz-rev2", "qcom,sc7180";

Changing the order in existing DTS, might not be worth. I propose then
to introduce the logical order in the future, so for new DTS:

compatible = "google,XXX-rev2", "google,XXX-rev1", "qcom,sc7180";

I understood that for your bootloader it does not matter.

Best regards,
Krzysztof
Doug Anderson May 16, 2022, 3:20 p.m. UTC | #7
Hi,

On Mon, May 16, 2022 at 8:15 AM Krzysztof Kozlowski
<krzysztof.kozlowski@linaro.org> wrote:
>
> On 16/05/2022 17:11, Doug Anderson wrote:
> > Hi,
> >
> > On Sun, May 15, 2022 at 11:40 PM Krzysztof Kozlowski
> > <krzysztof.kozlowski@linaro.org> wrote:
> >>
> >> On 13/05/2022 19:00, Doug Anderson wrote:
> >>> Hi,
> >>>
> >>> On Fri, May 13, 2022 at 2:01 AM Krzysztof Kozlowski
> >>> <krzysztof.kozlowski@linaro.org> wrote:
> >>>>
> >>>> On 13/05/2022 09:57, Krzysztof Kozlowski wrote:
> >>>>> On 12/05/2022 18:04, Douglas Anderson wrote:
> >>>>>> This copy-pastes compatibles from sc7180-based boards from the device
> >>>>>> trees to the yaml file so that `make dtbs_check` will be happy.
> >>>>>>
> >>>>>> NOTES:
> >>>>>> - I make no attempt to try to share an "item" for all sc7180 based
> >>>>>>   Chromebooks. Because of the revision matching scheme used by the
> >>>>>>   Chromebook bootloader, at times we need a different number of
> >>>>>>   revisions listed.
> >>>>>> - Some of the odd entries in here (like google,homestar-rev23 or the
> >>>>>>   fact that "Google Lazor Limozeen without Touchscreen" changed from
> >>>>>>   sku5 to sku6) are not typos but simply reflect reality.
> >>>>>> - Many revisions of boards here never actually went to consumers, but
> >>>>>>   they are still in use within various companies that were involved in
> >>>>>>   Chromebook development. Since Chromebooks are developed with an
> >>>>>>   "upstream first" methodology, having these revisions supported with
> >>>>>>   upstream Linux is important. Making it easy for Chromebooks to be
> >>>>>>   developed with an "upstream first" methodology is valuable to the
> >>>>>>   upstream community because it improves the quality of upstream and
> >>>>>>   gets Chromebooks supported with vanilla upstream faster.
> >>>>>>
> >>>>>> Signed-off-by: Douglas Anderson <dianders@chromium.org>
> >>>>>> ---
> >>>>>>
> >>>>>>  .../devicetree/bindings/arm/qcom.yaml         | 180 ++++++++++++++++++
> >>>>>>  1 file changed, 180 insertions(+)
> >>>>>>
> >>>>>> diff --git a/Documentation/devicetree/bindings/arm/qcom.yaml b/Documentation/devicetree/bindings/arm/qcom.yaml
> >>>>>> index 5c06d1bfc046..399be67eb5d2 100644
> >>>>>> --- a/Documentation/devicetree/bindings/arm/qcom.yaml
> >>>>>> +++ b/Documentation/devicetree/bindings/arm/qcom.yaml
> >>>>>> @@ -214,11 +214,191 @@ properties:
> >>>>>>                - qcom,ipq8074-hk10-c2
> >>>>>>            - const: qcom,ipq8074
> >>>>>>
> >>>>>> +      # Qualcomm Technologies, Inc. SC7180 IDP
> >>>>>>        - items:
> >>>>>>            - enum:
> >>>>>>                - qcom,sc7180-idp
> >>>>>>            - const: qcom,sc7180
> >>>>>>
> >>>>>> +      # Google CoachZ (rev1 - 2)
> >>>>>> +      - items:
> >>>>>> +          - const: google,coachz-rev1
> >>>>>> +          - const: google,coachz-rev2
> >>>>>
> >>>>> The inverted pattern of old revision being compatible with the new one,
> >>>>> is done on purpose? You claim here every rev1 is always compatible with
> >>>>> rev2 ...
> >>>>>
> >>>>> I don't think we discussed such patterns in previous talk. I quickly
> >>>>> went through it and there were only skuX moving around, not rev1 being
> >>>>> newer then rev2.
> >>>
> >>> Isn't this what we just had a whole discussion about?
> >>>
> >>> Oh, I see. You're objecting to the fact that the order here lists
> >>> "rev1" first and "rev2" second.
> >>>
> >>> I think the issue here is that for the purposes of booting Chromebooks
> >>> the order here doesn't matter. Certainly we can pick a fixed order and
> >>> we can validate that the order in the yaml matches the order in the
> >>> device tree, but for all intents and purposes it doesn't matter to
> >>> anything. The same device tree is compatible with _both_ rev1 and rev2
> >>> coachz devices. Neither of those two devices is inherently better
> >>> supported by this device tree than the other.
> >>
> >> OK, thanks for explanation. Since these were not documented maybe fixing
> >> existing DTS to more expected order (rev2 being the newest, rev1
> >> following) would make sense. But certainly please use such new order
> >> compatibles for new DTSes.
> >
> > I'm still not sure I understand: if the list of revisions is
> > effectively unordered, why does it matter which order they are listed
> > in? Certainly we can change the order, but I'm not sure how I justify
> > the extra churn in my patch description.
>
> The list for the bindings (YAML), the toolset and for the Devicetree
> spec is ordered. Even if it is not ordered for your bootloader
> implementation.

Understood. This is just like clocks where technically they are
unordered (because you have "clock-names" to look them up) but it is
expected that the order be documented and consistent, if nothing else
to make it easier to validate.


> Your current order is a bit confusing:
>
> compatible = "google,coachz-rev1", "google,coachz-rev2", "qcom,sc7180";
>
> Changing the order in existing DTS, might not be worth.

OK, I'll leave the existing DTS alone.


> I propose then
> to introduce the logical order in the future, so for new DTS:
>
> compatible = "google,XXX-rev2", "google,XXX-rev1", "qcom,sc7180";
>
> I understood that for your bootloader it does not matter.

Sure. I'm not sure why it's any less confusing to list higher
revisions first, but if you find it less confusing we can do it in the
future.

-Doug
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/arm/qcom.yaml b/Documentation/devicetree/bindings/arm/qcom.yaml
index 5c06d1bfc046..399be67eb5d2 100644
--- a/Documentation/devicetree/bindings/arm/qcom.yaml
+++ b/Documentation/devicetree/bindings/arm/qcom.yaml
@@ -214,11 +214,191 @@  properties:
               - qcom,ipq8074-hk10-c2
           - const: qcom,ipq8074
 
+      # Qualcomm Technologies, Inc. SC7180 IDP
       - items:
           - enum:
               - qcom,sc7180-idp
           - const: qcom,sc7180
 
+      # Google CoachZ (rev1 - 2)
+      - items:
+          - const: google,coachz-rev1
+          - const: google,coachz-rev2
+          - const: qcom,sc7180
+
+      # Google CoachZ (newest rev)
+      - items:
+          - const: google,coachz
+          - const: qcom,sc7180
+
+      # Google CoachZ with LTE (rev1 - 2)
+      - items:
+          - const: google,coachz-rev1-sku0
+          - const: google,coachz-rev2-sku0
+          - const: qcom,sc7180
+
+      # Google CoachZ with LTE (newest rev)
+      - items:
+          - const: google,coachz-sku0
+          - const: qcom,sc7180
+
+      # Google Homestar (rev2)
+      - items:
+          - const: google,homestar-rev2
+          - const: google,homestar-rev23
+          - const: qcom,sc7180
+
+      # Google Homestar (rev3)
+      - items:
+          - const: google,homestar-rev3
+          - const: qcom,sc7180
+
+      # Google Homestar (newest rev)
+      - items:
+          - const: google,homestar
+          - const: qcom,sc7180
+
+      # Google Lazor (rev0)
+      - items:
+          - const: google,lazor-rev0
+          - const: qcom,sc7180
+
+      # Google Lazor (rev1 - 2)
+      - items:
+          - const: google,lazor-rev1
+          - const: google,lazor-rev2
+          - const: qcom,sc7180
+
+      # Google Lazor (rev3 - 8)
+      - items:
+          - const: google,lazor-rev3
+          - const: google,lazor-rev4
+          - const: google,lazor-rev5
+          - const: google,lazor-rev6
+          - const: google,lazor-rev7
+          - const: google,lazor-rev8
+          - const: qcom,sc7180
+
+      # Google Lazor (newest rev)
+      - items:
+          - const: google,lazor
+          - const: qcom,sc7180
+
+      # Google Lazor with KB Backlight (rev1 - 2)
+      - items:
+          - const: google,lazor-rev1-sku2
+          - const: google,lazor-rev2-sku2
+          - const: qcom,sc7180
+
+      # Google Lazor with KB Backlight (rev3 - 8)
+      - items:
+          - const: google,lazor-rev3-sku2
+          - const: google,lazor-rev4-sku2
+          - const: google,lazor-rev5-sku2
+          - const: google,lazor-rev6-sku2
+          - const: google,lazor-rev7-sku2
+          - const: google,lazor-rev8-sku2
+          - const: qcom,sc7180
+
+      # Google Lazor with KB Backlight (newest rev)
+      - items:
+          - const: google,lazor-sku2
+          - const: qcom,sc7180
+
+      # Google Lazor with LTE (rev1 - 2)
+      - items:
+          - const: google,lazor-rev1-sku0
+          - const: google,lazor-rev2-sku0
+          - const: qcom,sc7180
+
+      # Google Lazor with LTE (rev3 - 8)
+      - items:
+          - const: google,lazor-rev3-sku0
+          - const: google,lazor-rev4-sku0
+          - const: google,lazor-rev5-sku0
+          - const: google,lazor-rev6-sku0
+          - const: google,lazor-rev7-sku0
+          - const: google,lazor-rev8-sku0
+          - const: qcom,sc7180
+
+      # Google Lazor with LTE (newest rev)
+      - items:
+          - const: google,lazor-sku0
+          - const: qcom,sc7180
+
+      # Google Lazor Limozeen (rev4 - rev8)
+      - items:
+          - const: google,lazor-rev4-sku4
+          - const: google,lazor-rev5-sku4
+          - const: google,lazor-rev6-sku4
+          - const: google,lazor-rev7-sku4
+          - const: google,lazor-rev8-sku4
+          - const: qcom,sc7180
+
+      # Google Lazor Limozeen (newest rev)
+      - items:
+          - const: google,lazor-sku4
+          - const: qcom,sc7180
+
+      # Google Lazor Limozeen without Touchscreen (rev4)
+      - items:
+          - const: google,lazor-rev4-sku5
+          - const: qcom,sc7180
+
+      # Google Lazor Limozeen without Touchscreen (rev5 - rev8)
+      - items:
+          - const: google,lazor-rev5-sku5
+          - const: google,lazor-rev5-sku6
+          - const: google,lazor-rev6-sku6
+          - const: google,lazor-rev7-sku6
+          - const: google,lazor-rev8-sku6
+          - const: qcom,sc7180
+
+      # Google Lazor Limozeen without Touchscreen (newest rev)
+      - items:
+          - const: google,lazor-sku6
+          - const: qcom,sc7180
+
+      # Google Pompom (rev1)
+      - items:
+          - const: google,pompom-rev1
+          - const: qcom,sc7180
+
+      # Google Pompom (rev2)
+      - items:
+          - const: google,pompom-rev2
+          - const: qcom,sc7180
+
+      # Google Pompom (newest rev)
+      - items:
+          - const: google,pompom
+          - const: qcom,sc7180
+
+      # Google Pompom with LTE (rev1)
+      - items:
+          - const: google,pompom-rev1-sku0
+          - const: qcom,sc7180
+
+      # Google Pompom with LTE (rev2)
+      - items:
+          - const: google,pompom-rev2-sku0
+          - const: qcom,sc7180
+
+      # Google Pompom with LTE (newest rev)
+      - items:
+          - const: google,pompom-sku0
+          - const: qcom,sc7180
+
+      # Google Trogdor (newest rev)
+      - items:
+          - const: google,trogdor
+          - const: qcom,sc7180
+
+      # Google Trogdor (newest rev) with LTE
+      - items:
+          - const: google,trogdor-sku0
+          - const: qcom,sc7180
+
       - items:
           - enum:
               - qcom,sc7280-crd