iokit/IOKit/pwr_mgt/IOPMinformeeList.h

   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/IOLocks.h>
  30 #include <IOKit/IOReturn.h>
  31
  32 class IOPMinformee;
  33 class IOService;
  34 extern uint32_t gCanSleepTimeout;
  35
  36 class IOPMinformeeList : public OSObject
  37 {
  38         OSDeclareDefaultStructors(IOPMinformeeList);
  39         friend class IOPMinformee;
  40
  41 private:
  42 // pointer to first informee in the list
  43         IOPMinformee       *firstItem;
  44 // how many informees are in the list
  45         unsigned long       length;
  46
  47 public:
  48         void initialize( void );
  49         void free( void ) APPLE_KEXT_OVERRIDE;
  50
  51         unsigned long numberOfItems( void );
  52
  53         LIBKERN_RETURNS_NOT_RETAINED IOPMinformee *appendNewInformee( IOService * newObject );
  54
  55 // OBSOLETE
  56 // do not use addToList(); Use appendNewInformee() instead
  57         IOReturn addToList(LIBKERN_CONSUMED IOPMinformee *   newInformee );
  58         IOReturn removeFromList( IOService * theItem );
  59
  60         LIBKERN_RETURNS_NOT_RETAINED IOPMinformee * firstInList( void );
  61         LIBKERN_RETURNS_NOT_RETAINED IOPMinformee * nextInList( IOPMinformee * currentItem );
  62
  63         LIBKERN_RETURNS_NOT_RETAINED IOPMinformee * findItem( IOService * driverOrChild );
  64
  65 // This lock must be held while modifying list or length
  66         static IORecursiveLock * getSharedRecursiveLock( void );
  67 };