Keys on GPIOs, reported as Input key events. More...

Data Structures
struct	pbl_gpio_keys_key
	A key. More...

struct	pbl_gpio_keys
	Keys on GPIOs. More...

Macros
#define	PBL_GPIO_KEYS_KEY(_label, _gpio, _code, _debounce_interval_ms)
	Initializer for a key.

#define	PBL_GPIO_KEYS_DEFINE(sym, _name, ...)
	Define and register a set of keys.

Detailed Description

Keys on GPIOs, reported as Input key events.

Each edge of a key restarts its debounce timer; when the timer expires the key is read and, if it changed, reported. A key must therefore be stable for its debounce interval to be reported. Keys held at initialization are reported once their debounce interval has elapsed.

The configuration follows the devicetree gpio-keys binding, one key per child node:

PBL_GPIO_KEYS_DEFINE(BUTTONS, "buttons",
  PBL_GPIO_KEYS_KEY("Back", PBL_GPIO(NRF5_GPIO_P0, 28, PBL_GPIO_ACTIVE_LOW | PBL_GPIO_PULL_UP),
                    PBL_INPUT_KEY_BACK, 40),
  ...);

Data Structure Documentation

◆ pbl_gpio_keys_key

struct pbl_gpio_keys_key

A key.

Data Fields
uint16_t	code	PBL_INPUT_EV_KEY code, `linux`,code.
uint16_t	debounce_interval_ms	Time the key must be stable to be reported, in ms, `debounce-interval`.
struct pbl_gpio	gpio	GPIO, `gpios`; reads active while pressed.
const char *	label	Name, `label`.

◆ pbl_gpio_keys

struct pbl_gpio_keys

Keys on GPIOs.

Data Fields
struct pbl_device	dev	Device.
const struct pbl_gpio_keys_key *	keys	Keys.
uint8_t	num_keys	Number of keys.
struct pbl_gpio_keys_key_state *	state	Runtime state of each key.

Macro Definition Documentation

◆ PBL_GPIO_KEYS_DEFINE

#define PBL_GPIO_KEYS_DEFINE	(	sym,
		_name,
		...
	)

Value:

  static const struct pbl_gpio_keys_key sym##_keys[] = {__VA_ARGS__};              \
  static struct pbl_gpio_keys_key_state sym##_key_state[ARRAY_LENGTH(sym##_keys)]; \
  PBL_DEVICE_STATE_DEFINE(sym);                                                    \
  const struct pbl_gpio_keys sym = {                                               \
    .dev = PBL_DEVICE_INIT(sym, _name, pbl_gpio_keys_init, nullptr, nullptr),      \
    .keys = sym##_keys,                                                            \
    .state = sym##_key_state,                                                      \
    .num_keys = ARRAY_LENGTH(sym##_keys),                                          \
  };                                                                               \
  PBL_DEVICE_REGISTER(sym, &sym.dev)

Define and register a set of keys.

Parameters

sym	Symbol of the struct pbl_gpio_keys.
_name	Device name.
...	Keys, each a PBL_GPIO_KEYS_KEY.

◆ PBL_GPIO_KEYS_KEY

#define PBL_GPIO_KEYS_KEY	(	_label,
		_gpio,
		_code,
		_debounce_interval_ms
	)