USB HID keyboard internals

nRF5 SDK v12.2.0
Data Structures | Macros | Functions | Variables

nRF52840 only: Module with types, definitions, and API used by the HID keyboard class. More...

Data Structures

struct app_usbd_hid_kbd_inst_t
HID keyboard part of class instance data. More...
struct app_usbd_hid_kbd_ctx_t
HID keyboard context. More...

Macros

#define APP_USBD_HID_KBD_CONFIG (iface, ep)   ((iface, ep))
HID keyboard configuration macro. More...
#define APP_USBD_HID_KBD_INSTANCE_SPECIFIC_DEC app_usbd_hid_kbd_inst_t inst;
Specific class constant data for HID keyboard class.
#define APP_USBD_HID_KBD_DATA_SPECIFIC_DEC app_usbd_hid_kbd_ctx_t ctx;
Specific class data for HID keyboard class.
#define APP_USBD_HID_KBD_DSC_CONFIG (interface_number, endpoint, rep_descriptor)
HID keyboard descriptors config macro. More...
#define APP_USBD_HID_KBD_INST_CONFIG (descriptors,report_desc,report_buff_in,report_buff_out,user_ev_handler)
Configure internal part of HID keyboard instance. More...
#define APP_USBD_HID_KBD_GLOBAL_DEF_INTERNAL (instance_name,interface_number,endpoint,user_ev_handler)
Global definition of app_usbd_hid_kbd_t class. More...

Functions

APP_USBD_CLASS_FORWARD (app_usbd_hid_kbd)
Forward declaration of HID keyboard class type.

Variables

const app_usbd_hid_methods_t app_usbd_hid_kbd_methods
Public HID keyboard interface.
const app_usbd_class_methods_t app_usbd_hid_kbd_class_methods
Public HID keyboard class interface.

Detailed Description

nRF52840 only: Module with types, definitions, and API used by the HID keyboard class.

Macro Definition Documentation

#define APP_USBD_HID_KBD_CONFIG ( iface,
ep
) ((iface, ep))

HID keyboard configuration macro.

Used by APP_USBD_HID_KBD_GLOBAL_DEF

#define APP_USBD_HID_KBD_DSC_CONFIG ( interface_number,
endpoint,
rep_descriptor
)
Value:
{ \
APP_USBD_HID_KBD_INTERFACE_DSC(interface_number) \
APP_USBD_HID_KBD_HID_DSC(rep_descriptor) \
APP_USBD_HID_KBD_EP_DSC(endpoint) \
}

HID keyboard descriptors config macro.

app_usbd_hid_kbd_inst_t

Parameters
interface_number Interface number
endpoint Endpoint number
rep_descriptor Keyboard report descriptor
#define APP_USBD_HID_KBD_GLOBAL_DEF_INTERNAL ( instance_name,
interface_number,
endpoint,
user_ev_handler
)
Value:
static const uint8_t CONCAT_2 (instance_name, _rep_dsc)[] = \
APP_USBD_HID_KBD_REPORT_DSC(); \
static const uint8_t CONCAT_2 (instance_name, _dsc)[] = \
APP_USBD_HID_KBD_DSC_CONFIG(interface_number, \
endpoint, \
CONCAT_2 (instance_name, _rep_dsc)); \
APP_USBD_HID_GENERIC_GLOBAL_OUT_REP_DEF( CONCAT_2 (instance_name, _out), 1 + 1); \
static app_usbd_hid_report_buffer_t CONCAT_2 (instance_name, _in)[1]; \
APP_USBD_CLASS_INST_GLOBAL_DEF( \
instance_name, \
app_usbd_hid_kbd, \
& app_usbd_hid_kbd_class_methods , \
APP_USBD_HID_KBD_CONFIG (interface_number, endpoint), \
( APP_USBD_HID_KBD_INST_CONFIG ( CONCAT_2 (instance_name, _dsc), \
CONCAT_2 (instance_name, _rep_dsc), \
CONCAT_2 (instance_name, _in), \
& CONCAT_2 (instance_name, _out), \
user_ev_handler)) \
)

Global definition of app_usbd_hid_kbd_t class.

APP_USBD_HID_KBD_GLOBAL_DEF

#define APP_USBD_HID_KBD_INST_CONFIG ( descriptors,
report_desc,
report_buff_in,
report_buff_out,
user_ev_handler
)
Value:
.inst = { \
.hid_inst = APP_USBD_HID_INST_CONFIG (descriptors, \
report_desc, \
report_buff_in, \
report_buff_out, \
user_ev_handler, \
& app_usbd_hid_kbd_methods ), \
}

Configure internal part of HID keyboard instance.

Parameters
descriptors Raw descriptors buffer
report_desc Report descriptor
report_buff_in Input report buffers array
report_buff_out Output report buffer
user_ev_handler User event handler