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 * x86 processor and associated handles. 31 */ 32 #ifndef __IMAGE4_API_COPROCESSOR_X86_H 33 #define __IMAGE4_API_COPROCESSOR_X86_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_X86 44 * An x86 processor executing payloads signed by the x86 Secure Boot CA. 45 * 46 * Handles for this environment are enumerated in the 47 * {@link image4_coprocessor_handle_x86_t} type. 48 */ 49 IMAGE4_API_AVAILABLE_SPRING_2024 50 OS_EXPORT 51 const image4_coprocessor_t _image4_coprocessor_x86; 52 #define IMAGE4_COPROCESSOR_X86 (&_image4_coprocessor_x86) 53 IMAGE4_XNU_AVAILABLE_INDIRECT(_image4_coprocessor_x86); 54 55 /*! 56 * @typedef image4_coprocessor_handle_x86_t 57 * Handles describing supported x86 execution environments. 58 * 59 * @const IMAGE4_COPROCESSOR_HANDLE_X86 60 * The host's x86 environment. 61 */ 62 OS_CLOSED_ENUM(image4_coprocessor_handle_x86, image4_coprocessor_handle_t, 63 IMAGE4_COPROCESSOR_HANDLE_X86 = 0, 64 _IMAGE4_COPROCESSOR_HANDLE_X86_CNT, 65 ); 66 67 /*! 68 * @const IMAGE4_COPROCESSOR_HANDLE_X86_DEFAULT 69 * The default handle for {@link IMAGE4_COPROCESSOR_X86}. This constant enables 70 * `DEFAULT` to be used as the second and third arguments to 71 * {@link image4_environment_init_coproc} and 72 * {@link image4_environment_new_coproc} respectively. 73 */ 74 #define IMAGE4_COPROCESSOR_HANDLE_X86_DEFAULT \ 75 IMAGE4_COPROCESSOR_HANDLE_X86 76 77 OS_ASSUME_PTR_ABI_SINGLE_END 78 OS_ASSUME_NONNULL_END 79 __END_DECLS 80 81 #endif // __IMAGE4_API_COPROCESSOR_X86_H 82