crc/v1/crc.h

Go to the documentation of this file.

/*
 * Copyright (C) 2021 Texas Instruments Incorporated
 *
 * 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 Texas Instruments Incorporated nor the names of
 *   its contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, 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.
 */
 
#ifndef CRC_V1_H_
#define CRC_V1_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <drivers/hw_include/cslr.h>
#include <drivers/hw_include/cslr_crc.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                             Macros & Typedefs                              */
/* ========================================================================== */
 
#define CRC_CHANNEL_IRQSTATUS_RAW_MAIN_ALL   \
    (uint32_t) ((uint32_t)CRC_INTR_CH1_FAILENR_MASK |  \
                (uint32_t)CRC_INTR_CH1_OVERENR_MASK |  \
                (uint32_t)CRC_INTR_CH1_UNDERENR_MASK | \
                (uint32_t)CRC_INTR_CH1_TIME_OUT_ENR_MASK)
 
#define CRC_PATTERN_COUNT_MAX          (0x000FFFFFU)
 
#define CRC_SECTOR_COUNT_MAX           (0x0000FFFFU)
 
#define CRC_BCTOPLD_MAX                (0x00FFFFFFU)
 
#define CRC_WDTOPLD_MAX                (0x00FFFFFFU)
 
#define CRC_MAX_NUM_OF_CHANNELS         (2U)
 
typedef uint32_t CRC_OperationMode_t;
#define CRC_OPERATION_MODE_FULLCPU      (CRC_CTRL2_CH1_MODE_FULLCPU)
 
typedef uint32_t CRC_Channel_t;
 
#define CRC_CHANNEL_1                   (0x1U)
 
#define CRC_CHANNEL_2                   (0x2U)
 
typedef uint32_t CRC_Type_t;
 
#define CRC_TYPE_16BIT                  (CRC_CTRL0_CH1_CRC_SEL_16BIT)
 
#define CRC_TYPE_32BIT                  (CRC_CTRL0_CH1_CRC_SEL_32BIT)
 
#define CRC_TYPE_64BIT                  (CRC_CTRL0_CH1_CRC_SEL_64BIT)
 
typedef uint32_t CRC_DataLength_t;
 
#define CRC_DATALENGTH_16BIT            (CRC_CTRL0_CH1_DW_SEL_16BIT)
 
#define CRC_DATALENGTH_32BIT            (CRC_CTRL0_CH1_DW_SEL_32BIT)
 
#define CRC_DATALENGTH_64BIT            (CRC_CTRL0_CH1_DW_SEL_64BIT)
 
typedef uint32_t CRC_BitSwap_t;
 
#define CRC_BITSWAP_MSB                 (CRC_CTRL0_CH1_BIT_SWAP_MSB)
 
#define CRC_BITSWAP_LSB                 (CRC_CTRL0_CH1_BIT_SWAP_LSB)
 
typedef uint32_t CRC_ByteSwap_t;
 
#define CRC_BYTESWAP_DISABLE            (CRC_CTRL0_CH1_BTYE_SWAP_DISABLE)
 
#define CRC_BYTESWAP_ENABLE             (CRC_CTRL0_CH1_BTYE_SWAP_ENABLE)
 
typedef uint32_t CRC_IntrPriority_t;
 
#define CRC_INTR_PRIORITY_CH1_FAIL                (0x1U)
 
#define CRC_INTR_PRIORITY_CH2_FAIL                (0x2U)
 
#define CRC_INTR_PRIORITY_CH1_COMPRESSION_DONE    (0x9U)
 
#define CRC_INTR_PRIORITY_CH2_COMPRESSION_DONE    (0xaU)
 
#define CRC_INTR_PRIORITY_CH1_OVERRUN             (0x11U)
 
#define CRC_INTR_PRIORITY_CH2_OVERRUN             (0x12U)
 
#define CRC_INTR_PRIORITY_CH1_UNDERRUN            (0x19U)
 
#define CRC_INTR_PRIORITY_CH2_UNDERRUN            (0x1aU)
 
#define CRC_INTR_PRIORITY_CH1_TIMEOUT             (0x21U)
 
#define CRC_INTR_PRIORITY_CH2_TIMEOUT             (0x22U)
 
typedef uint32_t CRC_DataBusMask_t;
 
#define CRC_DATA_BUS_ITCM_MASK     (CRC_MCRC_BUS_SEL_ITC_MEN_MASK)
 
#define CRC_DATA_BUS_DTCM_MASK     (CRC_MCRC_BUS_SEL_DTC_MEN_MASK)
 
#define CRC_DATA_BUS_VBUSM_MASK    (CRC_MCRC_BUS_SEL_MEN_MASK)
 
#define CRC_DATA_BUS_MASK_ALL      (CRC_MCRC_BUS_SEL_ITC_MEN_MASK | \
                                    CRC_MCRC_BUS_SEL_DTC_MEN_MASK | \
                                    CRC_MCRC_BUS_SEL_MEN_MASK)
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef struct CRC_Config_s
{
    CRC_OperationMode_t      mode;
    CRC_Type_t               type;
    CRC_DataLength_t         dataLen;
    CRC_BitSwap_t            bitSwap;
    CRC_ByteSwap_t           byteSwap;
    uint32_t                patternCount;
    uint32_t                sectorCount;
} CRC_Config;
 
typedef struct CRC_Signature_s
{
    uint32_t regL;
    uint32_t regH;
}CRC_Signature;
 
typedef struct CRC_SignatureRegAddr_s
{
    uint32_t regL;
    uint32_t regH;
}CRC_SignatureRegAddr;
 
typedef struct
{
    volatile uint32_t PCOUNT;
    volatile uint32_t SCOUNT;
    volatile uint32_t WDTOPLD;
    volatile uint32_t BCTOPLD;
} CRC_ChannelStaticRegs;
 
typedef struct
{
    CRC_ChannelStaticRegs channelRegs[CRC_MAX_NUM_OF_CHANNELS];
    volatile uint32_t CTRL0;
    volatile uint32_t CTRL1;
    volatile uint32_t BUS_SEL;
} CRC_StaticRegs;
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
int32_t CRC_initialize(uint32_t     baseAddr,
                      CRC_Channel_t channel,
                      uint32_t     crcWatchdogPreload,
                      uint32_t     crcBlockPreload);
 
int32_t CRC_verifyInitialize(uint32_t     baseAddr,
                            CRC_Channel_t channel,
                            uint32_t     crcWatchdogPreload,
                            uint32_t     crcBlockPreload);
 
int32_t CRC_configure(uint32_t           baseAddr,
                     CRC_Channel_t       channel,
                     const CRC_Config *config);
 
int32_t CRC_verifyConfigure(uint32_t           baseAddr,
                           CRC_Channel_t       channel,
                           uint32_t           patternCount,
                           uint32_t           sectorCount,
                           CRC_OperationMode_t mode);
 
int32_t CRC_channelReset(uint32_t     baseAddr,
                        CRC_Channel_t channel);
 
int32_t CRC_getPSASigRegAddr(uint32_t               baseAddr,
                            CRC_Channel_t           channel,
                            CRC_SignatureRegAddr *pCRCRegAddr);
 
int32_t CRC_getPSASig(uint32_t        baseAddr,
                     CRC_Channel_t    channel,
                     CRC_Signature *pCRCPSASign);
 
int32_t CRC_setPSASeedSig(uint32_t              baseAddr,
                         CRC_Channel_t          channel,
                         const CRC_Signature *pCRCPSASeedSign);
 
int32_t CRC_getPSASectorSig(uint32_t        baseAddr,
                           CRC_Channel_t    channel,
                           CRC_Signature *pCRCSectorSign);
 
int32_t CRC_getHighestPriorityIntrStatus(uint32_t baseAddr, uint32_t *pIntVecAddr);
 
int32_t CRC_getIntrStatus(uint32_t      baseAddr,
                         CRC_Channel_t  channel,
                         uint32_t     *pIntrStatus);
 
int32_t CRC_enableIntr(uint32_t     baseAddr,
                      CRC_Channel_t channel,
                      uint32_t     intrMask);
 
int32_t CRC_disableIntr(uint32_t     baseAddr,
                       CRC_Channel_t channel,
                       uint32_t     intrMask);
 
int32_t CRC_clearIntr(uint32_t     baseAddr,
                     CRC_Channel_t channel,
                     uint32_t     intrMask);
 
int32_t CRC_powerDownCtrl(uint32_t baseAddr,
                         uint32_t ctrlFlag);
 
int32_t CRC_isBusy(uint32_t      baseAddr,
                  CRC_Channel_t  channel,
                  uint32_t     *pBusyFlag);
 
int32_t CRC_getCurSecNum(uint32_t        baseAddr,
                        CRC_Channel_t    channel,
                        uint32_t       *pCurSecNum);
 
int32_t CRC_getCurPSASig(uint32_t        baseAddr,
                        CRC_Channel_t    channel,
                        CRC_Signature *pCurPSASig);
 
int32_t CRC_getRawData(uint32_t        baseAddr,
                      CRC_Channel_t    channel,
                      CRC_Signature *pRawData);
 
int32_t CRC_dataBusTracingCtrl(uint32_t         baseAddr,
                              uint32_t         ctrlFlag,
                              CRC_DataBusMask_t dataBusMask,
                              CRC_DataBusMask_t busEnableMask);
 
int32_t CRC_verifyBusTracingCtrl(uint32_t         baseAddr,
                                uint32_t         ctrlFlag,
                                CRC_DataBusMask_t dataBusMask,
                                CRC_DataBusMask_t busEnableMask);
 
int32_t CRC_readStaticRegs(uint32_t baseAddr, CRC_StaticRegs *pStaticRegs);
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif  /* #ifndef CRC_V1_H_ */