blob: 568d1deaa6fa73f4063fae3f72e9e716e0b6fd49 [file] [log] [blame]
/****************************************************************************
* include/crc8.h
*
* Copyright (C) 2014 Ken Pettit. All rights reserved.
* Author: Ken Pettit <pettitkd@gmail.com>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
#ifndef __INCLUDE_CRC8_H
#define __INCLUDE_CRC8_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <sys/types.h>
#include <stdint.h>
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
#ifdef __cplusplus
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif
/****************************************************************************
* Name: crc8part
*
* Description:
* Continue CRC calculation on a part of the buffer using the polynomial
* x^8+x^6+x^3+x^2+1 (Koopman, et al. "0xA6" poly).
*
****************************************************************************/
uint8_t crc8part(FAR const uint8_t *src, size_t len, uint8_t crc8val);
/****************************************************************************
* Name: crc8
*
* Description:
* Return an 8-bit CRC of the contents of the 'src' buffer, length 'len'
* using the polynomial x^8+x^6+x^3+x^2+1 (Koopman, et al. "0xA6" poly).
*
****************************************************************************/
uint8_t crc8(FAR const uint8_t *src, size_t len);
/****************************************************************************
* Name: crc8ccitt
*
* Description:
* Return an 8-bit CRC of the contents of the 'src' buffer, length 'len'
* using the polynomial x^8+x^2+x^1+1 (aka "0x07" poly).
*
****************************************************************************/
uint8_t crc8ccitt(FAR const uint8_t *src, size_t len);
#undef EXTERN
#ifdef __cplusplus
}
#endif
#endif /* __INCLUDE_CRC8_H */