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 | #include <IOKit/IORPC.h> |
40 | IORPCMessage * |
41 | IORPCMessageFromMach(IORPCMessageMach * msg, bool reply); |
42 | |
43 | #ifdef __cplusplus |
44 | extern "C" { |
45 | #endif |
46 | |
47 | #ifndef XNU_PLATFORM_DriverKit |
48 | |
49 | #include <mach/error.h> |
50 | |
51 | #else /* XNU_PLATFORM_DriverKit */ |
52 | |
53 | #ifdef DRIVERKIT_PRIVATE |
54 | |
55 | #include <mach/error.h> |
56 | |
57 | #else /* DRIVERKIT_PRIVATE */ |
58 | |
59 | typedef int kern_return_t; |
60 | |
61 | #define KERN_SUCCESS 0 |
62 | |
63 | /* |
64 | * error number layout as follows: |
65 | * |
66 | * hi lo |
67 | * | system(6) | subsystem(12) | code(14) | |
68 | */ |
69 | |
70 | #define err_none (kern_return_t)0 |
71 | #define ERR_SUCCESS (kern_return_t)0 |
72 | |
73 | #define err_system(x) ((signed)((((unsigned)(x))&0x3f)<<26)) |
74 | #define err_sub(x) (((x)&0xfff)<<14) |
75 | |
76 | #define err_get_system(err) (((err)>>26)&0x3f) |
77 | #define err_get_sub(err) (((err)>>14)&0xfff) |
78 | #define err_get_code(err) ((err)&0x3fff) |
79 | |
80 | #define err_max_system 0x3f |
81 | |
82 | #define system_emask (err_system(err_max_system)) |
83 | #define sub_emask (err_sub(0xfff)) |
84 | #define code_emask (0x3fff) |
85 | |
86 | #endif /* DRIVERKIT_PRIVATE */ |
87 | |
88 | #endif /* XNU_PLATFORM_DriverKit */ |
89 | |
90 | typedef kern_return_t IOReturn; |
91 | |
92 | #ifndef sys_iokit |
93 | #define sys_iokit err_system(0x38) |
94 | #endif /* sys_iokit */ |
95 | #define sub_iokit_common err_sub(0) |
96 | #define sub_iokit_usb err_sub(1) |
97 | #define sub_iokit_firewire err_sub(2) |
98 | #define sub_iokit_block_storage err_sub(4) |
99 | #define sub_iokit_graphics err_sub(5) |
100 | #define sub_iokit_networking err_sub(6) |
101 | #define sub_iokit_bluetooth err_sub(8) |
102 | #define sub_iokit_pmu err_sub(9) |
103 | #define sub_iokit_acpi err_sub(10) |
104 | #define sub_iokit_smbus err_sub(11) |
105 | #define sub_iokit_ahci err_sub(12) |
106 | #define sub_iokit_powermanagement err_sub(13) |
107 | #define sub_iokit_hidsystem err_sub(14) |
108 | #define sub_iokit_scsi err_sub(16) |
109 | #define sub_iokit_usbaudio err_sub(17) |
110 | #define sub_iokit_wirelesscharging err_sub(18) |
111 | //#define sub_iokit_pccard err_sub(21) |
112 | #ifdef PRIVATE |
113 | #define sub_iokit_nvme err_sub(28) |
114 | #endif |
115 | #define sub_iokit_thunderbolt err_sub(29) |
116 | #define sub_iokit_graphics_acceleration err_sub(30) |
117 | #define sub_iokit_keystore err_sub(31) |
118 | #ifdef PRIVATE |
119 | #define sub_iokit_smc err_sub(32) |
120 | #endif |
121 | #define sub_iokit_apfs err_sub(33) |
122 | #define sub_iokit_acpiec err_sub(34) |
123 | #define sub_iokit_timesync_avb err_sub(35) |
124 | |
125 | #define sub_iokit_platform err_sub(0x2A) |
126 | #define sub_iokit_audio_video err_sub(0x45) |
127 | #define sub_iokit_cec err_sub(0x46) |
128 | #define sub_iokit_arc err_sub(0x47) |
129 | #define sub_iokit_baseband err_sub(0x80) |
130 | #define sub_iokit_HDA err_sub(0xFE) |
131 | #define sub_iokit_hsic err_sub(0x147) |
132 | #define sub_iokit_sdio err_sub(0x174) |
133 | #define sub_iokit_wlan err_sub(0x208) |
134 | #define sub_iokit_appleembeddedsleepwakehandler err_sub(0x209) |
135 | #define sub_iokit_appleppm err_sub(0x20A) |
136 | |
137 | #define sub_iokit_vendor_specific err_sub(-2) |
138 | #define sub_iokit_reserved err_sub(-1) |
139 | |
140 | #define iokit_common_err(return ) (sys_iokit|sub_iokit_common|return) |
141 | #define iokit_family_err(sub, return ) (sys_iokit|sub|return) |
142 | #define iokit_vendor_specific_err(return ) (sys_iokit|sub_iokit_vendor_specific|return) |
143 | |
144 | #define kIOReturnSuccess KERN_SUCCESS // OK |
145 | #define kIOReturnError iokit_common_err(0x2bc) // general error |
146 | #define kIOReturnNoMemory iokit_common_err(0x2bd) // can't allocate memory |
147 | #define kIOReturnNoResources iokit_common_err(0x2be) // resource shortage |
148 | #define kIOReturnIPCError iokit_common_err(0x2bf) // error during IPC |
149 | #define kIOReturnNoDevice iokit_common_err(0x2c0) // no such device |
150 | #define kIOReturnNotPrivileged iokit_common_err(0x2c1) // privilege violation |
151 | #define kIOReturnBadArgument iokit_common_err(0x2c2) // invalid argument |
152 | #define kIOReturnLockedRead iokit_common_err(0x2c3) // device read locked |
153 | #define kIOReturnLockedWrite iokit_common_err(0x2c4) // device write locked |
154 | #define kIOReturnExclusiveAccess iokit_common_err(0x2c5) // exclusive access and |
155 | // device already open |
156 | #define kIOReturnBadMessageID iokit_common_err(0x2c6) // sent/received messages |
157 | // had different msg_id |
158 | #define kIOReturnUnsupported iokit_common_err(0x2c7) // unsupported function |
159 | #define kIOReturnVMError iokit_common_err(0x2c8) // misc. VM failure |
160 | #define kIOReturnInternalError iokit_common_err(0x2c9) // internal error |
161 | #define kIOReturnIOError iokit_common_err(0x2ca) // General I/O error |
162 | //#define kIOReturn???Error iokit_common_err(0x2cb) // ??? |
163 | #define kIOReturnCannotLock iokit_common_err(0x2cc) // can't acquire lock |
164 | #define kIOReturnNotOpen iokit_common_err(0x2cd) // device not open |
165 | #define kIOReturnNotReadable iokit_common_err(0x2ce) // read not supported |
166 | #define kIOReturnNotWritable iokit_common_err(0x2cf) // write not supported |
167 | #define kIOReturnNotAligned iokit_common_err(0x2d0) // alignment error |
168 | #define kIOReturnBadMedia iokit_common_err(0x2d1) // Media Error |
169 | #define kIOReturnStillOpen iokit_common_err(0x2d2) // device(s) still open |
170 | #define kIOReturnRLDError iokit_common_err(0x2d3) // rld failure |
171 | #define kIOReturnDMAError iokit_common_err(0x2d4) // DMA failure |
172 | #define kIOReturnBusy iokit_common_err(0x2d5) // Device Busy |
173 | #define kIOReturnTimeout iokit_common_err(0x2d6) // I/O Timeout |
174 | #define kIOReturnOffline iokit_common_err(0x2d7) // device offline |
175 | #define kIOReturnNotReady iokit_common_err(0x2d8) // not ready |
176 | #define kIOReturnNotAttached iokit_common_err(0x2d9) // device not attached |
177 | #define kIOReturnNoChannels iokit_common_err(0x2da) // no DMA channels left |
178 | #define kIOReturnNoSpace iokit_common_err(0x2db) // no space for data |
179 | //#define kIOReturn???Error iokit_common_err(0x2dc) // ??? |
180 | #define kIOReturnPortExists iokit_common_err(0x2dd) // port already exists |
181 | #define kIOReturnCannotWire iokit_common_err(0x2de) // can't wire down |
182 | // physical memory |
183 | #define kIOReturnNoInterrupt iokit_common_err(0x2df) // no interrupt attached |
184 | #define kIOReturnNoFrames iokit_common_err(0x2e0) // no DMA frames enqueued |
185 | #define kIOReturnMessageTooLarge iokit_common_err(0x2e1) // oversized msg received |
186 | // on interrupt port |
187 | #define kIOReturnNotPermitted iokit_common_err(0x2e2) // not permitted |
188 | #define kIOReturnNoPower iokit_common_err(0x2e3) // no power to device |
189 | #define kIOReturnNoMedia iokit_common_err(0x2e4) // media not present |
190 | #define kIOReturnUnformattedMedia iokit_common_err(0x2e5)// media not formatted |
191 | #define kIOReturnUnsupportedMode iokit_common_err(0x2e6) // no such mode |
192 | #define kIOReturnUnderrun iokit_common_err(0x2e7) // data underrun |
193 | #define kIOReturnOverrun iokit_common_err(0x2e8) // data overrun |
194 | #define kIOReturnDeviceError iokit_common_err(0x2e9) // the device is not working properly! |
195 | #define kIOReturnNoCompletion iokit_common_err(0x2ea) // a completion routine is required |
196 | #define kIOReturnAborted iokit_common_err(0x2eb) // operation aborted |
197 | #define kIOReturnNoBandwidth iokit_common_err(0x2ec) // bus bandwidth would be exceeded |
198 | #define kIOReturnNotResponding iokit_common_err(0x2ed) // device not responding |
199 | #define kIOReturnIsoTooOld iokit_common_err(0x2ee) // isochronous I/O request for distant past! |
200 | #define kIOReturnIsoTooNew iokit_common_err(0x2ef) // isochronous I/O request for distant future |
201 | #define kIOReturnNotFound iokit_common_err(0x2f0) // data was not found |
202 | #define kIOReturnInvalid iokit_common_err(0x1) // should never be seen |
203 | |
204 | #ifdef __cplusplus |
205 | } |
206 | #endif |
207 | |
208 | #endif /* ! __IOKIT_IORETURN_H */ |
209 | |