mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

platform/mbed_mpu_mgmt.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 189:f392fc9709a3 1 /** \addtogroup platform */
AnnaBridge 189:f392fc9709a3 2 /** @{*/
AnnaBridge 189:f392fc9709a3 3 /**
AnnaBridge 189:f392fc9709a3 4 * \defgroup platform_mpu_mgmt MPU management functions
AnnaBridge 189:f392fc9709a3 5 * @{
AnnaBridge 189:f392fc9709a3 6 */
AnnaBridge 189:f392fc9709a3 7
AnnaBridge 189:f392fc9709a3 8 /* mbed Microcontroller Library
AnnaBridge 189:f392fc9709a3 9 * Copyright (c) 2006-2018 ARM Limited
AnnaBridge 189:f392fc9709a3 10 *
AnnaBridge 189:f392fc9709a3 11 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 189:f392fc9709a3 12 * you may not use this file except in compliance with the License.
AnnaBridge 189:f392fc9709a3 13 * You may obtain a copy of the License at
AnnaBridge 189:f392fc9709a3 14 *
AnnaBridge 189:f392fc9709a3 15 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 189:f392fc9709a3 16 *
AnnaBridge 189:f392fc9709a3 17 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 189:f392fc9709a3 18 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 189:f392fc9709a3 19 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 189:f392fc9709a3 20 * See the License for the specific language governing permissions and
AnnaBridge 189:f392fc9709a3 21 * limitations under the License.
AnnaBridge 189:f392fc9709a3 22 */
AnnaBridge 189:f392fc9709a3 23 #ifndef MBED_MPU_MGMT_H
AnnaBridge 189:f392fc9709a3 24 #define MBED_MPU_MGMT_H
AnnaBridge 189:f392fc9709a3 25
AnnaBridge 189:f392fc9709a3 26 #include "mbed_toolchain.h"
AnnaBridge 189:f392fc9709a3 27 #include "hal/mpu_api.h"
AnnaBridge 189:f392fc9709a3 28 #include <stdbool.h>
AnnaBridge 189:f392fc9709a3 29
AnnaBridge 189:f392fc9709a3 30 #ifdef __cplusplus
AnnaBridge 189:f392fc9709a3 31 extern "C" {
AnnaBridge 189:f392fc9709a3 32 #endif
AnnaBridge 189:f392fc9709a3 33
AnnaBridge 189:f392fc9709a3 34 #if (DEVICE_MPU && MBED_CONF_PLATFORM_USE_MPU) || defined(DOXYGEN_ONLY)
AnnaBridge 189:f392fc9709a3 35
AnnaBridge 189:f392fc9709a3 36 #define mbed_mpu_manager_init() mbed_mpu_init()
AnnaBridge 189:f392fc9709a3 37
AnnaBridge 189:f392fc9709a3 38 #define mbed_mpu_manager_deinit() mbed_mpu_free()
AnnaBridge 189:f392fc9709a3 39
AnnaBridge 189:f392fc9709a3 40 /** Lock ram execute never mode off
AnnaBridge 189:f392fc9709a3 41 *
AnnaBridge 189:f392fc9709a3 42 * This disables the MPU's execute never ram protection and allows
AnnaBridge 189:f392fc9709a3 43 * functions to run from RAM. Execution directly from ram will be
AnnaBridge 189:f392fc9709a3 44 * allowed if this function is invoked at least once (the internal
AnnaBridge 189:f392fc9709a3 45 * counter is non-zero).
AnnaBridge 189:f392fc9709a3 46 *
AnnaBridge 189:f392fc9709a3 47 * Use this locking mechanism for code which needs to execute from
AnnaBridge 189:f392fc9709a3 48 * ram such as flash programming algorithms and ram thunks.
AnnaBridge 189:f392fc9709a3 49 *
AnnaBridge 189:f392fc9709a3 50 * The lock is a counter, can be locked up to USHRT_MAX
AnnaBridge 189:f392fc9709a3 51 * This function is IRQ and thread safe
AnnaBridge 189:f392fc9709a3 52 */
AnnaBridge 189:f392fc9709a3 53 void mbed_mpu_manager_lock_ram_execution(void);
AnnaBridge 189:f392fc9709a3 54
AnnaBridge 189:f392fc9709a3 55 /** Unlock ram execute never mode
AnnaBridge 189:f392fc9709a3 56 *
AnnaBridge 189:f392fc9709a3 57 * Use unlocking in pair with mbed_mpu_manager_lock_ram_execution().
AnnaBridge 189:f392fc9709a3 58 *
AnnaBridge 189:f392fc9709a3 59 * The lock is a counter, should be equally unlocked as locked
AnnaBridge 189:f392fc9709a3 60 * This function is IRQ and thread safe
AnnaBridge 189:f392fc9709a3 61 */
AnnaBridge 189:f392fc9709a3 62 void mbed_mpu_manager_unlock_ram_execution(void);
AnnaBridge 189:f392fc9709a3 63
AnnaBridge 189:f392fc9709a3 64 /** Lock rom write never mode off
AnnaBridge 189:f392fc9709a3 65 *
AnnaBridge 189:f392fc9709a3 66 * This disables the MPU's read only ROM protection and allows
AnnaBridge 189:f392fc9709a3 67 * ROM to be written to. Writing to ROM will not result in an MPU
AnnaBridge 189:f392fc9709a3 68 * fault if this function is invoked at least once (the internal
AnnaBridge 189:f392fc9709a3 69 * counter is non-zero).
AnnaBridge 189:f392fc9709a3 70 *
AnnaBridge 189:f392fc9709a3 71 * Use this locking mechanism for code which needs to write to
AnnaBridge 189:f392fc9709a3 72 * ROM such as flash programming algorithms.
AnnaBridge 189:f392fc9709a3 73 *
AnnaBridge 189:f392fc9709a3 74 * The lock is a counter, can be locked up to USHRT_MAX
AnnaBridge 189:f392fc9709a3 75 * This function is IRQ and thread safe
AnnaBridge 189:f392fc9709a3 76 */
AnnaBridge 189:f392fc9709a3 77 void mbed_mpu_manager_lock_rom_write(void);
AnnaBridge 189:f392fc9709a3 78
AnnaBridge 189:f392fc9709a3 79 /** Unlock rom write never mode
AnnaBridge 189:f392fc9709a3 80 *
AnnaBridge 189:f392fc9709a3 81 * Use unlocking in pair with mbed_mpu_manager_lock_rom_write().
AnnaBridge 189:f392fc9709a3 82 *
AnnaBridge 189:f392fc9709a3 83 * The lock is a counter, should be equally unlocked as locked
AnnaBridge 189:f392fc9709a3 84 * This function is IRQ and thread safe
AnnaBridge 189:f392fc9709a3 85 */
AnnaBridge 189:f392fc9709a3 86 void mbed_mpu_manager_unlock_rom_write(void);
AnnaBridge 189:f392fc9709a3 87
AnnaBridge 189:f392fc9709a3 88 #else
AnnaBridge 189:f392fc9709a3 89
AnnaBridge 189:f392fc9709a3 90 #define mbed_mpu_manager_init() (void)0
AnnaBridge 189:f392fc9709a3 91
AnnaBridge 189:f392fc9709a3 92 #define mbed_mpu_manager_deinit() (void)0
AnnaBridge 189:f392fc9709a3 93
AnnaBridge 189:f392fc9709a3 94 #define mbed_mpu_manager_lock_ram_execution() (void)0
AnnaBridge 189:f392fc9709a3 95
AnnaBridge 189:f392fc9709a3 96 #define mbed_mpu_manager_unlock_ram_execution() (void)0
AnnaBridge 189:f392fc9709a3 97
AnnaBridge 189:f392fc9709a3 98 #define mbed_mpu_manager_lock_rom_write() (void)0
AnnaBridge 189:f392fc9709a3 99
AnnaBridge 189:f392fc9709a3 100 #define mbed_mpu_manager_unlock_rom_write() (void)0
AnnaBridge 189:f392fc9709a3 101
AnnaBridge 189:f392fc9709a3 102 #endif
AnnaBridge 189:f392fc9709a3 103
AnnaBridge 189:f392fc9709a3 104 #ifdef __cplusplus
AnnaBridge 189:f392fc9709a3 105 }
AnnaBridge 189:f392fc9709a3 106 #endif
AnnaBridge 189:f392fc9709a3 107
AnnaBridge 189:f392fc9709a3 108 #endif
AnnaBridge 189:f392fc9709a3 109
AnnaBridge 189:f392fc9709a3 110 /** @}*/
AnnaBridge 189:f392fc9709a3 111 /** @}*/