#include <PiPei.h>
#include <Ppi/UsbIo.h>
#include <Ppi/UsbHostController.h>
#include <Ppi/BlockIo.h>
#include <Ppi/BlockIo2.h>
#include <Library/DebugLib.h>
#include <IndustryStandard/Usb.h>
#include <IndustryStandard/Atapi.h>

Data Structures
struct	PEI_BOT_DEVICE

Macros
#define	PEI_FAT_MAX_USB_IO_PPI 127

#define	USBCDROM 1

#define	USBFLOPPY 2

#define	USBFLOPPY2 3

#define	PEI_BOT_DEVICE_SIGNATURE SIGNATURE_32 ('U', 'B', 'O', 'T')

#define	PEI_BOT_DEVICE_FROM_THIS(a) CR (a, PEI_BOT_DEVICE, BlkIoPpi, PEI_BOT_DEVICE_SIGNATURE)

#define	PEI_BOT_DEVICE2_FROM_THIS(a) CR (a, PEI_BOT_DEVICE, BlkIo2Ppi, PEI_BOT_DEVICE_SIGNATURE)

Functions
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)

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	PeiAtapiCommand (IN EFI_PEI_SERVICES *PeiServices, IN PEI_BOT_DEVICE PeiBotDev, IN VOID Command, IN UINT8 CommandSize, IN VOID DataBuffer, IN UINT32 BufferLength, IN EFI_USB_DATA_DIRECTION Direction, IN UINT16 TimeOutInMilliSeconds)

Detailed Description

Usb BOT Peim definition.

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

Definition in file UsbBotPeim.h.

Macro Definition Documentation

◆ PEI_BOT_DEVICE2_FROM_THIS

#define PEI_BOT_DEVICE2_FROM_THIS ( a ) CR (a, PEI_BOT_DEVICE, BlkIo2Ppi, PEI_BOT_DEVICE_SIGNATURE)

Definition at line 308 of file UsbBotPeim.h.

◆ PEI_BOT_DEVICE_FROM_THIS

#define PEI_BOT_DEVICE_FROM_THIS ( a ) CR (a, PEI_BOT_DEVICE, BlkIoPpi, PEI_BOT_DEVICE_SIGNATURE)

Definition at line 307 of file UsbBotPeim.h.

◆ PEI_BOT_DEVICE_SIGNATURE

#define PEI_BOT_DEVICE_SIGNATURE SIGNATURE_32 ('U', 'B', 'O', 'T')

Definition at line 289 of file UsbBotPeim.h.

◆ PEI_FAT_MAX_USB_IO_PPI

#define PEI_FAT_MAX_USB_IO_PPI 127

Definition at line 25 of file UsbBotPeim.h.

◆ USBCDROM

#define USBCDROM 1

Definition at line 281 of file UsbBotPeim.h.

◆ USBFLOPPY

#define USBFLOPPY 2

Definition at line 283 of file UsbBotPeim.h.

◆ USBFLOPPY2

#define USBFLOPPY2 3

Definition at line 284 of file UsbBotPeim.h.

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.

◆ PeiAtapiCommand()

EFI_STATUS PeiAtapiCommand	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN PEI_BOT_DEVICE *	PeiBotDev,
		IN VOID *	Command,
		IN UINT8	CommandSize,
		IN VOID *	DataBuffer,
		IN UINT32	BufferLength,
		IN EFI_USB_DATA_DIRECTION	Direction,
		IN UINT16	TimeOutInMilliSeconds
	)

Send ATAPI command using BOT protocol.

Parameters

PeiServices	The pointer of EFI_PEI_SERVICES.
PeiBotDev	The instance to PEI_BOT_DEVICE.
Command	The command to be sent to ATAPI device.
CommandSize	The length of the data to be sent.
DataBuffer	The pointer to the data.
BufferLength	The length of the data.
Direction	The direction of the data.
TimeOutInMilliSeconds	Indicates the maximum time, in millisecond, which the transfer is allowed to complete.

Return values

EFI_DEVICE_ERROR	Successful to get the status of device.
EFI_SUCCESS	Failed to get the status of device.

Definition at line 321 of file BotPeim.c.

Data Structures

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ PEI_BOT_DEVICE2_FROM_THIS

◆ PEI_BOT_DEVICE_FROM_THIS

◆ PEI_BOT_DEVICE_SIGNATURE

◆ PEI_FAT_MAX_USB_IO_PPI

◆ USBCDROM

◆ USBFLOPPY

◆ USBFLOPPY2

Function Documentation

◆ BotGetMediaInfo()

◆ BotGetMediaInfo2()

◆ BotGetNumberOfBlockDevices()

◆ BotGetNumberOfBlockDevices2()

◆ BotReadBlocks()

◆ BotReadBlocks2()

◆ InitUsbBot()

◆ NotifyOnUsbIoPpi()

◆ PeiAtapiCommand()