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

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