Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: misc-devices: convert files without extension to ReST

Those files are also text files. Convert them to ReST and add
to the misc-files index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Link: https://lore.kernel.org/r/b7dc829809673bd8cffe0e7bbe9c9308681c6fe2.1561756511.git.mchehab+samsung@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Mauro Carvalho Chehab and committed by
Greg Kroah-Hartman
9b5db89e 69416739

+108 -42
+27 -16
Documentation/misc-devices/eeprom Documentation/misc-devices/eeprom.rst
··· 1 + ==================== 1 2 Kernel driver eeprom 2 3 ==================== 3 4 4 5 Supported chips: 6 + 5 7 * Any EEPROM chip in the designated address range 8 + 6 9 Prefix: 'eeprom' 10 + 7 11 Addresses scanned: I2C 0x50 - 0x57 12 + 8 13 Datasheets: Publicly available from: 14 + 9 15 Atmel (www.atmel.com), 10 16 Catalyst (www.catsemi.com), 11 17 Fairchild (www.fairchildsemi.com), ··· 22 16 Xicor (www.xicor.com), 23 17 and others. 24 18 25 - Chip Size (bits) Address 19 + ========= ============= ============================================ 20 + Chip Size (bits) Address 21 + ========= ============= ============================================ 26 22 24C01 1K 0x50 (shadows at 0x51 - 0x57) 27 23 24C01A 1K 0x50 - 0x57 (Typical device on DIMMs) 28 24 24C02 2K 0x50 - 0x57 ··· 32 24 (additional data at 0x51, 0x53, 0x55, 0x57) 33 25 24C08 8K 0x50, 0x54 (additional data at 0x51, 0x52, 34 26 0x53, 0x55, 0x56, 0x57) 35 - 24C16 16K 0x50 (additional data at 0x51 - 0x57) 27 + 24C16 16K 0x50 (additional data at 0x51 - 0x57) 36 28 Sony 2K 0x57 37 29 38 30 Atmel 34C02B 2K 0x50 - 0x57, SW write protect at 0x30-37 ··· 41 33 Fairchild 34W02 2K 0x50 - 0x57, SW write protect at 0x30-37 42 34 Microchip 24AA52 2K 0x50 - 0x57, SW write protect at 0x30-37 43 35 ST M34C02 2K 0x50 - 0x57, SW write protect at 0x30-37 36 + ========= ============= ============================================ 44 37 45 38 46 39 Authors: 47 - Frodo Looijaard <frodol@dds.nl>, 48 - Philip Edelbrock <phil@netroedge.com>, 49 - Jean Delvare <jdelvare@suse.de>, 50 - Greg Kroah-Hartman <greg@kroah.com>, 51 - IBM Corp. 40 + - Frodo Looijaard <frodol@dds.nl>, 41 + - Philip Edelbrock <phil@netroedge.com>, 42 + - Jean Delvare <jdelvare@suse.de>, 43 + - Greg Kroah-Hartman <greg@kroah.com>, 44 + - IBM Corp. 52 45 53 46 Description 54 47 ----------- ··· 83 74 device will no longer respond at the 0x30-37 address. The eeprom driver 84 75 does not support this register. 85 76 86 - Lacking functionality: 77 + Lacking functionality 78 + --------------------- 87 79 88 80 * Full support for larger devices (24C04, 24C08, 24C16). These are not 89 - typically found on a PC. These devices will appear as separate devices at 90 - multiple addresses. 81 + typically found on a PC. These devices will appear as separate devices at 82 + multiple addresses. 91 83 92 84 * Support for really large devices (24C32, 24C64, 24C128, 24C256, 24C512). 93 - These devices require two-byte address fields and are not supported. 85 + These devices require two-byte address fields and are not supported. 94 86 95 87 * Enable Writing. Again, no technical reason why not, but making it easy 96 - to change the contents of the EEPROMs (on DIMMs anyway) also makes it easy 97 - to disable the DIMMs (potentially preventing the computer from booting) 98 - until the values are restored somehow. 88 + to change the contents of the EEPROMs (on DIMMs anyway) also makes it easy 89 + to disable the DIMMs (potentially preventing the computer from booting) 90 + until the values are restored somehow. 99 91 100 - Use: 92 + Use 93 + --- 101 94 102 95 After inserting the module (and any other required SMBus/i2c modules), you 103 - should have some EEPROM directories in /sys/bus/i2c/devices/* of names such 96 + should have some EEPROM directories in ``/sys/bus/i2c/devices/*`` of names such 104 97 as "0-0050". Inside each of these is a series of files, the eeprom file 105 98 contains the binary data from EEPROM.
+6 -1
Documentation/misc-devices/ics932s401 Documentation/misc-devices/ics932s401.rst
··· 1 + ======================== 1 2 Kernel driver ics932s401 2 - ====================== 3 + ======================== 3 4 4 5 Supported chips: 6 + 5 7 * IDT ICS932S401 8 + 6 9 Prefix: 'ics932s401' 10 + 7 11 Addresses scanned: I2C 0x69 12 + 8 13 Datasheet: Publicly available at the IDT website 9 14 10 15 Author: Darrick J. Wong
+5
Documentation/misc-devices/index.rst
··· 14 14 .. toctree:: 15 15 :maxdepth: 2 16 16 17 + eeprom 17 18 ibmvmc 19 + ics932s401 20 + isl29003 21 + lis3lv02d 22 + max6875
+14 -1
Documentation/misc-devices/isl29003 Documentation/misc-devices/isl29003.rst
··· 1 + ====================== 1 2 Kernel driver isl29003 2 - ===================== 3 + ====================== 3 4 4 5 Supported chips: 6 + 5 7 * Intersil ISL29003 8 + 6 9 Prefix: 'isl29003' 10 + 7 11 Addresses scanned: none 12 + 8 13 Datasheet: 9 14 http://www.intersil.com/data/fn/fn7464.pdf 10 15 ··· 42 37 ------------- 43 38 44 39 range: 40 + == =========================== 45 41 0: 0 lux to 1000 lux (default) 46 42 1: 0 lux to 4000 lux 47 43 2: 0 lux to 16,000 lux 48 44 3: 0 lux to 64,000 lux 45 + == =========================== 49 46 50 47 resolution: 48 + == ===================== 51 49 0: 2^16 cycles (default) 52 50 1: 2^12 cycles 53 51 2: 2^8 cycles 54 52 3: 2^4 cycles 53 + == ===================== 55 54 56 55 mode: 56 + == ================================================= 57 57 0: diode1's current (unsigned 16bit) (default) 58 58 1: diode1's current (unsigned 16bit) 59 59 2: difference between diodes (l1 - l2, signed 15bit) 60 + == ================================================= 60 61 61 62 power_state: 63 + == ================================================= 62 64 0: device is disabled (default) 63 65 1: device is enabled 66 + == ================================================= 64 67 65 68 lux (read only): 66 69 returns the value from the last sensor reading
+13 -7
Documentation/misc-devices/lis3lv02d Documentation/misc-devices/lis3lv02d.rst
··· 1 + ======================= 1 2 Kernel driver lis3lv02d 2 3 ======================= 3 4 ··· 9 8 LIS331DLH (16 bits) 10 9 11 10 Authors: 12 - Yan Burman <burman.yan@gmail.com> 13 - Eric Piel <eric.piel@tremplin-utc.net> 11 + - Yan Burman <burman.yan@gmail.com> 12 + - Eric Piel <eric.piel@tremplin-utc.net> 14 13 15 14 16 15 Description ··· 26 25 to mg values (1/1000th of earth gravity). 27 26 28 27 Sysfs attributes under /sys/devices/platform/lis3lv02d/: 29 - position - 3D position that the accelerometer reports. Format: "(x,y,z)" 30 - rate - read reports the sampling rate of the accelerometer device in HZ. 28 + 29 + position 30 + - 3D position that the accelerometer reports. Format: "(x,y,z)" 31 + rate 32 + - read reports the sampling rate of the accelerometer device in HZ. 31 33 write changes sampling rate of the accelerometer device. 32 34 Only values which are supported by HW are accepted. 33 - selftest - performs selftest for the chip as specified by chip manufacturer. 35 + selftest 36 + - performs selftest for the chip as specified by chip manufacturer. 34 37 35 38 This driver also provides an absolute input class device, allowing 36 39 the laptop to act as a pinball machine-esque joystick. Joystick device can be ··· 74 69 For better compatibility between the various laptops. The values reported by 75 70 the accelerometer are converted into a "standard" organisation of the axes 76 71 (aka "can play neverball out of the box"): 72 + 77 73 * When the laptop is horizontal the position reported is about 0 for X and Y 78 - and a positive value for Z 74 + and a positive value for Z 79 75 * If the left side is elevated, X increases (becomes positive) 80 76 * If the front side (where the touchpad is) is elevated, Y decreases 81 - (becomes negative) 77 + (becomes negative) 82 78 * If the laptop is put upside-down, Z becomes negative 83 79 84 80 If your laptop model is not recognized (cf "dmesg"), you can send an
+39 -13
Documentation/misc-devices/max6875 Documentation/misc-devices/max6875.rst
··· 1 + ===================== 1 2 Kernel driver max6875 2 3 ===================== 3 4 4 5 Supported chips: 6 + 5 7 * Maxim MAX6874, MAX6875 8 + 6 9 Prefix: 'max6875' 10 + 7 11 Addresses scanned: None (see below) 8 - Datasheet: 9 - http://pdfserv.maxim-ic.com/en/ds/MAX6874-MAX6875.pdf 12 + 13 + Datasheet: http://pdfserv.maxim-ic.com/en/ds/MAX6874-MAX6875.pdf 10 14 11 15 Author: Ben Gardner <bgardner@wabtec.com> 12 16 ··· 28 24 29 25 The Maxim MAX6874 is a similar, mostly compatible device, with more inputs 30 26 and outputs: 31 - vin gpi vout 27 + 28 + =========== === === ==== 29 + - vin gpi vout 30 + =========== === === ==== 32 31 MAX6874 6 4 8 33 32 MAX6875 4 3 5 33 + =========== === === ==== 34 34 35 35 See the datasheet for more information. 36 36 ··· 49 41 --------------- 50 42 51 43 Valid addresses for the MAX6875 are 0x50 and 0x52. 44 + 52 45 Valid addresses for the MAX6874 are 0x50, 0x52, 0x54 and 0x56. 46 + 53 47 The driver does not probe any address, so you explicitly instantiate the 54 48 devices. 55 49 56 - Example: 57 - $ modprobe max6875 58 - $ echo max6875 0x50 > /sys/bus/i2c/devices/i2c-0/new_device 50 + Example:: 51 + 52 + $ modprobe max6875 53 + $ echo max6875 0x50 > /sys/bus/i2c/devices/i2c-0/new_device 59 54 60 55 The MAX6874/MAX6875 ignores address bit 0, so this driver attaches to multiple 61 56 addresses. For example, for address 0x50, it also reserves 0x51. ··· 69 58 ---------------------------------- 70 59 71 60 Use the i2c-dev interface to access and program the chips. 61 + 72 62 Reads and writes are performed differently depending on the address range. 73 63 74 64 The configuration registers are at addresses 0x00 - 0x45. 65 + 75 66 Use i2c_smbus_write_byte_data() to write a register and 76 67 i2c_smbus_read_byte_data() to read a register. 68 + 77 69 The command is the register number. 78 70 79 71 Examples: 80 - To write a 1 to register 0x45: 72 + 73 + To write a 1 to register 0x45:: 74 + 81 75 i2c_smbus_write_byte_data(fd, 0x45, 1); 82 76 83 - To read register 0x45: 77 + To read register 0x45:: 78 + 84 79 value = i2c_smbus_read_byte_data(fd, 0x45); 85 80 86 81 87 82 The configuration EEPROM is at addresses 0x8000 - 0x8045. 83 + 88 84 The user EEPROM is at addresses 0x8100 - 0x82ff. 89 85 90 86 Use i2c_smbus_write_word_data() to write a byte to EEPROM. 91 87 92 88 The command is the upper byte of the address: 0x80, 0x81, or 0x82. 93 - The data word is the lower part of the address or'd with data << 8. 89 + The data word is the lower part of the address or'd with data << 8:: 90 + 94 91 cmd = address >> 8; 95 92 val = (address & 0xff) | (data << 8); 96 93 97 94 Example: 98 - To write 0x5a to address 0x8003: 95 + 96 + To write 0x5a to address 0x8003:: 97 + 99 98 i2c_smbus_write_word_data(fd, 0x80, 0x5a03); 100 99 101 100 102 101 Reading data from the EEPROM is a little more complicated. 102 + 103 103 Use i2c_smbus_write_byte_data() to set the read address and then 104 104 i2c_smbus_read_byte() or i2c_smbus_read_i2c_block_data() to read the data. 105 105 106 106 Example: 107 - To read data starting at offset 0x8100, first set the address: 107 + 108 + To read data starting at offset 0x8100, first set the address:: 109 + 108 110 i2c_smbus_write_byte_data(fd, 0x81, 0x00); 109 111 110 - And then read the data 112 + And then read the data:: 113 + 111 114 value = i2c_smbus_read_byte(fd); 112 115 113 - or 116 + or:: 114 117 115 118 count = i2c_smbus_read_i2c_block_data(fd, 0x84, 16, buffer); 116 119 117 120 The block read should read 16 bytes. 121 + 118 122 0x84 is the block read command. 119 123 120 124 See the datasheet for more details.
+2 -2
MAINTAINERS
··· 8871 8871 LEGACY EEPROM DRIVER 8872 8872 M: Jean Delvare <jdelvare@suse.com> 8873 8873 S: Maintained 8874 - F: Documentation/misc-devices/eeprom 8874 + F: Documentation/misc-devices/eeprom.rst 8875 8875 F: drivers/misc/eeprom/eeprom.c 8876 8876 8877 8877 LEGO MINDSTORMS EV3 ··· 9157 9157 LIS3LV02D ACCELEROMETER DRIVER 9158 9158 M: Eric Piel <eric.piel@tremplin-utc.net> 9159 9159 S: Maintained 9160 - F: Documentation/misc-devices/lis3lv02d 9160 + F: Documentation/misc-devices/lis3lv02d.rst 9161 9161 F: drivers/misc/lis3lv02d/ 9162 9162 F: drivers/platform/x86/hp_accel.c 9163 9163
+1 -1
drivers/misc/isl29003.c
··· 3 3 * isl29003.c - Linux kernel module for 4 4 * Intersil ISL29003 ambient light sensor 5 5 * 6 - * See file:Documentation/misc-devices/isl29003 6 + * See file:Documentation/misc-devices/isl29003.rst 7 7 * 8 8 * Copyright (c) 2009 Daniel Mack <daniel@caiaq.de> 9 9 *
+1 -1
drivers/platform/x86/Kconfig
··· 341 341 342 342 Support for a led indicating disk protection will be provided as 343 343 hp::hddprotect. For more information on the feature, refer to 344 - Documentation/misc-devices/lis3lv02d. 344 + Documentation/misc-devices/lis3lv02d.rst. 345 345 346 346 To compile this driver as a module, choose M here: the module will 347 347 be called hp_accel.