xref: /xnu-10002.1.13/bsd/sys/variant_internal.h (revision 1031c584a5e37aff177559b9f69dbd3c8c3fd30a)
1 /*
2  * Copyright (c) 2021 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 #ifndef _SYS_VARIANT_INTERNAL_H_
30 #define _SYS_VARIANT_INTERNAL_H_
31 
32 __BEGIN_DECLS
33 
34 enum os_variant_check_status {
35 	OS_VARIANT_S_UNKNOWN = 0,
36 	OS_VARIANT_S_NO = 2,
37 	OS_VARIANT_S_YES = 3
38 };
39 
40 /*
41  * Bit allocation in kern.osvariant_status (all ranges inclusive):
42  * - [0-27] are 2-bit check_status values
43  * - [28-31] are 0xF
44  * - [32-32+VP_MAX-1] encode variant_property booleans
45  * - [48-51] encode the boot mode, if known
46  * - [60-62] are 0x7
47  */
48 #define OS_VARIANT_STATUS_INITIAL_BITS 0x70000000F0000000ULL
49 #define OS_VARIANT_STATUS_BIT_WIDTH 2
50 #define OS_VARIANT_STATUS_SET 0x2
51 #define OS_VARIANT_STATUS_MASK 0x3
52 
53 enum os_variant_status_flags_positions {
54 	OS_VARIANT_SFP_INTERNAL_CONTENT = 0,
55 	OS_VARIANT_SFP_INTERNAL_RELEASE_TYPE = 2,
56 	OS_VARIANT_SFP_INTERNAL_DIAGS_PROFILE = 3,
57 };
58 
59 enum os_variant_property {
60 	OS_VARIANT_PROPERTY_CONTENT,
61 	OS_VARIANT_PROPERTY_DIAGNOSTICS
62 };
63 
64 __END_DECLS
65 
66 #ifdef KERNEL_PRIVATE
67 
68 __BEGIN_DECLS
69 
70 bool os_variant_has_internal_diagnostics(const char *subsystem);
71 
72 __END_DECLS
73 #endif /* KERNEL_PRIVATE */
74 
75 #endif /* _SYS_VARIANT_INTERNAL_H_ */
76