xnu-792.tar.gz

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

diff --git a/iokit/IOKit/IODeviceMemory.h b/iokit/IOKit/IODeviceMemory.h
index 7c72d0524d5080d5db51f5e6325a0e308cf8a352..94b50cb00cb766bb46da30c58bd4171380c84f23 100644 (file)
--- a/iokit/IOKit/IODeviceMemory.h
+++ b/iokit/IOKit/IODeviceMemory.h
@@ -31,9 +31,10 @@
 
 #include <IOKit/IOMemoryDescriptor.h>
 
 
 #include <IOKit/IOMemoryDescriptor.h>
 

-/*! @class IODeviceMemory : public IOMemoryDescriptor
+/*! @class IODeviceMemory

     @abstract An IOMemoryDescriptor used for device physical memory ranges.
     @abstract An IOMemoryDescriptor used for device physical memory ranges.

-    @discussion The IODeviceMemory class is a simple subclass of IOMemoryDescriptor that uses its methods to describe a single range of physical memory on a device. IODeviceMemory objects are usually looked up with IOService or IOPCIDevice accessors, and are created by memory mapped bus families. IODeviceMemory implements only some factory methods in addition to the methods of IOMemoryDescriptor. */
+    @discussion The IODeviceMemory class is a simple subclass of IOMemoryDescriptor that uses its methods to describe a single range of physical memory on a device. IODeviceMemory objects are usually looked up with IOService or IOPCIDevice accessors, and are created by memory-mapped bus families. IODeviceMemory implements only some factory methods in addition to the methods of IOMemoryDescriptor. 
+*/

 
 class IODeviceMemory : public IOMemoryDescriptor
 {
 
 class IODeviceMemory : public IOMemoryDescriptor
 {


@@ -54,10 +55,10 @@ public:
 
 /*! @function arrayFromList
     @abstract Constructs an OSArray of IODeviceMemory instances, each describing one physical range, and a tag value.
 
 /*! @function arrayFromList
     @abstract Constructs an OSArray of IODeviceMemory instances, each describing one physical range, and a tag value.

-    @discussion This method creates IODeviceMemory instances for each physical range passed in a IODeviceMemory::InitElement array. Each element consists of a physical address, length and tag value for the IODeviceMemory. The instances are returned as a created OSArray.
+    @discussion This method creates IODeviceMemory instances for each physical range passed in an IODeviceMemory::InitElement array. Each element consists of a physical address, length and tag value for the IODeviceMemory. The instances are returned as a created OSArray.

     @param list An array of IODeviceMemory::InitElement structures.
     @param count The number of elements in the list.
     @param list An array of IODeviceMemory::InitElement structures.
     @param count The number of elements in the list.

-    @result A created OSArray of IODeviceMemory objects, to be released by the caller, or zero on failure. */
+    @result Returns a created OSArray of IODeviceMemory objects, to be released by the caller, or zero on failure. */

 
     static OSArray *           arrayFromList(
        InitElement             list[],
 
     static OSArray *           arrayFromList(
        InitElement             list[],


@@ -65,22 +66,22 @@ public:
 
 /*! @function withRange
     @abstract Constructs an IODeviceMemory instance, describing one physical range.
 
 /*! @function withRange
     @abstract Constructs an IODeviceMemory instance, describing one physical range.

-    @discussion This method creates IODeviceMemory instance for one physical range passed as a physical address and length. It just calls IOMemoryDescriptor::withPhysicalAddress.
+    @discussion This method creates an IODeviceMemory instance for one physical range passed as a physical address and length. It just calls IOMemoryDescriptor::withPhysicalAddress.

     @param address The physical address of the first byte in the memory.
     @param withLength The length of memory.
     @param address The physical address of the first byte in the memory.
     @param withLength The length of memory.

-    @result The created IODeviceMemory on success, to be released by the caller, or zero on failure. */
+    @result Returns the created IODeviceMemory on success, to be released by the caller, or zero on failure. */

 
     static IODeviceMemory *    withRange( 
        IOPhysicalAddress       start,
        IOPhysicalLength        length );
 
 
     static IODeviceMemory *    withRange( 
        IOPhysicalAddress       start,
        IOPhysicalLength        length );
 

-/*! @function withRange
+/*! @function withSubRange

     @abstract Constructs an IODeviceMemory instance, describing a subset of an existing IODeviceMemory range.
     @abstract Constructs an IODeviceMemory instance, describing a subset of an existing IODeviceMemory range.

-    @discussion This method creates IODeviceMemory instance for a subset of an existing IODeviceMemory range, passed as a physical address offset and length. It just calls IOMemoryDescriptor::withSubRange.
+    @discussion This method creates an IODeviceMemory instance for a subset of an existing IODeviceMemory range, passed as a physical address offset and length. It just calls IOMemoryDescriptor::withSubRange.

     @param of The parent IODeviceMemory of which a subrange is to be used for the new descriptor, which will be retained by the subrange IODeviceMemory.
     @param offset A byte offset into the parent's memory.
     @param length The length of the subrange.
     @param of The parent IODeviceMemory of which a subrange is to be used for the new descriptor, which will be retained by the subrange IODeviceMemory.
     @param offset A byte offset into the parent's memory.
     @param length The length of the subrange.

-    @result The created IODeviceMemory on success, to be released by the caller, or zero on failure. */
+    @result Returns the created IODeviceMemory on success, to be released by the caller, or zero on failure. */

 
     static IODeviceMemory *    withSubRange( 
        IODeviceMemory *        of,
 
     static IODeviceMemory *    withSubRange( 
        IODeviceMemory *        of,