Skip to content

Commit

Permalink
feat(power): Initial deep sleep work.
Browse files Browse the repository at this point in the history 
* New ZMK_SLEEP Kconfig symbol to enable the functionality.
* Switch to PORT events that allows wake from deep sleep.
* Initial basic power management policy, with idle ms,
  and ignoring deep sleep if we detect a USB connection.
  • Loading branch information
@petejohanson
petejohanson committed Oct 6, 2020
1 parent 9be5666 commit a7496ab
Show file tree
Hide file tree
Showing 5 changed files with 121 additions and 29 deletions.
1 change: 1 addition & 0 deletions app/CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ zephyr_linker_sources(RODATA include/linker/zmk-events.ld)
# Add your source file to the "app" target. This must come after
# find_package(Zephyr) which defines the target.
target_include_directories(app PRIVATE include)
target_sources_ifdef(CONFIG_ZMK_SLEEP app PRIVATE src/power.c)
target_sources(app PRIVATE src/kscan.c)
target_sources(app PRIVATE src/matrix_transform.c)
target_sources(app PRIVATE src/hid.c)
Expand Down
20 changes: 19 additions & 1 deletion app/Kconfig
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,25 @@ endif

endmenu

menuconfig ZMK_SLEEP
bool "Enable deep sleep support"
imply USB

if ZMK_SLEEP

config SYS_POWER_DEEP_SLEEP_STATES
default y

choice SYS_PM_POLICY
default SYS_PM_POLICY_APP
endchoice

config ZMK_IDLE_SLEEP_TIMEOUT
int "Milliseconds to wait to sleep when going idle"
default 900000

endif

config ZMK_DISPLAY
bool "ZMK display support"
default n
Expand Down Expand Up @@ -112,7 +131,6 @@ config ZMK_SPLIT_BLE_ROLE_CENTRAL

config ZMK_SPLIT_BLE_ROLE_PERIPHERAL
bool "Peripheral"
select BT_KEYS_OVERWRITE_OLDEST

if ZMK_SPLIT_BLE_ROLE_PERIPHERAL

Expand Down
58 changes: 31 additions & 27 deletions app/drivers/zephyr/kscan_gpio_matrix.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ static int kscan_gpio_config_interrupts(struct device **devices,
}; \
struct kscan_gpio_data_##n { \
kscan_callback_t callback; \
COND_CODE_0(CONFIG_ZMK_KSCAN_MATRIX_POLLING, (), (struct k_timer poll_timer;)) \
COND_CODE_1(CONFIG_ZMK_KSCAN_MATRIX_POLLING, (struct k_timer poll_timer;), ()) \
struct COND_CODE_0(DT_INST_PROP(n, debounce_period), (k_work), (k_delayed_work)) work; \
bool matrix_state[INST_MATRIX_ROWS(n)][INST_MATRIX_COLS(n)]; \
struct device *rows[INST_MATRIX_ROWS(n)]; \
Expand Down Expand Up @@ -101,7 +101,7 @@ static int kscan_gpio_config_interrupts(struct device **devices,
return ( \
COND_CODE_0(DT_ENUM_IDX(DT_DRV_INST(n), diode_direction), (cfg->rows), (cfg->cols))); \
} \
COND_CODE_0(CONFIG_ZMK_KSCAN_MATRIX_POLLING, \
COND_CODE_1(CONFIG_ZMK_KSCAN_MATRIX_POLLING, (), \
( \
static int kscan_gpio_enable_interrupts_##n(struct device *dev) { \
return kscan_gpio_config_interrupts( \
Expand All @@ -111,8 +111,7 @@ static int kscan_gpio_config_interrupts(struct device **devices,
return kscan_gpio_config_interrupts(kscan_gpio_input_devices_##n(dev), \
kscan_gpio_input_configs_##n(dev), \
INST_INPUT_LEN(n), GPIO_INT_DISABLE); \
}), \
()) \
})) \
static void kscan_gpio_set_output_state_##n(struct device *dev, int value) { \
int err; \
for (int i = 0; i < INST_OUTPUT_LEN(n); i++) { \
Expand Down Expand Up @@ -173,25 +172,29 @@ static int kscan_gpio_config_interrupts(struct device **devices,
k_delayed_work_submit(&data->work, K_MSEC(5)); \
})) \
} else { \
kscan_gpio_enable_interrupts_##n(dev); \
COND_CODE_1(CONFIG_ZMK_KSCAN_MATRIX_POLLING, (), \
(kscan_gpio_enable_interrupts_##n(dev);)) \
} \
return 0; \
} \
static void kscan_gpio_work_handler_##n(struct k_work *work) { \
struct kscan_gpio_data_##n *data = CONTAINER_OF(work, struct kscan_gpio_data_##n, work); \
kscan_gpio_read_##n(data->dev); \
} \
static void kscan_gpio_irq_callback_handler_##n(struct device *dev, struct gpio_callback *cb, \
gpio_port_pins_t pin) { \
struct kscan_gpio_irq_callback_##n *data = \
CONTAINER_OF(cb, struct kscan_gpio_irq_callback_##n, callback); \
kscan_gpio_disable_interrupts_##n(data->dev); \
COND_CODE_0(DT_INST_PROP(n, debounce_period), ({ k_work_submit(data->work); }), ({ \
k_delayed_work_cancel(data->work); \
k_delayed_work_submit(data->work, \
K_MSEC(DT_INST_PROP(n, debounce_period))); \
})) \
} \
COND_CODE_1(CONFIG_ZMK_KSCAN_MATRIX_POLLING, (), \
(static void kscan_gpio_irq_callback_handler_##n( \
struct device *dev, struct gpio_callback *cb, gpio_port_pins_t pin) { \
struct kscan_gpio_irq_callback_##n *data = \
CONTAINER_OF(cb, struct kscan_gpio_irq_callback_##n, callback); \
kscan_gpio_disable_interrupts_##n(data->dev); \
COND_CODE_0(DT_INST_PROP(n, debounce_period), \
({ k_work_submit(data->work); }), ({ \
k_delayed_work_cancel(data->work); \
k_delayed_work_submit( \
data->work, K_MSEC(DT_INST_PROP(n, debounce_period))); \
})) \
})) \
\
static struct kscan_gpio_data_##n kscan_gpio_data_##n = { \
.rows = {[INST_MATRIX_ROWS(n) - 1] = NULL}, .cols = {[INST_MATRIX_COLS(n) - 1] = NULL}}; \
static int kscan_gpio_configure_##n(struct device *dev, kscan_callback_t callback) { \
Expand All @@ -204,24 +207,25 @@ static int kscan_gpio_config_interrupts(struct device **devices,
return 0; \
}; \
static int kscan_gpio_enable_##n(struct device *dev) { \
COND_CODE_0(CONFIG_ZMK_KSCAN_MATRIX_POLLING, \
(int err = kscan_gpio_enable_interrupts_##n(dev); \
if (err) { return err; } return kscan_gpio_read_##n(dev);), \
COND_CODE_1(CONFIG_ZMK_KSCAN_MATRIX_POLLING, \
(struct kscan_gpio_data_##n *data = dev->driver_data; \
k_timer_start(&data->poll_timer, K_MSEC(10), K_MSEC(10)); return 0;)) \
k_timer_start(&data->poll_timer, K_MSEC(10), K_MSEC(10)); return 0;), \
(int err = kscan_gpio_enable_interrupts_##n(dev); \
if (err) { return err; } return kscan_gpio_read_##n(dev);)) \
}; \
static int kscan_gpio_disable_##n(struct device *dev) { \
COND_CODE_0(CONFIG_ZMK_KSCAN_MATRIX_POLLING, \
(return kscan_gpio_disable_interrupts_##n(dev);), \
COND_CODE_1(CONFIG_ZMK_KSCAN_MATRIX_POLLING, \
(struct kscan_gpio_data_##n *data = dev->driver_data; \
k_timer_stop(&data->poll_timer); return 0;)) \
k_timer_stop(&data->poll_timer); return 0;), \
(return kscan_gpio_disable_interrupts_##n(dev);)) \
}; \
COND_CODE_0(CONFIG_ZMK_KSCAN_MATRIX_POLLING, (), \
COND_CODE_1(CONFIG_ZMK_KSCAN_MATRIX_POLLING, \
(static void kscan_gpio_timer_handler(struct k_timer *timer) { \
struct kscan_gpio_data_##n *data = \
CONTAINER_OF(timer, struct kscan_gpio_data_##n, poll_timer); \
k_work_submit(&data->work.work); \
})) \
}), \
()) \
static int kscan_gpio_init_##n(struct device *dev) { \
struct kscan_gpio_data_##n *data = dev->driver_data; \
int err; \
Expand Down Expand Up @@ -267,8 +271,8 @@ static int kscan_gpio_config_interrupts(struct device **devices,
} \
} \
data->dev = dev; \
COND_CODE_0(CONFIG_ZMK_KSCAN_MATRIX_POLLING, (), \
(k_timer_init(&data->poll_timer, kscan_gpio_timer_handler, NULL);)) \
COND_CODE_1(CONFIG_ZMK_KSCAN_MATRIX_POLLING, \
(k_timer_init(&data->poll_timer, kscan_gpio_timer_handler, NULL);), ()) \
(COND_CODE_0(DT_INST_PROP(n, debounce_period), (k_work_init), (k_delayed_work_init)))( \
&data->work, kscan_gpio_work_handler_##n); \
return 0; \
Expand Down
2 changes: 1 addition & 1 deletion app/include/dt-bindings/zmk/bt.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ defines these aliases up front.
#define BT_CLR BT_CLR_CMD 0
#define BT_NXT BT_NXT_CMD 0
#define BT_PRV BT_PRV_CMD 0
#define BT_SEL BT_SEL_CMD
#define BT_SEL BT_SEL_CMD
69 changes: 69 additions & 0 deletions app/src/power.c
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
/*
* Copyright (c) 2020 The ZMK Contributors
*
* SPDX-License-Identifier: MIT
*/

#include <zephyr.h>
#include <kernel.h>
#include <power/power.h>

#include <logging/log.h>

LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL);

#include <zmk/usb.h>
#include <zmk/event-manager.h>
#include <zmk/events/position-state-changed.h>
#include <zmk/events/sensor-event.h>

static u32_t power_last_uptime;

#define MAX_IDLE_MS CONFIG_ZMK_IDLE_SLEEP_TIMEOUT

bool is_usb_power_present() {
#ifdef CONFIG_USB
enum usb_dc_status_code usb_status = zmk_usb_get_status();
switch (usb_status) {
case USB_DC_DISCONNECTED:
case USB_DC_UNKNOWN:
return false;
default:
return true;
}
#else
return false;
#endif /* CONFIG_USB */
}

enum power_states sys_pm_policy_next_state(s32_t ticks) {
#ifdef CONFIG_SYS_POWER_DEEP_SLEEP_STATES
#ifdef CONFIG_HAS_SYS_POWER_STATE_DEEP_SLEEP_1
s32_t current = k_uptime_get();
if (power_last_uptime > 0 && !is_usb_power_present() &&
current - power_last_uptime > MAX_IDLE_MS) {
return SYS_POWER_STATE_DEEP_SLEEP_1;
}
#endif /* CONFIG_HAS_SYS_POWER_STATE_DEEP_SLEEP_1 */
#endif /* CONFIG_SYS_POWER_DEEP_SLEEP_STATES */

return SYS_POWER_STATE_ACTIVE;
}

int power_event_listener(const struct zmk_event_header *eh) {
power_last_uptime = k_uptime_get();

return 0;
}

int power_init() {
power_last_uptime = k_uptime_get();

return 0;
}

ZMK_LISTENER(power, power_event_listener);
ZMK_SUBSCRIPTION(power, position_state_changed);
ZMK_SUBSCRIPTION(power, sensor_event);

SYS_INIT(power_init, APPLICATION, CONFIG_APPLICATION_INIT_PRIORITY);

0 comments on commit a7496ab

Please sign in to comment.