ADC Home > Reference Library > Reference > Hardware & Drivers > I/O Kit Framework Reference

 


IOReturn.h

Include Path:

<IOKit/IOReturn.h>

Path:

/System/Library/Frameworks/IOKit.framework/Versions/A/Headers/IOReturn.h

Includes:
<mach/error.h>

Overview

This header contains standard return codes common to all of the I/O Kit. Individual I/O Kit families may define additional error codes.



Typedefs


IOReturn


typedef kern_return_t IOReturn;  
Discussion

IOReturn is the return type used for most I/O Kit functions that can return an error.

#defines


iokit_common_err


#define iokit_common_err(return)  
Discussion

The iokit_common_err macro is defined as iokit_common_err(return) (sys_iokit|sub_iokit_common|return).


iokit_family_err


#define iokit_family_err(sub,return)  
Discussion

The iokit_family_err macro is defined as iokit_family_err(sub,return) (sys_iokit|sub|return).


iokit_vendor_specific_err


#define iokit_vendor_specific_err(return)  
Discussion

The iokit_vendor_specific_err macro is defined as iokit_vendor_specific_err(return) (sys_iokit|sub_iokit_vendor_specific|return).


kIOReturnAborted


The operation has been aborted (0xe00002eb).

#define kIOReturnAborted   


kIOReturnBadArgument


There is an invalid argument (0xe00002c2).

#define kIOReturnBadArgument   


kIOReturnBadMedia


There has been a media error (0xe00002d1).

#define kIOReturnBadMedia   


kIOReturnBadMessageID


The sent or received message had a different message id (0xe00002c6).

#define kIOReturnBadMessageID   


kIOReturnBusy


The device is busy (0xe00002d5).

#define kIOReturnBusy   


kIOReturnCannotLock


The lock cannot be acquired (0xe00002cc).

#define kIOReturnCannotLock   


kIOReturnCannotWire


Physical memory can't be wired down (0xe00002de).

#define kIOReturnCannotWire   


kIOReturnDeviceError


There has been a device error (0xe00002e9).

#define kIOReturnDeviceError   


kIOReturnDMAError


There has been a DMA failure (0xe00002d4).

#define kIOReturnDMAError   


kIOReturnError


A general error (0xe00002bc).

#define kIOReturnError   


kIOReturnExclusiveAccess


The device is already open with exclusive access (0xe00002c5).

#define kIOReturnExclusiveAccess   


kIOReturnInternalError


There has been an internal error (0xe00002c9).

#define kIOReturnInternalError   


kIOReturnInvalid


The is an invalid error (should never be seen) (0xe0000001).

#define kIOReturnInvalid   


kIOReturnIOError


There has been a general I/O error (0xe00002ca).

#define kIOReturnIOError   


kIOReturnIPCError


There has been an error during IPC (inter-process communication) (0xe00002bf).

#define kIOReturnIPCError   


kIOReturnIsoTooNew


The isochronous I/O request is too early (0xe00002ef).

#define kIOReturnIsoTooNew   


kIOReturnIsoTooOld


The isochronous I/O request is too old (0xe00002ee).

#define kIOReturnIsoTooOld   


kIOReturnLockedRead


The device is read locked (0xe00002c3).

#define kIOReturnLockedRead   


kIOReturnLockedWrite


The device is write locked (0xe00002c4).

#define kIOReturnLockedWrite   


kIOReturnMessageTooLarge


An oversized message has been received on an interrupt port (0xe00002e1).

#define kIOReturnMessageTooLarge   


kIOReturnNoBandwidth


The operation will cause bus bandwidth to be exceeded (0xe00002ec).

#define kIOReturnNoBandwidth   


kIOReturnNoChannels


There are no DMA channels left (0xe00002da).

#define kIOReturnNoChannels   


kIOReturnNoCompletion


A completion routine is required (0xe00002ea).

#define kIOReturnNoCompletion   


kIOReturnNoDevice


There is no such device (0xe00002c0).

#define kIOReturnNoDevice   


kIOReturnNoFrames


There are no DMA frames enqueued (0xe00002e0).

#define kIOReturnNoFrames   


kIOReturnNoInterrupt


There is no interrupt attached (0xe00002df).

#define kIOReturnNoInterrupt   


kIOReturnNoMedia


No media is present (0xe00002e4).

#define kIOReturnNoMedia   


kIOReturnNoMemory


Memory can't be allocated (0xe00002bd).

#define kIOReturnNoMemory   


kIOReturnNoPower


There is no power to the device (0xe00002e3).

#define kIOReturnNoPower   


kIOReturnNoResources


There is a resource shortage (0xe00002be).

#define kIOReturnNoResources   


kIOReturnNoSpace


There is no space for data (0xe00002db).

#define kIOReturnNoSpace   


kIOReturnNotAligned


There has been an alignment error (0xe00002d0).

#define kIOReturnNotAligned   


kIOReturnNotAttached


The device is not attached (0xe00002d9).

#define kIOReturnNotAttached   


kIOReturnNotFound


The data was not found (0xe00002f0).

#define kIOReturnNotFound   


kIOReturnNotOpen


The device is not open (0xe00002cd).

#define kIOReturnNotOpen   


kIOReturnNotPermitted


The operation is not permitted (0xe00002e2).

#define kIOReturnNotPermitted   


kIOReturnNotPrivileged


There has been a privilege violation (0xe00002c1).

#define kIOReturnNotPrivileged   


kIOReturnNotReadable


Read is not supported (0xe00002ce).

#define kIOReturnNotReadable   


kIOReturnNotReady


The device is not ready (0xe00002d8).

#define kIOReturnNotReady   


kIOReturnNotResponding


The device is not responding (0xe00002ed).

#define kIOReturnNotResponding   


kIOReturnNotWritable


Write is not supported (0xe00002cf).

#define kIOReturnNotWritable   


kIOReturnOffline


The device is offline (0xe00002d7).

#define kIOReturnOffline   


kIOReturnOverrun


There has been a data overrun (0xe00002e8).

#define kIOReturnOverrun   


kIOReturnPortExists


The port already exists (0xe00002dd).

#define kIOReturnPortExists   


kIOReturnRLDError


There has been an RLD failure (0xe00002d3).

#define kIOReturnRLDError   


kIOReturnStillOpen


The device is still open (0xe00002d2).

#define kIOReturnStillOpen   


kIOReturnSuccess


Success.

#define kIOReturnSuccess KERN_SUCCESS // OK  


kIOReturnTimeout


The I/O has timed out (0xe00002d6).

#define kIOReturnTimeout   


kIOReturnUnderrun


There has been a data underrun (0xe00002e7).

#define kIOReturnUnderrun   


kIOReturnUnformattedMedia


The media is not formatted (0xe00002e5).

#define kIOReturnUnformattedMedia   


kIOReturnUnsupported


This is an unsupported function (0xe00002c7).

#define kIOReturnUnsupported   


kIOReturnUnsupportedMode


There is no such mode (0xe00002e6).

#define kIOReturnUnsupportedMode   


kIOReturnVMError


There is some sort of VM (virtual memory) failure (0xe00002c8).

#define kIOReturnVMError   


sub_iokit_block_storage


#define sub_iokit_block_storage err_sub(4) 
Discussion

The sub_iokit_block_storage macro is defined as sub_iokit_block_storage err_sub(4).


sub_iokit_bluetooth


#define sub_iokit_bluetooth err_sub(8) 
Discussion

The sub_iokit_bluetooth macro is defined as sub_iokit_bluetooth err_sub(8).


sub_iokit_common


#define sub_iokit_common err_sub(0) 
Discussion

The sub_iokit_common macro is defined as sub_iokit_common err_sub(0).


sub_iokit_firewire


#define sub_iokit_firewire err_sub(2) 
Discussion

The sub_iokit_firewire macro is defined as sub_iokit_firewire err_sub(2).


sub_iokit_graphics


#define sub_iokit_graphics err_sub(5) 
Discussion

The sub_iokit_graphics macro is defined as sub_iokit_graphics err_sub(5).


sub_iokit_pmu


#define sub_iokit_pmu err_sub(9) 
Discussion

The sub_iokit_pmu macro is defined as sub_iokit_pmu err_sub(9).


sub_iokit_reserved


#define sub_iokit_reserved err_sub(-1) 
Discussion

The sub_iokit_reserved macro is defined as sub_iokit_reserved err_sub(-1).


sub_iokit_usb


#define sub_iokit_usb err_sub(1) 
Discussion

The sub_iokit_usb macro is defined as sub_iokit_usb err_sub(1).


sub_iokit_vendor_specific


#define sub_iokit_vendor_specific err_sub(-2) 
Discussion

The sub_iokit_vendor_specific macro is defined as sub_iokit_vendor_specific err_sub(-2).


sys_iokit


#define sys_iokit err_system(0x38) 
Discussion

The sys_iokit macro is defined as sys_iokit err_system(0x38).


Did this document help you?
Yes: Tell us what works for you.
It’s good, but: Report typos, inaccuracies, and so forth.
It wasn’t helpful: Tell us what would have helped.

 

Last Updated: 2009-02-23