crc.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_CORE
#include <cstddef>
#include <cstdint>
#include <type_traits>
#include <promeki/namespace.h>
 
PROMEKI_NAMESPACE_BEGIN
 
template <typename T> class CRC {
        public:
                static_assert(std::is_same_v<T, uint8_t> || std::is_same_v<T, uint16_t> ||
                                      std::is_same_v<T, uint32_t> || std::is_same_v<T, uint64_t>,
                              "CRC<T> requires T = uint8_t / uint16_t / uint32_t / uint64_t");
 
                using Value = T;
 
                static constexpr int Width = static_cast<int>(sizeof(T) * 8);
 
                struct Params {
                                T           poly;    
                                T           init;    
                                T           xorOut;  
                                bool        reflect; 
                                const char *name;    
                };
 
                explicit CRC(const Params &params);
 
                void reset();
 
                void update(const void *data, size_t len);
 
                T value() const;
 
                static T compute(const Params &params, const void *data, size_t len);
 
                const Params &params() const { return _params; }
 
        private:
                void buildTable();
 
                Params _params{};
                T      _table[256]{};
                T      _crc{};
};
 
extern template class CRC<uint8_t>;
extern template class CRC<uint16_t>;
extern template class CRC<uint32_t>;
extern template class CRC<uint64_t>;
 
using Crc8 = CRC<uint8_t>;
using Crc16 = CRC<uint16_t>;
using Crc32 = CRC<uint32_t>;
using Crc64 = CRC<uint64_t>;
 
namespace CrcParams {
 
        inline constexpr Crc8::Params Crc8Smbus{0x07, 0x00, 0x00, false, "CRC-8/SMBus"};
        inline constexpr Crc8::Params Crc8Autosar{0x2F, 0xFF, 0xFF, false, "CRC-8/AUTOSAR"};
        inline constexpr Crc8::Params Crc8Bluetooth{0xA7, 0x00, 0x00, true, "CRC-8/Bluetooth"};
 
        inline constexpr Crc16::Params Crc16CcittFalse{0x1021, 0xFFFF, 0x0000, false, "CRC-16/CCITT-FALSE"};
        inline constexpr Crc16::Params Crc16Kermit{0x1021, 0x0000, 0x0000, true, "CRC-16/Kermit"};
 
        inline constexpr Crc32::Params Crc32IsoHdlc{0x04C11DB7u, 0xFFFFFFFFu, 0xFFFFFFFFu, true, "CRC-32/ISO-HDLC"};
        inline constexpr Crc32::Params Crc32Bzip2{0x04C11DB7u, 0xFFFFFFFFu, 0xFFFFFFFFu, false, "CRC-32/BZIP2"};
 
} // namespace CrcParams
 
inline Crc8 crc8_smbus() {
        return Crc8(CrcParams::Crc8Smbus);
}
inline Crc8 crc8_autosar() {
        return Crc8(CrcParams::Crc8Autosar);
}
inline Crc16 crc16_ccitt_false() {
        return Crc16(CrcParams::Crc16CcittFalse);
}
inline Crc32 crc32_iso_hdlc() {
        return Crc32(CrcParams::Crc32IsoHdlc);
}
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_CORE