MdePkg/Library/DxeIoLibEsal/IoLib.c File Reference


Functions

UINT64 EFIAPI IoReadWorker (IN UINTN Port, IN EFI_CPU_IO_PROTOCOL_WIDTH Width)
UINT64 EFIAPI IoWriteWorker (IN UINTN Port, IN EFI_CPU_IO_PROTOCOL_WIDTH Width, IN UINT64 Data)
UINT64 EFIAPI MmioReadWorker (IN UINTN Address, IN EFI_CPU_IO_PROTOCOL_WIDTH Width)
UINT64 EFIAPI MmioWriteWorker (IN UINTN Address, IN EFI_CPU_IO_PROTOCOL_WIDTH Width, IN UINT64 Data)
UINT8 EFIAPI IoRead8 (IN UINTN Port)
UINT8 EFIAPI IoWrite8 (IN UINTN Port, IN UINT8 Value)
UINT16 EFIAPI IoRead16 (IN UINTN Port)
UINT16 EFIAPI IoWrite16 (IN UINTN Port, IN UINT16 Value)
UINT32 EFIAPI IoRead32 (IN UINTN Port)
UINT32 EFIAPI IoWrite32 (IN UINTN Port, IN UINT32 Value)
UINT64 EFIAPI IoRead64 (IN UINTN Port)
UINT64 EFIAPI IoWrite64 (IN UINTN Port, IN UINT64 Value)
UINT8 EFIAPI MmioRead8 (IN UINTN Address)
UINT8 EFIAPI MmioWrite8 (IN UINTN Address, IN UINT8 Value)
UINT16 EFIAPI MmioRead16 (IN UINTN Address)
UINT16 EFIAPI MmioWrite16 (IN UINTN Address, IN UINT16 Value)
UINT32 EFIAPI MmioRead32 (IN UINTN Address)
UINT32 EFIAPI MmioWrite32 (IN UINTN Address, IN UINT32 Value)
UINT64 EFIAPI MmioRead64 (IN UINTN Address)
UINT64 EFIAPI MmioWrite64 (IN UINTN Address, IN UINT64 Value)

Detailed Description

I/O Library basic function implementation and worker functions.

Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Function Documentation

UINT16 EFIAPI IoRead16 ( IN UINTN  Port  ) 

Reads a 16-bit I/O port.

Reads the 16-bit I/O port specified by Port. The 16-bit read value is returned. This function must guarantee that all I/O read and write operations are serialized.

If 16-bit I/O port operations are not supported, then ASSERT().

Parameters:
Port The I/O port to read.
Returns:
The value read.

References ASSERT, EfiCpuIoWidthUint16, and IoReadWorker().

UINT32 EFIAPI IoRead32 ( IN UINTN  Port  ) 

Reads a 32-bit I/O port.

Reads the 32-bit I/O port specified by Port. The 32-bit read value is returned. This function must guarantee that all I/O read and write operations are serialized.

If 32-bit I/O port operations are not supported, then ASSERT().

Parameters:
Port The I/O port to read.
Returns:
The value read.

References ASSERT, EfiCpuIoWidthUint32, and IoReadWorker().

UINT64 EFIAPI IoRead64 ( IN UINTN  Port  ) 

Reads a 64-bit I/O port.

Reads the 64-bit I/O port specified by Port. The 64-bit read value is returned. This function must guarantee that all I/O read and write operations are serialized.

If 64-bit I/O port operations are not supported, then ASSERT().

Parameters:
Port The I/O port to read.
Returns:
The value read.

References ASSERT, EfiCpuIoWidthUint64, and IoReadWorker().

UINT8 EFIAPI IoRead8 ( IN UINTN  Port  ) 

Reads an 8-bit I/O port.

Reads the 8-bit I/O port specified by Port. The 8-bit read value is returned. This function must guarantee that all I/O read and write operations are serialized.

If 8-bit I/O port operations are not supported, then ASSERT().

Parameters:
Port The I/O port to read.
Returns:
The value read.

References EfiCpuIoWidthUint8, and IoReadWorker().

UINT64 EFIAPI IoReadWorker ( IN UINTN  Port,
IN EFI_CPU_IO_PROTOCOL_WIDTH  Width 
)

Reads registers in the EFI CPU I/O space.

Reads the I/O port specified by Port with registers width specified by Width. The read value is returned. If such operations are not supported, then ASSERT(). This function must guarantee that all I/O read and write operations are serialized.

Parameters:
Port The base address of the I/O operation. The caller is responsible for aligning the Address if required.
Width The width of the I/O operation.
Returns:
Data read from registers in the EFI CPU I/O space.

References ASSERT, EFI_EXTENDED_SAL_BASE_IO_SERVICES_PROTOCOL_GUID_HI, EFI_EXTENDED_SAL_BASE_IO_SERVICES_PROTOCOL_GUID_LO, EFI_SAL_SUCCESS, EsalCall(), IoReadFunctionId, and SAL_RETURN_REGS::Status.

Referenced by IoRead16(), IoRead32(), IoRead64(), and IoRead8().

UINT16 EFIAPI IoWrite16 ( IN UINTN  Port,
IN UINT16  Value 
)

Writes a 16-bit I/O port.

Writes the 16-bit I/O port specified by Port with the value specified by Value and returns Value. This function must guarantee that all I/O read and write operations are serialized.

If 16-bit I/O port operations are not supported, then ASSERT().

Parameters:
Port The I/O port to write.
Value The value to write to the I/O port.
Returns:
The value written the I/O port.

References ASSERT, EfiCpuIoWidthUint16, and IoWriteWorker().

UINT32 EFIAPI IoWrite32 ( IN UINTN  Port,
IN UINT32  Value 
)

Writes a 32-bit I/O port.

Writes the 32-bit I/O port specified by Port with the value specified by Value and returns Value. This function must guarantee that all I/O read and write operations are serialized.

If 32-bit I/O port operations are not supported, then ASSERT().

Parameters:
Port The I/O port to write.
Value The value to write to the I/O port.
Returns:
The value written the I/O port.

References ASSERT, EfiCpuIoWidthUint32, and IoWriteWorker().

UINT64 EFIAPI IoWrite64 ( IN UINTN  Port,
IN UINT64  Value 
)

Writes a 64-bit I/O port.

Writes the 64-bit I/O port specified by Port with the value specified by Value and returns Value. This function must guarantee that all I/O read and write operations are serialized.

If 64-bit I/O port operations are not supported, then ASSERT().

Parameters:
Port The I/O port to write.
Value The value to write to the I/O port.
Returns:
The value written the I/O port.

References ASSERT, EfiCpuIoWidthUint64, and IoWriteWorker().

UINT8 EFIAPI IoWrite8 ( IN UINTN  Port,
IN UINT8  Value 
)

Writes an 8-bit I/O port.

Writes the 8-bit I/O port specified by Port with the value specified by Value and returns Value. This function must guarantee that all I/O read and write operations are serialized.

If 8-bit I/O port operations are not supported, then ASSERT().

Parameters:
Port The I/O port to write.
Value The value to write to the I/O port.
Returns:
The value written the I/O port.

References EfiCpuIoWidthUint8, and IoWriteWorker().

UINT64 EFIAPI IoWriteWorker ( IN UINTN  Port,
IN EFI_CPU_IO_PROTOCOL_WIDTH  Width,
IN UINT64  Data 
)

Writes registers in the EFI CPU I/O space.

Writes the I/O port specified by Port with registers width and value specified by Width and Data respectively. Data is returned. If such operations are not supported, then ASSERT(). This function must guarantee that all I/O read and write operations are serialized.

Parameters:
Port The base address of the I/O operation. The caller is responsible for aligning the Address if required.
Width The width of the I/O operation.
Data The value to write to the I/O port.
Returns:
The paramter of Data.

References ASSERT, EFI_EXTENDED_SAL_BASE_IO_SERVICES_PROTOCOL_GUID_HI, EFI_EXTENDED_SAL_BASE_IO_SERVICES_PROTOCOL_GUID_LO, EFI_SAL_SUCCESS, EsalCall(), IoWriteFunctionId, and SAL_RETURN_REGS::Status.

Referenced by IoWrite16(), IoWrite32(), IoWrite64(), and IoWrite8().

UINT16 EFIAPI MmioRead16 ( IN UINTN  Address  ) 

Reads a 16-bit MMIO register.

Reads the 16-bit MMIO register specified by Address. The 16-bit read value is returned. This function must guarantee that all MMIO read and write operations are serialized.

If 16-bit MMIO register operations are not supported, then ASSERT().

Parameters:
Address The MMIO register to read.
Returns:
The value read.

References ASSERT, EfiCpuIoWidthUint16, and MmioReadWorker().

UINT32 EFIAPI MmioRead32 ( IN UINTN  Address  ) 

Reads a 32-bit MMIO register.

Reads the 32-bit MMIO register specified by Address. The 32-bit read value is returned. This function must guarantee that all MMIO read and write operations are serialized.

If 32-bit MMIO register operations are not supported, then ASSERT().

Parameters:
Address The MMIO register to read.
Returns:
The value read.

References ASSERT, EfiCpuIoWidthUint32, and MmioReadWorker().

UINT64 EFIAPI MmioRead64 ( IN UINTN  Address  ) 

Reads a 64-bit MMIO register.

Reads the 64-bit MMIO register specified by Address. The 64-bit read value is returned. This function must guarantee that all MMIO read and write operations are serialized.

If 64-bit MMIO register operations are not supported, then ASSERT().

Parameters:
Address The MMIO register to read.
Returns:
The value read.

References ASSERT, EfiCpuIoWidthUint64, and MmioReadWorker().

UINT8 EFIAPI MmioRead8 ( IN UINTN  Address  ) 

Reads an 8-bit MMIO register.

Reads the 8-bit MMIO register specified by Address. The 8-bit read value is returned. This function must guarantee that all MMIO read and write operations are serialized.

If 8-bit MMIO register operations are not supported, then ASSERT().

Parameters:
Address The MMIO register to read.
Returns:
The value read.

References EfiCpuIoWidthUint8, and MmioReadWorker().

UINT64 EFIAPI MmioReadWorker ( IN UINTN  Address,
IN EFI_CPU_IO_PROTOCOL_WIDTH  Width 
)

Reads memory-mapped registers in the EFI system memory space.

Reads the MMIO registers specified by Address with registers width specified by Width. The read value is returned. If such operations are not supported, then ASSERT(). This function must guarantee that all MMIO read and write operations are serialized.

Parameters:
Address The MMIO register to read. The caller is responsible for aligning the Address if required.
Width The width of the I/O operation.
Returns:
Data read from registers in the EFI system memory space.

References ASSERT, EFI_EXTENDED_SAL_BASE_IO_SERVICES_PROTOCOL_GUID_HI, EFI_EXTENDED_SAL_BASE_IO_SERVICES_PROTOCOL_GUID_LO, EFI_SAL_SUCCESS, EsalCall(), MemReadFunctionId, and SAL_RETURN_REGS::Status.

Referenced by MmioRead16(), MmioRead32(), MmioRead64(), and MmioRead8().

UINT16 EFIAPI MmioWrite16 ( IN UINTN  Address,
IN UINT16  Value 
)

Writes a 16-bit MMIO register.

Writes the 16-bit MMIO register specified by Address with the value specified by Value and returns Value. This function must guarantee that all MMIO read and write operations are serialized.

If 16-bit MMIO register operations are not supported, then ASSERT().

Parameters:
Address The MMIO register to write.
Value The value to write to the MMIO register.

References ASSERT, EfiCpuIoWidthUint16, and MmioWriteWorker().

UINT32 EFIAPI MmioWrite32 ( IN UINTN  Address,
IN UINT32  Value 
)

Writes a 32-bit MMIO register.

Writes the 32-bit MMIO register specified by Address with the value specified by Value and returns Value. This function must guarantee that all MMIO read and write operations are serialized.

If 32-bit MMIO register operations are not supported, then ASSERT().

Parameters:
Address The MMIO register to write.
Value The value to write to the MMIO register.

References ASSERT, EfiCpuIoWidthUint32, and MmioWriteWorker().

UINT64 EFIAPI MmioWrite64 ( IN UINTN  Address,
IN UINT64  Value 
)

Writes a 64-bit MMIO register.

Writes the 64-bit MMIO register specified by Address with the value specified by Value and returns Value. This function must guarantee that all MMIO read and write operations are serialized.

If 64-bit MMIO register operations are not supported, then ASSERT().

Parameters:
Address The MMIO register to write.
Value The value to write to the MMIO register.

References ASSERT, EfiCpuIoWidthUint64, and MmioWriteWorker().

UINT8 EFIAPI MmioWrite8 ( IN UINTN  Address,
IN UINT8  Value 
)

Writes an 8-bit MMIO register.

Writes the 8-bit MMIO register specified by Address with the value specified by Value and returns Value. This function must guarantee that all MMIO read and write operations are serialized.

If 8-bit MMIO register operations are not supported, then ASSERT().

Parameters:
Address The MMIO register to write.
Value The value to write to the MMIO register.

References EfiCpuIoWidthUint8, and MmioWriteWorker().

UINT64 EFIAPI MmioWriteWorker ( IN UINTN  Address,
IN EFI_CPU_IO_PROTOCOL_WIDTH  Width,
IN UINT64  Data 
)

Writes memory-mapped registers in the EFI system memory space.

Writes the MMIO registers specified by Address with registers width and value specified by Width and Data respectively. Data is returned. If such operations are not supported, then ASSERT(). This function must guarantee that all MMIO read and write operations are serialized.

Parameters:
Address The MMIO register to read. The caller is responsible for aligning the Address if required.
Width The width of the I/O operation.
Data The value to write to memory-mapped registers
Returns:
Data read from registers in the EFI system memory space.

References ASSERT, EFI_EXTENDED_SAL_BASE_IO_SERVICES_PROTOCOL_GUID_HI, EFI_EXTENDED_SAL_BASE_IO_SERVICES_PROTOCOL_GUID_LO, EFI_SAL_SUCCESS, EsalCall(), MemWriteFunctionId, and SAL_RETURN_REGS::Status.

Referenced by MmioWrite16(), MmioWrite32(), MmioWrite64(), and MmioWrite8().


Generated on Thu Sep 24 23:14:21 2015 for MdePkg[ALL] by  doxygen 1.5.7.1