iokit/IOKit/IOMessage.h

   1 /*
   2  * Copyright (c) 1998-2000 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
  29 #ifndef __IOKIT_IOMESSAGE_H
  30 #define __IOKIT_IOMESSAGE_H
  31
  32 #include <IOKit/IOReturn.h>
  33 #include <IOKit/IOTypes.h>
  34
  35 typedef UInt32 IOMessage;
  36
  37 #define iokit_common_msg(message)          (UInt32)(sys_iokit|sub_iokit_common|message)
  38 #define iokit_family_msg(sub,message)      (UInt32)(sys_iokit|sub|message)
  39
  40 /*! @defined iokit_vendor_specific_msg
  41     @discussion iokit_vendor_specific_msg passes messages in the sub_iokit_vendor_specific
  42     subsystem. It can be used to be generate messages that are used for private
  43     communication between vendor specific code with the  IOService::message() etc. APIs.
  44 */
  45 #define iokit_vendor_specific_msg(message) (UInt32)(sys_iokit|sub_iokit_vendor_specific|message)
  46
  47 #define kIOMessageServiceIsTerminated      iokit_common_msg(0x010)
  48 #define kIOMessageServiceIsSuspended       iokit_common_msg(0x020)
  49 #define kIOMessageServiceIsResumed         iokit_common_msg(0x030)
  50
  51 #define kIOMessageServiceIsRequestingClose iokit_common_msg(0x100)
  52 #define kIOMessageServiceIsAttemptingOpen  iokit_common_msg(0x101)
  53 #define kIOMessageServiceWasClosed         iokit_common_msg(0x110)
  54
  55 #define kIOMessageServiceBusyStateChange   iokit_common_msg(0x120)
  56
  57 #define kIOMessageServicePropertyChange    iokit_common_msg(0x130)
  58
  59 #define kIOMessageCanDevicePowerOff        iokit_common_msg(0x200)
  60 #define kIOMessageDeviceWillPowerOff       iokit_common_msg(0x210)
  61 #define kIOMessageDeviceWillNotPowerOff    iokit_common_msg(0x220)
  62 #define kIOMessageDeviceHasPoweredOn       iokit_common_msg(0x230)
  63 #define kIOMessageCanSystemPowerOff        iokit_common_msg(0x240)
  64 #define kIOMessageSystemWillPowerOff       iokit_common_msg(0x250)
  65 #define kIOMessageSystemWillNotPowerOff    iokit_common_msg(0x260)
  66 #define kIOMessageCanSystemSleep           iokit_common_msg(0x270)
  67 #define kIOMessageSystemWillSleep          iokit_common_msg(0x280)
  68 #define kIOMessageSystemWillNotSleep       iokit_common_msg(0x290)
  69 #define kIOMessageSystemHasPoweredOn       iokit_common_msg(0x300)
  70 #define kIOMessageSystemWillRestart        iokit_common_msg(0x310)
  71 #define kIOMessageSystemWillPowerOn        iokit_common_msg(0x320)
  72
  73 #define kIOMessageCopyClientID             iokit_common_msg(0x330)
  74
  75 #endif /* ! __IOKIT_IOMESSAGE_H */