diff options
author | Ryan <[email protected]> | 2023-07-25 09:20:41 +1000 |
---|---|---|
committer | GitHub <[email protected]> | 2023-07-25 09:20:41 +1000 |
commit | 8b7ac7f2ca97200de27b69ddd7c55ee8a09c0b78 (patch) | |
tree | 98015af2ec06e8bdf247ff3f4820e7e6a55a043b /quantum | |
parent | 1ec73e9651bb3eca2aaed5172f8611964854db9b (diff) | |
download | qmk_firmware-8b7ac7f2ca97200de27b69ddd7c55ee8a09c0b78.tar.gz qmk_firmware-8b7ac7f2ca97200de27b69ddd7c55ee8a09c0b78.zip |
Raw HID: documentation improvements (#21596)
Diffstat (limited to 'quantum')
-rw-r--r-- | quantum/raw_hid.h | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/quantum/raw_hid.h b/quantum/raw_hid.h index 6d60ab2bff..16830833cc 100644 --- a/quantum/raw_hid.h +++ b/quantum/raw_hid.h @@ -1,5 +1,31 @@ +// Copyright 2023 QMK +// SPDX-License-Identifier: GPL-2.0-or-later + #pragma once +#include <stdint.h> + +/** + * \file + * + * \defgroup raw_hid Raw HID API + * \{ + */ + +/** + * \brief Callback, invoked when a raw HID report has been received from the host. + * + * \param data A pointer to the received data. Always 32 bytes in length. + * \param length The length of the buffer. Always 32. + */ void raw_hid_receive(uint8_t *data, uint8_t length); +/** + * \brief Send an HID report. + * + * \param data A pointer to the data to send. Must always be 32 bytes in length. + * \param length The length of the buffer. Must always be 32. + */ void raw_hid_send(uint8_t *data, uint8_t length); + +/** \} */ |