[PATCH 01/12] pinctrl: dt-bindings: Add documentation for Aspeed pin controllers

[Andrew Jeffery]

On Wed, 2016-07-20 at 14:05 -0500, Rob Herring wrote:
> On Wed, Jul 20, 2016 at 03:28:22PM +0930, Andrew Jeffery wrote:
> > 
> > Outline expectations on the pin controller's relationship with the
> > System Control Unit (SCU) IP through syscon, and document the compatible
> > strings for 4th and 5th generation Aspeed SoC pin controllers.
> > 
> > Signed-off-by: Andrew Jeffery <andrew at aj.id.au>
> > ---
> >  .../devicetree/bindings/pinctrl/pinctrl-aspeed.txt | 45 ++++++++++++++++++++++
> >  MAINTAINERS                                        |  1 +
> >  2 files changed, 46 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/pinctrl/pinctrl-aspeed.txt
> > 
> > diff --git a/Documentation/devicetree/bindings/pinctrl/pinctrl-aspeed.txt b/Documentation/devicetree/bindings/pinctrl/pinctrl-aspeed.txt
> > new file mode 100644
> > index 000000000000..5aac6a0a2e89
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/pinctrl/pinctrl-aspeed.txt
> > @@ -0,0 +1,45 @@
> > +Aspeed Pin Controllers
> > +----------------------
> > +
> > +The Aspeed SoCs vary in functionality inside a generation but have a common mux
> > +device register layout.
> > +
> > +Required properties:
> > +- compatible: should be one of the following:
> > +	"aspeed,g4-pinctrl";
> > +	"aspeed,g5-pinctrl"
> > +
> > +The pin controller node should be a child of a syscon node with the required
> > +property:
> > +- compatible: "syscon", "simple-mfd"
> > +
> > +Refer to the the bindings described in
> > +Documentation/devicetree/bindings/mfd/syscon.txt
> > +
> > +Subnode format:
> > +
> > +Please refer to pinctrl-bindings.txt in this directory for details of the
> > +common pinctrl bindings used by client devices.
> > +
> > +The required properties of child nodes are (as defined in pinctrl-bindings):
> > +- function
> > +- groups
> > +
> > +Each function has only one associated pin group. Each group is named by its
> > +function.
> > +
> > +Examples:
> > +
> > +syscon: scu at 1e6e2000 {
> > +	compatible = "syscon", "simple-mfd";
> > +	reg = <0x1e6e2000 0x1a8>;
> > +
> > +	pinctrl: pinctrl at 1e6e2000 {
> > +		compatible = "aspeed,g4-pinctrl";
> > +
> > +		pinctrl_i2c3_default: i2c3_default {
> > +			function = "I2C3";
> > +			groups = "I2C3";
> All these strings need to be documented.

Right! Will do.

Cheers,

Andrew
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: This is a digitally signed message part
URL: <http://lists.infradead.org/pipermail/linux-arm-kernel/attachments/20160721/707e6ef1/attachment.sig>