crc.h

Go to the documentation of this file.

 
/*
© [2025] Microchip Technology Inc. and its subsidiaries.
 
    Subject to your compliance with these terms, you may use Microchip 
    software and any derivatives exclusively with Microchip products. 
    You are responsible for complying with 3rd party license terms  
    applicable to your use of 3rd party software (including open source  
    software) that may accompany Microchip software. SOFTWARE IS ?AS IS.? 
    NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS 
    SOFTWARE, INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT,  
    MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT 
    WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, 
    INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY 
    KIND WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF 
    MICROCHIP HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE 
    FORESEEABLE. TO THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP?S 
    TOTAL LIABILITY ON ALL CLAIMS RELATED TO THE SOFTWARE WILL NOT 
    EXCEED AMOUNT OF FEES, IF ANY, YOU PAID DIRECTLY TO MICROCHIP FOR 
    THIS SOFTWARE.
*/
 
#ifndef CRC_H
#define CRC_H
 
// Section: Included Files
 
#include <xc.h>
#include <stdint.h>
#include <stdbool.h>
#include "crc_types.h"
#include "crc_interface.h"
// Section: Data Type Definitions
extern const struct CRC_INTERFACE CRC;
 
// Section: CRC Module APIs
 
void CRC_Initialize(void);
 
void CRC_Deinitialize(void);
 
void CRC_SeedSet(uint32_t seed, enum CRC_SEED_METHOD seedMethod, enum CRC_SEED_DIRECTION seedDirection);
 
void CRC_CalculateBufferStart(void *buffer, uint32_t sizeBytes);
 
void CRC_CalculateProgramStart(uint32_t startAddr, uint32_t sizeBytes);
 
void CRC_EventCallbackRegister(void (*handler)(void));
 
void CRC_EventCallback(void);
 
void CRC_Tasks(void);
 
bool CRC_CalculationIsDone(void);
 
uint32_t CRC_CalculationResultGet(bool reverse, uint32_t xorValue);
 
uint32_t CRC_CalculationResultRawGet(void);
 
uint32_t CRC_CalculationResultReverseGet(void);
 
uint32_t CRC_CalculationResultXORGet(uint32_t xorValue);
 
#endif  //CRC_H