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_DISCO_F413ZH/core_cmSecureAccess.h@170:e95d10626187, 2018-09-06 (annotated)

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

Who changed what in which revision?

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