kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-23 21:43:51 +01:00
Code Releases Activity

Merge pull request #18707 from benpicco/crc16_fast-doc

Browse Source 
sys/checksum: update CRC-16 documentation
This commit is contained in:
Marian Buschsieweke 2022-10-07 16:58:35 +02:00 committed by GitHub
commit 5e08923a10
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
sys/include/checksum/crc16_ccitt.h
View File

@ -13,12 +13,14 @@
* @brief Variations of CRC16-CCITT checksum algorithms
* @details This provides implementations for multiple variations
* of CRC16 checks.
* There is a more generalized version in @ref sys_checksum_ucrc16,
* that does not utilize a look-up table as these implementation
* do (and is thus also far more memory efficient). Its caveat
* however is that it is slower by about factor 8 than these versions.
*
* @note enable the `crc32_fast` module for a look-up table based
* There is a more generalized version in @ref sys_checksum_ucrc16,
* that does not optionally utilize a look-up table as these implementations
* can do (and is thus also far more memory efficient). Its caveat
* however is that it is slower by about factor 8 than these versions when
* enabling the look-up table.
*
* @note enable the `crc16_fast` module for a look-up table based
* implementation that trades code size for speed.
*
* @{