Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

components/TARGET_PSA/inc/psa/lifecycle.h@0:5b88d5760320, 2019-12-17 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 17 23:23:45 2019 +0000
Revision:
0:5b88d5760320
mbed-os5 only for TYBLE16

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 0:5b88d5760320 1 /* Copyright (c) 2018 ARM Limited
kenjiArai 0:5b88d5760320 2 *
kenjiArai 0:5b88d5760320 3 * SPDX-License-Identifier: Apache-2.0
kenjiArai 0:5b88d5760320 4 *
kenjiArai 0:5b88d5760320 5 * Licensed under the Apache License, Version 2.0 (the "License");
kenjiArai 0:5b88d5760320 6 * you may not use this file except in compliance with the License.
kenjiArai 0:5b88d5760320 7 * You may obtain a copy of the License at
kenjiArai 0:5b88d5760320 8 *
kenjiArai 0:5b88d5760320 9 * http://www.apache.org/licenses/LICENSE-2.0
kenjiArai 0:5b88d5760320 10 *
kenjiArai 0:5b88d5760320 11 * Unless required by applicable law or agreed to in writing, software
kenjiArai 0:5b88d5760320 12 * distributed under the License is distributed on an "AS IS" BASIS,
kenjiArai 0:5b88d5760320 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kenjiArai 0:5b88d5760320 14 * See the License for the specific language governing permissions and
kenjiArai 0:5b88d5760320 15 * limitations under the License.
kenjiArai 0:5b88d5760320 16 */
kenjiArai 0:5b88d5760320 17
kenjiArai 0:5b88d5760320 18 #ifndef __LIFECYCLE_H__
kenjiArai 0:5b88d5760320 19 #define __LIFECYCLE_H__
kenjiArai 0:5b88d5760320 20
kenjiArai 0:5b88d5760320 21 /** @file
kenjiArai 0:5b88d5760320 22 @brief This file describes the PSA RoT Lifecycle API
kenjiArai 0:5b88d5760320 23 */
kenjiArai 0:5b88d5760320 24
kenjiArai 0:5b88d5760320 25 #include <stddef.h>
kenjiArai 0:5b88d5760320 26 #include <stdint.h>
kenjiArai 0:5b88d5760320 27 #include "mbed_toolchain.h"
kenjiArai 0:5b88d5760320 28 #include "psa/error.h"
kenjiArai 0:5b88d5760320 29
kenjiArai 0:5b88d5760320 30 #ifdef __cplusplus
kenjiArai 0:5b88d5760320 31 extern "C"
kenjiArai 0:5b88d5760320 32 {
kenjiArai 0:5b88d5760320 33 #endif
kenjiArai 0:5b88d5760320 34
kenjiArai 0:5b88d5760320 35 #define PSA_LIFECYCLE_STATE_MASK (0xff00u) /**< A mask value that extracts the main lifecycle state */
kenjiArai 0:5b88d5760320 36 #define PSA_LIFECYCLE_SUBSTATE_MASK (0x00ffu) /**< A mask value that extracts the IMPLEMENTATION DEFINED lifecycle sub-state */
kenjiArai 0:5b88d5760320 37
kenjiArai 0:5b88d5760320 38 #define PSA_LIFECYCLE_UNKNOWN (0x0000u) /**< State is unknown */
kenjiArai 0:5b88d5760320 39 #define PSA_LIFECYCLE_ASSEMBLY_AND_TEST (0x1000u) /**< Assembly and Test state */
kenjiArai 0:5b88d5760320 40 #define PSA_LIFECYCLE_PSA_ROT_PROVISIONING (0x2000u) /**< PSA RoT Provisioning state */
kenjiArai 0:5b88d5760320 41 #define PSA_LIFECYCLE_SECURED (0x3000u) /**< Secured state */
kenjiArai 0:5b88d5760320 42 #define PSA_LIFECYCLE_NON_PSA_ROT_DEBUG (0x4000u) /**< Non PSA RoT debug state */
kenjiArai 0:5b88d5760320 43 #define PSA_LIFECYCLE_RECOVERABLE_PSA_ROT_DEBUG (0x5000u) /**< Recoverable PSA RoT Debug state */
kenjiArai 0:5b88d5760320 44 #define PSA_LIFECYCLE_DECOMMISSIONED (0x6000u) /**< Decommissioned state */
kenjiArai 0:5b88d5760320 45
kenjiArai 0:5b88d5760320 46 /** \brief Get PSA RoT lifecycle state
kenjiArai 0:5b88d5760320 47 *
kenjiArai 0:5b88d5760320 48 * \retval The main state and sub-state are encoded as follows:@n
kenjiArai 0:5b88d5760320 49 @a version[15:8] – main lifecycle state
kenjiArai 0:5b88d5760320 50 @a version[7:0] – IMPLEMENTATION DEFINED sub-state
kenjiArai 0:5b88d5760320 51 */
kenjiArai 0:5b88d5760320 52 uint32_t psa_security_lifecycle_state(void);
kenjiArai 0:5b88d5760320 53
kenjiArai 0:5b88d5760320 54 /** \brief Request state change
kenjiArai 0:5b88d5760320 55 *
kenjiArai 0:5b88d5760320 56 * State change requested and the reset the system.
kenjiArai 0:5b88d5760320 57 * \note System reset will not be performed when switching from PSA_LIFECYCLE_ASSEMBLY_AND_TEST
kenjiArai 0:5b88d5760320 58 * to PSA_LIFECYCLE_ASSEMBLY_AND_TEST.
kenjiArai 0:5b88d5760320 59 *
kenjiArai 0:5b88d5760320 60 * \note state change to follwing states will delete PSA internal storage:
kenjiArai 0:5b88d5760320 61 * - PSA_LIFECYCLE_ASSEMBLY_AND_TEST
kenjiArai 0:5b88d5760320 62 * - PSA_LIFECYCLE_PSA_ROT_PROVISIONING
kenjiArai 0:5b88d5760320 63 * - PSA_LIFECYCLE_DECOMMISSIONED
kenjiArai 0:5b88d5760320 64 */
kenjiArai 0:5b88d5760320 65 psa_status_t mbed_psa_reboot_and_request_new_security_state(uint32_t new_state);
kenjiArai 0:5b88d5760320 66
kenjiArai 0:5b88d5760320 67
kenjiArai 0:5b88d5760320 68 /** \brief Resets the system
kenjiArai 0:5b88d5760320 69 *
kenjiArai 0:5b88d5760320 70 * PSA targets do not allow NSPE to access system power domain.
kenjiArai 0:5b88d5760320 71 * This API requests system reset to be carried out by SPE once all critical secure tasks are finished.
kenjiArai 0:5b88d5760320 72 */
kenjiArai 0:5b88d5760320 73 MBED_NORETURN void mbed_psa_system_reset();
kenjiArai 0:5b88d5760320 74
kenjiArai 0:5b88d5760320 75 #ifdef __cplusplus
kenjiArai 0:5b88d5760320 76 }
kenjiArai 0:5b88d5760320 77 #endif
kenjiArai 0:5b88d5760320 78
kenjiArai 0:5b88d5760320 79 #endif // __LIFECYCLE_H__