Loading...
Searching...
No Matches
checksum.h
Go to the documentation of this file.
/******************************************************************************
The MIT License(MIT)
Embedded Template Library.
https://github.com/ETLCPP/etl
https://www.etlcpp.com
Copyright(c) 2014 John Wellbelove
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files(the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions :
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
******************************************************************************/
#ifndef ETL_CHECKSUM_INCLUDED
#define ETL_CHECKSUM_INCLUDED
#include "platform.h"
#include "binary.h"
#include "frame_check_sequence.h"
#include <stdint.h>
namespace etl
{
//***************************************************************************
//***************************************************************************
template <typename T>
struct checksum_policy_sum
{
typedef T value_type;
T initial() const
{
return 0;
}
T add(T sum, uint8_t value) const
{
return sum + value;
}
T final(T sum) const
{
return sum;
}
};
//***************************************************************************
//***************************************************************************
template <typename T>
struct checksum_policy_bsd
{
typedef T value_type;
T initial() const
{
return 0;
}
T add(T sum, uint8_t value) const
{
return etl::rotate_right(sum) + value;
}
T final(T sum) const
{
return sum;
}
};
//***************************************************************************
//***************************************************************************
template <typename T>
struct checksum_policy_xor
{
typedef T value_type;
T initial() const
{
return 0;
}
T add(T sum, uint8_t value) const
{
return sum ^ value;
}
T final(T sum) const
{
return sum;
}
};
//***************************************************************************
//***************************************************************************
template <typename T>
struct checksum_policy_xor_rotate
{
typedef T value_type;
T initial() const
{
return 0;
}
T add(T sum, uint8_t value) const
{
return etl::rotate_left(sum) ^ value;
}
T final(T sum) const
{
return sum;
}
};
//***************************************************************************
//***************************************************************************
template <typename T>
struct checksum_policy_parity
{
typedef T value_type;
T initial() const
{
return 0;
}
T add(T sum, uint8_t value) const
{
return sum ^ etl::parity(value);
}
T final(T sum) const
{
return sum;
}
};
//*************************************************************************
//*************************************************************************
template <typename T>
class checksum : public etl::frame_check_sequence<etl::checksum_policy_sum<T> >
{
public:
//*************************************************************************
//*************************************************************************
checksum()
{
this->reset();
}
//*************************************************************************
//*************************************************************************
template <typename TIterator>
checksum(TIterator begin, const TIterator end)
{
this->reset();
this->add(begin, end);
}
};
//*************************************************************************
//*************************************************************************
template <typename T>
class bsd_checksum : public etl::frame_check_sequence<etl::checksum_policy_bsd<T> >
{
public:
//*************************************************************************
//*************************************************************************
bsd_checksum()
{
this->reset();
}
//*************************************************************************
//*************************************************************************
template <typename TIterator>
bsd_checksum(TIterator begin, const TIterator end)
{
this->reset();
this->add(begin, end);
}
};
//*************************************************************************
//*************************************************************************
template <typename T>
class xor_checksum : public etl::frame_check_sequence<etl::checksum_policy_xor<T> >
{
public:
//*************************************************************************
//*************************************************************************
xor_checksum()
{
this->reset();
}
//*************************************************************************
//*************************************************************************
template <typename TIterator>
xor_checksum(TIterator begin, const TIterator end)
{
this->reset();
this->add(begin, end);
}
};
//*************************************************************************
//*************************************************************************
template <typename T>
class xor_rotate_checksum : public etl::frame_check_sequence<etl::checksum_policy_xor_rotate<T> >
{
public:
//*************************************************************************
//*************************************************************************
xor_rotate_checksum()
{
this->reset();
}
//*************************************************************************
//*************************************************************************
template <typename TIterator>
xor_rotate_checksum(TIterator begin, const TIterator end)
{
this->reset();
this->add(begin, end);
}
};
//*************************************************************************
//*************************************************************************
template <typename T>
class parity_checksum : public etl::frame_check_sequence<etl::checksum_policy_parity<T> >
{
public:
//*************************************************************************
//*************************************************************************
parity_checksum()
{
this->reset();
}
//*************************************************************************
//*************************************************************************
template <typename TIterator>
parity_checksum(TIterator begin, const TIterator end)
{
this->reset();
this->add(begin, end);
}
};
} // namespace etl
#endif
binary.h
etl::bsd_checksum::bsd_checksum
bsd_checksum()
Default constructor.
Definition checksum.h:201
etl::bsd_checksum::bsd_checksum
bsd_checksum(TIterator begin, const TIterator end)
Definition checksum.h:212
etl::checksum::checksum
checksum()
Default constructor.
Definition checksum.h:172
etl::checksum::checksum
checksum(TIterator begin, const TIterator end)
Definition checksum.h:183
etl::parity_checksum::parity_checksum
parity_checksum()
Default constructor.
Definition checksum.h:288
etl::parity_checksum::parity_checksum
parity_checksum(TIterator begin, const TIterator end)
Definition checksum.h:299
etl::xor_checksum::xor_checksum
xor_checksum(TIterator begin, const TIterator end)
Definition checksum.h:241
etl::xor_checksum::xor_checksum
xor_checksum()
Default constructor.
Definition checksum.h:230
etl::xor_rotate_checksum::xor_rotate_checksum
xor_rotate_checksum()
Default constructor.
Definition checksum.h:259
etl::xor_rotate_checksum::xor_rotate_checksum
xor_rotate_checksum(TIterator begin, const TIterator end)
Definition checksum.h:270
frame_check_sequence.h
etl::parity
ETL_CONSTEXPR14 etl::enable_if< etl::is_integral< T >::value &&etl::is_unsigned< T >::value &&(etl::integral_limits< T >::bits==16U), uint_least8_t >::type parity(T value)
Definition binary.h:1020
etl::rotate_left
ETL_CONSTEXPR14 T rotate_left(T value)
Definition binary.h:117
etl::rotate_right
ETL_CONSTEXPR14 T rotate_right(T value)
Definition binary.h:162
etl::frame_check_sequence< etl::checksum_policy_sum< T > >::add
ETL_CONSTEXPR14 void add(TIterator begin, const TIterator end)
Definition frame_check_sequence.h:145
etl::frame_check_sequence< etl::checksum_policy_sum< T > >::reset
ETL_CONSTEXPR14 void reset()
Definition frame_check_sequence.h:134
etl::frame_check_sequence
Definition frame_check_sequence.h:98
etl
Definition absolute.h:40
etl::end
TContainer::iterator end(TContainer &container)
Definition iterator.h:1166
etl::begin
TContainer::iterator begin(TContainer &container)
Definition iterator.h:1136
platform.h
etl::checksum_policy_bsd
BSD checksum policy.
Definition checksum.h:70
etl::checksum_policy_parity
Parity checksum policy.
Definition checksum.h:142
etl::checksum_policy_sum
Standard addition checksum policy.
Definition checksum.h:46
etl::checksum_policy_xor_rotate
XOR-rotate checksum policy.
Definition checksum.h:118
etl::checksum_policy_xor
Standard XOR checksum policy.
Definition checksum.h:94