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 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  42
  43 #if !defined(NO_KDEBUG)
  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
  51 #else /* NO_KDEBUG */
  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
  60 #endif /* NO_KDEBUG */
  61
  62 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  63
  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);
  69 vm_map_t IOPageableMapForAddress(uintptr_t address);
  70
  71 kern_return_t
  72 IOMemoryDescriptorMapMemEntry(vm_map_t * map, ipc_port_t entry, IOOptionBits options, bool pageable,
  73                                 mach_vm_size_t offset, mach_vm_address_t * address, mach_vm_size_t length);
  74 kern_return_t
  75 IOMemoryDescriptorMapCopy(vm_map_t * map,
  76                                 IOOptionBits options,
  77                                 mach_vm_size_t offset,
  78                                 mach_vm_address_t * address, mach_vm_size_t length);
  79
  80 mach_vm_address_t
  81 IOKernelAllocateWithPhysicalRestrict(mach_vm_size_t size, mach_vm_address_t maxPhys,
  82                                         mach_vm_size_t alignment, bool contiguous);
  83 void
  84 IOKernelFreePhysical(mach_vm_address_t address, mach_vm_size_t size);
  85
  86
  87 extern vm_size_t debug_iomallocpageable_size;
  88
  89 // osfmk/device/iokit_rpc.c
  90 extern kern_return_t IOMapPages(vm_map_t map, mach_vm_address_t va, mach_vm_address_t pa,
  91                                  mach_vm_size_t length, unsigned int mapFlags);
  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;
 100
 101 /* Physical to physical copy (ints must be disabled) */
 102 extern void bcopy_phys(addr64_t from, addr64_t to, int size);
 103
 104 __END_DECLS
 105
 106 // Used for dedicated communications for IODMACommand
 107 enum  {
 108     kIOMDWalkSegments         = 0x00000001,
 109     kIOMDFirstSegment         = 0x00000002 | kIOMDWalkSegments,
 110     kIOMDGetCharacteristics   = 0x00000004,
 111     kIOMDSetDMAActive         = 0x00000005,
 112     kIOMDSetDMAInactive       = 0x00000006,
 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
 131 struct IODMACommandInternal
 132 {
 133     IOMDDMAWalkSegmentState fState;
 134     IOMDDMACharacteristics  fMDSummary;
 135
 136     UInt64 fPreparedOffset;
 137     UInt64 fPreparedLength;
 138
 139     UInt32 fSourceAlignMask;
 140
 141     UInt8  fCursor;
 142     UInt8  fCheckAddressing;
 143     UInt8  fIterateOnly;
 144     UInt8  fMisaligned;
 145     UInt8  fMapContig;
 146     UInt8  fPrepared;
 147     UInt8  fDoubleBuffer;
 148     UInt8  fNewMD;
 149     UInt8  fLocalMapper;
 150
 151     vm_page_t fCopyPageAlloc;
 152     vm_page_t fCopyNext;
 153     vm_page_t fNextRemapPage;
 154
 155     ppnum_t  fCopyPageCount;
 156
 157     ppnum_t  fLocalMapperPageAlloc;
 158     ppnum_t  fLocalMapperPageCount;
 159
 160     class IOBufferMemoryDescriptor * fCopyMD;
 161
 162     // IODMAEventSource use
 163     IOReturn fStatus;
 164     UInt64   fActualByteCount;
 165 };
 166
 167 extern "C" struct timeval gIOLastSleepTime;
 168 extern "C" struct timeval gIOLastWakeTime;
 169
 170 extern "C" void IOKitResetTime( void );
 171 extern "C" void IOKitInitializeTime( void );
 172
 173 extern "C" OSString * IOCopyLogNameForPID(int pid);
 174
 175 #if defined(__i386__) || defined(__x86_64__)
 176 extern "C" void IOSetKeyStoreData(IOMemoryDescriptor * data);
 177 #endif
 178
 179 #endif /* ! _IOKIT_KERNELINTERNAL_H */