AM263Px MCU+ SDK: sdl_ip_pbist.h Source File

| AM263Px MCU+ SDK 26.00.00 |

sdl_ip_pbist.h
Go to the documentation of this file.
1 /********************************************************************
2 * Copyright (C) 2022-2023 Texas Instruments Incorporated.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the
14 * distribution.
15 *
16 * Neither the name of Texas Instruments Incorporated nor the names of
17 * its contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 */
33
41 /*
42 * @file sdl/pbist/v0/sdl_ip_pbist.h
43 *
44 * @brief This file contains the SDL-FL API's for PBIST
45 *
46 * This is the SDL-FL API documentation for the Programmable Built-In Self Test
47 * (PBIST) module.
48 *
49 *
50 *
51 */
52
53 #ifndef SDL_IP_PBIST_H_
54 #define SDL_IP_PBIST_H_
55
56 #ifdef __cplusplus
57 extern "C" {
58 #endif
59
60 #include <stdint.h>
61 #include <stdbool.h>
62 #include <sdl/pbist/v0/sdlr_pbist.h>
63 #include <sdl/pbist/v0/soc/sdl_soc_pbist.h>
64 #define PBIST_MAX_NUM_RUNS 45U
65
73 typedef struct
74 {
77 uint32_t override;
78
84 uint32_t algorithmsBitMap;
85
88 uint64_t memoryGroupsBitMap;
89
92 uint64_t scrambleValue;
93 } SDL_PBIST_config;
94
104 typedef struct
105 {
108 uint32_t CA0;
109
112 uint32_t CA1;
113
116 uint32_t CA2;
117
120 uint32_t CA3;
121
124 uint32_t CL0;
125
128 uint32_t CL1;
129
132 uint32_t CL2;
133
136 uint32_t CL3;
137
140 uint32_t CMS;
141
144 uint32_t CSR;
145
148 uint32_t I0;
149
152 uint32_t I1;
153
156 uint32_t I2;
157
160 uint32_t I3;
161
164 uint32_t RAMT;
165 } SDL_PBIST_configNeg;
166
180 int32_t SDL_PBIST_softReset(SDL_pbistRegs *pPBISTRegs);
181
195 int32_t SDL_PBIST_start(SDL_pbistRegs *pPBISTRegs,
196 const SDL_PBIST_config * pConfig);
197
211 int32_t SDL_PBIST_startNeg(SDL_pbistRegs *pPBISTRegs,
212 const SDL_PBIST_configNeg *pConfig);
213
227 int32_t SDL_PBIST_checkResult (const SDL_pbistRegs *pPBISTRegs, bool *pResult);
228
242 int32_t SDL_PBIST_releaseTestMode(SDL_pbistRegs *pPBISTRegs);
243
252 int32_t SDL_PBIST_Instance (SDL_PBIST_inst instance);
255 typedef struct
256 {
257 uint64_t PBISTRegsHiAddress;
258 SDL_pbistRegs *pPBISTRegs;
259 uint32_t numPBISTRuns;
260 SDL_PBIST_config PBISTConfigRun[PBIST_MAX_NUM_RUNS];
261 uint32_t interruptNumber;
262 uint32_t esmEventNumber;
263 volatile uint32_t doneFlag;
264 SDL_PBIST_configNeg PBISTNegConfigRun;
265 uint8_t failureDetected;
266 } SDL_pbistInstInfo;
267
268 #ifdef __cplusplus
269 }
270 #endif
271
272 #endif /* SDL_IP_PBIST_H_ */
SDL_pbistInstInfo::failureDetected
uint8_t failureDetected
Definition: sdl_ip_pbist.h:265
SDL_PBIST_configNeg::RAMT
uint32_t RAMT
Definition: sdl_ip_pbist.h:164
SDL_pbistRegs
Definition: sdlr_pbist.h:53
SDL_pbistInstInfo::doneFlag
volatile uint32_t doneFlag
Definition: sdl_ip_pbist.h:263
SDL_PBIST_configNeg::I0
uint32_t I0
Definition: sdl_ip_pbist.h:148
sdlr_pbist.h
SDL_PBIST_checkResult
int32_t SDL_PBIST_checkResult(const SDL_pbistRegs *pPBISTRegs, bool *pResult)
PBIST check result.
SDL_PBIST_Instance
int32_t SDL_PBIST_Instance(SDL_PBIST_inst instance)
PBIST Instance.
SDL_PBIST_configNeg::I1
uint32_t I1
Definition: sdl_ip_pbist.h:152
SDL_PBIST_config::scrambleValue
uint64_t scrambleValue
Definition: sdl_ip_pbist.h:92
SDL_PBIST_configNeg::I2
uint32_t I2
Definition: sdl_ip_pbist.h:156
SDL_PBIST_configNeg::CMS
uint32_t CMS
Definition: sdl_ip_pbist.h:140
SDL_pbistInstInfo::PBISTNegConfigRun
SDL_PBIST_configNeg PBISTNegConfigRun
Definition: sdl_ip_pbist.h:264
SDL_PBIST_config::memoryGroupsBitMap
uint64_t memoryGroupsBitMap
Definition: sdl_ip_pbist.h:88
SDL_PBIST_releaseTestMode
int32_t SDL_PBIST_releaseTestMode(SDL_pbistRegs *pPBISTRegs)
PBIST Release Test mode.
SDL_PBIST_configNeg::CSR
uint32_t CSR
Definition: sdl_ip_pbist.h:144
SDL_PBIST_config
This structure contains the different configuration used for PBIST.
Definition: sdl_ip_pbist.h:74
SDL_PBIST_configNeg::CL3
uint32_t CL3
Definition: sdl_ip_pbist.h:136
SDL_PBIST_configNeg::CA2
uint32_t CA2
Definition: sdl_ip_pbist.h:116
SDL_pbistInstInfo::pPBISTRegs
SDL_pbistRegs * pPBISTRegs
Definition: sdl_ip_pbist.h:258
sdl_soc_pbist.h
This file contains the SoC-specific SDL PBIST API's and definitions.
SDL_PBIST_configNeg::CA1
uint32_t CA1
Definition: sdl_ip_pbist.h:112
SDL_PBIST_configNeg::CL0
uint32_t CL0
Definition: sdl_ip_pbist.h:124
SDL_PBIST_configNeg::CA0
uint32_t CA0
Definition: sdl_ip_pbist.h:108
SDL_PBIST_start
int32_t SDL_PBIST_start(SDL_pbistRegs *pPBISTRegs, const SDL_PBIST_config *pConfig)
PBIST Start.
SDL_PBIST_configNeg::CL2
uint32_t CL2
Definition: sdl_ip_pbist.h:132
SDL_pbistInstInfo
Definition: sdl_ip_pbist.h:256
SDL_pbistInstInfo::esmEventNumber
uint32_t esmEventNumber
Definition: sdl_ip_pbist.h:262
SDL_pbistInstInfo::interruptNumber
uint32_t interruptNumber
Definition: sdl_ip_pbist.h:261
SDL_PBIST_config::algorithmsBitMap
uint32_t algorithmsBitMap
Definition: sdl_ip_pbist.h:84
SDL_PBIST_softReset
int32_t SDL_PBIST_softReset(SDL_pbistRegs *pPBISTRegs)
PBIST Soft reset.
SDL_PBIST_configNeg::CA3
uint32_t CA3
Definition: sdl_ip_pbist.h:120
SDL_pbistInstInfo::PBISTRegsHiAddress
uint64_t PBISTRegsHiAddress
Definition: sdl_ip_pbist.h:257
SDL_PBIST_configNeg::CL1
uint32_t CL1
Definition: sdl_ip_pbist.h:128
SDL_PBIST_configNeg
This structure contains the different configuration used for PBIST for the failure insertion test to ...
Definition: sdl_ip_pbist.h:105
SDL_PBIST_configNeg::I3
uint32_t I3
Definition: sdl_ip_pbist.h:160
SDL_PBIST_inst
SDL_PBIST_inst
PBIST instance.
Definition: sdl_pbist_soc.h:94
SDL_PBIST_startNeg
int32_t SDL_PBIST_startNeg(SDL_pbistRegs *pPBISTRegs, const SDL_PBIST_configNeg *pConfig)
PBIST Failure Insertion Test Start.
SDL_pbistInstInfo::numPBISTRuns
uint32_t numPBISTRuns
Definition: sdl_ip_pbist.h:259
PBIST_MAX_NUM_RUNS
#define PBIST_MAX_NUM_RUNS
Definition: sdl_ip_pbist.h:64