Board Support  Version 1.0
Functions available when using the Board Software Components
 All Data Structures Functions Variables Groups Pages
Buttons

Buttons Interface. More...

Functions

int32_t Buttons_Initialize (void)
 Initialize buttons. More...
 
int32_t Buttons_Uninitialize (void)
 De-initialize buttons. More...
 
uint32_t Buttons_GetState (void)
 Get buttons state. More...
 
uint32_t Buttons_GetCount (void)
 Get number of available buttons. More...
 

Description

Buttons Interface.

Button driver functions can be used to determine if push-buttons are pressed on an evaluation board.

Function Documentation

uint32_t Buttons_GetCount ( void  )

Get number of available buttons.

Returns
Number of available buttons

The function returns the number of available buttons.

uint32_t Buttons_GetState ( void  )

Get buttons state.

Returns
Buttons state

The function returns the bit-field which indicates which buttons are pressed.

int32_t Buttons_Initialize ( void  )

Initialize buttons.

Returns
  • 0: function succeeded
  • -1: function failed

The function initializes the buttons interface. The function returns an integer value of 0 on success, and -1 on error.

int32_t Buttons_Uninitialize ( void  )

De-initialize buttons.

Returns
  • 0: function succeeded
  • -1: function failed

The function de-initializes the buttons interface. The function returns an integer value of 0 on success, and -1 on error.