mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

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

hal/spm_api.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
AnnaBridge 189:f392fc9709a3 2 /** \addtogroup hal */
AnnaBridge 189:f392fc9709a3 3 /** @{*/
AnnaBridge 189:f392fc9709a3 4 /* Copyright (c) 2017-2018 ARM Limited
AnnaBridge 189:f392fc9709a3 5 *
AnnaBridge 189:f392fc9709a3 6 * SPDX-License-Identifier: Apache-2.0
AnnaBridge 189:f392fc9709a3 7 *
AnnaBridge 189:f392fc9709a3 8 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 189:f392fc9709a3 9 * you may not use this file except in compliance with the License.
AnnaBridge 189:f392fc9709a3 10 * You may obtain a copy of the License at
AnnaBridge 189:f392fc9709a3 11 *
AnnaBridge 189:f392fc9709a3 12 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 189:f392fc9709a3 13 *
AnnaBridge 189:f392fc9709a3 14 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 189:f392fc9709a3 15 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 189:f392fc9709a3 16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 189:f392fc9709a3 17 * See the License for the specific language governing permissions and
AnnaBridge 189:f392fc9709a3 18 * limitations under the License.
AnnaBridge 189:f392fc9709a3 19 */
AnnaBridge 189:f392fc9709a3 20
AnnaBridge 189:f392fc9709a3 21 #ifndef __SPM_API_H__
AnnaBridge 189:f392fc9709a3 22 #define __SPM_API_H__
AnnaBridge 189:f392fc9709a3 23
AnnaBridge 189:f392fc9709a3 24 #include <stdint.h>
AnnaBridge 189:f392fc9709a3 25 #include <stddef.h>
AnnaBridge 189:f392fc9709a3 26
AnnaBridge 189:f392fc9709a3 27 #ifdef __cplusplus
AnnaBridge 189:f392fc9709a3 28 extern "C" {
AnnaBridge 189:f392fc9709a3 29 #endif
AnnaBridge 189:f392fc9709a3 30
AnnaBridge 189:f392fc9709a3 31
AnnaBridge 189:f392fc9709a3 32 /** @defgroup SPM-HAL SPM HAL API
AnnaBridge 189:f392fc9709a3 33 * The HAL functions for PSA SPM
AnnaBridge 189:f392fc9709a3 34 * @{
AnnaBridge 189:f392fc9709a3 35 */
AnnaBridge 189:f392fc9709a3 36
AnnaBridge 189:f392fc9709a3 37
AnnaBridge 189:f392fc9709a3 38 /* ------------------------------------ HAL-SPE API ------------------------- */
AnnaBridge 189:f392fc9709a3 39
AnnaBridge 189:f392fc9709a3 40
AnnaBridge 189:f392fc9709a3 41 #if defined(COMPONENT_SPE)
AnnaBridge 189:f392fc9709a3 42 /**
AnnaBridge 189:f392fc9709a3 43 * Start running the NSPE.
AnnaBridge 189:f392fc9709a3 44 *
AnnaBridge 189:f392fc9709a3 45 * Secure Processing Environment (SPE) expected to boot first. Once all
AnnaBridge 189:f392fc9709a3 46 * the initializations are done, Nonsecure Processing Environment (NSPE)
AnnaBridge 189:f392fc9709a3 47 * should be booted.
AnnaBridge 189:f392fc9709a3 48 *
AnnaBridge 189:f392fc9709a3 49 * @note The function must be implemented by target specific code.
AnnaBridge 189:f392fc9709a3 50 */
AnnaBridge 189:f392fc9709a3 51 void spm_hal_start_nspe(void);
AnnaBridge 189:f392fc9709a3 52
AnnaBridge 189:f392fc9709a3 53
AnnaBridge 189:f392fc9709a3 54 /**
AnnaBridge 189:f392fc9709a3 55 * Configure memory protection mechanism.
AnnaBridge 189:f392fc9709a3 56 *
AnnaBridge 189:f392fc9709a3 57 * Apply memory protection schemes to ensure secure memory can only be accessed
AnnaBridge 189:f392fc9709a3 58 * from secure-state.
AnnaBridge 189:f392fc9709a3 59 *
AnnaBridge 189:f392fc9709a3 60 * @note The function must be implemented by target specific code.
AnnaBridge 189:f392fc9709a3 61 *
AnnaBridge 189:f392fc9709a3 62 */
AnnaBridge 189:f392fc9709a3 63 void spm_hal_memory_protection_init(void);
AnnaBridge 189:f392fc9709a3 64
AnnaBridge 189:f392fc9709a3 65 #endif // defined(COMPONENT_SPE)
AnnaBridge 189:f392fc9709a3 66
AnnaBridge 189:f392fc9709a3 67 /* ---------------------------------- HAL-Mailbox API ----------------------- */
AnnaBridge 189:f392fc9709a3 68
AnnaBridge 189:f392fc9709a3 69 #if defined(COMPONENT_SPM_MAILBOX)
AnnaBridge 189:f392fc9709a3 70 /**
AnnaBridge 189:f392fc9709a3 71 * @brief Wakeup mailbox dispatcher thread
AnnaBridge 189:f392fc9709a3 72 *
AnnaBridge 189:f392fc9709a3 73 * Arm implements this function, which is expected to be called by target-
AnnaBridge 189:f392fc9709a3 74 * specific Inter-Processor-Communication logic on mailbox interrupt handler.
AnnaBridge 189:f392fc9709a3 75 *
AnnaBridge 189:f392fc9709a3 76 */
AnnaBridge 189:f392fc9709a3 77 void spm_mailbox_irq_callback(void);
AnnaBridge 189:f392fc9709a3 78
AnnaBridge 189:f392fc9709a3 79 /**
AnnaBridge 189:f392fc9709a3 80 * @brief Notify the peer processor about a general event occurrence.
AnnaBridge 189:f392fc9709a3 81 *
AnnaBridge 189:f392fc9709a3 82 * Wake up the peer processor waiting on the mailbox driver event.
AnnaBridge 189:f392fc9709a3 83 *
AnnaBridge 189:f392fc9709a3 84 * @note Implement the functions below with target-specific code.
AnnaBridge 189:f392fc9709a3 85 */
AnnaBridge 189:f392fc9709a3 86 void spm_hal_mailbox_notify(void);
AnnaBridge 189:f392fc9709a3 87
AnnaBridge 189:f392fc9709a3 88 #endif // defined(COMPONENT_SPM_MAILBOX)
AnnaBridge 189:f392fc9709a3 89
AnnaBridge 189:f392fc9709a3 90 /** @}*/
AnnaBridge 189:f392fc9709a3 91
AnnaBridge 189:f392fc9709a3 92 #ifdef __cplusplus
AnnaBridge 189:f392fc9709a3 93 }
AnnaBridge 189:f392fc9709a3 94 #endif
AnnaBridge 189:f392fc9709a3 95
AnnaBridge 189:f392fc9709a3 96 #endif // __SPM_API_H__
AnnaBridge 189:f392fc9709a3 97
AnnaBridge 189:f392fc9709a3 98 /** @}*/