iokit/IOKit/IOPMEventSource.h

   1 /*
   2  * Copyright (c) 2001-2002 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22
  23  #ifndef _IOPMEVENTSOURCE_H_
  24  #define _IOPMEVENTSOURCE_H_
  25
  26  #include <IOKit/IOWorkLoop.h>
  27  #include <IOKit/IOEventSource.h>
  28
  29     // Queue of requested states
  30      typedef struct {
  31         unsigned long           state;
  32         void                    *next;
  33     } ActivityTickleStateList;
  34
  35  class IOPMEventSource : public IOEventSource
  36  {
  37     OSDeclareDefaultStructors(IOPMEventSource);
  38
  39 protected:
  40     virtual bool checkForWork(void);
  41
  42     ActivityTickleStateList             *states;
  43
  44 public:
  45     typedef void (*Action)(OSObject *owner, unsigned long state);
  46
  47     // static initialiser
  48     static IOPMEventSource *PMEventSource(OSObject *owner, Action action);
  49
  50     virtual bool init(OSObject *owner, Action action);
  51
  52     // Enqueues an activityTickle request to be executed on the workloop
  53     virtual IOReturn activityTickleOccurred(unsigned long);
  54  };
  55
  56  #endif /* _IOPMEVENTSOURCE_H_ */
  57