xref: /xnu-11215.41.3/iokit/IOKit/pwr_mgt/IOPMPowerSourceList.h (revision 33de042d024d46de5ff4e89f2471de6608e37fa4)
1 /*
2  * Copyright (c) 1998-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 #include <libkern/c++/OSObject.h>
29 #include <IOKit/IOReturn.h>
30 
31 class IOPMPowerSource;
32 
33 class IOPMPowerSourceList : public OSObject
34 {
35 	OSDeclareDefaultStructors(IOPMPowerSourceList);
36 private:
37 // pointer to first power source in list
38 	IOPMPowerSource         *firstItem;
39 
40 // how many power sources are in the list
41 	unsigned long           length;
42 
43 public:
44 	void initialize(void);
45 	void free(void) APPLE_KEXT_OVERRIDE;
46 
47 	unsigned long numberOfItems(void);
48 	IOReturn addToList(IOPMPowerSource *newPowerSource);
49 	IOReturn removeFromList(IOPMPowerSource *theItem);
50 
51 	LIBKERN_RETURNS_NOT_RETAINED IOPMPowerSource *firstInList(void);
52 	LIBKERN_RETURNS_NOT_RETAINED IOPMPowerSource *nextInList(IOPMPowerSource *currentItem);
53 };
54