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

/*
 * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_OSREFERENCE_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_LICENSE_OSREFERENCE_HEADER_END@
 */
/*
 * Copyright (c) 1998 Apple Computer, Inc.  All rights reserved. 
 *
 * HISTORY
 *
 */

/*
 * Internal definitions used between the iokit user library and
 * server routines.
 */

#ifndef _IOKIT_IOKITSERVER_H
#define _IOKIT_IOKITSERVER_H

#include <IOKit/IOTypes.h>
#include <IOKit/IOKitKeys.h>
#include <IOKit/OSMessageNotification.h>

#ifdef __cplusplus
extern "C" {
#endif
#include <mach/kmod.h>
#ifdef __cplusplus
}
#endif

// IOMakeMatching
/*!
    @enum IOMakeMatching
    @constant kIOServiceMatching
    @constant kIOBSDNameMatching
    @constant kIOOFPathMatching
*/
enum {
    kIOServiceMatching		= 100,
    kIOBSDNameMatching		= 101,
    kIOOFPathMatching		= 102
};

// IOCatalogueSendData
/*!
    @enum IOCatalogueSendData user-client flags.
    @constant kIOCatalogAddDrivers  Signals a call to the addDrivers function in IOCatalogue.
    @constant kIOCatalogAddDriversNoMatch  Signals a call to the addDrivers function in IOCatalogue but does not start a matching thread.
    @constant kIOCatalogRemoveDrivers  Signals a call to the removeDrivers function in IOCatalogue.
    @constant kIOCatalogRemoveDriversNoMatch  Signals a call to the removedrivers function in IOCatalogue but does not start a matching thread. 
    @constant kIOCatalogStartMatching  Signals the IOCatalogue to start an IOService matching thread.
*/
enum {
    kIOCatalogAddDrivers	= 1,
    kIOCatalogAddDriversNoMatch,
    kIOCatalogRemoveDrivers,
    kIOCatalogRemoveDriversNoMatch,
    kIOCatalogStartMatching,
    kIOCatalogRemoveKernelLinker
};

// IOCatalogueGetData
/*!
    @enum IOCatalogueGetData user-client flags
    @constant kIOCatalogGetContents  Returns a snapshot of the database to the caller.
*/
enum {
    kIOCatalogGetContents	  = 1,
    kIOCatalogGetModuleDemandList = 2,
    kIOCatalogGetCacheMissList	  = 3,
    kIOCatalogGetROMMkextList     = 4
};

// IOCatalogueReset
/*!
    @enum IOCatalogueReset user-client flag
    @constant kIOCatalogResetDefault  Removes all entries from IOCatalogue except those used for booting the system.
*/
enum {
    kIOCatalogResetDefault	= 1
};

// IOCatalogueTerminate
/*!
    @enum IOCatalogueTerminate user-client flags.
    @constant kIOCatalogModuleUnload Terminates all services which depend on a particular module and unloads the module.
    @constant kIOCatalogModuleTerminate Terminates all services which depend on a particular module but does not unload the module.
    @constant kIOCatalogServiceTerminate Terminates a particular service by name.
*/
enum {
    kIOCatalogModuleUnload      = 1,
    kIOCatalogModuleTerminate,
    kIOCatalogServiceTerminate
};

enum {
    kIOCatalogMatchIdle      = KMOD_IOKIT_END_RANGE_PACKET - 0x10
};

#endif /* ! _IOKIT_IOKITSERVER_H */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
	3	*
8ad349bb	4	* @APPLE_LICENSE_OSREFERENCE_HEADER_START@
1c79356b	5	*
8ad349bb 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
	10	* License may not be used to create, or enable the creation or
	11	* redistribution of, unlawful or unlicensed copies of an Apple operating
	12	* system, or to circumvent, violate, or enable the circumvention or
	13	* violation of, any terms of an Apple operating system software license
	14	* agreement.
	15	*
	16	* Please obtain a copy of the License at
	17	* http://www.opensource.apple.com/apsl/ and read it before using this
	18	* file.
	19	*
	20	* The Original Code and all software distributed under the License are
	21	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	22	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	23	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	24	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	25	* Please see the License for the specific language governing rights and
	26	* limitations under the License.
	27	*
	28	* @APPLE_LICENSE_OSREFERENCE_HEADER_END@
1c79356b A	29	*/
	30	/*
	31	* Copyright (c) 1998 Apple Computer, Inc. All rights reserved.
	32	*
	33	* HISTORY
	34	*
	35	*/
	36
	37	/*
	38	* Internal definitions used between the iokit user library and
	39	* server routines.
	40	*/
	41
	42	#ifndef _IOKIT_IOKITSERVER_H
	43	#define _IOKIT_IOKITSERVER_H
	44
	45	#include <IOKit/IOTypes.h>
	46	#include <IOKit/IOKitKeys.h>
	47	#include <IOKit/OSMessageNotification.h>
	48
	49	#ifdef __cplusplus
	50	extern "C" {
	51	#endif
	52	#include <mach/kmod.h>
	53	#ifdef __cplusplus
	54	}
	55	#endif
	56
	57	// IOMakeMatching
	58	/*!
	59	@enum IOMakeMatching
	60	@constant kIOServiceMatching
	61	@constant kIOBSDNameMatching
	62	@constant kIOOFPathMatching
	63	*/
	64	enum {
	65	kIOServiceMatching = 100,
	66	kIOBSDNameMatching = 101,
55e303ae	67	kIOOFPathMatching = 102
1c79356b A	68	};
	69
	70	// IOCatalogueSendData
	71	/*!
	72	@enum IOCatalogueSendData user-client flags.
	73	@constant kIOCatalogAddDrivers Signals a call to the addDrivers function in IOCatalogue.
	74	@constant kIOCatalogAddDriversNoMatch Signals a call to the addDrivers function in IOCatalogue but does not start a matching thread.
	75	@constant kIOCatalogRemoveDrivers Signals a call to the removeDrivers function in IOCatalogue.
	76	@constant kIOCatalogRemoveDriversNoMatch Signals a call to the removedrivers function in IOCatalogue but does not start a matching thread.
	77	@constant kIOCatalogStartMatching Signals the IOCatalogue to start an IOService matching thread.
	78	*/
	79	enum {
	80	kIOCatalogAddDrivers = 1,
	81	kIOCatalogAddDriversNoMatch,
	82	kIOCatalogRemoveDrivers,
	83	kIOCatalogRemoveDriversNoMatch,
	84	kIOCatalogStartMatching,
55e303ae	85	kIOCatalogRemoveKernelLinker
1c79356b A	86	};
	87
	88	// IOCatalogueGetData
	89	/*!
	90	@enum IOCatalogueGetData user-client flags
	91	@constant kIOCatalogGetContents Returns a snapshot of the database to the caller.
	92	*/
	93	enum {
55e303ae A	94	kIOCatalogGetContents = 1,
	95	kIOCatalogGetModuleDemandList = 2,
	96	kIOCatalogGetCacheMissList = 3,
	97	kIOCatalogGetROMMkextList = 4
1c79356b A	98	};
	99
	100	// IOCatalogueReset
	101	/*!
	102	@enum IOCatalogueReset user-client flag
	103	@constant kIOCatalogResetDefault Removes all entries from IOCatalogue except those used for booting the system.
	104	*/
	105	enum {
55e303ae	106	kIOCatalogResetDefault = 1
1c79356b A	107	};
	108
	109	// IOCatalogueTerminate
	110	/*!
	111	@enum IOCatalogueTerminate user-client flags.
	112	@constant kIOCatalogModuleUnload Terminates all services which depend on a particular module and unloads the module.
	113	@constant kIOCatalogModuleTerminate Terminates all services which depend on a particular module but does not unload the module.
	114	@constant kIOCatalogServiceTerminate Terminates a particular service by name.
	115	*/
	116	enum {
	117	kIOCatalogModuleUnload = 1,
	118	kIOCatalogModuleTerminate,
55e303ae	119	kIOCatalogServiceTerminate
1c79356b A	120	};
	121
	122	enum {
	123	kIOCatalogMatchIdle = KMOD_IOKIT_END_RANGE_PACKET - 0x10
	124	};
	125
	126	#endif /* ! _IOKIT_IOKITSERVER_H */
	127