Arduino.h: Remove builtin_led_gpios rule

soburi · soburi · commit bb1ef24f87bd · 2025-09-10T16:30:44.000+09:00
Now that GPIO can be specified generically,
we will discontinue the definition generation of LED_BUILTIN from builtin_led_gpios.
Delete this definition where automatic generation from led0 is not an issue,
and define it in variant.h in all other cases.

Signed-off-by: TOKITA Hiroshi &lt;tokita.hiroshi@gmail.com&gt;
diff --git a/cores/arduino/Arduino.h b/cores/arduino/Arduino.h
@@ -49,13 +49,8 @@ int digitalPinToInterrupt(pin_size_t pin);
 
 #include <variant.h>
 
-#ifndef LED_BUILTIN
-#if DT_NODE_HAS_PROP(DT_PATH(zephyr_user), builtin_led_gpios)                                      \
-  && (DT_PROP_LEN(DT_PATH(zephyr_user), builtin_led_gpios) > 0)
-#define LED_BUILTIN ZARD_GLOBAL_GPIO_NUM(DT_PATH(zephyr_user), builtin_led_gpios, 0)
-#elif DT_NODE_EXISTS(DT_ALIAS(led0))
+#if !defined(LED_BUILTIN) && DT_NODE_EXISTS(DT_ALIAS(led0))
 #define LED_BUILTIN ZARD_GLOBAL_GPIO_NUM(DT_ALIAS(led0), gpios, 0)
-#endif
 #endif // LED_BUILTIN
 
 #ifdef __cplusplus
diff --git a/documentation/variants.md b/documentation/variants.md
@@ -151,31 +151,12 @@ The following example instantiates `Wire` and `Wire2` with each `i2c0` and `i2c1
 
 ### Configure Builtin-LED
 
-The `builtin-led-gpios` node defines the Builtin-LED.
-This node defines the `LED_BUILTIN` value by looking up the `digital-pin-gpios`
-array to find the index of the pin.
+If `LED_BUILTIN` is defined, it will take precedence.
+This is usually defined in each board's variant.h file.
 
-The node is phandle-array, which uses the format same as `digital-pin-gpios`.
+If the `LED_BUILTIN` is not defined and the LED node aliased as `led0` available,
+`LED_BUILTIN` referencing `led0` will be automatically defined.
 
-It set the digital pin number to the `LED_BUILTIN` if found the pin
-that defined in `builtin-led-gpios` from `digital-pin-gpios`.
-
-If the `builtin-led-gpios` is not defined, Use the node aliased as `led0`
-to define `LED_BUILTIN`.
-
-The `LED_BUILTIN` does not define here if it has not found both nodes or
-defined `LED_BUILTIN` already.
-
-For example, in the case of the 13th digital pins connected to the onboard LED,
-define `builtin-led-gpios` as follows.
-
-```
-/ {
-	zephyr,user {
-		builtin-led-gpios = <&arduino_nano_header 13 0>;
-	};
-};
-```
 
 ### Overlays from scratch
 
diff --git a/variants/arduino_nano_33_ble_nrf52840/arduino_nano_33_ble_nrf52840.overlay b/variants/arduino_nano_33_ble_nrf52840/arduino_nano_33_ble_nrf52840.overlay
@@ -40,8 +40,6 @@
 				    <&arduino_nano_header 20 0>,
 				    <&arduino_nano_header 21 0>;
 
-		builtin-led-gpios = <&arduino_nano_header 13 0>;
-
 		pwms =	<&pwm1 1 255 PWM_POLARITY_NORMAL>,
 			<&pwm1 2 255 PWM_POLARITY_NORMAL>,
 			<&pwm1 3 255 PWM_POLARITY_NORMAL>,
diff --git a/variants/arduino_nano_33_ble_nrf52840/variant.h b/variants/arduino_nano_33_ble_nrf52840/variant.h
@@ -3,3 +3,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
+
+#pragma once
+
+#define LED_BUILTIN D13
diff --git a/variants/arduino_nano_33_ble_nrf52840_sense/arduino_nano_33_ble_nrf52840_sense.overlay b/variants/arduino_nano_33_ble_nrf52840_sense/arduino_nano_33_ble_nrf52840_sense.overlay
@@ -40,8 +40,6 @@
 				    <&arduino_nano_header 20 0>,
 				    <&arduino_nano_header 21 0>;
 
-		builtin-led-gpios = <&arduino_nano_header 13 0>;
-
 		pwms =	<&pwm1 1 255 PWM_POLARITY_NORMAL>,
 			<&pwm1 2 255 PWM_POLARITY_NORMAL>,
 			<&pwm1 3 255 PWM_POLARITY_NORMAL>,
diff --git a/variants/arduino_nano_33_ble_nrf52840_sense/variant.h b/variants/arduino_nano_33_ble_nrf52840_sense/variant.h
@@ -3,3 +3,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
+
+#pragma once
+
+#define LED_BUILTIN D13
diff --git a/variants/beagleconnect_freedom_cc1352p7/beagleconnect_freedom_cc1352p7.overlay b/variants/beagleconnect_freedom_cc1352p7/beagleconnect_freedom_cc1352p7.overlay
@@ -57,8 +57,6 @@
  			    <&gpio0 27 GPIO_ACTIVE_HIGH>, /* D7  - MB2 CS - A4 */
  			    <&gpio0 28 GPIO_ACTIVE_HIGH>; /* D3  - MB1 CS - A5 */
 
- 	builtin-led-gpios = <&gpio0 18 GPIO_ACTIVE_HIGH>;	/*  2.4GHz TX/RX  */
-
 	gpio-ports = <&gpio0>;
  	serials = <&uart0 &uart1>;
  	i2cs = <&i2c0>;
diff --git a/variants/cc3220sf_launchxl_cc3220sf/cc3220sf_launchxl_cc3220sf.overlay b/variants/cc3220sf_launchxl_cc3220sf/cc3220sf_launchxl_cc3220sf.overlay
@@ -29,7 +29,6 @@
 				<&boosterpack_header 30 0>,	/* GPIO_00 */
 				<&boosterpack_header 31 0>,	/* GPIO_24 */
 				<&boosterpack_header 32 0>;	/* GPIO_23 */
-		builtin-led-gpios = <&boosterpack_header 10 0>;	/*  GREEN_LED  */
 
 		gpio-ports = <&gpioa0>, <&gpioa1>, <&gpioa2>, <&gpioa3>;
 		serials = <&boosterpack_serial>;
diff --git a/variants/rpi_pico_rp2040/rpi_pico_rp2040.overlay b/variants/rpi_pico_rp2040/rpi_pico_rp2040.overlay
@@ -38,8 +38,6 @@
 				    <&pico_header 27 0>,
 				    <&pico_header 28 0>;
 
-		builtin-led-gpios = <&gpio0 25 0>;
-
 		pwm-pin-gpios =     <&pico_header 2 0>,
 				    <&pico_header 3 0>,
 				    <&pico_header 7 0>,

Original file line number	Diff line number	Diff line change
`@@ -3,3 +3,7 @@`
`3`	`3`	`*`
`4`	`4`	`* SPDX-License-Identifier: Apache-2.0`
`5`	`5`	`*/`
	`6`	`+`
	`7`	`+#pragma once`
	`8`	`+`
	`9`	`+#define LED_BUILTIN D13`