Skip to content

Commit

Permalink
docs: i2c: i2c-sysfs: fix hyperlinks
Browse files Browse the repository at this point in the history
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: 31df719 ("Documentation: i2c: Add doc for I2C sysfs")
Signed-off-by: Luca Ceresoli <[email protected]>
Signed-off-by: Wolfram Sang <[email protected]>
  • Loading branch information
lucaceresoli authored and wsakernel committed Aug 11, 2022
1 parent 55bdfb8 commit fe99b81
Showing 1 changed file with 4 additions and 11 deletions.
15 changes: 4 additions & 11 deletions Documentation/i2c/i2c-sysfs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,7 @@ Caveat
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
to a different number in logical I2C bus level in Device Tree Source (DTS) under
section ``aliases``. See
`arch/arm/boot/dts/nuvoton-npcm730-gsj.dts
<../../arch/arm/boot/dts/nuvoton-npcm730-gsj.dts>`_
section ``aliases``. See ``arch/arm/boot/dts/nuvoton-npcm730-gsj.dts``
for an example of DTS file.

Best Practice: **(To kernel software developers)** It is better to keep the I2C
Expand Down Expand Up @@ -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
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:
`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
I2C bus 2. The channel 2 of the MUX is defined as ``imux18`` in DTS,
Expand Down Expand Up @@ -382,13 +379,9 @@ Sysfs for the I2C sensor device::

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
------------------------------------

Refer to the doc:

`How to instantiate I2C devices, Method 4: Instantiate from user-space
<instantiating-devices.rst#method-4-instantiate-from-user-space>`_
Refer to section "Method 4: Instantiate from user-space" of instantiating-devices.rst

0 comments on commit fe99b81

Please sign in to comment.