xref: /xnu-11215.81.4/iokit/Kernel/IOPMPowerStateQueue.h (revision d4514f0bc1d3f944c22d92e68b646ac3fb40d452) !
1*d4514f0bSApple OSS Distributions /*
2*d4514f0bSApple OSS Distributions  * Copyright (c) 2001-2019 Apple Inc. All rights reserved.
3*d4514f0bSApple OSS Distributions  *
4*d4514f0bSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*d4514f0bSApple OSS Distributions  *
6*d4514f0bSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*d4514f0bSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*d4514f0bSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*d4514f0bSApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*d4514f0bSApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*d4514f0bSApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*d4514f0bSApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*d4514f0bSApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*d4514f0bSApple OSS Distributions  *
15*d4514f0bSApple OSS Distributions  * Please obtain a copy of the License at
16*d4514f0bSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*d4514f0bSApple OSS Distributions  *
18*d4514f0bSApple OSS Distributions  * The Original Code and all software distributed under the License are
19*d4514f0bSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*d4514f0bSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*d4514f0bSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*d4514f0bSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*d4514f0bSApple OSS Distributions  * Please see the License for the specific language governing rights and
24*d4514f0bSApple OSS Distributions  * limitations under the License.
25*d4514f0bSApple OSS Distributions  *
26*d4514f0bSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*d4514f0bSApple OSS Distributions  */
28*d4514f0bSApple OSS Distributions 
29*d4514f0bSApple OSS Distributions #ifndef _IOPMPOWERSTATEQUEUE_H_
30*d4514f0bSApple OSS Distributions #define _IOPMPOWERSTATEQUEUE_H_
31*d4514f0bSApple OSS Distributions 
32*d4514f0bSApple OSS Distributions #include <IOKit/IOEventSource.h>
33*d4514f0bSApple OSS Distributions #include <IOKit/IOLocks.h>
34*d4514f0bSApple OSS Distributions #include <kern/queue.h>
35*d4514f0bSApple OSS Distributions 
36*d4514f0bSApple OSS Distributions typedef void (*IOPMPowerStateQueueAction)(OSObject *, uint32_t event, void *, uint64_t);
37*d4514f0bSApple OSS Distributions 
38*d4514f0bSApple OSS Distributions class IOPMPowerStateQueue : public IOEventSource
39*d4514f0bSApple OSS Distributions {
40*d4514f0bSApple OSS Distributions 	OSDeclareDefaultStructors(IOPMPowerStateQueue);
41*d4514f0bSApple OSS Distributions 
42*d4514f0bSApple OSS Distributions private:
43*d4514f0bSApple OSS Distributions 	struct PowerEventEntry {
44*d4514f0bSApple OSS Distributions 		queue_chain_t   chain;
45*d4514f0bSApple OSS Distributions 		uint32_t        eventType;
46*d4514f0bSApple OSS Distributions 		void *          arg0;
47*d4514f0bSApple OSS Distributions 		uint64_t        arg1;
48*d4514f0bSApple OSS Distributions 	};
49*d4514f0bSApple OSS Distributions 
50*d4514f0bSApple OSS Distributions 	queue_head_t    queueHead;
51*d4514f0bSApple OSS Distributions 	IOLock *        queueLock;
52*d4514f0bSApple OSS Distributions 
53*d4514f0bSApple OSS Distributions protected:
54*d4514f0bSApple OSS Distributions 	virtual bool checkForWork( void ) APPLE_KEXT_OVERRIDE;
55*d4514f0bSApple OSS Distributions 	virtual bool init( OSObject * owner, Action action ) APPLE_KEXT_OVERRIDE;
56*d4514f0bSApple OSS Distributions 
57*d4514f0bSApple OSS Distributions public:
58*d4514f0bSApple OSS Distributions 	static IOPMPowerStateQueue * PMPowerStateQueue( OSObject * owner, Action action );
59*d4514f0bSApple OSS Distributions 
60*d4514f0bSApple OSS Distributions 	bool submitPowerEvent( uint32_t eventType, void * arg0 = NULL, uint64_t arg1 = 0 );
61*d4514f0bSApple OSS Distributions };
62*d4514f0bSApple OSS Distributions 
63*d4514f0bSApple OSS Distributions #endif /* _IOPMPOWERSTATEQUEUE_H_ */
64