Maxim Integrated / OneWire

1-Wire® library for mbed. Complete 1-Wire library that supports our silicon masters along with a bit-bang master on the MAX32600MBED platform with one common interface for mbed. Slave support has also been included and more slaves will be added as time permits.

Dependents:   MAXREFDES131_Qt_Demo MAX32630FTHR_iButton_uSD_Logger MAX32630FTHR_DS18B20_uSD_Logger MAXREFDES130_131_Demo ... more

Superseded by MaximInterface.

Utilities/crc.h

Committer:
IanBenzMaxim
Date:
2016-06-15
Revision:
86:2ce08ca58b9e
Parent:
crc.h@ 80:83b0d879cc32
Child:
104:3f48daed532b

File content as of revision 86:2ce08ca58b9e:

#ifndef OneWire_CRC
#define OneWire_CRC

#include <stdint.h>
#include <stddef.h>

namespace OneWire
{
    namespace crc
    {
        /// Perform a CRC8 calculation.
        /// @param crc8 Beginning state of the CRC generator.
        /// @param data Data to pass though the CRC generator.
        /// @returns The calculated CRC8.
        uint8_t calculateCrc8(uint8_t crc8, uint8_t data);
        
        /// Perform a CRC8 calculation with variable length data.
        /// @param[in] data Data array to pass through the CRC generator.
        /// @param dataLen Length of the data array to process.
        /// @param crc Beginning state of the CRC generator.
        /// @returns The calculated CRC8.
        uint8_t calculateCrc8(const uint8_t * data, size_t dataLen, uint8_t crc = 0);
        
        /// Perform a CRC16 calculation.
        /// @param crc16 Beginning state of the CRC generator.
        /// @param data Data to pass though the CRC generator.
        /// @returns The calculated CRC16.
        uint16_t calculateCrc16(uint16_t crc16, uint16_t data);

        /// Perform a CRC16 calculation with variable length data.
        /// @param[in] data Data array to pass through the CRC generator.
        /// @param data_offset Offset of the data array to begin processing.
        /// @param data_len Length of the data array to process.
        /// @param crc Beginning state of the CRC generator.
        /// @returns The calculated CRC16.
        uint16_t calculateCrc16(const uint8_t * data, size_t dataOffset, size_t dataLen, uint16_t crc = 0);
    }
}

#endif