drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

Raw HID: documentation improvements (#21596)

Browse source
This commit is contained in:
Ryan 2023-07-25 09:20:41 +10:00 • committed by GitHub
parent 1ec73e9651
commit 8b7ac7f2ca
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 146 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

26
quantum/raw_hid.h
View file

@ -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);
/** \} */