sdl_ip_mcrc.h

Go to the documentation of this file.

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

#include <stddef.h>
#include <stdbool.h>
#include <sdl_mcrc.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Define SDL_TRUE/SDL_FALSE to go with uint32_t */
#ifndef SDL_TRUE
#define SDL_TRUE    (1U)
#endif

typedef uint32_t SDL_MCRC_IntrPriority_t;

#define SDL_MCRC_INTR_PRIORITY_CH1_FAIL                (0x1U)

#define SDL_MCRC_INTR_PRIORITY_CH2_FAIL                (0x2U)

#define SDL_MCRC_INTR_PRIORITY_CH3_FAIL                (0x3U)

#define SDL_MCRC_INTR_PRIORITY_CH4_FAIL                (0x4U)

#define SDL_MCRC_INTR_PRIORITY_CH1_COMPRESSION_DONE    (0x9U)

#define SDL_MCRC_INTR_PRIORITY_CH2_COMPRESSION_DONE    (0xaU)

#define SDL_MCRC_INTR_PRIORITY_CH3_COMPRESSION_DONE    (0xbU)

#define SDL_MCRC_INTR_PRIORITY_CH4_COMPRESSION_DONE    (0xcU)

#define SDL_MCRC_INTR_PRIORITY_CH1_OVERRUN             (0x11U)

#define SDL_MCRC_INTR_PRIORITY_CH2_OVERRUN             (0x12U)

#define SDL_MCRC_INTR_PRIORITY_CH3_OVERRUN             (0x13U)

#define SDL_MCRC_INTR_PRIORITY_CH4_OVERRUN             (0x14U)

#define SDL_MCRC_INTR_PRIORITY_CH1_UNDERRUN            (0x19U)

#define SDL_MCRC_INTR_PRIORITY_CH2_UNDERRUN            (0x1aU)

#define SDL_MCRC_INTR_PRIORITY_CH3_UNDERRUN            (0x1bU)

#define SDL_MCRC_INTR_PRIORITY_CH4_UNDERRUN            (0x1cU)

#define SDL_MCRC_INTR_PRIORITY_CH1_TIMEOUT             (0x21U)

#define SDL_MCRC_INTR_PRIORITY_CH2_TIMEOUT             (0x22U)

#define SDL_MCRC_INTR_PRIORITY_CH3_TIMEOUT             (0x23U)

#define SDL_MCRC_INTR_PRIORITY_CH4_TIMEOUT             (0x24U)

/* @} */

typedef uint32_t SDL_MCRC_DataBusMask_t;

#define SDL_MCRC_DATA_BUS_ITCM_MASK     (SDL_MCRC_MCRC_BUS_SEL_ITC_MEN_MASK)

#define SDL_MCRC_DATA_BUS_DTCM_MASK     (SDL_MCRC_MCRC_BUS_SEL_DTC_MEN_MASK)

#define SDL_MCRC_DATA_BUS_VBUSM_MASK    (SDL_MCRC_MCRC_BUS_SEL_MEN_MASK)

#define SDL_MCRC_DATA_BUS_MASK_ALL      (SDL_MCRC_MCRC_BUS_SEL_ITC_MEN_MASK | \
                                    SDL_MCRC_MCRC_BUS_SEL_DTC_MEN_MASK | \
                                    SDL_MCRC_MCRC_BUS_SEL_MEN_MASK)

/* @} */

/* @} */

/* ========================================================================== */
/*                         Function Declarations                              */
/* ========================================================================== */

int32_t SDL_MCRC_GetHighestPriorityIntrStatus(SDL_MCRC_InstType instance, uint32_t *pIntVecAddr);
int32_t SDL_MCRC_DataBusTracingCtrl(SDL_MCRC_InstType instance,
                              uint32_t         ctrlFlag,
                              SDL_MCRC_DataBusMask_t dataBusMask,
                              SDL_MCRC_DataBusMask_t busEnableMask);

int32_t SDL_MCRC_getBaseaddr(SDL_MCRC_InstType instance,
                            uint32_t *baseAddr);

int32_t SDL_MCRC_VerifyBusTracingCtrl(SDL_MCRC_InstType     instance,
                                uint32_t         ctrlFlag,
                                SDL_MCRC_DataBusMask_t dataBusMask,
                                SDL_MCRC_DataBusMask_t busEnableMask);
/* @} */

#ifdef __cplusplus
}
#endif
#endif /* SDL_IP_MCRC_H_ */