This header file defines the prototypes for keyboard matrix driver functions. More...

Macros
#define	DRV_KEYBOARD_MAX_KEYS 6
	Maximum number of simultaneously held keys.

Functions
ret_code_t	drv_keyboard_disable (void)
	Disable keyboard scanning. More...

ret_code_t	drv_keyboard_enable (void)
	Enable keyboard scanning. More...

ret_code_t	drv_keyboard_init (drv_keyboard_event_handler_t keyboard_event_handler)
	Keyboard driver initialization. More...

ret_code_t	drv_keyboard_keys_get (uint8_t p_pressed_keys, uint8_t p_number_of_pressed_keys, bool *p_keys_blocked)
	Get the state of keyboard matrix. More...

bool	drv_keyboard_shutdown (bool wakeup)
	Shutdown keyboard and prepare it for sleeping. More...

Detailed Description

This header file defines the prototypes for keyboard matrix driver functions.

Function Documentation

ret_code_t drv_keyboard_disable ( void )

Disable keyboard scanning.

ret_code_t drv_keyboard_enable ( void )

Enable keyboard scanning.

ret_code_t drv_keyboard_init ( drv_keyboard_event_handler_t keyboard_event_handler )

Keyboard driver initialization.

Parameters

[in] keyboard_event_handler Handler for data read from the keyboard.

ret_code_t drv_keyboard_keys_get	(	uint8_t *	p_pressed_keys,
		uint8_t *	p_number_of_pressed_keys,
		bool *	p_keys_blocked
	)

Get the state of keyboard matrix.

One scan performed as a blocking function. Functional only when pulling is disabled. Returns an error otherwise.

Parameters

[out]	p_pressed_keys	Pointer to the pressed_keys array. The array should have at least KEY_VECTOR_SIZE elements.
[out]	p_number_of_pressed_keys	Number of pressed keys.
[out]	p_keys_blocked	True, if some keys are blocked and cannot be read.

bool drv_keyboard_shutdown ( bool wakeup )

Shutdown keyboard and prepare it for sleeping.

Parameters

[in] wakeup If false, go to deepest sleep and do not prepare to wake up the system.