iokit/IOKit/IOMemoryDescriptor.h

147 	uint32_t    options;
172     @discussion The IOMemoryDescriptor object represents a buffer or range of memory, specified as one or more physical or virtual address ranges. It contains methods to return the memory's physically contiguous segments (fragments), for use with the IOMemoryCursor, and methods to map the memory into any address space with caching and placed mapping options. */
217                                  IOOptionBits	options,
256     @param options The operation to perform on the memory:<br>
263     virtual IOReturn performOperation( IOOptionBits options,
279                                          IOOptionBits  options = 0 ) = 0;
283                                          IOOptionBits  options );
379     @param options
380         kIOMemoryDirectionMask (options:direction)	This nibble indicates the I/O direction to be associated with the descriptor, which may affect the operation of the prepare and complete methods on some architectures.
387 					IOOptionBits      options,
395     @param options
396         kIOMemoryDirectionMask (options:direction)	This nibble indicates the I/O direction to be associated with the descriptor, which may affect the operation of the prepare and complete methods on some architectures.
397         kIOMemoryAsReference	For options:type = Virtual or Physical this indicate that the memory descriptor need not copy the ranges array into local memory.  This is an optimisation to try to minimise unnecessary allocations.
404 					IOOptionBits     options,
409     @discussion This method creates and initializes an IOMemoryDescriptor for memory it has three main variants: Virtual, Physical & mach UPL.  These variants are selected with the options parameter, see below.  This memory descriptor needs to be prepared before it can be used to extract data from the memory described.
412     @param buffers A pointer to an array of IOAddressRange when options:type is kIOMemoryTypeVirtual64 or kIOMemoryTypePhysical64 or a 64bit kernel. For type UPL it is a upl_t returned by the mach/memory_object_types.h apis, primarily used internally by the UBC. IOVirtualRanges or IOPhysicalRanges are 32 bit only types for use when options:type is kIOMemoryTypeVirtual or kIOMemoryTypePhysical on 32bit kernels.
414     @param count options:type = Virtual or Physical count contains a count of the number of entires in the buffers array.  For options:type = UPL this field contains a total length.
416     @param offset Only used when options:type = UPL, in which case this field contains an offset for the memory within the buffers upl.
418     @param task Only used options:type = Virtual, The task each of the virtual ranges are mapped into.
420     @param options
421         kIOMemoryDirectionMask (options:direction)	This nibble indicates the I/O direction to be associated with the descriptor, which may affect the operation of the prepare and complete methods on some architectures.
422         kIOMemoryTypeMask (options:type)	kIOMemoryTypeVirtual64, kIOMemoryTypeVirtual, kIOMemoryTypePhysical64, kIOMemoryTypePhysical, kIOMemoryTypeUPL Indicates that what type of memory basic memory descriptor to use.  This sub-field also controls the interpretation of the buffers, count, offset & task parameters.
423         kIOMemoryAsReference	For options:type = Virtual or Physical this indicate that the memory descriptor need not copy the ranges array into local memory.  This is an optimisation to try to minimise unnecessary allocations.
434                                            IOOptionBits	options,
574     @discussion This is the general purpose method to map all or part of the memory described by a memory descriptor into a task at any available address, or at a fixed address if possible. Caching & read-only options may be set for the mapping. The mapping is represented as a returned reference to a IOMemoryMap object, which may be shared if the mapping is compatible with an existing mapping of the IOMemoryDescriptor. The IOMemoryMap object returned should be released only when the caller has finished accessing the mapping, as freeing the object destroys the mapping.
577     @param options Mapping options are defined in IOTypes.h,<br>
591 	IOOptionBits		options,
599 	IOOptionBits		options,
607     @param options Mapping options as in the full version of the createMappingInTask method, with kIOMapAnywhere assumed.
611 	IOOptionBits		options = 0 );
618     @param options Caching and read-only attributes of the mapping.
624 	IOOptionBits		options = 0 );
639         IOOptionBits		options );
645 	IOOptionBits		options,
659 	IOOptionBits		options,
716 	       					   IOOptionBits  options = 0);
751     @abstract Accessor to the options the mapping was created with.
752     @discussion This method returns the options to IOMemoryDescriptor::map the mapping was created with.
770     @param options Mapping options are defined in IOTypes.h, and are documented in IOMemoryDescriptor::map()
778 					 IOOptionBits         options,
782 					 IOOptionBits         options,
816 	IOOptionBits		options,
829     	uint32_t		options,
845 // Also these flags should not overlap with the options to
846 //	IOMemoryDescriptor::initWithRanges(... IOOptionsBits options);
942                                  IOOptionBits	options,
991                                          IOOptionBits  options = 0 );
993                                          IOOptionBits  options );
1003 	IOOptionBits		options,