/** @file\r
Common I/O Library routines.\r
\r
- Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
- All rights reserved. This program and the accompanying materials\r
+ Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+ Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>\r
+\r
+ This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
- http://opensource.org/licenses/bsd-license.php\r
+ http://opensource.org/licenses/bsd-license.php.\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
}\r
\r
/**\r
- Reads a 8-bit I/O port.\r
+ Reads an 8-bit I/O port.\r
\r
Reads the 8-bit I/O port specified by Port. The 8-bit read value is returned.\r
This function must guarantee that all I/O read and write operations are\r
serialized.\r
\r
+ If 8-bit I/O port operations are not supported, then ASSERT().\r
+\r
@param Port The I/O port to read.\r
\r
- @return The value read from Port.\r
+ @return The value read.\r
\r
**/\r
UINT8\r
EFIAPI\r
IoRead8 (\r
- IN UINTN Port\r
+ IN UINTN Port\r
)\r
{\r
return MmioRead8 (InternalGetMemoryMapAddress (Port));\r
This function must guarantee that all I/O read and write operations are\r
serialized.\r
\r
+ If 16-bit I/O port operations are not supported, then ASSERT().\r
+ If Port is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
@param Port The I/O port to read.\r
\r
- @return The value read from Port.\r
+ @return The value read.\r
\r
**/\r
UINT16\r
EFIAPI\r
IoRead16 (\r
- IN UINTN Port\r
+ IN UINTN Port\r
)\r
{\r
return MmioRead16 (InternalGetMemoryMapAddress (Port));\r
This function must guarantee that all I/O read and write operations are\r
serialized.\r
\r
+ If 32-bit I/O port operations are not supported, then ASSERT().\r
+ If Port is not aligned on a 32-bit boundary, then ASSERT().\r
+ \r
@param Port The I/O port to read.\r
\r
- @return The value read from Port.\r
+ @return The value read.\r
\r
**/\r
UINT32\r
EFIAPI\r
IoRead32 (\r
- IN UINTN Port\r
+ IN UINTN Port\r
)\r
{\r
return MmioRead32 (InternalGetMemoryMapAddress (Port));\r
serialized.\r
\r
If 64-bit I/O port operations are not supported, then ASSERT().\r
+ If Port is not aligned on a 64-bit boundary, then ASSERT().\r
\r
@param Port The I/O port to read.\r
\r
- @return The value read from Port.\r
+ @return The value read.\r
\r
**/\r
UINT64\r
return 0;\r
}\r
\r
+\r
/**\r
- Writes a 8-bit I/O port.\r
+ Writes an 8-bit I/O port.\r
\r
Writes the 8-bit I/O port specified by Port with the value specified by Value\r
and returns Value. This function must guarantee that all I/O read and write\r
operations are serialized.\r
\r
+ If 8-bit I/O port operations are not supported, then ASSERT().\r
+\r
@param Port The I/O port to write.\r
- @param Data The value to write to the I/O port.\r
+ @param Value The value to write to the I/O port.\r
\r
- @return The value written to the I/O port. It equals to the\r
- input Value instead of the actual value read back from\r
- the I/O port.\r
+ @return The value written the I/O port.\r
\r
**/\r
UINT8\r
EFIAPI\r
IoWrite8 (\r
- IN UINTN Port,\r
- IN UINT8 Data\r
+ IN UINTN Port,\r
+ IN UINT8 Value\r
)\r
{\r
- return MmioWrite8 (InternalGetMemoryMapAddress (Port), Data);\r
+ return MmioWrite8 (InternalGetMemoryMapAddress (Port), Value);\r
}\r
\r
/**\r
and returns Value. This function must guarantee that all I/O read and write\r
operations are serialized.\r
\r
+ If 16-bit I/O port operations are not supported, then ASSERT().\r
+ If Port is not aligned on a 16-bit boundary, then ASSERT().\r
+ \r
@param Port The I/O port to write.\r
- @param Data The value to write to the I/O port.\r
+ @param Value The value to write to the I/O port.\r
\r
- @return The value written to the I/O port. It equals to the\r
- input Value instead of the actual value read back from\r
- the I/O port.\r
+ @return The value written the I/O port.\r
\r
**/\r
UINT16\r
EFIAPI\r
IoWrite16 (\r
- IN UINTN Port,\r
- IN UINT16 Data\r
+ IN UINTN Port,\r
+ IN UINT16 Value\r
)\r
{\r
- return MmioWrite16 (InternalGetMemoryMapAddress (Port), Data);\r
+ return MmioWrite16 (InternalGetMemoryMapAddress (Port), Value);\r
}\r
\r
/**\r
and returns Value. This function must guarantee that all I/O read and write\r
operations are serialized.\r
\r
+ If 32-bit I/O port operations are not supported, then ASSERT().\r
+ If Port is not aligned on a 32-bit boundary, then ASSERT().\r
+ \r
@param Port The I/O port to write.\r
- @param Data The value to write to the I/O port.\r
+ @param Value The value to write to the I/O port.\r
\r
- @return The value written to the I/O port. It equals to the\r
- input Value instead of the actual value read back from\r
- the I/O port.\r
+ @return The value written the I/O port.\r
\r
**/\r
UINT32\r
EFIAPI\r
IoWrite32 (\r
- IN UINTN Port,\r
- IN UINT32 Data\r
+ IN UINTN Port,\r
+ IN UINT32 Value\r
)\r
{\r
- return MmioWrite32 (InternalGetMemoryMapAddress (Port), Data);\r
+ return MmioWrite32 (InternalGetMemoryMapAddress (Port), Value);\r
}\r
\r
/**\r
operations are serialized.\r
\r
If 64-bit I/O port operations are not supported, then ASSERT().\r
+ If Port is not aligned on a 64-bit boundary, then ASSERT().\r
\r
@param Port The I/O port to write.\r
@param Value The value to write to the I/O port.\r
\r
- @return The value written to the I/O port. It equals to the\r
- input Value instead of the actual value read back from\r
- the I/O port.\r
+ @return The value written the I/O port.\r
\r
**/\r
UINT64\r
}\r
\r
/**\r
- Reads a 8-bit MMIO register.\r
+ Reads an 8-bit I/O port fifo into a block of memory.\r
+\r
+ Reads the 8-bit I/O fifo port specified by Port.\r
+ The port is read Count times, and the read data is\r
+ stored in the provided Buffer.\r
+\r
+ This function must guarantee that all I/O read and write operations are\r
+ serialized.\r
+\r
+ If 8-bit I/O port operations are not supported, then ASSERT().\r
+\r
+ @param Port The I/O port to read.\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
+IoReadFifo8 (\r
+ IN UINTN Port,\r
+ IN UINTN Count,\r
+ OUT VOID *Buffer\r
+ )\r
+{\r
+ UINT8 *Buffer8;\r
+\r
+ Buffer8 = (UINT8 *)Buffer;\r
+ while (Count--) {\r
+ *Buffer8++ = IoRead8 (Port);\r
+ }\r
+}\r
+\r
+/**\r
+ Reads a 16-bit I/O port fifo into a block of memory.\r
+\r
+ Reads the 16-bit I/O fifo port specified by Port.\r
+ The port is read Count times, and the read data is\r
+ stored in the provided Buffer.\r
+\r
+ This function must guarantee that all I/O read and write operations are\r
+ serialized.\r
+\r
+ If 16-bit I/O port operations are not supported, then ASSERT().\r
+\r
+ @param Port The I/O port to read.\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
+IoReadFifo16 (\r
+ IN UINTN Port,\r
+ IN UINTN Count,\r
+ OUT VOID *Buffer\r
+ )\r
+{\r
+ UINT16 *Buffer16;\r
+\r
+ Buffer16 = (UINT16 *)Buffer;\r
+ while (Count--) {\r
+ *Buffer16++ = IoRead16 (Port);\r
+ }\r
+}\r
+\r
+/**\r
+ Reads a 32-bit I/O port fifo into a block of memory.\r
+\r
+ Reads the 32-bit I/O fifo port specified by Port.\r
+ The port is read Count times, and the read data is\r
+ stored in the provided Buffer.\r
+\r
+ This function must guarantee that all I/O read and write operations are\r
+ serialized.\r
+\r
+ If 32-bit I/O port operations are not supported, then ASSERT().\r
+\r
+ @param Port The I/O port to read.\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
+IoReadFifo32 (\r
+ IN UINTN Port,\r
+ IN UINTN Count,\r
+ OUT VOID *Buffer\r
+ )\r
+{\r
+ UINT32 *Buffer32;\r
+\r
+ Buffer32 = (UINT32 *)Buffer;\r
+ while (Count--) {\r
+ *Buffer32++ = IoRead32 (Port);\r
+ }\r
+}\r
+\r
+/**\r
+ Writes a block of memory into an 8-bit I/O port fifo.\r
+\r
+ Writes the 8-bit I/O fifo port specified by Port.\r
+ The port is written Count times, and the write data is\r
+ retrieved from the provided Buffer.\r
+\r
+ This function must guarantee that all I/O write and write operations are\r
+ serialized.\r
+\r
+ If 8-bit I/O port operations are not supported, then ASSERT().\r
+\r
+ @param Port The I/O port to write.\r
+ @param Count The number of times to write I/O port.\r
+ @param Buffer The buffer to retrieve the write data from.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+IoWriteFifo8 (\r
+ IN UINTN Port,\r
+ IN UINTN Count,\r
+ IN VOID *Buffer\r
+ )\r
+{\r
+ UINT8 *Buffer8;\r
+\r
+ Buffer8 = (UINT8 *)Buffer;\r
+ while (Count--) {\r
+ IoWrite8 (Port, *Buffer8++);\r
+ }\r
+}\r
+\r
+/**\r
+ Writes a block of memory into a 16-bit I/O port fifo.\r
+\r
+ Writes the 16-bit I/O fifo port specified by Port.\r
+ The port is written Count times, and the write data is\r
+ retrieved from the provided Buffer.\r
+\r
+ This function must guarantee that all I/O write and write operations are\r
+ serialized.\r
+\r
+ If 16-bit I/O port operations are not supported, then ASSERT().\r
+\r
+ @param Port The I/O port to write.\r
+ @param Count The number of times to write I/O port.\r
+ @param Buffer The buffer to retrieve the write data from.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+IoWriteFifo16 (\r
+ IN UINTN Port,\r
+ IN UINTN Count,\r
+ IN VOID *Buffer\r
+ )\r
+{\r
+ UINT16 *Buffer16;\r
+\r
+ Buffer16 = (UINT16 *)Buffer;\r
+ while (Count--) {\r
+ IoWrite16 (Port, *Buffer16++);\r
+ }\r
+}\r
+\r
+/**\r
+ Writes a block of memory into a 32-bit I/O port fifo.\r
+\r
+ Writes the 32-bit I/O fifo port specified by Port.\r
+ The port is written Count times, and the write data is\r
+ retrieved from the provided Buffer.\r
+\r
+ This function must guarantee that all I/O write and write operations are\r
+ serialized.\r
+\r
+ If 32-bit I/O port operations are not supported, then ASSERT().\r
+\r
+ @param Port The I/O port to write.\r
+ @param Count The number of times to write I/O port.\r
+ @param Buffer The buffer to retrieve the write data from.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+IoWriteFifo32 (\r
+ IN UINTN Port,\r
+ IN UINTN Count,\r
+ IN VOID *Buffer\r
+ )\r
+{\r
+ UINT32 *Buffer32;\r
+\r
+ Buffer32 = (UINT32 *)Buffer;\r
+ while (Count--) {\r
+ IoWrite32 (Port, *Buffer32++);\r
+ }\r
+}\r
+\r
+/**\r
+ Reads an 8-bit MMIO register.\r
\r
Reads the 8-bit MMIO register specified by Address. The 8-bit read value is\r
returned. This function must guarantee that all MMIO read and write\r
operations are serialized.\r
\r
+ If 8-bit MMIO register operations are not supported, then ASSERT().\r
+\r
@param Address The MMIO register to read.\r
\r
- @return The value read from Address.\r
+ @return The value read.\r
\r
**/\r
UINT8\r
EFIAPI\r
MmioRead8 (\r
- IN UINTN Address\r
+ IN UINTN Address\r
)\r
{\r
UINT8 Data;\r
returned. This function must guarantee that all MMIO read and write\r
operations are serialized.\r
\r
+ If 16-bit MMIO register operations are not supported, then ASSERT().\r
+ If Address is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
@param Address The MMIO register to read.\r
\r
- @return The value read from Address.\r
+ @return The value read.\r
\r
**/\r
UINT16\r
EFIAPI\r
MmioRead16 (\r
- IN UINTN Address\r
+ IN UINTN Address\r
)\r
{\r
UINT16 Data;\r
returned. This function must guarantee that all MMIO read and write\r
operations are serialized.\r
\r
+ If 32-bit MMIO register operations are not supported, then ASSERT().\r
+ If Address is not aligned on a 32-bit boundary, then ASSERT().\r
+\r
@param Address The MMIO register to read.\r
\r
- @return The value read from Address.\r
+ @return The value read.\r
\r
**/\r
UINT32\r
EFIAPI\r
MmioRead32 (\r
- IN UINTN Address\r
+ IN UINTN Address\r
)\r
{\r
UINT32 Data;\r
returned. This function must guarantee that all MMIO read and write\r
operations are serialized.\r
\r
+ If 64-bit MMIO register operations are not supported, then ASSERT().\r
+ If Address is not aligned on a 64-bit boundary, then ASSERT().\r
+\r
@param Address The MMIO register to read.\r
\r
- @return The value read from Address.\r
+ @return The value read.\r
\r
**/\r
UINT64\r
EFIAPI\r
MmioRead64 (\r
- IN UINTN Address\r
+ IN UINTN Address\r
)\r
{\r
UINT64 Data;\r
}\r
\r
/**\r
- Writes a 8-bit MMIO register.\r
+ Writes an 8-bit MMIO register.\r
\r
Writes the 8-bit MMIO register specified by Address with the value specified\r
by Value and returns Value. This function must guarantee that all MMIO read\r
and write operations are serialized.\r
\r
- @param Address The MMIO register to write.\r
- @param Data The value to write to the MMIO register.\r
+ If 8-bit MMIO register operations are not supported, then ASSERT().\r
\r
- @return The value written to the Mmio. It equals to the\r
- input Value instead of the actual value read back from\r
- the Mmio.\r
+ @param Address The MMIO register to write.\r
+ @param Value The value to write to the MMIO register.\r
+ \r
+ @return Value.\r
\r
**/\r
UINT8\r
EFIAPI\r
MmioWrite8 (\r
- IN UINTN Address,\r
- IN UINT8 Data\r
+ IN UINTN Address,\r
+ IN UINT8 Value\r
)\r
{\r
Address |= BIT63;\r
\r
MemoryFence ();\r
- *((volatile UINT8 *) Address) = Data;\r
+ *((volatile UINT8 *) Address) = Value;\r
MemoryFence ();\r
\r
- return Data;\r
+ return Value;\r
}\r
\r
/**\r
by Value and returns Value. This function must guarantee that all MMIO read\r
and write operations are serialized.\r
\r
- @param Address The MMIO register to write.\r
- @param Data The value to write to the MMIO register.\r
+ If 16-bit MMIO register operations are not supported, then ASSERT().\r
+ If Address is not aligned on a 16-bit boundary, then ASSERT().\r
\r
- @return The value written to the Mmio. It equals to the\r
- input Value instead of the actual value read back from\r
- the Mmio.\r
+ @param Address The MMIO register to write.\r
+ @param Value The value to write to the MMIO register.\r
+ \r
+ @return Value.\r
\r
**/\r
UINT16\r
EFIAPI\r
MmioWrite16 (\r
- IN UINTN Address,\r
- IN UINT16 Data\r
+ IN UINTN Address,\r
+ IN UINT16 Value\r
)\r
{\r
//\r
Address |= BIT63;\r
\r
MemoryFence ();\r
- *((volatile UINT16 *) Address) = Data;\r
+ *((volatile UINT16 *) Address) = Value;\r
MemoryFence ();\r
\r
- return Data;\r
+ return Value;\r
}\r
\r
/**\r
by Value and returns Value. This function must guarantee that all MMIO read\r
and write operations are serialized.\r
\r
- @param Address The MMIO register to write.\r
- @param Data The value to write to the MMIO register.\r
+ If 32-bit MMIO register operations are not supported, then ASSERT().\r
+ If Address is not aligned on a 32-bit boundary, then ASSERT().\r
\r
- @return The value written to the Mmio. It equals to the\r
- input Value instead of the actual value read back from\r
- the Mmio.\r
+ @param Address The MMIO register to write.\r
+ @param Value The value to write to the MMIO register.\r
+ \r
+ @return Value.\r
\r
**/\r
UINT32\r
EFIAPI\r
MmioWrite32 (\r
- IN UINTN Address,\r
- IN UINT32 Data\r
+ IN UINTN Address,\r
+ IN UINT32 Value\r
)\r
{\r
//\r
Address |= BIT63;\r
\r
MemoryFence ();\r
- *((volatile UINT32 *) Address) = Data;\r
+ *((volatile UINT32 *) Address) = Value;\r
MemoryFence ();\r
\r
- return Data;\r
+ return Value;\r
}\r
\r
/**\r
by Value and returns Value. This function must guarantee that all MMIO read\r
and write operations are serialized.\r
\r
- @param Address The MMIO register to write.\r
- @param Data The value to write to the MMIO register.\r
+ If 64-bit MMIO register operations are not supported, then ASSERT().\r
+ If Address is not aligned on a 64-bit boundary, then ASSERT().\r
\r
- @return The value written to the Mmio. It equals to the\r
- input Value instead of the actual value read back from\r
- the Mmio.\r
+ @param Address The MMIO register to write.\r
+ @param Value The value to write to the MMIO register.\r
\r
**/\r
UINT64\r
EFIAPI\r
MmioWrite64 (\r
- IN UINTN Address,\r
- IN UINT64 Data\r
+ IN UINTN Address,\r
+ IN UINT64 Value\r
)\r
{\r
//\r
Address |= BIT63;\r
\r
MemoryFence ();\r
- *((volatile UINT64 *) Address) = Data;\r
+ *((volatile UINT64 *) Address) = Value;\r
MemoryFence ();\r
\r
- return Data;\r
+ return Value;\r
}\r
projects / mirror_edk2.git / blobdiff