docs: i2c: instantiating-devices: use monospace for sysfs attributes
[linux-block.git] / Documentation / i2c / old-module-parameters.rst
CommitLineData
ccf988b6 1=================================================
c7b25a9e
JD
2I2C device driver binding control from user-space
3=================================================
4
2f07c05f 5Up to kernel 2.6.32, many I2C drivers used helper macros provided by
c7b25a9e 6<linux/i2c.h> which created standard module parameters to let the user
2f07c05f 7control how the driver would probe I2C buses and attach to devices. These
c7b25a9e
JD
8parameters were known as "probe" (to let the driver probe for an extra
9address), "force" (to forcibly attach the driver to a given device) and
10"ignore" (to prevent a driver from probing a given address).
11
2f07c05f 12With the conversion of the I2C subsystem to the standard device driver
c7b25a9e
JD
13binding model, it became clear that these per-module parameters were no
14longer needed, and that a centralized implementation was possible. The new,
15sysfs-based interface is described in the documentation file
16"instantiating-devices", section "Method 4: Instantiate from user-space".
17
18Below is a mapping from the old module parameters to the new interface.
19
20Attaching a driver to an I2C device
21-----------------------------------
22
ccf988b6
MCC
23Old method (module parameters)::
24
25 # modprobe <driver> probe=1,0x2d
26 # modprobe <driver> force=1,0x2d
27 # modprobe <driver> force_<device>=1,0x2d
28
29New method (sysfs interface)::
c7b25a9e 30
ccf988b6 31 # echo <device> 0x2d > /sys/bus/i2c/devices/i2c-1/new_device
c7b25a9e
JD
32
33Preventing a driver from attaching to an I2C device
34---------------------------------------------------
35
ccf988b6
MCC
36Old method (module parameters)::
37
38 # modprobe <driver> ignore=1,0x2f
39
40New method (sysfs interface)::
c7b25a9e 41
ccf988b6
MCC
42 # echo dummy 0x2f > /sys/bus/i2c/devices/i2c-1/new_device
43 # modprobe <driver>
c7b25a9e
JD
44
45Of course, it is important to instantiate the "dummy" device before loading
46the driver. The dummy device will be handled by i2c-core itself, preventing
47other drivers from binding to it later on. If there is a real device at the
48problematic address, and you want another driver to bind to it, then simply
49pass the name of the device in question instead of "dummy".