xref: /xnu-12377.41.6/osfmk/device/device_types.h (revision bbb1b6f9e71b8cdde6e5cd6f4841f207dee3d828)
1 /*
2  * Copyright (c) 2000-2004 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  * @OSF_COPYRIGHT@
30  */
31 /*
32  * Mach Operating System
33  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
34  * All Rights Reserved.
35  *
36  * Permission to use, copy, modify and distribute this software and its
37  * documentation is hereby granted, provided that both the copyright
38  * notice and this permission notice appear in all copies of the
39  * software, derivative works or modified versions, and any portions
40  * thereof, and that both notices appear in supporting documentation.
41  *
42  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
43  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
44  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
45  *
46  * Carnegie Mellon requests users of this software to return to
47  *
48  *  Software Distribution Coordinator  or  [email protected]
49  *  School of Computer Science
50  *  Carnegie Mellon University
51  *  Pittsburgh PA 15213-3890
52  *
53  * any improvements or extensions that they make and grant Carnegie Mellon
54  * the rights to redistribute these changes.
55  */
56 /*
57  */
58 /*
59  *	Author: David B. Golub, Carnegie Mellon University
60  *	Date:   3/89
61  */
62 
63 #ifndef DEVICE_TYPES_H
64 #define DEVICE_TYPES_H
65 
66 /*
67  * Types for device interface.
68  */
69 #include <mach/std_types.h>
70 #include <mach/mach_types.h>
71 #include <mach/message.h>
72 #include <mach/port.h>
73 #ifdef MACH_KERNEL_PRIVATE
74 #include <mach_debug/mach_debug_types.h>
75 #include <kern/ipc_kobject.h>
76 #endif
77 #include <stdint.h>
78 
79 #if PRIVATE
80 #define IOKIT_SERVER_VERSION    20210810
81 #endif
82 
83 
84 /*
85  * IO buffer - out-of-line array of characters.
86  */
87 typedef char *  io_buf_ptr_t;
88 
89 /*
90  * Some types for IOKit.
91  */
92 
93 #ifdef IOKIT
94 
95 /* must match device_types.defs */
96 typedef char                    io_name_t[128];
97 typedef char                    io_string_t[512];
98 typedef char                    io_string_inband_t[4096];
99 typedef char                    io_struct_inband_t[4096];
100 
101 #if KERNEL
102 typedef uint64_t                io_user_scalar_t;
103 typedef uint64_t                io_user_reference_t __kernel_ptr_semantics;
104 typedef int                     io_scalar_inband_t[16];
105 // must be the same type as OSAsyncReference
106 typedef natural_t               io_async_ref_t[8] __kernel_ptr_semantics;
107 typedef io_user_scalar_t        io_scalar_inband64_t[16];
108 typedef io_user_reference_t     io_async_ref64_t[8];
109 #elif __LP64__
110 typedef uint64_t                io_user_scalar_t;
111 typedef uint64_t                io_user_reference_t;
112 typedef io_user_scalar_t        io_scalar_inband_t[16];
113 typedef io_user_reference_t     io_async_ref_t[8];
114 typedef io_user_scalar_t        io_scalar_inband64_t[16];
115 typedef io_user_reference_t     io_async_ref64_t[8];
116 #else
117 typedef int                     io_user_scalar_t;
118 typedef natural_t               io_user_reference_t;
119 typedef io_user_scalar_t        io_scalar_inband_t[16];
120 typedef io_user_reference_t     io_async_ref_t[8];
121 typedef uint64_t                io_scalar_inband64_t[16];
122 typedef uint64_t                io_async_ref64_t[8];
123 #endif // __LP64__
124 
125 #ifdef MACH_KERNEL_PRIVATE
126 
127 typedef struct IOObject * io_object_t;
128 typedef struct IOMachPort * io_kobject_t;
129 typedef io_object_t io_connect_t;
130 typedef io_object_t io_ident_t;
131 typedef io_object_t uext_object_t;
132 
133 extern void iokit_add_reference( io_object_t obj );
134 extern void iokit_remove_reference( io_object_t obj );
135 extern void iokit_remove_connect_reference( io_object_t obj );
136 extern void iokit_port_object_description(io_object_t obj, kobject_description_t desc);
137 
138 extern io_object_t iokit_lookup_object_port( ipc_port_t port );
139 extern io_connect_t iokit_lookup_connect_port( ipc_port_t port );
140 extern io_ident_t iokit_lookup_ident_port( ipc_port_t port );
141 extern uext_object_t iokit_lookup_uext_object_port( ipc_port_t port );
142 
143 extern ipc_port_t iokit_make_object_port( io_object_t obj );
144 extern ipc_port_t iokit_make_connect_port( io_connect_t obj );
145 extern ipc_port_t iokit_make_ident_port( io_ident_t obj );
146 
147 extern void iokit_kobject_retain(io_kobject_t machPort);
148 extern io_object_t iokit_copy_object_for_consumed_kobject(io_kobject_t machPort);
149 
150 #else
151 
152 #ifndef __IOKIT_PORTS_DEFINED__
153 #define __IOKIT_PORTS_DEFINED__
154 typedef mach_port_t     io_object_t;
155 #endif  /* __IOKIT_PORTS_DEFINED__ */
156 
157 #endif  /* MACH_KERNEL */
158 
159 #endif  /* IOKIT */
160 
161 #endif  /* DEVICE_TYPES_H */
162