123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864 |
- /** @file
- I/O Library.
- The implementation of I/O operation for this library instance
- are based on EFI_CPU_IO_PROTOCOL.
- 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: IoLib.c
- **/
- #include "DxeCpuIoLibInternal.h"
- //
- // Globle varible to cache pointer to CpuIo protocol.
- //
- EFI_CPU_IO_PROTOCOL *mCpuIo = NULL;
- /**
- The constructor function caches the pointer to CpuIo protocol.
- The constructor function locates CpuIo protocol from protocol database.
- It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.
- @param ImageHandle The firmware allocated handle for the EFI image.
- @param SystemTable A pointer to the EFI System Table.
- @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
- **/
- EFI_STATUS
- EFIAPI
- IoLibConstructor (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- )
- {
- EFI_STATUS Status;
- Status = gBS->LocateProtocol (&gEfiCpuIoProtocolGuid, NULL, (VOID **) &mCpuIo);
- ASSERT_EFI_ERROR (Status);
- return Status;
- }
- /**
- 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.
- @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
- )
- {
- EFI_STATUS Status;
- UINT64 Data;
- Status = mCpuIo->Io.Read (mCpuIo, Width, Port, 1, &Data);
- ASSERT_EFI_ERROR (Status);
- return 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.
- @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
- )
- {
- EFI_STATUS Status;
- Status = mCpuIo->Io.Write (mCpuIo, Width, Port, 1, &Data);
- ASSERT_EFI_ERROR (Status);
- return 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
- )
- {
- EFI_STATUS Status;
- Status = mCpuIo->Io.Read (mCpuIo, Width, Port, Count, Buffer);
- ASSERT_EFI_ERROR (Status);
- }
- /**
- 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
- )
- {
- EFI_STATUS Status;
- Status = mCpuIo->Io.Write (mCpuIo, Width, Port, Count, Buffer);
- ASSERT_EFI_ERROR (Status);
- }
- /**
- 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
- )
- {
- EFI_STATUS Status;
- UINT64 Data;
- Status = mCpuIo->Mem.Read (mCpuIo, Width, Address, 1, &Data);
- ASSERT_EFI_ERROR (Status);
- return 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.
- @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
- )
- {
- EFI_STATUS Status;
- Status = mCpuIo->Mem.Write (mCpuIo, Width, Address, 1, &Data);
- ASSERT_EFI_ERROR (Status);
- return Data;
- }
- /**
- 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().
- @param Port The I/O port to read.
- @return The value read.
- **/
- UINT8
- EFIAPI
- IoRead8 (
- IN UINTN Port
- )
- {
- return (UINT8)IoReadWorker (Port, EfiCpuIoWidthUint8);
- }
- /**
- 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().
- @param Port The I/O port to write.
- @param Value The value to write to the I/O port.
- @return The value written the I/O port.
- **/
- UINT8
- EFIAPI
- IoWrite8 (
- IN UINTN Port,
- IN UINT8 Value
- )
- {
- return (UINT8)IoWriteWorker (Port, EfiCpuIoWidthUint8, Value);
- }
- /**
- 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 Port is not aligned on a 16-bit boundary, then ASSERT().
- If 16-bit I/O port operations are not supported, then ASSERT().
- @param Port The I/O port to read.
- @return The value read.
- **/
- UINT16
- EFIAPI
- IoRead16 (
- IN UINTN Port
- )
- {
- //
- // Make sure Port is aligned on a 16-bit boundary.
- //
- ASSERT ((Port & 1) == 0);
- return (UINT16)IoReadWorker (Port, EfiCpuIoWidthUint16);
- }
- /**
- 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 Port is not aligned on a 16-bit boundary, then ASSERT().
- If 16-bit I/O port operations are not supported, then ASSERT().
- @param Port The I/O port to write.
- @param Value The value to write to the I/O port.
- @return The value written the I/O port.
- **/
- UINT16
- EFIAPI
- IoWrite16 (
- IN UINTN Port,
- IN UINT16 Value
- )
- {
- //
- // Make sure Port is aligned on a 16-bit boundary.
- //
- ASSERT ((Port & 1) == 0);
- return (UINT16)IoWriteWorker (Port, EfiCpuIoWidthUint16, Value);
- }
- /**
- 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 Port is not aligned on a 32-bit boundary, then ASSERT().
- If 32-bit I/O port operations are not supported, then ASSERT().
- @param Port The I/O port to read.
- @return The value read.
- **/
- UINT32
- EFIAPI
- IoRead32 (
- IN UINTN Port
- )
- {
- //
- // Make sure Port is aligned on a 32-bit boundary.
- //
- ASSERT ((Port & 3) == 0);
- return (UINT32)IoReadWorker (Port, EfiCpuIoWidthUint32);
- }
- /**
- 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 Port is not aligned on a 32-bit boundary, then ASSERT().
- If 32-bit I/O port operations are not supported, then ASSERT().
- @param Port The I/O port to write.
- @param Value The value to write to the I/O port.
- @return The value written the I/O port.
- **/
- UINT32
- EFIAPI
- IoWrite32 (
- IN UINTN Port,
- IN UINT32 Value
- )
- {
- //
- // Make sure Port is aligned on a 32-bit boundary.
- //
- ASSERT ((Port & 3) == 0);
- return (UINT32)IoWriteWorker (Port, EfiCpuIoWidthUint32, Value);
- }
- /**
- 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 Port is not aligned on a 64-bit boundary, then ASSERT().
- If 64-bit I/O port operations are not supported, then ASSERT().
- @param Port The I/O port to read.
- @return The value read.
- **/
- UINT64
- EFIAPI
- IoRead64 (
- IN UINTN Port
- )
- {
- //
- // Make sure Port is aligned on a 64-bit boundary.
- //
- ASSERT ((Port & 7) == 0);
- return IoReadWorker (Port, EfiCpuIoWidthUint64);
- }
- /**
- 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 Port is not aligned on a 64-bit boundary, then ASSERT().
- If 64-bit I/O port operations are not supported, then ASSERT().
- @param Port The I/O port to write.
- @param Value The value to write to the I/O port.
- @return The value written the I/O port.
- **/
- UINT64
- EFIAPI
- IoWrite64 (
- IN UINTN Port,
- IN UINT64 Value
- )
- {
- //
- // Make sure Port is aligned on a 64-bit boundary.
- //
- ASSERT ((Port & 7) == 0);
- return IoWriteWorker (Port, EfiCpuIoWidthUint64, Value);
- }
- /**
- Reads an 8-bit I/O port fifo into a block of memory.
- Reads the 8-bit I/O fifo port specified by Port.
- 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 8-bit I/O port operations are not supported, then ASSERT().
- @param Port The I/O port to read.
- @param Count The number of times to read I/O port.
- @param Buffer The buffer to store the read data into.
- **/
- VOID
- EFIAPI
- IoReadFifo8 (
- IN UINTN Port,
- IN UINTN Count,
- OUT VOID *Buffer
- )
- {
- IoReadFifoWorker (Port, EfiCpuIoWidthFifoUint8, Count, Buffer);
- }
- /**
- Writes a block of memory into an 8-bit I/O port fifo.
- Writes the 8-bit I/O fifo port specified by Port.
- The port is written Count times, and the write data is
- retrieved from the provided Buffer.
- This function must guarantee that all I/O write and write operations are
- serialized.
- If 8-bit I/O port operations are not supported, then ASSERT().
- @param Port The I/O port to write.
- @param Count The number of times to write I/O port.
- @param Buffer The buffer to retrieve the write data from.
- **/
- VOID
- EFIAPI
- IoWriteFifo8 (
- IN UINTN Port,
- IN UINTN Count,
- IN VOID *Buffer
- )
- {
- IoWriteFifoWorker (Port, EfiCpuIoWidthFifoUint8, Count, Buffer);
- }
- /**
- Reads a 16-bit I/O port fifo into a block of memory.
- Reads the 16-bit I/O fifo port specified by Port.
- 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 16-bit I/O port operations are not supported, then ASSERT().
- @param Port The I/O port to read.
- @param Count The number of times to read I/O port.
- @param Buffer The buffer to store the read data into.
- **/
- VOID
- EFIAPI
- IoReadFifo16 (
- IN UINTN Port,
- IN UINTN Count,
- OUT VOID *Buffer
- )
- {
- //
- // Make sure Port is aligned on a 16-bit boundary.
- //
- ASSERT ((Port & 1) == 0);
- IoReadFifoWorker (Port, EfiCpuIoWidthFifoUint16, Count, Buffer);
- }
- /**
- Writes a block of memory into a 16-bit I/O port fifo.
- Writes the 16-bit I/O fifo port specified by Port.
- The port is written Count times, and the write data is
- retrieved from the provided Buffer.
- This function must guarantee that all I/O write and write operations are
- serialized.
- If 16-bit I/O port operations are not supported, then ASSERT().
- @param Port The I/O port to write.
- @param Count The number of times to write I/O port.
- @param Buffer The buffer to retrieve the write data from.
- **/
- VOID
- EFIAPI
- IoWriteFifo16 (
- IN UINTN Port,
- IN UINTN Count,
- IN VOID *Buffer
- )
- {
- //
- // Make sure Port is aligned on a 16-bit boundary.
- //
- ASSERT ((Port & 1) == 0);
- IoWriteFifoWorker (Port, EfiCpuIoWidthFifoUint16, Count, Buffer);
- }
- /**
- Reads a 32-bit I/O port fifo into a block of memory.
- Reads the 32-bit I/O fifo port specified by Port.
- 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 32-bit I/O port operations are not supported, then ASSERT().
- @param Port The I/O port to read.
- @param Count The number of times to read I/O port.
- @param Buffer The buffer to store the read data into.
- **/
- VOID
- EFIAPI
- IoReadFifo32 (
- IN UINTN Port,
- IN UINTN Count,
- OUT VOID *Buffer
- )
- {
- //
- // Make sure Port is aligned on a 32-bit boundary.
- //
- ASSERT ((Port & 3) == 0);
- IoReadFifoWorker (Port, EfiCpuIoWidthFifoUint32, Count, Buffer);
- }
- /**
- Writes a block of memory into a 32-bit I/O port fifo.
- Writes the 32-bit I/O fifo port specified by Port.
- The port is written Count times, and the write data is
- retrieved from the provided Buffer.
- This function must guarantee that all I/O write and write operations are
- serialized.
- If 32-bit I/O port operations are not supported, then ASSERT().
- @param Port The I/O port to write.
- @param Count The number of times to write I/O port.
- @param Buffer The buffer to retrieve the write data from.
- **/
- VOID
- EFIAPI
- IoWriteFifo32 (
- IN UINTN Port,
- IN UINTN Count,
- IN VOID *Buffer
- )
- {
- //
- // Make sure Port is aligned on a 32-bit boundary.
- //
- ASSERT ((Port & 3) == 0);
- IoWriteFifoWorker (Port, EfiCpuIoWidthFifoUint32, Count, Buffer);
- }
- /**
- 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().
- @param Address The MMIO register to read.
- @return The value read.
- **/
- UINT8
- EFIAPI
- MmioRead8 (
- IN UINTN Address
- )
- {
- return (UINT8)MmioReadWorker (Address, EfiCpuIoWidthUint8);
- }
- /**
- 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().
- @param Address The MMIO register to write.
- @param Value The value to write to the MMIO register.
- **/
- UINT8
- EFIAPI
- MmioWrite8 (
- IN UINTN Address,
- IN UINT8 Value
- )
- {
- return (UINT8)MmioWriteWorker (Address, EfiCpuIoWidthUint8, Value);
- }
- /**
- 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 Address is not aligned on a 16-bit boundary, then ASSERT().
- If 16-bit MMIO register operations are not supported, then ASSERT().
- @param Address The MMIO register to read.
- @return The value read.
- **/
- UINT16
- EFIAPI
- MmioRead16 (
- IN UINTN Address
- )
- {
- //
- // Make sure Address is aligned on a 16-bit boundary.
- //
- ASSERT ((Address & 1) == 0);
- return (UINT16)MmioReadWorker (Address, EfiCpuIoWidthUint16);
- }
- /**
- 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 Address is not aligned on a 16-bit boundary, then ASSERT().
- If 16-bit MMIO register operations are not supported, then ASSERT().
- @param Address The MMIO register to write.
- @param Value The value to write to the MMIO register.
- **/
- UINT16
- EFIAPI
- MmioWrite16 (
- IN UINTN Address,
- IN UINT16 Value
- )
- {
- //
- // Make sure Address is aligned on a 16-bit boundary.
- //
- ASSERT ((Address & 1) == 0);
- return (UINT16)MmioWriteWorker (Address, EfiCpuIoWidthUint16, Value);
- }
- /**
- 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 Address is not aligned on a 32-bit boundary, then ASSERT().
- If 32-bit MMIO register operations are not supported, then ASSERT().
- @param Address The MMIO register to read.
- @return The value read.
- **/
- UINT32
- EFIAPI
- MmioRead32 (
- IN UINTN Address
- )
- {
- //
- // Make sure Address is aligned on a 32-bit boundary.
- //
- ASSERT ((Address & 3) == 0);
- return (UINT32)MmioReadWorker (Address, EfiCpuIoWidthUint32);
- }
- /**
- 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 Address is not aligned on a 32-bit boundary, then ASSERT().
- If 32-bit MMIO register operations are not supported, then ASSERT().
- @param Address The MMIO register to write.
- @param Value The value to write to the MMIO register.
- **/
- UINT32
- EFIAPI
- MmioWrite32 (
- IN UINTN Address,
- IN UINT32 Value
- )
- {
- //
- // Make sure Address is aligned on a 32-bit boundary.
- //
- ASSERT ((Address & 3) == 0);
- return (UINT32)MmioWriteWorker (Address, EfiCpuIoWidthUint32, Value);
- }
- /**
- 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 Address is not aligned on a 64-bit boundary, then ASSERT().
- If 64-bit MMIO register operations are not supported, then ASSERT().
- @param Address The MMIO register to read.
- @return The value read.
- **/
- UINT64
- EFIAPI
- MmioRead64 (
- IN UINTN Address
- )
- {
- //
- // Make sure Address is aligned on a 64-bit boundary.
- //
- ASSERT ((Address & 7) == 0);
- return (UINT64)MmioReadWorker (Address, EfiCpuIoWidthUint64);
- }
- /**
- 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 Address is not aligned on a 64-bit boundary, then ASSERT().
- If 64-bit MMIO register operations are not supported, then ASSERT().
- @param Address The MMIO register to write.
- @param Value The value to write to the MMIO register.
- **/
- UINT64
- EFIAPI
- MmioWrite64 (
- IN UINTN Address,
- IN UINT64 Value
- )
- {
- //
- // Make sure Address is aligned on a 64-bit boundary.
- //
- ASSERT ((Address & 7) == 0);
- return (UINT64)MmioWriteWorker (Address, EfiCpuIoWidthUint64, Value);
- }
|