xref: /freebsd/sys/contrib/device-tree/Bindings/input/ti,drv260x.txt (revision 2b8331622f0b212cf3bb4fc4914a501e5321d506)
1* Texas Instruments - drv260x Haptics driver family
2
3Required properties:
4	- compatible - One of:
5		"ti,drv2604" - DRV2604
6		"ti,drv2605" - DRV2605
7		"ti,drv2605l" - DRV2605L
8	- reg -  I2C slave address
9	- vbat-supply - Required supply regulator
10	- mode - Power up mode of the chip (defined in include/dt-bindings/input/ti-drv260x.h)
11		DRV260X_LRA_MODE - Linear Resonance Actuator mode (Piezoelectric)
12		DRV260X_LRA_NO_CAL_MODE - This is a LRA Mode but there is no calibration
13				sequence during init.  And the device is configured for real
14				time playback mode (RTP mode).
15		DRV260X_ERM_MODE - Eccentric Rotating Mass mode (Rotary vibrator)
16	- library-sel - These are ROM based waveforms pre-programmed into the IC.
17				This should be set to set the library to use at power up.
18				(defined in include/dt-bindings/input/ti-drv260x.h)
19		DRV260X_LIB_EMPTY - Do not use a pre-programmed library
20		DRV260X_ERM_LIB_A - Pre-programmed Library
21		DRV260X_ERM_LIB_B - Pre-programmed Library
22		DRV260X_ERM_LIB_C - Pre-programmed Library
23		DRV260X_ERM_LIB_D - Pre-programmed Library
24		DRV260X_ERM_LIB_E - Pre-programmed Library
25		DRV260X_ERM_LIB_F - Pre-programmed Library
26		DRV260X_LIB_LRA - Pre-programmed LRA Library
27
28Optional properties:
29	- enable-gpio - gpio pin to enable/disable the device.
30	- vib-rated-mv - The rated voltage of the actuator in millivolts.
31			  If this is not set then the value will be defaulted to
32			  3.2 v.
33	- vib-overdrive-mv - The overdrive voltage of the actuator in millivolts.
34			  If this is not set then the value will be defaulted to
35			  3.2 v.
36Example:
37
38haptics: haptics@5a {
39	compatible = "ti,drv2605l";
40	reg = <0x5a>;
41	vbat-supply = <&vbat>;
42	enable-gpio = <&gpio1 28 GPIO_ACTIVE_HIGH>;
43	mode = <DRV260X_LRA_MODE>;
44	library-sel = <DRV260X_LIB_LRA>;
45	vib-rated-mv = <3200>;
46	vib-overdrive-mv = <3200>;
47}
48
49For more product information please see the link below:
50http://www.ti.com/product/drv2605
51