xref: /xnu-12377.81.4/bsd/sys/preoslog.h (revision 043036a2b3718f7f0be807e2870f8f47d3fa0796) !
1*043036a2SApple OSS Distributions /*
2*043036a2SApple OSS Distributions  * Copyright (c) 2021-2022 Apple Inc. All rights reserved.
3*043036a2SApple OSS Distributions  *
4*043036a2SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*043036a2SApple OSS Distributions  *
6*043036a2SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*043036a2SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*043036a2SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*043036a2SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*043036a2SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*043036a2SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*043036a2SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*043036a2SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*043036a2SApple OSS Distributions  *
15*043036a2SApple OSS Distributions  * Please obtain a copy of the License at
16*043036a2SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*043036a2SApple OSS Distributions  *
18*043036a2SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*043036a2SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*043036a2SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*043036a2SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*043036a2SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*043036a2SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*043036a2SApple OSS Distributions  * limitations under the License.
25*043036a2SApple OSS Distributions  *
26*043036a2SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*043036a2SApple OSS Distributions  */
28*043036a2SApple OSS Distributions 
29*043036a2SApple OSS Distributions #ifndef _SYS_PREOSLOG_H_
30*043036a2SApple OSS Distributions #define _SYS_PREOSLOG_H_
31*043036a2SApple OSS Distributions 
32*043036a2SApple OSS Distributions #include <sys/cdefs.h>
33*043036a2SApple OSS Distributions 
34*043036a2SApple OSS Distributions __BEGIN_DECLS
35*043036a2SApple OSS Distributions 
36*043036a2SApple OSS Distributions #define PREOSLOG_MAGIC 'LSOP'
37*043036a2SApple OSS Distributions #define PREOSLOG_SYSCTL "kern.preoslog"
38*043036a2SApple OSS Distributions 
39*043036a2SApple OSS Distributions typedef uint8_t preoslog_source_t;
40*043036a2SApple OSS Distributions enum {
41*043036a2SApple OSS Distributions 	PREOSLOG_SOURCE_IBOOT = 0,
42*043036a2SApple OSS Distributions 	PREOSLOG_SOURCE_MACEFI,
43*043036a2SApple OSS Distributions 	PREOSLOG_SOURCE_MAX
44*043036a2SApple OSS Distributions };
45*043036a2SApple OSS Distributions 
46*043036a2SApple OSS Distributions /*
47*043036a2SApple OSS Distributions  * Any change to this structure must be reflected in boot loader (iboot / xnu SDK header) and vice versa.
48*043036a2SApple OSS Distributions  * Beware: if you remove __attribute__((packed)) here, then sizeof() on this structure will return 16.
49*043036a2SApple OSS Distributions  * However, with or without __attribute__((packed)), offset_of(preoslog_header_t, data) will always return 14.
50*043036a2SApple OSS Distributions  */
51*043036a2SApple OSS Distributions 
52*043036a2SApple OSS Distributions typedef struct  __attribute__((packed)) {
53*043036a2SApple OSS Distributions 	uint32_t magic; /* PREOGLOS_MAGIC if valid */
54*043036a2SApple OSS Distributions 	uint32_t size; /* Size of the preoslog buffer including the header */
55*043036a2SApple OSS Distributions 	uint32_t offset; /* Write pointer. Indicates where in the buffer new log entry would go */
56*043036a2SApple OSS Distributions 	preoslog_source_t source; /* Indicates who filled in the buffer (e.g. iboot vs MacEFI) */
57*043036a2SApple OSS Distributions 	uint8_t wrapped; /* If equal to 1, the preoslog ring buffer wrapped at least once */
58*043036a2SApple OSS Distributions 	char data[]; /* log buffer */
59*043036a2SApple OSS Distributions } preoslog_header_t;
60*043036a2SApple OSS Distributions 
61*043036a2SApple OSS Distributions __END_DECLS
62*043036a2SApple OSS Distributions 
63*043036a2SApple OSS Distributions #endif  /* !_SYS_PREOSLOG_H_ */
64