iokit/Kernel/IOPMWorkArbiter.h

   1 /*
   2  * Copyright (c) 2001-2002 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_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
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30
  31 #ifndef _IOPMWorkArbiter_H_
  32 #define _IOPMWorkArbiter_H_
  33
  34 #include <IOKit/IOWorkLoop.h>
  35 #include <IOKit/IOEventSource.h>
  36 #include <IOKit/IOService.h>
  37 extern "C" {
  38     #include <kern/queue.h>
  39 }
  40
  41 class IOPMWorkArbiter : public IOEventSource
  42 {
  43     OSDeclareDefaultStructors(IOPMWorkArbiter);
  44
  45 private:
  46     enum {
  47         kAllAcked = 0,
  48         kDriverAcked,
  49         kRootDomainClamshellChanged
  50     };
  51
  52     // Queue of requested states
  53     struct PMEventEntry
  54     {
  55         void                    *next;
  56         IOService               *target;
  57         uint16_t                actionType;
  58         uint32_t                intArgument;
  59     };
  60
  61     IOPMrootDomain              *fRootDomain;
  62
  63     void                        *events;
  64     IOLock                      *tmpLock;
  65
  66 protected:
  67     virtual bool checkForWork(void);
  68
  69 public:
  70     IOLock              *arbiterLock;
  71
  72     //typedef void (*Action)(IOService *target, unsigned long state);
  73
  74     virtual bool init(OSObject *owner, Action action = 0);
  75
  76     // static initialiser
  77     static IOPMWorkArbiter *pmWorkArbiter(IOPMrootDomain *owner);
  78
  79     // thread launcher
  80     static void checkForWorkThreadFunc(void *refcon);
  81
  82     /* IOServicePM work */
  83     bool allAckedOccurred(IOService *inTarget);
  84     bool driverAckedOccurred(IOService *inTarget);
  85
  86     /* IOPMrootDomain work */
  87     bool clamshellStateChangeOccurred(uint32_t messageValue);
  88  };
  89
  90
  91 /*
  92 class PMWorkUnit : public OSObject
  93 {
  94     friend class IOService:
  95     OSDeclareDefaultStructors(PMWorkUnit)
  96 public:
  97     uint16_t        type;
  98     IOService       *who;
  99 }
 100
 101 class PMWorkerThread : public OSObject
 102 {
 103     friend class IOService;
 104     OSDeclareDefaultStructors(PMWorkerThread)
 105
 106 public:
 107     virtual void free();
 108
 109     static PMWorkerThread *workerThread( void );
 110     static void main( PMWorkerThread * self );
 111 };
 112 */
 113
 114  #endif /* _IOPMWorkArbiter_H_ */
 115