hid_report_desc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef _HID_REPORT_DESC_H_
#define _HID_REPORT_DESC_H_
 
#include <stddef.h>
#include <zephyr/types.h>
#include <zephyr/toolchain.h>
#include <zephyr/sys/util.h>
 
#include "hid_report_mouse.h"
#include "hid_report_keyboard.h"
#include "hid_report_system_ctrl.h"
#include "hid_report_consumer_ctrl.h"
#include "hid_report_user_config.h"
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum report_id {
        REPORT_ID_RESERVED,
 
        REPORT_ID_MOUSE,
        REPORT_ID_KEYBOARD_KEYS,
        REPORT_ID_SYSTEM_CTRL,
        REPORT_ID_CONSUMER_CTRL,
 
        REPORT_ID_KEYBOARD_LEDS,
 
        REPORT_ID_USER_CONFIG,
        REPORT_ID_USER_CONFIG_OUT,
 
        REPORT_ID_VENDOR_IN,
        REPORT_ID_VENDOR_OUT,
 
        REPORT_ID_BOOT_MOUSE,
        REPORT_ID_BOOT_KEYBOARD,
 
        REPORT_ID_COUNT
};
 
static const uint8_t input_reports[] = {
        REPORT_ID_MOUSE,
        REPORT_ID_KEYBOARD_KEYS,
        REPORT_ID_SYSTEM_CTRL,
        REPORT_ID_CONSUMER_CTRL,
        REPORT_ID_BOOT_MOUSE,
        REPORT_ID_BOOT_KEYBOARD,
};
 
static const uint8_t output_reports[] = {
        REPORT_ID_KEYBOARD_LEDS,
};
 
/* Internal definitions used to calculate size of the biggest supported HID input report. */
#define _REPORT_BUFFER_SIZE_MOUSE \
        (IS_ENABLED(CONFIG_DESKTOP_HID_REPORT_MOUSE_SUPPORT) ? (REPORT_SIZE_MOUSE) : (0))
#define _REPORT_BUFFER_SIZE_KEYBOARD_KEYS \
        (IS_ENABLED(CONFIG_DESKTOP_HID_REPORT_KEYBOARD_SUPPORT) ? (REPORT_SIZE_KEYBOARD_KEYS) : (0))
#define _REPORT_BUFFER_SIZE_SYSTEM_CTRL                                                         \
        (IS_ENABLED(CONFIG_DESKTOP_HID_REPORT_SYSTEM_CTRL_SUPPORT) ?                            \
         (REPORT_SIZE_SYSTEM_CTRL) : (0))
#define _REPORT_BUFFER_SIZE_CONSUMER_CTRL                                                       \
        (IS_ENABLED(CONFIG_DESKTOP_HID_REPORT_CONSUMER_CTRL_SUPPORT) ?                          \
         (REPORT_SIZE_CONSUMER_CTRL) : (0))
#define _REPORT_BUFFER_SIZE_BOOT_MOUSE \
        (IS_ENABLED(CONFIG_DESKTOP_HID_BOOT_INTERFACE_MOUSE) ? (REPORT_SIZE_MOUSE_BOOT) : (0))
#define _REPORT_BUFFER_SIZE_BOOT_KEYBOARD \
        (IS_ENABLED(CONFIG_DESKTOP_HID_BOOT_INTERFACE_KEYBOARD) ? (REPORT_SIZE_KEYBOARD_BOOT) : (0))
#define _MAX6(a, b, c, d, e, f) MAX(MAX(a, b), MAX(MAX(c, d), MAX(e, f)))
 
/* Size of the biggest supported HID input report that is part of input reports map. */
#define REPORT_BUFFER_SIZE_INPUT_REPORT                                                         \
        _MAX6(_REPORT_BUFFER_SIZE_MOUSE, _REPORT_BUFFER_SIZE_KEYBOARD_KEYS,                     \
              _REPORT_BUFFER_SIZE_SYSTEM_CTRL, _REPORT_BUFFER_SIZE_CONSUMER_CTRL,               \
              _REPORT_BUFFER_SIZE_BOOT_MOUSE, _REPORT_BUFFER_SIZE_BOOT_KEYBOARD)
 
/* Internal definitions used to calculate size of the biggest supported HID output report. */
#define _REPORT_BUFFER_SIZE_KEYBOARD_LEDS \
        (IS_ENABLED(CONFIG_DESKTOP_HID_REPORT_KEYBOARD_SUPPORT) ? (REPORT_SIZE_KEYBOARD_LEDS) : (0))
 
/* Size of the biggest supported HID output report that is part of output reports map. */
#define REPORT_BUFFER_SIZE_OUTPUT_REPORT        _REPORT_BUFFER_SIZE_KEYBOARD_LEDS
 
extern const uint8_t hid_report_desc[];
extern const size_t hid_report_desc_size;
 
#ifdef __cplusplus
}
#endif
 
#endif /* _HID_REPORT_DESC_H_ */