iokit/IOKit/IOPMEventSource.h

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