1 /*
2  * Copyright (c) 2001-2019 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 _IOPMPOWERSTATEQUEUE_H_
30 #define _IOPMPOWERSTATEQUEUE_H_
31 
32 #include <IOKit/IOEventSource.h>
33 #include <IOKit/IOLocks.h>
34 #include <kern/queue.h>
35 
36 typedef void (*IOPMPowerStateQueueAction)(OSObject *, uint32_t event, void *, uint64_t);
37 
38 class IOPMPowerStateQueue : public IOEventSource
39 {
40 	OSDeclareDefaultStructors(IOPMPowerStateQueue);
41 
42 private:
43 	struct PowerEventEntry {
44 		queue_chain_t   chain;
45 		uint32_t        eventType;
46 		void *          arg0;
47 		uint64_t        arg1;
48 	};
49 
50 	queue_head_t    queueHead;
51 	IOLock *        queueLock;
52 
53 protected:
54 	virtual bool checkForWork( void ) APPLE_KEXT_OVERRIDE;
55 	virtual bool init( OSObject * owner, Action action ) APPLE_KEXT_OVERRIDE;
56 
57 public:
58 	static IOPMPowerStateQueue * PMPowerStateQueue( OSObject * owner, Action action );
59 
60 	bool submitPowerEvent( uint32_t eventType, void * arg0 = NULL, uint64_t arg1 = 0 );
61 };
62 
63 #endif /* _IOPMPOWERSTATEQUEUE_H_ */
64