Changeset 4217 in vbox

Timestamp:

Aug 18, 2007 11:37:04 PM (17 years ago)

Author:

vboxsync

Message:

Updated the AllocNC and ReserveKernel docs.

File:

• trunk/include/iprt/memobj.h (modified) (2 diffs)

trunk/include/iprt/memobj.h

@@ -167 +167 @@
  * Allocates non-contiguous page aligned physical memory without (necessarily) any kernel mapping.
  *
- * @returns IPRT status code.
+ * This API is for allocating huge amounts of pages and will return
+ * VERR_NOT_SUPPORTED if this cannot be implemented in a satisfactory
+ * manner.
+ *
+ * @returns IPRT status code.
+ * @retval  VERR_NOT_SUPPORTED if it's not possible to allocated unmapped
+ *          physical memory on this platform. The caller should expect
+ *          this error and have a fallback strategy for it.
  * @param   pMemObj         Where to store the ring-0 memory object handle.
  * @param   cb              Number of bytes to allocate. This is rounded up to nearest page.
@@ -191 +198 @@
  * Reserves kernel virtual address space.
  *
+ * If this function fails with VERR_NOT_SUPPORTED, the idea is that you
+ * can use RTR0MemObjEnterPhys() + RTR0MemObjMapKernel() as a fallback if
+ * you have a safe physical address range to make use of...
+ *
  * @returns IPRT status code.
  * @param   pMemObj         Where to store the ring-0 memory object handle.