1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00

sys/checksum: update CRC-16 documentation

This commit is contained in:
Benjamin Valentin 2022-10-07 12:32:29 +02:00
parent 24f7d2011a
commit f78fa2c632

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.
*
* @{