crc.h

00001 /******************************************************************//**
00002 * Copyright (C) 2016 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 OneWire_CRC
00034 #define OneWire_CRC
00035 
00036 #include <stdint.h>
00037 #include <stddef.h>
00038 
00039 namespace OneWire
00040 {
00041     namespace crc
00042     {
00043         /// Perform a CRC8 calculation.
00044         /// @param crc8 Beginning state of the CRC generator.
00045         /// @param data Data to pass though the CRC generator.
00046         /// @returns The calculated CRC8.
00047         uint8_t calculateCrc8(uint8_t crc8, uint8_t data);
00048         
00049         /// Perform a CRC8 calculation with variable length data.
00050         /// @param[in] data Data array to pass through the CRC generator.
00051         /// @param dataLen Length of the data array to process.
00052         /// @param crc Beginning state of the CRC generator.
00053         /// @returns The calculated CRC8.
00054         uint8_t calculateCrc8(const uint8_t * data, size_t dataLen, uint8_t crc = 0);
00055         
00056         /// Perform a CRC16 calculation.
00057         /// @param crc16 Beginning state of the CRC generator.
00058         /// @param data Data to pass though the CRC generator.
00059         /// @returns The calculated CRC16.
00060         uint16_t calculateCrc16(uint16_t crc16, uint16_t data);
00061 
00062         /// Perform a CRC16 calculation with variable length data.
00063         /// @param[in] data Data array to pass through the CRC generator.
00064         /// @param data_offset Offset of the data array to begin processing.
00065         /// @param data_len Length of the data array to process.
00066         /// @param crc Beginning state of the CRC generator.
00067         /// @returns The calculated CRC16.
00068         uint16_t calculateCrc16(const uint8_t * data, size_t dataLen, uint16_t crc = 0);
00069     }
00070 }
00071 
00072 #endif