Diff: MaximInterfaceCore/Crc.hpp

Revision:

9:fa054cc51fdb

Parent:

8:5ea891c7d1a1

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/MaximInterfaceCore/Crc.hpp	Fri Sep 27 16:19:38 2019 -0500
@@ -0,0 +1,107 @@
+/*******************************************************************************
+* Copyright (C) Maxim Integrated Products, Inc., All Rights Reserved.
+*
+* 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 MAXIM INTEGRATED 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.
+*
+* Except as contained in this notice, the name of Maxim Integrated
+* Products, Inc. shall not be used except as stated in the Maxim Integrated
+* Products, Inc. Branding Policy.
+*
+* The mere transfer of this software does not imply any licenses
+* of trade secrets, proprietary technology, copyrights, patents,
+* trademarks, maskwork rights, or any other form of intellectual
+* property whatsoever. Maxim Integrated Products, Inc. retains all
+* ownership rights.
+*******************************************************************************/
+
+#ifndef MaximInterfaceCore_Crc_hpp
+#define MaximInterfaceCore_Crc_hpp
+
+#include <stddef.h>
+#include <stdint.h>
+#include "Config.hpp"
+#include "span.hpp"
+
+namespace MaximInterfaceCore {
+
+/// @brief Perform a CRC8 calculation.
+/// @param crc Beginning state of the CRC generator.
+/// @param data Data to pass though the CRC generator.
+/// @returns The calculated CRC8.
+MaximInterfaceCore_EXPORT uint_fast8_t calculateCrc8(uint_fast8_t crc,
+                                                     uint_fast8_t data);
+
+/// @brief
+/// Perform a CRC8 calculation with the CRC generator initialized to zero.
+/// @param data Data to pass though the CRC generator.
+/// @returns The calculated CRC8.
+inline uint_fast8_t calculateCrc8(uint_fast8_t data) {
+  return calculateCrc8(0, data);
+}
+
+/// @brief Perform a CRC8 calculation with variable length data.
+/// @param crc Beginning state of the CRC generator.
+/// @param[in] data Data array to pass through the CRC generator.
+/// @returns The calculated CRC8.
+MaximInterfaceCore_EXPORT uint_fast8_t
+calculateCrc8(uint_fast8_t crc, span<const uint_least8_t> data);
+
+/// @brief
+/// Perform a CRC8 calculation with variable length data and the CRC generator
+/// initialized to zero.
+/// @param[in] data Data array to pass through the CRC generator.
+/// @returns The calculated CRC8.
+inline uint_fast8_t calculateCrc8(span<const uint_least8_t> data) {
+  return calculateCrc8(0, data);
+}
+
+/// @brief Perform a CRC16 calculation.
+/// @param crc Beginning state of the CRC generator.
+/// @param data Data to pass though the CRC generator.
+/// @returns The calculated CRC16.
+MaximInterfaceCore_EXPORT uint_fast16_t calculateCrc16(uint_fast16_t crc,
+                                                       uint_fast8_t data);
+
+/// @brief
+/// Perform a CRC16 calculation with the CRC generator initialized to zero.
+/// @param data Data to pass though the CRC generator.
+/// @returns The calculated CRC16.
+inline uint_fast16_t calculateCrc16(uint_fast8_t data) {
+  return calculateCrc16(0, data);
+}
+
+/// @brief Perform a CRC16 calculation with variable length data.
+/// @param crc Beginning state of the CRC generator.
+/// @param[in] data Data array to pass through the CRC generator.
+/// @returns The calculated CRC16.
+MaximInterfaceCore_EXPORT uint_fast16_t
+calculateCrc16(uint_fast16_t crc, span<const uint_least8_t> data);
+
+/// @brief
+/// Perform a CRC16 calculation with variable length data and the CRC generator
+/// initialized to zero.
+/// @param[in] data Data array to pass through the CRC generator.
+/// @returns The calculated CRC16.
+inline uint_fast16_t calculateCrc16(span<const uint_least8_t> data) {
+  return calculateCrc16(0, data);
+}
+
+} // namespace MaximInterfaceCore
+
+#endif