hal_cache.h

/* Copyright Statement:
 *
 * (C) 2005-2017 MediaTek Inc. All rights reserved.
 *
 * This software/firmware and related documentation ("MediaTek Software") are
 * protected under relevant copyright laws. The information contained herein
 * is confidential and proprietary to MediaTek Inc. ("MediaTek") and/or its licensors.
 * Without the prior written permission of MediaTek and/or its licensors,
 * any reproduction, modification, use or disclosure of MediaTek Software,
 * and information contained herein, in whole or in part, shall be strictly prohibited.
 * You may only use, reproduce, modify, or distribute (as applicable) MediaTek Software
 * if you have agreed to and been bound by the applicable license agreement with
 * MediaTek ("License Agreement") and been granted explicit permission to do so within
 * the License Agreement ("Permitted User"). If you are not a Permitted User,
 * please cease any access or use of MediaTek Software immediately.
 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 * THAT MEDIATEK SOFTWARE RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES
 * ARE PROVIDED TO RECEIVER 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 MEDIATEK SOFTWARE, AND RECEIVER AGREES TO LOOK ONLY TO SUCH
 * THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. RECEIVER EXPRESSLY ACKNOWLEDGES
 * THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES
 * CONTAINED IN MEDIATEK SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK
 * SOFTWARE RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND
 * CUMULATIVE LIABILITY WITH RESPECT TO MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
 * AT MEDIATEK'S OPTION, TO REVISE OR REPLACE MEDIATEK SOFTWARE AT ISSUE,
 * OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY RECEIVER TO
 * MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
 */

#ifndef __HAL_CACHE_H__
#define __HAL_CACHE_H__
#include "hal_platform.h"

#ifdef HAL_CACHE_MODULE_ENABLED

#ifdef __cplusplus
extern "C" {
#endif

/*****************************************************************************
 * Enums
 *****************************************************************************/

typedef enum {
    HAL_CACHE_STATUS_INVALID_PARAMETER = -7,    
    HAL_CACHE_STATUS_ERROR_BUSY = -6,           
    HAL_CACHE_STATUS_ERROR_CACHE_SIZE = -5,     
    HAL_CACHE_STATUS_ERROR_REGION = -4,         
    HAL_CACHE_STATUS_ERROR_REGION_ADDRESS = -3, 
    HAL_CACHE_STATUS_ERROR_REGION_SIZE = -2,    
    HAL_CACHE_STATUS_ERROR = -1,                
    HAL_CACHE_STATUS_OK = 0                     
} hal_cache_status_t;


typedef enum {
    HAL_CACHE_SIZE_0KB = 0,                     
    HAL_CACHE_SIZE_8KB = 1,                     
    HAL_CACHE_SIZE_16KB = 2,                    
    HAL_CACHE_SIZE_32KB = 3,                    
    HAL_CACHE_SIZE_MAX                          
} hal_cache_size_t;


typedef enum {
    HAL_CACHE_REGION_0 = 0,                     
    HAL_CACHE_REGION_1 = 1,                     
    HAL_CACHE_REGION_2 = 2,                     
    HAL_CACHE_REGION_3 = 3,                     
    HAL_CACHE_REGION_4 = 4,                     
    HAL_CACHE_REGION_5 = 5,                     
    HAL_CACHE_REGION_6 = 6,                     
    HAL_CACHE_REGION_7 = 7,                     
    HAL_CACHE_REGION_8 = 8,                     
    HAL_CACHE_REGION_9 = 9,                     
    HAL_CACHE_REGION_10 = 10,                   
    HAL_CACHE_REGION_11 = 11,                   
    HAL_CACHE_REGION_12 = 12,                   
    HAL_CACHE_REGION_13 = 13,                   
    HAL_CACHE_REGION_14 = 14,                   
    HAL_CACHE_REGION_15 = 15,                   
    HAL_CACHE_REGION_MAX                        
} hal_cache_region_t;

/*****************************************************************************
 * Structures
 *****************************************************************************/

typedef struct {
    uint32_t cache_region_address;              
    uint32_t cache_region_size;                 
} hal_cache_region_config_t;

/*****************************************************************************
 * Functions
 *****************************************************************************/

hal_cache_status_t hal_cache_init(void);


hal_cache_status_t hal_cache_deinit(void);


hal_cache_status_t hal_cache_enable(void);


hal_cache_status_t hal_cache_disable(void);


hal_cache_status_t hal_cache_region_enable(hal_cache_region_t region);


hal_cache_status_t hal_cache_region_disable(hal_cache_region_t region);


hal_cache_status_t hal_cache_set_size(hal_cache_size_t cache_size);

hal_cache_status_t hal_cache_region_config(hal_cache_region_t region, const hal_cache_region_config_t *region_config);

hal_cache_status_t hal_cache_invalidate_one_cache_line(uint32_t address);

hal_cache_status_t hal_cache_invalidate_multiple_cache_lines(uint32_t address, uint32_t length);


hal_cache_status_t hal_cache_invalidate_all_cache_lines(void);

hal_cache_status_t hal_cache_flush_one_cache_line(uint32_t address);

hal_cache_status_t hal_cache_flush_multiple_cache_lines(uint32_t address, uint32_t length);


hal_cache_status_t hal_cache_flush_all_cache_lines(void);


bool hal_cache_is_cacheable(uint32_t address);


#define HAL_CACHE_LINE_SIZE         (32)


#ifdef HAL_CACHE_WITH_REMAP_FEATURE

#define HAL_CACHE_VIRTUAL_TO_PHYSICAL(address) (address & (~VRAM_BASE))


#define HAL_CACHE_PHYSICAL_TO_VIRTUAL(address) (address | VRAM_BASE)
#endif


#ifdef __cplusplus
}
#endif

#endif /*HAL_CACHE_MODULE_ENABLED*/
#endif /* __HAL_CACHE_H__ */