diff mbox

[v4,4/5] Documentation: dt-bindings: pci: altera pcie device tree binding

Message ID 1439802579-22651-5-git-send-email-lftan@altera.com (mailing list archive)
State New, archived
Headers show

Commit Message

Ley Foon Tan Aug. 17, 2015, 9:09 a.m. UTC
This patch adds the bindings for Altera PCIe host controller driver and
Altera PCIe MSI driver.

Signed-off-by: Ley Foon Tan <lftan@altera.com>
---
 .../devicetree/bindings/pci/altera-pcie-msi.txt    | 27 ++++++++++++
 .../devicetree/bindings/pci/altera-pcie.txt        | 49 ++++++++++++++++++++++
 2 files changed, 76 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/pci/altera-pcie-msi.txt
 create mode 100644 Documentation/devicetree/bindings/pci/altera-pcie.txt

Comments

Dinh Nguyen Aug. 18, 2015, 7:22 p.m. UTC | #1
On Mon, Aug 17, 2015 at 4:09 AM, Ley Foon Tan <lftan@altera.com> wrote:
> This patch adds the bindings for Altera PCIe host controller driver and
> Altera PCIe MSI driver.
>
> Signed-off-by: Ley Foon Tan <lftan@altera.com>
> ---
>  .../devicetree/bindings/pci/altera-pcie-msi.txt    | 27 ++++++++++++
>  .../devicetree/bindings/pci/altera-pcie.txt        | 49 ++++++++++++++++++++++
>  2 files changed, 76 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/pci/altera-pcie-msi.txt
>  create mode 100644 Documentation/devicetree/bindings/pci/altera-pcie.txt
>
> diff --git a/Documentation/devicetree/bindings/pci/altera-pcie-msi.txt b/Documentation/devicetree/bindings/pci/altera-pcie-msi.txt
> new file mode 100644
> index 0000000..7f330c9
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/pci/altera-pcie-msi.txt
> @@ -0,0 +1,27 @@
> +* Altera PCIe MSI controller
> +
> +Required properties:
> +- compatible:  should contain "altr,msi-1.0"
> +- reg:         specifies the physical base address of the controller and
> +               the length of the memory mapped region.
> +- reg-names:   Must include the following entries:
> +               "csr": CSR registers
> +               "vector_slave": vectors region

Can you be a little bit more specific here? What is a vectors region?
Also, I'm not 100% sure, but I think "vector-slave" should be used.

> +-interrupts:   specifies the interrupt source of the parent interrupt
> +               controller. The format of the interrupt specifier depends on the
> +               parent interrupt controller.

Need to document "interrupt-parent" .

> +- num-vectors: Number of vectors, range 1 to 32.
> +- msi-controller:      indicates that this is MSI controller node
> +
> +
> +Example
> +msi0: msi@0xFF200000 {
> +       compatible = "altr,msi-1.0";
> +       reg = <0xFF200000 0x00000010
> +               0xFF200010 0x00000080>;
> +       reg-names = "csr", "vector_slave";
> +       interrupt-parent = <&hps_0_arm_gic_0>;
> +       interrupts = <0 42 4>;
> +       msi-controller = <1>;
> +       num-vectors = <32>;
> +};
> diff --git a/Documentation/devicetree/bindings/pci/altera-pcie.txt b/Documentation/devicetree/bindings/pci/altera-pcie.txt
> new file mode 100644
> index 0000000..73a8dc0
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/pci/altera-pcie.txt
> @@ -0,0 +1,49 @@
> +* Altera PCIe controller
> +
> +Required properties:
> +- compatible : should contain "altr,pcie-root-port-1.0"
> +- reg:         A list of physical base address and length for TXS and CRA.
> +- reg-names:   Must include the following entries:
> +               "Txs" or "txs": TXS region

What is a TXS region?

> +               "Cra" or "cra": Control register access region
> +-interrupts:   specifies the interrupt source of the parent interrupt controller.
> +               The format of the interrupt specifier depends on the parent interrupt
> +               controller.
> +- device_type: must be "pci"
> +- #address-cells:      set to <3>
> +- #size-cells: set to <2>
> +- #interrupt-cells:    set to <1>
> +- ranges:              Describes the translation of addresses for root ports and standard
> +               PCI regions.
> +- interrupt-map-mask and interrupt-map: standard PCI properties
> +       to define the mapping of the PCIe interface to interrupt
> +       numbers.

"interrupt-parent" ?

Dinh
Ley Foon Tan Aug. 19, 2015, 1:28 a.m. UTC | #2
On Wed, Aug 19, 2015 at 3:22 AM, Dinh Nguyen <dinh.linux@gmail.com> wrote:
> On Mon, Aug 17, 2015 at 4:09 AM, Ley Foon Tan <lftan@altera.com> wrote:
>> This patch adds the bindings for Altera PCIe host controller driver and
>> Altera PCIe MSI driver.
>>
>> Signed-off-by: Ley Foon Tan <lftan@altera.com>
>> ---
>>  .../devicetree/bindings/pci/altera-pcie-msi.txt    | 27 ++++++++++++
>>  .../devicetree/bindings/pci/altera-pcie.txt        | 49 ++++++++++++++++++++++
>>  2 files changed, 76 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/pci/altera-pcie-msi.txt
>>  create mode 100644 Documentation/devicetree/bindings/pci/altera-pcie.txt
>>
>> diff --git a/Documentation/devicetree/bindings/pci/altera-pcie-msi.txt b/Documentation/devicetree/bindings/pci/altera-pcie-msi.txt
>> new file mode 100644
>> index 0000000..7f330c9
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/pci/altera-pcie-msi.txt
>> @@ -0,0 +1,27 @@
>> +* Altera PCIe MSI controller
>> +
>> +Required properties:
>> +- compatible:  should contain "altr,msi-1.0"
>> +- reg:         specifies the physical base address of the controller and
>> +               the length of the memory mapped region.
>> +- reg-names:   Must include the following entries:
>> +               "csr": CSR registers
>> +               "vector_slave": vectors region
>
> Can you be a little bit more specific here? What is a vectors region?
> Also, I'm not 100% sure, but I think "vector-slave" should be used.
This parameter is the Avalon slave name in MSI IP hardware. It is auto
generated from dts generator.
I can add more description for it here.

>
>> +-interrupts:   specifies the interrupt source of the parent interrupt
>> +               controller. The format of the interrupt specifier depends on the
>> +               parent interrupt controller.
>
> Need to document "interrupt-parent" .
Okay.

>
>> +- num-vectors: Number of vectors, range 1 to 32.
>> +- msi-controller:      indicates that this is MSI controller node
>> +
>> +
>> +Example
>> +msi0: msi@0xFF200000 {
>> +       compatible = "altr,msi-1.0";
>> +       reg = <0xFF200000 0x00000010
>> +               0xFF200010 0x00000080>;
>> +       reg-names = "csr", "vector_slave";
>> +       interrupt-parent = <&hps_0_arm_gic_0>;
>> +       interrupts = <0 42 4>;
>> +       msi-controller = <1>;
>> +       num-vectors = <32>;
>> +};
>> diff --git a/Documentation/devicetree/bindings/pci/altera-pcie.txt b/Documentation/devicetree/bindings/pci/altera-pcie.txt
>> new file mode 100644
>> index 0000000..73a8dc0
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/pci/altera-pcie.txt
>> @@ -0,0 +1,49 @@
>> +* Altera PCIe controller
>> +
>> +Required properties:
>> +- compatible : should contain "altr,pcie-root-port-1.0"
>> +- reg:         A list of physical base address and length for TXS and CRA.
>> +- reg-names:   Must include the following entries:
>> +               "Txs" or "txs": TXS region
>
> What is a TXS region?
It is TX slave port in PCIe IP. I can update this.

>
>> +               "Cra" or "cra": Control register access region
>> +-interrupts:   specifies the interrupt source of the parent interrupt controller.
>> +               The format of the interrupt specifier depends on the parent interrupt
>> +               controller.
>> +- device_type: must be "pci"
>> +- #address-cells:      set to <3>
>> +- #size-cells: set to <2>
>> +- #interrupt-cells:    set to <1>
>> +- ranges:              Describes the translation of addresses for root ports and standard
>> +               PCI regions.
>> +- interrupt-map-mask and interrupt-map: standard PCI properties
>> +       to define the mapping of the PCIe interface to interrupt
>> +       numbers.
>
> "interrupt-parent" ?
Will add it.

Thanks.

Regards
Ley Foon
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/pci/altera-pcie-msi.txt b/Documentation/devicetree/bindings/pci/altera-pcie-msi.txt
new file mode 100644
index 0000000..7f330c9
--- /dev/null
+++ b/Documentation/devicetree/bindings/pci/altera-pcie-msi.txt
@@ -0,0 +1,27 @@ 
+* Altera PCIe MSI controller
+
+Required properties:
+- compatible:	should contain "altr,msi-1.0"
+- reg:		specifies the physical base address of the controller and
+		the length of the memory mapped region.
+- reg-names:	Must include the following entries:
+		"csr": CSR registers
+		"vector_slave": vectors region
+-interrupts:	specifies the interrupt source of the parent interrupt
+		controller. The format of the interrupt specifier depends on the
+		parent interrupt controller.
+- num-vectors:	Number of vectors, range 1 to 32.
+- msi-controller:	indicates that this is MSI controller node
+
+
+Example
+msi0: msi@0xFF200000 {
+	compatible = "altr,msi-1.0";
+	reg = <0xFF200000 0x00000010
+		0xFF200010 0x00000080>;
+	reg-names = "csr", "vector_slave";
+	interrupt-parent = <&hps_0_arm_gic_0>;
+	interrupts = <0 42 4>;
+	msi-controller = <1>;
+	num-vectors = <32>;
+};
diff --git a/Documentation/devicetree/bindings/pci/altera-pcie.txt b/Documentation/devicetree/bindings/pci/altera-pcie.txt
new file mode 100644
index 0000000..73a8dc0
--- /dev/null
+++ b/Documentation/devicetree/bindings/pci/altera-pcie.txt
@@ -0,0 +1,49 @@ 
+* Altera PCIe controller
+
+Required properties:
+- compatible :	should contain "altr,pcie-root-port-1.0"
+- reg:		A list of physical base address and length for TXS and CRA.
+- reg-names:	Must include the following entries:
+		"Txs" or "txs": TXS region
+		"Cra" or "cra": Control register access region
+-interrupts:	specifies the interrupt source of the parent interrupt controller.
+		The format of the interrupt specifier depends on the parent interrupt
+		controller.
+- device_type:	must be "pci"
+- #address-cells:	set to <3>
+- #size-cells:	set to <2>
+- #interrupt-cells:	set to <1>
+- ranges:		Describes the translation of addresses for root ports and standard
+		PCI regions.
+- interrupt-map-mask and interrupt-map: standard PCI properties
+	to define the mapping of the PCIe interface to interrupt
+	numbers.
+
+Optional properties:
+- msi-parent:	Link to the hardware entity that serves as the MSI controller for this PCIe
+		controller.
+- bus-range:	PCI bus numbers covered
+
+Example
+	pcie_0: pcie@0xc00000000 {
+		compatible = "altr,pcie-root-port-1.0";
+		reg = <0xc0000000 0x20000000>,
+			<0xff220000 0x00004000>;
+		reg-names = "Txs", "Cra";
+		interrupt-parent = <&hps_0_arm_gic_0>;
+		interrupts = <0 40 4>;
+		interrupt-controller;
+		#interrupt-cells = <1>;
+		bus-range = <0x0 0xFF>;
+		device_type = "pci";
+		msi-parent = <&msi_to_gic_gen_0>;
+		#address-cells = <3>;
+		#size-cells = <2>;
+		interrupt-map-mask = <0 0 0 7>;
+		interrupt-map = <0 0 0 1 &pcie_0 1>,
+			            <0 0 0 2 &pcie_0 2>,
+			            <0 0 0 3 &pcie_0 3>,
+			            <0 0 0 4 &pcie_0 4>;
+		ranges = <0x82000000 0x00000000 0x00000000 0xc0000000 0x00000000 0x10000000
+			    0x82000000 0x00000000 0x10000000 0xd0000000 0x00000000 0x10000000>;
+	};