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 * Cryptex1 coprocessor and associated handles. 31 */ 32 #ifndef __IMAGE4_API_COPROCESSOR_CRYPTEX1_H 33 #define __IMAGE4_API_COPROCESSOR_CRYPTEX1_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_CRYPTEX1 44 * The Cryptex1 coprocessor executing payloads signed by the Secure Boot Extra 45 * Content CA. 46 * 47 * Handles for this environment are enumerated in the 48 * {@link image4_coprocessor_handle_cryptex1_t} type. 49 */ 50 IMAGE4_API_AVAILABLE_SPRING_2024 51 OS_EXPORT 52 const image4_coprocessor_t _image4_coprocessor_cryptex1; 53 #define IMAGE4_COPROCESSOR_CRYPTEX1 (&_image4_coprocessor_cryptex1) 54 IMAGE4_XNU_AVAILABLE_INDIRECT(_image4_coprocessor_cryptex1); 55 56 /*! 57 * @typedef image4_coprocessor_handle_cryptex1_t 58 * Handles describing supported Cryptex1 execution environments. 59 * 60 * @const IMAGE4_COPROCESSOR_HANDLE_CRYPTEX1_BOOT 61 * The host's Cryptex1 boot coprocessor. 62 * 63 * @const IMAGE4_COPROCESSOR_HANDLE_CRYPTEX1_BOOT_LIVE 64 * The host's Cryptex1 boot coprocessor used for executing newly-authorized 65 * firmware prior to that firmware being evaluated by Secure Boot. 66 * 67 * @const IMAGE4_COPROCESSOR_HANDLE_CRYPTEX1_ASSET_BRAIN 68 * The host's Cryptex1 coprocessor used for loading MobileAsset brain firmware. 69 * 70 * @const IMAGE4_COPROCESSOR_HANDLE_CRYPTEX1_GENERIC 71 * The host's Cryptex1 coprocessor used for loading generic supplemental 72 * content. 73 */ 74 OS_CLOSED_ENUM(image4_coprocessor_handle_cryptex1, image4_coprocessor_handle_t, 75 IMAGE4_COPROCESSOR_HANDLE_CRYPTEX1_BOOT = 0, 76 IMAGE4_COPROCESSOR_HANDLE_CRYPTEX1_BOOT_LIVE, 77 IMAGE4_COPROCESSOR_HANDLE_CRYPTEX1_ASSET_BRAIN, 78 IMAGE4_COPROCESSOR_HANDLE_CRYPTEX1_GENERIC, 79 IMAGE4_COPROCESSOR_HANDLE_CRYPTEX1_RESERVED_0, 80 IMAGE4_COPROCESSOR_HANDLE_CRYPTEX1_RESERVED_1, 81 IMAGE4_COPROCESSOR_HANDLE_CRYPTEX1_RESERVED_2, 82 _IMAGE4_COPROCESSOR_HANDLE_CRYPTEX1_CNT, 83 ); 84 85 /*! 86 * @const IMAGE4_COPROCESSOR_HANDLE_CRYPTEX1_DEFAULT 87 * The default handle for {@link IMAGE4_COPROCESSOR_CRYPTEX1}. This constant 88 * enables `DEFAULT` to be used as the second and third arguments to 89 * {@link image4_environment_init_coproc} and 90 * {@link image4_environment_new_coproc} respectively. 91 */ 92 #define IMAGE4_COPROCESSOR_HANDLE_CRYPTEX1_DEFAULT \ 93 IMAGE4_COPROCESSOR_HANDLE_CRYPTEX1_BOOT 94 95 OS_ASSUME_PTR_ABI_SINGLE_END 96 OS_ASSUME_NONNULL_END 97 __END_DECLS 98 99 #endif // __IMAGE4_API_COPROCESSOR_CRYPTEX1_H 100