diff mbox series

[v4,1/2] hwmon: lochnagar: Add device tree binding document

Message ID 20190328130937.3756-1-ckeepax@opensource.cirrus.com (mailing list archive)
State Accepted
Headers show
Series [v4,1/2] hwmon: lochnagar: Add device tree binding document | expand

Commit Message

Charles Keepax March 28, 2019, 1:09 p.m. UTC 
Lochnagar is an evaluation and development board for Cirrus
Logic Smart CODEC and Amp devices. It allows the connection of
most Cirrus Logic devices on mini-cards, as well as allowing
connection of various application processor systems to provide a
full evaluation platform. This driver supports the board
controller chip on the Lochnagar board.

Signed-off-by: Charles Keepax <ckeepax@opensource.cirrus.com>
---

No changes since v3.

Thanks,
Charles

 .../devicetree/bindings/hwmon/cirrus,lochnagar.txt | 26 ++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/hwmon/cirrus,lochnagar.txt

Comments

Rob Herring March 28, 2019, 5:46 p.m. UTC | #1 
On Thu, Mar 28, 2019 at 01:09:36PM +0000, Charles Keepax wrote:
> Lochnagar is an evaluation and development board for Cirrus
> Logic Smart CODEC and Amp devices. It allows the connection of
> most Cirrus Logic devices on mini-cards, as well as allowing
> connection of various application processor systems to provide a
> full evaluation platform. This driver supports the board
> controller chip on the Lochnagar board.
> 
> Signed-off-by: Charles Keepax <ckeepax@opensource.cirrus.com>
> ---
> 
> No changes since v3.
> 
> Thanks,
> Charles
> 
>  .../devicetree/bindings/hwmon/cirrus,lochnagar.txt | 26 ++++++++++++++++++++++
>  1 file changed, 26 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/hwmon/cirrus,lochnagar.txt
> 
> diff --git a/Documentation/devicetree/bindings/hwmon/cirrus,lochnagar.txt b/Documentation/devicetree/bindings/hwmon/cirrus,lochnagar.txt
> new file mode 100644
> index 0000000000000..ffb79ccf51ee3
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/cirrus,lochnagar.txt
> @@ -0,0 +1,26 @@
> +Cirrus Logic Lochnagar Audio Development Board
> +
> +Lochnagar is an evaluation and development board for Cirrus Logic
> +Smart CODEC and Amp devices. It allows the connection of most Cirrus
> +Logic devices on mini-cards, as well as allowing connection of
> +various application processor systems to provide a full evaluation
> +platform.  Audio system topology, clocking and power can all be
> +controlled through the Lochnagar, allowing the device under test
> +to be used in a variety of possible use cases.
> +
> +This binding document describes the binding for the hardware monitor
> +portion of the driver.
> +
> +This binding must be part of the Lochnagar MFD binding:
> +  [4] ../mfd/cirrus,lochnagar.txt
> +
> +Required properties:
> +
> +  - compatible : One of the following strings:
> +                 "cirrus,lochnagar2-hwmon"
> +
> +Example:
> +
> +lochnagar-hwmon {
> +	compatible = "cirrus,lochnagar2-hwmon";

You don't have any resources in DT, the parent MFD driver can just 
instantiate this child device.

Rob
Charles Keepax March 29, 2019, 9:22 a.m. UTC | #2 
On Thu, Mar 28, 2019 at 12:46:15PM -0500, Rob Herring wrote:
> On Thu, Mar 28, 2019 at 01:09:36PM +0000, Charles Keepax wrote:
> > Lochnagar is an evaluation and development board for Cirrus
> > Logic Smart CODEC and Amp devices. It allows the connection of
> > most Cirrus Logic devices on mini-cards, as well as allowing
> > connection of various application processor systems to provide a
> > full evaluation platform. This driver supports the board
> > controller chip on the Lochnagar board.
> > 
> > Signed-off-by: Charles Keepax <ckeepax@opensource.cirrus.com>
> > ---
> > +Required properties:
> > +
> > +  - compatible : One of the following strings:
> > +                 "cirrus,lochnagar2-hwmon"
> > +
> > +Example:
> > +
> > +lochnagar-hwmon {
> > +	compatible = "cirrus,lochnagar2-hwmon";
> 
> You don't have any resources in DT, the parent MFD driver can just 
> instantiate this child device.
> 

+ Lee Jones

Lee, was very very keen for me to not mix mfd_add_devices and
of_platform_populate in the MFD driver. As such we moved all the
sub-drivers into DT. I agree it is a little odd that this exists
only to bind in this driver but I think it is probably a bit late
to change that. If we were going to have the MFD instantiating
children directly a lot of the rest of the binding would have
been done very differently.

Thanks,
Charles
Rob Herring March 29, 2019, 1:28 p.m. UTC | #3 
On Fri, Mar 29, 2019 at 4:22 AM Charles Keepax
<ckeepax@opensource.cirrus.com> wrote:
>
> On Thu, Mar 28, 2019 at 12:46:15PM -0500, Rob Herring wrote:
> > On Thu, Mar 28, 2019 at 01:09:36PM +0000, Charles Keepax wrote:
> > > Lochnagar is an evaluation and development board for Cirrus
> > > Logic Smart CODEC and Amp devices. It allows the connection of
> > > most Cirrus Logic devices on mini-cards, as well as allowing
> > > connection of various application processor systems to provide a
> > > full evaluation platform. This driver supports the board
> > > controller chip on the Lochnagar board.
> > >
> > > Signed-off-by: Charles Keepax <ckeepax@opensource.cirrus.com>
> > > ---
> > > +Required properties:
> > > +
> > > +  - compatible : One of the following strings:
> > > +                 "cirrus,lochnagar2-hwmon"
> > > +
> > > +Example:
> > > +
> > > +lochnagar-hwmon {
> > > +   compatible = "cirrus,lochnagar2-hwmon";
> >
> > You don't have any resources in DT, the parent MFD driver can just
> > instantiate this child device.
> >
>
> + Lee Jones
>
> Lee, was very very keen for me to not mix mfd_add_devices and
> of_platform_populate in the MFD driver. As such we moved all the
> sub-drivers into DT. I agree it is a little odd that this exists
> only to bind in this driver but I think it is probably a bit late
> to change that. If we were going to have the MFD instantiating
> children directly a lot of the rest of the binding would have
> been done very differently.

Okay. This is why I don't like incomplete examples...

Reviewed-by: Rob Herring <robh@kernel.org>
Charles Keepax March 29, 2019, 1:59 p.m. UTC | #4 
On Fri, Mar 29, 2019 at 08:28:35AM -0500, Rob Herring wrote:
> On Fri, Mar 29, 2019 at 4:22 AM Charles Keepax
> <ckeepax@opensource.cirrus.com> wrote:
> > On Thu, Mar 28, 2019 at 12:46:15PM -0500, Rob Herring wrote:
> > > On Thu, Mar 28, 2019 at 01:09:36PM +0000, Charles Keepax wrote:
> > > > Lochnagar is an evaluation and development board for Cirrus
> > > > Logic Smart CODEC and Amp devices. It allows the connection of
> > > > most Cirrus Logic devices on mini-cards, as well as allowing
> > > > connection of various application processor systems to provide a
> > > > full evaluation platform. This driver supports the board
> > > > controller chip on the Lochnagar board.
> > > >
> > > > Signed-off-by: Charles Keepax <ckeepax@opensource.cirrus.com>
> > > > ---
> > > > +Example:
> > > > +
> > > > +lochnagar-hwmon {
> > > > +   compatible = "cirrus,lochnagar2-hwmon";
> > >
> > > You don't have any resources in DT, the parent MFD driver can just
> > > instantiate this child device.
> > >
> >
> > + Lee Jones
> >
> > Lee, was very very keen for me to not mix mfd_add_devices and
> > of_platform_populate in the MFD driver. As such we moved all the
> > sub-drivers into DT. I agree it is a little odd that this exists
> > only to bind in this driver but I think it is probably a bit late
> > to change that. If we were going to have the MFD instantiating
> > children directly a lot of the rest of the binding would have
> > been done very differently.
> 
> Okay. This is why I don't like incomplete examples...
> 
> Reviewed-by: Rob Herring <robh@kernel.org>

Thank you, and apologies for that. I do not think it will
always be possible to include all the functionality in the
first sending, certainly from a code perspective. But we could
look at least to include some stubs/as much as we can foresee in
the binding document. Would that be the sort of direction you
had in mind?

Thanks,
Charles
Guenter Roeck March 29, 2019, 4:53 p.m. UTC | #5 
On Thu, Mar 28, 2019 at 01:09:36PM +0000, Charles Keepax wrote:
> Lochnagar is an evaluation and development board for Cirrus
> Logic Smart CODEC and Amp devices. It allows the connection of
> most Cirrus Logic devices on mini-cards, as well as allowing
> connection of various application processor systems to provide a
> full evaluation platform. This driver supports the board
> controller chip on the Lochnagar board.
> 
> Signed-off-by: Charles Keepax <ckeepax@opensource.cirrus.com>
> Reviewed-by: Rob Herring <robh@kernel.org>

Applied to hwmon-next.

Thanks,
Guenter

> ---
> 
> No changes since v3.
> 
> Thanks,
> Charles
> 
>  .../devicetree/bindings/hwmon/cirrus,lochnagar.txt | 26 ++++++++++++++++++++++
>  1 file changed, 26 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/hwmon/cirrus,lochnagar.txt
> 
> diff --git a/Documentation/devicetree/bindings/hwmon/cirrus,lochnagar.txt b/Documentation/devicetree/bindings/hwmon/cirrus,lochnagar.txt
> new file mode 100644
> index 0000000000000..ffb79ccf51ee3
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/cirrus,lochnagar.txt
> @@ -0,0 +1,26 @@
> +Cirrus Logic Lochnagar Audio Development Board
> +
> +Lochnagar is an evaluation and development board for Cirrus Logic
> +Smart CODEC and Amp devices. It allows the connection of most Cirrus
> +Logic devices on mini-cards, as well as allowing connection of
> +various application processor systems to provide a full evaluation
> +platform.  Audio system topology, clocking and power can all be
> +controlled through the Lochnagar, allowing the device under test
> +to be used in a variety of possible use cases.
> +
> +This binding document describes the binding for the hardware monitor
> +portion of the driver.
> +
> +This binding must be part of the Lochnagar MFD binding:
> +  [4] ../mfd/cirrus,lochnagar.txt
> +
> +Required properties:
> +
> +  - compatible : One of the following strings:
> +                 "cirrus,lochnagar2-hwmon"
> +
> +Example:
> +
> +lochnagar-hwmon {
> +	compatible = "cirrus,lochnagar2-hwmon";
> +};
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/hwmon/cirrus,lochnagar.txt b/Documentation/devicetree/bindings/hwmon/cirrus,lochnagar.txt
new file mode 100644
index 0000000000000..ffb79ccf51ee3
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwmon/cirrus,lochnagar.txt
@@ -0,0 +1,26 @@ 
+Cirrus Logic Lochnagar Audio Development Board
+
+Lochnagar is an evaluation and development board for Cirrus Logic
+Smart CODEC and Amp devices. It allows the connection of most Cirrus
+Logic devices on mini-cards, as well as allowing connection of
+various application processor systems to provide a full evaluation
+platform.  Audio system topology, clocking and power can all be
+controlled through the Lochnagar, allowing the device under test
+to be used in a variety of possible use cases.
+
+This binding document describes the binding for the hardware monitor
+portion of the driver.
+
+This binding must be part of the Lochnagar MFD binding:
+  [4] ../mfd/cirrus,lochnagar.txt
+
+Required properties:
+
+  - compatible : One of the following strings:
+                 "cirrus,lochnagar2-hwmon"
+
+Example:
+
+lochnagar-hwmon {
+	compatible = "cirrus,lochnagar2-hwmon";
+};