Crc.hpp

00001 /*******************************************************************************
00002 * Copyright (C) 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 MaximInterfaceCore_Crc_hpp
00034 #define MaximInterfaceCore_Crc_hpp
00035 
00036 #include <stddef.h>
00037 #include <stdint.h>
00038 #include "Config.hpp"
00039 #include "span.hpp"
00040 
00041 namespace MaximInterfaceCore {
00042 
00043 /// @brief Perform a CRC8 calculation.
00044 /// @param crc Beginning state of the CRC generator.
00045 /// @param data Data to pass though the CRC generator.
00046 /// @returns The calculated CRC8.
00047 MaximInterfaceCore_EXPORT uint_fast8_t calculateCrc8(uint_fast8_t crc,
00048                                                      uint_fast8_t data);
00049 
00050 /// @brief
00051 /// Perform a CRC8 calculation with the CRC generator initialized to zero.
00052 /// @param data Data to pass though the CRC generator.
00053 /// @returns The calculated CRC8.
00054 inline uint_fast8_t calculateCrc8(uint_fast8_t data) {
00055   return calculateCrc8(0, data);
00056 }
00057 
00058 /// @brief Perform a CRC8 calculation with variable length data.
00059 /// @param crc Beginning state of the CRC generator.
00060 /// @param[in] data Data array to pass through the CRC generator.
00061 /// @returns The calculated CRC8.
00062 MaximInterfaceCore_EXPORT uint_fast8_t
00063 calculateCrc8(uint_fast8_t crc, span<const uint_least8_t> data);
00064 
00065 /// @brief
00066 /// Perform a CRC8 calculation with variable length data and the CRC generator
00067 /// initialized to zero.
00068 /// @param[in] data Data array to pass through the CRC generator.
00069 /// @returns The calculated CRC8.
00070 inline uint_fast8_t calculateCrc8(span<const uint_least8_t> data) {
00071   return calculateCrc8(0, data);
00072 }
00073 
00074 /// @brief Perform a CRC16 calculation.
00075 /// @param crc Beginning state of the CRC generator.
00076 /// @param data Data to pass though the CRC generator.
00077 /// @returns The calculated CRC16.
00078 MaximInterfaceCore_EXPORT uint_fast16_t calculateCrc16(uint_fast16_t crc,
00079                                                        uint_fast8_t data);
00080 
00081 /// @brief
00082 /// Perform a CRC16 calculation with the CRC generator initialized to zero.
00083 /// @param data Data to pass though the CRC generator.
00084 /// @returns The calculated CRC16.
00085 inline uint_fast16_t calculateCrc16(uint_fast8_t data) {
00086   return calculateCrc16(0, data);
00087 }
00088 
00089 /// @brief Perform a CRC16 calculation with variable length data.
00090 /// @param crc Beginning state of the CRC generator.
00091 /// @param[in] data Data array to pass through the CRC generator.
00092 /// @returns The calculated CRC16.
00093 MaximInterfaceCore_EXPORT uint_fast16_t
00094 calculateCrc16(uint_fast16_t crc, span<const uint_least8_t> data);
00095 
00096 /// @brief
00097 /// Perform a CRC16 calculation with variable length data and the CRC generator
00098 /// initialized to zero.
00099 /// @param[in] data Data array to pass through the CRC generator.
00100 /// @returns The calculated CRC16.
00101 inline uint_fast16_t calculateCrc16(span<const uint_least8_t> data) {
00102   return calculateCrc16(0, data);
00103 }
00104 
00105 } // namespace MaximInterfaceCore
00106 
00107 #endif