lkml.org 
[lkml]   [2020]   [Apr]   [30]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH v4 11/19] docs: misc-devices/apds990x.txt: convert to ReST format
    Date
    - Adjust title markup;
    - Adjust identation.

    Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
    ---
    .../{apds990x.txt => apds990x.rst} | 31 ++++++++++++++-----
    Documentation/misc-devices/index.rst | 1 +
    2 files changed, 25 insertions(+), 7 deletions(-)
    rename Documentation/misc-devices/{apds990x.txt => apds990x.rst} (86%)

    diff --git a/Documentation/misc-devices/apds990x.txt b/Documentation/misc-devices/apds990x.rst
    similarity index 86%
    rename from Documentation/misc-devices/apds990x.txt
    rename to Documentation/misc-devices/apds990x.rst
    index 454d95d623b3..e2f75577f731 100644
    --- a/Documentation/misc-devices/apds990x.txt
    +++ b/Documentation/misc-devices/apds990x.rst
    @@ -1,3 +1,6 @@
    +.. SPDX-License-Identifier: GPL-2.0
    +
    +======================
    Kernel driver apds990x
    ======================

    @@ -50,14 +53,18 @@ chip_id

    power_state
    RW - enable / disable chip. Uses counting logic
    +
    1 enables the chip
    0 disables the chip
    lux0_input
    RO - measured lux value
    +
    sysfs_notify called when threshold interrupt occurs

    lux0_sensor_range
    - RO - lux0_input max value. Actually never reaches since sensor tends
    + RO - lux0_input max value.
    +
    + Actually never reaches since sensor tends
    to saturate much before that. Real max value varies depending
    on the light spectrum etc.

    @@ -68,7 +75,9 @@ lux0_rate_avail
    RO - supported measurement rates

    lux0_calibscale
    - RW - calibration value. Set to neutral value by default.
    + RW - calibration value.
    +
    + Set to neutral value by default.
    Output results are multiplied with calibscale / calibscale_default
    value.

    @@ -76,16 +85,21 @@ lux0_calibscale_default
    RO - neutral calibration value

    lux0_thresh_above_value
    - RW - HI level threshold value. All results above the value
    + RW - HI level threshold value.
    +
    + All results above the value
    trigs an interrupt. 65535 (i.e. sensor_range) disables the above
    interrupt.

    lux0_thresh_below_value
    - RW - LO level threshold value. All results below the value
    + RW - LO level threshold value.
    +
    + All results below the value
    trigs an interrupt. 0 disables the below interrupt.

    prox0_raw
    RO - measured proximity value
    +
    sysfs_notify called when threshold interrupt occurs

    prox0_sensor_range
    @@ -93,11 +107,14 @@ prox0_sensor_range

    prox0_raw_en
    RW - enable / disable proximity - uses counting logic
    - 1 enables the proximity
    - 0 disables the proximity
    +
    + - 1 enables the proximity
    + - 0 disables the proximity

    prox0_reporting_mode
    - RW - trigger / periodic. In "trigger" mode the driver tells two possible
    + RW - trigger / periodic.
    +
    + In "trigger" mode the driver tells two possible
    values: 0 or prox0_sensor_range value. 0 means no proximity,
    1023 means proximity. This causes minimal number of interrupts.
    In "periodic" mode the driver reports all values above
    diff --git a/Documentation/misc-devices/index.rst b/Documentation/misc-devices/index.rst
    index d28e755a1595..a31c2ab8151f 100644
    --- a/Documentation/misc-devices/index.rst
    +++ b/Documentation/misc-devices/index.rst
    @@ -15,6 +15,7 @@ fit into other categories.
    :maxdepth: 2

    ad525x_dpot
    + apds990x
    bh1770glc
    eeprom
    c2port
    --
    2.25.4
    \
     
     \ /
      Last update: 2020-04-30 18:20    [W:4.645 / U:0.512 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site