Re: [PATCH v3 1/3] usb: dwc3: msm: Add device tree binding information

["Ivan T. Ivanov" <iivanov@mm-sol.com>]

Hi, 

On Fri, 2013-08-16 at 16:44 -0600, Stephen Warren wrote: 
> On 08/14/2013 06:59 AM, Ivan T. Ivanov wrote:
> > From: "Ivan T. Ivanov" <iivanov@mm-sol.com>
> > 
> > MSM USB3.0 core wrapper consist of USB3.0 IP from Synopsys
> > (SNPS) and HS, SS PHY's control and configuration registers.
> > 
> > It could operate in device mode (SS, HS, FS) and host
> > mode (SS, HS, FS, LS).
> 
> > diff --git a/Documentation/devicetree/bindings/usb/msm-ssusb.txt b/Documentation/devicetree/bindings/usb/msm-ssusb.txt
> 
> > +- clock-names :
> ...
> > +	"sleep_a_clk" : Sleep clock, used when USB3 core goes into low
> ...
> > +	"ref_clk" : Reference clock - used in host mode.
> ...
> > +	"core_clk" : Master/Core clock, have to be >= 125 MHz for SS
> ...
> > +	"iface_clk" : System bus AXI clock
> > +	"sleep_clk" : Sleep clock, used when USB3 core goes into low
> ...
> > +	"utmi_clk" : Generated by HS-PHY. Used to clock the low power
> 
> I think it makes sense to remove "_clk" from all those names, unless the
> HW documentation really talks about a clock named e.g. iface_clk yet
> some other clock names in the documentation don't have the "_clk"
> suffix, e.g. the "xo I didn't quote.

>From limited information that I have, I could not say how clock inputs 
are named from the controller perspective, but I agree that "_clk"
suffix looks redundant. 

Side question: if for example label in controller says "UTMI", should I
also use capital letters for the resource or this could be "utmi"?

> 
> > +Sub nodes:
> > +==========
> 
> That section title is the same style as all the other section title, so
> it's no obvious that this is a sub-node for the controller wrapper.
> Instead, I would suggest something more like:
> 
> Required child nodes:
> 
> > +- Sub node for "DWC3 USB3 controller".
> 
> Then you can drop that since it's obvious.
> 
> > +  This sub node is required property for device node. The properties
> > +  of this subnode are specified in dwc3.txt.
> 
> That doesn't really say much. How about.
> 
> ----------
> A child node must exist to represent the core DWC3 IP block. The name of
> the node is not important. The content of the node is defined in dwc3.txt.
> ----------

Thanks, I will use your suggestion.

Regards,
Ivan