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[] = {
#if CONFIG_DESKTOP_HID_REPORT_MOUSE_SUPPORT
        REPORT_ID_MOUSE,
#endif
#if CONFIG_DESKTOP_HID_REPORT_KEYBOARD_SUPPORT
        REPORT_ID_KEYBOARD_KEYS,
#endif
#if CONFIG_DESKTOP_HID_REPORT_SYSTEM_CTRL_SUPPORT
        REPORT_ID_SYSTEM_CTRL,
#endif
#if CONFIG_DESKTOP_HID_REPORT_CONSUMER_CTRL_SUPPORT
        REPORT_ID_CONSUMER_CTRL,
#endif
        /* Keep HID boot report IDs at the end as these don't have own data. */
#if CONFIG_DESKTOP_HID_BOOT_INTERFACE_MOUSE
        REPORT_ID_BOOT_MOUSE,
#endif
#if CONFIG_DESKTOP_HID_BOOT_INTERFACE_KEYBOARD
        REPORT_ID_BOOT_KEYBOARD,
#endif
};
 
static const uint8_t output_reports[] = {
#if CONFIG_DESKTOP_HID_REPORT_KEYBOARD_SUPPORT
        REPORT_ID_KEYBOARD_LEDS,
#endif
};
 
union _input_report_size_max {
#if CONFIG_DESKTOP_HID_REPORT_MOUSE_SUPPORT
        uint8_t _mouse_report[REPORT_SIZE_MOUSE];
#endif
#if CONFIG_DESKTOP_HID_REPORT_KEYBOARD_SUPPORT
        uint8_t _keyboard_report[REPORT_SIZE_KEYBOARD_KEYS];
#endif
#if CONFIG_DESKTOP_HID_REPORT_SYSTEM_CTRL_SUPPORT
        uint8_t _sysctrl_report[REPORT_SIZE_SYSTEM_CTRL];
#endif
#if CONFIG_DESKTOP_HID_REPORT_CONSUMER_CTRL_SUPPORT
        uint8_t _consumerctrl_report[REPORT_SIZE_CONSUMER_CTRL];
#endif
#if CONFIG_DESKTOP_HID_BOOT_INTERFACE_MOUSE
        uint8_t _boot_mouse_report[REPORT_SIZE_MOUSE_BOOT];
#endif
#if CONFIG_DESKTOP_HID_BOOT_INTERFACE_KEYBOARD
        uint8_t _boot_keyboard_report[REPORT_SIZE_KEYBOARD_BOOT];
#endif
};
 
union _output_report_size_max {
#if CONFIG_DESKTOP_HID_REPORT_KEYBOARD_SUPPORT
        uint8_t _keyboard_report[REPORT_SIZE_KEYBOARD_LEDS];
#endif
};
 
/* Size of the biggest supported HID input report that is part of input reports map. */
#define REPORT_BUFFER_SIZE_INPUT_REPORT sizeof(union _input_report_size_max)
 
/* Size of the biggest supported HID output report that is part of output reports map. */
#define REPORT_BUFFER_SIZE_OUTPUT_REPORT sizeof(union _output_report_size_max)
 
extern const uint8_t hid_report_desc[];
extern const size_t hid_report_desc_size;
 
#ifdef __cplusplus
}
#endif
 
#endif /* _HID_REPORT_DESC_H_ */