[apple/xnu.git] / osfmk / device / device_types.h

/*
 * Copyright (c) 2000-2004 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@
 */
/*
 * @OSF_COPYRIGHT@
 */
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990,1989 Carnegie Mellon University
 * All Rights Reserved.
 * 
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 * 
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 * 
 * Carnegie Mellon requests users of this software to return to
 * 
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 * 
 * any improvements or extensions that they make and grant Carnegie Mellon
 * the rights to redistribute these changes.
 */
/*
 */
/*
 *	Author: David B. Golub, Carnegie Mellon University
 *	Date: 	3/89
 */

#ifndef	DEVICE_TYPES_H
#define	DEVICE_TYPES_H

/*
 * Types for device interface.
 */
#include <mach/std_types.h>
#include <mach/mach_types.h>
#include <mach/message.h>
#include <mach/port.h>

#if PRIVATE
#define IOKIT_SERVER_VERSION	20150715
#endif


/*
 * IO buffer - out-of-line array of characters.
 */
typedef char *	io_buf_ptr_t;

/*
 * Some types for IOKit.
 */

#ifdef IOKIT

/* must match device_types.defs */
typedef	char			io_name_t[128];
typedef	char			io_string_t[512];	
typedef	char			io_string_inband_t[4096];
typedef char 			io_struct_inband_t[4096];

#if KERNEL
typedef uint64_t		io_user_scalar_t;
typedef uint64_t		io_user_reference_t;
typedef int 			io_scalar_inband_t[16];
// must be the same type as OSAsyncReference
typedef natural_t		io_async_ref_t[8];
typedef io_user_scalar_t	io_scalar_inband64_t[16];
typedef io_user_reference_t	io_async_ref64_t[8];
#elif __LP64__
typedef uint64_t		io_user_scalar_t;
typedef uint64_t		io_user_reference_t;
typedef io_user_scalar_t	io_scalar_inband_t[16];
typedef io_user_reference_t	io_async_ref_t[8];
typedef io_user_scalar_t	io_scalar_inband64_t[16];
typedef io_user_reference_t	io_async_ref64_t[8];
#else
typedef int			io_user_scalar_t;
typedef natural_t		io_user_reference_t;
typedef io_user_scalar_t	io_scalar_inband_t[16];
typedef io_user_reference_t	io_async_ref_t[8];
typedef uint64_t		io_scalar_inband64_t[16];
typedef uint64_t		io_async_ref64_t[8];
#endif // __LP64__

#ifdef MACH_KERNEL_PRIVATE

typedef struct IOObject * io_object_t;
typedef io_object_t io_connect_t;

extern void iokit_remove_reference( io_object_t	obj );

extern io_object_t iokit_lookup_object_port( ipc_port_t port );
extern io_connect_t iokit_lookup_connect_port( ipc_port_t port );

extern ipc_port_t iokit_make_object_port( io_object_t obj );
extern ipc_port_t iokit_make_connect_port( io_connect_t obj );

extern boolean_t iokit_notify( mach_msg_header_t *msg );

#else

#ifndef	__IOKIT_PORTS_DEFINED__
#define __IOKIT_PORTS_DEFINED__
typedef mach_port_t	io_object_t;
#endif	/* __IOKIT_PORTS_DEFINED__ */

#endif  /* MACH_KERNEL */

#endif  /* IOKIT */

#endif	/* DEVICE_TYPES_H */
Commit	Line	Data
1c79356b	1	/*
91447636	2	* Copyright (c) 2000-2004 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,
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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	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 Software.Distribution@CS.CMU.EDU
	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>
91447636 A	70	#include <mach/mach_types.h>
91447636 A	71	#include <mach/message.h>
1c79356b A	72	#include <mach/port.h>
1c79356b A	73
fe8ab488	74	#if PRIVATE
3e170ce0	75	#define IOKIT_SERVER_VERSION 20150715
fe8ab488 A	76	#endif
	77
	78
1c79356b A	79	/*
	80	* IO buffer - out-of-line array of characters.
	81	*/
	82	typedef char * io_buf_ptr_t;
	83
	84	/*
	85	* Some types for IOKit.
	86	*/
	87
	88	#ifdef IOKIT
	89
	90	/* must match device_types.defs */
2d21ac55 A	91	typedef char io_name_t[128];
2d21ac55 A	92	typedef char io_string_t[512];
3e170ce0	93	typedef char io_string_inband_t[4096];
2d21ac55 A	94	typedef char io_struct_inband_t[4096];
	95
	96	#if KERNEL
	97	typedef uint64_t io_user_scalar_t;
	98	typedef uint64_t io_user_reference_t;
	99	typedef int io_scalar_inband_t[16];
b0d623f7	100	// must be the same type as OSAsyncReference
2d21ac55 A	101	typedef natural_t io_async_ref_t[8];
	102	typedef io_user_scalar_t io_scalar_inband64_t[16];
	103	typedef io_user_reference_t io_async_ref64_t[8];
	104	#elif __LP64__
	105	typedef uint64_t io_user_scalar_t;
	106	typedef uint64_t io_user_reference_t;
	107	typedef io_user_scalar_t io_scalar_inband_t[16];
	108	typedef io_user_reference_t io_async_ref_t[8];
	109	typedef io_user_scalar_t io_scalar_inband64_t[16];
	110	typedef io_user_reference_t io_async_ref64_t[8];
	111	#else
	112	typedef int io_user_scalar_t;
	113	typedef natural_t io_user_reference_t;
	114	typedef io_user_scalar_t io_scalar_inband_t[16];
	115	typedef io_user_reference_t io_async_ref_t[8];
	116	typedef uint64_t io_scalar_inband64_t[16];
	117	typedef uint64_t io_async_ref64_t[8];
	118	#endif // __LP64__
1c79356b	119
fe8ab488	120	#ifdef MACH_KERNEL_PRIVATE
1c79356b A	121
	122	typedef struct IOObject * io_object_t;
	123	typedef io_object_t io_connect_t;
	124
	125	extern void iokit_remove_reference( io_object_t obj );
	126
	127	extern io_object_t iokit_lookup_object_port( ipc_port_t port );
	128	extern io_connect_t iokit_lookup_connect_port( ipc_port_t port );
	129
	130	extern ipc_port_t iokit_make_object_port( io_object_t obj );
	131	extern ipc_port_t iokit_make_connect_port( io_connect_t obj );
	132
91447636 A	133	extern boolean_t iokit_notify( mach_msg_header_t *msg );
91447636 A	134
1c79356b A	135	#else
	136
	137	#ifndef __IOKIT_PORTS_DEFINED__
	138	#define __IOKIT_PORTS_DEFINED__
	139	typedef mach_port_t io_object_t;
	140	#endif /* __IOKIT_PORTS_DEFINED__ */
	141
	142	#endif /* MACH_KERNEL */
	143
	144	#endif /* IOKIT */
	145
	146	#endif /* DEVICE_TYPES_H */
	147