iokit/Kernel/IOPMWorkArbiter.h

   1 /*
   2  * Copyright (c) 2001-2002 Apple Computer, 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 _IOPMWorkArbiter_H_
  30 #define _IOPMWorkArbiter_H_
  31
  32 #include <IOKit/IOWorkLoop.h>
  33 #include <IOKit/IOEventSource.h>
  34 #include <IOKit/IOService.h>
  35 extern "C" {
  36     #include <kern/queue.h>
  37 }
  38
  39 class IOPMWorkArbiter : public IOEventSource
  40 {
  41     OSDeclareDefaultStructors(IOPMWorkArbiter);
  42
  43 private:
  44     enum {
  45         kAllAcked = 0,
  46         kDriverAcked,
  47         kRootDomainClamshellChanged
  48     };
  49
  50     // Queue of requested states
  51     struct PMEventEntry
  52     {
  53         void                    *next;
  54         IOService               *target;
  55         uint16_t                actionType;
  56         uint32_t                intArgument;
  57     };
  58
  59     IOPMrootDomain              *fRootDomain;
  60
  61     void                        *events;
  62     IOLock                      *tmpLock;
  63
  64 protected:
  65     virtual bool checkForWork(void);
  66
  67 public:
  68     IOLock              *arbiterLock;
  69
  70     //typedef void (*Action)(IOService *target, unsigned long state);
  71
  72     virtual bool init(OSObject *owner, Action action = 0);
  73
  74     // static initialiser
  75     static IOPMWorkArbiter *pmWorkArbiter(IOPMrootDomain *owner);
  76
  77     /* IOPMrootDomain work */
  78     bool clamshellStateChangeOccurred(uint32_t messageValue);
  79  };
  80
  81
  82  #endif /* _IOPMWorkArbiter_H_ */
  83