crc/v0/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_V0_H_
#define CRC_V0_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <drivers/hw_include/cslr.h>
#include <drivers/hw_include/cslr_crc.h>
#include <drivers/hw_include/hw_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                             Macros & Typedefs                              */
/* ========================================================================== */
 
#define CRC_CHANNEL_IRQSTATUS_RAW_MAIN_ALL   \
    (uint32_t) ((uint32_t)CRC_INTS_CH1_CCITENS_MASK |  \
                (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        (4U)
 
typedef uint32_t crcOperationMode_t;
 
#define CRC_OPERATION_MODE_DATA        (CRC_CTRL2_CH1_MODE_DATA)
 
#define CRC_OPERATION_MODE_AUTO        (CRC_CTRL2_CH1_MODE_AUTO)
 
#define CRC_OPERATION_MODE_SEMICPU     (CRC_CTRL2_CH1_MODE_SEMICPU)
 
#define CRC_OPERATION_MODE_FULLCPU     (CRC_CTRL2_CH1_MODE_FULLCPU)
 
typedef uint32_t crcChannel_t;
 
#define CRC_CHANNEL_1                  (0x1U)
 
#define CRC_CHANNEL_2                  (0x2U)
 
#define CRC_CHANNEL_3                  (0x3U)
 
#define CRC_CHANNEL_4                  (0x4U)
 
typedef uint32_t crcIntrPriority_t;
 
#define CRC_INTR_PRIORITY_CH1_FAIL                (0x1U)
 
#define CRC_INTR_PRIORITY_CH2_FAIL                (0x2U)
 
#define CRC_INTR_PRIORITY_CH3_FAIL                (0x3U)
 
#define CRC_INTR_PRIORITY_CH4_FAIL                (0x4U)
 
#define CRC_INTR_PRIORITY_CH1_COMPRESSION_DONE    (0x9U)
 
#define CRC_INTR_PRIORITY_CH2_COMPRESSION_DONE    (0xaU)
 
#define CRC_INTR_PRIORITY_CH3_COMPRESSION_DONE    (0xbU)
 
#define CRC_INTR_PRIORITY_CH4_COMPRESSION_DONE    (0xcU)
 
#define CRC_INTR_PRIORITY_CH1_OVERRUN             (0x11U)
 
#define CRC_INTR_PRIORITY_CH2_OVERRUN             (0x12U)
 
#define CRC_INTR_PRIORITY_CH3_OVERRUN             (0x13U)
 
#define CRC_INTR_PRIORITY_CH4_OVERRUN             (0x14U)
 
#define CRC_INTR_PRIORITY_CH1_UNDERRUN            (0x19U)
 
#define CRC_INTR_PRIORITY_CH2_UNDERRUN            (0x1aU)
 
#define CRC_INTR_PRIORITY_CH3_UNDERRUN            (0x1bU)
 
#define CRC_INTR_PRIORITY_CH4_UNDERRUN            (0x1cU)
 
#define CRC_INTR_PRIORITY_CH1_TIMEOUT             (0x21U)
 
#define CRC_INTR_PRIORITY_CH2_TIMEOUT             (0x22U)
 
#define CRC_INTR_PRIORITY_CH3_TIMEOUT             (0x23U)
 
#define CRC_INTR_PRIORITY_CH4_TIMEOUT             (0x24U)
 
typedef uint32_t crcDataBusMask_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 crcSignature
{
    uint32_t regL;
    uint32_t regH;
}crcSignature_t;
 
typedef struct crcSignatureRegAddr
{
    uint32_t regL;
    uint32_t regH;
}crcSignatureRegAddr_t;
 
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 CRCInitialize(uint32_t     baseAddr,
                      crcChannel_t channel,
                      uint32_t     crcWatchdogPreload,
                      uint32_t     crcBlockPreload);
 
int32_t CRCVerifyInitialize(uint32_t     baseAddr,
                            crcChannel_t channel,
                            uint32_t     crcWatchdogPreload,
                            uint32_t     crcBlockPreload);
 
int32_t CRCConfigure(uint32_t           baseAddr,
                     crcChannel_t       channel,
                     uint32_t           crcPatternCount,
                     uint32_t           crcSectorCount,
                     crcOperationMode_t crcMode);
 
int32_t CRCVerifyConfigure(uint32_t           baseAddr,
                           crcChannel_t       channel,
                           uint32_t           crcPatternCount,
                           uint32_t           crcSectorCount,
                           crcOperationMode_t crcMode);
 
int32_t CRCChannelReset(uint32_t     baseAddr,
                        crcChannel_t channel);
 
int32_t CRCGetPSASigRegAddr(uint32_t               baseAddr,
                            crcChannel_t           channel,
                            crcSignatureRegAddr_t *pCRCRegAddr);
 
int32_t CRCGetPSASig(uint32_t        baseAddr,
                     crcChannel_t    channel,
                     crcSignature_t *pCRCPSASign);
 
int32_t CRCSetPSASeedSig(uint32_t              baseAddr,
                         crcChannel_t          channel,
                         const crcSignature_t *pCRCPSASeedSign);
 
int32_t CRCGetPSASectorSig(uint32_t        baseAddr,
                           crcChannel_t    channel,
                           crcSignature_t *pCRCSectorSign);
 
int32_t CRCGetHighestPriorityIntrStatus(uint32_t baseAddr, uint32_t *pIntVecAddr);
 
int32_t CRCGetIntrStatus(uint32_t      baseAddr,
                         crcChannel_t  channel,
                         uint32_t     *pIntrStatus);
 
int32_t CRCEnableIntr(uint32_t     baseAddr,
                      crcChannel_t channel,
                      uint32_t     intrMask);
 
int32_t CRCDisableIntr(uint32_t     baseAddr,
                       crcChannel_t channel,
                       uint32_t     intrMask);
 
int32_t CRCClearIntr(uint32_t     baseAddr,
                     crcChannel_t channel,
                     uint32_t     intrMask);
 
int32_t CRCPowerDownCtrl(uint32_t baseAddr,
                         uint32_t ctrlFlag);
 
int32_t CRCIsBusy(uint32_t      baseAddr,
                  crcChannel_t  channel,
                  uint32_t     *pBusyFlag);
 
int32_t CRCGetCurSecNum(uint32_t        baseAddr,
                        crcChannel_t    channel,
                        uint32_t       *pCurSecNum);
 
int32_t CRCGetCurPSASig(uint32_t        baseAddr,
                        crcChannel_t    channel,
                        crcSignature_t *pCurPSASig);
 
int32_t CRCGetRawData(uint32_t        baseAddr,
                      crcChannel_t    channel,
                      crcSignature_t *pRawData);
 
int32_t CRCDataBusTracingCtrl(uint32_t         baseAddr,
                              uint32_t         ctrlFlag,
                              crcDataBusMask_t dataBusMask,
                              crcDataBusMask_t busEnableMask);
 
int32_t CRCVerifyBusTracingCtrl(uint32_t         baseAddr,
                                uint32_t         ctrlFlag,
                                crcDataBusMask_t dataBusMask,
                                crcDataBusMask_t busEnableMask);
 
int32_t CRCReadStaticRegs(uint32_t baseAddr, Crc_StaticRegs *pStaticRegs);
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif  /* #ifndef CRC_V0_H_ */