nagai/kernel
3
0
Fork 0
forked from mirrors/linux
Code Pull requests Activity

docs: i2c: i2c-sysfs: fix hyperlinks

Browse source 
dts files cannot be linked conveniently, thus replace them with literal
formatting.

The links to other rst pages are broken, fix them using the proper syntax.

Fixes: 31df7195b1 ("Documentation: i2c: Add doc for I2C sysfs")
Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
Signed-off-by: Wolfram Sang <wsa@kernel.org>
This commit is contained in:
Luca Ceresoli 2022-08-08 16:17:08 +02:00 committed by Wolfram Sang
parent 55bdfb8b55
commit fe99b81948
1 changed files with 4 additions and 11 deletions
repo.diff.show_diff_stats Download patch file Download diff file Expand all files Collapse all files

15
Documentation/i2c/i2c-sysfs.rst
View file

@ -99,9 +99,7 @@ Caveat
This may be a confusing part for people who only know about the physical I2C This may be a confusing part for people who only know about the physical I2C
design of a board. It is actually possible to rename the I2C bus physical number design of a board. It is actually possible to rename the I2C bus physical number
to a different number in logical I2C bus level in Device Tree Source (DTS) under to a different number in logical I2C bus level in Device Tree Source (DTS) under
section ``aliases``. See section ``aliases``. See ``arch/arm/boot/dts/nuvoton-npcm730-gsj.dts``
`arch/arm/boot/dts/nuvoton-npcm730-gsj.dts
<../../arch/arm/boot/dts/nuvoton-npcm730-gsj.dts>`_
for an example of DTS file. for an example of DTS file.
Best Practice: **(To kernel software developers)** It is better to keep the I2C Best Practice: **(To kernel software developers)** It is better to keep the I2C
@ -289,8 +287,7 @@ MUX channel 0, and all the way to ``i2c-19`` for the MUX channel 3.
The kernel software developer is able to pin the fanout MUX channels to a static The kernel software developer is able to pin the fanout MUX channels to a static
logical I2C bus number in the DTS. This doc will not go through the details on logical I2C bus number in the DTS. This doc will not go through the details on
how to implement this in DTS, but we can see an example in: how to implement this in DTS, but we can see an example in:
`arch/arm/boot/dts/aspeed-bmc-facebook-wedge400.dts ``arch/arm/boot/dts/aspeed-bmc-facebook-wedge400.dts``
<../../arch/arm/boot/dts/aspeed-bmc-facebook-wedge400.dts>`_
In the above example, there is an 8-channel I2C MUX at address 0x70 on physical In the above example, there is an 8-channel I2C MUX at address 0x70 on physical
I2C bus 2. The channel 2 of the MUX is defined as ``imux18`` in DTS, I2C bus 2. The channel 2 of the MUX is defined as ``imux18`` in DTS,
@ -382,13 +379,9 @@ Sysfs for the I2C sensor device::
For more info on the Hwmon Sysfs, refer to the doc: For more info on the Hwmon Sysfs, refer to the doc:
`Naming and data format standards for sysfs files ../hwmon/sysfs-interface.rst
<../hwmon/sysfs-interface.rst>`_
Instantiate I2C Devices in I2C Sysfs Instantiate I2C Devices in I2C Sysfs
------------------------------------ ------------------------------------
Refer to the doc: Refer to section "Method 4: Instantiate from user-space" of instantiating-devices.rst
`How to instantiate I2C devices, Method 4: Instantiate from user-space
<instantiating-devices.rst#method-4-instantiate-from-user-space>`_