[apple/xnu.git] / iokit / IOKit / IOReturn.h

/*
 * Copyright (c) 1998-2002 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * HISTORY
 */

/*
 * Core IOReturn values. Others may be family defined.
 */

#ifndef __IOKIT_IORETURN_H
#define __IOKIT_IORETURN_H

#ifdef __cplusplus
extern "C" {
#endif

#ifndef PLATFORM_DriverKit

#include <mach/error.h>

#else  /* PLATFORM_DriverKit */

typedef int             kern_return_t;

#define KERN_SUCCESS                    0

/*
 *	error number layout as follows:
 *
 *	hi		                       lo
 *	| system(6) | subsystem(12) | code(14) |
 */

#define err_none                (kern_return_t)0
#define ERR_SUCCESS             (kern_return_t)0

#define err_system(x)           ((signed)((((unsigned)(x))&0x3f)<<26))
#define err_sub(x)              (((x)&0xfff)<<14)

#define err_get_system(err)     (((err)>>26)&0x3f)
#define err_get_sub(err)        (((err)>>14)&0xfff)
#define err_get_code(err)       ((err)&0x3fff)

#define err_max_system          0x3f

#define system_emask            (err_system(err_max_system))
#define sub_emask               (err_sub(0xfff))
#define code_emask              (0x3fff)

#endif /* PLATFORM_DriverKit */

typedef kern_return_t           IOReturn;

#ifndef sys_iokit
#define sys_iokit                         err_system(0x38)
#endif /* sys_iokit */
#define sub_iokit_common                  err_sub(0)
#define sub_iokit_usb                     err_sub(1)
#define sub_iokit_firewire                err_sub(2)
#define sub_iokit_block_storage           err_sub(4)
#define sub_iokit_graphics                err_sub(5)
#define sub_iokit_networking              err_sub(6)
#define sub_iokit_bluetooth               err_sub(8)
#define sub_iokit_pmu                     err_sub(9)
#define sub_iokit_acpi                    err_sub(10)
#define sub_iokit_smbus                   err_sub(11)
#define sub_iokit_ahci                    err_sub(12)
#define sub_iokit_powermanagement         err_sub(13)
#define sub_iokit_hidsystem               err_sub(14)
#define sub_iokit_scsi                    err_sub(16)
#define sub_iokit_usbaudio                err_sub(17)
#define sub_iokit_wirelesscharging        err_sub(18)
//#define sub_iokit_pccard                err_sub(21)
#ifdef PRIVATE
#define sub_iokit_nvme                    err_sub(28)
#endif
#define sub_iokit_thunderbolt             err_sub(29)
#define sub_iokit_graphics_acceleration   err_sub(30)
#define sub_iokit_keystore                err_sub(31)
#ifdef PRIVATE
#define sub_iokit_smc                     err_sub(32)
#endif
#define sub_iokit_apfs                    err_sub(33)
#define sub_iokit_acpiec                  err_sub(34)
#define sub_iokit_timesync_avb            err_sub(35)

#define sub_iokit_platform                err_sub(0x2A)
#define sub_iokit_audio_video             err_sub(0x45)
#define sub_iokit_cec                     err_sub(0x46)
#define sub_iokit_baseband                err_sub(0x80)
#define sub_iokit_HDA                     err_sub(0xFE)
#define sub_iokit_hsic                    err_sub(0x147)
#define sub_iokit_sdio                    err_sub(0x174)
#define sub_iokit_wlan                    err_sub(0x208)
#define sub_iokit_appleembeddedsleepwakehandler  err_sub(0x209)
#define sub_iokit_appleppm                err_sub(0x20A)

#define sub_iokit_vendor_specific         err_sub(-2)
#define sub_iokit_reserved                err_sub(-1)

#define iokit_common_err(return )          (sys_iokit|sub_iokit_common|return)
#define iokit_family_err(sub, return )      (sys_iokit|sub|return)
#define iokit_vendor_specific_err(return ) (sys_iokit|sub_iokit_vendor_specific|return)

#define kIOReturnSuccess         KERN_SUCCESS            // OK
#define kIOReturnError           iokit_common_err(0x2bc) // general error
#define kIOReturnNoMemory        iokit_common_err(0x2bd) // can't allocate memory
#define kIOReturnNoResources     iokit_common_err(0x2be) // resource shortage
#define kIOReturnIPCError        iokit_common_err(0x2bf) // error during IPC
#define kIOReturnNoDevice        iokit_common_err(0x2c0) // no such device
#define kIOReturnNotPrivileged   iokit_common_err(0x2c1) // privilege violation
#define kIOReturnBadArgument     iokit_common_err(0x2c2) // invalid argument
#define kIOReturnLockedRead      iokit_common_err(0x2c3) // device read locked
#define kIOReturnLockedWrite     iokit_common_err(0x2c4) // device write locked
#define kIOReturnExclusiveAccess iokit_common_err(0x2c5) // exclusive access and
                                                         //   device already open
#define kIOReturnBadMessageID    iokit_common_err(0x2c6) // sent/received messages
                                                         //   had different msg_id
#define kIOReturnUnsupported     iokit_common_err(0x2c7) // unsupported function
#define kIOReturnVMError         iokit_common_err(0x2c8) // misc. VM failure
#define kIOReturnInternalError   iokit_common_err(0x2c9) // internal error
#define kIOReturnIOError         iokit_common_err(0x2ca) // General I/O error
//#define kIOReturn???Error      iokit_common_err(0x2cb) // ???
#define kIOReturnCannotLock      iokit_common_err(0x2cc) // can't acquire lock
#define kIOReturnNotOpen         iokit_common_err(0x2cd) // device not open
#define kIOReturnNotReadable     iokit_common_err(0x2ce) // read not supported
#define kIOReturnNotWritable     iokit_common_err(0x2cf) // write not supported
#define kIOReturnNotAligned      iokit_common_err(0x2d0) // alignment error
#define kIOReturnBadMedia        iokit_common_err(0x2d1) // Media Error
#define kIOReturnStillOpen       iokit_common_err(0x2d2) // device(s) still open
#define kIOReturnRLDError        iokit_common_err(0x2d3) // rld failure
#define kIOReturnDMAError        iokit_common_err(0x2d4) // DMA failure
#define kIOReturnBusy            iokit_common_err(0x2d5) // Device Busy
#define kIOReturnTimeout         iokit_common_err(0x2d6) // I/O Timeout
#define kIOReturnOffline         iokit_common_err(0x2d7) // device offline
#define kIOReturnNotReady        iokit_common_err(0x2d8) // not ready
#define kIOReturnNotAttached     iokit_common_err(0x2d9) // device not attached
#define kIOReturnNoChannels      iokit_common_err(0x2da) // no DMA channels left
#define kIOReturnNoSpace         iokit_common_err(0x2db) // no space for data
//#define kIOReturn???Error      iokit_common_err(0x2dc) // ???
#define kIOReturnPortExists      iokit_common_err(0x2dd) // port already exists
#define kIOReturnCannotWire      iokit_common_err(0x2de) // can't wire down
                                                         //   physical memory
#define kIOReturnNoInterrupt     iokit_common_err(0x2df) // no interrupt attached
#define kIOReturnNoFrames        iokit_common_err(0x2e0) // no DMA frames enqueued
#define kIOReturnMessageTooLarge iokit_common_err(0x2e1) // oversized msg received
                                                         //   on interrupt port
#define kIOReturnNotPermitted    iokit_common_err(0x2e2) // not permitted
#define kIOReturnNoPower         iokit_common_err(0x2e3) // no power to device
#define kIOReturnNoMedia         iokit_common_err(0x2e4) // media not present
#define kIOReturnUnformattedMedia iokit_common_err(0x2e5)// media not formatted
#define kIOReturnUnsupportedMode iokit_common_err(0x2e6) // no such mode
#define kIOReturnUnderrun        iokit_common_err(0x2e7) // data underrun
#define kIOReturnOverrun         iokit_common_err(0x2e8) // data overrun
#define kIOReturnDeviceError     iokit_common_err(0x2e9) // the device is not working properly!
#define kIOReturnNoCompletion    iokit_common_err(0x2ea) // a completion routine is required
#define kIOReturnAborted         iokit_common_err(0x2eb) // operation aborted
#define kIOReturnNoBandwidth     iokit_common_err(0x2ec) // bus bandwidth would be exceeded
#define kIOReturnNotResponding   iokit_common_err(0x2ed) // device not responding
#define kIOReturnIsoTooOld       iokit_common_err(0x2ee) // isochronous I/O request for distant past!
#define kIOReturnIsoTooNew       iokit_common_err(0x2ef) // isochronous I/O request for distant future
#define kIOReturnNotFound        iokit_common_err(0x2f0) // data was not found
#define kIOReturnInvalid         iokit_common_err(0x1)   // should never be seen

#ifdef __cplusplus
}
#endif

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