led: add and use a LED_BRIGTHNESS_MAX definition

fabiobaltieri · kartben · commit 551c1363ddb0 · 2025-05-14T16:27:18.000+02:00
The led_set_brightness API says that brightness is defined as
percentage, add a macro from the max and use it everywhere.

Signed-off-by: Fabio Baltieri &lt;fabiobaltieri@google.com&gt;
diff --git a/drivers/led/ht16k33.c b/drivers/led/ht16k33.c
@@ -305,7 +305,7 @@ static int ht16k33_init(const struct device *dev)
 	dev_data->min_period = 0U;
 	dev_data->max_period = 2000U;
 	dev_data->min_brightness = 0U;
-	dev_data->max_brightness = 100U;
+	dev_data->max_brightness = LED_BRIGTHNESS_MAX;
 
 	/* System oscillator on */
 	cmd[0] = HT16K33_CMD_SYSTEM_SETUP | HT16K33_OPT_S;
diff --git a/drivers/led/is31fl3194.c b/drivers/led/is31fl3194.c
@@ -145,12 +145,12 @@ static int is31fl3194_set_brightness(const struct device *dev, uint32_t led, uin
 		return -ENOTSUP;
 	}
 
-	if (value > 100) {
+	if (value > LED_BRIGTHNESS_MAX) {
 		return -EINVAL;
 	}
 
 	/* Rescale 0..100 to 0..255 */
-	value = value * 255 / 100;
+	value = value * 255 / LED_BRIGTHNESS_MAX;
 
 	ret = i2c_reg_write_byte_dt(&config->bus, led_channels[led], value);
 	if (ret == 0) {
@@ -168,7 +168,7 @@ static int is31fl3194_set_brightness(const struct device *dev, uint32_t led, uin
 
 static inline int is31fl3194_led_on(const struct device *dev, uint32_t led)
 {
-	return is31fl3194_set_brightness(dev, led, 100);
+	return is31fl3194_set_brightness(dev, led, LED_BRIGTHNESS_MAX);
 }
 
 static inline int is31fl3194_led_off(const struct device *dev, uint32_t led)
diff --git a/drivers/led/is31fl3216a.c b/drivers/led/is31fl3216a.c
@@ -62,7 +62,7 @@ static int is31fl3216a_update_pwm(const struct i2c_dt_spec *i2c)
 
 static uint8_t is31fl3216a_brightness_to_pwm(uint8_t brightness)
 {
-	return (0xFFU * brightness) / 100;
+	return (0xFFU * brightness) / LED_BRIGTHNESS_MAX;
 }
 
 static int is31fl3216a_led_write_channels(const struct device *dev,
@@ -87,7 +87,7 @@ static int is31fl3216a_led_write_channels(const struct device *dev,
 	i2c_buffer[0] = IS31FL3216A_REG_PWM_LAST - start_channel -
 			(num_channels - 1);
 	for (i = 0; i < num_channels; i++) {
-		if (buf[num_channels - i - 1] > 100) {
+		if (buf[num_channels - i - 1] > LED_BRIGTHNESS_MAX) {
 			return -EINVAL;
 		}
 		i2c_buffer[i + 1] = is31fl3216a_brightness_to_pwm(
@@ -111,7 +111,7 @@ static int is31fl3216a_led_set_brightness(const struct device *dev,
 	int status;
 	uint8_t pwm_value;
 
-	if (led > IS31FL3216A_MAX_LEDS - 1 || value > 100) {
+	if (led > IS31FL3216A_MAX_LEDS - 1 || value > LED_BRIGTHNESS_MAX) {
 		return -EINVAL;
 	}
 
@@ -126,7 +126,7 @@ static int is31fl3216a_led_set_brightness(const struct device *dev,
 
 static int is31fl3216a_led_on(const struct device *dev, uint32_t led)
 {
-	return is31fl3216a_led_set_brightness(dev, led, 100);
+	return is31fl3216a_led_set_brightness(dev, led, LED_BRIGTHNESS_MAX);
 }
 
 static int is31fl3216a_led_off(const struct device *dev, uint32_t led)
diff --git a/drivers/led/is31fl3733.c b/drivers/led/is31fl3733.c
@@ -43,8 +43,6 @@ LOG_MODULE_REGISTER(is31fl3733, CONFIG_LED_LOG_LEVEL);
 #define IS31FL3733_MAX_LED (IS31FL3733_ROW_COUNT * IS31FL3733_COL_COUNT)
 
 /* Max brightness */
-#define IS31FL3733_MAX_BRIGHTNESS 100
-
 struct is31fl3733_config {
 	struct i2c_dt_spec bus;
 	struct gpio_dt_spec sdb;
@@ -98,7 +96,7 @@ static int is31fl3733_led_set_brightness(const struct device *dev, uint32_t led,
 {
 	const struct is31fl3733_config *config = dev->config;
 	int ret;
-	uint8_t led_brightness = (uint8_t)(((uint32_t)value * 255) / 100);
+	uint8_t led_brightness = (uint8_t)(((uint32_t)value * 255) / LED_BRIGTHNESS_MAX);
 
 	if (led >= IS31FL3733_MAX_LED) {
 		return -EINVAL;
@@ -115,7 +113,7 @@ static int is31fl3733_led_set_brightness(const struct device *dev, uint32_t led,
 
 static int is31fl3733_led_on(const struct device *dev, uint32_t led)
 {
-	return is31fl3733_led_set_brightness(dev, led, IS31FL3733_MAX_BRIGHTNESS);
+	return is31fl3733_led_set_brightness(dev, led, LED_BRIGTHNESS_MAX);
 }
 
 static int is31fl3733_led_off(const struct device *dev, uint32_t led)
diff --git a/drivers/led/led_dac.c b/drivers/led/led_dac.c
@@ -43,7 +43,7 @@ static int led_dac_set_brightness(const struct device *dev, uint32_t led, uint8_
 	value = pct > 0 ? config->leds[led].dac_min_brightness +
 				  (uint64_t)(config->leds[led].dac_max_brightness -
 					     config->leds[led].dac_min_brightness) *
-					  pct / 100
+					  pct / LED_BRIGTHNESS_MAX
 			: 0;
 
 	return led_dac_set_raw(dev, led, value);
diff --git a/drivers/led/led_gpio.c b/drivers/led/led_gpio.c
@@ -30,7 +30,7 @@ static int led_gpio_set_brightness(const struct device *dev, uint32_t led, uint8
 	const struct led_gpio_config *config = dev->config;
 	const struct gpio_dt_spec *led_gpio;
 
-	if ((led >= config->num_leds) || (value > 100)) {
+	if ((led >= config->num_leds) || (value > LED_BRIGTHNESS_MAX)) {
 		return -EINVAL;
 	}
 
@@ -41,7 +41,7 @@ static int led_gpio_set_brightness(const struct device *dev, uint32_t led, uint8
 
 static int led_gpio_on(const struct device *dev, uint32_t led)
 {
-	return led_gpio_set_brightness(dev, led, 100);
+	return led_gpio_set_brightness(dev, led, LED_BRIGTHNESS_MAX);
 }
 
 static int led_gpio_off(const struct device *dev, uint32_t led)
diff --git a/drivers/led/led_pwm.c b/drivers/led/led_pwm.c
@@ -58,19 +58,19 @@ static int led_pwm_set_brightness(const struct device *dev,
 	const struct led_pwm_config *config = dev->config;
 	const struct pwm_dt_spec *dt_led;
 
-	if (led >= config->num_leds || value > 100) {
+	if (led >= config->num_leds || value > LED_BRIGTHNESS_MAX) {
 		return -EINVAL;
 	}
 
 	dt_led = &config->led[led];
 
 	return pwm_set_pulse_dt(&config->led[led],
-			(uint32_t) ((uint64_t) dt_led->period * value / 100));
+			(uint32_t) ((uint64_t) dt_led->period * value / LED_BRIGTHNESS_MAX));
 }
 
 static int led_pwm_on(const struct device *dev, uint32_t led)
 {
-	return led_pwm_set_brightness(dev, led, 100);
+	return led_pwm_set_brightness(dev, led, LED_BRIGTHNESS_MAX);
 }
 
 static int led_pwm_off(const struct device *dev, uint32_t led)
diff --git a/drivers/led/led_shell.c b/drivers/led/led_shell.c
@@ -164,7 +164,7 @@ static int cmd_set_brightness(const struct shell *sh,
 			     argv[arg_idx_value]);
 		return -EINVAL;
 	}
-	if (value > 100) {
+	if (value > LED_BRIGTHNESS_MAX) {
 		shell_error(sh, "Invalid LED brightness value %lu (max 100)",
 			    value);
 		return -EINVAL;
diff --git a/drivers/led/lp3943.c b/drivers/led/lp3943.c
@@ -264,7 +264,7 @@ static int lp3943_led_init(const struct device *dev)
 	dev_data->min_period = 0U;
 	dev_data->max_period = 1600U;
 	dev_data->min_brightness = 0U;
-	dev_data->max_brightness = 100U;
+	dev_data->max_brightness = LED_BRIGTHNESS_MAX;
 
 	return 0;
 }
diff --git a/drivers/led/lp50xx.c b/drivers/led/lp50xx.c
@@ -23,8 +23,6 @@
 #include <zephyr/logging/log.h>
 LOG_MODULE_REGISTER(lp50xx, CONFIG_LED_LOG_LEVEL);
 
-#define LP50XX_MAX_BRIGHTNESS		100U
-
 /*
  * Number of supported RGB led modules per chipset.
  *
@@ -126,21 +124,21 @@ static int lp50xx_set_brightness(const struct device *dev,
 		return -ENODEV;
 	}
 
-	if (value > LP50XX_MAX_BRIGHTNESS) {
+	if (value > LED_BRIGTHNESS_MAX) {
 		LOG_ERR("%s: brightness value out of bounds: val=%d, max=%d",
-			dev->name, value, LP50XX_MAX_BRIGHTNESS);
+			dev->name, value, LED_BRIGTHNESS_MAX);
 		return -EINVAL;
 	}
 
 	buf[0] = LP50XX_LED0_BRIGHTNESS(config->num_modules) + led_info->index;
-	buf[1] = (value * 0xff) / 100;
+	buf[1] = (value * 0xff) / LED_BRIGTHNESS_MAX;
 
 	return i2c_write_dt(&config->bus, buf, sizeof(buf));
 }
 
 static int lp50xx_on(const struct device *dev, uint32_t led)
 {
-	return lp50xx_set_brightness(dev, led, 100);
+	return lp50xx_set_brightness(dev, led, LED_BRIGTHNESS_MAX);
 }
 
 static int lp50xx_off(const struct device *dev, uint32_t led)
diff --git a/drivers/led/lp5562.c b/drivers/led/lp5562.c
@@ -81,7 +81,7 @@ LOG_MODULE_REGISTER(lp5562);
 
 /* Brightness limits in percent */
 #define LP5562_MIN_BRIGHTNESS 0
-#define LP5562_MAX_BRIGHTNESS 100
+#define LP5562_MAX_BRIGHTNESS LED_BRIGTHNESS_MAX
 
 /* Output current limits in 0.1 mA */
 #define LP5562_MIN_CURRENT_SETTING 0
diff --git a/drivers/led/lp5569.c b/drivers/led/lp5569.c
@@ -49,12 +49,12 @@ static int lp5569_led_set_brightness(const struct device *dev, uint32_t led, uin
 	uint8_t val;
 	int ret;
 
-	if (led >= LP5569_NUM_LEDS || brightness > 100) {
+	if (led >= LP5569_NUM_LEDS || brightness > LED_BRIGTHNESS_MAX) {
 		return -EINVAL;
 	}
 
 	/* Map 0-100 % to 0-255 pwm register value */
-	val = brightness * 255 / 100;
+	val = brightness * 255 / LED_BRIGTHNESS_MAX;
 
 	ret = i2c_reg_write_byte_dt(&config->bus, LP5569_LED0_PWM + led, val);
 	if (ret < 0) {
@@ -68,7 +68,7 @@ static int lp5569_led_set_brightness(const struct device *dev, uint32_t led, uin
 static inline int lp5569_led_on(const struct device *dev, uint32_t led)
 {
 	/* Set LED brightness to 100 % */
-	return lp5569_led_set_brightness(dev, led, 100);
+	return lp5569_led_set_brightness(dev, led, LED_BRIGTHNESS_MAX);
 }
 
 static inline int lp5569_led_off(const struct device *dev, uint32_t led)
diff --git a/drivers/led/ncp5623.c b/drivers/led/ncp5623.c
@@ -100,7 +100,7 @@ static int ncp5623_set_brightness(const struct device *dev, uint32_t led, uint8_
 		return -ENODEV;
 	}
 
-	if (value > 100) {
+	if (value > LED_BRIGTHNESS_MAX) {
 		return -EINVAL;
 	}
 
@@ -109,7 +109,7 @@ static int ncp5623_set_brightness(const struct device *dev, uint32_t led, uint8_
 	}
 
 	/* Rescale 0..100 to 0..31 */
-	value = value * NCP5623_MAX_BRIGHTNESS / 100;
+	value = value * NCP5623_MAX_BRIGHTNESS / LED_BRIGTHNESS_MAX;
 
 	ret = i2c_reg_write_byte_dt(&config->bus, led_channels[led] | value, 0x70);
 
@@ -122,7 +122,7 @@ static int ncp5623_set_brightness(const struct device *dev, uint32_t led, uint8_
 
 static inline int ncp5623_led_on(const struct device *dev, uint32_t led)
 {
-	return ncp5623_set_brightness(dev, led, 100);
+	return ncp5623_set_brightness(dev, led, LED_BRIGTHNESS_MAX);
 }
 
 static inline int ncp5623_led_off(const struct device *dev, uint32_t led)
diff --git a/drivers/led/pca9633.c b/drivers/led/pca9633.c
@@ -211,7 +211,7 @@ static int pca9633_led_init(const struct device *dev)
 	dev_data->min_period = 41U;
 	dev_data->max_period = 10667U;
 	dev_data->min_brightness = 0U;
-	dev_data->max_brightness = 100U;
+	dev_data->max_brightness = LED_BRIGTHNESS_MAX;
 
 	return 0;
 }
diff --git a/drivers/led/tlc59108.c b/drivers/led/tlc59108.c
@@ -203,7 +203,7 @@ static int tlc59108_led_init(const struct device *dev)
 	dev_data->min_period = 41U;
 	dev_data->max_period = 10730U;
 	dev_data->min_brightness = 0U;
-	dev_data->max_brightness = 100U;
+	dev_data->max_brightness = LED_BRIGTHNESS_MAX;
 
 	return 0;
 }
diff --git a/include/zephyr/drivers/led.h b/include/zephyr/drivers/led.h
@@ -30,6 +30,11 @@
 extern "C" {
 #endif
 
+/**
+ * @brief Maximum brightness level, range is 0 to 100.
+ */
+#define LED_BRIGTHNESS_MAX 100u
+
 /**
  * @brief LED information structure
  *

Original file line number	Diff line number	Diff line change
`@@ -145,12 +145,12 @@ static int is31fl3194_set_brightness(const struct device *dev, uint32_t led, uin`
`145`	`145`	`return -ENOTSUP;`
`146`	`146`	`}`
`147`	`147`
`148`		`- if (value > 100) {`
	`148`	`+ if (value > LED_BRIGTHNESS_MAX) {`
`149`	`149`	`return -EINVAL;`
`150`	`150`	`}`
`151`	`151`
`152`	`152`	`/* Rescale 0..100 to 0..255 */`
`153`		`- value = value * 255 / 100;`
	`153`	`+ value = value * 255 / LED_BRIGTHNESS_MAX;`
`154`	`154`
`155`	`155`	`ret = i2c_reg_write_byte_dt(&config->bus, led_channels[led], value);`
`156`	`156`	`if (ret == 0) {`
`@@ -168,7 +168,7 @@ static int is31fl3194_set_brightness(const struct device *dev, uint32_t led, uin`
`168`	`168`
`169`	`169`	`static inline int is31fl3194_led_on(const struct device *dev, uint32_t led)`
`170`	`170`	`{`
`171`		`- return is31fl3194_set_brightness(dev, led, 100);`
	`171`	`+ return is31fl3194_set_brightness(dev, led, LED_BRIGTHNESS_MAX);`
`172`	`172`	`}`
`173`	`173`
`174`	`174`	`static inline int is31fl3194_led_off(const struct device *dev, uint32_t led)`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ static int is31fl3216a_update_pwm(const struct i2c_dt_spec *i2c)`
`62`	`62`
`63`	`63`	`static uint8_t is31fl3216a_brightness_to_pwm(uint8_t brightness)`
`64`	`64`	`{`
`65`		`- return (0xFFU * brightness) / 100;`
	`65`	`+ return (0xFFU * brightness) / LED_BRIGTHNESS_MAX;`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`static int is31fl3216a_led_write_channels(const struct device *dev,`
`@@ -87,7 +87,7 @@ static int is31fl3216a_led_write_channels(const struct device *dev,`
`87`	`87`	`i2c_buffer[0] = IS31FL3216A_REG_PWM_LAST - start_channel -`
`88`	`88`	`(num_channels - 1);`
`89`	`89`	`for (i = 0; i < num_channels; i++) {`
`90`		`- if (buf[num_channels - i - 1] > 100) {`
	`90`	`+ if (buf[num_channels - i - 1] > LED_BRIGTHNESS_MAX) {`
`91`	`91`	`return -EINVAL;`
`92`	`92`	`}`
`93`	`93`	`i2c_buffer[i + 1] = is31fl3216a_brightness_to_pwm(`
`@@ -111,7 +111,7 @@ static int is31fl3216a_led_set_brightness(const struct device *dev,`
`111`	`111`	`int status;`
`112`	`112`	`uint8_t pwm_value;`
`113`	`113`
`114`		`- if (led > IS31FL3216A_MAX_LEDS - 1 \|\| value > 100) {`
	`114`	`+ if (led > IS31FL3216A_MAX_LEDS - 1 \|\| value > LED_BRIGTHNESS_MAX) {`
`115`	`115`	`return -EINVAL;`
`116`	`116`	`}`
`117`	`117`
`@@ -126,7 +126,7 @@ static int is31fl3216a_led_set_brightness(const struct device *dev,`
`126`	`126`
`127`	`127`	`static int is31fl3216a_led_on(const struct device *dev, uint32_t led)`
`128`	`128`	`{`
`129`		`- return is31fl3216a_led_set_brightness(dev, led, 100);`
	`129`	`+ return is31fl3216a_led_set_brightness(dev, led, LED_BRIGTHNESS_MAX);`
`130`	`130`	`}`
`131`	`131`
`132`	`132`	`static int is31fl3216a_led_off(const struct device *dev, uint32_t led)`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ static int led_gpio_set_brightness(const struct device *dev, uint32_t led, uint8`
`30`	`30`	`const struct led_gpio_config *config = dev->config;`
`31`	`31`	`const struct gpio_dt_spec *led_gpio;`
`32`	`32`
`33`		`- if ((led >= config->num_leds) \|\| (value > 100)) {`
	`33`	`+ if ((led >= config->num_leds) \|\| (value > LED_BRIGTHNESS_MAX)) {`
`34`	`34`	`return -EINVAL;`
`35`	`35`	`}`
`36`	`36`
`@@ -41,7 +41,7 @@ static int led_gpio_set_brightness(const struct device *dev, uint32_t led, uint8`
`41`	`41`
`42`	`42`	`static int led_gpio_on(const struct device *dev, uint32_t led)`
`43`	`43`	`{`
`44`		`- return led_gpio_set_brightness(dev, led, 100);`
	`44`	`+ return led_gpio_set_brightness(dev, led, LED_BRIGTHNESS_MAX);`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`static int led_gpio_off(const struct device *dev, uint32_t led)`
Original file line number	Diff line number	Diff line change
`@@ -58,19 +58,19 @@ static int led_pwm_set_brightness(const struct device *dev,`
`58`	`58`	`const struct led_pwm_config *config = dev->config;`
`59`	`59`	`const struct pwm_dt_spec *dt_led;`
`60`	`60`
`61`		`- if (led >= config->num_leds \|\| value > 100) {`
	`61`	`+ if (led >= config->num_leds \|\| value > LED_BRIGTHNESS_MAX) {`
`62`	`62`	`return -EINVAL;`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`dt_led = &config->led[led];`
`66`	`66`
`67`	`67`	`return pwm_set_pulse_dt(&config->led[led],`
`68`		`- (uint32_t) ((uint64_t) dt_led->period * value / 100));`
	`68`	`+ (uint32_t) ((uint64_t) dt_led->period * value / LED_BRIGTHNESS_MAX));`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`static int led_pwm_on(const struct device *dev, uint32_t led)`
`72`	`72`	`{`
`73`		`- return led_pwm_set_brightness(dev, led, 100);`
	`73`	`+ return led_pwm_set_brightness(dev, led, LED_BRIGTHNESS_MAX);`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`static int led_pwm_off(const struct device *dev, uint32_t led)`
Original file line number	Diff line number	Diff line change
`@@ -164,7 +164,7 @@ static int cmd_set_brightness(const struct shell *sh,`
`164`	`164`	`argv[arg_idx_value]);`
`165`	`165`	`return -EINVAL;`
`166`	`166`	`}`
`167`		`- if (value > 100) {`
	`167`	`+ if (value > LED_BRIGTHNESS_MAX) {`
`168`	`168`	`shell_error(sh, "Invalid LED brightness value %lu (max 100)",`
`169`	`169`	`value);`
`170`	`170`	`return -EINVAL;`
Original file line number	Diff line number	Diff line change
`@@ -264,7 +264,7 @@ static int lp3943_led_init(const struct device *dev)`
`264`	`264`	`dev_data->min_period = 0U;`
`265`	`265`	`dev_data->max_period = 1600U;`
`266`	`266`	`dev_data->min_brightness = 0U;`
`267`		`- dev_data->max_brightness = 100U;`
	`267`	`+ dev_data->max_brightness = LED_BRIGTHNESS_MAX;`
`268`	`268`
`269`	`269`	`return 0;`
`270`	`270`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,8 +23,6 @@`
`23`	`23`	`#include <zephyr/logging/log.h>`
`24`	`24`	`LOG_MODULE_REGISTER(lp50xx, CONFIG_LED_LOG_LEVEL);`
`25`	`25`
`26`		`-#define LP50XX_MAX_BRIGHTNESS 100U`
`27`		`-`
`28`	`26`	`/*`
`29`	`27`	`* Number of supported RGB led modules per chipset.`
`30`	`28`	`*`
`@@ -126,21 +124,21 @@ static int lp50xx_set_brightness(const struct device *dev,`
`126`	`124`	`return -ENODEV;`
`127`	`125`	`}`
`128`	`126`
`129`		`- if (value > LP50XX_MAX_BRIGHTNESS) {`
	`127`	`+ if (value > LED_BRIGTHNESS_MAX) {`
`130`	`128`	`LOG_ERR("%s: brightness value out of bounds: val=%d, max=%d",`
`131`		`- dev->name, value, LP50XX_MAX_BRIGHTNESS);`
	`129`	`+ dev->name, value, LED_BRIGTHNESS_MAX);`
`132`	`130`	`return -EINVAL;`
`133`	`131`	`}`
`134`	`132`
`135`	`133`	`buf[0] = LP50XX_LED0_BRIGHTNESS(config->num_modules) + led_info->index;`
`136`		`- buf[1] = (value * 0xff) / 100;`
	`134`	`+ buf[1] = (value * 0xff) / LED_BRIGTHNESS_MAX;`
`137`	`135`
`138`	`136`	`return i2c_write_dt(&config->bus, buf, sizeof(buf));`
`139`	`137`	`}`
`140`	`138`
`141`	`139`	`static int lp50xx_on(const struct device *dev, uint32_t led)`
`142`	`140`	`{`
`143`		`- return lp50xx_set_brightness(dev, led, 100);`
	`141`	`+ return lp50xx_set_brightness(dev, led, LED_BRIGTHNESS_MAX);`
`144`	`142`	`}`
`145`	`143`
`146`	`144`	`static int lp50xx_off(const struct device *dev, uint32_t led)`