/** @file\r
- I/O and MMIO Library Services\r
+ Provide services to access I/O Ports and MMIO registers.\r
\r
- Copyright (c) 2006 - 2007, Intel Corporation\r
- All rights reserved. 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
+Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
+All rights reserved. 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
\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
+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
#ifndef __IO_LIB_H__\r
#define __IO_LIB_H__\r
\r
+/**\r
+ Macro that converts PCI Segment and I/O Port to an address that can be\r
+ passed to the I/O Library functions.\r
+ \r
+ Computes an address that is compatible with the I/O Library functions. \r
+ The unused upper bits of Segment, and Port are stripped prior to the \r
+ generation of the address.\r
+ \r
+ @param Segment PCI Segment number. Range 0..65535.\r
+ @param Port I/O Port number. Range 0..65535.\r
+ \r
+ @return An address that the I/o Library functions need.\r
+\r
+**/\r
+\r
#define IO_LIB_ADDRESS(Segment,Port) \\r
( ((Port) & 0xffff) | (((Segment) & 0xffff) << 16) )\r
\r
);\r
\r
/**\r
- Reads an 8-bit I/O port, performs a bitwise inclusive OR, and writes the\r
+ Reads an 8-bit I/O port, performs a bitwise OR, and writes the\r
result back to the 8-bit I/O port.\r
\r
- Reads the 8-bit I/O port specified by Port, performs a bitwise inclusive OR\r
+ Reads the 8-bit I/O port specified by Port, performs a bitwise OR\r
between the read result and the value specified by OrData, and writes the\r
result to the 8-bit I/O port specified by Port. The value written to the I/O\r
port is returned. This function must guarantee that all I/O read and write\r
);\r
\r
/**\r
- Reads an 8-bit I/O port, performs a bitwise AND followed by a bitwise\r
- inclusive OR, and writes the result back to the 8-bit I/O port.\r
+ Reads an 8-bit I/O port, performs a bitwise AND followed by a bitwise \r
+ OR, and writes the result back to the 8-bit I/O port.\r
\r
Reads the 8-bit I/O port specified by Port, performs a bitwise AND between\r
the read result and the value specified by AndData, performs a bitwise OR\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. Extra\r
- left bits in Value are stripped.\r
+ register are preserved. The value written to the I/O port is returned. \r
\r
If 8-bit I/O port operations are not supported, then ASSERT().\r
If StartBit is greater than 7, then ASSERT().\r
Reads a bit field in an 8-bit port, performs a bitwise OR, and writes the\r
result back to the bit field in the 8-bit port.\r
\r
- Reads the 8-bit I/O port specified by Port, performs a bitwise inclusive OR\r
+ Reads the 8-bit I/O port specified by Port, performs a bitwise OR\r
between the read result and the value specified by OrData, and writes the\r
result to the 8-bit I/O port specified by Port. The value written to the I/O\r
port is returned. This function must guarantee that all I/O read and write\r
\r
/**\r
Reads a bit field in an 8-bit port, performs a bitwise AND followed by a\r
- bitwise inclusive OR, and writes the result back to the bit field in the\r
+ bitwise OR, and writes the result back to the bit field in the\r
8-bit port.\r
\r
Reads the 8-bit I/O port specified by Port, performs a bitwise AND followed\r
- by a bitwise inclusive OR between the read result and the value specified by\r
+ by a bitwise OR between the read result and the value specified by\r
AndData, and writes the result to the 8-bit I/O port specified by Port. The\r
value written to the I/O port is returned. This function must guarantee that\r
all I/O read and write operations are serialized. Extra left bits in both\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
operations are serialized.\r
\r
If 16-bit I/O port operations are not supported, then ASSERT().\r
-\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 Value The value to write to the I/O port.\r
\r
);\r
\r
/**\r
- Reads a 16-bit I/O port, performs a bitwise inclusive OR, and writes the\r
+ Reads a 16-bit I/O port, performs a bitwise OR, and writes the\r
result back to the 16-bit I/O port.\r
\r
- Reads the 16-bit I/O port specified by Port, performs a bitwise inclusive OR\r
+ Reads the 16-bit I/O port specified by Port, performs a bitwise OR\r
between the read result and the value specified by OrData, and writes the\r
result to the 16-bit I/O port specified by Port. The value written to the I/O\r
port is returned. 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 OrData The value to OR with the read value from the I/O port.\r
are serialized.\r
\r
If 16-bit I/O port operations are not supported, then ASSERT().\r
-\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 AndData The value to AND with the read value from the I/O port.\r
\r
);\r
\r
/**\r
- Reads a 16-bit I/O port, performs a bitwise AND followed by a bitwise\r
- inclusive OR, and writes the result back to the 16-bit I/O port.\r
+ Reads a 16-bit I/O port, performs a bitwise AND followed by a bitwise \r
+ OR, and writes the result back to the 16-bit I/O port.\r
\r
Reads the 16-bit I/O port specified by Port, performs a bitwise AND between\r
the read result and the value specified by AndData, performs a bitwise OR\r
I/O read and write operations are serialized.\r
\r
If 16-bit I/O port operations are not supported, then ASSERT().\r
-\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 AndData The value to AND with the read value from the I/O port.\r
@param OrData The value to OR with the result of the AND operation.\r
the StartBit and the EndBit. The value of the bit field is returned.\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
If StartBit is greater than 15, then ASSERT().\r
If EndBit is greater than 15, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
left bits in Value are stripped.\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
If StartBit is greater than 15, then ASSERT().\r
If EndBit is greater than 15, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
Reads a bit field in a 16-bit port, performs a bitwise OR, and writes the\r
result back to the bit field in the 16-bit port.\r
\r
- Reads the 16-bit I/O port specified by Port, performs a bitwise inclusive OR\r
+ Reads the 16-bit I/O port specified by Port, performs a bitwise OR\r
between the read result and the value specified by OrData, and writes the\r
result to the 16-bit I/O port specified by Port. The value written to the I/O\r
port is returned. This function must guarantee that all I/O read and write\r
operations are serialized. Extra left bits in OrData are stripped.\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
If StartBit is greater than 15, then ASSERT().\r
If EndBit is greater than 15, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
are serialized. Extra left bits in AndData are stripped.\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
If StartBit is greater than 15, then ASSERT().\r
If EndBit is greater than 15, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
\r
/**\r
Reads a bit field in a 16-bit port, performs a bitwise AND followed by a\r
- bitwise inclusive OR, and writes the result back to the bit field in the\r
+ bitwise OR, and writes the result back to the bit field in the\r
16-bit port.\r
\r
Reads the 16-bit I/O port specified by Port, performs a bitwise AND followed\r
- by a bitwise inclusive OR between the read result and the value specified by\r
+ by a bitwise OR between the read result and the value specified by\r
AndData, and writes the result to the 16-bit I/O port specified by Port. The\r
value written to the I/O port is returned. This function must guarantee that\r
all I/O read and write operations are serialized. Extra left bits in both\r
AndData and OrData are stripped.\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
If StartBit is greater than 15, then ASSERT().\r
If EndBit is greater than 15, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
serialized.\r
\r
If 32-bit I/O port operations are not supported, then ASSERT().\r
-\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.\r
operations are serialized.\r
\r
If 32-bit I/O port operations are not supported, then ASSERT().\r
-\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 Value The value to write to the I/O port.\r
\r
);\r
\r
/**\r
- Reads a 32-bit I/O port, performs a bitwise inclusive OR, and writes the\r
+ Reads a 32-bit I/O port, performs a bitwise OR, and writes the\r
result back to the 32-bit I/O port.\r
\r
- Reads the 32-bit I/O port specified by Port, performs a bitwise inclusive OR\r
+ Reads the 32-bit I/O port specified by Port, performs a bitwise OR\r
between the read result and the value specified by OrData, and writes the\r
result to the 32-bit I/O port specified by Port. The value written to the I/O\r
port is returned. 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 OrData The value to OR with the read value from the I/O port.\r
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 AndData The value to AND with the read value from the I/O port.\r
);\r
\r
/**\r
- Reads a 32-bit I/O port, performs a bitwise AND followed by a bitwise\r
- inclusive OR, and writes the result back to the 32-bit I/O port.\r
+ Reads a 32-bit I/O port, performs a bitwise AND followed by a bitwise \r
+ OR, and writes the result back to the 32-bit I/O port.\r
\r
Reads the 32-bit I/O port specified by Port, performs a bitwise AND between\r
the read result and the value specified by AndData, performs a bitwise OR\r
I/O read and write 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 AndData The value to AND with the read value from the I/O port.\r
the StartBit and the EndBit. The value of the bit field is returned.\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
If StartBit is greater than 31, then ASSERT().\r
If EndBit is greater than 31, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
left bits in Value are stripped.\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
If StartBit is greater than 31, then ASSERT().\r
If EndBit is greater than 31, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
Reads a bit field in a 32-bit port, performs a bitwise OR, and writes the\r
result back to the bit field in the 32-bit port.\r
\r
- Reads the 32-bit I/O port specified by Port, performs a bitwise inclusive OR\r
+ Reads the 32-bit I/O port specified by Port, performs a bitwise OR\r
between the read result and the value specified by OrData, and writes the\r
result to the 32-bit I/O port specified by Port. The value written to the I/O\r
port is returned. This function must guarantee that all I/O read and write\r
operations are serialized. Extra left bits in OrData are stripped.\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
If StartBit is greater than 31, then ASSERT().\r
If EndBit is greater than 31, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
are serialized. Extra left bits in AndData are stripped.\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
If StartBit is greater than 31, then ASSERT().\r
If EndBit is greater than 31, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
\r
/**\r
Reads a bit field in a 32-bit port, performs a bitwise AND followed by a\r
- bitwise inclusive OR, and writes the result back to the bit field in the\r
+ bitwise OR, and writes the result back to the bit field in the\r
32-bit port.\r
\r
Reads the 32-bit I/O port specified by Port, performs a bitwise AND followed\r
- by a bitwise inclusive OR between the read result and the value specified by\r
+ by a bitwise OR between the read result and the value specified by\r
AndData, and writes the result to the 32-bit I/O port specified by Port. The\r
value written to the I/O port is returned. This function must guarantee that\r
all I/O read and write operations are serialized. Extra left bits in both\r
AndData and OrData are stripped.\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
If StartBit is greater than 31, then ASSERT().\r
If EndBit is greater than 31, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\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
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
\r
/**\r
- Reads a 64-bit I/O port, performs a bitwise inclusive OR, and writes the\r
+ Reads a 64-bit I/O port, performs a bitwise OR, and writes the\r
result back to the 64-bit I/O port.\r
\r
- Reads the 64-bit I/O port specified by Port, performs a bitwise inclusive OR\r
+ Reads the 64-bit I/O port specified by Port, performs a bitwise OR\r
between the read result and the value specified by OrData, and writes the\r
result to the 64-bit I/O port specified by Port. The value written to the I/O\r
port is returned. This function must guarantee that all I/O read and write\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 OrData The value to OR with the read value from the I/O port.\r
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 AndData The value to AND with the read value from the I/O port.\r
);\r
\r
/**\r
- Reads a 64-bit I/O port, performs a bitwise AND followed by a bitwise\r
- inclusive OR, and writes the result back to the 64-bit I/O port.\r
+ Reads a 64-bit I/O port, performs a bitwise AND followed by a bitwise \r
+ OR, and writes the result back to the 64-bit I/O port.\r
\r
Reads the 64-bit I/O port specified by Port, performs a bitwise AND between\r
the read result and the value specified by AndData, performs a bitwise OR\r
I/O read and write 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 AndData The value to AND with the read value from the I/O port.\r
the StartBit and the EndBit. The value of the bit field is returned.\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
If StartBit is greater than 63, then ASSERT().\r
If EndBit is greater than 63, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
left bits in Value are stripped.\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
If StartBit is greater than 63, then ASSERT().\r
If EndBit is greater than 63, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
Reads a bit field in a 64-bit port, performs a bitwise OR, and writes the\r
result back to the bit field in the 64-bit port.\r
\r
- Reads the 64-bit I/O port specified by Port, performs a bitwise inclusive OR\r
+ Reads the 64-bit I/O port specified by Port, performs a bitwise OR\r
between the read result and the value specified by OrData, and writes the\r
result to the 64-bit I/O port specified by Port. The value written to the I/O\r
port is returned. This function must guarantee that all I/O read and write\r
operations are serialized. Extra left bits in OrData are stripped.\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
If StartBit is greater than 63, then ASSERT().\r
If EndBit is greater than 63, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
are serialized. Extra left bits in AndData are stripped.\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
If StartBit is greater than 63, then ASSERT().\r
If EndBit is greater than 63, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
\r
/**\r
Reads a bit field in a 64-bit port, performs a bitwise AND followed by a\r
- bitwise inclusive OR, and writes the result back to the bit field in the\r
+ bitwise OR, and writes the result back to the bit field in the\r
64-bit port.\r
\r
Reads the 64-bit I/O port specified by Port, performs a bitwise AND followed\r
- by a bitwise inclusive OR between the read result and the value specified by\r
+ by a bitwise OR between the read result and the value specified by\r
AndData, and writes the result to the 64-bit I/O port specified by Port. The\r
value written to the I/O port is returned. This function must guarantee that\r
all I/O read and write operations are serialized. Extra left bits in both\r
AndData and OrData are stripped.\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
If StartBit is greater than 63, then ASSERT().\r
If EndBit is greater than 63, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
\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
);\r
\r
/**\r
- Reads an 8-bit MMIO register, performs a bitwise inclusive OR, and writes the\r
+ Reads an 8-bit MMIO register, performs a bitwise OR, and writes the\r
result back to the 8-bit MMIO register.\r
\r
- Reads the 8-bit MMIO register specified by Address, performs a bitwise\r
- inclusive OR between the read result and the value specified by OrData, and\r
+ Reads the 8-bit MMIO register specified by Address, performs a bitwise \r
+ OR between the read result and the value specified by OrData, and\r
writes the result to the 8-bit MMIO register specified by Address. The value\r
written to the MMIO register is returned. This function must guarantee that\r
all MMIO read and write operations are serialized.\r
);\r
\r
/**\r
- Reads an 8-bit MMIO register, performs a bitwise AND followed by a bitwise\r
- inclusive OR, and writes the result back to the 8-bit MMIO register.\r
+ Reads an 8-bit MMIO register, performs a bitwise AND followed by a bitwise \r
+ OR, and writes the result back to the 8-bit MMIO register.\r
\r
Reads the 8-bit MMIO register specified by Address, performs a bitwise AND\r
between the read result and the value specified by AndData, performs a\r
Reads a bit field in an 8-bit MMIO register, performs a bitwise OR, and\r
writes the result back to the bit field in the 8-bit MMIO register.\r
\r
- Reads the 8-bit MMIO register specified by Address, performs a bitwise\r
- inclusive OR between the read result and the value specified by OrData, and\r
+ Reads the 8-bit MMIO register specified by Address, performs a bitwise \r
+ OR between the read result and the value specified by OrData, and\r
writes the result to the 8-bit MMIO register specified by Address. The value\r
written to the MMIO register is returned. This function must guarantee that\r
all MMIO read and write operations are serialized. Extra left bits in OrData\r
\r
/**\r
Reads a bit field in an 8-bit MMIO register, performs a bitwise AND followed\r
- by a bitwise inclusive OR, and writes the result back to the bit field in the\r
+ by a bitwise OR, and writes the result back to the bit field in the\r
8-bit MMIO register.\r
\r
Reads the 8-bit MMIO register specified by Address, performs a bitwise AND\r
- followed by a bitwise inclusive OR between the read result and the value\r
+ followed by a bitwise OR between the read result and the value\r
specified by AndData, and writes the result to the 8-bit MMIO register\r
specified by Address. The value written to the MMIO register is returned.\r
This function must guarantee that all MMIO read and write operations are\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
and write 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 write.\r
@param Value The value to write to the MMIO register.\r
+ \r
+ @return Value.\r
\r
**/\r
UINT16\r
);\r
\r
/**\r
- Reads a 16-bit MMIO register, performs a bitwise inclusive OR, and writes the\r
+ Reads a 16-bit MMIO register, performs a bitwise OR, and writes the\r
result back to the 16-bit MMIO register.\r
\r
- Reads the 16-bit MMIO register specified by Address, performs a bitwise\r
- inclusive OR between the read result and the value specified by OrData, and\r
+ Reads the 16-bit MMIO register specified by Address, performs a bitwise \r
+ OR between the read result and the value specified by OrData, and\r
writes the result to the 16-bit MMIO register specified by Address. The value\r
written to the MMIO register is returned. This function must guarantee that\r
all MMIO read and write 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 write.\r
@param OrData The value to OR with the read value from the MMIO register.\r
read and write 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 write.\r
@param AndData The value to AND with the read value from the MMIO register.\r
);\r
\r
/**\r
- Reads a 16-bit MMIO register, performs a bitwise AND followed by a bitwise\r
- inclusive OR, and writes the result back to the 16-bit MMIO register.\r
+ Reads a 16-bit MMIO register, performs a bitwise AND followed by a bitwise \r
+ OR, and writes the result back to the 16-bit MMIO register.\r
\r
Reads the 16-bit MMIO register specified by Address, performs a bitwise AND\r
between the read result and the value specified by AndData, performs a\r
must guarantee that all MMIO read and write operations are serialized.\r
\r
If 16-bit MMIO register operations are not supported, then ASSERT().\r
-\r
+ If Address is not aligned on a 16-bit boundary, then ASSERT().\r
\r
@param Address The MMIO register to write.\r
@param AndData The value to AND with the read value from the MMIO register.\r
the StartBit and the EndBit. The value of the bit field is returned.\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
If StartBit is greater than 15, then ASSERT().\r
If EndBit is greater than 15, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
MMIO register are preserved. The new value of the 16-bit register is returned.\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
If StartBit is greater than 15, then ASSERT().\r
If EndBit is greater than 15, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
Reads a bit field in a 16-bit MMIO register, performs a bitwise OR, and\r
writes the result back to the bit field in the 16-bit MMIO register.\r
\r
- Reads the 16-bit MMIO register specified by Address, performs a bitwise\r
- inclusive OR between the read result and the value specified by OrData, and\r
+ Reads the 16-bit MMIO register specified by Address, performs a bitwise \r
+ OR between the read result and the value specified by OrData, and\r
writes the result to the 16-bit MMIO register specified by Address. The value\r
written to the MMIO register is returned. This function must guarantee that\r
all MMIO read and write operations are serialized. Extra left bits in OrData\r
are stripped.\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
If StartBit is greater than 15, then ASSERT().\r
If EndBit is greater than 15, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
stripped.\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
If StartBit is greater than 15, then ASSERT().\r
If EndBit is greater than 15, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
\r
/**\r
Reads a bit field in a 16-bit MMIO register, performs a bitwise AND followed\r
- by a bitwise inclusive OR, and writes the result back to the bit field in the\r
+ by a bitwise OR, and writes the result back to the bit field in the\r
16-bit MMIO register.\r
\r
Reads the 16-bit MMIO register specified by Address, performs a bitwise AND\r
- followed by a bitwise inclusive OR between the read result and the value\r
+ followed by a bitwise OR between the read result and the value\r
specified by AndData, and writes the result to the 16-bit MMIO register\r
specified by Address. The value written to the MMIO register is returned.\r
This function must guarantee that all MMIO read and write operations are\r
serialized. Extra left bits in both AndData and OrData are stripped.\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
If StartBit is greater than 15, then ASSERT().\r
If EndBit is greater than 15, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\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
and write 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 write.\r
@param Value The value to write to the MMIO register.\r
+ \r
+ @return Value.\r
\r
**/\r
UINT32\r
);\r
\r
/**\r
- Reads a 32-bit MMIO register, performs a bitwise inclusive OR, and writes the\r
+ Reads a 32-bit MMIO register, performs a bitwise OR, and writes the\r
result back to the 32-bit MMIO register.\r
\r
- Reads the 32-bit MMIO register specified by Address, performs a bitwise\r
- inclusive OR between the read result and the value specified by OrData, and\r
+ Reads the 32-bit MMIO register specified by Address, performs a bitwise \r
+ OR between the read result and the value specified by OrData, and\r
writes the result to the 32-bit MMIO register specified by Address. The value\r
written to the MMIO register is returned. This function must guarantee that\r
all MMIO read and write 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 write.\r
@param OrData The value to OR with the read value from the MMIO register.\r
read and write 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 write.\r
@param AndData The value to AND with the read value from the MMIO register.\r
);\r
\r
/**\r
- Reads a 32-bit MMIO register, performs a bitwise AND followed by a bitwise\r
- inclusive OR, and writes the result back to the 32-bit MMIO register.\r
+ Reads a 32-bit MMIO register, performs a bitwise AND followed by a bitwise \r
+ OR, and writes the result back to the 32-bit MMIO register.\r
\r
Reads the 32-bit MMIO register specified by Address, performs a bitwise AND\r
between the read result and the value specified by AndData, performs a\r
must guarantee that all MMIO read and write operations are serialized.\r
\r
If 32-bit MMIO register operations are not supported, then ASSERT().\r
-\r
+ If Address is not aligned on a 32-bit boundary, then ASSERT().\r
\r
@param Address The MMIO register to write.\r
@param AndData The value to AND with the read value from the MMIO register.\r
the StartBit and the EndBit. The value of the bit field is returned.\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
If StartBit is greater than 31, then ASSERT().\r
If EndBit is greater than 31, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
MMIO register are preserved. The new value of the 32-bit register is returned.\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
If StartBit is greater than 31, then ASSERT().\r
If EndBit is greater than 31, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
Reads a bit field in a 32-bit MMIO register, performs a bitwise OR, and\r
writes the result back to the bit field in the 32-bit MMIO register.\r
\r
- Reads the 32-bit MMIO register specified by Address, performs a bitwise\r
- inclusive OR between the read result and the value specified by OrData, and\r
+ Reads the 32-bit MMIO register specified by Address, performs a bitwise \r
+ OR between the read result and the value specified by OrData, and\r
writes the result to the 32-bit MMIO register specified by Address. The value\r
written to the MMIO register is returned. This function must guarantee that\r
all MMIO read and write operations are serialized. Extra left bits in OrData\r
are stripped.\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
If StartBit is greater than 31, then ASSERT().\r
If EndBit is greater than 31, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
stripped.\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
If StartBit is greater than 31, then ASSERT().\r
If EndBit is greater than 31, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
\r
/**\r
Reads a bit field in a 32-bit MMIO register, performs a bitwise AND followed\r
- by a bitwise inclusive OR, and writes the result back to the bit field in the\r
+ by a bitwise OR, and writes the result back to the bit field in the\r
32-bit MMIO register.\r
\r
Reads the 32-bit MMIO register specified by Address, performs a bitwise AND\r
- followed by a bitwise inclusive OR between the read result and the value\r
+ followed by a bitwise OR between the read result and the value\r
specified by AndData, and writes the result to the 32-bit MMIO register\r
specified by Address. The value written to the MMIO register is returned.\r
This function must guarantee that all MMIO read and write operations are\r
serialized. Extra left bits in both AndData and OrData are stripped.\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
If StartBit is greater than 31, then ASSERT().\r
If EndBit is greater than 31, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\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
and write 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 write.\r
@param Value The value to write to the MMIO register.\r
);\r
\r
/**\r
- Reads a 64-bit MMIO register, performs a bitwise inclusive OR, and writes the\r
+ Reads a 64-bit MMIO register, performs a bitwise OR, and writes the\r
result back to the 64-bit MMIO register.\r
\r
- Reads the 64-bit MMIO register specified by Address, performs a bitwise\r
- inclusive OR between the read result and the value specified by OrData, and\r
+ Reads the 64-bit MMIO register specified by Address, performs a bitwise \r
+ OR between the read result and the value specified by OrData, and\r
writes the result to the 64-bit MMIO register specified by Address. The value\r
written to the MMIO register is returned. This function must guarantee that\r
all MMIO read and write 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 write.\r
@param OrData The value to OR with the read value from the MMIO register.\r
read and write 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 write.\r
@param AndData The value to AND with the read value from the MMIO register.\r
);\r
\r
/**\r
- Reads a 64-bit MMIO register, performs a bitwise AND followed by a bitwise\r
- inclusive OR, and writes the result back to the 64-bit MMIO register.\r
+ Reads a 64-bit MMIO register, performs a bitwise AND followed by a bitwise \r
+ OR, and writes the result back to the 64-bit MMIO register.\r
\r
Reads the 64-bit MMIO register specified by Address, performs a bitwise AND\r
between the read result and the value specified by AndData, performs a\r
must guarantee that all MMIO read and write operations are serialized.\r
\r
If 64-bit MMIO register operations are not supported, then ASSERT().\r
-\r
+ If Address is not aligned on a 64-bit boundary, then ASSERT().\r
\r
@param Address The MMIO register to write.\r
@param AndData The value to AND with the read value from the MMIO register.\r
the StartBit and the EndBit. The value of the bit field is returned.\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
If StartBit is greater than 63, then ASSERT().\r
If EndBit is greater than 63, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
MMIO register are preserved. The new value of the 64-bit register is returned.\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
If StartBit is greater than 63, then ASSERT().\r
If EndBit is greater than 63, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
Reads a bit field in a 64-bit MMIO register, performs a bitwise OR, and\r
writes the result back to the bit field in the 64-bit MMIO register.\r
\r
- Reads the 64-bit MMIO register specified by Address, performs a bitwise\r
- inclusive OR between the read result and the value specified by OrData, and\r
+ Reads the 64-bit MMIO register specified by Address, performs a bitwise \r
+ OR between the read result and the value specified by OrData, and\r
writes the result to the 64-bit MMIO register specified by Address. The value\r
written to the MMIO register is returned. This function must guarantee that\r
all MMIO read and write operations are serialized. Extra left bits in OrData\r
are stripped.\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
If StartBit is greater than 63, then ASSERT().\r
If EndBit is greater than 63, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
stripped.\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
If StartBit is greater than 63, then ASSERT().\r
If EndBit is greater than 63, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
\r
/**\r
Reads a bit field in a 64-bit MMIO register, performs a bitwise AND followed\r
- by a bitwise inclusive OR, and writes the result back to the bit field in the\r
+ by a bitwise OR, and writes the result back to the bit field in the\r
64-bit MMIO register.\r
\r
Reads the 64-bit MMIO register specified by Address, performs a bitwise AND\r
- followed by a bitwise inclusive OR between the read result and the value\r
+ followed by a bitwise OR between the read result and the value\r
specified by AndData, and writes the result to the 64-bit MMIO register\r
specified by Address. The value written to the MMIO register is returned.\r
This function must guarantee that all MMIO read and write operations are\r
serialized. Extra left bits in both AndData and OrData are stripped.\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
If StartBit is greater than 63, then ASSERT().\r
If EndBit is greater than 63, then ASSERT().\r
If EndBit is less than StartBit, then ASSERT().\r
\r
\r
@param StartAddress Starting address for the MMIO region to be copied from.\r
- @param Length Size in bytes of the copy.\r
+ @param Length The size, in bytes, of Buffer.\r
@param Buffer Pointer to a system memory buffer receiving the data read.\r
\r
@return Buffer\r
If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
\r
@param StartAddress Starting address for the MMIO region to be copied from.\r
- @param Length Size in bytes of the copy.\r
+ @param Length The size, in bytes, of Buffer.\r
@param Buffer Pointer to a system memory buffer receiving the data read.\r
\r
@return Buffer\r
If Buffer is not aligned on a 32-bit boundary, then ASSERT().\r
\r
@param StartAddress Starting address for the MMIO region to be copied from.\r
- @param Length Size in bytes of the copy.\r
+ @param Length The size, in bytes, of Buffer.\r
@param Buffer Pointer to a system memory buffer receiving the data read.\r
\r
@return Buffer\r
If Buffer is not aligned on a 64-bit boundary, then ASSERT().\r
\r
@param StartAddress Starting address for the MMIO region to be copied from.\r
- @param Length Size in bytes of the copy.\r
+ @param Length The size, in bytes, of Buffer.\r
@param Buffer Pointer to a system memory buffer receiving the data read.\r
\r
@return Buffer\r
\r
\r
@param StartAddress Starting address for the MMIO region to be copied to.\r
- @param Length Size in bytes of the copy.\r
+ @param Length The size, in bytes, of Buffer.\r
@param Buffer Pointer to a system memory buffer containing the data to write.\r
\r
@return Size in bytes of the copy.\r
If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
\r
@param StartAddress Starting address for the MMIO region to be copied to.\r
- @param Length Size in bytes of the copy.\r
+ @param Length The size, in bytes, of Buffer.\r
@param Buffer Pointer to a system memory buffer containing the data to write.\r
\r
@return Size in bytes of the copy.\r
If Buffer is not aligned on a 32-bit boundary, then ASSERT().\r
\r
@param StartAddress Starting address for the MMIO region to be copied to.\r
- @param Length Size in bytes of the copy.\r
+ @param Length The size, in bytes, of Buffer.\r
@param Buffer Pointer to a system memory buffer containing the data to write.\r
\r
@return Size in bytes of the copy.\r
If Buffer is not aligned on a 64-bit boundary, then ASSERT().\r
\r
@param StartAddress Starting address for the MMIO region to be copied to.\r
- @param Length Size in bytes of the copy.\r
+ @param Length The size, in bytes, of Buffer.\r
@param Buffer Pointer to a system memory buffer containing the data to write.\r
\r
@return Size in bytes of the copy.\r
projects / mirror_edk2.git / blobdiff