iokit/Kernel/IOKitKernelInternal.h

   1 /*
   2  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   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.
  14  *
  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
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  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.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29
  30 #ifndef _IOKIT_KERNELINTERNAL_H
  31 #define _IOKIT_KERNELINTERNAL_H
  32
  33 #include <sys/cdefs.h>
  34
  35 __BEGIN_DECLS
  36
  37 #include <vm/vm_pageout.h>
  38 #include <mach/memory_object_types.h>
  39 #include <device/device_port.h>
  40
  41 typedef kern_return_t (*IOIteratePageableMapsCallback)(vm_map_t map, void * ref);
  42
  43 void IOLibInit(void);
  44 kern_return_t IOIteratePageableMaps(vm_size_t size,
  45                     IOIteratePageableMapsCallback callback, void * ref);
  46 vm_map_t IOPageableMapForAddress(uintptr_t address);
  47
  48 kern_return_t
  49 IOMemoryDescriptorMapMemEntry(vm_map_t map, ipc_port_t entry, IOOptionBits options, bool pageable,
  50                                 mach_vm_size_t offset, mach_vm_address_t * address, mach_vm_size_t length);
  51 kern_return_t
  52 IOMemoryDescriptorMapCopy(vm_map_t map,
  53                                 vm_map_t src_map,
  54                                 mach_vm_offset_t src_address,
  55                                 IOOptionBits options,
  56                                 mach_vm_size_t offset,
  57                                 mach_vm_address_t * address, mach_vm_size_t length);
  58
  59 mach_vm_address_t
  60 IOKernelAllocateWithPhysicalRestrict(mach_vm_size_t size, mach_vm_address_t maxPhys,
  61                                         mach_vm_size_t alignment, bool contiguous);
  62 void
  63 IOKernelFreePhysical(mach_vm_address_t address, mach_vm_size_t size);
  64
  65
  66 extern vm_size_t debug_iomallocpageable_size;
  67
  68 // osfmk/device/iokit_rpc.c
  69 extern kern_return_t IOMapPages(vm_map_t map, mach_vm_address_t va, mach_vm_address_t pa,
  70                                  mach_vm_size_t length, unsigned int mapFlags);
  71 extern kern_return_t IOUnmapPages(vm_map_t map, mach_vm_address_t va, mach_vm_size_t length);
  72
  73 extern kern_return_t IOProtectCacheMode(vm_map_t map, mach_vm_address_t va,
  74                                         mach_vm_size_t length, unsigned int mapFlags);
  75
  76 extern ppnum_t IOGetLastPageNumber(void);
  77
  78 extern ppnum_t gIOLastPage;
  79
  80 /* Physical to physical copy (ints must be disabled) */
  81 extern void bcopy_phys(addr64_t from, addr64_t to, int size);
  82
  83 __END_DECLS
  84
  85 // Used for dedicated communications for IODMACommand
  86 enum  {
  87     kIOMDWalkSegments         = 0x00000001,
  88     kIOMDFirstSegment         = 0x00000002 | kIOMDWalkSegments,
  89     kIOMDGetCharacteristics   = 0x00000004,
  90     kIOMDSetDMAActive         = 0x00000005,
  91     kIOMDSetDMAInactive       = 0x00000006,
  92     kIOMDLastDMACommandOperation
  93 };
  94 struct IOMDDMACharacteristics {
  95     UInt64 fLength;
  96     UInt32 fSGCount;
  97     UInt32 fPages;
  98     UInt32 fPageAlign;
  99     ppnum_t fHighestPage;
 100     IODirection fDirection;
 101     UInt8 fIsMapped, fIsPrepared;
 102 };
 103 struct IOMDDMAWalkSegmentArgs {
 104     UInt64 fOffset;                     // Input/Output offset
 105     UInt64 fIOVMAddr, fLength;          // Output variables
 106     UInt8 fMapped;                      // Input Variable, Require mapped IOVMA
 107 };
 108 typedef UInt8 IOMDDMAWalkSegmentState[128];
 109
 110 struct IODMACommandInternal
 111 {
 112     IOMDDMAWalkSegmentState fState;
 113     IOMDDMACharacteristics  fMDSummary;
 114
 115     UInt64 fPreparedOffset;
 116     UInt64 fPreparedLength;
 117
 118     UInt32 fSourceAlignMask;
 119
 120     UInt8  fCursor;
 121     UInt8  fCheckAddressing;
 122     UInt8  fIterateOnly;
 123     UInt8  fMisaligned;
 124     UInt8  fMapContig;
 125     UInt8  fPrepared;
 126     UInt8  fDoubleBuffer;
 127     UInt8  fNewMD;
 128     UInt8  fLocalMapper;
 129
 130     vm_page_t fCopyPageAlloc;
 131     vm_page_t fCopyNext;
 132     vm_page_t fNextRemapPage;
 133
 134     ppnum_t  fCopyPageCount;
 135
 136     ppnum_t  fLocalMapperPageAlloc;
 137     ppnum_t  fLocalMapperPageCount;
 138
 139     class IOBufferMemoryDescriptor * fCopyMD;
 140
 141     // IODMAEventSource use
 142     IOReturn fStatus;
 143     UInt64   fActualByteCount;
 144 };
 145
 146 extern "C" struct timeval gIOLastSleepTime;
 147 extern "C" struct timeval gIOLastWakeTime;
 148
 149 extern "C" void IOKitResetTime( void );
 150 extern "C" void IOKitInitializeTime( void );
 151
 152 extern "C" OSString * IOCopyLogNameForPID(int pid);
 153
 154 #endif /* ! _IOKIT_KERNELINTERNAL_H */