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

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

#ifndef	__OS_OSMESSAGENOTIFICATION_H
#define __OS_OSMESSAGENOTIFICATION_H

#ifdef __cplusplus
extern "C" {
#endif

#include <mach/mach_types.h>
#include <device/device_types.h>
#include <IOKit/IOReturn.h>

enum {
    kFirstIOKitNotificationType 		= 100,
    kIOServicePublishNotificationType 		= 100,
    kIOServiceMatchedNotificationType		= 101,
    kIOServiceTerminatedNotificationType	= 102,
    kIOAsyncCompletionNotificationType		= 150,
    kIOServiceMessageNotificationType		= 160,
    kLastIOKitNotificationType 			= 199,

    // reserved bits
    kIOKitNoticationTypeMask                    = 0x00000FFF,
    kIOKitNoticationTypeSizeAdjShift            = 30,
    kIOKitNoticationMsgSizeMask                 = 3,
};

enum {
    kOSNotificationMessageID		= 53,
    kOSAsyncCompleteMessageID		= 57,
    kMaxAsyncArgs			= 16
};

enum {
    kIOAsyncReservedIndex 	= 0,
    kIOAsyncReservedCount,

    kIOAsyncCalloutFuncIndex 	= kIOAsyncReservedCount,
    kIOAsyncCalloutRefconIndex,
    kIOAsyncCalloutCount,

    kIOMatchingCalloutFuncIndex	= kIOAsyncReservedCount,
    kIOMatchingCalloutRefconIndex,
    kIOMatchingCalloutCount,
    
    kIOInterestCalloutFuncIndex	= kIOAsyncReservedCount,
    kIOInterestCalloutRefconIndex,
    kIOInterestCalloutServiceIndex,
    kIOInterestCalloutCount
};


// --------------
enum {
    kOSAsyncRef64Count	= 8,
    kOSAsyncRef64Size 	= kOSAsyncRef64Count * ((int) sizeof(io_user_reference_t))
};
typedef io_user_reference_t OSAsyncReference64[kOSAsyncRef64Count];

struct OSNotificationHeader64 {
    mach_msg_size_t	size;		/* content size */
    natural_t		type;
    OSAsyncReference64	reference;

#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
    unsigned char	content[];
#else
    unsigned char	content[0];
#endif
};

#pragma pack(4)
struct IOServiceInterestContent64 {
    natural_t		messageType;
    io_user_reference_t	messageArgument[1];
};
#pragma pack()
// --------------

#if !KERNEL_USER32

enum {
    kOSAsyncRefCount	= 8,
    kOSAsyncRefSize 	= 32
};
typedef natural_t OSAsyncReference[kOSAsyncRefCount];

struct OSNotificationHeader {
    mach_msg_size_t	size;		/* content size */
    natural_t		type;
    OSAsyncReference	reference;

#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
    unsigned char	content[];
#else
    unsigned char	content[0];
#endif
};

#pragma pack(4)
struct IOServiceInterestContent {
    natural_t	messageType;
    void *	messageArgument[1];
};
#pragma pack()

#endif /* KERNEL_USER32  */

struct IOAsyncCompletionContent {
    IOReturn result;
#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
    void * args[] __attribute__ ((packed));
#else
    void * args[0] __attribute__ ((packed));
#endif
};

#ifndef __cplusplus
typedef struct OSNotificationHeader OSNotificationHeader;
typedef struct IOServiceInterestContent IOServiceInterestContent;
typedef struct IOAsyncCompletionContent IOAsyncCompletionContent;
#endif

#ifdef __cplusplus
}
#endif

#endif /*  __OS_OSMESSAGENOTIFICATION_H */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
	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	* Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
	30	*
	31	* HISTORY
	32	*
	33	*/
	34
	35	#ifndef __OS_OSMESSAGENOTIFICATION_H
	36	#define __OS_OSMESSAGENOTIFICATION_H
	37
	38	#ifdef __cplusplus
	39	extern "C" {
	40	#endif
	41
	42	#include <mach/mach_types.h>
2d21ac55	43	#include <device/device_types.h>
1c79356b A	44	#include <IOKit/IOReturn.h>
	45
	46	enum {
	47	kFirstIOKitNotificationType = 100,
	48	kIOServicePublishNotificationType = 100,
	49	kIOServiceMatchedNotificationType = 101,
	50	kIOServiceTerminatedNotificationType = 102,
	51	kIOAsyncCompletionNotificationType = 150,
	52	kIOServiceMessageNotificationType = 160,
fe8ab488 A	53	kLastIOKitNotificationType = 199,
	54
	55	// reserved bits
	56	kIOKitNoticationTypeMask = 0x00000FFF,
	57	kIOKitNoticationTypeSizeAdjShift = 30,
	58	kIOKitNoticationMsgSizeMask = 3,
1c79356b A	59	};
	60
	61	enum {
	62	kOSNotificationMessageID = 53,
	63	kOSAsyncCompleteMessageID = 57,
	64	kMaxAsyncArgs = 16
	65	};
	66
	67	enum {
	68	kIOAsyncReservedIndex = 0,
	69	kIOAsyncReservedCount,
	70
	71	kIOAsyncCalloutFuncIndex = kIOAsyncReservedCount,
	72	kIOAsyncCalloutRefconIndex,
	73	kIOAsyncCalloutCount,
	74
	75	kIOMatchingCalloutFuncIndex = kIOAsyncReservedCount,
	76	kIOMatchingCalloutRefconIndex,
	77	kIOMatchingCalloutCount,
	78
	79	kIOInterestCalloutFuncIndex = kIOAsyncReservedCount,
	80	kIOInterestCalloutRefconIndex,
	81	kIOInterestCalloutServiceIndex,
	82	kIOInterestCalloutCount
	83	};
	84
2d21ac55 A	85
	86
	87	// --------------
	88	enum {
	89	kOSAsyncRef64Count = 8,
b0d623f7	90	kOSAsyncRef64Size = kOSAsyncRef64Count * ((int) sizeof(io_user_reference_t))
2d21ac55 A	91	};
	92	typedef io_user_reference_t OSAsyncReference64[kOSAsyncRef64Count];
	93
	94	struct OSNotificationHeader64 {
	95	mach_msg_size_t size; /* content size */
	96	natural_t type;
	97	OSAsyncReference64 reference;
	98
	99	#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
	100	unsigned char content[];
	101	#else
	102	unsigned char content[0];
	103	#endif
	104	};
	105
b0d623f7	106	#pragma pack(4)
2d21ac55 A	107	struct IOServiceInterestContent64 {
	108	natural_t messageType;
	109	io_user_reference_t messageArgument[1];
	110	};
b0d623f7	111	#pragma pack()
2d21ac55 A	112	// --------------
	113
	114	#if !KERNEL_USER32
	115
1c79356b A	116	enum {
	117	kOSAsyncRefCount = 8,
	118	kOSAsyncRefSize = 32
	119	};
	120	typedef natural_t OSAsyncReference[kOSAsyncRefCount];
	121
	122	struct OSNotificationHeader {
2d21ac55	123	mach_msg_size_t size; /* content size */
1c79356b A	124	natural_t type;
1c79356b A	125	OSAsyncReference reference;
91447636 A	126
	127	#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
	128	unsigned char content[];
	129	#else
1c79356b	130	unsigned char content[0];
91447636	131	#endif
1c79356b A	132	};
1c79356b A	133
2d21ac55	134	#pragma pack(4)
1c79356b A	135	struct IOServiceInterestContent {
	136	natural_t messageType;
	137	void * messageArgument[1];
	138	};
2d21ac55 A	139	#pragma pack()
	140
	141	#endif /* KERNEL_USER32 */
1c79356b A	142
	143	struct IOAsyncCompletionContent {
	144	IOReturn result;
91447636	145	#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
b0d623f7	146	void * args[] __attribute__ ((packed));
91447636	147	#else
b0d623f7	148	void * args[0] __attribute__ ((packed));
91447636	149	#endif
1c79356b A	150	};
	151
	152	#ifndef __cplusplus
	153	typedef struct OSNotificationHeader OSNotificationHeader;
	154	typedef struct IOServiceInterestContent IOServiceInterestContent;
	155	typedef struct IOAsyncCompletionContent IOAsyncCompletionContent;
	156	#endif
	157
	158	#ifdef __cplusplus
	159	}
	160	#endif
	161
	162	#endif /* __OS_OSMESSAGENOTIFICATION_H */
	163