iokit/IOKit/IOBufferMemoryDescriptor.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 #ifndef _IOBUFFERMEMORYDESCRIPTOR_H
  29 #define _IOBUFFERMEMORYDESCRIPTOR_H
  30
  31 #include <IOKit/IOMemoryDescriptor.h>
  32
  33 enum {
  34     kIOMemoryPhysicallyContiguous       = 0x00000010,
  35     kIOMemoryPageable                   = 0x00000020,
  36     kIOMemoryPurgeable                  = 0x00000040,
  37     kIOMemorySharingTypeMask            = 0x000f0000,
  38     kIOMemoryUnshared                   = 0x00000000,
  39     kIOMemoryKernelUserShared           = 0x00010000
  40 };
  41
  42 #define _IOBUFFERMEMORYDESCRIPTOR_INTASKWITHOPTIONS_    1
  43 /*!
  44     @class IOBufferMemoryDescriptor
  45     @abstract Provides a simple memory descriptor that allocates its own buffer memory.
  46 */
  47
  48 class IOBufferMemoryDescriptor : public IOGeneralMemoryDescriptor
  49 {
  50     OSDeclareDefaultStructors(IOBufferMemoryDescriptor);
  51
  52 protected:
  53 /*! @struct ExpansionData
  54     @discussion This structure will be used to expand the capablilties of this class in the future.
  55     */
  56     struct ExpansionData {
  57         vm_map_t        map;
  58     };
  59
  60 /*! @var reserved
  61     Reserved for future use.  (Internal use only)  */
  62     ExpansionData * reserved;
  63
  64 protected:
  65     void *               _buffer;
  66     vm_size_t            _capacity;
  67     vm_offset_t          _alignment;
  68     IOOptionBits         _options;
  69     IOPhysicalAddress *  _physAddrs;
  70     unsigned             _physSegCount;
  71
  72 private:
  73     virtual bool initWithOptions(
  74                                IOOptionBits options,
  75                                vm_size_t    capacity,
  76                                vm_offset_t  alignment,
  77                                task_t       inTask);
  78     OSMetaClassDeclareReservedUsed(IOBufferMemoryDescriptor, 0);
  79
  80 #if !(defined(__ppc__) && defined(KPI_10_4_0_PPC_COMPAT))
  81     virtual bool initWithPhysicalMask(
  82                                 task_t            inTask,
  83                                 IOOptionBits      options,
  84                                 mach_vm_size_t    capacity,
  85                                 mach_vm_address_t alignment,
  86                                 mach_vm_address_t physicalMask);
  87     OSMetaClassDeclareReservedUsed(IOBufferMemoryDescriptor, 1);
  88 #else
  89     OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 1);
  90 #endif
  91     OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 2);
  92     OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 3);
  93     OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 4);
  94     OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 5);
  95     OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 6);
  96     OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 7);
  97     OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 8);
  98     OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 9);
  99     OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 10);
 100     OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 11);
 101     OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 12);
 102     OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 13);
 103     OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 14);
 104     OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 15);
 105
 106 protected:
 107     virtual void free();
 108
 109     virtual bool initWithAddress( void *      address,       /* not supported */
 110                                   IOByteCount withLength,
 111                                   IODirection withDirection );
 112
 113     virtual bool initWithAddress( vm_address_t address,      /* not supported */
 114                                   IOByteCount  withLength,
 115                                   IODirection  withDirection,
 116                                   task_t       withTask );
 117
 118     virtual bool initWithPhysicalAddress(
 119                                   IOPhysicalAddress address, /* not supported */
 120                                   IOByteCount       withLength,
 121                                   IODirection       withDirection );
 122
 123     virtual bool initWithPhysicalRanges(
 124                                   IOPhysicalRange * ranges,  /* not supported */
 125                                   UInt32            withCount,
 126                                   IODirection       withDirection,
 127                                   bool              asReference = false );
 128
 129     virtual bool initWithRanges(  IOVirtualRange * ranges,   /* not supported */
 130                                   UInt32           withCount,
 131                                   IODirection      withDirection,
 132                                   task_t           withTask,
 133                                   bool             asReference = false );
 134
 135     IOGeneralMemoryDescriptor::withAddress;                  /* not supported */
 136     IOGeneralMemoryDescriptor::withPhysicalAddress;          /* not supported */
 137     IOGeneralMemoryDescriptor::withPhysicalRanges;           /* not supported */
 138     IOGeneralMemoryDescriptor::withRanges;                   /* not supported */
 139     IOGeneralMemoryDescriptor::withSubRange;                 /* not supported */
 140
 141 public:
 142
 143     /*
 144      * withOptions:
 145      *
 146      * Returns a new IOBufferMemoryDescriptor with a buffer large enough to
 147      * hold capacity bytes.  The descriptor's length is initially set to the
 148      * capacity.
 149      */
 150     virtual bool initWithOptions(   IOOptionBits options,
 151                                     vm_size_t    capacity,
 152                                     vm_offset_t  alignment);
 153
 154     static IOBufferMemoryDescriptor * withOptions(  IOOptionBits options,
 155                                                     vm_size_t    capacity,
 156                                                     vm_offset_t  alignment = 1);
 157
 158 /*! @function inTaskWithOptions
 159     @abstract Creates a memory buffer with memory descriptor for that buffer.
 160     @discussion Added in Mac OS X 10.2, this method allocates a memory buffer with a given size and alignment in the task's address space specified, and returns a memory descriptor instance representing the memory. It is recommended that memory allocated for I/O or sharing via mapping be created via IOBufferMemoryDescriptor. Options passed with the request specify the kind of memory to be allocated - pageablity and sharing are specified with option bits. This function may block and so should not be called from interrupt level or while a simple lock is held.
 161     @param inTask The task the buffer will be allocated in.
 162     @param options Options for the allocation:<br>
 163     kIODirectionOut, kIODirectionIn - set the direction of the I/O transfer.<br>
 164     kIOMemoryPhysicallyContiguous - pass to request memory be physically contiguous. This option is heavily discouraged. The request may fail if memory is fragmented, may cause large amounts of paging activity, and may take a very long time to execute.<br>
 165     kIOMemoryPageable - pass to request memory be non-wired - the default for kernel allocated memory is wired.<br>
 166     kIOMemoryPurgeable - pass to request memory that may later have its purgeable state set with IOMemoryDescriptor::setPurgeable. Only supported for kIOMemoryPageable allocations.<br>
 167     kIOMemoryKernelUserShared - pass to request memory that will be mapped into both the kernel and client applications.
 168     @param capacity The number of bytes to allocate.
 169     @param alignment The minimum required alignment of the buffer in bytes - 1 is the default for no required alignment. For example, pass 256 to get memory allocated at an address with bits 0-7 zero.
 170     @result Returns an instance of class IOBufferMemoryDescriptor to be released by the caller, which will free the memory desriptor and associated buffer. */
 171
 172     static IOBufferMemoryDescriptor * inTaskWithOptions(
 173                                             task_t       inTask,
 174                                             IOOptionBits options,
 175                                             vm_size_t    capacity,
 176                                             vm_offset_t  alignment = 1);
 177
 178 #if !(defined(__ppc__) && defined(KPI_10_4_0_PPC_COMPAT))
 179 /*! @function inTaskWithPhysicalMask
 180     @abstract Creates a memory buffer with memory descriptor for that buffer.
 181     @discussion Added in Mac OS X 10.5, this method allocates a memory buffer with a given size and alignment in the task's address space specified, and returns a memory descriptor instance representing the memory. It is recommended that memory allocated for I/O or sharing via mapping be created via IOBufferMemoryDescriptor. Options passed with the request specify the kind of memory to be allocated - pageablity and sharing are specified with option bits. This function may block and so should not be called from interrupt level or while a simple lock is held.
 182     @param inTask The task the buffer will be mapped in. Pass NULL to create memory unmapped in any task (eg. for use as a DMA buffer).
 183     @param options Options for the allocation:<br>
 184     kIODirectionOut, kIODirectionIn - set the direction of the I/O transfer.<br>
 185     kIOMemoryPhysicallyContiguous - pass to request memory be physically contiguous. This option is heavily discouraged. The request may fail if memory is fragmented, may cause large amounts of paging activity, and may take a very long time to execute.<br>
 186     kIOMemoryKernelUserShared - pass to request memory that will be mapped into both the kernel and client applications.
 187     @param capacity The number of bytes to allocate.
 188     @param mask The buffer will be allocated with pages such that physical addresses will only have bits set present in physicalMask. For example, pass 0x00000000FFFFFFFFULL for a buffer to be accessed by hardware that has 32 address bits.
 189     @result Returns an instance of class IOBufferMemoryDescriptor to be released by the caller, which will free the memory desriptor and associated buffer. */
 190
 191     static IOBufferMemoryDescriptor * inTaskWithPhysicalMask(
 192                                             task_t            inTask,
 193                                             IOOptionBits      options,
 194                                             mach_vm_size_t    capacity,
 195                                             mach_vm_address_t physicalMask);
 196 #endif
 197
 198     /*
 199      * withCapacity:
 200      *
 201      * Returns a new IOBufferMemoryDescriptor with a buffer large enough to
 202      * hold capacity bytes.  The descriptor's length is initially set to the
 203      * capacity.
 204      */
 205     static IOBufferMemoryDescriptor * withCapacity(
 206                                      vm_size_t    capacity,
 207                                      IODirection  withDirection,
 208                                      bool         withContiguousMemory = false);
 209     /*
 210      * initWithBytes:
 211      *
 212      * Initialize a new IOBufferMemoryDescriptor preloaded with bytes (copied).
 213      * The descriptor's length and capacity are set to the input buffer's size.
 214      */
 215     virtual bool initWithBytes(const void * bytes,
 216                                vm_size_t    withLength,
 217                                IODirection  withDirection,
 218                                bool         withContiguousMemory = false);
 219
 220     /*
 221      * withBytes:
 222      *
 223      * Returns a new IOBufferMemoryDescriptor preloaded with bytes (copied).
 224      * The descriptor's length and capacity are set to the input buffer's size.
 225      */
 226     static IOBufferMemoryDescriptor * withBytes(
 227                                      const void * bytes,
 228                                      vm_size_t    withLength,
 229                                      IODirection  withDirection,
 230                                      bool         withContiguousMemory = false);
 231
 232     /*
 233      * setLength:
 234      *
 235      * Change the buffer length of the memory descriptor.  When a new buffer
 236      * is created, the initial length of the buffer is set to be the same as
 237      * the capacity.  The length can be adjusted via setLength for a shorter
 238      * transfer (there is no need to create more buffer descriptors when you
 239      * can reuse an existing one, even for different transfer sizes).   Note
 240      * that the specified length must not exceed the capacity of the buffer.
 241      */
 242     virtual void setLength(vm_size_t length);
 243
 244     /*
 245      * setDirection:
 246      *
 247      * Change the direction of the transfer.  This method allows one to redirect
 248      * the descriptor's transfer direction.  This eliminates the need to destroy
 249      * and create new buffers when different transfer directions are needed.
 250      */
 251     virtual void setDirection(IODirection direction);
 252
 253     /*
 254      * getCapacity:
 255      *
 256      * Get the buffer capacity
 257      */
 258     virtual vm_size_t getCapacity() const;
 259
 260     /*
 261      * getBytesNoCopy:
 262      *
 263      * Return the virtual address of the beginning of the buffer
 264      */
 265     virtual void *getBytesNoCopy();
 266
 267     /*
 268      * getBytesNoCopy:
 269      *
 270      * Return the virtual address of an offset from the beginning of the buffer
 271      */
 272     virtual void *getBytesNoCopy(vm_size_t start, vm_size_t withLength);
 273
 274     /*
 275      * appendBytes:
 276      *
 277      * Add some data to the end of the buffer.  This method automatically
 278      * maintains the memory descriptor buffer length.  Note that appendBytes
 279      * will not copy past the end of the memory descriptor's current capacity.
 280      */
 281     virtual bool appendBytes(const void *bytes, vm_size_t withLength);
 282
 283 #if !(defined(__ppc__) && defined(KPI_10_4_0_PPC_COMPAT))
 284     /* DEPRECATED */ virtual void * getVirtualSegment(IOByteCount offset,
 285     /* DEPRECATED */                                    IOByteCount * length);
 286 #endif
 287 };
 288
 289 #endif /* !_IOBUFFERMEMORYDESCRIPTOR_H */