iokit/IOKit/IOLib.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  * Copyright (c) 1998 Apple Computer, Inc.  All rights reserved.
  30  *
  31  * HISTORY
  32  *
  33  */
  34
  35 #ifndef __IOKIT_IOLIB_H
  36 #define __IOKIT_IOLIB_H
  37
  38 #ifndef KERNEL
  39 #error IOLib.h is for kernel use only
  40 #endif
  41
  42 #include <stdarg.h>
  43 #include <sys/cdefs.h>
  44
  45 #include <sys/appleapiopts.h>
  46
  47 #include <IOKit/system.h>
  48
  49 #include <IOKit/IOReturn.h>
  50 #include <IOKit/IOTypes.h>
  51 #include <IOKit/IOLocks.h>
  52
  53 #include <libkern/OSAtomic.h>
  54
  55 __BEGIN_DECLS
  56
  57 #include <kern/thread_call.h>
  58 #include <kern/clock.h>
  59
  60 /*
  61  * min/max macros.
  62  */
  63
  64 #define min(a,b) ((a) < (b) ? (a) : (b))
  65 #define max(a,b) ((a) > (b) ? (a) : (b))
  66
  67 /*
  68  * These are opaque to the user.
  69  */
  70 typedef thread_t IOThread;
  71 typedef void (*IOThreadFunc)(void *argument);
  72
  73 /*
  74  * Memory allocation functions.
  75  */
  76
  77 /*! @function IOMalloc
  78     @abstract Allocates general purpose, wired memory in the kernel map.
  79     @discussion This is a general purpose utility to allocate memory in the kernel. There are no alignment guarantees given on the returned memory, and alignment may vary depending on the kernel configuration. This function may block and so should not be called from interrupt level or while a simple lock is held.
  80     @param size Size of the memory requested.
  81     @result Pointer to the allocated memory, or zero on failure. */
  82
  83 void * IOMalloc(vm_size_t size);
  84
  85 /*! @function IOFree
  86     @abstract Frees memory allocated with IOMalloc.
  87     @discussion This function frees memory allocated with IOMalloc, it may block and so should not be called from interrupt level or while a simple lock is held.
  88     @param address Pointer to the allocated memory.
  89     @param size Size of the memory allocated. */
  90
  91 void   IOFree(void * address, vm_size_t size);
  92
  93 /*! @function IOMallocAligned
  94     @abstract Allocates wired memory in the kernel map, with an alignment restriction.
  95     @discussion This is a utility to allocate memory in the kernel, with an alignment restriction which is specified as a byte count. This function may block and so should not be called from interrupt level or while a simple lock is held.
  96     @param size Size of the memory requested.
  97     @param alignment Byte count of the alignment for the memory. For example, pass 256 to get memory allocated at an address with bit 0-7 zero.
  98     @result Pointer to the allocated memory, or zero on failure. */
  99
 100 void * IOMallocAligned(vm_size_t size, vm_offset_t alignment);
 101
 102 /*! @function IOFreeAligned
 103     @abstract Frees memory allocated with IOMallocAligned.
 104     @discussion This function frees memory allocated with IOMallocAligned, it may block and so should not be called from interrupt level or while a simple lock is held.
 105     @param address Pointer to the allocated memory.
 106     @param size Size of the memory allocated. */
 107
 108 void   IOFreeAligned(void * address, vm_size_t size);
 109
 110 /*! @function IOMallocContiguous
 111     @abstract Deprecated - use IOBufferMemoryDescriptor. Allocates wired memory in the kernel map, with an alignment restriction and physically contiguous.
 112     @discussion This is a utility to allocate memory in the kernel, with an alignment restriction which is specified as a byte count, and will allocate only physically contiguous memory. The request may fail if memory is fragmented, and may cause large amounts of paging activity. This function may block and so should not be called from interrupt level or while a simple lock is held.
 113     @param size Size of the memory requested.
 114     @param alignment Byte count of the alignment for the memory. For example, pass 256 to get memory allocated at an address with bits 0-7 zero.
 115     @param physicalAddress IOMallocContiguous returns the physical address of the allocated memory here, if physicalAddress is a non-zero pointer. The physicalAddress argument is deprecated and should be passed as NULL. To obtain the physical address for a memory buffer, use the IODMACommand class in conjunction with the IOMemoryDescriptor or IOBufferMemoryDescriptor classes.
 116     @result Virtual address of the allocated memory, or zero on failure. */
 117
 118 void * IOMallocContiguous(vm_size_t size, vm_size_t alignment,
 119                            IOPhysicalAddress * physicalAddress) __attribute__((deprecated));
 120
 121 /*! @function IOFreeContiguous
 122     @abstract Deprecated - use IOBufferMemoryDescriptor. Frees memory allocated with IOMallocContiguous.
 123     @discussion This function frees memory allocated with IOMallocContiguous, it may block and so should not be called from interrupt level or while a simple lock is held.
 124     @param address Virtual address of the allocated memory.
 125     @param size Size of the memory allocated. */
 126
 127 void   IOFreeContiguous(void * address, vm_size_t size) __attribute__((deprecated));
 128
 129
 130 /*! @function IOMallocPageable
 131     @abstract Allocates pageable memory in the kernel map.
 132     @discussion This is a utility to allocate pageable memory in the kernel. This function may block and so should not be called from interrupt level or while a simple lock is held.
 133     @param size Size of the memory requested.
 134     @param alignment Byte count of the alignment for the memory. For example, pass 256 to get memory allocated at an address with bits 0-7 zero.
 135     @result Pointer to the allocated memory, or zero on failure. */
 136
 137 void * IOMallocPageable(vm_size_t size, vm_size_t alignment);
 138
 139 /*! @function IOFreePageable
 140     @abstract Frees memory allocated with IOMallocPageable.
 141     @discussion This function frees memory allocated with IOMallocPageable, it may block and so should not be called from interrupt level or while a simple lock is held.
 142     @param address Virtual address of the allocated memory.
 143     @param size Size of the memory allocated. */
 144
 145 void IOFreePageable(void * address, vm_size_t size);
 146
 147 /*
 148  * Typed memory allocation macros. Both may block.
 149  */
 150 #define IONew(type,number)        (type*)IOMalloc(sizeof(type) * (number) )
 151 #define IODelete(ptr,type,number) IOFree( (ptr) , sizeof(type) * (number) )
 152
 153 /////////////////////////////////////////////////////////////////////////////
 154 //
 155 //
 156 //      These functions are now implemented in IOMapper.cpp
 157 //
 158 //
 159 /////////////////////////////////////////////////////////////////////////////
 160
 161 /*! @function IOMappedRead8
 162     @abstract Read one byte from the desired "Physical" IOSpace address.
 163     @discussion Read one byte from the desired "Physical" IOSpace address.  This function allows the developer to read an address returned from any memory descriptor's getPhysicalSegment routine.  It can then be used by segmenting a physical page slightly to tag the physical page with its kernel space virtual address.
 164     @param address The desired address, as returned by IOMemoryDescriptor::getPhysicalSegment.
 165     @result Data contained at that location */
 166
 167 UInt8 IOMappedRead8(IOPhysicalAddress address);
 168
 169 /*! @function IOMappedRead16
 170     @abstract Read two bytes from the desired "Physical" IOSpace address.
 171     @discussion Read two bytes from the desired "Physical" IOSpace address.  This function allows the developer to read an address returned from any memory descriptor's getPhysicalSegment routine.  It can then be used by segmenting a physical page slightly to tag the physical page with its kernel space virtual address.
 172     @param address The desired address, as returned by IOMemoryDescriptor::getPhysicalSegment.
 173     @result Data contained at that location */
 174
 175 UInt16 IOMappedRead16(IOPhysicalAddress address);
 176
 177 /*! @function IOMappedRead32
 178     @abstract Read four bytes from the desired "Physical" IOSpace address.
 179     @discussion Read four bytes from the desired "Physical" IOSpace address.  This function allows the developer to read an address returned from any memory descriptor's getPhysicalSegment routine.  It can then be used by segmenting a physical page slightly to tag the physical page with its kernel space virtual address.
 180     @param address The desired address, as returned by IOMemoryDescriptor::getPhysicalSegment.
 181     @result Data contained at that location */
 182
 183 UInt32 IOMappedRead32(IOPhysicalAddress address);
 184
 185 /*! @function IOMappedRead64
 186     @abstract Read eight bytes from the desired "Physical" IOSpace address.
 187     @discussion Read eight bytes from the desired "Physical" IOSpace address.  This function allows the developer to read an address returned from any memory descriptor's getPhysicalSegment routine.  It can then be used by segmenting a physical page slightly to tag the physical page with its kernel space virtual address.
 188     @param address The desired address, as returned by IOMemoryDescriptor::getPhysicalSegment.
 189     @result Data contained at that location */
 190
 191 UInt64 IOMappedRead64(IOPhysicalAddress address);
 192
 193 /*! @function IOMappedWrite8
 194     @abstract Write one byte to the desired "Physical" IOSpace address.
 195     @discussion Write one byte to the desired "Physical" IOSpace address.  This function allows the developer to write to an address returned from any memory descriptor's getPhysicalSegment routine.
 196     @param address The desired address, as returned by IOMemoryDescriptor::getPhysicalSegment.
 197     @param value Data to be writen to the desired location */
 198
 199 void IOMappedWrite8(IOPhysicalAddress address, UInt8 value);
 200
 201 /*! @function IOMappedWrite16
 202     @abstract Write two bytes to the desired "Physical" IOSpace address.
 203     @discussion Write two bytes to the desired "Physical" IOSpace address.  This function allows the developer to write to an address returned from any memory descriptor's getPhysicalSegment routine.
 204     @param address The desired address, as returned by IOMemoryDescriptor::getPhysicalSegment.
 205     @param value Data to be writen to the desired location */
 206
 207 void IOMappedWrite16(IOPhysicalAddress address, UInt16 value);
 208
 209 /*! @function IOMappedWrite32
 210     @abstract Write four bytes to the desired "Physical" IOSpace address.
 211     @discussion Write four bytes to the desired "Physical" IOSpace address.  This function allows the developer to write to an address returned from any memory descriptor's getPhysicalSegment routine.
 212     @param address The desired address, as returned by IOMemoryDescriptor::getPhysicalSegment.
 213     @param value Data to be writen to the desired location */
 214
 215 void IOMappedWrite32(IOPhysicalAddress address, UInt32 value);
 216
 217 /*! @function IOMappedWrite64
 218     @abstract Write eight bytes to the desired "Physical" IOSpace address.
 219     @discussion Write eight bytes to the desired "Physical" IOSpace address.  This function allows the developer to write to an address returned from any memory descriptor's getPhysicalSegment routine.
 220     @param address The desired address, as returned by IOMemoryDescriptor::getPhysicalSegment.
 221     @param value Data to be writen to the desired location */
 222
 223 void IOMappedWrite64(IOPhysicalAddress address, UInt64 value);
 224
 225 /*! @function IOSetProcessorCacheMode
 226     @abstract Sets the processor cache mode for mapped memory.
 227     @discussion This function sets the cache mode of an already mapped & wired memory range. Note this may not be supported on I/O mappings or shared memory - it is far preferable to set the cache mode as mappings are created with the IOMemoryDescriptor::map method.
 228     @param task Task the memory is mapped into.
 229     @param address Virtual address of the memory.
 230     @param length Length of the range to set.
 231     @param cacheMode A constant from IOTypes.h, <br>
 232         kIOMapDefaultCache to inhibit the cache in I/O areas, kIOMapCopybackCache in general purpose RAM.<br>
 233         kIOMapInhibitCache, kIOMapWriteThruCache, kIOMapCopybackCache to set the appropriate caching.<br>
 234     @result An IOReturn code.*/
 235
 236 IOReturn IOSetProcessorCacheMode( task_t task, IOVirtualAddress address,
 237                                   IOByteCount length, IOOptionBits cacheMode );
 238
 239 /*! @function IOFlushProcessorCache
 240     @abstract Flushes the processor cache for mapped memory.
 241     @discussion This function flushes the processor cache of an already mapped memory range. Note in most cases it is preferable to use IOMemoryDescriptor::prepare and complete to manage cache coherency since they are aware of the architecture's requirements. Flushing the processor cache is not required for coherency in most situations.
 242     @param task Task the memory is mapped into.
 243     @param address Virtual address of the memory.
 244     @param length Length of the range to set.
 245     @result An IOReturn code. */
 246
 247 IOReturn IOFlushProcessorCache( task_t task, IOVirtualAddress address,
 248                                   IOByteCount length );
 249
 250 /*! @function IOThreadSelf
 251     @abstract Returns the osfmk identifier for the currently running thread.
 252     @discussion This function returns the current thread (a pointer to the currently active osfmk thread_shuttle). */
 253
 254 #define IOThreadSelf() (current_thread())
 255
 256 /*! @function IOCreateThread
 257     @abstract Deprecated function - use kernel_thread_start(). Create a kernel thread.
 258     @discussion This function creates a kernel thread, and passes the caller supplied argument to the new thread.  Warning: the value returned by this function is not 100% reliable.  There is a race condition where it is possible that the new thread has already terminated before this call returns.  Under that circumstance the IOThread returned will be invalid.  In general there is little that can be done with this value except compare it against 0.  The thread itself can call IOThreadSelf() 100% reliably and that is the prefered mechanism to manipulate the IOThreads state.
 259     @param function A C-function pointer where the thread will begin execution.
 260     @param argument Caller specified data to be passed to the new thread.
 261     @result An IOThread identifier for the new thread, equivalent to an osfmk thread_t. */
 262
 263 IOThread IOCreateThread(IOThreadFunc function, void *argument) __attribute__((deprecated));
 264
 265 /*! @function IOExitThread
 266     @abstract Deprecated function - use thread_terminate(). Terminate execution of current thread.
 267     @discussion This function destroys the currently running thread, and does not return. */
 268
 269 void IOExitThread(void) __attribute__((deprecated));
 270
 271 /*! @function IOSleep
 272     @abstract Sleep the calling thread for a number of milliseconds.
 273     @discussion This function blocks the calling thread for at least the number of specified milliseconds, giving time to other processes.
 274     @param milliseconds The integer number of milliseconds to wait. */
 275
 276 void IOSleep(unsigned milliseconds);
 277
 278 /*! @function IODelay
 279     @abstract Spin delay for a number of microseconds.
 280     @discussion This function spins to delay for at least the number of specified microseconds. Since the CPU is busy spinning no time is made available to other processes; this method of delay should be used only for short periods. Also, the AbsoluteTime based APIs of kern/clock.h provide finer grained and lower cost delays.
 281     @param microseconds The integer number of microseconds to spin wait. */
 282
 283 void IODelay(unsigned microseconds);
 284
 285 /*! @function IOPause
 286     @abstract Spin delay for a number of nanoseconds.
 287     @discussion This function spins to delay for at least the number of specified nanoseconds. Since the CPU is busy spinning no time is made available to other processes; this method of delay should be used only for short periods.
 288     @param microseconds The integer number of nanoseconds to spin wait. */
 289
 290 void IOPause(unsigned nanoseconds);
 291
 292 /*! @function IOLog
 293     @abstract Log a message to console in text mode, and /var/log/system.log.
 294     @discussion This function allows a driver to log diagnostic information to the screen during verbose boots, and to a log file found at /var/log/system.log. IOLog should not be called from interrupt context.
 295     @param format A printf() style format string (see printf(3) documentation).
 296     @param other arguments described by the format string. */
 297
 298 void IOLog(const char *format, ...)
 299 __attribute__((format(printf, 1, 2)));
 300
 301 /*! @function IOLogv
 302     @abstract Log a message to console in text mode, and /var/log/system.log.
 303     @discussion This function allows a driver to log diagnostic information to the screen during verbose boots, and to a log file found at /var/log/system.log. IOLogv should not be called from interrupt context.
 304     @param format A printf() style format string (see printf(3) documentation).
 305     @param ap stdarg(3) style variable arguments. */
 306
 307 void IOLogv(const char *format, va_list ap);
 308
 309 #ifndef _FN_KPRINTF
 310 #define _FN_KPRINTF
 311 void kprintf(const char *format, ...);
 312 #endif
 313 #ifndef _FN_KPRINTF_DECLARED
 314 #define _FN_KPRINTF_DECLARED
 315 #endif
 316
 317 /*
 318  * Convert a integer constant (typically a #define or enum) to a string
 319  * via an array of IONamedValue.
 320  */
 321 const char *IOFindNameForValue(int value,
 322         const IONamedValue *namedValueArray);
 323
 324 /*
 325  * Convert a string to an int via an array of IONamedValue. Returns
 326  * kIOReturnSuccess of string found, else returns kIOReturnBadArgument.
 327  */
 328 IOReturn IOFindValueForName(const char *string,
 329         const IONamedValue *regValueArray,
 330         int *value);                            /* RETURNED */
 331
 332 /*! @function Debugger
 333     @abstract Enter the kernel debugger.
 334     @discussion This function freezes the kernel and enters the builtin debugger. It may not be possible to exit the debugger without a second machine.
 335     @param reason A C-string to describe why the debugger is being entered. */
 336
 337 void Debugger(const char * reason);
 338 #if __LP64__
 339 #define IOPanic(reason) panic("%s", reason)
 340 #else
 341 void IOPanic(const char *reason) __attribute__((deprecated));
 342 #endif
 343
 344 struct OSDictionary * IOBSDNameMatching( const char * name );
 345 struct OSDictionary * IOOFPathMatching( const char * path, char * buf, int maxLen );
 346
 347 /*
 348  * Convert between size and a power-of-two alignment.
 349  */
 350 IOAlignment IOSizeToAlignment(unsigned int size);
 351 unsigned int IOAlignmentToSize(IOAlignment align);
 352
 353 /*
 354  * Multiply and divide routines for IOFixed datatype.
 355  */
 356
 357 static inline IOFixed IOFixedMultiply(IOFixed a, IOFixed b)
 358 {
 359     return (IOFixed)((((SInt64) a) * ((SInt64) b)) >> 16);
 360 }
 361
 362 static inline IOFixed IOFixedDivide(IOFixed a, IOFixed b)
 363 {
 364     return (IOFixed)((((SInt64) a) << 16) / ((SInt64) b));
 365 }
 366
 367 /*
 368  * IORound and IOTrunc convenience functions, in the spirit
 369  * of vm's round_page() and trunc_page().
 370  */
 371 #define IORound(value,multiple) \
 372         ((((value) + (multiple) - 1) / (multiple)) * (multiple))
 373
 374 #define IOTrunc(value,multiple) \
 375         (((value) / (multiple)) * (multiple));
 376
 377
 378 #if defined(__APPLE_API_OBSOLETE)
 379
 380 /* The following API is deprecated */
 381
 382 /* The API exported by kern/clock.h
 383    should be used for high resolution timing. */
 384
 385 void IOGetTime( mach_timespec_t * clock_time) __attribute__((deprecated));
 386
 387 #if !defined(__LP64__)
 388
 389 #undef eieio
 390 #define eieio() \
 391     OSSynchronizeIO()
 392
 393 extern mach_timespec_t IOZeroTvalspec;
 394
 395 #endif /* !defined(__LP64__) */
 396
 397 #endif /* __APPLE_API_OBSOLETE */
 398
 399 __END_DECLS
 400
 401 #endif /* !__IOKIT_IOLIB_H */