xnu-2782.10.72.tar.gz

[apple/xnu.git] / iokit / IOKit / IORangeAllocator.h

diff --git a/iokit/IOKit/IORangeAllocator.h b/iokit/IOKit/IORangeAllocator.h
index a0f2aeaa6b1aa40826c2c0f48c5d97b286930bf4..d81bbefc2d42249da44189b6caf4d2c06a641078 100644 (file)
--- a/iokit/IOKit/IORangeAllocator.h
+++ b/iokit/IOKit/IORangeAllocator.h
@@ -1,16 +1,19 @@
 /*
  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
  *
 /*
  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
  *

- * @APPLE_LICENSE_HEADER_START@
- * 
- * Copyright (c) 1999-2003 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
  * 
  * 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. Please obtain a copy of the License at
- * http://www.opensource.apple.com/apsl/ and read it before using this
- * file.
+ * 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
  * 
  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER


@@ -20,7 +23,7 @@
  * Please see the License for the specific language governing rights and
  * limitations under the License.
  * 
  * Please see the License for the specific language governing rights and
  * limitations under the License.
  * 

- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

  */
 /*
  * Copyright (c) 1999 Apple Computer, Inc.
  */
 /*
  * Copyright (c) 1999 Apple Computer, Inc.


@@ -37,11 +40,12 @@
 #include <libkern/c++/OSObject.h>
 #include <IOKit/IOTypes.h>
 
 #include <libkern/c++/OSObject.h>
 #include <IOKit/IOTypes.h>
 

-typedef UInt32 IORangeScalar;
+typedef IOByteCount IORangeScalar;

 
 

-/*! @class IORangeAllocator : public OSObject
+/*! @class IORangeAllocator

     @abstract A utility class to manage allocations from a range.
     @abstract A utility class to manage allocations from a range.

-    @discussion The IORangeAllocator class provides functions for allocating ranges, at a fixed or any offset, and freeing them back to a free list. It is useful for describing ranges of memory or address space without requiring storage in the memory - information describing the free elements is kept elsewhere. Ranges are described by a start offset and a size. IORangeAllocator is optionally protected against multithreaded access. */
+    @discussion The IORangeAllocator class provides functions for allocating ranges, at a fixed or any offset, and freeing them back to a free list. It is useful for describing ranges of memory or address space without requiring storage in the memory - information describing the free elements is kept elsewhere. Ranges are described by a start offset and a size. IORangeAllocator is optionally protected against multithreaded access. 
+*/

 
 class IORangeAllocator : public OSObject {
 
 
 class IORangeAllocator : public OSObject {
 


@@ -69,11 +73,11 @@ public:
 /*! @function init
     @abstract Standard initializer for IORangeAllocator.
     @discussion This method initializes an IORangeAllocator and optionally sets the free list to contain one fragment, from zero to an endOfRange parameter. The capacity in terms of free fragments and locking options are set for the instance.
 /*! @function init
     @abstract Standard initializer for IORangeAllocator.
     @discussion This method initializes an IORangeAllocator and optionally sets the free list to contain one fragment, from zero to an endOfRange parameter. The capacity in terms of free fragments and locking options are set for the instance.

-    @param endOfRange If the free list is to contain an initial fragment, set endOfRange to the last offset in the range, ie. size - 1, to create a free fragment for the range zero to endOfRange inclusive. If zero is passed the free list will be initialized empty, and can be populated with calls to the deallocate method.
+    @param endOfRange If the free list is to contain an initial fragment, set endOfRange to the last offset in the range, ie. size - 1, to create a free fragment for the range zero to endOfRange inclusive. If zero is passed, the free list will be initialized empty, and can be populated with calls to the deallocate method.

     @param defaultAlignment If this parameter is non-zero it specifies a required alignment for all allocations, for example pass 256 to align allocations on 256 byte boundaries. Zero or one specify unaligned allocations.
     @param defaultAlignment If this parameter is non-zero it specifies a required alignment for all allocations, for example pass 256 to align allocations on 256 byte boundaries. Zero or one specify unaligned allocations.

-    @param capacity Sets the initial size of the free list in number of non-contiguous fragments. This value is also used for the capacityIncrement.
+    @param capacity Sets the initial size of the free list in number of noncontiguous fragments. This value is also used for the capacityIncrement.

     @param options Pass kLocking if the instance can be used by multiple threads.
     @param options Pass kLocking if the instance can be used by multiple threads.

-    @result Returns true if the instance is successfully initialize, false on failure. */
+    @result Returns true if the instance is successfully initialized, false on failure. */

 
     virtual bool init( IORangeScalar endOfRange,
                        IORangeScalar defaultAlignment,
 
     virtual bool init( IORangeScalar endOfRange,
                        IORangeScalar defaultAlignment,


@@ -90,7 +94,8 @@ public:
     @result Returns the new IORangeAllocator instance, to be released by the caller, or zero on failure. */
 
     static IORangeAllocator * withRange( IORangeScalar endOfRange,
     @result Returns the new IORangeAllocator instance, to be released by the caller, or zero on failure. */
 
     static IORangeAllocator * withRange( IORangeScalar endOfRange,

-                                       IORangeScalar defaultAlignment = 0,                                             UInt32 capacity = 0,
+                                       IORangeScalar defaultAlignment = 0,
+                                       UInt32 capacity = 0,

                                        IOOptionBits options = 0 );
 
     virtual void free();
                                        IOOptionBits options = 0 );
 
     virtual void free();


@@ -99,58 +104,65 @@ public:
 /*! @function getFragmentCount
     @abstract Accessor to return the number of free fragments in the range.
     @discussion This method returns a count of free fragments. Each fragment describes a non-contiguous free range - deallocations will merge contiguous fragments together.
 /*! @function getFragmentCount
     @abstract Accessor to return the number of free fragments in the range.
     @discussion This method returns a count of free fragments. Each fragment describes a non-contiguous free range - deallocations will merge contiguous fragments together.

-    @result The count of free fragments. */
+    @result Returns the count of free fragments. 
+*/

 
     virtual UInt32 getFragmentCount( void );
 
 /*! @function getFragmentCapacity
     @abstract Accessor to return the number of free fragments in the range.
     @discussion This method returns the current capacity of the free fragment list.
 
     virtual UInt32 getFragmentCount( void );
 
 /*! @function getFragmentCapacity
     @abstract Accessor to return the number of free fragments in the range.
     @discussion This method returns the current capacity of the free fragment list.

-    @result The current capacity of free fragment list. */
+    @result Returns the current capacity of free fragment list. 
+*/

 
     virtual UInt32 getFragmentCapacity( void );
 
 /*! @function setFragmentCapacityIncrement
     @abstract Sets the count of fragments the free list will increase by when full.
 
     virtual UInt32 getFragmentCapacity( void );
 
 /*! @function setFragmentCapacityIncrement
     @abstract Sets the count of fragments the free list will increase by when full.

-    @discussion This method sets the number of extra fragments the free  list will expand to when full. It defaults to the initial capacity.
-    @param count The number of fragments to increment the capacity by when the free list is full. */
+    @discussion This method sets the number of extra fragments the free list will expand to when full. It defaults to the initial capacity.
+    @param count The number of fragments to increment the capacity by when the free list is full. 
+*/

 
     virtual void setFragmentCapacityIncrement( UInt32 count );
 
 /*! @function getFreeCount
     @abstract Totals the sizes of the free fragments.
     @discussion This method returns the total of the sizes of the fragments on the free list.
 
     virtual void setFragmentCapacityIncrement( UInt32 count );
 
 /*! @function getFreeCount
     @abstract Totals the sizes of the free fragments.
     @discussion This method returns the total of the sizes of the fragments on the free list.

-    @result The total of the free fragments sizes. */
+    @result Returns the total of the free fragments sizes. 
+*/

 
     virtual IORangeScalar getFreeCount( void );
 
 /*! @function allocate
 
     virtual IORangeScalar getFreeCount( void );
 
 /*! @function allocate

-    @abstract Allocate from the free list, at any offset.
+    @abstract Allocates from the free list, at any offset.

     @discussion This method allocates a range from the free list. The alignment will default to the alignment set when the allocator was created or may be set here. 
     @param size The size of the range requested.
     @param result The beginning of the range allocated is returned here on success.
     @param alignment If zero is passed, default to the allocators alignment, otherwise pass an alignment required for the allocation, for example 4096 to page align.
     @discussion This method allocates a range from the free list. The alignment will default to the alignment set when the allocator was created or may be set here. 
     @param size The size of the range requested.
     @param result The beginning of the range allocated is returned here on success.
     @param alignment If zero is passed, default to the allocators alignment, otherwise pass an alignment required for the allocation, for example 4096 to page align.

-    @result True if the allocation was successful, else false. */
+    @result Returns true if the allocation was successful, else false. 
+*/

 
     virtual bool allocate( IORangeScalar size,
                                            IORangeScalar * result,
                                            IORangeScalar alignment = 0 );
 
 /*! @function allocateRange
 
     virtual bool allocate( IORangeScalar size,
                                            IORangeScalar * result,
                                            IORangeScalar alignment = 0 );
 
 /*! @function allocateRange

-    @abstract Allocate from the free list, at a set offset.
+    @abstract Allocates from the free list, at a set offset.

     @discussion This method allocates a range from the free list, given a set offset passed in. 
     @param start The beginning of the range requested.
     @param size The size of the range requested.
     @discussion This method allocates a range from the free list, given a set offset passed in. 
     @param start The beginning of the range requested.
     @param size The size of the range requested.

-    @result True if the allocation was successful, else false. */
+    @result Returns true if the allocation was successful, else false.
+*/

 
     virtual bool allocateRange( IORangeScalar start,
                                                    IORangeScalar size );
 
 /*! @function deallocate
 
     virtual bool allocateRange( IORangeScalar start,
                                                    IORangeScalar size );
 
 /*! @function deallocate

-    @abstract Deallocate a range to the free list.
+    @abstract Deallocates a range to the free list.

     @discussion This method deallocates a range to the free list, given a the start offset and length passed in. 
     @param start The beginning of the range requested.
     @discussion This method deallocates a range to the free list, given a the start offset and length passed in. 
     @param start The beginning of the range requested.

-    @param size The size of the range requested. */
+    @param size Returns the size of the range requested. 
+*/

 
     virtual void deallocate( IORangeScalar start,
                                         IORangeScalar size );
 
     virtual void deallocate( IORangeScalar start,
                                         IORangeScalar size );