VirtualBox

Ignore:
Timestamp:
Oct 20, 2015 1:58:41 PM (9 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
103540
Message:

HostDrivers: Doxygen fixes

Location:
trunk/src/VBox/HostDrivers/Support
Files:
17 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/VBox/HostDrivers/Support/SUPDrv-dtrace.cpp

    r57358 r58340  
    10461046/**
    10471047 * Module initialization code.
    1048  *
    1049  * @param   hMod            Opque module handle.
    10501048 */
    10511049const SUPDRVTRACERREG * VBOXCALL supdrvDTraceInit(void)

  • trunk/src/VBox/HostDrivers/Support/SUPDrv.cpp

    r57735 r58340  
    23982398 * @param   pSession    Session data.
    23992399 * @param   pReqHdr     The request header.
     2400 * @param   cbReq       The size of the request buffer.
    24002401 */
    24012402int VBOXCALL supdrvIOCtl(uintptr_t uIOCtl, PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPREQHDR pReqHdr, size_t cbReq)
    … …  
    26202621 *          All future reference must use this identifier.
    26212622 * @returns NULL on failure.
     2623 * @param   pSession        The caller's session.
     2624 * @param   enmType         The object type.
    26222625 * @param   pfnDestructor   The destructore function which will be called when the reference count reaches 0.
    26232626 * @param   pvUser1         The first user argument.
    … …  
    33813384 * @param   ppvR3       Where to store the address of the Ring-3 mapping.
    33823385 *                      NULL if no ring-3 mapping.
    3383  * @param   ppvR3       Where to store the address of the Ring-0 mapping.
     3386 * @param   ppvR0       Where to store the address of the Ring-0 mapping.
    33843387 *                      NULL if no ring-0 mapping.
    33853388 * @param   paPages     Where to store the addresses of the pages. Optional.
    … …  
    36463649 * Reports a bad context, currenctly that means EFLAGS.AC is 0 instead of 1.
    36473650 *
    3648  * @param   pSession        The session of the caller.
     3651 * @param   pDevExt         The device extension.
    36493652 * @param   pszFile         The source file where the caller detected the bad
    36503653 *                          context.
    … …  
    38693872 *
    38703873 * @returns VBox status code.
    3871  * @param   fIsSmxModeAmbiguous   Where to write whether the SMX mode causes
     3874 * @param   pfIsSmxModeAmbiguous  Where to return whether the SMX mode causes
    38723875 *                                ambiguity that makes us unsure whether we
    38733876 *                                really can use VT-x or not.
    … …  
    38763879 *          The caller is also expected to check that the CPU is an Intel (or
    38773880 *          VIA) CPU -and- that it supports VT-x.  Otherwise, this function
    3878  *          might throw a #GP fault as it tries to read/write MSRs that may not
     3881 *          might throw a \#GP fault as it tries to read/write MSRs that may not
    38793882 *          be present!
    38803883 */
    … …  
    52325235 * @returns IPRT status code.
    52335236 * @param   pDevExt             Device globals.
    5234  * @param   pSession            Session data.
    5235  * @param   pVMMR0              VMMR0 image handle.
     5237 * @param   pvVMMR0             VMMR0 image handle.
    52365238 * @param   pvVMMR0EntryFast    VMMR0EntryFast address.
    52375239 * @param   pvVMMR0EntryEx      VMMR0EntryEx address.

  • trunk/src/VBox/HostDrivers/Support/SUPDrvGip.cpp

    r57358 r58340  
    42424242 *          other error code on internal error.
    42434243 *
    4244  * @param   pThis           Pointer to the grant service instance data.
     4244 * @param   pDevExt         The device instance data.
    42454245 * @param   enmCurState     The current state.
    42464246 * @param   enmNewState     The new state we're waiting for it to enter.

  • trunk/src/VBox/HostDrivers/Support/SUPDrvIOC.h

    r57378 r58340  
    14421442                } Modify;
    14431443
    1444                 /** Reserve space for the future.. */
     1444                /** Reserve space for the future. */
    14451445                uint64_t        auPadding[3];
    14461446            } uArgs;

  • trunk/src/VBox/HostDrivers/Support/SUPDrvInternal.h

    r57378 r58340  
    231231#endif
    232232
     233#ifdef DOXYGEN_RUNNING
     234# define SUPDRV_WITH_MSR_PROBER
     235# define SUPDRV_WITHOUT_MSR_PROBER
     236#endif
     237
    233238#if 1
    234 /**  Use a dedicated kernel thread to service TSC-delta measurement requests.
    235  *   @todo Test on servers with many CPUs and sockets. */
    236 #define SUPDRV_USE_TSC_DELTA_THREAD
    237 #endif
     239/** @def SUPDRV_USE_TSC_DELTA_THREAD
     240 * Use a dedicated kernel thread to service TSC-delta measurement requests.
     241 * @todo Test on servers with many CPUs and sockets. */
     242# define SUPDRV_USE_TSC_DELTA_THREAD
     243#endif
     244
    238245
    239246/*******************************************************************************

  • trunk/src/VBox/HostDrivers/Support/SUPDrvTracer.cpp

    r57358 r58340  
    249249 * @param   uVtgHdrAddr         The address where the header is actually
    250250 *                              loaded.
    251  * @param   cbVtgObj            The alleged size of the header.
    252251 * @param   pbImage             The image base, if available.
    253252 * @param   cbImage             The image size, if available.
    … …  
    868867 *
    869868 * @returns VBox status code.
    870  * @param   pszName             The driver name.
     869 * @param   pDevExt             The device instance data.
    871870 * @param   pVtgHdr             The VTG object header.
    872871 * @param   pImage              The image if applicable.
    … …  
    11031102 *
    11041103 * @param   pSession            The support driver session handle.
    1105  * @param   pVtgHdr             The VTG header.
    11061104 */
    11071105SUPR0DECL(void) SUPR0TracerDeregisterDrv(PSUPDRVSESSION pSession)

  • trunk/src/VBox/HostDrivers/Support/SUPLib.cpp

    r57358 r58340  
    17911791 *
    17921792 * @param   pThis               The string table structure.
    1793  * @param   paProbLocs          The probe location array.
    1794  * @param   cProbLocs           The number of probe locations.
     1793 * @param   paProbeLocs32       The probe location array, 32-bit type variant.
     1794 * @param   paProbeLocs64       The probe location array, 64-bit type variant.
     1795 * @param   cProbeLocs          The number of elements in the array.
     1796 * @param   f32Bit              Set if @a paProbeLocs32 should be used, when
     1797 *                              clear use @a paProbeLocs64.
    17951798 */
    17961799static void supr3TracerDestroyStrTab(PSUPDRVTRACERSTRTAB pThis, PVTGPROBELOC32 paProbeLocs32, PVTGPROBELOC64 paProbeLocs64,
    … …  
    18191822 *
    18201823 * @returns Pointer to a string table structure.  NULL on failure.
    1821  * @param   paProbLocs          The probe location array.
    1822  * @param   cProbLocs           The number of elements in the array.
    1823  * @param   cBits
     1824 * @param   paProbeLocs32       The probe location array, 32-bit type variant.
     1825 * @param   paProbeLocs64       The probe location array, 64-bit type variant.
     1826 * @param   cProbeLocs          The number of elements in the array.
     1827 * @param   offDelta            Relocation offset for the string pointers.
     1828 * @param   f32Bit              Set if @a paProbeLocs32 should be used, when
     1829 *                              clear use @a paProbeLocs64.
    18241830 */
    18251831static PSUPDRVTRACERSTRTAB supr3TracerCreateStrTab(PVTGPROBELOC32 paProbeLocs32,

  • trunk/src/VBox/HostDrivers/Support/SUPLibLdr.cpp

    r57378 r58340  
    350350 *
    351351 * @returns VBox status code.
    352  * @param   pszFilename     Name of the VMMR0 image file
     352 * @param   pszFilename         Name of the VMMR0 image file
     353 * @param   pszModule           The modulen name.
     354 * @param   pszSrvReqHandler    The service request handler symbol name,
     355 *                              optional.
     356 * @param   pErrInfo            Where to store detailed error info. Optional.
     357 * @param   ppvImageBase        Where to return the load address.
    353358 */
    354359static int supLoadModule(const char *pszFilename, const char *pszModule, const char *pszSrvReqHandler,

  • trunk/src/VBox/HostDrivers/Support/SUPR0IdcClientStubs.c

    r57358 r58340  
    4040 *
    4141 * @param   pHandle     The IDC handle.
     42 * @param   ppfn        Where to return the address of the symbol.
    4243 * @param   pszName     The name of the symbol.
    4344 */
    … …  
    6667 * @returns Pointer to the symbol on success, NULL on failure.
    6768 *
    68  * @param   pHandle     The IDC handle.
     69 * @param   pSession    The IDC session.
     70 * @param   ppfn        Where to return the address of the symbol.
    6971 * @param   pszName     The name of the symbol.
    7072 */

  • trunk/src/VBox/HostDrivers/Support/SUPR3HardenedMain.cpp

    r58132 r58340  
    845845
    846846/**
    847  * Returns the full path to the executable.
     847 * Returns the full path to the executable in g_szSupLibHardenedExePath.
    848848 *
    849849 * @returns IPRT status code.
    850  * @param   pszPath     Where to store it.
    851  * @param   cchPath     How big that buffer is.
    852850 */
    853851static void supR3HardenedGetFullExePath(void)

  • trunk/src/VBox/HostDrivers/Support/SUPSvc.cpp

    r57358 r58340  
    305305 *
    306306 * @param   pszFormat   The log string. No trailing newline.
    307  * @param   ...         Format arguments.
     307 * @param   va          Format arguments.
    308308 *
    309309 * @todo    This should later be replaced by the release logger and callback destination(s).

  • trunk/src/VBox/HostDrivers/Support/SUPSvcInternal.h

    r56293 r58340  
    5454 * Logs the message to the appropriate system log.
    5555 *
    56  * @param   psMsg       The log string.
     56 * @param   pszMsg      The log string.
    5757 */
    5858void supSvcOsLogErrorStr(const char *pszMsg);

  • trunk/src/VBox/HostDrivers/Support/darwin/SUPDrv-darwin.cpp

    r58277 r58340  
    849849 *
    850850 * @returns VBox status code, see supdrvIDC.
    851  * @param   iReq        The request code.
     851 * @param   uReq        The request code.
    852852 * @param   pReq        The request.
    853853 */

  • trunk/src/VBox/HostDrivers/Support/freebsd/SUPDrv-freebsd.c

    r57358 r58340  
    7575static d_open_t     VBoxDrvFreeBSDOpenUsr;
    7676static d_open_t     VBoxDrvFreeBSDOpenSys;
    77 static void         VBoxDrvFreeBSDDtr(void *pData);
     77static void         VBoxDrvFreeBSDDtr(void *pvData);
    7878static d_ioctl_t    VBoxDrvFreeBSDIOCtl;
    7979static int          VBoxDrvFreeBSDIOCtlSlow(PSUPDRVSESSION pSession, u_long ulCmd, caddr_t pvData, struct thread *pTd);
    … …  
    225225 * @returns 0 on success, errno on failure.
    226226 *          EBUSY if the device is used by someone else.
    227  * @param   pDev        The device node.
    228  * @param   fOpen       The open flags.
    229  * @param   pTd         The thread.
    230  * @param   iDevType    ???
    231  */
    232 static int vboxdrvFreeBSDOpenCommon(struct cdev *pDev, int fOpen, int iDevtype, struct thread *pTd, bool fUnrestricted)
     227 * @param   pDev            The device node.
     228 * @param   fOpen           The open flags.
     229 * @param   iDevType        Some device type thing we don't use.
     230 * @param   pTd             The thread.
     231 * @param   fUnrestricted   Set if opening /dev/vboxdrv, clear if /dev/vboxdrvu.
     232 */
     233static int vboxdrvFreeBSDOpenCommon(struct cdev *pDev, int fOpen, int iDevType, struct thread *pTd, bool fUnrestricted)
    233234{
    234235    PSUPDRVSESSION pSession;
    … …  
    253254        pSession->Uid = stuff;
    254255        pSession->Gid = stuff; */
    255         devfs_set_cdevpriv(pSession, VBoxDrvFreeBSDDtr);
     256        rc = devfs_set_cdevpriv(pSession, vboxdrvFreeBSDDtr); Assert(rc == 0);
    256257        Log(("VBoxDrvFreeBSDOpen: pSession=%p\n", pSession));
    257258        ASMAtomicIncU32(&g_cUsers);
    … …  
    264265
    265266/** For vboxdrv. */
    266 static int VBoxDrvFreeBSDOpenSys(struct cdev *pDev, int fOpen, int iDevtype, struct thread *pTd)
    267 {
    268     return vboxdrvFreeBSDOpenCommon(pDev, fOpen, iDevtype, pTd, true);
     267static int VBoxDrvFreeBSDOpenSys(struct cdev *pDev, int fOpen, int iDevType, struct thread *pTd)
     268{
     269    return vboxdrvFreeBSDOpenCommon(pDev, fOpen, iDevType, pTd, true);
    269270}
    270271
    271272
    272273/** For vboxdrvu. */
    273 static int VBoxDrvFreeBSDOpenUsr(struct cdev *pDev, int fOpen, int iDevtype, struct thread *pTd)
    274 {
    275     return vboxdrvFreeBSDOpenCommon(pDev, fOpen, iDevtype, pTd, false);
    276 }
    277 
    278 
    279 /**
    280  * Close a file device previously opened by VBoxDrvFreeBSDOpen
     274static int VBoxDrvFreeBSDOpenUsr(struct cdev *pDev, int fOpen, int iDevType, struct thread *pTd)
     275{
     276    return vboxdrvFreeBSDOpenCommon(pDev, fOpen, iDevType, pTd, false);
     277}
     278
     279
     280/**
     281 * Close a file device previously opened by VBoxDrvFreeBSDOpen.
    281282 *
    282283 * @returns 0 on success.
    283  * @param   pDev        The device.
    284  * @param   fFile       The file descriptor flags.
    285  * @param   DevType     The device type (CHR.
    286  * @param   pTd         The calling thread.
    287  */
    288 static void VBoxDrvFreeBSDDtr(void *pData)
    289 {
    290     PSUPDRVSESSION pSession = pData;
    291     Log(("VBoxDrvFreeBSDDtr: pSession=%p\n", pSession));
     284 * @param   pvData      The session being closed.
     285 */
     286static void vboxdrvFreeBSDDtr(void *pvData)
     287{
     288    PSUPDRVSESSION pSession = pvData;
     289    Log(("vboxdrvFreeBSDDtr: pSession=%p\n", pSession));
    292290
    293291    /*
    … …  
    469467 *
    470468 * @returns VBox status code, see supdrvIDC.
    471  * @param   iReq        The request code.
     469 * @param   uReq        The request code.
    472470 * @param   pReq        The request.
    473471 */

  • trunk/src/VBox/HostDrivers/Support/linux/SUPDrv-linux.c

    r57840 r58340  
    604604 * Suspend callback.
    605605 * @param   pDev        Pointer to the platform device.
    606  * @param   State       message type, see Documentation/power/devices.txt.
    607  */
    608 # if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 30)
     606 * @param   State       Message type, see Documentation/power/devices.txt.
     607 *                      Ignored.
     608 */
     609# if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 30) && !defined(DOXYGEN_RUNNING)
    609610static int VBoxDrvSuspend(struct device *pDev)
    610611# else
    … …  
    640641 * @param   ulArg       The argument specified to ioctl().
    641642 */
    642 #ifdef HAVE_UNLOCKED_IOCTL
     643#if defined(HAVE_UNLOCKED_IOCTL) || defined(DOXYGEN_RUNNING)
    643644static long VBoxDrvLinuxIOCtl(struct file *pFilp, unsigned int uCmd, unsigned long ulArg)
    644645#else
    … …  
    811812 *
    812813 * @returns VBox status code, see supdrvIDC.
    813  * @param   iReq        The request code.
     814 * @param   uReq        The request code.
    814815 * @param   pReq        The request.
    815816 */

  • trunk/src/VBox/HostDrivers/Support/solaris/SUPDrv-solaris.c

    r57358 r58340  
    665665 * @param   Dev             Device number
    666666 * @param   Cmd             Operation identifier
    667  * @param   pArg            Arguments from user to driver
     667 * @param   pArgs           Arguments from user to driver
    668668 * @param   Mode            Information bitfield (read/write, address space etc.)
    669669 * @param   pCred           User credentials
    … …  
    745745 *
    746746 * @param   pSession    The session.
    747  * @param   Cmd         The IOCtl command.
     747 * @param   iCmd        The IOCtl command.
    748748 * @param   Mode        Information bitfield (for specifying ownership of data)
    749749 * @param   iArg        User space address of the request buffer.
    … …  
    849849 *
    850850 * @returns VBox status code, see supdrvIDC.
    851  * @param   iReq        The request code.
     851 * @param   uReq        The request code.
    852852 * @param   pReq        The request.
    853853 */

  • trunk/src/VBox/HostDrivers/Support/win/SUPDrv-win.cpp

    r57501 r58340  
    10051005 * @param   pvOutput            The output buffer as specfied by the user.
    10061006 * @param   cbOutput            The size of the output buffer.
    1007  * @param   uFunction           The function.
     1007 * @param   uCmd                The I/O command/function being invoked.
    10081008 * @param   pIoStatus           Where to return the status of the operation.
    10091009 * @param   pDevObj             The device object..
    … …  
    12591259 * @returns NT status code.
    12601260 *
    1261  * @param   pDevObj     Device object.
     1261 * @param   pDevExt     Device extension.
    12621262 * @param   pSession    The session.
    12631263 * @param   pIrp        Request packet.
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