[apple/xnu.git] / iokit / IOKit / pwr_mgt / IOPMlog.h

/*
 * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
enum PMLogEnum {
    kPMLogSetParent = 1,		//  1	0x05100004
    kPMLogAddChild,			//  2	0x05100008
    kPMLogRemoveChild,			//  3	0x0510000c
    kPMLogControllingDriver,		//  4	0x05100010
    kPMLogControllingDriverErr1,	//  5	0x05100014 - bad power state array version
    kPMLogControllingDriverErr2,	//  6	0x05100018 - power states already registered
    kPMLogControllingDriverErr3,	//  7	0x0510001c
    kPMLogControllingDriverErr4,	//  8	0x05100020 - power driver is invalid
    kPMLogInterestedDriver,		//  9	0x05100024
    kPMLogAcknowledgeErr1,		// 10	0x05100028 - unknown entity called acknowledgePowerChange
    kPMLogChildAcknowledge,		// 11	0x0510002c
    kPMLogDriverAcknowledge,		// 12	0x05100030 - interested driver acknowledges
    kPMLogAcknowledgeErr2,		// 13	0x05100034 - object has already acked
    kPMLogAcknowledgeErr3,		// 14	0x05100038 - not expecting any acks
    kPMLogAcknowledgeErr4,		// 15	0x0510003c - not expecting acknowledgeSetPowerState
    kPMLogDriverAcknowledgeSet,		// 16	0x05100040 - controlling driver acknowledges
    kPMLogWillChange,			// 17	0x05100044
    kPMLogDidChange,			// 18	0x05100048
    kPMLogRequestDomain,		// 19	0x0510004c
    kPMLogMakeUsable,			// 20	0x05100050
    kPMLogChangeStateTo,		// 21	0x05100054
    kPMLogChangeStateToPriv,		// 22	0x05100058
    kPMLogSetAggressiveness,		// 23	0x0510005c
    kPMLogCriticalTemp,			// 24	0x05100060
    kPMLogOverrideOn,			// 25	0x05100064
    kPMLogOverrideOff,			// 26	0x05100068
    kPMLogEnqueueErr,			// 27	0x0510006c - change queue overflow
    kPMLogCollapseQueue,		// 28	0x05100070
    kPMLogChangeDone,			// 29	0x05100074
    kPMLogCtrlDriverTardy,		// 30	0x05100078 - controlling driver didn't acknowledge
    kPMLogIntDriverTardy,		// 31	0x0510007c - interested driver didn't acknowledge
    kPMLogStartAckTimer,		// 32	0x05100080
    kPMLogStartParentChange,		// 33	0x05100084
    kPMLogAmendParentChange,		// 34	0x05100088
    kPMLogStartDeviceChange,		// 35	0x0510008c
    kPMLogRequestDenied,		// 36	0x05100090 - parent denied domain state change request
    kPMLogControllingDriverErr5,	// 37	0x05100094 - too few power states
    kPMLogProgramHardware,		// 38	0x05100098
    kPMLogInformDriverPreChange,	// 39	0x0510009c
    kPMLogInformDriverPostChange,	// 40	0x051000a0
    kPMLogRemoveDriver,			// 41	0x051000a4
    kPMLogSetIdleTimerPeriod,		// 42	0x051000a8
    kPMLogSystemWake,			// 43	0x051000ac
    kPMLogAcknowledgeErr5,		// 44	0x051000b0
    kPMLogClientAcknowledge,		// 45	0x051000b4
    kPMLogClientTardy,			// 46	0x051000b8 - application didn't acknowledge
    kPMLogClientCancel,			// 47	0x051000bc
    kPMLogClientNotify,			// 48	0x051000c0 - client sent a notification
    kPMLogAppNotify,			// 49	0x051000c4 - application sent a notification
    kPMLogSetClockGating,		// 50	0x051000c8 - platform device specific clock control
    kPMLogSetPowerGating,		// 51	0x051000cc - platform device specific power control
    kPMLogSetPinGroup,			// 52	0x051000d0 - platform device specific gpio control
    kPMLogIdleCancel,			// 53	0x051000d4 - device unidle during change
    kIOPMlogLastEvent
};

// Deprecated Power Management Logging Constants
#define PMlogSetParent			kPMLogSetParent
#define PMlogAddChild			kPMLogAddChild
#define PMlogRemoveChild		kPMLogRemoveChild
#define PMlogControllingDriver		kPMLogControllingDriver
#define PMlogControllingDriverErr1	kPMLogControllingDriverErr1
#define PMlogControllingDriverErr2	kPMLogControllingDriverErr2
#define PMlogControllingDriverErr3	kPMLogControllingDriverErr3
#define PMlogControllingDriverErr4	kPMLogControllingDriverErr4
#define PMlogInterestedDriver		kPMLogInterestedDriver
#define PMlogAcknowledgeErr1		kPMLogAcknowledgeErr1
#define PMlogChildAcknowledge		kPMLogChildAcknowledge
#define PMlogDriverAcknowledge		kPMLogDriverAcknowledge
#define PMlogAcknowledgeErr2		kPMLogAcknowledgeErr2
#define PMlogAcknowledgeErr3		kPMLogAcknowledgeErr3
#define PMlogAcknowledgeErr4		kPMLogAcknowledgeErr4
#define PMlogDriverAcknowledgeSet	kPMLogDriverAcknowledgeSet
#define PMlogWillChange			kPMLogWillChange
#define PMlogDidChange			kPMLogDidChange
#define PMlogRequestDomain		kPMLogRequestDomain
#define PMlogMakeUsable			kPMLogMakeUsable
#define PMlogChangeStateTo		kPMLogChangeStateTo
#define PMlogChangeStateToPriv		kPMLogChangeStateToPriv
#define PMlogSetAggressiveness		kPMLogSetAggressiveness
#define PMlogCriticalTemp		kPMLogCriticalTemp
#define PMlogOverrideOn			kPMLogOverrideOn
#define PMlogOverrideOff		kPMLogOverrideOff
#define PMlogEnqueueErr			kPMLogEnqueueErr
#define PMlogCollapseQueue		kPMLogCollapseQueue
#define PMlogChangeDone			kPMLogChangeDone
#define PMlogCtrlDriverTardy		kPMLogCtrlDriverTardy
#define PMlogIntDriverTardy		kPMLogIntDriverTardy
#define PMlogStartAckTimer		kPMLogStartAckTimer
#define PMlogStartParentChange		kPMLogStartParentChange
#define PMlogAmendParentChange		kPMLogAmendParentChange
#define PMlogStartDeviceChange		kPMLogStartDeviceChange
#define PMlogRequestDenied		kPMLogRequestDenied
#define PMlogControllingDriverErr5	kPMLogControllingDriverErr5
#define PMlogProgramHardware		kPMLogProgramHardware
#define PMlogInformDriverPreChange	kPMLogInformDriverPreChange
#define PMlogInformDriverPostChange	kPMLogInformDriverPostChange
#define PMlogRemoveDriver		kPMLogRemoveDriver
#define PMsetIdleTimerPeriod		kPMLogSetIdleTimerPeriod
#define PMlogSystemWake			kPMLogSystemWake
#define PMlogAcknowledgeErr5		kPMLogAcknowledgeErr5
#define PMlogClientAcknowledge		kPMLogClientAcknowledge
#define PMlogClientTardy		kPMLogClientTardy
#define PMlogClientCancel		kPMLogClientCancel
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b	27	*/
91447636 A	28	enum PMLogEnum {
	29	kPMLogSetParent = 1, // 1 0x05100004
	30	kPMLogAddChild, // 2 0x05100008
	31	kPMLogRemoveChild, // 3 0x0510000c
	32	kPMLogControllingDriver, // 4 0x05100010
	33	kPMLogControllingDriverErr1, // 5 0x05100014 - bad power state array version
2d21ac55 A	34	kPMLogControllingDriverErr2, // 6 0x05100018 - power states already registered
	35	kPMLogControllingDriverErr3, // 7 0x0510001c
	36	kPMLogControllingDriverErr4, // 8 0x05100020 - power driver is invalid
91447636 A	37	kPMLogInterestedDriver, // 9 0x05100024
	38	kPMLogAcknowledgeErr1, // 10 0x05100028 - unknown entity called acknowledgePowerChange
	39	kPMLogChildAcknowledge, // 11 0x0510002c
	40	kPMLogDriverAcknowledge, // 12 0x05100030 - interested driver acknowledges
	41	kPMLogAcknowledgeErr2, // 13 0x05100034 - object has already acked
	42	kPMLogAcknowledgeErr3, // 14 0x05100038 - not expecting any acks
	43	kPMLogAcknowledgeErr4, // 15 0x0510003c - not expecting acknowledgeSetPowerState
	44	kPMLogDriverAcknowledgeSet, // 16 0x05100040 - controlling driver acknowledges
	45	kPMLogWillChange, // 17 0x05100044
	46	kPMLogDidChange, // 18 0x05100048
	47	kPMLogRequestDomain, // 19 0x0510004c
	48	kPMLogMakeUsable, // 20 0x05100050
	49	kPMLogChangeStateTo, // 21 0x05100054
	50	kPMLogChangeStateToPriv, // 22 0x05100058
	51	kPMLogSetAggressiveness, // 23 0x0510005c
	52	kPMLogCriticalTemp, // 24 0x05100060
	53	kPMLogOverrideOn, // 25 0x05100064
	54	kPMLogOverrideOff, // 26 0x05100068
	55	kPMLogEnqueueErr, // 27 0x0510006c - change queue overflow
	56	kPMLogCollapseQueue, // 28 0x05100070
	57	kPMLogChangeDone, // 29 0x05100074
	58	kPMLogCtrlDriverTardy, // 30 0x05100078 - controlling driver didn't acknowledge
	59	kPMLogIntDriverTardy, // 31 0x0510007c - interested driver didn't acknowledge
	60	kPMLogStartAckTimer, // 32 0x05100080
	61	kPMLogStartParentChange, // 33 0x05100084
	62	kPMLogAmendParentChange, // 34 0x05100088
	63	kPMLogStartDeviceChange, // 35 0x0510008c
	64	kPMLogRequestDenied, // 36 0x05100090 - parent denied domain state change request
2d21ac55	65	kPMLogControllingDriverErr5, // 37 0x05100094 - too few power states
91447636 A	66	kPMLogProgramHardware, // 38 0x05100098
	67	kPMLogInformDriverPreChange, // 39 0x0510009c
	68	kPMLogInformDriverPostChange, // 40 0x051000a0
	69	kPMLogRemoveDriver, // 41 0x051000a4
	70	kPMLogSetIdleTimerPeriod, // 42 0x051000a8
	71	kPMLogSystemWake, // 43 0x051000ac
	72	kPMLogAcknowledgeErr5, // 44 0x051000b0
	73	kPMLogClientAcknowledge, // 45 0x051000b4
	74	kPMLogClientTardy, // 46 0x051000b8 - application didn't acknowledge
	75	kPMLogClientCancel, // 47 0x051000bc
	76	kPMLogClientNotify, // 48 0x051000c0 - client sent a notification
	77	kPMLogAppNotify, // 49 0x051000c4 - application sent a notification
2d21ac55 A	78	kPMLogSetClockGating, // 50 0x051000c8 - platform device specific clock control
	79	kPMLogSetPowerGating, // 51 0x051000cc - platform device specific power control
	80	kPMLogSetPinGroup, // 52 0x051000d0 - platform device specific gpio control
593a1d5f	81	kPMLogIdleCancel, // 53 0x051000d4 - device unidle during change
91447636 A	82	kIOPMlogLastEvent
	83	};
	84
	85	// Deprecated Power Management Logging Constants
	86	#define PMlogSetParent kPMLogSetParent
	87	#define PMlogAddChild kPMLogAddChild
	88	#define PMlogRemoveChild kPMLogRemoveChild
	89	#define PMlogControllingDriver kPMLogControllingDriver
	90	#define PMlogControllingDriverErr1 kPMLogControllingDriverErr1
	91	#define PMlogControllingDriverErr2 kPMLogControllingDriverErr2
	92	#define PMlogControllingDriverErr3 kPMLogControllingDriverErr3
	93	#define PMlogControllingDriverErr4 kPMLogControllingDriverErr4
	94	#define PMlogInterestedDriver kPMLogInterestedDriver
	95	#define PMlogAcknowledgeErr1 kPMLogAcknowledgeErr1
	96	#define PMlogChildAcknowledge kPMLogChildAcknowledge
	97	#define PMlogDriverAcknowledge kPMLogDriverAcknowledge
	98	#define PMlogAcknowledgeErr2 kPMLogAcknowledgeErr2
	99	#define PMlogAcknowledgeErr3 kPMLogAcknowledgeErr3
	100	#define PMlogAcknowledgeErr4 kPMLogAcknowledgeErr4
	101	#define PMlogDriverAcknowledgeSet kPMLogDriverAcknowledgeSet
	102	#define PMlogWillChange kPMLogWillChange
	103	#define PMlogDidChange kPMLogDidChange
	104	#define PMlogRequestDomain kPMLogRequestDomain
	105	#define PMlogMakeUsable kPMLogMakeUsable
	106	#define PMlogChangeStateTo kPMLogChangeStateTo
	107	#define PMlogChangeStateToPriv kPMLogChangeStateToPriv
	108	#define PMlogSetAggressiveness kPMLogSetAggressiveness
	109	#define PMlogCriticalTemp kPMLogCriticalTemp
	110	#define PMlogOverrideOn kPMLogOverrideOn
	111	#define PMlogOverrideOff kPMLogOverrideOff
	112	#define PMlogEnqueueErr kPMLogEnqueueErr
	113	#define PMlogCollapseQueue kPMLogCollapseQueue
	114	#define PMlogChangeDone kPMLogChangeDone
	115	#define PMlogCtrlDriverTardy kPMLogCtrlDriverTardy
	116	#define PMlogIntDriverTardy kPMLogIntDriverTardy
	117	#define PMlogStartAckTimer kPMLogStartAckTimer
	118	#define PMlogStartParentChange kPMLogStartParentChange
	119	#define PMlogAmendParentChange kPMLogAmendParentChange
	120	#define PMlogStartDeviceChange kPMLogStartDeviceChange
	121	#define PMlogRequestDenied kPMLogRequestDenied
	122	#define PMlogControllingDriverErr5 kPMLogControllingDriverErr5
	123	#define PMlogProgramHardware kPMLogProgramHardware
	124	#define PMlogInformDriverPreChange kPMLogInformDriverPreChange
	125	#define PMlogInformDriverPostChange kPMLogInformDriverPostChange
	126	#define PMlogRemoveDriver kPMLogRemoveDriver
	127	#define PMsetIdleTimerPeriod kPMLogSetIdleTimerPeriod
	128	#define PMlogSystemWake kPMLogSystemWake
	129	#define PMlogAcknowledgeErr5 kPMLogAcknowledgeErr5
	130	#define PMlogClientAcknowledge kPMLogClientAcknowledge
	131	#define PMlogClientTardy kPMLogClientTardy
	132	#define PMlogClientCancel kPMLogClientCancel
	133