VirtualBox

Changeset 58106 in vbox for trunk


Ignore:
Timestamp:
Oct 7, 2015 5:07:25 PM (9 years ago)
Author:
vboxsync
Message:

include,misc: Corrected a bunch of doxygen errors.

Location:
trunk
Files:
57 edited

Legend:

Unmodified
Added
Removed

  • trunk/Doxyfile.Core

    r58089 r58106  
    3232    "vmstateto=@par VM State Out:\n"
    3333
     34# Input / output paragraphs.
     35ALIASES                += \
     36    "output=@par Output:\n" \
     37    "input=@par Input:\n"
     38
    3439# Interface method implementation macros.
    3540ALIASES                += \
    … …  
    460465    RT_IPRT_FORMAT_ATTR(a,b)= \
    461466    RT_IPRT_FORMAT_ATTR_MAYBE_NULL(a,b)= \
    462     RT_NO_THROW_PROTO=
     467    RT_NO_THROW_PROTO= \
     468    RTASN1CONTEXTTAG_IMPL_CURSOR_INLINES(a)=
    463469
    464470# decl and calling conventions.
    … …  
    475481    DECLNORETURN(type)=type \
    476482    VBOXCALL= \
    477     RTCALL=
     483    RTCALL= \
     484    DECLVBGL(type)=type \
     485    DECLR0VBGL(type)=type \
     486    USBLIB_DECL(type)=type
     487
    478488# context hacks.
    479489PREDEFINED            += RCPTRTYPE(RCType)=RCType
    … …  
    482492PREDEFINED            += HCPTRTYPE(HCType)=HCType
    483493PREDEFINED            += R3R0PTRTYPE(R3R0Type)=R3R0Type
     494
    484495# Compile assertion hacks.
    485496PREDEFINED            += \
    … …  
    497508    AssertCompileMembersSameSize(type1, member1, type2, member2) \
    498509    AssertCompileMembersSameSizeAndOffset(type1, member1, type2, member2)
     510
    499511# COM/XPCOM hacks.
    500 PREDEFINED            += STDMETHODIMP=HRESULT
    501 PREDEFINED            += "COMGETTER(n)=get_##n"
    502 PREDEFINED            += "COMSETTER(n)=set_##n"
     512PREDEFINED            += \
     513    STDMETHODIMP=HRESULT \
     514    "COMGETTER(n)=get_##n" \
     515    "COMSETTER(n)=set_##n" \
     516    "ComSafeArrayIn(aType,aArg)=aType *aArg" \
     517    "ComSafeArrayOut(aType, aArg)=aType **aArg" \
     518    DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(a)=
     519
    503520# COM hacks from From http://www.stack.nl/~dimitri/doxygen/preprocessing.html
    504 PREDEFINED          += "DECLARE_INTERFACE(name)=class name" \
    505                        "STDMETHOD_(result,name)=virtual result name" \
    506                        "PURE= = 0" \
    507                        THIS_= \
    508                        THIS= \
    509                        DECLARE_REGISTRY_RESOURCEID=// \
    510                        DECLARE_PROTECT_FINAL_CONSTRUCT=// \
    511                        "DECLARE_AGGREGATABLE(Class)= " \
    512                        "DECLARE_REGISTRY_RESOURCEID(Id)= " \
    513                        DECLARE_MESSAGE_MAP= \
    514                        BEGIN_MESSAGE_MAP=/* \
    515                        END_MESSAGE_MAP=*/// \
    516                        BEGIN_COM_MAP=/* \
    517                        END_COM_MAP=*/// \
    518                        BEGIN_PROP_MAP=/* \
    519                        END_PROP_MAP=*/// \
    520                        BEGIN_MSG_MAP=/* \
    521                        END_MSG_MAP=*/// \
    522                        BEGIN_PROPERTY_MAP=/* \
    523                        END_PROPERTY_MAP=*/// \
    524                        BEGIN_OBJECT_MAP=/* \
    525                        END_OBJECT_MAP()=*/// \
    526                        DECLARE_VIEW_STATUS=// \
    527                        "STDMETHOD(a)=HRESULT a" \
    528                        "ATL_NO_VTABLE= " \
    529                        "__declspec(a)= " \
    530                        BEGIN_CONNECTION_POINT_MAP=/* \
    531                        END_CONNECTION_POINT_MAP=*/// \
    532                        "DECLARE_DYNAMIC(class)= " \
    533                        "IMPLEMENT_DYNAMIC(class1, class2)= " \
    534                        "DECLARE_DYNCREATE(class)= " \
    535                        "IMPLEMENT_DYNCREATE(class1, class2)= " \
    536                        "IMPLEMENT_SERIAL(class1, class2, class3)= " \
    537                        "DECLARE_MESSAGE_MAP()= " \
    538                        TRY=try \
    539                        "CATCH_ALL(e)= catch(...)" \
    540                        END_CATCH_ALL= \
    541                        "THROW_LAST()= throw"\
    542                        "RUNTIME_CLASS(class)=class" \
    543                        "MAKEINTRESOURCE(nId)=nId" \
    544                        "IMPLEMENT_REGISTER(v, w, x, y, z)= " \
    545                        "ASSERT(x)=assert(x)" \
    546                        "ASSERT_VALID(x)=assert(x)" \
    547                        "TRACE0(x)=printf(x)" \
    548                        "OS_ERR(A,B)={ #A, B }" \
    549                        __cplusplus \
    550                        "DECLARE_OLECREATE(class)= " \
    551                        "BEGIN_DISPATCH_MAP(class1, class2)= " \
    552                        "BEGIN_INTERFACE_MAP(class1, class2)= " \
    553                        "INTERFACE_PART(class, id, name)= " \
    554                        "END_INTERFACE_MAP()=" \
    555                        "DISP_FUNCTION(class, name, function, result, id)=" \
    556                        "END_DISPATCH_MAP()=" \
    557                        "IMPLEMENT_OLECREATE2(class, name, id1, id2, id3, id4,\
    558                         id5, id6, id7, id8, id9, id10, id11)="
     521PREDEFINED          += \
     522    "DECLARE_INTERFACE(name)=class name" \
     523    "STDMETHOD_(result,name)=virtual result name" \
     524    "PURE= = 0" \
     525    THIS_= \
     526    THIS= \
     527    DECLARE_REGISTRY_RESOURCEID=// \
     528    DECLARE_PROTECT_FINAL_CONSTRUCT=// \
     529    "DECLARE_AGGREGATABLE(Class)= " \
     530    "DECLARE_REGISTRY_RESOURCEID(Id)= " \
     531    DECLARE_MESSAGE_MAP= \
     532    BEGIN_MESSAGE_MAP=/* \
     533    END_MESSAGE_MAP=*/// \
     534    BEGIN_COM_MAP=/* \
     535    END_COM_MAP=*/// \
     536    BEGIN_PROP_MAP=/* \
     537    END_PROP_MAP=*/// \
     538    BEGIN_MSG_MAP=/* \
     539    END_MSG_MAP=*/// \
     540    BEGIN_PROPERTY_MAP=/* \
     541    END_PROPERTY_MAP=*/// \
     542    BEGIN_OBJECT_MAP=/* \
     543    END_OBJECT_MAP()=*/// \
     544    DECLARE_VIEW_STATUS=// \
     545    "STDMETHOD(a)=HRESULT a" \
     546    "ATL_NO_VTABLE= " \
     547    "__declspec(a)= " \
     548    BEGIN_CONNECTION_POINT_MAP=/* \
     549    END_CONNECTION_POINT_MAP=*/// \
     550    "DECLARE_DYNAMIC(class)= " \
     551    "IMPLEMENT_DYNAMIC(class1, class2)= " \
     552    "DECLARE_DYNCREATE(class)= " \
     553    "IMPLEMENT_DYNCREATE(class1, class2)= " \
     554    "IMPLEMENT_SERIAL(class1, class2, class3)= " \
     555    "DECLARE_MESSAGE_MAP()= " \
     556    TRY=try \
     557    "CATCH_ALL(e)= catch(...)" \
     558    END_CATCH_ALL= \
     559    "THROW_LAST()= throw"\
     560    "RUNTIME_CLASS(class)=class" \
     561    "MAKEINTRESOURCE(nId)=nId" \
     562    "IMPLEMENT_REGISTER(v, w, x, y, z)= " \
     563    "ASSERT(x)=assert(x)" \
     564    "ASSERT_VALID(x)=assert(x)" \
     565    "TRACE0(x)=printf(x)" \
     566    "OS_ERR(A,B)={ #A, B }" \
     567    __cplusplus \
     568    "DECLARE_OLECREATE(class)= " \
     569    "BEGIN_DISPATCH_MAP(class1, class2)= " \
     570    "BEGIN_INTERFACE_MAP(class1, class2)= " \
     571    "INTERFACE_PART(class, id, name)= " \
     572    "END_INTERFACE_MAP()=" \
     573    "DISP_FUNCTION(class, name, function, result, id)=" \
     574    "END_DISPATCH_MAP()=" \
     575    "IMPLEMENT_OLECREATE2(class, name, id1, id2, id3, id4,\
     576    id5, id6, id7, id8, id9, id10, id11)="
    559577
    560578EXPAND_AS_DEFINED      = \

  • trunk/include/VBox/GuestHost/clipboard-helper.h

    r56291 r58106  
    11/* $Id$ */
    22/** @file
    3  * Shared Clipboard: Some helper function for converting between the various eol.
     3 * Shared Clipboard - Some helper function for converting between the various EOLs.
    44 */
    55
    … …  
    2525 */
    2626
    27 #ifndef ___CLIPBOARD_HELPER_H
    28 #define ___CLIPBOARD_HELPER_H
     27#ifndef ___VBox_GuestHost_clipboard_helper_h
     28#define ___VBox_GuestHost_clipboard_helper_h
    2929
    3030#include <iprt/string.h>
    … …  
    3636    /** In Windows, lines end with a carriage return and a linefeed character. */
    3737    CARRIAGERETURN = 0xd,
    38     /** Little endian "real" Utf16 strings start with this marker. */
     38    /** Little endian "real" UTF-16 strings start with this marker. */
    3939    UTF16LEMARKER = 0xfeff,
    40     /** Big endian "real" Utf16 strings start with this marker. */
     40    /** Big endian "real" UTF-16 strings start with this marker. */
    4141    UTF16BEMARKER = 0xfffe
    4242};
    4343
    4444/**
    45  * Get the size of the buffer needed to hold a Utf16-LE zero terminated string with Windows EOLs
    46  * converted from a Utf16 string with Linux EOLs.
     45 * Get the size of the buffer needed to hold a UTF-16-LE zero terminated string
     46 * with Windows EOLs converted from a UTF-16 string with Linux EOLs.
    4747 *
    48  * @returns RT error code
     48 * @returns VBox status code.
    4949 *
    50  * @param   pwszSrc  The source Utf16 string
    51  * @param   cwSrc    The length in 16 bit words of the source string
    52  * @retval  pcwDest  The length of the destination string in 16 bit words
     50 * @param   pwszSrc  The source UTF-16 string.
     51 * @param   cwcSrc   The length of the source string in RTUTF16 units.
     52 * @param   pcwcDst  The length of the destination string in RTUTF16 units.
    5353 */
    54 int vboxClipboardUtf16GetWinSize(PRTUTF16 pwszSrc, size_t cwSrc, size_t *pcwDest);
     54int vboxClipboardUtf16GetWinSize(PRTUTF16 pwszSrc, size_t cwcSrc, size_t *pcwcDst);
    5555
    5656/**
    57  * Convert a Utf16 text with Linux EOLs to null-terminated Utf16-LE with Windows EOLs.  Does no
    58  * checking for validity.
     57 * Convert a UTF-16 text with Linux EOLs to null-terminated UTF-16-LE with
     58 * Windows EOLs.
     59 *
     60 * Does no checking for validity.
    5961 *
    6062 * @returns VBox status code
    6163 *
    62  * @param   pwszSrc  Source Utf16 text to convert
    63  * @param   cwSrc    Size of the source text in 16 bit words
    64  * @retval  pu16Dest Buffer to store the converted text to.
    65  * @retval  pcwDest  Size of the buffer for the converted text in 16 bit words
     64 * @param   pwszSrc  Source UTF-16 text to convert.
     65 * @param   cwcSrc   Size of the source text int RTUTF16 units
     66 * @param   pwszDst Buffer to store the converted text to.
     67 * @param   cwcDst   Size of the buffer for the converted text in RTUTF16 units.
    6668 */
    67 int vboxClipboardUtf16LinToWin(PRTUTF16 pwszSrc, size_t cwSrc, PRTUTF16 pu16Dest, size_t cwDest);
     69int vboxClipboardUtf16LinToWin(PRTUTF16 pwszSrc, size_t cwcSrc, PRTUTF16 pwszDst, size_t cwcDst);
    6870
    6971/**
    70  * Get the size of the buffer needed to hold a zero-terminated Utf16 string with Linux EOLs
    71  * converted from a Utf16 string with Windows EOLs.
     72 * Get the size of the buffer needed to hold a zero-terminated UTF-16 string
     73 * with Linux EOLs converted from a UTF-16 string with Windows EOLs.
    7274 *
    7375 * @returns RT status code
    7476 *
    75  * @param   pwszSrc  The source Utf16 string
    76  * @param   cwSrc    The length in 16 bit words of the source string
    77  * @retval  pcwDest  The length of the destination string in 16 bit words
     77 * @param   pwszSrc  The source UTF-16 string
     78 * @param   cwcSrc   The length of the source string in RTUTF16 units.
     79 * @retval  pcwcDst  The length of the destination string in RTUTF16 units.
    7880 */
    79 int vboxClipboardUtf16GetLinSize(PRTUTF16 pwszSrc, size_t cwSrc, size_t *pcwDest);
     81int vboxClipboardUtf16GetLinSize(PRTUTF16 pwszSrc, size_t cwcSrc, size_t *pcwcDst);
    8082
    8183/**
    82  * Convert Utf16-LE text with Windows EOLs to zero-terminated Utf16 with Linux EOLs.  This
    83  * function does not verify that the Utf16 is valid.
     84 * Convert UTF-16-LE text with Windows EOLs to zero-terminated UTF-16 with Linux
     85 * EOLs.  This function does not verify that the UTF-16 is valid.
    8486 *
    8587 * @returns VBox status code
    8688 *
    87  * @param   pwszSrc       Text to convert
    88  * @param   cwSrc         Size of the source text in 16 bit words
    89  * @param   pu16Dest      The buffer to store the converted text to
    90  * @param   cwDest        The size of the buffer for the destination text in 16 bit words
     89 * @param   pwszSrc  Text to convert
     90 * @param   cwcSrc   Size of the source text in RTUTF16 units.
     91 * @param   pwszDst  The buffer to store the converted text to
     92 * @param   cwcDst   The size of the buffer for the destination text in RTUTF16
     93 *                   chars.
    9194 */
    92 int vboxClipboardUtf16WinToLin(PRTUTF16 pwszSrc, size_t cwSrc, PRTUTF16 pu16Dest, size_t cwDest);
     95int vboxClipboardUtf16WinToLin(PRTUTF16 pwszSrc, size_t cwcSrc, PRTUTF16 pwszDst, size_t cwcDst);
    9396
    9497#pragma pack(1)
    … …  
    101104typedef struct BMFILEHEADER
    102105{
     106/** @todo r=bird: this type centric prefixing is what give hungarian notation a bad name... */
    103107    uint16_t    u16Type;
    104108    uint32_t    u32Size;
    … …  
    118122typedef struct BMINFOHEADER
    119123{
     124/** @todo r=bird: this type centric prefixing is what give hungarian notation a bad name... */
    120125    uint32_t    u32Size;
    121126    uint32_t    u32Width;
    … …  
    132137/** Pointer to a BMINFOHEADER structure. */
    133138typedef BMINFOHEADER *PBMINFOHEADER;
    134 #pragma pack()
     139#pragma pack() /** @todo r=bird: Only BMFILEHEADER needs packing. The BMINFOHEADER is perfectly aligned. */
    135140
    136141/**
    … …  
    140145 * @returns VBox status code
    141146 *
    142  * @param   pSrc          DIB data to convert
     147 * @param   pvSrc         DIB data to convert
    143148 * @param   cbSrc         Size of the DIB data to convert in bytes
    144  * @param   ppDest        Where to store the pointer to the buffer for the destination data
    145  * @param   pcbDest       Pointer to the size of the buffer for the destination data in bytes
     149 * @param   ppvDst        Where to store the pointer to the buffer for the
     150 *                        destination data
     151 * @param   pcbDst        Pointer to the size of the buffer for the destination
     152 *                        data in bytes.
    146153 */
    147 int vboxClipboardDibToBmp(const void *pvSrc, size_t cbSrc, void **ppvDest, size_t *pcbDest);
     154int vboxClipboardDibToBmp(const void *pvSrc, size_t cbSrc, void **ppvDst, size_t *pcbDst);
    148155
    149156/**
    … …  
    153160 * @returns VBox status code
    154161 *
    155  * @param   pSrc          BMP data to convert
     162 * @param   pvSrc         BMP data to convert
    156163 * @param   cbSrc         Size of the BMP data to convert in bytes
    157  * @param   ppDest        Where to store the pointer to the destination data
    158  * @param   pcbDest       Pointer to the size of the destination data in bytes
     164 * @param   ppvDst        Where to store the pointer to the destination data
     165 * @param   pcbDst        Pointer to the size of the destination data in bytes
    159166 */
    160 int vboxClipboardBmpGetDib(const void *pvSrc, size_t cbSrc, const void **ppvDest, size_t *pcbDest);
     167int vboxClipboardBmpGetDib(const void *pvSrc, size_t cbSrc, const void **ppvDst, size_t *pcbDst);
    161168
    162169

  • trunk/include/VBox/HostServices/Service.h

    r56323 r58106  
    3636#include <memory>  /* for auto_ptr */
    3737
     38/** @todo  document the poor classes.   */
    3839namespace HGCM
    3940{
    … …  
    406407
    407408    /**
    408      * @copydoc VBOXHGCMSVCHELPERS::pfnUnload
     409     * @copydoc VBOXHGCMSVCFNTABLE::pfnUnload
    409410     * Simply deletes the service object
    410411     */
    … …  
    421422
    422423    /**
    423      * @copydoc VBOXHGCMSVCHELPERS::pfnConnect
     424     * @copydoc VBOXHGCMSVCFNTABLE::pfnConnect
    424425     * Stub implementation of pfnConnect and pfnDisconnect.
    425426     */
    … …  
    437438
    438439    /**
    439      * @copydoc VBOXHGCMSVCHELPERS::pfnConnect
     440     * @copydoc VBOXHGCMSVCFNTABLE::pfnConnect
    440441     * Stub implementation of pfnConnect and pfnDisconnect.
    441442     */
    … …  
    453454
    454455    /**
    455      * @copydoc VBOXHGCMSVCHELPERS::pfnCall
     456     * @copydoc VBOXHGCMSVCFNTABLE::pfnCall
    456457     * Wraps to the call member function
    457458     */
    … …  
    472473
    473474    /**
    474      * @copydoc VBOXHGCMSVCHELPERS::pfnHostCall
     475     * @copydoc VBOXHGCMSVCFNTABLE::pfnHostCall
    475476     * Wraps to the hostCall member function
    476477     */
    … …  
    489490
    490491    /**
    491      * @copydoc VBOXHGCMSVCHELPERS::pfnRegisterExtension
     492     * @copydoc VBOXHGCMSVCFNTABLE::pfnRegisterExtension
    492493     * Installs a host callback for notifications of property changes.
    493494     */

  • trunk/include/VBox/VBoxTpG.h

    r56291 r58106  
    105105#  define VTG_DECL_VTGPROBELOC(a_VarName) \
    106106    __declspec(allocate(VTG_LOC_SECT)) static VTGPROBELOC a_VarName
    107 # elif defined(__GNUC__)
     107# elif defined(__GNUC__) || defined(DOXYGEN_RUNNING)
    108108#  define VTG_DECL_VTGPROBELOC(a_VarName) \
    109109    static VTGPROBELOC __attribute__((section(VTG_LOC_SECT))) a_VarName
    … …  
    116116# define VTG_LOC_SECT       "__VTGPrLc"
    117117# define VTG_LOC_SEG        "__VTG"
    118 # ifdef __GNUC__
     118# if defined(__GNUC__) || defined(DOXYGEN_RUNNING)
    119119#  define VTG_DECL_VTGPROBELOC(a_VarName) \
    120120    static VTGPROBELOC __attribute__((section(VTG_LOC_SEG "," VTG_LOC_SECT ",regular")/*, aligned(16)*/)) a_VarName
    … …  
    127127# define VTG_LOC_SECT       "__VTGPrLc"
    128128# define VTG_LOC_SET        "__VTGPrLcSet"
    129 # ifdef __GNUC__
     129# if defined(__GNUC__) || defined(DOXYGEN_RUNNING)
    130130#  define VTG_DECL_VTGPROBELOC(a_VarName) \
    131131    static VTGPROBELOC a_VarName; \
    … …  
    139139# define VTG_OBJ_SECT       ".VTGObj"
    140140# define VTG_LOC_SECT       ".VTGPrLc"
    141 # ifdef __GNUC__
     141# if defined(__GNUC__) || defined(DOXYGEN_RUNNING)
    142142#  define VTG_DECL_VTGPROBELOC(a_VarName) \
    143143    static VTGPROBELOC __attribute__((section(VTG_LOC_SECT))) a_VarName

  • trunk/include/VBox/com/AutoLock.h

    r56291 r58106  
    120120    /**
    121121     * Returns the current write lock level of this semaphore. The lock level
    122      * determines the number of nested #lock() calls on the given semaphore
    123      * handle.
     122     * determines the number of nested #lockWrite() calls on the given
     123     * semaphore handle.
    124124     *
    125125     * Note that this call is valid only when the current thread owns a write
    … …  
    522522
    523523    /**
    524      * Release all write locks acquired by this instance through the #lock()
     524     * Release all write locks acquired by this instance through the #acquire()
    525525     * call and destroys the instance.
    526526     *
    527      * Note that if there there are nested #lock() calls without the
    528      * corresponding number of #unlock() calls when the destructor is called, it
     527     * Note that if there there are nested #acquire() calls without the
     528     * corresponding number of #release() calls when the destructor is called, it
    529529     * will assert. This is because having an unbalanced number of nested locks
    530530     * is a program logic error which must be fixed.

  • trunk/include/VBox/com/ErrorInfo.h

    r56291 r58106  
    191191
    192192    /** Specialization for the IVirtualBoxErrorInfo smart pointer */
    193     ErrorInfo (const ComPtr <IVirtualBoxErrorInfo> &aPtr)
    194         : mIsBasicAvailable (false), mIsFullAvailable (false)
    195         , mResultCode (S_OK), mResultDetail(0)
    196         { init (aPtr); }
     193    ErrorInfo(const ComPtr<IVirtualBoxErrorInfo> &aPtr)
     194        : mIsBasicAvailable(false), mIsFullAvailable(false)
     195        , mResultCode(S_OK), mResultDetail(0)
     196        { init(aPtr); }
    197197
    198198    /**
    … …  
    204204     *                  holds error info to be fetched by this instance
    205205     */
    206     ErrorInfo (IVirtualBoxErrorInfo *aInfo)
    207         : mIsBasicAvailable (false), mIsFullAvailable (false)
    208         , mResultCode (S_OK), mResultDetail(0)
    209         { init (aInfo); }
     206    ErrorInfo(IVirtualBoxErrorInfo *aInfo)
     207        : mIsBasicAvailable(false), mIsFullAvailable(false)
     208        , mResultCode(S_OK), mResultDetail(0)
     209        { init(aInfo); }
    210210
    211211    ErrorInfo(const ErrorInfo &x)
    … …  
    320320     *
    321321     *  This method returns a non-null IID only if the instance was created
    322      *  using #template <class I> ErrorInfo(I *i) or
     322     *  using template <class I> ErrorInfo(I *i) or
    323323     *  template <class I> ErrorInfo(const ComPtr<I> &i) constructor.
     324     *
     325     *  @todo broken ErrorInfo documentation links, possibly misleading.
    324326     */
    325327    const Guid& getCalleeIID() const
    … …  
    332334     *
    333335     *  This method returns a non-null name only if the instance was created
    334      *  using #template <class I> ErrorInfo(I *i) or
     336     *  using template <class I> ErrorInfo(I *i) or
    335337     *  template <class I> ErrorInfo(const ComPtr<I> &i) constructor.
     338     *
     339     *  @todo broken ErrorInfo documentation links, possibly misleading.
    336340     */
    337341    const Bstr& getCalleeName() const

  • trunk/include/VBox/com/MultiResult.h

    r56291 r58106  
    129129 *
    130130 * Here is the typical usage pattern:
    131  *  <code>
    132 
     131 * @code
    133132    HRESULT Bar::method()
    134133    {
    … …  
    157156        return S_OK;
    158157    }
    159 
    160  *  </code>
     158 * @endcode
    161159 *
    162160 * @note This class is intended to be instantiated on the stack, therefore
    … …  
    170168
    171169    /**
    172      * @copydoc FWResult::FWResult().
     170     * @copydoc FWResult::FWResult()
    173171     */
    174172    MultiResult (HRESULT aRC = E_FAIL) : FWResult (aRC) { incCounter(); }

  • trunk/include/VBox/com/VirtualBox.h

    r56291 r58106  
    99 *       interfaces; the include file is called VirtualBox.h on Windows hosts
    1010 *       and VirtualBox_XPCOM.h on Linux hosts.  The build process places it in
    11  *       out/<platform>/bin/sdk/include, from where it gets
     11 *       out/{platform}/bin/sdk/include, from where it gets
    1212 *       included by the rest of the VirtualBox code.
    1313 */

  • trunk/include/VBox/com/array.h

    r56291 r58106  
    156156 * Arrays of interface pointers are also supported but they require to use a
    157157 * special SafeArray implementation, com::SafeIfacePointer, which takes the
    158  * interface class name as a template argument (e.g. com::SafeIfacePointer
    159  * <IUnknown>). This implementation functions identically to com::SafeArray.
     158 * interface class name as a template argument (e.g.
     159 * com::SafeIfacePointer\<IUnknown\>). This implementation functions
     160 * identically to com::SafeArray.
    160161 */
    161162
    … …  
    687688     * @param aCntr Container object to copy.
    688689     *
    689      * @param C     Standard C++ container template class (normally deduced from
     690     * @tparam C    Standard C++ container template class (normally deduced from
    690691     *              @c aCntr).
    691692     */
    … …  
    712713     * @param aMap  Map object to copy.
    713714     *
    714      * @param C     Standard C++ map template class (normally deduced from
    715      *              @c aCntr).
    716      * @param L     Standard C++ compare class (deduced from @c aCntr).
    717      * @param A     Standard C++ allocator class (deduced from @c aCntr).
    718      * @param K     Map key class (deduced from @c aCntr).
     715     * @tparam C    Standard C++ map template class (normally deduced from
     716     *              @a aMap).
     717     * @tparam L    Standard C++ compare class (deduced from @a aMap).
     718     * @tparam A    Standard C++ allocator class (deduced from @a aMap).
     719     * @tparam K    Map key class (deduced from @a aMap).
    719720     */
    720721    template<template<typename, typename, typename, typename>
    … …  
    829830     * <tt>Bstr("foo").detachTo(array.appendedRaw());</tt>. Don't use it as
    830831     * an l-value (<tt>array.appendedRaw() = SysAllocString(L"tralala");</tt>)
    831      * since this doesn't check for a NULL condition; use #resize() and
    832      * #setRawAt() instead. If you need to assign a copy of the existing value
    833      * instead of transferring the ownership, look at #push_back().
     832     * since this doesn't check for a NULL condition; use #resize() instead. If
     833     * you need to assign a copy of the existing value instead of transferring
     834     * the ownership, look at #push_back().
    834835     *
    835836     * @return          Raw pointer to the added element or NULL if no memory.
    … …  
    16291630    /**
    16301631     * Creates a deep copy of the given standard C++ container that stores
    1631      * interface pointers as objects of the ComPtr<I> class.
     1632     * interface pointers as objects of the ComPtr\<I\> class.
    16321633     *
    16331634     * @param aCntr Container object to copy.
    16341635     *
    1635      * @param C     Standard C++ container template class (normally deduced from
     1636     * @tparam C    Standard C++ container template class (normally deduced from
    16361637     *              @c aCntr).
    1637      * @param A     Standard C++ allocator class (deduced from @c aCntr).
    1638      * @param OI    Argument to the ComPtr template (deduced from @c aCntr).
     1638     * @tparam A    Standard C++ allocator class (deduced from @c aCntr).
     1639     * @tparam OI   Argument to the ComPtr template (deduced from @c aCntr).
    16391640     */
    16401641    template<template<typename, typename> class C, class A, class OI>
    … …  
    16581659    /**
    16591660     * Creates a deep copy of the given standard C++ container that stores
    1660      * interface pointers as objects of the ComObjPtr<I> class.
     1661     * interface pointers as objects of the ComObjPtr\<I\> class.
    16611662     *
    16621663     * @param aCntr Container object to copy.
    16631664     *
    1664      * @param C     Standard C++ container template class (normally deduced from
     1665     * @tparam C    Standard C++ container template class (normally deduced from
    16651666     *              @c aCntr).
    1666      * @param A     Standard C++ allocator class (deduced from @c aCntr).
    1667      * @param OI    Argument to the ComObjPtr template (deduced from @c aCntr).
     1667     * @tparam A    Standard C++ allocator class (deduced from @c aCntr).
     1668     * @tparam OI   Argument to the ComObjPtr template (deduced from @c aCntr).
    16681669     */
    16691670    template<template<typename, typename> class C, class A, class OI>
    … …  
    16871688    /**
    16881689     * Creates a deep copy of the given standard C++ map whose values are
    1689      * interface pointers stored as objects of the ComPtr<I> class.
     1690     * interface pointers stored as objects of the ComPtr\<I\> class.
    16901691     *
    16911692     * @param aMap  Map object to copy.
    16921693     *
    1693      * @param C     Standard C++ map template class (normally deduced from
     1694     * @tparam C    Standard C++ map template class (normally deduced from
    16941695     *              @c aCntr).
    1695      * @param L     Standard C++ compare class (deduced from @c aCntr).
    1696      * @param A     Standard C++ allocator class (deduced from @c aCntr).
    1697      * @param K     Map key class (deduced from @c aCntr).
    1698      * @param OI    Argument to the ComPtr template (deduced from @c aCntr).
     1696     * @tparam L    Standard C++ compare class (deduced from @c aCntr).
     1697     * @tparam A    Standard C++ allocator class (deduced from @c aCntr).
     1698     * @tparam K    Map key class (deduced from @c aCntr).
     1699     * @tparam OI   Argument to the ComPtr template (deduced from @c aCntr).
    16991700     */
    17001701    template<template<typename, typename, typename, typename>
    … …  
    17191720    /**
    17201721     * Creates a deep copy of the given standard C++ map whose values are
    1721      * interface pointers stored as objects of the ComObjPtr<I> class.
     1722     * interface pointers stored as objects of the ComObjPtr\<I\> class.
    17221723     *
    17231724     * @param aMap  Map object to copy.
    17241725     *
    1725      * @param C     Standard C++ map template class (normally deduced from
     1726     * @tparam C    Standard C++ map template class (normally deduced from
    17261727     *              @c aCntr).
    1727      * @param L     Standard C++ compare class (deduced from @c aCntr).
    1728      * @param A     Standard C++ allocator class (deduced from @c aCntr).
    1729      * @param K     Map key class (deduced from @c aCntr).
    1730      * @param OI    Argument to the ComObjPtr template (deduced from @c aCntr).
     1728     * @tparam L    Standard C++ compare class (deduced from @c aCntr).
     1729     * @tparam A    Standard C++ allocator class (deduced from @c aCntr).
     1730     * @tparam K    Map key class (deduced from @c aCntr).
     1731     * @tparam OI   Argument to the ComObjPtr template (deduced from @c aCntr).
    17311732     */
    17321733    template<template<typename, typename, typename, typename>

  • trunk/include/VBox/com/com.h

    r56291 r58106  
    3737 *  willing to perform COM operations.
    3838 *
    39  *  @param fMain     if call is performed on the GUI thread
     39 *  @param fGui     if call is performed on the GUI thread
    4040 *  @return COM result code
    4141 */

  • trunk/include/VBox/com/defs.h

    r56291 r58106  
    145145
    146146/**
    147  * Expands to @true if the given input safearray parameter is a "null pointer"
     147 * Expands to @c true if the given input safearray parameter is a "null pointer"
    148148 * which makes it impossible to use it for reading safearray data.
    149149 */
    … …  
    180180
    181181/**
    182  * Expands to @true if the given output safearray parameter is a "null pointer"
    183  * which makes it impossible to use it for returning a safearray.
     182 * Expands to @c true if the given output safearray parameter is a "null
     183 * pointer" which makes it impossible to use it for returning a safearray.
    184184 */
    185185#define ComSafeArrayOutIsNull(aArg)     ((aArg) == NULL)
    … …  
    241241 *  interface.
    242242 *
    243  *  @param i    interface class
     243 *  @param I    interface class
    244244 */
    245245#define COM_IIDOF(I) _ATL_IIDOF(I)

  • trunk/include/VBox/com/errorprint.h

    r56291 r58106  
    239239 * statement after error reporting.
    240240 *
     241 * @param   hrc         The result variable (type HRESULT).
    241242 * @param   iface       The interface pointer (can be a smart pointer object).
    242243 * @param   method      The method to invoke together with the parameters.

  • trunk/include/VBox/com/list.h

    r56291 r58106  
    3737 * Specialized list class for using with com::ComPtr<C>
    3838 *
    39  * @note: This is necessary cause ComPtr<IFACE> has a size of 8.
     39 * @note    This is necessary cause ComPtr<IFACE> has a size of 8.
    4040 */
    4141template <typename C>
    … …  
    5454     * This preallocates @a cCapacity elements within the list.
    5555     *
    56      * @param   cCapacitiy   The initial capacity the list has.
     56     * @param   cCapacity   The initial capacity the list has.
    5757     * @throws  std::bad_alloc
    5858     */
    … …  
    8484     * This preallocates @a cCapacity elements within the list.
    8585     *
    86      * @param   cCapacitiy   The initial capacity the list has.
     86     * @param   cCapacity   The initial capacity the list has.
    8787     * @throws  std::bad_alloc
    8888     */
    … …  
    114114     * This preallocates @a cCapacity elements within the list.
    115115     *
    116      * @param   cCapacitiy   The initial capacity the list has.
     116     * @param   cCapacity    The initial capacity the list has.
    117117     * @throws  std::bad_alloc
    118118     */

  • trunk/include/VBox/com/mtlist.h

    r56291 r58106  
    5353     * This preallocates @a cCapacity elements within the list.
    5454     *
    55      * @param   cCapacitiy   The initial capacity the list has.
     55     * @param   cCapacity   The initial capacity the list has.
    5656     * @throws  std::bad_alloc
    5757     */
    … …  
    8383     * This preallocates @a cCapacity elements within the list.
    8484     *
    85      * @param   cCapacitiy   The initial capacity the list has.
     85     * @param   cCapacity   The initial capacity the list has.
    8686     * @throws  std::bad_alloc
    8787     */
    … …  
    113113     * This preallocates @a cCapacity elements within the list.
    114114     *
    115      * @param   cCapacitiy   The initial capacity the list has.
     115     * @param   cCapacity    The initial capacity the list has.
    116116     * @throws  std::bad_alloc
    117117     */

  • trunk/include/VBox/com/string.h

    r57005 r58106  
    456456     * @param   a_pszSrc            The source string.  The caller guarantees
    457457     *                              that this is valid UTF-8.
    458      * @param   a_cchMax            The maximum number of chars (not
    459      *                              codepoints) to copy.  If you pass RTSTR_MAX
    460      *                              it'll be exactly like copyFrom().
     458     * @param   a_cchSrc            The maximum number of chars (not codepoints) to
     459     *                              copy.  If you pass RTSTR_MAX it'll be exactly
     460     *                              like copyFrom().
    461461     *
    462462     * @throws  std::bad_alloc - the object is representing an empty string.
    … …  
    582582     *
    583583     * @returns S_OK, E_OUTOFMEMORY or E_INVALIDARG.
    584      * @param   a_pcszSrc   The source string
     584     * @param   a_rSrcStr   The source string
    585585     * @param   a_offSrc    The character (byte) offset of the substring.
    586586     * @param   a_cchSrc    The number of characters (bytes) to copy from the source

  • trunk/include/VBox/dbg.h

    r57006 r58106  
    684684
    685685/**
    686  * @copydoc DBGCCMDHLP::pfnPrintf
     686 * Command helper for writing formatted text to the debug console.
     687 *
     688 * @returns VBox status.
     689 * @param   pCmdHlp     Pointer to the command callback structure.
     690 * @param   pszFormat   The format string.  This may use all IPRT extensions as
     691 *                      well as the debugger ones.
     692 * @param   ...         Arguments specified in the format string.
    687693 */
    688694DECLINLINE(int) RT_IPRT_FORMAT_ATTR(2, 3) DBGCCmdHlpPrintf(PDBGCCMDHLP pCmdHlp, const char *pszFormat, ...)
    … …  
    716722
    717723/**
    718  * @copydoc FNDBGCHLPVBOXERROR
     724 * @copydoc DBGCCMDHLP::pfnVBoxError
    719725 */
    720726DECLINLINE(int) RT_IPRT_FORMAT_ATTR(3, 4) DBGCCmdHlpVBoxError(PDBGCCMDHLP pCmdHlp, int rc, const char *pszFormat, ...)
    … …  
    730736
    731737/**
    732  * @copydoc FNDBGCHLPMEMREAD
     738 * @copydoc DBGCCMDHLP::pfnMemRead
    733739 */
    734740DECLINLINE(int) DBGCCmdHlpMemRead(PDBGCCMDHLP pCmdHlp, void *pvBuffer, size_t cbRead, PCDBGCVAR pVarPointer, size_t *pcbRead)
    … …  
    845851
    846852/**
    847  * @copydoc DBGCCMDHLP::pfnVarToDbgfAddr
     853 * @copydoc DBGCCMDHLP::pfnVarFromDbgfAddr
    848854 */
    849855DECLINLINE(int) DBGCCmdHlpVarFromDbgfAddr(PDBGCCMDHLP pCmdHlp, PCDBGFADDRESS pAddress, PDBGCVAR pResult)

  • trunk/include/VBox/dbggui.h

    r56291 r58106  
    9090 */
    9191DBGDECL(int) DBGGuiCreate(ISession *pSession, PDBGGUI *ppGui, PCDBGGUIVT *ppGuiVT);
    92 /** @copydoc DBGGuiCreate. */
     92/** @copydoc DBGGuiCreate */
    9393typedef DECLCALLBACK(int) FNDBGGUICREATE(ISession *pSession, PDBGGUI *ppGui, PCDBGGUIVT *ppGuiVT);
    9494/** Pointer to DBGGuiCreate. */
    … …  
    105105 */
    106106DBGDECL(int) DBGGuiCreateForVM(PUVM pUVM, PDBGGUI *ppGui, PCDBGGUIVT *ppGuiVT);
    107 /** @copydoc DBGGuiCreateForVM. */
     107/** @copydoc DBGGuiCreateForVM */
    108108typedef DECLCALLBACK(int) FNDBGGUICREATEFORVM(PUVM pUVM, PDBGGUI *ppGui, PCDBGGUIVT *ppGuiVT);
    109109/** Pointer to DBGGuiCreateForVM. */

  • trunk/include/VBox/err.h

    r57989 r58106  
    492492/** Catch write access and route it thru PGM. */
    493493#define VERR_PGM_PHYS_TLB_CATCH_WRITE           (-1635)
    494 /** No CR3 root shadow page table.. */
     494/** No CR3 root shadow page table. */
    495495#define VERR_PGM_NO_CR3_SHADOW_ROOT             (-1636)
    496496/** Trying to free a page with an invalid Page ID. */
    … …  
    23592359/** Generic debugger command failure. */
    23602360#define VERR_DBGC_COMMAND_FAILED                    (-5407)
    2361 /** Logic bug in the DBGC code.. */
     2361/** Logic bug in the DBGC code. */
    23622362#define VERR_DBGC_IPE                               (-5408)
    23632363

  • trunk/include/VBox/hgcmsvc.h

    r56291 r58106  
    7373
    7474/** Service helpers pointers table. */
    75 typedef struct _VBOXHGCMSVCHELPERS
     75typedef struct VBOXHGCMSVCHELPERS
    7676{
    7777    /** The service has processed the Call request. */
    … …  
    355355
    356356/* The structure is used in separately compiled binaries so an explicit packing is required. */
    357 #pragma pack(1)
    358 typedef struct _VBOXHGCMSVCFNTABLE
     357#pragma pack(1) /** @todo r=bird: The pragma pack(1) is not at all required!! */
     358typedef struct VBOXHGCMSVCFNTABLE
    359359{
    360     /** Filled by HGCM */
     360    /** @name Filled by HGCM
     361     * @{ */
    361362
    362363    /** Size of the structure. */
    … …  
    367368
    368369    PVBOXHGCMSVCHELPERS      pHelpers;
    369 
    370     /** Filled by the service. */
     370    /** @} */
     371
     372    /** @name Filled in by the service.
     373     * @{ */
    371374
    372375    /** Size of client information the service want to have. */
    … …  
    408411    void *pvService;
    409412
     413    /** @} */
    410414} VBOXHGCMSVCFNTABLE;
    411415#pragma pack()

  • trunk/include/VBox/intnetinline.h

    r56291 r58106  
    398398 * @param   pRingBuf            The ring buffer.
    399399 * @param   cbFrame             The frame size.
     400 * @param   u8Type              The header type.
    400401 * @param   ppHdr               Where to return the frame header.
    401402 *                              Don't touch this!
    … …  
    738739 *
    739740 * @returns Size of the frame in bytes.  0 is returned if nothing in the buffer.
    740  * @param   pRingBuff   The ring buffer to read from.
     741 * @param   pRingBuf    The ring buffer to read from.
    741742 * @param   pvFrameDst  Where to put the frame.  The caller is responsible for
    742743 *                      ensuring that there is sufficient space for the frame.

  • trunk/include/VBox/pci.h

    r56291 r58106  
    793793 *
    794794 * @param   pPciDev         The PCI device.
     795 * @param   iReg            Base address register number (0..5).
    795796 * @param   fIOSpace        Whether it's I/O (true) or memory (false) space.
    796797 * @param   fPrefetchable   Whether the memory is prefetachable. Must be false if fIOSpace == true.
    … …  
    798799 * @param   u32Addr         The address value.
    799800 */
    800 DECLINLINE(void) PCIDevSetBaseAddress(PPCIDEVICE pPciDev, uint8_t iReg, bool fIOSpace, bool fPrefetchable, bool f64Bit, uint32_t u32Addr)
     801DECLINLINE(void) PCIDevSetBaseAddress(PPCIDEVICE pPciDev, uint8_t iReg, bool fIOSpace, bool fPrefetchable, bool f64Bit,
     802                                      uint32_t u32Addr)
    801803{
    802804    if (fIOSpace)

  • trunk/include/VBox/sup.h

    r57235 r58106  
    11501150 * @param   pszService  The service name.
    11511151 * @param   cchService  The length of the service name.
    1152  * @param   uReq        The request number.
     1152 * @param   uOperation  The request number.
    11531153 * @param   u64Arg      Constant argument.
    11541154 * @param   pReqHdr     Pointer to a request header. Optional.
    … …  
    13731373 *
    13741374 * @returns VBox status code.
    1375  * @param   pszModule       The module to free.
     1375 * @param   pvImageBase     The base address of the image to free.
    13761376 * @remark  This will not actually 'free' the module, there are of course usage counting.
    13771377 */
    … …  
    13941394 *
    13951395 * @returns VBox status code.
    1396  * @param   pszModule       The module name.
     1396 * @param   pvImageBase     The base address of the image to search.
    13971397 * @param   pszSymbol       Symbol name. If it's value is less than 64k it's treated like a
    13981398 *                          ordinal value rather than a string pointer.
    … …  
    19831983    /** The actual module bit count (corresponds to cbProbeLocsEn). */
    19841984    uint8_t                     cBits;
    1985     /** Set if this is a Umod, otherwise clear.. */
     1985    /** Set if this is a Umod, otherwise clear. */
    19861986    bool                        fUmod;
    19871987    /** Explicit alignment padding (paranoia). */

  • trunk/include/VBox/vd-ifs-internal.h

    r56291 r58106  
    129129     * @param   pszLocation     Name of the location to open.
    130130     * @param   fOpen           Flags for opening the backend.
    131      *                          See RTFILE_O_* #defines, inventing another set
     131     *                          See RTFILE_O_* \#defines, inventing another set
    132132     *                          of open flags is not worth the mapping effort.
    133133     * @param   ppStorage       Where to store the storage handle.
    … …  
    256256     * @param   pvCompleteUser Opaque user data passed in the completion callback.
    257257     *
    258      * @notes If pIoCtx is NULL the metadata read is handled synchronously
    259      *        i.e. the call returns only if the data is available in the given
    260      *        buffer. ppMetaXfer, pfnCompleted and pvCompleteUser are ignored in that case.
    261      *        Use the synchronous version only when opening/closing the image
    262      *        or when doing certain operations like resizing, compacting or repairing
    263      *        the disk.
     258     * @note    If pIoCtx is NULL the metadata read is handled synchronously
     259     *          i.e. the call returns only if the data is available in the given
     260     *          buffer. ppMetaXfer, pfnCompleted and pvCompleteUser are ignored in that case.
     261     *          Use the synchronous version only when opening/closing the image
     262     *          or when doing certain operations like resizing, compacting or repairing
     263     *          the disk.
    264264     */
    265265    DECLR3CALLBACKMEMBER(int, pfnReadMeta, (void *pvUser, PVDIOSTORAGE pStorage,
    … …  
    283283     * @param   pvCompleteUser Opaque user data passed in the completion callback.
    284284     *
    285      * @notes See pfnReadMeta().
     285     * @sa      VDINTERFACEIOINT::pfnReadMeta
    286286     */
    287287    DECLR3CALLBACKMEMBER(int, pfnWriteMeta, (void *pvUser, PVDIOSTORAGE pStorage,
    … …  
    311311     * @param   pvCompleteUser Opaque user data passed in the completion callback.
    312312     *
    313      * @notes See pfnReadMeta().
     313     * @sa      VDINTERFACEIOINT::pfnReadMeta
    314314     */
    315315    DECLR3CALLBACKMEMBER(int, pfnFlush, (void *pvUser, PVDIOSTORAGE pStorage,

  • trunk/include/VBox/vd-ifs.h

    r58092 r58106  
    143143 * @param  enmInterface Type of the interface.
    144144 * @param  pvUser       Opaque user data passed on every function call.
     145 * @param  cbInterface  The interface size.
    145146 * @param  ppVDIfs      Pointer to the VD interface list.
    146147 */
    147 DECLINLINE(int) VDInterfaceAdd(PVDINTERFACE pInterface, const char *pszName,
    148                                VDINTERFACETYPE enmInterface, void *pvUser,
     148DECLINLINE(int) VDInterfaceAdd(PVDINTERFACE pInterface, const char *pszName, VDINTERFACETYPE enmInterface, void *pvUser,
    149149                               size_t cbInterface, PVDINTERFACE *ppVDIfs)
    150150{
    … …  
    240240     * @param   pvUser          The opaque data passed on container creation.
    241241     * @param   rc              The VBox error code.
    242      * @param   RT_SRC_POS_DECL Use RT_SRC_POS.
     242     * @param   SRC_POS        Use RT_SRC_POS.
    243243     * @param   pszFormat       Error message format string.
    244244     * @param   va              Error message arguments.
    … …  
    285285 * @param   pIfError           The error interface.
    286286 * @param   rc                 The status code.
    287  * @param   RT_SRC_POS_DECL    The position in the source code.
     287 * @param   SRC_POS            The position in the source code.
    288288 * @param   pszFormat          The format string to pass.
    289289 * @param   ...                Arguments to the format string.
    … …  
    350350     * @param   pszLocation     Name of the location to open.
    351351     * @param   fOpen           Flags for opening the backend.
    352      *                          See RTFILE_O_* #defines, inventing another set
     352     *                          See RTFILE_O_* \#defines, inventing another set
    353353     *                          of open flags is not worth the mapping effort.
    354354     * @param   pfnCompleted    The callback which is called whenever a task
    … …  
    10911091     * @return  iprt status code.
    10921092     * @retval  VERR_NOT_SUPPORTED if the combination of flags is not supported.
    1093      * @param   fFlags    Combination of the VD_INTERFACETCPNET_CONNECT_* #defines.
     1093     * @param   fFlags    Combination of the VD_INTERFACETCPNET_CONNECT_* \#defines.
    10941094     * @param   pSock     Where to store the handle.
    10951095     */
    … …  
    12981298 * container. Opening or closing images is covered by the synchronization, but
    12991299 * that does not mean it is safe to close images while a thread executes
    1300  * <link to="VDMerge"/> or <link to="VDCopy"/> operating on these images.
    1301  * Making them safe would require the lock to be held during the entire
    1302  * operation, which prevents other concurrent acitivities.
     1300 * #VDMerge or #VDCopy operating on these images. Making them safe would require
     1301 * the lock to be held during the entire operation, which prevents other
     1302 * concurrent acitivities.
    13031303 *
    13041304 * @note Right now this is kept as simple as possible, and does not even

  • trunk/include/VBox/vd.h

    r57064 r58106  
    190190    uint32_t        uFlags;
    191191    /** Filename for the raw disk. Ignored for partitioned raw disks.
    192      * For Linux e.g. /dev/sda, and for Windows e.g. \\\\.\\PhysicalDisk0. */
     192     * For Linux e.g. /dev/sda, and for Windows e.g. //./PhysicalDisk0. */
    193193    const char      *pszRawDisk;
    194194    /** Number of entries in the partition descriptor array. */
    … …  
    564564 * @return  VBox status code.
    565565 * @param   pszBackend      The backend name (case insensitive).
    566  * @param   pEntries        Pointer to an entry.
     566 * @param   pEntry          Pointer to an entry.
    567567 */
    568568VBOXDDU_DECL(int) VDBackendInfoOne(const char *pszBackend, PVDBACKENDINFO pEntry);
    … …  
    585585 * @return  VBox status code.
    586586 * @param   pszFilter       The filter name (case insensitive).
    587  * @param   pEntries        Pointer to an entry.
     587 * @param   pEntry          Pointer to an entry.
    588588 */
    589589VBOXDDU_DECL(int) VDFilterInfoOne(const char *pszFilter, PVDFILTERINFO pEntry);
    … …  
    731731 * @return  VBox status code.
    732732 * @param   pDisk           Name of the cache file backend to use (case insensitive).
     733 * @param   pszBackend      Name of the image file backend to use (case insensitive).
    733734 * @param   pszFilename     Name of the differencing cache file to create.
    734735 * @param   cbSize          Maximum size of the cache.
    … …  
    764765/**
    765766 * Copies an image from one HDD container to another - extended version.
    766  * The copy is opened in the target HDD container.
    767  * It is possible to convert between different image formats, because the
    768  * backend for the destination may be different from the source.
    769  * If both the source and destination reference the same HDD container,
    770  * then the image is moved (by copying/deleting or renaming) to the new location.
    771  * The source container is unchanged if the move operation fails, otherwise
    772  * the image at the new location is opened in the same way as the old one was.
     767 *
     768 * The copy is opened in the target HDD container.  It is possible to convert
     769 * between different image formats, because the backend for the destination may
     770 * be different from the source.  If both the source and destination reference
     771 * the same HDD container, then the image is moved (by copying/deleting or
     772 * renaming) to the new location.  The source container is unchanged if the move
     773 * operation fails, otherwise the image at the new location is opened in the
     774 * same way as the old one was.
    773775 *
    774776 * @note The read/write accesses across disks are not synchronized, just the
    … …  
    778780 * @return  VBox status code.
    779781 * @return  VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
     782 *
    780783 * @param   pDiskFrom       Pointer to source HDD container.
    781  * @param   nImage          Image number, counts from 0. 0 is always base image of container.
     784 * @param   nImage          Image number, counts from 0. 0 is always base image
     785 *                          of container.
    782786 * @param   pDiskTo         Pointer to destination HDD container.
    783  * @param   pszBackend      Name of the image file backend to use (may be NULL to use the same as the source, case insensitive).
    784  * @param   pszFilename     New name of the image (may be NULL to specify that the
    785  *                          copy destination is the destination container, or
    786  *                          if pDiskFrom == pDiskTo, i.e. when moving).
    787  * @param   fMoveByRename   If true, attempt to perform a move by renaming (if successful the new size is ignored).
     787 * @param   pszBackend      Name of the image file backend to use (may be NULL
     788 *                          to use the same as the source, case insensitive).
     789 * @param   pszFilename     New name of the image (may be NULL to specify that
     790 *                          the copy destination is the destination container,
     791 *                          or if pDiskFrom == pDiskTo, i.e. when moving).
     792 * @param   fMoveByRename   If true, attempt to perform a move by renaming (if
     793 *                          successful the new size is ignored).
    788794 * @param   cbSize          New image size (0 means leave unchanged).
    789  * @param   nImageSameFrom  The number of the last image in the source chain having the same content as the
    790  *                          image in the destination chain given by nImageSameTo or
    791  *                          VD_IMAGE_CONTENT_UNKNOWN to indicate that the content of both containers is unknown.
    792  *                          See the notes for further information.
    793  * @param   nImageSameTo    The number of the last image in the destination chain having the same content as the
    794  *                          image in the source chain given by nImageSameFrom or
    795  *                          VD_IMAGE_CONTENT_UNKNOWN to indicate that the content of both containers is unknown.
    796  *                          See the notes for further information.
     795 * @param   nImageFromSame  The number of the last image in the source chain
     796 *                          having the same content as the image in the
     797 *                          destination chain given by nImageToSame or
     798 *                          VD_IMAGE_CONTENT_UNKNOWN to indicate that the
     799 *                          content of both containers is unknown.  See the
     800 *                          notes for further information.
     801 * @param   nImageToSame    The number of the last image in the destination
     802 *                          chain having the same content as the image in the
     803 *                          source chain given by nImageFromSame or
     804 *                          VD_IMAGE_CONTENT_UNKNOWN to indicate that the
     805 *                          content of both containers is unknown. See the notes
     806 *                          for further information.
    797807 * @param   uImageFlags     Flags specifying special destination image features.
    798  * @param   pDstUuid        New UUID of the destination image. If NULL, a new UUID is created.
    799  *                          This parameter is used if and only if a true copy is created.
    800  *                          In all rename/move cases or copy to existing image cases the modification UUIDs are copied over.
     808 * @param   pDstUuid        New UUID of the destination image. If NULL, a new
     809 *                          UUID is created. This parameter is used if and only
     810 *                          if a true copy is created. In all rename/move cases
     811 *                          or copy to existing image cases the modification
     812 *                          UUIDs are copied over.
    801813 * @param   uOpenFlags      Image file open mode, see VD_OPEN_FLAGS_* constants.
    802814 *                          Only used if the destination image is created.
    … …  
    804816 * @param   pDstVDIfsImage  Pointer to the per-image VD interface list, for the
    805817 *                          destination image.
    806  * @param   pDstVDIfsOperation Pointer to the per-operation VD interface list,
     818 * @param   pDstVDIfsOperation  Pointer to the per-operation VD interface list,
    807819 *                          for the destination operation.
    808820 *
    809  * @note Using nImageSameFrom and nImageSameTo can lead to a significant speedup
    810  *       when copying an image but can also lead to a corrupted copy if used incorrectly.
    811  *       It is mainly useful when cloning a chain of images and it is known that
    812  *       the virtual disk content of the two chains is exactly the same upto a certain image.
    813  *       Example:
    814  *          Imagine the chain of images which consist of a base and one diff image.
    815  *          Copying the chain starts with the base image. When copying the first
    816  *          diff image VDCopy() will read the data from the diff of the source chain
    817  *          and probably from the base image again in case the diff doesn't has data
    818  *          for the block. However the block will be optimized away because VDCopy()
    819  *          reads data from the base image of the destination chain compares the to
    820  *          and suppresses the write because the data is unchanged.
    821  *          For a lot of diff images this will be a huge waste of I/O bandwidth if
    822  *          the diff images contain only few changes.
    823  *          Because it is known that the base image of the source and the destination chain
    824  *          have the same content it is enough to check the diff image for changed data
    825  *          and copy it to the destination diff image which is achieved with
    826  *          nImageSameFrom and nImageSameTo. Setting both to 0 can suppress a lot of I/O.
     821 * @note Using nImageFromSame and nImageToSame can lead to a significant speedup
     822 *       when copying an image but can also lead to a corrupted copy if used
     823 *       incorrectly. It is mainly useful when cloning a chain of images and it
     824 *       is known that the virtual disk content of the two chains is exactly the
     825 *       same upto a certain image. Example:
     826 *          Imagine the chain of images which consist of a base and one diff
     827 *          image. Copying the chain starts with the base image. When copying
     828 *          the first diff image VDCopy() will read the data from the diff of
     829 *          the source chain and probably from the base image again in case the
     830 *          diff doesn't has data for the block. However the block will be
     831 *          optimized away because VDCopy() reads data from the base image of
     832 *          the destination chain compares the to and suppresses the write
     833 *          because the data is unchanged. For a lot of diff images this will be
     834 *          a huge waste of I/O bandwidth if the diff images contain only few
     835 *          changes. Because it is known that the base image of the source and
     836 *          the destination chain have the same content it is enough to check
     837 *          the diff image for changed data and copy it to the destination diff
     838 *          image which is achieved with nImageFromSame and nImageToSame.
     839 *          Setting both to 0 can suppress a lot of I/O.
    827840 */
    828841VBOXDDU_DECL(int) VDCopyEx(PVBOXHDD pDiskFrom, unsigned nImage, PVBOXHDD pDiskTo,
    … …  
    901914 * @param   pVDIfsOperation Pointer to the per-operation VD interface list.
    902915 */
    903 VBOXDDU_DECL(int) VDCompact(PVBOXHDD pDisk, unsigned nImage,
    904                             PVDINTERFACE pVDIfsOperation);
     916VBOXDDU_DECL(int) VDCompact(PVBOXHDD pDisk, unsigned nImage, PVDINTERFACE pVDIfsOperation);
    905917
    906918/**
    … …  
    9901002 * @return  VERR_VD_NOT_OPENED if no image is opened in HDD container.
    9911003 * @param   pDisk           Pointer to HDD container.
    992  * @param   uOffset         Offset of first reading byte from start of disk.
     1004 * @param   off             Offset of first reading byte from start of disk.
    9931005 *                          Must be aligned to a sector boundary.
    9941006 * @param   pvBuffer        Pointer to buffer for reading data.
    … …  
    9961008 *                          Must be aligned to a sector boundary.
    9971009 */
    998 VBOXDDU_DECL(int) VDRead(PVBOXHDD pDisk, uint64_t uOffset, void *pvBuffer, size_t cbBuffer);
     1010VBOXDDU_DECL(int) VDRead(PVBOXHDD pDisk, uint64_t off, void *pvBuffer, size_t cbBuffer);
    9991011
    10001012/**
    … …  
    10041016 * @return  VERR_VD_NOT_OPENED if no image is opened in HDD container.
    10051017 * @param   pDisk           Pointer to HDD container.
    1006  * @param   uOffset         Offset of first writing byte from start of disk.
     1018 * @param   off             Offset of first writing byte from start of disk.
    10071019 *                          Must be aligned to a sector boundary.
    10081020 * @param   pvBuffer        Pointer to buffer for writing data.
    … …  
    10101022 *                          Must be aligned to a sector boundary.
    10111023 */
    1012 VBOXDDU_DECL(int) VDWrite(PVBOXHDD pDisk, uint64_t uOffset, const void *pvBuffer, size_t cbBuffer);
     1024VBOXDDU_DECL(int) VDWrite(PVBOXHDD pDisk, uint64_t off, const void *pvBuffer, size_t cbBuffer);
    10131025
    10141026/**
    … …  
    10781090 * @param   pPCHSGeometry   Where to store PCHS geometry. Not NULL.
    10791091 */
    1080 VBOXDDU_DECL(int) VDGetPCHSGeometry(PVBOXHDD pDisk, unsigned nImage,
    1081                                     PVDGEOMETRY pPCHSGeometry);
     1092VBOXDDU_DECL(int) VDGetPCHSGeometry(PVBOXHDD pDisk, unsigned nImage, PVDGEOMETRY pPCHSGeometry);
    10821093
    10831094/**
    … …  
    10901101 * @param   pPCHSGeometry   Where to load PCHS geometry from. Not NULL.
    10911102 */
    1092 VBOXDDU_DECL(int) VDSetPCHSGeometry(PVBOXHDD pDisk, unsigned nImage,
    1093                                     PCVDGEOMETRY pPCHSGeometry);
     1103VBOXDDU_DECL(int) VDSetPCHSGeometry(PVBOXHDD pDisk, unsigned nImage, PCVDGEOMETRY pPCHSGeometry);
    10941104
    10951105/**
    … …  
    11031113 * @param   pLCHSGeometry   Where to store LCHS geometry. Not NULL.
    11041114 */
    1105 VBOXDDU_DECL(int) VDGetLCHSGeometry(PVBOXHDD pDisk, unsigned nImage,
    1106                                     PVDGEOMETRY pLCHSGeometry);
     1115VBOXDDU_DECL(int) VDGetLCHSGeometry(PVBOXHDD pDisk, unsigned nImage, PVDGEOMETRY pLCHSGeometry);
    11071116
    11081117/**
    … …  
    11151124 * @param   pLCHSGeometry   Where to load LCHS geometry from. Not NULL.
    11161125 */
    1117 VBOXDDU_DECL(int) VDSetLCHSGeometry(PVBOXHDD pDisk, unsigned nImage,
    1118                                     PCVDGEOMETRY pLCHSGeometry);
     1126VBOXDDU_DECL(int) VDSetLCHSGeometry(PVBOXHDD pDisk, unsigned nImage, PCVDGEOMETRY pLCHSGeometry);
    11191127
    11201128/**
    … …  
    11271135 * @param   puVersion       Where to store the image version.
    11281136 */
    1129 VBOXDDU_DECL(int) VDGetVersion(PVBOXHDD pDisk, unsigned nImage,
    1130                                unsigned *puVersion);
     1137VBOXDDU_DECL(int) VDGetVersion(PVBOXHDD pDisk, unsigned nImage, unsigned *puVersion);
    11311138
    11321139/**
    … …  
    11371144 * @param   pDisk           Pointer to the HDD container.
    11381145 * @param   nImage          Image number, counts from 0. 0 is always base image of container.
    1139  * @param   pbackendInfo    Where to store the backend information.
    1140  */
    1141 VBOXDDU_DECL(int) VDBackendInfoSingle(PVBOXHDD pDisk, unsigned nImage,
    1142                                       PVDBACKENDINFO pBackendInfo);
     1146 * @param   pBackendInfo    Where to store the backend information.
     1147 */
     1148VBOXDDU_DECL(int) VDBackendInfoSingle(PVBOXHDD pDisk, unsigned nImage, PVDBACKENDINFO pBackendInfo);
    11431149
    11441150/**
    … …  
    11621168 * @param   puOpenFlags     Where to store the image open flags.
    11631169 */
    1164 VBOXDDU_DECL(int) VDGetOpenFlags(PVBOXHDD pDisk, unsigned nImage,
    1165                                  unsigned *puOpenFlags);
     1170VBOXDDU_DECL(int) VDGetOpenFlags(PVBOXHDD pDisk, unsigned nImage, unsigned *puOpenFlags);
    11661171
    11671172/**
    … …  
    11761181 * @param   uOpenFlags      Image file open mode, see VD_OPEN_FLAGS_* constants.
    11771182 */
    1178 VBOXDDU_DECL(int) VDSetOpenFlags(PVBOXHDD pDisk, unsigned nImage,
    1179                                  unsigned uOpenFlags);
     1183VBOXDDU_DECL(int) VDSetOpenFlags(PVBOXHDD pDisk, unsigned nImage, unsigned uOpenFlags);
    11801184
    11811185/**
    … …  
    11921196 * @param   cbFilename      Size of buffer pszFilename points to.
    11931197 */
    1194 VBOXDDU_DECL(int) VDGetFilename(PVBOXHDD pDisk, unsigned nImage,
    1195                                 char *pszFilename, unsigned cbFilename);
     1198VBOXDDU_DECL(int) VDGetFilename(PVBOXHDD pDisk, unsigned nImage, char *pszFilename, unsigned cbFilename);
    11961199
    11971200/**
    … …  
    12061209 * @param   cbComment       The size of pszComment buffer. 0 is ok.
    12071210 */
    1208 VBOXDDU_DECL(int) VDGetComment(PVBOXHDD pDisk, unsigned nImage,
    1209                                char *pszComment, unsigned cbComment);
     1211VBOXDDU_DECL(int) VDGetComment(PVBOXHDD pDisk, unsigned nImage, char *pszComment, unsigned cbComment);
    12101212
    12111213/**
    … …  
    12181220 * @param   pszComment      New comment string (UTF-8). NULL is allowed to reset the comment.
    12191221 */
    1220 VBOXDDU_DECL(int) VDSetComment(PVBOXHDD pDisk, unsigned nImage,
    1221                                    const char *pszComment);
     1222VBOXDDU_DECL(int) VDSetComment(PVBOXHDD pDisk, unsigned nImage, const char *pszComment);
    12221223
    12231224/**
    … …  
    12521253 * @param   pUuid           Where to store the image modification UUID.
    12531254 */
    1254 VBOXDDU_DECL(int) VDGetModificationUuid(PVBOXHDD pDisk, unsigned nImage,
    1255                                         PRTUUID pUuid);
     1255VBOXDDU_DECL(int) VDGetModificationUuid(PVBOXHDD pDisk, unsigned nImage, PRTUUID pUuid);
    12561256
    12571257/**
    … …  
    12641264 * @param   pUuid           New modification UUID of the image. If NULL, a new UUID is created.
    12651265 */
    1266 VBOXDDU_DECL(int) VDSetModificationUuid(PVBOXHDD pDisk, unsigned nImage,
    1267                                         PCRTUUID pUuid);
     1266VBOXDDU_DECL(int) VDSetModificationUuid(PVBOXHDD pDisk, unsigned nImage, PCRTUUID pUuid);
    12681267
    12691268/**
    … …  
    12761275 * @param   pUuid           Where to store the parent image UUID.
    12771276 */
    1278 VBOXDDU_DECL(int) VDGetParentUuid(PVBOXHDD pDisk, unsigned nImage,
    1279                                   PRTUUID pUuid);
     1277VBOXDDU_DECL(int) VDGetParentUuid(PVBOXHDD pDisk, unsigned nImage, PRTUUID pUuid);
    12801278
    12811279/**
    … …  
    12871285 * @param   pUuid           New parent UUID of the image. If NULL, a new UUID is created.
    12881286 */
    1289 VBOXDDU_DECL(int) VDSetParentUuid(PVBOXHDD pDisk, unsigned nImage,
    1290                                   PCRTUUID pUuid);
     1287VBOXDDU_DECL(int) VDSetParentUuid(PVBOXHDD pDisk, unsigned nImage, PCRTUUID pUuid);
    12911288
    12921289
    … …  
    13181315 * @return  VBox status code.
    13191316 * @param   pDisk           Pointer to the HDD container.
    1320  * @param   uOffset         The offset of the virtual disk to read from.
     1317 * @param   off             The offset of the virtual disk to read from.
    13211318 * @param   cbRead          How many bytes to read.
    13221319 * @param   pcSgBuf         Pointer to the S/G buffer to read into.
    13231320 * @param   pfnComplete     Completion callback.
    1324  * @param   pvUser          User data which is passed on completion
    1325  */
    1326 VBOXDDU_DECL(int) VDAsyncRead(PVBOXHDD pDisk, uint64_t uOffset, size_t cbRead,
     1321 * @param   pvUser1         User data which is passed on completion.
     1322 * @param   pvUser2         User data which is passed on completion.
     1323 */
     1324VBOXDDU_DECL(int) VDAsyncRead(PVBOXHDD pDisk, uint64_t off, size_t cbRead,
    13271325                              PCRTSGBUF pcSgBuf,
    13281326                              PFNVDASYNCTRANSFERCOMPLETE pfnComplete,
    … …  
    13351333 * @return  VBox status code.
    13361334 * @param   pDisk           Pointer to the HDD container.
    1337  * @param   uOffset         The offset of the virtual disk to write to.
    1338  * @param   cbWrtie         How many bytes to write.
     1335 * @param   off             The offset of the virtual disk to write to.
     1336 * @param   cbWrite         How many bytes to write.
    13391337 * @param   pcSgBuf         Pointer to the S/G buffer to write from.
    13401338 * @param   pfnComplete     Completion callback.
    1341  * @param   pvUser          User data which is passed on completion.
    1342  */
    1343 VBOXDDU_DECL(int) VDAsyncWrite(PVBOXHDD pDisk, uint64_t uOffset, size_t cbWrite,
     1339 * @param   pvUser1         User data which is passed on completion.
     1340 * @param   pvUser2         User data which is passed on completion.
     1341 */
     1342VBOXDDU_DECL(int) VDAsyncWrite(PVBOXHDD pDisk, uint64_t off, size_t cbWrite,
    13441343                               PCRTSGBUF pcSgBuf,
    13451344                               PFNVDASYNCTRANSFERCOMPLETE pfnComplete,
    … …  
    13531352 * @param   pDisk           Pointer to the HDD container.
    13541353 * @param   pfnComplete     Completion callback.
    1355  * @param   pvUser          User data which is passed on completion.
     1354 * @param   pvUser1         User data which is passed on completion.
     1355 * @param   pvUser2         User data which is passed on completion.
    13561356 */
    13571357VBOXDDU_DECL(int) VDAsyncFlush(PVBOXHDD pDisk,
    … …  
    13721372VBOXDDU_DECL(int) VDAsyncDiscardRanges(PVBOXHDD pDisk, PCRTRANGE paRanges, unsigned cRanges,
    13731373                                       PFNVDASYNCTRANSFERCOMPLETE pfnComplete,
    1374                                        void *pvUser1, void *pvUser);
     1374                                       void *pvUser1, void *pvUser2);
    13751375
    13761376/**
    … …  
    13831383 * @param   pVDIfsImage     Pointer to the per-image VD interface list.
    13841384 * @param   pszFilename     Name of the image file to repair.
    1385  * @param   pszFormat       The backend to use.
     1385 * @param   pszBackend      The backend to use.
    13861386 * @param   fFlags          Combination of the VD_REPAIR_* flags.
    13871387 */
    13881388VBOXDDU_DECL(int) VDRepair(PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
    1389                            const char *pszFilename, const char *pszBackend,
    1390                            uint32_t fFlags);
     1389                           const char *pszFilename, const char *pszBackend, uint32_t fFlags);
    13911390
    13921391/**

  • trunk/include/VBox/vddbg.h

    r56291 r58106  
    203203 * @returns VBox status code.
    204204 * @param   hIoLogger    The I/O logger to use.
    205  * @param   penmEvent    Where to store the next event on success.
     205 * @param   penmReq      Where to store the next request on success.
    206206 */
    207207VBOXDDU_DECL(int) VDDbgIoLogReqTypeGetNext(VDIOLOGGER hIoLogger, PVDDBGIOLOGREQ penmReq);

  • trunk/include/VBox/vmm/cpum.h

    r57172 r58106  
    11611161 *
    11621162 * @returns true if in paged protected mode, otherwise false.
    1163  * @param   pVM     The VM handle.
     1163 * @param   pCtx    Current CPU context
    11641164 */
    11651165DECLINLINE(bool) CPUMIsGuestInPagedProtectedModeEx(PCPUMCTX pCtx)
    … …  
    11851185 *
    11861186 * @returns true if in 64 bits protected mode, otherwise false.
    1187  * @param   pVCpu   The current virtual CPU.
    11881187 * @param   pCtx    Current CPU context
    11891188 */

  • trunk/include/VBox/vmm/cpumctx-v1_6.h

    r56291 r58106  
    3232RT_C_DECLS_BEGIN
    3333
    34 /** @addgroup grp_cpum_ctx_v1_6  The CPUM Context Structures from v1.6
     34/** @defgroup grp_cpum_ctx_v1_6  The CPUM Context Structures from v1.6
    3535 * @ingroup grp_cpum
    3636 * @{

  • trunk/include/VBox/vmm/cpumctx.h

    r55469 r58106  
    3737RT_C_DECLS_BEGIN
    3838
    39 /** @addgroup grp_cpum_ctx  The CPUM Context Structures
     39/** @defgroup grp_cpum_ctx  The CPUM Context Structures
    4040 * @ingroup grp_cpum
    4141 * @{

  • trunk/include/VBox/vmm/dbgf.h

    r57006 r58106  
    4343
    4444#if defined(IN_RC) || defined(IN_RING0)
    45 /** @addgroup grp_dbgf_rz  The RZ DBGF API
     45/** @defgroup grp_dbgf_rz  The RZ DBGF API
    4646 * @ingroup grp_dbgf
    4747 * @{

  • trunk/include/VBox/vmm/dbgfcorefmt.h

    r57167 r58106  
    3535
    3636
    37 /** @addgroup grp_dbgf_corefmt  VM Core File Format
     37/** @defgroup grp_dbgf_corefmt  VM Core File Format
    3838 * @ingroup grp_dbgf
    3939 *

  • trunk/include/VBox/vmm/dbgftrace.h

    r56291 r58106  
    3131
    3232RT_C_DECLS_BEGIN
    33 /** @addgroup grp_dbgf_trace  Tracing
     33/** @defgroup grp_dbgf_trace  Tracing
    3434 * @ingroup grp_dbgf
    3535 *

  • trunk/include/VBox/vmm/gmm.h

    r53615 r58106  
    247247    /** The Page ID.
    248248     *
    249      * @intput  GMMR0AllocateHandyPages expects the Page ID of the page to
     249     * @input   GMMR0AllocateHandyPages expects the Page ID of the page to
    250250     *          update here. NIL_GMM_PAGEID means no page should be updated.
    251251     *

  • trunk/include/VBox/vmm/hm.h

    r56381 r58106  
    4242 * Checks whether HM (VT-x/AMD-V) is being used by this VM.
    4343 *
    44  * @retval  @c true if used.
    45  * @retval  @c false if software virtualization (raw-mode) is used.
     44 * @retval  true if used.
     45 * @retval  false if software virtualization (raw-mode) is used.
    4646 *
    4747 * @param   a_pVM       The cross context VM structure.
    … …  
    5858 * Checks whether raw-mode context is required for any purpose.
    5959 *
    60  * @retval  @c true if required either by raw-mode itself or by HM for doing
     60 * @retval  true if required either by raw-mode itself or by HM for doing
    6161 *          switching the cpu to 64-bit mode.
    62  * @retval  @c false if not required.
     62 * @retval  false if not required.
    6363 *
    6464 * @param   a_pVM       The cross context VM structure.

  • trunk/include/VBox/vmm/patm.h

    r55937 r58106  
    136136 *
    137137 * @returns 0 - disabled, 1 - enabled
    138  * @param   pVM         The VM to operate on.
     138 * @param   a_pVM       The VM to operate on.
    139139 * @internal
    140140 */

  • trunk/include/VBox/vmm/pdmblkcache.h

    r56291 r58106  
    6666 * Completion callback for drivers.
    6767 *
    68  * @param   pDrvIns        The driver instance.
    69  * @param   pvUser         User argument given during request initiation.
    70  * @param   rc             The status code of the completed request.
     68 * @param   pDrvIns         The driver instance.
     69 * @param   pvUser          User argument given during request initiation.
     70 * @param   rc              The status code of the completed request.
    7171 */
    7272typedef DECLCALLBACK(void) FNPDMBLKCACHEXFERCOMPLETEDRV(PPDMDRVINS pDrvIns, void *pvUser, int rc);
    … …  
    7777 * I/O enqueue callback for drivers.
    7878 *
    79  * @param   pDrvIns        The driver instance.
    80  * @param   pvUser         User argument given during request initiation.
    81  * @param   rc             The status code of the completed request.
    82  */
    83 typedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEDRV(PPDMDRVINS pDrvIns,
    84                                                       PDMBLKCACHEXFERDIR enmXferDir,
    85                                                       uint64_t off, size_t cbXfer,
    86                                                       PCRTSGBUF pcSgBuf, PPDMBLKCACHEIOXFER hIoXfer);
     79 * @param   pDrvIns         The driver instance.
     80 * @param   enmXferDir      Transfer direction.
     81 * @param   off             Transfer offset.
     82 * @param   cbXfer          Transfer size.
     83 * @param   pSgBuf          Scather / gather buffer for the transfer.
     84 * @param   hIoXfer         I/O transfer handle to ping on completion.
     85 */
     86typedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEDRV(PPDMDRVINS pDrvIns, PDMBLKCACHEXFERDIR enmXferDir,
     87                                                      uint64_t off, size_t cbXfer, PCRTSGBUF pSgBuf, PPDMBLKCACHEIOXFER hIoXfer);
    8788/** Pointer to a FNPDMBLKCACHEXFERENQUEUEDRV(). */
    8889typedef FNPDMBLKCACHEXFERENQUEUEDRV *PFNPDMBLKCACHEXFERENQUEUEDRV;
    … …  
    9192 * Discard enqueue callback for drivers.
    9293 *
    93  * @param   pDrvIns        The driver instance.
    94  * @param   paRanges       Ranges to discard.
    95  * @param   cRanges        Number of range entries.
    96  * @param   hIoXfer        I/O handle to return on completion.
    97  */
    98 typedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEDISCARDDRV(PPDMDRVINS pDrvIns,
    99                                                              PCRTRANGE paRanges, unsigned cRanges,
     94 * @param   pDrvIns         The driver instance.
     95 * @param   paRanges        Ranges to discard.
     96 * @param   cRanges         Number of range entries.
     97 * @param   hIoXfer         I/O handle to return on completion.
     98 */
     99typedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEDISCARDDRV(PPDMDRVINS pDrvIns, PCRTRANGE paRanges, unsigned cRanges,
    100100                                                             PPDMBLKCACHEIOXFER hIoXfer);
    101101/** Pointer to a FNPDMBLKCACHEXFERENQUEUEDISCARDDRV(). */
    … …  
    105105 * Completion callback for devices.
    106106 *
    107  * @param   pDrvIns        The device instance.
    108  * @param   pvUser         User argument given during request initiation.
    109  * @param   rc             The status code of the completed request.
     107 * @param   pDrvIns         The device instance.
     108 * @param   pvUser          User argument given during request initiation.
     109 * @param   rc              The status code of the completed request.
    110110 */
    111111typedef DECLCALLBACK(void) FNPDMBLKCACHEXFERCOMPLETEDEV(PPDMDEVINS pDevIns, void *pvUser, int rc);
    … …  
    116116 * I/O enqueue callback for devices.
    117117 *
    118  * @param   pDevIns        The device instance.
    119  * @param   pvUser         User argument given during request initiation.
    120  * @param   rc             The status code of the completed request.
    121  */
    122 typedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEDEV(PPDMDEVINS pDevIns,
    123                                                       PDMBLKCACHEXFERDIR enmXferDir,
    124                                                       uint64_t off, size_t cbXfer,
    125                                                       PCRTSGBUF pcSgBuf, PPDMBLKCACHEIOXFER hIoXfer);
     118 * @param   pDevIns         The device instance.
     119 * @param   enmXferDir      Transfer direction.
     120 * @param   off             Transfer offset.
     121 * @param   cbXfer          Transfer size.
     122 * @param   pSgBuf          Scather / gather buffer for the transfer.
     123 * @param   hIoXfer         I/O transfer handle to ping on completion.
     124 */
     125typedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEDEV(PPDMDEVINS pDevIns, PDMBLKCACHEXFERDIR enmXferDir,
     126                                                      uint64_t off, size_t cbXfer, PCRTSGBUF pSgBuf, PPDMBLKCACHEIOXFER hIoXfer);
    126127/** Pointer to a FNPDMBLKCACHEXFERENQUEUEDEV(). */
    127128typedef FNPDMBLKCACHEXFERENQUEUEDEV *PFNPDMBLKCACHEXFERENQUEUEDEV;
    … …  
    130131 * Discard enqueue callback for devices.
    131132 *
    132  * @param   pDrvIns        The driver instance.
    133  * @param   paRanges       Ranges to discard.
    134  * @param   cRanges        Number of range entries.
    135  * @param   hIoXfer        I/O handle to return on completion.
    136  */
    137 typedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEDISCARDDEV(PPDMDEVINS pDevIns,
    138                                                              PCRTRANGE paRanges, unsigned cRanges,
     133 * @param   pDrvIns         The driver instance.
     134 * @param   paRanges        Ranges to discard.
     135 * @param   cRanges         Number of range entries.
     136 * @param   hIoXfer         I/O handle to return on completion.
     137 */
     138typedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEDISCARDDEV(PPDMDEVINS pDevIns, PCRTRANGE paRanges, unsigned cRanges,
    139139                                                             PPDMBLKCACHEIOXFER hIoXfer);
    140140/** Pointer to a FNPDMBLKCACHEXFERENQUEUEDISCARDDEV(). */
    … …  
    144144 * Completion callback for drivers.
    145145 *
    146  * @param   pDrvIns        The driver instance.
    147  * @param   pvUser         User argument given during request initiation.
    148  * @param   rc             The status code of the completed request.
     146 * @param   pDrvIns         The driver instance.
     147 * @param   pvUser          User argument given during request initiation.
     148 * @param   rc              The status code of the completed request.
    149149 */
    150150typedef DECLCALLBACK(void) FNPDMBLKCACHEXFERCOMPLETEINT(void *pvUserInt, void *pvUser, int rc);
    … …  
    155155 * I/O enqueue callback for drivers.
    156156 *
    157  * @param   pDrvIns        The driver instance.
    158  * @param   pvUser         User argument given during request initiation.
    159  * @param   rc             The status code of the completed request.
    160  */
    161 typedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEINT(void *pvUser,
    162                                                       PDMBLKCACHEXFERDIR enmXferDir,
    163                                                       uint64_t off, size_t cbXfer,
    164                                                       PCRTSGBUF pcSgBuf, PPDMBLKCACHEIOXFER hIoXfer);
     157 * @param   pDrvIns         The driver instance.
     158 * @param   enmXferDir      Transfer direction.
     159 * @param   off             Transfer offset.
     160 * @param   cbXfer          Transfer size.
     161 * @param   pSgBuf          Scather / gather buffer for the transfer.
     162 * @param   hIoXfer         I/O transfer handle to ping on completion.
     163 */
     164typedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEINT(void *pvUser, PDMBLKCACHEXFERDIR enmXferDir,
     165                                                      uint64_t off, size_t cbXfer, PCRTSGBUF pSgBuf, PPDMBLKCACHEIOXFER hIoXfer);
    165166/** Pointer to a FNPDMBLKCACHEXFERENQUEUEINT(). */
    166167typedef FNPDMBLKCACHEXFERENQUEUEINT *PFNPDMBLKCACHEXFERENQUEUEINT;
    … …  
    169170 * Discard enqueue callback for VMM internal users.
    170171 *
    171  * @param   pDrvIns        The driver instance.
    172  * @param   paRanges       Ranges to discard.
    173  * @param   cRanges        Number of range entries.
    174  * @param   hIoXfer        I/O handle to return on completion.
    175  */
    176 typedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEDISCARDINT(void *pvUser,
    177                                                              PCRTRANGE paRanges, unsigned cRanges,
     172 * @param   pDrvIns         The driver instance.
     173 * @param   paRanges        Ranges to discard.
     174 * @param   cRanges         Number of range entries.
     175 * @param   hIoXfer         I/O handle to return on completion.
     176 */
     177typedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEDISCARDINT(void *pvUser, PCRTRANGE paRanges, unsigned cRanges,
    178178                                                             PPDMBLKCACHEIOXFER hIoXfer);
    179179/** Pointer to a FNPDMBLKCACHEXFERENQUEUEDISCARDINT(). */
    … …  
    183183 * Completion callback for USB.
    184184 *
    185  * @param   pDrvIns        The driver instance.
    186  * @param   pvUser         User argument given during request initiation.
    187  * @param   rc             The status code of the completed request.
     185 * @param   pDrvIns         The driver instance.
     186 * @param   pvUser          User argument given during request initiation.
     187 * @param   rc              The status code of the completed request.
    188188 */
    189189typedef DECLCALLBACK(void) FNPDMBLKCACHEXFERCOMPLETEUSB(PPDMUSBINS pUsbIns, void *pvUser, int rc);
    … …  
    194194 * I/O enqueue callback for drivers.
    195195 *
    196  * @param   pDrvIns        The driver instance.
    197  * @param   pvUser         User argument given during request initiation.
    198  * @param   rc             The status code of the completed request.
    199  */
    200 typedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEUSB(PPDMUSBINS pUsbIns,
    201                                                       PDMBLKCACHEXFERDIR enmXferDir,
    202                                                       uint64_t off, size_t cbXfer,
    203                                                       PCRTSGBUF pcSgBuf, PPDMBLKCACHEIOXFER hIoXfer);
     196 * @param   pDrvIns         The driver instance.
     197 * @param   enmXferDir      Transfer direction.
     198 * @param   off             Transfer offset.
     199 * @param   cbXfer          Transfer size.
     200 * @param   pSgBuf          Scather / gather buffer for the transfer.
     201 * @param   hIoXfer         I/O transfer handle to ping on completion.
     202 */
     203typedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEUSB(PPDMUSBINS pUsbIns, PDMBLKCACHEXFERDIR enmXferDir,
     204                                                      uint64_t off, size_t cbXfer, PCRTSGBUF pSgBuf, PPDMBLKCACHEIOXFER hIoXfer);
    204205/** Pointer to a FNPDMBLKCACHEXFERENQUEUEUSB(). */
    205206typedef FNPDMBLKCACHEXFERENQUEUEUSB *PFNPDMBLKCACHEXFERENQUEUEUSB;
    … …  
    208209 * Discard enqueue callback for USB devices.
    209210 *
    210  * @param   pUsbIns        The USB device instance.
    211  * @param   paRanges       Ranges to discard.
    212  * @param   cRanges        Number of range entries.
    213  * @param   hIoXfer        I/O handle to return on completion.
    214  */
    215 typedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEDISCARDUSB(PPDMUSBINS pUsbIns,
    216                                                              PCRTRANGE paRanges, unsigned cRanges,
     211 * @param   pUsbIns         The USB device instance.
     212 * @param   paRanges        Ranges to discard.
     213 * @param   cRanges         Number of range entries.
     214 * @param   hIoXfer         I/O handle to return on completion.
     215 */
     216typedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEDISCARDUSB(PPDMUSBINS pUsbIns, PCRTRANGE paRanges, unsigned cRanges,
    217217                                                             PPDMBLKCACHEIOXFER hIoXfer);
    218218/** Pointer to a FNPDMBLKCACHEXFERENQUEUEDISCARDUSB(). */
    … …  
    330330 *
    331331 * @returns VBox status code.
    332  * @param   pEndpoint       The file endpoint to read from.
     332 * @param   pBlkCache       The cache instance.
    333333 * @param   off             Where to start reading from.
    334  * @param   paSegments      Scatter gather list to store the data in.
    335  * @param   cSegments       Number of segments in the list.
     334 * @param   pSgBuf          Scatter gather buffer store the data in.
    336335 * @param   cbRead          The overall number of bytes to read.
    337336 * @param   pvUser          Opaque user data returned in the completion callback
    338337 *                          upon completion of the read.
    339338 */
    340 VMMR3DECL(int) PDMR3BlkCacheRead(PPDMBLKCACHE pBlkCache, uint64_t off,
    341                                  PCRTSGBUF pcSgBuf, size_t cbRead, void *pvUser);
     339VMMR3DECL(int) PDMR3BlkCacheRead(PPDMBLKCACHE pBlkCache, uint64_t off, PCRTSGBUF pSgBuf, size_t cbRead, void *pvUser);
    342340
    343341/**
    … …  
    345343 *
    346344 * @returns VBox status code.
    347  * @param   pEndpoint       The file endpoint to write to.
     345 * @param   pBlkCache       The cache instance.
    348346 * @param   off             Where to start writing at.
    349  * @param   paSegments      Scatter gather list of the data to write.
    350  * @param   cSegments       Number of segments in the list.
     347 * @param   pSgBuf          Scatter gather buffer gather the data from.
    351348 * @param   cbWrite         The overall number of bytes to write.
    352349 * @param   pvUser          Opaque user data returned in the completion callback
    353350 *                          upon completion of the task.
    354351 */
    355 VMMR3DECL(int) PDMR3BlkCacheWrite(PPDMBLKCACHE pBlkCache, uint64_t off,
    356                                   PCRTSGBUF pcSgBuf, size_t cbWrite, void *pvUser);
     352VMMR3DECL(int) PDMR3BlkCacheWrite(PPDMBLKCACHE pBlkCache, uint64_t off, PCRTSGBUF pSgBuf, size_t cbWrite, void *pvUser);
    357353
    358354/**
    … …  
    360356 *
    361357 * @returns VBox status code.
    362  * @param   pEndpoint       The file endpoint to flush.
     358 * @param   pBlkCache       The cache instance.
    363359 * @param   pvUser          Opaque user data returned in the completion callback
    364360 *                          upon completion of the task.
    … …  
    370366 *
    371367 * @returns VBox status code.
    372  * @param   pEndpoint       The file endpoint to flush.
     368 * @param   pBlkCache       The cache instance.
    373369 * @param   paRanges        Array of ranges to discard.
    374370 * @param   cRanges         Number of ranges in the array.
    … …  
    389385
    390386/**
    391  * Suspends the block cache. The cache waits until all I/O transfers completed
    392  * and stops to enqueue new requests after the call returned but will not accept
    393  * reads, write or flushes either.
     387 * Suspends the block cache.
     388 *
     389 * The cache waits until all I/O transfers completed and stops to enqueue new
     390 * requests after the call returned but will not accept reads, write or flushes
     391 * either.
    394392 *
    395393 * @returns VBox status code.
    … …  
    407405
    408406/**
    409  * Clears the block cache and removes all entries. The cache waits until all
    410  * I/O transfers completed.
     407 * Clears the block cache and removes all entries.
     408 *
     409 * The cache waits until all I/O transfers completed.
    411410 *
    412411 * @returns VBox status code.

  • trunk/include/VBox/vmm/pdmdev.h

    r57393 r58106  
    23282328
    23292329    /**
    2330      * Register a Memory Mapped I/O (MMIO) region for GC.
     2330     * Register a Memory Mapped I/O (MMIO) region for RC.
    23312331     *
    23322332     * These callbacks are for the raw-mode context (RC). Register ring-3 context
    … …  
    23632363     * @param   pszRead             Name of the RC function which is gonna handle Read operations.
    23642364     * @param   pszFill             Name of the RC function which is gonna handle Fill/memset operations. (optional)
    2365      * @param   pszDesc             Obsolete. NULL is fine.
    23662365     * @remarks Caller enters the device critical section prior to invoking the
    23672366     *          registered callback methods.
    … …  
    25282527     * @returns VBox status.
    25292528     * @param   pDevIns             The device instance.
    2530      * @param   pszName             Data unit name.
    2531      * @param   uInstance           The instance identifier of the data unit.
    2532      *                              This must together with the name be unique.
    25332529     * @param   uVersion            Data layout version number.
    25342530     * @param   cbGuess             The approximate amount of data in the unit.
    … …  
    25712567     *          callback.
    25722568     */
    2573     DECLR3CALLBACKMEMBER(int, pfnTMTimerCreate,(PPDMDEVINS pDevIns, TMCLOCK enmClock, PFNTMTIMERDEV pfnCallback, void *pvUser, uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer));
     2569    DECLR3CALLBACKMEMBER(int, pfnTMTimerCreate,(PPDMDEVINS pDevIns, TMCLOCK enmClock, PFNTMTIMERDEV pfnCallback,
     2570                                                void *pvUser, uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer));
    25742571
    25752572    /**
    … …  
    26232620     * @retval  VERR_PGM_INVALID_GC_PHYSICAL_ADDRESS if it's not a valid physical address.
    26242621     *
    2625      * @param   pVM                 The VM handle.
     2622     * @param   pDevIns             The device instance.
    26262623     * @param   GCPhys              The guest physical address of the page that
    26272624     *                              should be mapped.
    … …  
    26372634     * @thread  Any.
    26382635     */
    2639     DECLR3CALLBACKMEMBER(int, pfnPhysGCPhys2CCPtr,(PPDMDEVINS pDevIns, RTGCPHYS GCPhys, uint32_t fFlags, void **ppv, PPGMPAGEMAPLOCK pLock));
     2636    DECLR3CALLBACKMEMBER(int, pfnPhysGCPhys2CCPtr,(PPDMDEVINS pDevIns, RTGCPHYS GCPhys, uint32_t fFlags, void **ppv,
     2637                                                   PPGMPAGEMAPLOCK pLock));
    26402638
    26412639    /**
    … …  
    26642662     * @thread  Any.
    26652663     */
    2666     DECLR3CALLBACKMEMBER(int, pfnPhysGCPhys2CCPtrReadOnly,(PPDMDEVINS pDevIns, RTGCPHYS GCPhys, uint32_t fFlags, void const **ppv, PPGMPAGEMAPLOCK pLock));
     2664    DECLR3CALLBACKMEMBER(int, pfnPhysGCPhys2CCPtrReadOnly,(PPDMDEVINS pDevIns, RTGCPHYS GCPhys, uint32_t fFlags,
     2665                                                           void const **ppv, PPGMPAGEMAPLOCK pLock));
    26672666
    26682667    /**
    … …  
    27652764     * @param   pDevIns             The device instance.
    27662765     * @param   rc                  VBox status code.
    2767      * @param   RT_SRC_POS_DECL     Use RT_SRC_POS.
     2766     * @param   SRC_POS             Use RT_SRC_POS.
    27682767     * @param   pszFormat           Error message format string.
    27692768     * @param   ...                 Error message arguments.
    … …  
    27782777     * @param   pDevIns             The device instance.
    27792778     * @param   rc                  VBox status code.
    2780      * @param   RT_SRC_POS_DECL     Use RT_SRC_POS.
     2779     * @param   SRC_POS             Use RT_SRC_POS.
    27812780     * @param   pszFormat           Error message format string.
    27822781     * @param   va                  Error message arguments.
    … …  
    29712970     *                              to call default PCI config read function. Can be NULL.
    29722971     * @param   pfnWrite            Pointer to the user defined PCI config write function.
    2973      * @param   pfnWriteOld         Pointer to function pointer which will receive the old (default)
    2974      *                              PCI config write function. This way, user can decide when (and if)
    2975      *                              to call default PCI config write function. Can be NULL.
     2972     * @param   ppfnWriteOld        Pointer to function pointer which will receive
     2973     *                              the old (default) PCI config write function.
     2974     *                              This way, user can decide when (and if) to call
     2975     *                              default PCI config write function. Can be NULL.
    29762976     * @remarks The callbacks will be invoked holding the PDM lock. The device lock
    29772977     *          is NOT take because that is very likely be a lock order violation.
    … …  
    30973097     * @param   pDevIns             The device instance.
    30983098     * @param   pCritSect           Pointer to the critical section.
    3099      * @param   RT_SRC_POS_DECL     Use RT_SRC_POS.
     3099     * @param   SRC_POS             Use RT_SRC_POS.
    31003100     * @param   pszNameFmt          Format string for naming the critical section.
    31013101     *                              For statistics and lock validation.
    … …  
    32593259     * @returns VBox status code.
    32603260     * @param   pDevIns             The device instance.
    3261      * @param   pHpetReg            Pointer to a raw PCI registration structure.
     3261     * @param   pPciRawReg          Pointer to a raw PCI registration structure.
    32623262     * @param   ppPciRawHlpR3       Where to store the pointer to the raw PCI
    32633263     *                              device helpers.
    … …  
    36553655     *
    36563656     * @returns Support driver session handle.
    3657      * @param   pDrvIns         The driver instance.
     3657     * @param   pDevIns             The device instance.
    36583658     */
    36593659    DECLR3CALLBACKMEMBER(PSUPDRVSESSION, pfnGetSupDrvSession,(PPDMDEVINS pDevIns));
    … …  
    37753775     * @param   pDrvIns         Driver instance.
    37763776     * @param   rc              VBox status code.
    3777      * @param   RT_SRC_POS_DECL Use RT_SRC_POS.
     3777     * @param   SRC_POS        Use RT_SRC_POS.
    37783778     * @param   pszFormat       Error message format string.
    37793779     * @param   ...             Error message arguments.
    … …  
    37883788     * @param   pDrvIns         Driver instance.
    37893789     * @param   rc              VBox status code.
    3790      * @param   RT_SRC_POS_DECL Use RT_SRC_POS.
     3790     * @param   SRC_POS        Use RT_SRC_POS.
    37913791     * @param   pszFormat       Error message format string.
    37923792     * @param   va              Error message arguments.
    … …  
    40044004     * @param   pDrvIns         Driver instance.
    40054005     * @param   rc              VBox status code.
    4006      * @param   RT_SRC_POS_DECL Use RT_SRC_POS.
     4006     * @param   SRC_POS        Use RT_SRC_POS.
    40074007     * @param   pszFormat       Error message format string.
    40084008     * @param   ...             Error message arguments.
    … …  
    40174017     * @param   pDrvIns         Driver instance.
    40184018     * @param   rc              VBox status code.
    4019      * @param   RT_SRC_POS_DECL Use RT_SRC_POS.
     4019     * @param   SRC_POS        Use RT_SRC_POS.
    40204020     * @param   pszFormat       Error message format string.
    40214021     * @param   va              Error message arguments.
    … …  
    44074407
    44084408/**
    4409  * Register a Memory Mapped I/O (MMIO) region for GC.
     4409 * Register a Memory Mapped I/O (MMIO) region for RC.
    44104410 *
    44114411 * These callbacks are for the raw-mode context (RC). Register ring-3 context
    … …  
    44284428
    44294429/**
    4430  * @copydoc PDMDEVHLPR3::pfnMMIORegisterR0
     4430 * Register a Memory Mapped I/O (MMIO) region for R0.
     4431 *
     4432 * These callbacks are for the ring-0 host context (R0).  Register ring-3
     4433 * constext (R3) handlers before R0 handlers!  There must be a R3 handler for
     4434 * every R0 handler!
     4435 *
     4436 * @returns VBox status.
     4437 * @param   pDevIns             The device instance to register the MMIO with.
     4438 * @param   GCPhysStart         First physical address in the range.
     4439 * @param   cbRange             The size of the range (in bytes).
     4440 * @param   pvUser              User argument. (if pointer, then it must be in locked memory!)
     4441 * @param   pszWrite            Name of the RC function which is gonna handle Write operations.
     4442 * @param   pszRead             Name of the RC function which is gonna handle Read operations.
     4443 * @remarks Caller enters the device critical section prior to invoking the
     4444 *          registered callback methods.
    44314445 */
    44324446DECLINLINE(int) PDMDevHlpMMIORegisterR0(PPDMDEVINS pDevIns, RTGCPHYS GCPhysStart, uint32_t cbRange, RTR0PTR pvUser,
    … …  
    44514465 */
    44524466DECLINLINE(int) PDMDevHlpMMIORegisterRCEx(PPDMDEVINS pDevIns, RTGCPHYS GCPhysStart, uint32_t cbRange, RTRCPTR pvUser,
    4453                                         const char *pszWrite, const char *pszRead, const char *pszFill)
     4467                                          const char *pszWrite, const char *pszRead, const char *pszFill)
    44544468{
    44554469    return pDevIns->pHlpR3->pfnMMIORegisterRC(pDevIns, GCPhysStart, cbRange, pvUser, pszWrite, pszRead, pszFill);
    … …  
    44604474 */
    44614475DECLINLINE(int) PDMDevHlpMMIORegisterR0Ex(PPDMDEVINS pDevIns, RTGCPHYS GCPhysStart, uint32_t cbRange, RTR0PTR pvUser,
    4462                                         const char *pszWrite, const char *pszRead, const char *pszFill)
     4476                                          const char *pszWrite, const char *pszRead, const char *pszFill)
    44634477{
    44644478    return pDevIns->pHlpR3->pfnMMIORegisterR0(pDevIns, GCPhysStart, cbRange, pvUser, pszWrite, pszRead, pszFill);
    … …  
    45904604{
    45914605    return pDevIns->pHlpR3->pfnSSMRegister(pDevIns, uVersion, cbGuess, pszBefore,
    4592                                               pfnLivePrep, pfnLiveExec, pfnLiveVote,
    4593                                               pfnSavePrep, pfnSaveExec, pfnSaveDone,
    4594                                               pfnLoadPrep, pfnLoadExec, pfnLoadDone);
     4606                                           pfnLivePrep, pfnLiveExec, pfnLiveVote,
     4607                                           pfnSavePrep, pfnSaveExec, pfnSaveDone,
     4608                                           pfnLoadPrep, pfnLoadExec, pfnLoadDone);
    45954609}
    45964610
    … …  
    46434657 * @copydoc PDMDEVHLPR3::pfnPhysGCPhys2CCPtrReadOnly
    46444658 */
    4645 DECLINLINE(int) PDMDevHlpPhysGCPhys2CCPtrReadOnly(PPDMDEVINS pDevIns, RTGCPHYS GCPhys, uint32_t fFlags, void const **ppv, PPGMPAGEMAPLOCK pLock)
     4659DECLINLINE(int) PDMDevHlpPhysGCPhys2CCPtrReadOnly(PPDMDEVINS pDevIns, RTGCPHYS GCPhys, uint32_t fFlags, void const **ppv,
     4660                                                  PPGMPAGEMAPLOCK pLock)
    46464661{
    46474662    return pDevIns->CTX_SUFF(pHlp)->pfnPhysGCPhys2CCPtrReadOnly(pDevIns, GCPhys, fFlags, ppv, pLock);
    … …  
    47564771 *          VINF_SUCCESS in non-strict builds.
    47574772 * @param   pDevIns             The device instance.
    4758  * @param   RT_SRC_POS_DECL     Use RT_SRC_POS.
     4773 * @param   SRC_POS             Use RT_SRC_POS.
    47594774 * @param   pszFormat           Message. (optional)
    47604775 * @param   ...                 Message parameters.
    … …  
    48384853 * @copydoc PDMDEVHLPR3::pfnPCIIORegionRegister
    48394854 */
    4840 DECLINLINE(int) PDMDevHlpPCIIORegionRegister(PPDMDEVINS pDevIns, int iRegion, uint32_t cbRegion, PCIADDRESSSPACE enmType, PFNPCIIOREGIONMAP pfnCallback)
     4855DECLINLINE(int) PDMDevHlpPCIIORegionRegister(PPDMDEVINS pDevIns, int iRegion, uint32_t cbRegion,
     4856                                             PCIADDRESSSPACE enmType, PFNPCIIOREGIONMAP pfnCallback)
    48414857{
    48424858    return pDevIns->pHlpR3->pfnPCIIORegionRegister(pDevIns, iRegion, cbRegion, enmType, pfnCallback);
    … …  
    49384954 * @param   pDevIns             The device instance.
    49394955 * @param   pCritSect           Pointer to the critical section.
    4940  * @param   RT_SRC_POS_DECL     Use RT_SRC_POS.
     4956 * @param   SRC_POS             Use RT_SRC_POS.
    49414957 * @param   pszNameFmt          Format string for naming the critical section.
    49424958 *                              For statistics and lock validation.
    … …  
    50525068
    50535069/**
    5054  * @copydoc PDMDEVHLPR3::pfn
     5070 * @copydoc PDMDEVHLPR3::pfnIOAPICRegister
    50555071 */
    50565072DECLINLINE(int) PDMDevHlpIOAPICRegister(PPDMDEVINS pDevIns, PPDMIOAPICREG pIoApicReg, PCPDMIOAPICHLPR3 *ppIoApicHlpR3)
    … …  
    51485164
    51495165/**
    5150  * @copydoc PDMDEVHLP::pfnCallR0
     5166 * @copydoc PDMDEVHLPR3::pfnCallR0
    51515167 */
    51525168DECLINLINE(int) PDMDevHlpCallR0(PPDMDEVINS pDevIns, uint32_t uOperation, uint64_t u64Arg)
    … …  
    51565172
    51575173/**
    5158  * @copydoc PDMDEVHLP::pfnVMGetSuspendReason
     5174 * @copydoc PDMDEVHLPR3::pfnVMGetSuspendReason
    51595175 */
    51605176DECLINLINE(VMSUSPENDREASON) PDMDevHlpVMGetSuspendReason(PPDMDEVINS pDevIns)
    … …  
    51645180
    51655181/**
    5166  * @copydoc PDMDEVHLP::pfnVMGetResumeReason
     5182 * @copydoc PDMDEVHLPR3::pfnVMGetResumeReason
    51675183 */
    51685184DECLINLINE(VMRESUMEREASON) PDMDevHlpVMGetResumeReason(PPDMDEVINS pDevIns)

  • trunk/include/VBox/vmm/pdmdrv.h

    r57006 r58106  
    577577     * @param   pDrvIns         Driver instance.
    578578     * @param   rc              VBox status code.
    579      * @param   RT_SRC_POS_DECL Use RT_SRC_POS.
     579     * @param   SRC_POS        Use RT_SRC_POS.
    580580     * @param   pszFormat       Error message format string.
    581581     * @param   ...             Error message arguments.
    … …  
    590590     * @param   pDrvIns         Driver instance.
    591591     * @param   rc              VBox status code.
    592      * @param   RT_SRC_POS_DECL Use RT_SRC_POS.
     592     * @param   SRC_POS        Use RT_SRC_POS.
    593593     * @param   pszFormat       Error message format string.
    594594     * @param   va              Error message arguments.
    … …  
    677677     * @param   pDrvIns         Driver instance.
    678678     * @param   rc              VBox status code.
    679      * @param   RT_SRC_POS_DECL Use RT_SRC_POS.
     679     * @param   SRC_POS        Use RT_SRC_POS.
    680680     * @param   pszFormat       Error message format string.
    681681     * @param   ...             Error message arguments.
    … …  
    690690     * @param   pDrvIns         Driver instance.
    691691     * @param   rc              VBox status code.
    692      * @param   RT_SRC_POS_DECL Use RT_SRC_POS.
     692     * @param   SRC_POS        Use RT_SRC_POS.
    693693     * @param   pszFormat       Error message format string.
    694694     * @param   va              Error message arguments.
    … …  
    847847     * @param   pDrvIns         Driver instance.
    848848     * @param   rc              VBox status code.
    849      * @param   RT_SRC_POS_DECL Use RT_SRC_POS.
     849     * @param   SRC_POS        Use RT_SRC_POS.
    850850     * @param   pszFormat       Error message format string.
    851851     * @param   ...             Error message arguments.
    … …  
    860860     * @param   pDrvIns         Driver instance.
    861861     * @param   rc              VBox status code.
    862      * @param   RT_SRC_POS_DECL Use RT_SRC_POS.
     862     * @param   SRC_POS        Use RT_SRC_POS.
    863863     * @param   pszFormat       Error message format string.
    864864     * @param   va              Error message arguments.
    … …  
    12561256     * @param   pDrvIns             The driver instance.
    12571257     * @param   pCritSect           Pointer to the critical section.
    1258      * @param   RT_SRC_POS_DECL     Use RT_SRC_POS.
     1258     * @param   SRC_POS             Use RT_SRC_POS.
    12591259     * @param   pszName             The base name of the critical section.  Will be
    12601260     *                              mangeled with the instance number.  For
    12611261     *                              statistics and lock validation.
    1262      * @param   va                  Arguments for the format string.
    12631262     * @thread  EMT
    12641263     */
    1265     DECLR3CALLBACKMEMBER(int, pfnCritSectInit,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect,
    1266                                                RT_SRC_POS_DECL, const char *pszName));
     1264    DECLR3CALLBACKMEMBER(int, pfnCritSectInit,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, RT_SRC_POS_DECL, const char *pszName));
    12671265
    12681266    /**
    … …  
    13011299     *
    13021300     * @returns VBox status code.
    1303      * @param   pDrvIns         The driver instance.
    1304      * @param   ppBlkCache      Where to store the handle to the block cache.
    1305      * @param   pfnXferComplete The I/O transfer complete callback.
    1306      * @param   pfnXferEnqueue  The I/O request enqueue callback.
    1307      * @param   pcszId          Unique ID used to identify the user.
     1301     * @param   pDrvIns             The driver instance.
     1302     * @param   ppBlkCache          Where to store the handle to the block cache.
     1303     * @param   pfnXferComplete     The I/O transfer complete callback.
     1304     * @param   pfnXferEnqueue      The I/O request enqueue callback.
     1305     * @param   pfnXferEnqueueDiscard   The discard request enqueue callback.
     1306     * @param   pcszId              Unique ID used to identify the user.
    13081307     */
    13091308    DECLR3CALLBACKMEMBER(int, pfnBlkCacheRetain, (PPDMDRVINS pDrvIns, PPPDMBLKCACHE ppBlkCache,
    … …  
    13541353
    13551354/**
    1356  * @copydoc PDMDRVHLP::pfnVMSetError
     1355 * @copydoc PDMDRVHLPR3::pfnVMSetError
    13571356 */
    13581357DECLINLINE(int)  RT_IPRT_FORMAT_ATTR(6, 7) PDMDrvHlpVMSetError(PPDMDRVINS pDrvIns, const int rc, RT_SRC_POS_DECL,
    … …  
    13731372
    13741373/**
    1375  * @copydoc PDMDRVHLP::pfnVMSetErrorV
     1374 * @copydoc PDMDRVHLPR3::pfnVMSetErrorV
    13761375 */
    13771376DECLINLINE(int)  RT_IPRT_FORMAT_ATTR(6, 0) PDMDrvHlpVMSetErrorV(PPDMDRVINS pDrvIns, const int rc, RT_SRC_POS_DECL,
    … …  
    13831382
    13841383/**
    1385  * @copydoc PDMDRVHLP::pfnVMSetRuntimeError
     1384 * @copydoc PDMDRVHLPR3::pfnVMSetRuntimeError
    13861385 */
    13871386DECLINLINE(int)  RT_IPRT_FORMAT_ATTR(4, 5) PDMDrvHlpVMSetRuntimeError(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId,
    … …  
    14031402
    14041403/**
    1405  * @copydoc PDMDRVHLP::pfnVMSetRuntimeErrorV
     1404 * @copydoc PDMDRVHLPR3::pfnVMSetRuntimeErrorV
    14061405 */
    14071406DECLINLINE(int)  RT_IPRT_FORMAT_ATTR(4, 0) PDMDrvHlpVMSetRuntimeErrorV(PPDMDRVINS pDrvIns, uint32_t fFlags,
    … …  
    14321431
    14331432/**
    1434  * @copydoc PDMDRVHLP::pfnFTSetCheckpoint
     1433 * @copydoc PDMDRVHLPR3::pfnFTSetCheckpoint
    14351434 */
    14361435DECLINLINE(int) PDMDrvHlpFTSetCheckpoint(PPDMDRVINS pDrvIns, FTMCHECKPOINTTYPE enmType)
    … …  
    14431442
    14441443/**
    1445  * @copydoc PDMDRVHLP::pfnAttach
     1444 * @copydoc PDMDRVHLPR3::pfnAttach
    14461445 */
    14471446DECLINLINE(int) PDMDrvHlpAttach(PPDMDRVINS pDrvIns, uint32_t fFlags, PPDMIBASE *ppBaseInterface)
    … …  
    14621461
    14631462/**
    1464  * @copydoc PDMDRVHLP::pfnDetach
     1463 * @copydoc PDMDRVHLPR3::pfnDetach
    14651464 */
    14661465DECLINLINE(int) PDMDrvHlpDetach(PPDMDRVINS pDrvIns, uint32_t fFlags)
    … …  
    14701469
    14711470/**
    1472  * @copydoc PDMDRVHLP::pfnDetachSelf
     1471 * @copydoc PDMDRVHLPR3::pfnDetachSelf
    14731472 */
    14741473DECLINLINE(int) PDMDrvHlpDetachSelf(PPDMDRVINS pDrvIns, uint32_t fFlags)
    … …  
    14781477
    14791478/**
    1480  * @copydoc PDMDRVHLP::pfnMountPrepare
     1479 * @copydoc PDMDRVHLPR3::pfnMountPrepare
    14811480 */
    14821481DECLINLINE(int) PDMDrvHlpMountPrepare(PPDMDRVINS pDrvIns, const char *pszFilename, const char *pszCoreDriver)
    … …  
    14861485
    14871486/**
    1488  * @copydoc PDMDRVHLP::pfnVMState
     1487 * @copydoc PDMDRVHLPR3::pfnVMState
    14891488 */
    14901489DECLINLINE(VMSTATE) PDMDrvHlpVMState(PPDMDRVINS pDrvIns)
    … …  
    14941493
    14951494/**
    1496  * @copydoc PDMDRVHLP::pfnVMTeleportedAndNotFullyResumedYet
     1495 * @copydoc PDMDRVHLPR3::pfnVMTeleportedAndNotFullyResumedYet
    14971496 */
    14981497DECLINLINE(bool) PDMDrvHlpVMTeleportedAndNotFullyResumedYet(PPDMDRVINS pDrvIns)
    … …  
    15021501
    15031502/**
    1504  * @copydoc PDMDRVHLP::pfnGetSupDrvSession
     1503 * @copydoc PDMDRVHLPR3::pfnGetSupDrvSession
    15051504 */
    15061505DECLINLINE(PSUPDRVSESSION) PDMDrvHlpGetSupDrvSession(PPDMDRVINS pDrvIns)
    … …  
    15101509
    15111510/**
    1512  * @copydoc PDMDRVHLP::pfnQueueCreate
     1511 * @copydoc PDMDRVHLPR3::pfnQueueCreate
    15131512 */
    15141513DECLINLINE(int) PDMDrvHlpQueueCreate(PPDMDRVINS pDrvIns, uint32_t cbItem, uint32_t cItems, uint32_t cMilliesInterval,
    … …  
    15191518
    15201519/**
    1521  * @copydoc PDMDRVHLP::pfnTMGetVirtualFreq
     1520 * @copydoc PDMDRVHLPR3::pfnTMGetVirtualFreq
    15221521 */
    15231522DECLINLINE(uint64_t) PDMDrvHlpTMGetVirtualFreq(PPDMDRVINS pDrvIns)
    … …  
    15271526
    15281527/**
    1529  * @copydoc PDMDRVHLP::pfnTMGetVirtualTime
     1528 * @copydoc PDMDRVHLPR3::pfnTMGetVirtualTime
    15301529 */
    15311530DECLINLINE(uint64_t) PDMDrvHlpTMGetVirtualTime(PPDMDRVINS pDrvIns)
    … …  
    15351534
    15361535/**
    1537  * @copydoc PDMDRVHLP::pfnTMTimerCreate
     1536 * @copydoc PDMDRVHLPR3::pfnTMTimerCreate
    15381537 */
    15391538DECLINLINE(int) PDMDrvHlpTMTimerCreate(PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void *pvUser, uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer)
    … …  
    15631562
    15641563/**
    1565  * @copydoc PDMDRVHLP::pfnSSMRegister
     1564 * @copydoc PDMDRVHLPR3::pfnSSMRegister
    15661565 */
    15671566DECLINLINE(int) PDMDrvHlpSSMRegisterEx(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
    … …  
    15921591
    15931592/**
    1594  * @copydoc PDMDRVHLP::pfnDBGFInfoRegister
     1593 * @copydoc PDMDRVHLPR3::pfnDBGFInfoRegister
    15951594 */
    15961595DECLINLINE(int) PDMDrvHlpDBGFInfoRegister(PPDMDRVINS pDrvIns, const char *pszName, const char *pszDesc, PFNDBGFHANDLERDRV pfnHandler)
    … …  
    16001599
    16011600/**
    1602  * @copydoc PDMDRVHLP::pfnDBGFInfoDeregister
     1601 * @copydoc PDMDRVHLPR3::pfnDBGFInfoRegister
    16031602 */
    16041603DECLINLINE(int) PDMDrvHlpDBGFInfoDeregister(PPDMDRVINS pDrvIns, const char *pszName, const char *pszDesc, PFNDBGFHANDLERDRV pfnHandler)
    … …  
    16081607
    16091608/**
    1610  * @copydoc PDMDRVHLP::pfnSTAMRegister
     1609 * @copydoc PDMDRVHLPR3::pfnSTAMRegister
    16111610 */
    16121611DECLINLINE(void) PDMDrvHlpSTAMRegister(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, const char *pszName, STAMUNIT enmUnit, const char *pszDesc)
    … …  
    16161615
    16171616/**
    1618  * @copydoc PDMDRVHLP::pfnSTAMRegisterF
     1617 * @copydoc PDMDRVHLPR3::pfnSTAMRegisterF
    16191618 */
    16201619DECLINLINE(void)  RT_IPRT_FORMAT_ATTR(7, 8) PDMDrvHlpSTAMRegisterF(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType,
    … …  
    17231722
    17241723/**
    1725  * @copydoc PDMDRVHLP::pfnSTAMDeregister
     1724 * @copydoc PDMDRVHLPR3::pfnSTAMDeregister
    17261725 */
    17271726DECLINLINE(int) PDMDrvHlpSTAMDeregister(PPDMDRVINS pDrvIns, void *pvSample)
    … …  
    17311730
    17321731/**
    1733  * @copydoc PDMDRVHLP::pfnSUPCallVMMR0Ex
     1732 * @copydoc PDMDRVHLPR3::pfnSUPCallVMMR0Ex
    17341733 */
    17351734DECLINLINE(int) PDMDrvHlpSUPCallVMMR0Ex(PPDMDRVINS pDrvIns, unsigned uOperation, void *pvArg, unsigned cbArg)
    … …  
    17391738
    17401739/**
    1741  * @copydoc PDMDRVHLP::pfnUSBRegisterHub
     1740 * @copydoc PDMDRVHLPR3::pfnUSBRegisterHub
    17421741 */
    17431742DECLINLINE(int) PDMDrvHlpUSBRegisterHub(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp)
    … …  
    17471746
    17481747/**
    1749  * @copydoc PDMDRVHLP::pfnSetAsyncNotification
     1748 * @copydoc PDMDRVHLPR3::pfnSetAsyncNotification
    17501749 */
    17511750DECLINLINE(int) PDMDrvHlpSetAsyncNotification(PPDMDRVINS pDrvIns, PFNPDMDRVASYNCNOTIFY pfnAsyncNotify)
    … …  
    17551754
    17561755/**
    1757  * @copydoc PDMDRVHLP::pfnAsyncNotificationCompleted
     1756 * @copydoc PDMDRVHLPR3::pfnAsyncNotificationCompleted
    17581757 */
    17591758DECLINLINE(void) PDMDrvHlpAsyncNotificationCompleted(PPDMDRVINS pDrvIns)
    … …  
    17631762
    17641763/**
    1765  * @copydoc PDMDRVHLP::pfnThreadCreate
     1764 * @copydoc PDMDRVHLPR3::pfnThreadCreate
    17661765 */
    17671766DECLINLINE(int) PDMDrvHlpThreadCreate(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
    … …  
    17731772# ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
    17741773/**
    1775  * @copydoc PDMDRVHLP::pfnAsyncCompletionTemplateCreate
     1774 * @copydoc PDMDRVHLPR3::pfnAsyncCompletionTemplateCreate
    17761775 */
    17771776DECLINLINE(int) PDMDrvHlpAsyncCompletionTemplateCreate(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate,
    … …  
    17841783# ifdef VBOX_WITH_NETSHAPER
    17851784/**
    1786  * @copydoc PDMDRVHLP::pfnNetShaperAttach
     1785 * @copydoc PDMDRVHLPR3::pfnNetShaperAttach
    17871786 */
    17881787DECLINLINE(int) PDMDrvHlpNetShaperAttach(PPDMDRVINS pDrvIns, const char *pcszBwGroup, PPDMNSFILTER pFilter)
    … …  
    17921791
    17931792/**
    1794  * @copydoc PDMDRVHLP::pfnNetShaperDetach
     1793 * @copydoc PDMDRVHLPR3::pfnNetShaperDetach
    17951794 */
    17961795DECLINLINE(int) PDMDrvHlpNetShaperDetach(PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter)
    … …  
    18011800
    18021801/**
    1803  * @copydoc PDMDRVHLP::pfnCritSectInit
     1802 * @copydoc PDMDRVHLPR3::pfnCritSectInit
    18041803 */
    18051804DECLINLINE(int) PDMDrvHlpCritSectInit(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, RT_SRC_POS_DECL, const char *pszName)
    … …  
    18091808
    18101809/**
    1811  * @copydoc PDMDRVHLP::pfnCallR0
     1810 * @copydoc PDMDRVHLPR3::pfnCallR0
    18121811 */
    18131812DECLINLINE(int) PDMDrvHlpCallR0(PPDMDRVINS pDrvIns, uint32_t uOperation, uint64_t u64Arg)
    … …  
    18171816
    18181817/**
    1819  * @copydoc PDMDRVHLP::pfnBlkCacheRetain
     1818 * @copydoc PDMDRVHLPR3::pfnBlkCacheRetain
    18201819 */
    18211820DECLINLINE(int) PDMDrvHlpBlkCacheRetain(PPDMDRVINS pDrvIns, PPPDMBLKCACHE ppBlkCache,
    … …  
    18291828
    18301829/**
    1831  * @copydoc PDMDRVHLP::pfnVMGetSuspendReason
     1830 * @copydoc PDMDRVHLPR3::pfnVMGetSuspendReason
    18321831 */
    18331832DECLINLINE(VMSUSPENDREASON) PDMDrvHlpVMGetSuspendReason(PPDMDRVINS pDrvIns)
    … …  
    18371836
    18381837/**
    1839  * @copydoc PDMDRVHLP::pfnVMGetResumeReason
     1838 * @copydoc PDMDRVHLPR3::pfnVMGetResumeReason
    18401839 */
    18411840DECLINLINE(VMRESUMEREASON) PDMDrvHlpVMGetResumeReason(PPDMDRVINS pDrvIns)

  • trunk/include/VBox/vmm/pdmnetifs.h

    r56291 r58106  
    337337    /** @copydoc PDMINETWORKUP::pfnSendBuf */
    338338    DECLR0CALLBACKMEMBER(int,  pfnSendBuf,(PPDMINETWORKUPR0 pInterface, PPDMSCATTERGATHER pSgBuf, bool fOnWorkerThread));
    339     /** @copydoc PDMINETWORKUP::pfnEndBuf */
     339    /** @copydoc PDMINETWORKUP::pfnEndXmit */
    340340    DECLR0CALLBACKMEMBER(void, pfnEndXmit,(PPDMINETWORKUPR0 pInterface));
    341341    /** @copydoc PDMINETWORKUP::pfnSetPromiscuousMode */
    … …  
    355355    /** @copydoc PDMINETWORKUP::pfnSendBuf */
    356356    DECLRCCALLBACKMEMBER(int,  pfnSendBuf,(PPDMINETWORKUPRC pInterface, PPDMSCATTERGATHER pSgBuf, bool fOnWorkerThread));
    357     /** @copydoc PDMINETWORKUP::pfnEndBuf */
     357    /** @copydoc PDMINETWORKUP::pfnEndXmit */
    358358    DECLRCCALLBACKMEMBER(void, pfnEndXmit,(PPDMINETWORKUPRC pInterface));
    359359    /** @copydoc PDMINETWORKUP::pfnSetPromiscuousMode */

  • trunk/include/VBox/vmm/pdmnetinline.h

    r56291 r58106  
    198198 * @returns Offset of the IPv6 header.
    199199 * @param   pbSegHdrs           The headers / frame start.
    200  * @param   offIpHdr            The offset of the IPv4 header.
     200 * @param   offIPv4Hdr          The offset of the IPv4 header.
    201201 */
    202202DECLINLINE(uint8_t) pgmNetGsoCalcIpv6Offset(uint8_t *pbSegHdrs, uint8_t offIPv4Hdr)
    … …  
    360360 * @param   cbSegPayload        The amount of segmented payload.
    361361 * @param   offFragment         The offset of this fragment for reassembly.
    362  * @param   iSeg                The segment index.
    363362 * @param   cbHdrs              The size of all the headers.
    364363 * @param   fLastFragment       True if this is the last fragment of datagram.

  • trunk/include/VBox/vmm/pdmusb.h

    r57006 r58106  
    622622     * @param   pUsbIns             The USB device instance.
    623623     * @param   rc                  VBox status code.
    624      * @param   RT_SRC_POS_DECL     Use RT_SRC_POS.
     624     * @param   SRC_POS             Use RT_SRC_POS.
    625625     * @param   pszFormat           Error message format string.
    626626     * @param   va                  Error message arguments.
    … …  
    658658     *
    659659     * @returns VBox status code.
    660      * @param   pDevIns             The device instance.
     660     * @param   pUsbIns             The USB device instance.
    661661     * @param   ppThread            Where to store the thread 'handle'.
    662662     * @param   pvUser              The user argument to the thread function.
    … …  
    678678     *
    679679     * @returns VBox status code.
    680      * @param   pUSBIns             The USB device instance.
     680     * @param   pUsbIns             The USB device instance.
    681681     * @param   pfnAsyncNotify      The callback.
    682682     * @thread  EMT(0)
    … …  
    690690     * This can be called at any time, spurious calls will simply be ignored.
    691691     *
    692      * @param   pUSBIns             The USB device instance.
     692     * @param   pUsbIns             The USB device instance.
    693693     * @thread  Any
    694694     */
    … …  
    892892 * @returns VBox status code which must be passed up to the VMM.
    893893 * @param   pUsbIns             Device instance.
    894  * @param   RT_SRC_POS_DECL     Use RT_SRC_POS.
     894 * @param   SRC_POS             Use RT_SRC_POS.
    895895 * @param   pszFormat           Message. (optional)
    896896 * @param   ...                 Message parameters.
    … …  
    927927 */
    928928DECLINLINE(int) PDMUsbHlpThreadCreate(PPDMUSBINS pUsbIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADUSB pfnThread,
    929                                          PFNPDMTHREADWAKEUPUSB pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName)
     929                                      PFNPDMTHREADWAKEUPUSB pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName)
    930930{
    931931    return pUsbIns->pHlpR3->pfnThreadCreate(pUsbIns, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName);
    … …  
    955955 * @param   pUsbIns             The USB device instance.
    956956 * @param   rc                  VBox status code.
    957  * @param   RT_SRC_POS_DECL     Use RT_SRC_POS.
     957 * @param   SRC_POS             Use RT_SRC_POS.
    958958 * @param   pszFormat           Error message format string.
    959959 * @param   ...                 Error message arguments.

  • trunk/include/VBox/vmm/stam.h

    r57570 r58106  
    343343
    344344
    345 /** @def STAM_REL_U16_INC
     345/** @def STAM_REL_U16_ADD
    346346 * Increments a uint16_t sample by a value.
    347347 *
    … …  
    355355# define STAM_REL_U16_ADD(pCounter, Addend) do { } while (0)
    356356#endif
    357 /** @def STAM_U16_INC
     357/** @def STAM_U16_ADD
    358358 * Increments a uint16_t sample by a value.
    359359 *
    … …  
    637637 * Adds a period.
    638638 *
    639  * @param   pProfileAdv     Pointer to the STAMPROFILEADV structure to operate on.
     639 * @param   pProfile        Pointer to the STAMPROFILE structure to operate on.
    640640 * @param   cTicksInPeriod  The number of tick (or whatever) of the preiod
    641641 *                          being added.  This is only referenced once.
    … …  
    658658 * Adds a period.
    659659 *
    660  * @param   pProfileAdv     Pointer to the STAMPROFILEADV structure to operate on.
     660 * @param   pProfile        Pointer to the STAMPROFILE structure to operate on.
    661661 * @param   cTicksInPeriod  The number of tick (or whatever) of the preiod
    662662 *                          being added.  This is only referenced once.
    … …  
    903903 * sample.
    904904 *
    905  * @param   pProfileAdv Pointer to the STAMPROFILEADV structure to operate on.
    906  * @param   Prefix      Identifier prefix used to internal variables.
     905 * @param   pProfileAdv1    Pointer to the STAMPROFILEADV structure to stop.
     906 * @param   pProfileAdv2    Pointer to the STAMPROFILEADV structure to start.
     907 * @param   Prefix          Identifier prefix used to internal variables.
    907908 */
    908909#ifdef VBOX_WITH_STATISTICS

  • trunk/include/VBox/vmm/vm.h

    r57989 r58106  
    581581#define VM_FF_IS_PENDING(pVM, fFlags)       RT_BOOL((pVM)->fGlobalForcedActions & (fFlags))
    582582
    583 /** @def VM_FF_TESTANDCLEAR
     583/** @def VM_FF_TEST_AND_CLEAR
    584584 * Checks if one (!) force action in the specified set is pending and clears it atomically
    585585 *
    … …  
    591591#define VM_FF_TEST_AND_CLEAR(pVM, iBit)     (ASMAtomicBitTestAndClear(&(pVM)->fGlobalForcedActions, iBit##_BIT))
    592592
    593 /** @def VMCPU_FF_TESTANDCLEAR
     593/** @def VMCPU_FF_TEST_AND_CLEAR
    594594 * Checks if one (!) force action in the specified set is pending and clears it atomically
    595595 *
    … …  
    926926    /** @} */
    927927
    928     /** Alignment padding.. */
     928    /** Alignment padding. */
    929929    uint8_t                     uPadding1[2];
    930930
    … …  
    940940
    941941#if HC_ARCH_BITS == 32
    942     /** Alignment padding.. */
     942    /** Alignment padding. */
    943943    uint32_t                    uPadding2;
    944944#endif

  • trunk/include/VBox/vmm/vmcpuset.h

    r53794 r58106  
    3737 */
    3838
    39 /** Tests if a valid CPU ID is present in the set.. */
     39/** Tests if a valid CPU ID is present in the set. */
    4040#define VMCPUSET_IS_PRESENT(pSet, idCpu)    ASMBitTest( &(pSet)->au32Bitmap[0], (idCpu))
    4141/** Adds a CPU to the set. */

  • trunk/include/VBox/vmm/vmm.h

    r56286 r58106  
    247247 *
    248248 * @returns @c true / @c false
    249  * @param   pVCpu           The caller's cross context virtual CPU structure.
     249 * @param   a_pVCpu     The caller's cross context virtual CPU structure.
    250250 * @thread  EMT
    251251 * @sa      VMMR0IsLongJumpArmed

  • trunk/include/VBox/vscsi.h

    r56439 r58106  
    208208 *
    209209 * @returns VBox status code.
    210  * @param   hScsiDevice    The SCSI device handle to destroy.
     210 * @param   hVScsiDevice   The SCSI device handle to destroy.
    211211 */
    212212VBOXDDU_DECL(int) VSCSIDeviceDestroy(VSCSIDEVICE hVScsiDevice);
    … …  
    216216 *
    217217 * @returns VBox status code.
    218  * @param   hScsiDevice    The SCSI device handle to add the LUN to.
    219  * @param   hScsiLun       The LUN handle to add.
     218 * @param   hVScsiDevice   The SCSI device handle to add the LUN to.
     219 * @param   hVScsiLun      The LUN handle to add.
    220220 * @param   iLun           The LUN number.
    221221 */
    … …  
    257257 *
    258258 * @returns VBox status code.
    259  * @param   phVScsiDevice     The SCSI device handle.
     259 * @param   hVScsiDevice      The SCSI device handle.
    260260 * @param   phVScsiReq        Where to SCSI request handle.
    261261 * @param   iLun              The LUN the request is for.

  • trunk/include/VBox/vusb.h

    r56454 r58106  
    680680     *
    681681     * @param   pInterface  Pointer to this struct.
     682     * @param   pDevice     Pointer to a USB device.
    682683     * @param   cMillies    Number of milliseconds to poll for completion.
    683684     */
    … …  
    720721     * @returns VBox status code.
    721722     * @param   pInterface  Pointer to this struct.
    722      * @param   pDevice     Pointer to the device (interface) attach.
     723     * @param   pDevice     Pointer to the device (interface) to attach.
    723724     */
    724725    DECLR3CALLBACKMEMBER(int, pfnAttachDevice,(PVUSBIROOTHUBCONNECTOR pInterface, PVUSBIDEVICE pDevice));
    … …  
    969970
    970971/**
    971  * @copydoc VUSBIDEVICE::pfnIsSaveStateSupported
     972 * @copydoc VUSBIDEVICE::pfnIsSavedStateSupported
    972973 */
    973974DECLINLINE(bool) VUSBIDevIsSavedStateSupported(PVUSBIDEVICE pInterface)

  • trunk/include/iprt/asn1.h

    r57926 r58106  
    20112011 *
    20122012 * @returns true / false
    2013  * @param   pCursor         The cursore we're decoding from.
     2013 * @param   pCursor         The cursor we're decoding from.
    20142014 * @remarks May produce error info output on mismatch.
    20152015 */
    … …  
    20242024 *
    20252025 * @returns true / false
    2026  * @param   pCursor         The cursore we're decoding from.
     2026 * @param   pCursor         The cursor we're decoding from.
    20272027 * @remarks May produce error info output on mismatch.
    20282028 */

  • trunk/src/VBox/Main/src-server/ApplianceImplImport.cpp

    r58005 r58106  
    10251025
    10261026                    vrc = VDInterfaceAdd(&pFileIo->Core, name.c_str(),
    1027                                              VDINTERFACETYPE_IO, 0, sizeof(VDINTERFACEIO),
    1028                                              &storage.pVDImageIfaces);
     1027                                         VDINTERFACETYPE_IO, 0, sizeof(VDINTERFACEIO),
     1028                                         &storage.pVDImageIfaces);
    10291029                    if (RT_FAILURE(vrc))
    10301030                        throw setError(VBOX_E_IPRT_ERROR, "Creation of the VD interface failed (%Rrc)", vrc);

  • trunk/src/VBox/Runtime/testcase/tstIprtList.cpp

    r57358 r58106  
    339339
    340340    /*
    341      * setCapacitiy
     341     * setCapacity
    342342     */
    343343    testList.setCapacity(cTestItems * 5);

  • trunk/src/VBox/VMM/VMMR3/PDMBlkCache.cpp

    r57389 r58106  
    19241924
    19251925VMMR3DECL(int) PDMR3BlkCacheRead(PPDMBLKCACHE pBlkCache, uint64_t off,
    1926                                  PCRTSGBUF pcSgBuf, size_t cbRead, void *pvUser)
     1926                                 PCRTSGBUF pSgBuf, size_t cbRead, void *pvUser)
    19271927{
    19281928    int rc = VINF_SUCCESS;
    … …  
    19311931    PPDMBLKCACHEREQ    pReq;
    19321932
    1933     LogFlowFunc((": pBlkCache=%#p{%s} off=%llu pcSgBuf=%#p cbRead=%u pvUser=%#p\n",
    1934                  pBlkCache, pBlkCache->pszId, off, pcSgBuf, cbRead, pvUser));
     1933    LogFlowFunc((": pBlkCache=%#p{%s} off=%llu pSgBuf=%#p cbRead=%u pvUser=%#p\n",
     1934                 pBlkCache, pBlkCache->pszId, off, pSgBuf, cbRead, pvUser));
    19351935
    19361936    AssertPtrReturn(pBlkCache, VERR_INVALID_POINTER);
    … …  
    19381938
    19391939    RTSGBUF SgBuf;
    1940     RTSgBufClone(&SgBuf, pcSgBuf);
     1940    RTSgBufClone(&SgBuf, pSgBuf);
    19411941
    19421942    /* Allocate new request structure. */
    … …  
    21442144}
    21452145
    2146 VMMR3DECL(int) PDMR3BlkCacheWrite(PPDMBLKCACHE pBlkCache, uint64_t off,
    2147                                   PCRTSGBUF pcSgBuf, size_t cbWrite, void *pvUser)
     2146VMMR3DECL(int) PDMR3BlkCacheWrite(PPDMBLKCACHE pBlkCache, uint64_t off, PCRTSGBUF pSgBuf, size_t cbWrite, void *pvUser)
    21482147{
    21492148    int rc = VINF_SUCCESS;
    … …  
    21522151    PPDMBLKCACHEREQ pReq;
    21532152
    2154     LogFlowFunc((": pBlkCache=%#p{%s} off=%llu pcSgBuf=%#p cbWrite=%u pvUser=%#p\n",
    2155                  pBlkCache, pBlkCache->pszId, off, pcSgBuf, cbWrite, pvUser));
     2153    LogFlowFunc((": pBlkCache=%#p{%s} off=%llu pSgBuf=%#p cbWrite=%u pvUser=%#p\n",
     2154                 pBlkCache, pBlkCache->pszId, off, pSgBuf, cbWrite, pvUser));
    21562155
    21572156    AssertPtrReturn(pBlkCache, VERR_INVALID_POINTER);
    … …  
    21592158
    21602159    RTSGBUF SgBuf;
    2161     RTSgBufClone(&SgBuf, pcSgBuf);
     2160    RTSgBufClone(&SgBuf, pSgBuf);
    21622161
    21632162    /* Allocate new request structure. */
    … …  
    21802179
    21812180            uint64_t offDiff = off - pEntry->Core.Key;
    2182 
    2183             AssertMsg(off >= pEntry->Core.Key,
    2184                       ("Overflow in calculation off=%llu OffsetAligned=%llu\n",
    2185                       off, pEntry->Core.Key));
     2181            AssertMsg(off >= pEntry->Core.Key, ("Overflow in calculation off=%llu OffsetAligned=%llu\n", off, pEntry->Core.Key));
    21862182
    21872183            cbToWrite = RT_MIN(pEntry->cbData - offDiff, cbWrite);

  • trunk/src/VBox/VMM/include/HMInternal.h

    r57884 r58106  
    4949/** @def HM_PROFILE_EXIT_DISPATCH
    5050 * Enables profiling of the VM exit handler dispatching. */
    51 #if 0
     51#if 0 || defined(DOXYGEN_RUNNING)
    5252# define HM_PROFILE_EXIT_DISPATCH
    5353#endif
    … …  
    127127
    128128
    129 /** Resets/initializes the VM-exit/#VMEXIT history array. */
     129/** Resets/initializes the VM-exit/\#VMEXIT history array. */
    130130#define HMCPU_EXIT_HISTORY_RESET(pVCpu)           (memset(&(pVCpu)->hm.s.auExitHistory, 0xff, sizeof((pVCpu)->hm.s.auExitHistory)))
    131131
    132 /** Updates the VM-exit/#VMEXIT history array. */
     132/** Updates the VM-exit/\#VMEXIT history array. */
    133133#define HMCPU_EXIT_HISTORY_ADD(pVCpu, a_ExitReason) \
    134134    do { \
    … …  
    623623    /** Whether we're using the hyper DR7 or guest DR7. */
    624624    bool                        fUsingHyperDR7;
    625     /** Whether to preload the guest-FPU state to avoid #NM VM-exit overhead. */
     625    /** Whether to preload the guest-FPU state to avoid \#NM VM-exit overhead. */
    626626    bool                        fPreloadGuestFpu;
    627627    /** Set if XCR0 needs to be loaded and saved when entering and exiting guest
    … …  
    629629    bool                        fLoadSaveGuestXcr0;
    630630
    631     /** Whether #UD needs to be intercepted (required by certain GIM providers). */
     631    /** Whether \#UD needs to be intercepted (required by certain GIM providers). */
    632632    bool                        fGIMTrapXcptUD;
    633633    /** Whether paravirt. hypercalls are enabled. */
    … …  
    871871    RTCPUID                 idEnteredCpu;
    872872
    873     /** VT-x/AMD-V VM-exit/#VMXEXIT history, circular array. */
     873    /** VT-x/AMD-V VM-exit/\#VMXEXIT history, circular array. */
    874874    uint16_t                auExitHistory[31];
    875875    /** The index of the next free slot in the history array. */
    … …  
    903903    STAMCOUNTER             StatExitShadowNM;
    904904    STAMCOUNTER             StatExitGuestNM;
    905     STAMCOUNTER             StatExitShadowPF;       /* Misleading, currently used for MMIO #PFs as well. */
     905    STAMCOUNTER             StatExitShadowPF;       /**< Misleading, currently used for MMIO \#PFs as well. */
    906906    STAMCOUNTER             StatExitShadowPFEM;
    907907    STAMCOUNTER             StatExitGuestPF;

  • trunk/src/VBox/VMM/include/PDMInternal.h

    r56402 r58106  
    294294    PVMRC                           pVMRC;
    295295    /** Set if this critical section is the automatically created default
    296      * section of a device.. */
     296     * section of a device. */
    297297    bool                            fAutomaticDefaultCritsect;
    298298    /** Set if the critical section is used by a timer or similar.
    … …  
    689689    /** @copydoc PDMPCIBUSREG::pfnRegisterR3 */
    690690    DECLR3CALLBACKMEMBER(int,       pfnRegisterR3,(PPDMDEVINS pDevIns, PPCIDEVICE pPciDev, const char *pszName, int iDev));
    691     /** @copydoc PDMPCIBUSREG::pfnPCIRegisterMsiR3 */
     691    /** @copydoc PDMPCIBUSREG::pfnRegisterMsiR3 */
    692692    DECLR3CALLBACKMEMBER(int,       pfnRegisterMsiR3,(PPDMDEVINS pDevIns, PPCIDEVICE pPciDev, PPDMMSIREG pMsiReg));
    693693    /** @copydoc PDMPCIBUSREG::pfnIORegionRegisterR3 */
    … …  
    977977        } SetIRQ;
    978978
    979         /** Expanding the structure.. */
     979        /** Expanding the structure. */
    980980        uint64_t    au64[2];
    981981    } u;

  • trunk/src/VBox/VMM/include/PGMInternal.h

    r57446 r58106  
    152152/** @def VBOX_WITH_NEW_LAZY_PAGE_ALLOC
    153153 * Enables the experimental lazy page allocation code. */
    154 /*#define VBOX_WITH_NEW_LAZY_PAGE_ALLOC */
     154#ifdef DOXYGEN_RUNNING
     155# define VBOX_WITH_NEW_LAZY_PAGE_ALLOC
     156#endif
    155157
    156158/** @def VBOX_WITH_REAL_WRITE_MONITORED_PAGES
    157159 * Enables real write monitoring of pages, i.e. mapping them read-only and
    158  * only making them writable when getting a write access #PF. */
     160 * only making them writable when getting a write access \#PF. */
    159161#define VBOX_WITH_REAL_WRITE_MONITORED_PAGES
    160162
    … …  
    876878 * Initializes the page structure.
    877879 * @param   a_pPage     Pointer to the physical guest page tracking structure.
     880 * @param   a_HCPhys    The host physical address of the page.
     881 * @param   a_idPage    The (GMM) page ID of the page.
     882 * @param   a_uType     The page type (PGMPAGETYPE).
     883 * @param   a_uState    The page state (PGM_PAGE_STATE_XXX).
    878884 */
    879885#define PGM_PAGE_INIT(a_pPage, a_HCPhys, a_idPage, a_uType, a_uState) \
    … …  
    15531559 *
    15541560 * @returns RAM range TLB index.
    1555  * @param   GCPhys      The guest physical address.
     1561 * @param   a_GCPhys    The guest physical address.
    15561562 */
    15571563#define PGM_RAMRANGE_TLB_IDX(a_GCPhys)      ( ((a_GCPhys) >> 20) & (PGM_RAMRANGE_TLB_ENTRIES - 1) )
    … …  
    20742080/** @typedef PPPGMPAGEMAP
    20752081 * Pointer to a page mapper unit pointer for current context. */
    2076 #ifdef IN_RC
     2082#if defined(IN_RC) && !defined(DOXYGEN_RUNNING)
    20772083// typedef PPGMPAGEGCMAPTLB               PPGMPAGEMAPTLB;
    20782084// typedef PPGMPAGEGCMAPTLBE              PPGMPAGEMAPTLBE;
    … …  
    37173723    STAMCOUNTER StatRZSyncPagePDOutOfSync;          /**< RC/R0: The number of time we've encountered an out-of-sync PD in SyncPage. */
    37183724    STAMCOUNTER StatRZAccessedPage;                 /**< RC/R0: The number of pages marked not present for accessed bit emulation. */
    3719     STAMPROFILE StatRZDirtyBitTracking;             /**< RC/R0: Profiling the dirty bit tracking in CheckPageFault().. */
     3725    STAMPROFILE StatRZDirtyBitTracking;             /**< RC/R0: Profiling the dirty bit tracking in CheckPageFault(). */
    37203726    STAMCOUNTER StatRZDirtyPage;                    /**< RC/R0: The number of pages marked read-only for dirty bit tracking. */
    37213727    STAMCOUNTER StatRZDirtyPageBig;                 /**< RC/R0: The number of pages marked read-only for dirty bit tracking. */
    … …  
    38013807 * Converts a PGMCPU pointer into a VM pointer.
    38023808 * @returns Pointer to the VM structure the PGM is part of.
    3803  * @param   pPGM   Pointer to PGMCPU instance data.
     3809 * @param   pPGM    Pointer to PGMCPU instance data.
    38043810 */
    38053811#define PGMCPU2VM(pPGM)         ( (PVM)((char*)(pPGM) - (pPGM)->offVM) )
    … …  
    38083814 * Converts a PGMCPU pointer into a PGM pointer.
    38093815 * @returns Pointer to the VM structure the PGM is part of.
    3810  * @param   pPGM  Pointer to PGMCPU instance data.
     3816 * @param   pPGMCpu Pointer to PGMCPU instance data.
    38113817 */
    38123818#define PGMCPU2PGM(pPGMCpu)     ( (PPGM)((char *)(pPGMCpu) - (pPGMCpu)->offPGM) )

  • trunk/src/VBox/VMM/include/TRPMInternal.h

    r56287 r58106  
    7676 * Converts a TRPM pointer into a VM pointer.
    7777 * @returns Pointer to the VM structure the TRPM is part of.
    78  * @param   pTRPM   Pointer to TRPM instance data.
     78 * @param   pTRPM       Pointer to TRPM instance data.
    7979 */
    8080#define TRPM_2_VM(pTRPM)            ( (PVM)((uint8_t *)(pTRPM) - (pTRPM)->offVM) )
    … …  
    8484 * Converts a TRPM pointer into a TRPMCPU pointer.
    8585 * @returns Pointer to the VM structure the TRPMCPU is part of.
    86  * @param   pTRPM   Pointer to TRPMCPU instance data.
     86 * @param   pTrpmCpu    Pointer to TRPMCPU instance data.
    8787 * @remarks Raw-mode only, not SMP safe.
    8888 */
    … …  
    109109     * This configuration option is provided for speeding up guest like Solaris
    110110     * that put the IDT on the same page as a whole lot of other data that is
    111      * frequently updated. The updates will cause #PFs and have to be interpreted
     111     * frequently updated. The updates will cause \#PFs and have to be interpreted
    112112     * by PGMInterpretInstruction which is slow compared to raw execution.
    113113     *
    … …  
    115115     * there is no problem with dropping the IDT monitoring.
    116116     *
    117      * @cfgm    /TRPM/SafeToDropGuestIDTMonitoring   boolean     defaults to false.
     117     * @cfgm{/TRPM/SafeToDropGuestIDTMonitoring, boolean, defaults to false.}
    118118     */
    119119    bool                    fSafeToDropGuestIDTMonitoring;
    … …  
    162162
    163163    STAMPROFILE             StatTrap0dDisasm;
    164     STAMCOUNTER             StatTrap0dRdTsc;    /**< Number of RDTSC #GPs. */
     164    STAMCOUNTER             StatTrap0dRdTsc;    /**< Number of RDTSC \#GPs. */
    165165
    166166#ifdef VBOX_WITH_STATISTICS
    … …  
    185185 * Converts a TRPMCPU pointer into a VM pointer.
    186186 * @returns Pointer to the VM structure the TRPMCPU is part of.
    187  * @param   pTRPM   Pointer to TRPMCPU instance data.
     187 * @param   pTrpmCpu    Pointer to TRPMCPU instance data.
    188188 */
    189189#define TRPMCPU_2_VM(pTrpmCpu)      ( (PVM)((uint8_t *)(pTrpmCpu) - (pTrpmCpu)->offVM) )
    … …  
    192192 * Converts a TRPMCPU pointer into a VMCPU pointer.
    193193 * @returns Pointer to the VMCPU structure the TRPMCPU is part of.
    194  * @param   pTRPM   Pointer to TRPMCPU instance data.
     194 * @param   pTrpmCpu    Pointer to TRPMCPU instance data.
    195195 */
    196196#define TRPMCPU_2_VMCPU(pTrpmCpu)   ( (PVMCPU)((uint8_t *)(pTrpmCpu) - (pTrpmCpu)->offVMCpu) )
    … …  
    240240    RTGCUINT                uPrevVector;
    241241
    242     /** Instruction length for software interrupts and software exceptions (#BP,
    243      *  #OF) */
     242    /** Instruction length for software interrupts and software exceptions
     243     * (\#BP, \#OF) */
    244244    uint8_t                 cbInstr;
    245245

  • trunk/src/VBox/VMM/include/VMMInternal.h

    r57446 r58106  
    5050 * Ring-0 logging isn't 100% safe yet (thread id reuse / process exit cleanup),
    5151 * so you have to sign up here by adding your defined(DEBUG_<userid>) to the
    52  * #if, or by adding VBOX_WITH_R0_LOGGING to your LocalConfig.kmk.
     52 * \#if, or by adding VBOX_WITH_R0_LOGGING to your LocalConfig.kmk.
    5353 */
    5454#if defined(DEBUG_sandervl) || defined(DEBUG_frank) || defined(DEBUG_ramshankar) || defined(DOXYGEN_RUNNING)
    … …  
    514514    /** Switching testing and profiling stub. */
    515515    VMMRC_DO_TESTCASE_NOP,
    516     /** Testcase for checking interrupt masking.. */
     516    /** Testcase for checking interrupt masking. */
    517517    VMMRC_DO_TESTCASE_INTERRUPT_MASKING,
    518518    /** Switching testing and profiling stub. */
    … …  
    585585 * @param   pfn         The function to be called when not resuming..
    586586 * @param   pVM         The argument of that function.
     587 * @param   pVCpu       The VCPU of the calling EMT.
    587588 */
    588589DECLASM(int)    vmmR0CallRing3SetJmp(PVMMR0JMPBUF pJmpBuf, PFNVMMR0SETJMP pfn, PVM pVM, PVMCPU pVCpu);

  • trunk/src/recompiler/VBoxRecompiler.c

    r57358 r58106  
    35253525 * @param   addr        The virtual address.
    35263526 * @param   pTLBEntry   The TLB entry.
     3527 * @param   IoTlbEntry  The I/O TLB entry address.
    35273528 */
    35283529target_ulong remR3PhysGetPhysicalAddressCode(CPUX86State       *env,
    35293530                                             target_ulong       addr,
    35303531                                             CPUTLBEntry       *pTLBEntry,
    3531                                              target_phys_addr_t ioTLBEntry)
     3532                                             target_phys_addr_t IoTlbEntry)
    35323533{
    35333534    PVM pVM = env->pVM;
    35343535
    3535     if ((ioTLBEntry & ~TARGET_PAGE_MASK) == pVM->rem.s.iHandlerMemType)
     3536    if ((IoTlbEntry & ~TARGET_PAGE_MASK) == pVM->rem.s.iHandlerMemType)
    35363537    {
    35373538        /* If code memory is being monitored, appropriate IOTLB entry will have
    35383539           handler IO type, and addend will provide real physical address, no
    35393540           matter if we store VA in TLB or not, as handlers are always passed PA */
    3540         target_ulong ret = (ioTLBEntry & TARGET_PAGE_MASK) + addr;
     3541        target_ulong ret = (IoTlbEntry & TARGET_PAGE_MASK) + addr;
    35413542        return ret;
    35423543    }
    35433544    LogRel(("\nTrying to execute code with memory type addr_code=%RGv addend=%RGp at %RGv! (iHandlerMemType=%#x iMMIOMemType=%#x IOTLB=%RGp)\n"
    35443545            "*** handlers\n",
    3545             (RTGCPTR)pTLBEntry->addr_code, (RTGCPHYS)pTLBEntry->addend, (RTGCPTR)addr, pVM->rem.s.iHandlerMemType, pVM->rem.s.iMMIOMemType, (RTGCPHYS)ioTLBEntry));
     3546            (RTGCPTR)pTLBEntry->addr_code, (RTGCPHYS)pTLBEntry->addend, (RTGCPTR)addr, pVM->rem.s.iHandlerMemType, pVM->rem.s.iMMIOMemType, (RTGCPHYS)IoTlbEntry));
    35463547    DBGFR3Info(pVM->pUVM, "handlers", NULL, DBGFR3InfoLogRelHlp());
    35473548    LogRel(("*** mmio\n"));
    … …  
    40944095 * @param   cb              Size of the code block.
    40954096 */
    4096 void disas(FILE *phFile, void *pvCode, unsigned long cb)
     4097void disas(FILE *phFileIgnored, void *pvCode, unsigned long cb)
    40974098{
    40984099    if (LogIs2Enabled())
    … …  
    41344135 * @param   fFlags          Flags, probably something which tells if this is 16, 32 or 64 bit code.
    41354136 */
    4136 void target_disas(FILE *phFile, target_ulong uCode, target_ulong cb, int fFlags)
     4137void target_disas(FILE *phFileIgnored, target_ulong uCode, target_ulong cb, int fFlags)
    41374138{
    41384139    if (LogIs2Enabled())
    … …  
    45834584 * @retval -1 failure, raise \#GP(0).
    45844585 * @param   env     The cpu state.
    4585  * @param   idMsr   The MSR to read.
    4586  * @param   puValue Where to return the value.
     4586 * @param   idMsr   The MSR to write to.
     4587 * @param   uValue  The value to write.
    45874588 */
    45884589int cpu_wrmsr(CPUX86State *env, uint32_t idMsr, uint64_t uValue)
    … …  
    47174718 * @param   idx         The CPUID leaf (eax).
    47184719 * @param   idxSub      The CPUID sub-leaf (ecx) where applicable.
    4719  * @param   pvEAX       Where to store eax.
    4720  * @param   pvEBX       Where to store ebx.
    4721  * @param   pvECX       Where to store ecx.
    4722  * @param   pvEDX       Where to store edx.
     4720 * @param   pEAX        Where to store eax.
     4721 * @param   pEBX        Where to store ebx.
     4722 * @param   pECX        Where to store ecx.
     4723 * @param   pEDX        Where to store edx.
    47234724 */
    47244725void cpu_x86_cpuid(CPUX86State *env, uint32_t idx, uint32_t idxSub,
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