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/ScopedRomWriteLock.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 /* mbed Microcontroller Library
AnnaBridge 172:65be27845400 2 * Copyright (c) 2018 ARM Limited
AnnaBridge 172:65be27845400 3 *
AnnaBridge 172:65be27845400 4 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 172:65be27845400 5 * you may not use this file except in compliance with the License.
AnnaBridge 172:65be27845400 6 * You may obtain a copy of the License at
AnnaBridge 172:65be27845400 7 *
AnnaBridge 172:65be27845400 8 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 172:65be27845400 9 *
AnnaBridge 172:65be27845400 10 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 172:65be27845400 11 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 172:65be27845400 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 172:65be27845400 13 * See the License for the specific language governing permissions and
AnnaBridge 172:65be27845400 14 * limitations under the License.
AnnaBridge 172:65be27845400 15 */
AnnaBridge 172:65be27845400 16 #ifndef MBED_SCOPEDROMWRITELOCK_H
AnnaBridge 172:65be27845400 17 #define MBED_SCOPEDROMWRITELOCK_H
AnnaBridge 172:65be27845400 18
AnnaBridge 172:65be27845400 19 #include "platform/mbed_mpu_mgmt.h"
AnnaBridge 172:65be27845400 20 #include "platform/NonCopyable.h"
AnnaBridge 172:65be27845400 21
AnnaBridge 172:65be27845400 22 namespace mbed {
AnnaBridge 172:65be27845400 23
AnnaBridge 172:65be27845400 24 /** \addtogroup platform */
AnnaBridge 172:65be27845400 25 /** @{*/
AnnaBridge 172:65be27845400 26
AnnaBridge 172:65be27845400 27 /** RAII object for disabling, then restoring ROM write never mode
AnnaBridge 172:65be27845400 28 * Usage:
AnnaBridge 172:65be27845400 29 * @code
AnnaBridge 172:65be27845400 30 *
AnnaBridge 172:65be27845400 31 * void f() {
AnnaBridge 172:65be27845400 32 * // some code here
AnnaBridge 172:65be27845400 33 * {
AnnaBridge 172:65be27845400 34 * ScopedRomWriteLock make_ram_executable;
AnnaBridge 172:65be27845400 35 * // Code in this block is allowed to write to ROM
AnnaBridge 172:65be27845400 36 * }
AnnaBridge 172:65be27845400 37 * // Writing to ROM is no longer allowed
AnnaBridge 172:65be27845400 38 * }
AnnaBridge 172:65be27845400 39 * @endcode
AnnaBridge 172:65be27845400 40 */
AnnaBridge 172:65be27845400 41 class ScopedRomWriteLock : private mbed::NonCopyable<ScopedRomWriteLock> {
AnnaBridge 172:65be27845400 42 public:
AnnaBridge 172:65be27845400 43
AnnaBridge 172:65be27845400 44 /**
AnnaBridge 172:65be27845400 45 * Allow writing to ROM
AnnaBridge 172:65be27845400 46 *
AnnaBridge 172:65be27845400 47 * Increment the ROM write lock to ensure code can
AnnaBridge 172:65be27845400 48 * write to ROM. This class uses RAII to allow
AnnaBridge 172:65be27845400 49 * writing to ROM while it is in scope.
AnnaBridge 172:65be27845400 50 */
AnnaBridge 172:65be27845400 51 ScopedRomWriteLock()
AnnaBridge 172:65be27845400 52 {
AnnaBridge 172:65be27845400 53 mbed_mpu_manager_lock_rom_write();
AnnaBridge 172:65be27845400 54 }
AnnaBridge 172:65be27845400 55
AnnaBridge 172:65be27845400 56 /**
AnnaBridge 172:65be27845400 57 * Restore previous write to ROM settings
AnnaBridge 172:65be27845400 58 *
AnnaBridge 172:65be27845400 59 * Decrement the ROM write lock to return ROM write
AnnaBridge 172:65be27845400 60 * to its prior state.
AnnaBridge 172:65be27845400 61 */
AnnaBridge 172:65be27845400 62 ~ScopedRomWriteLock()
AnnaBridge 172:65be27845400 63 {
AnnaBridge 172:65be27845400 64 mbed_mpu_manager_unlock_rom_write();
AnnaBridge 172:65be27845400 65 }
AnnaBridge 172:65be27845400 66 };
AnnaBridge 172:65be27845400 67
AnnaBridge 172:65be27845400 68 /**@}*/
AnnaBridge 172:65be27845400 69
AnnaBridge 172:65be27845400 70 }
AnnaBridge 172:65be27845400 71
AnnaBridge 172:65be27845400 72 #endif