[CXRD-19] Added User button actions subsys

- added user action subsytem to monitor actions on button

Signed-off-by: Anuj Pathak <[email protected]>

Author: cx-anuj-pathak

include/user_button_actions/user_button_actions.h

@@ -0,0 +1,44 @@
+#pragma once
+
+#include <stdint.h>
+#include <zephyr/kernel.h>
+#include <zephyr/drivers/gpio.h>
+#include <utils/sll_listeners.h>
+
+enum user_button_actions {
+	eUSER_BUTTON_PRESS = 0x01,
+	eUSER_BUTTON_CLICK = 0x11,
+	eUSER_BUTTON_CLICK_AND_HOLD = 0x12,
+	eUSER_BUTTON_DOUBLE_CLICK = 0x22,
+	eUSER_BUTTON_DOUBLE_CLICK_AND_HOLD = 0x23,
+	eUSER_BUTTON_TRIPLE_CLICK = 0x33,
+	eUSER_BUTTON_TRIPLE_CLICK_AND_HOLD = 0x34,
+};
+
+union user_button_action_code {
+	struct {
+		uint8_t down_cnt : 4;
+		uint8_t up_cnt : 4;
+	};
+	uint8_t code;
+};
+
+struct user_button_actions_channel {
+	uint8_t id;
+	union user_button_action_code _rv;
+	union user_button_action_code result;
+	struct k_timer timer;
+	struct k_work work;
+	struct gpio_dt_spec btn;
+	struct gpio_callback cb;
+};
+
+typedef void (*user_button_actions_callback)(struct user_button_actions_channel *ch);
+
+struct user_button_actions_listener {
+	user_button_actions_callback handler;
+};
+
+SLL_LISTENER_DECLARE(user_button_actions, struct user_button_actions_listener);
+
+int user_button_actions_start_monitor(struct user_button_actions_channel *ch);

subsys/CMakeLists.txt

@@ -1 +1,2 @@
 add_subdirectory_ifdef(CONFIG_USER_ALERTS user_alerts)
+add_subdirectory_ifdef(CONFIG_USER_BUTTON_ACTIONS user_button_actions)

subsys/Kconfig

@@ -1 +1,2 @@
 rsource "user_alerts/Kconfig"
+rsource "user_button_actions/Kconfig"

subsys/user_button_actions/CMakeLists.txt

@@ -0,0 +1,4 @@
+zephyr_library()
+zephyr_library_sources(
+	user_button_actions.c
+)

subsys/user_button_actions/Kconfig

@@ -0,0 +1,18 @@
+config USER_BUTTON_ACTIONS
+	bool "Enable user buttin actions monitoring"
+	select GPIO
+	help
+	  enable button monitoring to help user signal
+	  multiple actions to the user
+
+if USER_BUTTON_ACTIONS
+
+config USER_BUTTON_ACTION_HOLD_TIMEOUT_MS
+	int "timeout to detect button hold"
+	default 1000
+
+config USER_BUTTON_ACTION_RE_CLICK_TIMEOUT_MS
+	int "timeout to detect button hold"
+	default 250
+
+endif

subsys/user_button_actions/user_button_actions.c

@@ -0,0 +1,90 @@
+#include <user_button_actions/user_button_actions.h>
+#include <zephyr/kernel.h>
+#include <zephyr/device.h>
+#include <zephyr/logging/log.h>
+#include <zephyr/drivers/gpio.h>
+
+LOG_MODULE_REGISTER(user_button_actions);
+
+#define CB_NULL_CHECK(cb) (((cb)->handler) != NULL)
+
+SLL_LISTENER_DEFINE(user_button_actions, CB_NULL_CHECK);
+
+void user_button_actions_fire_work(struct k_work *work)
+{
+	struct user_button_actions_channel *ch = CONTAINER_OF(work,
+							struct user_button_actions_channel,
+							work);
+	if ((ch->_rv.down_cnt - ch->_rv.up_cnt) <= 1) {
+		LOG_INF("BTN Action %x", ch->result.code);
+		SLL_LISTENER_FIRE_NODES(user_button_actions, handler, ch);
+	}
+}
+
+void user_button_actions_timeout(struct k_timer *timer)
+{
+	struct user_button_actions_channel *ch = CONTAINER_OF(timer,
+							struct user_button_actions_channel,
+							timer);
+	ch->result.code = ch->_rv.code;
+	ch->_rv.code = 0;
+	k_work_submit(&ch->work);
+}
+
+static void user_button_actions_handler(const struct device *dev,
+					struct gpio_callback *cb,
+					uint32_t pins)
+{
+	struct user_button_actions_channel *ch = CONTAINER_OF(cb,
+							struct user_button_actions_channel,
+							cb);
+	if (gpio_pin_get_dt(&ch->btn)) {
+		// pressed
+		ch->_rv.down_cnt++;
+		k_timer_start(&ch->timer,
+			K_MSEC(CONFIG_USER_BUTTON_ACTION_HOLD_TIMEOUT_MS),
+			K_NO_WAIT);
+	} else {
+		// releases
+		ch->_rv.up_cnt++;
+		k_timer_start(&ch->timer,
+			K_MSEC(CONFIG_USER_BUTTON_ACTION_RE_CLICK_TIMEOUT_MS),
+			K_NO_WAIT);
+	}
+}
+
+int user_button_actions_start_monitor(struct user_button_actions_channel *ch)
+{
+	int err;
+
+	err = gpio_is_ready_dt(&ch->btn);
+	if (!err) {
+		LOG_ERR("BTN is not ready");
+		return 0;
+	}
+
+	err = gpio_pin_configure_dt(&ch->btn, GPIO_INPUT);
+	if (err) {
+		LOG_ERR("BTN is config err %d", err);
+		return 0;
+	}
+
+	gpio_init_callback(&ch->cb, user_button_actions_handler, BIT(ch->btn.pin));
+
+	err = gpio_add_callback(ch->btn.port, &ch->cb);
+	if (err) {
+		LOG_ERR("Callback config err %d", err);
+		return 0;
+	}
+
+	err = gpio_pin_interrupt_configure_dt(&ch->btn, GPIO_INT_EDGE_BOTH);
+	if (err) {
+		LOG_ERR("int config err %d", err);
+		return 0;
+	}
+
+	k_timer_init(&ch->timer, user_button_actions_timeout, NULL);
+	k_work_init(&ch->work, user_button_actions_fire_work);
+
+	return 0;
+}