Bluetooth HID

Bluetooth HID. More...

HID protocol mode values
Defined in HID spec v1.1.2 Section 2.1.2, which makes Report Protocol Mode the default. The same values are carried by GET_PROTOCOL and SET_PROTOCOL in both directions, so they are shared by the Device and the Host role.
#define	BT_HID_PROTOCOL_BOOT_MODE   0x00U
	Boot Protocol Mode (legacy).
#define	BT_HID_PROTOCOL_REPORT_MODE   0x01U
	Report Protocol Mode (default).

HID report type values
The report type carried by GET_REPORT, SET_REPORT and DATA transfers. Defined in HID spec v1.1.2 Table 3.4.
#define	BT_HID_REPORT_TYPE_OTHER   0x00U
	Reserved report type, used where no type applies.
#define	BT_HID_REPORT_TYPE_INPUT   0x01U
	Input report (device to host).
#define	BT_HID_REPORT_TYPE_OUTPUT   0x02U
	Output report (host to device).
#define	BT_HID_REPORT_TYPE_FEATURE   0x03U
	Feature report.

HID HANDSHAKE result codes
Result of a request sent on the control channel. Defined in HID spec v1.1.2 Section 3.1.2.1. A Host reports them to the application, a Device answers with them, so they are shared by both roles.
#define	BT_HID_HS_RSP_SUCCESS   0x00U
	The request completed successfully.
#define	BT_HID_HS_RSP_NOT_READY   0x01U
	The peer is too busy to accept the request; the sender may retry.
#define	BT_HID_HS_RSP_ERR_INVALID_REPORT_ID   0x02U
	The request referenced an unsupported Report ID.
#define	BT_HID_HS_RSP_ERR_UNSUPPORTED_REQ   0x03U
	The peer does not support the request.
#define	BT_HID_HS_RSP_ERR_INVALID_PARAM   0x04U
	The request carried an invalid parameter.
#define	BT_HID_HS_RSP_ERR_UNKNOWN   0x0eU
	The peer could not identify the error condition.
#define	BT_HID_HS_RSP_ERR_FATAL   0x0fU
	The peer encountered a fatal error and needs to be restarted.

Detailed Description

Bluetooth HID.

Macro Definition Documentation

BT_HID_HS_RSP_ERR_FATAL

#define BT_HID_HS_RSP_ERR_FATAL   0x0fU

#include <hid.h>

The peer encountered a fatal error and needs to be restarted.

BT_HID_HS_RSP_ERR_INVALID_PARAM

#define BT_HID_HS_RSP_ERR_INVALID_PARAM   0x04U

#include <hid.h>

The request carried an invalid parameter.

BT_HID_HS_RSP_ERR_INVALID_REPORT_ID

#define BT_HID_HS_RSP_ERR_INVALID_REPORT_ID   0x02U

#include <hid.h>

The request referenced an unsupported Report ID.

BT_HID_HS_RSP_ERR_UNKNOWN

#define BT_HID_HS_RSP_ERR_UNKNOWN   0x0eU

#include <hid.h>

The peer could not identify the error condition.

BT_HID_HS_RSP_ERR_UNSUPPORTED_REQ

#define BT_HID_HS_RSP_ERR_UNSUPPORTED_REQ   0x03U

#include <hid.h>

The peer does not support the request.

BT_HID_HS_RSP_NOT_READY

#define BT_HID_HS_RSP_NOT_READY   0x01U

#include <hid.h>

The peer is too busy to accept the request; the sender may retry.

BT_HID_HS_RSP_SUCCESS

#define BT_HID_HS_RSP_SUCCESS   0x00U

#include <hid.h>

The request completed successfully.

BT_HID_PROTOCOL_BOOT_MODE

#define BT_HID_PROTOCOL_BOOT_MODE   0x00U

#include <hid.h>

Boot Protocol Mode (legacy).

BT_HID_PROTOCOL_REPORT_MODE

#define BT_HID_PROTOCOL_REPORT_MODE   0x01U

#include <hid.h>

Report Protocol Mode (default).

BT_HID_REPORT_TYPE_FEATURE

#define BT_HID_REPORT_TYPE_FEATURE   0x03U

#include <hid.h>

Feature report.

BT_HID_REPORT_TYPE_INPUT

#define BT_HID_REPORT_TYPE_INPUT   0x01U

#include <hid.h>

Input report (device to host).

BT_HID_REPORT_TYPE_OTHER

#define BT_HID_REPORT_TYPE_OTHER   0x00U

#include <hid.h>

Reserved report type, used where no type applies.

BT_HID_REPORT_TYPE_OUTPUT

#define BT_HID_REPORT_TYPE_OUTPUT   0x02U

#include <hid.h>

Output report (host to device).