forked from kofal.net/zmk
refactor: Move drivers into properly module.
* Align our driver module layout to properly match Zephyr conventions, allowing proper CMake setup to amend the library for each type of driver.
This commit is contained in:
committed by
Pete Johanson
parent
eaeea4bdfa
commit
690bc1bb44
5
app/module/drivers/sensor/CMakeLists.txt
Normal file
5
app/module/drivers/sensor/CMakeLists.txt
Normal file
@@ -0,0 +1,5 @@
|
||||
# Copyright (c) 2020-2021 The ZMK Contributors
|
||||
# SPDX-License-Identifier: MIT
|
||||
|
||||
add_subdirectory_ifdef(CONFIG_ZMK_BATTERY battery)
|
||||
add_subdirectory_ifdef(CONFIG_EC11 ec11)
|
||||
9
app/module/drivers/sensor/Kconfig
Normal file
9
app/module/drivers/sensor/Kconfig
Normal file
@@ -0,0 +1,9 @@
|
||||
# Copyright (c) 2020 The ZMK Contributors
|
||||
# SPDX-License-Identifier: MIT
|
||||
|
||||
if SENSOR
|
||||
|
||||
rsource "battery/Kconfig"
|
||||
rsource "ec11/Kconfig"
|
||||
|
||||
endif # SENSOR
|
||||
10
app/module/drivers/sensor/battery/CMakeLists.txt
Normal file
10
app/module/drivers/sensor/battery/CMakeLists.txt
Normal file
@@ -0,0 +1,10 @@
|
||||
# Copyright (c) 2020-2021 The ZMK Contributors
|
||||
# SPDX-License-Identifier: MIT
|
||||
|
||||
zephyr_include_directories(.)
|
||||
|
||||
zephyr_library()
|
||||
|
||||
zephyr_library_sources(battery_common.c)
|
||||
zephyr_library_sources_ifdef(CONFIG_ZMK_BATTERY_NRF_VDDH battery_nrf_vddh.c)
|
||||
zephyr_library_sources_ifdef(CONFIG_ZMK_BATTERY_VOLTAGE_DIVIDER battery_voltage_divider.c)
|
||||
28
app/module/drivers/sensor/battery/Kconfig
Normal file
28
app/module/drivers/sensor/battery/Kconfig
Normal file
@@ -0,0 +1,28 @@
|
||||
# Copyright (c) 2020-2021 The ZMK Contributors
|
||||
# SPDX-License-Identifier: MIT
|
||||
|
||||
DT_COMPAT_ZMK_BATTERY_NRF_VDDH := zmk,battery-nrf-vddh
|
||||
DT_COMPAT_ZMK_BATTERY_VOLTAGE_DIVIDER := zmk,battery-voltage-divider
|
||||
|
||||
config ZMK_BATTERY
|
||||
bool "ZMK battery monitoring"
|
||||
help
|
||||
Enable battery monitoring
|
||||
|
||||
config ZMK_BATTERY_NRF_VDDH
|
||||
bool
|
||||
default $(dt_compat_enabled,$(DT_COMPAT_ZMK_BATTERY_NRF_VDDH))
|
||||
select ADC
|
||||
select ZMK_BATTERY
|
||||
depends on SENSOR
|
||||
help
|
||||
Enable ZMK nRF VDDH voltage driver for battery monitoring.
|
||||
|
||||
config ZMK_BATTERY_VOLTAGE_DIVIDER
|
||||
bool
|
||||
default $(dt_compat_enabled,$(DT_COMPAT_ZMK_BATTERY_VOLTAGE_DIVIDER))
|
||||
select ADC
|
||||
select ZMK_BATTERY
|
||||
depends on SENSOR
|
||||
help
|
||||
Enable ZMK battery voltage divider driver for battery monitoring.
|
||||
43
app/module/drivers/sensor/battery/battery_common.c
Normal file
43
app/module/drivers/sensor/battery/battery_common.c
Normal file
@@ -0,0 +1,43 @@
|
||||
/*
|
||||
* Copyright (c) 2021 The ZMK Contributors
|
||||
*
|
||||
* SPDX-License-Identifier: MIT
|
||||
*/
|
||||
|
||||
#include <errno.h>
|
||||
#include <zephyr/drivers/sensor.h>
|
||||
|
||||
#include "battery_common.h"
|
||||
|
||||
int battery_channel_get(const struct battery_value *value, enum sensor_channel chan,
|
||||
struct sensor_value *val_out) {
|
||||
switch (chan) {
|
||||
case SENSOR_CHAN_GAUGE_VOLTAGE:
|
||||
val_out->val1 = value->millivolts / 1000;
|
||||
val_out->val2 = (value->millivolts % 1000) * 1000U;
|
||||
break;
|
||||
|
||||
case SENSOR_CHAN_GAUGE_STATE_OF_CHARGE:
|
||||
val_out->val1 = value->state_of_charge;
|
||||
val_out->val2 = 0;
|
||||
break;
|
||||
|
||||
default:
|
||||
return -ENOTSUP;
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
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;
|
||||
}
|
||||
21
app/module/drivers/sensor/battery/battery_common.h
Normal file
21
app/module/drivers/sensor/battery/battery_common.h
Normal file
@@ -0,0 +1,21 @@
|
||||
/*
|
||||
* Copyright (c) 2021 The ZMK Contributors
|
||||
*
|
||||
* SPDX-License-Identifier: MIT
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <zephyr/drivers/sensor.h>
|
||||
#include <stdint.h>
|
||||
|
||||
struct battery_value {
|
||||
uint16_t adc_raw;
|
||||
uint16_t millivolts;
|
||||
uint8_t state_of_charge;
|
||||
};
|
||||
|
||||
int battery_channel_get(const struct battery_value *value, enum sensor_channel chan,
|
||||
struct sensor_value *val_out);
|
||||
|
||||
uint8_t lithium_ion_mv_to_pct(int16_t bat_mv);
|
||||
116
app/module/drivers/sensor/battery/battery_nrf_vddh.c
Normal file
116
app/module/drivers/sensor/battery/battery_nrf_vddh.c
Normal file
@@ -0,0 +1,116 @@
|
||||
/*
|
||||
* Copyright (c) 2021 The ZMK Contributors
|
||||
*
|
||||
* SPDX-License-Identifier: MIT
|
||||
*
|
||||
* This is a simplified version of battery_voltage_divider.c which always reads
|
||||
* the VDDHDIV5 channel of the &adc node and multiplies it by 5.
|
||||
*/
|
||||
|
||||
#define DT_DRV_COMPAT zmk_battery_nrf_vddh
|
||||
|
||||
#include <zephyr/device.h>
|
||||
#include <zephyr/devicetree.h>
|
||||
#include <zephyr/drivers/adc.h>
|
||||
#include <zephyr/drivers/sensor.h>
|
||||
#include <zephyr/logging/log.h>
|
||||
|
||||
#include "battery_common.h"
|
||||
|
||||
LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL);
|
||||
|
||||
#define VDDHDIV (5)
|
||||
|
||||
static const struct device *adc = DEVICE_DT_GET(DT_NODELABEL(adc));
|
||||
|
||||
struct vddh_data {
|
||||
struct adc_channel_cfg acc;
|
||||
struct adc_sequence as;
|
||||
struct battery_value value;
|
||||
};
|
||||
|
||||
static int vddh_sample_fetch(const struct device *dev, enum sensor_channel chan) {
|
||||
// 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;
|
||||
}
|
||||
|
||||
struct vddh_data *drv_data = dev->data;
|
||||
struct adc_sequence *as = &drv_data->as;
|
||||
|
||||
int rc = adc_read(adc, as);
|
||||
as->calibrate = false;
|
||||
|
||||
if (rc != 0) {
|
||||
LOG_ERR("Failed to read ADC: %d", rc);
|
||||
return rc;
|
||||
}
|
||||
|
||||
int32_t val = drv_data->value.adc_raw;
|
||||
rc = adc_raw_to_millivolts(adc_ref_internal(adc), drv_data->acc.gain, as->resolution, &val);
|
||||
if (rc != 0) {
|
||||
LOG_ERR("Failed to convert raw ADC to mV: %d", rc);
|
||||
return rc;
|
||||
}
|
||||
|
||||
drv_data->value.millivolts = val * VDDHDIV;
|
||||
drv_data->value.state_of_charge = lithium_ion_mv_to_pct(drv_data->value.millivolts);
|
||||
|
||||
LOG_DBG("ADC raw %d ~ %d mV => %d%%", drv_data->value.adc_raw, drv_data->value.millivolts,
|
||||
drv_data->value.state_of_charge);
|
||||
|
||||
return rc;
|
||||
}
|
||||
|
||||
static int vddh_channel_get(const struct device *dev, enum sensor_channel chan,
|
||||
struct sensor_value *val) {
|
||||
struct vddh_data const *drv_data = dev->data;
|
||||
return battery_channel_get(&drv_data->value, chan, val);
|
||||
}
|
||||
|
||||
static const struct sensor_driver_api vddh_api = {
|
||||
.sample_fetch = vddh_sample_fetch,
|
||||
.channel_get = vddh_channel_get,
|
||||
};
|
||||
|
||||
static int vddh_init(const struct device *dev) {
|
||||
struct vddh_data *drv_data = dev->data;
|
||||
|
||||
if (!device_is_ready(adc)) {
|
||||
LOG_ERR("ADC device is not ready %s", adc->name);
|
||||
return -ENODEV;
|
||||
}
|
||||
|
||||
drv_data->as = (struct adc_sequence){
|
||||
.channels = BIT(0),
|
||||
.buffer = &drv_data->value.adc_raw,
|
||||
.buffer_size = sizeof(drv_data->value.adc_raw),
|
||||
.oversampling = 4,
|
||||
.calibrate = true,
|
||||
};
|
||||
|
||||
#ifdef CONFIG_ADC_NRFX_SAADC
|
||||
drv_data->acc = (struct adc_channel_cfg){
|
||||
.gain = ADC_GAIN_1_2,
|
||||
.reference = ADC_REF_INTERNAL,
|
||||
.acquisition_time = ADC_ACQ_TIME(ADC_ACQ_TIME_MICROSECONDS, 40),
|
||||
.input_positive = SAADC_CH_PSELN_PSELN_VDDHDIV5,
|
||||
};
|
||||
|
||||
drv_data->as.resolution = 12;
|
||||
#else
|
||||
#error Unsupported ADC
|
||||
#endif
|
||||
|
||||
const int rc = adc_channel_setup(adc, &drv_data->acc);
|
||||
LOG_DBG("VDDHDIV5 setup returned %d", rc);
|
||||
|
||||
return rc;
|
||||
}
|
||||
|
||||
static struct vddh_data vddh_data;
|
||||
|
||||
DEVICE_DT_INST_DEFINE(0, &vddh_init, NULL, &vddh_data, NULL, POST_KERNEL,
|
||||
CONFIG_SENSOR_INIT_PRIORITY, &vddh_api);
|
||||
175
app/module/drivers/sensor/battery/battery_voltage_divider.c
Normal file
175
app/module/drivers/sensor/battery/battery_voltage_divider.c
Normal file
@@ -0,0 +1,175 @@
|
||||
/*
|
||||
* Copyright (c) 2020 The ZMK Contributors
|
||||
*
|
||||
* SPDX-License-Identifier: MIT
|
||||
*/
|
||||
|
||||
#define DT_DRV_COMPAT zmk_battery_voltage_divider
|
||||
|
||||
#include <zephyr/device.h>
|
||||
#include <zephyr/devicetree.h>
|
||||
#include <zephyr/drivers/gpio.h>
|
||||
#include <zephyr/drivers/adc.h>
|
||||
#include <zephyr/drivers/sensor.h>
|
||||
#include <zephyr/logging/log.h>
|
||||
|
||||
#include "battery_common.h"
|
||||
|
||||
LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL);
|
||||
|
||||
struct io_channel_config {
|
||||
uint8_t channel;
|
||||
};
|
||||
|
||||
struct bvd_config {
|
||||
struct io_channel_config io_channel;
|
||||
struct gpio_dt_spec power;
|
||||
uint32_t output_ohm;
|
||||
uint32_t full_ohm;
|
||||
};
|
||||
|
||||
struct bvd_data {
|
||||
const struct device *adc;
|
||||
struct adc_channel_cfg acc;
|
||||
struct adc_sequence as;
|
||||
struct battery_value value;
|
||||
};
|
||||
|
||||
static int bvd_sample_fetch(const struct device *dev, enum sensor_channel chan) {
|
||||
struct bvd_data *drv_data = dev->data;
|
||||
const struct bvd_config *drv_cfg = dev->config;
|
||||
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;
|
||||
|
||||
#if DT_INST_NODE_HAS_PROP(0, power_gpios)
|
||||
// Enable power before sampling
|
||||
rc = gpio_pin_set_dt(&drv_cfg->power, 1);
|
||||
|
||||
if (rc != 0) {
|
||||
LOG_DBG("Failed to enable ADC power GPIO: %d", rc);
|
||||
return rc;
|
||||
}
|
||||
|
||||
// wait for any capacitance to charge up
|
||||
k_sleep(K_MSEC(10));
|
||||
#endif // DT_INST_NODE_HAS_PROP(0, power_gpios)
|
||||
|
||||
// Read ADC
|
||||
rc = adc_read(drv_data->adc, as);
|
||||
as->calibrate = false;
|
||||
|
||||
if (rc == 0) {
|
||||
int32_t val = drv_data->value.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", drv_data->value.adc_raw, val, millivolts);
|
||||
uint8_t percent = lithium_ion_mv_to_pct(millivolts);
|
||||
LOG_DBG("Percent: %d", percent);
|
||||
|
||||
drv_data->value.millivolts = millivolts;
|
||||
drv_data->value.state_of_charge = percent;
|
||||
} else {
|
||||
LOG_DBG("Failed to read ADC: %d", rc);
|
||||
}
|
||||
|
||||
#if DT_INST_NODE_HAS_PROP(0, power_gpios)
|
||||
// Disable power GPIO if present
|
||||
int rc2 = gpio_pin_set_dt(&drv_cfg->power, 0);
|
||||
|
||||
if (rc2 != 0) {
|
||||
LOG_DBG("Failed to disable ADC power GPIO: %d", rc2);
|
||||
return rc2;
|
||||
}
|
||||
#endif // DT_INST_NODE_HAS_PROP(0, power_gpios)
|
||||
|
||||
return rc;
|
||||
}
|
||||
|
||||
static int bvd_channel_get(const struct device *dev, enum sensor_channel chan,
|
||||
struct sensor_value *val) {
|
||||
struct bvd_data *drv_data = dev->data;
|
||||
return battery_channel_get(&drv_data->value, chan, val);
|
||||
}
|
||||
|
||||
static const struct sensor_driver_api bvd_api = {
|
||||
.sample_fetch = bvd_sample_fetch,
|
||||
.channel_get = bvd_channel_get,
|
||||
};
|
||||
|
||||
static int bvd_init(const struct device *dev) {
|
||||
struct bvd_data *drv_data = dev->data;
|
||||
const struct bvd_config *drv_cfg = dev->config;
|
||||
|
||||
if (drv_data->adc == NULL) {
|
||||
LOG_ERR("ADC failed to retrieve ADC driver");
|
||||
return -ENODEV;
|
||||
}
|
||||
|
||||
int rc = 0;
|
||||
|
||||
#if DT_INST_NODE_HAS_PROP(0, power_gpios)
|
||||
if (!device_is_ready(drv_cfg->power.port)) {
|
||||
LOG_ERR("GPIO port for power control is not ready");
|
||||
return -ENODEV;
|
||||
}
|
||||
rc = gpio_pin_configure_dt(&drv_cfg->power, GPIO_OUTPUT_INACTIVE);
|
||||
if (rc != 0) {
|
||||
LOG_ERR("Failed to control feed %u: %d", drv_cfg->power.pin, rc);
|
||||
return rc;
|
||||
}
|
||||
#endif // DT_INST_NODE_HAS_PROP(0, power_gpios)
|
||||
|
||||
drv_data->as = (struct adc_sequence){
|
||||
.channels = BIT(0),
|
||||
.buffer = &drv_data->value.adc_raw,
|
||||
.buffer_size = sizeof(drv_data->value.adc_raw),
|
||||
.oversampling = 4,
|
||||
.calibrate = true,
|
||||
};
|
||||
|
||||
#ifdef CONFIG_ADC_NRFX_SAADC
|
||||
drv_data->acc = (struct adc_channel_cfg){
|
||||
.gain = ADC_GAIN_1_6,
|
||||
.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 = {.adc = DEVICE_DT_GET(DT_IO_CHANNELS_CTLR(DT_DRV_INST(0)))};
|
||||
|
||||
static const struct bvd_config bvd_cfg = {
|
||||
.io_channel =
|
||||
{
|
||||
DT_IO_CHANNELS_INPUT(DT_DRV_INST(0)),
|
||||
},
|
||||
#if DT_INST_NODE_HAS_PROP(0, power_gpios)
|
||||
.power = GPIO_DT_SPEC_INST_GET(0, power_gpios),
|
||||
#endif
|
||||
.output_ohm = DT_INST_PROP(0, output_ohms),
|
||||
.full_ohm = DT_INST_PROP(0, full_ohms),
|
||||
};
|
||||
|
||||
DEVICE_DT_INST_DEFINE(0, &bvd_init, NULL, &bvd_data, &bvd_cfg, POST_KERNEL,
|
||||
CONFIG_SENSOR_INIT_PRIORITY, &bvd_api);
|
||||
9
app/module/drivers/sensor/ec11/CMakeLists.txt
Normal file
9
app/module/drivers/sensor/ec11/CMakeLists.txt
Normal file
@@ -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)
|
||||
52
app/module/drivers/sensor/ec11/Kconfig
Normal file
52
app/module/drivers/sensor/ec11/Kconfig
Normal file
@@ -0,0 +1,52 @@
|
||||
# Copyright (c) 2020 The ZMK Contributors
|
||||
# SPDX-License-Identifier: MIT
|
||||
|
||||
menuconfig EC11
|
||||
bool "EC11 Incremental Encoder Sensor"
|
||||
default y
|
||||
depends on DT_HAS_ALPS_EC11_ENABLED
|
||||
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
|
||||
161
app/module/drivers/sensor/ec11/ec11.c
Normal file
161
app/module/drivers/sensor/ec11/ec11.c
Normal file
@@ -0,0 +1,161 @@
|
||||
/*
|
||||
* Copyright (c) 2020 The ZMK Contributors
|
||||
*
|
||||
* SPDX-License-Identifier: MIT
|
||||
*/
|
||||
|
||||
#define DT_DRV_COMPAT alps_ec11
|
||||
|
||||
#include <zephyr/device.h>
|
||||
#include <zephyr/drivers/gpio.h>
|
||||
#include <zephyr/sys/util.h>
|
||||
#include <zephyr/kernel.h>
|
||||
#include <zephyr/drivers/sensor.h>
|
||||
#include <zephyr/sys/__assert.h>
|
||||
#include <zephyr/logging/log.h>
|
||||
|
||||
#include "ec11.h"
|
||||
|
||||
#define FULL_ROTATION 360
|
||||
|
||||
LOG_MODULE_REGISTER(EC11, CONFIG_SENSOR_LOG_LEVEL);
|
||||
|
||||
static int ec11_get_ab_state(const struct device *dev) {
|
||||
const struct ec11_config *drv_cfg = dev->config;
|
||||
|
||||
return (gpio_pin_get_dt(&drv_cfg->a) << 1) | gpio_pin_get_dt(&drv_cfg->b);
|
||||
}
|
||||
|
||||
static int ec11_sample_fetch(const struct device *dev, enum sensor_channel chan) {
|
||||
struct ec11_data *drv_data = dev->data;
|
||||
const struct ec11_config *drv_cfg = dev->config;
|
||||
uint8_t val;
|
||||
int8_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;
|
||||
|
||||
// TODO: Temporary code for backwards compatibility to support
|
||||
// the sensor channel rotation reporting *ticks* instead of delta of degrees.
|
||||
// REMOVE ME
|
||||
if (drv_cfg->steps == 0) {
|
||||
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(const struct device *dev, enum sensor_channel chan,
|
||||
struct sensor_value *val) {
|
||||
struct ec11_data *drv_data = dev->data;
|
||||
const struct ec11_config *drv_cfg = dev->config;
|
||||
int32_t pulses = drv_data->pulses;
|
||||
|
||||
if (chan != SENSOR_CHAN_ROTATION) {
|
||||
return -ENOTSUP;
|
||||
}
|
||||
|
||||
drv_data->pulses = 0;
|
||||
|
||||
if (drv_cfg->steps > 0) {
|
||||
val->val1 = (pulses * FULL_ROTATION) / drv_cfg->steps;
|
||||
val->val2 = (pulses * FULL_ROTATION) % drv_cfg->steps;
|
||||
if (val->val2 != 0) {
|
||||
val->val2 *= 1000000;
|
||||
val->val2 /= drv_cfg->steps;
|
||||
}
|
||||
} else {
|
||||
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(const struct device *dev) {
|
||||
struct ec11_data *drv_data = dev->data;
|
||||
const struct ec11_config *drv_cfg = dev->config;
|
||||
|
||||
LOG_DBG("A: %s %d B: %s %d resolution %d", drv_cfg->a.port->name, drv_cfg->a.pin,
|
||||
drv_cfg->b.port->name, drv_cfg->b.pin, drv_cfg->resolution);
|
||||
|
||||
if (!device_is_ready(drv_cfg->a.port)) {
|
||||
LOG_ERR("A GPIO device is not ready");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
if (!device_is_ready(drv_cfg->b.port)) {
|
||||
LOG_ERR("B GPIO device is not ready");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
if (gpio_pin_configure_dt(&drv_cfg->a, GPIO_INPUT)) {
|
||||
LOG_DBG("Failed to configure A pin");
|
||||
return -EIO;
|
||||
}
|
||||
|
||||
if (gpio_pin_configure_dt(&drv_cfg->b, 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 = GPIO_DT_SPEC_INST_GET(n, a_gpios), \
|
||||
.b = GPIO_DT_SPEC_INST_GET(n, b_gpios), \
|
||||
.resolution = DT_INST_PROP_OR(n, resolution, 1), \
|
||||
.steps = DT_INST_PROP_OR(n, steps, 0), \
|
||||
}; \
|
||||
DEVICE_DT_INST_DEFINE(n, ec11_init, NULL, &ec11_data_##n, &ec11_cfg_##n, POST_KERNEL, \
|
||||
CONFIG_SENSOR_INIT_PRIORITY, &ec11_driver_api);
|
||||
|
||||
DT_INST_FOREACH_STATUS_OKAY(EC11_INST)
|
||||
52
app/module/drivers/sensor/ec11/ec11.h
Normal file
52
app/module/drivers/sensor/ec11/ec11.h
Normal file
@@ -0,0 +1,52 @@
|
||||
/*
|
||||
* Copyright (c) 2020 The ZMK Contributors
|
||||
*
|
||||
* SPDX-License-Identifier: MIT
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <zephyr/device.h>
|
||||
#include <zephyr/drivers/gpio.h>
|
||||
#include <zephyr/sys/util.h>
|
||||
|
||||
struct ec11_config {
|
||||
const struct gpio_dt_spec a;
|
||||
const struct gpio_dt_spec b;
|
||||
|
||||
const uint16_t steps;
|
||||
const uint8_t resolution;
|
||||
};
|
||||
|
||||
struct ec11_data {
|
||||
uint8_t ab_state;
|
||||
int8_t pulses;
|
||||
int8_t ticks;
|
||||
int8_t delta;
|
||||
|
||||
#ifdef CONFIG_EC11_TRIGGER
|
||||
struct gpio_callback a_gpio_cb;
|
||||
struct gpio_callback b_gpio_cb;
|
||||
const 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(const struct device *dev, const struct sensor_trigger *trig,
|
||||
sensor_trigger_handler_t handler);
|
||||
|
||||
int ec11_init_interrupt(const struct device *dev);
|
||||
#endif
|
||||
146
app/module/drivers/sensor/ec11/ec11_trigger.c
Normal file
146
app/module/drivers/sensor/ec11/ec11_trigger.c
Normal file
@@ -0,0 +1,146 @@
|
||||
/*
|
||||
* Copyright (c) 2020 The ZMK Contributors
|
||||
*
|
||||
* SPDX-License-Identifier: MIT
|
||||
*/
|
||||
|
||||
#define DT_DRV_COMPAT alps_ec11
|
||||
|
||||
#include <zephyr/device.h>
|
||||
#include <zephyr/drivers/gpio.h>
|
||||
#include <zephyr/sys/util.h>
|
||||
#include <zephyr/kernel.h>
|
||||
#include <zephyr/drivers/sensor.h>
|
||||
|
||||
#include "ec11.h"
|
||||
|
||||
extern struct ec11_data ec11_driver;
|
||||
|
||||
#include <zephyr/logging/log.h>
|
||||
LOG_MODULE_DECLARE(EC11, CONFIG_SENSOR_LOG_LEVEL);
|
||||
|
||||
static inline void setup_int(const struct device *dev, bool enable) {
|
||||
const struct ec11_config *cfg = dev->config;
|
||||
|
||||
LOG_DBG("enabled %s", (enable ? "true" : "false"));
|
||||
|
||||
if (gpio_pin_interrupt_configure_dt(&cfg->a, enable ? GPIO_INT_EDGE_BOTH : GPIO_INT_DISABLE)) {
|
||||
LOG_WRN("Unable to set A pin GPIO interrupt");
|
||||
}
|
||||
|
||||
if (gpio_pin_interrupt_configure_dt(&cfg->b, enable ? GPIO_INT_EDGE_BOTH : GPIO_INT_DISABLE)) {
|
||||
LOG_WRN("Unable to set A pin GPIO interrupt");
|
||||
}
|
||||
}
|
||||
|
||||
static void ec11_a_gpio_callback(const struct device *dev, struct gpio_callback *cb,
|
||||
uint32_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(const struct device *dev, struct gpio_callback *cb,
|
||||
uint32_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(const struct device *dev) {
|
||||
struct ec11_data *drv_data = dev->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) {
|
||||
const struct device *dev = INT_TO_POINTER(dev_ptr);
|
||||
struct ec11_data *drv_data = dev->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(const struct device *dev, const struct sensor_trigger *trig,
|
||||
sensor_trigger_handler_t handler) {
|
||||
struct ec11_data *drv_data = dev->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(const struct device *dev) {
|
||||
struct ec11_data *drv_data = dev->data;
|
||||
const struct ec11_config *drv_cfg = dev->config;
|
||||
|
||||
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_cfg->a.port, &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_cfg->b.port, &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;
|
||||
}
|
||||
Reference in New Issue
Block a user