mayhem-firmware/firmware/common/crc.hpp
2016-02-18 20:36:32 -08:00

139 lines
3.4 KiB
C++

/*
* Copyright (C) 2014 Jared Boone, ShareBrained Technology, Inc.
*
* This file is part of PortaPack.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street,
* Boston, MA 02110-1301, USA.
*/
#ifndef __CRC_H__
#define __CRC_H__
#include <cstddef>
#include <cstdint>
#include <array>
/* Inspired by
* http://www.barrgroup.com/Embedded-Systems/How-To/CRC-Calculation-C-Code
*
* ...then munged into a simplified implementation of boost::crc_basic and
* boost::crc_optimal.
* http://www.boost.org/doc/libs/release/libs/crc/
*
* Copyright 2001, 2004 Daryle Walker. Use, modification, and distribution are
* subject to the Boost Software License, Version 1.0. (See accompanying file
* LICENSE_1_0.txt or a copy at <http://www.boost.org/LICENSE_1_0.txt>.)
*
*/
template<typename T, bool RevIn = false, bool RevOut = false>
class CRC {
public:
constexpr CRC(
const T truncated_polynomial,
const T initial_remainder = 0,
const T final_xor_value = 0
) : truncated_polynomial { truncated_polynomial },
initial_remainder { initial_remainder },
final_xor_value { final_xor_value },
remainder { initial_remainder }
{
}
T get_initial_remainder() const {
return initial_remainder;
}
void reset(T new_initial_remainder) {
remainder = new_initial_remainder;
}
void reset() {
remainder = initial_remainder;
}
void process_bit(bool bit) {
remainder ^= (bit ? top_bit() : 0U);
const auto do_poly_div = static_cast<bool>(remainder & top_bit());
remainder <<= 1;
if( do_poly_div ) {
remainder ^= truncated_polynomial;
}
}
void process_bits(uint8_t bits, size_t bit_count) {
bits <<= (8 - bit_count);
for(size_t i=bit_count; i>0; --i, bits <<= 1) {
process_bit(static_cast<bool>(bits & 0x80));
}
}
void process_bits_lsb_first(uint8_t bits, size_t bit_count) {
for(size_t i=bit_count; i>0; --i, bits >>= 1) {
process_bit(static_cast<bool>(bits & 0x01));
}
}
void process_byte(const uint8_t byte) {
if( RevIn ) {
process_bits_lsb_first(byte, 8);
} else {
process_bits(byte, 8);
}
}
void process_bytes(const uint8_t* const data, const size_t length) {
for(size_t i=0; i<length; i++) {
process_byte(data[i]);
}
}
template<size_t N>
void process_bytes(const std::array<uint8_t, N>& data) {
process_bytes(data.data(), data.size());
}
T checksum() const {
return (RevOut ? reflect(remainder) : remainder) ^ final_xor_value;
}
private:
const T truncated_polynomial;
const T initial_remainder;
const T final_xor_value;
T remainder;
static constexpr size_t width() {
return 8 * sizeof(T);
}
static constexpr T top_bit() {
return 1U << (width() - 1);
}
static T reflect(T x) {
T reflection = 0;
for(size_t i=0; i<width(); ++i) {
reflection <<= 1;
reflection |= (x & 1);
x >>= 1;
}
return reflection;
}
};
#endif/*__CRC_H__*/