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