#include "DiskIo.h"

Functions
EFI_STATUS EFIAPI	DiskIoDriverBindingSupported (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath OPTIONAL)

EFI_STATUS EFIAPI	DiskIoDriverBindingStart (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath OPTIONAL)

EFI_STATUS EFIAPI	DiskIoDriverBindingStop (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE ControllerHandle, IN UINTN NumberOfChildren, IN EFI_HANDLE ChildHandleBuffer)

LIST_ENTRY *	DiskIoDestroySubtask (IN DISK_IO_PRIVATE_DATA Instance, IN DISK_IO_SUBTASK Subtask)

VOID EFIAPI	DiskIo2OnReadWriteComplete (IN EFI_EVENT Event, IN VOID *Context)

DISK_IO_SUBTASK *	DiskIoCreateSubtask (IN BOOLEAN Write, IN UINT64 Lba, IN UINT32 Offset, IN UINTN Length, IN VOID WorkingBuffer OPTIONAL, IN VOID Buffer, IN BOOLEAN Blocking)

BOOLEAN	DiskIoCreateSubtaskList (IN DISK_IO_PRIVATE_DATA Instance, IN BOOLEAN Write, IN UINT64 Offset, IN UINTN BufferSize, IN VOID Buffer, IN BOOLEAN Blocking, IN VOID SharedWorkingBuffer, IN OUT LIST_ENTRY Subtasks)

EFI_STATUS EFIAPI	DiskIo2Cancel (IN EFI_DISK_IO2_PROTOCOL *This)

BOOLEAN	DiskIo2RemoveCompletedTask (IN DISK_IO_PRIVATE_DATA *Instance)

EFI_STATUS	DiskIo2ReadWriteDisk (IN DISK_IO_PRIVATE_DATA Instance, IN BOOLEAN Write, IN UINT32 MediaId, IN UINT64 Offset, IN EFI_DISK_IO2_TOKEN Token, IN UINTN BufferSize, IN UINT8 *Buffer)

EFI_STATUS EFIAPI	DiskIo2ReadDiskEx (IN EFI_DISK_IO2_PROTOCOL This, IN UINT32 MediaId, IN UINT64 Offset, IN OUT EFI_DISK_IO2_TOKEN Token, IN UINTN BufferSize, OUT VOID *Buffer)

EFI_STATUS EFIAPI	DiskIo2WriteDiskEx (IN EFI_DISK_IO2_PROTOCOL This, IN UINT32 MediaId, IN UINT64 Offset, IN OUT EFI_DISK_IO2_TOKEN Token, IN UINTN BufferSize, IN VOID *Buffer)

VOID EFIAPI	DiskIo2OnFlushComplete (IN EFI_EVENT Event, IN VOID *Context)

EFI_STATUS EFIAPI	DiskIo2FlushDiskEx (IN EFI_DISK_IO2_PROTOCOL This, IN OUT EFI_DISK_IO2_TOKEN Token)

EFI_STATUS EFIAPI	DiskIoReadDisk (IN EFI_DISK_IO_PROTOCOL This, IN UINT32 MediaId, IN UINT64 Offset, IN UINTN BufferSize, OUT VOID Buffer)

EFI_STATUS EFIAPI	DiskIoWriteDisk (IN EFI_DISK_IO_PROTOCOL This, IN UINT32 MediaId, IN UINT64 Offset, IN UINTN BufferSize, IN VOID Buffer)

EFI_STATUS EFIAPI	InitializeDiskIo (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables
EFI_DRIVER_BINDING_PROTOCOL	gDiskIoDriverBinding

DISK_IO_PRIVATE_DATA	gDiskIoPrivateDataTemplate

Detailed Description

DiskIo driver that lays on every BlockIo protocol in the system. DiskIo converts a block oriented device to a byte oriented device.

Disk access may have to handle unaligned request about sector boundaries. There are three cases: UnderRun - The first byte is not on a sector boundary or the read request is less than a sector in length. Aligned - A read of N contiguous sectors. OverRun - The last byte is not on a sector boundary.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file DiskIo.c.

Function Documentation

◆ DiskIo2Cancel()

EFI_STATUS EFIAPI DiskIo2Cancel ( IN EFI_DISK_IO2_PROTOCOL * This )

Terminate outstanding asynchronous requests to a device.

Parameters

This	Indicates a pointer to the calling context.

Return values

EFI_SUCCESS	All outstanding requests were successfully terminated.
EFI_DEVICE_ERROR	The device reported an error while performing the cancel operation.

Definition at line 745 of file DiskIo.c.

◆ DiskIo2FlushDiskEx()

EFI_STATUS EFIAPI DiskIo2FlushDiskEx	(	IN EFI_DISK_IO2_PROTOCOL *	This,
		IN OUT EFI_DISK_IO2_TOKEN *	Token
	)

Flushes all modified data to the physical device.

Parameters

This	Indicates a pointer to the calling context.
Token	A pointer to the token associated with the transaction. If this field is NULL, synchronous/blocking IO is performed.

Return values

EFI_SUCCESS	If Event is NULL (blocking I/O): The data was flushed successfully to the device. If Event is not NULL (asynchronous I/O): The request was successfully queued for processing. Event will be signaled upon completion.
EFI_WRITE_PROTECTED	The device cannot be written to.
EFI_DEVICE_ERROR	The device reported an error while performing the write operation.
EFI_NO_MEDIA	There is no medium in the device.
EFI_OUT_OF_RESOURCES	The request could not be completed due to a lack of resources.

Definition at line 1152 of file DiskIo.c.

◆ DiskIo2OnFlushComplete()

VOID EFIAPI DiskIo2OnFlushComplete	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

The callback for the BlockIo2 FlushBlocksEx.

Parameters

Event	Event whose notification function is being invoked.
Context	The pointer to the notification function's context, which points to the DISK_IO2_FLUSH_TASK instance.

Definition at line 1118 of file DiskIo.c.

◆ DiskIo2OnReadWriteComplete()

VOID EFIAPI DiskIo2OnReadWriteComplete	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

The callback for the BlockIo2 ReadBlocksEx/WriteBlocksEx.

Parameters

Event	Event whose notification function is being invoked.
Context	The pointer to the notification function's context, which points to the DISK_IO_SUBTASK instance.

Definition at line 409 of file DiskIo.c.

◆ DiskIo2ReadDiskEx()

EFI_STATUS EFIAPI DiskIo2ReadDiskEx	(	IN EFI_DISK_IO2_PROTOCOL *	This,
		IN UINT32	MediaId,
		IN UINT64	Offset,
		IN OUT EFI_DISK_IO2_TOKEN *	Token,
		IN UINTN	BufferSize,
		OUT VOID *	Buffer
	)

Reads a specified number of bytes from a device.

Parameters

This	Indicates a pointer to the calling context.
MediaId	ID of the medium to be read.
Offset	The starting byte offset on the logical block I/O device to read from.
Token	A pointer to the token associated with the transaction. If this field is NULL, synchronous/blocking IO is performed.
BufferSize	The size in bytes of Buffer. The number of bytes to read from the device.
Buffer	A pointer to the destination buffer for the data. The caller is responsible either having implicit or explicit ownership of the buffer.

Return values

EFI_SUCCESS	If Event is NULL (blocking I/O): The data was read correctly from the device. If Event is not NULL (asynchronous I/O): The request was successfully queued for processing. Event will be signaled upon completion.
EFI_DEVICE_ERROR	The device reported an error while performing the write.
EFI_NO_MEDIA	There is no medium in the device.
EFI_MEDIA_CHNAGED	The MediaId is not for the current medium.
EFI_INVALID_PARAMETER	The read request contains device addresses that are not valid for the device.
EFI_OUT_OF_RESOURCES	The request could not be completed due to a lack of resources.

Definition at line 1046 of file DiskIo.c.

◆ DiskIo2ReadWriteDisk()

EFI_STATUS DiskIo2ReadWriteDisk	(	IN DISK_IO_PRIVATE_DATA *	Instance,
		IN BOOLEAN	Write,
		IN UINT32	MediaId,
		IN UINT64	Offset,
		IN EFI_DISK_IO2_TOKEN *	Token,
		IN UINTN	BufferSize,
		IN UINT8 *	Buffer
	)

Common routine to access the disk.

Parameters

Instance	Pointer to the DISK_IO_PRIVATE_DATA.
Write	TRUE: Write operation; FALSE: Read operation.
MediaId	ID of the medium to access.
Offset	The starting byte offset on the logical block I/O device to access.
Token	A pointer to the token associated with the transaction. If this field is NULL, synchronous/blocking IO is performed.
BufferSize	The size in bytes of Buffer. The number of bytes to read from the device.
Buffer	A pointer to the destination buffer for the data. The caller is responsible either having implicit or explicit ownership of the buffer.

Definition at line 830 of file DiskIo.c.

◆ DiskIo2RemoveCompletedTask()

BOOLEAN DiskIo2RemoveCompletedTask ( IN DISK_IO_PRIVATE_DATA * Instance )

Remove the completed tasks from Instance->TaskQueue. Completed tasks are those who don't have any subtasks.

Parameters

Instance Pointer to the DISK_IO_PRIVATE_DATA.

Return values

TRUE	The Instance->TaskQueue is empty after the completed tasks are removed.
FALSE	The Instance->TaskQueue is not empty after the completed tasks are removed.

Definition at line 788 of file DiskIo.c.

◆ DiskIo2WriteDiskEx()

EFI_STATUS EFIAPI DiskIo2WriteDiskEx	(	IN EFI_DISK_IO2_PROTOCOL *	This,
		IN UINT32	MediaId,
		IN UINT64	Offset,
		IN OUT EFI_DISK_IO2_TOKEN *	Token,
		IN UINTN	BufferSize,
		IN VOID *	Buffer
	)

Writes a specified number of bytes to a device.

Parameters

This	Indicates a pointer to the calling context.
MediaId	ID of the medium to be written.
Offset	The starting byte offset on the logical block I/O device to write to.
Token	A pointer to the token associated with the transaction. If this field is NULL, synchronous/blocking IO is performed.
BufferSize	The size in bytes of Buffer. The number of bytes to write to the device.
Buffer	A pointer to the buffer containing the data to be written.

Return values

EFI_SUCCESS	If Event is NULL (blocking I/O): The data was written correctly to the device. If Event is not NULL (asynchronous I/O): The request was successfully queued for processing. Event will be signaled upon completion.
EFI_WRITE_PROTECTED	The device cannot be written to.
EFI_DEVICE_ERROR	The device reported an error while performing the write operation.
EFI_NO_MEDIA	There is no medium in the device.
EFI_MEDIA_CHNAGED	The MediaId is not for the current medium.
EFI_INVALID_PARAMETER	The write request contains device addresses that are not valid for the device.
EFI_OUT_OF_RESOURCES	The request could not be completed due to a lack of resources.

Definition at line 1090 of file DiskIo.c.

◆ DiskIoCreateSubtask()

DISK_IO_SUBTASK * DiskIoCreateSubtask	(	IN BOOLEAN	Write,
		IN UINT64	Lba,
		IN UINT32	Offset,
		IN UINTN	Length,
		IN VOID *WorkingBuffer	OPTIONAL,
		IN VOID *	Buffer,
		IN BOOLEAN	Blocking
	)

Create the subtask.

Parameters

Write	TRUE: Write request; FALSE: Read request.
Lba	The starting logical block address to read from on the device.
Offset	The starting byte offset to read from the LBA.
Length	The number of bytes to read from the device.
WorkingBuffer	The aligned buffer to hold the data for reading or writing.
Buffer	The buffer to hold the data for reading or writing.
Blocking	TRUE: Blocking request; FALSE: Non-blocking request.

Returns: A pointer to the created subtask.

Definition at line 468 of file DiskIo.c.

◆ DiskIoCreateSubtaskList()

BOOLEAN DiskIoCreateSubtaskList	(	IN DISK_IO_PRIVATE_DATA *	Instance,
		IN BOOLEAN	Write,
		IN UINT64	Offset,
		IN UINTN	BufferSize,
		IN VOID *	Buffer,
		IN BOOLEAN	Blocking,
		IN VOID *	SharedWorkingBuffer,
		IN OUT LIST_ENTRY *	Subtasks
	)

Create the subtask list.

Parameters

Instance	Pointer to the DISK_IO_PRIVATE_DATA.
Write	TRUE: Write request; FALSE: Read request.
Offset	The starting byte offset to read from the device.
BufferSize	The size in bytes of Buffer. The number of bytes to read from the device.
Buffer	A pointer to the buffer for the data.
Blocking	TRUE: Blocking request; FALSE: Non-blocking request.
SharedWorkingBuffer	The aligned buffer to hold the data for reading or writing.
Subtasks	The subtask list header.

Return values

TRUE	The subtask list is created successfully.
FALSE	The subtask list is not created.

Definition at line 538 of file DiskIo.c.

◆ DiskIoDestroySubtask()

LIST_ENTRY * DiskIoDestroySubtask	(	IN DISK_IO_PRIVATE_DATA *	Instance,
		IN DISK_IO_SUBTASK *	Subtask
	)

Destroy the sub task.

Parameters

Instance	Pointer to the DISK_IO_PRIVATE_DATA.
Subtask	Subtask.

Returns: LIST_ENTRY * Pointer to the next link of subtask.

Definition at line 365 of file DiskIo.c.

◆ DiskIoDriverBindingStart()

EFI_STATUS EFIAPI DiskIoDriverBindingStart	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	ControllerHandle,
		IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath	OPTIONAL
	)

Start this driver on ControllerHandle by opening a Block IO protocol and installing a Disk IO protocol on ControllerHandle.

Parameters

This	Protocol instance pointer.
ControllerHandle	Handle of device to bind driver to
RemainingDevicePath	Optional parameter use to pick a specific child device to start.

Return values

EFI_SUCCESS	This driver is added to ControllerHandle
EFI_ALREADY_STARTED	This driver is already running on ControllerHandle
other	This driver does not support this device

Definition at line 118 of file DiskIo.c.

◆ DiskIoDriverBindingStop()

EFI_STATUS EFIAPI DiskIoDriverBindingStop	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	ControllerHandle,
		IN UINTN	NumberOfChildren,
		IN EFI_HANDLE *	ChildHandleBuffer
	)

Stop this driver on ControllerHandle by removing Disk IO protocol and closing the Block IO protocol on ControllerHandle.

Parameters

This	Protocol instance pointer.
ControllerHandle	Handle of device to stop driver on
NumberOfChildren	Number of Handles in ChildHandleBuffer. If number of children is zero stop the entire bus driver.
ChildHandleBuffer	List of Child Handles to Stop.

Return values

EFI_SUCCESS	This driver is removed ControllerHandle
other	This driver was not removed from this device

Definition at line 252 of file DiskIo.c.

◆ DiskIoDriverBindingSupported()

EFI_STATUS EFIAPI DiskIoDriverBindingSupported	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	ControllerHandle,
		IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath	OPTIONAL
	)

Test to see if this driver supports ControllerHandle.

Parameters

This	Protocol instance pointer.
ControllerHandle	Handle of device to test
RemainingDevicePath	Optional parameter use to pick a specific child device to start.

Return values

EFI_SUCCESS	This driver supports this device
EFI_ALREADY_STARTED	This driver is already running on this device
other	This driver does not support this device

Definition at line 66 of file DiskIo.c.

◆ DiskIoReadDisk()

EFI_STATUS EFIAPI DiskIoReadDisk	(	IN EFI_DISK_IO_PROTOCOL *	This,
		IN UINT32	MediaId,
		IN UINT64	Offset,
		IN UINTN	BufferSize,
		OUT VOID *	Buffer
	)

Read BufferSize bytes from Offset into Buffer. Reads may support reads that are not aligned on sector boundaries. There are three cases: UnderRun - The first byte is not on a sector boundary or the read request is less than a sector in length. Aligned - A read of N contiguous sectors. OverRun - The last byte is not on a sector boundary.

Parameters

This	Protocol instance pointer.
MediaId	Id of the media, changes every time the media is replaced.
Offset	The starting byte offset to read from
BufferSize	Size of Buffer
Buffer	Buffer containing read data

Return values

EFI_SUCCESS	The data was read correctly from the device.
EFI_DEVICE_ERROR	The device reported an error while performing the read.
EFI_NO_MEDIA	There is no media in the device.
EFI_MEDIA_CHNAGED	The MediaId does not matched the current device.
EFI_INVALID_PARAMETER	The read request contains device addresses that are not valid for the device.

Definition at line 1220 of file DiskIo.c.

◆ DiskIoWriteDisk()

EFI_STATUS EFIAPI DiskIoWriteDisk	(	IN EFI_DISK_IO_PROTOCOL *	This,
		IN UINT32	MediaId,
		IN UINT64	Offset,
		IN UINTN	BufferSize,
		IN VOID *	Buffer
	)

Writes BufferSize bytes from Buffer into Offset. Writes may require a read modify write to support writes that are not aligned on sector boundaries. There are three cases: UnderRun - The first byte is not on a sector boundary or the write request is less than a sector in length. Read modify write is required. Aligned - A write of N contiguous sectors. OverRun - The last byte is not on a sector boundary. Read modified write required.

Parameters

This	Protocol instance pointer.
MediaId	Id of the media, changes every time the media is replaced.
Offset	The starting byte offset to read from
BufferSize	Size of Buffer
Buffer	Buffer containing read data

Return values

EFI_SUCCESS	The data was written correctly to the device.
EFI_WRITE_PROTECTED	The device can not be written to.
EFI_DEVICE_ERROR	The device reported an error while performing the write.
EFI_NO_MEDIA	There is no media in the device.
EFI_MEDIA_CHNAGED	The MediaId does not matched the current device.
EFI_INVALID_PARAMETER	The write request contains device addresses that are not valid for the device.

Definition at line 1266 of file DiskIo.c.

◆ InitializeDiskIo()

EFI_STATUS EFIAPI InitializeDiskIo	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

The user Entry Point for module DiskIo. The user code starts with this function.

Parameters

[in]	ImageHandle	The firmware allocated handle for the EFI image.
[in]	SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS	The entry point is executed successfully.
other	Some error occurs when executing this entry point.

Definition at line 1297 of file DiskIo.c.

Variable Documentation

◆ gDiskIoDriverBinding

EFI_DRIVER_BINDING_PROTOCOL gDiskIoDriverBinding

Initial value:

= {
  DiskIoDriverBindingSupported,
  DiskIoDriverBindingStart,
  DiskIoDriverBindingStop,
  0xa,
  NULL,
  NULL
}

Definition at line 22 of file DiskIo.c.

◆ gDiskIoPrivateDataTemplate

DISK_IO_PRIVATE_DATA gDiskIoPrivateDataTemplate

Initial value:

= {
  DISK_IO_PRIVATE_DATA_SIGNATURE,
  {
    EFI_DISK_IO_PROTOCOL_REVISION,
    DiskIoReadDisk,
    DiskIoWriteDisk
  },
  {
    EFI_DISK_IO2_PROTOCOL_REVISION,
    DiskIo2Cancel,
    DiskIo2ReadDiskEx,
    DiskIo2WriteDiskEx,
    DiskIo2FlushDiskEx
  }
}

Definition at line 35 of file DiskIo.c.

Functions

Variables

Detailed Description

Function Documentation

◆ DiskIo2Cancel()

◆ DiskIo2FlushDiskEx()

◆ DiskIo2OnFlushComplete()

◆ DiskIo2OnReadWriteComplete()

◆ DiskIo2ReadDiskEx()

◆ DiskIo2ReadWriteDisk()

◆ DiskIo2RemoveCompletedTask()

◆ DiskIo2WriteDiskEx()

◆ DiskIoCreateSubtask()

◆ DiskIoCreateSubtaskList()

◆ DiskIoDestroySubtask()

◆ DiskIoDriverBindingStart()

◆ DiskIoDriverBindingStop()

◆ DiskIoDriverBindingSupported()

◆ DiskIoReadDisk()

◆ DiskIoWriteDisk()

◆ InitializeDiskIo()

Variable Documentation

◆ gDiskIoDriverBinding

◆ gDiskIoPrivateDataTemplate