Changeset 99758 in vbox for trunk/src/VBox/Runtime/r0drv

Timestamp:

May 11, 2023 9:37:59 PM (21 months ago)

Author:

vboxsync

Message:

IPRT: Make doxygen 1.9.6 happy. Mostly removing duplicate docs (iprt is documented in the header files). bugref:10442

Location:

trunk/src/VBox/Runtime/r0drv

Files:

• linux/the-linux-kernel.h (modified) (1 diff)
• memobj-r0drv.cpp (modified) (7 diffs)
• nt/alloc-r0drv-nt.cpp (modified) (2 diffs)
• nt/timer-r0drv-nt.cpp (modified) (1 diff)

trunk/src/VBox/Runtime/r0drv/linux/the-linux-kernel.h

@@ -472 +472 @@
  * Whether the kernel support high resolution timers (Linux kernel versions
  * 2.6.28 and later (hrtimer_add_expires_ns() & schedule_hrtimeout). */
-#if RTLNX_VER_MIN(2,6,28)
+#if RTLNX_VER_MIN(2,6,28) || defined(DOXYGEN_RUNNING)
 # define IPRT_LINUX_HAS_HRTIMER
 #endif

trunk/src/VBox/Runtime/r0drv/memobj-r0drv.cpp

@@ -157 +157 @@
 
 
-/**
- * Checks if this is mapping or not.
- *
- * @returns true if it's a mapping, otherwise false.
- * @param   MemObj      The ring-0 memory object handle.
- */
 RTR0DECL(bool) RTR0MemObjIsMapping(RTR0MEMOBJ MemObj)
 {
@@ -178 +172 @@
 
 
-/**
- * Gets the address of a ring-0 memory object.
- *
- * @returns The address of the memory object.
- * @returns NULL if the handle is invalid (asserts in strict builds) or if there isn't any mapping.
- * @param   MemObj  The ring-0 memory object handle.
- */
 RTR0DECL(void *) RTR0MemObjAddress(RTR0MEMOBJ MemObj)
 {
@@ -202 +189 @@
 
 
-/**
- * Gets the ring-3 address of a ring-0 memory object.
- *
- * This only applies to ring-0 memory object with ring-3 mappings of some kind, i.e.
- * locked user memory, reserved user address space and user mappings. This API should
- * not be used on any other objects.
- *
- * @returns The address of the memory object.
- * @returns NIL_RTR3PTR if the handle is invalid or if it's not an object with a ring-3 mapping.
- *          Strict builds will assert in both cases.
- * @param   MemObj  The ring-0 memory object handle.
- */
 RTR0DECL(RTR3PTR) RTR0MemObjAddressR3(RTR0MEMOBJ MemObj)
 {
@@ -241 +216 @@
 
 
-/**
- * Gets the size of a ring-0 memory object.
- *
- * The returned value may differ from the one specified to the API creating the
- * object because of alignment adjustments.  The minimal alignment currently
- * employed by any API is PAGE_SIZE, so the result can safely be shifted by
- * PAGE_SHIFT to calculate a page count.
- *
- * @returns The object size.
- * @returns 0 if the handle is invalid (asserts in strict builds) or if there isn't any mapping.
- * @param   MemObj  The ring-0 memory object handle.
- */
 RTR0DECL(size_t) RTR0MemObjSize(RTR0MEMOBJ MemObj)
 {
@@ -272 +235 @@
 
 
-/**
- * Get the physical address of an page in the memory object.
- *
- * @returns The physical address.
- * @returns NIL_RTHCPHYS if the object doesn't contain fixed physical pages.
- * @returns NIL_RTHCPHYS if the iPage is out of range.
- * @returns NIL_RTHCPHYS if the object handle isn't valid.
- * @param   MemObj  The ring-0 memory object handle.
- * @param   iPage   The page number within the object.
- */
 /* Work around gcc bug 55940 */
 #if defined(__GNUC__) && defined(RT_ARCH_X86) && (__GNUC__ * 100 + __GNUC_MINOR__) == 407
@@ -322 +275 @@
 
 
-/**
- * Checks whether the allocation was zero initialized or not.
- *
- * This only works on allocations.  It is not meaningful for mappings, reserved
- * memory and entered physical address, and will return false for these.
- *
- * @returns true if the allocation was initialized to zero at allocation time,
- *          false if not or query not meaningful to the object type.
- * @param   hMemObj             The ring-0 memory object to be freed.
- *
- * @remarks It can be expected that memory allocated in the same fashion will
- *          have the same initialization state.  So, if this returns true for
- *          one allocation it will return true for all other similarly made
- *          allocations.
- */
 RTR0DECL(bool) RTR0MemObjWasZeroInitialized(RTR0MEMOBJ hMemObj)
 {
@@ -358 +296 @@
 
 
-/**
- * Frees a ring-0 memory object.
- *
- * @returns IPRT status code.
- * @retval  VERR_INVALID_HANDLE if
- * @param   MemObj          The ring-0 memory object to be freed. NIL is
- *                          accepted.
- * @param   fFreeMappings   Whether or not to free mappings of the object.
- */
 RTR0DECL(int) RTR0MemObjFree(RTR0MEMOBJ MemObj, bool fFreeMappings)
 {

trunk/src/VBox/Runtime/r0drv/nt/alloc-r0drv-nt.cpp

@@ -93 +93 @@
 
 
-/**
- * Allocates physical contiguous memory (below 4GB).
- * The allocation is page aligned and its contents is undefined.
- *
- * @returns Pointer to the memory block. This is page aligned.
- * @param   pPhys   Where to store the physical address.
- * @param   cb      The allocation size in bytes. This is always
- *                  rounded up to PAGE_SIZE.
- */
 RTR0DECL(void *) RTMemContAlloc(PRTCCPHYS pPhys, size_t cb)
 {
@@ -143 +134 @@
 
 
-/**
- * Frees memory allocated ysing RTMemContAlloc().
- *
- * @param   pv      Pointer to return from RTMemContAlloc().
- * @param   cb      The cb parameter passed to RTMemContAlloc().
- */
 RTR0DECL(void) RTMemContFree(void *pv, size_t cb)
 {

trunk/src/VBox/Runtime/r0drv/nt/timer-r0drv-nt.cpp

@@ -313 +313 @@
  * Common timer callback worker for the non-omni timers.
  *
- * @returns HRTIMER_NORESTART or HRTIMER_RESTART depending on whether it's a one-shot or interval timer.
  * @param   pTimer          The timer.
  */