Commit 0e7ade47 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

docs: misc-devices/bh1770glc.txt: convert to ReST 



- Adjust document title markup;
- use list markups;
- Adjust identations to display properly at ReST output.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/58ba712524318d03b3196bba33cb409472b4807d.1592203650.git.mchehab+huawei@kernel.org


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 433b1b0d

Documentation/misc-devices/bh1770glc.txt→Documentation/misc-devices/bh1770glc.rst

+32 −13
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



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

Kernel driver bh1770glc

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



Supported chips:

ROHM BH1770GLC

OSRAM SFH7770



- ROHM BH1770GLC

- OSRAM SFH7770



Data sheet:

Not freely available
@@ -48,12 +52,16 @@ chip_id 
	RO - shows detected chip type and version



power_state

	RW - enable / disable chip. Uses counting logic

	     1 enables the chip

	     0 disables the chip

	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
@@ -66,16 +74,22 @@ lux0_rate_avail 
	RO - supported measurement rates



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.



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.
@@ -84,15 +98,19 @@ lux0_calibscale_default 


prox0_raw

	RO - measured proximity value



	     sysfs_notify called when threshold interrupt occurs



prox0_sensor_range

	RO - prox0_raw max value



prox0_raw_en

	RW - enable / disable proximity - uses counting logic

	     1 enables the proximity

	     0 disables the proximity

	RW - enable / disable proximity



	     Uses counting logic



	     - 1 enables the proximity

	     - 0 disables the proximity



prox0_thresh_above_count

	RW - number of proximity interrupts needed before triggering the event
@@ -110,6 +128,7 @@ prox0_rate_avail 


prox0_thresh_above0_value

	RW - threshold level which trigs proximity events.



	     Filtered by persistence filter (prox0_thresh_above_count)



prox0_thresh_above1_value

Documentation/misc-devices/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -15,6 +15,7 @@ fit into other categories. 
   :maxdepth: 2



   ad525x_dpot

   bh1770glc

   eeprom

   c2port

   ibmvmc

CRA Git | Maintained and supported by SUSTech CRA and CCSE