Re: [PATCH V1 1/8] dt-bindings: Add the yaml bindings for EUD

From: schowdhu@codeaurora.org
To: Bjorn Andersson <bjorn.andersson@linaro.org>
Cc: linux-arm-msm@vger.kernel.org, linux-usb@vger.kernel.org,
	devicetree@vger.kernel.org, pure.logic@nexus-software.ie,
	greg@kroah.com, linux-kernel@vger.kernel.org,
	tsoni@codeaurora.org, psodagud@codeaurora.org,
	satyap@codeaurora.org, pheragu@codeaurora.org,
	rnayak@codeaurora.org, sibis@codeaurora.org,
	saiprakash.ranjan@codeaurora.org, quic_schowdhu@quicinc.com
Subject: Re: [PATCH V1 1/8] dt-bindings: Add the yaml bindings for EUD
Date: Wed, 24 Nov 2021 15:42:09 +0530	[thread overview]
Message-ID: <c1772ad6c60dabd206be9cf91dd08c77@codeaurora.org> (raw)
In-Reply-To: <YZ2zx4/8+yCcls/G@ripper>

On 2021-11-24 09:08, Bjorn Andersson wrote:
> On Mon 22 Nov 20:28 PST 2021, Souradeep Chowdhury wrote:
> 
>> Documentation for Embedded USB Debugger(EUD) device tree
>> bindings in yaml format.
>> 
>> Signed-off-by: Souradeep Chowdhury <schowdhu@codeaurora.org>
>> ---
>>  .../devicetree/bindings/soc/qcom/qcom,eud.yaml     | 52 
>> ++++++++++++++++++++++
>>  1 file changed, 52 insertions(+)
>>  create mode 100644 
>> Documentation/devicetree/bindings/soc/qcom/qcom,eud.yaml
>> 
>> diff --git a/Documentation/devicetree/bindings/soc/qcom/qcom,eud.yaml 
>> b/Documentation/devicetree/bindings/soc/qcom/qcom,eud.yaml
>> new file mode 100644
>> index 0000000..724552c
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/soc/qcom/qcom,eud.yaml
>> @@ -0,0 +1,52 @@
>> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: "http://devicetree.org/schemas/soc/qcom/qcom,eud.yaml#"
>> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
>> +
>> +title: Qualcomm Embedded USB Debugger
>> +
>> +maintainers:
>> +  - Souradeep Chowdhury <schowdhu@codeaurora.org>
>> +
>> +description: |
> 
> The '|' indicates that the formatting is significant, but it's not.

Ack

> 
>> +  This binding is used to describe the Qualcomm Embedded USB 
>> Debugger, which is
>> +  mini USB-hub implemented on chip to support USB-based debug 
>> capabilities.
>> +
>> +properties:
>> +  compatible:
>> +    items:
>> +      - enum:
>> +          - qcom,sc7280-eud
>> +      - const: qcom,eud
>> +
>> +  reg:
>> +    items:
>> +      - description: EUD Base Register Region
>> +      - description: EUD Mode Manager Register
>> +
>> +  interrupts:
>> +    description:
>> +      EUD interrupt
>> +
>> +
> 
> Drop one of these two empty lines please.

Ack

> 
>> +  port:
>> +    description:
>> +      Any connector to the data bus of this controller should be 
>> modelled
>> +      using the OF graph bindings specified, if the "usb-role-switch"
>> +      property is used. See graph.txt
> 
> This description does unfortunately not help me to understand what to
> point this port to.
> 
> What's "the data bus"?
> 
> Is usb-role-switch a property to be put in this node? Doesn't it need 
> to
> be mentioned as a valid property?

The end point of this port is attached to the connector child of dwc3 
node. The dwc3 node has the "usb-role-switch"
property. So "usb-role-switch" is not a valid property of the EUD node.
Will update the description with more clarity accordingly.

> 
>> +    $ref: /schemas/graph.yaml#/properties/port
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +
>> +additionalProperties: false
>> +
>> +examples:
>> +  - |
>> +    eud@88e0000 {
>> +           compatible = "qcom,sc7280-eud","qcom,eud";
>> +           reg = <0 0x88e0000 0 0x2000>,
>> +                 <0 0x88e2000 0 0x1000>;
> 
> The example is compiled with #address-cells == #size-cells == 1, so 
> drop
> the four lone 0s from the reg.

Ack

> 
> Regards,
> Bjorn
> 
>> +    };
>> --
>> QUALCOMM INDIA, on behalf of Qualcomm Innovation Center, Inc. is a 
>> member
>> of Code Aurora Forum, hosted by The Linux Foundation
>> 