From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1754882Ab3KKRN7 (ORCPT ); Mon, 11 Nov 2013 12:13:59 -0500 Received: from arroyo.ext.ti.com ([192.94.94.40]:55264 "EHLO arroyo.ext.ti.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1754840Ab3KKRNp (ORCPT ); Mon, 11 Nov 2013 12:13:45 -0500 Message-ID: <5281103F.8050407@ti.com> Date: Mon, 11 Nov 2013 11:13:35 -0600 From: Joel Fernandes User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:17.0) Gecko/20130803 Thunderbird/17.0.8 MIME-Version: 1.0 To: Mark Rutland CC: "devicetree@vger.kernel.org" , "santosh.shilimkar@ti.com" , "linux-omap@vger.kernel.org" , "rob.herring@calxeda.com" , Pawel Moll , Stephen Warren , Ian Campbell , Rob Landley , open list: DOCUMENTATION , open list , ; Illegal-Object: Syntax error in CC: address found on vger.kernel.org: CC: ; ^-missing semicolon to end mail group, extraneous tokens in mailbox, missing end of mailbox Subject: Re: [PATCH] doc: devicetree: Add bindings documentation for omap-des driver References: <1383871035-16608-1-git-send-email-joelf@ti.com> <20131111110106.GC21201@e106331-lin.cambridge.arm.com> In-Reply-To: <20131111110106.GC21201@e106331-lin.cambridge.arm.com> Content-Type: text/plain; charset="ISO-8859-1" Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On 11/11/2013 05:01 AM, Mark Rutland wrote: > Hi Joel, > > I realise I'm a little late in replying to this, but there are a few > things that would be nice to fix up. > > On Fri, Nov 08, 2013 at 12:37:09AM +0000, Joel Fernandes wrote: >> Add documentation for the generic OMAP DES crypto module describing the device >> tree bindings. >> >> Signed-off-by: Joel Fernandes >> --- >> .../devicetree/bindings/crypto/omap-des.txt | 28 ++++++++++++++++++++++ >> 1 file changed, 28 insertions(+) >> create mode 100644 Documentation/devicetree/bindings/crypto/omap-des.txt >> >> diff --git a/Documentation/devicetree/bindings/crypto/omap-des.txt b/Documentation/devicetree/bindings/crypto/omap-des.txt >> new file mode 100644 >> index 0000000..0637647 >> --- /dev/null >> +++ b/Documentation/devicetree/bindings/crypto/omap-des.txt >> @@ -0,0 +1,28 @@ >> +OMAP SoC DES crypto Module >> + >> +Required properties: >> + >> +- compatible : Should be "ti,omap4-des" > > Nit: s/Should be/Should contain/ ok > >> +- ti,hwmods: Name of the hwmod associated with the DES module >> +- reg : Offset and length of the register set for the module >> +- interrupts : the interrupt-specifier for the DES module > > Just to check: there's only one interrupt? Yes. >> +- clocks : phandle to the functional clock node of the DES module >> +- clock-names : Name of the functional clock > > What name is expected here? The intent of clock-names is to describe > which clock input lines the clocks are wired to, so this should be > well-defined. > > From the looks of the example, the clock input is called "fck". Is that > correct? Yes. The clock name is used by PM code to get the clock for the particular device. Yes the code assumes it to be "fck", I can change doc to be so. > When you have clock-names, the nicest thing to do is to define clocks > in terms of clock-names. Something like: > > - clocks: A phandle + clock-specifier pair for each entry in > clock-names. > > - clock-names: Should contain: > * "fck" for the functional clock > > Which implies that the correct way to find clocks is to look in > clock-names first to find the clock's index, rather than grabbing the > clock by index. This makes it far easier to add/remove/change clocks in > future. Ok. I'll reword documentation of clocks as above. > >> + >> +Optional properties: >> +- dmas: DMA specifiers for tx and rx dma. See the DMA client binding, >> + Documentation/devicetree/bindings/dma/dma.txt > > Similarly here it would be nice to have dmas refer to dma-names for > the description of which dmas exist. Ok, will make the above 3 changes and resubmit, if its ok will add your Reviewed-by. thanks, -Joel