iokit/IOKit/IOPMEventSource.h

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