Version 2.0.0-0

keyboard Reference

File
core/xeos/include/xeos/hal/keyboard.h
Date
Wednesday, June 25, 2014
Includes
  • <stdint.h>

Tasks

XEOS_HAL_Keyboard_DisableScan Top

XEOS_HAL_Keyboard_Response XEOS_HAL_Keyboard_DisableScan( void );

XEOS_HAL_Keyboard_Echo Top

XEOS_HAL_Keyboard_Response XEOS_HAL_Keyboard_Echo( void );

XEOS_HAL_Keyboard_EnableScan Top

XEOS_HAL_Keyboard_Response XEOS_HAL_Keyboard_EnableScan( void );

XEOS_HAL_Keyboard_GetScanCodeSet Top

XEOS_HAL_Keyboard_ScanCodeSet XEOS_HAL_Keyboard_GetScanCodeSet( void );

XEOS_HAL_Keyboard_ReadData Top

uint8_t XEOS_HAL_Keyboard_ReadData( void );

XEOS_HAL_Keyboard_ResendLastByte Top

XEOS_HAL_Keyboard_Response XEOS_HAL_Keyboard_ResendLastByte( void );

XEOS_HAL_Keyboard_Reset Top

XEOS_HAL_Keyboard_Response XEOS_HAL_Keyboard_Reset( void );

XEOS_HAL_Keyboard_SendCommand Top

// IRQ1 needs to be disabled or masked XEOS_HAL_Keyboard_Response XEOS_HAL_Keyboard_SendCommand( XEOS_HAL_Keyboard_Command command );

XEOS_HAL_Keyboard_SendCommandWithData Top

XEOS_HAL_Keyboard_Response XEOS_HAL_Keyboard_SendCommandWithData( XEOS_HAL_Keyboard_Command command, uint8_t data );

XEOS_HAL_Keyboard_SetDefaultParameters Top

XEOS_HAL_Keyboard_Response XEOS_HAL_Keyboard_SetDefaultParameters( void );

XEOS_HAL_Keyboard_SetLED Top

XEOS_HAL_Keyboard_Response XEOS_HAL_Keyboard_SetLED( XEOS_HAL_Keyboard_LEDState state );

XEOS_HAL_Keyboard_SetRateAndDelay Top

XEOS_HAL_Keyboard_Response XEOS_HAL_Keyboard_SetRateAndDelay( uint8_t value );

XEOS_HAL_Keyboard_SetScanCodeSet Top

XEOS_HAL_Keyboard_Response XEOS_HAL_Keyboard_SetScanCodeSet( XEOS_HAL_Keyboard_ScanCodeSet set );

Types

XEOS_HAL_Keyboard_Command Top

typedef enum { XEOS_HAL_Keyboard_CommandSetLED = 0xED, XEOS_HAL_Keyboard_CommandEcho = 0xEE, XEOS_HAL_Keyboard_CommandScanCode = 0xF0, XEOS_HAL_Keyboard_CommandSetRateAndDelay = 0xF3, XEOS_HAL_Keyboard_CommandEnableScan = 0xF4, XEOS_HAL_Keyboard_CommandDisableScan = 0xF5, XEOS_HAL_Keyboard_CommandSetDefaultParameters = 0xF6, XEOS_HAL_Keyboard_CommandResendLastByte = 0xFE, XEOS_HAL_Keyboard_CommandReset = 0xFF } XEOS_HAL_Keyboard_Command;

XEOS_HAL_Keyboard_LEDState Top

typedef enum { XEOS_HAL_Keyboard_LEDStateScrollLock = 0x01, XEOS_HAL_Keyboard_LEDStateNumLock = 0x02, XEOS_HAL_Keyboard_LEDStateCapsLock = 0x04 } XEOS_HAL_Keyboard_LEDState;

XEOS_HAL_Keyboard_Response Top

typedef enum { XEOS_HAL_Keyboard_ResponseACK = 0xFA, XEOS_HAL_Keyboard_ResponseResend = 0xFE, XEOS_HAL_Keyboard_ResponseEcho = 0xEE, XEOS_HAL_Keyboard_ResponseSelfTestPassed = 0xAA, XEOS_HAL_Keyboard_ResponseSelfTestFailed = 0xFD } XEOS_HAL_Keyboard_Response;

XEOS_HAL_Keyboard_ScanCodeSet Top

typedef enum { XEOS_HAL_Keyboard_ScanCodeSetUnknown = 0x00, XEOS_HAL_Keyboard_ScanCodeSet1 = 0x01, XEOS_HAL_Keyboard_ScanCodeSet2 = 0x02, XEOS_HAL_Keyboard_ScanCodeSet3 = 0x03 } XEOS_HAL_Keyboard_ScanCodeSet;

Macros

__XEOS_HAL_KEYBOARD_H__ Top

#define __XEOS_HAL_KEYBOARD_H__