Luca Ceresoli | f6fcefa | 2020-01-29 16:19:51 +0100 | [diff] [blame] | 1 | ================================================================ |
| 2 | I2C device driver binding control from user-space in old kernels |
| 3 | ================================================================ |
Jean Delvare | c7b25a9 | 2009-12-06 17:06:24 +0100 | [diff] [blame] | 4 | |
Luca Ceresoli | dfea2b1 | 2020-01-29 16:19:49 +0100 | [diff] [blame] | 5 | .. 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 Ceresoli | 2f07c05 | 2020-01-29 16:19:29 +0100 | [diff] [blame] | 10 | Up to kernel 2.6.32, many I2C drivers used helper macros provided by |
Jean Delvare | c7b25a9 | 2009-12-06 17:06:24 +0100 | [diff] [blame] | 11 | <linux/i2c.h> which created standard module parameters to let the user |
Luca Ceresoli | 2f07c05 | 2020-01-29 16:19:29 +0100 | [diff] [blame] | 12 | control how the driver would probe I2C buses and attach to devices. These |
Luca Ceresoli | 1ef0572 | 2020-01-29 16:19:50 +0100 | [diff] [blame] | 13 | parameters were known as ``probe`` (to let the driver probe for an extra |
| 14 | address), ``force`` (to forcibly attach the driver to a given device) and |
| 15 | ``ignore`` (to prevent a driver from probing a given address). |
Jean Delvare | c7b25a9 | 2009-12-06 17:06:24 +0100 | [diff] [blame] | 16 | |
Luca Ceresoli | 2f07c05 | 2020-01-29 16:19:29 +0100 | [diff] [blame] | 17 | With the conversion of the I2C subsystem to the standard device driver |
Jean Delvare | c7b25a9 | 2009-12-06 17:06:24 +0100 | [diff] [blame] | 18 | binding model, it became clear that these per-module parameters were no |
| 19 | longer needed, and that a centralized implementation was possible. The new, |
Mauro Carvalho Chehab | 25edd3a | 2021-06-16 08:27:33 +0200 | [diff] [blame] | 20 | sysfs-based interface is described in |
| 21 | Documentation/i2c/instantiating-devices.rst, section |
Luca Ceresoli | 899b56b | 2020-01-29 16:19:48 +0100 | [diff] [blame] | 22 | "Method 4: Instantiate from user-space". |
Jean Delvare | c7b25a9 | 2009-12-06 17:06:24 +0100 | [diff] [blame] | 23 | |
| 24 | Below is a mapping from the old module parameters to the new interface. |
| 25 | |
| 26 | Attaching a driver to an I2C device |
| 27 | ----------------------------------- |
| 28 | |
Mauro Carvalho Chehab | ccf988b | 2019-07-26 09:51:16 -0300 | [diff] [blame] | 29 | Old method (module parameters):: |
Jean Delvare | c7b25a9 | 2009-12-06 17:06:24 +0100 | [diff] [blame] | 30 | |
Mauro Carvalho Chehab | ccf988b | 2019-07-26 09:51:16 -0300 | [diff] [blame] | 31 | # modprobe <driver> probe=1,0x2d |
| 32 | # modprobe <driver> force=1,0x2d |
| 33 | # modprobe <driver> force_<device>=1,0x2d |
| 34 | |
| 35 | New method (sysfs interface):: |
| 36 | |
| 37 | # echo <device> 0x2d > /sys/bus/i2c/devices/i2c-1/new_device |
Jean Delvare | c7b25a9 | 2009-12-06 17:06:24 +0100 | [diff] [blame] | 38 | |
| 39 | Preventing a driver from attaching to an I2C device |
| 40 | --------------------------------------------------- |
| 41 | |
Mauro Carvalho Chehab | ccf988b | 2019-07-26 09:51:16 -0300 | [diff] [blame] | 42 | Old method (module parameters):: |
Jean Delvare | c7b25a9 | 2009-12-06 17:06:24 +0100 | [diff] [blame] | 43 | |
Mauro Carvalho Chehab | ccf988b | 2019-07-26 09:51:16 -0300 | [diff] [blame] | 44 | # modprobe <driver> ignore=1,0x2f |
| 45 | |
| 46 | New method (sysfs interface):: |
| 47 | |
| 48 | # echo dummy 0x2f > /sys/bus/i2c/devices/i2c-1/new_device |
| 49 | # modprobe <driver> |
Jean Delvare | c7b25a9 | 2009-12-06 17:06:24 +0100 | [diff] [blame] | 50 | |
Luca Ceresoli | 1ef0572 | 2020-01-29 16:19:50 +0100 | [diff] [blame] | 51 | Of course, it is important to instantiate the ``dummy`` device before loading |
Jean Delvare | c7b25a9 | 2009-12-06 17:06:24 +0100 | [diff] [blame] | 52 | the driver. The dummy device will be handled by i2c-core itself, preventing |
| 53 | other drivers from binding to it later on. If there is a real device at the |
| 54 | problematic address, and you want another driver to bind to it, then simply |
Luca Ceresoli | 1ef0572 | 2020-01-29 16:19:50 +0100 | [diff] [blame] | 55 | pass the name of the device in question instead of ``dummy``. |