Subject: Re: [PATCH 1/2] can: sja1000: add documentation for Technologic Systems version

From: Damien Riegel <[email-masked]>
Date: Mon, 21 Dec 2015 10:09:54 -0500

On Sat, Dec 19, 2015 at 09:37:42PM -0600, Rob Herring wrote:
> On Fri, Dec 18, 2015 at 03:17:24PM -0500, Damien Riegel wrote:
> > This commit adds documentation for the Technologic Systems version of
> > SJA1000. The difference with the NXP version is in the way the registers
> > are accessed.
> > 
> > Signed-off-by: Damien Riegel <[email-masked]>
> > ---
> >  Documentation/devicetree/bindings/net/can/sja1000.txt | 3 ++-
> >  1 file changed, 2 insertions(+), 1 deletion(-)
> > 
> > diff --git a/Documentation/devicetree/bindings/net/can/sja1000.txt b/Documentation/devicetree/bindings/net/can/sja1000.txt
> > index b4a6d53..7a158d5 100644
> > --- a/Documentation/devicetree/bindings/net/can/sja1000.txt
> > +++ b/Documentation/devicetree/bindings/net/can/sja1000.txt
> > @@ -2,7 +2,7 @@ Memory mapped SJA1000 CAN controller from NXP (formerly Philips)
> >  
> >  Required properties:
> >  
> > -- compatible : should be "nxp,sja1000".
> > +- compatible : should be one of "nxp,sja1000", "technologic,sja1000".
> >  
> >  - reg : should specify the chip select, address offset and size required
> >  	to map the registers of the SJA1000. The size is usually 0x80.
> > @@ -14,6 +14,7 @@ Optional properties:
> >  
> >  - reg-io-width : Specify the size (in bytes) of the IO accesses that
> >  	should be performed on the device.  Valid value is 1, 2 or 4.
> > +	Must be set to 2 for technologic version.
> >  	Default to 1 (8 bits).
> 
> Really, this should default to 2 for technologic version and not be 
> required.

Would something along the line of "This property is <not used|ignored>
for technologic version." be more appropriate?

Thanks,
Damien