xref: /xnu-11417.121.6/bsd/sys/variant_internal.h (revision a1e26a70f38d1d7daa7b49b258e2f8538ad81650)
1*a1e26a70SApple OSS Distributions /*
2*a1e26a70SApple OSS Distributions  * Copyright (c) 2021 Apple Inc. All rights reserved.
3*a1e26a70SApple OSS Distributions  *
4*a1e26a70SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*a1e26a70SApple OSS Distributions  *
6*a1e26a70SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*a1e26a70SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*a1e26a70SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*a1e26a70SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*a1e26a70SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*a1e26a70SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*a1e26a70SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*a1e26a70SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*a1e26a70SApple OSS Distributions  *
15*a1e26a70SApple OSS Distributions  * Please obtain a copy of the License at
16*a1e26a70SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*a1e26a70SApple OSS Distributions  *
18*a1e26a70SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*a1e26a70SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*a1e26a70SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*a1e26a70SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*a1e26a70SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*a1e26a70SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*a1e26a70SApple OSS Distributions  * limitations under the License.
25*a1e26a70SApple OSS Distributions  *
26*a1e26a70SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*a1e26a70SApple OSS Distributions  */
28*a1e26a70SApple OSS Distributions 
29*a1e26a70SApple OSS Distributions #ifndef _SYS_VARIANT_INTERNAL_H_
30*a1e26a70SApple OSS Distributions #define _SYS_VARIANT_INTERNAL_H_
31*a1e26a70SApple OSS Distributions 
32*a1e26a70SApple OSS Distributions __BEGIN_DECLS
33*a1e26a70SApple OSS Distributions 
34*a1e26a70SApple OSS Distributions enum os_variant_check_status {
35*a1e26a70SApple OSS Distributions 	OS_VARIANT_S_UNKNOWN = 0,
36*a1e26a70SApple OSS Distributions 	OS_VARIANT_S_NO = 2,
37*a1e26a70SApple OSS Distributions 	OS_VARIANT_S_YES = 3
38*a1e26a70SApple OSS Distributions };
39*a1e26a70SApple OSS Distributions 
40*a1e26a70SApple OSS Distributions /*
41*a1e26a70SApple OSS Distributions  * Bit allocation in kern.osvariant_status (all ranges inclusive):
42*a1e26a70SApple OSS Distributions  * - [0-27] are 2-bit check_status values
43*a1e26a70SApple OSS Distributions  * - [28-31] are 0xF
44*a1e26a70SApple OSS Distributions  * - [32-32+VP_MAX-1] encode variant_property booleans
45*a1e26a70SApple OSS Distributions  * - [48-51] encode the boot mode, if known
46*a1e26a70SApple OSS Distributions  * - [60-62] are 0x7
47*a1e26a70SApple OSS Distributions  */
48*a1e26a70SApple OSS Distributions #define OS_VARIANT_STATUS_INITIAL_BITS 0x70000000F0000000ULL
49*a1e26a70SApple OSS Distributions #define OS_VARIANT_STATUS_BIT_WIDTH 2
50*a1e26a70SApple OSS Distributions #define OS_VARIANT_STATUS_SET 0x2
51*a1e26a70SApple OSS Distributions #define OS_VARIANT_STATUS_MASK 0x3
52*a1e26a70SApple OSS Distributions 
53*a1e26a70SApple OSS Distributions enum os_variant_status_flags_positions {
54*a1e26a70SApple OSS Distributions 	OS_VARIANT_SFP_INTERNAL_CONTENT = 0,
55*a1e26a70SApple OSS Distributions 	OS_VARIANT_SFP_INTERNAL_RELEASE_TYPE = 2,
56*a1e26a70SApple OSS Distributions 	OS_VARIANT_SFP_INTERNAL_DIAGS_PROFILE = 3,
57*a1e26a70SApple OSS Distributions };
58*a1e26a70SApple OSS Distributions 
59*a1e26a70SApple OSS Distributions enum os_variant_property {
60*a1e26a70SApple OSS Distributions 	OS_VARIANT_PROPERTY_CONTENT,
61*a1e26a70SApple OSS Distributions 	OS_VARIANT_PROPERTY_DIAGNOSTICS
62*a1e26a70SApple OSS Distributions };
63*a1e26a70SApple OSS Distributions 
64*a1e26a70SApple OSS Distributions __END_DECLS
65*a1e26a70SApple OSS Distributions 
66*a1e26a70SApple OSS Distributions #ifdef KERNEL_PRIVATE
67*a1e26a70SApple OSS Distributions 
68*a1e26a70SApple OSS Distributions __BEGIN_DECLS
69*a1e26a70SApple OSS Distributions 
70*a1e26a70SApple OSS Distributions bool os_variant_has_internal_diagnostics(const char *subsystem);
71*a1e26a70SApple OSS Distributions 
72*a1e26a70SApple OSS Distributions __END_DECLS
73*a1e26a70SApple OSS Distributions #endif /* KERNEL_PRIVATE */
74*a1e26a70SApple OSS Distributions 
75*a1e26a70SApple OSS Distributions #endif /* _SYS_VARIANT_INTERNAL_H_ */
76