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