1 /* 2 * Copyright © 2017-2024 Apple Inc. All rights reserved. 3 * 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5 * 6 * This file contains Original Code and/or Modifications of Original Code 7 * as defined in and that are subject to the Apple Public Source License 8 * Version 2.0 (the 'License'). You may not use this file except in 9 * compliance with the License. The rights granted to you under the License 10 * may not be used to create, or enable the creation or redistribution of, 11 * unlawful or unlicensed copies of an Apple operating system, or to 12 * circumvent, violate, or enable the circumvention or violation of, any 13 * terms of an Apple operating system software license agreement. 14 * 15 * Please obtain a copy of the License at 16 * http://www.opensource.apple.com/apsl/ and read it before using this file. 17 * 18 * The Original Code and all software distributed under the License are 19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23 * Please see the License for the specific language governing rights and 24 * limitations under the License. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28 /*! 29 * @header 30 * Third-generation virtualized Application Processor and associated handles. 31 */ 32 #ifndef __IMAGE4_API_COPROCESSOR_VMA3_H 33 #define __IMAGE4_API_COPROCESSOR_VMA3_H 34 35 #include <image4/image4.h> 36 #include <image4/types.h> 37 38 __BEGIN_DECLS 39 OS_ASSUME_NONNULL_BEGIN 40 OS_ASSUME_PTR_ABI_SINGLE_BEGIN 41 42 /*! 43 * @const IMAGE4_COPROCESSOR_VMA3 44 * The second-generation virtualized Application Processor executing payloads 45 * signed by the Secure Boot Virtual Machine CA. 46 * 47 * Handles for this environment are enumerated in the 48 * {@link image4_coprocessor_handle_vma3_t} type. 49 * 50 * @discussion 51 * Unlike {@link IMAGE4_COPROCESSOR_AP}, the default handle for this coprocessor 52 * will not consult the host's secure boot level since virtualized APs do not 53 * have a specific reduced or permissive security policy. They simply use the 54 * same policy as physical SoCs. 55 * 56 * @availability 57 * This coprocessor is available starting in API version 20240318. 58 */ 59 IMAGE4_API_AVAILABLE_SPRING_2024 60 OS_EXPORT 61 const image4_coprocessor_t _image4_coprocessor_vma3; 62 #define IMAGE4_COPROCESSOR_VMA3 (&_image4_coprocessor_vma3) 63 IMAGE4_XNU_AVAILABLE_INDIRECT(_image4_coprocessor_vma3); 64 65 /*! 66 * @typedef image4_coprocessor_handle_x86_t 67 * Handles describing supported third-generation virtualized AP execution 68 * environments. 69 * 70 * @const IMAGE4_COPROCESSOR_HANDLE_VMA3 71 * The personalized VMA3 environment. 72 */ 73 OS_CLOSED_ENUM(image4_coprocessor_handle_vma3, image4_coprocessor_handle_t, 74 IMAGE4_COPROCESSOR_HANDLE_VMA3 = 0, 75 _IMAGE4_COPROCESSOR_HANDLE_VMA3_CNT, 76 ); 77 78 OS_ASSUME_PTR_ABI_SINGLE_END 79 OS_ASSUME_NONNULL_END 80 __END_DECLS 81 82 #endif // __IMAGE4_API_COPROCESSOR_VMA3_H 83