Re: i2c: Documentation: fix device matching description

[Jean Delvare <khali-PUYAD+kWke1g9hUCZPvPmw@public.gmane.org>]

On Tue, 3 Jun 2008 18:28:57 +0100, Ben Dooks wrote:
> On Tue, Jun 03, 2008 at 06:26:03PM +0100, Ben Dooks wrote:
> > The matching process described for new style clients in
> > Documentation/i2c/writing-clients is classed as out-of-date
> > as it requires the presence of an .id_table entry in the
> > driver's i2c_driver entry.
> > 
> > Signed-off-by: Ben Dooks <ben-linux-elnMNo+KYs3YtjvyW6yDsg@public.gmane.org>
> > 
> > Index: linux-2.6.26-rc4-quilt3/Documentation/i2c/writing-clients
> > ===================================================================
> > --- linux-2.6.26-rc4-quilt3.orig/Documentation/i2c/writing-clients	2008-06-03 18:05:36.000000000 +0100
> > +++ linux-2.6.26-rc4-quilt3/Documentation/i2c/writing-clients	2008-06-03 18:25:45.000000000 +0100
> > @@ -25,12 +25,23 @@ routines, and should be zero-initialized
> >  provide.  A client structure holds device-specific information like the
> >  driver model device node, and its I2C address.
> >  
> > +/* iff driver uses driver model ("new style") binding model: */
> > +
> > +static struct i2c_device_id foo_idtable[] = {
> > +	{ "foo", my_id_for_foo },
> > +	{ "bar", my_id_for_bar },
> > +	{ }
> > +};
> > +
> > +MODULE_DEVICE_TABLE(i2c, foo_idtable);
> > +
> >  static struct i2c_driver foo_driver = {
> >  	.driver = {
> >  		.name	= "foo",
> >  	},
> >  
> >  	/* iff driver uses driver model ("new style") binding model: */
> > +	.id_table	= foo_ids,
> >  	.probe		= foo_probe,
> >  	.remove		= foo_remove,
> >  
> > @@ -173,10 +184,9 @@ handle may be used during foo_probe().  
> >  (zero not a negative status code) it may save the handle and use it until
> >  foo_remove() returns.  That binding model is used by most Linux drivers.
> >  
> > -Drivers match devices when i2c_client.driver_name and the driver name are
> > -the same; this approach is used in several other busses that don't have
> > -device typing support in the hardware.  The driver and module name should
> > -match, so hotplug/coldplug mechanisms will modprobe the driver.
> > +The probe function is called when an entry in the id_table name field
> > +matches the device's name. The probe function is passed the entry that
> > +was matched so that it can support different versions of a device.
> 
> Hmm, that would have read better as:
> 
> The probe function is called when an entry in the id_table name field
> matches the device's name. It is passed the entry that was matched so
> the driver knows which one in the table matched.

Applied and queued for 2.6.26, if I have more patches to send to Linus
(2.6.27 otherwise). Thank you.

-- 
Jean Delvare

_______________________________________________
i2c mailing list
i2c-GZX6beZjE8VD60Wz+7aTrA@public.gmane.org
http://lists.lm-sensors.org/mailman/listinfo/i2c