HIDDKeyboard.h File Reference

#include "USBDescriptors.h"
#include "USBRequests.h"
#include "HIDDescriptors.h"
#include "USBDDriver.h"

Go to the source code of this file.

Data Structures
struct	_HIDDKeyboardOutputReport
struct	_HIDDKeyboardInputReport
struct	_HIDDKeyboardDriverConfigurationDescriptors
Defines
#define	HIDDKeyboardInputReport_MAXKEYPRESSES   3
#define	HIDDKeyboardDescriptors_FIRSTMODIFIERKEY   HIDKeypad_LEFTCONTROL
#define	HIDDKeyboardDescriptors_LASTMODIFIERKEY   HIDKeypad_RIGHTGUI
#define	HIDDKeyboardDescriptors_FIRSTSTANDARDKEY   0
#define	HIDDKeyboardDescriptors_LASTSTANDARDKEY   HIDKeypad_NUMLOCK
#define	HIDDKeyboardDescriptors_INTERRUPTIN_POLLING_FS   16
#define	HIDDKeyboardDescriptors_INTERRUPTIN_POLLING_HS   8
#define	HIDDKeyboardDescriptors_INTERRUPTOUT_POLLING_FS   16
#define	HIDDKeyboardDescriptors_INTERRUPTOUT_POLLING_HS   8
#define	HIDDKeyboard_REPORTDESCRIPTORSIZE   61
Functions
struct _HIDDKeyboardOutputReport	__attribute__ ((__packed__)) HIDDKeyboardOutputReport
void	HIDDKeyboard_Initialize (USBDDriver *pUsbd, uint8_t bInterfaceNb)
void	HIDDKeyboard_ConfigureFunction (USBGenericDescriptor *pDescriptors, uint16_t wLength)
uint32_t	HIDDKeyboard_RequestHandler (const USBGenericRequest *request)
uint32_t	HIDDKeyboard_ChangeKeys (uint8_t *pressedKeys, uint8_t pressedKeysSize, uint8_t *releasedKeys, uint8_t releasedKeysSize)
void	HIDDKeyboard_RemoteWakeUp (void)
WEAK void	HIDDKeyboardCallbacks_LedsChanged (uint8_t numLockStatus, uint8_t capsLockStatus, uint8_t scrollLockStatus)
void	HIDDKeyboardInputReport_Initialize (HIDDKeyboardInputReport *report)
void	HIDDKeyboardInputReport_PressStandardKey (HIDDKeyboardInputReport *report, uint8_t key)
void	HIDDKeyboardInputReport_ReleaseStandardKey (HIDDKeyboardInputReport *report, uint8_t key)
void	HIDDKeyboardInputReport_PressModifierKey (HIDDKeyboardInputReport *report, uint8_t key)
void	HIDDKeyboardInputReport_ReleaseModifierKey (HIDDKeyboardInputReport *report, uint8_t key)
void	HIDDKeyboardOutputReport_Initialize (HIDDKeyboardOutputReport *report)
unsigned char	HIDDKeyboardOutputReport_GetNumLockStatus (const HIDDKeyboardOutputReport *report)
unsigned char	HIDDKeyboardOutputReport_GetCapsLockStatus (const HIDDKeyboardOutputReport *report)
unsigned char	HIDDKeyboardOutputReport_GetScrollLockStatus (const HIDDKeyboardOutputReport *report)
Variables
uint8_t	numLockStatus
uint8_t	capsLockStatus
uint8_t	scrollLockStatus
uint8_t	padding
uint8_t	bmModifierKeys
uint8_t	pressedKeys [HIDDKeyboardInputReport_MAXKEYPRESSES]
USBConfigurationDescriptor	configuration
USBInterfaceDescriptor	interface
HIDDescriptor1	hid
USBEndpointDescriptor	interruptIn
USBEndpointDescriptor	interruptOut

---

Detailed Description

Definition of methods for using a HID keyboard function.

Definition in file HIDDKeyboard.h.

---

Variable Documentation

uint8_t bmModifierKeys

State of modifier keys.

Definition at line 147 of file HIDDKeyboard.h.

uint8_t capsLockStatus

State of the num. lock LED.

Definition at line 130 of file HIDDKeyboard.h.

USBConfigurationDescriptor configuration

Configuration descriptor.

Definition at line 168 of file HIDDKeyboard.h.

HIDDescriptor1 hid

HID descriptor.

Definition at line 172 of file HIDDKeyboard.h.

USBInterfaceDescriptor interface

Interface descriptor.

Definition at line 170 of file HIDDKeyboard.h.

USBEndpointDescriptor interruptIn

Interrupt IN endpoint descriptor.

Definition at line 174 of file HIDDKeyboard.h.

USBEndpointDescriptor interruptOut

Interrupt OUT endpoint descriptor.

Definition at line 176 of file HIDDKeyboard.h.

uint8_t padding

State of the scroll lock LED.

Definition at line 130 of file HIDDKeyboard.h.

uint8_t pressedKeys[HIDDKeyboardInputReport_MAXKEYPRESSES]

Key codes of pressed keys.

Definition at line 149 of file HIDDKeyboard.h.

uint8_t scrollLockStatus

State of the caps lock LED.

Definition at line 130 of file HIDDKeyboard.h.