mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

platform/mbed_mpu_mgmt.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
mbed library release version 165

Who changed what in which revision?

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