VirtualBox

Changeset 90382 in vbox for trunk


Ignore:
Timestamp:
Jul 28, 2021 10:13:15 PM (3 years ago)
Author:
vboxsync
Message:

VMM: Doxygen fixes for critsect devhlps. bugref:9218 bugref:10074

Location:
trunk
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/include/VBox/vmm/pdmdev.h

    r90364 r90382  
    78607860
    78617861/**
    7862  * @copydoc PDMCritSectEnter
     7862 * Enters a PDM critical section.
     7863 *
     7864 * @returns VINF_SUCCESS if entered successfully.
     7865 * @returns rcBusy when encountering a busy critical section in RC/R0.
     7866 * @retval  VERR_SEM_DESTROYED if the critical section is delete before or
     7867 *          during the operation.
     7868 *
     7869 * @param   pDevIns             The device instance.
     7870 * @param   pCritSect           The PDM critical section to enter.
     7871 * @param   rcBusy              The status code to return when we're in RC or R0
     7872 *                              and the section is busy.  Pass VINF_SUCCESS to
     7873 *                              acquired the critical section thru a ring-3
     7874 *                              call if necessary.
     7875 * @sa      PDMCritSectEnter
     7876 */
     7877DECLINLINE(int) PDMDevHlpCritSectEnter(PPDMDEVINS pDevIns, PPDMCRITSECT pCritSect, int rcBusy)
     7878{
     7879    return pDevIns->CTX_SUFF(pHlp)->pfnCritSectEnter(pDevIns, pCritSect, rcBusy);
     7880}
     7881
     7882/**
     7883 * Enters a PDM critical section, with location information for debugging.
     7884 *
     7885 * @returns VINF_SUCCESS if entered successfully.
     7886 * @returns rcBusy when encountering a busy critical section in RC/R0.
     7887 * @retval  VERR_SEM_DESTROYED if the critical section is delete before or
     7888 *          during the operation.
     7889 *
    78637890 * @param   pDevIns  The device instance.
    7864  */
    7865 DECLINLINE(int) PDMDevHlpCritSectEnter(PPDMDEVINS pDevIns, PPDMCRITSECT pCritSect, int rcBusy)
    7866 {
    7867     return pDevIns->CTX_SUFF(pHlp)->pfnCritSectEnter(pDevIns, pCritSect, rcBusy);
    7868 }
    7869 
    7870 /**
    7871  * @copydoc PDMCritSectEnterDebug
    7872  * @param   pDevIns  The device instance.
     7891 * @param   pCritSect           The PDM critical section to enter.
     7892 * @param   rcBusy              The status code to return when we're in RC or R0
     7893 *                              and the section is busy.   Pass VINF_SUCCESS to
     7894 *                              acquired the critical section thru a ring-3
     7895 *                              call if necessary.
     7896 * @param   uId                 Some kind of locking location ID.  Typically a
     7897 *                              return address up the stack.  Optional (0).
     7898 * @param   SRC_POS             The source position where to lock is being
     7899 *                              acquired from.  Optional.
     7900 * @sa      PDMCritSectEnterDebug
    78737901 */
    78747902DECLINLINE(int) PDMDevHlpCritSectEnterDebug(PPDMDEVINS pDevIns, PPDMCRITSECT pCritSect, int rcBusy, RTHCUINTPTR uId, RT_SRC_POS_DECL)
     
    78787906
    78797907/**
    7880  * @copydoc PDMCritSectTryEnter
    7881  * @param   pDevIns  The device instance.
     7908 * Try enter a critical section.
     7909 *
     7910 * @retval  VINF_SUCCESS on success.
     7911 * @retval  VERR_SEM_BUSY if the critsect was owned.
     7912 * @retval  VERR_SEM_NESTED if nested enter on a no nesting section. (Asserted.)
     7913 * @retval  VERR_SEM_DESTROYED if the critical section is delete before or
     7914 *          during the operation.
     7915 *
     7916 * @param   pDevIns     The device instance.
     7917 * @param   pCritSect   The critical section.
     7918 * @sa      PDMCritSectTryEnter
    78827919 */
    78837920DECLINLINE(int)      PDMDevHlpCritSectTryEnter(PPDMDEVINS pDevIns, PPDMCRITSECT pCritSect)
     
    78877924
    78887925/**
    7889  * @copydoc PDMCritSectTryEnterDebug
    7890  * @param   pDevIns  The device instance.
     7926 * Try enter a critical section, with location information for debugging.
     7927 *
     7928 * @retval  VINF_SUCCESS on success.
     7929 * @retval  VERR_SEM_BUSY if the critsect was owned.
     7930 * @retval  VERR_SEM_NESTED if nested enter on a no nesting section. (Asserted.)
     7931 * @retval  VERR_SEM_DESTROYED if the critical section is delete before or
     7932 *          during the operation.
     7933 *
     7934 * @param   pDevIns             The device instance.
     7935 * @param   pCritSect           The critical section.
     7936 * @param   uId                 Some kind of locking location ID.  Typically a
     7937 *                              return address up the stack.  Optional (0).
     7938 * @param   SRC_POS             The source position where to lock is being
     7939 *                              acquired from.  Optional.
     7940 * @sa      PDMCritSectTryEnterDebug
    78917941 */
    78927942DECLINLINE(int)      PDMDevHlpCritSectTryEnterDebug(PPDMDEVINS pDevIns, PPDMCRITSECT pCritSect, RTHCUINTPTR uId, RT_SRC_POS_DECL)
     
    78967946
    78977947/**
    7898  * @copydoc PDMCritSectLeave
    7899  * @param   pDevIns  The device instance.
     7948 * Leaves a critical section entered with PDMCritSectEnter().
     7949 *
     7950 * @returns Indication whether we really exited the critical section.
     7951 * @retval  VINF_SUCCESS if we really exited.
     7952 * @retval  VINF_SEM_NESTED if we only reduced the nesting count.
     7953 * @retval  VERR_NOT_OWNER if you somehow ignore release assertions.
     7954 *
     7955 * @param   pDevIns     The device instance.
     7956 * @param   pCritSect   The PDM critical section to leave.
     7957 * @sa      PDMCritSectLeave
    79007958 */
    79017959DECLINLINE(int)      PDMDevHlpCritSectLeave(PPDMDEVINS pDevIns, PPDMCRITSECT pCritSect)
     
    79057963
    79067964/**
    7907  * @copydoc PDMCritSectIsOwner
    7908  * @param   pDevIns  The device instance.
     7965 * @see PDMCritSectIsOwner
    79097966 */
    79107967DECLINLINE(bool)     PDMDevHlpCritSectIsOwner(PPDMDEVINS pDevIns, PCPDMCRITSECT pCritSect)
     
    79147971
    79157972/**
    7916  * @copydoc PDMCritSectIsInitialized
    7917  * @param   pDevIns  The device instance.
     7973 * @see PDMCritSectIsInitialized
    79187974 */
    79197975DECLINLINE(bool)     PDMDevHlpCritSectIsInitialized(PPDMDEVINS pDevIns, PCPDMCRITSECT pCritSect)
     
    79237979
    79247980/**
    7925  * @copydoc PDMCritSectHasWaiters
    7926  * @param   pDevIns  The device instance.
     7981 * @see PDMCritSectHasWaiters
    79277982 */
    79287983DECLINLINE(bool)     PDMDevHlpCritSectHasWaiters(PPDMDEVINS pDevIns, PCPDMCRITSECT pCritSect)
     
    79327987
    79337988/**
    7934  * @copydoc PDMCritSectGetRecursion
    7935  * @param   pDevIns  The device instance.
     7989 * @see PDMCritSectGetRecursion
    79367990 */
    79377991DECLINLINE(uint32_t) PDMDevHlpCritSectGetRecursion(PPDMDEVINS pDevIns, PCPDMCRITSECT pCritSect)
     
    79427996#if defined(IN_RING3) || defined(IN_RING0)
    79437997/**
    7944  * @copydoc PDMHCCritSectScheduleExitEvent
    7945  * @param   pDevIns  The device instance.
     7998 * @see PDMHCCritSectScheduleExitEvent
    79467999 */
    79478000DECLINLINE(int) PDMDevHlpCritSectScheduleExitEvent(PPDMDEVINS pDevIns, PPDMCRITSECT pCritSect, SUPSEMEVENT hEventToSignal)
     
    79658018
    79668019/**
    7967  * @copydoc PDMR3CritSectDelete
    7968  * @param   pDevIns  The device instance.
     8020 * Deletes the critical section.
     8021 *
     8022 * @returns VBox status code.
     8023 * @param   pDevIns     The device instance.
     8024 * @param   pCritSect   The PDM critical section to destroy.
     8025 * @sa      PDMR3CritSectDelete
    79698026 */
    79708027DECLINLINE(int) PDMDevHlpCritSectDelete(PPDMDEVINS pDevIns, PPDMCRITSECT pCritSect)
  • trunk/include/VBox/vmm/pdmdrv.h

    r90346 r90382  
    12411241     * @returns VBox status code.
    12421242     * @param   pDrvIns         The driver instance.
    1243      * @param   pcszBwGroup     Name of the bandwidth group to attach to.
     1243     * @param   pszBwGroup      Name of the bandwidth group to attach to.
    12441244     * @param   pFilter         Pointer to the filter we attach.
    12451245     */
  • trunk/src/VBox/VMM/VMMR0/PDMR0Driver.cpp

    r90346 r90382  
    189189
    190190
    191 /** @interface_method_impl{PDMDRVHLPR0,pfn} */
     191/** @interface_method_impl{PDMDRVHLPR0,pfnCritSectScheduleExitEvent} */
    192192static DECLCALLBACK(int)      pdmR0DrvHlp_CritSectScheduleExitEvent(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect,
    193193                                                                    SUPSEMEVENT hEventToSignal)
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette