The latest development version of this page may be more current than this released 4.0.0 version.

ams,tmd2620 (on i2c bus)

Vendor: AMS AG

Note

An implementation of a driver matching this compatible is available in drivers/sensor/ams/tmd2620/tmd2620.c.

Description

OSRAM ams TMD2620 Proximity Sensor

Properties

Properties not inherited from the base binding file.

Name

Type

Details

int-gpios

phandle-array

 
The interrupt pin of TMD2620 is open-drain, active low.
If connected directly the MCU, the pin should be configured
as pull-up, active low.

This property is required.

proximity-gain

int

 
Proximity detection gain of the sensor

This property is required.

Legal values: 1, 2, 4, 8

proximity-pulse-length

int

 
IR led pulse length in ms

This property is required.

Legal values: 4, 8, 16, 32

proximity-pulse-count

int

 
count of IR led pulses (min. 1; max. 64)

This property is required.

proximity-high-threshold

int

 
high threshold for interrupt. (min. 0; max. 255)

proximity-low-threshold

int

 
low threshold for interrupt. (min. 0; max. 255)

proximity-led-drive-strength

int

 
LED drive strength in multiples of 6mA (min. 0; max. 31)

This property is required.

proximity-interrupt-filter

int

 
filters proximity interrupt. (min. 0; max. 15)

0-> every cycle fires an interrupt
1-> 1 consecutive proximity value out of threshold range fires an interrupt
2-> 2 consecutive proximity values out of threshold range fires an interrupt
...

enable-wait-mode

boolean

 
Enables wait mode

wait-time-factor

int

 
time the sensor waits between proximity cycles. (min. 0; max 255).
given in multiples of 2.81 starting at 0 for 2.81ms wait time.

wait-long

boolean

 
increases the wait time by a factor of x12

friendly-name

string

 
Human readable string describing the sensor. It can be used to
distinguish multiple instances of the same model (e.g., lid accelerometer
vs. base accelerometer in a laptop) to a host operating system.

This property is defined in the Generic Sensor Property Usages of the HID
Usage Tables specification
(https://usb.org/sites/default/files/hut1_3_0.pdf, section 22.5).

supply-gpios

phandle-array

 
GPIO specifier that controls power to the device.

This property should be provided when the device has a dedicated
switch that controls power to the device.  The supply state is
entirely the responsibility of the device driver.

Contrast with vin-supply.

vin-supply

phandle

 
Reference to the regulator that controls power to the device.
The referenced devicetree node must have a regulator compatible.

This property should be provided when device power is supplied
by a shared regulator.  The supply state is dependent on the
request status of all devices fed by the regulator.

Contrast with supply-gpios.  If both properties are provided
then the regulator must be requested before the supply GPIOS is
set to an active state, and the supply GPIOS must be set to an
inactive state before releasing the regulator.