Key Matrix Interface

Interface for key matrix functions. More...

Data Structures
struct	keymatrix_callback_args_t
struct	keymatrix_cfg_t
struct	keymatrix_api_t
struct	keymatrix_instance_t

Macros
#define	KEYMATRIX_API_VERSION_MAJOR   (2U)
	KEY MATRIX API version number (Major)
#define	KEYMATRIX_API_VERSION_MINOR   (0U)
	KEY MATRIX API version number (Minor)

Typedefs
typedef uint32_t	keymatrix_channels_t
typedef void	keymatrix_ctrl_t

Enumerations
enum	keymatrix_trigger_t { KEYMATRIX_TRIG_FALLING = 0, KEYMATRIX_TRIG_RISING = 1 }

Detailed Description

Interface for key matrix functions.

Summary

The KEYMATRIX interface provides standard KeyMatrix functionality including event generation on a rising or falling edge for one or more channels at the same time. The generated event indicates all channels that are active in that instant via a bit mask. This allows the interface to be used with a matrix configuration or a one-to-one hardware implementation that is triggered on either a rising or a falling edge.

Related SSP architecture topics:

• SSP Interfaces
• SSP Predefined Layers
• Using SSP Modules

Key Matrix Interface description: Key Matrix Driver

Typedef Documentation

keymatrix_channels_t

typedef uint32_t keymatrix_channels_t

Channel definition. This is a bit mask with each bit from 0-7 representing channels 0-7 respectively.

keymatrix_ctrl_t

typedef void keymatrix_ctrl_t

Key matrix control block. Allocate an instance specific control block to pass into the key matrix API calls.

Implemented as

• kint_instance_ctrl_t

Enumeration Type Documentation

keymatrix_trigger_t

enum keymatrix_trigger_t

Trigger type: rising edge, falling edge

Enumerator
KEYMATRIX_TRIG_FALLING	Falling edge trigger.
KEYMATRIX_TRIG_RISING	Rising edge trigger.