iokit/IOKit/IOLib.h

   1 /*
   2  * Copyright (c) 1998-2011 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. Must be identical to result
  89     @of a prior IOMalloc.
  90     @param size Size of the memory allocated. Must be identical to size of
  91     @the corresponding IOMalloc */
  92
  93 void   IOFree(void * address, vm_size_t size);
  94
  95 /*! @function IOMallocAligned
  96     @abstract Allocates wired memory in the kernel map, with an alignment restriction.
  97     @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.
  98     @param size Size of the memory requested.
  99     @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.
 100     @result Pointer to the allocated memory, or zero on failure. */
 101
 102 void * IOMallocAligned(vm_size_t size, vm_offset_t alignment);
 103
 104 /*! @function IOFreeAligned
 105     @abstract Frees memory allocated with IOMallocAligned.
 106     @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.
 107     @param address Pointer to the allocated memory.
 108     @param size Size of the memory allocated. */
 109
 110 void   IOFreeAligned(void * address, vm_size_t size);
 111
 112 /*! @function IOMallocContiguous
 113     @abstract Deprecated - use IOBufferMemoryDescriptor. Allocates wired memory in the kernel map, with an alignment restriction and physically contiguous.
 114     @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.
 115     @param size Size of the memory requested.
 116     @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.
 117     @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.
 118     @result Virtual address of the allocated memory, or zero on failure. */
 119
 120 void * IOMallocContiguous(vm_size_t size, vm_size_t alignment,
 121                            IOPhysicalAddress * physicalAddress) __attribute__((deprecated));
 122
 123 /*! @function IOFreeContiguous
 124     @abstract Deprecated - use IOBufferMemoryDescriptor. Frees memory allocated with IOMallocContiguous.
 125     @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.
 126     @param address Virtual address of the allocated memory.
 127     @param size Size of the memory allocated. */
 128
 129 void   IOFreeContiguous(void * address, vm_size_t size) __attribute__((deprecated));
 130
 131
 132 /*! @function IOMallocPageable
 133     @abstract Allocates pageable memory in the kernel map.
 134     @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.
 135     @param size Size of the memory requested.
 136     @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.
 137     @result Pointer to the allocated memory, or zero on failure. */
 138
 139 void * IOMallocPageable(vm_size_t size, vm_size_t alignment);
 140
 141 /*! @function IOFreePageable
 142     @abstract Frees memory allocated with IOMallocPageable.
 143     @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.
 144     @param address Virtual address of the allocated memory.
 145     @param size Size of the memory allocated. */
 146
 147 void IOFreePageable(void * address, vm_size_t size);
 148
 149 /*
 150  * Typed memory allocation macros. Both may block.
 151  */
 152 #define IONew(type,number)        (type*)IOMalloc(sizeof(type) * (number) )
 153 #define IODelete(ptr,type,number) IOFree( (ptr) , sizeof(type) * (number) )
 154
 155 /////////////////////////////////////////////////////////////////////////////
 156 //
 157 //
 158 //      These functions are now implemented in IOMapper.cpp
 159 //
 160 //
 161 /////////////////////////////////////////////////////////////////////////////
 162
 163 /*! @function IOMappedRead8
 164     @abstract Read one byte from the desired "Physical" IOSpace address.
 165     @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.
 166     @param address The desired address, as returned by IOMemoryDescriptor::getPhysicalSegment.
 167     @result Data contained at that location */
 168
 169 UInt8 IOMappedRead8(IOPhysicalAddress address);
 170
 171 /*! @function IOMappedRead16
 172     @abstract Read two bytes from the desired "Physical" IOSpace address.
 173     @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.
 174     @param address The desired address, as returned by IOMemoryDescriptor::getPhysicalSegment.
 175     @result Data contained at that location */
 176
 177 UInt16 IOMappedRead16(IOPhysicalAddress address);
 178
 179 /*! @function IOMappedRead32
 180     @abstract Read four bytes from the desired "Physical" IOSpace address.
 181     @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.
 182     @param address The desired address, as returned by IOMemoryDescriptor::getPhysicalSegment.
 183     @result Data contained at that location */
 184
 185 UInt32 IOMappedRead32(IOPhysicalAddress address);
 186
 187 /*! @function IOMappedRead64
 188     @abstract Read eight bytes from the desired "Physical" IOSpace address.
 189     @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.
 190     @param address The desired address, as returned by IOMemoryDescriptor::getPhysicalSegment.
 191     @result Data contained at that location */
 192
 193 UInt64 IOMappedRead64(IOPhysicalAddress address);
 194
 195 /*! @function IOMappedWrite8
 196     @abstract Write one byte to the desired "Physical" IOSpace address.
 197     @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.
 198     @param address The desired address, as returned by IOMemoryDescriptor::getPhysicalSegment.
 199     @param value Data to be writen to the desired location */
 200
 201 void IOMappedWrite8(IOPhysicalAddress address, UInt8 value);
 202
 203 /*! @function IOMappedWrite16
 204     @abstract Write two bytes to the desired "Physical" IOSpace address.
 205     @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.
 206     @param address The desired address, as returned by IOMemoryDescriptor::getPhysicalSegment.
 207     @param value Data to be writen to the desired location */
 208
 209 void IOMappedWrite16(IOPhysicalAddress address, UInt16 value);
 210
 211 /*! @function IOMappedWrite32
 212     @abstract Write four bytes to the desired "Physical" IOSpace address.
 213     @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.
 214     @param address The desired address, as returned by IOMemoryDescriptor::getPhysicalSegment.
 215     @param value Data to be writen to the desired location */
 216
 217 void IOMappedWrite32(IOPhysicalAddress address, UInt32 value);
 218
 219 /*! @function IOMappedWrite64
 220     @abstract Write eight bytes to the desired "Physical" IOSpace address.
 221     @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.
 222     @param address The desired address, as returned by IOMemoryDescriptor::getPhysicalSegment.
 223     @param value Data to be writen to the desired location */
 224
 225 void IOMappedWrite64(IOPhysicalAddress address, UInt64 value);
 226
 227 /* This function is deprecated. Cache settings may be set for allocated memory with the IOBufferMemoryDescriptor api. */
 228
 229 IOReturn IOSetProcessorCacheMode( task_t task, IOVirtualAddress address,
 230                                   IOByteCount length, IOOptionBits cacheMode ) __attribute__((deprecated));
 231
 232 /*! @function IOFlushProcessorCache
 233     @abstract Flushes the processor cache for mapped memory.
 234     @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.
 235     @param task Task the memory is mapped into.
 236     @param address Virtual address of the memory.
 237     @param length Length of the range to set.
 238     @result An IOReturn code. */
 239
 240 IOReturn IOFlushProcessorCache( task_t task, IOVirtualAddress address,
 241                                   IOByteCount length );
 242
 243 /*! @function IOThreadSelf
 244     @abstract Returns the osfmk identifier for the currently running thread.
 245     @discussion This function returns the current thread (a pointer to the currently active osfmk thread_shuttle). */
 246
 247 #define IOThreadSelf() (current_thread())
 248
 249 /*! @function IOCreateThread
 250     @abstract Deprecated function - use kernel_thread_start(). Create a kernel thread.
 251     @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.
 252     @param function A C-function pointer where the thread will begin execution.
 253     @param argument Caller specified data to be passed to the new thread.
 254     @result An IOThread identifier for the new thread, equivalent to an osfmk thread_t. */
 255
 256 IOThread IOCreateThread(IOThreadFunc function, void *argument) __attribute__((deprecated));
 257
 258 /*! @function IOExitThread
 259     @abstract Deprecated function - use thread_terminate(). Terminate execution of current thread.
 260     @discussion This function destroys the currently running thread, and does not return. */
 261
 262 void IOExitThread(void) __attribute__((deprecated));
 263
 264 /*! @function IOSleep
 265     @abstract Sleep the calling thread for a number of milliseconds.
 266     @discussion This function blocks the calling thread for at least the number of specified milliseconds, giving time to other processes.
 267     @param milliseconds The integer number of milliseconds to wait. */
 268
 269 void IOSleep(unsigned milliseconds);
 270
 271 /*! @function IODelay
 272     @abstract Spin delay for a number of microseconds.
 273     @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.
 274     @param microseconds The integer number of microseconds to spin wait. */
 275
 276 void IODelay(unsigned microseconds);
 277
 278 /*! @function IOPause
 279     @abstract Spin delay for a number of nanoseconds.
 280     @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.
 281     @param microseconds The integer number of nanoseconds to spin wait. */
 282
 283 void IOPause(unsigned nanoseconds);
 284
 285 /*! @function IOLog
 286     @abstract Log a message to console in text mode, and /var/log/system.log.
 287     @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.
 288     @param format A printf() style format string (see printf(3) documentation).
 289     @param other arguments described by the format string. */
 290
 291 void IOLog(const char *format, ...)
 292 __attribute__((format(printf, 1, 2)));
 293
 294 /*! @function IOLogv
 295     @abstract Log a message to console in text mode, and /var/log/system.log.
 296     @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.
 297     @param format A printf() style format string (see printf(3) documentation).
 298     @param ap stdarg(3) style variable arguments. */
 299
 300 void IOLogv(const char *format, va_list ap);
 301
 302 #ifndef _FN_KPRINTF
 303 #define _FN_KPRINTF
 304 void kprintf(const char *format, ...);
 305 #endif
 306 #ifndef _FN_KPRINTF_DECLARED
 307 #define _FN_KPRINTF_DECLARED
 308 #endif
 309
 310 /*
 311  * Convert a integer constant (typically a #define or enum) to a string
 312  * via an array of IONamedValue.
 313  */
 314 const char *IOFindNameForValue(int value,
 315         const IONamedValue *namedValueArray);
 316
 317 /*
 318  * Convert a string to an int via an array of IONamedValue. Returns
 319  * kIOReturnSuccess of string found, else returns kIOReturnBadArgument.
 320  */
 321 IOReturn IOFindValueForName(const char *string,
 322         const IONamedValue *regValueArray,
 323         int *value);                            /* RETURNED */
 324
 325 /*! @function Debugger
 326     @abstract Enter the kernel debugger.
 327     @discussion This function freezes the kernel and enters the builtin debugger. It may not be possible to exit the debugger without a second machine.
 328     @param reason A C-string to describe why the debugger is being entered. */
 329
 330 void Debugger(const char * reason);
 331 #if __LP64__
 332 #define IOPanic(reason) panic("%s", reason)
 333 #else
 334 void IOPanic(const char *reason) __attribute__((deprecated));
 335 #endif
 336
 337 #ifdef __cplusplus
 338 class OSDictionary;
 339 #endif
 340
 341 #ifdef __cplusplus
 342 OSDictionary *
 343 #else
 344 struct OSDictionary *
 345 #endif
 346 IOBSDNameMatching( const char * name );
 347
 348 #ifdef __cplusplus
 349 OSDictionary *
 350 #else
 351 struct OSDictionary *
 352 #endif
 353 IOOFPathMatching( const char * path, char * buf, int maxLen ) __attribute__((deprecated));
 354
 355 /*
 356  * Convert between size and a power-of-two alignment.
 357  */
 358 IOAlignment IOSizeToAlignment(unsigned int size);
 359 unsigned int IOAlignmentToSize(IOAlignment align);
 360
 361 /*
 362  * Multiply and divide routines for IOFixed datatype.
 363  */
 364
 365 static inline IOFixed IOFixedMultiply(IOFixed a, IOFixed b)
 366 {
 367     return (IOFixed)((((SInt64) a) * ((SInt64) b)) >> 16);
 368 }
 369
 370 static inline IOFixed IOFixedDivide(IOFixed a, IOFixed b)
 371 {
 372     return (IOFixed)((((SInt64) a) << 16) / ((SInt64) b));
 373 }
 374
 375 /*
 376  * IORound and IOTrunc convenience functions, in the spirit
 377  * of vm's round_page() and trunc_page().
 378  */
 379 #define IORound(value,multiple) \
 380         ((((value) + (multiple) - 1) / (multiple)) * (multiple))
 381
 382 #define IOTrunc(value,multiple) \
 383         (((value) / (multiple)) * (multiple));
 384
 385
 386 #if defined(__APPLE_API_OBSOLETE)
 387
 388 /* The following API is deprecated */
 389
 390 /* The API exported by kern/clock.h
 391    should be used for high resolution timing. */
 392
 393 void IOGetTime( mach_timespec_t * clock_time) __attribute__((deprecated));
 394
 395 #if !defined(__LP64__)
 396
 397 #undef eieio
 398 #define eieio() \
 399     OSSynchronizeIO()
 400
 401 extern mach_timespec_t IOZeroTvalspec;
 402
 403 #endif /* !defined(__LP64__) */
 404
 405 #endif /* __APPLE_API_OBSOLETE */
 406
 407 __END_DECLS
 408
 409 #endif /* !__IOKIT_IOLIB_H */