erkin yucel / mbed-os

mbed os with nrf51 internal bandgap enabled to read battery level

Dependents:   BLE_file_test BLE_Blink ExternalEncoder

cmsis/core_cmSecureAccess.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:f269e3021894 1 /**************************************************************************//**
elessair 0:f269e3021894 2 * @file core_cmSecureAccess.h
elessair 0:f269e3021894 3 * @brief CMSIS Cortex-M Core Secure Access Header File
elessair 0:f269e3021894 4 * @version XXX
elessair 0:f269e3021894 5 * @date 10. June 2016
elessair 0:f269e3021894 6 *
elessair 0:f269e3021894 7 * @note
elessair 0:f269e3021894 8 *
elessair 0:f269e3021894 9 ******************************************************************************/
elessair 0:f269e3021894 10 /* Copyright (c) 2016 ARM LIMITED
elessair 0:f269e3021894 11
elessair 0:f269e3021894 12 All rights reserved.
elessair 0:f269e3021894 13 Redistribution and use in source and binary forms, with or without
elessair 0:f269e3021894 14 modification, are permitted provided that the following conditions are met:
elessair 0:f269e3021894 15 - Redistributions of source code must retain the above copyright
elessair 0:f269e3021894 16 notice, this list of conditions and the following disclaimer.
elessair 0:f269e3021894 17 - Redistributions in binary form must reproduce the above copyright
elessair 0:f269e3021894 18 notice, this list of conditions and the following disclaimer in the
elessair 0:f269e3021894 19 documentation and/or other materials provided with the distribution.
elessair 0:f269e3021894 20 - Neither the name of ARM nor the names of its contributors may be used
elessair 0:f269e3021894 21 to endorse or promote products derived from this software without
elessair 0:f269e3021894 22 specific prior written permission.
elessair 0:f269e3021894 23 *
elessair 0:f269e3021894 24 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
elessair 0:f269e3021894 25 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
elessair 0:f269e3021894 26 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
elessair 0:f269e3021894 27 ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE
elessair 0:f269e3021894 28 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
elessair 0:f269e3021894 29 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
elessair 0:f269e3021894 30 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
elessair 0:f269e3021894 31 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
elessair 0:f269e3021894 32 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
elessair 0:f269e3021894 33 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
elessair 0:f269e3021894 34 POSSIBILITY OF SUCH DAMAGE.
elessair 0:f269e3021894 35 ---------------------------------------------------------------------------*/
elessair 0:f269e3021894 36
elessair 0:f269e3021894 37
elessair 0:f269e3021894 38 #ifndef __CORE_CM_SECURE_ACCESS_H
elessair 0:f269e3021894 39 #define __CORE_CM_SECURE_ACCESS_H
elessair 0:f269e3021894 40
elessair 0:f269e3021894 41
elessair 0:f269e3021894 42 /* ########################### Core Secure Access ########################### */
elessair 0:f269e3021894 43
elessair 0:f269e3021894 44 #ifdef FEATURE_UVISOR
elessair 0:f269e3021894 45 #include "uvisor-lib.h"
elessair 0:f269e3021894 46
elessair 0:f269e3021894 47 /* Secure uVisor implementation. */
elessair 0:f269e3021894 48
elessair 0:f269e3021894 49 /** Set the value at the target address.
elessair 0:f269e3021894 50 *
elessair 0:f269e3021894 51 * Equivalent to: `*address = value`.
elessair 0:f269e3021894 52 * @param address[in] Target address
elessair 0:f269e3021894 53 * @param value[in] Value to write at the address location.
elessair 0:f269e3021894 54 */
elessair 0:f269e3021894 55 #define SECURE_WRITE(address, value) \
elessair 0:f269e3021894 56 uvisor_write(main, UVISOR_RGW_SHARED, address, value, UVISOR_RGW_OP_WRITE, 0xFFFFFFFFUL)
elessair 0:f269e3021894 57
elessair 0:f269e3021894 58 /** Get the value at the target address.
elessair 0:f269e3021894 59 *
elessair 0:f269e3021894 60 * @param address[in] Target address
elessair 0:f269e3021894 61 * @returns The value `*address`.
elessair 0:f269e3021894 62 */
elessair 0:f269e3021894 63 #define SECURE_READ(address) \
elessair 0:f269e3021894 64 uvisor_read(main, UVISOR_RGW_SHARED, address, UVISOR_RGW_OP_READ, 0xFFFFFFFFUL)
elessair 0:f269e3021894 65
elessair 0:f269e3021894 66 /** Get the selected bits at the target address.
elessair 0:f269e3021894 67 *
elessair 0:f269e3021894 68 * @param address[in] Target address
elessair 0:f269e3021894 69 * @param mask[in] Bits to select out of the target address
elessair 0:f269e3021894 70 * @returns The value `*address & mask`.
elessair 0:f269e3021894 71 */
elessair 0:f269e3021894 72 #define SECURE_BITS_GET(address, mask) \
elessair 0:f269e3021894 73 UVISOR_BITS_GET(main, UVISOR_RGW_SHARED, address, mask)
elessair 0:f269e3021894 74
elessair 0:f269e3021894 75 /** Check the selected bits at the target address.
elessair 0:f269e3021894 76 *
elessair 0:f269e3021894 77 * @param address[in] Address at which to check the bits
elessair 0:f269e3021894 78 * @param mask[in] Bits to select out of the target address
elessair 0:f269e3021894 79 * @returns The value `((*address & mask) == mask)`.
elessair 0:f269e3021894 80 */
elessair 0:f269e3021894 81 #define SECURE_BITS_CHECK(address, mask) \
elessair 0:f269e3021894 82 UVISOR_BITS_CHECK(main, UVISOR_RGW_SHARED, address, mask)
elessair 0:f269e3021894 83
elessair 0:f269e3021894 84 /** Set the selected bits to 1 at the target address.
elessair 0:f269e3021894 85 *
elessair 0:f269e3021894 86 * Equivalent to: `*address |= mask`.
elessair 0:f269e3021894 87 * @param address[in] Target address
elessair 0:f269e3021894 88 * @param mask[in] Bits to select out of the target address
elessair 0:f269e3021894 89 */
elessair 0:f269e3021894 90 #define SECURE_BITS_SET(address, mask) \
elessair 0:f269e3021894 91 UVISOR_BITS_SET(main, UVISOR_RGW_SHARED, address, mask)
elessair 0:f269e3021894 92
elessair 0:f269e3021894 93 /** Clear the selected bits at the target address.
elessair 0:f269e3021894 94 *
elessair 0:f269e3021894 95 * Equivalent to: `*address &= ~mask`.
elessair 0:f269e3021894 96 * @param address[in] Target address
elessair 0:f269e3021894 97 * @param mask[in] Bits to select out of the target address
elessair 0:f269e3021894 98 */
elessair 0:f269e3021894 99 #define SECURE_BITS_CLEAR(address, mask) \
elessair 0:f269e3021894 100 UVISOR_BITS_CLEAR(main, UVISOR_RGW_SHARED, address, mask)
elessair 0:f269e3021894 101
elessair 0:f269e3021894 102 /** Set the selected bits at the target address to the given value.
elessair 0:f269e3021894 103 *
elessair 0:f269e3021894 104 * Equivalent to: `*address = (*address & ~mask) | (value & mask)`.
elessair 0:f269e3021894 105 * @param address[in] Target address
elessair 0:f269e3021894 106 * @param mask[in] Bits to select out of the target address
elessair 0:f269e3021894 107 * @param value[in] Value to write at the address location. Note: The value
elessair 0:f269e3021894 108 * must be already shifted to the correct bit position
elessair 0:f269e3021894 109 */
elessair 0:f269e3021894 110 #define SECURE_BITS_SET_VALUE(address, mask, value) \
elessair 0:f269e3021894 111 UVISOR_BITS_SET_VALUE(main, UVISOR_RGW_SHARED, address, mask, value)
elessair 0:f269e3021894 112
elessair 0:f269e3021894 113 /** Toggle the selected bits at the target address.
elessair 0:f269e3021894 114 *
elessair 0:f269e3021894 115 * Equivalent to: `*address ^= mask`.
elessair 0:f269e3021894 116 * @param address[in] Target address
elessair 0:f269e3021894 117 * @param mask[in] Bits to select out of the target address
elessair 0:f269e3021894 118 */
elessair 0:f269e3021894 119 #define SECURE_BITS_TOGGLE(address, mask) \
elessair 0:f269e3021894 120 UVISOR_BITS_TOGGLE(main, UVISOR_RGW_SHARED, address, mask)
elessair 0:f269e3021894 121
elessair 0:f269e3021894 122 #else
elessair 0:f269e3021894 123
elessair 0:f269e3021894 124 /* Insecure fallback implementation. */
elessair 0:f269e3021894 125
elessair 0:f269e3021894 126 /** Set the value at the target address.
elessair 0:f269e3021894 127 *
elessair 0:f269e3021894 128 * Equivalent to: `*address = value`.
elessair 0:f269e3021894 129 * @param address[in] Target address
elessair 0:f269e3021894 130 * @param value[in] Value to write at the address location.
elessair 0:f269e3021894 131 */
elessair 0:f269e3021894 132 #define SECURE_WRITE(address, value) \
elessair 0:f269e3021894 133 *(address) = (value)
elessair 0:f269e3021894 134
elessair 0:f269e3021894 135 /** Get the value at the target address.
elessair 0:f269e3021894 136 *
elessair 0:f269e3021894 137 * @param address[in] Target address
elessair 0:f269e3021894 138 * @returns The value `*address`.
elessair 0:f269e3021894 139 */
elessair 0:f269e3021894 140 #define SECURE_READ(address) \
elessair 0:f269e3021894 141 (*(address))
elessair 0:f269e3021894 142
elessair 0:f269e3021894 143 /** Get the selected bits at the target address.
elessair 0:f269e3021894 144 *
elessair 0:f269e3021894 145 * @param address[in] Target address
elessair 0:f269e3021894 146 * @param mask[in] Bits to select out of the target address
elessair 0:f269e3021894 147 * @returns The value `*address & mask`.
elessair 0:f269e3021894 148 */
elessair 0:f269e3021894 149 #define SECURE_BITS_GET(address, mask) \
elessair 0:f269e3021894 150 (*(address) & (mask))
elessair 0:f269e3021894 151
elessair 0:f269e3021894 152 /** Check the selected bits at the target address.
elessair 0:f269e3021894 153 *
elessair 0:f269e3021894 154 * @param address[in] Address at which to check the bits
elessair 0:f269e3021894 155 * @param mask[in] Bits to select out of the target address
elessair 0:f269e3021894 156 * @returns The value `((*address & mask) == mask)`.
elessair 0:f269e3021894 157 */
elessair 0:f269e3021894 158 #define SECURE_BITS_CHECK(address, mask) \
elessair 0:f269e3021894 159 ((*(address) & (mask)) == (mask))
elessair 0:f269e3021894 160
elessair 0:f269e3021894 161 /** Set the selected bits to 1 at the target address.
elessair 0:f269e3021894 162 *
elessair 0:f269e3021894 163 * Equivalent to: `*address |= mask`.
elessair 0:f269e3021894 164 * @param address[in] Target address
elessair 0:f269e3021894 165 * @param mask[in] Bits to select out of the target address
elessair 0:f269e3021894 166 */
elessair 0:f269e3021894 167 #define SECURE_BITS_SET(address, mask) \
elessair 0:f269e3021894 168 *(address) |= (mask)
elessair 0:f269e3021894 169
elessair 0:f269e3021894 170 /** Clear the selected bits at the target address.
elessair 0:f269e3021894 171 *
elessair 0:f269e3021894 172 * Equivalent to: `*address &= ~mask`.
elessair 0:f269e3021894 173 * @param address[in] Target address
elessair 0:f269e3021894 174 * @param mask[in] Bits to select out of the target address
elessair 0:f269e3021894 175 */
elessair 0:f269e3021894 176 #define SECURE_BITS_CLEAR(address, mask) \
elessair 0:f269e3021894 177 *(address) &= ~(mask)
elessair 0:f269e3021894 178
elessair 0:f269e3021894 179 /** Set the selected bits at the target address to the given value.
elessair 0:f269e3021894 180 *
elessair 0:f269e3021894 181 * Equivalent to: `*address = (*address & ~mask) | (value & mask)`.
elessair 0:f269e3021894 182 * @param address[in] Target address
elessair 0:f269e3021894 183 * @param mask[in] Bits to select out of the target address
elessair 0:f269e3021894 184 * @param value[in] Value to write at the address location. Note: The value
elessair 0:f269e3021894 185 * must be already shifted to the correct bit position
elessair 0:f269e3021894 186 */
elessair 0:f269e3021894 187 #define SECURE_BITS_SET_VALUE(address, mask, value) \
elessair 0:f269e3021894 188 *(address) = (*(address) & ~(mask)) | ((value) & (mask))
elessair 0:f269e3021894 189
elessair 0:f269e3021894 190 /** Toggle the selected bits at the target address.
elessair 0:f269e3021894 191 *
elessair 0:f269e3021894 192 * Equivalent to: `*address ^= mask`.
elessair 0:f269e3021894 193 * @param address[in] Target address
elessair 0:f269e3021894 194 * @param mask[in] Bits to select out of the target address
elessair 0:f269e3021894 195 */
elessair 0:f269e3021894 196 #define SECURE_BITS_TOGGLE(address, mask) \
elessair 0:f269e3021894 197 *(address) ^= (mask)
elessair 0:f269e3021894 198
elessair 0:f269e3021894 199 #endif
elessair 0:f269e3021894 200
elessair 0:f269e3021894 201 #endif /* __CORE_CM_SECURE_ACCESS_H */