VirtualBox

Changeset 99739 in vbox for trunk/src/VBox/Devices/Storage


Ignore:
Timestamp:
May 11, 2023 1:01:08 AM (22 months ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
157315
Message:

*: doxygen corrections (mostly about removing @returns from functions returning void).

Location:
trunk/src/VBox/Devices/Storage
Files:
17 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/VBox/Devices/Storage/ATAPIPassthrough.cpp

    r98103 r99739  
    165165 * Initilizes the given track from the given CUE sheet entry.
    166166 *
    167  * @returns nothing.
    168167 * @param   pTrack             The track to initialize.
    169168 * @param   pbCueSheetEntry    CUE sheet entry to use.
     
    476475 * Dump the complete track list to the release log.
    477476 *
    478  * @returns nothing.
    479477 * @param   pTrackList   The track list to dump.
    480478 */
     
    517515 * Destroys the allocated task list handle.
    518516 *
    519  * @returns nothing.
    520517 * @param   pTrackList  The track list handle to destroy.
    521518 */
     
    530527 * Clears all tracks from the given task list.
    531528 *
    532  * @returns nothing.
    533529 * @param   pTrackList  The track list to clear.
    534530 */
  • trunk/src/VBox/Devices/Storage/DevAHCI.cpp

    r98103 r99739  
    637637 * Memory buffer callback.
    638638 *
    639  * @returns nothing.
    640639 * @param   pDevIns  The device instance.
    641640 * @param   GCPhys   The guest physical address of the memory buffer.
     
    985984 * Finishes the port reset of the given port.
    986985 *
    987  * @returns nothing.
    988986 * @param   pDevIns     The device instance.
    989987 * @param   pThis       The shared AHCI state.
     
    10491047 * Kicks the I/O thread from RC or R0.
    10501048 *
    1051  * @returns nothing.
    10521049 * @param   pDevIns     The device instance.
    10531050 * @param   pAhciPort   The port to kick, shared bits.
     
    25342531 * Dump info about the FIS
    25352532 *
    2536  * @returns nothing
    25372533 * @param   pAhciPort     The port the command FIS was read from (shared bits).
    25382534 * @param   cmdFis        The FIS to print info from.
     
    26162612 * Dump info about the command header
    26172613 *
    2618  * @returns nothing
    26192614 * @param   pAhciPort   Pointer to the port the command header was read from
    26202615 *                      (shared bits).
     
    26512646 * Post the first D2H FIS from the device into guest memory.
    26522647 *
    2653  * @returns nothing
    26542648 * @param   pDevIns     The device instance.
    26552649 * @param   pAhciPort   Pointer to the port which "receives" the FIS (shared bits).
     
    29362930 * Reset all values after a reset of the attached storage device.
    29372931 *
    2938  * @returns nothing
    29392932 * @param   pDevIns     The device instance.
    29402933 * @param   pThis       The shared AHCI state.
     
    29662959 * Initiates a device reset caused by ATA_DEVICE_RESET (ATAPI only).
    29672960 *
    2968  * @returns nothing.
    29692961 * @param   pDevIns     The device instance.
    29702962 * @param   pThis       The shared AHCI state.
     
    29882980 * Create a PIO setup FIS and post it into the memory area of the guest.
    29892981 *
    2990  * @returns nothing.
    29912982 * @param   pDevIns     The device instance.
    29922983 * @param   pThis       The shared AHCI state.
     
    30563047 * Build a D2H FIS and post into the memory area of the guest.
    30573048 *
    3058  * @returns Nothing
    30593049 * @param   pDevIns     The device instance.
    30603050 * @param   pThis       The shared AHCI state.
     
    31263116 * Build a SDB Fis and post it into the memory area of the guest.
    31273117 *
    3128  * @returns Nothing
    31293118 * @param   pDevIns         The device instance.
    31303119 * @param   pThis           The shared AHCI state.
     
    35853574 * Frees a given AHCI request structure.
    35863575 *
    3587  * @returns nothing.
    35883576 * @param   pAhciPortR3 The AHCI port, ring-3 bits.
    35893577 * @param   pAhciReq    The request to free.
  • trunk/src/VBox/Devices/Storage/DevATA.cpp

    r98271 r99739  
    12751275 * Enters the lock protecting the controller data against concurrent access.
    12761276 *
    1277  * @returns nothing.
    12781277 * @param   pDevIns     The device instance.
    12791278 * @param   pCtl        The controller to lock.
     
    12901289 * Leaves the lock protecting the controller against concurrent data access.
    12911290 *
    1292  * @returns nothing.
    12931291 * @param   pDevIns     The device instance.
    12941292 * @param   pCtl        The controller to unlock.
     
    71367134 * Resume notification.
    71377135 *
    7138  * @returns VBox status code.
    71397136 * @param   pDevIns     The device instance data.
    71407137 */
     
    76017598 * Power Off notification.
    76027599 *
    7603  * @returns VBox status code.
    76047600 * @param   pDevIns     The device instance data.
    76057601 */
     
    76147610 * Suspend notification.
    76157611 *
    7616  * @returns VBox status code.
    76177612 * @param   pDevIns     The device instance data.
    76187613 */
  • trunk/src/VBox/Devices/Storage/DevBusLogic.cpp

    r98103 r99739  
    10291029 * Memory buffer callback.
    10301030 *
    1031  * @returns nothing.
    10321031 * @param   pDevIns The device instance.
    10331032 * @param   pThis   Pointer to the shared BusLogic instance data.
     
    10651064 * an interrupt of a different type is still pending.
    10661065 *
    1067  * @returns nothing.
    10681066 * @param   pDevIns         The device instance.
    10691067 * @param   pThis           Pointer to the shared BusLogic instance data.
     
    11191117 * Deasserts the interrupt line of the BusLogic adapter.
    11201118 *
    1121  * @returns nothing.
    11221119 * @param   pDevIns     The device instance.
    11231120 * @param   pThis       Pointer to the shared BusLogic instance data.
     
    11461143 * Advances the mailbox pointer to the next slot.
    11471144 *
    1148  * @returns nothing.
    11491145 * @param   pThis       Pointer to the shared BusLogic instance data.
    11501146 */
     
    11571153 * Initialize local RAM of host adapter with default values.
    11581154 *
    1159  * @returns nothing.
    11601155 * @param   pThis       Pointer to the shared BusLogic instance data.
    11611156 */
     
    12321227 * Note that suppressing CMDC also suppresses the interrupt, but not vice versa.
    12331228 *
    1234  * @returns nothing.
    12351229 * @param   pDevIns         The device instance.
    12361230 * @param   pThis           Pointer to the shared BusLogic instance data.
     
    12631257 * Memory write helper to handle PCI/ISA differences - metadata writes.
    12641258 *
    1265  * @returns nothing.
    12661259 * @param   pDevIns     The device instance.
    12671260 * @param   pThis       Pointer to the shared BusLogic instance data.
     
    12811274 * Memory read helper to handle PCI/ISA differences - metadata reads.
    12821275 *
    1283  * @returns nothing.
    12841276 * @param   pDevIns     The device instance.
    12851277 * @param   pThis       Pointer to the shared BusLogic instance data.
     
    12961288}
    12971289
    1298 #if defined(IN_RING3)
     1290#ifdef IN_RING3
    12991291
    13001292/**
    13011293 * Memory write helper to handle PCI/ISA differences - userdata writes.
    13021294 *
    1303  * @returns nothing.
    13041295 * @param   pDevIns     The device instance.
    13051296 * @param   pThis       Pointer to the shared BusLogic instance data.
     
    13191310 * Memory read helper to handle PCI/ISA differences - userdata reads.
    13201311 *
    1321  * @returns nothing.
    13221312 * @param   pDevIns     The device instance.
    13231313 * @param   pThis       Pointer to the shared BusLogic instance data.
     
    13371327 * Initiates a hard reset which was issued from the guest.
    13381328 *
    1339  * @returns nothing
    13401329 * @param   pDevIns     The device instance.
    13411330 * @param   pThis       Pointer to the shared BusLogic instance data.
     
    13631352 * Send a mailbox with set status codes to the guest.
    13641353 *
    1365  * @returns nothing.
    13661354 * @param   pDevIns                 The device instance.
    13671355 * @param   pThis                   Pointer to the shared BusLogic instance data.
     
    14691457 * Dumps the content of a command control block for debugging purposes.
    14701458 *
    1471  * @returns nothing.
    14721459 * @param   pCCB            Pointer to the command control block to dump.
    14731460 * @param   fIs24BitCCB     Flag to determine CCB format.
     
    18421829 * Free the sense buffer.
    18431830 *
    1844  * @returns nothing.
    18451831 * @param   pReq         Pointer to the request state.
    18461832 * @param   fCopy        If sense data should be copied to guest memory.
     
    28552841 * Update the ISA I/O range.
    28562842 *
    2857  * @returns nothing.
     2843 * @returns VBox status code.
    28582844 * @param   pDevIns         The device instance.
    28592845 * @param   pThis           Pointer to the shared BusLogic instance data.
     
    29142900 * Completes a request initiated by the BIOS through the BUSLOGICCOMMAND_EXECUTE_SCSI_COMMAND command.
    29152901 *
    2916  * @returns nothing.
    29172902 * @param   pThis       Pointer to the shared BusLogic instance data.
    29182903 * @param   u8ScsiSts   The SCSI status code.
     
    33853370 * Processes a SCSI request issued by the BIOS with the BUSLOGICCOMMAND_EXECUTE_SCSI_COMMAND command.
    33863371 *
    3387  * @returns nothing.
    33883372 * @param   pDevIns     The device instance.
    33893373 * @param   pThis       Pointer to the shared BusLogic instance data.
  • trunk/src/VBox/Devices/Storage/DevLsiLogicSCSI.cpp

    r98103 r99739  
    101101 * Memory buffer callback.
    102102 *
    103  * @returns nothing.
    104103 * @param   pDevIns     The device instance.
    105104 * @param   GCPhys      The guest physical address of the memory buffer.
     
    449448 * Updates the status of the interrupt pin of the device.
    450449 *
    451  * @returns nothing.
    452450 * @param   pDevIns     The device instance.
    453451 * @param   pThis       Pointer to the shared LsiLogic device state.
     
    480478 * updates the interrupt status.
    481479 *
    482  * @returns nothing.
    483480 * @param   pDevIns     The device instance.
    484481 * @param   pThis       Pointer to the shared LsiLogic device state.
     
    495492 * updates the interrupt status.
    496493 *
    497  * @returns nothing.
    498494 * @param   pDevIns     The device instance.
    499495 * @param   pThis       Pointer to the shared LsiLogic device state.
     
    511507 * Sets the I/O controller into fault state and sets the fault code.
    512508 *
    513  * @returns nothing
    514509 * @param   pThis           Pointer to the shared LsiLogic device state.
    515510 * @param   uIOCFaultCode   Fault code to set.
     
    618613 * Allocates the configuration pages based on the device.
    619614 *
    620  * @returns nothing.
     615 * @returns VBox status code.
    621616 * @param   pThis    Pointer to the shared LsiLogic device state.
    622617 * @param   pThisCC  Pointer to the ring-3 LsiLogic device state.
     
    686681 * Frees the configuration pages if allocated.
    687682 *
    688  * @returns nothing.
    689683 * @param   pThis    Pointer to the shared LsiLogic device state.
    690684 * @param   pThisCC  Pointer to the ring-3 LsiLogic device state.
     
    732726 * Finishes a context reply.
    733727 *
    734  * @returns nothing
    735728 * @param   pDevIns             The device instance.
    736729 * @param   pThis               Pointer to the shared LsiLogic device state.
     
    771764 * Takes necessary steps to finish a reply frame.
    772765 *
    773  * @returns nothing
    774766 * @param   pDevIns         The device instance.
    775767 * @param   pThis           Pointer to the shared LsiLogic device state.
     
    891883 * Frees all allocated memory regions.
    892884 *
    893  * @returns nothing.
    894885 * @param   pThisCC         Pointer to the ring-3 LsiLogic device state.
    895886 */
     
    910901 * Inserts a given memory region into the list.
    911902 *
    912  * @returns nothing.
    913903 * @param   pThisCC         Pointer to the ring-3 LsiLogic device state.
    914904 * @param   pRegion         The region to insert.
     
    955945 * Handles a write to the diagnostic data register.
    956946 *
    957  * @returns nothing.
    958947 * @param   pThis           Pointer to the shared LsiLogic device state.
    959948 * @param   pThisCC         Pointer to the ring-3 LsiLogic device state.
     
    10451034 * Handles a read from the diagnostic data register.
    10461035 *
    1047  * @returns nothing.
    10481036 * @param   pThis           Pointer to the shared LsiLogic device state.
    10491037 * @param   pThisCC         Pointer to the ring-3 LsiLogic device state.
     
    10771065 * Handles a write to the diagnostic memory address register.
    10781066 *
    1079  * @returns nothing.
    10801067 * @param   pThis           Pointer to the shared LsiLogic device state.
    10811068 * @param   u32Addr         Address to write.
     
    10891076 * Handles a read from the diagnostic memory address register.
    10901077 *
    1091  * @returns nothing.
    10921078 * @param   pThis           Pointer to the shared LsiLogic device state.
    10931079 * @param   pu32Addr        Where to store the current address.
     
    19101896 * Dump an SG entry.
    19111897 *
    1912  * @returns nothing.
    19131898 * @param   pSGEntry    Pointer to the SG entry to dump
    19141899 */
     
    22202205 * Handles the completion of th given request.
    22212206 *
    2222  * @returns nothing.
    22232207 * @param   pDevIns     The device instance.
    22242208 * @param   pThis       Pointer to the shared LsiLogic device state.
     
    33463330 * Initializes the configuration pages for the SPI SCSI controller.
    33473331 *
    3348  * @returns nothing
    33493332 * @param   pThis       Pointer to the shared LsiLogic device state.
    33503333 * @param   pThisCC     Pointer to the ring-3 LsiLogic device state.
     
    34503433 * Generates a SAS address (WWID)
    34513434 *
    3452  * @returns nothing.
    34533435 * @param   pSASAddress Pointer to an unitialised SAS address.
    34543436 * @param   iId         iId which will go into the address.
     
    34713453 * Initializes the configuration pages for the SAS SCSI controller.
    34723454 *
    3473  * @returns nothing
    34743455 * @param   pThis       Pointer to the shared LsiLogic device state.
    34753456 * @param   pThisCC     Pointer to the ring-3 LsiLogic device state.
     
    36503631 * Initializes the configuration pages.
    36513632 *
    3652  * @returns nothing
    36533633 * @param   pDevIns     The device instance.
    36543634 * @param   pThis       Pointer to the shared LsiLogic device state.
     
    41064086 * or loaded from a saved state.
    41074087 *
    4108  * @returns nothing.
    41094088 * @param   pDevIns     The device instance.
    41104089 * @param   pThis       Pointer to the shared LsiLogic device state.
  • trunk/src/VBox/Devices/Storage/DevVirtioSCSI.cpp

    r98661 r99739  
    721721 * Wrapper around virtioCoreR3VirtqUsedBufPut() and virtioCoreVirtqUsedRingSync() doing some device locking.
    722722 *
    723  * @returns nothing.
    724723 * @param   pDevIns         The PDM device instance.
    725724 * @param   pVirtio         Pointer to the shared virtio core structure.
     
    829828 * Releases one reference from the given controller instances active request counter.
    830829 *
    831  * @returns nothing.
    832830 * @param   pDevIns     The device instance.
    833831 * @param   pThis       VirtIO SCSI shared instance data.
     
    845843 * Retains one reference for the given controller instances active request counter.
    846844 *
    847  * @returns nothing.
    848845 * @param   pThis       VirtIO SCSI shared instance data.
    849846 */
  • trunk/src/VBox/Devices/Storage/DrvDiskIntegrity.cpp

    r98103 r99739  
    685685 * Adds a request to the active list.
    686686 *
    687  * @returns nothing.
    688687 * @param   pThis    The driver instance data.
    689688 * @param   pIoReq   The request to add.
     
    706705 * Removes a request from the active list.
    707706 *
    708  * @returns nothing.
    709707 * @param   pThis    The driver instance data.
    710708 * @param   pIoReq   The request to remove.
     
    787785 * Fires a read event if enabled.
    788786 *
    789  * @returns nothing.
    790787 * @param   pThis    The driver instance data.
    791788 * @param   uGrp     The group ID.
     
    808805 * Fires a write event if enabled.
    809806 *
    810  * @returns nothing.
    811807 * @param   pThis    The driver instance data.
    812808 * @param   uGrp     The group ID.
     
    829825 * Fires a flush event if enabled.
    830826 *
    831  * @returns nothing.
    832827 * @param   pThis    The driver instance data.
    833828 * @param   uGrp     The group ID.
     
    848843 * Fires a request complete event if enabled.
    849844 *
    850  * @returns nothing.
    851845 * @param   pThis    The driver instance data.
    852846 * @param   uGrp     The group ID.
  • trunk/src/VBox/Devices/Storage/DrvHostBase.cpp

    r98103 r99739  
    11491149 * Deregisters statistics associated with the given media driver.
    11501150 *
    1151  * @returns nothing.
    11521151 * @param   pThis      The media driver instance.
    11531152 */
  • trunk/src/VBox/Devices/Storage/DrvRamDisk.cpp

    r98561 r99739  
    10461046 * Frees a I/O memory buffer allocated previously.
    10471047 *
    1048  * @returns nothing.
    10491048 * @param   pThis     VBox disk container instance data.
    10501049 * @param   pIoReq    I/O request for which to free memory.
  • trunk/src/VBox/Devices/Storage/DrvVD.cpp

    r98271 r99739  
    24762476 * device/driver above about the completion if requested.
    24772477 *
    2478  * @returns VBox status code.
    24792478 * @param   pThis     VBox disk container instance data.
    24802479 * @param   pIoReq    I/O request to complete.
     
    30273026 * Tries to process any requests waiting for available I/O memory.
    30283027 *
    3029  * @returns nothing.
    30303028 * @param   pThis     VBox disk container instance data.
    30313029 */
     
    31083106 * Frees a I/O memory buffer allocated previously.
    31093107 *
    3110  * @returns nothing.
    31113108 * @param   pThis     VBox disk container instance data.
    31123109 * @param   pIoReq    I/O request for which to free memory.
     
    31863183 * Dumps the interesting bits about the given I/O request to the release log.
    31873184 *
    3188  * @returns nothing.
    31893185 * @param   pThis     VBox disk container instance data.
    31903186 * @param   pIoReq    The I/O request to dump.
     
    42014197 * Deregisters statistics associated with the given media driver.
    42024198 *
    4203  * @returns nothing.
    42044199 * @param   pThis      The media driver instance.
    42054200 */
     
    42844279 * Worker for the power off or destruct callback.
    42854280 *
    4286  * @returns nothing.
    42874281 * @param   pDrvIns    The driver instance.
    42884282 */
  • trunk/src/VBox/Devices/Storage/HBDMgmt-darwin.cpp

    r98103 r99739  
    124124 * Unclaims the given block device and frees its state removing it from the list.
    125125 *
    126  * @returns nothing.
    127126 * @param   pDev           The block device to unclaim.
    128127 */
     
    295294 * Dummy handler for the wakeup source to kick the worker thread.
    296295 *
    297  * @returns nothing.
    298296 * @param   pInfo            Opaque user data given during source creation, unused.
    299297 */
  • trunk/src/VBox/Devices/Storage/HBDMgmt-win.cpp

    r98103 r99739  
    9595 * Unclaims the given block device and frees its state removing it from the list.
    9696 *
    97  * @returns nothing.
    9897 * @param   pDev           The block device to unclaim.
    9998 */
  • trunk/src/VBox/Devices/Storage/HBDMgmt.h

    r98103 r99739  
    5757 * Destroys the given block device manager unclaiming all managed block devices.
    5858 *
    59  * @returns nothing.
    6059 * @param   hHbdMgr     The block device manager.
    6160 */
  • trunk/src/VBox/Devices/Storage/IOBufMgmt.cpp

    r98103 r99739  
    176176 * Resets the bins to factory default (memory resigin in the largest bin).
    177177 *
    178  * @returns nothing.
    179178 * @param   pThis       The I/O buffer manager instance.
    180179 */
  • trunk/src/VBox/Devices/Storage/IOBufMgmt.h

    r98103 r99739  
    111111 * Frees a given I/O buffer.
    112112 *
    113  * @returns nothing.
    114113 * @param   pIoBufDesc         The I/O buffer descriptor to free.
    115114 */
  • trunk/src/VBox/Devices/Storage/UsbMsd.cpp

    r98103 r99739  
    10781078 * Process a completed request.
    10791079 *
    1080  * @returns nothing.
    10811080 * @param   pThis               The MSD instance.
    10821081 * @param   pReq                The request.
  • trunk/src/VBox/Devices/Storage/VSCSI/VSCSIInternal.h

    r98103 r99739  
    321321 * Completes a SCSI request and calls the completion handler.
    322322 *
    323  * @returns nothing.
    324323 * @param   pVScsiDevice    The virtual SCSI device.
    325324 * @param   pVScsiReq       The request which completed.
     
    335334 * Init the sense data state.
    336335 *
    337  * @returns nothing.
    338336 * @param   pVScsiSense  The SCSI sense data state to init.
    339337 */
     
    396394 * Destroys the given VPD page pool freeing all pages in it.
    397395 *
    398  * @returns nothing.
    399396 * @param   pVScsiVpdPool    The VPD page pool to destroy.
    400397 */
     
    495492 * Sets the transfer size for the given request.
    496493 *
    497  * @returns nothing.
    498494 * @param   pVScsiReq     The SCSI request.
    499495 * @param   cbXfer        The transfer size for the request.
     
    507503 * Sets the transfer direction for the given request.
    508504 *
    509  * @returns nothing.
    510505 * @param   pVScsiReq     The SCSI request.
    511506 * @param   cbXfer        The transfer size for the request.
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