Keyscan Button

Functions
void	wiced_hal_keyscan_button_configure (uint8_t num_buttons, wiced_bool_t flush_user_activity_allowed, wiced_bool_t clear_cur_button_state_on_flush, uint16_t *report_bits)
	Defines the button driver that based on keyscan driver using keyscan hardware. More...
void	wiced_hal_keyscan_button_init (void)
	Initilaiizes the button interface. More...
uint16_t	wiced_hal_keyscan_button_get_current_state (void)
	Get the current button state. More...
uint16_t	wiced_hal_keyscan_button_flush (void)
	Flush any queued button activity in FW or HW. More...

Detailed Description

Function Documentation

void wiced_hal_keyscan_button_configure	(	uint8_t	num_buttons,
		wiced_bool_t	flush_user_activity_allowed,
		wiced_bool_t	clear_cur_button_state_on_flush,
		uint16_t *	report_bits
	)

Defines the button driver that based on keyscan driver using keyscan hardware.

Buttons are implemented as keys. A scan matrix of 1 row, n cols is created and scanned by the keyscan hardware. The hardware reports the state of the buttons as keys. This information is translated by the button interface into a byte representing various buttons. configure button driver

Application use this to configure the button driver, which is based on keyscan driver using the keyscan HW

Parameters

num_buttons	- defines the number of columns in keyscan matrix. MAX is 16. For button driver, number of rows is always 1.
flushUserActivityAllowed	- indicates whether all pending key events should be processed when a flush request is received.
clearCurButtonStateOnFlush	-indicates whether current button state should be cleared on a flush. Note!!! this is independent of flushUserActivityAllowed item However, it is reccommended that this flag should only be set to WICED_TRUE if flushUserActivityAllowed is set to WICED_TRUE
report_bits	-pointer to button report bit mapping

Default button configuraton is as followed: { // Default to 4 buttons 4,

// Disregard flush request from the mouse application. // Flushing may cause us to lose connect button events FALSE,

// Don't clear button state on flush. This means that a flush determines the // current state of the buttons, discarding intermediate events FALSE,

// Button bit to report bit mappings // repor_bits { // 1st button is left button 0x0001,

// 2nd button is middle button 0x0004,

// 3rd button is right button 0x0002,

// 4th button is connect button. Map it as the last button 0x8000 } };

Returns

- none

uint16_t wiced_hal_keyscan_button_flush

(

void

)

Flush any queued button activity in FW or HW.

This function actually processes all pending key events from the keyscan driver. Depending on the configuration it may also set state of all buttons to "not pressed"

Returns

Bit mapped value providing the current button state

uint16_t wiced_hal_keyscan_button_get_current_state

(

void

)

Get the current button state.

Returns

Bit mapped value providing the current button state

void wiced_hal_keyscan_button_init

(

void

)

Initilaiizes the button interface.

The state of all buttons is cleared. This must be invoked once at power up before accessing any button services Since this initializes keyscan driver, keyscan driver must not be initialized separately. This will cause undefined behavior. Also, button driver must be initialized after mia driver has been initialized.