d7d9eed317
* Add HID report/descriptor for a new report with mouse buttons, and x/y/wheel deltas. * New mouse key press behavior for press/release of mouse keys. * Add constants for HID main item values (e.g. data/array/absolute) * Define and use constants for our HID report IDs.
75 lines
2.1 KiB
C
75 lines
2.1 KiB
C
/*
|
|
* Copyright (c) 2020 The ZMK Contributors
|
|
*
|
|
* SPDX-License-Identifier: MIT
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <zmk/ble.h>
|
|
#include <zmk/endpoints_types.h>
|
|
|
|
/**
|
|
* Recommended length of string buffer for printing endpoint identifiers.
|
|
*/
|
|
#define ZMK_ENDPOINT_STR_LEN 10
|
|
|
|
#ifdef CONFIG_ZMK_USB
|
|
#define ZMK_ENDPOINT_USB_COUNT 1
|
|
#else
|
|
#define ZMK_ENDPOINT_USB_COUNT 0
|
|
#endif
|
|
|
|
#ifdef CONFIG_ZMK_BLE
|
|
#define ZMK_ENDPOINT_BLE_COUNT ZMK_BLE_PROFILE_COUNT
|
|
#else
|
|
#define ZMK_ENDPOINT_BLE_COUNT 0
|
|
#endif
|
|
|
|
/**
|
|
* The total number of different (struct zmk_endpoint_instance) values that can
|
|
* be selected.
|
|
*
|
|
* Note that this value may change between firmware versions, so it should not
|
|
* be used in any persistent storage.
|
|
*/
|
|
#define ZMK_ENDPOINT_COUNT (ZMK_ENDPOINT_USB_COUNT + ZMK_ENDPOINT_BLE_COUNT)
|
|
|
|
bool zmk_endpoint_instance_eq(struct zmk_endpoint_instance a, struct zmk_endpoint_instance b);
|
|
|
|
/**
|
|
* Writes a string identifying an endpoint instance.
|
|
*
|
|
* @param str Address of output string buffer
|
|
* @param len Length of string buffer. See ZMK_ENDPOINT_STR_LEN for recommended length.
|
|
*
|
|
* @returns Number of characters written.
|
|
*/
|
|
int zmk_endpoint_instance_to_str(struct zmk_endpoint_instance endpoint, char *str, size_t len);
|
|
|
|
/**
|
|
* Gets a unique index for an endpoint instance. This can be used together with
|
|
* ZMK_ENDPOINT_COUNT to manage separate state for each endpoint instance.
|
|
*
|
|
* Note that the index for a specific instance may change between firmware versions,
|
|
* so it should not be used in any persistent storage.
|
|
*/
|
|
int zmk_endpoint_instance_to_index(struct zmk_endpoint_instance endpoint);
|
|
|
|
/**
|
|
* Sets the preferred endpoint transport to use. (If the preferred endpoint is
|
|
* not available, a different one may automatically be selected.)
|
|
*/
|
|
int zmk_endpoints_select_transport(enum zmk_transport transport);
|
|
int zmk_endpoints_toggle_transport(void);
|
|
|
|
/**
|
|
* Gets the currently-selected endpoint.
|
|
*/
|
|
struct zmk_endpoint_instance zmk_endpoints_selected(void);
|
|
|
|
int zmk_endpoints_send_report(uint16_t usage_page);
|
|
|
|
#if IS_ENABLED(CONFIG_ZMK_MOUSE)
|
|
int zmk_endpoints_send_mouse_report();
|
|
#endif // IS_ENABLE(CONFIG_ZMK_MOUSE)
|