sdl_mcrc.h

Go to the documentation of this file.

/*
 *   Copyright (c) Texas Instruments Incorporated 2021
 *
 *  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 SDL_MCRC_H_
#define SDL_MCRC_H_

/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#include <src/sdl/mcrc/sdl_mcrc_hw.h>

#if defined (SOC_J721E)
#include <include/soc/j721e/sdlr_soc_baseaddress.h>
#endif /* SOC_J721E */

#ifdef _cplusplus
extern "C" {
#endif

/* ========================================================================== */
/*                            Macros & Typedefs                               */
/* ========================================================================== */

#define SDL_MCRC_CHANNEL_IRQSTATUS_RAW_MAIN_ALL   \
    (uint32_t) ((uint32_t)SDL_MCRC_INTS_CH1_CCITENS_MASK |  \
                (uint32_t)SDL_MCRC_INTR_CH1_FAILENR_MASK |  \
                (uint32_t)SDL_MCRC_INTR_CH1_OVERENR_MASK |  \
                (uint32_t)SDL_MCRC_INTR_CH1_UNDERENR_MASK | \
                (uint32_t)SDL_MCRC_INTR_CH1_TIME_OUT_ENR_MASK)

#define SDL_MCRC_PATTERN_COUNT_MAX          (0x000FFFFFU)

#define SDL_MCRC_SECTOR_COUNT_MAX           (0x0000FFFFU)

#define SDL_MCRC_BCTOPLD_MAX                (0x00FFFFFFU)

#define SDL_MCRC_WDTOPLD_MAX                (0x00FFFFFFU)

#define SDL_MCRC_MAX_NUM_OF_CHANNELS        (4U)

typedef uint32_t SDL_MCRC_ModeType;

#define SDL_MCRC_OPERATION_MODE_DATA        (SDL_MCRC_CTRL2_CH1_MODE_DATA)

#define SDL_MCRC_OPERATION_MODE_AUTO        (SDL_MCRC_CTRL2_CH1_MODE_AUTO)

#define SDL_MCRC_OPERATION_MODE_SEMICPU     (SDL_MCRC_CTRL2_CH1_MODE_SEMICPU)

#define SDL_MCRC_OPERATION_MODE_FULLCPU     (SDL_MCRC_CTRL2_CH1_MODE_FULLCPU)

/* @} */

typedef uint32_t SDL_MCRC_channel_t;
#define SDL_MCRC_CHANNEL_1                  (0x1U)

#define SDL_MCRC_CHANNEL_2                  (0x2U)

#define SDL_MCRC_CHANNEL_3                  (0x3U)

#define SDL_MCRC_CHANNEL_4                  (0x4U)

/* @} */

typedef enum {
   NAVSS0_MCRC_0 = 1,
   MCRC_MCU_NAVSS = 2,
   SDL_MCRC_INVALID = 0xffff,
} SDL_MCRC_InstType;

typedef enum {
    SDL_MCRC_DATA_8_BIT = 1,
    SDL_MCRC_DATA_16_BIT = 2,
    SDL_MCRC_DATA_32_BIT = 3,
} SDL_MCRC_dataBitSize;

/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */

typedef struct SDL_MCRC_Signature
{
    uint32_t regL;
    uint32_t regH;
}SDL_MCRC_Signature_t;

typedef struct SDL_MCRC_SigantureRegAddr
{
    uint32_t regL;
    uint32_t regH;
}SDL_MCRC_SignatureRegAddr_t;

typedef struct {
    volatile uint32_t PCOUNT;
    volatile uint32_t SCOUNT;
    volatile uint32_t WDTOPLD;
    volatile uint32_t BCTOPLD;
} SDL_MCRC_ChannelStaticRegs;

typedef struct {
    SDL_MCRC_ChannelStaticRegs channelRegs[SDL_MCRC_MAX_NUM_OF_CHANNELS];
    volatile uint32_t CTRL0;
    volatile uint32_t CTRL1;
    volatile uint32_t BUS_SEL;
} SDL_MCRC_StaticRegs_t;

typedef struct SDL_MCRC_dataConfig
{
    uint32_t *pMCRCData;
    uint32_t size;
    SDL_MCRC_dataBitSize dataBitSize;
}SDL_MCRC_dataConfig_t;

/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
int32_t SDL_MCRC_init(SDL_MCRC_InstType     instance,
                            SDL_MCRC_channel_t channel,
                            uint32_t     watchdogPreload,
                            uint32_t     blockPreload);

int32_t SDL_MCRC_verifyInit(SDL_MCRC_InstType     instance,
                            SDL_MCRC_channel_t channel,
                            uint32_t     watchdogPreload,
                            uint32_t   blockPreload);

int32_t SDL_MCRC_config(SDL_MCRC_InstType     instance,
                     SDL_MCRC_channel_t       channel,
                     uint32_t                 patternCount,
                     uint32_t                 sectorCount,
                     SDL_MCRC_ModeType mode);

int32_t SDL_MCRC_verifyConfig(SDL_MCRC_InstType     instance,
                           SDL_MCRC_channel_t       channel,
                           uint32_t           patternCount,
                           uint32_t           sectorCount,
                           SDL_MCRC_ModeType mode);

int32_t SDL_MCRC_channelReset(SDL_MCRC_InstType     instance,
                        SDL_MCRC_channel_t channel);

int32_t SDL_MCRC_setPSASeedSig(SDL_MCRC_InstType     instance,
                         SDL_MCRC_channel_t          channel,
                         const SDL_MCRC_Signature_t *pSeedSign);

int32_t SDL_MCRC_getPSASectorSig(SDL_MCRC_InstType     instance,
                           SDL_MCRC_channel_t    channel,
                           SDL_MCRC_Signature_t *pSecSign);
int32_t SDL_MCRC_intrStatus(SDL_MCRC_InstType     instance,
                         SDL_MCRC_channel_t  channel,
                         uint32_t     *pIntrStatus);

int32_t SDL_MCRC_enableIntr(SDL_MCRC_InstType     instance,
                      SDL_MCRC_channel_t channel,
                      uint32_t     intrMask);

int32_t SDL_MCRC_disableIntr(SDL_MCRC_InstType     instance,
                       SDL_MCRC_channel_t channel,
                       uint32_t     intrMask);

int32_t SDL_MCRC_clearIntr(SDL_MCRC_InstType     instance,
                     SDL_MCRC_channel_t channel,
                     uint32_t     intrMask);

int32_t SDL_MCRC_isBusy(SDL_MCRC_InstType     instance,
                  SDL_MCRC_channel_t  channel,
                  uint32_t     *pBusyFlag);

int32_t SDL_MCRC_getCurSecNum(SDL_MCRC_InstType     instance,
                        SDL_MCRC_channel_t    channel,
                        uint32_t       *pCurSecNum);

int32_t SDL_MCRC_getPSASig(SDL_MCRC_InstType     instance,
                        SDL_MCRC_channel_t    channel,
                        SDL_MCRC_Signature_t *pPSAsig);

int32_t SDL_MCRC_readStaticReg (SDL_MCRC_InstType     instance,
                           SDL_MCRC_StaticRegs_t *pStaticRegs);

int32_t SDL_MCRC_getCurPSASig(SDL_MCRC_InstType     instance,
                        SDL_MCRC_channel_t    channel,
                        SDL_MCRC_Signature_t *pCurPSASig);
 int32_t SDL_MCRC_getPSASigRegAddr(SDL_MCRC_InstType instance, SDL_MCRC_channel_t channel,
                                   SDL_MCRC_SignatureRegAddr_t *pMCRCregAddr);

int32_t SDL_MCRC_computeSignCPUmode (SDL_MCRC_InstType instance,
                                     SDL_MCRC_channel_t channel,
                                     const SDL_MCRC_dataConfig_t *pDataConfig,
                                     SDL_MCRC_Signature_t *sectSignVal);

#ifdef _cplusplus
}

#endif /*extern "C" */

#endif