pbist/V0/sdl_ip_pbist.h

Go to the documentation of this file.

/********************************************************************
 * Copyright (C) 2019-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 SDL_IP_PBIST_H_
#define SDL_IP_PBIST_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdbool.h>
#include <src/ip/sdlr_pbist.h>

typedef struct
{
    uint32_t override;

    uint32_t algorithmsBitMap;

    uint64_t memoryGroupsBitMap;

    uint64_t scrambleValue;
} SDL_PBIST_config;

typedef struct
{
    uint32_t CA0;

    uint32_t CA1;

    uint32_t CA2;

    uint32_t CA3;

    uint32_t CL0;

    uint32_t CL1;

    uint32_t CL2;

    uint32_t CL3;

    uint32_t CMS;

    uint32_t CSR;

    uint32_t I0;

    uint32_t I1;

    uint32_t I2;

    uint32_t I3;

    uint32_t RAMT;
} SDL_PBIST_configNeg;

typedef struct 
{
    uint32_t D;

    uint32_t E;

    uint32_t CA2;

    uint32_t CL0;

    uint32_t CA3;

    uint32_t I0;

    uint32_t CL1;

    uint32_t I3;

    uint32_t I2;

    uint32_t CL2;

    uint32_t CA1;

    uint32_t CA0;

    uint32_t CL3;

    uint32_t I1;

    uint32_t RAMT;

    uint32_t CSR;

    uint32_t CMS;
    
} SDL_PBIST_romTest;


int32_t SDL_PBIST_softReset(SDL_pbistRegs *pPBISTRegs);

int32_t SDL_PBIST_start(SDL_pbistRegs *pPBISTRegs,
                        const SDL_PBIST_config * pConfig);

int32_t SDL_PBIST_startNeg(SDL_pbistRegs *pPBISTRegs,
                           const SDL_PBIST_configNeg *pConfig);

int32_t SDL_PBIST_startROMTest(SDL_pbistRegs *pPBISTRegs,
                                const SDL_PBIST_romTest * const pConfig);

int32_t SDL_PBIST_checkResult (const SDL_pbistRegs *pPBISTRegs, bool *pResult);

int32_t SDL_PBIST_releaseTestMode(SDL_pbistRegs *pPBISTRegs);

#ifdef __cplusplus
}
#endif

#endif /* SDL_IP_PBIST_H_ */