drivers: sensor: s/examplesensor/example-|_sensor/

Just a rename so things look a bit nicer.

Signed-off-by: Gerard Marull-Paretas <[email protected]>

Author: gmarull

app/boards/nucleo_f302r8.overlay

@@ -10,8 +10,8 @@
  */
 
 / {
-	examplesensor0: examplesensor_0 {
-		compatible = "zephyr,examplesensor";
+	example_sensor: example-sensor {
+		compatible = "zephyr,example-sensor";
 		input-gpios = <&gpioc 13 (GPIO_PULL_UP | GPIO_ACTIVE_LOW)>;
 	};
 };

app/src/main.c

@@ -17,7 +17,7 @@ int main(void)
 
 	printk("Zephyr Example Application %s\n", APP_VERSION_STRING);
 
-	sensor = DEVICE_DT_GET(DT_NODELABEL(examplesensor0));
+	sensor = DEVICE_DT_GET(DT_NODELABEL(example_sensor));
 	if (!device_is_ready(sensor)) {
 		LOG_ERR("Sensor not ready");
 		return 0;

boards/vendor/custom_plank/custom_plank.dts

@@ -17,8 +17,8 @@
 		zephyr,flash = &flash0;
 	};
 
-	examplesensor0: examplesensor_0 {
-		compatible = "zephyr,examplesensor";
+	example_sensor: example-sensor {
+		compatible = "zephyr,example-sensor";
 		input-gpios = <&gpio0 11 (GPIO_PULL_UP | GPIO_ACTIVE_LOW)>;
 	};
 };

drivers/sensor/CMakeLists.txt

@@ -1,4 +1,4 @@
 # Copyright (c) 2021 Nordic Semiconductor ASA
 # SPDX-License-Identifier: Apache-2.0
 
-add_subdirectory_ifdef(CONFIG_EXAMPLESENSOR examplesensor)
+add_subdirectory_ifdef(CONFIG_EXAMPLE_SENSOR example_sensor)

drivers/sensor/Kconfig

@@ -2,5 +2,5 @@
 # SPDX-License-Identifier: Apache-2.0
 
 if SENSOR
-rsource "examplesensor/Kconfig"
+rsource "example_sensor/Kconfig"
 endif # SENSOR

drivers/sensor/examplesensor/CMakeLists.txt renamed to drivers/sensor/example_sensor/CMakeLists.txt

@@ -2,4 +2,4 @@
 # SPDX-License-Identifier: Apache-2.0
 
 zephyr_library()
-zephyr_library_sources(examplesensor.c)
+zephyr_library_sources(example_sensor.c)

drivers/sensor/examplesensor/Kconfig renamed to drivers/sensor/example_sensor/Kconfig

@@ -1,10 +1,10 @@
 # Copyright (c) 2021 Nordic Semiconductor ASA
 # SPDX-License-Identifier: Apache-2.0
 
-config EXAMPLESENSOR
+config EXAMPLE_SENSOR
 	bool "Example sensor"
 	default y
-	depends on DT_HAS_ZEPHYR_EXAMPLESENSOR_ENABLED
+	depends on DT_HAS_ZEPHYR_EXAMPLE_SENSOR_ENABLED
 	select GPIO
 	help
 	  Enable example sensor

drivers/sensor/example_sensor/example_sensor.c

@@ -0,0 +1,86 @@
+/*
+ * Copyright (c) 2021 Nordic Semiconductor ASA
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#define DT_DRV_COMPAT zephyr_example_sensor
+
+#include <zephyr/device.h>
+#include <zephyr/drivers/gpio.h>
+#include <zephyr/drivers/sensor.h>
+
+#include <zephyr/logging/log.h>
+LOG_MODULE_REGISTER(example_sensor, CONFIG_SENSOR_LOG_LEVEL);
+
+struct example_sensor_data {
+	int state;
+};
+
+struct example_sensor_config {
+	struct gpio_dt_spec input;
+};
+
+static int example_sensor_sample_fetch(const struct device *dev,
+				      enum sensor_channel chan)
+{
+	const struct example_sensor_config *config = dev->config;
+	struct example_sensor_data *data = dev->data;
+
+	data->state = gpio_pin_get_dt(&config->input);
+
+	return 0;
+}
+
+static int example_sensor_channel_get(const struct device *dev,
+				     enum sensor_channel chan,
+				     struct sensor_value *val)
+{
+	struct example_sensor_data *data = dev->data;
+
+	if (chan != SENSOR_CHAN_PROX) {
+		return -ENOTSUP;
+	}
+
+	val->val1 = data->state;
+
+	return 0;
+}
+
+static const struct sensor_driver_api example_sensor_api = {
+	.sample_fetch = &example_sensor_sample_fetch,
+	.channel_get = &example_sensor_channel_get,
+};
+
+static int example_sensor_init(const struct device *dev)
+{
+	const struct example_sensor_config *config = dev->config;
+
+	int ret;
+
+	if (!device_is_ready(config->input.port)) {
+		LOG_ERR("Input GPIO not ready");
+		return -ENODEV;
+	}
+
+	ret = gpio_pin_configure_dt(&config->input, GPIO_INPUT);
+	if (ret < 0) {
+		LOG_ERR("Could not configure input GPIO (%d)", ret);
+		return ret;
+	}
+
+	return 0;
+}
+
+#define EXAMPLE_SENSOR_INIT(i)						       \
+	static struct example_sensor_data example_sensor_data_##i;	       \
+									       \
+	static const struct example_sensor_config example_sensor_config_##i = {\
+		.input = GPIO_DT_SPEC_INST_GET(i, input_gpios),		       \
+	};								       \
+									       \
+	DEVICE_DT_INST_DEFINE(i, example_sensor_init, NULL,		       \
+			      &example_sensor_data_##i,			       \
+			      &example_sensor_config_##i, POST_KERNEL,	       \
+			      CONFIG_SENSOR_INIT_PRIORITY, &example_sensor_api);
+
+DT_INST_FOREACH_STATUS_OKAY(EXAMPLE_SENSOR_INIT)

drivers/sensor/examplesensor/examplesensor.c

@@ -7,12 +7,12 @@ description: |
 
   Example definition in devicetree:
 
-    examplesensor {
-        compatible = "zephyr,examplesensor";
+    example-sensor {
+        compatible = "zephyr,example-sensor";
         input-gpios = <&gpio0 0 (GPIO_PULL_UP | GPIO_ACTIVE_LOW)>;
     };
 
-compatible: "zephyr,examplesensor"
+compatible: "zephyr,example-sensor"
 
 include: base.yaml