mcu/service/sst/include/SST_mem_utility.h

/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2015
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE. 
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/

/*****************************************************************************
 *
 * Filename:
 * ---------
 *   SST_mem_utility.h
 *
 * Project:
 * --------
 *   Maui_Software
 *
 * Description:
 * ------------
 *   
 *
 * Author:
 * -------
 * -------
 *
 *============================================================================
 *             HISTORY
 * Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *------------------------------------------------------------------------------
 *
 *------------------------------------------------------------------------------
 * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *============================================================================
 ****************************************************************************/

#ifndef _SST_MEM_UTILITY_H
#define _SST_MEM_UTILITY_H

/*******************************************************************************
 * Included header files
 *******************************************************************************/
#include "kal_general_types.h"
/*******************************************************************************
 * Constant Definition
 *******************************************************************************/

/*******************************************************************************
 * Macro definition
 *******************************************************************************/



#define L1_NBR_OF_WORDS_IN_LINE 8
struct l1_icache_line {
    kal_uint32 address;
    kal_uint32 line[L1_NBR_OF_WORDS_IN_LINE];
};

#define L2_NBR_OF_WORDS_IN_LINE 16
struct l2_cache_line {
    kal_uint32 address;
    kal_uint32 line[L2_NBR_OF_WORDS_IN_LINE];
};

extern kal_uint32 get_program_counter(void);
extern kal_bool read_instruction(kal_uint32 addr, kal_uint32 *instruction);

extern void SST_GetSysStackInfo(kal_uint32 * const base, kal_uint32 * const end,
                         kal_uint32 core, kal_uint32 tc);

extern void SST_GetCurrentSysStackInfo(kal_uint32 * const base, kal_uint32 * const end);
extern void SST_GetTaskStackInfo(kal_uint32 task_index, kal_uint32 * const base, kal_uint32 * const end);
extern void SST_GetTaskStackPointer(kal_uint32 task_index, kal_uint32 * const pointer);
extern void SST_GetHisrStackInfo(kal_uint32 hisr_index, kal_uint32 * const base, kal_uint32 * const end);
extern void SST_GetCurrentStackInfo(kal_uint32 * const base, kal_uint32 * const end);
extern kal_bool SST_CheckIfSP(kal_uint32 mem_ptr);

#endif /* _SST_MEM_UTILITY_H */