bm_buttons.h

/*
 * Copyright (c) 2012-2025 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef BM_BUTTONS_H__
#define BM_BUTTONS_H__
 
#include <stdint.h>
#include <stdbool.h>
 
#include <bm/bm_timer.h>
#include <nrfx_gpiote.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define BM_BUTTONS_DETECTION_DELAY_MIN_US                                                          \
        (2 * k_ticks_to_us_ceil32(MAX(1, BM_TIMER_MIN_TIMEOUT_TICKS)))
 
enum bm_buttons_evt_type {
        /* Indicates that a button is released. */
        BM_BUTTONS_RELEASE = 0,
        /* Indicates that a button is pressed. */
        BM_BUTTONS_PRESS = 1
};
 
enum bm_buttons_active_state {
        /* Indicates that a button is active low. */
        BM_BUTTONS_ACTIVE_LOW = 0,
        /* Indicates that a button is active high. */
        BM_BUTTONS_ACTIVE_HIGH = 1
};
 
enum bm_buttons_pin_pull {
        /* Pin pull-up resistor disabled. */
        BM_BUTTONS_PIN_NOPULL = NRF_GPIO_PIN_NOPULL,
        /* Pin pull-down resistor enabled. */
        BM_BUTTONS_PIN_PULLDOWN = NRF_GPIO_PIN_PULLDOWN,
        /* Pin pull-up resistor enabled. */
        BM_BUTTONS_PIN_PULLUP = NRF_GPIO_PIN_PULLUP,
};
 
typedef void (*bm_buttons_handler_t)(uint8_t pin_number, enum bm_buttons_evt_type action);
 
struct bm_buttons_config {
        /* Pin to be used as a button. */
        uint8_t pin_number;
        /* BM_BUTTONS_ACTIVE_HIGH or BM_BUTTONS_ACTIVE_LOW. */
        enum bm_buttons_active_state active_state;
        /* Pull-up or pull-down configuration. */
        enum bm_buttons_pin_pull pull_config;
        /* Handler to be called when the button is pressed. */
        bm_buttons_handler_t handler;
};
 
int bm_buttons_init(const struct bm_buttons_config *configs, uint8_t num_configs,
                    uint32_t detection_delay);
 
int bm_buttons_deinit(void);
 
int bm_buttons_enable(void);
 
int bm_buttons_disable(void);
 
bool bm_buttons_is_pressed(uint8_t pin);
 
#ifdef __cplusplus
}
#endif
 
#endif /* BM_BUTTONS_H__ */