blob: b08b6daabce9b62f2cecefabe7e2f6bd64a04771 [file] [log] [blame]
Luca Ceresolif6fcefa2020-01-29 16:19:51 +01001================================================================
2I2C device driver binding control from user-space in old kernels
3================================================================
Jean Delvarec7b25a92009-12-06 17:06:24 +01004
Luca Ceresolidfea2b12020-01-29 16:19:49 +01005.. NOTE::
6 Note: this section is only relevant if you are handling some old code
7 found in kernel 2.6. If you work with more recent kernels, you can
8 safely skip this section.
9
Luca Ceresoli2f07c052020-01-29 16:19:29 +010010Up to kernel 2.6.32, many I2C drivers used helper macros provided by
Jean Delvarec7b25a92009-12-06 17:06:24 +010011<linux/i2c.h> which created standard module parameters to let the user
Luca Ceresoli2f07c052020-01-29 16:19:29 +010012control how the driver would probe I2C buses and attach to devices. These
Luca Ceresoli1ef05722020-01-29 16:19:50 +010013parameters were known as ``probe`` (to let the driver probe for an extra
14address), ``force`` (to forcibly attach the driver to a given device) and
15``ignore`` (to prevent a driver from probing a given address).
Jean Delvarec7b25a92009-12-06 17:06:24 +010016
Luca Ceresoli2f07c052020-01-29 16:19:29 +010017With the conversion of the I2C subsystem to the standard device driver
Jean Delvarec7b25a92009-12-06 17:06:24 +010018binding model, it became clear that these per-module parameters were no
19longer needed, and that a centralized implementation was possible. The new,
Mauro Carvalho Chehab25edd3a2021-06-16 08:27:33 +020020sysfs-based interface is described in
21Documentation/i2c/instantiating-devices.rst, section
Luca Ceresoli899b56b2020-01-29 16:19:48 +010022"Method 4: Instantiate from user-space".
Jean Delvarec7b25a92009-12-06 17:06:24 +010023
24Below is a mapping from the old module parameters to the new interface.
25
26Attaching a driver to an I2C device
27-----------------------------------
28
Mauro Carvalho Chehabccf988b2019-07-26 09:51:16 -030029Old method (module parameters)::
Jean Delvarec7b25a92009-12-06 17:06:24 +010030
Mauro Carvalho Chehabccf988b2019-07-26 09:51:16 -030031 # modprobe <driver> probe=1,0x2d
32 # modprobe <driver> force=1,0x2d
33 # modprobe <driver> force_<device>=1,0x2d
34
35New method (sysfs interface)::
36
37 # echo <device> 0x2d > /sys/bus/i2c/devices/i2c-1/new_device
Jean Delvarec7b25a92009-12-06 17:06:24 +010038
39Preventing a driver from attaching to an I2C device
40---------------------------------------------------
41
Mauro Carvalho Chehabccf988b2019-07-26 09:51:16 -030042Old method (module parameters)::
Jean Delvarec7b25a92009-12-06 17:06:24 +010043
Mauro Carvalho Chehabccf988b2019-07-26 09:51:16 -030044 # modprobe <driver> ignore=1,0x2f
45
46New method (sysfs interface)::
47
48 # echo dummy 0x2f > /sys/bus/i2c/devices/i2c-1/new_device
49 # modprobe <driver>
Jean Delvarec7b25a92009-12-06 17:06:24 +010050
Luca Ceresoli1ef05722020-01-29 16:19:50 +010051Of course, it is important to instantiate the ``dummy`` device before loading
Jean Delvarec7b25a92009-12-06 17:06:24 +010052the driver. The dummy device will be handled by i2c-core itself, preventing
53other drivers from binding to it later on. If there is a real device at the
54problematic address, and you want another driver to bind to it, then simply
Luca Ceresoli1ef05722020-01-29 16:19:50 +010055pass the name of the device in question instead of ``dummy``.