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

Documentation/devicetree/bindings/i2c/i2c-mux-gpmux.txt

+1 −1
Original line number Diff line number Diff line
@@ -42,7 +42,7 @@ Optional properties: 
  This means that no unrelated I2C transactions are allowed on the parent I2C

  adapter for the complete multiplexed I2C transaction.

  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

be numbered based on their order in the device tree.

Documentation/driver-api/ipmb.rst

+1 −1
Original line number Diff line number Diff line
@@ -83,7 +83,7 @@ Instantiate the device 
----------------------



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

a different I2C bus, you can instantiate a device for each of

those BMCs.

Documentation/hwmon/adm1021.rst

+1 −1
Original line number Diff line number Diff line
@@ -142,7 +142,7 @@ loading the adm1021 module, then things are good. 
If nothing happens when loading the adm1021 module, and you are certain

that your specific Xeon processor model includes compatible sensors, you

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

only temp2 will be correct and temp1 will have to be ignored.

Documentation/hwmon/adm1275.rst

+1 −1
Original line number Diff line number Diff line
@@ -75,7 +75,7 @@ Usage Notes 
-----------



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.



The ADM1075, unlike many other PMBus devices, does not support internal voltage

Documentation/hwmon/hih6130.rst

+1 −1
Original line number Diff line number Diff line
@@ -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)

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.



sysfs-Interface

CRA Git | Maintained and supported by SUSTech CRA and CCSE