wip: rename api to propy_radio

README.md

@@ -80,7 +80,7 @@ This driver uses a minimalist custom API.
 
 ## Read
 ```
-int nrf24_read(const struct device *dev, uint8_t *buffer, uint8_t data_len)
+int propy_radio_read(const struct device *dev, uint8_t *buffer, uint8_t data_len)
 ```
 
 This methods reads data\_len bytes from the device dev, and places it in buffer.
@@ -90,7 +90,7 @@ In polling mode, it will loop forever.
 
 # Write
 ```
-int nrf24_write(const struct device *dev, uint8_t *buffer, uint8_t data_len)
+int propy_radio_write(const struct device *dev, uint8_t *buffer, uint8_t data_len)
 ```
 
 This methods writes data\_len bytes from buffer, and sends it through device dev.

app/src/main.c

@@ -6,7 +6,7 @@
 #include <zephyr/kernel.h>
 #include <zephyr/devicetree.h>
 
-#include <app/drivers/nrf24.h>
+#include <app/drivers/propy_radio.h>
 #include <zephyr/logging/log.h>
 LOG_MODULE_REGISTER(main, CONFIG_APP_LOG_LEVEL);
 #if !DT_NODE_EXISTS(DT_NODELABEL(radio0))
@@ -49,23 +49,23 @@ int main(void)
 	while (true) {
 		strncpy(buffer, "I am Alice, hi!", 16);
 #ifdef TRIGGER
-		while (nrf24_write(nrf24, buffer, data_len))
+		while (propy_radio_write(nrf24, buffer, data_len))
 		{
 			k_sleep(K_MSEC(10));
 		}
 #else
 		for (i=0; i<10; i++)
 		{
-			nrf24_write(nrf24, buffer, data_len);
+			propy_radio_write(nrf24, buffer, data_len);
 			k_sleep(K_MSEC(10));
 		}
 #endif // TRIGGER
 		LOG_HEXDUMP_INF(buffer, data_len, "Sent: ");
 		LOG_DBG("Switch to read");
 #ifdef TRIGGER
-		while (nrf24_read(nrf24, buffer, data_len));
+		while (propy_radio_read(nrf24, buffer, data_len));
 #else
-		nrf24_read(nrf24, buffer, data_len);
+		propy_radio_read(nrf24, buffer, data_len);
 #endif // TRIGGER
 		LOG_HEXDUMP_INF(buffer, data_len, "Received: ");
 		k_sleep(K_MSEC(1000));
@@ -77,23 +77,23 @@ int main(void)
 	LOG_WRN("I am Bob!");
 	while (true) {
 #ifdef TRIGGER
-		while (nrf24_read(nrf24, buffer, data_len));
+		while (propy_radio_read(nrf24, buffer, data_len));
 #else
-		nrf24_read(nrf24, buffer, data_len);
+		propy_radio_read(nrf24, buffer, data_len);
 #endif // TRIGGER
 		LOG_HEXDUMP_INF(buffer, data_len, "Received: ");
 		LOG_DBG("Switch to write");
 		strncpy(buffer, "Hi Alice Im Bob", 16);
 		k_sleep(K_MSEC(1000));
 #ifdef TRIGGER
-		while (nrf24_write(nrf24, buffer, data_len))
+		while (propy_radio_write(nrf24, buffer, data_len))
 		{
 			k_sleep(K_MSEC(10));
 		}
 #else
 		for (i=0; i<10; i++)
 		{
-			nrf24_write(nrf24, buffer, data_len);
+			propy_radio_write(nrf24, buffer, data_len);
 			k_sleep(K_MSEC(10));
 		}
 #endif // TRIGGER
@@ -106,10 +106,10 @@ int main(void)
 	LOG_WRN("I am Eve!");
 	while (true) {
 #ifdef TRIGGER
-		while (nrf24_read(nrf24, buffer, data_len));
+		while (propy_radio_read(nrf24, buffer, data_len));
 #else
 		strncpy(buffer, "               ", 16);
-		nrf24_read(nrf24, buffer, data_len);
+		propy_radio_read(nrf24, buffer, data_len);
 #endif // TRIGGER
 		LOG_HEXDUMP_INF(buffer, data_len, "I spied: ");
 	}

drivers/nrf24l01/nrf24l01.c

@@ -10,7 +10,7 @@
 #include <zephyr/drivers/spi.h>
 #include <zephyr/kernel.h>
 
-#include <app/drivers/nrf24.h>
+#include <app/drivers/propy_radio.h>
 #include "nrf24l01_defines.h"
 
 #define SPI_MAX_MSG_LEN 64
@@ -736,7 +736,7 @@ static int nrf24l01_write(const struct device *dev, uint8_t *buffer, uint8_t dat
 	return ret;
 }
 
-static const struct nrf24_api nrf24l01_api = {
+static const struct propy_radio_api nrf24l01_api = {
 	.read = nrf24l01_read,
 	.write = nrf24l01_write,
 };

include/app/drivers/propy_radio.h

@@ -0,0 +1,65 @@
+/*
+ */
+#ifndef ZEPHYR_INCLUDE_ZEPHYR_DRIVERS_WIRELESS_PROPY_RADIO_H_
+#define ZEPHYR_INCLUDE_ZEPHYR_DRIVERS_WIRELESS_PROPY_RADIO_H_
+
+#include <zephyr/device.h>
+#include <zephyr/toolchain.h>
+
+/** @cond INTERNAL_HIDDEN */
+
+typedef int (*propy_radio_read_t)(const struct device *dev, uint8_t *buffer, uint8_t data_len);
+typedef int (*propy_radio_write_t)(const struct device *dev, uint8_t *buffer, uint8_t data_len);
+
+__subsystem struct propy_radio_api {
+	propy_radio_read_t read;
+	propy_radio_write_t write;
+};
+
+/** @endcond */
+/**
+ * @brief Read data.
+ *
+ * @param dev propy_radio instance.
+ * @param buf Read buffer.
+ * @param data_len Number of bytes to read
+ *
+ * @retval 0 On success.
+ * @retval -EIO Nothing in RX queue (trigger mode)
+ * @retval -errno Other negative errno in case of failure.
+ */
+__syscall int propy_radio_read(const struct device *dev, uint8_t *buffer, uint8_t data_len);
+
+static inline int z_impl_propy_radio_read(const struct device *dev, uint8_t *buffer, uint8_t data_len)
+{
+	const struct propy_radio_api *api =
+		(const struct propy_radio_api *)dev->api;
+
+	return api->read(dev, buffer, data_len);
+}
+
+/**
+ * @brief Write data.
+ *
+ * @param dev propy_radio instance.
+ * @param buf Write buffer.
+ * @param data_len Number of bytes to write
+ *
+ * @retval 0 On success.
+ * @retval -ETIME TX sending timed out (trigger mode)
+ * @retval -EIO Max retries exceeded (polling mode)
+ * @retval MAX_RT Message not acknowledged (trigger mode)
+ * @retval -errno Other negative errno in case of failure.
+ */
+__syscall int propy_radio_write(const struct device *dev, uint8_t *buffer, uint8_t data_len);
+
+static inline int z_impl_propy_radio_write(const struct device *dev, uint8_t *buffer, uint8_t data_len)
+{
+	const struct propy_radio_api *api =
+		(const struct propy_radio_api *)dev->api;
+
+	return api->write(dev, buffer, data_len);
+}
+
+#include <syscalls/propy_radio.h>
+#endif /* ZEPHYR_INCLUDE_ZEPHYR_DRIVERS_WIRELESS_PROPY_RADIO_H_ */