cleanup: include/: move led.h to drivers/led.h

move led.h to drivers/led.h and
create a shim for backward-compatibility.

No functional changes to the headers.
A warning in the shim can be controlled with CONFIG_COMPAT_INCLUDES.

Related to #16539

Signed-off-by: Anas Nashif <anas.nashif@intel.com>

drivers/led/ht16k33.c

@@ -12,7 +12,7 @@
 #include <drivers/gpio.h>
 #include <drivers/i2c.h>
 #include <kernel.h>
-#include <led.h>
+#include <drivers/led.h>
 #include <misc/byteorder.h>
 #include <zephyr.h>
 

drivers/led/led_handlers.c

@@ -5,7 +5,7 @@
  */
 
 #include <syscall_handler.h>
-#include <led.h>
+#include <drivers/led.h>
 
 Z_SYSCALL_HANDLER(led_blink, dev, led, delay_on, delay_off)
 {

drivers/led/lp3943.c

@@ -18,7 +18,7 @@
  */
 
 #include <drivers/i2c.h>
-#include <led.h>
+#include <drivers/led.h>
 #include <misc/util.h>
 #include <zephyr.h>
 

drivers/led/lp5562.c

@@ -29,7 +29,7 @@
  */
 
 #include <drivers/i2c.h>
-#include <led.h>
+#include <drivers/led.h>
 #include <device.h>
 #include <zephyr.h>
 

drivers/led/pca9633.c

@@ -10,7 +10,7 @@
  */
 
 #include <drivers/i2c.h>
-#include <led.h>
+#include <drivers/led.h>
 #include <misc/util.h>
 #include <zephyr.h>
 

include/drivers/led.h

@@ -0,0 +1,145 @@
+/*
+ * Copyright (c) 2018 Linaro Limited
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_DRIVERS_LED_H_
+#define ZEPHYR_INCLUDE_DRIVERS_LED_H_
+
+/**
+ * @file
+ * @brief Public LED driver APIs
+ */
+
+#include <zephyr/types.h>
+#include <device.h>
+
+/**
+ * @typedef led_api_blink()
+ * @brief Callback API for blinking an LED
+ *
+ * @see led_blink() for argument descriptions.
+ */
+typedef int (*led_api_blink)(struct device *dev, u32_t led,
+			     u32_t delay_on, u32_t delay_off);
+
+/**
+ * @typedef led_api_set_brightness()
+ * @brief Callback API for setting brightness of an LED
+ *
+ * @see led_set_brightness() for argument descriptions.
+ */
+typedef int (*led_api_set_brightness)(struct device *dev, u32_t led,
+				      u8_t value);
+/**
+ * @typedef led_api_on()
+ * @brief Callback API for turning on an LED
+ *
+ * @see led_on() for argument descriptions.
+ */
+typedef int (*led_api_on)(struct device *dev, u32_t led);
+
+/**
+ * @typedef led_api_off()
+ * @brief Callback API for turning off an LED
+ *
+ * @see led_off() for argument descriptions.
+ */
+typedef int (*led_api_off)(struct device *dev, u32_t led);
+
+/**
+ * @brief LED driver API
+ *
+ * This is the mandatory API any LED driver needs to expose.
+ */
+struct led_driver_api {
+	led_api_blink blink;
+	led_api_set_brightness set_brightness;
+	led_api_on on;
+	led_api_off off;
+};
+
+/**
+ * @brief Blink an LED
+ *
+ * This routine starts blinking an LED forever with the given time period
+ *
+ * @param dev LED device
+ * @param led LED channel/pin
+ * @param delay_on Time period (in milliseconds) an LED should be ON
+ * @param delay_off Time period (in milliseconds) an LED should be OFF
+ * @return 0 on success, negative on error
+ */
+__syscall int led_blink(struct device *dev, u32_t led,
+			    u32_t delay_on, u32_t delay_off);
+
+static inline int z_impl_led_blink(struct device *dev, u32_t led,
+			    u32_t delay_on, u32_t delay_off)
+{
+	const struct led_driver_api *api = dev->driver_api;
+
+	return api->blink(dev, led, delay_on, delay_off);
+}
+
+/**
+ * @brief Set LED brightness
+ *
+ * This routine sets the brightness of a LED to the given value.
+ * Calling this function after led_blink() won't affect blinking.
+ *
+ * @param dev LED device
+ * @param led LED channel/pin
+ * @param value Brightness value to set in percent
+ * @return 0 on success, negative on error
+ */
+__syscall int led_set_brightness(struct device *dev, u32_t led,
+				     u8_t value);
+
+static inline int z_impl_led_set_brightness(struct device *dev, u32_t led,
+				     u8_t value)
+{
+	const struct led_driver_api *api = dev->driver_api;
+
+	return api->set_brightness(dev, led, value);
+}
+
+/**
+ * @brief Turn on an LED
+ *
+ * This routine turns on an LED
+ *
+ * @param dev LED device
+ * @param led LED channel/pin
+ * @return 0 on success, negative on error
+ */
+__syscall int led_on(struct device *dev, u32_t led);
+
+static inline int z_impl_led_on(struct device *dev, u32_t led)
+{
+	const struct led_driver_api *api = dev->driver_api;
+
+	return api->on(dev, led);
+}
+
+/**
+ * @brief Turn off an LED
+ *
+ * This routine turns off an LED
+ *
+ * @param dev LED device
+ * @param led LED channel/pin
+ * @return 0 on success, negative on error
+ */
+__syscall int led_off(struct device *dev, u32_t led);
+
+static inline int z_impl_led_off(struct device *dev, u32_t led)
+{
+	const struct led_driver_api *api = dev->driver_api;
+
+	return api->off(dev, led);
+}
+
+#include <syscalls/led.h>
+
+#endif	/* ZEPHYR_INCLUDE_DRIVERS_LED_H_ */

include/led.h

@@ -1,145 +1,15 @@
 /*
- * Copyright (c) 2018 Linaro Limited
+ * Copyright (c) 2019 Intel Corporation
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-
 #ifndef ZEPHYR_INCLUDE_LED_H_
 #define ZEPHYR_INCLUDE_LED_H_
 
-/**
+#ifndef CONFIG_COMPAT_INCLUDES
- * @file
+#warning "This header file has moved, include <drivers/led.h> instead."
- * @brief Public LED driver APIs
+#endif
- */
 
-#include <zephyr/types.h>
+#include <drivers/led.h>
-#include <device.h>
 
-/**
+#endif /* ZEPHYR_INCLUDE_LED_H_ */
- * @typedef led_api_blink()
- * @brief Callback API for blinking an LED
- *
- * @see led_blink() for argument descriptions.
- */
-typedef int (*led_api_blink)(struct device *dev, u32_t led,
-			     u32_t delay_on, u32_t delay_off);
-
-/**
- * @typedef led_api_set_brightness()
- * @brief Callback API for setting brightness of an LED
- *
- * @see led_set_brightness() for argument descriptions.
- */
-typedef int (*led_api_set_brightness)(struct device *dev, u32_t led,
-				      u8_t value);
-/**
- * @typedef led_api_on()
- * @brief Callback API for turning on an LED
- *
- * @see led_on() for argument descriptions.
- */
-typedef int (*led_api_on)(struct device *dev, u32_t led);
-
-/**
- * @typedef led_api_off()
- * @brief Callback API for turning off an LED
- *
- * @see led_off() for argument descriptions.
- */
-typedef int (*led_api_off)(struct device *dev, u32_t led);
-
-/**
- * @brief LED driver API
- *
- * This is the mandatory API any LED driver needs to expose.
- */
-struct led_driver_api {
-	led_api_blink blink;
-	led_api_set_brightness set_brightness;
-	led_api_on on;
-	led_api_off off;
-};
-
-/**
- * @brief Blink an LED
- *
- * This routine starts blinking an LED forever with the given time period
- *
- * @param dev LED device
- * @param led LED channel/pin
- * @param delay_on Time period (in milliseconds) an LED should be ON
- * @param delay_off Time period (in milliseconds) an LED should be OFF
- * @return 0 on success, negative on error
- */
-__syscall int led_blink(struct device *dev, u32_t led,
-			    u32_t delay_on, u32_t delay_off);
-
-static inline int z_impl_led_blink(struct device *dev, u32_t led,
-			    u32_t delay_on, u32_t delay_off)
-{
-	const struct led_driver_api *api = dev->driver_api;
-
-	return api->blink(dev, led, delay_on, delay_off);
-}
-
-/**
- * @brief Set LED brightness
- *
- * This routine sets the brightness of a LED to the given value.
- * Calling this function after led_blink() won't affect blinking.
- *
- * @param dev LED device
- * @param led LED channel/pin
- * @param value Brightness value to set in percent
- * @return 0 on success, negative on error
- */
-__syscall int led_set_brightness(struct device *dev, u32_t led,
-				     u8_t value);
-
-static inline int z_impl_led_set_brightness(struct device *dev, u32_t led,
-				     u8_t value)
-{
-	const struct led_driver_api *api = dev->driver_api;
-
-	return api->set_brightness(dev, led, value);
-}
-
-/**
- * @brief Turn on an LED
- *
- * This routine turns on an LED
- *
- * @param dev LED device
- * @param led LED channel/pin
- * @return 0 on success, negative on error
- */
-__syscall int led_on(struct device *dev, u32_t led);
-
-static inline int z_impl_led_on(struct device *dev, u32_t led)
-{
-	const struct led_driver_api *api = dev->driver_api;
-
-	return api->on(dev, led);
-}
-
-/**
- * @brief Turn off an LED
- *
- * This routine turns off an LED
- *
- * @param dev LED device
- * @param led LED channel/pin
- * @return 0 on success, negative on error
- */
-__syscall int led_off(struct device *dev, u32_t led);
-
-static inline int z_impl_led_off(struct device *dev, u32_t led)
-{
-	const struct led_driver_api *api = dev->driver_api;
-
-	return api->off(dev, led);
-}
-
-#include <syscalls/led.h>
-
-#endif	/* ZEPHYR_INCLUDE_LED_H_ */

samples/boards/96b_argonkey/microphone/src/main.c

@@ -9,7 +9,7 @@
 #include <misc/printk.h>
 
 #include <drivers/gpio.h>
-#include <led.h>
+#include <drivers/led.h>
 
 #include <audio/dmic.h>
 

samples/boards/96b_argonkey/sensors/src/main.c

@@ -8,7 +8,7 @@
 #include <misc/printk.h>
 
 #include <drivers/gpio.h>
-#include <led.h>
+#include <drivers/led.h>
 #include <drivers/i2c.h>
 #include <spi.h>
 #include <sensor.h>

samples/drivers/ht16k33/src/main.c

@@ -5,7 +5,7 @@
  */
 
 #include <device.h>
-#include <led.h>
+#include <drivers/led.h>
 #include <drivers/gpio.h>
 #include <zephyr.h>
 

samples/drivers/led_lp3943/src/main.c

@@ -6,7 +6,7 @@
 
 #include <device.h>
 #include <errno.h>
-#include <led.h>
+#include <drivers/led.h>
 #include <misc/util.h>
 #include <zephyr.h>
 

samples/drivers/led_lp5562/src/main.c

@@ -6,7 +6,7 @@
 
 #include <device.h>
 #include <errno.h>
-#include <led.h>
+#include <drivers/led.h>
 #include <misc/util.h>
 #include <zephyr.h>
 

samples/drivers/led_pca9633/src/main.c

@@ -6,7 +6,7 @@
 
 #include <device.h>
 #include <errno.h>
-#include <led.h>
+#include <drivers/led.h>
 #include <misc/util.h>
 #include <zephyr.h>