iokit/IOKit/IOPMEventSource.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 _IOPMEVENTSOURCE_H_
  32  #define _IOPMEVENTSOURCE_H_
  33
  34  #include <IOKit/IOWorkLoop.h>
  35  #include <IOKit/IOEventSource.h>
  36
  37     // Queue of requested states
  38      typedef struct {
  39         unsigned long           state;
  40         void                    *next;
  41     } ActivityTickleStateList;
  42
  43  class IOPMEventSource : public IOEventSource
  44  {
  45     OSDeclareDefaultStructors(IOPMEventSource);
  46
  47 protected:
  48     virtual bool checkForWork(void);
  49
  50     ActivityTickleStateList             *states;
  51
  52 public:
  53     typedef void (*Action)(OSObject *owner, unsigned long state);
  54
  55     // static initialiser
  56     static IOPMEventSource *PMEventSource(OSObject *owner, Action action);
  57
  58     virtual bool init(OSObject *owner, Action action);
  59
  60     // Enqueues an activityTickle request to be executed on the workloop
  61     virtual IOReturn activityTickleOccurred(unsigned long);
  62  };
  63
  64  #endif /* _IOPMEVENTSOURCE_H_ */
  65