Functions
crc.h File Reference

Declares the functions to compute and validate the CRC of a buffer. More...

#include <rosaic/packed_structs/sbf_structs.hpp>
#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
Include dependency graph for crc.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

uint16_t FW_EXPORT compute16CCITT (const void *buf, size_t buf_length)
 This function computes the CRC-8-CCITT (Cyclic Redundancy Check) of a buffer "buf" of "buf_length" bytes. More...
 
bool FW_EXPORT isValid (const void *block)
 Validates whether the calculated CRC of the SBF block at hand matches the CRC field of the streamed SBF block. More...
 

Detailed Description

Declares the functions to compute and validate the CRC of a buffer.

Date
17/08/20

Definition in file crc.h.

Function Documentation

◆ compute16CCITT()

uint16_t FW_EXPORT compute16CCITT ( const void *  buf,
size_t  buf_length 
)

This function computes the CRC-8-CCITT (Cyclic Redundancy Check) of a buffer "buf" of "buf_length" bytes.

Parameters
[in]bufThe buffer at hand
[in]buf_lengthNumber of bytes in "buf"
Returns
The calculated CRC

Note that a void pointer is a pointer that has no associated data type with it. A void pointer can hold address of any type and can be typcasted to any type.

Definition at line 43 of file crc.c.

◆ isValid()

bool FW_EXPORT isValid ( const void *  block)

Validates whether the calculated CRC of the SBF block at hand matches the CRC field of the streamed SBF block.

Parameters
blockThe SBF block that we are interested in
Returns
True if the CRC check of the SBFBlock has passed, false otherwise

Definition at line 68 of file crc.c.



rosaic
Author(s): Tibor Dome
autogenerated on Wed Oct 14 2020 03:43:50