From 8b7ac7f2ca97200de27b69ddd7c55ee8a09c0b78 Mon Sep 17 00:00:00 2001 From: Ryan Date: Tue, 25 Jul 2023 09:20:41 +1000 Subject: Raw HID: documentation improvements (#21596) --- quantum/raw_hid.h | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) (limited to 'quantum') 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 + +/** + * \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); + +/** \} */ -- cgit v1.2.3