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