aboutsummaryrefslogtreecommitdiff
path: root/quantum/crc.h
diff options
context:
space:
mode:
Diffstat (limited to 'quantum/crc.h')
-rw-r--r--quantum/crc.h44
1 files changed, 44 insertions, 0 deletions
diff --git a/quantum/crc.h b/quantum/crc.h
new file mode 100644
index 000000000..c17f5888e
--- /dev/null
+++ b/quantum/crc.h
@@ -0,0 +1,44 @@
1/* Copyright 2021 QMK
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16
17#pragma once
18
19#include "quantum.h"
20
21/**
22 * The type of the CRC values.
23 *
24 * This type must be big enough to contain at least 8 bits.
25 */
26#if defined(CRC8_OPTIMIZE_SPEED)
27typedef uint_fast8_t crc_t;
28#else
29typedef uint_least8_t crc_t;
30#endif
31
32/**
33 * Initialize crc subsystem.
34 */
35__attribute__((weak)) void crc_init(void);
36
37/**
38 * Generate CRC8 value from given data.
39 *
40 * \param[in] data Pointer to a buffer of \a data_len bytes.
41 * \param[in] data_len Number of bytes in the \a data buffer.
42 * \return The calculated crc value.
43 */
44__attribute__((weak)) uint8_t crc8(const void *data, size_t data_len); \ No newline at end of file