hids.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Xiaomi Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_SERVICES_HIDS_H_
#define ZEPHYR_INCLUDE_BLUETOOTH_SERVICES_HIDS_H_
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <sys/types.h>
 
#include <zephyr/bluetooth/conn.h>
#include <zephyr/bluetooth/gatt.h>
#include <zephyr/sys/util.h>
 
#ifdef __cplusplus
extern "C" {
#endif


#define BT_HIDS_REPORT_MAP_MAX_LEN 512U

enum bt_hids_report_type {
        BT_HIDS_REPORT_TYPE_INPUT = 0x01U,

        BT_HIDS_REPORT_TYPE_OUTPUT = 0x02U,

        BT_HIDS_REPORT_TYPE_FEATURE = 0x03U,
};

enum bt_hids_info_flags {
        BT_HIDS_INFO_FLAG_REMOTE_WAKE = BIT(0),

        BT_HIDS_INFO_FLAG_NORMALLY_CONNECTABLE = BIT(1),
};

enum bt_hids_ctrl_point {
        BT_HIDS_CTRL_SUSPEND = 0x00U,

        BT_HIDS_CTRL_EXIT_SUSPEND = 0x01U,
};

struct bt_hids_cb {
        void (*set_report)(struct bt_conn *conn, enum bt_hids_report_type report_type,
                           uint8_t report_id, const uint8_t *data, uint16_t len);

        void (*ctrl_point)(struct bt_conn *conn, enum bt_hids_ctrl_point cmd);
};

struct bt_hids_register_param {
        uint16_t bcd_hid;

        uint8_t country_code;

        uint8_t flags;

        const uint8_t *report_map;

        uint16_t report_map_len;
 
#if CONFIG_BT_HIDS_INPUT_REPORT_COUNT > 0 || defined(__DOXYGEN__)
        uint8_t input_report_ids[CONFIG_BT_HIDS_INPUT_REPORT_COUNT];
#endif
 
#if CONFIG_BT_HIDS_OUTPUT_REPORT_COUNT > 0 || defined(__DOXYGEN__)
        uint8_t output_report_ids[CONFIG_BT_HIDS_OUTPUT_REPORT_COUNT];
#endif
 
#if CONFIG_BT_HIDS_FEATURE_REPORT_COUNT > 0 || defined(__DOXYGEN__)
        uint8_t feature_report_ids[CONFIG_BT_HIDS_FEATURE_REPORT_COUNT];
#endif

        const struct bt_hids_cb *cb;
};

int bt_hids_register(const struct bt_hids_register_param *param);

int bt_hids_unregister(void);

int bt_hids_report_set(enum bt_hids_report_type report_type, uint8_t report_id,
                       const uint8_t *data, uint16_t len);

int bt_hids_report_get(enum bt_hids_report_type report_type, uint8_t report_id, uint8_t *data,
                       uint16_t *len);

int bt_hids_send_report(struct bt_conn *conn, uint8_t report_id, const uint8_t *data, uint16_t len,
                        bt_gatt_complete_func_t func, void *user_data);

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_SERVICES_HIDS_H_ */