#include "UsbBotPeim.h"
#include "BotPeim.h"

Functions
EFI_STATUS	PeiBotDetectMedia (IN EFI_PEI_SERVICES *PeiServices, IN PEI_BOT_DEVICE PeiBotDev)

EFI_STATUS EFIAPI	PeimInitializeUsbBot (IN EFI_PEI_FILE_HANDLE FileHandle, IN CONST EFI_PEI_SERVICES **PeiServices)

EFI_STATUS EFIAPI	NotifyOnUsbIoPpi (IN EFI_PEI_SERVICES *PeiServices, IN EFI_PEI_NOTIFY_DESCRIPTOR NotifyDesc, IN VOID *InvokePpi)

EFI_STATUS	InitUsbBot (IN EFI_PEI_SERVICES *PeiServices, IN PEI_USB_IO_PPI UsbIoPpi)

EFI_STATUS EFIAPI	BotGetNumberOfBlockDevices (IN EFI_PEI_SERVICES *PeiServices, IN EFI_PEI_RECOVERY_BLOCK_IO_PPI This, OUT UINTN *NumberBlockDevices)

EFI_STATUS EFIAPI	BotGetMediaInfo (IN EFI_PEI_SERVICES *PeiServices, IN EFI_PEI_RECOVERY_BLOCK_IO_PPI This, IN UINTN DeviceIndex, OUT EFI_PEI_BLOCK_IO_MEDIA *MediaInfo)

EFI_STATUS EFIAPI	BotReadBlocks (IN EFI_PEI_SERVICES *PeiServices, IN EFI_PEI_RECOVERY_BLOCK_IO_PPI This, IN UINTN DeviceIndex, IN EFI_PEI_LBA StartLBA, IN UINTN BufferSize, OUT VOID *Buffer)

EFI_STATUS EFIAPI	BotGetNumberOfBlockDevices2 (IN EFI_PEI_SERVICES *PeiServices, IN EFI_PEI_RECOVERY_BLOCK_IO2_PPI This, OUT UINTN *NumberBlockDevices)

EFI_STATUS EFIAPI	BotGetMediaInfo2 (IN EFI_PEI_SERVICES *PeiServices, IN EFI_PEI_RECOVERY_BLOCK_IO2_PPI This, IN UINTN DeviceIndex, OUT EFI_PEI_BLOCK_IO2_MEDIA *MediaInfo)

EFI_STATUS EFIAPI	BotReadBlocks2 (IN EFI_PEI_SERVICES *PeiServices, IN EFI_PEI_RECOVERY_BLOCK_IO2_PPI This, IN UINTN DeviceIndex, IN EFI_PEI_LBA StartLBA, IN UINTN BufferSize, OUT VOID *Buffer)

Variables
EFI_PEI_NOTIFY_DESCRIPTOR	mNotifyList

EFI_PEI_RECOVERY_BLOCK_IO_PPI	mRecoveryBlkIoPpi

EFI_PEI_RECOVERY_BLOCK_IO2_PPI	mRecoveryBlkIo2Ppi

EFI_PEI_PPI_DESCRIPTOR	mPpiList [2]

Detailed Description

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file UsbBotPeim.c.

Function Documentation

◆ BotGetMediaInfo()

EFI_STATUS EFIAPI BotGetMediaInfo	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN EFI_PEI_RECOVERY_BLOCK_IO_PPI *	This,
		IN UINTN	DeviceIndex,
		OUT EFI_PEI_BLOCK_IO_MEDIA *	MediaInfo
	)

Gets a block device's media information.

This function will provide the caller with the specified block device's media information. If the media changes, calling this function will update the media information accordingly.

Parameters

[in]	PeiServices	General-purpose services that are available to every PEIM
[in]	This	Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
[in]	DeviceIndex	Specifies the block device to which the function wants to talk. Because the driver that implements Block I/O PPIs will manage multiple block devices, the PPIs that want to talk to a single device must specify the device index that was assigned during the enumeration process. This index is a number from one to NumberBlockDevices.
[out]	MediaInfo	The media information of the specified block media. The caller is responsible for the ownership of this data structure.

Return values

EFI_SUCCESS	Media information about the specified block device was obtained successfully.
EFI_DEVICE_ERROR	Cannot get the media information due to a hardware error.

Definition at line 348 of file UsbBotPeim.c.

◆ BotGetMediaInfo2()

EFI_STATUS EFIAPI BotGetMediaInfo2	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN EFI_PEI_RECOVERY_BLOCK_IO2_PPI *	This,
		IN UINTN	DeviceIndex,
		OUT EFI_PEI_BLOCK_IO2_MEDIA *	MediaInfo
	)

Gets a block device's media information.

This function will provide the caller with the specified block device's media information. If the media changes, calling this function will update the media information accordingly.

Parameters

[in]	PeiServices	General-purpose services that are available to every PEIM
[in]	This	Indicates the EFI_PEI_RECOVERY_BLOCK_IO2_PPI instance.
[in]	DeviceIndex	Specifies the block device to which the function wants to talk. Because the driver that implements Block I/O PPIs will manage multiple block devices, the PPIs that want to talk to a single device must specify the device index that was assigned during the enumeration process. This index is a number from one to NumberBlockDevices.
[out]	MediaInfo	The media information of the specified block media. The caller is responsible for the ownership of this data structure.

Return values

EFI_SUCCESS	Media information about the specified block device was obtained successfully.
EFI_DEVICE_ERROR	Cannot get the media information due to a hardware error.

Definition at line 625 of file UsbBotPeim.c.

◆ BotGetNumberOfBlockDevices()

EFI_STATUS EFIAPI BotGetNumberOfBlockDevices	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN EFI_PEI_RECOVERY_BLOCK_IO_PPI *	This,
		OUT UINTN *	NumberBlockDevices
	)

Gets the count of block I/O devices that one specific block driver detects.

This function is used for getting the count of block I/O devices that one specific block driver detects. To the PEI ATAPI driver, it returns the number of all the detected ATAPI devices it detects during the enumeration process. To the PEI legacy floppy driver, it returns the number of all the legacy devices it finds during its enumeration process. If no device is detected, then the function will return zero.

Parameters

[in]	PeiServices	General-purpose services that are available to every PEIM.
[in]	This	Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
[out]	NumberBlockDevices	The number of block I/O devices discovered.

Return values

EFI_SUCCESS Operation performed successfully.

Definition at line 306 of file UsbBotPeim.c.

◆ BotGetNumberOfBlockDevices2()

EFI_STATUS EFIAPI BotGetNumberOfBlockDevices2	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN EFI_PEI_RECOVERY_BLOCK_IO2_PPI *	This,
		OUT UINTN *	NumberBlockDevices
	)

Gets the count of block I/O devices that one specific block driver detects.

This function is used for getting the count of block I/O devices that one specific block driver detects. To the PEI ATAPI driver, it returns the number of all the detected ATAPI devices it detects during the enumeration process. To the PEI legacy floppy driver, it returns the number of all the legacy devices it finds during its enumeration process. If no device is detected, then the function will return zero.

Parameters

[in]	PeiServices	General-purpose services that are available to every PEIM.
[in]	This	Indicates the EFI_PEI_RECOVERY_BLOCK_IO2_PPI instance.
[out]	NumberBlockDevices	The number of block I/O devices discovered.

Return values

EFI_SUCCESS Operation performed successfully.

Definition at line 583 of file UsbBotPeim.c.

◆ BotReadBlocks()

EFI_STATUS EFIAPI BotReadBlocks	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN EFI_PEI_RECOVERY_BLOCK_IO_PPI *	This,
		IN UINTN	DeviceIndex,
		IN EFI_PEI_LBA	StartLBA,
		IN UINTN	BufferSize,
		OUT VOID *	Buffer
	)

Reads the requested number of blocks from the specified block device.

The function reads the requested number of blocks from the device. All the blocks are read, or an error is returned. If there is no media in the device, the function returns EFI_NO_MEDIA.

Parameters

[in]	PeiServices	General-purpose services that are available to every PEIM.
[in]	This	Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
[in]	DeviceIndex	Specifies the block device to which the function wants to talk. Because the driver that implements Block I/O PPIs will manage multiple block devices, the PPIs that want to talk to a single device must specify the device index that was assigned during the enumeration process. This index is a number from one to NumberBlockDevices.
[in]	StartLBA	The starting logical block address (LBA) to read from on the device
[in]	BufferSize	The size of the Buffer in bytes. This number must be a multiple of the intrinsic block size of the device.
[out]	Buffer	A pointer to the destination buffer for the data. The caller is responsible for the ownership of the buffer.

Return values

EFI_SUCCESS	The data was read correctly from the device.
EFI_DEVICE_ERROR	The device reported an error while attempting to perform the read operation.
EFI_INVALID_PARAMETER	The read request contains LBAs that are not valid, or the buffer is not properly aligned.
EFI_NO_MEDIA	There is no media in the device.
EFI_BAD_BUFFER_SIZE	The BufferSize parameter is not a multiple of the intrinsic block size of the device.

Definition at line 422 of file UsbBotPeim.c.

◆ BotReadBlocks2()

EFI_STATUS EFIAPI BotReadBlocks2	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN EFI_PEI_RECOVERY_BLOCK_IO2_PPI *	This,
		IN UINTN	DeviceIndex,
		IN EFI_PEI_LBA	StartLBA,
		IN UINTN	BufferSize,
		OUT VOID *	Buffer
	)

Reads the requested number of blocks from the specified block device.

The function reads the requested number of blocks from the device. All the blocks are read, or an error is returned. If there is no media in the device, the function returns EFI_NO_MEDIA.

Parameters

[in]	PeiServices	General-purpose services that are available to every PEIM.
[in]	This	Indicates the EFI_PEI_RECOVERY_BLOCK_IO2_PPI instance.
[in]	DeviceIndex	Specifies the block device to which the function wants to talk. Because the driver that implements Block I/O PPIs will manage multiple block devices, the PPIs that want to talk to a single device must specify the device index that was assigned during the enumeration process. This index is a number from one to NumberBlockDevices.
[in]	StartLBA	The starting logical block address (LBA) to read from on the device
[in]	BufferSize	The size of the Buffer in bytes. This number must be a multiple of the intrinsic block size of the device.
[out]	Buffer	A pointer to the destination buffer for the data. The caller is responsible for the ownership of the buffer.

Return values

EFI_SUCCESS	The data was read correctly from the device.
EFI_DEVICE_ERROR	The device reported an error while attempting to perform the read operation.
EFI_INVALID_PARAMETER	The read request contains LBAs that are not valid, or the buffer is not properly aligned.
EFI_NO_MEDIA	There is no media in the device.
EFI_BAD_BUFFER_SIZE	The BufferSize parameter is not a multiple of the intrinsic block size of the device.

Definition at line 693 of file UsbBotPeim.c.

◆ InitUsbBot()

EFI_STATUS InitUsbBot	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN PEI_USB_IO_PPI *	UsbIoPpi
	)

Initialize the usb bot device.

Parameters

[in]	PeiServices	General-purpose services that are available to every PEIM.
[in]	UsbIoPpi	Indicates the PEI_USB_IO_PPI instance.

Return values

EFI_SUCCESS	The usb bot device is initialized successfully.
Other	Failed to initialize media.

Definition at line 156 of file UsbBotPeim.c.

◆ NotifyOnUsbIoPpi()

EFI_STATUS EFIAPI NotifyOnUsbIoPpi	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN EFI_PEI_NOTIFY_DESCRIPTOR *	NotifyDesc,
		IN VOID *	InvokePpi
	)

UsbIo installation notification function.

This function finds out all the current USB IO PPIs in the system and add them into private data.

Parameters

PeiServices	Indirect reference to the PEI Services Table.
NotifyDesc	Address of the notification descriptor data structure.
InvokePpi	Address of the PPI that was invoked.

Return values

EFI_SUCCESS The function completes successfully.

Definition at line 129 of file UsbBotPeim.c.

◆ PeiBotDetectMedia()

EFI_STATUS PeiBotDetectMedia	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN PEI_BOT_DEVICE *	PeiBotDev
	)

Detect whether the removable media is present and whether it has changed.

Parameters

[in]	PeiServices	General-purpose services that are available to every PEIM.
[in]	PeiBotDev	Indicates the PEI_BOT_DEVICE instance.

Return values

EFI_SUCCESS	The media status is successfully checked.
Other	Failed to detect media.

Definition at line 736 of file UsbBotPeim.c.

◆ PeimInitializeUsbBot()

EFI_STATUS EFIAPI PeimInitializeUsbBot	(	IN EFI_PEI_FILE_HANDLE	FileHandle,
		IN CONST EFI_PEI_SERVICES **	PeiServices
	)

Initializes the Usb Bot.

Parameters

FileHandle	Handle of the file being invoked.
PeiServices	Describes the list of possible PEI Services.

Return values

EFI_SUCCESS	Usb bot driver is successfully initialized.
EFI_OUT_OF_RESOURCES	Can't initialize the driver.

Definition at line 76 of file UsbBotPeim.c.

Variable Documentation

◆ mNotifyList

EFI_PEI_NOTIFY_DESCRIPTOR mNotifyList

Initial value:

= {
  EFI_PEI_PPI_DESCRIPTOR_NOTIFY_DISPATCH | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,
  &gPeiUsbIoPpiGuid,
  NotifyOnUsbIoPpi
}

Definition at line 15 of file UsbBotPeim.c.

◆ mPpiList

EFI_PEI_PPI_DESCRIPTOR mPpiList[2]

Initial value:

= {
  {
    EFI_PEI_PPI_DESCRIPTOR_PPI,
    &gEfiPeiVirtualBlockIoPpiGuid,
    NULL
  },
  {
    EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,
    &gEfiPeiVirtualBlockIo2PpiGuid,
    NULL
  }
}

Definition at line 34 of file UsbBotPeim.c.

◆ mRecoveryBlkIo2Ppi

EFI_PEI_RECOVERY_BLOCK_IO2_PPI mRecoveryBlkIo2Ppi

Initial value:

= {
  EFI_PEI_RECOVERY_BLOCK_IO2_PPI_REVISION,
  BotGetNumberOfBlockDevices2,
  BotGetMediaInfo2,
  BotReadBlocks2
}

Definition at line 27 of file UsbBotPeim.c.

◆ mRecoveryBlkIoPpi

EFI_PEI_RECOVERY_BLOCK_IO_PPI mRecoveryBlkIoPpi

Initial value:

= {
  BotGetNumberOfBlockDevices,
  BotGetMediaInfo,
  BotReadBlocks
}

Definition at line 21 of file UsbBotPeim.c.

Functions

Variables

Detailed Description

Function Documentation

◆ BotGetMediaInfo()

◆ BotGetMediaInfo2()

◆ BotGetNumberOfBlockDevices()

◆ BotGetNumberOfBlockDevices2()

◆ BotReadBlocks()

◆ BotReadBlocks2()

◆ InitUsbBot()

◆ NotifyOnUsbIoPpi()

◆ PeiBotDetectMedia()

◆ PeimInitializeUsbBot()

Variable Documentation

◆ mNotifyList

◆ mPpiList

◆ mRecoveryBlkIo2Ppi

◆ mRecoveryBlkIoPpi