diff options
| author | Stephen Kitt <steve@sk2.org> | 2022-03-25 17:19:10 +0100 |
|---|---|---|
| committer | Wolfram Sang <wsa@kernel.org> | 2022-05-04 22:35:19 +0200 |
| commit | 32d4536133f5d96b0b63ff70748b9ef4579b211d (patch) | |
| tree | caa49e3bb381b9893893679c92d48a4f51f6f98b /Documentation/i2c | |
| parent | 43bf42ff4737d6f6e4fb328e61cdaa9044a22639 (diff) | |
| download | linux-stable-32d4536133f5d96b0b63ff70748b9ef4579b211d.tar.gz linux-stable-32d4536133f5d96b0b63ff70748b9ef4579b211d.tar.bz2 linux-stable-32d4536133f5d96b0b63ff70748b9ef4579b211d.zip | |
docs: i2c: reference simple probes
Instead of documenting old-style probes, reference "simple probes" and
document the i2c_match_id function. This might help reduce the use of
two-argument probes in new code.
Signed-off-by: Stephen Kitt <steve@sk2.org>
Signed-off-by: Wolfram Sang <wsa@kernel.org>
Diffstat (limited to 'Documentation/i2c')
| -rw-r--r-- | Documentation/i2c/writing-clients.rst | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/Documentation/i2c/writing-clients.rst b/Documentation/i2c/writing-clients.rst index 978cc8210bf3..e3b126cf4a3b 100644 --- a/Documentation/i2c/writing-clients.rst +++ b/Documentation/i2c/writing-clients.rst @@ -46,7 +46,7 @@ driver model device node, and its I2C address. }, .id_table = foo_idtable, - .probe = foo_probe, + .probe_new = foo_probe, .remove = foo_remove, /* if device autodetection is needed: */ .class = I2C_CLASS_SOMETHING, @@ -155,8 +155,7 @@ those devices, and a remove() method to unbind. :: - static int foo_probe(struct i2c_client *client, - const struct i2c_device_id *id); + static int foo_probe(struct i2c_client *client); static int foo_remove(struct i2c_client *client); Remember that the i2c_driver does not create those client handles. The @@ -165,8 +164,12 @@ handle may be used during foo_probe(). If foo_probe() reports success foo_remove() returns. That binding model is used by most Linux drivers. 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. +matches the device's name. If the probe function needs that entry, it +can retrieve it using + +:: + + const struct i2c_device_id *id = i2c_match_id(foo_idtable, client); Device Creation |