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

Node specific 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.

Deprecated node specific properties

Deprecated properties not inherited from the base binding file.

(None)

Base properties

Properties inherited from the base binding file, which defines common properties that may be set on many nodes. Not all of these may apply to the “ams,tmd2620” compatible.

Name

Type

Details

status

string

 
indicates the operational status of a device

Legal values: 'ok', 'okay', 'disabled', 'reserved', 'fail', 'fail-sss'

See Important properties for more information.

compatible

string-array

 
compatible strings

This property is required.

See Important properties for more information.

reg

array

 
register space

This property is required.

See Important properties for more information.

reg-names

string-array

 
name of each register space

interrupts

array

 
interrupts for device

See Important properties for more information.

interrupts-extended

compound

 
extended interrupt specifier for device

interrupt-names

string-array

 
name of each interrupt

interrupt-parent

phandle

 
phandle to interrupt controller node

label

string

 
Human readable string describing the device (used as device_get_binding() argument)

See Important properties for more information.

This property is deprecated.

clocks

phandle-array

 
Clock gate information

clock-names

string-array

 
name of each clock

#address-cells

int

 
number of address cells in reg property

#size-cells

int

 
number of size cells in reg property

dmas

phandle-array

 
DMA channels specifiers

dma-names

string-array

 
Provided names of DMA channel specifiers

io-channels

phandle-array

 
IO channels specifiers

io-channel-names

string-array

 
Provided names of IO channel specifiers

mboxes

phandle-array

 
mailbox / IPM channels specifiers

mbox-names

string-array

 
Provided names of mailbox / IPM channel specifiers

power-domains

phandle-array

 
Power domain specifiers

power-domain-names

string-array

 
Provided names of power domain specifiers

#power-domain-cells

int

 
Number of cells in power-domains property

zephyr,deferred-init

boolean

 
Do not initialize device automatically on boot. Device should be manually
initialized using device_init().

wakeup-source

boolean

 
Property to identify that a device can be used as wake up source.

When this property is provided a specific flag is set into the
device that tells the system that the device is capable of
wake up the system.

Wake up capable devices are disabled (interruptions will not wake up
the system) by default but they can be enabled at runtime if necessary.

zephyr,pm-device-runtime-auto

boolean

 
Automatically configure the device for runtime power management after the
init function runs.

zephyr,disabling-power-states

phandles

 
List of power states that will disable this device power.