iokit/IOKit/pwr_mgt/IOPMPrivate.h

   1 /*
   2  * Copyright (c) 2002 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_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. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 #ifndef _IOKIT_IOPMPRIVATE_H
  29 #define _IOKIT_IOPMPRIVATE_H
  30
  31 #include <IOKit/pwr_mgt/IOPM.h>
  32
  33 // Private power commands issued to root domain
  34 // bits 0-7 in IOPM.h
  35
  36 enum {
  37     kIOPMSetValue               = (1<<16),
  38     // don't sleep on clamshell closure on a portable with AC connected
  39     kIOPMSetDesktopMode         = (1<<17),
  40     // set state of AC adaptor connected
  41     kIOPMSetACAdaptorConnected  = (1<<18)
  42 };
  43
  44 /*
  45  * PM notification types
  46  */
  47
  48 /* @constant kIOPMStateConsoleUserShutdown
  49  * @abstract Notification of GUI shutdown state available to kexts.
  50  * @discussion This type can be passed as arguments to registerPMSettingController()
  51  * to receive callbacks.
  52  */
  53 #define kIOPMStateConsoleShutdown   "ConsoleShutdown"
  54
  55 /* @enum ShutdownValues
  56  * @abstract Potential values shared with key kIOPMStateConsoleUserShutdown
  57  */
  58 enum {
  59 /* @constant kIOPMStateConsoleShutdownNone
  60  * @abstract System shutdown (or restart) hasn't started; system is ON.
  61  * @discussion Next state: 2
  62  */
  63     kIOPMStateConsoleShutdownNone   = 1,
  64 /* @constant kIOPMStateConsoleShutdownPossible
  65  * @abstract User has been presented with the option to shutdown or restart. Shutdown may be cancelled.
  66  * @discussion Next state may be: 1, 4
  67  */
  68     kIOPMStateConsoleShutdownPossible = 2,
  69 /* @constant kIOPMStateConsoleShutdownUnderway
  70  * @abstract Shutdown or restart is proceeding. It may still be cancelled.
  71  * @discussion Next state may be: 1, 4. This state is currently unused.
  72  */
  73     kIOPMStateConsoleShutdownUnderway = 3,
  74 /* @constant kIOPMStateConsoleShutdownCertain
  75  * @abstract Shutdown is in progress and irrevocable.
  76  * @discussion State remains 4 until power is removed from CPU.
  77  */
  78     kIOPMStateConsoleShutdownCertain = 4
  79 };
  80
  81 #endif /* ! _IOKIT_IOPMPRIVATE_H */
  82