| Message ID | 1580445811-15948-2-git-send-email-akdwived@codeaurora.org |
|---|---|
| State | New |
| Headers | show |
| Series | [v4,1/2] dt-bindings: Documentation for qcom,eud | expand |
On 31/01/2020 04:43, Avaneesh Kumar Dwivedi wrote: > 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> > Signed-off-by: Avaneesh Kumar Dwivedi <akdwived@codeaurora.org> > --- > .../devicetree/bindings/soc/qcom/qcom,msm-eud.txt | 43 ++++++++++++++++++++++ > 1 file changed, 43 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..57476ce > --- /dev/null > +++ b/Documentation/devicetree/bindings/soc/qcom/qcom,msm-eud.txt > @@ -0,0 +1,43 @@ > +* 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. on chip to support 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 > + > +EUD notifies clients for VBUS attach/detach and charger enable/disable > +events. The link between event consumer(i.e.USB controller for vbus missing space consumer (i.e. > +attach/detach event) and EUD is established via a directed graph. EUD > +act The EUD acts > as an output link and clients of EUD as input link of this directed > +graph. Events flows through the directed graph only during debug mode. Probably this is a very obvious question but, you mean debug and trace events or do you mean VBUS/charger events? > + > +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>; > + usb_con: connector { > + compatible = "usb-c-connector"; > + label = "USB-C"; > + port { > + eud_usb_output: endpoint { > + remote-endpoint = <&eud_usb3_input>; > + }; > + }; > + }; > + }; > + > +An example for EUD client: > + > + usb3 { > + port { > + eud_usb3_input: endpoint { > + remote-endpoint = <&eud_usb_output>; > + }; > + }; > + }; >
On 31/01/2020 04:43, Avaneesh Kumar Dwivedi wrote: > 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> > Signed-off-by: Avaneesh Kumar Dwivedi <akdwived@codeaurora.org> > --- > .../devicetree/bindings/soc/qcom/qcom,msm-eud.txt | 43 ++++++++++++++++++++++ > 1 file changed, 43 insertions(+) > create mode 100644 Documentation/devicetree/bindings/soc/qcom/qcom,msm-eud.txt Forgot to mention, this file should be described in YAML. ./Documentation/devicetree/writing-schema.rst ./Documentation/devicetree/bindings/example-schema.yaml --- bod
Thank you very much Bryan for your review comments, will be working on your and other maintainers comment on this patchset and will be posting new patchset soon. On 2/4/2020 8:21 AM, Bryan O'Donoghue wrote: > On 31/01/2020 04:43, Avaneesh Kumar Dwivedi wrote: >> 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> >> Signed-off-by: Avaneesh Kumar Dwivedi <akdwived@codeaurora.org> >> --- >> .../devicetree/bindings/soc/qcom/qcom,msm-eud.txt | 43 >> ++++++++++++++++++++++ >> 1 file changed, 43 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..57476ce >> --- /dev/null >> +++ b/Documentation/devicetree/bindings/soc/qcom/qcom,msm-eud.txt >> @@ -0,0 +1,43 @@ >> +* 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. > > on chip to support USB-based debug and trace capabilities. OK > >> + >> +Required properties: >> + >> + - compatible: Should be "qcom,msm-eud" >> + - interrupts: Interrupt number >> + - reg: Should be address and size of EUD register space >> + >> +EUD notifies clients for VBUS attach/detach and charger enable/disable >> +events. The link between event consumer(i.e.USB controller for vbus > missing space > consumer (i.e. Ok > >> +attach/detach event) and EUD is established via a directed graph. EUD >> +act > The EUD acts OK > >> as an output link and clients of EUD as input link of this directed >> +graph. Events flows through the directed graph only during debug mode. > > Probably this is a very obvious question but, you mean debug and trace > events or do you mean VBUS/charger events? Directed graph is to show VBUS and charger events flow. > >> + >> +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>; >> + usb_con: connector { >> + compatible = "usb-c-connector"; >> + label = "USB-C"; >> + port { >> + eud_usb_output: endpoint { >> + remote-endpoint = <&eud_usb3_input>; >> + }; >> + }; >> + }; >> + }; >> + >> +An example for EUD client: >> + >> + usb3 { >> + port { >> + eud_usb3_input: endpoint { >> + remote-endpoint = <&eud_usb_output>; >> + }; >> + }; >> + }; >>
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..57476ce --- /dev/null +++ b/Documentation/devicetree/bindings/soc/qcom/qcom,msm-eud.txt @@ -0,0 +1,43 @@ +* 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 + +EUD notifies clients for VBUS attach/detach and charger enable/disable +events. The link between event consumer(i.e.USB controller for vbus +attach/detach event) and EUD is established via a directed graph. EUD +act as an output link and clients of EUD as input link of this directed +graph. Events flows through the directed graph only during debug mode. + +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>; + usb_con: connector { + compatible = "usb-c-connector"; + label = "USB-C"; + port { + eud_usb_output: endpoint { + remote-endpoint = <&eud_usb3_input>; + }; + }; + }; + }; + +An example for EUD client: + + usb3 { + port { + eud_usb3_input: endpoint { + remote-endpoint = <&eud_usb_output>; + }; + }; + };