hal_mpu.h

/* Copyright Statement:
 *
 * (C) 2005-2016  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_MPU_H__
#define __HAL_MPU_H__
#include "hal_platform.h"

#ifdef HAL_MPU_MODULE_ENABLED

#ifdef __cplusplus
extern "C" {
#endif


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

typedef enum {
    HAL_MPU_STATUS_INVALID_PARAMETER = -6,      
    HAL_MPU_STATUS_ERROR_BUSY = -5,             
    HAL_MPU_STATUS_ERROR_REGION = -4,           
    HAL_MPU_STATUS_ERROR_REGION_ADDRESS = -3,   
    HAL_MPU_STATUS_ERROR_REGION_SIZE = -2,      
    HAL_MPU_STATUS_ERROR = -1,                  
    HAL_MPU_STATUS_OK = 0                       
} hal_mpu_status_t;

typedef enum {
    HAL_MPU_REGION_0 = 0,                       
    HAL_MPU_REGION_1 = 1,                       
    HAL_MPU_REGION_2 = 2,                       
    HAL_MPU_REGION_3 = 3,                       
    HAL_MPU_REGION_4 = 4,                       
    HAL_MPU_REGION_5 = 5,                       
    HAL_MPU_REGION_6 = 6,                       
    HAL_MPU_REGION_7 = 7,                       
    HAL_MPU_REGION_MAX                          
} hal_mpu_region_t;

typedef enum {
    HAL_MPU_REGION_SIZE_MIN = 3,                
    HAL_MPU_REGION_SIZE_32B = 4,                
    HAL_MPU_REGION_SIZE_64B = 5,                
    HAL_MPU_REGION_SIZE_128B = 6,               
    HAL_MPU_REGION_SIZE_256B = 7,               
    HAL_MPU_REGION_SIZE_512B = 8,               
    HAL_MPU_REGION_SIZE_1KB = 9,                
    HAL_MPU_REGION_SIZE_2KB = 10,               
    HAL_MPU_REGION_SIZE_4KB = 11,               
    HAL_MPU_REGION_SIZE_8KB = 12,               
    HAL_MPU_REGION_SIZE_16KB = 13,              
    HAL_MPU_REGION_SIZE_32KB = 14,              
    HAL_MPU_REGION_SIZE_64KB = 15,              
    HAL_MPU_REGION_SIZE_128KB = 16,             
    HAL_MPU_REGION_SIZE_256KB = 17,             
    HAL_MPU_REGION_SIZE_512KB = 18,             
    HAL_MPU_REGION_SIZE_1MB = 19,               
    HAL_MPU_REGION_SIZE_2MB = 20,               
    HAL_MPU_REGION_SIZE_4MB = 21,               
    HAL_MPU_REGION_SIZE_8MB = 22,               
    HAL_MPU_REGION_SIZE_16MB = 23,              
    HAL_MPU_REGION_SIZE_32MB = 24,              
    HAL_MPU_REGION_SIZE_64MB = 25,              
    HAL_MPU_REGION_SIZE_128MB = 26,             
    HAL_MPU_REGION_SIZE_256MB = 27,             
    HAL_MPU_REGION_SIZE_512MB = 28,             
    HAL_MPU_REGION_SIZE_1GB = 29,               
    HAL_MPU_REGION_SIZE_2GB = 30,               
    HAL_MPU_REGION_SIZE_4GB = 31,               
    HAL_MPU_REGION_SIZE_MAX                     
} hal_mpu_region_size_t;

typedef enum {
    HAL_MPU_NO_ACCESS = 0,                      
    HAL_MPU_PRIVILEGED_ACCESS_ONLY = 1,         
    HAL_MPU_PRIVILEGED_READ_WRITE_UNPRIVILEGED_READ_ONLY = 2,  
    HAL_MPU_FULL_ACCESS = 3,                    
    HAL_MPU_UNPREDICTABLE = 4,                  
    HAL_MPU_PRIVILEGED_READ_ONLY = 5,           
    HAL_MPU_READONLY = 6                        
} hal_mpu_access_permission_t;

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

typedef struct {
    bool privdefena;                          
    bool hfnmiena;                            
} hal_mpu_config_t;

typedef struct {
    uint32_t mpu_region_address;                
    hal_mpu_region_size_t mpu_region_size;      
    hal_mpu_access_permission_t mpu_region_access_permission; 
    uint8_t mpu_subregion_mask;                 
    bool mpu_xn;                                
} hal_mpu_region_config_t;

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

hal_mpu_status_t hal_mpu_init(const hal_mpu_config_t *mpu_config);

hal_mpu_status_t hal_mpu_deinit(void);

hal_mpu_status_t hal_mpu_enable(void);

hal_mpu_status_t hal_mpu_disable(void);

hal_mpu_status_t hal_mpu_region_enable(hal_mpu_region_t region);

hal_mpu_status_t hal_mpu_region_disable(hal_mpu_region_t region);

hal_mpu_status_t hal_mpu_region_configure(hal_mpu_region_t region, const hal_mpu_region_config_t *region_config);

#ifdef __cplusplus
}
#endif

#endif /* HAL_MPU_MODULE_ENABLED */
#endif /* __HAL_MPU_H__ */