Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1756239AbaFYJdK (ORCPT ); Wed, 25 Jun 2014 05:33:10 -0400 Received: from cam-admin0.cambridge.arm.com ([217.140.96.50]:34487 "EHLO cam-admin0.cambridge.arm.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752199AbaFYJdF (ORCPT ); Wed, 25 Jun 2014 05:33:05 -0400 Date: Wed, 25 Jun 2014 10:32:59 +0100 From: Mark Rutland To: Daniel Jeong Cc: Jingoo Han , Bryan Wu , Lee Jones , Jean-Christophe Plagniol-Villard , Tomi Valkeinen , "grant.likely@linaro.org" , Rob Herring , Randy Dunlap , Daniel Jeong , "linux-kernel@vger.kernel.org" , "linux-fbdev@vger.kernel.org" , "devicetree@vger.kernel.org" , "linux-doc@vger.kernel.org" Subject: Re: [RFC v3 2/2] backlight: device tree: add new tps611xx backlight driver Message-ID: <20140625093259.GC29789@leverpostej> References: <1403594330-15387-1-git-send-email-gshark.jeong@gmail.com> <1403594330-15387-3-git-send-email-gshark.jeong@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <1403594330-15387-3-git-send-email-gshark.jeong@gmail.com> Thread-Topic: [RFC v3 2/2] backlight: device tree: add new tps611xx backlight driver Accept-Language: en-GB, en-US Content-Language: en-US User-Agent: Mutt/1.5.21 (2010-09-15) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Hello, Please fix the subject: this is a _binding_, not a driver. On Tue, Jun 24, 2014 at 08:18:50AM +0100, Daniel Jeong wrote: > This commit is about tps611xx device tree documentation. > > Signed-off-by: Daniel Jeong > --- > .../video/backlight/tps611xx-backlight.txt | 16 ++++++++++++++++ > 1 file changed, 16 insertions(+) > create mode 100644 Documentation/devicetree/bindings/video/backlight/tps611xx-backlight.txt > > diff --git a/Documentation/devicetree/bindings/video/backlight/tps611xx-backlight.txt b/Documentation/devicetree/bindings/video/backlight/tps611xx-backlight.txt > new file mode 100644 > index 0000000..01f110d > --- /dev/null > +++ b/Documentation/devicetree/bindings/video/backlight/tps611xx-backlight.txt > @@ -0,0 +1,16 @@ > +TPS611xx family of backlight driver based on EasyScale. > + > +It supports tps61158, tps61161, tps61163 and tps61165. What supports these? The driver? The binding should describe the _hardware_, not the driver. > +Required properties: > +- compatible: "ti,tps61158_bl", "ti,tps61161_bl", "ti,tps61163_bl", "ti,tps61165_bl" Use '-' rather than '_' in compatible strings and properties. Is there any reason for the "bl" suffix? Does that actually form part of the name of the unit, or is that just to point out it's a backlight? If it's the latter, drop it. Are these all very similar? Can I use a particular string as a fallback? To allow for future expansion, the addition of notes, and to make this easier to read, I would recommend formatting this something like: - compatible: should contain at least one of: * "ti,tps61158" * "ti,tps61161" * "ti,tps61163" * "ti,tps61165" > +- rfa_en: enable request for acknowledge. ( 0 : disable , 1 : enable ) Use empty properties for describing booleans. That said, why does this need to be in the DT? When would I want this and when wouldn't I? Why can't the driver choose? > +- en_gpio_num: gpio number for en pin. Use the GPIO bindings. The numbering Linux uses internally is completely arbitrary, so this is completely broken. Are there other pins we might need to describe? Regulators? Clocks? Mark. -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/