crc.hpp

00001 /*******************************************************************************
00002 * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
00003 *
00004 * Permission is hereby granted, free of charge, to any person obtaining a
00005 * copy of this software and associated documentation files (the "Software"),
00006 * to deal in the Software without restriction, including without limitation
00007 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008 * and/or sell copies of the Software, and to permit persons to whom the
00009 * Software is furnished to do so, subject to the following conditions:
00010 *
00011 * The above copyright notice and this permission notice shall be included
00012 * in all copies or substantial portions of the Software.
00013 *
00014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00017 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00018 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00019 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00020 * OTHER DEALINGS IN THE SOFTWARE.
00021 *
00022 * Except as contained in this notice, the name of Maxim Integrated
00023 * Products, Inc. shall not be used except as stated in the Maxim Integrated
00024 * Products, Inc. Branding Policy.
00025 *
00026 * The mere transfer of this software does not imply any licenses
00027 * of trade secrets, proprietary technology, copyrights, patents,
00028 * trademarks, maskwork rights, or any other form of intellectual
00029 * property whatsoever. Maxim Integrated Products, Inc. retains all
00030 * ownership rights.
00031 *******************************************************************************/
00032 
00033 #ifndef MaximInterface_crc
00034 #define MaximInterface_crc
00035 
00036 #include <stddef.h>
00037 #include <stdint.h>
00038 #include <MaximInterface/Utilities/Export.h>
00039 #include "span.hpp"
00040 
00041 namespace MaximInterface {
00042 
00043 /// @brief Perform a CRC8 calculation.
00044 /// @param data Data to pass though the CRC generator.
00045 /// @param crc Beginning state of the CRC generator.
00046 /// @returns The calculated CRC8.
00047 MaximInterface_EXPORT uint_fast8_t calculateCrc8(uint_fast8_t data,
00048                                                  uint_fast8_t crc = 0);
00049 
00050 /// @brief Perform a CRC8 calculation with variable length data.
00051 /// @param[in] data Data array to pass through the CRC generator.
00052 /// @param crc Beginning state of the CRC generator.
00053 /// @returns The calculated CRC8.
00054 MaximInterface_EXPORT uint_fast8_t calculateCrc8(span<const uint_least8_t> data,
00055                                                  uint_fast8_t crc = 0);
00056 
00057 /// @brief Perform a CRC16 calculation.
00058 /// @param data Data to pass though the CRC generator.
00059 /// @param crc Beginning state of the CRC generator.
00060 /// @returns The calculated CRC16.
00061 MaximInterface_EXPORT uint_fast16_t calculateCrc16(uint_fast8_t data,
00062                                                    uint_fast16_t crc = 0);
00063 
00064 /// @brief Perform a CRC16 calculation with variable length data.
00065 /// @param[in] data Data array to pass through the CRC generator.
00066 /// @param crc Beginning state of the CRC generator.
00067 /// @returns The calculated CRC16.
00068 MaximInterface_EXPORT uint_fast16_t
00069 calculateCrc16(span<const uint_least8_t> data, uint_fast16_t crc = 0);
00070 
00071 } // namespace MaximInterface
00072 
00073 #endif