diff mbox series

[1/2] dt-bindings: Documentation for qcom,eud

Message ID 1533061333-7680-2-git-send-email-pheragu@codeaurora.org (mailing list archive)
State Not Applicable, archived
Delegated to: Andy Gross
Headers show
Series Add Embedded USB Debugger (EUD) driver | expand

Commit Message

Prakruthi Deepak Heragu July 31, 2018, 6:22 p.m. UTC
Documentation for Embedded USB Debugger (EUD) device tree bindings.

Signed-off-by: Satya Durga Srinivasu Prabhala <satyap@codeaurora.org>
Signed-off-by: Prakruthi Deepak Heragu <pheragu@codeaurora.org>
---
 .../devicetree/bindings/soc/qcom/qcom,msm-eud.txt  | 28 ++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/soc/qcom/qcom,msm-eud.txt

Comments

Rob Herring (Arm) Aug. 1, 2018, 2:04 p.m. UTC | #1
On Tue, Jul 31, 2018 at 12:22 PM Prakruthi Deepak Heragu
<pheragu@codeaurora.org> wrote:
>
> Documentation for Embedded USB Debugger (EUD) device tree bindings.

If you want bindings reviewed, send them to the correct list and
people (hint: run get_maintainers.pl).

New bindings should not use extcon.

>
> Signed-off-by: Satya Durga Srinivasu Prabhala <satyap@codeaurora.org>
> Signed-off-by: Prakruthi Deepak Heragu <pheragu@codeaurora.org>
> ---
>  .../devicetree/bindings/soc/qcom/qcom,msm-eud.txt  | 28 ++++++++++++++++++++++
>  1 file changed, 28 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/soc/qcom/qcom,msm-eud.txt
>
> diff --git a/Documentation/devicetree/bindings/soc/qcom/qcom,msm-eud.txt b/Documentation/devicetree/bindings/soc/qcom/qcom,msm-eud.txt
> new file mode 100644
> index 0000000..ea63f1c
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/soc/qcom/qcom,msm-eud.txt
> @@ -0,0 +1,28 @@
> +* Qualcomm Technologies Inc Embedded USB Debugger (EUD)
> +
> +The EUD (Embedded USB Debugger) is a mini-USB hub implemented
> +on chip to support the USB-based debug and trace capabilities.
> +
> +Required properties:
> +
> + - compatible:  Should be "qcom,msm-eud"
> + - interrupts:  Interrupt number
> + - reg: Should be address and size of EUD register space
> +
> +Driver notifies clients via extcon for VBUS attach/detach
> +and charger enable/disable events. Clients registered for these
> +notifications should have extcon property set to eud.
> +
> +An example for EUD device node:
> +
> +       eud: qcom,msm-eud@88e0000 {
> +               compatible = "qcom,msm-eud";
> +               interrupts = <GIC_SPI 492 IRQ_TYPE_LEVEL_HIGH>;
> +               reg = <0x88e0000 0x4000>;
> +       };
> +
> +An example for EUD extcon client:
> +
> +       usb3 {
> +               extcon = <&eud>;
> +       };
> --
> The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
> a Linux Foundation Collaborative Project
>
--
To unsubscribe from this list: send the line "unsubscribe linux-arm-msm" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Prakruthi Deepak Heragu Aug. 2, 2018, 6:44 p.m. UTC | #2
On 2018-08-01 07:04, Rob Herring wrote:
> On Tue, Jul 31, 2018 at 12:22 PM Prakruthi Deepak Heragu
> <pheragu@codeaurora.org> wrote:
>> 
>> Documentation for Embedded USB Debugger (EUD) device tree bindings.
> 
> If you want bindings reviewed, send them to the correct list and
> people (hint: run get_maintainers.pl).
> 
> New bindings should not use extcon.
> 
Why should we not use extcon? Are there any alternatives which you
would suggest? We were looking at graphs instead of extcon.
>> 
>> Signed-off-by: Satya Durga Srinivasu Prabhala <satyap@codeaurora.org>
>> Signed-off-by: Prakruthi Deepak Heragu <pheragu@codeaurora.org>
>> ---
>>  .../devicetree/bindings/soc/qcom/qcom,msm-eud.txt  | 28 
>> ++++++++++++++++++++++
>>  1 file changed, 28 insertions(+)
>>  create mode 100644 
>> Documentation/devicetree/bindings/soc/qcom/qcom,msm-eud.txt
>> 
>> diff --git 
>> a/Documentation/devicetree/bindings/soc/qcom/qcom,msm-eud.txt 
>> b/Documentation/devicetree/bindings/soc/qcom/qcom,msm-eud.txt
>> new file mode 100644
>> index 0000000..ea63f1c
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/soc/qcom/qcom,msm-eud.txt
>> @@ -0,0 +1,28 @@
>> +* Qualcomm Technologies Inc Embedded USB Debugger (EUD)
>> +
>> +The EUD (Embedded USB Debugger) is a mini-USB hub implemented
>> +on chip to support the USB-based debug and trace capabilities.
>> +
>> +Required properties:
>> +
>> + - compatible:  Should be "qcom,msm-eud"
>> + - interrupts:  Interrupt number
>> + - reg: Should be address and size of EUD register space
>> +
>> +Driver notifies clients via extcon for VBUS attach/detach
>> +and charger enable/disable events. Clients registered for these
>> +notifications should have extcon property set to eud.
>> +
>> +An example for EUD device node:
>> +
>> +       eud: qcom,msm-eud@88e0000 {
>> +               compatible = "qcom,msm-eud";
>> +               interrupts = <GIC_SPI 492 IRQ_TYPE_LEVEL_HIGH>;
>> +               reg = <0x88e0000 0x4000>;
>> +       };
>> +
>> +An example for EUD extcon client:
>> +
>> +       usb3 {
>> +               extcon = <&eud>;
>> +       };
>> --
>> The Qualcomm Innovation Center, Inc. is a member of the Code Aurora 
>> Forum,
>> a Linux Foundation Collaborative Project
>> 
--
To unsubscribe from this list: send the line "unsubscribe linux-arm-msm" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Rob Herring (Arm) Aug. 2, 2018, 9:23 p.m. UTC | #3
On Thu, Aug 2, 2018 at 12:44 PM <pheragu@codeaurora.org> wrote:
>
> On 2018-08-01 07:04, Rob Herring wrote:
> > On Tue, Jul 31, 2018 at 12:22 PM Prakruthi Deepak Heragu
> > <pheragu@codeaurora.org> wrote:
> >>
> >> Documentation for Embedded USB Debugger (EUD) device tree bindings.
> >
> > If you want bindings reviewed, send them to the correct list and
> > people (hint: run get_maintainers.pl).
> >
> > New bindings should not use extcon.
> >
> Why should we not use extcon?

Because it is poorly designed and has things which are Linux specific.

> Are there any alternatives which you
> would suggest? We were looking at graphs instead of extcon.

There's a usb-connector binding now which does use graphs.

But I'm not really sure what this should look like given this appears
to be both a USB device and a MMIO device.

Rob
--
To unsubscribe from this list: send the line "unsubscribe linux-arm-msm" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/soc/qcom/qcom,msm-eud.txt b/Documentation/devicetree/bindings/soc/qcom/qcom,msm-eud.txt
new file mode 100644
index 0000000..ea63f1c
--- /dev/null
+++ b/Documentation/devicetree/bindings/soc/qcom/qcom,msm-eud.txt
@@ -0,0 +1,28 @@ 
+* Qualcomm Technologies Inc Embedded USB Debugger (EUD)
+
+The EUD (Embedded USB Debugger) is a mini-USB hub implemented
+on chip to support the USB-based debug and trace capabilities.
+
+Required properties:
+
+ - compatible:  Should be "qcom,msm-eud"
+ - interrupts:  Interrupt number
+ - reg: Should be address and size of EUD register space
+
+Driver notifies clients via extcon for VBUS attach/detach
+and charger enable/disable events. Clients registered for these
+notifications should have extcon property set to eud.
+
+An example for EUD device node:
+
+	eud: qcom,msm-eud@88e0000 {
+		compatible = "qcom,msm-eud";
+		interrupts = <GIC_SPI 492 IRQ_TYPE_LEVEL_HIGH>;
+		reg = <0x88e0000 0x4000>;
+	};
+
+An example for EUD extcon client:
+
+	usb3 {
+		extcon = <&eud>;
+	};