/** @file\r
I/O and MMIO Library Services that do I/O and also enable the I/O operation\r
to be replayed during an S3 resume. This library class maps directly on top\r
- of the IoLib class. \r
+ of the IoLib class.\r
\r
- Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>\r
+ Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions\r
\r
/**\r
Reads an 8-bit I/O port, performs a bitwise AND followed by a bitwise\r
- inclusive OR, writes the result back to the 8-bit I/O port, and saves \r
+ inclusive OR, writes the result back to the 8-bit I/O port, and saves\r
the value in the S3 script to be replayed on S3 resume.\r
\r
Reads the 8-bit I/O port specified by Port, performs a bitwise AND between\r
\r
Writes Value to the bit field of the I/O register. The bit field is specified\r
by the StartBit and the EndBit. All other bits in the destination I/O\r
- register are preserved. The value written to the I/O port is returned. \r
+ register are preserved. The value written to the I/O port is returned.\r
Remaining bits in Value are stripped.\r
\r
If 8-bit I/O port operations are not supported, then ASSERT().\r
\r
/**\r
Reads a bit field in an 8-bit port, performs a bitwise OR, writes the\r
- result back to the bit field in the 8-bit port, and saves the value in the \r
+ result back to the bit field in the 8-bit port, and saves the value in the\r
S3 script to be replayed on S3 resume.\r
\r
Reads the 8-bit I/O port specified by Port, performs a bitwise OR\r
\r
/**\r
Reads a bit field in an 8-bit port, performs a bitwise AND, writes the\r
- result back to the bit field in the 8-bit port, and saves the value in the \r
+ result back to the bit field in the 8-bit port, and saves the value in the\r
S3 script to be replayed on S3 resume.\r
\r
Reads the 8-bit I/O port specified by Port, performs a bitwise AND between\r
\r
/**\r
Reads a 16-bit I/O port, performs a bitwise OR, writes the\r
- result back to the 16-bit I/O port, and saves the value in the S3 script to \r
+ result back to the 16-bit I/O port, and saves the value in the S3 script to\r
be replayed on S3 resume.\r
\r
Reads the 16-bit I/O port specified by Port, performs a bitwise OR\r
);\r
\r
/**\r
- Writes a bit field to an I/O register, and saves the value in the S3 script \r
+ Writes a bit field to an I/O register, and saves the value in the S3 script\r
to be replayed on S3 resume.\r
\r
Writes Value to the bit field of the I/O register. The bit field is specified\r
\r
/**\r
Reads a bit field in a 16-bit port, performs a bitwise OR, writes the\r
- result back to the bit field in the 16-bit port, and saves the value in the \r
+ result back to the bit field in the 16-bit port, and saves the value in the\r
S3 script to be replayed on S3 resume.\r
\r
Reads the 16-bit I/O port specified by Port, performs a bitwise OR\r
\r
/**\r
Reads a bit field in a 16-bit port, performs a bitwise AND, writes the\r
- result back to the bit field in the 16-bit port, and saves the value in the \r
+ result back to the bit field in the 16-bit port, and saves the value in the\r
S3 script to be replayed on S3 resume.\r
\r
Reads the 16-bit I/O port specified by Port, performs a bitwise AND between\r
/**\r
Reads a bit field in a 16-bit port, performs a bitwise AND followed by a\r
bitwise OR, writes the result back to the bit field in the\r
- 16-bit port, and saves the value in the S3 script to be replayed on S3 \r
+ 16-bit port, and saves the value in the S3 script to be replayed on S3\r
resume.\r
\r
Reads the 16-bit I/O port specified by Port, performs a bitwise AND followed\r
\r
/**\r
Reads a 32-bit I/O port, performs a bitwise OR, writes the\r
- result back to the 32-bit I/O port, and saves the value in the S3 script to \r
+ result back to the 32-bit I/O port, and saves the value in the S3 script to\r
be replayed on S3 resume.\r
\r
Reads the 32-bit I/O port specified by Port, performs a bitwise OR\r
\r
/**\r
Reads a 32-bit I/O port, performs a bitwise AND followed by a bitwise\r
- inclusive OR, writes the result back to the 32-bit I/O port, and saves \r
+ inclusive OR, writes the result back to the 32-bit I/O port, and saves\r
the value in the S3 script to be replayed on S3 resume.\r
\r
Reads the 32-bit I/O port specified by Port, performs a bitwise AND between\r
\r
/**\r
Reads a bit field in a 32-bit port, performs a bitwise OR, writes the\r
- result back to the bit field in the 32-bit port, and saves the value in the \r
+ result back to the bit field in the 32-bit port, and saves the value in the\r
S3 script to be replayed on S3 resume.\r
\r
Reads the 32-bit I/O port specified by Port, performs a bitwise OR\r
\r
/**\r
Reads a bit field in a 32-bit port, performs a bitwise AND, writes the\r
- result back to the bit field in the 32-bit port, and saves the value in the \r
+ result back to the bit field in the 32-bit port, and saves the value in the\r
S3 script to be replayed on S3 resume.\r
\r
Reads the 32-bit I/O port specified by Port, performs a bitwise AND between\r
/**\r
Reads a bit field in a 32-bit port, performs a bitwise AND followed by a\r
bitwise OR, writes the result back to the bit field in the\r
- 32-bit port, and saves the value in the S3 script to be replayed on S3 \r
+ 32-bit port, and saves the value in the S3 script to be replayed on S3\r
resume.\r
\r
Reads the 32-bit I/O port specified by Port, performs a bitwise AND followed\r
\r
/**\r
Reads a 64-bit I/O port, performs a bitwise OR, writes the\r
- result back to the 64-bit I/O port, and saves the value in the S3 script to \r
+ result back to the 64-bit I/O port, and saves the value in the S3 script to\r
be replayed on S3 resume.\r
\r
Reads the 64-bit I/O port specified by Port, performs a bitwise OR\r
\r
/**\r
Reads a bit field in a 64-bit port, performs a bitwise OR, writes the\r
- result back to the bit field in the 64-bit port, and saves the value in the \r
+ result back to the bit field in the 64-bit port, and saves the value in the\r
S3 script to be replayed on S3 resume.\r
\r
Reads the 64-bit I/O port specified by Port, performs a bitwise OR\r
\r
/**\r
Reads a bit field in a 64-bit port, performs a bitwise AND, writes the\r
- result back to the bit field in the 64-bit port, and saves the value in the \r
+ result back to the bit field in the 64-bit port, and saves the value in the\r
S3 script to be replayed on S3 resume.\r
\r
Reads the 64-bit I/O port specified by Port, performs a bitwise AND between\r
/**\r
Reads a bit field in a 64-bit port, performs a bitwise AND followed by a\r
bitwise OR, writes the result back to the bit field in the\r
- 64-bit port, and saves the value in the S3 script to be replayed on S3 \r
+ 64-bit port, and saves the value in the S3 script to be replayed on S3\r
resume.\r
\r
Reads the 64-bit I/O port specified by Port, performs a bitwise AND followed\r
);\r
\r
/**\r
- Reads an 8-bit MMIO register, and saves the value in the S3 script to be \r
+ Reads an 8-bit MMIO register, and saves the value in the S3 script to be\r
replayed on S3 resume.\r
\r
Reads the 8-bit MMIO register specified by Address. The 8-bit read value is\r
);\r
\r
/**\r
- Writes an 8-bit MMIO register, and saves the value in the S3 script to be \r
+ Writes an 8-bit MMIO register, and saves the value in the S3 script to be\r
replayed on S3 resume.\r
\r
Writes the 8-bit MMIO register specified by Address with the value specified\r
\r
/**\r
Reads an 8-bit MMIO register, performs a bitwise OR, writes the\r
- result back to the 8-bit MMIO register, and saves the value in the S3 script \r
+ result back to the 8-bit MMIO register, and saves the value in the S3 script\r
to be replayed on S3 resume.\r
\r
Reads the 8-bit MMIO register specified by Address, performs a bitwise\r
\r
/**\r
Reads an 8-bit MMIO register, performs a bitwise AND, writes the result\r
- back to the 8-bit MMIO register, and saves the value in the S3 script to be \r
+ back to the 8-bit MMIO register, and saves the value in the S3 script to be\r
replayed on S3 resume.\r
\r
Reads the 8-bit MMIO register specified by Address, performs a bitwise AND\r
\r
/**\r
Reads an 8-bit MMIO register, performs a bitwise AND followed by a bitwise\r
- inclusive OR, writes the result back to the 8-bit MMIO register, and saves \r
+ inclusive OR, writes the result back to the 8-bit MMIO register, and saves\r
the value in the S3 script to be replayed on S3 resume.\r
\r
Reads the 8-bit MMIO register specified by Address, performs a bitwise AND\r
);\r
\r
/**\r
- Reads a bit field in an 8-bit MMIO register, performs a bitwise OR, \r
+ Reads a bit field in an 8-bit MMIO register, performs a bitwise OR,\r
writes the result back to the bit field in the 8-bit MMIO register, and saves\r
the value in the S3 script to be replayed on S3 resume.\r
\r
\r
/**\r
Reads a 16-bit MMIO register, performs a bitwise OR, writes the\r
- result back to the 16-bit MMIO register, and saves the value in the S3 script \r
+ result back to the 16-bit MMIO register, and saves the value in the S3 script\r
to be replayed on S3 resume.\r
\r
Reads the 16-bit MMIO register specified by Address, performs a bitwise\r
\r
/**\r
Reads a 16-bit MMIO register, performs a bitwise AND, writes the result\r
- back to the 16-bit MMIO register, and saves the value in the S3 script to be \r
+ back to the 16-bit MMIO register, and saves the value in the S3 script to be\r
replayed on S3 resume.\r
\r
Reads the 16-bit MMIO register specified by Address, performs a bitwise AND\r
\r
/**\r
Reads a 16-bit MMIO register, performs a bitwise AND followed by a bitwise\r
- inclusive OR, writes the result back to the 16-bit MMIO register, and \r
+ inclusive OR, writes the result back to the 16-bit MMIO register, and\r
saves the value in the S3 script to be replayed on S3 resume.\r
\r
Reads the 16-bit MMIO register specified by Address, performs a bitwise AND\r
);\r
\r
/**\r
- Reads a bit field in a 16-bit MMIO register, performs a bitwise OR, \r
- writes the result back to the bit field in the 16-bit MMIO register, and \r
+ Reads a bit field in a 16-bit MMIO register, performs a bitwise OR,\r
+ writes the result back to the bit field in the 16-bit MMIO register, and\r
saves the value in the S3 script to be replayed on S3 resume.\r
\r
Reads the 16-bit MMIO register specified by Address, performs a bitwise\r
\r
/**\r
Reads a bit field in a 16-bit MMIO register, performs a bitwise AND, and\r
- writes the result back to the bit field in the 16-bit MMIO register and \r
+ writes the result back to the bit field in the 16-bit MMIO register and\r
saves the value in the S3 script to be replayed on S3 resume.\r
\r
Reads the 16-bit MMIO register specified by Address, performs a bitwise AND\r
);\r
\r
/**\r
- Reads a 32-bit MMIO register saves the value in the S3 script to be \r
+ Reads a 32-bit MMIO register saves the value in the S3 script to be\r
replayed on S3 resume.\r
\r
Reads the 32-bit MMIO register specified by Address. The 32-bit read value is\r
);\r
\r
/**\r
- Writes a 32-bit MMIO register, and saves the value in the S3 script to be \r
+ Writes a 32-bit MMIO register, and saves the value in the S3 script to be\r
replayed on S3 resume.\r
\r
Writes the 32-bit MMIO register specified by Address with the value specified\r
\r
/**\r
Reads a 32-bit MMIO register, performs a bitwise OR, writes the\r
- result back to the 32-bit MMIO register, and saves the value in the S3 script \r
+ result back to the 32-bit MMIO register, and saves the value in the S3 script\r
to be replayed on S3 resume.\r
\r
Reads the 32-bit MMIO register specified by Address, performs a bitwise\r
\r
/**\r
Reads a 32-bit MMIO register, performs a bitwise AND, writes the result\r
- back to the 32-bit MMIO register, and saves the value in the S3 script to be \r
+ back to the 32-bit MMIO register, and saves the value in the S3 script to be\r
replayed on S3 resume.\r
\r
Reads the 32-bit MMIO register specified by Address, performs a bitwise AND\r
\r
/**\r
Reads a 32-bit MMIO register, performs a bitwise AND followed by a bitwise\r
- inclusive OR, writes the result back to the 32-bit MMIO register, and \r
+ inclusive OR, writes the result back to the 32-bit MMIO register, and\r
saves the value in the S3 script to be replayed on S3 resume.\r
\r
Reads the 32-bit MMIO register specified by Address, performs a bitwise AND\r
);\r
\r
/**\r
- Reads a bit field of a MMIO register, and saves the value in the S3 script \r
+ Reads a bit field of a MMIO register, and saves the value in the S3 script\r
to be replayed on S3 resume.\r
\r
Reads the bit field in a 32-bit MMIO register. The bit field is specified by\r
);\r
\r
/**\r
- Writes a bit field to a MMIO register, and saves the value in the S3 script \r
+ Writes a bit field to a MMIO register, and saves the value in the S3 script\r
to be replayed on S3 resume.\r
\r
Writes Value to the bit field of the MMIO register. The bit field is\r
);\r
\r
/**\r
- Reads a bit field in a 32-bit MMIO register, performs a bitwise OR, \r
- writes the result back to the bit field in the 32-bit MMIO register, and \r
+ Reads a bit field in a 32-bit MMIO register, performs a bitwise OR,\r
+ writes the result back to the bit field in the 32-bit MMIO register, and\r
saves the value in the S3 script to be replayed on S3 resume.\r
\r
Reads the 32-bit MMIO register specified by Address, performs a bitwise\r
\r
/**\r
Reads a bit field in a 32-bit MMIO register, performs a bitwise AND, and\r
- writes the result back to the bit field in the 32-bit MMIO register and \r
+ writes the result back to the bit field in the 32-bit MMIO register and\r
saves the value in the S3 script to be replayed on S3 resume.\r
\r
Reads the 32-bit MMIO register specified by Address, performs a bitwise AND\r
);\r
\r
/**\r
- Reads a 64-bit MMIO register, and saves the value in the S3 script to be \r
+ Reads a 64-bit MMIO register, and saves the value in the S3 script to be\r
replayed on S3 resume.\r
\r
Reads the 64-bit MMIO register specified by Address. The 64-bit read value is\r
);\r
\r
/**\r
- Writes a 64-bit MMIO register, and saves the value in the S3 script to be \r
+ Writes a 64-bit MMIO register, and saves the value in the S3 script to be\r
replayed on S3 resume.\r
\r
Writes the 64-bit MMIO register specified by Address with the value specified\r
\r
/**\r
Reads a 64-bit MMIO register, performs a bitwise OR, writes the\r
- result back to the 64-bit MMIO register, and saves the value in the S3 script \r
+ result back to the 64-bit MMIO register, and saves the value in the S3 script\r
to be replayed on S3 resume.\r
\r
Reads the 64-bit MMIO register specified by Address, performs a bitwise\r
\r
/**\r
Reads a 64-bit MMIO register, performs a bitwise AND, writes the result\r
- back to the 64-bit MMIO register, and saves the value in the S3 script to be \r
+ back to the 64-bit MMIO register, and saves the value in the S3 script to be\r
replayed on S3 resume.\r
\r
Reads the 64-bit MMIO register specified by Address, performs a bitwise AND\r
\r
/**\r
Reads a 64-bit MMIO register, performs a bitwise AND followed by a bitwise\r
- inclusive OR, writes the result back to the 64-bit MMIO register, and \r
+ inclusive OR, writes the result back to the 64-bit MMIO register, and\r
saves the value in the S3 script to be replayed on S3 resume.\r
\r
Reads the 64-bit MMIO register specified by Address, performs a bitwise AND\r
);\r
\r
/**\r
- Reads a bit field in a 64-bit MMIO register, performs a bitwise OR, \r
- writes the result back to the bit field in the 64-bit MMIO register, and \r
+ Reads a bit field in a 64-bit MMIO register, performs a bitwise OR,\r
+ writes the result back to the bit field in the 64-bit MMIO register, and\r
saves the value in the S3 script to be replayed on S3 resume.\r
\r
Reads the 64-bit MMIO register specified by Address, performs a bitwise\r
Copies data from MMIO region to system memory by using 8-bit access,\r
and saves the value in the S3 script to be replayed on S3 resume.\r
\r
- Copy data from MMIO region specified by starting address StartAddress \r
- to system memory specified by Buffer by using 8-bit access. The total \r
+ Copy data from MMIO region specified by starting address StartAddress\r
+ to system memory specified by Buffer by using 8-bit access. The total\r
number of bytes to be copied is specified by Length. Buffer is returned.\r
- \r
- If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). \r
+\r
+ If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
\r
Copies data from MMIO region to system memory by using 16-bit access,\r
and saves the value in the S3 script to be replayed on S3 resume.\r
\r
- Copy data from MMIO region specified by starting address StartAddress \r
- to system memory specified by Buffer by using 16-bit access. The total \r
+ Copy data from MMIO region specified by starting address StartAddress\r
+ to system memory specified by Buffer by using 16-bit access. The total\r
number of bytes to be copied is specified by Length. Buffer is returned.\r
- \r
+\r
If StartAddress is not aligned on a 16-bit boundary, then ASSERT().\r
\r
- If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). \r
+ If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
If Length is not aligned on a 16-bit boundary, then ASSERT().\r
Copies data from MMIO region to system memory by using 32-bit access,\r
and saves the value in the S3 script to be replayed on S3 resume.\r
\r
- Copy data from MMIO region specified by starting address StartAddress \r
- to system memory specified by Buffer by using 32-bit access. The total \r
+ Copy data from MMIO region specified by starting address StartAddress\r
+ to system memory specified by Buffer by using 32-bit access. The total\r
number of byte to be copied is specified by Length. Buffer is returned.\r
- \r
+\r
If StartAddress is not aligned on a 32-bit boundary, then ASSERT().\r
\r
- If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). \r
+ If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
If Length is not aligned on a 32-bit boundary, then ASSERT().\r
Copies data from MMIO region to system memory by using 64-bit access,\r
and saves the value in the S3 script to be replayed on S3 resume.\r
\r
- Copy data from MMIO region specified by starting address StartAddress \r
- to system memory specified by Buffer by using 64-bit access. The total \r
+ Copy data from MMIO region specified by starting address StartAddress\r
+ to system memory specified by Buffer by using 64-bit access. The total\r
number of byte to be copied is specified by Length. Buffer is returned.\r
- \r
+\r
If StartAddress is not aligned on a 64-bit boundary, then ASSERT().\r
\r
- If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). \r
+ If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
If Length is not aligned on a 64-bit boundary, then ASSERT().\r
Copies data from system memory to MMIO region by using 8-bit access,\r
and saves the value in the S3 script to be replayed on S3 resume.\r
\r
- Copy data from system memory specified by Buffer to MMIO region specified \r
- by starting address StartAddress by using 8-bit access. The total number \r
+ Copy data from system memory specified by Buffer to MMIO region specified\r
+ by starting address StartAddress by using 8-bit access. The total number\r
of byte to be copied is specified by Length. Buffer is returned.\r
- \r
- If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). \r
+\r
+ If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT().\r
If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT().\r
\r
\r
Copies data from system memory to MMIO region by using 16-bit access,\r
and saves the value in the S3 script to be replayed on S3 resume.\r
\r
- Copy data from system memory specified by Buffer to MMIO region specified \r
- by starting address StartAddress by using 16-bit access. The total number \r
+ Copy data from system memory specified by Buffer to MMIO region specified\r
+ by starting address StartAddress by using 16-bit access. The total number\r
of bytes to be copied is specified by Length. Buffer is returned.\r
- \r
+\r
If StartAddress is not aligned on a 16-bit boundary, then ASSERT().\r
\r
- If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). \r
+ If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT().\r
If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT().\r
\r
If Length is not aligned on a 16-bit boundary, then ASSERT().\r
Copies data from system memory to MMIO region by using 32-bit access,\r
and saves the value in the S3 script to be replayed on S3 resume.\r
\r
- Copy data from system memory specified by Buffer to MMIO region specified \r
- by starting address StartAddress by using 32-bit access. The total number \r
+ Copy data from system memory specified by Buffer to MMIO region specified\r
+ by starting address StartAddress by using 32-bit access. The total number\r
of bytes to be copied is specified by Length. Buffer is returned.\r
- \r
+\r
If StartAddress is not aligned on a 32-bit boundary, then ASSERT().\r
\r
- If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). \r
+ If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT().\r
If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT().\r
\r
If Length is not aligned on a 32-bit boundary, then ASSERT().\r
);\r
\r
/**\r
- Copies data from system memory to MMIO region by using 64-bit access, \r
+ Copies data from system memory to MMIO region by using 64-bit access,\r
and saves the value in the S3 script to be replayed on S3 resume.\r
\r
- Copy data from system memory specified by Buffer to MMIO region specified \r
- by starting address StartAddress by using 64-bit access. The total number \r
+ Copy data from system memory specified by Buffer to MMIO region specified\r
+ by starting address StartAddress by using 64-bit access. The total number\r
of bytes to be copied is specified by Length. Buffer is returned.\r
- \r
+\r
If StartAddress is not aligned on a 64-bit boundary, then ASSERT().\r
\r
- If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). \r
+ If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT().\r
If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT().\r
\r
If Length is not aligned on a 64-bit boundary, then ASSERT().\r
projects / mirror_edk2.git / blobdiff