iokit/IOKit/IOReturn.h

   1 /*
   2  * Copyright (c) 1998-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  * HISTORY
  32  */
  33
  34 /*
  35  * Core IOReturn values. Others may be family defined.
  36  */
  37
  38 #ifndef __IOKIT_IORETURN_H
  39 #define __IOKIT_IORETURN_H
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 #include <mach/error.h>
  46
  47 typedef kern_return_t           IOReturn;
  48
  49 #ifndef sys_iokit
  50 #define sys_iokit                         err_system(0x38)
  51 #endif /* sys_iokit */
  52 #define sub_iokit_common                  err_sub(0)
  53 #define sub_iokit_usb                     err_sub(1)
  54 #define sub_iokit_firewire                err_sub(2)
  55 #define sub_iokit_block_storage           err_sub(4)
  56 #define sub_iokit_graphics                err_sub(5)
  57 #define sub_iokit_bluetooth               err_sub(8)
  58 #define sub_iokit_pmu                     err_sub(9)
  59 #define sub_iokit_vendor_specific         err_sub(-2)
  60 #define sub_iokit_reserved                err_sub(-1)
  61
  62 #define iokit_common_err(return)          (sys_iokit|sub_iokit_common|return)
  63 #define iokit_family_err(sub,return)      (sys_iokit|sub|return)
  64 #define iokit_vendor_specific_err(return) (sys_iokit|sub_iokit_vendor_specific|return)
  65
  66 #define kIOReturnSuccess         KERN_SUCCESS            // OK
  67 #define kIOReturnError           iokit_common_err(0x2bc) // general error
  68 #define kIOReturnNoMemory        iokit_common_err(0x2bd) // can't allocate memory
  69 #define kIOReturnNoResources     iokit_common_err(0x2be) // resource shortage
  70 #define kIOReturnIPCError        iokit_common_err(0x2bf) // error during IPC
  71 #define kIOReturnNoDevice        iokit_common_err(0x2c0) // no such device
  72 #define kIOReturnNotPrivileged   iokit_common_err(0x2c1) // privilege violation
  73 #define kIOReturnBadArgument     iokit_common_err(0x2c2) // invalid argument
  74 #define kIOReturnLockedRead      iokit_common_err(0x2c3) // device read locked
  75 #define kIOReturnLockedWrite     iokit_common_err(0x2c4) // device write locked
  76 #define kIOReturnExclusiveAccess iokit_common_err(0x2c5) // exclusive access and
  77                                                          //   device already open
  78 #define kIOReturnBadMessageID    iokit_common_err(0x2c6) // sent/received messages
  79                                                          //   had different msg_id
  80 #define kIOReturnUnsupported     iokit_common_err(0x2c7) // unsupported function
  81 #define kIOReturnVMError         iokit_common_err(0x2c8) // misc. VM failure
  82 #define kIOReturnInternalError   iokit_common_err(0x2c9) // internal error
  83 #define kIOReturnIOError         iokit_common_err(0x2ca) // General I/O error
  84 //#define kIOReturn???Error      iokit_common_err(0x2cb) // ???
  85 #define kIOReturnCannotLock      iokit_common_err(0x2cc) // can't acquire lock
  86 #define kIOReturnNotOpen         iokit_common_err(0x2cd) // device not open
  87 #define kIOReturnNotReadable     iokit_common_err(0x2ce) // read not supported
  88 #define kIOReturnNotWritable     iokit_common_err(0x2cf) // write not supported
  89 #define kIOReturnNotAligned      iokit_common_err(0x2d0) // alignment error
  90 #define kIOReturnBadMedia        iokit_common_err(0x2d1) // Media Error
  91 #define kIOReturnStillOpen       iokit_common_err(0x2d2) // device(s) still open
  92 #define kIOReturnRLDError        iokit_common_err(0x2d3) // rld failure
  93 #define kIOReturnDMAError        iokit_common_err(0x2d4) // DMA failure
  94 #define kIOReturnBusy            iokit_common_err(0x2d5) // Device Busy
  95 #define kIOReturnTimeout         iokit_common_err(0x2d6) // I/O Timeout
  96 #define kIOReturnOffline         iokit_common_err(0x2d7) // device offline
  97 #define kIOReturnNotReady        iokit_common_err(0x2d8) // not ready
  98 #define kIOReturnNotAttached     iokit_common_err(0x2d9) // device not attached
  99 #define kIOReturnNoChannels      iokit_common_err(0x2da) // no DMA channels left
 100 #define kIOReturnNoSpace         iokit_common_err(0x2db) // no space for data
 101 //#define kIOReturn???Error      iokit_common_err(0x2dc) // ???
 102 #define kIOReturnPortExists      iokit_common_err(0x2dd) // port already exists
 103 #define kIOReturnCannotWire      iokit_common_err(0x2de) // can't wire down
 104                                                          //   physical memory
 105 #define kIOReturnNoInterrupt     iokit_common_err(0x2df) // no interrupt attached
 106 #define kIOReturnNoFrames        iokit_common_err(0x2e0) // no DMA frames enqueued
 107 #define kIOReturnMessageTooLarge iokit_common_err(0x2e1) // oversized msg received
 108                                                          //   on interrupt port
 109 #define kIOReturnNotPermitted    iokit_common_err(0x2e2) // not permitted
 110 #define kIOReturnNoPower         iokit_common_err(0x2e3) // no power to device
 111 #define kIOReturnNoMedia         iokit_common_err(0x2e4) // media not present
 112 #define kIOReturnUnformattedMedia iokit_common_err(0x2e5)// media not formatted
 113 #define kIOReturnUnsupportedMode iokit_common_err(0x2e6) // no such mode
 114 #define kIOReturnUnderrun        iokit_common_err(0x2e7) // data underrun
 115 #define kIOReturnOverrun         iokit_common_err(0x2e8) // data overrun
 116 #define kIOReturnDeviceError     iokit_common_err(0x2e9) // the device is not working properly!
 117 #define kIOReturnNoCompletion    iokit_common_err(0x2ea) // a completion routine is required
 118 #define kIOReturnAborted         iokit_common_err(0x2eb) // operation aborted
 119 #define kIOReturnNoBandwidth     iokit_common_err(0x2ec) // bus bandwidth would be exceeded
 120 #define kIOReturnNotResponding   iokit_common_err(0x2ed) // device not responding
 121 #define kIOReturnIsoTooOld       iokit_common_err(0x2ee) // isochronous I/O request for distant past!
 122 #define kIOReturnIsoTooNew       iokit_common_err(0x2ef) // isochronous I/O request for distant future
 123 #define kIOReturnNotFound        iokit_common_err(0x2f0) // data was not found
 124 #define kIOReturnInvalid         iokit_common_err(0x1)   // should never be seen
 125
 126 #ifdef __cplusplus
 127 }
 128 #endif
 129
 130 #endif /* ! __IOKIT_IORETURN_H */