diff mbox

[v2,1/2] dt-bindings: usb: add bindings doc for HiSilicon STB xHCI host controller

Message ID 1525514990-18207-2-git-send-email-sunjg79@163.com (mailing list archive)
State New, archived
Headers show

Commit Message

Jianguo Sun May 5, 2018, 10:09 a.m. UTC
From: Jianguo Sun <sunjianguo1@huawei.com>

This commit adds bindings doc for HiSilicon STB xHCI host controller.

Signed-off-by: Jianguo Sun <sunjianguo1@huawei.com>
---
 .../bindings/usb/hisilicon,histb-xhci.txt          | 46 ++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/usb/hisilicon,histb-xhci.txt

Comments

Rob Herring May 7, 2018, 5:09 p.m. UTC | #1
On Sat, May 05, 2018 at 06:09:49PM +0800, sunjg79@163.com wrote:
> From: Jianguo Sun <sunjianguo1@huawei.com>
> 
> This commit adds bindings doc for HiSilicon STB xHCI host controller.
> 
> Signed-off-by: Jianguo Sun <sunjianguo1@huawei.com>
> ---
>  .../bindings/usb/hisilicon,histb-xhci.txt          | 46 ++++++++++++++++++++++
>  1 file changed, 46 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/usb/hisilicon,histb-xhci.txt
> 
> diff --git a/Documentation/devicetree/bindings/usb/hisilicon,histb-xhci.txt b/Documentation/devicetree/bindings/usb/hisilicon,histb-xhci.txt
> new file mode 100644
> index 0000000..b1a06f1
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/usb/hisilicon,histb-xhci.txt
> @@ -0,0 +1,46 @@
> +HiSilicon STB xHCI
> +
> +The device node for HiSilicon STB xHCI host controller
> +
> +Required properties:
> + - compatible: should be "hisilicon,hi3798cv200-xhci"
> + - reg: specifies physical base address and size of the registers
> + - interrupts : interrupt used by the controller
> + - clocks: a list of phandle + clock-specifier pairs, one for each
> +	entry in clock-names
> + - clock-names: must contain
> +	"bus": for bus clock
> +	"utmi": for utmi clock
> +	"pipe": for pipeE clock
> +	"suspend": for suspend clock
> + - resets: a list of phandle and reset specifier pairs as listed in
> +	reset-names property.
> + - reset-names: must contain
> +	"soft": for soft reset
> + - phys: a list of phandle + phy specifier pairs
> + - phy-names: must contain at least one of following:
> +	"inno": for inno phy
> +	"combo": for combo phy
> +
> +Optional properties:
> +  - usb2-lpm-disable: indicate if we don't want to enable USB2 HW LPM
> +  - usb3-lpm-capable: determines if platform is USB3 LPM capable
> +  - quirk-broken-port-ped: set if the controller has broken port disable mechanism

This should either be true or not based on the compatible string.

> +  - imod-interval-ns: default interrupt moderation interval is 40000ns
> +
> +Example:
> +
> +xhci0: xchi@f98a0000 {
> +	compatible = "hisilicon,hi3798cv200-xhci";
> +	reg = <0xf98a0000 0x10000>;
> +	interrupts = <GIC_SPI 69 IRQ_TYPE_LEVEL_HIGH>;
> +	clocks = <&crg HISTB_USB3_BUS_CLK>,
> +		 <&crg HISTB_USB3_UTMI_CLK>,
> +		 <&crg HISTB_USB3_PIPE_CLK>,
> +		 <&crg HISTB_USB3_SUSPEND_CLK>;
> +	clock-names = "bus", "utmi", "pipe", "suspend";
> +	resets = <&crg 0xb0 12>;
> +	reset-names = "soft";
> +	phys = <&usb2_phy1_port1 0>, <&combphy0 PHY_TYPE_USB3>;
> +	phy-names = "inno", "combo";
> +};
> -- 
> 2.7.4
> 
> 
> --
> To unsubscribe from this list: send the line "unsubscribe devicetree" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
--
To unsubscribe from this list: send the line "unsubscribe linux-usb" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Jianguo Sun May 8, 2018, 3:27 a.m. UTC | #2
Hi Rob,


On 05/08/2018 01:09 AM, Rob Herring wrote:
> On Sat, May 05, 2018 at 06:09:49PM +0800, sunjg79@163.com wrote:
>> From: Jianguo Sun <sunjianguo1@huawei.com>
>>
>> This commit adds bindings doc for HiSilicon STB xHCI host controller.
>>
>> Signed-off-by: Jianguo Sun <sunjianguo1@huawei.com>
>> ---
>>   .../bindings/usb/hisilicon,histb-xhci.txt          | 46 ++++++++++++++++++++++
>>   1 file changed, 46 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/usb/hisilicon,histb-xhci.txt
>>
>> diff --git a/Documentation/devicetree/bindings/usb/hisilicon,histb-xhci.txt b/Documentation/devicetree/bindings/usb/hisilicon,histb-xhci.txt
>> new file mode 100644
>> index 0000000..b1a06f1
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/usb/hisilicon,histb-xhci.txt
>> @@ -0,0 +1,46 @@
>> +HiSilicon STB xHCI
>> +
>> +The device node for HiSilicon STB xHCI host controller
>> +
>> +Required properties:
>> + - compatible: should be "hisilicon,hi3798cv200-xhci"
>> + - reg: specifies physical base address and size of the registers
>> + - interrupts : interrupt used by the controller
>> + - clocks: a list of phandle + clock-specifier pairs, one for each
>> +	entry in clock-names
>> + - clock-names: must contain
>> +	"bus": for bus clock
>> +	"utmi": for utmi clock
>> +	"pipe": for pipeE clock
>> +	"suspend": for suspend clock
>> + - resets: a list of phandle and reset specifier pairs as listed in
>> +	reset-names property.
>> + - reset-names: must contain
>> +	"soft": for soft reset
>> + - phys: a list of phandle + phy specifier pairs
>> + - phy-names: must contain at least one of following:
>> +	"inno": for inno phy
>> +	"combo": for combo phy
>> +
>> +Optional properties:
>> +  - usb2-lpm-disable: indicate if we don't want to enable USB2 HW LPM
>> +  - usb3-lpm-capable: determines if platform is USB3 LPM capable
>> +  - quirk-broken-port-ped: set if the controller has broken port disable mechanism
> This should either be true or not based on the compatible string.
This is borrowed from usb-xhci.txt, and I wasn't aware that it was a 
workaround.
Since this issue doesn't occur on Hi3798CV200 SoC, I will remove this 
property in v3.
Thanks.
>> +  - imod-interval-ns: default interrupt moderation interval is 40000ns
>> +
>> +Example:
>> +
>> +xhci0: xchi@f98a0000 {
>> +	compatible = "hisilicon,hi3798cv200-xhci";
>> +	reg = <0xf98a0000 0x10000>;
>> +	interrupts = <GIC_SPI 69 IRQ_TYPE_LEVEL_HIGH>;
>> +	clocks = <&crg HISTB_USB3_BUS_CLK>,
>> +		 <&crg HISTB_USB3_UTMI_CLK>,
>> +		 <&crg HISTB_USB3_PIPE_CLK>,
>> +		 <&crg HISTB_USB3_SUSPEND_CLK>;
>> +	clock-names = "bus", "utmi", "pipe", "suspend";
>> +	resets = <&crg 0xb0 12>;
>> +	reset-names = "soft";
>> +	phys = <&usb2_phy1_port1 0>, <&combphy0 PHY_TYPE_USB3>;
>> +	phy-names = "inno", "combo";
>> +};
>> -- 
>> 2.7.4
>>
>>
>> --
>> To unsubscribe from this list: send the line "unsubscribe devicetree" in
>> the body of a message to majordomo@vger.kernel.org
>> More majordomo info at  http://vger.kernel.org/majordomo-info.html


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

Patch

diff --git a/Documentation/devicetree/bindings/usb/hisilicon,histb-xhci.txt b/Documentation/devicetree/bindings/usb/hisilicon,histb-xhci.txt
new file mode 100644
index 0000000..b1a06f1
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/hisilicon,histb-xhci.txt
@@ -0,0 +1,46 @@ 
+HiSilicon STB xHCI
+
+The device node for HiSilicon STB xHCI host controller
+
+Required properties:
+ - compatible: should be "hisilicon,hi3798cv200-xhci"
+ - reg: specifies physical base address and size of the registers
+ - interrupts : interrupt used by the controller
+ - clocks: a list of phandle + clock-specifier pairs, one for each
+	entry in clock-names
+ - clock-names: must contain
+	"bus": for bus clock
+	"utmi": for utmi clock
+	"pipe": for pipeE clock
+	"suspend": for suspend clock
+ - resets: a list of phandle and reset specifier pairs as listed in
+	reset-names property.
+ - reset-names: must contain
+	"soft": for soft reset
+ - phys: a list of phandle + phy specifier pairs
+ - phy-names: must contain at least one of following:
+	"inno": for inno phy
+	"combo": for combo phy
+
+Optional properties:
+  - usb2-lpm-disable: indicate if we don't want to enable USB2 HW LPM
+  - usb3-lpm-capable: determines if platform is USB3 LPM capable
+  - quirk-broken-port-ped: set if the controller has broken port disable mechanism
+  - imod-interval-ns: default interrupt moderation interval is 40000ns
+
+Example:
+
+xhci0: xchi@f98a0000 {
+	compatible = "hisilicon,hi3798cv200-xhci";
+	reg = <0xf98a0000 0x10000>;
+	interrupts = <GIC_SPI 69 IRQ_TYPE_LEVEL_HIGH>;
+	clocks = <&crg HISTB_USB3_BUS_CLK>,
+		 <&crg HISTB_USB3_UTMI_CLK>,
+		 <&crg HISTB_USB3_PIPE_CLK>,
+		 <&crg HISTB_USB3_SUSPEND_CLK>;
+	clock-names = "bus", "utmi", "pipe", "suspend";
+	resets = <&crg 0xb0 12>;
+	reset-names = "soft";
+	phys = <&usb2_phy1_port1 0>, <&combphy0 PHY_TYPE_USB3>;
+	phy-names = "inno", "combo";
+};