sdl_ccm.h

Go to the documentation of this file.

/*
 * SDL CCM
 *
 * Software Diagnostics Library module for CCM module
 *
 *  Copyright (c) Texas Instruments Incorporated 2019-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 INCLUDE_SDL_CCM_H_
#define INCLUDE_SDL_CCM_H_

#include <src/sdl/sdl_types.h>
#include <src/sdl/tistdtypes.h>
#include <soc.h>

#if defined (SOC_J721E)
#include <src/sdl/r5/j721e/sdl_soc_ccm.h>
#endif

#if defined (SOC_J7200)
#include <src/sdl/r5/j7200/sdl_soc_ccm.h>
#endif

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    SDL_CCM_MONITOR_TYPE_NONE = 0,
    SDL_CCM_MONITOR_TYPE_OUTPUT_COMPARE_BLOCK = 1,
    SDL_CCM_MONITOR_TYPE_VIM = 2,
    SDL_CCM_MONITOR_TYPE_INACTIVITY_MONITOR = 3,
    SDL_CCM_MONITOR_TYPE_INVALID = 4,
} SDL_CCM_MonitorType;

typedef enum {
    SDL_CCM_SELFTEST_TYPE_NORMAL = 1,
    SDL_CCM_SELFTEST_TYPE_ERROR_FORCING = 2,
    SDL_CCM_SELFTEST_POLARITY_INVERSION = 3,
    SDL_CCM_SELFTEST_TYPE_INVALID = 4,
} SDL_CCM_SelfTestType;

/* @} */

typedef struct {
    volatile uint32_t CCMKEYR1;          /* MKEY1 value */
    volatile uint32_t CCMKEYR2;          /* MKEY2 value */
    volatile uint32_t CCMKEYR3;          /* MKEY3 value */
    volatile uint32_t CCMPOLCNTRL;       /* POL_INV value */
} SDL_CCM_staticRegs;

typedef struct SDL_CCM_ErrorStatus_s
{
    bool compareErrorFlag;
    bool selfTestErrorFlag;
    bool selfTestErrorTypeFlag;
} SDL_CCM_ErrorStatus_t;

/* @} */

int32_t SDL_CCM_init(SDL_CCM_Inst instance);

 int32_t SDL_CCM_verifyConfig(SDL_CCM_Inst instance);
 
 int32_t SDL_CCM_selfTest(SDL_CCM_Inst instance, SDL_CCM_MonitorType monitorType, SDL_CCM_SelfTestType testType, \
                            uint32_t polarityInversionMask, uint32_t timeoutCnt);
 
 int32_t SDL_CCM_injectError(SDL_CCM_Inst instance, SDL_CCM_MonitorType monitorType);
 
 int32_t SDL_CCM_getStaticRegisters(SDL_CCM_Inst instance, SDL_CCM_staticRegs *pStaticRegs);
 
 int32_t SDL_CCM_getErrorType(SDL_CCM_Inst instance, uint32_t intSrc, SDL_CCM_MonitorType *monitorType);
 
 int32_t SDL_CCM_clearError(SDL_CCM_Inst instance, SDL_CCM_MonitorType monitorType);

/* @} */

#ifdef __cplusplus
}
#endif  /* extern "C" */

#endif /* INCLUDE_SDL_CCM_H_ */