esp-idf/components/esp_hid/include/esp_private/esp_hidd_private.h
Tomas Rezucha 56a159a7d5 refactor(esp_hid): Move header files to esp_private directory
esp_hidd_private.h and esp_hidh_private.h are required by components
that extend esp_hid with a new transport layer, such as USB
2024-02-07 15:34:55 +08:00

63 lines
2.2 KiB
C

/*
* SPDX-FileCopyrightText: 2017-2024 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include "esp_err.h"
#include "esp_hidd.h"
#include "esp_hid_common.h"
#ifdef __cplusplus
extern "C" {
#endif
typedef union {
struct {
uint16_t notify_enable : 1;
uint16_t indicate_enable : 1;
uint16_t reserved : 14;
};
uint16_t value;
} hidd_le_ccc_value_t;
typedef struct {
uint8_t map_index; // the index of the report map
uint8_t report_id; // the id of the report
uint8_t report_type; // input, output or feature
uint8_t protocol_mode; // boot or report
esp_hid_usage_t usage; // generic, keyboard, mouse, joystick or gamepad
uint16_t value_len; // maximum len of value by report map
// used by gatts
uint8_t index; // index of the value in the gatts attr db
uint16_t handle; // obtained once all attributes are registered
uint16_t ccc_handle; // obtained once all attributes are registered
hidd_le_ccc_value_t ccc; // notifications and/or indications enabled
} hidd_report_item_t;
struct esp_hidd_dev_s {
void *dev;
esp_hid_transport_t transport;
bool (*connected) (void *dev);
esp_err_t (*deinit) (void *dev);
esp_err_t (*disconnect) (void *dev);
esp_err_t (*virtual_unplug) (void *dev);
esp_err_t (*battery_set) (void *dev, uint8_t level);
esp_err_t (*input_set) (void *dev, size_t map_index, size_t report_id, uint8_t *data, size_t length);
esp_err_t (*feature_set) (void *dev, size_t map_index, size_t report_id, uint8_t *data, size_t length);
esp_err_t (*event_handler_register) (void *dev, esp_event_handler_t callback, esp_hidd_event_t event);
esp_err_t (*event_handler_unregister) (void *dev, esp_event_handler_t callback, esp_hidd_event_t event);
};
typedef struct esp_hidd_dev_s esp_hidd_dev_t;
void esp_hidd_process_event_data_handler(void *event_handler_arg, esp_event_base_t event_base, int32_t event_id,
void *event_data);
#ifdef __cplusplus
}
#endif