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

move entropy.h to drivers/entropy.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/entropy/entropy_cc13xx_cc26xx.c

@@ -6,7 +6,7 @@
 
 #include <kernel.h>
 #include <device.h>
-#include <entropy.h>
+#include <drivers/entropy.h>
 #include <irq.h>
 #include <ring_buffer.h>
 #include <sys/sys_io.h>

drivers/entropy/entropy_esp32.c

@@ -5,7 +5,7 @@
  */
 
 #include <string.h>
-#include <entropy.h>
+#include <drivers/entropy.h>
 
 static inline u32_t entropy_esp32_get_u32(void)
 {

drivers/entropy/entropy_handlers.c

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include <entropy.h>
+#include <drivers/entropy.h>
 #include <syscall_handler.h>
 
 Z_SYSCALL_HANDLER(entropy_get_entropy, dev, buffer, len)

drivers/entropy/entropy_mcux_rnga.c

@@ -5,7 +5,7 @@
  */
 
 #include <device.h>
-#include <entropy.h>
+#include <drivers/entropy.h>
 #include <random/rand32.h>
 #include <init.h>
 

drivers/entropy/entropy_mcux_trng.c

@@ -5,7 +5,7 @@
  */
 
 #include <device.h>
-#include <entropy.h>
+#include <drivers/entropy.h>
 #include <random/rand32.h>
 #include <init.h>
 

drivers/entropy/entropy_nrf5.c

@@ -5,7 +5,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include <entropy.h>
+#include <drivers/entropy.h>
 #include <sys/atomic.h>
 #include <soc.h>
 #include "nrf_rng.h"

drivers/entropy/entropy_sam.c

@@ -5,7 +5,7 @@
  */
 
 #include <device.h>
-#include <entropy.h>
+#include <drivers/entropy.h>
 #include <errno.h>
 #include <init.h>
 #include <soc.h>

drivers/entropy/entropy_stm32.c

@@ -6,7 +6,7 @@
 
 #include <kernel.h>
 #include <device.h>
-#include <entropy.h>
+#include <drivers/entropy.h>
 #include <random/rand32.h>
 #include <init.h>
 #include <misc/__assert.h>

drivers/entropy/fake_entropy_native_posix.c

@@ -12,7 +12,7 @@
  */
 
 #include "device.h"
-#include "entropy.h"
+#include <drivers/entropy.h>
 #include "init.h"
 #include "misc/util.h"
 #include <stdlib.h>

include/drivers/entropy.h

@@ -0,0 +1,119 @@
+/**
+ * @file entropy.h
+ *
+ * @brief Public APIs for the entropy driver.
+ */
+
+/*
+ * Copyright (c) 2016 ARM Ltd.
+ * Copyright (c) 2017 Intel Corporation
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#ifndef ZEPHYR_INCLUDE_DRIVERS_ENTROPY_H_
+#define ZEPHYR_INCLUDE_DRIVERS_ENTROPY_H_
+
+/**
+ * @brief Entropy Interface
+ * @defgroup entropy_interface Entropy Interface
+ * @ingroup io_interfaces
+ * @{
+ */
+
+#include <zephyr/types.h>
+#include <device.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @typedef entropy_get_entropy_t
+ * @brief Callback API to get entropy.
+ *
+ * See entropy_get_entropy() for argument description
+ */
+typedef int (*entropy_get_entropy_t)(struct device *dev,
+				    u8_t *buffer,
+				    u16_t length);
+/**
+ * @typedef entropy_get_entropy_isr_t
+ * @brief Callback API to get entropy from an ISR.
+ *
+ * See entropy_get_entropy_isr() for argument description
+ */
+typedef int (*entropy_get_entropy_isr_t)(struct device *dev,
+					 u8_t *buffer,
+					 u16_t length,
+					 u32_t flags);
+struct entropy_driver_api {
+	entropy_get_entropy_t     get_entropy;
+	entropy_get_entropy_isr_t get_entropy_isr;
+};
+
+/**
+ * @brief Fills a buffer with entropy. Blocks if required in order to
+ *        generate the necessary random data.
+ *
+ * @param dev Pointer to the entropy device.
+ * @param buffer Buffer to fill with entropy.
+ * @param length Buffer length.
+ * @retval 0 on success.
+ * @retval -ERRNO errno code on error.
+ */
+__syscall int entropy_get_entropy(struct device *dev,
+				  u8_t *buffer,
+				  u16_t length);
+
+static inline int z_impl_entropy_get_entropy(struct device *dev,
+					    u8_t *buffer,
+					    u16_t length)
+{
+	const struct entropy_driver_api *api =
+		(const struct entropy_driver_api *)dev->driver_api;
+
+	__ASSERT(api->get_entropy != NULL,
+		"Callback pointer should not be NULL");
+	return api->get_entropy(dev, buffer, length);
+}
+
+/* Busy-wait for random data to be ready */
+#define ENTROPY_BUSYWAIT  BIT(0)
+
+/**
+ * @brief Fills a buffer with entropy in a non-blocking or busy-wait manner.
+ * 	  Callable from ISRs.
+ *
+ * @param dev Pointer to the device structure.
+ * @param buffer Buffer to fill with entropy.
+ * @param length Buffer length.
+ * @param flags Flags to modify the behavior of the call.
+ * @retval number of bytes filled with entropy or -error.
+ */
+static inline int entropy_get_entropy_isr(struct device *dev,
+					  u8_t *buffer,
+					  u16_t length,
+					  u32_t flags)
+{
+	const struct entropy_driver_api *api =
+		(const struct entropy_driver_api *)dev->driver_api;
+
+	if (unlikely(!api->get_entropy_isr)) {
+		return -ENOTSUP;
+	}
+
+	return api->get_entropy_isr(dev, buffer, length, flags);
+}
+
+
+#ifdef __cplusplus
+}
+#endif
+
+/**
+ * @}
+ */
+
+#include <syscalls/entropy.h>
+
+#endif /* ZEPHYR_INCLUDE_DRIVERS_ENTROPY_H_ */

include/entropy.h

@@ -1,119 +1,15 @@
-/**
- * @file entropy.h
- *
- * @brief Public APIs for the entropy driver.
- */
-
 /*
- * Copyright (c) 2016 ARM Ltd.
+ * Copyright (c) 2019 Intel Corporation
- * Copyright (c) 2017 Intel Corporation
  *
  * SPDX-License-Identifier: Apache-2.0
  */
 #ifndef ZEPHYR_INCLUDE_ENTROPY_H_
 #define ZEPHYR_INCLUDE_ENTROPY_H_
 
-/**
+#ifndef CONFIG_COMPAT_INCLUDES
- * @brief Entropy Interface
+#warning "This header file has moved, include <drivers/entropy.h> instead."
- * @defgroup entropy_interface Entropy Interface
- * @ingroup io_interfaces
- * @{
- */
-
-#include <zephyr/types.h>
-#include <device.h>
-
-#ifdef __cplusplus
-extern "C" {
 #endif
 
-/**
+#include <drivers/entropy.h>
- * @typedef entropy_get_entropy_t
- * @brief Callback API to get entropy.
- *
- * See entropy_get_entropy() for argument description
- */
-typedef int (*entropy_get_entropy_t)(struct device *dev,
-				    u8_t *buffer,
-				    u16_t length);
-/**
- * @typedef entropy_get_entropy_isr_t
- * @brief Callback API to get entropy from an ISR.
- *
- * See entropy_get_entropy_isr() for argument description
- */
-typedef int (*entropy_get_entropy_isr_t)(struct device *dev,
-					 u8_t *buffer,
-					 u16_t length,
-					 u32_t flags);
-struct entropy_driver_api {
-	entropy_get_entropy_t     get_entropy;
-	entropy_get_entropy_isr_t get_entropy_isr;
-};
-
-/**
- * @brief Fills a buffer with entropy. Blocks if required in order to
- *        generate the necessary random data.
- *
- * @param dev Pointer to the entropy device.
- * @param buffer Buffer to fill with entropy.
- * @param length Buffer length.
- * @retval 0 on success.
- * @retval -ERRNO errno code on error.
- */
-__syscall int entropy_get_entropy(struct device *dev,
-				  u8_t *buffer,
-				  u16_t length);
-
-static inline int z_impl_entropy_get_entropy(struct device *dev,
-					    u8_t *buffer,
-					    u16_t length)
-{
-	const struct entropy_driver_api *api =
-		(const struct entropy_driver_api *)dev->driver_api;
-
-	__ASSERT(api->get_entropy != NULL,
-		"Callback pointer should not be NULL");
-	return api->get_entropy(dev, buffer, length);
-}
-
-/* Busy-wait for random data to be ready */
-#define ENTROPY_BUSYWAIT  BIT(0)
-
-/**
- * @brief Fills a buffer with entropy in a non-blocking or busy-wait manner.
- * 	  Callable from ISRs.
- *
- * @param dev Pointer to the device structure.
- * @param buffer Buffer to fill with entropy.
- * @param length Buffer length.
- * @param flags Flags to modify the behavior of the call.
- * @retval number of bytes filled with entropy or -error.
- */
-static inline int entropy_get_entropy_isr(struct device *dev,
-					  u8_t *buffer,
-					  u16_t length,
-					  u32_t flags)
-{
-	const struct entropy_driver_api *api =
-		(const struct entropy_driver_api *)dev->driver_api;
-
-	if (unlikely(!api->get_entropy_isr)) {
-		return -ENOTSUP;
-	}
-
-	return api->get_entropy_isr(dev, buffer, length, flags);
-}
-
-
-#ifdef __cplusplus
-}
-#endif
-
-/**
- * @}
- */
-
-#include <syscalls/entropy.h>
 
 #endif /* ZEPHYR_INCLUDE_ENTROPY_H_ */

kernel/init.c

@@ -29,7 +29,7 @@
 #include <misc/dlist.h>
 #include <kernel_internal.h>
 #include <kswap.h>
-#include <entropy.h>
+#include <drivers/entropy.h>
 #include <logging/log_ctrl.h>
 #include <debug/tracing.h>
 #include <stdbool.h>

samples/drivers/entropy/src/main.c

@@ -5,7 +5,7 @@
  */
 
 #include <zephyr.h>
-#include <entropy.h>
+#include <drivers/entropy.h>
 #include <stdio.h>
 
 void main(void)

samples/net/google_iot_mqtt/src/protocol.c

@@ -13,7 +13,7 @@ LOG_MODULE_DECLARE(net_google_iot_mqtt, LOG_LEVEL_DBG);
 #include <zephyr.h>
 #include <string.h>
 #include <data/jwt.h>
-#include <entropy.h>
+#include <drivers/entropy.h>
 
 #include <net/tls_credentials.h>
 #include <net/mqtt.h>

subsys/bluetooth/controller/ll_sw/ctrl.c

@@ -11,7 +11,7 @@
 
 #include <soc.h>
 #include <device.h>
-#include <entropy.h>
+#include <drivers/entropy.h>
 #include <drivers/clock_control.h>
 #include <bluetooth/hci.h>
 #include <misc/util.h>

subsys/bluetooth/controller/ll_sw/nordic/lll/lll.c

@@ -7,7 +7,7 @@
 #include <errno.h>
 #include <zephyr/types.h>
 #include <device.h>
-#include <entropy.h>
+#include <drivers/entropy.h>
 #include <drivers/clock_control.h>
 #include <drivers/clock_control/nrf_clock_control.h>
 

subsys/bluetooth/controller/ll_sw/ull.c

@@ -10,7 +10,7 @@
 
 #include <zephyr/types.h>
 #include <device.h>
-#include <entropy.h>
+#include <drivers/entropy.h>
 #include <bluetooth/hci.h>
 
 #include "hal/cntr.h"

subsys/bluetooth/controller/ll_sw/ull_conn.c

@@ -7,7 +7,7 @@
 #include <stddef.h>
 #include <zephyr.h>
 #include <device.h>
-#include <entropy.h>
+#include <drivers/entropy.h>
 #include <bluetooth/bluetooth.h>
 #include <misc/byteorder.h>
 

subsys/net/lib/sockets/sockets_can.c

@@ -11,7 +11,7 @@
 LOG_MODULE_REGISTER(net_sock_can, CONFIG_NET_SOCKETS_LOG_LEVEL);
 
 #include <kernel.h>
-#include <entropy.h>
+#include <drivers/entropy.h>
 #include <misc/util.h>
 #include <net/net_context.h>
 #include <net/net_pkt.h>

subsys/net/lib/sockets/sockets_packet.c

@@ -11,7 +11,7 @@
 LOG_MODULE_REGISTER(net_sock_packet, CONFIG_NET_SOCKETS_LOG_LEVEL);
 
 #include <kernel.h>
-#include <entropy.h>
+#include <drivers/entropy.h>
 #include <misc/util.h>
 #include <net/net_context.h>
 #include <net/net_pkt.h>

subsys/net/lib/sockets/sockets_tls.c

@@ -12,7 +12,7 @@
 LOG_MODULE_REGISTER(net_sock_tls, CONFIG_NET_SOCKETS_LOG_LEVEL);
 
 #include <init.h>
-#include <entropy.h>
+#include <drivers/entropy.h>
 #include <misc/util.h>
 #include <net/net_context.h>
 #include <net/socket.h>

subsys/random/rand32_entropy_device.c

@@ -6,7 +6,7 @@
 
 #include <sys/atomic.h>
 #include <kernel.h>
-#include <entropy.h>
+#include <drivers/entropy.h>
 
 static struct device *entropy_driver;
 

subsys/random/rand32_xoroshiro128.c

@@ -39,7 +39,7 @@
 
 #include <init.h>
 #include <device.h>
-#include <entropy.h>
+#include <drivers/entropy.h>
 #include <kernel.h>
 
 static u64_t state[2];

tests/drivers/entropy/api/src/main.c

@@ -3,7 +3,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-#include <entropy.h>
+#include <drivers/entropy.h>
 #include <ztest.h>
 
 /*