Forum | Documentation | Website | Blog

Skip to content
Snippets Groups Projects
Commit ccf988b6 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

docs: i2c: convert to ReST and add to driver-api bookset


Convert each file at I2C subsystem, renaming them to .rst and
adding to the driver-api book.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Acked-by: default avatarWolfram Sang <wsa@the-dreams.de>
Acked-by: default avatarAlexandre Belloni <alexandre.belloni@bootlin.com>
Acked-by: default avatarJonathan Cameron <Jonathan.Cameron@huawei.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 09f4c750
No related merge requests found
Showing
with 20 additions and 20 deletions
...@@ -42,7 +42,7 @@ Optional properties: ...@@ -42,7 +42,7 @@ Optional properties:
This means that no unrelated I2C transactions are allowed on the parent I2C This means that no unrelated I2C transactions are allowed on the parent I2C
adapter for the complete multiplexed I2C transaction. adapter for the complete multiplexed I2C transaction.
The properties of mux-locked and parent-locked multiplexers are discussed The properties of mux-locked and parent-locked multiplexers are discussed
in more detail in Documentation/i2c/i2c-topology. in more detail in Documentation/i2c/i2c-topology.rst.
For each i2c child node, an I2C child bus will be created. They will For each i2c child node, an I2C child bus will be created. They will
be numbered based on their order in the device tree. be numbered based on their order in the device tree.
......
...@@ -83,7 +83,7 @@ Instantiate the device ...@@ -83,7 +83,7 @@ Instantiate the device
---------------------- ----------------------
After loading the driver, you can instantiate the device as After loading the driver, you can instantiate the device as
described in 'Documentation/i2c/instantiating-devices'. described in 'Documentation/i2c/instantiating-devices.rst'.
If you have multiple BMCs, each connected to your Satellite MC via If you have multiple BMCs, each connected to your Satellite MC via
a different I2C bus, you can instantiate a device for each of a different I2C bus, you can instantiate a device for each of
those BMCs. those BMCs.
......
...@@ -142,7 +142,7 @@ loading the adm1021 module, then things are good. ...@@ -142,7 +142,7 @@ loading the adm1021 module, then things are good.
If nothing happens when loading the adm1021 module, and you are certain If nothing happens when loading the adm1021 module, and you are certain
that your specific Xeon processor model includes compatible sensors, you that your specific Xeon processor model includes compatible sensors, you
will have to explicitly instantiate the sensor chips from user-space. See will have to explicitly instantiate the sensor chips from user-space. See
method 4 in Documentation/i2c/instantiating-devices. Possible slave method 4 in Documentation/i2c/instantiating-devices.rst. Possible slave
addresses are 0x18, 0x1a, 0x29, 0x2b, 0x4c, or 0x4e. It is likely that addresses are 0x18, 0x1a, 0x29, 0x2b, 0x4c, or 0x4e. It is likely that
only temp2 will be correct and temp1 will have to be ignored. only temp2 will be correct and temp1 will have to be ignored.
......
...@@ -75,7 +75,7 @@ Usage Notes ...@@ -75,7 +75,7 @@ Usage Notes
----------- -----------
This driver does not auto-detect devices. You will have to instantiate the This driver does not auto-detect devices. You will have to instantiate the
devices explicitly. Please see Documentation/i2c/instantiating-devices for devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
details. details.
The ADM1075, unlike many other PMBus devices, does not support internal voltage The ADM1075, unlike many other PMBus devices, does not support internal voltage
......
...@@ -27,7 +27,7 @@ The devices communicate with the I2C protocol. All sensors are set to the same ...@@ -27,7 +27,7 @@ The devices communicate with the I2C protocol. All sensors are set to the same
I2C address 0x27 by default, so an entry with I2C_BOARD_INFO("hih6130", 0x27) I2C address 0x27 by default, so an entry with I2C_BOARD_INFO("hih6130", 0x27)
can be used in the board setup code. can be used in the board setup code.
Please see Documentation/i2c/instantiating-devices for details on how to Please see Documentation/i2c/instantiating-devices.rst for details on how to
instantiate I2C devices. instantiate I2C devices.
sysfs-Interface sysfs-Interface
......
...@@ -17,7 +17,7 @@ Usage Notes ...@@ -17,7 +17,7 @@ Usage Notes
----------- -----------
This driver does not auto-detect devices. You will have to instantiate the This driver does not auto-detect devices. You will have to instantiate the
devices explicitly. Please see Documentation/i2c/instantiating-devices for devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
details. details.
Sysfs entries Sysfs entries
......
...@@ -76,7 +76,7 @@ Usage Notes ...@@ -76,7 +76,7 @@ Usage Notes
----------- -----------
This driver does not auto-detect devices. You will have to instantiate the This driver does not auto-detect devices. You will have to instantiate the
devices explicitly. Please see Documentation/i2c/instantiating-devices for devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
details. details.
......
...@@ -28,7 +28,7 @@ Usage Notes ...@@ -28,7 +28,7 @@ Usage Notes
----------- -----------
This driver does not auto-detect devices. You will have to instantiate the This driver does not auto-detect devices. You will have to instantiate the
devices explicitly. Please see Documentation/i2c/instantiating-devices for devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
details. details.
......
...@@ -79,7 +79,7 @@ Usage Notes ...@@ -79,7 +79,7 @@ Usage Notes
This driver does not probe for devices, since there is no register which This driver does not probe for devices, since there is no register which
can be safely used to identify the chip. You will have to instantiate can be safely used to identify the chip. You will have to instantiate
the devices explicitly. Please see Documentation/i2c/instantiating-devices for the devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
details. details.
WARNING: Do not access chip registers using the i2cdump command, and do not use WARNING: Do not access chip registers using the i2cdump command, and do not use
......
...@@ -30,7 +30,7 @@ Usage Notes ...@@ -30,7 +30,7 @@ Usage Notes
----------- -----------
This driver does not auto-detect devices. You will have to instantiate the This driver does not auto-detect devices. You will have to instantiate the
devices explicitly. Please see Documentation/i2c/instantiating-devices for devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
details. details.
......
...@@ -83,7 +83,7 @@ Usage Notes ...@@ -83,7 +83,7 @@ Usage Notes
----------- -----------
This driver does not auto-detect devices. You will have to instantiate the This driver does not auto-detect devices. You will have to instantiate the
devices explicitly. Please see Documentation/i2c/instantiating-devices for devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
details. details.
For MAX34446, the value of the currX_crit attribute determines if current or For MAX34446, the value of the currX_crit attribute determines if current or
......
...@@ -55,7 +55,7 @@ Usage notes ...@@ -55,7 +55,7 @@ Usage notes
----------- -----------
This driver does not auto-detect devices. You will have to instantiate the This driver does not auto-detect devices. You will have to instantiate the
devices explicitly. Please see Documentation/i2c/instantiating-devices for devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
details. details.
Module parameters Module parameters
......
...@@ -28,7 +28,7 @@ Usage Notes ...@@ -28,7 +28,7 @@ Usage Notes
----------- -----------
This driver does not auto-detect devices. You will have to instantiate the This driver does not auto-detect devices. You will have to instantiate the
devices explicitly. Please see Documentation/i2c/instantiating-devices for devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
details. details.
......
...@@ -28,7 +28,7 @@ Usage Notes ...@@ -28,7 +28,7 @@ Usage Notes
This driver is part of the MFD driver named "menf21bmc" and does This driver is part of the MFD driver named "menf21bmc" and does
not auto-detect devices. not auto-detect devices.
You will have to instantiate the MFD driver explicitly. You will have to instantiate the MFD driver explicitly.
Please see Documentation/i2c/instantiating-devices for Please see Documentation/i2c/instantiating-devices.rst for
details. details.
Sysfs entries Sysfs entries
......
...@@ -68,7 +68,7 @@ Accessing PCF8591 via /sys interface ...@@ -68,7 +68,7 @@ Accessing PCF8591 via /sys interface
The PCF8591 is plainly impossible to detect! Thus the driver won't even The PCF8591 is plainly impossible to detect! Thus the driver won't even
try. You have to explicitly instantiate the device at the relevant try. You have to explicitly instantiate the device at the relevant
address (in the interval [0x48..0x4f]) either through platform data, or address (in the interval [0x48..0x4f]) either through platform data, or
using the sysfs interface. See Documentation/i2c/instantiating-devices using the sysfs interface. See Documentation/i2c/instantiating-devices.rst
for details. for details.
Directories are being created for each instantiated PCF8591: Directories are being created for each instantiated PCF8591:
......
...@@ -26,7 +26,7 @@ scaled by 1000, i.e. the value for 31.5 degrees celsius is 31500. ...@@ -26,7 +26,7 @@ scaled by 1000, i.e. the value for 31.5 degrees celsius is 31500.
The device communicates with the I2C protocol. Sensors can have the I2C The device communicates with the I2C protocol. Sensors can have the I2C
addresses 0x44 or 0x45, depending on the wiring. See addresses 0x44 or 0x45, depending on the wiring. See
Documentation/i2c/instantiating-devices for methods to instantiate the device. Documentation/i2c/instantiating-devices.rst for methods to instantiate the device.
There are two options configurable by means of sht3x_platform_data: There are two options configurable by means of sht3x_platform_data:
......
...@@ -36,7 +36,7 @@ humidity is expressed as a percentage. Driver can be used as well for SHTW1 ...@@ -36,7 +36,7 @@ humidity is expressed as a percentage. Driver can be used as well for SHTW1
chip, which has the same electrical interface. chip, which has the same electrical interface.
The device communicates with the I2C protocol. All sensors are set to I2C The device communicates with the I2C protocol. All sensors are set to I2C
address 0x70. See Documentation/i2c/instantiating-devices for methods to address 0x70. See Documentation/i2c/instantiating-devices.rst for methods to
instantiate the device. instantiate the device.
There are two options configurable by means of shtc1_platform_data: There are two options configurable by means of shtc1_platform_data:
......
...@@ -30,4 +30,4 @@ The driver provides the common sysfs-interface for temperatures (see ...@@ -30,4 +30,4 @@ The driver provides the common sysfs-interface for temperatures (see
Documentation/hwmon/sysfs-interface.rst under Temperatures). Documentation/hwmon/sysfs-interface.rst under Temperatures).
Please refer how to instantiate this driver: Please refer how to instantiate this driver:
Documentation/i2c/instantiating-devices Documentation/i2c/instantiating-devices.rst
...@@ -28,7 +28,7 @@ Usage Notes ...@@ -28,7 +28,7 @@ Usage Notes
----------- -----------
This driver does not auto-detect devices. You will have to instantiate the This driver does not auto-detect devices. You will have to instantiate the
devices explicitly. Please see Documentation/i2c/instantiating-devices for devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
details. details.
......
...@@ -64,7 +64,7 @@ Usage Notes ...@@ -64,7 +64,7 @@ Usage Notes
----------- -----------
This driver does not auto-detect devices. You will have to instantiate the This driver does not auto-detect devices. You will have to instantiate the
devices explicitly. Please see Documentation/i2c/instantiating-devices for devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
details. details.
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment