crc.h

 
/******************************************************************************
 *
 * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 
 * Analog Devices, Inc.),
 * Copyright (C) 2023-2024 Analog Devices, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ******************************************************************************/
 
#ifndef LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32680_CRC_H_
#define LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32680_CRC_H_
 
/***** Includes *****/
#include "crc_regs.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/***** CRC Definitions *****/
typedef struct _mxc_crc_req_t {
    uint32_t *dataBuffer; 
    uint32_t dataLen; 
    uint32_t resultCRC; 
} mxc_crc_req_t;
 
typedef enum { CRC_LSB_FIRST, CRC_MSB_FIRST } mxc_crc_bitorder_t;
 
/***** Function Prototypes *****/
 
/* ************************************************************************* */
/* Global Control/Configuration functions                                    */
/* ************************************************************************* */
 
int MXC_CRC_Init(void);
 
int MXC_CRC_Shutdown(void);
 
void MXC_CRC_Handler(int ch, int error);
 
void MXC_CRC_SetDirection(mxc_crc_bitorder_t bitOrder);
 
mxc_crc_bitorder_t MXC_CRC_GetDirection(void);
 
void MXC_CRC_SwapDataIn(mxc_crc_bitorder_t bitOrder);
 
void MXC_CRC_SwapDataOut(mxc_crc_bitorder_t bitOrder);
 
void MXC_CRC_SetPoly(uint32_t poly);
 
uint32_t MXC_CRC_GetPoly(void);
 
uint32_t MXC_CRC_GetResult(void);
 
/*******************************/
/* High Level Functions        */
/*******************************/
 
int MXC_CRC_Compute(mxc_crc_req_t *req);
 
int MXC_CRC_ComputeAsync(mxc_crc_req_t *req);
 
#ifdef __cplusplus
}
#endif
#endif // LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32680_CRC_H_