/** @file\r
I/O Library basic function implementation and worker functions.\r
\r
- Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
+ Copyright (c) 2006 - 2018, 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
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. If such operations are not supported, then ASSERT().\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
ReturnReg = EsalCall (\r
EFI_EXTENDED_SAL_BASE_IO_SERVICES_PROTOCOL_GUID_LO,\r
EFI_EXTENDED_SAL_BASE_IO_SERVICES_PROTOCOL_GUID_HI,\r
- IoReadFunctionId, \r
- (UINT64)Width, \r
- Port, \r
- 1, \r
- (UINT64)&Data, \r
- 0, \r
- 0, \r
+ IoReadFunctionId,\r
+ (UINT64)Width,\r
+ Port,\r
+ 1,\r
+ (UINT64)&Data,\r
+ 0,\r
+ 0,\r
0\r
);\r
ASSERT (ReturnReg.Status == EFI_SAL_SUCCESS);\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. If such operations are not supported, then ASSERT().\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 paramter of Data.\r
+ @return The parameter of Data.\r
\r
**/\r
UINT64\r
ReturnReg = EsalCall (\r
EFI_EXTENDED_SAL_BASE_IO_SERVICES_PROTOCOL_GUID_LO,\r
EFI_EXTENDED_SAL_BASE_IO_SERVICES_PROTOCOL_GUID_HI,\r
- IoWriteFunctionId, \r
- (UINT64)Width, \r
- Port, \r
- 1, \r
- (UINT64)&Data, \r
- 0, \r
- 0, \r
+ IoWriteFunctionId,\r
+ (UINT64)Width,\r
+ Port,\r
+ 1,\r
+ (UINT64)&Data,\r
+ 0,\r
+ 0,\r
0\r
);\r
ASSERT (ReturnReg.Status == EFI_SAL_SUCCESS);\r
return 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
+ SAL_RETURN_REGS ReturnReg;\r
+\r
+ ReturnReg = EsalCall (\r
+ EFI_EXTENDED_SAL_BASE_IO_SERVICES_PROTOCOL_GUID_LO,\r
+ EFI_EXTENDED_SAL_BASE_IO_SERVICES_PROTOCOL_GUID_HI,\r
+ IoReadFunctionId,\r
+ (UINT64)Width,\r
+ Port,\r
+ Count,\r
+ (UINT64)Buffer,\r
+ 0,\r
+ 0,\r
+ 0\r
+ );\r
+ ASSERT (ReturnReg.Status == EFI_SAL_SUCCESS);\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
+ SAL_RETURN_REGS ReturnReg;\r
+\r
+ ReturnReg = EsalCall (\r
+ EFI_EXTENDED_SAL_BASE_IO_SERVICES_PROTOCOL_GUID_LO,\r
+ EFI_EXTENDED_SAL_BASE_IO_SERVICES_PROTOCOL_GUID_HI,\r
+ IoWriteFunctionId,\r
+ (UINT64)Width,\r
+ Port,\r
+ Count,\r
+ (UINT64)Buffer,\r
+ 0,\r
+ 0,\r
+ 0\r
+ );\r
+ ASSERT (ReturnReg.Status == EFI_SAL_SUCCESS);\r
+}\r
+\r
/**\r
Reads memory-mapped registers in the EFI system memory space.\r
\r
ReturnReg = EsalCall (\r
EFI_EXTENDED_SAL_BASE_IO_SERVICES_PROTOCOL_GUID_LO,\r
EFI_EXTENDED_SAL_BASE_IO_SERVICES_PROTOCOL_GUID_HI,\r
- MemReadFunctionId, \r
- (UINT64)Width, \r
- Address, \r
- 1, \r
- (UINT64)&Data, \r
- 0, \r
- 0, \r
+ MemReadFunctionId,\r
+ (UINT64)Width,\r
+ Address,\r
+ 1,\r
+ (UINT64)&Data,\r
+ 0,\r
+ 0,\r
0\r
);\r
ASSERT (ReturnReg.Status == EFI_SAL_SUCCESS);\r
ReturnReg = EsalCall (\r
EFI_EXTENDED_SAL_BASE_IO_SERVICES_PROTOCOL_GUID_LO,\r
EFI_EXTENDED_SAL_BASE_IO_SERVICES_PROTOCOL_GUID_HI,\r
- MemWriteFunctionId, \r
- (UINT64)Width, \r
- Address, \r
- 1, \r
- (UINT64)&Data, \r
- 0, \r
- 0, \r
+ MemWriteFunctionId,\r
+ (UINT64)Width,\r
+ Address,\r
+ 1,\r
+ (UINT64)&Data,\r
+ 0,\r
+ 0,\r
0\r
);\r
ASSERT (ReturnReg.Status == EFI_SAL_SUCCESS);\r
return IoWriteWorker (Port, EfiCpuIoWidthUint64, Value);\r
}\r
\r
+/**\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
+ IoReadFifoWorker (Port, EfiCpuIoWidthFifoUint8, Count, Buffer);\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
+ IoWriteFifoWorker (Port, EfiCpuIoWidthFifoUint8, Count, Buffer);\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
+ //\r
+ // Make sure Port is aligned on a 16-bit boundary.\r
+ //\r
+ ASSERT ((Port & 1) == 0);\r
+ IoReadFifoWorker (Port, EfiCpuIoWidthFifoUint16, Count, Buffer);\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
+ //\r
+ // Make sure Port is aligned on a 16-bit boundary.\r
+ //\r
+ ASSERT ((Port & 1) == 0);\r
+ IoWriteFifoWorker (Port, EfiCpuIoWidthFifoUint16, Count, Buffer);\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
+ //\r
+ // Make sure Port is aligned on a 32-bit boundary.\r
+ //\r
+ ASSERT ((Port & 3) == 0);\r
+ IoReadFifoWorker (Port, EfiCpuIoWidthFifoUint32, Count, Buffer);\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
+ //\r
+ // Make sure Port is aligned on a 32-bit boundary.\r
+ //\r
+ ASSERT ((Port & 3) == 0);\r
+ IoWriteFifoWorker (Port, EfiCpuIoWidthFifoUint32, Count, Buffer);\r
+}\r
+\r
/**\r
Reads an 8-bit MMIO register.\r
\r
projects / mirror_edk2.git / blobdiff