refactor: Align drivers with Zephyr file system conventions

PR: #400

app/drivers/sensor/CMakeLists.txt

@@ -0,0 +1,5 @@
+# Copyright (c) 2020 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+add_subdirectory_ifdef(CONFIG_ZMK_BATTERY_VOLTAGE_DIVIDER battery_voltage_divider)
+add_subdirectory_ifdef(CONFIG_EC11 ec11)

app/drivers/sensor/Kconfig

@@ -0,0 +1,5 @@
+# Copyright (c) 2020 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+rsource "battery_voltage_divider/Kconfig"
+rsource "ec11/Kconfig"

app/drivers/sensor/battery_voltage_divider/CMakeLists.txt

@@ -0,0 +1,6 @@
+# Copyright (c) 2020 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+zephyr_library()
+
+zephyr_library_sources(battery_voltage_divider.c)

app/drivers/sensor/battery_voltage_divider/Kconfig

@@ -0,0 +1,8 @@
+# Copyright (c) 2020 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+config ZMK_BATTERY_VOLTAGE_DIVIDER
+	bool "ZMK battery voltage divider"
+	select ADC
+	help
+		Enable ZMK battery voltage divider driver for battery monitoring.

app/drivers/sensor/battery_voltage_divider/battery_voltage_divider.c

@@ -0,0 +1,217 @@
+/*
+ * Copyright (c) 2020 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#define DT_DRV_COMPAT zmk_battery_voltage_divider
+
+#include <device.h>
+#include <drivers/gpio.h>
+#include <drivers/adc.h>
+#include <drivers/sensor.h>
+#include <logging/log.h>
+
+LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL);
+
+struct io_channel_config {
+    const char *label;
+    uint8_t channel;
+};
+
+struct gpio_channel_config {
+    const char *label;
+    uint8_t pin;
+    uint8_t flags;
+};
+
+struct bvd_config {
+    struct io_channel_config io_channel;
+    struct gpio_channel_config power_gpios;
+    uint32_t output_ohm;
+    uint32_t full_ohm;
+};
+
+struct bvd_data {
+    struct device *adc;
+    struct device *gpio;
+    struct adc_channel_cfg acc;
+    struct adc_sequence as;
+    uint16_t adc_raw;
+    uint16_t voltage;
+    uint8_t state_of_charge;
+};
+
+static uint8_t lithium_ion_mv_to_pct(int16_t bat_mv) {
+    // Simple linear approximation of a battery based off adafruit's discharge graph:
+    // https://learn.adafruit.com/li-ion-and-lipoly-batteries/voltages
+
+    if (bat_mv >= 4200) {
+        return 100;
+    } else if (bat_mv <= 3450) {
+        return 0;
+    }
+
+    return bat_mv * 2 / 15 - 459;
+}
+
+static int bvd_sample_fetch(struct device *dev, enum sensor_channel chan) {
+    struct bvd_data *drv_data = dev->driver_data;
+    const struct bvd_config *drv_cfg = dev->config_info;
+    struct adc_sequence *as = &drv_data->as;
+
+    // Make sure selected channel is supported
+    if (chan != SENSOR_CHAN_GAUGE_VOLTAGE && chan != SENSOR_CHAN_GAUGE_STATE_OF_CHARGE &&
+        chan != SENSOR_CHAN_ALL) {
+        LOG_DBG("Selected channel is not supported: %d.", chan);
+        return -ENOTSUP;
+    }
+
+    int rc = 0;
+
+    // Enable power GPIO if present
+    if (drv_data->gpio) {
+        rc = gpio_pin_set(drv_data->gpio, drv_cfg->power_gpios.pin, 1);
+
+        if (rc != 0) {
+            LOG_DBG("Failed to enable ADC power GPIO: %d", rc);
+            return rc;
+        }
+    }
+
+    // Read ADC
+    rc = adc_read(drv_data->adc, as);
+    as->calibrate = false;
+
+    if (rc == 0) {
+        int32_t val = drv_data->adc_raw;
+
+        adc_raw_to_millivolts(adc_ref_internal(drv_data->adc), drv_data->acc.gain, as->resolution,
+                              &val);
+
+        uint16_t millivolts = val * (uint64_t)drv_cfg->full_ohm / drv_cfg->output_ohm;
+        LOG_DBG("ADC raw %d ~ %d mV => %d mV\n", drv_data->adc_raw, val, millivolts);
+        uint8_t percent = lithium_ion_mv_to_pct(millivolts);
+        LOG_DBG("Percent: %d", percent);
+
+        drv_data->voltage = millivolts;
+        drv_data->state_of_charge = percent;
+    } else {
+        LOG_DBG("Failed to read ADC: %d", rc);
+    }
+
+    // Disable power GPIO if present
+    if (drv_data->gpio) {
+        int rc2 = gpio_pin_set(drv_data->gpio, drv_cfg->power_gpios.pin, 0);
+
+        if (rc2 != 0) {
+            LOG_DBG("Failed to disable ADC power GPIO: %d", rc2);
+            return rc2;
+        }
+    }
+
+    return rc;
+}
+
+static int bvd_channel_get(struct device *dev, enum sensor_channel chan, struct sensor_value *val) {
+    struct bvd_data *drv_data = dev->driver_data;
+
+    switch (chan) {
+    case SENSOR_CHAN_GAUGE_VOLTAGE:
+        val->val1 = drv_data->voltage / 1000;
+        val->val2 = (drv_data->voltage % 1000) * 1000U;
+        break;
+
+    case SENSOR_CHAN_GAUGE_STATE_OF_CHARGE:
+        val->val1 = drv_data->state_of_charge;
+        val->val2 = 0;
+        break;
+
+    default:
+        return -ENOTSUP;
+    }
+
+    return 0;
+}
+
+static const struct sensor_driver_api bvd_api = {
+    .sample_fetch = bvd_sample_fetch,
+    .channel_get = bvd_channel_get,
+};
+
+static int bvd_init(struct device *dev) {
+    struct bvd_data *drv_data = dev->driver_data;
+    const struct bvd_config *drv_cfg = dev->config_info;
+
+    drv_data->adc = device_get_binding(drv_cfg->io_channel.label);
+
+    if (drv_data->adc == NULL) {
+        LOG_ERR("ADC %s failed to retrieve", drv_cfg->io_channel.label);
+        return -ENODEV;
+    }
+
+    int rc = 0;
+
+    if (drv_cfg->power_gpios.label) {
+        drv_data->gpio = device_get_binding(drv_cfg->power_gpios.label);
+        if (drv_data->gpio == NULL) {
+            LOG_ERR("Failed to get GPIO %s", drv_cfg->power_gpios.label);
+            return -ENODEV;
+        }
+        rc = gpio_pin_configure(drv_data->gpio, drv_cfg->power_gpios.pin,
+                                GPIO_OUTPUT_INACTIVE | drv_cfg->power_gpios.flags);
+        if (rc != 0) {
+            LOG_ERR("Failed to control feed %s.%u: %d", drv_cfg->power_gpios.label,
+                    drv_cfg->power_gpios.pin, rc);
+            return rc;
+        }
+    }
+
+    drv_data->as = (struct adc_sequence){
+        .channels = BIT(0),
+        .buffer = &drv_data->adc_raw,
+        .buffer_size = sizeof(drv_data->adc_raw),
+        .oversampling = 4,
+        .calibrate = true,
+    };
+
+#ifdef CONFIG_ADC_NRFX_SAADC
+    drv_data->acc = (struct adc_channel_cfg){
+        .gain = ADC_GAIN_1_5,
+        .reference = ADC_REF_INTERNAL,
+        .acquisition_time = ADC_ACQ_TIME(ADC_ACQ_TIME_MICROSECONDS, 40),
+        .input_positive = SAADC_CH_PSELP_PSELP_AnalogInput0 + drv_cfg->io_channel.channel,
+    };
+
+    drv_data->as.resolution = 12;
+#else
+#error Unsupported ADC
+#endif
+
+    rc = adc_channel_setup(drv_data->adc, &drv_data->acc);
+    LOG_DBG("AIN%u setup returned %d", drv_cfg->io_channel.channel, rc);
+
+    return rc;
+}
+
+static struct bvd_data bvd_data;
+static const struct bvd_config bvd_cfg = {
+    .io_channel =
+        {
+            DT_INST_IO_CHANNELS_LABEL(0),
+            DT_INST_IO_CHANNELS_INPUT(0),
+        },
+#if DT_INST_NODE_HAS_PROP(0, power_gpios)
+    .power_gpios =
+        {
+            DT_INST_GPIO_LABEL(0, power_gpios),
+            DT_INST_GPIO_PIN(0, power_gpios),
+            DT_INST_GPIO_FLAGS(0, power_gpios),
+        },
+#endif
+    .output_ohm = DT_INST_PROP(0, output_ohms),
+    .full_ohm = DT_INST_PROP(0, full_ohms),
+};
+
+DEVICE_AND_API_INIT(bvd_dev, DT_INST_LABEL(0), &bvd_init, &bvd_data, &bvd_cfg, POST_KERNEL,
+                    CONFIG_SENSOR_INIT_PRIORITY, &bvd_api);

app/drivers/sensor/ec11/CMakeLists.txt

@@ -0,0 +1,9 @@
+# Copyright (c) 2020 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+zephyr_include_directories(.)
+
+zephyr_library()
+
+zephyr_library_sources(ec11.c)
+zephyr_library_sources_ifdef(CONFIG_EC11_TRIGGER ec11_trigger.c)

app/drivers/sensor/ec11/Kconfig

@@ -0,0 +1,50 @@
+# Copyright (c) 2020 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+menuconfig EC11
+	bool "EC11 Incremental Encoder Sensor"
+	depends on GPIO
+	help
+	  Enable driver for EC11 incremental encoder sensors.
+
+if EC11
+
+choice
+	prompt "Trigger mode"
+	default EC11_TRIGGER_NONE
+	help
+	  Specify the type of triggering to be used by the driver.
+
+config EC11_TRIGGER_NONE
+	bool "No trigger"
+
+config EC11_TRIGGER_GLOBAL_THREAD
+	bool "Use global thread"
+	depends on GPIO
+	select EC11_TRIGGER
+
+config EC11_TRIGGER_OWN_THREAD
+	bool "Use own thread"
+	depends on GPIO
+	select EC11_TRIGGER
+
+endchoice
+
+config EC11_TRIGGER
+	bool
+
+config EC11_THREAD_PRIORITY
+	int "Thread priority"
+	depends on EC11_TRIGGER_OWN_THREAD
+	default 10
+	help
+	  Priority of thread used by the driver to handle interrupts.
+
+config EC11_THREAD_STACK_SIZE
+	int "Thread stack size"
+	depends on EC11_TRIGGER_OWN_THREAD
+	default 1024
+	help
+	  Stack size of thread used by the driver to handle interrupts.
+
+endif # EC11

app/drivers/sensor/ec11/ec11.c

@@ -0,0 +1,148 @@
+/*
+ * Copyright (c) 2020 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#define DT_DRV_COMPAT alps_ec11
+
+#include <device.h>
+#include <drivers/gpio.h>
+#include <sys/util.h>
+#include <kernel.h>
+#include <drivers/sensor.h>
+#include <sys/__assert.h>
+#include <logging/log.h>
+
+#include "ec11.h"
+
+LOG_MODULE_REGISTER(EC11, CONFIG_SENSOR_LOG_LEVEL);
+
+static int ec11_get_ab_state(struct device *dev) {
+    struct ec11_data *drv_data = dev->driver_data;
+    const struct ec11_config *drv_cfg = dev->config_info;
+
+    return (gpio_pin_get(drv_data->a, drv_cfg->a_pin) << 1) |
+           gpio_pin_get(drv_data->b, drv_cfg->b_pin);
+}
+
+static int ec11_sample_fetch(struct device *dev, enum sensor_channel chan) {
+    struct ec11_data *drv_data = dev->driver_data;
+    const struct ec11_config *drv_cfg = dev->config_info;
+    u8_t val;
+    s8_t delta;
+
+    __ASSERT_NO_MSG(chan == SENSOR_CHAN_ALL || chan == SENSOR_CHAN_ROTATION);
+
+    val = ec11_get_ab_state(dev);
+
+    LOG_DBG("prev: %d, new: %d", drv_data->ab_state, val);
+
+    switch (val | (drv_data->ab_state << 2)) {
+    case 0b0010:
+    case 0b0100:
+    case 0b1101:
+    case 0b1011:
+        delta = -1;
+        break;
+    case 0b0001:
+    case 0b0111:
+    case 0b1110:
+    case 0b1000:
+        delta = 1;
+        break;
+    default:
+        delta = 0;
+        break;
+    }
+
+    LOG_DBG("Delta: %d", delta);
+
+    drv_data->pulses += delta;
+    drv_data->ab_state = val;
+
+    drv_data->ticks = drv_data->pulses / drv_cfg->resolution;
+    drv_data->delta = delta;
+    drv_data->pulses %= drv_cfg->resolution;
+
+    return 0;
+}
+
+static int ec11_channel_get(struct device *dev, enum sensor_channel chan,
+                            struct sensor_value *val) {
+    struct ec11_data *drv_data = dev->driver_data;
+
+    if (chan != SENSOR_CHAN_ROTATION) {
+        return -ENOTSUP;
+    }
+
+    val->val1 = drv_data->ticks;
+    val->val2 = drv_data->delta;
+
+    return 0;
+}
+
+static const struct sensor_driver_api ec11_driver_api = {
+#ifdef CONFIG_EC11_TRIGGER
+    .trigger_set = ec11_trigger_set,
+#endif
+    .sample_fetch = ec11_sample_fetch,
+    .channel_get = ec11_channel_get,
+};
+
+int ec11_init(struct device *dev) {
+    struct ec11_data *drv_data = dev->driver_data;
+    const struct ec11_config *drv_cfg = dev->config_info;
+
+    LOG_DBG("A: %s %d B: %s %d resolution %d", drv_cfg->a_label, drv_cfg->a_pin, drv_cfg->b_label,
+            drv_cfg->b_pin, drv_cfg->resolution);
+
+    drv_data->a = device_get_binding(drv_cfg->a_label);
+    if (drv_data->a == NULL) {
+        LOG_ERR("Failed to get pointer to A GPIO device");
+        return -EINVAL;
+    }
+
+    drv_data->b = device_get_binding(drv_cfg->b_label);
+    if (drv_data->b == NULL) {
+        LOG_ERR("Failed to get pointer to B GPIO device");
+        return -EINVAL;
+    }
+
+    if (gpio_pin_configure(drv_data->a, drv_cfg->a_pin, drv_cfg->a_flags | GPIO_INPUT)) {
+        LOG_DBG("Failed to configure A pin");
+        return -EIO;
+    }
+
+    if (gpio_pin_configure(drv_data->b, drv_cfg->b_pin, drv_cfg->b_flags | GPIO_INPUT)) {
+        LOG_DBG("Failed to configure B pin");
+        return -EIO;
+    }
+
+#ifdef CONFIG_EC11_TRIGGER
+    if (ec11_init_interrupt(dev) < 0) {
+        LOG_DBG("Failed to initialize interrupt!");
+        return -EIO;
+    }
+#endif
+
+    drv_data->ab_state = ec11_get_ab_state(dev);
+
+    return 0;
+}
+
+#define EC11_INST(n)                                                                               \
+    struct ec11_data ec11_data_##n;                                                                \
+    const struct ec11_config ec11_cfg_##n = {                                                      \
+        .a_label = DT_INST_GPIO_LABEL(n, a_gpios),                                                 \
+        .a_pin = DT_INST_GPIO_PIN(n, a_gpios),                                                     \
+        .a_flags = DT_INST_GPIO_FLAGS(n, a_gpios),                                                 \
+        .b_label = DT_INST_GPIO_LABEL(n, b_gpios),                                                 \
+        .b_pin = DT_INST_GPIO_PIN(n, b_gpios),                                                     \
+        .b_flags = DT_INST_GPIO_FLAGS(n, b_gpios),                                                 \
+        COND_CODE_0(DT_INST_NODE_HAS_PROP(n, resolution), (1), (DT_INST_PROP(n, resolution))),     \
+    };                                                                                             \
+    DEVICE_AND_API_INIT(ec11_##n, DT_INST_LABEL(n), ec11_init, &ec11_data_##n, &ec11_cfg_##n,      \
+                        POST_KERNEL, CONFIG_SENSOR_INIT_PRIORITY, &ec11_driver_api);
+
+DT_INST_FOREACH_STATUS_OKAY(EC11_INST)

app/drivers/sensor/ec11/ec11.h

@@ -0,0 +1,58 @@
+/*
+ * Copyright (c) 2020 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#pragma once
+
+#include <device.h>
+#include <drivers/gpio.h>
+#include <sys/util.h>
+
+struct ec11_config {
+    const char *a_label;
+    const u8_t a_pin;
+    const u8_t a_flags;
+
+    const char *b_label;
+    const u8_t b_pin;
+    const u8_t b_flags;
+
+    const u8_t resolution;
+};
+
+struct ec11_data {
+    struct device *a;
+    struct device *b;
+    u8_t ab_state;
+    s8_t pulses;
+    s8_t ticks;
+    s8_t delta;
+
+#ifdef CONFIG_EC11_TRIGGER
+    struct gpio_callback a_gpio_cb;
+    struct gpio_callback b_gpio_cb;
+    struct device *dev;
+
+    sensor_trigger_handler_t handler;
+    const struct sensor_trigger *trigger;
+
+#if defined(CONFIG_EC11_TRIGGER_OWN_THREAD)
+    K_THREAD_STACK_MEMBER(thread_stack, CONFIG_EC11_THREAD_STACK_SIZE);
+    struct k_sem gpio_sem;
+    struct k_thread thread;
+#elif defined(CONFIG_EC11_TRIGGER_GLOBAL_THREAD)
+    struct k_work work;
+#endif
+
+#endif /* CONFIG_EC11_TRIGGER */
+};
+
+#ifdef CONFIG_EC11_TRIGGER
+
+int ec11_trigger_set(struct device *dev, const struct sensor_trigger *trig,
+                     sensor_trigger_handler_t handler);
+
+int ec11_init_interrupt(struct device *dev);
+#endif

app/drivers/sensor/ec11/ec11_trigger.c

@@ -0,0 +1,148 @@
+/*
+ * Copyright (c) 2020 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#define DT_DRV_COMPAT alps_ec11
+
+#include <device.h>
+#include <drivers/gpio.h>
+#include <sys/util.h>
+#include <kernel.h>
+#include <drivers/sensor.h>
+
+#include "ec11.h"
+
+extern struct ec11_data ec11_driver;
+
+#include <logging/log.h>
+LOG_MODULE_DECLARE(EC11, CONFIG_SENSOR_LOG_LEVEL);
+
+static inline void setup_int(struct device *dev, bool enable) {
+    struct ec11_data *data = dev->driver_data;
+    const struct ec11_config *cfg = dev->config_info;
+
+    LOG_DBG("enabled %s", (enable ? "true" : "false"));
+
+    if (gpio_pin_interrupt_configure(data->a, cfg->a_pin,
+                                     enable ? GPIO_INT_EDGE_BOTH : GPIO_INT_DISABLE)) {
+        LOG_WRN("Unable to set A pin GPIO interrupt");
+    }
+
+    if (gpio_pin_interrupt_configure(data->b, cfg->b_pin,
+                                     enable ? GPIO_INT_EDGE_BOTH : GPIO_INT_DISABLE)) {
+        LOG_WRN("Unable to set A pin GPIO interrupt");
+    }
+}
+
+static void ec11_a_gpio_callback(struct device *dev, struct gpio_callback *cb, u32_t pins) {
+    struct ec11_data *drv_data = CONTAINER_OF(cb, struct ec11_data, a_gpio_cb);
+
+    LOG_DBG("");
+
+    setup_int(drv_data->dev, false);
+
+#if defined(CONFIG_EC11_TRIGGER_OWN_THREAD)
+    k_sem_give(&drv_data->gpio_sem);
+#elif defined(CONFIG_EC11_TRIGGER_GLOBAL_THREAD)
+    k_work_submit(&drv_data->work);
+#endif
+}
+
+static void ec11_b_gpio_callback(struct device *dev, struct gpio_callback *cb, u32_t pins) {
+    struct ec11_data *drv_data = CONTAINER_OF(cb, struct ec11_data, b_gpio_cb);
+
+    LOG_DBG("");
+
+    setup_int(drv_data->dev, false);
+
+#if defined(CONFIG_EC11_TRIGGER_OWN_THREAD)
+    k_sem_give(&drv_data->gpio_sem);
+#elif defined(CONFIG_EC11_TRIGGER_GLOBAL_THREAD)
+    k_work_submit(&drv_data->work);
+#endif
+}
+
+static void ec11_thread_cb(void *arg) {
+    struct device *dev = arg;
+    struct ec11_data *drv_data = dev->driver_data;
+
+    drv_data->handler(dev, drv_data->trigger);
+
+    setup_int(dev, true);
+}
+
+#ifdef CONFIG_EC11_TRIGGER_OWN_THREAD
+static void ec11_thread(int dev_ptr, int unused) {
+    struct device *dev = INT_TO_POINTER(dev_ptr);
+    struct ec11_data *drv_data = dev->driver_data;
+
+    ARG_UNUSED(unused);
+
+    while (1) {
+        k_sem_take(&drv_data->gpio_sem, K_FOREVER);
+        ec11_thread_cb(dev);
+    }
+}
+#endif
+
+#ifdef CONFIG_EC11_TRIGGER_GLOBAL_THREAD
+static void ec11_work_cb(struct k_work *work) {
+    struct ec11_data *drv_data = CONTAINER_OF(work, struct ec11_data, work);
+
+    LOG_DBG("");
+
+    ec11_thread_cb(drv_data->dev);
+}
+#endif
+
+int ec11_trigger_set(struct device *dev, const struct sensor_trigger *trig,
+                     sensor_trigger_handler_t handler) {
+    struct ec11_data *drv_data = dev->driver_data;
+
+    setup_int(dev, false);
+
+    k_msleep(5);
+
+    drv_data->trigger = trig;
+    drv_data->handler = handler;
+
+    setup_int(dev, true);
+
+    return 0;
+}
+
+int ec11_init_interrupt(struct device *dev) {
+    struct ec11_data *drv_data = dev->driver_data;
+    const struct ec11_config *drv_cfg = dev->config_info;
+
+    drv_data->dev = dev;
+    /* setup gpio interrupt */
+
+    gpio_init_callback(&drv_data->a_gpio_cb, ec11_a_gpio_callback, BIT(drv_cfg->a_pin));
+
+    if (gpio_add_callback(drv_data->a, &drv_data->a_gpio_cb) < 0) {
+        LOG_DBG("Failed to set A callback!");
+        return -EIO;
+    }
+
+    gpio_init_callback(&drv_data->b_gpio_cb, ec11_b_gpio_callback, BIT(drv_cfg->b_pin));
+
+    if (gpio_add_callback(drv_data->b, &drv_data->b_gpio_cb) < 0) {
+        LOG_DBG("Failed to set B callback!");
+        return -EIO;
+    }
+
+#if defined(CONFIG_EC11_TRIGGER_OWN_THREAD)
+    k_sem_init(&drv_data->gpio_sem, 0, UINT_MAX);
+
+    k_thread_create(&drv_data->thread, drv_data->thread_stack, CONFIG_EC11_THREAD_STACK_SIZE,
+                    (k_thread_entry_t)ec11_thread, dev, 0, NULL,
+                    K_PRIO_COOP(CONFIG_EC11_THREAD_PRIORITY), 0, K_NO_WAIT);
+#elif defined(CONFIG_EC11_TRIGGER_GLOBAL_THREAD)
+    k_work_init(&drv_data->work, ec11_work_cb);
+#endif
+
+    return 0;
+}