MdePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdePkg / Library / DxeIoLibCpuIo2 / DxeCpuIo2LibInternal.h

/** @file\r
  Internal include file of DXE CPU IO2 Library.\r
\r
  Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
  Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _DXE_CPUIO2_LIB_INTERNAL_H_\r
#define _DXE_CPUIO2_LIB_INTERNAL_H_\r
\r
#include <PiDxe.h>\r
\r
#include <Protocol/CpuIo2.h>\r
\r
#include <Library/IoLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseLib.h>\r
\r
\r
/**\r
  Reads registers in the EFI CPU I/O space.\r
\r
  Reads the I/O port specified by Port with registers width specified by Width.\r
  The read value is returned.\r
\r
  This function must guarantee that all I/O read and write operations are serialized.\r
  If such operations are not supported, then ASSERT().\r
\r
  @param  Port          The base address of the I/O operation.\r
                        The caller is responsible for aligning the Address if required.\r
  @param  Width         The width of the I/O operation.\r
\r
  @return Data read from registers in the EFI CPU I/O space.\r
\r
**/\r
UINT64\r
EFIAPI\r
IoReadWorker (\r
  IN      UINTN                      Port,\r
  IN      EFI_CPU_IO_PROTOCOL_WIDTH  Width\r
  );\r
\r
/**\r
  Writes registers in the EFI CPU I/O space.\r
\r
  Writes the I/O port specified by Port with registers width and value specified by Width\r
  and Data respectively. Data is returned.\r
\r
  This function must guarantee that all I/O read and write operations are serialized.\r
  If such operations are not supported, then ASSERT().\r
\r
  @param  Port          The base address of the I/O operation.\r
                        The caller is responsible for aligning the Address if required.\r
  @param  Width         The width of the I/O operation.\r
  @param  Data          The value to write to the I/O port.\r
\r
  @return The parameter of Data.\r
\r
**/\r
UINT64\r
EFIAPI\r
IoWriteWorker (\r
  IN      UINTN                      Port,\r
  IN      EFI_CPU_IO_PROTOCOL_WIDTH  Width,\r
  IN      UINT64                     Data\r
  );\r
\r
/**\r
  Reads registers in the EFI CPU I/O space.\r
\r
  Reads the I/O port specified by Port with registers width specified by Width.\r
  The port is read Count times, and the read data is stored in the provided Buffer.\r
\r
  This function must guarantee that all I/O read and write operations are serialized.\r
  If such operations are not supported, then ASSERT().\r
\r
  @param  Port          The base address of the I/O operation.\r
                        The caller is responsible for aligning the Address if required.\r
  @param  Width         The width of the I/O operation.\r
  @param  Count         The number of times to read I/O port.\r
  @param  Buffer        The buffer to store the read data into.\r
\r
**/\r
VOID\r
EFIAPI\r
IoReadFifoWorker (\r
  IN      UINTN                      Port,\r
  IN      EFI_CPU_IO_PROTOCOL_WIDTH  Width,\r
  IN      UINTN                      Count,\r
  IN      VOID                       *Buffer\r
  );\r
\r
/**\r
  Writes registers in the EFI CPU I/O space.\r
\r
  Writes the I/O port specified by Port with registers width specified by Width.\r
  The port is written Count times, and the write data is retrieved from the provided Buffer.\r
\r
  This function must guarantee that all I/O read and write operations are serialized.\r
  If such operations are not supported, then ASSERT().\r
\r
  @param  Port          The base address of the I/O operation.\r
                        The caller is responsible for aligning the Address if required.\r
  @param  Width         The width of the I/O operation.\r
  @param  Count         The number of times to write I/O port.\r
  @param  Buffer        The buffer to store the read data into.\r
\r
**/\r
VOID\r
EFIAPI\r
IoWriteFifoWorker (\r
  IN      UINTN                      Port,\r
  IN      EFI_CPU_IO_PROTOCOL_WIDTH  Width,\r
  IN      UINTN                      Count,\r
  IN      VOID                       *Buffer\r
  );\r
\r
/**\r
  Reads memory-mapped registers in the EFI system memory space.\r
\r
  Reads the MMIO registers specified by Address with registers width specified by Width.\r
  The read value is returned. If such operations are not supported, then ASSERT().\r
  This function must guarantee that all MMIO read and write operations are serialized.\r
\r
  @param  Address       The MMIO register to read.\r
                        The caller is responsible for aligning the Address if required.\r
  @param  Width         The width of the I/O operation.\r
\r
  @return Data read from registers in the EFI system memory space.\r
\r
**/\r
UINT64\r
EFIAPI\r
MmioReadWorker (\r
  IN      UINTN                     Address,\r
  IN      EFI_CPU_IO_PROTOCOL_WIDTH Width\r
  );\r
\r
/**\r
  Writes memory-mapped registers in the EFI system memory space.\r
\r
  Writes the MMIO registers specified by Address with registers width and value specified by Width\r
  and Data respectively. Data is returned. If such operations are not supported, then ASSERT().\r
  This function must guarantee that all MMIO read and write operations are serialized.\r
\r
  @param  Address       The MMIO register to read.\r
                        The caller is responsible for aligning the Address if required.\r
  @param  Width         The width of the I/O operation.\r
  @param  Data          The value to write to the I/O port.\r
\r
  @return Data read from registers in the EFI system memory space.\r
\r
**/\r
UINT64\r
EFIAPI\r
MmioWriteWorker (\r
  IN      UINTN                     Address,\r
  IN      EFI_CPU_IO_PROTOCOL_WIDTH Width,\r
  IN      UINT64                    Data\r
  );\r
\r
#endif\r