sdl_ecc_priv.h

Go to the documentation of this file.

/*
 * SDL ECC
 *
 * Software Diagnostics Library module for ECC
 *
 *  Copyright (c) Texas Instruments Incorporated 2023
 *
 *  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 INCLUDE_SDL_ECC_PRIV_H_
#define INCLUDE_SDL_ECC_PRIV_H_
 
#include <stdbool.h>
 
#define SDL_ECC_EVENT_FOUND (1u)
 
#define SDL_ECC_RAMID_INVALID      (0xffffffffu)
#define SDL_ECC_INJECTTYPE_INVALID (0xffffffffu)
#define SDL_ECC_TYPE_INVALID       (0xffffffffu)
 
typedef struct SDL_GrpChkConfig_s
{
    uint32_t grpChkType;
    uint32_t dataWidth;
}  SDL_GrpChkConfig_t;
 
typedef struct SDL_RAMIdEntry_s
{
    uint32_t RAMId;
    uint32_t aggregatorTypeInjectOnly;
    uint32_t ramIdType;
    uint32_t numCheckers;
    const SDL_GrpChkConfig_t *grpChkConfig;
} SDL_RAMIdEntry_t;
 
typedef struct SDL_MemConfig_s
{
    SDL_ECC_MemSubType memSubType;
    uintptr_t memStartAddr;
    uint32_t size;
    uint32_t stride;
    uint32_t rowSize;
    bool readable;
}  SDL_MemConfig_t;
 
typedef struct SDL_EccAggrEntry_s
{
    uint32_t numRams;
    const SDL_RAMIdEntry_t *ramTable;
    uint32_t numMemEntries;
    const SDL_MemConfig_t *memConfigTable;
    uint32_t esmInst;
    uint32_t esmIntSEC;
    uint32_t esmIntDED;
} SDL_EccAggrEntry_t;
 
#endif /* INCLUDE_SDL_ECC_PRIV_H_ */