coffee/etl
1
0
Fork 0
mirror of https://github.com/ETLCPP/etl.git synced 2026-10-28 18:07:10 +08:00
Code Issues Packages Projects Releases Wiki Activity

Added M17 CRC

Browse Source
This commit is contained in:
John Wellbelove 2023-02-12 11:44:59 +01:00
parent 8634480fa6
commit 26caa70981
6 changed files with 347 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
include/etl/crc.h
View File

@ -67,6 +67,7 @@ SOFTWARE.
#include "crc16_usb.h"
#include "crc16_x25.h"
#include "crc16_xmodem.h"
#include "crc16_m17.h"
#include "crc32.h"
#include "crc32_bzip2.h"

78
include/etl/crc16_m17.h Normal file
View File

@ -0,0 +1,78 @@
///\file
/******************************************************************************
The MIT License(MIT)
Embedded Template Library.
https://github.com/ETLCPP/etl
https://www.etlcpp.com
Copyright(c) 2023 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_CRC16_M17_INCLUDED
#define ETL_CRC16_M17_INCLUDED
#include "platform.h"
#include "private/crc_implementation.h"
///\defgroup crc16_m17 16 bit CRC calculation
///\ingroup crc
namespace etl
{
#if ETL_USING_CPP11 && !defined(ETL_CRC_FORCE_CPP03_IMPLEMENTATION)
template <size_t Table_Size>
using crc16_m17_t = etl::crc_type<etl::private_crc::crc16_m17_parameters, Table_Size>;
#else
template <size_t Table_Size>
class crc16_m17_t : public etl::crc_type<etl::private_crc::crc16_m17_parameters, Table_Size>
{
public:
//*************************************************************************
/// Default constructor.
//*************************************************************************
crc16_m17_t()
{
this->reset();
}
//*************************************************************************
/// Constructor from range.
/// \param begin Start of the range.
/// \param end End of the range.
//*************************************************************************
template<typename TIterator>
crc16_m17_t(TIterator begin, const TIterator end)
{
this->reset();
this->add(begin, end);
}
};
#endif
typedef etl::crc16_m17_t<256U> crc16_m17_t256;
typedef etl::crc16_m17_t<16U> crc16_m17_t16;
typedef etl::crc16_m17_t<4U> crc16_m17_t4;
typedef crc16_m17_t256 crc16_m17;
}
#endif

1
include/etl/private/crc_parameters.h
View File

@ -91,6 +91,7 @@ namespace etl
typedef crc_parameters<uint16_t, 0x1021U, 0x89ECU, 0x0000U, true> crc16_tms37157_parameters;
typedef crc_parameters<uint16_t, 0x1021U, 0xC6C6U, 0x0000U, true> crc16_a_parameters;
typedef crc_parameters<uint16_t, 0x8005U, 0x0000U, 0x0000U, true> crc16_arc_parameters;
typedef crc_parameters<uint16_t, 0x5935U, 0xFFFFU, 0x0000U, false> crc16_m17_parameters;
// 32 bit.
typedef crc_parameters<uint32_t, 0x04C11DB7UL, 0xFFFFFFFFUL, 0xFFFFFFFFUL, true> crc32_parameters;

263
test/test_crc16_m17.cpp Normal file
View File

@ -0,0 +1,263 @@
/******************************************************************************
The MIT License(MIT)
Embedded Template Library.
https://github.com/ETLCPP/etl
https://www.etlcpp.com
Copyright(c) 2023 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.
******************************************************************************/
#include "unit_test_framework.h"
#include <iterator>
#include <string>
#include <vector>
#include <stdint.h>
#include "etl/crc16_m17.h"
//*****************************************************************************
// The results for these tests were created from https://crccalc.com/
//*****************************************************************************
namespace
{
SUITE(test_crc16_m17)
{
//*************************************************************************
// Table size 256
//*************************************************************************
TEST(test_crc16_m17)
{
std::string data("123456789");
uint16_t crc = etl::crc16_m17(data.begin(), data.end());
CHECK_EQUAL(0x772BU, crc);
}
//*************************************************************************
TEST(test_crc16_m17_add_values)
{
std::string data("123456789");
etl::crc16_m17 crc_calculator;
for (size_t i = 0UL; i < data.size(); ++i)
{
crc_calculator.add(data[i]);
}
uint16_t crc = crc_calculator;
CHECK_EQUAL(0x772BU, crc);
}
//*************************************************************************
TEST(test_crc16_m17_add_range)
{
std::string data("123456789");
etl::crc16_m17 crc_calculator;
crc_calculator.add(data.begin(), data.end());
uint16_t crc = crc_calculator.value();
CHECK_EQUAL(0x772BU, crc);
}
//*************************************************************************
TEST(test_crc16_m17_add_range_via_iterator)
{
std::string data("123456789");
etl::crc16_m17 crc_calculator;
std::copy(data.begin(), data.end(), crc_calculator.input());
uint16_t crc = crc_calculator.value();
CHECK_EQUAL(0x772BU, crc);
}
//*************************************************************************
TEST(test_crc16_m17_add_range_endian)
{
std::vector<uint8_t> data1 = { 0x01U, 0x02U, 0x03U, 0x04U, 0x05U, 0x06U, 0x07U, 0x08U };
std::vector<uint32_t> data2 = { 0x04030201UL, 0x08070605UL };
std::vector<uint8_t> data3 = { 0x08U, 0x07U, 0x06U, 0x05U, 0x04U, 0x03U, 0x02U, 0x01U };
uint16_t crc1 = etl::crc16_m17(data1.begin(), data1.end());
uint16_t crc2 = etl::crc16_m17((uint8_t*)&data2[0], (uint8_t*)(&data2[0] + data2.size()));
CHECK_EQUAL(crc1, crc2);
uint16_t crc3 = etl::crc16_m17(data3.rbegin(), data3.rend());
CHECK_EQUAL(crc1, crc3);
}
//*************************************************************************
// Table size 16
//*************************************************************************
TEST(test_crc16_m17_16)
{
std::string data("123456789");
uint16_t crc = etl::crc16_m17_t16(data.begin(), data.end());
CHECK_EQUAL(0x772BU, crc);
}
//*************************************************************************
TEST(test_crc16_m17_16_add_values)
{
std::string data("123456789");
etl::crc16_m17_t16 crc_calculator;
for (size_t i = 0UL; i < data.size(); ++i)
{
crc_calculator.add(data[i]);
}
uint16_t crc = crc_calculator;
CHECK_EQUAL(0x772BU, crc);
}
//*************************************************************************
TEST(test_crc16_m17_16_add_range)
{
std::string data("123456789");
etl::crc16_m17_t16 crc_calculator;
crc_calculator.add(data.begin(), data.end());
uint16_t crc = crc_calculator.value();
CHECK_EQUAL(0x772BU, crc);
}
//*************************************************************************
TEST(test_crc16_m17_16_add_range_via_iterator)
{
std::string data("123456789");
etl::crc16_m17_t16 crc_calculator;
std::copy(data.begin(), data.end(), crc_calculator.input());
uint16_t crc = crc_calculator.value();
CHECK_EQUAL(0x772BU, crc);
}
//*************************************************************************
TEST(test_crc16_m17_16_add_range_endian)
{
std::vector<uint8_t> data1 = { 0x01U, 0x02U, 0x03U, 0x04U, 0x05U, 0x06U, 0x07U, 0x08U };
std::vector<uint32_t> data2 = { 0x04030201UL, 0x08070605UL };
std::vector<uint8_t> data3 = { 0x08U, 0x07U, 0x06U, 0x05U, 0x04U, 0x03U, 0x02U, 0x01U };
uint16_t crc1 = etl::crc16_m17_t16(data1.begin(), data1.end());
uint16_t crc2 = etl::crc16_m17_t16((uint8_t*)&data2[0], (uint8_t*)(&data2[0] + data2.size()));
CHECK_EQUAL(crc1, crc2);
uint16_t crc3 = etl::crc16_m17_t16(data3.rbegin(), data3.rend());
CHECK_EQUAL(crc1, crc3);
}
//*************************************************************************
// Table size 4
//*************************************************************************
TEST(test_crc16_m17_4)
{
std::string data("123456789");
uint16_t crc = etl::crc16_m17_t4(data.begin(), data.end());
CHECK_EQUAL(0x772BU, crc);
}
//*************************************************************************
TEST(test_crc16_m17_4_add_values)
{
std::string data("123456789");
etl::crc16_m17_t4 crc_calculator;
for (size_t i = 0UL; i < data.size(); ++i)
{
crc_calculator.add(data[i]);
}
uint16_t crc = crc_calculator;
CHECK_EQUAL(0x772BU, crc);
}
//*************************************************************************
TEST(test_crc16_m17_4_add_range)
{
std::string data("123456789");
etl::crc16_m17_t4 crc_calculator;
crc_calculator.add(data.begin(), data.end());
uint16_t crc = crc_calculator.value();
CHECK_EQUAL(0x772BU, crc);
}
//*************************************************************************
TEST(test_crc16_m17_4_add_range_via_iterator)
{
std::string data("123456789");
etl::crc16_m17_t4 crc_calculator;
std::copy(data.begin(), data.end(), crc_calculator.input());
uint16_t crc = crc_calculator.value();
CHECK_EQUAL(0x772BU, crc);
}
//*************************************************************************
TEST(test_crc16_m17_4_add_range_endian)
{
std::vector<uint8_t> data1 = { 0x01U, 0x02U, 0x03U, 0x04U, 0x05U, 0x06U, 0x07U, 0x08U };
std::vector<uint32_t> data2 = { 0x04030201UL, 0x08070605UL };
std::vector<uint8_t> data3 = { 0x08U, 0x07U, 0x06U, 0x05U, 0x04U, 0x03U, 0x02U, 0x01U };
uint16_t crc1 = etl::crc16_m17_t4(data1.begin(), data1.end());
uint16_t crc2 = etl::crc16_m17_t4((uint8_t*)&data2[0], (uint8_t*)(&data2[0] + data2.size()));
CHECK_EQUAL(crc1, crc2);
uint16_t crc3 = etl::crc16_m17_t4(data3.rbegin(), data3.rend());
CHECK_EQUAL(crc1, crc3);
}
};
}

1
test/vs2019/etl.vcxproj
View File

@ -11350,6 +11350,7 @@
<ClCompile Include="..\test_crc16_en13757.cpp" />
<ClCompile Include="..\test_crc16_genibus.cpp" />
<ClCompile Include="..\test_crc16_kermit.cpp" />
<ClCompile Include="..\test_crc16_m17.cpp" />
<ClCompile Include="..\test_crc16_maxim.cpp" />
<ClCompile Include="..\test_crc16_mcrf4xx.cpp" />
<ClCompile Include="..\test_crc16_profibus.cpp" />

3
test/vs2019/etl.vcxproj.filters
View File

@ -3392,6 +3392,9 @@
<ClCompile Include="..\sanity-check\to_arithmetic.h.t.cpp">
<Filter>Tests\Sanity Checks\Source</Filter>
</ClCompile>
<ClCompile Include="..\test_crc16_m17.cpp">
<Filter>Tests\CRC</Filter>
</ClCompile>
</ItemGroup>
<ItemGroup>
<None Include="..\..\library.properties">