xnu-1699.32.7.tar.gz
[apple/xnu.git] / iokit / IOKit / IOReturn.h
CommitLineData
1c79356b 1/*
55e303ae 2 * Copyright (c) 1998-2002 Apple Computer, Inc. All rights reserved.
1c79356b 3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b 5 *
2d21ac55
A
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.
8f6c56a5 14 *
2d21ac55
A
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
8f6c56a5
A
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55
A
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.
8f6c56a5 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b
A
27 */
28/*
1c79356b 29 * HISTORY
1c79356b
A
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
40extern "C" {
41#endif
42
43#include <mach/error.h>
44
45typedef kern_return_t IOReturn;
46
47#ifndef sys_iokit
91447636 48#define sys_iokit err_system(0x38)
1c79356b 49#endif /* sys_iokit */
91447636
A
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)
0c530ab8 55#define sub_iokit_networking err_sub(6)
91447636
A
56#define sub_iokit_bluetooth err_sub(8)
57#define sub_iokit_pmu err_sub(9)
0c530ab8
A
58#define sub_iokit_acpi err_sub(10)
59#define sub_iokit_smbus err_sub(11)
60#define sub_iokit_ahci err_sub(12)
61#define sub_iokit_powermanagement err_sub(13)
62//#define sub_iokit_hidsystem err_sub(14)
7e4a7d39 63#define sub_iokit_scsi err_sub(16)
0c530ab8 64//#define sub_iokit_pccard err_sub(21)
060df5ea 65#define sub_iokit_thunderbolt err_sub(29)
0c530ab8 66
91447636
A
67#define sub_iokit_vendor_specific err_sub(-2)
68#define sub_iokit_reserved err_sub(-1)
69
70#define iokit_common_err(return) (sys_iokit|sub_iokit_common|return)
71#define iokit_family_err(sub,return) (sys_iokit|sub|return)
72#define iokit_vendor_specific_err(return) (sys_iokit|sub_iokit_vendor_specific|return)
1c79356b
A
73
74#define kIOReturnSuccess KERN_SUCCESS // OK
75#define kIOReturnError iokit_common_err(0x2bc) // general error
76#define kIOReturnNoMemory iokit_common_err(0x2bd) // can't allocate memory
77#define kIOReturnNoResources iokit_common_err(0x2be) // resource shortage
78#define kIOReturnIPCError iokit_common_err(0x2bf) // error during IPC
79#define kIOReturnNoDevice iokit_common_err(0x2c0) // no such device
80#define kIOReturnNotPrivileged iokit_common_err(0x2c1) // privilege violation
81#define kIOReturnBadArgument iokit_common_err(0x2c2) // invalid argument
82#define kIOReturnLockedRead iokit_common_err(0x2c3) // device read locked
83#define kIOReturnLockedWrite iokit_common_err(0x2c4) // device write locked
84#define kIOReturnExclusiveAccess iokit_common_err(0x2c5) // exclusive access and
85 // device already open
86#define kIOReturnBadMessageID iokit_common_err(0x2c6) // sent/received messages
87 // had different msg_id
88#define kIOReturnUnsupported iokit_common_err(0x2c7) // unsupported function
89#define kIOReturnVMError iokit_common_err(0x2c8) // misc. VM failure
90#define kIOReturnInternalError iokit_common_err(0x2c9) // internal error
91#define kIOReturnIOError iokit_common_err(0x2ca) // General I/O error
92//#define kIOReturn???Error iokit_common_err(0x2cb) // ???
93#define kIOReturnCannotLock iokit_common_err(0x2cc) // can't acquire lock
94#define kIOReturnNotOpen iokit_common_err(0x2cd) // device not open
95#define kIOReturnNotReadable iokit_common_err(0x2ce) // read not supported
96#define kIOReturnNotWritable iokit_common_err(0x2cf) // write not supported
97#define kIOReturnNotAligned iokit_common_err(0x2d0) // alignment error
98#define kIOReturnBadMedia iokit_common_err(0x2d1) // Media Error
99#define kIOReturnStillOpen iokit_common_err(0x2d2) // device(s) still open
100#define kIOReturnRLDError iokit_common_err(0x2d3) // rld failure
101#define kIOReturnDMAError iokit_common_err(0x2d4) // DMA failure
102#define kIOReturnBusy iokit_common_err(0x2d5) // Device Busy
103#define kIOReturnTimeout iokit_common_err(0x2d6) // I/O Timeout
104#define kIOReturnOffline iokit_common_err(0x2d7) // device offline
105#define kIOReturnNotReady iokit_common_err(0x2d8) // not ready
106#define kIOReturnNotAttached iokit_common_err(0x2d9) // device not attached
107#define kIOReturnNoChannels iokit_common_err(0x2da) // no DMA channels left
108#define kIOReturnNoSpace iokit_common_err(0x2db) // no space for data
109//#define kIOReturn???Error iokit_common_err(0x2dc) // ???
110#define kIOReturnPortExists iokit_common_err(0x2dd) // port already exists
111#define kIOReturnCannotWire iokit_common_err(0x2de) // can't wire down
112 // physical memory
113#define kIOReturnNoInterrupt iokit_common_err(0x2df) // no interrupt attached
114#define kIOReturnNoFrames iokit_common_err(0x2e0) // no DMA frames enqueued
115#define kIOReturnMessageTooLarge iokit_common_err(0x2e1) // oversized msg received
116 // on interrupt port
117#define kIOReturnNotPermitted iokit_common_err(0x2e2) // not permitted
118#define kIOReturnNoPower iokit_common_err(0x2e3) // no power to device
119#define kIOReturnNoMedia iokit_common_err(0x2e4) // media not present
120#define kIOReturnUnformattedMedia iokit_common_err(0x2e5)// media not formatted
121#define kIOReturnUnsupportedMode iokit_common_err(0x2e6) // no such mode
122#define kIOReturnUnderrun iokit_common_err(0x2e7) // data underrun
123#define kIOReturnOverrun iokit_common_err(0x2e8) // data overrun
124#define kIOReturnDeviceError iokit_common_err(0x2e9) // the device is not working properly!
125#define kIOReturnNoCompletion iokit_common_err(0x2ea) // a completion routine is required
126#define kIOReturnAborted iokit_common_err(0x2eb) // operation aborted
127#define kIOReturnNoBandwidth iokit_common_err(0x2ec) // bus bandwidth would be exceeded
128#define kIOReturnNotResponding iokit_common_err(0x2ed) // device not responding
129#define kIOReturnIsoTooOld iokit_common_err(0x2ee) // isochronous I/O request for distant past!
130#define kIOReturnIsoTooNew iokit_common_err(0x2ef) // isochronous I/O request for distant future
131#define kIOReturnNotFound iokit_common_err(0x2f0) // data was not found
132#define kIOReturnInvalid iokit_common_err(0x1) // should never be seen
133
134#ifdef __cplusplus
135}
136#endif
137
138#endif /* ! __IOKIT_IORETURN_H */