Keyscan Interface Queue

Functions
wiced_bool_t	wiced_hal_keyscan_events_pending (void)
	Defines a keyscan driver. More...
wiced_bool_t	wiced_hal_keyscan_get_next_event (KeyEvent *key)
	Get the next event. More...
void	wiced_hal_keyscan_flush_HW_events (void)
	Clears the keys in the HW queue. More...

Detailed Description

Function Documentation

wiced_bool_t wiced_hal_keyscan_events_pending

(

void

)

Defines a keyscan driver.

The keyscan interface is practically defined as a queue from the consumer's perspective. Key up/down events are seen as a stream coming from the driver. In addition the interface provides the user with the ability to reset the HW as well as turn key scanning on/off. Check if there are any pending events in the firmware FIFO

Returns

• WICED_TRUE if keyscan events are pending in firmware FIFO
• WICED_FALSE otherwise

void wiced_hal_keyscan_flush_HW_events

(

void

)

Clears the keys in the HW queue.

Parameters

-none

Returns

- none

wiced_bool_t wiced_hal_keyscan_get_next_event

(

KeyEvent *

key

)

Get the next event.

Note that this function only returns events from the FW FIFO. It does not check the HW. The HW is checked when the MIA poll function is called.

Parameters

key	- pointer to the key event

Returns

• WICED_FALSE - if FW fifo is empty,
• WICED_TRUE - otherwise.