2016-03-05 04:35:06

by Rob Herring (Arm)

[permalink] [raw]
Subject: Re: [PATCH v17 2/6] ARM: socfpga: add bindings document for fpga bridge drivers

On Thu, Feb 25, 2016 at 05:25:07PM -0600, Alan Tull wrote:
> Add bindings documentation for Altera SOCFPGA bridges:
> * fpga2sdram
> * fpga2hps
> * hps2fpga
> * lwhps2fpga
>
> Signed-off-by: Alan Tull <[email protected]>
> Signed-off-by: Matthew Gerlach <[email protected]>
> Signed-off-by: Dinh Nguyen <[email protected]>
> ---
> v2: separate into 2 documents for the 2 drivers
> v12: bump version to line up with simple-fpga-bus version
> remove Linux specific notes such as references to sysfs
> move non-DT specific documentation elsewhere
> remove bindings that would have been used to pass configuration
> clean up formatting
> v13: Remove 'label' property
> Change property from init-val to bridge-enable
> Fix email address
> v14: Add resets
> Change order of bridges to put lw bridge (controlling bridge) first
> v15: No change in this patch for v15 of this patch set
> v16: Added regs property, cleaned up unit addresses
> v17: No change to this patch in v17 of patch set
> ---
> .../bindings/fpga/altera-fpga2sdram-bridge.txt | 15 +++++++
> .../bindings/fpga/altera-hps2fpga-bridge.txt | 47 ++++++++++++++++++++
> 2 files changed, 62 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/fpga/altera-fpga2sdram-bridge.txt
> create mode 100644 Documentation/devicetree/bindings/fpga/altera-hps2fpga-bridge.txt

Just a few minor things.

> diff --git a/Documentation/devicetree/bindings/fpga/altera-fpga2sdram-bridge.txt b/Documentation/devicetree/bindings/fpga/altera-fpga2sdram-bridge.txt
> new file mode 100644
> index 0000000..4479a79
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/fpga/altera-fpga2sdram-bridge.txt
> @@ -0,0 +1,15 @@
> +Altera FPGA To SDRAM Bridge Driver
> +
> +Required properties:
> +- compatible : Should contain "altr,socfpga-fpga2sdram-bridge"
> +
> +Optional properties:
> +- bridge-enable : 0 if driver should disable bridge at startup
> + 1 if driver should enable bridge at startup
> + Default is to leave bridge in current state.
> +
> +Example:
> + fpga2sdram_br {

fpga-bridge@??

> + compatible = "altr,socfpga-fpga2sdram-bridge";
> + bridge-enable = <0>;
> + };
> diff --git a/Documentation/devicetree/bindings/fpga/altera-hps2fpga-bridge.txt b/Documentation/devicetree/bindings/fpga/altera-hps2fpga-bridge.txt
> new file mode 100644
> index 0000000..e6b7474
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/fpga/altera-hps2fpga-bridge.txt
> @@ -0,0 +1,47 @@
> +Altera FPGA/HPS Bridge Driver
> +
> +Required properties:
> +- regs : base address and size for AXI bridge module
> +- compatible : Should contain one of:
> + "altr,socfpga-lwhps2fpga-bridge",
> + "altr,socfpga-hps2fpga-bridge", or
> + "altr,socfpga-fpga2hps-bridge"
> +- reset-names : Should contain one of:
> + "lwhps2fpga",
> + "hps2fpga", or
> + "fpga2hps"

Names should be the input signal names. Do you need names with only one?

> +- resets : Phandle and reset specifier for the reset listed in
> + reset-names
> +- clocks : Clocks used by this module.
> +
> +Optional properties:
> +- bridge-enable : 0 if driver should disable bridge at startup.
> + 1 if driver should enable bridge at startup.
> + Default is to leave bridge in its current state.
> +
> +Example:
> + hps_fpgabridge0: fpgabridge@ff400000 {

No underscores.

fpga-bridge@...

> + compatible = "altr,socfpga-lwhps2fpga-bridge";
> + reg = <0xff400000 0x100000>;
> + resets = <&rst LWHPS2FPGA_RESET>;
> + reset-names = "lwhps2fpga";
> + clocks = <&l4_main_clk>;
> + bridge-enable = <0>;
> + };
> +
> + hps_fpgabridge1: fpgabridge@ff500000 {
> + compatible = "altr,socfpga-hps2fpga-bridge";
> + reg = <0xff500000 0x10000>;
> + resets = <&rst HPS2FPGA_RESET>;
> + reset-names = "hps2fpga";
> + clocks = <&l4_main_clk>;
> + bridge-enable = <1>;
> + };
> +
> + hps_fpgabridge2: fpgabridge@ff600000 {
> + compatible = "altr,socfpga-fpga2hps-bridge";
> + reg = <0xff600000 0x100000>;
> + resets = <&rst FPGA2HPS_RESET>;
> + reset-names = "fpga2hps";
> + clocks = <&l4_main_clk>;
> + };
> --
> 1.7.9.5
>


2016-03-07 16:12:09

by atull

[permalink] [raw]
Subject: Re: [PATCH v17 2/6] ARM: socfpga: add bindings document for fpga bridge drivers

On Sat, 5 Mar 2016, Rob Herring wrote:

> On Thu, Feb 25, 2016 at 05:25:07PM -0600, Alan Tull wrote:
> > Add bindings documentation for Altera SOCFPGA bridges:
> > * fpga2sdram
> > * fpga2hps
> > * hps2fpga
> > * lwhps2fpga
> >
> > Signed-off-by: Alan Tull <[email protected]>
> > Signed-off-by: Matthew Gerlach <[email protected]>
> > Signed-off-by: Dinh Nguyen <[email protected]>
> > ---
> > v2: separate into 2 documents for the 2 drivers
> > v12: bump version to line up with simple-fpga-bus version
> > remove Linux specific notes such as references to sysfs
> > move non-DT specific documentation elsewhere
> > remove bindings that would have been used to pass configuration
> > clean up formatting
> > v13: Remove 'label' property
> > Change property from init-val to bridge-enable
> > Fix email address
> > v14: Add resets
> > Change order of bridges to put lw bridge (controlling bridge) first
> > v15: No change in this patch for v15 of this patch set
> > v16: Added regs property, cleaned up unit addresses
> > v17: No change to this patch in v17 of patch set
> > ---
> > .../bindings/fpga/altera-fpga2sdram-bridge.txt | 15 +++++++
> > .../bindings/fpga/altera-hps2fpga-bridge.txt | 47 ++++++++++++++++++++
> > 2 files changed, 62 insertions(+)
> > create mode 100644 Documentation/devicetree/bindings/fpga/altera-fpga2sdram-bridge.txt
> > create mode 100644 Documentation/devicetree/bindings/fpga/altera-hps2fpga-bridge.txt
>
> Just a few minor things.
>
> > diff --git a/Documentation/devicetree/bindings/fpga/altera-fpga2sdram-bridge.txt b/Documentation/devicetree/bindings/fpga/altera-fpga2sdram-bridge.txt
> > new file mode 100644
> > index 0000000..4479a79
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/fpga/altera-fpga2sdram-bridge.txt
> > @@ -0,0 +1,15 @@
> > +Altera FPGA To SDRAM Bridge Driver
> > +
> > +Required properties:
> > +- compatible : Should contain "altr,socfpga-fpga2sdram-bridge"
> > +
> > +Optional properties:
> > +- bridge-enable : 0 if driver should disable bridge at startup
> > + 1 if driver should enable bridge at startup
> > + Default is to leave bridge in current state.
> > +
> > +Example:
> > + fpga2sdram_br {
>
> fpga-bridge@??

The hardware is messy here as the control of this bridge is
lumped into the sdram controller. I could give the address
of the one register that enables/disable the bridge here.

>
> > + compatible = "altr,socfpga-fpga2sdram-bridge";
> > + bridge-enable = <0>;
> > + };
> > diff --git a/Documentation/devicetree/bindings/fpga/altera-hps2fpga-bridge.txt b/Documentation/devicetree/bindings/fpga/altera-hps2fpga-bridge.txt
> > new file mode 100644
> > index 0000000..e6b7474
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/fpga/altera-hps2fpga-bridge.txt
> > @@ -0,0 +1,47 @@
> > +Altera FPGA/HPS Bridge Driver
> > +
> > +Required properties:
> > +- regs : base address and size for AXI bridge module
> > +- compatible : Should contain one of:
> > + "altr,socfpga-lwhps2fpga-bridge",
> > + "altr,socfpga-hps2fpga-bridge", or
> > + "altr,socfpga-fpga2hps-bridge"
> > +- reset-names : Should contain one of:
> > + "lwhps2fpga",
> > + "hps2fpga", or
> > + "fpga2hps"
>
> Names should be the input signal names. Do you need names with only one?

Right, I will use
of_reset_control_get_by_index(dev->of_node, 0) and eliminate
the reset-names here.

>
> > +- resets : Phandle and reset specifier for the reset listed in
> > + reset-names
> > +- clocks : Clocks used by this module.
> > +
> > +Optional properties:
> > +- bridge-enable : 0 if driver should disable bridge at startup.
> > + 1 if driver should enable bridge at startup.
> > + Default is to leave bridge in its current state.
> > +
> > +Example:
> > + hps_fpgabridge0: fpgabridge@ff400000 {
>
> No underscores.
>
> fpga-bridge@...

OK, will add these fixes in v18.

>
> > + compatible = "altr,socfpga-lwhps2fpga-bridge";
> > + reg = <0xff400000 0x100000>;
> > + resets = <&rst LWHPS2FPGA_RESET>;
> > + reset-names = "lwhps2fpga";
> > + clocks = <&l4_main_clk>;
> > + bridge-enable = <0>;
> > + };
> > +
> > + hps_fpgabridge1: fpgabridge@ff500000 {
> > + compatible = "altr,socfpga-hps2fpga-bridge";
> > + reg = <0xff500000 0x10000>;
> > + resets = <&rst HPS2FPGA_RESET>;
> > + reset-names = "hps2fpga";
> > + clocks = <&l4_main_clk>;
> > + bridge-enable = <1>;
> > + };
> > +
> > + hps_fpgabridge2: fpgabridge@ff600000 {
> > + compatible = "altr,socfpga-fpga2hps-bridge";
> > + reg = <0xff600000 0x100000>;
> > + resets = <&rst FPGA2HPS_RESET>;
> > + reset-names = "fpga2hps";
> > + clocks = <&l4_main_clk>;
> > + };
> > --
> > 1.7.9.5
> >
>

2016-03-15 22:10:08

by atull

[permalink] [raw]
Subject: Re: [PATCH v17 2/6] ARM: socfpga: add bindings document for fpga bridge drivers

On Sat, 5 Mar 2016, Rob Herring wrote:

> > +Example:
> > + hps_fpgabridge0: fpgabridge@ff400000 {
>
> No underscores.
>
> fpga-bridge@...

Hi Rob,

The dtc is not letting me compile if I use a hyphen in the label.
I think we have to use hyphens in the node names and underscores
in the labels. So it will end up being:

+ fpga_bridge0: fpga-bridge@ff400000 {

Alan

2016-03-28 22:09:31

by Rob Herring (Arm)

[permalink] [raw]
Subject: Re: [PATCH v17 2/6] ARM: socfpga: add bindings document for fpga bridge drivers

On Tue, Mar 15, 2016 at 05:04:53PM -0500, atull wrote:
> On Sat, 5 Mar 2016, Rob Herring wrote:
>
> > > +Example:
> > > + hps_fpgabridge0: fpgabridge@ff400000 {
> >
> > No underscores.
> >
> > fpga-bridge@...
>
> Hi Rob,
>
> The dtc is not letting me compile if I use a hyphen in the label.
> I think we have to use hyphens in the node names and underscores
> in the labels. So it will end up being:
>
> + fpga_bridge0: fpga-bridge@ff400000 {

Sorry, don't know what I was looking at. In labels, underscores are
fine. This looks fine.

Rob