VirtualBox

Changeset 53615 in vbox


Ignore:
Timestamp:
Dec 31, 2014 1:53:47 AM (10 years ago)
Author:
vboxsync
Message:

doxygen fixes.

Location:
trunk/include
Files:
43 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/VBox/VBoxGuest.h

    r52867 r53615  
    66
    77/*
    8  * Copyright (C) 2006-2012 Oracle Corporation
     8 * Copyright (C) 2006-2015 Oracle Corporation
    99 *
    1010 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    4040 */
    4141
    42 /** @todo it would be nice if we could have two define without paths. */
     42/** @todo It would be nice if we could have two defines without paths. */
    4343
    4444/** @def VBOXGUEST_DEVICE_NAME
    … …  
    8181#ifdef RT_OS_DARWIN
    8282/** Cookie used to fend off some unwanted clients to the IOService. */
    83 #define VBOXGUEST_DARWIN_IOSERVICE_COOKIE   0x56426F78 /* 'VBox' */
     83# define VBOXGUEST_DARWIN_IOSERVICE_COOKIE      UINT32_C(0x56426f78) /* 'VBox' */
    8484#endif
    8585
    8686#if !defined(IN_RC) && !defined(IN_RING0_AGNOSTIC) && !defined(IPRT_NO_CRT)
     87
    8788/** @name VBoxGuest IOCTL codes and structures.
    8889 *
    … …  
    360361/** @name IOCTL numbers that 32-bit clients, like the Windows OpenGL guest
    361362 *        driver, will use when taking to a 64-bit driver.
    362  * @remarks These are only used by the driver implementation! */
     363 * @remarks These are only used by the driver implementation!
     364 * @{*/
    363365#  define VBOXGUEST_IOCTL_HGCM_CONNECT_32           VBOXGUEST_IOCTL_CODE_32(16, sizeof(VBoxGuestHGCMConnectInfo))
    364366#  define VBOXGUEST_IOCTL_HGCM_DISCONNECT_32        VBOXGUEST_IOCTL_CODE_32(17, sizeof(VBoxGuestHGCMDisconnectInfo))
    … …  
    548550#endif /* RT_OS_LINUX || RT_OS_SOLARIS || RT_OS_FREEBSD */
    549551
     552#endif /* !defined(IN_RC) && !defined(IN_RING0_AGNOSTIC) && !defined(IPRT_NO_CRT) */
     553
    550554/** @} */
    551 #endif /* !defined(IN_RC) && !defined(IN_RING0_AGNOSTIC) && !defined(IPRT_NO_CRT) */
    552 
    553 #endif
    554 
     555
     556#endif
     557

  • trunk/include/VBox/param.h

    r44528 r53615  
    66
    77/*
    8  * Copyright (C) 2006-2011 Oracle Corporation
     8 * Copyright (C) 2006-2015 Oracle Corporation
    99 *
    1010 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    5353
    5454/** @defgroup   grp_vbox_param_mm  Memory Monitor Parameters
    55  * @ingroup grp_vbox_param
    5655 * @{
    5756 */
    … …  
    9089
    9190/** @defgroup   grp_vbox_param_pgm  Page Manager Parameters
    92  * @ingroup grp_vbox_param
    9391 * @{
    9492 */
    … …  
    124122
    125123/** @defgroup   grp_vbox_param_vmm  VMM Parameters
    126  * @ingroup grp_vbox_param
    127124 * @{
    128125 */

  • trunk/include/VBox/sup.h

    r53441 r53615  
    44
    55/*
    6  * Copyright (C) 2006-2014 Oracle Corporation
     6 * Copyright (C) 2006-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    703703
    704704/** @defgroup   grp_sup_r3     SUP Host Context Ring-3 API
    705  * @ingroup grp_sup
    706705 * @{
    707706 */
    … …  
    16501649#ifdef IN_RING0
    16511650/** @defgroup   grp_sup_r0     SUP Host Context Ring-0 API
    1652  * @ingroup grp_sup
    16531651 * @{
    16541652 */
    … …  
    20452043
    20462044/** @defgroup   grp_sup_r0_idc  The IDC Interface
    2047  * @ingroup grp_sup_r0
    20482045 * @{
    20492046 */

  • trunk/include/VBox/types.h

    r45152 r53615  
    44
    55/*
    6  * Copyright (C) 2006-2012 Oracle Corporation
     6 * Copyright (C) 2006-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    3737
    3838/** @defgroup grp_types_both  Common Guest and Host Context Basic Types
    39  * @ingroup grp_types
    4039 * @{
    4140 */
    … …  
    4342
    4443/** @defgroup grp_types_hc  Host Context Basic Types
    45  * @ingroup grp_types_both
    4644 * @{
    4745 */
    … …  
    5149
    5250/** @defgroup grp_types_gc  Guest Context Basic Types
    53  * @ingroup grp_types_both
    5451 * @{
    5552 */
    … …  
    405402
    406403/** @defgroup grp_types_idt     Interrupt Descriptor Table Entry.
    407  * @ingroup grp_types
    408404 * @todo This all belongs in x86.h!
    409405 * @{ */

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

    r53437 r53615  
    44
    55/*
    6  * Copyright (C) 2006-2013 Oracle Corporation
     6 * Copyright (C) 2006-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    5555#ifdef IN_RING3
    5656/** @defgroup   grp_cfgm_r3     The CFGM Host Context Ring-3 API
    57  * @ingroup grp_cfgm
    5857 * @{
    5958 */

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

    r53466 r53615  
    44
    55/*
    6  * Copyright (C) 2006-2014 Oracle Corporation
     6 * Copyright (C) 2006-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    12451245
    12461246#ifdef IN_RING3
    1247 /** @defgroup grp_cpum_r3    The CPU Monitor(/Manager) API
    1248  * @ingroup grp_cpum
     1247/** @defgroup grp_cpum_r3    The CPUM ring-3 API
    12491248 * @{
    12501249 */
    … …  
    12821281
    12831282#ifdef IN_RC
    1284 /** @defgroup grp_cpum_gc    The CPU Monitor(/Manager) API
    1285  * @ingroup grp_cpum
     1283/** @defgroup grp_cpum_rc    The CPUM Raw-mode Context API
    12861284 * @{
    12871285 */
    … …  
    13221320
    13231321#ifdef IN_RING0
    1324 /** @defgroup grp_cpum_r0    The CPU Monitor(/Manager) API
    1325  * @ingroup grp_cpum
     1322/** @defgroup grp_cpum_r0    The CPUM ring-0 API
    13261323 * @{
    13271324 */

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

    r45528 r53615  
    44
    55/*
    6  * Copyright (C) 2006-2013 Oracle Corporation
     6 * Copyright (C) 2006-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    7373#ifdef IN_RING3
    7474/** @defgroup grp_csam_r3      The Code Scanning and Analysis API
    75  * @ingroup grp_csam
    7675 * @{
    7776 */

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

    r48898 r53615  
    537537                                    const char *pszSepFmt, PCDBGFINFOHLP pHlp);
    538538
    539 /** @def DBGFR3InfoLog
     539/** @def DBGFR3_INFO_LOG
    540540 * Display a piece of info writing to the log if enabled.
    541541 *
    … …  
    913913VMMR3DECL(int)      DBGFR3DisasInstrCurrentLogInternal(PVMCPU pVCpu, const char *pszPrefix);
    914914
    915 /** @def DBGFR3DisasInstrCurrentLog
     915/** @def DBGFR3_DISAS_INSTR_CUR_LOG
    916916 * Disassembles the current guest context instruction and writes it to the log.
    917917 * All registers and data will be displayed. Addresses will be attempted resolved to symbols.
    … …  
    929929VMMR3DECL(int) DBGFR3DisasInstrLogInternal(PVMCPU pVCpu, RTSEL Sel, RTGCPTR GCPtr, const char *pszPrefix);
    930930
    931 /** @def DBGFR3DisasInstrLog
     931/** @def DBGFR3_DISAS_INSTR_LOG
    932932 * Disassembles the specified guest context instruction and writes it to the log.
    933933 * Addresses will be attempted resolved to symbols.

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

    r48370 r53615  
    44
    55/*
    6  * Copyright (C) 2006-2013 Oracle Corporation
     6 * Copyright (C) 2006-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    251251#ifdef IN_RING3
    252252/** @defgroup grp_em_r3     The EM Host Context Ring-3 API
    253  * @ingroup grp_em
    254253 * @{
    255254 */

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

    r44529 r53615  
    44
    55/*
    6  * Copyright (C) 2010-2013 Oracle Corporation
     6 * Copyright (C) 2010-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    5353#ifdef IN_RING3
    5454/** @defgroup grp_ftm_r3     The FTM Host Context Ring-3 API
    55  * @ingroup grp_ftm
    5655 * @{
    5756 */

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

    r53466 r53615  
    44
    55/*
    6  * Copyright (C) 2014 Oracle Corporation
     6 * Copyright (C) 2014-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    141141#ifdef IN_RC
    142142/** @defgroup grp_gim_rc  The GIM Raw-mode Context API
    143  * @ingroup grp_gim
    144143 * @{
    145144 */
    … …  
    149148#ifdef IN_RING0
    150149/** @defgroup grp_gim_r0  The GIM Host Context Ring-0 API
    151  * @ingroup grp_gim
    152150 * @{
    153151 */
    … …  
    161159#ifdef IN_RING3
    162160/** @defgroup grp_gim_r3  The GIM Host Context Ring-3 API
    163  * @ingroup grp_gim
    164161 * @{
    165162 */

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

    r44528 r53615  
    44
    55/*
    6  * Copyright (C) 2007-2012 Oracle Corporation
     6 * Copyright (C) 2007-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    769769#ifdef IN_RING3
    770770/** @defgroup grp_gmm_r3    The Global Memory Manager Ring-3 API Wrappers
    771  * @ingroup grp_gmm
    772771 * @{
    773772 */

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

    r44528 r53615  
    55
    66/*
    7  * Copyright (C) 2007-2011 Oracle Corporation
     7 * Copyright (C) 2007-2015 Oracle Corporation
    88 *
    99 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    3333
    3434
    35 /** @defgroup grp_gvm  GVMCPU - The Global VMCPU Data
     35/** @defgroup grp_gvmcpu GVMCPU - The Global VMCPU Data
    3636 * @{
    3737 */

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

    r52419 r53615  
    44
    55/*
    6  * Copyright (C) 2006-2014 Oracle Corporation
     6 * Copyright (C) 2006-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    165165#ifdef IN_RING0
    166166/** @defgroup grp_hm_r0    The VM Hardware Manager API
    167  * @ingroup grp_hm
    168167 * @{
    169168 */
    … …  
    180179VMMR0_INT_DECL(void)            HMR0SavePendingIOPortRead(PVMCPU pVCpu, RTGCPTR GCPtrRip, RTGCPTR GCPtrRipNext,
    181180                                                          unsigned uPort, unsigned uAndVal, unsigned cbSize);
     181/** Disables preemption if required. */
     182# define HM_DISABLE_PREEMPT_IF_NEEDED() \
     183    RTTHREADPREEMPTSTATE PreemptStateInternal = RTTHREADPREEMPTSTATE_INITIALIZER; \
     184    bool fPreemptDisabledInternal = false; \
     185    if (RTThreadPreemptIsEnabled(NIL_RTTHREAD)) \
     186    { \
     187        Assert(VMMR0ThreadCtxHooksAreRegistered(pVCpu)); \
     188        RTThreadPreemptDisable(&PreemptStateInternal); \
     189        fPreemptDisabledInternal = true; \
     190    } else do { } while (0)
     191
     192/** Restores preemption if previously disabled by HM_DISABLE_PREEMPT(). */
     193# define HM_RESTORE_PREEMPT_IF_NEEDED() \
     194    do \
     195    { \
     196        if (fPreemptDisabledInternal) \
     197            RTThreadPreemptRestore(&PreemptStateInternal); \
     198    } while (0)
     199
     200VMMR0_INT_DECL(int)             HMR0SetupVM(PVM pVM);
     201VMMR0_INT_DECL(int)             HMR0RunGuestCode(PVM pVM, PVMCPU pVCpu);
     202VMMR0_INT_DECL(int)             HMR0Enter(PVM pVM, PVMCPU pVCpu);
     203VMMR0_INT_DECL(int)             HMR0EnterCpu(PVMCPU pVCpu);
     204VMMR0_INT_DECL(int)             HMR0LeaveCpu(PVMCPU pVCpu);
     205VMMR0_INT_DECL(void)            HMR0ThreadCtxCallback(RTTHREADCTXEVENT enmEvent, void *pvUser);
     206VMMR0_INT_DECL(bool)            HMR0SuspendPending(void);
     207
     208# if HC_ARCH_BITS == 32 && defined(VBOX_WITH_64_BITS_GUESTS)
     209VMMR0_INT_DECL(int)             HMR0SaveFPUState(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx);
     210VMMR0_INT_DECL(int)             HMR0SaveDebugState(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx);
     211VMMR0_INT_DECL(int)             HMR0TestSwitcher3264(PVM pVM);
     212# endif
    182213
    183214/** @} */
    … …  
    187218#ifdef IN_RING3
    188219/** @defgroup grp_hm_r3    The VM Hardware Manager API
    189  * @ingroup grp_hm
    190220 * @{
    191221 */
    … …  
    221251#endif /* IN_RING3 */
    222252
    223 #ifdef IN_RING0
    224 /** @addtogroup grp_hm_r0
    225  * @{
    226  */
    227 /** Disables preemption if required. */
    228 # define HM_DISABLE_PREEMPT_IF_NEEDED() \
    229    RTTHREADPREEMPTSTATE PreemptStateInternal = RTTHREADPREEMPTSTATE_INITIALIZER; \
    230    bool fPreemptDisabledInternal = false; \
    231    if (RTThreadPreemptIsEnabled(NIL_RTTHREAD)) \
    232    { \
    233        Assert(VMMR0ThreadCtxHooksAreRegistered(pVCpu)); \
    234        RTThreadPreemptDisable(&PreemptStateInternal); \
    235        fPreemptDisabledInternal = true; \
    236    }
    237 
    238 /** Restores preemption if previously disabled by HM_DISABLE_PREEMPT(). */
    239 # define HM_RESTORE_PREEMPT_IF_NEEDED() \
    240    do \
    241    { \
    242         if (fPreemptDisabledInternal) \
    243             RTThreadPreemptRestore(&PreemptStateInternal); \
    244    } while (0)
    245 
    246 VMMR0_INT_DECL(int)             HMR0SetupVM(PVM pVM);
    247 VMMR0_INT_DECL(int)             HMR0RunGuestCode(PVM pVM, PVMCPU pVCpu);
    248 VMMR0_INT_DECL(int)             HMR0Enter(PVM pVM, PVMCPU pVCpu);
    249 VMMR0_INT_DECL(int)             HMR0EnterCpu(PVMCPU pVCpu);
    250 VMMR0_INT_DECL(int)             HMR0LeaveCpu(PVMCPU pVCpu);
    251 VMMR0_INT_DECL(void)            HMR0ThreadCtxCallback(RTTHREADCTXEVENT enmEvent, void *pvUser);
    252 VMMR0_INT_DECL(bool)            HMR0SuspendPending(void);
    253 
    254 # if HC_ARCH_BITS == 32 && defined(VBOX_WITH_64_BITS_GUESTS)
    255 VMMR0_INT_DECL(int)             HMR0SaveFPUState(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx);
    256 VMMR0_INT_DECL(int)             HMR0SaveDebugState(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx);
    257 VMMR0_INT_DECL(int)             HMR0TestSwitcher3264(PVM pVM);
    258 # endif
    259 
    260 /** @} */
    261 #endif /* IN_RING0 */
    262 
    263 
    264253/** @} */
    265254RT_C_DECLS_END

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

    r46842 r53615  
    11/** @file
    2  * HM - SVM Structures and Definitions. (VMM)
     2 * HM - SVM (AMD-V) Structures and Definitions. (VMM)
    33 */
    44
    55/*
    6  * Copyright (C) 2006-2013 Oracle Corporation
     6 * Copyright (C) 2006-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    3232#include <iprt/asm.h>
    3333
    34 /** @defgroup grp_svm   svm Types and Definitions
     34
     35/** @defgroup grp_svm   SVM (AMD-V) Types and Definitions
    3536 * @ingroup grp_hm
    3637 * @{

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

    r53610 r53615  
    9595
    9696/** @name Host-state restoration flags.
    97  * @{
    98  */
    99 /* If you change these values don't forget to update the assembly defines as well! */
     97 * @note If you change these values don't forget to update the assembly
     98 *       defines as well!
     99 * @{
     100 */
    100101#define VMX_RESTORE_HOST_SEL_DS               RT_BIT(0)
    101102#define VMX_RESTORE_HOST_SEL_ES               RT_BIT(1)
    … …  
    435436 * @{
    436437 */
    437 # define VMX_VMCS_GUEST_ES_BASE_CACHE_IDX                       0
    438 # define VMX_VMCS_GUEST_CS_BASE_CACHE_IDX                       1
    439 # define VMX_VMCS_GUEST_SS_BASE_CACHE_IDX                       2
    440 # define VMX_VMCS_GUEST_DS_BASE_CACHE_IDX                       3
    441 # define VMX_VMCS_GUEST_FS_BASE_CACHE_IDX                       4
    442 # define VMX_VMCS_GUEST_GS_BASE_CACHE_IDX                       5
    443 # define VMX_VMCS_GUEST_LDTR_BASE_CACHE_IDX                     6
    444 # define VMX_VMCS_GUEST_TR_BASE_CACHE_IDX                       7
    445 # define VMX_VMCS_GUEST_GDTR_BASE_CACHE_IDX                     8
    446 # define VMX_VMCS_GUEST_IDTR_BASE_CACHE_IDX                     9
    447 # define VMX_VMCS_GUEST_RSP_CACHE_IDX                           10
    448 # define VMX_VMCS_GUEST_RIP_CACHE_IDX                           11
    449 # define VMX_VMCS_GUEST_SYSENTER_ESP_CACHE_IDX                  12
    450 # define VMX_VMCS_GUEST_SYSENTER_EIP_CACHE_IDX                  13
    451 # define VMX_VMCS_RO_EXIT_QUALIFICATION_CACHE_IDX               14
    452 # define VMX_VMCS_MAX_CACHE_IDX                                 (VMX_VMCS_RO_EXIT_QUALIFICATION_CACHE_IDX + 1)
    453 # define VMX_VMCS_GUEST_CR3_CACHE_IDX                           15
    454 # define VMX_VMCS_MAX_NESTED_PAGING_CACHE_IDX                   (VMX_VMCS_GUEST_CR3_CACHE_IDX + 1)
     438#define VMX_VMCS_GUEST_ES_BASE_CACHE_IDX                        0
     439#define VMX_VMCS_GUEST_CS_BASE_CACHE_IDX                        1
     440#define VMX_VMCS_GUEST_SS_BASE_CACHE_IDX                        2
     441#define VMX_VMCS_GUEST_DS_BASE_CACHE_IDX                        3
     442#define VMX_VMCS_GUEST_FS_BASE_CACHE_IDX                        4
     443#define VMX_VMCS_GUEST_GS_BASE_CACHE_IDX                        5
     444#define VMX_VMCS_GUEST_LDTR_BASE_CACHE_IDX                      6
     445#define VMX_VMCS_GUEST_TR_BASE_CACHE_IDX                        7
     446#define VMX_VMCS_GUEST_GDTR_BASE_CACHE_IDX                      8
     447#define VMX_VMCS_GUEST_IDTR_BASE_CACHE_IDX                      9
     448#define VMX_VMCS_GUEST_RSP_CACHE_IDX                            10
     449#define VMX_VMCS_GUEST_RIP_CACHE_IDX                            11
     450#define VMX_VMCS_GUEST_SYSENTER_ESP_CACHE_IDX                   12
     451#define VMX_VMCS_GUEST_SYSENTER_EIP_CACHE_IDX                   13
     452#define VMX_VMCS_RO_EXIT_QUALIFICATION_CACHE_IDX                14
     453#define VMX_VMCS_MAX_CACHE_IDX                                  (VMX_VMCS_RO_EXIT_QUALIFICATION_CACHE_IDX + 1)
     454#define VMX_VMCS_GUEST_CR3_CACHE_IDX                            15
     455#define VMX_VMCS_MAX_NESTED_PAGING_CACHE_IDX                    (VMX_VMCS_GUEST_CR3_CACHE_IDX + 1)
    455456/** @} */
    456457
    … …  
    781782typedef const EPTPT *PCEPTPT;
    782783
    783 /** @name VMX VPID flush types.
    784  *  Warning!! Valid enum members are in accordance to the VT-x spec.
    785  * @{
     784/** @} */
     785
     786/** VMX VPID flush types.
     787 * Warning!! Valid enum members are in accordance to the VT-x spec.
    786788 */
    787789typedef enum
    … …  
    801803} VMXFLUSHVPID;
    802804AssertCompileSize(VMXFLUSHVPID, 4);
    803 /** @} */
    804 
    805 /** @name VMX EPT flush types.
    806  *  Warning!! Valid enums values below are in accordance to the VT-x spec.
    807  * @{
     805
     806/** VMX EPT flush types.
     807 * @note Warning!! Valid enums values below are in accordance to the VT-x spec.
    808808 */
    809809typedef enum
    … …  
    819819} VMXFLUSHEPT;
    820820AssertCompileSize(VMXFLUSHEPT, 4);
    821 /** @} */
    822 
    823 /** @name VMX MSR autoload/store element.
    824  *  In accordance to VT-x spec.
    825  * @{
    826  */
    827 #pragma pack(1)
     821
     822/** VMX MSR autoload/store element.
     823 * In accordance to VT-x spec.
     824 */
    828825typedef struct
    829826{
    … …  
    835832    uint64_t    u64Value;
    836833} VMXAUTOMSR;
    837 #pragma pack()
     834AssertCompileSize(VMXAUTOMSR, 8);
    838835/** Pointer to an MSR load/store element. */
    839836typedef VMXAUTOMSR *PVMXAUTOMSR;
    840837/** Pointer to a const MSR load/store element. */
    841838typedef const VMXAUTOMSR *PCVMXAUTOMSR;
    842 /** @} */
    843 
    844 /** @name VMX-capability qword
    845  * @{
    846  */
    847 #pragma pack(1)
     839
     840/**
     841 * VMX-capability qword
     842 */
    848843typedef union
    849844{
    … …  
    858853    uint64_t            u;
    859854} VMXCAPABILITY;
    860 #pragma pack()
    861 /** @} */
    862 
    863 /** @name VMX MSRs.
    864  *  @{
     855AssertCompileSize(VMXCAPABILITY, 8);
     856
     857/**
     858 * VMX MSRs.
    865859 */
    866860typedef struct VMXMSRS
    … …  
    882876    uint64_t                u64EptVpidCaps;
    883877} VMXMSRS;
     878AssertCompileSizeAlignment(VMXMSRS, 8);
    884879/** Pointer to a VMXMSRS struct. */
    885880typedef VMXMSRS *PVMXMSRS;
    886 AssertCompileSizeAlignment(VMXMSRS, 8);
    887 /** @} */
    888881
    889882/** @name VMX EFLAGS reserved bits.
    … …  
    891884 */
    892885/** And-mask for setting reserved bits to zero */
    893 #define VMX_EFLAGS_RESERVED_0                                   (~0xffc08028)
     886#define VMX_EFLAGS_RESERVED_0                                   (~(X86_EFL_1 | X86_EFL_LIVE_MASK))
    894887/** Or-mask for setting reserved bits to 1 */
    895 #define VMX_EFLAGS_RESERVED_1                                   0x00000002
     888#define VMX_EFLAGS_RESERVED_1                                   X86_EFL_1
    896889/** @} */
    897890
    … …  
    10701063/** Invalid operand to INVEPT/INVVPID. */
    10711064#define VMX_ERROR_INVEPTVPID_INVALID_OPERAND                    28
    1072 
    10731065/** @} */
    10741066
    … …  
    11551147#define MSR_IA32_VMX_EPT_VPID_CAP_INVVPID_ALL_CONTEXTS                   RT_BIT_64(42)
    11561148#define MSR_IA32_VMX_EPT_VPID_CAP_INVVPID_SINGLE_CONTEXT_RETAIN_GLOBALS  RT_BIT_64(43)
    1157 
    11581149/** @} */
    11591150
    … …  
    14501441 */
    14511442/** EPTP-switching function changes the value of the EPTP to one chosen from the EPTP list. */
    1452 #define VMX_VMCS_CTRL_VMFUNC_EPTP_SWITCHING            RT_BIT_64(0)
    1453 /** @} */
    1454 
    1455 
    1456 /**  @name VMCS field encoding - 32 Bits read-only fields
    1457  * @{
    1458  */
    1459 #define VMX_VMCS32_RO_VM_INSTR_ERROR                              0x4400
    1460 #define VMX_VMCS32_RO_EXIT_REASON                                 0x4402
    1461 #define VMX_VMCS32_RO_EXIT_INTERRUPTION_INFO                      0x4404
    1462 #define VMX_VMCS32_RO_EXIT_INTERRUPTION_ERROR_CODE                0x4406
    1463 #define VMX_VMCS32_RO_IDT_INFO                                    0x4408
    1464 #define VMX_VMCS32_RO_IDT_ERROR_CODE                              0x440A
    1465 #define VMX_VMCS32_RO_EXIT_INSTR_LENGTH                           0x440C
    1466 #define VMX_VMCS32_RO_EXIT_INSTR_INFO                             0x440E
     1443#define VMX_VMCS_CTRL_VMFUNC_EPTP_SWITCHING                     RT_BIT_64(0)
     1444/** @} */
     1445
     1446
     1447/** @name VMCS field encoding - 32 Bits read-only fields
     1448 * @{
     1449 */
     1450#define VMX_VMCS32_RO_VM_INSTR_ERROR                            0x4400
     1451#define VMX_VMCS32_RO_EXIT_REASON                               0x4402
     1452#define VMX_VMCS32_RO_EXIT_INTERRUPTION_INFO                    0x4404
     1453#define VMX_VMCS32_RO_EXIT_INTERRUPTION_ERROR_CODE              0x4406
     1454#define VMX_VMCS32_RO_IDT_INFO                                  0x4408
     1455#define VMX_VMCS32_RO_IDT_ERROR_CODE                            0x440A
     1456#define VMX_VMCS32_RO_EXIT_INSTR_LENGTH                         0x440C
     1457#define VMX_VMCS32_RO_EXIT_INSTR_INFO                           0x440E
    14671458/** @} */
    14681459
    … …  
    14701461 * @{
    14711462 */
    1472 #define VMX_EXIT_REASON_BASIC(a)                                  ((a) & 0xffff)
     1463#define VMX_EXIT_REASON_BASIC(a)                                ((a) & 0xffff)
    14731464/** @} */
    14741465
    … …  
    14761467 * @{
    14771468 */
    1478 #define VMX_ENTRY_INTERRUPTION_INFO_IS_VALID(a)                   RT_BOOL((a) & RT_BIT(31))
    1479 #define VMX_ENTRY_INTERRUPTION_INFO_TYPE_SHIFT                    8
    1480 #define VMX_ENTRY_INTERRUPTION_INFO_TYPE(a)                       ((a >> VMX_ENTRY_INTERRUPTION_INFO_TYPE_SHIFT) & 7)
     1469#define VMX_ENTRY_INTERRUPTION_INFO_IS_VALID(a)                 RT_BOOL((a) & RT_BIT(31))
     1470#define VMX_ENTRY_INTERRUPTION_INFO_TYPE_SHIFT                  8
     1471#define VMX_ENTRY_INTERRUPTION_INFO_TYPE(a)                     ((a >> VMX_ENTRY_INTERRUPTION_INFO_TYPE_SHIFT) & 7)
    14811472/** @} */
    14821473
    … …  
    14851476 * @{
    14861477 */
    1487 #define VMX_EXIT_INTERRUPTION_INFO_VECTOR(a)                      ((a) & 0xff)
    1488 #define VMX_EXIT_INTERRUPTION_INFO_TYPE_SHIFT                     8
    1489 #define VMX_EXIT_INTERRUPTION_INFO_TYPE(a)                        (((a) >> VMX_EXIT_INTERRUPTION_INFO_TYPE_SHIFT) & 7)
    1490 #define VMX_EXIT_INTERRUPTION_INFO_ERROR_CODE_VALID               RT_BIT(11)
    1491 #define VMX_EXIT_INTERRUPTION_INFO_ERROR_CODE_IS_VALID(a)         RT_BOOL((a) & VMX_EXIT_INTERRUPTION_INFO_ERROR_CODE_VALID)
    1492 #define VMX_EXIT_INTERRUPTION_INFO_NMI_UNBLOCK_IRET(a)            ((a) & RT_BIT(12))
    1493 #define VMX_EXIT_INTERRUPTION_INFO_VALID                          RT_BIT(31)
    1494 #define VMX_EXIT_INTERRUPTION_INFO_IS_VALID(a)                    RT_BOOL((a) & RT_BIT(31))
     1478#define VMX_EXIT_INTERRUPTION_INFO_VECTOR(a)                    ((a) & 0xff)
     1479#define VMX_EXIT_INTERRUPTION_INFO_TYPE_SHIFT                   8
     1480#define VMX_EXIT_INTERRUPTION_INFO_TYPE(a)                      (((a) >> VMX_EXIT_INTERRUPTION_INFO_TYPE_SHIFT) & 7)
     1481#define VMX_EXIT_INTERRUPTION_INFO_ERROR_CODE_VALID             RT_BIT(11)
     1482#define VMX_EXIT_INTERRUPTION_INFO_ERROR_CODE_IS_VALID(a)       RT_BOOL((a) & VMX_EXIT_INTERRUPTION_INFO_ERROR_CODE_VALID)
     1483#define VMX_EXIT_INTERRUPTION_INFO_NMI_UNBLOCK_IRET(a)          ((a) & RT_BIT(12))
     1484#define VMX_EXIT_INTERRUPTION_INFO_VALID                        RT_BIT(31)
     1485#define VMX_EXIT_INTERRUPTION_INFO_IS_VALID(a)                  RT_BOOL((a) & RT_BIT(31))
    14951486/** Construct an irq event injection value from the exit interruption info value (same except that bit 12 is reserved). */
    1496 #define VMX_VMCS_CTRL_ENTRY_IRQ_INFO_FROM_EXIT_INT_INFO(a)        ((a) & ~RT_BIT(12))
     1487#define VMX_VMCS_CTRL_ENTRY_IRQ_INFO_FROM_EXIT_INT_INFO(a)      ((a) & ~RT_BIT(12))
    14971488/** @} */
    14981489
    … …  
    15001491 * @{
    15011492 */
    1502 #define VMX_EXIT_INTERRUPTION_INFO_TYPE_EXT_INT                   0
    1503 #define VMX_EXIT_INTERRUPTION_INFO_TYPE_NMI                       2
    1504 #define VMX_EXIT_INTERRUPTION_INFO_TYPE_HW_XCPT                   3
    1505 #define VMX_EXIT_INTERRUPTION_INFO_TYPE_SW_INT                    4
    1506 #define VMX_EXIT_INTERRUPTION_INFO_TYPE_PRIV_SW_XCPT              5
    1507 #define VMX_EXIT_INTERRUPTION_INFO_TYPE_SW_XCPT                   6
     1493#define VMX_EXIT_INTERRUPTION_INFO_TYPE_EXT_INT                 0
     1494#define VMX_EXIT_INTERRUPTION_INFO_TYPE_NMI                     2
     1495#define VMX_EXIT_INTERRUPTION_INFO_TYPE_HW_XCPT                 3
     1496#define VMX_EXIT_INTERRUPTION_INFO_TYPE_SW_INT                  4
     1497#define VMX_EXIT_INTERRUPTION_INFO_TYPE_PRIV_SW_XCPT            5
     1498#define VMX_EXIT_INTERRUPTION_INFO_TYPE_SW_XCPT                 6
    15081499/** @} */
    15091500
    … …  
    15111502 * @{
    15121503 */
    1513 #define VMX_IDT_VECTORING_INFO_VECTOR(a)                          ((a) & 0xff)
    1514 #define VMX_IDT_VECTORING_INFO_TYPE_SHIFT                         8
    1515 #define VMX_IDT_VECTORING_INFO_TYPE(a)                            (((a) >> VMX_IDT_VECTORING_INFO_TYPE_SHIFT) & 7)
    1516 #define VMX_IDT_VECTORING_INFO_ERROR_CODE_VALID                   RT_BIT(11)
    1517 #define VMX_IDT_VECTORING_INFO_ERROR_CODE_IS_VALID(a)             RT_BOOL((a) & VMX_IDT_VECTORING_INFO_ERROR_CODE_VALID)
    1518 #define VMX_IDT_VECTORING_INFO_VALID(a)                           ((a) & RT_BIT(31))
    1519 #define VMX_ENTRY_INT_INFO_FROM_EXIT_IDT_INFO(a)                  ((a) & ~RT_BIT(12))
     1504#define VMX_IDT_VECTORING_INFO_VECTOR(a)                        ((a) & 0xff)
     1505#define VMX_IDT_VECTORING_INFO_TYPE_SHIFT                       8
     1506#define VMX_IDT_VECTORING_INFO_TYPE(a)                          (((a) >> VMX_IDT_VECTORING_INFO_TYPE_SHIFT) & 7)
     1507#define VMX_IDT_VECTORING_INFO_ERROR_CODE_VALID                 RT_BIT(11)
     1508#define VMX_IDT_VECTORING_INFO_ERROR_CODE_IS_VALID(a)           RT_BOOL((a) & VMX_IDT_VECTORING_INFO_ERROR_CODE_VALID)
     1509#define VMX_IDT_VECTORING_INFO_VALID(a)                         ((a) & RT_BIT(31))
     1510#define VMX_ENTRY_INT_INFO_FROM_EXIT_IDT_INFO(a)                ((a) & ~RT_BIT(12))
    15201511/** @} */
    15211512
    … …  
    15231514 * @{
    15241515 */
    1525 #define VMX_IDT_VECTORING_INFO_TYPE_EXT_INT                       0
    1526 #define VMX_IDT_VECTORING_INFO_TYPE_NMI                           2
    1527 #define VMX_IDT_VECTORING_INFO_TYPE_HW_XCPT                       3
    1528 #define VMX_IDT_VECTORING_INFO_TYPE_SW_INT                        4
    1529 #define VMX_IDT_VECTORING_INFO_TYPE_PRIV_SW_XCPT                  5
    1530 #define VMX_IDT_VECTORING_INFO_TYPE_SW_XCPT                       6
    1531 /** @} */
    1532 
    1533 
    1534 /**  @name VMCS field encoding - 32 Bits guest state fields
    1535  * @{
    1536  */
    1537 #define VMX_VMCS32_GUEST_ES_LIMIT                                 0x4800
    1538 #define VMX_VMCS32_GUEST_CS_LIMIT                                 0x4802
    1539 #define VMX_VMCS32_GUEST_SS_LIMIT                                 0x4804
    1540 #define VMX_VMCS32_GUEST_DS_LIMIT                                 0x4806
    1541 #define VMX_VMCS32_GUEST_FS_LIMIT                                 0x4808
    1542 #define VMX_VMCS32_GUEST_GS_LIMIT                                 0x480A
    1543 #define VMX_VMCS32_GUEST_LDTR_LIMIT                               0x480C
    1544 #define VMX_VMCS32_GUEST_TR_LIMIT                                 0x480E
    1545 #define VMX_VMCS32_GUEST_GDTR_LIMIT                               0x4810
    1546 #define VMX_VMCS32_GUEST_IDTR_LIMIT                               0x4812
    1547 #define VMX_VMCS32_GUEST_ES_ACCESS_RIGHTS                         0x4814
    1548 #define VMX_VMCS32_GUEST_CS_ACCESS_RIGHTS                         0x4816
    1549 #define VMX_VMCS32_GUEST_SS_ACCESS_RIGHTS                         0x4818
    1550 #define VMX_VMCS32_GUEST_DS_ACCESS_RIGHTS                         0x481A
    1551 #define VMX_VMCS32_GUEST_FS_ACCESS_RIGHTS                         0x481C
    1552 #define VMX_VMCS32_GUEST_GS_ACCESS_RIGHTS                         0x481E
    1553 #define VMX_VMCS32_GUEST_LDTR_ACCESS_RIGHTS                       0x4820
    1554 #define VMX_VMCS32_GUEST_TR_ACCESS_RIGHTS                         0x4822
    1555 #define VMX_VMCS32_GUEST_INTERRUPTIBILITY_STATE                   0x4824
    1556 #define VMX_VMCS32_GUEST_ACTIVITY_STATE                           0x4826
    1557 #define VMX_VMCS32_GUEST_SYSENTER_CS                              0x482A  /**< MSR IA32_SYSENTER_CS */
    1558 #define VMX_VMCS32_GUEST_PREEMPT_TIMER_VALUE                      0x482E
     1516#define VMX_IDT_VECTORING_INFO_TYPE_EXT_INT                     0
     1517#define VMX_IDT_VECTORING_INFO_TYPE_NMI                         2
     1518#define VMX_IDT_VECTORING_INFO_TYPE_HW_XCPT                     3
     1519#define VMX_IDT_VECTORING_INFO_TYPE_SW_INT                      4
     1520#define VMX_IDT_VECTORING_INFO_TYPE_PRIV_SW_XCPT                5
     1521#define VMX_IDT_VECTORING_INFO_TYPE_SW_XCPT                     6
     1522/** @} */
     1523
     1524
     1525/** @name VMCS field encoding - 32 Bits guest state fields
     1526 * @{
     1527 */
     1528#define VMX_VMCS32_GUEST_ES_LIMIT                               0x4800
     1529#define VMX_VMCS32_GUEST_CS_LIMIT                               0x4802
     1530#define VMX_VMCS32_GUEST_SS_LIMIT                               0x4804
     1531#define VMX_VMCS32_GUEST_DS_LIMIT                               0x4806
     1532#define VMX_VMCS32_GUEST_FS_LIMIT                               0x4808
     1533#define VMX_VMCS32_GUEST_GS_LIMIT                               0x480A
     1534#define VMX_VMCS32_GUEST_LDTR_LIMIT                             0x480C
     1535#define VMX_VMCS32_GUEST_TR_LIMIT                               0x480E
     1536#define VMX_VMCS32_GUEST_GDTR_LIMIT                             0x4810
     1537#define VMX_VMCS32_GUEST_IDTR_LIMIT                             0x4812
     1538#define VMX_VMCS32_GUEST_ES_ACCESS_RIGHTS                       0x4814
     1539#define VMX_VMCS32_GUEST_CS_ACCESS_RIGHTS                       0x4816
     1540#define VMX_VMCS32_GUEST_SS_ACCESS_RIGHTS                       0x4818
     1541#define VMX_VMCS32_GUEST_DS_ACCESS_RIGHTS                       0x481A
     1542#define VMX_VMCS32_GUEST_FS_ACCESS_RIGHTS                       0x481C
     1543#define VMX_VMCS32_GUEST_GS_ACCESS_RIGHTS                       0x481E
     1544#define VMX_VMCS32_GUEST_LDTR_ACCESS_RIGHTS                     0x4820
     1545#define VMX_VMCS32_GUEST_TR_ACCESS_RIGHTS                       0x4822
     1546#define VMX_VMCS32_GUEST_INTERRUPTIBILITY_STATE                 0x4824
     1547#define VMX_VMCS32_GUEST_ACTIVITY_STATE                         0x4826
     1548#define VMX_VMCS32_GUEST_SYSENTER_CS                            0x482A  /**< MSR IA32_SYSENTER_CS */
     1549#define VMX_VMCS32_GUEST_PREEMPT_TIMER_VALUE                    0x482E
    15591550/** @} */
    15601551
    … …  
    15641555 */
    15651556/** The logical processor is active. */
    1566 #define VMX_VMCS_GUEST_ACTIVITY_ACTIVE                           0x0
     1557#define VMX_VMCS_GUEST_ACTIVITY_ACTIVE                          0x0
    15671558/** The logical processor is inactive, because executed a HLT instruction. */
    1568 #define VMX_VMCS_GUEST_ACTIVITY_HLT                              0x1
     1559#define VMX_VMCS_GUEST_ACTIVITY_HLT                             0x1
    15691560/** The logical processor is inactive, because of a triple fault or other serious error. */
    1570 #define VMX_VMCS_GUEST_ACTIVITY_SHUTDOWN                         0x2
     1561#define VMX_VMCS_GUEST_ACTIVITY_SHUTDOWN                        0x2
    15711562/** The logical processor is inactive, because it's waiting for a startup-IPI */
    1572 #define VMX_VMCS_GUEST_ACTIVITY_SIPI_WAIT                        0x3
     1563#define VMX_VMCS_GUEST_ACTIVITY_SIPI_WAIT                       0x3
    15731564/** @} */
    15741565
    … …  
    16581649/** 16-31: LMSW source data (else 0). */
    16591650#define VMX_EXIT_QUALIFICATION_CRX_LMSW_DATA(a)                 (((a) >> 16) & 0xFFFF)
    1660 /** Rest: reserved. */
     1651/* Rest: reserved. */
    16611652/** @} */
    16621653
    … …  
    17721763/** @} */
    17731764
    1774 /** @} */
    17751765
    17761766/** @name VMCS field encoding - Natural width guest state fields
    … …  
    18011791
    18021792/** @name VMX_VMCS_GUEST_DEBUG_EXCEPTIONS
     1793 * Bits 4-11, 13 and 15-63 are reserved.
    18031794 * @{
    18041795 */
    … …  
    18151806/** A debug exception would have been triggered by single-step execution mode. */
    18161807#define VMX_VMCS_GUEST_DEBUG_EXCEPTIONS_BS                      RT_BIT(14)
    1817 /** Bits 4-11, 13 and 15-63 are reserved. */
    1818 
    18191808/** @} */
    18201809
    … …  
    18361825/** @} */
    18371826
    1838 /** @} */
    1839 
    18401827
    18411828/** @defgroup grp_vmx_asm   vmx assembly helpers
    1842  * @ingroup grp_vmx
    18431829 * @{
    18441830 */
    … …  
    21842170# define VMXWriteVmcsHstN                       VMXWriteVmcs32
    21852171# define VMXWriteVmcsGstN(idxField, u64Val)     VMXWriteVmcs64Ex(pVCpu, idxField, u64Val)
    2186 # else  /* ARCH_BITS == 64 */
     2172#else  /* ARCH_BITS == 64 */
    21872173# define VMXWriteVmcsHstN                       VMXWriteVmcs64
    21882174# define VMXWriteVmcsGstN                       VMXWriteVmcs64
    2189 # endif
     2175#endif
    21902176
    21912177
    … …  
    23612347/** @} */
    23622348
     2349/** @} */
     2350
    23632351#endif
    23642352

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

    r51182 r53615  
    8484
    8585
    86 /** @defgroup grp_em_r3     The IEM Host Context Ring-3 API.
    87  * @ingroup grp_em
     86/** @defgroup grp_iem_r3     The IEM Host Context Ring-3 API.
    8887 * @{
    8988 */

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

    r50645 r53615  
    44
    55/*
    6  * Copyright (C) 2006-2013 Oracle Corporation
     6 * Copyright (C) 2006-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    290290#ifdef IN_RC
    291291/** @defgroup grp_iom_rc    The IOM Raw-Mode Context API
    292  * @ingroup grp_iom
    293292 * @{
    294293 */
    … …  
    301300#ifdef IN_RING3
    302301/** @defgroup grp_iom_r3    The IOM Host Context Ring-3 API
    303  * @ingroup grp_iom
    304302 * @{
    305303 */

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

    r51271 r53615  
    142142
    143143/** @defgroup grp_mm_hyper  Hypervisor Memory Management
    144  * @ingroup grp_mm
    145144 * @{ */
    146145
    … …  
    241240
    242241
    243 #ifdef IN_RING3
     242#if defined(IN_RING3) || defined(DOXYGEN_RUNNING)
    244243/** @defgroup grp_mm_r3    The MM Host Context Ring-3 API
    245  * @ingroup grp_mm
    246244 * @{
    247245 */
    … …  
    261259
    262260/** @defgroup grp_mm_r3_hyper  Hypervisor Memory Manager (HC R3 Portion)
    263  * @ingroup grp_mm_r3
    264261 * @{ */
    265262VMMR3DECL(int)      MMR3HyperAllocOnceNoRel(PVM pVM, size_t cb, uint32_t uAlignment, MMTAG enmTag, void **ppv);
    … …  
    289286/** @defgroup grp_mm_phys   Guest Physical Memory Manager
    290287 * @todo retire this group, elimintating or moving MMR3PhysGetRamSize to PGMPhys.
    291  * @ingroup grp_mm_r3
    292288 * @{ */
    293289VMMR3DECL(uint64_t) MMR3PhysGetRamSize(PVM pVM);
    … …  
    296292
    297293/** @defgroup grp_mm_page   Physical Page Pool
    298  * @ingroup grp_mm_r3
    299294 * @{ */
    300295VMMR3DECL(void *)   MMR3PageAlloc(PVM pVM);
    … …  
    310305
    311306/** @defgroup grp_mm_heap   Heap Manager
    312  * @ingroup grp_mm_r3
    313307 * @{ */
    314308VMMR3DECL(void *)   MMR3HeapAlloc(PVM pVM, MMTAG enmTag, size_t cbSize);
    … …  
    330324/** @} */
    331325
    332 /** @defgroup grp_mm_heap   User-kernel Heap Manager.
    333  * @ingroup grp_mm_r3
     326/** @defgroup grp_mm_ukheap   User-kernel Heap Manager.
    334327 *
    335328 * The memory is safely accessible from kernel context as well as user land.
    … …  
    344337
    345338/** @} */
    346 #endif /* IN_RING3 */
    347 
    348 
    349 
    350 #ifdef IN_RC
    351 /** @defgroup grp_mm_gc    The MM Guest Context API
    352  * @ingroup grp_mm
     339#endif /* IN_RING3 || DOXYGEN_RUNNING */
     340
     341
     342
     343#if defined(IN_RC) || defined(DOXYGEN_RUNNING)
     344/** @defgroup grp_mm_rc    The MM Raw-mode Context API
    353345 * @{
    354346 */
    … …  
    365357
    366358/** @} */
    367 #endif /* IN_RC */
     359#endif /* IN_RC || DOXYGEN_RUNNING */
    368360
    369361/** @} */

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

    r47427 r53615  
    44
    55/*
    6  * Copyright (C) 2006-2013 Oracle Corporation
     6 * Copyright (C) 2006-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    160160
    161161#ifdef IN_RC
    162 /** @defgroup grp_patm_rc    The Patch Manager RC API
    163  * @ingroup grp_patm
     162/** @defgroup grp_patm_rc    The Patch Manager Raw-mode Context API
    164163 * @{
    165164 */
    … …  
    174173
    175174#ifdef IN_RING3
    176 /** @defgroup grp_patm_r3    The Patch Manager API
    177  * @ingroup grp_patm
     175/** @defgroup grp_patm_r3    The Patch Manager Host Ring-3 Context API
    178176 * @{
    179177 */

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

    r52670 r53615  
    88
    99/*
    10  * Copyright (C) 2006-2013 Oracle Corporation
     10 * Copyright (C) 2006-2015 Oracle Corporation
    1111 *
    1212 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    6060
    6161/** @defgroup grp_pdm_r3    The PDM Host Context Ring-3 API
    62  * @ingroup grp_pdm
    6362 * @{
    6463 */
    … …  
    165164
    166165/** @defgroup grp_pdm_rc    The PDM Raw-Mode Context API
    167  * @ingroup grp_pdm
    168166 * @{
    169167 */
    … …  
    173171
    174172/** @defgroup grp_pdm_r0    The PDM Ring-0 Context API
    175  * @ingroup grp_pdm
    176173 * @{
    177174 */

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

    r49640 r53615  
    44
    55/*
    6  * Copyright (C) 2006-2013 Oracle Corporation
     6 * Copyright (C) 2006-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    415415#ifdef IN_RC
    416416/** @defgroup grp_pgm_gc  The PGM Guest Context API
    417  * @ingroup grp_pgm
    418417 * @{
    419418 */
    … …  
    425424#ifdef IN_RING0
    426425/** @defgroup grp_pgm_r0  The PGM Host Context Ring-0 API
    427  * @ingroup grp_pgm
    428426 * @{
    429427 */
    … …  
    451449#ifdef IN_RING3
    452450/** @defgroup grp_pgm_r3  The PGM Host Context Ring-3 API
    453  * @ingroup grp_pgm
    454451 * @{
    455452 */

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

    r44528 r53615  
    44
    55/*
    6  * Copyright (C) 2006-2011 Oracle Corporation
     6 * Copyright (C) 2006-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    5656#ifdef IN_RING3
    5757/** @defgroup grp_rem_r3   REM Host Context Ring 3 API
    58  * @ingroup grp_rem
    5958 * @{
    6059 */

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

    r45705 r53615  
    44
    55/*
    6  * Copyright (C) 2006-2012 Oracle Corporation
     6 * Copyright (C) 2006-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    8686#ifdef IN_RING3
    8787/** @defgroup grp_selm_r3   The Selector Monitor(/Manager) API
    88  * @ingroup grp_selm
    8988 * @{
    9089 */

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

    r46493 r53615  
    10981098
    10991099/** @defgroup grp_stam_r3   The STAM Host Context Ring 3 API
    1100  * @ingroup grp_stam
    11011100 * @{
    11021101 */

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

    r51643 r53615  
    44
    55/*
    6  * Copyright (C) 2006-2013 Oracle Corporation
     6 * Copyright (C) 2006-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    246246#ifdef IN_RING3
    247247/** @defgroup grp_tm_r3     The TM Host Context Ring-3 API
    248  * @ingroup grp_tm
    249248 * @{
    250249 */

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

    r45728 r53615  
    44
    55/*
    6  * Copyright (C) 2006-2012 Oracle Corporation
     6 * Copyright (C) 2006-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    9393#ifdef IN_RING3
    9494/** @defgroup grp_trpm_r3   TRPM Host Context Ring 3 API
    95  * @ingroup grp_trpm
    9695 * @{
    9796 */
    … …  
    116115
    117116#ifdef IN_RC
    118 /** @defgroup grp_trpm_gc    The TRPM Guest Context API
    119  * @ingroup grp_trpm
     117/** @defgroup grp_trpm_rc    The TRPM Raw-mode Context API
    120118 * @{
    121119 */
    … …  
    141139#ifdef IN_RING0
    142140/** @defgroup grp_trpm_r0   TRPM Host Context Ring 0 API
    143  * @ingroup grp_trpm
    144141 * @{
    145142 */

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

    r39303 r53615  
    102102}
    103103
    104 /** @ */
     104/** @} */
    105105
    106106#endif

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

    r50001 r53615  
    44
    55/*
    6  * Copyright (C) 2006-2013 Oracle Corporation
     6 * Copyright (C) 2006-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    270270
    271271
    272 #ifdef IN_RING3
     272#if defined(IN_RING3) || defined(DOXYGEN_RUNNING)
    273273/** @defgroup grp_vmm_r3    The VMM Host Context Ring 3 API
    274  * @ingroup grp_vmm
    275274 * @{
    276275 */
    … …  
    337336
    338337/** @defgroup grp_vmm_r0    The VMM Host Context Ring 0 API
    339  * @ingroup grp_vmm
    340338 * @{
    341339 */
    … …  
    504502typedef GCFGMVALUEREQ *PGCFGMVALUEREQ;
    505503
    506 #ifdef IN_RING0
     504#if defined(IN_RING0) || defined(DOXYGEN_RUNNING)
    507505VMMR0DECL(int)       VMMR0EntryInt(PVM pVM, VMMR0OPERATION enmOperation, void *pvArg);
    508506VMMR0DECL(void)      VMMR0EntryFast(PVM pVM, VMCPUID idCpu, VMMR0OPERATION enmOperation);
    … …  
    532530
    533531
    534 #ifdef IN_RC
     532#if defined(IN_RC) || defined(DOXYGEN_RUNNING)
    535533/** @defgroup grp_vmm_rc    The VMM Raw-Mode Context API
    536  * @ingroup grp_vmm
    537534 * @{
    538535 */
    … …  
    543540#endif /* IN_RC */
    544541
    545 #if defined(IN_RC) || defined(IN_RING0)
     542#if defined(IN_RC) || defined(IN_RING0) || defined(DOXYGEN_RUNNING)
    546543/** @defgroup grp_vmm_rz    The VMM Raw-Mode and Ring-0 Context API
    547  * @ingroup grp_vmm
    548544 * @{
    549545 */

  • trunk/include/iprt/asm.h

    r52929 r53615  
    142142 */
    143143#ifndef RT_INLINE_DONT_MIX_CMPXCHG8B_AND_PIC
    144 # define RT_INLINE_DONT_MIX_CMPXCHG8B_AND_PIC \
     144# ifdef DOXYGEN_RUNNING
     145#  define RT_INLINE_DONT_MIX_CMPXCHG8B_AND_PIC 1
     146# else
     147#  define RT_INLINE_DONT_MIX_CMPXCHG8B_AND_PIC \
    145148    (   (defined(PIC) || defined(__PIC__)) \
    146149     && defined(RT_ARCH_X86) \
    147150     && (   RT_INLINE_ASM_GCC_4_3_X_X86 \
    148151         || defined(RT_OS_DARWIN)) )
     152# endif
    149153#endif
    150154

  • trunk/include/iprt/cdrom.h

    r39730 r53615  
    44
    55/*
    6  * Copyright (C) 2012 Oracle Corporation
     6 * Copyright (C) 2012-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    3131RT_C_DECLS_BEGIN
    3232
    33 /** @defgroup grp_cdrom     IPRT CD/DVD/BD-ROM Drive API
     33/** @defgroup grp_rt_cdrom  IPRT CD/DVD/BD-ROM Drive API
     34 * @ingroup grp_rt
    3435 *
    3536 * The user of the API is currently resposible for serializing calls to it.

  • trunk/include/iprt/cpp/utils.h

    r48833 r53615  
    44
    55/*
    6  * Copyright (C) 2006-2011 Oracle Corporation
     6 * Copyright (C) 2006-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    4242 * Inherit from this class in order to prevent automatic generation
    4343 * of the copy constructor and assignment operator in your class.
    44  *
    45  * @addtogroup grp_rt_cpp_util
    4644 */
    4745class RTCNonCopyable

  • trunk/include/iprt/err.h

    r52533 r53615  
    44
    55/*
    6  * Copyright (C) 2006-2013 Oracle Corporation
     6 * Copyright (C) 2006-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    4444
    4545/** @defgroup grp_rt_err_hlp        Status Code Helpers
    46  * @ingroup grp_rt_err
    4746 * @{
    4847 */

  • trunk/include/iprt/filesystem.h

    r41549 r53615  
    3333RT_C_DECLS_BEGIN
    3434
    35 /** @defgroup grp_filesystem           IPRT Filesystem VFS
     35/** @defgroup grp_rt_filesystem           IPRT Filesystem VFS
     36 *
     37 * @todo r=bird: WRONG WRONG WRONG FILE. We already have a file system API in
     38 * IPRT, it is RTFs*, see @ref grp_rt_fs.  NOBODY ADDS ANY NEW APIS HERE!!
     39 *
    3640 * @{
    3741 */

  • trunk/include/iprt/queueatomic.h

    r46185 r53615  
    44
    55/*
    6  * Copyright (C) 2013 Oracle Corporation
     6 * Copyright (C) 2013-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    3030#include <iprt/asm.h>
    3131
    32 /** @defgroup grp_rt_list    RTQueueAtomic - Generic Work Queue
     32/** @defgroup grp_rt_queueatomic RTQueueAtomic - Generic Work Queue
    3333 * @ingroup grp_rt
    3434 *
    … …  
    122122
    123123#endif
     124

  • trunk/include/iprt/socket.h

    r53536 r53615  
    44
    55/*
    6  * Copyright (C) 2006-2012 Oracle Corporation
     6 * Copyright (C) 2006-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    4040RT_C_DECLS_BEGIN
    4141
    42 /** @defgroup grp_rt_tcp    RTSocket - Network Sockets
     42/** @defgroup grp_rt_socket RTSocket - Network Sockets
    4343 * @ingroup grp_rt
    4444 * @{

  • trunk/include/iprt/string.h

    r52944 r53615  
    26022602
    26032603/** @defgroup rt_str_conv   String To/From Number Conversions
    2604  * @ingroup grp_rt_str
    26052604 * @{ */
    26062605
    … …  
    30443043
    30453044/** @defgroup rt_str_space  Unique String Space
    3046  * @ingroup grp_rt_str
    30473045 * @{
    30483046 */
    … …  
    31663164
    31673165/** @defgroup rt_str_hash       Sting hashing
    3168  * @ingroup grp_rt_str
    31693166 * @{ */
    31703167
    … …  
    32153212
    32163213/** @defgroup rt_str_utf16      UTF-16 String Manipulation
    3217  * @ingroup grp_rt_str
    32183214 * @{
    32193215 */
    … …  
    40614057
    40624058/** @defgroup rt_str_latin1     Latin-1 (ISO-8859-1) String Manipulation
    4063  * @ingroup grp_rt_str
    40644059 * @{
    40654060 */

  • trunk/include/iprt/tcp.h

    r53536 r53615  
    44
    55/*
    6  * Copyright (C) 2006-2010 Oracle Corporation
     6 * Copyright (C) 2006-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as

  • trunk/include/iprt/types.h

    r53020 r53615  
    760760
    761761/** @defgroup grp_rt_types_both  Common Guest and Host Context Basic Types
    762  * @ingroup grp_rt_types
    763762 * @{
    764763 */
    … …  
    950949
    951950/** @defgroup grp_rt_types_hc  Host Context Basic Types
    952  * @ingroup grp_rt_types
    953951 * @{
    954952 */
    … …  
    12291227
    12301228/** @defgroup grp_rt_types_gc  Guest Context Basic Types
    1231  * @ingroup grp_rt_types
    12321229 * @{
    12331230 */
    … …  
    14311428
    14321429/** @defgroup grp_rt_types_rc  Raw mode Context Basic Types
    1433  * @ingroup grp_rt_types
    14341430 * @{
    14351431 */
    … …  
    14831479
    14841480/** @defgroup grp_rt_types_cc  Current Context Basic Types
    1485  * @ingroup grp_rt_types
    14861481 * @{
    14871482 */

  • trunk/include/iprt/uint128.h

    r52335 r53615  
    44
    55/*
    6  * Copyright (C) 2011 Oracle Corporation
     6 * Copyright (C) 2011-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    3737RT_C_DECLS_BEGIN
    3838
    39 /** @defgroup grp_rt_once      RTUInt128 - 128-bit Unsigned Integer Methods
     39/** @defgroup grp_rt_uint128 RTUInt128 - 128-bit Unsigned Integer Methods
    4040 * @ingroup grp_rt
    4141 * @{

  • trunk/include/iprt/uri.h

    r50507 r53615  
    44
    55/*
    6  * Copyright (C) 2011 Oracle Corporation
     6 * Copyright (C) 2011-2015 Oracle Corporation
    77 *
    88 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    109109 * Adds file: scheme support to the generic RTUri interface. This is partly
    110110 * documented in http://datatracker.ietf.org/doc/rfc1738/.
    111  * @ingroup grp_rt_uri
    112111 * @{
    113112 */

  • trunk/include/iprt/vfs.h

    r47359 r53615  
    130130                                      bool *pfUsed);
    131131
    132 /** @defgroup grp_vfs_dir           VFS Base Object API
     132/** @defgroup grp_vfs_obj           VFS Base Object API
    133133 * @{
    134134 */

  • trunk/include/iprt/vfslowlevel.h

    r44529 r53615  
    11531153/** Mask of valid flags. */
    11541154#define RTVFSCHAIN_PF_VALID_MASK                UINT32_C(0x00000007)
    1155 /** @}*/
     1155/** @} */
    11561156
    11571157/**
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