summaryrefslogtreecommitdiff
path: root/quantum/raw_hid.h
diff options
context:
space:
mode:
Diffstat (limited to 'quantum/raw_hid.h')
-rw-r--r--quantum/raw_hid.h26
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);
+
+/** \} */