/*
 * Copyright (c) 2018-2020, Arm Limited and affiliates.
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef MBED_MPU_MGMT_H
#define MBED_MPU_MGMT_H

#include "hal/mpu_api.h"

#ifdef __cplusplus
extern "C" {
#endif

/** \addtogroup platform-public-api */
/** @{*/

/**
 * \defgroup platform_mpu_mgmt MPU management functions
 * @{
 */

#if (DEVICE_MPU && MBED_CONF_PLATFORM_USE_MPU) || defined(DOXYGEN_ONLY)

#define mbed_mpu_manager_init() mbed_mpu_init()

#define mbed_mpu_manager_deinit() mbed_mpu_free()

/** Lock ram execute never mode off
 *
 * This disables the MPU's execute never ram protection and allows
 * functions to run from RAM. Execution directly from ram will be
 * allowed if this function is invoked at least once (the internal
 * counter is non-zero).
 *
 * Use this locking mechanism for code which needs to execute from
 * ram such as flash programming algorithms and ram thunks.
 *
 * The lock is a counter, can be locked up to USHRT_MAX
 * This function is IRQ and thread safe
 */
void mbed_mpu_manager_lock_ram_execution(void);

/** Unlock ram execute never mode
 *
 * Use unlocking in pair with mbed_mpu_manager_lock_ram_execution().
 *
 * The lock is a counter, should be equally unlocked as locked
 * This function is IRQ and thread safe
 */
void mbed_mpu_manager_unlock_ram_execution(void);

/** Lock rom write never mode off
 *
 * This disables the MPU's read only ROM protection and allows
 * ROM to be written to. Writing to ROM will not result in an MPU
 * fault if this function is invoked at least once (the internal
 * counter is non-zero).
 *
 * Use this locking mechanism for code which needs to write to
 * ROM such as flash programming algorithms.
 *
 * The lock is a counter, can be locked up to USHRT_MAX
 * This function is IRQ and thread safe
 */
void mbed_mpu_manager_lock_rom_write(void);

/** Unlock rom write never mode
 *
 * Use unlocking in pair with mbed_mpu_manager_lock_rom_write().
 *
 * The lock is a counter, should be equally unlocked as locked
 * This function is IRQ and thread safe
 */
void mbed_mpu_manager_unlock_rom_write(void);

#else

#define mbed_mpu_manager_init() (void)0

#define mbed_mpu_manager_deinit() (void)0

#define mbed_mpu_manager_lock_ram_execution() (void)0

#define mbed_mpu_manager_unlock_ram_execution() (void)0

#define mbed_mpu_manager_lock_rom_write() (void)0

#define mbed_mpu_manager_unlock_rom_write() (void)0

#endif

#ifdef __cplusplus
}
#endif

#endif

/** @}*/
/** @}*/