VirtualBox

Changeset 41783 in vbox for trunk/src/VBox/Devices/EFI


Ignore:
Timestamp:
Jun 16, 2012 7:24:15 PM (13 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
78601
Message:

Doxygen, comment typos.

Location:
trunk/src/VBox/Devices/EFI/Firmware2/VBoxPkg
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/VBox/Devices/EFI/Firmware2/VBoxPkg/Include/Library/GenericBdsLib.h

    r33540 r41783  
    135135/**
    136136  This function will enumerate all possible boot devices in the system, and
    137   automatically create boot options for Network, Shell, Removable BlockIo, 
    138   and Non-BlockIo Simplefile devices. 
    139  
     137  automatically create boot options for Network, Shell, Removable BlockIo,
     138  and Non-BlockIo Simplefile devices.
     139
    140140  BDS separates EFI boot options into six types:
    141   1. Network - The boot option points to the SimpleNetworkProtocol device. 
     141  1. Network - The boot option points to the SimpleNetworkProtocol device.
    142142               Bds will try to automatically create this type of boot option during enumeration.
    143   2. Shell   - The boot option points to internal flash shell. 
     143  2. Shell   - The boot option points to internal flash shell.
    144144               Bds will try to automatically create this type of boot option during enumeration.
    145145  3. Removable BlockIo      - The boot option points to a removable media
    … …  
    147147                              These devices should contain a *removable* blockIo
    148148                              protocol in their device handle.
    149                               Bds will try to automatically create this type boot option 
     149                              Bds will try to automatically create this type boot option
    150150                              when enumerate.
    151   4. Fixed BlockIo          - The boot option points to a Fixed blockIo device, 
     151  4. Fixed BlockIo          - The boot option points to a Fixed blockIo device,
    152152                              such as a hard disk.
    153153                              These devices should contain a *fixed* blockIo
    154154                              protocol in their device handle.
    155155                              BDS will skip fixed blockIo devices, and not
    156                               automatically create boot option for them. But BDS 
    157                               will help to delete those fixed blockIo boot options, 
     156                              automatically create boot option for them. But BDS
     157                              will help to delete those fixed blockIo boot options,
    158158                              whose description rules conflict with other auto-created
    159159                              boot options.
    160   5. Non-BlockIo Simplefile - The boot option points to a device whose handle 
     160  5. Non-BlockIo Simplefile - The boot option points to a device whose handle
    161161                              has SimpleFileSystem Protocol, but has no blockio
    162162                              protocol. These devices do not offer blockIo
    163                               protocol, but BDS still can get the 
     163                              protocol, but BDS still can get the
    164164                              \EFI\BOOT\boot{machinename}.EFI by SimpleFileSystem
    165165                              Protocol.
    166   6. File    - The boot option points to a file. These boot options are usually 
     166  6. File    - The boot option points to a file. These boot options are usually
    167167               created by the user, either manually or with an OS loader. BDS will not delete or modify
    168                these boot options.       
    169    
     168               these boot options.
     169
    170170  This function will enumerate all possible boot devices in the system, and
    171   automatically create boot options for Network, Shell, Removable BlockIo, 
     171  automatically create boot options for Network, Shell, Removable BlockIo,
    172172  and Non-BlockIo Simplefile devices.
    173173  It will excute once every boot.
    174  
     174
    175175  @param  BdsBootOptionList      The header of the linked list that indexed all
    176176                                 current boot options
    … …  
    365365//
    366366/**
    367   This function connects all system drivers with the corresponding controllers. 
     367  This function connects all system drivers with the corresponding controllers.
    368368
    369369**/
    … …  
    387387  This function creates all handles associated with the given device
    388388  path node. If the handle associated with one device path node can not
    389   be created, then it tries to execute the dispatch to load the missing drivers. 
     389  be created, then it tries to execute the dispatch to load the missing drivers.
    390390
    391391  @param  DevicePathToConnect   The device path to be connected. Can be
    … …  
    504504//
    505505/**
    506   Delete the instance in Multi that overlaps with Single 
     506  Delete the instance in Multi that overlaps with Single
    507507
    508508  @param  Multi                 A pointer to a multi-instance device path data
    … …  
    604604
    605605/**
    606   Shadow all Legacy OptionRom. 
     606  Shadow all Legacy OptionRom.
    607607
    608608**/
    … …  
    643643  Add the legacy boot options from BBS table if they do not exist.
    644644
    645   @retval EFI_SUCCESS          The boot options are added successfully 
     645  @retval EFI_SUCCESS          The boot options are added successfully
    646646                               or they are already in boot options.
    647647  @retval EFI_NOT_FOUND        No legacy boot options is found.
    … …  
    656656
    657657/**
    658   Add the legacy boot devices from BBS table into 
     658  Add the legacy boot devices from BBS table into
    659659  the legacy device boot order.
    660660
    … …  
    675675
    676676  @param  Entry             The boot option is to be checked for refresh BBS table.
    677  
     677
    678678  @retval EFI_SUCCESS           The boot priority for BBS entries is refreshed successfully.
    679679  @retval EFI_NOT_FOUND         BBS entries can't be found.
    … …  
    844844/**
    845845  Expand a device path that starts with a hard drive media device path node to be a
    846   full device path that includes the full hardware path to the device. This function enables the device to boot. 
     846  full device path that includes the full hardware path to the device. This function enables the device to boot.
    847847  To avoid requiring a connect on every boot, the front match is saved in a variable (the part point
    848848  to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ).
    … …  
    861861  IN  HARDDRIVE_DEVICE_PATH      *HardDriveDevicePath
    862862  );
    863  
     863
    864864/**
    865865  Return the bootable media handle.
    866866  First, check whether the device is connected.
    867867  Second, check whether the device path points to a device that supports SimpleFileSystemProtocol.
    868   Third, detect the the default boot file in the Media, and return the removable Media handle.
     868  Third, detect the default boot file in the Media, and return the removable Media handle.
    869869
    870870  @param  DevicePath             Device Path to a  bootable device
    … …  
    879879  IN OUT CHAR16                     **NewFileName
    880880  );
    881  
     881
    882882
    883883/**
    … …  
    927927  @param  DevicePath                      The bootable device Path to check
    928928
    929   @retval BDS_EFI_MEDIA_HD_BOOT           If given device path contains MEDIA_DEVICE_PATH type device path node                                           which subtype is MEDIA_HARDDRIVE_DP  @retval BDS_EFI_MEDIA_CDROM_BOOT        If given device path contains MEDIA_DEVICE_PATH type device path node                                          which subtype is MEDIA_CDROM_DP  @retval BDS_EFI_ACPI_FLOPPY_BOOT        If given device path contains ACPI_DEVICE_PATH type device path node                                          which HID is floppy device.  @retval BDS_EFI_MESSAGE_ATAPI_BOOT      If given device path contains MESSAGING_DEVICE_PATH type device path node                                          and its last device path node's subtype is MSG_ATAPI_DP.  @retval BDS_EFI_MESSAGE_SCSI_BOOT       If given device path contains MESSAGING_DEVICE_PATH type device path node                                          and its last device path node's subtype is MSG_SCSI_DP.  @retval BDS_EFI_MESSAGE_USB_DEVICE_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node                                          and its last device path node's subtype is MSG_USB_DP.  @retval BDS_EFI_MESSAGE_MISC_BOOT       If the device path not contains any media device path node,  and                                          its last device path node point to a message device path node.  @retval BDS_LEGACY_BBS_BOOT             If given device path contains BBS_DEVICE_PATH type device path node.  @retval BDS_EFI_UNSUPPORT               An EFI Removable BlockIO device path not point to a media and message device,   
     929  @retval BDS_EFI_MEDIA_HD_BOOT           If given device path contains MEDIA_DEVICE_PATH type device path node                                           which subtype is MEDIA_HARDDRIVE_DP  @retval BDS_EFI_MEDIA_CDROM_BOOT        If given device path contains MEDIA_DEVICE_PATH type device path node                                          which subtype is MEDIA_CDROM_DP  @retval BDS_EFI_ACPI_FLOPPY_BOOT        If given device path contains ACPI_DEVICE_PATH type device path node                                          which HID is floppy device.  @retval BDS_EFI_MESSAGE_ATAPI_BOOT      If given device path contains MESSAGING_DEVICE_PATH type device path node                                          and its last device path node's subtype is MSG_ATAPI_DP.  @retval BDS_EFI_MESSAGE_SCSI_BOOT       If given device path contains MESSAGING_DEVICE_PATH type device path node                                          and its last device path node's subtype is MSG_SCSI_DP.  @retval BDS_EFI_MESSAGE_USB_DEVICE_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node                                          and its last device path node's subtype is MSG_USB_DP.  @retval BDS_EFI_MESSAGE_MISC_BOOT       If the device path not contains any media device path node,  and                                          its last device path node point to a message device path node.  @retval BDS_LEGACY_BBS_BOOT             If given device path contains BBS_DEVICE_PATH type device path node.  @retval BDS_EFI_UNSUPPORT               An EFI Removable BlockIO device path not point to a media and message device,
    930930**/
    931931UINT32
    … …  
    946946  VOID
    947947  );
    948  
     948
    949949
    950950/**
    … …  
    986986
    987987  @retval EFI_SUCCESS           The specific Usb device is connected successfully.
    988   @retval EFI_INVALID_PARAMETER Invalid HostControllerPi (not 0x00, 0x20 or 0xFF) 
     988  @retval EFI_INVALID_PARAMETER Invalid HostControllerPi (not 0x00, 0x20 or 0xFF)
    989989                                or RemainingDevicePath is not the USB class device path.
    990990  @retval EFI_NOT_FOUND         The device specified by device path is not found.
    … …  
    997997  IN EFI_DEVICE_PATH_PROTOCOL   *RemainingDevicePath
    998998  );
    999  
     999
    10001000
    10011001//
    … …  
    10541054
    10551055/**
    1056   Use SystemTable ConOut to turn on video based Simple Text Out consoles. The 
     1056  Use SystemTable ConOut to turn on video based Simple Text Out consoles. The
    10571057  Simple Text Out screens will now be synced up with all non video output devices
    10581058

  • trunk/src/VBox/Devices/EFI/Firmware2/VBoxPkg/Library/VBoxGenericBdsLib/BdsBoot.c

    r37147 r41783  
    14281428  First, check the device is connected
    14291429  Second, check whether the device path point to a device which support SimpleFileSystemProtocol,
    1430   Third, detect the the default boot file in the Media, and return the removable Media handle.
     1430  Third, detect the default boot file in the Media, and return the removable Media handle.
    14311431
    14321432  @param  DevicePath  Device Path to a  bootable device
    … …  
    15031503
    15041504  //
    1505   // Detect the the default boot file from removable Media
     1505  // Detect the default boot file from removable Media
    15061506  //
    15071507
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