Enda Kilgarriff / platform_drivers
Embed: (wiki syntax)

« Back to documentation index

crc8.c File Reference

crc8.c File Reference

Source file of CRC-8 computation. More...

Go to the source code of this file.

Functions

void crc8_populate_msb (uint8_t *table, const uint8_t polynomial)
 Creates the CRC-8 lookup table for a given polynomial.
uint8_t crc8 (const uint8_t *table, const uint8_t *pdata, size_t nbytes, uint8_t crc)
 Computes the CRC-8 over a buffer of data.

Detailed Description

Source file of CRC-8 computation.

Author:
Darius Berghe (darius.berghe@analog.com)

Copyright 2020(c) Analog Devices, Inc.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • 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.
  • Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
  • The use of this software may or may not infringe the patent rights of one or more patent holders. This license does not release you from the requirement that you obtain separate licenses from these patent holders to use this software.
  • Use of the software either in source or binary form, must be run on or directly connected to an Analog Devices Inc. component.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, 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.

Definition in file crc8.c.


Function Documentation

uint8_t crc8 ( const uint8_t *  table,
const uint8_t *  pdata,
size_t  nbytes,
uint8_t  crc 
)

Computes the CRC-8 over a buffer of data.

Parameters:
table- Pointer to a CRC-8 lookup table for the desired polynomial.
pdata- Pointer to 8-bit data buffer.
nbytes- Number of bytes to compute the CRC-8 over.
crc- Initial value for the CRC-8 computation. Can be used to cascade calls to this function by providing a previous output of this function as the crc parameter.
Returns:
crc - Computed CRC-8 value.

Definition at line 88 of file crc8.c.

void crc8_populate_msb ( uint8_t *  table,
const uint8_t  polynomial 
)

Creates the CRC-8 lookup table for a given polynomial.

Parameters:
table- Pointer to a CRC-8 lookup table to write to.
polynomial- msb-first representation of desired polynomial.

Polynomials in CRC algorithms are typically represented as shown below.

poly = x^8 + x^2 + x^1 + 1

Using msb-first direction, x^7 maps to the msb.

msb first: poly = (1)00000111 = 0x07

Returns:
None.

Definition at line 57 of file crc8.c.