1/*
2 * Copyright (c) 1998-2012 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#ifndef __IOKIT_IOTYPES_H
29#define __IOKIT_IOTYPES_H
30
31#ifndef XNU_PLATFORM_DriverKit
32
33#ifndef IOKIT
34#define IOKIT 1
35#endif /* !IOKIT */
36
37#include <sys/cdefs.h>
38
39#if KERNEL
40#include <IOKit/system.h>
41#else
42#include <mach/message.h>
43#include <mach/vm_types.h>
44#endif
45
46#include <IOKit/IOReturn.h>
47
48#ifdef __cplusplus
49extern "C" {
50#endif
51
52#ifndef NULL
53#if defined (__cplusplus)
54#ifdef XNU_KERNEL_PRIVATE
55#define NULL nullptr
56#else
57#if __cplusplus >= 201103L && (defined(__arm__) || defined(__arm64__))
58#define NULL nullptr
59#else
60#define NULL 0
61#endif
62#endif
63#else
64#define NULL ((void *)0)
65#endif
66#endif
67
68/*
69 * Simple data types.
70 */
71#include <stdbool.h>
72#include <libkern/OSTypes.h>
73
74#if KERNEL
75#include <libkern/OSBase.h>
76#endif
77
78typedef UInt32 IOOptionBits;
79typedef SInt32 IOFixed;
80typedef UInt32 IOVersion;
81typedef UInt32 IOItemCount;
82typedef UInt32 IOCacheMode;
83
84typedef UInt32 IOByteCount32;
85typedef UInt64 IOByteCount64;
86
87typedef UInt32 IOPhysicalAddress32;
88typedef UInt64 IOPhysicalAddress64;
89typedef UInt32 IOPhysicalLength32;
90typedef UInt64 IOPhysicalLength64;
91
92#if !defined(__arm__) && !defined(__i386__)
93typedef mach_vm_address_t IOVirtualAddress __kernel_ptr_semantics;
94#else
95typedef vm_address_t IOVirtualAddress __kernel_ptr_semantics;
96#endif
97
98#if !defined(__arm__) && !defined(__i386__) && !(defined(__x86_64__) && !defined(KERNEL)) && !(defined(__arm64__) && !defined(__LP64__))
99typedef IOByteCount64 IOByteCount;
100#define PRIIOByteCount PRIu64
101#else
102typedef IOByteCount32 IOByteCount;
103#define PRIIOByteCount PRIu32
104#endif
105
106typedef IOVirtualAddress IOLogicalAddress;
107
108#if !defined(__arm__) && !defined(__i386__) && !(defined(__x86_64__) && !defined(KERNEL))
109
110typedef IOPhysicalAddress64 IOPhysicalAddress;
111typedef IOPhysicalLength64 IOPhysicalLength;
112#define IOPhysical32( hi, lo ) ((UInt64) lo + ((UInt64)(hi) << 32))
113#define IOPhysSize 64
114
115#else
116
117typedef IOPhysicalAddress32 IOPhysicalAddress;
118typedef IOPhysicalLength32 IOPhysicalLength;
119#define IOPhysical32( hi, lo ) (lo)
120#define IOPhysSize 32
121
122#endif
123
124
125typedef struct{
126 IOPhysicalAddress address;
127 IOByteCount length;
128} IOPhysicalRange;
129
130typedef struct{
131 IOVirtualAddress address;
132 IOByteCount length;
133} IOVirtualRange;
134
135#if !defined(__arm__) && !defined(__i386__)
136typedef IOVirtualRange IOAddressRange;
137#else
138typedef struct{
139 mach_vm_address_t address;
140 mach_vm_size_t length;
141} IOAddressRange;
142#endif
143
144/*
145 * Map between #defined or enum'd constants and text description.
146 */
147typedef struct {
148 int value;
149 const char *name;
150} IONamedValue;
151
152
153/*
154 * Memory alignment -- specified as a power of two.
155 */
156typedef unsigned int IOAlignment;
157
158#define IO_NULL_VM_TASK ((vm_task_t)0)
159
160
161/*
162 * Pull in machine specific stuff.
163 */
164
165//#include <IOKit/machine/IOTypes.h>
166
167#ifndef MACH_KERNEL
168
169#ifndef __IOKIT_PORTS_DEFINED__
170#define __IOKIT_PORTS_DEFINED__
171#ifdef KERNEL
172#ifdef __cplusplus
173class OSObject;
174typedef OSObject * io_object_t;
175#else
176typedef struct OSObject * io_object_t;
177#endif
178#else /* KERNEL */
179typedef mach_port_t io_object_t;
180#endif /* KERNEL */
181#endif /* __IOKIT_PORTS_DEFINED__ */
182
183#include <device/device_types.h>
184
185typedef io_object_t io_connect_t;
186typedef io_object_t io_enumerator_t;
187typedef io_object_t io_ident_t;
188typedef io_object_t io_iterator_t;
189typedef io_object_t io_registry_entry_t;
190typedef io_object_t io_service_t;
191typedef io_object_t uext_object_t;
192
193#define IO_OBJECT_NULL ((io_object_t) 0)
194
195#endif /* MACH_KERNEL */
196
197#include <IOKit/IOMapTypes.h>
198
199/*! @enum Scale Factors
200 * @discussion Used when a scale_factor parameter is required to define a unit of time.
201 * @constant kNanosecondScale Scale factor for nanosecond based times.
202 * @constant kMicrosecondScale Scale factor for microsecond based times.
203 * @constant kMillisecondScale Scale factor for millisecond based times.
204 * @constant kTickScale Scale factor for the standard (100Hz) tick.
205 * @constant kSecondScale Scale factor for second based times. */
206
207enum {
208 kNanosecondScale = 1,
209 kMicrosecondScale = 1000,
210 kMillisecondScale = 1000 * 1000,
211 kSecondScale = 1000 * 1000 * 1000,
212 kTickScale = (kSecondScale / 100)
213};
214
215enum {
216 kIOConnectMethodVarOutputSize = -3
217};
218
219/* compatibility types */
220
221#ifndef KERNEL
222
223typedef unsigned int IODeviceNumber;
224
225#endif
226
227#ifdef __cplusplus
228}
229#endif
230
231#else /* !XNU_PLATFORM_DriverKit */
232
233#include <stdint.h>
234
235typedef uint32_t IOOptionBits;
236typedef int32_t IOFixed;
237typedef uint32_t IOVersion;
238typedef uint32_t IOItemCount;
239typedef uint32_t IOCacheMode;
240
241typedef uint32_t IOByteCount32;
242typedef uint64_t IOByteCount64;
243typedef IOByteCount64 IOByteCount;
244
245typedef uint32_t IOPhysicalAddress32;
246typedef uint64_t IOPhysicalAddress64;
247typedef uint32_t IOPhysicalLength32;
248typedef uint64_t IOPhysicalLength64;
249
250typedef IOPhysicalAddress64 IOPhysicalAddress;
251typedef IOPhysicalLength64 IOPhysicalLength;
252
253typedef uint64_t IOVirtualAddress;
254
255#endif /* XNU_PLATFORM_DriverKit */
256
257enum {
258 kIOMaxBusStall40usec = 40000,
259 kIOMaxBusStall30usec = 30000,
260 kIOMaxBusStall25usec = 25000,
261 kIOMaxBusStall20usec = 20000,
262 kIOMaxBusStall10usec = 10000,
263 kIOMaxBusStall5usec = 5000,
264 kIOMaxBusStallNone = 0,
265};
266
267#if PRIVATE
268#define LIBKERN_OSNUMBER_FLOAT_SUPPORT 1
269#endif /* PRIVATE */
270
271#endif /* ! __IOKIT_IOTYPES_H */
272