From: Mauro Carvalho Chehab Date: Mon, 15 Jun 2020 06:50:13 +0000 (+0200) Subject: docs: misc-devices/pci-endpoint-test.txt: convert to ReST X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=8a05eb89cb84eba1091bdc6baa9d0e463655779f;p=linux.git docs: misc-devices/pci-endpoint-test.txt: convert to ReST - use title markups; - mark literal blocks. Signed-off-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/1b1f4e5e57fd2065828cecc9d07afbd247349e94.1592203650.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet --- diff --git a/Documentation/misc-devices/ad525x_dpot.rst b/Documentation/misc-devices/ad525x_dpot.rst new file mode 100644 index 0000000000000..6483ec2545207 --- /dev/null +++ b/Documentation/misc-devices/ad525x_dpot.rst @@ -0,0 +1,57 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============================= +AD525x Digital Potentiometers +============================= + +The ad525x_dpot driver exports a simple sysfs interface. This allows you to +work with the immediate resistance settings as well as update the saved startup +settings. Access to the factory programmed tolerance is also provided, but +interpretation of this settings is required by the end application according to +the specific part in use. + +Files +===== + +Each dpot device will have a set of eeprom, rdac, and tolerance files. How +many depends on the actual part you have, as will the range of allowed values. + +The eeprom files are used to program the startup value of the device. + +The rdac files are used to program the immediate value of the device. + +The tolerance files are the read-only factory programmed tolerance settings +and may vary greatly on a part-by-part basis. For exact interpretation of +this field, please consult the datasheet for your part. This is presented +as a hex file for easier parsing. + +Example +======= + +Locate the device in your sysfs tree. This is probably easiest by going into +the common i2c directory and locating the device by the i2c slave address:: + + # ls /sys/bus/i2c/devices/ + 0-0022 0-0027 0-002f + +So assuming the device in question is on the first i2c bus and has the slave +address of 0x2f, we descend (unrelated sysfs entries have been trimmed):: + + # ls /sys/bus/i2c/devices/0-002f/ + eeprom0 rdac0 tolerance0 + +You can use simple reads/writes to access these files:: + + # cd /sys/bus/i2c/devices/0-002f/ + + # cat eeprom0 + 0 + # echo 10 > eeprom0 + # cat eeprom0 + 10 + + # cat rdac0 + 5 + # echo 3 > rdac0 + # cat rdac0 + 3 diff --git a/Documentation/misc-devices/ad525x_dpot.txt b/Documentation/misc-devices/ad525x_dpot.txt deleted file mode 100644 index 0c9413b1cbf30..0000000000000 --- a/Documentation/misc-devices/ad525x_dpot.txt +++ /dev/null @@ -1,57 +0,0 @@ ---------------------------------- - AD525x Digital Potentiometers ---------------------------------- - -The ad525x_dpot driver exports a simple sysfs interface. This allows you to -work with the immediate resistance settings as well as update the saved startup -settings. Access to the factory programmed tolerance is also provided, but -interpretation of this settings is required by the end application according to -the specific part in use. - ---------- - Files ---------- - -Each dpot device will have a set of eeprom, rdac, and tolerance files. How -many depends on the actual part you have, as will the range of allowed values. - -The eeprom files are used to program the startup value of the device. - -The rdac files are used to program the immediate value of the device. - -The tolerance files are the read-only factory programmed tolerance settings -and may vary greatly on a part-by-part basis. For exact interpretation of -this field, please consult the datasheet for your part. This is presented -as a hex file for easier parsing. - ------------ - Example ------------ - -Locate the device in your sysfs tree. This is probably easiest by going into -the common i2c directory and locating the device by the i2c slave address. - - # ls /sys/bus/i2c/devices/ - 0-0022 0-0027 0-002f - -So assuming the device in question is on the first i2c bus and has the slave -address of 0x2f, we descend (unrelated sysfs entries have been trimmed). - - # ls /sys/bus/i2c/devices/0-002f/ - eeprom0 rdac0 tolerance0 - -You can use simple reads/writes to access these files: - - # cd /sys/bus/i2c/devices/0-002f/ - - # cat eeprom0 - 0 - # echo 10 > eeprom0 - # cat eeprom0 - 10 - - # cat rdac0 - 5 - # echo 3 > rdac0 - # cat rdac0 - 3 diff --git a/Documentation/misc-devices/index.rst b/Documentation/misc-devices/index.rst index 56fc1e03488a9..d05626dd0fbb4 100644 --- a/Documentation/misc-devices/index.rst +++ b/Documentation/misc-devices/index.rst @@ -14,6 +14,7 @@ fit into other categories. .. toctree:: :maxdepth: 2 + ad525x_dpot eeprom ibmvmc ics932s401 diff --git a/drivers/misc/Kconfig b/drivers/misc/Kconfig index e1b1ba5e2b925..3ca4325cc191e 100644 --- a/drivers/misc/Kconfig +++ b/drivers/misc/Kconfig @@ -24,7 +24,7 @@ config AD525X_DPOT AD5271, AD5272, AD5274 digital potentiometer chips. - See Documentation/misc-devices/ad525x_dpot.txt for the + See Documentation/misc-devices/ad525x_dpot.rst for the userspace interface. This driver can also be built as a module. If so, the module diff --git a/drivers/misc/ad525x_dpot.c b/drivers/misc/ad525x_dpot.c index ccce3226a5712..6f164522b0282 100644 --- a/drivers/misc/ad525x_dpot.c +++ b/drivers/misc/ad525x_dpot.c @@ -58,7 +58,7 @@ * AD5272 1 1024 20, 50, 100 (50-TP) * AD5274 1 256 20, 50, 100 (50-TP) * - * See Documentation/misc-devices/ad525x_dpot.txt for more info. + * See Documentation/misc-devices/ad525x_dpot.rst for more info. * * derived from ad5258.c * Copyright (c) 2009 Cyber Switching, Inc.