xref: /xnu-11215/iokit/IOKit/IOKitDebug.h (revision d0c1fef6)
1 /*
2  * Copyright (c) 1998-2010 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 _IOKIT_IOKITDEBUG_H
30 #define _IOKIT_IOKITDEBUG_H
31 
32 #include <IOKit/IOTypes.h>
33 
34 
35 #ifdef __cplusplus
36 
37 #include <libkern/c++/OSObject.h>
38 #include <libkern/c++/OSDictionary.h>
39 #include <libkern/c++/OSSerialize.h>
40 
41 class IOKitDiagnostics : public OSObject
42 {
43     OSDeclareDefaultStructors(IOKitDiagnostics)
44 
45 public:
46     static OSObject * diagnostics( void );
47     virtual bool serialize(OSSerialize *s) const;
48 private:
49     static void updateOffset( OSDictionary * dict,
50             UInt32 value, const char * name );
51 };
52 
53 #endif /* __cplusplus */
54 
55 enum {
56     // loggage
57     kIOLogAttach        =         0x00000001ULL,
58     kIOLogProbe         =         0x00000002ULL,
59     kIOLogStart         =         0x00000004ULL,
60     kIOLogRegister      =         0x00000008ULL,
61     kIOLogMatch         =         0x00000010ULL,
62     kIOLogConfig        =         0x00000020ULL,
63     kIOLogYield         =         0x00000040ULL,
64     kIOLogPower         =         0x00000080ULL,
65     kIOLogMapping       =         0x00000100ULL,
66     kIOLogCatalogue     =         0x00000200ULL,
67 	kIOLogTracePower    =         0x00000400ULL,  // Obsolete: Use iotrace=0x00000400ULL to enable now
68     kIOLogDebugPower    =         0x00000800ULL,
69     kIOLogServiceTree   =         0x00001000ULL,
70     kIOLogDTree         =         0x00002000ULL,
71     kIOLogMemory        =         0x00004000ULL,
72     kIOLogKextMemory    =         0x00008000ULL,
73     kOSLogRegistryMods  =         0x00010000ULL,  // Log attempts to modify registry collections
74     kIOLogPMRootDomain  =         0x00020000ULL,
75     kOSRegistryModsMode =         0x00040000ULL,  // Change default registry modification handling - panic vs. log
76 //    kIOTraceIOService   =         0x00080000ULL,  // Obsolete: Use iotrace=0x00080000ULL to enable now
77     kIOLogHibernate     =         0x00100000ULL,
78     kIOLogDriverPower1  =         0x01000000ULL,
79     kIOLogDriverPower2  =         0x02000000ULL,
80     kIOStatistics       =         0x04000000ULL,
81 
82     // debug aids - change behaviour
83     kIONoFreeObjects    =         0x00100000ULL,
84     kIOLogSynchronous   =         0x00200000ULL,  // IOLog completes synchronously
85     kOSTraceObjectAlloc =         0x00400000ULL,
86 
87     _kIODebugTopFlag    = 0x8000000000000000ULL   // force enum to be 64 bits
88 };
89 
90 enum {
91 	kIOTraceInterrupts		= 		0x00000001ULL,	// Trace primary interrupts
92 	kIOTraceWorkLoops		=		0x00000002ULL,	// Trace workloop activity
93 	kIOTraceEventSources	=		0x00000004ULL,	// Trace non-passive event sources
94 	kIOTraceIntEventSource	=		0x00000008ULL,	// Trace IOIES and IOFIES sources
95 	kIOTraceCommandGates	=		0x00000010ULL,	// Trace command gate activity
96 	kIOTraceTimers			= 		0x00000008ULL,	// Trace timer event source activity
97 
98 	kIOTracePowerMgmt		=		0x00000400ULL,	// Trace power management changes
99 
100 	kIOTraceIOService   	=		0x00080000ULL,	// registerService/termination
101 
102 	kIOTraceCompatBootArgs	=		kIOTraceIOService | kIOTracePowerMgmt
103 };
104 
105 extern SInt64    gIOKitDebug;
106 extern SInt64    gIOKitTrace;
107 
108 #ifdef __cplusplus
109 extern "C" {
110 #endif
111 
112 #ifdef __cplusplus
113 class IORegistryPlane;
114 #endif
115 
116 extern void    IOPrintPlane(
117 #ifdef __cplusplus
118                             const IORegistryPlane * plane
119 #else
120                             const struct IORegistryPlane * plane
121 #endif
122                            );
123 #ifndef _OSCPPDEBUG_H
124 extern void    OSPrintMemory( void );
125 #endif
126 #define IOPrintMemory OSPrintMemory
127 
128 #ifdef __cplusplus
129 } /* extern "C" */
130 #endif /* __cplusplus */
131 
132 #endif /* ! _IOKIT_IOKITDEBUG_H */
133