123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172 |
- /** @file
- Internal include file of DXE CPU IO Library.
- It includes all necessary protocol/library class's header file
- for implementation of IoLib library instance. It is included
- all source code of this library instance.
- Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
- Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>
- SPDX-License-Identifier: BSD-2-Clause-Patent
- Module Name: DxeCpuIoLibInternal.h
- **/
- #ifndef _DXE_CPUIO_LIB_INTERNAL_H_
- #define _DXE_CPUIO_LIB_INTERNAL_H_
- #include <FrameworkDxe.h>
- #include <Protocol/CpuIo.h>
- #include <Library/IoLib.h>
- #include <Library/UefiBootServicesTableLib.h>
- #include <Library/DebugLib.h>
- #include <Library/BaseLib.h>
- /**
- 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.
- This function must guarantee that all I/O read and write operations are serialized.
- If such operations are not supported, then ASSERT().
- @param Port The base address of the I/O operation.
- The caller is responsible for aligning the Address if required.
- @param Width The width of the I/O operation.
- @return Data read from registers in the EFI CPU I/O space.
- **/
- UINT64
- EFIAPI
- IoReadWorker (
- IN UINTN Port,
- IN EFI_CPU_IO_PROTOCOL_WIDTH Width
- );
- /**
- 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.
- This function must guarantee that all I/O read and write operations are serialized.
- If such operations are not supported, then ASSERT().
- @param Port The base address of the I/O operation.
- The caller is responsible for aligning the Address if required.
- @param Width The width of the I/O operation.
- @param Data The value to write to the I/O port.
- @return The parameter of Data.
- **/
- UINT64
- EFIAPI
- IoWriteWorker (
- IN UINTN Port,
- IN EFI_CPU_IO_PROTOCOL_WIDTH Width,
- IN UINT64 Data
- );
- /**
- Reads registers in the EFI CPU I/O space.
- Reads the I/O port specified by Port with registers width specified by Width.
- The port is read Count times, and the read data is stored in the provided Buffer.
- This function must guarantee that all I/O read and write operations are serialized.
- If such operations are not supported, then ASSERT().
- @param Port The base address of the I/O operation.
- The caller is responsible for aligning the Address if required.
- @param Width The width of the I/O operation.
- @param Count The number of times to read I/O port.
- @param Buffer The buffer to store the read data into.
- **/
- VOID
- EFIAPI
- IoReadFifoWorker (
- IN UINTN Port,
- IN EFI_CPU_IO_PROTOCOL_WIDTH Width,
- IN UINTN Count,
- IN VOID *Buffer
- );
- /**
- Writes registers in the EFI CPU I/O space.
- Writes the I/O port specified by Port with registers width specified by Width.
- The port is written Count times, and the write data is retrieved from the provided Buffer.
- This function must guarantee that all I/O read and write operations are serialized.
- If such operations are not supported, then ASSERT().
- @param Port The base address of the I/O operation.
- The caller is responsible for aligning the Address if required.
- @param Width The width of the I/O operation.
- @param Count The number of times to write I/O port.
- @param Buffer The buffer to store the read data into.
- **/
- VOID
- EFIAPI
- IoWriteFifoWorker (
- IN UINTN Port,
- IN EFI_CPU_IO_PROTOCOL_WIDTH Width,
- IN UINTN Count,
- IN VOID *Buffer
- );
- /**
- 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.
- @param Address The MMIO register to read.
- The caller is responsible for aligning the Address if required.
- @param Width The width of the I/O operation.
- @return Data read from registers in the EFI system memory space.
- **/
- UINT64
- EFIAPI
- MmioReadWorker (
- IN UINTN Address,
- IN EFI_CPU_IO_PROTOCOL_WIDTH Width
- );
- /**
- 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.
- @param Address The MMIO register to read.
- The caller is responsible for aligning the Address if required.
- @param Width The width of the I/O operation.
- @param Data The value to write to the I/O port.
- @return Data read from registers in the EFI system memory space.
- **/
- UINT64
- EFIAPI
- MmioWriteWorker (
- IN UINTN Address,
- IN EFI_CPU_IO_PROTOCOL_WIDTH Width,
- IN UINT64 Data
- );
- #endif
|