[PATCH 3/3] i2c-ocores: add some device tree documentation

Jonas Bonn jonas at southpole.se
Fri Dec 24 20:38:57 EST 2010


> > +/*
> > + * Device tree configuration:
> > + *
> > + * Required properties:
> > + * - compatible      : "opencores,i2c-ocores"
> 
> I assume the i2c-ocore interface could end up changing in the future.
> This compatible value should have some form of version embedded into
> it.
> 

Unfortunately, versioning is currently one of OpenCores weak points.
This driver is based on specification version 0.9 and has implementation
version 1.16 according to source and SVN revision 76.  I've started an
internal discussion to try to standardize on something useful, but
there's no consensus, as of yet.  I could make something up here for the
compatible value, but I'd rather we find a consistent versioning scheme
that's tenable long-term.

I guess I'll have to sit on these patches for another cycle while we
think about this.  Of course, if you have any suggestions, let me know;
looking at other drivers, there doesn't seem to be a canonical way of
doing this...

Perhaps:  opencores,i2c-cores-0.9-76
(i.e. {driver}-{spec revision}-{implementation svn rev})

/Jonas

PS: Honestly not crazy about the name 'i2c-ocores' either as it doesn't
match the name of the upstream Verilog project which is called,
unfortunately, simply 'i2c'.  This driver, however, has been upstream
for a while so I guess we're stuck with it.



More information about the devicetree-discuss mailing list