Commit 9b5db89e authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Greg Kroah-Hartman
Browse files

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: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Link: https://lore.kernel.org/r/b7dc829809673bd8cffe0e7bbe9c9308681c6fe2.1561756511.git.mchehab+samsung@kernel.org


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 69416739

Documentation/misc-devices/eeprom→Documentation/misc-devices/eeprom.rst

+27 −16
Original line number Diff line number Diff line 
====================

Kernel driver eeprom

====================



Supported chips:



  * Any EEPROM chip in the designated address range



    Prefix: 'eeprom'



    Addresses scanned: I2C 0x50 - 0x57



    Datasheets: Publicly available from:



                Atmel (www.atmel.com),

                Catalyst (www.catsemi.com),

                Fairchild (www.fairchildsemi.com),
@@ -16,7 +22,9 @@ Supported chips: 
                Xicor (www.xicor.com),

                and others.



        ========= ============= ============================================

        Chip      Size (bits)   Address

        ========= ============= ============================================

        24C01     1K            0x50 (shadows at 0x51 - 0x57)

        24C01A    1K            0x50 - 0x57 (Typical device on DIMMs)

        24C02     2K            0x50 - 0x57
@@ -33,14 +41,15 @@ Supported chips: 
        Fairchild 34W02   2K    0x50 - 0x57, SW write protect at 0x30-37

        Microchip 24AA52  2K    0x50 - 0x57, SW write protect at 0x30-37

        ST        M34C02  2K    0x50 - 0x57, SW write protect at 0x30-37

        ========= ============= ============================================





Authors:

        Frodo Looijaard <frodol@dds.nl>,

        Philip Edelbrock <phil@netroedge.com>,

        Jean Delvare <jdelvare@suse.de>,

        Greg Kroah-Hartman <greg@kroah.com>,

        IBM Corp.

        - Frodo Looijaard <frodol@dds.nl>,

        - Philip Edelbrock <phil@netroedge.com>,

        - Jean Delvare <jdelvare@suse.de>,

        - Greg Kroah-Hartman <greg@kroah.com>,

        - IBM Corp.



Description

-----------
@@ -74,7 +83,8 @@ this address will write protect the memory array permanently, and the 
device will no longer respond at the 0x30-37 address. The eeprom driver

does not support this register.



Lacking functionality:

Lacking functionality

---------------------



* Full support for larger devices (24C04, 24C08, 24C16). These are not

  typically found on a PC. These devices will appear as separate devices at
@@ -88,9 +98,10 @@ to change the contents of the EEPROMs (on DIMMs anyway) also makes it easy 
  to disable the DIMMs (potentially preventing the computer from booting)

  until the values are restored somehow.



Use:

Use

---



After inserting the module (and any other required SMBus/i2c modules), you

should have some EEPROM directories in /sys/bus/i2c/devices/* of names such

should have some EEPROM directories in ``/sys/bus/i2c/devices/*`` of names such

as "0-0050". Inside each of these is a series of files, the eeprom file

contains the binary data from EEPROM.

Documentation/misc-devices/ics932s401→Documentation/misc-devices/ics932s401.rst

+6 −1
Original line number Diff line number Diff line 
========================

Kernel driver ics932s401

======================

========================



Supported chips:



  * IDT ICS932S401



    Prefix: 'ics932s401'



    Addresses scanned: I2C 0x69



    Datasheet: Publicly available at the IDT website



Author: Darrick J. Wong

Documentation/misc-devices/index.rst

+5 −0
Original line number Diff line number Diff line
@@ -14,4 +14,9 @@ fit into other categories. 
.. toctree::

   :maxdepth: 2



   eeprom

   ibmvmc

   ics932s401

   isl29003

   lis3lv02d

   max6875

Documentation/misc-devices/isl29003→Documentation/misc-devices/isl29003.rst

+14 −1
Original line number Diff line number Diff line 
======================

Kernel driver isl29003

=====================

======================



Supported chips:



* Intersil ISL29003



Prefix: 'isl29003'



Addresses scanned: none



Datasheet:

http://www.intersil.com/data/fn/fn7464.pdf
@@ -37,25 +42,33 @@ Sysfs entries 
-------------



range:

        == ===========================

	0: 0 lux to 1000 lux (default)

	1: 0 lux to 4000 lux

	2: 0 lux to 16,000 lux

	3: 0 lux to 64,000 lux

        == ===========================



resolution:

        == =====================

	0: 2^16 cycles (default)

	1: 2^12 cycles

	2: 2^8 cycles

	3: 2^4 cycles

        == =====================



mode:

        == =================================================

	0: diode1's current (unsigned 16bit) (default)

	1: diode1's current (unsigned 16bit)

	2: difference between diodes (l1 - l2, signed 15bit)

        == =================================================



power_state:

        == =================================================

	0: device is disabled (default)

	1: device is enabled

        == =================================================



lux (read only):

	returns the value from the last sensor reading

Documentation/misc-devices/lis3lv02d→Documentation/misc-devices/lis3lv02d.rst

+13 −7
Original line number Diff line number Diff line 
=======================

Kernel driver lis3lv02d

=======================
@@ -8,8 +9,8 @@ Supported chips: 
    LIS331DLH (16 bits)



Authors:

        Yan Burman <burman.yan@gmail.com>

	Eric Piel <eric.piel@tremplin-utc.net>

        - Yan Burman <burman.yan@gmail.com>

	- Eric Piel <eric.piel@tremplin-utc.net>





Description
@@ -25,11 +26,15 @@ neverball). The accelerometer data is readable via 
to mg values (1/1000th of earth gravity).



Sysfs attributes under /sys/devices/platform/lis3lv02d/:

position - 3D position that the accelerometer reports. Format: "(x,y,z)"

rate - read reports the sampling rate of the accelerometer device in HZ.



position

      - 3D position that the accelerometer reports. Format: "(x,y,z)"

rate

      - read reports the sampling rate of the accelerometer device in HZ.

	write changes sampling rate of the accelerometer device.

	Only values which are supported by HW are accepted.

selftest - performs selftest for the chip as specified by chip manufacturer.

selftest

      - performs selftest for the chip as specified by chip manufacturer.



This driver also provides an absolute input class device, allowing

the laptop to act as a pinball machine-esque joystick. Joystick device can be
@@ -69,6 +74,7 @@ Axes orientation 
For better compatibility between the various laptops. The values reported by

the accelerometer are converted into a "standard" organisation of the axes

(aka "can play neverball out of the box"):



 * When the laptop is horizontal the position reported is about 0 for X and Y

   and a positive value for Z

 * If the left side is elevated, X increases (becomes positive)

CRA Git | Maintained and supported by SUSTech CRA and CCSE