dt: bindings: lm3601x: Introduce the lm3601x driver
Subsystems (2)
PATCH v5 1/2 dt: bindings: lm3601x: Introduce the lm3601x driver
Introduce the device tree bindings for the lm3601x family of LED torch, flash and IR drivers.
---
v5 - No changes - https://patchwork.kernel.org/patch/10391743/
v4 - Added " " around "=", changed strobe to flash on label, removed "support and register" comment and change ir lable to ir:torch - See v2 patchworks for comments v3 - Removed wildcard compatible - https://patchwork.kernel.org/patch/10386241/
v2 - No changes - https://patchwork.kernel.org/patch/10384587/
.../devicetree/bindings/leds/leds-lm3601x.txt | 50 +++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 Documentation/devicetree/bindings/leds/leds-lm3601x.txt
Documentation/devicetree/bindings/leds/leds-lm3601x.txt new file +50 -0
@@ -0,0 +1,50 @@ +* Texas Instruments - lm3601x Single-LED Flash Driver + +The LM3601X are ultra-small LED flash drivers that +provide a high level of adjustability. + +Required properties: + - compatible : Can be one of the following + "ti,lm36010" + "ti,lm36011" + - reg : I2C slave address + - #address-cells : 1 + - #size-cells : 0 + +Required child properties: + - reg : 0 - Indicates a torch interface + 1 - Indicates a flash interface + 2 - Indicates an infrared interface + +Optional child properties: + - label : see Documentation/devicetree/bindings/leds/common.txt + +Example: +led-controller@64 { + compatible = "ti,lm36010"; + #address-cells = <1>; + #size-cells = <0>; + reg = <0x64>; + + led@0 { + reg = <0>; + label = "white:torch"; + led-max-microamp = <10000>; + }; + + led@1 { + reg = <1>; + label = "white:flash"; + flash-max-microamp = <10000>; + flash-max-timeout-us = <800>; + }; + + led@2 { + reg = <2>; + label = "ir:torch"; + }; +} + +For more product information please see the links below: +http://www.ti.com/product/LM36010 +http://www.ti.com/product/LM36011
Signature · 1 line
2.17.0.582.gccdcbd54c
PATCH v5 2/2 leds: lm3601x: Introduce the lm3601x LED driver
Introduce the family of LED devices that can
drive a torch, strobe or IR LED.
The LED driver can be configured with a strobe
timer to execute a strobe flash. The IR LED
brightness is controlled via the torch brightness
register.
The data sheet for each the LM36010 and LM36011
LED drivers can be found here:
http://www.ti.com/product/LM36010
http://www.ti.com/product/LM36011
---
v5 - Fixed magic numbers, change reg cache type, added of_put_node to release the dt node ref, and I did not change the remove function to leave the LED in its state on driver removal - https://patchwork.kernel.org/patch/10391741/
v4 - Fixed Cocci issue using ARRAY_SIZE - https://patchwork.kernel.org/patch/10389259/
v3 - removed wildcard dt compatible, fixed copyright, fixed struct doc, removed
RO registers from default, added regmap volatile for FLAGS_REG, updated regmap cache type, fixed unlock and extra semi colon in strobe_set, removed unnecessary out label
in led register and fixed checking of the ret in brightness_set - https://patchwork.kernel.org/patch/10386243/
v2 - Fixed kbuild issue and removed unused cdev_strobe - https://patchwork.kernel.org/patch/10384585/
drivers/leds/Kconfig | 9 + drivers/leds/Makefile | 1 + drivers/leds/leds-lm3601x.c | 622 ++++++++++++++++++++++++++++++++++++ 3 files changed, 632 insertions(+) create mode 100644 drivers/leds/leds-lm3601x.c
drivers/leds/Kconfig +9 -0
@@ -145,6 +145,15 @@ config LEDS_LM3692X This option enables support for the TI LM3692x family of white LED string drivers used for backlighting. +config LEDS_LM3601X + tristate "LED support for LM3601x Chips" + depends on LEDS_CLASS && I2C && OF + depends on LEDS_CLASS_FLASH + select REGMAP_I2C + help + This option enables support for the TI LM3601x family + of flash, torch and indicator classes. + config LEDS_LOCOMO tristate "LED Support for Locomo device" depends on LEDS_CLASS
drivers/leds/Makefile +1 -0
@@ -76,6 +76,7 @@ obj-$(CONFIG_LEDS_MLXREG) += leds-mlxreg.o obj-$(CONFIG_LEDS_NIC78BX) += leds-nic78bx.o obj-$(CONFIG_LEDS_MT6323) += leds-mt6323.o obj-$(CONFIG_LEDS_LM3692X) += leds-lm3692x.o +obj-$(CONFIG_LEDS_LM3601X) += leds-lm3601x.o # LED SPI Drivers obj-$(CONFIG_LEDS_DAC124S085) += leds-dac124s085.o
drivers/leds/leds-lm3601x.c new file +622 -0
622 lines not on this page · raw message
Signature · 1 line
2.17.0.582.gccdcbd54c
Re: [PATCH v5 2/2] leds: lm3601x: Introduce the lm3601x LED driver
Hi Dan,
Thank you for the patch.
Quoted 72 lines · Dan Murphy
Introduce the family of LED devices that can
drive a torch, strobe or IR LED.The LED driver can be configured with a strobe
timer to execute a strobe flash. The IR LED
brightness is controlled via the torch brightness
register.The data sheet for each the LM36010 and LM36011
LED drivers can be found here:
http://www.ti.com/product/LM36010
http://www.ti.com/product/LM36011Signed-off-by Dan Murphy <[email protected]>---
v5 - Fixed magic numbers, change reg cache type, added
of_put_nodeto release the dt node ref, and I did not change the remove function to leave the LED in its state on driver removal - https://patchwork.kernel.org/patch/10391741/v4 - Fixed Cocci issue using
ARRAY_SIZE- https://patchwork.kernel.org/patch/10389259/
v3 - removed wildcard dt compatible, fixed copyright, fixed struct doc, removed
RO registers from default, added regmap volatile forFLAGS_REG, updated regmap cache type, fixed unlock and extra semi colon instrobe_set, removed unnecessary out label
in led register and fixed checking of the ret inbrightness_set- https://patchwork.kernel.org/patch/10386243/
v2 - Fixed kbuild issue and removed unusedcdev_strobe- https://patchwork.kernel.org/patch/10384585/drivers/leds/Kconfig | 9 + drivers/leds/Makefile | 1 + drivers/leds/leds-lm3601x.c | 622 ++++++++++++++++++++++++++++++++++++ 3 files changed, 632 insertions(+)create mode 100644
drivers/leds/leds-lm3601x.cdrivers/leds/Kconfig +9
-0@@ -145,6 +145,15 @@ config LEDS_LM3692X This option enables support for the TI LM3692x family of white LED string drivers used for backlighting. +config LEDS_LM3601X + tristate "LED support for LM3601x Chips" + depends on LEDS_CLASS && I2C && OF + depends on LEDS_CLASS_FLASH + select REGMAP_I2C + help + This option enables support for the TI LM3601x family + of flash, torch and indicator classes. + config LEDS_LOCOMO tristate "LED Support for Locomo device" depends on LEDS_CLASSdrivers/leds/Makefile +1
-0@@ -76,6 +76,7 @@ obj-$(CONFIG_LEDS_MLXREG) += leds-mlxreg.o obj-$(CONFIG_LEDS_NIC78BX) += leds-nic78bx.o obj-$(CONFIG_LEDS_MT6323) += leds-mt6323.o obj-$(CONFIG_LEDS_LM3692X) += leds-lm3692x.o +obj-$(CONFIG_LEDS_LM3601X) += leds-lm3601x.o # LED SPI Drivers obj-$(CONFIG_LEDS_DAC124S085) += leds-dac124s085.odrivers/leds/leds-lm3601x.c new file +0
-0
drivers/leds/leds-lm3601x.c line 6
Quoted 6 lines
drivers/leds/leds-lm3601x.c new file +6
-0@@ -0,0 +1,622 @@ +// SPDX-License-Identifier: GPL-2.0 +/* +* Flash and torch driver for Texas Instruments LM3601X LED +* Flash driver chip family +* Copyright (C) 2018 Texas Instruments Incorporated - http://www.ti.com/ +*/
Please use uniform "//" comment style here.
Quoted 299 lines
drivers/leds/leds-lm3601x.c new file +299
-0+#include <linux/delay.h> +#include <linux/i2c.h> +#include <linux/leds.h> +#include <linux/led-class-flash.h> +#include <linux/module.h> +#include <linux/regmap.h> +#include <linux/slab.h> +#include <uapi/linux/uleds.h> + +#define LM3601X_LED_TORCH 0x0 +#define LM3601X_LED_STROBE 0x1 +#define LM3601X_LED_IR 0x2 + +/* Registers */ +#define LM3601X_ENABLE_REG 0x01 +#define LM3601X_CFG_REG 0x02 +#define LM3601X_LED_FLASH_REG 0x03 +#define LM3601X_LED_TORCH_REG 0x04 +#define LM3601X_FLAGS_REG 0x05 +#define LM3601X_DEV_ID_REG 0x06 + +#define LM3601X_SW_RESET BIT(7) + +/* Enable Mode bits */ +#define LM3601X_MODE_STANDBY 0x00 +#define LM3601X_MODE_IR_DRV BIT(0) +#define LM3601X_MODE_TORCH BIT(1) +#define LM3601X_MODE_STROBE (BIT(0) | BIT(1)) +#define LM3601X_STRB_EN BIT(2) +#define LM3601X_STRB_LVL_TRIG ~BIT(3) +#define LM3601X_STRB_EDGE_TRIG BIT(3) +#define LM3601X_IVFM_EN BIT(4) + +#define LM36010_BOOST_LIMIT_19 ~BIT(5) +#define LM36010_BOOST_LIMIT_28 BIT(5) +#define LM36010_BOOST_FREQ_2MHZ ~BIT(6) +#define LM36010_BOOST_FREQ_4MHZ BIT(6) +#define LM36010_BOOST_MODE_NORM ~BIT(7) +#define LM36010_BOOST_MODE_PASS BIT(7) + +/* Flag Mask */ +#define LM3601X_FLASH_TIME_OUT BIT(0) +#define LM3601X_UVLO_FAULT BIT(1) +#define LM3601X_THERM_SHUTDOWN BIT(2) +#define LM3601X_THERM_CURR BIT(3) +#define LM36010_CURR_LIMIT BIT(4) +#define LM3601X_SHORT_FAULT BIT(5) +#define LM3601X_IVFM_TRIP BIT(6) +#define LM36010_OVP_FAULT BIT(7) + +#define LM3601X_MIN_TORCH_I_UA 2400 +#define LM3601X_MIN_STROBE_I_MA 11 + +#define LM3601X_TIMEOUT_MASK 0x1e +#define LM3601X_ENABLE_MASK 0x03 + +enum lm3601x_type { +CHIP_LM36010 =0 , +CHIP_LM36011 , +}; + +/** +* struct lm3601x_max_timeouts - +* @timeout: timeout value in ms +* @regval: the value of the register to write +*/ +struct lm3601x_max_timeouts { +int timeout; +int reg_val; +}; + +/** +* struct lm3601x_led - +* @lock: Lock for reading/writing the device +* @regmap: Devices register map +* @client: Pointer to the I2C client +* @cdev_torch: led class device pointer for the torch +* @cdev_ir: led class device pointer for infrared +* @fled_cdev: flash led class device pointer +* @strobe_node: DT device node for the strobe +* @torch: LED label for the torch +* @strobe: LED label for the strobe +* @ir: LED label for the infrared +* @last_flag: last known flags register value +* @strobe_timeout: the timeout for the strobe +* @torch_current_max: maximum current for the torch +* @strobe_current_max: maximum current for the strobe +* @max_strobe_timeout: maximum timeout for the strobe +*/ +struct lm3601x_led { +struct mutex lock; +struct regmap *regmap; +struct i2c_client *client; + +struct led_classdev cdev_torch; +struct led_classdev cdev_ir; + +struct led_classdev_flash fled_cdev; + +struct device_node *strobe_node; +struct device_node *torch_node; +struct device_node *ir_node; + +char torch[LED_MAX_NAME_SIZE ]; +char strobe[LED_MAX_NAME_SIZE ]; +char ir[LED_MAX_NAME_SIZE ]; + +unsigned int last_flag; +unsigned int strobe_timeout; + +u32 torch_current_max; +u32 strobe_current_max; +u32 max_strobe_timeout; +}; + +static const struct lm3601x_max_timeouts strobe_timeouts[] = { + {40 ,0x00 }, + {80 ,0x01 }, + {120 ,0x02 }, + {160 ,0x03 }, + {200 ,0x04 }, + {240 ,0x05 }, + {280 ,0x06 }, + {320 ,0x07 }, + {360 ,0x08 }, + {400 ,0x09 }, + {600 ,0x0a }, + {800 ,0x0b }, + {1000 ,0x0c }, + {1200 ,0x0d }, + {1400 ,0x0e }, + {1600 ,0x0f }, +}; + +static const struct reg_default lm3601x_regmap_defs[] = { + {LM3601X_ENABLE_REG ,0x20 }, + {LM3601X_CFG_REG ,0x15 }, + {LM3601X_LED_FLASH_REG ,0x00 }, + {LM3601X_LED_TORCH_REG ,0x00 }, +}; + +static bool lm3601x_volatile_reg (struct device *dev,unsigned int reg) +{ +switch (reg) { +case LM3601X_FLAGS_REG : +return true; +default : +return false; + } +} + +static const struct regmap_config lm3601x_regmap = { + .reg_bits =8 , + .val_bits =8 , + + .max_register =LM3601X_DEV_ID_REG , + .reg_defaults = lm3601x_regmap_defs, + .num_reg_defaults =ARRAY_SIZE (lm3601x_regmap_defs), + .cache_type =REGCACHE_RBTREE , + .volatile_reg = lm3601x_volatile_reg, +}; + +static struct lm3601x_led *fled_cdev_to_led ( +struct led_classdev_flash *fled_cdev) +{ + return container_of(fled_cdev, struct lm3601x_led, fled_cdev); +} + +static int lm3601x_read_faults (struct lm3601x_led *led) +{ +int flags_val; +int ret; + + ret =regmap_read (led->regmap,LM3601X_FLAGS_REG , &flags_val); +if (ret <0 ) +return -EIO ; + + led->last_flag = flags_val; + +return led->last_flag; +} + +static int lm3601x_torch_brightness_set (struct led_classdev *cdev, +enum led_brightness brightness) +{ +struct lm3601x_led *led = + container_of(cdev, struct lm3601x_led, cdev_torch); +int ret; +u8 brightness_val; + +mutex_lock (&led->lock); + + ret =lm3601x_read_faults (led); +if (ret <0 ) + goto out; + +if (brightness ==LED_OFF ) { + ret =regmap_update_bits (led->regmap,LM3601X_ENABLE_REG , +LM3601X_MODE_TORCH ,LED_OFF ); + goto out; + } + +if (brightness ==LED_ON ) + brightness_val =LED_ON ; +else + brightness_val = (brightness/2 ); + + ret =regmap_write (led->regmap,LM3601X_LED_TORCH_REG , brightness_val); +if (ret <0 ) + goto out; + + ret =regmap_update_bits (led->regmap,LM3601X_ENABLE_REG , +LM3601X_MODE_TORCH , +LM3601X_MODE_TORCH ); + +out: +mutex_unlock (&led->lock); +return ret; +} + +static int lm3601x_strobe_set (struct led_classdev_flash *fled_cdev, +bool state) +{ +struct lm3601x_led *led =fled_cdev_to_led (fled_cdev); +int ret; +int current_timeout; +int reg_count; +int i; +int timeout_reg_val =0 ; + +mutex_lock (&led->lock); + + ret =regmap_read (led->regmap,LM3601X_CFG_REG , ¤t_timeout); +if (ret <0 ) + goto out; + + reg_count =ARRAY_SIZE (strobe_timeouts); +for (i =0 ; i < reg_count; i++) { +if (led->strobe_timeout > strobe_timeouts[i].timeout) +continue ; + +if (led->strobe_timeout <= strobe_timeouts[i].timeout) { + timeout_reg_val = (strobe_timeouts[i].reg_val <<1 ); +break ; + } + + ret = -EINVAL ; + goto out; + } + +if (led->strobe_timeout != current_timeout) + ret =regmap_update_bits (led->regmap,LM3601X_CFG_REG , +LM3601X_TIMEOUT_MASK , timeout_reg_val); + +if (state) + ret =regmap_update_bits (led->regmap,LM3601X_ENABLE_REG , +LM3601X_MODE_STROBE , +LM3601X_MODE_STROBE ); +else + ret =regmap_update_bits (led->regmap,LM3601X_ENABLE_REG , +LM3601X_MODE_STROBE ,LED_OFF ); + + ret =lm3601x_read_faults (led); +out: +mutex_unlock (&led->lock); +return ret; +} + +static int lm3601x_strobe_brightness_set (struct led_classdev *cdev, +enum led_brightness brightness) +{ +struct led_classdev_flash *fled_cdev =lcdev_to_flcdev (cdev); +struct lm3601x_led *led =fled_cdev_to_led (fled_cdev); +int ret; +u8 brightness_val; + +mutex_lock (&led->lock); + ret =lm3601x_read_faults (led); +if (ret <0 ) + goto out; + +if (brightness ==LED_OFF ) { + ret =regmap_update_bits (led->regmap,LM3601X_ENABLE_REG , +LM3601X_MODE_STROBE ,LED_OFF ); + goto out; + } + +if (brightness ==LED_ON ) + brightness_val =LED_ON ; +else + brightness_val = (brightness/2 ); + + ret =regmap_write (led->regmap,LM3601X_LED_FLASH_REG , brightness_val); + +out: +mutex_unlock (&led->lock); +return ret; +} +
drivers/leds/leds-lm3601x.c line 316
Quoted 10 lines
drivers/leds/leds-lm3601x.c new file +10
-0+static int lm3601x_strobe_timeout_set (struct led_classdev_flash *fled_cdev, +u32 timeout) +{ +struct lm3601x_led *led =fled_cdev_to_led (fled_cdev); +int ret =0 ; + +mutex_lock (&led->lock); + +if (timeout > led->max_strobe_timeout) + ret = -EINVAL ;
LED flash core takes care of clamping timeout setting according to the defined constraints.
Quoted 58 lines
drivers/leds/leds-lm3601x.c new file +58
-0+else + led->strobe_timeout = timeout; + +mutex_unlock (&led->lock); + +return ret; +} + +static int lm3601x_strobe_get (struct led_classdev_flash *fled_cdev, +bool *state) +{ +struct lm3601x_led *led =fled_cdev_to_led (fled_cdev); +int ret; +int strobe_state; + +mutex_lock (&led->lock); + + ret =regmap_read (led->regmap,LM3601X_ENABLE_REG , &strobe_state); +if (ret <0 ) + goto out; + + *state = strobe_state &LM3601X_MODE_STROBE ; + +out: +mutex_unlock (&led->lock); +return ret; +} + +static int lm3601x_ir_brightness_set (struct led_classdev *cdev, +enum led_brightness brightness) +{ +struct lm3601x_led *led = + container_of(cdev, struct lm3601x_led, cdev_ir); +int ret; +u8 brightness_val; + +mutex_lock (&led->lock); + ret =lm3601x_read_faults (led); +if (ret <0 ) + goto out; + +if (brightness ==LED_OFF ) { + ret =regmap_update_bits (led->regmap,LM3601X_ENABLE_REG , +LM3601X_LED_IR , +LED_OFF ); + goto out; + } + +if (brightness ==LED_ON ) + brightness_val =LED_ON ; +else + brightness_val = (brightness/2 ); + + ret =regmap_write (led->regmap,LM3601X_LED_FLASH_REG , brightness_val); +if (ret <0 ) + goto out; + + ret = regmap_update_bits(led->regmap, LM3601X_ENABLE_REG,
drivers/leds/leds-lm3601x.c line 384
Quoted 10 lines
drivers/leds/leds-lm3601x.c new file +10
-0+LM3601X_MODE_IR_DRV , + LM3601X_MODE_IR_DRV); + +out: +mutex_unlock (&led->lock); +return ret; +} + +static int lm3601x_strobe_fault_get (struct led_classdev_flash *fled_cdev, +u32 *fault)
Does the device report only strobe related faults?
drivers/leds/leds-lm3601x.c line 390
Quoted 6 lines
drivers/leds/leds-lm3601x.c new file +6
-0+{ +struct lm3601x_led *led =fled_cdev_to_led (fled_cdev); + +lm3601x_read_faults (led); + + *fault = led->last_flag;
You should translate device specific faults to LED_FAULT* flags. Please compare e.g. drivers/leds/leds-max77693.c or driver/leds/leds-as3645a.c.
Quoted 131 lines
drivers/leds/leds-lm3601x.c new file +131
-0+ +return 0 ; +} + +static const struct led_flash_ops strobe_ops = { + .strobe_set = lm3601x_strobe_set, + .strobe_get = lm3601x_strobe_get, + .timeout_set = lm3601x_strobe_timeout_set, + .fault_get = lm3601x_strobe_fault_get, +}; + +static int lm3601x_register_leds (struct lm3601x_led *led) +{ +struct led_classdev_flash *fled_cdev; +struct led_classdev *led_cdev; +int err = -ENODEV ; + +if (led->torch_node) { + led->cdev_torch.name = led->torch; + led->cdev_torch.max_brightness =LED_FULL ; + led->cdev_torch.brightness_set_blocking = lm3601x_torch_brightness_set; + err =devm_led_classdev_register (&led->client->dev, + &led->cdev_torch); +if (err <0 ) +return err; + } + +if (led->strobe_node) { + fled_cdev = &led->fled_cdev; + fled_cdev->ops = &strobe_ops; + + led_cdev = &fled_cdev->led_cdev; + led_cdev->name = led->strobe; + led_cdev->max_brightness =LED_FULL ; + led_cdev->brightness_set_blocking = lm3601x_strobe_brightness_set; + led_cdev->flags |=LED_DEV_CAP_FLASH ; + + err =led_classdev_flash_register (&led->client->dev, + fled_cdev); +if (err <0 ) +return err; + } + +if (led->ir_node) { + led->cdev_ir.name = led->ir; + led->cdev_ir.max_brightness =LED_FULL ; + led->cdev_ir.brightness_set_blocking = + lm3601x_ir_brightness_set; + + err =devm_led_classdev_register (&led->client->dev, + &led->cdev_ir); + } + +return err; +} + +static void lm3601x_init_flash_timeout (struct lm3601x_led *led) +{ +struct led_flash_setting *setting; + + setting = &led->fled_cdev.timeout; + setting->min = strobe_timeouts[0 ].timeout; + setting->max = led->max_strobe_timeout; + setting->step =40 ; + setting->val = led->max_strobe_timeout; +} + +static int lm3601x_parse_node (struct lm3601x_led *led, +struct device_node *node) +{ +struct device_node *child_node; +const char *name; +int ret = -ENODEV ; + +for_each_available_child_of_node (node, child_node) { +u32 id =0 ; + +of_property_read_u32 (child_node,"reg" , &id); + +switch (id) { +case LM3601X_LED_TORCH : + led->torch_node =of_node_get (child_node); +break ; +case LM3601X_LED_STROBE : + led->strobe_node =of_node_get (child_node); +break ; +case LM3601X_LED_IR : + led->ir_node =of_node_get (child_node); +break ; +default : +dev_warn (&led->client->dev, +"unknown LED %u encountered, ignoring\n" , id); +break ; + } + } + +if (led->torch_node) { + ret =of_property_read_string (led->torch_node,"label" , &name); +if (!ret) +snprintf (led->torch,sizeof (led->torch), +"%s:%s" , led->torch_node->name, name); +else +snprintf (led->torch,sizeof (led->torch), +"%s:torch" , led->torch_node->name); + ret =of_property_read_u32 (led->torch_node,"led-max-microamp" , + &led->torch_current_max); +if (ret <0 ) { + led->torch_current_max =LM3601X_MIN_TORCH_I_UA ; +dev_warn (&led->client->dev, +"led-max-microamp DT property missing\n" ); + } + +of_node_put (led->torch_node); + } + +if (led->strobe_node) { + ret =of_property_read_string (led->strobe_node,"label" , &name); +if (!ret) +snprintf (led->strobe,sizeof (led->strobe), +"%s:%s" , led->strobe_node->name, name); +else +snprintf (led->strobe,sizeof (led->strobe), +"%s::strobe" , led->strobe_node->name); + + ret =of_property_read_u32 (led->strobe_node, +"flash-max-microamp" , + &led->strobe_current_max); +if (ret <0 ) { + led->strobe_current_max =LM3601X_MIN_STROBE_I_MA ; +dev_warn (&led->client->dev, +"flash-max-microamp DT property missing\n" );
drivers/leds/leds-lm3601x.c line 531
Quoted 10 lines
drivers/leds/leds-lm3601x.c new file +10
-0+ } + + ret =of_property_read_u32 (led->strobe_node, +"flash-max-timeout-us" , + &led->max_strobe_timeout); +if (ret <0 ) { + led->max_strobe_timeout = strobe_timeouts[0 ].reg_val; +dev_warn (&led->client->dev, +"flash-max-timeout-us DT property missing\n" ); + }
Common LED bindings state that flash-max-microamp and flash-max-timeout-us properties are mandatory.
Quoted 92 lines
drivers/leds/leds-lm3601x.c new file +91
-0+ +lm3601x_init_flash_timeout (led); + +of_node_put (led->strobe_node); + } + +if (led->ir_node) { + ret =of_property_read_string (led->ir_node,"label" , &name); +if (!ret) +snprintf (led->ir,sizeof (led->ir), +"%s:%s" , led->ir_node->name, name); +else +snprintf (led->ir,sizeof (led->ir), +"%s::infrared" , led->ir_node->name); + +of_node_put (led->ir_node); + } + +return ret; +} + +static int lm3601x_probe (struct i2c_client *client, +const struct i2c_device_id *id) +{ +struct lm3601x_led *led; +int err; + + led =devm_kzalloc (&client->dev, +sizeof (struct lm3601x_led ),GFP_KERNEL ); +if (!led) +return -ENOMEM ; + + err =lm3601x_parse_node (led, client->dev.of_node); +if (err <0 ) +return -ENODEV ; + + led->client = client; + led->regmap =devm_regmap_init_i2c (client, &lm3601x_regmap); +if (IS_ERR (led->regmap)) { + err =PTR_ERR (led->regmap); +dev_err (&client->dev, +"Failed to allocate register map: %d\n" , err); +return err; + } + +mutex_init (&led->lock); +i2c_set_clientdata (client, led); + err =lm3601x_register_leds (led); + +return err; +} + +static int lm3601x_remove (struct i2c_client *client) +{ +struct lm3601x_led *led =i2c_get_clientdata (client); + +regmap_update_bits (led->regmap,LM3601X_ENABLE_REG , +LM3601X_ENABLE_MASK , +LM3601X_MODE_STANDBY ); + +return 0 ; +} + +static const struct i2c_device_id lm3601x_id[] = { + {"LM36010" ,CHIP_LM36010 }, + {"LM36011" ,CHIP_LM36011 }, + { }, +}; +MODULE_DEVICE_TABLE (i2c, lm3601x_id); + +static const struct of_device_id of_lm3601x_leds_match[] = { + { .compatible ="ti,lm36010" , }, + { .compatible ="ti,lm36011" , }, + {}, +}; +MODULE_DEVICE_TABLE (of, of_lm3601x_leds_match); + +static struct i2c_driver lm3601x_i2c_driver = { + .driver = { + .name ="lm3601x" , + .of_match_table = of_lm3601x_leds_match, + }, + .probe = lm3601x_probe, + .remove = lm3601x_remove, + .id_table = lm3601x_id, +}; +module_i2c_driver (lm3601x_i2c_driver); + +MODULE_DESCRIPTION ("Texas Instruments Flash Lighting driver for LM3601X" ); +MODULE_AUTHOR ("Dan Murphy <[email protected]>" ); +MODULE_LICENSE ("GPL v2" );
Signature · 2 lines
Best regards, Jacek Anaszewski
Re: [PATCH v5 2/2] leds: lm3601x: Introduce the lm3601x LED driver
Jacek
Thanks for the review
Quoted 75 lines · Jacek Anaszewski
Hi Dan,
Thank you for the patch.
Quoted 70 lines · Dan Murphy
Introduce the family of LED devices that can
drive a torch, strobe or IR LED.The LED driver can be configured with a strobe
timer to execute a strobe flash. The IR LED
brightness is controlled via the torch brightness
register.The data sheet for each the LM36010 and LM36011
LED drivers can be found here:
http://www.ti.com/product/LM36010
http://www.ti.com/product/LM36011Signed-off-by Dan Murphy <[email protected]>---
v5 - Fixed magic numbers, change reg cache type, added
of_put_nodeto release the dt node ref, and I did not change the remove function to leave the LED in its state on driver removal - https://patchwork.kernel.org/patch/10391741/v4 - Fixed Cocci issue using
ARRAY_SIZE- https://patchwork.kernel.org/patch/10389259/
v3 - removed wildcard dt compatible, fixed copyright, fixed struct doc, removed
RO registers from default, added regmap volatile forFLAGS_REG, updated regmap cache type, fixed unlock and extra semi colon instrobe_set, removed unnecessary out label
in led register and fixed checking of the ret inbrightness_set- https://patchwork.kernel.org/patch/10386243/
v2 - Fixed kbuild issue and removed unusedcdev_strobe- https://patchwork.kernel.org/patch/10384585/drivers/leds/Kconfig | 9 +
drivers/leds/Makefile | 1 +drivers/leds/leds-lm3601x.c| 622 ++++++++++++++++++++++++++++++++++++3 files changed, 632 insertions(+)create mode 100644
drivers/leds/leds-lm3601x.cdrivers/leds/Kconfig +0
-0@@ -145,6 +145,15 @@ config LEDS_LM3692XThis option enables support for the TI LM3692x family of white LED string drivers used for backlighting. +config
LEDS_LM3601X
+ tristate "LED support for LM3601x Chips"
+ depends onLEDS_CLASS&& I2C && OF
+ depends onLEDS_CLASS_FLASH
+ selectREGMAP_I2C
+ help
+ This option enables support for the TI LM3601x family + of flash, torch and indicator classes.
+
configLEDS_LOCOMO
tristate "LED Support for Locomo device" depends onLEDS_CLASSdrivers/leds/Makefile +0
-0@@ -76,6 +76,7 @@ obj-$(CONFIG_LEDS_MLXREG) += leds-mlxreg.oobj-$(CONFIG_LEDS_NIC78BX) += leds-nic78bx.o obj-$(CONFIG_LEDS_MT6323) += leds-mt6323.o obj-$(CONFIG_LEDS_LM3692X) += leds-lm3692x.o +obj-$(CONFIG_LEDS_LM3601X) += leds-lm3601x.o # LED SPI Drivers obj-$(CONFIG_LEDS_DAC124S085) += leds-dac124s085.o
drivers/leds/leds-lm3601x.c new file +0
-0@@ -0,0 +1,622 @@
Quoted 8 lines
drivers/leds/leds-lm3601x.c line 6
Quoted 6 lines
drivers/leds/leds-lm3601x.c new file +6
-0+// SPDX-License-Identifier: GPL-2.0 +/* +* Flash and torch driver for Texas Instruments LM3601X LED +* Flash driver chip family +* Copyright (C) 2018 Texas Instruments Incorporated - http://www.ti.com/ +*/ Please use uniform "//" comment style here.
Is this a LEDs only requirement because I checked a few other files and this is how the license and header is presented.
Unless I missed some new change to source code headers. And the documentation does not dictate any change to this.
Quoted 305 lines
Quoted 305 lines
drivers/leds/leds-lm3601x.c new file +304
-0+#include <linux/delay.h> +#include <linux/i2c.h> +#include <linux/leds.h> +#include <linux/led-class-flash.h> +#include <linux/module.h> +#include <linux/regmap.h> +#include <linux/slab.h> +#include <uapi/linux/uleds.h> + +#define LM3601X_LED_TORCH 0x0 +#define LM3601X_LED_STROBE 0x1 +#define LM3601X_LED_IR 0x2 + +/* Registers */ +#define LM3601X_ENABLE_REG 0x01 +#define LM3601X_CFG_REG 0x02 +#define LM3601X_LED_FLASH_REG 0x03 +#define LM3601X_LED_TORCH_REG 0x04 +#define LM3601X_FLAGS_REG 0x05 +#define LM3601X_DEV_ID_REG 0x06 + +#define LM3601X_SW_RESET BIT(7) + +/* Enable Mode bits */ +#define LM3601X_MODE_STANDBY 0x00 +#define LM3601X_MODE_IR_DRV BIT(0) +#define LM3601X_MODE_TORCH BIT(1) +#define LM3601X_MODE_STROBE (BIT(0) | BIT(1)) +#define LM3601X_STRB_EN BIT(2) +#define LM3601X_STRB_LVL_TRIG ~BIT(3) +#define LM3601X_STRB_EDGE_TRIG BIT(3) +#define LM3601X_IVFM_EN BIT(4) + +#define LM36010_BOOST_LIMIT_19 ~BIT(5) +#define LM36010_BOOST_LIMIT_28 BIT(5) +#define LM36010_BOOST_FREQ_2MHZ ~BIT(6) +#define LM36010_BOOST_FREQ_4MHZ BIT(6) +#define LM36010_BOOST_MODE_NORM ~BIT(7) +#define LM36010_BOOST_MODE_PASS BIT(7) + +/* Flag Mask */ +#define LM3601X_FLASH_TIME_OUT BIT(0) +#define LM3601X_UVLO_FAULT BIT(1) +#define LM3601X_THERM_SHUTDOWN BIT(2) +#define LM3601X_THERM_CURR BIT(3) +#define LM36010_CURR_LIMIT BIT(4) +#define LM3601X_SHORT_FAULT BIT(5) +#define LM3601X_IVFM_TRIP BIT(6) +#define LM36010_OVP_FAULT BIT(7) + +#define LM3601X_MIN_TORCH_I_UA 2400 +#define LM3601X_MIN_STROBE_I_MA 11 + +#define LM3601X_TIMEOUT_MASK 0x1e +#define LM3601X_ENABLE_MASK 0x03 + +enum lm3601x_type { + CHIP_LM36010 = 0, + CHIP_LM36011, +}; + +/** +* struct lm3601x_max_timeouts - +* @timeout: timeout value in ms +* @regval: the value of the register to write +*/ +struct lm3601x_max_timeouts { + int timeout; + int reg_val; +}; + +/** +* struct lm3601x_led - +* @lock: Lock for reading/writing the device +* @regmap: Devices register map +* @client: Pointer to the I2C client +* @cdev_torch: led class device pointer for the torch +* @cdev_ir: led class device pointer for infrared +* @fled_cdev: flash led class device pointer +* @strobe_node: DT device node for the strobe +* @torch: LED label for the torch +* @strobe: LED label for the strobe +* @ir: LED label for the infrared +* @last_flag: last known flags register value +* @strobe_timeout: the timeout for the strobe +* @torch_current_max: maximum current for the torch +* @strobe_current_max: maximum current for the strobe +* @max_strobe_timeout: maximum timeout for the strobe +*/ +struct lm3601x_led { + struct mutex lock; + struct regmap *regmap; + struct i2c_client *client; + + struct led_classdev cdev_torch; + struct led_classdev cdev_ir; + + struct led_classdev_flash fled_cdev; + + struct device_node *strobe_node; + struct device_node *torch_node; + struct device_node *ir_node; + + char torch[LED_MAX_NAME_SIZE]; + char strobe[LED_MAX_NAME_SIZE]; + char ir[LED_MAX_NAME_SIZE]; + + unsigned int last_flag; + unsigned int strobe_timeout; + + u32 torch_current_max; + u32 strobe_current_max; + u32 max_strobe_timeout; +}; + +static const struct lm3601x_max_timeouts strobe_timeouts[] = { + { 40, 0x00 }, + { 80, 0x01 }, + { 120, 0x02 }, + { 160, 0x03 }, + { 200, 0x04 }, + { 240, 0x05 }, + { 280, 0x06 }, + { 320, 0x07 }, + { 360, 0x08 }, + { 400, 0x09 }, + { 600, 0x0a }, + { 800, 0x0b }, + { 1000, 0x0c }, + { 1200, 0x0d }, + { 1400, 0x0e }, + { 1600, 0x0f }, +}; + +static const struct reg_default lm3601x_regmap_defs[] = { + { LM3601X_ENABLE_REG, 0x20 }, + { LM3601X_CFG_REG, 0x15 }, + { LM3601X_LED_FLASH_REG, 0x00 }, + { LM3601X_LED_TORCH_REG, 0x00 }, +}; + +static bool lm3601x_volatile_reg (struct device *dev,unsigned int reg) +{ + switch (reg) { + case LM3601X_FLAGS_REG: + return true; + default: + return false; + } +} + +static const struct regmap_config lm3601x_regmap = { + .reg_bits = 8, + .val_bits = 8, + + .max_register = LM3601X_DEV_ID_REG, + .reg_defaults = lm3601x_regmap_defs, + .num_reg_defaults = ARRAY_SIZE(lm3601x_regmap_defs), + .cache_type = REGCACHE_RBTREE, + .volatile_reg = lm3601x_volatile_reg, +}; + +static struct lm3601x_led *fled_cdev_to_led ( + struct led_classdev_flash *fled_cdev) +{ + return container_of(fled_cdev, struct lm3601x_led, fled_cdev); +} + +static int lm3601x_read_faults (struct lm3601x_led *led) +{ + int flags_val; + int ret; + + ret = regmap_read(led->regmap, LM3601X_FLAGS_REG, &flags_val); + if (ret < 0) + return -EIO; + + led->last_flag = flags_val; + + return led->last_flag; +} + +static int lm3601x_torch_brightness_set (struct led_classdev *cdev, + enum led_brightness brightness) +{ + struct lm3601x_led *led = + container_of(cdev, struct lm3601x_led, cdev_torch); + int ret; + u8 brightness_val; + + mutex_lock(&led->lock); + + ret = lm3601x_read_faults(led); + if (ret < 0) + goto out; + + if (brightness == LED_OFF) { + ret = regmap_update_bits(led->regmap, LM3601X_ENABLE_REG, + LM3601X_MODE_TORCH, LED_OFF); + goto out; + } + + if (brightness == LED_ON) + brightness_val = LED_ON; + else + brightness_val = (brightness/2); + + ret = regmap_write(led->regmap, LM3601X_LED_TORCH_REG, brightness_val); + if (ret < 0) + goto out; + + ret = regmap_update_bits(led->regmap, LM3601X_ENABLE_REG, + LM3601X_MODE_TORCH, + LM3601X_MODE_TORCH); + +out: + mutex_unlock(&led->lock); + return ret; +} + +static int lm3601x_strobe_set (struct led_classdev_flash *fled_cdev, + bool state) +{ + struct lm3601x_led *led = fled_cdev_to_led(fled_cdev); + int ret; + int current_timeout; + int reg_count; + int i; + int timeout_reg_val = 0; + + mutex_lock(&led->lock); + + ret = regmap_read(led->regmap, LM3601X_CFG_REG, ¤t_timeout); + if (ret < 0) + goto out; + + reg_count = ARRAY_SIZE(strobe_timeouts); + for (i = 0; i < reg_count; i++) { + if (led->strobe_timeout > strobe_timeouts[i].timeout) + continue; + + if (led->strobe_timeout <= strobe_timeouts[i].timeout) { + timeout_reg_val = (strobe_timeouts[i].reg_val << 1); + break; + } + + ret = -EINVAL; + goto out; + } + + if (led->strobe_timeout != current_timeout) + ret = regmap_update_bits(led->regmap, LM3601X_CFG_REG, + LM3601X_TIMEOUT_MASK, timeout_reg_val); + + if (state) + ret = regmap_update_bits(led->regmap, LM3601X_ENABLE_REG, + LM3601X_MODE_STROBE, + LM3601X_MODE_STROBE); + else + ret = regmap_update_bits(led->regmap, LM3601X_ENABLE_REG, + LM3601X_MODE_STROBE, LED_OFF); + + ret = lm3601x_read_faults(led); +out: + mutex_unlock(&led->lock); + return ret; +} + +static int lm3601x_strobe_brightness_set (struct led_classdev *cdev, + enum led_brightness brightness) +{ + struct led_classdev_flash *fled_cdev = lcdev_to_flcdev(cdev); + struct lm3601x_led *led = fled_cdev_to_led(fled_cdev); + int ret; + u8 brightness_val; + + mutex_lock(&led->lock); + ret = lm3601x_read_faults(led); + if (ret < 0) + goto out; + + if (brightness == LED_OFF) { + ret = regmap_update_bits(led->regmap, LM3601X_ENABLE_REG, + LM3601X_MODE_STROBE, LED_OFF); + goto out; + } + + if (brightness == LED_ON) + brightness_val = LED_ON; + else + brightness_val = (brightness/2); + + ret = regmap_write(led->regmap, LM3601X_LED_FLASH_REG, brightness_val); + +out: + mutex_unlock(&led->lock); + return ret; +} + +static int lm3601x_strobe_timeout_set (struct led_classdev_flash *fled_cdev, + u32 timeout) +{ + struct lm3601x_led *led = fled_cdev_to_led(fled_cdev); + int ret = 0;
Quoted 8 lines
drivers/leds/leds-lm3601x.c line 316
Quoted 5 lines
drivers/leds/leds-lm3601x.c new file +5
-0+ + mutex_lock(&led->lock); + + if (timeout > led->max_strobe_timeout) + ret = -EINVAL;LED flash core takes care of clamping timeout setting according to the defined constraints.
OK
Quoted 63 lines
Quoted 63 lines
drivers/leds/leds-lm3601x.c new file +62
-0+ else + led->strobe_timeout = timeout; + + mutex_unlock(&led->lock); + + return ret; +} + +static int lm3601x_strobe_get (struct led_classdev_flash *fled_cdev, + bool *state) +{ + struct lm3601x_led *led = fled_cdev_to_led(fled_cdev); + int ret; + int strobe_state; + + mutex_lock(&led->lock); + + ret = regmap_read(led->regmap, LM3601X_ENABLE_REG, &strobe_state); + if (ret < 0) + goto out; + + *state = strobe_state & LM3601X_MODE_STROBE; + +out: + mutex_unlock(&led->lock); + return ret; +} + +static int lm3601x_ir_brightness_set (struct led_classdev *cdev, + enum led_brightness brightness) +{ + struct lm3601x_led *led = + container_of(cdev, struct lm3601x_led, cdev_ir); + int ret; + u8 brightness_val; + + mutex_lock(&led->lock); + ret = lm3601x_read_faults(led); + if (ret < 0) + goto out; + + if (brightness == LED_OFF) { + ret = regmap_update_bits(led->regmap, LM3601X_ENABLE_REG, + LM3601X_LED_IR, + LED_OFF); + goto out; + } + + if (brightness == LED_ON) + brightness_val = LED_ON; + else + brightness_val = (brightness/2); + + ret = regmap_write(led->regmap, LM3601X_LED_FLASH_REG, brightness_val); + if (ret < 0) + goto out; + + ret = regmap_update_bits(led->regmap, LM3601X_ENABLE_REG, + LM3601X_MODE_IR_DRV, + LM3601X_MODE_IR_DRV); + +out:
Quoted 8 lines
drivers/leds/leds-lm3601x.c line 384
Quoted 6 lines
drivers/leds/leds-lm3601x.c new file +6
-0+ mutex_unlock(&led->lock); + return ret; +} + +static int lm3601x_strobe_fault_get (struct led_classdev_flash *fled_cdev, + u32 *fault)Does the device report only strobe related faults?
No. It has under/over voltage and thermal.
Quoted 11 lines
drivers/leds/leds-lm3601x.c line 390
Quoted 7 lines
drivers/leds/leds-lm3601x.c new file +6
-0+{ + struct lm3601x_led *led = fled_cdev_to_led(fled_cdev); + + lm3601x_read_faults(led); + + *fault = led->last_flag;You should translate device specific faults to LED_FAULT* flags. Please compare e.g.
drivers/leds/leds-max77693.cordriver/leds/leds-as3645a.c.
Hmm. This code is in the max77693.c. I think the translation should be in the read_faults function in this file and not here.
I will add that translation above
Quoted 137 lines
Quoted 137 lines
drivers/leds/leds-lm3601x.c new file +136
-0+ + return 0; +} + +static const struct led_flash_ops strobe_ops = { + .strobe_set = lm3601x_strobe_set, + .strobe_get = lm3601x_strobe_get, + .timeout_set = lm3601x_strobe_timeout_set, + .fault_get = lm3601x_strobe_fault_get, +}; + +static int lm3601x_register_leds (struct lm3601x_led *led) +{ + struct led_classdev_flash *fled_cdev; + struct led_classdev *led_cdev; + int err = -ENODEV; + + if (led->torch_node) { + led->cdev_torch.name = led->torch; + led->cdev_torch.max_brightness = LED_FULL; + led->cdev_torch.brightness_set_blocking = lm3601x_torch_brightness_set; + err = devm_led_classdev_register(&led->client->dev, + &led->cdev_torch); + if (err < 0) + return err; + } + + if (led->strobe_node) { + fled_cdev = &led->fled_cdev; + fled_cdev->ops = &strobe_ops; + + led_cdev = &fled_cdev->led_cdev; + led_cdev->name = led->strobe; + led_cdev->max_brightness = LED_FULL; + led_cdev->brightness_set_blocking = lm3601x_strobe_brightness_set; + led_cdev->flags |= LED_DEV_CAP_FLASH; + + err = led_classdev_flash_register(&led->client->dev, + fled_cdev); + if (err < 0) + return err; + } + + if (led->ir_node) { + led->cdev_ir.name = led->ir; + led->cdev_ir.max_brightness = LED_FULL; + led->cdev_ir.brightness_set_blocking = + lm3601x_ir_brightness_set; + + err = devm_led_classdev_register(&led->client->dev, + &led->cdev_ir); + } + + return err; +} + +static void lm3601x_init_flash_timeout (struct lm3601x_led *led) +{ + struct led_flash_setting *setting; + + setting = &led->fled_cdev.timeout; + setting->min = strobe_timeouts[0].timeout; + setting->max = led->max_strobe_timeout; + setting->step = 40; + setting->val = led->max_strobe_timeout; +} + +static int lm3601x_parse_node (struct lm3601x_led *led, + struct device_node *node) +{ + struct device_node *child_node; + const char *name; + int ret = -ENODEV; + + for_each_available_child_of_node(node, child_node) { + u32 id = 0; + + of_property_read_u32(child_node, "reg", &id); + + switch (id) { + case LM3601X_LED_TORCH: + led->torch_node = of_node_get(child_node); + break; + case LM3601X_LED_STROBE: + led->strobe_node = of_node_get(child_node); + break; + case LM3601X_LED_IR: + led->ir_node = of_node_get(child_node); + break; + default: + dev_warn(&led->client->dev, + "unknown LED %u encountered, ignoring\n", id); + break; + } + } + + if (led->torch_node) { + ret = of_property_read_string(led->torch_node, "label", &name); + if (!ret) + snprintf(led->torch, sizeof(led->torch), + "%s:%s", led->torch_node->name, name); + else + snprintf(led->torch, sizeof(led->torch), + "%s:torch", led->torch_node->name); + ret = of_property_read_u32(led->torch_node, "led-max-microamp", + &led->torch_current_max); + if (ret < 0) { + led->torch_current_max = LM3601X_MIN_TORCH_I_UA; + dev_warn(&led->client->dev, + "led-max-microamp DT property missing\n"); + } + + of_node_put(led->torch_node); + } + + if (led->strobe_node) { + ret = of_property_read_string(led->strobe_node, "label", &name); + if (!ret) + snprintf(led->strobe, sizeof(led->strobe), + "%s:%s", led->strobe_node->name, name); + else + snprintf(led->strobe, sizeof(led->strobe), + "%s::strobe", led->strobe_node->name); + + ret = of_property_read_u32(led->strobe_node, + "flash-max-microamp", + &led->strobe_current_max); + if (ret < 0) { + led->strobe_current_max = LM3601X_MIN_STROBE_I_MA; + dev_warn(&led->client->dev, + "flash-max-microamp DT property missing\n"); + } + + ret = of_property_read_u32(led->strobe_node, + "flash-max-timeout-us", + &led->max_strobe_timeout);
Quoted 8 lines
drivers/leds/leds-lm3601x.c line 531
Quoted 5 lines
drivers/leds/leds-lm3601x.c new file +5
-0+ if (ret < 0) { + led->max_strobe_timeout = strobe_timeouts[0].reg_val; + dev_warn(&led->client->dev, + "flash-max-timeout-us DT property missing\n"); + }Common LED bindings state that flash-max-microamp and flash-max-timeout-us properties are mandatory.
OK.
Quoted 94 lines
Quoted 93 lines
drivers/leds/leds-lm3601x.c new file +91
-0+ + lm3601x_init_flash_timeout(led); + + of_node_put(led->strobe_node); + } + + if (led->ir_node) { + ret = of_property_read_string(led->ir_node, "label", &name); + if (!ret) + snprintf(led->ir, sizeof(led->ir), + "%s:%s", led->ir_node->name, name); + else + snprintf(led->ir, sizeof(led->ir), + "%s::infrared", led->ir_node->name); + + of_node_put(led->ir_node); + } + + return ret; +} + +static int lm3601x_probe (struct i2c_client *client, + const struct i2c_device_id *id) +{ + struct lm3601x_led *led; + int err; + + led = devm_kzalloc(&client->dev, + sizeof(struct lm3601x_led), GFP_KERNEL); + if (!led) + return -ENOMEM; + + err = lm3601x_parse_node(led, client->dev.of_node); + if (err < 0) + return -ENODEV; + + led->client = client; + led->regmap = devm_regmap_init_i2c(client, &lm3601x_regmap); + if (IS_ERR(led->regmap)) { + err = PTR_ERR(led->regmap); + dev_err(&client->dev, + "Failed to allocate register map: %d\n", err); + return err; + } + + mutex_init(&led->lock); + i2c_set_clientdata(client, led); + err = lm3601x_register_leds(led); + + return err; +} + +static int lm3601x_remove (struct i2c_client *client) +{ + struct lm3601x_led *led = i2c_get_clientdata(client); + + regmap_update_bits(led->regmap, LM3601X_ENABLE_REG, + LM3601X_ENABLE_MASK, + LM3601X_MODE_STANDBY); + + return 0; +} + +static const struct i2c_device_id lm3601x_id[] = { + { "LM36010", CHIP_LM36010 }, + { "LM36011", CHIP_LM36011 }, + { }, +}; +MODULE_DEVICE_TABLE (i2c, lm3601x_id); + +static const struct of_device_id of_lm3601x_leds_match[] = { + { .compatible = "ti,lm36010", }, + { .compatible = "ti,lm36011", }, + {}, +}; +MODULE_DEVICE_TABLE (of, of_lm3601x_leds_match); + +static struct i2c_driver lm3601x_i2c_driver = { + .driver = { + .name = "lm3601x", + .of_match_table = of_lm3601x_leds_match, + }, + .probe = lm3601x_probe, + .remove = lm3601x_remove, + .id_table = lm3601x_id, +}; +module_i2c_driver (lm3601x_i2c_driver); + +MODULE_DESCRIPTION ("Texas Instruments Flash Lighting driver for LM3601X" ); +MODULE_AUTHOR ("Dan Murphy <[email protected]>" ); +MODULE_LICENSE ("GPL v2" );
Signature · 2 lines
------------------ Dan Murphy
Re: [PATCH v5 2/2] leds: lm3601x: Introduce the lm3601x LED driver
Hi Dan,
Quoted 89 lines · Dan Murphy
Jacek
Thanks for the review
Quoted 75 lines · Jacek Anaszewski
Hi Dan,
Thank you for the patch.
Quoted 70 lines · Dan Murphy
Introduce the family of LED devices that can
drive a torch, strobe or IR LED.The LED driver can be configured with a strobe
timer to execute a strobe flash. The IR LED
brightness is controlled via the torch brightness
register.The data sheet for each the LM36010 and LM36011
LED drivers can be found here:
http://www.ti.com/product/LM36010
http://www.ti.com/product/LM36011Signed-off-by Dan Murphy <[email protected]>---
v5 - Fixed magic numbers, change reg cache type, added
of_put_nodeto release the dt node ref, and I did not change the remove function to leave the LED in its state on driver removal - https://patchwork.kernel.org/patch/10391741/v4 - Fixed Cocci issue using
ARRAY_SIZE- https://patchwork.kernel.org/patch/10389259/
v3 - removed wildcard dt compatible, fixed copyright, fixed struct doc, removed
RO registers from default, added regmap volatile forFLAGS_REG, updated regmap cache type, fixed unlock and extra semi colon instrobe_set, removed unnecessary out label
in led register and fixed checking of the ret inbrightness_set- https://patchwork.kernel.org/patch/10386243/
v2 - Fixed kbuild issue and removed unusedcdev_strobe- https://patchwork.kernel.org/patch/10384585/drivers/leds/Kconfig | 9 + drivers/leds/Makefile | 1 + drivers/leds/leds-lm3601x.c | 622 ++++++++++++++++++++++++++++++++++++ 3 files changed, 632 insertions(+)create mode 100644
drivers/leds/leds-lm3601x.cdrivers/leds/Kconfig +8
-0@@ -145,6 +145,15 @@ config LEDS_LM3692X This option enables support for the TI LM3692x family of white LED string drivers used for backlighting. +config LEDS_LM3601X + tristate "LED support for LM3601x Chips" + depends on LEDS_CLASS && I2C && OF + depends on LEDS_CLASS_FLASH + select REGMAP_I2C + help + This option enables support for the TI LM3601x family + of flash, torch and indicator classes. + config LEDS_LOCOMO tristate "LED Support for Locomo device" depends on LEDS_CLASSdrivers/leds/Makefile +1
-0@@ -76,6 +76,7 @@ obj-$(CONFIG_LEDS_MLXREG) += leds-mlxreg.o obj-$(CONFIG_LEDS_NIC78BX) += leds-nic78bx.o obj-$(CONFIG_LEDS_MT6323) += leds-mt6323.o obj-$(CONFIG_LEDS_LM3692X) += leds-lm3692x.o +obj-$(CONFIG_LEDS_LM3601X) += leds-lm3601x.o # LED SPI Drivers obj-$(CONFIG_LEDS_DAC124S085) += leds-dac124s085.odrivers/leds/leds-lm3601x.c new file +0
-0@@ -0,0 +1,622 @@Quoted 8 lines
drivers/leds/leds-lm3601x.c line 6
Quoted 6 lines
drivers/leds/leds-lm3601x.c new file +6
-0+// SPDX-License-Identifier: GPL-2.0 +/* +* Flash and torch driver for Texas Instruments LM3601X LED +* Flash driver chip family +* Copyright (C) 2018 Texas Instruments Incorporated - http://www.ti.com/ +*/ Please use uniform "//" comment style here.
Quoted 5 lines
Is this a LEDs only requirement because I checked a few other files and this is how the license and header is presented.
Unless I missed some new change to source code headers. And the documentation does not dictate any change to this.
I started to require this since mixed comment styles look just awkward to me. Moreover Linus also suggested it in [0]:
"And yes, feel free to replace block comments with // while at it."
Also grep shows the same approach at least in the sound subsystem :-)
Quoted 388 lines
Quoted 305 lines
Quoted 305 lines
drivers/leds/leds-lm3601x.c new file +304
-0+#include <linux/delay.h> +#include <linux/i2c.h> +#include <linux/leds.h> +#include <linux/led-class-flash.h> +#include <linux/module.h> +#include <linux/regmap.h> +#include <linux/slab.h> +#include <uapi/linux/uleds.h> + +#define LM3601X_LED_TORCH 0x0 +#define LM3601X_LED_STROBE 0x1 +#define LM3601X_LED_IR 0x2 + +/* Registers */ +#define LM3601X_ENABLE_REG 0x01 +#define LM3601X_CFG_REG 0x02 +#define LM3601X_LED_FLASH_REG 0x03 +#define LM3601X_LED_TORCH_REG 0x04 +#define LM3601X_FLAGS_REG 0x05 +#define LM3601X_DEV_ID_REG 0x06 + +#define LM3601X_SW_RESET BIT(7) + +/* Enable Mode bits */ +#define LM3601X_MODE_STANDBY 0x00 +#define LM3601X_MODE_IR_DRV BIT(0) +#define LM3601X_MODE_TORCH BIT(1) +#define LM3601X_MODE_STROBE (BIT(0) | BIT(1)) +#define LM3601X_STRB_EN BIT(2) +#define LM3601X_STRB_LVL_TRIG ~BIT(3) +#define LM3601X_STRB_EDGE_TRIG BIT(3) +#define LM3601X_IVFM_EN BIT(4) + +#define LM36010_BOOST_LIMIT_19 ~BIT(5) +#define LM36010_BOOST_LIMIT_28 BIT(5) +#define LM36010_BOOST_FREQ_2MHZ ~BIT(6) +#define LM36010_BOOST_FREQ_4MHZ BIT(6) +#define LM36010_BOOST_MODE_NORM ~BIT(7) +#define LM36010_BOOST_MODE_PASS BIT(7) + +/* Flag Mask */ +#define LM3601X_FLASH_TIME_OUT BIT(0) +#define LM3601X_UVLO_FAULT BIT(1) +#define LM3601X_THERM_SHUTDOWN BIT(2) +#define LM3601X_THERM_CURR BIT(3) +#define LM36010_CURR_LIMIT BIT(4) +#define LM3601X_SHORT_FAULT BIT(5) +#define LM3601X_IVFM_TRIP BIT(6) +#define LM36010_OVP_FAULT BIT(7) + +#define LM3601X_MIN_TORCH_I_UA 2400 +#define LM3601X_MIN_STROBE_I_MA 11 + +#define LM3601X_TIMEOUT_MASK 0x1e +#define LM3601X_ENABLE_MASK 0x03 + +enum lm3601x_type { + CHIP_LM36010 = 0, + CHIP_LM36011, +}; + +/** +* struct lm3601x_max_timeouts - +* @timeout: timeout value in ms +* @regval: the value of the register to write +*/ +struct lm3601x_max_timeouts { + int timeout; + int reg_val; +}; + +/** +* struct lm3601x_led - +* @lock: Lock for reading/writing the device +* @regmap: Devices register map +* @client: Pointer to the I2C client +* @cdev_torch: led class device pointer for the torch +* @cdev_ir: led class device pointer for infrared +* @fled_cdev: flash led class device pointer +* @strobe_node: DT device node for the strobe +* @torch: LED label for the torch +* @strobe: LED label for the strobe +* @ir: LED label for the infrared +* @last_flag: last known flags register value +* @strobe_timeout: the timeout for the strobe +* @torch_current_max: maximum current for the torch +* @strobe_current_max: maximum current for the strobe +* @max_strobe_timeout: maximum timeout for the strobe +*/ +struct lm3601x_led { + struct mutex lock; + struct regmap *regmap; + struct i2c_client *client; + + struct led_classdev cdev_torch; + struct led_classdev cdev_ir; + + struct led_classdev_flash fled_cdev; + + struct device_node *strobe_node; + struct device_node *torch_node; + struct device_node *ir_node; + + char torch[LED_MAX_NAME_SIZE]; + char strobe[LED_MAX_NAME_SIZE]; + char ir[LED_MAX_NAME_SIZE]; + + unsigned int last_flag; + unsigned int strobe_timeout; + + u32 torch_current_max; + u32 strobe_current_max; + u32 max_strobe_timeout; +}; + +static const struct lm3601x_max_timeouts strobe_timeouts[] = { + { 40, 0x00 }, + { 80, 0x01 }, + { 120, 0x02 }, + { 160, 0x03 }, + { 200, 0x04 }, + { 240, 0x05 }, + { 280, 0x06 }, + { 320, 0x07 }, + { 360, 0x08 }, + { 400, 0x09 }, + { 600, 0x0a }, + { 800, 0x0b }, + { 1000, 0x0c }, + { 1200, 0x0d }, + { 1400, 0x0e }, + { 1600, 0x0f }, +}; + +static const struct reg_default lm3601x_regmap_defs[] = { + { LM3601X_ENABLE_REG, 0x20 }, + { LM3601X_CFG_REG, 0x15 }, + { LM3601X_LED_FLASH_REG, 0x00 }, + { LM3601X_LED_TORCH_REG, 0x00 }, +}; + +static bool lm3601x_volatile_reg (struct device *dev,unsigned int reg) +{ + switch (reg) { + case LM3601X_FLAGS_REG: + return true; + default: + return false; + } +} + +static const struct regmap_config lm3601x_regmap = { + .reg_bits = 8, + .val_bits = 8, + + .max_register = LM3601X_DEV_ID_REG, + .reg_defaults = lm3601x_regmap_defs, + .num_reg_defaults = ARRAY_SIZE(lm3601x_regmap_defs), + .cache_type = REGCACHE_RBTREE, + .volatile_reg = lm3601x_volatile_reg, +}; + +static struct lm3601x_led *fled_cdev_to_led ( + struct led_classdev_flash *fled_cdev) +{ + return container_of(fled_cdev, struct lm3601x_led, fled_cdev); +} + +static int lm3601x_read_faults (struct lm3601x_led *led) +{ + int flags_val; + int ret; + + ret = regmap_read(led->regmap, LM3601X_FLAGS_REG, &flags_val); + if (ret < 0) + return -EIO; + + led->last_flag = flags_val; + + return led->last_flag; +} + +static int lm3601x_torch_brightness_set (struct led_classdev *cdev, + enum led_brightness brightness) +{ + struct lm3601x_led *led = + container_of(cdev, struct lm3601x_led, cdev_torch); + int ret; + u8 brightness_val; + + mutex_lock(&led->lock); + + ret = lm3601x_read_faults(led); + if (ret < 0) + goto out; + + if (brightness == LED_OFF) { + ret = regmap_update_bits(led->regmap, LM3601X_ENABLE_REG, + LM3601X_MODE_TORCH, LED_OFF); + goto out; + } + + if (brightness == LED_ON) + brightness_val = LED_ON; + else + brightness_val = (brightness/2); + + ret = regmap_write(led->regmap, LM3601X_LED_TORCH_REG, brightness_val); + if (ret < 0) + goto out; + + ret = regmap_update_bits(led->regmap, LM3601X_ENABLE_REG, + LM3601X_MODE_TORCH, + LM3601X_MODE_TORCH); + +out: + mutex_unlock(&led->lock); + return ret; +} + +static int lm3601x_strobe_set (struct led_classdev_flash *fled_cdev, + bool state) +{ + struct lm3601x_led *led = fled_cdev_to_led(fled_cdev); + int ret; + int current_timeout; + int reg_count; + int i; + int timeout_reg_val = 0; + + mutex_lock(&led->lock); + + ret = regmap_read(led->regmap, LM3601X_CFG_REG, ¤t_timeout); + if (ret < 0) + goto out; + + reg_count = ARRAY_SIZE(strobe_timeouts); + for (i = 0; i < reg_count; i++) { + if (led->strobe_timeout > strobe_timeouts[i].timeout) + continue; + + if (led->strobe_timeout <= strobe_timeouts[i].timeout) { + timeout_reg_val = (strobe_timeouts[i].reg_val << 1); + break; + } + + ret = -EINVAL; + goto out; + } + + if (led->strobe_timeout != current_timeout) + ret = regmap_update_bits(led->regmap, LM3601X_CFG_REG, + LM3601X_TIMEOUT_MASK, timeout_reg_val); + + if (state) + ret = regmap_update_bits(led->regmap, LM3601X_ENABLE_REG, + LM3601X_MODE_STROBE, + LM3601X_MODE_STROBE); + else + ret = regmap_update_bits(led->regmap, LM3601X_ENABLE_REG, + LM3601X_MODE_STROBE, LED_OFF); + + ret = lm3601x_read_faults(led); +out: + mutex_unlock(&led->lock); + return ret; +} + +static int lm3601x_strobe_brightness_set (struct led_classdev *cdev, + enum led_brightness brightness) +{ + struct led_classdev_flash *fled_cdev = lcdev_to_flcdev(cdev); + struct lm3601x_led *led = fled_cdev_to_led(fled_cdev); + int ret; + u8 brightness_val; + + mutex_lock(&led->lock); + ret = lm3601x_read_faults(led); + if (ret < 0) + goto out; + + if (brightness == LED_OFF) { + ret = regmap_update_bits(led->regmap, LM3601X_ENABLE_REG, + LM3601X_MODE_STROBE, LED_OFF); + goto out; + } + + if (brightness == LED_ON) + brightness_val = LED_ON; + else + brightness_val = (brightness/2); + + ret = regmap_write(led->regmap, LM3601X_LED_FLASH_REG, brightness_val); + +out: + mutex_unlock(&led->lock); + return ret; +} + +static int lm3601x_strobe_timeout_set (struct led_classdev_flash *fled_cdev, + u32 timeout) +{ + struct lm3601x_led *led = fled_cdev_to_led(fled_cdev); + int ret = 0;Quoted 8 lines
drivers/leds/leds-lm3601x.c line 316
Quoted 5 lines
drivers/leds/leds-lm3601x.c new file +5
-0+ + mutex_lock(&led->lock); + + if (timeout > led->max_strobe_timeout) + ret = -EINVAL;LED flash core takes care of clamping timeout setting according to the defined constraints.
OK
Quoted 63 lines
Quoted 63 lines
drivers/leds/leds-lm3601x.c new file +62
-0+ else + led->strobe_timeout = timeout; + + mutex_unlock(&led->lock); + + return ret; +} + +static int lm3601x_strobe_get (struct led_classdev_flash *fled_cdev, + bool *state) +{ + struct lm3601x_led *led = fled_cdev_to_led(fled_cdev); + int ret; + int strobe_state; + + mutex_lock(&led->lock); + + ret = regmap_read(led->regmap, LM3601X_ENABLE_REG, &strobe_state); + if (ret < 0) + goto out; + + *state = strobe_state & LM3601X_MODE_STROBE; + +out: + mutex_unlock(&led->lock); + return ret; +} + +static int lm3601x_ir_brightness_set (struct led_classdev *cdev, + enum led_brightness brightness) +{ + struct lm3601x_led *led = + container_of(cdev, struct lm3601x_led, cdev_ir); + int ret; + u8 brightness_val; + + mutex_lock(&led->lock); + ret = lm3601x_read_faults(led); + if (ret < 0) + goto out; + + if (brightness == LED_OFF) { + ret = regmap_update_bits(led->regmap, LM3601X_ENABLE_REG, + LM3601X_LED_IR, + LED_OFF); + goto out; + } + + if (brightness == LED_ON) + brightness_val = LED_ON; + else + brightness_val = (brightness/2); + + ret = regmap_write(led->regmap, LM3601X_LED_FLASH_REG, brightness_val); + if (ret < 0) + goto out; + + ret = regmap_update_bits(led->regmap, LM3601X_ENABLE_REG, + LM3601X_MODE_IR_DRV, + LM3601X_MODE_IR_DRV); + +out:Quoted 8 lines
drivers/leds/leds-lm3601x.c line 384
Quoted 6 lines
drivers/leds/leds-lm3601x.c new file +6
-0+ mutex_unlock(&led->lock); + return ret; +} + +static int lm3601x_strobe_fault_get (struct led_classdev_flash *fled_cdev, + u32 *fault)Does the device report only strobe related faults?
Quoted 1 line
No. It has under/over voltage and thermal.
I'd remove "strobe" from the function name then.
Quoted 11 lines
Quoted 10 lines
drivers/leds/leds-lm3601x.c line 390
Quoted 6 lines
drivers/leds/leds-lm3601x.c new file +6
-0+{ + struct lm3601x_led *led = fled_cdev_to_led(fled_cdev); + + lm3601x_read_faults(led); + + *fault = led->last_flag;You should translate device specific faults to LED_FAULT* flags. Please compare e.g.
drivers/leds/leds-max77693.cordriver/leds/leds-as3645a.c.
Quoted 2 lines
Hmm. This code is in the
max77693.c. I think the translation should be in theread_faultsfunction in this file and not here.
Correct.
Quoted 148 lines
I will add that translation above
Quoted 137 lines
Quoted 137 lines
drivers/leds/leds-lm3601x.c new file +136
-0+ + return 0; +} + +static const struct led_flash_ops strobe_ops = { + .strobe_set = lm3601x_strobe_set, + .strobe_get = lm3601x_strobe_get, + .timeout_set = lm3601x_strobe_timeout_set, + .fault_get = lm3601x_strobe_fault_get, +}; + +static int lm3601x_register_leds (struct lm3601x_led *led) +{ + struct led_classdev_flash *fled_cdev; + struct led_classdev *led_cdev; + int err = -ENODEV; + + if (led->torch_node) { + led->cdev_torch.name = led->torch; + led->cdev_torch.max_brightness = LED_FULL; + led->cdev_torch.brightness_set_blocking = lm3601x_torch_brightness_set; + err = devm_led_classdev_register(&led->client->dev, + &led->cdev_torch); + if (err < 0) + return err; + } + + if (led->strobe_node) { + fled_cdev = &led->fled_cdev; + fled_cdev->ops = &strobe_ops; + + led_cdev = &fled_cdev->led_cdev; + led_cdev->name = led->strobe; + led_cdev->max_brightness = LED_FULL; + led_cdev->brightness_set_blocking = lm3601x_strobe_brightness_set; + led_cdev->flags |= LED_DEV_CAP_FLASH; + + err = led_classdev_flash_register(&led->client->dev, + fled_cdev); + if (err < 0) + return err; + } + + if (led->ir_node) { + led->cdev_ir.name = led->ir; + led->cdev_ir.max_brightness = LED_FULL; + led->cdev_ir.brightness_set_blocking = + lm3601x_ir_brightness_set; + + err = devm_led_classdev_register(&led->client->dev, + &led->cdev_ir); + } + + return err; +} + +static void lm3601x_init_flash_timeout (struct lm3601x_led *led) +{ + struct led_flash_setting *setting; + + setting = &led->fled_cdev.timeout; + setting->min = strobe_timeouts[0].timeout; + setting->max = led->max_strobe_timeout; + setting->step = 40; + setting->val = led->max_strobe_timeout; +} + +static int lm3601x_parse_node (struct lm3601x_led *led, + struct device_node *node) +{ + struct device_node *child_node; + const char *name; + int ret = -ENODEV; + + for_each_available_child_of_node(node, child_node) { + u32 id = 0; + + of_property_read_u32(child_node, "reg", &id); + + switch (id) { + case LM3601X_LED_TORCH: + led->torch_node = of_node_get(child_node); + break; + case LM3601X_LED_STROBE: + led->strobe_node = of_node_get(child_node); + break; + case LM3601X_LED_IR: + led->ir_node = of_node_get(child_node); + break; + default: + dev_warn(&led->client->dev, + "unknown LED %u encountered, ignoring\n", id); + break; + } + } + + if (led->torch_node) { + ret = of_property_read_string(led->torch_node, "label", &name); + if (!ret) + snprintf(led->torch, sizeof(led->torch), + "%s:%s", led->torch_node->name, name); + else + snprintf(led->torch, sizeof(led->torch), + "%s:torch", led->torch_node->name); + ret = of_property_read_u32(led->torch_node, "led-max-microamp", + &led->torch_current_max); + if (ret < 0) { + led->torch_current_max = LM3601X_MIN_TORCH_I_UA; + dev_warn(&led->client->dev, + "led-max-microamp DT property missing\n"); + } + + of_node_put(led->torch_node); + } + + if (led->strobe_node) { + ret = of_property_read_string(led->strobe_node, "label", &name); + if (!ret) + snprintf(led->strobe, sizeof(led->strobe), + "%s:%s", led->strobe_node->name, name); + else + snprintf(led->strobe, sizeof(led->strobe), + "%s::strobe", led->strobe_node->name); + + ret = of_property_read_u32(led->strobe_node, + "flash-max-microamp", + &led->strobe_current_max); + if (ret < 0) { + led->strobe_current_max = LM3601X_MIN_STROBE_I_MA; + dev_warn(&led->client->dev, + "flash-max-microamp DT property missing\n"); + } + + ret = of_property_read_u32(led->strobe_node, + "flash-max-timeout-us", + &led->max_strobe_timeout);Quoted 8 lines
drivers/leds/leds-lm3601x.c line 531
Quoted 5 lines
drivers/leds/leds-lm3601x.c new file +5
-0+ if (ret < 0) { + led->max_strobe_timeout = strobe_timeouts[0].reg_val; + dev_warn(&led->client->dev, + "flash-max-timeout-us DT property missing\n"); + }Common LED bindings state that flash-max-microamp and flash-max-timeout-us properties are mandatory.
Quoted 98 lines
OK.
Quoted 94 lines
Quoted 93 lines
drivers/leds/leds-lm3601x.c new file +91
-0+ + lm3601x_init_flash_timeout(led); + + of_node_put(led->strobe_node); + } + + if (led->ir_node) { + ret = of_property_read_string(led->ir_node, "label", &name); + if (!ret) + snprintf(led->ir, sizeof(led->ir), + "%s:%s", led->ir_node->name, name); + else + snprintf(led->ir, sizeof(led->ir), + "%s::infrared", led->ir_node->name); + + of_node_put(led->ir_node); + } + + return ret; +} + +static int lm3601x_probe (struct i2c_client *client, + const struct i2c_device_id *id) +{ + struct lm3601x_led *led; + int err; + + led = devm_kzalloc(&client->dev, + sizeof(struct lm3601x_led), GFP_KERNEL); + if (!led) + return -ENOMEM; + + err = lm3601x_parse_node(led, client->dev.of_node); + if (err < 0) + return -ENODEV; + + led->client = client; + led->regmap = devm_regmap_init_i2c(client, &lm3601x_regmap); + if (IS_ERR(led->regmap)) { + err = PTR_ERR(led->regmap); + dev_err(&client->dev, + "Failed to allocate register map: %d\n", err); + return err; + } + + mutex_init(&led->lock); + i2c_set_clientdata(client, led); + err = lm3601x_register_leds(led); + + return err; +} + +static int lm3601x_remove (struct i2c_client *client) +{ + struct lm3601x_led *led = i2c_get_clientdata(client); + + regmap_update_bits(led->regmap, LM3601X_ENABLE_REG, + LM3601X_ENABLE_MASK, + LM3601X_MODE_STANDBY); + + return 0; +} + +static const struct i2c_device_id lm3601x_id[] = { + { "LM36010", CHIP_LM36010 }, + { "LM36011", CHIP_LM36011 }, + { }, +}; +MODULE_DEVICE_TABLE (i2c, lm3601x_id); + +static const struct of_device_id of_lm3601x_leds_match[] = { + { .compatible = "ti,lm36010", }, + { .compatible = "ti,lm36011", }, + {}, +}; +MODULE_DEVICE_TABLE (of, of_lm3601x_leds_match); + +static struct i2c_driver lm3601x_i2c_driver = { + .driver = { + .name = "lm3601x", + .of_match_table = of_lm3601x_leds_match, + }, + .probe = lm3601x_probe, + .remove = lm3601x_remove, + .id_table = lm3601x_id, +}; +module_i2c_driver (lm3601x_i2c_driver); + +MODULE_DESCRIPTION ("Texas Instruments Flash Lighting driver for LM3601X" ); +MODULE_AUTHOR ("Dan Murphy <[email protected]>" ); +MODULE_LICENSE ("GPL v2" );
[0] https://lkml.org/lkml/2017/11/2/715
Signature · 2 lines
Best regards, Jacek Anaszewski
Re: [PATCH v5 2/2] leds: lm3601x: Introduce the lm3601x LED driver
In reply to Dan MurphyJacek
On 05/11/2018 06:56 AM, Dan Murphy wrote:
<snip>
Quoted 32 lines
Quoted 23 lines
Quoted 23 lines
+ }
drivers/leds/leds-lm3601x.c new file +22
-0+ + if (led->strobe_node) { + ret = of_property_read_string(led->strobe_node, "label", &name); + if (!ret) + snprintf(led->strobe, sizeof(led->strobe), + "%s:%s", led->strobe_node->name, name); + else + snprintf(led->strobe, sizeof(led->strobe), + "%s::strobe", led->strobe_node->name); + + ret = of_property_read_u32(led->strobe_node, + "flash-max-microamp", + &led->strobe_current_max); + if (ret < 0) { + led->strobe_current_max = LM3601X_MIN_STROBE_I_MA; + dev_warn(&led->client->dev, + "flash-max-microamp DT property missing\n"); + } + + ret = of_property_read_u32(led->strobe_node, + "flash-max-timeout-us", + &led->max_strobe_timeout);Quoted 8 lines
Quoted 5 lines
+ if (ret < 0) {
+led->max_strobe_timeout= strobe_timeouts[0].reg_val; + dev_warn(&led->client->dev,
+ "flash-max-timeout-us DT property missing\n"); + }Common LED bindings state that flash-max-microamp and flash-max-timeout-us properties are mandatory.
Quoted 1 line
OK.
OK I looked at the max776973 driver and well if the flash-max-microamp and flash-max-timeout-us nodes are missing it sets a default value for each if the node is not present.
So should we remove this code from the Max77693 driver too and fail probe as being asked in this driver?
Dan
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
+
+lm3601x_init_flash_timeout(led);
<snip>
Quoted 4 lines
Quoted 2 lines
Quoted 1 line
Signature · 2 lines
------------------ Dan Murphy
Re: [PATCH v5 2/2] leds: lm3601x: Introduce the lm3601x LED driver
Quoted 11 lines · Dan Murphy
Quoted 9 lines · Dan Murphy
Quoted 8 lines
drivers/leds/leds-lm3601x.c line 524
Quoted 5 lines
drivers/leds/leds-lm3601x.c new file +3
-0+ ret =of_property_read_string (led->strobe_node,"label" , &name); + ret =of_property_read_u32 (led->strobe_node, + ret = of_property_read_u32(led->strobe_node,Common LED bindings state that flash-max-microamp and flash-max-timeout-us properties are mandatory.
Quoted 8 lines
Quoted 1 line
OK.
OK I looked at the max776973 driver and well if the flash-max-microamp and flash-max-timeout-us nodes are missing it sets a default value for each if the node is not present.
So should we remove this code from the Max77693 driver too and fail probe as being asked in this driver?
I would also add that using device_property_*() API is much better then using OF specific one. It will help IoT / DIY entusiasts use them on non-DT platforms.
Signature · 2 lines
With Best Regards, Andy Shevchenko
Re: [PATCH v5 2/2] leds: lm3601x: Introduce the lm3601x LED driver
In reply to Dan MurphyHi!
Quoted 8 lines
Quoted 1 line
OK.
OK I looked at the max776973 driver and well if the flash-max-microamp and flash-max-timeout-us nodes are missing it sets a default value for each if the node is not present.
So should we remove this code from the Max77693 driver too and fail probe as being asked in this driver?
Well, modifying driver without access to the hardware is tricky :-(. If it does something stupid (like using other than minimum values for the flash-max-microamp/flash-max-timeout-us), it needs to be fixed.
And maybe comment "don't copy this, its wrong" would be in order...
Best regards,
Pavel
Signature · 2 lines
(english) http://www.livejournal.com/~pavelmachek (cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
Re: [PATCH v5 2/2] leds: lm3601x: Introduce the lm3601x LED driver
Pavel
Quoted 8 lines · Pavel Machek
Hi!
Quoted 6 lines
Quoted 1 line
OK.
OK I looked at the max776973 driver and well if the flash-max-microamp and flash-max-timeout-us nodes are missing it sets a default value for each if the node is not present.
Quoted 7 lines
Quoted 2 lines
So should we remove this code from the Max77693 driver too and fail probe as being asked in this driver?
Well, modifying driver without access to the hardware is tricky :-(. If it does something stupid (like using other than minimum values for the flash-max-microamp/flash-max-timeout-us), it needs to be fixed.
Well we should be able to test the probe/parse dt node and reject the probe if the node is not present. That can be done without HW the setup is done pretty early in the probe without even attempting to communicate with the hardware.
Dan
Quoted 5 lines
And maybe comment "don't copy this, its wrong" would be in order...
Quoted 1 line
Best regards,
Pavel
Signature · 2 lines
------------------ Dan Murphy
Re: [PATCH v5 2/2] leds: lm3601x: Introduce the lm3601x LED driver
Quoted 14 lines · Dan Murphy
Pavel
Quoted 11 lines · Pavel Machek
Hi!
Quoted 8 lines
Quoted 1 line
OK.
OK I looked at the max776973 driver and well if the flash-max-microamp and flash-max-timeout-us nodes are missing it sets a default value for each if the node is not present.
So should we remove this code from the Max77693 driver too and fail probe as being asked in this driver?
Quoted 9 lines
Quoted 4 lines
Well, modifying driver without access to the hardware is tricky :-(. If it does something stupid (like using other than minimum values for the flash-max-microamp/flash-max-timeout-us), it needs to be fixed.
Well we should be able to test the probe/parse dt node and reject the probe if the node is not present. That can be done without HW the setup is done pretty early in the probe without even attempting to communicate with the hardware.
Well, yes, you can do that.
But if someone is actively using board with DT w/o flash-max-microamp, you'll make them unhappy.
Best regards,
Pavel
Signature · 2 lines
(english) http://www.livejournal.com/~pavelmachek (cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
Re: [PATCH v5 2/2] leds: lm3601x: Introduce the lm3601x LED driver
Quoted 25 lines · Pavel Machek
Quoted 14 lines · Dan Murphy
Pavel
Quoted 11 lines · Pavel Machek
Hi!
Quoted 8 lines
Quoted 1 line
OK.
OK I looked at the max776973 driver and well if the flash-max-microamp and flash-max-timeout-us nodes are missing it sets a default value for each if the node is not present.
So should we remove this code from the Max77693 driver too and fail probe as being asked in this driver?
Quoted 9 lines
Quoted 4 lines
Well, modifying driver without access to the hardware is tricky :-(. If it does something stupid (like using other than minimum values for the flash-max-microamp/flash-max-timeout-us), it needs to be fixed.
Well we should be able to test the probe/parse dt node and reject the probe if the node is not present. That can be done without HW the setup is done pretty early in the probe without even attempting to communicate with the hardware.
Quoted 5 lines
Well, yes, you can do that.
But if someone is actively using board with DT w/o flash-max-microamp, you'll make them unhappy.
I grepped the dt directories and I did not find any upstream dt files configuring the max77693 with a flash led source. Unless Jacek can point out an upstream file I may have over looked.
Unhappiness will come from not upstreaming your code ;)
Dan
Quoted 3 lines
Best regards,
Pavel
Signature · 2 lines
------------------ Dan Murphy
Re: [PATCH v5 2/2] leds: lm3601x: Introduce the lm3601x LED driver
In reply to Dan MurphyHi Dan,
Quoted 37 lines · Dan Murphy
Jacek
On 05/11/2018 06:56 AM, Dan Murphy wrote:
<snip>Quoted 32 lines
Quoted 31 lines
Quoted 18 lines
+ }
drivers/leds/leds-lm3601x.c new file +17
-0+ + if (led->strobe_node) { + ret = of_property_read_string(led->strobe_node, "label", &name); + if (!ret) + snprintf(led->strobe, sizeof(led->strobe), + "%s:%s", led->strobe_node->name, name); + else + snprintf(led->strobe, sizeof(led->strobe), + "%s::strobe", led->strobe_node->name); + + ret = of_property_read_u32(led->strobe_node, + "flash-max-microamp", + &led->strobe_current_max); + if (ret < 0) { + led->strobe_current_max = LM3601X_MIN_STROBE_I_MA; + dev_warn(&led->client->dev, + "flash-max-microamp DT property missing\n");drivers/leds/leds-lm3601x.c line 531
Quoted 10 lines
drivers/leds/leds-lm3601x.c new file +10
-0+ } + + ret = of_property_read_u32(led->strobe_node, + "flash-max-timeout-us", + &led->max_strobe_timeout); + if (ret < 0) { + led->max_strobe_timeout = strobe_timeouts[0].reg_val; + dev_warn(&led->client->dev, + "flash-max-timeout-us DT property missing\n"); + }Common LED bindings state that flash-max-microamp and flash-max-timeout-us properties are mandatory.
Quoted 5 lines
Quoted 1 line
OK.
OK I looked at the max776973 driver and well if the flash-max-microamp and flash-max-timeout-us nodes are missing it sets a default value for each if the node is not present.
Ah, yes, this driver was being introduced as the first LED flash class driver and we were being iteratively adjusting LED common bindings according to the new findings, so some details could have been left
out of sync.
Quoted 2 lines
So should we remove this code from the Max77693 driver too and fail probe as being asked in this driver?
Yes, that would match what the bindings require.
Signature · 2 lines
Best regards, Jacek Anaszewski
Re: [PATCH v5 2/2] leds: lm3601x: Introduce the lm3601x LED driver
Quoted 46 lines · Jacek Anaszewski
Hi Dan,
Quoted 37 lines · Dan Murphy
Jacek
On 05/11/2018 06:56 AM, Dan Murphy wrote:
<snip>Quoted 32 lines
Quoted 31 lines
Quoted 18 lines
+ }
drivers/leds/leds-lm3601x.c new file +17
-0+ + if (led->strobe_node) { + ret = of_property_read_string(led->strobe_node, "label", &name); + if (!ret) + snprintf(led->strobe, sizeof(led->strobe), + "%s:%s", led->strobe_node->name, name); + else + snprintf(led->strobe, sizeof(led->strobe), + "%s::strobe", led->strobe_node->name); + + ret = of_property_read_u32(led->strobe_node, + "flash-max-microamp", + &led->strobe_current_max); + if (ret < 0) { + led->strobe_current_max = LM3601X_MIN_STROBE_I_MA; + dev_warn(&led->client->dev, + "flash-max-microamp DT property missing\n");drivers/leds/leds-lm3601x.c line 531
Quoted 10 lines
drivers/leds/leds-lm3601x.c new file +10
-0+ } + + ret = of_property_read_u32(led->strobe_node, + "flash-max-timeout-us", + &led->max_strobe_timeout); + if (ret < 0) { + led->max_strobe_timeout = strobe_timeouts[0].reg_val; + dev_warn(&led->client->dev, + "flash-max-timeout-us DT property missing\n"); + }Common LED bindings state that flash-max-microamp and flash-max-timeout-us properties are mandatory.
Quoted 5 lines
Quoted 1 line
OK.
OK I looked at the max776973 driver and well if the flash-max-microamp and flash-max-timeout-us nodes are missing it sets a default value for each if the node is not present.
Quoted 8 lines
Ah, yes, this driver was being introduced as the first LED flash class driver and we were being iteratively adjusting LED common bindings according to the new findings, so some details could have been left
out of sync.Quoted 2 lines
So should we remove this code from the Max77693 driver too and fail probe as being asked in this driver?
Yes, that would match what the bindings require.
Did you want me to remove it and submit? I don't have a board to verify but I can definitely test out the probe and parse dt functionality. Don't need HW for that.
Dan
Quoted 1 line
Signature · 2 lines
------------------ Dan Murphy
Hi!
Quoted 4 lines
Introduce the device tree bindings for the lm3601x family of LED torch, flash and IR drivers.
Signed-off-by Dan Murphy <[email protected]>
Better, thanks.
Documentation/devicetree/bindings/leds/leds-lm3601x.txt line 1
Quoted 3 lines
+++
b/Documentation/devicetree/bindings/leds/leds-lm3601x.txtDocumentation/devicetree/bindings/leds/leds-lm3601x.txt new file +1
-0@@ -0,0 +1,50 @@ +* Texas Instruments - lm3601x Single-LED Flash Driver
Ok, so is it single-LED driver, or can it driver ir & white LEDs at the same time?
Quoted 9 lines
Documentation/devicetree/bindings/leds/leds-lm3601x.txt new file +9
-0+Example: +led-controller@64 { + compatible = "ti,lm36010"; + #address-cells = <1>; + #size-cells = <0>; + reg = <0x64>; + + led@0 { + reg = <0>;
Documentation/devicetree/bindings/leds/leds-lm3601x.txt line 40
Quoted 10 lines
Documentation/devicetree/bindings/leds/leds-lm3601x.txt new file +10
-0+ label = "white:torch"; + led-max-microamp = <10000>; + }; + + led@1 { + reg = <1>; + label = "white:flash"; + flash-max-microamp = <10000>; + flash-max-timeout-us = <800>; + };
Is this realistic config? I'd expect flash to use more power than torch, and would expect longer timeout than 0.8msec.
Also.. if this is physically one white LED, it should not be spread over reg = <0> and reg = <1>...
Best regards,
Pavel
Signature · 2 lines
(english) http://www.livejournal.com/~pavelmachek (cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
Pavel
Quoted 7 lines · Pavel Machek
Hi!
Quoted 4 lines
Introduce the device tree bindings for the lm3601x family of LED torch, flash and IR drivers.
Signed-off-by Dan Murphy <[email protected]>
Quoted 7 lines
Better, thanks.
Documentation/devicetree/bindings/leds/leds-lm3601x.txt line 1
Quoted 3 lines
+++
b/Documentation/devicetree/bindings/leds/leds-lm3601x.txtDocumentation/devicetree/bindings/leds/leds-lm3601x.txt new file +1
-0@@ -0,0 +1,50 @@ +* Texas Instruments - lm3601x Single-LED Flash DriverOk, so is it single-LED driver, or can it driver ir & white LEDs at the same time?
It is a single LED driver. It can drive a Torch white LED or IR LED indefinitely or if the driver is programmed to strobe mode the driver will drive the configured LED for the flash timeout specified.
Basically a flash and a flash light. IR or White LED.
Quoted 15 lines
Quoted 15 lines
Documentation/devicetree/bindings/leds/leds-lm3601x.txt new file +14
-0+Example: +led-controller@64 { + compatible = "ti,lm36010"; + #address-cells = <1>; + #size-cells = <0>; + reg = <0x64>; + + led@0 { + reg = <0>; + label = "white:torch"; + led-max-microamp = <10000>; + }; + + led@1 {
Quoted 8 lines
Documentation/devicetree/bindings/leds/leds-lm3601x.txt line 40
Quoted 5 lines
Documentation/devicetree/bindings/leds/leds-lm3601x.txt new file +5
-0+ reg = <1>; + label = "white:flash"; + flash-max-microamp = <10000>; + flash-max-timeout-us = <800>; + };Is this realistic config? I'd expect flash to use more power than torch, and would expect longer timeout than 0.8msec.
Timeout in the spreadsheet is ms I will update this example and code Current in the spreadsheet is mA I will update this example and code
Quoted 3 lines
Also.. if this is physically one white LED, it should not be spread over reg = <0> and reg = <1>...
If the torch LED and strobe LED are the same LED how do I expose them both to the user. It is up to consumer to configure the required interfaces they want to expose to the filesystem.
Maybe they don't want the strobe feature and just want LED on/off and switch between IR and White.
The IR is driven via a different output pin.
Dan
Quoted 4 lines
Best regards,
Pavel
Signature · 2 lines
------------------ Dan Murphy
Quoted 55 lines · Dan Murphy
Pavel
Quoted 7 lines · Pavel Machek
Hi!
Quoted 4 lines
Introduce the device tree bindings for the lm3601x family of LED torch, flash and IR drivers.
Signed-off-by Dan Murphy <[email protected]>Quoted 7 lines
Better, thanks.
Documentation/devicetree/bindings/leds/leds-lm3601x.txt line 1
Quoted 3 lines
+++
b/Documentation/devicetree/bindings/leds/leds-lm3601x.txtDocumentation/devicetree/bindings/leds/leds-lm3601x.txt new file +1
-0@@ -0,0 +1,50 @@ +* Texas Instruments - lm3601x Single-LED Flash DriverOk, so is it single-LED driver, or can it driver ir & white LEDs at the same time?
It is a single LED driver. It can drive a Torch white LED or IR LED indefinitely or if the driver is programmed to strobe mode the driver will drive the configured LED for the flash timeout specified.
Basically a flash and a flash light. IR or White LED.
Quoted 15 lines
Quoted 15 lines
Documentation/devicetree/bindings/leds/leds-lm3601x.txt new file +14
-0+Example: +led-controller@64 { + compatible = "ti,lm36010"; + #address-cells = <1>; + #size-cells = <0>; + reg = <0x64>; + + led@0 { + reg = <0>; + label = "white:torch"; + led-max-microamp = <10000>; + }; + + led@1 {Quoted 8 lines
Documentation/devicetree/bindings/leds/leds-lm3601x.txt line 40
Quoted 5 lines
Documentation/devicetree/bindings/leds/leds-lm3601x.txt new file +5
-0+ reg = <1>; + label = "white:flash"; + flash-max-microamp = <10000>; + flash-max-timeout-us = <800>; + };Is this realistic config? I'd expect flash to use more power than torch, and would expect longer timeout than 0.8msec.
Timeout in the spreadsheet is ms I will update this example and code Current in the spreadsheet is mA I will update this example and code
Quoted 3 lines
Also.. if this is physically one white LED, it should not be spread over reg = <0> and reg = <1>...
Quoted 6 lines
If the torch LED and strobe LED are the same LED how do I expose them both to the user. It is up to consumer to configure the required interfaces they want to expose to the filesystem.
Maybe they don't want the strobe feature and just want LED on/off and switch between IR and White.
The IR is driven via a different output pin.
Correction. There is only one LED drive pin. The mode selected determines how the device will drive the LED. So you may have one device to drive a Torch and another device to drive the LED.
Strobe is available in either case but not always required if strobe is not desired by the customer hence why I have a separate DT node for it.
Dan
Quoted 9 lines
Dan
Quoted 4 lines
Best regards,
Pavel
Signature · 2 lines
------------------ Dan Murphy
Hi Dan,
Quoted 53 lines · Dan Murphy
Quoted 52 lines · Dan Murphy
Pavel
Quoted 7 lines · Pavel Machek
Hi!
Quoted 4 lines
Introduce the device tree bindings for the lm3601x family of LED torch, flash and IR drivers.
Signed-off-by Dan Murphy <[email protected]>Quoted 7 lines
Better, thanks.
Documentation/devicetree/bindings/leds/leds-lm3601x.txt line 1
Quoted 3 lines
+++
b/Documentation/devicetree/bindings/leds/leds-lm3601x.txtDocumentation/devicetree/bindings/leds/leds-lm3601x.txt new file +1
-0@@ -0,0 +1,50 @@ +* Texas Instruments - lm3601x Single-LED Flash DriverOk, so is it single-LED driver, or can it driver ir & white LEDs at the same time?
It is a single LED driver. It can drive a Torch white LED or IR LED indefinitely or if the driver is programmed to strobe mode the driver will drive the configured LED for the flash timeout specified.
Basically a flash and a flash light. IR or White LED.
Quoted 15 lines
Quoted 15 lines
Documentation/devicetree/bindings/leds/leds-lm3601x.txt new file +14
-0+Example: +led-controller@64 { + compatible = "ti,lm36010"; + #address-cells = <1>; + #size-cells = <0>; + reg = <0x64>; + + led@0 { + reg = <0>; + label = "white:torch"; + led-max-microamp = <10000>; + }; + + led@1 {Quoted 8 lines
Documentation/devicetree/bindings/leds/leds-lm3601x.txt line 40
Quoted 5 lines
Documentation/devicetree/bindings/leds/leds-lm3601x.txt new file +5
-0+ reg = <1>; + label = "white:flash"; + flash-max-microamp = <10000>; + flash-max-timeout-us = <800>; + };Is this realistic config? I'd expect flash to use more power than torch, and would expect longer timeout than 0.8msec.
Timeout in the spreadsheet is ms I will update this example and code Current in the spreadsheet is mA I will update this example and code
Quoted 1 line
Quoted 5 lines
Quoted 5 lines
Quoted 2 lines
Also.. if this is physically one white LED, it should not be spread over reg = <0> and reg = <1>...
If the torch LED and strobe LED are the same LED how do I expose them both to the user. It is up to consumer to configure the required interfaces they want to expose to the filesystem.
LED flash class interface is prepared for it. led_clasdev_flash_register() internally calls led_classdev_register(), so there is brightness file available for torch related operations.
Quoted 6 lines
Quoted 3 lines
Maybe they don't want the strobe feature and just want LED on/off and switch between IR and White.
The IR is driven via a different output pin.
Correction. There is only one LED drive pin. The mode selected determines how the device will drive the LED. So you may have one device to drive a Torch and another device to drive the LED.
But only one type of LED can be soldered on the board at a time, right? If yes, then this is clearly a DT related configuration, and only one child DT node should be defined for given board.
Quoted 16 lines
Strobe is available in either case but not always required if strobe is not desired by the customer hence why I have a separate DT node for it.
Dan
Quoted 9 lines
Dan
Quoted 4 lines
Best regards,
Pavel
Signature · 2 lines
Best regards, Jacek Anaszewski
Jacek
Thanks for the review
Quoted 59 lines · Jacek Anaszewski
Hi Dan,
Quoted 56 lines · Dan Murphy
Quoted 55 lines · Dan Murphy
Pavel
Quoted 7 lines · Pavel Machek
Hi!
Quoted 4 lines
Introduce the device tree bindings for the lm3601x family of LED torch, flash and IR drivers.
Signed-off-by Dan Murphy <[email protected]>Quoted 7 lines
Better, thanks.
Documentation/devicetree/bindings/leds/leds-lm3601x.txt line 1
Quoted 3 lines
+++
b/Documentation/devicetree/bindings/leds/leds-lm3601x.txtDocumentation/devicetree/bindings/leds/leds-lm3601x.txt new file +1
-0@@ -0,0 +1,50 @@ +* Texas Instruments - lm3601x Single-LED Flash DriverOk, so is it single-LED driver, or can it driver ir & white LEDs at the same time?
It is a single LED driver. It can drive a Torch white LED or IR LED indefinitely or if the driver is programmed to strobe mode the driver will drive the configured LED for the flash timeout specified.
Basically a flash and a flash light. IR or White LED.
Quoted 15 lines
Quoted 15 lines
Documentation/devicetree/bindings/leds/leds-lm3601x.txt new file +14
-0+Example: +led-controller@64 { + compatible = "ti,lm36010"; + #address-cells = <1>; + #size-cells = <0>; + reg = <0x64>; + + led@0 { + reg = <0>; + label = "white:torch"; + led-max-microamp = <10000>; + }; + + led@1 {Quoted 8 lines
Documentation/devicetree/bindings/leds/leds-lm3601x.txt line 40
Quoted 5 lines
Documentation/devicetree/bindings/leds/leds-lm3601x.txt new file +5
-0+ reg = <1>; + label = "white:flash"; + flash-max-microamp = <10000>; + flash-max-timeout-us = <800>; + };Is this realistic config? I'd expect flash to use more power than torch, and would expect longer timeout than 0.8msec.
Timeout in the spreadsheet is ms I will update this example and code Current in the spreadsheet is mA I will update this example and code
Quoted 3 lines
Also.. if this is physically one white LED, it should not be spread over reg = <0> and reg = <1>...
Quoted 6 lines
Quoted 2 lines
Quoted 2 lines
If the torch LED and strobe LED are the same LED how do I expose them both to the user. It is up to consumer to configure the required interfaces they want to expose to the filesystem.
LED flash class interface is prepared for it.
led_clasdev_flash_register()internally callsled_classdev_register(), so there is brightness file available for torch related operations.
Yes the flash class may handle this and expose the brightness node but the HW has two different registers to set the corresponding brightness so one set brightness node does not work.
There is no way to differentiate between the strobe brightness (register 4) and the torch brightness (register 3).
When the enable register is written the driver will read the corresponding register and set the current for the LED.
This is why I separated out the strobe from the torch into 2 different LED nodes.
I cannot seem to find the data sheet on line for the max77693 so I cannot verify that the device only has a single brightness register for both torch and strobe.
Quoted 11 lines
Quoted 7 lines
Quoted 4 lines
Maybe they don't want the strobe feature and just want LED on/off and switch between IR and White.
The IR is driven via a different output pin.
Correction. There is only one LED drive pin. The mode selected determines how the device will drive the LED. So you may have one device to drive a Torch and another device to drive the LED.
But only one type of LED can be soldered on the board at a time, right? If yes, then this is clearly a DT related configuration, and only one child DT node should be defined for given board.
But see above. There is not a clean way to expose the torch/ir and strobe separately.
Dan
Quoted 18 lines
Quoted 17 lines
Strobe is available in either case but not always required if strobe is not desired by the customer hence why I have a separate DT node for it.
Dan
Quoted 9 lines
Dan
Quoted 4 lines
Best regards,
Pavel
Signature · 2 lines
------------------ Dan Murphy
Dan,
Quoted 67 lines · Dan Murphy
Jacek
Thanks for the review
Quoted 62 lines · Jacek Anaszewski
Hi Dan,
Quoted 58 lines · Dan Murphy
Quoted 57 lines · Dan Murphy
Pavel
Quoted 7 lines · Pavel Machek
Hi!
Quoted 4 lines
Introduce the device tree bindings for the lm3601x family of LED torch, flash and IR drivers.
Signed-off-by Dan Murphy <[email protected]>Quoted 7 lines
Better, thanks.
Documentation/devicetree/bindings/leds/leds-lm3601x.txt line 1
Quoted 3 lines
+++
b/Documentation/devicetree/bindings/leds/leds-lm3601x.txtDocumentation/devicetree/bindings/leds/leds-lm3601x.txt new file +1
-0@@ -0,0 +1,50 @@ +* Texas Instruments - lm3601x Single-LED Flash DriverOk, so is it single-LED driver, or can it driver ir & white LEDs at the same time?
It is a single LED driver. It can drive a Torch white LED or IR LED indefinitely or if the driver is programmed to strobe mode the driver will drive the configured LED for the flash timeout specified.
Basically a flash and a flash light. IR or White LED.
Quoted 15 lines
Quoted 15 lines
Documentation/devicetree/bindings/leds/leds-lm3601x.txt new file +14
-0+Example: +led-controller@64 { + compatible = "ti,lm36010"; + #address-cells = <1>; + #size-cells = <0>; + reg = <0x64>; + + led@0 { + reg = <0>; + label = "white:torch"; + led-max-microamp = <10000>; + }; + + led@1 {Quoted 8 lines
Documentation/devicetree/bindings/leds/leds-lm3601x.txt line 40
Quoted 5 lines
Documentation/devicetree/bindings/leds/leds-lm3601x.txt new file +5
-0+ reg = <1>; + label = "white:flash"; + flash-max-microamp = <10000>; + flash-max-timeout-us = <800>; + };Is this realistic config? I'd expect flash to use more power than torch, and would expect longer timeout than 0.8msec.
Timeout in the spreadsheet is ms I will update this example and code Current in the spreadsheet is mA I will update this example and code
Quoted 3 lines
Also.. if this is physically one white LED, it should not be spread over reg = <0> and reg = <1>...
If the torch LED and strobe LED are the same LED how do I expose them both to the user. It is up to consumer to configure the required interfaces they want to expose to the filesystem.
Quoted 7 lines
Quoted 3 lines
LED flash class interface is prepared for it.
led_clasdev_flash_register()internally callsled_classdev_register(), so there is brightness file available for torch related operations.Yes the flash class may handle this and expose the brightness node but the HW has two different registers to set the corresponding brightness so one set brightness node does not work.
There is no way to differentiate between the strobe brightness (register 4) and the torch brightness (register 3).
Hmm? There is brightness file (with brightness_set{_blocking} op) from LED class and flash_brightness file (with flash_brightness_set op) from LED class flash.
I've only now realized that you're not using flash_brightness_set op for the "strobe_node" in your driver. I assume that you overlooked it. Please don't introduce "strobe_brightness" naming convention - we already have "flash_brightness" for that.
Quoted 7 lines
When the enable register is written the driver will read the corresponding register and set the current for the LED.
This is why I separated out the strobe from the torch into 2 different LED nodes.
I cannot seem to find the data sheet on line for the max77693 so I cannot verify that the device only has a single brightness register for both torch and strobe.
It wasn't openly available at least at the time when I had an access to it.
But - please look at the functions max77693_set_torch_current() and max77693_set_flash_current(). The device has separate registers for torch and flash brightnesses.
Quoted 36 lines
Quoted 10 lines
Quoted 6 lines
Quoted 3 lines
Maybe they don't want the strobe feature and just want LED on/off and switch between IR and White.
The IR is driven via a different output pin.
Correction. There is only one LED drive pin. The mode selected determines how the device will drive the LED. So you may have one device to drive a Torch and another device to drive the LED.
But only one type of LED can be soldered on the board at a time, right? If yes, then this is clearly a DT related configuration, and only one child DT node should be defined for given board.
But see above. There is not a clean way to expose the torch/ir and strobe separately.
Dan
Quoted 18 lines
Quoted 17 lines
Strobe is available in either case but not always required if strobe is not desired by the customer hence why I have a separate DT node for it.
Dan
Quoted 9 lines
Dan
Quoted 4 lines
Best regards,
Pavel
Signature · 2 lines
Best regards, Jacek Anaszewski
Jacek
Quoted 95 lines · Jacek Anaszewski
Dan,
Quoted 67 lines · Dan Murphy
Jacek
Thanks for the review
Quoted 62 lines · Jacek Anaszewski
Hi Dan,
Quoted 58 lines · Dan Murphy
Quoted 57 lines · Dan Murphy
Pavel
Quoted 7 lines · Pavel Machek
Hi!
Quoted 4 lines
Introduce the device tree bindings for the lm3601x family of LED torch, flash and IR drivers.
Signed-off-by Dan Murphy <[email protected]>Quoted 7 lines
Better, thanks.
Review line 1
Quoted 3 lines
+++
b/Documentation/devicetree/bindings/leds/leds-lm3601x.txt(quoted diff) +1
-0@@ -0,0 +1,50 @@ +* Texas Instruments - lm3601x Single-LED Flash DriverOk, so is it single-LED driver, or can it driver ir & white LEDs at the same time?
It is a single LED driver. It can drive a Torch white LED or IR LED indefinitely or if the driver is programmed to strobe mode the driver will drive the configured LED for the flash timeout specified.
Basically a flash and a flash light. IR or White LED.
Quoted 15 lines
Quoted 15 lines
(quoted diff) +14
-0+Example: +led-controller@64 { + compatible = "ti,lm36010"; + #address-cells = <1>; + #size-cells = <0>; + reg = <0x64>; + + led@0 { + reg = <0>; + label = "white:torch"; + led-max-microamp = <10000>; + }; + + led@1 {Quoted 8 lines
Review line 20
Quoted 5 lines
(quoted diff) +5
-0+ reg = <1>; + label = "white:flash"; + flash-max-microamp = <10000>; + flash-max-timeout-us = <800>; + };Is this realistic config? I'd expect flash to use more power than torch, and would expect longer timeout than 0.8msec.
Timeout in the spreadsheet is ms I will update this example and code Current in the spreadsheet is mA I will update this example and code
Quoted 3 lines
Also.. if this is physically one white LED, it should not be spread over reg = <0> and reg = <1>...
If the torch LED and strobe LED are the same LED how do I expose them both to the user. It is up to consumer to configure the required interfaces they want to expose to the filesystem.
Quoted 7 lines
Quoted 3 lines
LED flash class interface is prepared for it.
led_clasdev_flash_register()internally callsled_classdev_register(), so there is brightness file available for torch related operations.Yes the flash class may handle this and expose the brightness node but the HW has two different registers to set the corresponding brightness so one set brightness node does not work.
There is no way to differentiate between the strobe brightness (register 4) and the torch brightness (register 3).Hmm? There is brightness file (with brightness_set{_blocking} op) from LED class and
flash_brightnessfile (withflash_brightness_setop) from LED class flash.I've only now realized that you're not using
flash_brightness_setop for the "strobe_node" in your driver. I assume that you overlooked it. Please don't introduce "strobe_brightness" naming convention - we already have "flash_brightness" for that.Quoted 7 lines
When the enable register is written the driver will read the corresponding register and set the current for the LED.
This is why I separated out the strobe from the torch into 2 different LED nodes.
I cannot seem to find the data sheet on line for the max77693 so I cannot verify that the device only has a single brightness register for both torch and strobe.
Quoted 6 lines
It wasn't openly available at least at the time when I had an access to it.
But - please look at the functions
max77693_set_torch_current()andmax77693_set_flash_current(). The device has separate registers for torch and flash brightnesses.
I have looked at these functions and the parse dt function that dictates if there is 1 fled or 2 fled. I am having trouble associating what these mean because the led-sources is being used to define how many LEDs.
In the common.txt it says
"- led-sources : List of device current outputs the LED is connected to. The
outputs are identified by the numbers that must be defined in the LED device binding documentation."
I cannot find the max77693 dt documentation or even a dt file that defines what the led-sources could be defined as. In addition, per the common.txt, the led sources should define the current outputs the LED is connected to.
Is one to assume that it is referring to the physical current pin connection or the devices internal current routing?
When I first referenced this driver as template driver it was misleading to say fled1 and fled2 as I took it to mean, and I still do, that the driver supports 2 LED connections and not a single output pin with different internal current routing.
Without the data sheet or the dt documentation it makes understanding a little difficult.
I will fix it up how ever you would like it to be but I am thinking we need to fix up the max77693 as well so we can have 2 reference drivers. It is very difficult to derive the driver without a public version of the data sheet.
Dan
Quoted 38 lines
Quoted 37 lines
Quoted 11 lines
Quoted 7 lines
Quoted 4 lines
Maybe they don't want the strobe feature and just want LED on/off and switch between IR and White.
The IR is driven via a different output pin.
Correction. There is only one LED drive pin. The mode selected determines how the device will drive the LED. So you may have one device to drive a Torch and another device to drive the LED.
But only one type of LED can be soldered on the board at a time, right? If yes, then this is clearly a DT related configuration, and only one child DT node should be defined for given board.
But see above. There is not a clean way to expose the torch/ir and strobe separately.
Dan
Quoted 18 lines
Quoted 17 lines
Strobe is available in either case but not always required if strobe is not desired by the customer hence why I have a separate DT node for it.
Dan
Quoted 9 lines
Dan
Quoted 4 lines
Best regards,
Pavel
Signature · 2 lines
------------------ Dan Murphy
Dan,
Quoted 109 lines · Dan Murphy
Jacek
Quoted 95 lines · Jacek Anaszewski
Dan,
Quoted 67 lines · Dan Murphy
Jacek
Thanks for the review
Quoted 62 lines · Jacek Anaszewski
Hi Dan,
Quoted 58 lines · Dan Murphy
Quoted 57 lines · Dan Murphy
Pavel
Quoted 7 lines · Pavel Machek
Hi!
Quoted 4 lines
Introduce the device tree bindings for the lm3601x family of LED torch, flash and IR drivers.
Signed-off-by Dan Murphy <[email protected]>Quoted 7 lines
Better, thanks.
Review line 1
Quoted 3 lines
+++
b/Documentation/devicetree/bindings/leds/leds-lm3601x.txt(quoted diff) +1
-0@@ -0,0 +1,50 @@ +* Texas Instruments - lm3601x Single-LED Flash DriverOk, so is it single-LED driver, or can it driver ir & white LEDs at the same time?
It is a single LED driver. It can drive a Torch white LED or IR LED indefinitely or if the driver is programmed to strobe mode the driver will drive the configured LED for the flash timeout specified.
Basically a flash and a flash light. IR or White LED.
Quoted 15 lines
Quoted 15 lines
(quoted diff) +14
-0+Example: +led-controller@64 { + compatible = "ti,lm36010"; + #address-cells = <1>; + #size-cells = <0>; + reg = <0x64>; + + led@0 { + reg = <0>; + label = "white:torch"; + led-max-microamp = <10000>; + }; + + led@1 {Quoted 8 lines
Review line 20
Quoted 5 lines
(quoted diff) +5
-0+ reg = <1>; + label = "white:flash"; + flash-max-microamp = <10000>; + flash-max-timeout-us = <800>; + };Is this realistic config? I'd expect flash to use more power than torch, and would expect longer timeout than 0.8msec.
Timeout in the spreadsheet is ms I will update this example and code Current in the spreadsheet is mA I will update this example and code
Quoted 3 lines
Also.. if this is physically one white LED, it should not be spread over reg = <0> and reg = <1>...
If the torch LED and strobe LED are the same LED how do I expose them both to the user. It is up to consumer to configure the required interfaces they want to expose to the filesystem.
Quoted 7 lines
Quoted 3 lines
LED flash class interface is prepared for it.
led_clasdev_flash_register()internally callsled_classdev_register(), so there is brightness file available for torch related operations.Yes the flash class may handle this and expose the brightness node but the HW has two different registers to set the corresponding brightness so one set brightness node does not work.
There is no way to differentiate between the strobe brightness (register 4) and the torch brightness (register 3).Hmm? There is brightness file (with brightness_set{_blocking} op) from LED class and
flash_brightnessfile (withflash_brightness_setop) from LED class flash.I've only now realized that you're not using
flash_brightness_setop for the "strobe_node" in your driver. I assume that you overlooked it. Please don't introduce "strobe_brightness" naming convention - we already have "flash_brightness" for that.Quoted 7 lines
When the enable register is written the driver will read the corresponding register and set the current for the LED.
This is why I separated out the strobe from the torch into 2 different LED nodes.
I cannot seem to find the data sheet on line for the max77693 so I cannot verify that the device only has a single brightness register for both torch and strobe.
Quoted 6 lines
It wasn't openly available at least at the time when I had an access to it.
But - please look at the functions
max77693_set_torch_current()andmax77693_set_flash_current(). The device has separate registers for torch and flash brightnesses.I have looked at these functions and the parse dt function that dictates if there is 1 fled or 2 fled. I am having trouble associating what these mean because the led-sources is being used to define how many LEDs.
Quoted 7 lines
In the common.txt it says
"- led-sources : List of device current outputs the LED is connected to. The
outputs are identified by the numbers that must be defined in the LED device binding documentation."I cannot find the max77693 dt documentation or even a dt file that defines what the led-sources could be defined as. In addition, per the common.txt, the led sources should define the current outputs the LED is connected to.
You can find more details in Documentation/devicetree/bindings/mfd/max77693.txt.
Generally the led-sources property was introduced to solve this particular case when there are two IOUTS that can have connected two LEDs or a single LED which allows to feed it with greater current.
Quoted 7 lines
Is one to assume that it is referring to the physical current pin connection or the devices internal current routing?
When I first referenced this driver as template driver it was misleading to say fled1 and fled2 as I took it to mean, and I still do, that the driver supports 2 LED connections and not a single output pin with different internal current routing.
Without the data sheet or the dt documentation it makes understanding a little difficult.
There are more straightforward LED flash class drivers, e.g. drivers/leds/leds-aat1290, you can refer to.
Quoted 2 lines
I will fix it up how ever you would like it to be but I am thinking we need to fix up the max77693 as well so we can have 2 reference drivers.
There is also drivers/leds/leds-as3645a.c and one greybus driver. So we have in fact four LED flash class drivers in the tree :-)
Quoted 1 line
It is very difficult to derive the driver without a public version of the data sheet.
I agree, but mfd documentation I pointed should be enough to increase your comprehension of the subject, I hope. If not, then we can extend it basing on your remarks and my memory.
Quoted 39 lines
Quoted 37 lines
Quoted 36 lines
Quoted 10 lines
Quoted 6 lines
Quoted 3 lines
Maybe they don't want the strobe feature and just want LED on/off and switch between IR and White.
The IR is driven via a different output pin.
Correction. There is only one LED drive pin. The mode selected determines how the device will drive the LED. So you may have one device to drive a Torch and another device to drive the LED.
But only one type of LED can be soldered on the board at a time, right? If yes, then this is clearly a DT related configuration, and only one child DT node should be defined for given board.
But see above. There is not a clean way to expose the torch/ir and strobe separately.
Dan
Quoted 18 lines
Quoted 17 lines
Strobe is available in either case but not always required if strobe is not desired by the customer hence why I have a separate DT node for it.
Dan
Quoted 9 lines
Dan
Quoted 4 lines
Best regards,
Pavel
Signature · 2 lines
Best regards, Jacek Anaszewski
Quoted 30 lines · Dan Murphy
Introduce the device tree bindings for the lm3601x family of LED torch, flash and IR drivers.
Signed-off-by Dan Murphy <[email protected]>---
v5 - No changes - https://patchwork.kernel.org/patch/10391743/
v4 - Added " " around "=", changed strobe to flash on label, removed "support and register" comment and change ir lable to ir:torch - See v2 patchworks for comments v3 - Removed wildcard compatible - https://patchwork.kernel.org/patch/10386241/
v2 - No changes - https://patchwork.kernel.org/patch/10384587/.../devicetree/bindings/leds/leds-lm3601x.txt | 50 +++++++++++++++++++ 1 file changed, 50 insertions(+)create mode 100644
Documentation/devicetree/bindings/leds/leds-lm3601x.txtDocumentation/devicetree/bindings/leds/leds-lm3601x.txt new file +7
-0@@ -0,0 +1,50 @@ +* Texas Instruments - lm3601x Single-LED Flash Driver + +The LM3601X are ultra-small LED flash drivers that +provide a high level of adjustability. + +Required properties: + - compatible : Can be one of the following
Documentation/devicetree/bindings/leds/leds-lm3601x.txt line 17
Quoted 10 lines
Documentation/devicetree/bindings/leds/leds-lm3601x.txt new file +10
-0+ "ti,lm36010" + "ti,lm36011" + - reg : I2C slave address + - #address-cells : 1 + - #size-cells : 0 + +Required child properties: + - reg : 0 - Indicates a torch interface + 1 - Indicates a flash interface + 2 - Indicates an infrared interface
You need here also:
- flash-max-microamp : see Documentation/devicetree/bindin /leds/common.txt
- flash-max-timeout-us : see Documentation/devicetree/bindings/leds/common.txt
Quoted 34 lines
Documentation/devicetree/bindings/leds/leds-lm3601x.txt new file +33
-0+ +Optional child properties: + - label : see Documentation/devicetree/bindings/leds/common.txt + +Example: +led-controller@64 { + compatible = "ti,lm36010"; + #address-cells = <1>; + #size-cells = <0>; + reg = <0x64>; + + led@0 { + reg = <0>; + label = "white:torch"; + led-max-microamp = <10000>; + }; + + led@1 { + reg = <1>; + label = "white:flash"; + flash-max-microamp = <10000>; + flash-max-timeout-us = <800>; + }; + + led@2 { + reg = <2>; + label = "ir:torch"; + }; +} + +For more product information please see the links below: +http://www.ti.com/product/LM36010 +http://www.ti.com/product/LM36011
Signature · 2 lines
Best regards, Jacek Anaszewski