[apple/xnu.git] / iokit / Kernel / IOKitKernelInternal.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@
 */


#ifndef _IOKIT_KERNELINTERNAL_H
#define _IOKIT_KERNELINTERNAL_H

#include <sys/cdefs.h>

__BEGIN_DECLS

#include <vm/vm_pageout.h>
#include <mach/memory_object_types.h>
#include <device/device_port.h>

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

#if (KDEBUG_LEVEL >= KDEBUG_LEVEL_STANDARD)

#define IOServiceTrace(csc, a, b, c, d) do {				\
    if(kIOTraceIOService & gIOKitDebug) {				\
	KERNEL_DEBUG_CONSTANT(IODBG_IOSERVICE(csc), a, b, c, d, 0);	\
    }									\
} while(0)

#else /* (KDEBUG_LEVEL >= KDEBUG_LEVEL_STANDARD) */

#define IOServiceTrace(csc, a, b, c, d) do {	\
  (void)a;					\
  (void)b;					\
  (void)c;					\
  (void)d;					\
} while (0)

#endif /* (KDEBUG_LEVEL >= KDEBUG_LEVEL_STANDARD) */

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

typedef kern_return_t (*IOIteratePageableMapsCallback)(vm_map_t map, void * ref);

void IOLibInit(void);
kern_return_t IOIteratePageableMaps(vm_size_t size,
                    IOIteratePageableMapsCallback callback, void * ref);
vm_map_t IOPageableMapForAddress(uintptr_t address);

kern_return_t 
IOMemoryDescriptorMapMemEntry(vm_map_t * map, ipc_port_t entry, IOOptionBits options, bool pageable,
				mach_vm_size_t offset, mach_vm_address_t * address, mach_vm_size_t length);
kern_return_t 
IOMemoryDescriptorMapCopy(vm_map_t * map, 
				IOOptionBits options,
				mach_vm_size_t offset, 
				mach_vm_address_t * address, mach_vm_size_t length);

mach_vm_address_t
IOKernelAllocateWithPhysicalRestrict(mach_vm_size_t size, mach_vm_address_t maxPhys, 
			                mach_vm_size_t alignment, bool contiguous);
void
IOKernelFreePhysical(mach_vm_address_t address, mach_vm_size_t size);


extern vm_size_t debug_iomallocpageable_size;

// osfmk/device/iokit_rpc.c
extern kern_return_t IOMapPages(vm_map_t map, mach_vm_address_t va, mach_vm_address_t pa,
                                 mach_vm_size_t length, unsigned int mapFlags);
extern kern_return_t IOUnmapPages(vm_map_t map, mach_vm_address_t va, mach_vm_size_t length);

extern kern_return_t IOProtectCacheMode(vm_map_t map, mach_vm_address_t va,
					mach_vm_size_t length, unsigned int mapFlags);

extern ppnum_t IOGetLastPageNumber(void);

extern ppnum_t gIOLastPage;

/* Physical to physical copy (ints must be disabled) */
extern void bcopy_phys(addr64_t from, addr64_t to, vm_size_t size);

__END_DECLS

// Used for dedicated communications for IODMACommand
enum  {
    kIOMDWalkSegments         = 0x00000001,
    kIOMDFirstSegment	      = 0x00000002 | kIOMDWalkSegments,
    kIOMDGetCharacteristics   = 0x00000004,
    kIOMDSetDMAActive         = 0x00000005,
    kIOMDSetDMAInactive       = 0x00000006,
    kIOMDLastDMACommandOperation
};
struct IOMDDMACharacteristics {
    UInt64 fLength;
    UInt32 fSGCount;
    UInt32 fPages;
    UInt32 fPageAlign;
    ppnum_t fHighestPage;
    IODirection fDirection;
    UInt8 fIsMapped, fIsPrepared;
};
struct IOMDDMAWalkSegmentArgs {
    UInt64 fOffset;			// Input/Output offset
    UInt64 fIOVMAddr, fLength;		// Output variables
    UInt8 fMapped;			// Input Variable, Require mapped IOVMA
};
typedef UInt8 IOMDDMAWalkSegmentState[128];

struct IODMACommandInternal
{
    IOMDDMAWalkSegmentState fState;
    IOMDDMACharacteristics  fMDSummary;

    UInt64 fPreparedOffset;
    UInt64 fPreparedLength;

    UInt32 fSourceAlignMask;
	
    UInt8  fCursor;
    UInt8  fCheckAddressing;
    UInt8  fIterateOnly;
    UInt8  fMisaligned;
    UInt8  fMapContig;
    UInt8  fPrepared;
    UInt8  fDoubleBuffer;
    UInt8  fNewMD;
    UInt8  fLocalMapper;
	
    vm_page_t fCopyPageAlloc;
    vm_page_t fCopyNext;
    vm_page_t fNextRemapPage;

    ppnum_t  fCopyPageCount;

    ppnum_t  fLocalMapperPageAlloc;
    ppnum_t  fLocalMapperPageCount;

    class IOBufferMemoryDescriptor * fCopyMD;

    // IODMAEventSource use
    IOReturn fStatus;
    UInt64   fActualByteCount;
};

struct IOMemoryDescriptorDevicePager {
    void *		         devicePager;
    unsigned int	     pagerContig:1;
    unsigned int	     unused:31;
    IOMemoryDescriptor * memory;
};

struct IOMemoryDescriptorReserved {
    IOMemoryDescriptorDevicePager dp;
    uint64_t                      preparationID;
    // for kernel IOMD subclasses... they have no expansion
    uint64_t                      kernReserved[4];
};


extern "C" struct timeval gIOLastSleepTime;
extern "C" struct timeval gIOLastWakeTime;

extern clock_sec_t gIOConsoleLockTime;

extern "C" void IOKitResetTime( void );
extern "C" void IOKitInitializeTime( void );

extern "C" OSString * IOCopyLogNameForPID(int pid);

#if defined(__i386__) || defined(__x86_64__)
extern "C" void IOSetKeyStoreData(IOMemoryDescriptor * data);
#endif

void IOScreenLockTimeUpdate(clock_sec_t secs);


#endif /* ! _IOKIT_KERNELINTERNAL_H */
Commit	Line	Data
91447636 A	1	/*
	2	* Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
91447636	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@
91447636 A	27	*/
	28
	29
	30	#ifndef _IOKIT_KERNELINTERNAL_H
	31	#define _IOKIT_KERNELINTERNAL_H
	32
	33	#include <sys/cdefs.h>
	34
	35	__BEGIN_DECLS
	36
0b4c1975	37	#include <vm/vm_pageout.h>
91447636 A	38	#include <mach/memory_object_types.h>
	39	#include <device/device_port.h>
	40
6d2010ae A	41	/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
6d2010ae A	42
316670eb	43	#if (KDEBUG_LEVEL >= KDEBUG_LEVEL_STANDARD)
6d2010ae A	44
	45	#define IOServiceTrace(csc, a, b, c, d) do { \
	46	if(kIOTraceIOService & gIOKitDebug) { \
	47	KERNEL_DEBUG_CONSTANT(IODBG_IOSERVICE(csc), a, b, c, d, 0); \
	48	} \
	49	} while(0)
	50
316670eb	51	#else /* (KDEBUG_LEVEL >= KDEBUG_LEVEL_STANDARD) */
6d2010ae A	52
	53	#define IOServiceTrace(csc, a, b, c, d) do { \
	54	(void)a; \
	55	(void)b; \
	56	(void)c; \
	57	(void)d; \
	58	} while (0)
	59
316670eb	60	#endif /* (KDEBUG_LEVEL >= KDEBUG_LEVEL_STANDARD) */
6d2010ae A	61
	62	/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
	63
91447636 A	64	typedef kern_return_t (IOIteratePageableMapsCallback)(vm_map_t map, void ref);
	65
	66	void IOLibInit(void);
	67	kern_return_t IOIteratePageableMaps(vm_size_t size,
	68	IOIteratePageableMapsCallback callback, void * ref);
b0d623f7	69	vm_map_t IOPageableMapForAddress(uintptr_t address);
2d21ac55 A	70
2d21ac55 A	71	kern_return_t
060df5ea	72	IOMemoryDescriptorMapMemEntry(vm_map_t * map, ipc_port_t entry, IOOptionBits options, bool pageable,
2d21ac55	73	mach_vm_size_t offset, mach_vm_address_t * address, mach_vm_size_t length);
b0d623f7	74	kern_return_t
060df5ea	75	IOMemoryDescriptorMapCopy(vm_map_t * map,
b0d623f7 A	76	IOOptionBits options,
	77	mach_vm_size_t offset,
	78	mach_vm_address_t * address, mach_vm_size_t length);
91447636	79
0c530ab8	80	mach_vm_address_t
0b4c1975 A	81	IOKernelAllocateWithPhysicalRestrict(mach_vm_size_t size, mach_vm_address_t maxPhys,
0b4c1975 A	82	mach_vm_size_t alignment, bool contiguous);
0c530ab8	83	void
0b4c1975 A	84	IOKernelFreePhysical(mach_vm_address_t address, mach_vm_size_t size);
0b4c1975 A	85
0c530ab8	86
91447636 A	87	extern vm_size_t debug_iomallocpageable_size;
	88
	89	// osfmk/device/iokit_rpc.c
0c530ab8	90	extern kern_return_t IOMapPages(vm_map_t map, mach_vm_address_t va, mach_vm_address_t pa,
2d21ac55	91	mach_vm_size_t length, unsigned int mapFlags);
0c530ab8 A	92	extern kern_return_t IOUnmapPages(vm_map_t map, mach_vm_address_t va, mach_vm_size_t length);
	93
	94	extern kern_return_t IOProtectCacheMode(vm_map_t map, mach_vm_address_t va,
	95	mach_vm_size_t length, unsigned int mapFlags);
	96
	97	extern ppnum_t IOGetLastPageNumber(void);
	98
	99	extern ppnum_t gIOLastPage;
91447636 A	100
91447636 A	101	/* Physical to physical copy (ints must be disabled) */
316670eb	102	extern void bcopy_phys(addr64_t from, addr64_t to, vm_size_t size);
91447636 A	103
	104	__END_DECLS
	105
0c530ab8 A	106	// Used for dedicated communications for IODMACommand
	107	enum {
	108	kIOMDWalkSegments = 0x00000001,
	109	kIOMDFirstSegment = 0x00000002 \| kIOMDWalkSegments,
	110	kIOMDGetCharacteristics = 0x00000004,
b0d623f7 A	111	kIOMDSetDMAActive = 0x00000005,
b0d623f7 A	112	kIOMDSetDMAInactive = 0x00000006,
0c530ab8 A	113	kIOMDLastDMACommandOperation
	114	};
	115	struct IOMDDMACharacteristics {
	116	UInt64 fLength;
	117	UInt32 fSGCount;
	118	UInt32 fPages;
	119	UInt32 fPageAlign;
	120	ppnum_t fHighestPage;
	121	IODirection fDirection;
	122	UInt8 fIsMapped, fIsPrepared;
	123	};
	124	struct IOMDDMAWalkSegmentArgs {
	125	UInt64 fOffset; // Input/Output offset
	126	UInt64 fIOVMAddr, fLength; // Output variables
	127	UInt8 fMapped; // Input Variable, Require mapped IOVMA
	128	};
	129	typedef UInt8 IOMDDMAWalkSegmentState[128];
	130
2d21ac55 A	131	struct IODMACommandInternal
	132	{
	133	IOMDDMAWalkSegmentState fState;
	134	IOMDDMACharacteristics fMDSummary;
	135
	136	UInt64 fPreparedOffset;
	137	UInt64 fPreparedLength;
	138
0b4c1975	139	UInt32 fSourceAlignMask;
b0d623f7	140
2d21ac55 A	141	UInt8 fCursor;
	142	UInt8 fCheckAddressing;
	143	UInt8 fIterateOnly;
	144	UInt8 fMisaligned;
b0d623f7	145	UInt8 fMapContig;
2d21ac55 A	146	UInt8 fPrepared;
2d21ac55 A	147	UInt8 fDoubleBuffer;
4a3eedf9	148	UInt8 fNewMD;
b0d623f7 A	149	UInt8 fLocalMapper;
b0d623f7 A	150
0b4c1975 A	151	vm_page_t fCopyPageAlloc;
	152	vm_page_t fCopyNext;
	153	vm_page_t fNextRemapPage;
	154
2d21ac55	155	ppnum_t fCopyPageCount;
2d21ac55	156
0b4c1975	157	ppnum_t fLocalMapperPageAlloc;
b0d623f7 A	158	ppnum_t fLocalMapperPageCount;
b0d623f7 A	159
2d21ac55 A	160	class IOBufferMemoryDescriptor * fCopyMD;
	161
	162	// IODMAEventSource use
	163	IOReturn fStatus;
	164	UInt64 fActualByteCount;
	165	};
	166
316670eb A	167	struct IOMemoryDescriptorDevicePager {
	168	void * devicePager;
	169	unsigned int pagerContig:1;
	170	unsigned int unused:31;
	171	IOMemoryDescriptor * memory;
	172	};
	173
	174	struct IOMemoryDescriptorReserved {
	175	IOMemoryDescriptorDevicePager dp;
	176	uint64_t preparationID;
	177	// for kernel IOMD subclasses... they have no expansion
	178	uint64_t kernReserved[4];
	179	};
	180
	181
2d21ac55 A	182	extern "C" struct timeval gIOLastSleepTime;
	183	extern "C" struct timeval gIOLastWakeTime;
	184
316670eb A	185	extern clock_sec_t gIOConsoleLockTime;
316670eb A	186
2d21ac55 A	187	extern "C" void IOKitResetTime( void );
	188	extern "C" void IOKitInitializeTime( void );
	189
	190	extern "C" OSString * IOCopyLogNameForPID(int pid);
	191
6d2010ae A	192	#if defined(__i386__) \|\| defined(__x86_64__)
	193	extern "C" void IOSetKeyStoreData(IOMemoryDescriptor * data);
	194	#endif
	195
316670eb A	196	void IOScreenLockTimeUpdate(clock_sec_t secs);
	197
	198
91447636	199	#endif /* ! _IOKIT_KERNELINTERNAL_H */