MIME-Version: 1.0
In-Reply-To: <86044d44009316a48b402050f9dd742391d46eac.1329073559.git.marvin24@gmx.de>
References: <1ec0e63a7453072689618430ebc2bdd7b62542a2.1329073559.git.marvin24@gmx.de>
	<86044d44009316a48b402050f9dd742391d46eac.1329073559.git.marvin24@gmx.de>
Date: Sun, 12 Feb 2012 12:21:12 -0800
Message-ID: <CAPnjgZ2b4QjKMKjKyHqGGU1TbMamq6pBPUAAO99gMa98Rd+Erw@mail.gmail.com> (sfid-20120212_212134_522451_CD16F66C)
Subject: Re: [PATCH 2/3] dt: rfkill-gpio: add bindings documentation
From: Simon Glass <sjg@chromium.org>
To: Marc Dietrich <marvin24@gmx.de>
Cc: linux-tegra@vger.kernel.org, Stephen Warren <swarren@nvidia.com>,
	Colin Cross <ccross@android.com>,
	Olof Johansson <olof@lixom.net>,
	linux-wireless@vger.kernel.org,
	"John W. Linville" <linville@tuxdriver.com>,
	Johannes Berg <johannes@sipsolutions.net>,
	Rhyland Klein <rklein@nvidia.com>,
	Grant Likely <grant.likely@secretlab.ca>,
	devicetree-discuss@lists.ozlabs.org
Content-Type: text/plain; charset=ISO-8859-1
Sender: linux-wireless-owner@vger.kernel.org

Hi Marc,

On Sun, Feb 12, 2012 at 11:13 AM, Marc Dietrich <marvin24@gmx.de> wrote:
> Add device tree bindings information for rfkill gpio switches.
>
> Cc: linux-wireless@vger.kernel.org
> Cc: "John W. Linville" <linville@tuxdriver.com>
> Cc: Johannes Berg <johannes@sipsolutions.net>
> Cc: Rhyland Klein <rklein@nvidia.com>
> Cc: Grant Likely <grant.likely@secretlab.ca>
> Cc: devicetree-discuss@lists.ozlabs.org
> Signed-off-by: Marc Dietrich <marvin24@gmx.de>
> ---
> ?Documentation/devicetree/bindings/gpio/rfkill.txt | ? 38 +++++++++++++++++++++
> ?1 files changed, 38 insertions(+), 0 deletions(-)
> ?create mode 100644 Documentation/devicetree/bindings/gpio/rfkill.txt
>
> diff --git a/Documentation/devicetree/bindings/gpio/rfkill.txt b/Documentation/devicetree/bindings/gpio/rfkill.txt
> new file mode 100644
> index 0000000..22bf22a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/gpio/rfkill.txt
> @@ -0,0 +1,38 @@
> +RFKILL switches connected to GPIO lines
> +
> +Required properties:
> +- compatible : should be "rfkill-gpio".
> +
> +Each rfkill switch is represented as a sub-node of the rfkill-gpio device.
> +Each node has a label property which represents the name of the corresponding
> +rfkill device.
> +
> +RFKILL sub-node properties:
> +- label : ?(optional) The label for this rfkill switch. ?If omitted, the label is
> + ?taken from the node name (excluding the unit address).
> +- reset-gpio, shutdown-gpio : ?Should specify the rfkill gpios for reset and
> + ?shutdown (see "Specifying GPIO information for devices" in

Should that be reset-gpios, shutdown-gpios? Even though you have only
one it seems that people put an 's' on the end.

> + ?Documentation/devicetree/booting-without-of.txt).
> +- type : enumerated type of the gpio (see include/linux/rfkill.h).

It would be better I think if this were explicit here. If you have a
number, then what values does it take and what do they mean?

> +- clock : (optional) name of the clock name associated with the rfkill switch

Can this be a phandle instead of a string?

> + ?(see include/linux/rfkill-gpio.h)

IMO device tree bindings should be fully documented in this file,
rather than needing to look at a separate header. This is particularly
true if the binding is used in another project.

> +
> +Examples:
> +
> +rfkill-switches {
> + ? ? ? compatible = "rfkill-gpio";
> +
> + ? ? ? wifi {
> + ? ? ? ? ? ? ? label = "wifi";
> + ? ? ? ? ? ? ? reset-gpio = <&gpio 25 0>; /* Active high */
> + ? ? ? ? ? ? ? shutdown-gpio = <&gpio 85 0>; /* Active high */
> + ? ? ? ? ? ? ? type = <1>;
> + ? ? ? };
> +
> + ? ? ? bt {
> + ? ? ? ? ? ? ? label = "bluetooth";
> + ? ? ? ? ? ? ? reset-gpio = <&gpio 17 0>; /* Active high */
> + ? ? ? ? ? ? ? shutdown-gpio = <&gpio 35 0>; /* Active high */
> + ? ? ? ? ? ? ? type = <1>;
> + ? ? ? };
> +};
> --
> 1.7.5.4
>
> --
> To unsubscribe from this list: send the line "unsubscribe linux-tegra" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at ?http://vger.kernel.org/majordomo-info.html

Regards,
Simon