Skip to contentSkip to conversation

dt: lm3532: Add lm3532 dt doc and update ti_lmu doc

PATCH Superseded Dan Murphy 2 participants 6 messages Mar 12, 2019

Subsystems (3)

v3 of 4 Superseded Latest is v4 →

lore
Share & tools
lore

Dan Murphy

author
#0 lore raw

PATCH v3 1/4 dt: lm3532: Add lm3532 dt doc and update ti_lmu doc

Add the lm3532 device tree documentation.
Remove lm3532 device tree reference from the ti_lmu devicetree documentation.

With the addition of the dedicated lm3532 documentation the device can be removed from the ti_lmu.txt.

The reason for this is that the lm3532 dt documentation now defines the ability to control LED output strings against different control banks or groups multiple strings to be controlled by a single control bank.

Another addition was for ALS lighting control and configuration. The LM3532 has a feature that can take in the ALS reading from 2 separate ALS devices and adjust the brightness on the strings that are configured to support this feature.

Finally the device specific properties were moved to the parent node as these properties are not control bank configurable. These include the runtime ramp and the ALS configuration.

---

v3 - No changes - https://lore.kernel.org/patchwork/patch/1049026/

v2 - Fixed ramp-up and ramp-down properties, removed hard coded property values,
added ranges for variable properties, I did not change the label - https://lore.kernel.org/patchwork/patch/1048805/

 .../devicetree/bindings/leds/leds-lm3532.txt  | 127 ++++++++++++++++++
 .../devicetree/bindings/mfd/ti-lmu.txt        |  20 ---
 2 files changed, 127 insertions(+), 20 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/leds/leds-lm3532.txt
Documentation/devicetree/bindings/leds/leds-lm3532.txt new file +127 -0
new file mode 100644
index 000000000000..b267d696b511
@@ -0,0 +1,127 @@
+* Texas Instruments - lm3532 White LED driver with ambient light sensing
+capability.
+
+The LM3532 provides the 3 high-voltage, low-side current sinks. The device is
+programmable over an I2C-compatible interface and has independent
+current control for all three channels. The adaptive current regulation
+method allows for different LED currents in each current sink thus allowing
+for a wide variety of backlight and keypad applications.
+
+The main features of the LM3532 include dual ambient light sensor inputs
+each with 32 internal voltage setting resistors, 8-bit logarithmic and linear
+brightness control, dual external PWM brightness control inputs, and up to
+1000:1 dimming ratio with programmable fade in and fade out settings.
+
+Required properties:
+	- compatible : "ti,lm3532"
+	- reg : I2C slave address
+	- #address-cells : 1
+	- #size-cells : 0
+
+Required child properties:
+	- reg : Indicates control bank the LED string is controlled by
+	- led-sources : see Documentation/devicetree/bindings/leds/common.txt
+	- ti,led-mode : Defines if the LED strings are manually controlled or
+			if the LED strings are controlled by the ALS.
+			0x00 - LED strings are I2C controlled via full scale
+			       brightness control register
+			0x01 - LED strings are ALS controlled
+
+Optional child properties:
+	Range for ramp settings: 8us - 65536us
+	- ramp-up-us - The Run time ramp rates/step are from one current
+		       set-point to another after the device has reached its
+		       initial target set point from turn-on
+	- ramp-down-us - The Run time ramp rates/step are from one current
+			 set-point to another after the device has reached its
+			 initial target set point from turn-on
+
+Optional child properties if ALS mode is used:
+	- als-vmin - Minimum ALS voltage defined in Volts
+	- als-vmax - Maximum ALS voltage defined in Volts
+	Per the data sheet the max ALS voltage is 2V and the min is 0V
+
+	- als1-imp-sel - ALS1 impedance resistor selection in Ohms
+	- als2-imp-sel - ALS2 impedance resistor selection in Ohms
+	Range for impedance select: 37000 Ohms - 1190 Ohms
+	Values above 37kohms will be set to the "High Impedance" setting
+
+	- als-avrg-time-us - Determines the length of time the device needs to
+			  average the two ALS inputs.  This is only used if
+			  the input mode is LM3532_ALS_INPUT_AVRG.
+			     Range: 17920us - 2293760us
+	- als-input-mode - Determines how the device uses the attached ALS
+			   devices.
+			   0x00 - ALS1 and ALS2 input average
+			   0x01 - ALS1 Input
+			   0x02 - ALS2 Input
+			   0x03 - Max of ALS1 and ALS2
+
+Optional LED child properties:
+	- label : see Documentation/devicetree/bindings/leds/common.txt
+	- linux,default-trigger :
+	   see Documentation/devicetree/bindings/leds/common.txt
+
+Example:
+led-controller@38 {
+	compatible = "ti,lm3532";
+	#address-cells = <1>;
+	#size-cells = <0>;
+	reg = <0x38>;
+
+	enable-gpios = <&gpio6 12 GPIO_ACTIVE_HIGH>;
+	ramp-up-ms = <1024>;
+	ramp-down-ms = <65536>;
+
+	lcd_backlight: led@0 {
+		reg = <0>;
+		led-sources = <2>;
+		ti,led-mode = <0>;
+		label = "backlight";
+		linux,default-trigger = "backlight";
+	};
+
+	led@1 {
+		reg = <1>;
+		led-sources = <1>;
+		ti,led-mode = <0>;
+		label = "keypad";
+	};
+};
+
+Example with ALS:
+led-controller@38 {
+	compatible = "ti,lm3532";
+	#address-cells = <1>;
+	#size-cells = <0>;
+	reg = <0x38>;
+
+	enable-gpios = <&gpio6 12 GPIO_ACTIVE_HIGH>;
+	ramp-up-ms = <1024>;
+	ramp-down-ms = <65536>;
+
+	als-vmin = <0>;
+	als-vmax = <2000>;
+	als1-imp-sel = <4110>;
+	als2-imp-sel = <2180>;
+	als-avrg-time-us = <17920>;
+	als-input-mode = <0x00>;
+
+	lcd_backlight: led@0 {
+		reg = <0>;
+		led-sources = <2>;
+		ti,led-mode = <1>;
+		label = "backlight";
+		linux,default-trigger = "backlight";
+	};
+
+	led@1 {
+		reg = <1>;
+		led-sources = <1>;
+		ti,led-mode = <0>;
+		label = "keypad";
+	};
+};
+
+For more product information please see the links below:
+http://www.ti.com/product/LM3532
Documentation/devicetree/bindings/mfd/ti-lmu.txt +0 -20
index c885cf89b8ce..980394d701a7 100644
@@ -4,7 +4,6 @@ TI LMU driver supports lighting devices below.
 
    Name                  Child nodes
   ------      ---------------------------------
-  LM3532       Backlight
   LM3631       Backlight and regulator
   LM3632       Backlight and regulator
   LM3633       Backlight, LED and fault monitor
@@ -13,7 +12,6 @@ TI LMU driver supports lighting devices below.
 
 Required properties:
   - compatible: Should be one of:
-                "ti,lm3532"
                 "ti,lm3631"
                 "ti,lm3632"
                 "ti,lm3633"
@@ -23,7 +21,6 @@ Required properties:
          0x11 for LM3632
          0x29 for LM3631
          0x36 for LM3633, LM3697
-         0x38 for LM3532
          0x63 for LM3695
 
 Optional property:
@@ -47,23 +44,6 @@ Optional nodes:
 [2] ../leds/leds-lm3633.txt
 [3] ../regulator/lm363x-regulator.txt
 
-lm3532@38 {
-	compatible = "ti,lm3532";
-	reg = <0x38>;
-
-	enable-gpios = <&pioC 2 GPIO_ACTIVE_HIGH>;
-
-	backlight {
-		compatible = "ti,lm3532-backlight";
-
-		lcd {
-			led-sources = <0 1 2>;
-			ramp-up-msec = <30>;
-			ramp-down-msec = <0>;
-		};
-	};
-};
-
 lm3631@29 {
 	compatible = "ti,lm3631";
 	reg = <0x29>;
Signature · 1 line
2.20.1.390.gb5101f9297
author
#1 lore raw

PATCH v3 2/4 ARM: dts: omap4-droid4: Update backlight dt properties

Update the properties for the lm3532 device node for droid4. With this change the backlight LED string and the keypad LED strings will be controlled separately.

---

v3 - updated keypad label on v1 comment - https://lore.kernel.org/patchwork/patch/1049023/

v2 - Fixed ramp-up and ramp-down properties, removed hard coded property values,
I did not change the label as it is undecided what it could be - https://lore.kernel.org/patchwork/patch/1048806/

 arch/arm/boot/dts/omap4-droid4-xt894.dts | 26 ++++++++++++++++--------
 1 file changed, 18 insertions(+), 8 deletions(-)
arch/arm/boot/dts/omap4-droid4-xt894.dts +18 -8
index e21ec929f096..aea206f04f76 100644
@@ -383,20 +383,30 @@
 };
 
 &i2c1 {
-	lm3532@38 {
+	led-controller@38 {
 		compatible = "ti,lm3532";
+		#address-cells = <1>;
+		#size-cells = <0>;
 		reg = <0x38>;
 
 		enable-gpios = <&gpio6 12 GPIO_ACTIVE_HIGH>;
 
-		lcd_backlight: backlight {
-			compatible = "ti,lm3532-backlight";
+		ramp-up-us = <1024>;
+		ramp-down-us = <8193>;
 
-			lcd {
-				led-sources = <0 1 2>;
-				ramp-up-msec = <1>;
-				ramp-down-msec = <0>;
-			};
+		lcd_backlight: led@0 {
+			reg = <0>;
+			led-sources = <2>;
+			ti,led-mode = <0>;
+			label = "backlight";
+			linux,default-trigger = "backlight";
+		};
+
+		led@1 {
+			reg = <1>;
+			led-sources = <1>;
+			ti,led-mode = <0>;
+			label = "platform::kbd_backlight";
 		};
 	};
 };
Signature · 1 line
2.20.1.390.gb5101f9297
author
#2 lore raw

PATCH v3 3/4 mfd: ti-lmu: Remove LM3532 backlight driver references

In reply to Dan Murphy

Remove the LM3532 backlight driver references from the ti-lmu code as dedicated driver support is available.

---

v3 - No changes - https://lore.kernel.org/patchwork/patch/1049025/

v2 - Removed LM3532 register definitions from ti-lmu-register - https://lore.kernel.org/patchwork/patch/1048808/

 drivers/mfd/ti-lmu.c                | 11 --------
 include/linux/mfd/ti-lmu-register.h | 44 -----------------------------
 include/linux/mfd/ti-lmu.h          |  1 -
 3 files changed, 56 deletions(-)
drivers/mfd/ti-lmu.c +0 -11
index 37d0bdb291c3..b06cb908d1aa 100644
@@ -54,14 +54,6 @@ static void ti_lmu_disable_hw(void *data)
 		gpiod_set_value(lmu->en_gpio, 0);
 }
 
-static const struct mfd_cell lm3532_devices[] = {
-	{
-		.name          = "ti-lmu-backlight",
-		.id            = LM3532,
-		.of_compatible = "ti,lm3532-backlight",
-	},
-};
-
 #define LM363X_REGULATOR(_id)			\
 {						\
 	.name          = "lm363x-regulator",	\
@@ -141,7 +133,6 @@ static const struct ti_lmu_data chip##_data =	\
 	.max_register = max_reg,		\
 }						\
 
-TI_LMU_DATA(lm3532, LM3532_MAX_REG);
 TI_LMU_DATA(lm3631, LM3631_MAX_REG);
 TI_LMU_DATA(lm3632, LM3632_MAX_REG);
 TI_LMU_DATA(lm3633, LM3633_MAX_REG);
@@ -211,7 +202,6 @@ static int ti_lmu_probe(struct i2c_client *cl, const struct i2c_device_id *id)
 }
 
 static const struct of_device_id ti_lmu_of_match[] = {
-	{ .compatible = "ti,lm3532", .data = &lm3532_data },
 	{ .compatible = "ti,lm3631", .data = &lm3631_data },
 	{ .compatible = "ti,lm3632", .data = &lm3632_data },
 	{ .compatible = "ti,lm3633", .data = &lm3633_data },
@@ -222,7 +212,6 @@ static const struct of_device_id ti_lmu_of_match[] = {
 MODULE_DEVICE_TABLE(of, ti_lmu_of_match);
 
 static const struct i2c_device_id ti_lmu_ids[] = {
-	{ "lm3532", LM3532 },
 	{ "lm3631", LM3631 },
 	{ "lm3632", LM3632 },
 	{ "lm3633", LM3633 },
include/linux/mfd/ti-lmu-register.h +0 -44

50 lines not on this page · raw message

include/linux/mfd/ti-lmu.h +0 -1
index 1ef51ed36be5..7762c1bce55d 100644
@@ -22,7 +22,6 @@
 #define LMU_EVENT_MONITOR_DONE		0x01
 
 enum ti_lmu_id {
-	LM3532,
 	LM3631,
 	LM3632,
 	LM3633,
Signature · 1 line
2.20.1.390.gb5101f9297
author
#3 lore raw

PATCH v3 4/4 leds: lm3532: Introduce the lm3532 LED driver

In reply to Dan Murphy

Introduce the Texas Instruments LM3532 White LED driver. The driver supports ALS configurability or manual brightness control.

The driver also supports associating LED strings with specific control banks in a group or as individually controlled strings.

---

v3 - Removed switch case for register setting in favor of an algorithim (v1 comment),
https://lore.kernel.org/patchwork/patch/1049024/

v2 - Added look up tables for als_avg, als_imp and ramp times, fixed brightness control when ALS is in control, added property value checks to ensure the values are not out of bounds - https://lore.kernel.org/patchwork/patch/1048807/

 drivers/leds/Kconfig       |  10 +
 drivers/leds/Makefile      |   1 +
 drivers/leds/leds-lm3532.c | 681 +++++++++++++++++++++++++++++++++++++
 3 files changed, 692 insertions(+)
 create mode 100644 drivers/leds/leds-lm3532.c
drivers/leds/Kconfig +10 -0
index a72f97fca57b..da00b9ed5a5c 100644
@@ -138,6 +138,16 @@ config LEDS_LM3530
 	  controlled manually or using PWM input or using ambient
 	  light automatically.
 
+config LEDS_LM3532
+	tristate "LCD Backlight driver for LM3532"
+	depends on LEDS_CLASS
+	depends on I2C
+	help
+	  This option enables support for the LCD backlight using
+	  LM3532 ambient light sensor chip. This ALS chip can be
+	  controlled manually or using PWM input or using ambient
+	  light automatically.
+
 config LEDS_LM3533
 	tristate "LED support for LM3533"
 	depends on LEDS_CLASS
drivers/leds/Makefile +1 -0
index 4c1b0054f379..7a8b1f55d459 100644
@@ -18,6 +18,7 @@ obj-$(CONFIG_LEDS_BD2802)		+= leds-bd2802.o
 obj-$(CONFIG_LEDS_CPCAP)		+= leds-cpcap.o
 obj-$(CONFIG_LEDS_LOCOMO)		+= leds-locomo.o
 obj-$(CONFIG_LEDS_LM3530)		+= leds-lm3530.o
+obj-$(CONFIG_LEDS_LM3532)		+= leds-lm3532.o
 obj-$(CONFIG_LEDS_LM3533)		+= leds-lm3533.o
 obj-$(CONFIG_LEDS_LM3642)		+= leds-lm3642.o
 obj-$(CONFIG_LEDS_MIKROTIK_RB532)	+= leds-rb532.o
drivers/leds/leds-lm3532.c new file +681 -0

681 lines not on this page · raw message

Signature · 1 line
2.20.1.390.gb5101f9297
maintainer
#4 lore raw
In reply to Dan Murphy
Quoted 69 lines · Dan Murphy

Add the lm3532 device tree documentation.
Remove lm3532 device tree reference from the ti_lmu devicetree documentation.

With the addition of the dedicated lm3532 documentation the device can be removed from the ti_lmu.txt.

The reason for this is that the lm3532 dt documentation now defines the ability to control LED output strings against different control banks or groups multiple strings to be controlled by a single control bank.

Another addition was for ALS lighting control and configuration. The LM3532 has a feature that can take in the ALS reading from 2 separate ALS devices and adjust the brightness on the strings that are configured to support this feature.

Finally the device specific properties were moved to the parent node as these properties are not control bank configurable. These include the runtime ramp and the ALS configuration.

---

v3 - No changes - https://lore.kernel.org/patchwork/patch/1049026/

v2 - Fixed ramp-up and ramp-down properties, removed hard coded property values,
added ranges for variable properties, I did not change the label - https://lore.kernel.org/patchwork/patch/1048805/

 .../devicetree/bindings/leds/leds-lm3532.txt  | 127 ++++++++++++++++++
 .../devicetree/bindings/mfd/ti-lmu.txt        |  20 ---
 2 files changed, 127 insertions(+), 20 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/leds/leds-lm3532.txt
Documentation/devicetree/bindings/leds/leds-lm3532.txt new file +29 -0
new file mode 100644
index 000000000000..b267d696b511
@@ -0,0 +1,127 @@
+* Texas Instruments - lm3532 White LED driver with ambient light sensing
+capability.
+
+The LM3532 provides the 3 high-voltage, low-side current sinks. The device is
+programmable over an I2C-compatible interface and has independent
+current control for all three channels. The adaptive current regulation
+method allows for different LED currents in each current sink thus allowing
+for a wide variety of backlight and keypad applications.
+
+The main features of the LM3532 include dual ambient light sensor inputs
+each with 32 internal voltage setting resistors, 8-bit logarithmic and linear
+brightness control, dual external PWM brightness control inputs, and up to
+1000:1 dimming ratio with programmable fade in and fade out settings.
+
+Required properties:
+	- compatible : "ti,lm3532"
+	- reg : I2C slave address
+	- #address-cells : 1
+	- #size-cells : 0
+
+Required child properties:
+	- reg : Indicates control bank the LED string is controlled by
+	- led-sources : see Documentation/devicetree/bindings/leds/common.txt
+	- ti,led-mode : Defines if the LED strings are manually controlled or
+			if the LED strings are controlled by the ALS.
+			0x00 - LED strings are I2C controlled via full scale
+			       brightness control register
+			0x01 - LED strings are ALS controlled
+

Documentation/devicetree/bindings/leds/leds-lm3532.txt line 39

Quoted 10 lines
Documentation/devicetree/bindings/leds/leds-lm3532.txt new file +10 -0
+Optional child properties:
+	Range for ramp settings: 8us - 65536us
+	- ramp-up-us - The Run time ramp rates/step are from one current
+		       set-point to another after the device has reached its
+		       initial target set point from turn-on
+	- ramp-down-us - The Run time ramp rates/step are from one current
+			 set-point to another after the device has reached its
+			 initial target set point from turn-on
+
+Optional child properties if ALS mode is used:

I think you want to remove 'child' here.

Is this all als properties or none or any combination are valid?

Quoted 9 lines
Documentation/devicetree/bindings/leds/leds-lm3532.txt new file +9 -0
+	- als-vmin - Minimum ALS voltage defined in Volts
+	- als-vmax - Maximum ALS voltage defined in Volts
+	Per the data sheet the max ALS voltage is 2V and the min is 0V
+
+	- als1-imp-sel - ALS1 impedance resistor selection in Ohms
+	- als2-imp-sel - ALS2 impedance resistor selection in Ohms
+	Range for impedance select: 37000 Ohms - 1190 Ohms
+	Values above 37kohms will be set to the "High Impedance" setting
+

Documentation/devicetree/bindings/leds/leds-lm3532.txt line 58

Quoted 10 lines
Documentation/devicetree/bindings/leds/leds-lm3532.txt new file +10 -0
+	- als-avrg-time-us - Determines the length of time the device needs to
+			  average the two ALS inputs.  This is only used if
+			  the input mode is LM3532_ALS_INPUT_AVRG.
+			     Range: 17920us - 2293760us
+	- als-input-mode - Determines how the device uses the attached ALS
+			   devices.
+			   0x00 - ALS1 and ALS2 input average
+			   0x01 - ALS1 Input
+			   0x02 - ALS2 Input
+			   0x03 - Max of ALS1 and ALS2

These all need a 'ti' prefix or determination of whether they should be common properties.

Quoted 4 lines
Documentation/devicetree/bindings/leds/leds-lm3532.txt new file +4 -0
+
+Optional LED child properties:
+	- label : see Documentation/devicetree/bindings/leds/common.txt
+	- linux,default-trigger :

Documentation/devicetree/bindings/leds/leds-lm3532.txt line 72

Quoted 10 lines
Documentation/devicetree/bindings/leds/leds-lm3532.txt new file +10 -0
+	   see Documentation/devicetree/bindings/leds/common.txt
+
+Example:
+led-controller@38 {
+	compatible = "ti,lm3532";
+	#address-cells = <1>;
+	#size-cells = <0>;
+	reg = <0x38>;
+
+	enable-gpios = <&gpio6 12 GPIO_ACTIVE_HIGH>;

Not documented.

Documentation/devicetree/bindings/leds/leds-lm3532.txt line 74

Quoted 2 lines
Documentation/devicetree/bindings/leds/leds-lm3532.txt new file +2 -0
+	ramp-up-ms = <1024>;
+	ramp-down-ms = <65536>;

Says above these go in the child nodes.

Quoted 8 lines
Documentation/devicetree/bindings/leds/leds-lm3532.txt new file +8 -0
+
+	lcd_backlight: led@0 {
+		reg = <0>;
+		led-sources = <2>;
+		ti,led-mode = <0>;
+		label = "backlight";
+		linux,default-trigger = "backlight";
+	};

Documentation/devicetree/bindings/leds/leds-lm3532.txt line 92

Quoted 10 lines
Documentation/devicetree/bindings/leds/leds-lm3532.txt new file +10 -0
+
+	led@1 {
+		reg = <1>;
+		led-sources = <1>;
+		ti,led-mode = <0>;
+		label = "keypad";
+	};
+};
+
+Example with ALS:

Do we really need 2 examples? Seems like this one would be enough.

Quoted 90 lines
Documentation/devicetree/bindings/leds/leds-lm3532.txt new file +35 -0
+led-controller@38 {
+	compatible = "ti,lm3532";
+	#address-cells = <1>;
+	#size-cells = <0>;
+	reg = <0x38>;
+
+	enable-gpios = <&gpio6 12 GPIO_ACTIVE_HIGH>;
+	ramp-up-ms = <1024>;
+	ramp-down-ms = <65536>;
+
+	als-vmin = <0>;
+	als-vmax = <2000>;
+	als1-imp-sel = <4110>;
+	als2-imp-sel = <2180>;
+	als-avrg-time-us = <17920>;
+	als-input-mode = <0x00>;
+
+	lcd_backlight: led@0 {
+		reg = <0>;
+		led-sources = <2>;
+		ti,led-mode = <1>;
+		label = "backlight";
+		linux,default-trigger = "backlight";
+	};
+
+	led@1 {
+		reg = <1>;
+		led-sources = <1>;
+		ti,led-mode = <0>;
+		label = "keypad";
+	};
+};
+
+For more product information please see the links below:
+http://www.ti.com/product/LM3532
Documentation/devicetree/bindings/mfd/ti-lmu.txt +0 -20
index c885cf89b8ce..980394d701a7 100644
@@ -4,7 +4,6 @@ TI LMU driver supports lighting devices below.
 
    Name                  Child nodes
   ------      ---------------------------------
-  LM3532       Backlight
   LM3631       Backlight and regulator
   LM3632       Backlight and regulator
   LM3633       Backlight, LED and fault monitor
@@ -13,7 +12,6 @@ TI LMU driver supports lighting devices below.
 
 Required properties:
   - compatible: Should be one of:
-                "ti,lm3532"
                 "ti,lm3631"
                 "ti,lm3632"
                 "ti,lm3633"
@@ -23,7 +21,6 @@ Required properties:
          0x11 for LM3632
          0x29 for LM3631
          0x36 for LM3633, LM3697
-         0x38 for LM3532
          0x63 for LM3695
 
 Optional property:
@@ -47,23 +44,6 @@ Optional nodes:
 [2] ../leds/leds-lm3633.txt
 [3] ../regulator/lm363x-regulator.txt
 
-lm3532@38 {
-	compatible = "ti,lm3532";
-	reg = <0x38>;
-
-	enable-gpios = <&pioC 2 GPIO_ACTIVE_HIGH>;
-
-	backlight {
-		compatible = "ti,lm3532-backlight";
-
-		lcd {
-			led-sources = <0 1 2>;
-			ramp-up-msec = <30>;
-			ramp-down-msec = <0>;
-		};
-	};
-};
-
 lm3631@29 {
 	compatible = "ti,lm3631";
 	reg = <0x29>;
Signature · 1 line
2.20.1.390.gb5101f9297
author
#5 lore raw

Rob

Quoted 74 lines · Rob Herring
Quoted 73 lines · Dan Murphy

Add the lm3532 device tree documentation.
Remove lm3532 device tree reference from the ti_lmu devicetree documentation.

With the addition of the dedicated lm3532 documentation the device can be removed from the ti_lmu.txt.

The reason for this is that the lm3532 dt documentation now defines the ability to control LED output strings against different control banks or groups multiple strings to be controlled by a single control bank.

Another addition was for ALS lighting control and configuration. The LM3532 has a feature that can take in the ALS reading from 2 separate ALS devices and adjust the brightness on the strings that are configured to support this feature.

Finally the device specific properties were moved to the parent node as these properties are not control bank configurable. These include the runtime ramp and the ALS configuration.

---

v3 - No changes - https://lore.kernel.org/patchwork/patch/1049026/

v2 - Fixed ramp-up and ramp-down properties, removed hard coded property values,
added ranges for variable properties, I did not change the label - https://lore.kernel.org/patchwork/patch/1048805/

 .../devicetree/bindings/leds/leds-lm3532.txt  | 127 ++++++++++++++++++
 .../devicetree/bindings/mfd/ti-lmu.txt        |  20 ---
 2 files changed, 127 insertions(+), 20 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/leds/leds-lm3532.txt
Documentation/devicetree/bindings/leds/leds-lm3532.txt new file +33 -0
new file mode 100644
index 000000000000..b267d696b511
@@ -0,0 +1,127 @@
+* Texas Instruments - lm3532 White LED driver with ambient light sensing
+capability.
+
+The LM3532 provides the 3 high-voltage, low-side current sinks. The device is
+programmable over an I2C-compatible interface and has independent
+current control for all three channels. The adaptive current regulation
+method allows for different LED currents in each current sink thus allowing
+for a wide variety of backlight and keypad applications.
+
+The main features of the LM3532 include dual ambient light sensor inputs
+each with 32 internal voltage setting resistors, 8-bit logarithmic and linear
+brightness control, dual external PWM brightness control inputs, and up to
+1000:1 dimming ratio with programmable fade in and fade out settings.
+
+Required properties:
+	- compatible : "ti,lm3532"
+	- reg : I2C slave address
+	- #address-cells : 1
+	- #size-cells : 0
+
+Required child properties:
+	- reg : Indicates control bank the LED string is controlled by
+	- led-sources : see Documentation/devicetree/bindings/leds/common.txt
+	- ti,led-mode : Defines if the LED strings are manually controlled or
+			if the LED strings are controlled by the ALS.
+			0x00 - LED strings are I2C controlled via full scale
+			       brightness control register
+			0x01 - LED strings are ALS controlled
+
+Optional child properties:
+	Range for ramp settings: 8us - 65536us
+	- ramp-up-us - The Run time ramp rates/step are from one current
+		       set-point to another after the device has reached its
Quoted 9 lines

Documentation/devicetree/bindings/leds/leds-lm3532.txt line 39

Quoted 6 lines
Documentation/devicetree/bindings/leds/leds-lm3532.txt new file +6 -0
+		       initial target set point from turn-on
+	- ramp-down-us - The Run time ramp rates/step are from one current
+			 set-point to another after the device has reached its
+			 initial target set point from turn-on
+
+Optional child properties if ALS mode is used:

I think you want to remove 'child' here.

Yes they need to be in the parent since they are device and not string specific configurations.

Quoted 2 lines

Is this all als properties or none or any combination are valid?

They are all optional in combination. If the value is not set then the default is taken

Quoted 14 lines
Quoted 14 lines
Documentation/devicetree/bindings/leds/leds-lm3532.txt new file +14 -0
+	- als-vmin - Minimum ALS voltage defined in Volts
+	- als-vmax - Maximum ALS voltage defined in Volts
+	Per the data sheet the max ALS voltage is 2V and the min is 0V
+
+	- als1-imp-sel - ALS1 impedance resistor selection in Ohms
+	- als2-imp-sel - ALS2 impedance resistor selection in Ohms
+	Range for impedance select: 37000 Ohms - 1190 Ohms
+	Values above 37kohms will be set to the "High Impedance" setting
+
+	- als-avrg-time-us - Determines the length of time the device needs to
+			  average the two ALS inputs.  This is only used if
+			  the input mode is LM3532_ALS_INPUT_AVRG.
+			     Range: 17920us - 2293760us
+	- als-input-mode - Determines how the device uses the attached ALS
Quoted 9 lines

Documentation/devicetree/bindings/leds/leds-lm3532.txt line 58

Quoted 5 lines
Documentation/devicetree/bindings/leds/leds-lm3532.txt new file +5 -0
+			   devices.
+			   0x00 - ALS1 and ALS2 input average
+			   0x01 - ALS1 Input
+			   0x02 - ALS2 Input
+			   0x03 - Max of ALS1 and ALS2

These all need a 'ti' prefix or determination of whether they should be common properties.

Ack

Quoted 8 lines
Quoted 8 lines
Documentation/devicetree/bindings/leds/leds-lm3532.txt new file +8 -0
+
+Optional LED child properties:
+	- label : see Documentation/devicetree/bindings/leds/common.txt
+	- linux,default-trigger :
+	   see Documentation/devicetree/bindings/leds/common.txt
+
+Example:
+led-controller@38 {
Quoted 9 lines

Documentation/devicetree/bindings/leds/leds-lm3532.txt line 72

Quoted 6 lines
Documentation/devicetree/bindings/leds/leds-lm3532.txt new file +6 -0
+	compatible = "ti,lm3532";
+	#address-cells = <1>;
+	#size-cells = <0>;
+	reg = <0x38>;
+
+	enable-gpios = <&gpio6 12 GPIO_ACTIVE_HIGH>;

Not documented.

Ack

Quoted 5 lines

Documentation/devicetree/bindings/leds/leds-lm3532.txt line 74

Quoted 2 lines
Documentation/devicetree/bindings/leds/leds-lm3532.txt new file +2 -0
+	ramp-up-ms = <1024>;
+	ramp-down-ms = <65536>;

Says above these go in the child nodes.

They are device configuration not LED string specific. I will move them to the parent.

Quoted 12 lines
Quoted 12 lines
Documentation/devicetree/bindings/leds/leds-lm3532.txt new file +12 -0
+
+	lcd_backlight: led@0 {
+		reg = <0>;
+		led-sources = <2>;
+		ti,led-mode = <0>;
+		label = "backlight";
+		linux,default-trigger = "backlight";
+	};
+
+	led@1 {
+		reg = <1>;
+		led-sources = <1>;
Quoted 9 lines

Documentation/devicetree/bindings/leds/leds-lm3532.txt line 92

Quoted 6 lines
Documentation/devicetree/bindings/leds/leds-lm3532.txt new file +6 -0
+		ti,led-mode = <0>;
+		label = "keypad";
+	};
+};
+
+Example with ALS:

Do we really need 2 examples? Seems like this one would be enough.

I can remove the non-ALS example

Dan

Quoted 90 lines
Quoted 90 lines
Documentation/devicetree/bindings/leds/leds-lm3532.txt new file +35 -0
+led-controller@38 {
+	compatible = "ti,lm3532";
+	#address-cells = <1>;
+	#size-cells = <0>;
+	reg = <0x38>;
+
+	enable-gpios = <&gpio6 12 GPIO_ACTIVE_HIGH>;
+	ramp-up-ms = <1024>;
+	ramp-down-ms = <65536>;
+
+	als-vmin = <0>;
+	als-vmax = <2000>;
+	als1-imp-sel = <4110>;
+	als2-imp-sel = <2180>;
+	als-avrg-time-us = <17920>;
+	als-input-mode = <0x00>;
+
+	lcd_backlight: led@0 {
+		reg = <0>;
+		led-sources = <2>;
+		ti,led-mode = <1>;
+		label = "backlight";
+		linux,default-trigger = "backlight";
+	};
+
+	led@1 {
+		reg = <1>;
+		led-sources = <1>;
+		ti,led-mode = <0>;
+		label = "keypad";
+	};
+};
+
+For more product information please see the links below:
+http://www.ti.com/product/LM3532
Documentation/devicetree/bindings/mfd/ti-lmu.txt +0 -20
index c885cf89b8ce..980394d701a7 100644
@@ -4,7 +4,6 @@ TI LMU driver supports lighting devices below.
 
    Name                  Child nodes
   ------      ---------------------------------
-  LM3532       Backlight
   LM3631       Backlight and regulator
   LM3632       Backlight and regulator
   LM3633       Backlight, LED and fault monitor
@@ -13,7 +12,6 @@ TI LMU driver supports lighting devices below.
 
 Required properties:
   - compatible: Should be one of:
-                "ti,lm3532"
                 "ti,lm3631"
                 "ti,lm3632"
                 "ti,lm3633"
@@ -23,7 +21,6 @@ Required properties:
          0x11 for LM3632
          0x29 for LM3631
          0x36 for LM3633, LM3697
-         0x38 for LM3532
          0x63 for LM3695
 
 Optional property:
@@ -47,23 +44,6 @@ Optional nodes:
 [2] ../leds/leds-lm3633.txt
 [3] ../regulator/lm363x-regulator.txt
 
-lm3532@38 {
-	compatible = "ti,lm3532";
-	reg = <0x38>;
-
-	enable-gpios = <&pioC 2 GPIO_ACTIVE_HIGH>;
-
-	backlight {
-		compatible = "ti,lm3532-backlight";
-
-		lcd {
-			led-sources = <0 1 2>;
-			ramp-up-msec = <30>;
-			ramp-down-msec = <0>;
-		};
-	};
-};
-
 lm3631@29 {
 	compatible = "ti,lm3631";
 	reg = <0x29>;
Signature · 1 line
2.20.1.390.gb5101f9297
Signature · 2 lines
------------------
Dan Murphy