blob: 5ae1a880751b0a1a0dacc5d8e0f2de6cd1ff43f1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
.. default-domain:: cpp
.. highlight:: sh
-----------
pw_checksum
-----------
The pw_checksum module provides functions for calculating checksums.
pw_checksum/ccitt_crc16.h
=========================
.. cpp:namespace:: pw::checksum
.. cpp:var:: constexpr uint16_t kCcittCrc16DefaultInitialValue = 0xFFFF
The default initial value for the CRC16.
.. cpp:function:: uint16_t CcittCrc16(span<const std::byte> data, uint16_t initial_value = kCcittCrc16DefaultInitialValue)
Calculates the CRC16 of the provided data using polynomial 0x1021, with a
default initial value of :cpp:expr:`0xFFFF`.
To incrementally calculate a CRC16, use the previous value as the initial
value.
.. code-block:: cpp
uint16_t crc = CcittCrc16(my_data);
crc = CcittCrc16(more_data, crc);
Compatibility
=============
* C
* C++17
Dependencies
============
* pw_span
|