crc.h File Reference

This is the generated driver header file for the CRC driver. More...

#include <xc.h>
#include <stdint.h>
#include <stdbool.h>
#include "crc_types.h"
#include "crc_interface.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
void	CRC_Initialize (void)
	Initializes the CRC module. This function sets the polynomial and data width; data and seed shift; updates the polynomial and shifts the seed value. After the function is called, the CRC module is ready to calculate the CRC of a data buffer.
void	CRC_Deinitialize (void)
	Deinitializes CRC to POR values.
void	CRC_SeedSet (uint32_t seed, enum CRC_SEED_METHOD seedMethod, enum CRC_SEED_DIRECTION seedDirection)
	Sets the CRC seed with method and direction.
void	CRC_CalculateBufferStart (void *buffer, uint32_t sizeBytes)
	CRC module calculation on a buffer in data space.
void	CRC_CalculateProgramStart (uint32_t startAddr, uint32_t sizeBytes)
	Starts the CRC calculation on a buffer in program space.
void	CRC_EventCallbackRegister (void(*handler)(void))
	This function can be used to override default callback and to define custom callback for CRC Event event.
void	CRC_EventCallback (void)
	This is the default callback with weak attribute. The user can override and implement the default callback without weak attribute or can register a custom callback function using CRC_EventCallbackRegister.
void	CRC_Tasks (void)
	This function cycles through the CRC calculations. This function will load the CRC module FIFO with the buffer data.
bool	CRC_CalculationIsDone (void)
	Returns the CRC calculation complete status
uint32_t	CRC_CalculationResultGet (bool reverse, uint32_t xorValue)
	Gets the CRC result if the calculation is done.
uint32_t	CRC_CalculationResultRawGet (void)
	Gets the CRC raw result if the calculation is done.
uint32_t	CRC_CalculationResultReverseGet (void)
	Gets the CRC reversed value of result if the calculation is done.
uint32_t	CRC_CalculationResultXORGet (uint32_t xorValue)
	Gets the CRC XOR'd value of the result if the calculation is done.

Variables
const struct CRC_INTERFACE	CRC
	Structure object of type CRC_INTERFACE with the custom name given by the user in the Melody Driver User interface. The default name e.g. CRC can be changed by the user in the CRC user interface. This allows defining a structure with application specific name using the 'Custom Name' field. Application specific name allows the API Portability.

Detailed Description

This is the generated driver source file for the CRC driver.

CRC Generated Driver Header File

CRC Generated Driver Source File

Definition in file crc.h.