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

Joystick Interface: input device with 5 buttons. More...

Functions

int32_t Joystick_Initialize (void)
 Initialize joystick. More...
 
int32_t Joystick_Uninitialize (void)
 De-initialize joystick. More...
 
uint32_t Joystick_GetState (void)
 Get joystick state. More...
 

Description

Joystick Interface: input device with 5 buttons.

Joystick driver functions can be used to determine if joystick buttons are pressed on an evaluation board.

Function Documentation

uint32_t Joystick_GetState ( void  )

Get joystick state.

Returns
Joystick state

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

int32_t Joystick_Initialize ( void  )

Initialize joystick.

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

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

int32_t Joystick_Uninitialize ( void  )

De-initialize joystick.

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

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