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.

TARGET_STEVAL_3DP001V1/core_cmSecureAccess.h@170:e95d10626187, 2018-09-06 (annotated)

Committer:
AnnaBridge
Date:
Thu Sep 06 13:39:34 2018 +0100
Revision:
170:e95d10626187
Parent:
163:e59c8e839560 
mbed library. Release version 163

Who changed what in which revision?

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