Skip to content

Commit

Permalink
[PATCH] I2C: minor I2C doc cleanups
Browse files Browse the repository at this point in the history
The I2C stack has long had "id" fields, of rather dubious utility, in
many data structures.  This removes mention of one of them from the
documentation about how to write an I2C driver, so that only drivers
that really need to use them (probably old/legacy code) will have any
reason to use this field.

Signed-off-by: David Brownell <[email protected]>
Signed-off-by: Greg Kroah-Hartman <[email protected]>
  • Loading branch information
[email protected] authored and gregkh committed Jul 11, 2005
1 parent 2db3276 commit 61f5809
Showing 1 changed file with 0 additions and 7 deletions.
7 changes: 0 additions & 7 deletions Documentation/i2c/writing-clients
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ address.
static struct i2c_driver foo_driver = {
.owner = THIS_MODULE,
.name = "Foo version 2.3 driver",
.id = I2C_DRIVERID_FOO, /* from i2c-id.h, optional */
.flags = I2C_DF_NOTIFY,
.attach_adapter = &foo_attach_adapter,
.detach_client = &foo_detach_client,
Expand All @@ -37,12 +36,6 @@ static struct i2c_driver foo_driver = {
The name can be chosen freely, and may be upto 40 characters long. Please
use something descriptive here.

If used, the id should be a unique ID. The range 0xf000 to 0xffff is
reserved for local use, and you can use one of those until you start
distributing the driver, at which time you should contact the i2c authors
to get your own ID(s). Note that most of the time you don't need an ID
at all so you can just omit it.

Don't worry about the flags field; just put I2C_DF_NOTIFY into it. This
means that your driver will be notified when new adapters are found.
This is almost always what you want.
Expand Down

0 comments on commit 61f5809

Please sign in to comment.