iokit/IOKit/IOReturn.h

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