xref: /xnu-11215.61.5/EXTERNAL_HEADERS/image4/coprocessor/ap_local.h (revision 4f1223e81cd707a65cc109d0b8ad6653699da3c4)
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  * Locally-Signed Application Processor and associated handles.
31  */
32 #ifndef __IMAGE4_API_COPROCESSOR_AP_LOCAL_H
33 #define __IMAGE4_API_COPROCESSOR_AP_LOCAL_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_AP_LOCAL
44  * The Application Processor executing payloads signed by the Basic Attestation
45  * Authority.
46  *
47  * Handles for this environment are enumerated in the
48  * {@link image4_coprocessor_handle_ap_local_t} type.
49  */
50 IMAGE4_API_AVAILABLE_SPRING_2024
51 OS_EXPORT
52 const image4_coprocessor_t _image4_coprocessor_ap_local;
53 #define IMAGE4_COPROCESSOR_AP_LOCAL (&_image4_coprocessor_ap_local)
54 IMAGE4_XNU_AVAILABLE_INDIRECT(_image4_coprocessor_ap_local);
55 
56 /*!
57  * @typedef image4_coprocessor_handle_ap_local_t
58  * Handles describing supported local policy execution environments.
59  *
60  * @const IMAGE4_COPROCESSOR_HANDLE_AP_LOCAL
61  * The host's local policy environment.
62  */
63 OS_CLOSED_ENUM(image4_coprocessor_handle_ap_local, image4_coprocessor_handle_t,
64 	IMAGE4_COPROCESSOR_HANDLE_AP_LOCAL = 0,
65 	IMAGE4_COPROCESSOR_HANDLE_AP_LOCAL_RESERVED_0,
66 	IMAGE4_COPROCESSOR_HANDLE_AP_LOCAL_RESERVED_1,
67 	IMAGE4_COPROCESSOR_HANDLE_AP_LOCAL_RESERVED_2,
68 	_IMAGE4_COPROCESSOR_HANDLE_AP_LOCAL_CNT,
69 );
70 
71 /*!
72  * @const IMAGE4_COPROCESSOR_HANDLE_AP_LOCAL_DEFAULT
73  * The default handle for {@link IMAGE4_COPROCESSOR_AP_LOCAL}. This constant
74  * enables `DEFAULT` to be used as the second and third arguments to
75  * {@link image4_environment_init_coproc} and
76  * {@link image4_environment_new_coproc} respectively.
77  */
78 #define IMAGE4_COPROCESSOR_HANDLE_AP_LOCAL_DEFAULT \
79 	IMAGE4_COPROCESSOR_HANDLE_AP_LOCAL
80 
81 OS_ASSUME_PTR_ABI_SINGLE_END
82 OS_ASSUME_NONNULL_END
83 __END_DECLS
84 
85 #endif // __IMAGE4_API_COPROCESSOR_AP_LOCAL_H
86