mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

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

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