+++ /dev/null
-/** @file\r
- High-level Io/Mmio functions.\r
-\r
- All assertions for bit field operations are handled bit field functions in the\r
- Base Library.\r
-\r
- Copyright (c) 2006, 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
-\r
- Module Name: IoHighLevel.c\r
-\r
- The following IoLib instances share the same version of this file:\r
-\r
- BaseIoLibIntrinsic\r
- DxeIoLibCpuIo\r
- PeiIoLibCpuIo\r
-\r
-**/\r
-\r
-/**\r
- Reads an 8-bit I/O port, performs a bitwise inclusive 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
- 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
- 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 OrData The value to OR with the read value from the I/O port.\r
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT8\r
-EFIAPI\r
-IoOr8 (\r
- IN UINTN Port,\r
- IN UINT8 OrData\r
- )\r
-{\r
- return IoWrite8 (Port, (UINT8) (IoRead8 (Port) | OrData));\r
-}\r
-\r
-/**\r
- Reads an 8-bit I/O port, performs a bitwise AND, and writes the result back\r
- 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, and writes the result to\r
- the 8-bit I/O port specified by Port. The value written to the I/O port is\r
- returned. This function must guarantee that all I/O read and write operations\r
- 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 AndData The value to AND with the read value from the I/O port.\r
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT8\r
-EFIAPI\r
-IoAnd8 (\r
- IN UINTN Port,\r
- IN UINT8 AndData\r
- )\r
-{\r
- return IoWrite8 (Port, (UINT8) (IoRead8 (Port) & AndData));\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
-\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
- between the result of the AND operation and the value specified by OrData,\r
- and writes the result to the 8-bit I/O port specified by Port. The value\r
- written to the I/O port is returned. This function must guarantee that all\r
- I/O read and write 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 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
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT8\r
-EFIAPI\r
-IoAndThenOr8 (\r
- IN UINTN Port,\r
- IN UINT8 AndData,\r
- IN UINT8 OrData\r
- )\r
-{\r
- return IoWrite8 (Port, (UINT8) ((IoRead8 (Port) & AndData) | OrData));\r
-}\r
-\r
-/**\r
- Reads a bit field of an I/O register.\r
-\r
- Reads the bit field in an 8-bit I/O register. The bit field is specified by\r
- the StartBit and the EndBit. The value of the bit field 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
- If EndBit is greater than 7, then ASSERT().\r
- If EndBit is less than StartBit, then ASSERT().\r
-\r
- @param Port The I/O port to read.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..7.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..7.\r
-\r
- @return The value read.\r
-\r
-**/\r
-UINT8\r
-EFIAPI\r
-IoBitFieldRead8 (\r
- IN UINTN Port,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit\r
- )\r
-{\r
- return BitFieldRead8 (IoRead8 (Port), StartBit, EndBit);\r
-}\r
-\r
-/**\r
- Writes a bit field to an I/O register.\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
-\r
- If 8-bit I/O port operations are not supported, then ASSERT().\r
- If StartBit is greater than 7, then ASSERT().\r
- If EndBit is greater than 7, then ASSERT().\r
- If EndBit is less than StartBit, then ASSERT().\r
-\r
- @param Port The I/O port to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..7.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..7.\r
- @param Value New value of the bit field.\r
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT8\r
-EFIAPI\r
-IoBitFieldWrite8 (\r
- IN UINTN Port,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT8 Value\r
- )\r
-{\r
- return IoWrite8 (\r
- Port,\r
- BitFieldWrite8 (IoRead8 (Port), StartBit, EndBit, Value)\r
- );\r
-}\r
-\r
-/**\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
- 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
- operations are serialized. Extra left bits in OrData are stripped.\r
-\r
- If 8-bit I/O port operations are not supported, then ASSERT().\r
- If StartBit is greater than 7, then ASSERT().\r
- If EndBit is greater than 7, then ASSERT().\r
- If EndBit is less than StartBit, then ASSERT().\r
-\r
- @param Port The I/O port to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..7.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..7.\r
- @param OrData The value to OR with the read value from the I/O port.\r
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT8\r
-EFIAPI\r
-IoBitFieldOr8 (\r
- IN UINTN Port,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT8 OrData\r
- )\r
-{\r
- return IoWrite8 (\r
- Port,\r
- BitFieldOr8 (IoRead8 (Port), StartBit, EndBit, OrData)\r
- );\r
-}\r
-\r
-/**\r
- Reads a bit field in an 8-bit port, performs a bitwise AND, 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 AND between\r
- the read result and the value specified by AndData, and writes the result to\r
- the 8-bit I/O port specified by Port. The value written to the I/O port is\r
- returned. This function must guarantee that all I/O read and write operations\r
- are serialized. Extra left bits in AndData are stripped.\r
-\r
- If 8-bit I/O port operations are not supported, then ASSERT().\r
- If StartBit is greater than 7, then ASSERT().\r
- If EndBit is greater than 7, then ASSERT().\r
- If EndBit is less than StartBit, then ASSERT().\r
-\r
- @param Port The I/O port to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..7.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..7.\r
- @param AndData The value to AND with the read value from the I/O port.\r
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT8\r
-EFIAPI\r
-IoBitFieldAnd8 (\r
- IN UINTN Port,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT8 AndData\r
- )\r
-{\r
- return IoWrite8 (\r
- Port,\r
- BitFieldAnd8 (IoRead8 (Port), StartBit, EndBit, AndData)\r
- );\r
-}\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
- 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
- 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
- AndData and OrData are stripped.\r
-\r
- If 8-bit I/O port operations are not supported, then ASSERT().\r
- If StartBit is greater than 7, then ASSERT().\r
- If EndBit is greater than 7, then ASSERT().\r
- If EndBit is less than StartBit, then ASSERT().\r
-\r
- @param Port The I/O port to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..7.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..7.\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
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT8\r
-EFIAPI\r
-IoBitFieldAndThenOr8 (\r
- IN UINTN Port,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT8 AndData,\r
- IN UINT8 OrData\r
- )\r
-{\r
- return IoWrite8 (\r
- Port,\r
- BitFieldAndThenOr8 (IoRead8 (Port), StartBit, EndBit, AndData, OrData)\r
- );\r
-}\r
-\r
-/**\r
- Reads a 16-bit I/O port, performs a bitwise inclusive 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
- 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
-\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
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT16\r
-EFIAPI\r
-IoOr16 (\r
- IN UINTN Port,\r
- IN UINT16 OrData\r
- )\r
-{\r
- return IoWrite16 (Port, (UINT16) (IoRead16 (Port) | OrData));\r
-}\r
-\r
-/**\r
- Reads a 16-bit I/O port, performs a bitwise AND, and writes the result back\r
- 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, and writes the result to\r
- the 16-bit I/O port specified by Port. The value written to the I/O port is\r
- returned. This function must guarantee that all I/O read and write operations\r
- are 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 AndData The value to AND with the read value from the I/O port.\r
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT16\r
-EFIAPI\r
-IoAnd16 (\r
- IN UINTN Port,\r
- IN UINT16 AndData\r
- )\r
-{\r
- return IoWrite16 (Port, (UINT16) (IoRead16 (Port) & AndData));\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
-\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
- between the result of the AND operation and the value specified by OrData,\r
- and writes the result to the 16-bit I/O port specified by Port. The value\r
- written to the I/O port is returned. This function must guarantee that all\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
- @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
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT16\r
-EFIAPI\r
-IoAndThenOr16 (\r
- IN UINTN Port,\r
- IN UINT16 AndData,\r
- IN UINT16 OrData\r
- )\r
-{\r
- return IoWrite16 (Port, (UINT16) ((IoRead16 (Port) & AndData) | OrData));\r
-}\r
-\r
-/**\r
- Reads a bit field of an I/O register.\r
-\r
- Reads the bit field in a 16-bit I/O register. The bit field is specified by\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 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
- @param Port The I/O port to read.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..15.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..15.\r
-\r
- @return The value read.\r
-\r
-**/\r
-UINT16\r
-EFIAPI\r
-IoBitFieldRead16 (\r
- IN UINTN Port,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit\r
- )\r
-{\r
- return BitFieldRead16 (IoRead16 (Port), StartBit, EndBit);\r
-}\r
-\r
-/**\r
- Writes a bit field to an I/O register.\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
-\r
- If 16-bit I/O port operations are not supported, 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
- @param Port The I/O port to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..15.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..15.\r
- @param Value New value of the bit field.\r
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT16\r
-EFIAPI\r
-IoBitFieldWrite16 (\r
- IN UINTN Port,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT16 Value\r
- )\r
-{\r
- return IoWrite16 (\r
- Port,\r
- BitFieldWrite16 (IoRead16 (Port), StartBit, EndBit, Value)\r
- );\r
-}\r
-\r
-/**\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
- 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 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
- @param Port The I/O port to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..15.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..15.\r
- @param OrData The value to OR with the read value from the I/O port.\r
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT16\r
-EFIAPI\r
-IoBitFieldOr16 (\r
- IN UINTN Port,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT16 OrData\r
- )\r
-{\r
- return IoWrite16 (\r
- Port,\r
- BitFieldOr16 (IoRead16 (Port), StartBit, EndBit, OrData)\r
- );\r
-}\r
-\r
-/**\r
- Reads a bit field in a 16-bit port, performs a bitwise AND, 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 AND between\r
- the read result and the value specified by AndData, and writes the result to\r
- the 16-bit I/O port specified by Port. The value written to the I/O port is\r
- returned. This function must guarantee that all I/O read and write operations\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 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
- @param Port The I/O port to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..15.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..15.\r
- @param AndData The value to AND with the read value from the I/O port.\r
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT16\r
-EFIAPI\r
-IoBitFieldAnd16 (\r
- IN UINTN Port,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT16 AndData\r
- )\r
-{\r
- return IoWrite16 (\r
- Port,\r
- BitFieldAnd16 (IoRead16 (Port), StartBit, EndBit, AndData)\r
- );\r
-}\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
- 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
- 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 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
- @param Port The I/O port to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..15.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..15.\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
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT16\r
-EFIAPI\r
-IoBitFieldAndThenOr16 (\r
- IN UINTN Port,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT16 AndData,\r
- IN UINT16 OrData\r
- )\r
-{\r
- return IoWrite16 (\r
- Port,\r
- BitFieldAndThenOr16 (IoRead16 (Port), StartBit, EndBit, AndData, OrData)\r
- );\r
-}\r
-\r
-/**\r
- Reads a 32-bit I/O port, performs a bitwise inclusive 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
- 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
-\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
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT32\r
-EFIAPI\r
-IoOr32 (\r
- IN UINTN Port,\r
- IN UINT32 OrData\r
- )\r
-{\r
- return IoWrite32 (Port, IoRead32 (Port) | OrData);\r
-}\r
-\r
-/**\r
- Reads a 32-bit I/O port, performs a bitwise AND, and writes the result back\r
- 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, and writes the result to\r
- the 32-bit I/O port specified by Port. The value written to the I/O port is\r
- returned. This function must guarantee that all I/O read and write operations\r
- are 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 AndData The value to AND with the read value from the I/O port.\r
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT32\r
-EFIAPI\r
-IoAnd32 (\r
- IN UINTN Port,\r
- IN UINT32 AndData\r
- )\r
-{\r
- return IoWrite32 (Port, IoRead32 (Port) & AndData);\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
-\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
- between the result of the AND operation and the value specified by OrData,\r
- and writes the result to the 32-bit I/O port specified by Port. The value\r
- written to the I/O port is returned. This function must guarantee that all\r
- I/O read and write operations are 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 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
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT32\r
-EFIAPI\r
-IoAndThenOr32 (\r
- IN UINTN Port,\r
- IN UINT32 AndData,\r
- IN UINT32 OrData\r
- )\r
-{\r
- return IoWrite32 (Port, (IoRead32 (Port) & AndData) | OrData);\r
-}\r
-\r
-/**\r
- Reads a bit field of an I/O register.\r
-\r
- Reads the bit field in a 32-bit I/O register. The bit field is specified by\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 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
- @param Port The I/O port to read.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..31.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..31.\r
-\r
- @return The value read.\r
-\r
-**/\r
-UINT32\r
-EFIAPI\r
-IoBitFieldRead32 (\r
- IN UINTN Port,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit\r
- )\r
-{\r
- return BitFieldRead32 (IoRead32 (Port), StartBit, EndBit);\r
-}\r
-\r
-/**\r
- Writes a bit field to an I/O register.\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
-\r
- If 32-bit I/O port operations are not supported, 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
- @param Port The I/O port to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..31.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..31.\r
- @param Value New value of the bit field.\r
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT32\r
-EFIAPI\r
-IoBitFieldWrite32 (\r
- IN UINTN Port,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT32 Value\r
- )\r
-{\r
- return IoWrite32 (\r
- Port,\r
- BitFieldWrite32 (IoRead32 (Port), StartBit, EndBit, Value)\r
- );\r
-}\r
-\r
-/**\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
- 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 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
- @param Port The I/O port to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..31.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..31.\r
- @param OrData The value to OR with the read value from the I/O port.\r
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT32\r
-EFIAPI\r
-IoBitFieldOr32 (\r
- IN UINTN Port,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT32 OrData\r
- )\r
-{\r
- return IoWrite32 (\r
- Port,\r
- BitFieldOr32 (IoRead32 (Port), StartBit, EndBit, OrData)\r
- );\r
-}\r
-\r
-/**\r
- Reads a bit field in a 32-bit port, performs a bitwise AND, 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 AND between\r
- the read result and the value specified by AndData, and writes the result to\r
- the 32-bit I/O port specified by Port. The value written to the I/O port is\r
- returned. This function must guarantee that all I/O read and write operations\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 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
- @param Port The I/O port to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..31.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..31.\r
- @param AndData The value to AND with the read value from the I/O port.\r
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT32\r
-EFIAPI\r
-IoBitFieldAnd32 (\r
- IN UINTN Port,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT32 AndData\r
- )\r
-{\r
- return IoWrite32 (\r
- Port,\r
- BitFieldAnd32 (IoRead32 (Port), StartBit, EndBit, AndData)\r
- );\r
-}\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
- 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
- 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 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
- @param Port The I/O port to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..31.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..31.\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
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT32\r
-EFIAPI\r
-IoBitFieldAndThenOr32 (\r
- IN UINTN Port,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT32 AndData,\r
- IN UINT32 OrData\r
- )\r
-{\r
- return IoWrite32 (\r
- Port,\r
- BitFieldAndThenOr32 (IoRead32 (Port), StartBit, EndBit, AndData, OrData)\r
- );\r
-}\r
-\r
-/**\r
- Reads a 64-bit I/O port, performs a bitwise inclusive 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
- 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
-\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
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT64\r
-EFIAPI\r
-IoOr64 (\r
- IN UINTN Port,\r
- IN UINT64 OrData\r
- )\r
-{\r
- return IoWrite64 (Port, IoRead64 (Port) | OrData);\r
-}\r
-\r
-/**\r
- Reads a 64-bit I/O port, performs a bitwise AND, and writes the result back\r
- 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, and writes the result to\r
- the 64-bit I/O port specified by Port. The value written to the I/O port is\r
- returned. This function must guarantee that all I/O read and write operations\r
- are serialized.\r
-\r
- If 64-bit I/O port operations are not supported, 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
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT64\r
-EFIAPI\r
-IoAnd64 (\r
- IN UINTN Port,\r
- IN UINT64 AndData\r
- )\r
-{\r
- return IoWrite64 (Port, IoRead64 (Port) & AndData);\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
-\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
- between the result of the AND operation and the value specified by OrData,\r
- and writes the result to the 64-bit I/O port specified by Port. The value\r
- written to the I/O port is returned. This function must guarantee that all\r
- I/O read and write operations are serialized.\r
-\r
- If 64-bit I/O port operations are not supported, 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
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT64\r
-EFIAPI\r
-IoAndThenOr64 (\r
- IN UINTN Port,\r
- IN UINT64 AndData,\r
- IN UINT64 OrData\r
- )\r
-{\r
- return IoWrite64 (Port, (IoRead64 (Port) & AndData) | OrData);\r
-}\r
-\r
-/**\r
- Reads a bit field of an I/O register.\r
-\r
- Reads the bit field in a 64-bit I/O register. The bit field is specified by\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 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 Port The I/O port to read.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..63.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..63.\r
-\r
- @return The value read.\r
-\r
-**/\r
-UINT64\r
-EFIAPI\r
-IoBitFieldRead64 (\r
- IN UINTN Port,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit\r
- )\r
-{\r
- return BitFieldRead64 (IoRead64 (Port), StartBit, EndBit);\r
-}\r
-\r
-/**\r
- Writes a bit field to an I/O register.\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
-\r
- If 64-bit I/O port operations are not supported, 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 Port The I/O port to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..63.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..63.\r
- @param Value New value of the bit field.\r
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT64\r
-EFIAPI\r
-IoBitFieldWrite64 (\r
- IN UINTN Port,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT64 Value\r
- )\r
-{\r
- return IoWrite64 (\r
- Port,\r
- BitFieldWrite64 (IoRead64 (Port), StartBit, EndBit, Value)\r
- );\r
-}\r
-\r
-/**\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
- 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 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 Port The I/O port to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..63.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..63.\r
- @param OrData The value to OR with the read value from the I/O port.\r
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT64\r
-EFIAPI\r
-IoBitFieldOr64 (\r
- IN UINTN Port,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT64 OrData\r
- )\r
-{\r
- return IoWrite64 (\r
- Port,\r
- BitFieldOr64 (IoRead64 (Port), StartBit, EndBit, OrData)\r
- );\r
-}\r
-\r
-/**\r
- Reads a bit field in a 64-bit port, performs a bitwise AND, 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 AND between\r
- the read result and the value specified by AndData, and writes the result to\r
- the 64-bit I/O port specified by Port. The value written to the I/O port is\r
- returned. This function must guarantee that all I/O read and write operations\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 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 Port The I/O port to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..63.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..63.\r
- @param AndData The value to AND with the read value from the I/O port.\r
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT64\r
-EFIAPI\r
-IoBitFieldAnd64 (\r
- IN UINTN Port,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT64 AndData\r
- )\r
-{\r
- return IoWrite64 (\r
- Port,\r
- BitFieldAnd64 (IoRead64 (Port), StartBit, EndBit, AndData)\r
- );\r
-}\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
- 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
- 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 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 Port The I/O port to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..63.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..63.\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
-\r
- @return The value written back to the I/O port.\r
-\r
-**/\r
-UINT64\r
-EFIAPI\r
-IoBitFieldAndThenOr64 (\r
- IN UINTN Port,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT64 AndData,\r
- IN UINT64 OrData\r
- )\r
-{\r
- return IoWrite64 (\r
- Port,\r
- BitFieldAndThenOr64 (IoRead64 (Port), StartBit, EndBit, AndData, OrData)\r
- );\r
-}\r
-\r
-/**\r
- Reads an 8-bit MMIO register, performs a bitwise inclusive 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
- 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
- If 8-bit MMIO register operations are not supported, 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
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT8\r
-EFIAPI\r
-MmioOr8 (\r
- IN UINTN Address,\r
- IN UINT8 OrData\r
- )\r
-{\r
- return MmioWrite8 (Address, (UINT8) (MmioRead8 (Address) | OrData));\r
-}\r
-\r
-/**\r
- Reads an 8-bit MMIO register, performs a bitwise AND, and writes the result\r
- 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, and writes the\r
- result to the 8-bit MMIO register specified by Address. The value written to\r
- the MMIO register is returned. This function must guarantee that all MMIO\r
- read and write operations are serialized.\r
-\r
- If 8-bit MMIO register operations are not supported, 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
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT8\r
-EFIAPI\r
-MmioAnd8 (\r
- IN UINTN Address,\r
- IN UINT8 AndData\r
- )\r
-{\r
- return MmioWrite8 (Address, (UINT8) (MmioRead8 (Address) & AndData));\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
-\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
- bitwise OR between the result of the AND operation and the value specified by\r
- OrData, and writes the result to the 8-bit MMIO register specified by\r
- Address. The value written to the MMIO register is returned. This function\r
- must guarantee that all MMIO read and write operations are serialized.\r
-\r
- If 8-bit MMIO register operations are not supported, then ASSERT().\r
-\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
- @param OrData The value to OR with the result of the AND operation.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT8\r
-EFIAPI\r
-MmioAndThenOr8 (\r
- IN UINTN Address,\r
- IN UINT8 AndData,\r
- IN UINT8 OrData\r
- )\r
-{\r
- return MmioWrite8 (Address, (UINT8) ((MmioRead8 (Address) & AndData) | OrData));\r
-}\r
-\r
-/**\r
- Reads a bit field of a MMIO register.\r
-\r
- Reads the bit field in an 8-bit MMIO register. The bit field is specified by\r
- the StartBit and the EndBit. The value of the bit field is returned.\r
-\r
- If 8-bit MMIO register operations are not supported, then ASSERT().\r
- If StartBit is greater than 7, then ASSERT().\r
- If EndBit is greater than 7, then ASSERT().\r
- If EndBit is less than StartBit, then ASSERT().\r
-\r
- @param Address MMIO register to read.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..7.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..7.\r
-\r
- @return The value read.\r
-\r
-**/\r
-UINT8\r
-EFIAPI\r
-MmioBitFieldRead8 (\r
- IN UINTN Address,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit\r
- )\r
-{\r
- return BitFieldRead8 (MmioRead8 (Address), StartBit, EndBit);\r
-}\r
-\r
-/**\r
- Writes a bit field to a MMIO register.\r
-\r
- Writes Value to the bit field of the MMIO register. The bit field is\r
- specified by the StartBit and the EndBit. All other bits in the destination\r
- MMIO register are preserved. The new value of the 8-bit register is returned.\r
-\r
- If 8-bit MMIO register operations are not supported, then ASSERT().\r
- If StartBit is greater than 7, then ASSERT().\r
- If EndBit is greater than 7, then ASSERT().\r
- If EndBit is less than StartBit, then ASSERT().\r
-\r
- @param Address MMIO register to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..7.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..7.\r
- @param Value New value of the bit field.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT8\r
-EFIAPI\r
-MmioBitFieldWrite8 (\r
- IN UINTN Address,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT8 Value\r
- )\r
-{\r
- return MmioWrite8 (\r
- Address,\r
- BitFieldWrite8 (MmioRead8 (Address), StartBit, EndBit, Value)\r
- );\r
-}\r
-\r
-/**\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
- 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
- are stripped.\r
-\r
- If 8-bit MMIO register operations are not supported, then ASSERT().\r
- If StartBit is greater than 7, then ASSERT().\r
- If EndBit is greater than 7, then ASSERT().\r
- If EndBit is less than StartBit, then ASSERT().\r
-\r
- @param Address MMIO register to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..7.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..7.\r
- @param OrData The value to OR with read value from the MMIO register.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT8\r
-EFIAPI\r
-MmioBitFieldOr8 (\r
- IN UINTN Address,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT8 OrData\r
- )\r
-{\r
- return MmioWrite8 (\r
- Address,\r
- BitFieldOr8 (MmioRead8 (Address), StartBit, EndBit, OrData)\r
- );\r
-}\r
-\r
-/**\r
- Reads a bit field in an 8-bit MMIO register, performs a bitwise AND, 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 AND\r
- between the read result and the value specified by AndData, and writes the\r
- result to the 8-bit MMIO register specified by Address. The value written to\r
- the MMIO register is returned. This function must guarantee that all MMIO\r
- read and write operations are serialized. Extra left bits in AndData are\r
- stripped.\r
-\r
- If 8-bit MMIO register operations are not supported, then ASSERT().\r
- If StartBit is greater than 7, then ASSERT().\r
- If EndBit is greater than 7, then ASSERT().\r
- If EndBit is less than StartBit, then ASSERT().\r
-\r
- @param Address MMIO register to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..7.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..7.\r
- @param AndData The value to AND with read value from the MMIO register.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT8\r
-EFIAPI\r
-MmioBitFieldAnd8 (\r
- IN UINTN Address,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT8 AndData\r
- )\r
-{\r
- return MmioWrite8 (\r
- Address,\r
- BitFieldAnd8 (MmioRead8 (Address), StartBit, EndBit, AndData)\r
- );\r
-}\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
- 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
- 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
- serialized. Extra left bits in both AndData and OrData are stripped.\r
-\r
- If 8-bit MMIO register operations are not supported, then ASSERT().\r
- If StartBit is greater than 7, then ASSERT().\r
- If EndBit is greater than 7, then ASSERT().\r
- If EndBit is less than StartBit, then ASSERT().\r
-\r
- @param Address MMIO register to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..7.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..7.\r
- @param AndData The value to AND with read value from the MMIO register.\r
- @param OrData The value to OR with the result of the AND operation.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT8\r
-EFIAPI\r
-MmioBitFieldAndThenOr8 (\r
- IN UINTN Address,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT8 AndData,\r
- IN UINT8 OrData\r
- )\r
-{\r
- return MmioWrite8 (\r
- Address,\r
- BitFieldAndThenOr8 (MmioRead8 (Address), StartBit, EndBit, AndData, OrData)\r
- );\r
-}\r
-\r
-/**\r
- Reads a 16-bit MMIO register, performs a bitwise inclusive 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
- 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
-\r
- @param Address The MMIO register to write.\r
- @param OrData The value to OR with the read value from the MMIO register.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT16\r
-EFIAPI\r
-MmioOr16 (\r
- IN UINTN Address,\r
- IN UINT16 OrData\r
- )\r
-{\r
- return MmioWrite16 (Address, (UINT16) (MmioRead16 (Address) | OrData));\r
-}\r
-\r
-/**\r
- Reads a 16-bit MMIO register, performs a bitwise AND, and writes the result\r
- 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, and writes the\r
- result to the 16-bit MMIO register specified by Address. The value written to\r
- the MMIO register is returned. This function must guarantee that all MMIO\r
- read and write operations are serialized.\r
-\r
- If 16-bit MMIO register operations are not supported, 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
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT16\r
-EFIAPI\r
-MmioAnd16 (\r
- IN UINTN Address,\r
- IN UINT16 AndData\r
- )\r
-{\r
- return MmioWrite16 (Address, (UINT16) (MmioRead16 (Address) & AndData));\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
-\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
- bitwise OR between the result of the AND operation and the value specified by\r
- OrData, and writes the result to the 16-bit MMIO register specified by\r
- Address. The value written to the MMIO register is returned. This function\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
-\r
- @param Address The MMIO register to write.\r
- @param AndData The value to AND with the read value from the MMIO register.\r
- @param OrData The value to OR with the result of the AND operation.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT16\r
-EFIAPI\r
-MmioAndThenOr16 (\r
- IN UINTN Address,\r
- IN UINT16 AndData,\r
- IN UINT16 OrData\r
- )\r
-{\r
- return MmioWrite16 (Address, (UINT16) ((MmioRead16 (Address) & AndData) | OrData));\r
-}\r
-\r
-/**\r
- Reads a bit field of a MMIO register.\r
-\r
- Reads the bit field in a 16-bit MMIO register. The bit field is specified by\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 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
- @param Address MMIO register to read.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..15.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..15.\r
-\r
- @return The value read.\r
-\r
-**/\r
-UINT16\r
-EFIAPI\r
-MmioBitFieldRead16 (\r
- IN UINTN Address,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit\r
- )\r
-{\r
- return BitFieldRead16 (MmioRead16 (Address), StartBit, EndBit);\r
-}\r
-\r
-/**\r
- Writes a bit field to a MMIO register.\r
-\r
- Writes Value to the bit field of the MMIO register. The bit field is\r
- specified by the StartBit and the EndBit. All other bits in the destination\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 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
- @param Address MMIO register to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..15.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..15.\r
- @param Value New value of the bit field.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT16\r
-EFIAPI\r
-MmioBitFieldWrite16 (\r
- IN UINTN Address,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT16 Value\r
- )\r
-{\r
- return MmioWrite16 (\r
- Address,\r
- BitFieldWrite16 (MmioRead16 (Address), StartBit, EndBit, Value)\r
- );\r
-}\r
-\r
-/**\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
- 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 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
- @param Address MMIO register to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..15.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..15.\r
- @param OrData The value to OR with read value from the MMIO register.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT16\r
-EFIAPI\r
-MmioBitFieldOr16 (\r
- IN UINTN Address,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT16 OrData\r
- )\r
-{\r
- return MmioWrite16 (\r
- Address,\r
- BitFieldOr16 (MmioRead16 (Address), StartBit, EndBit, OrData)\r
- );\r
-}\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.\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, and writes the\r
- result to the 16-bit MMIO register specified by Address. The value written to\r
- the MMIO register is returned. This function must guarantee that all MMIO\r
- read and write operations are serialized. Extra left bits in AndData are\r
- stripped.\r
-\r
- If 16-bit MMIO register operations are not supported, 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
- @param Address MMIO register to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..15.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..15.\r
- @param AndData The value to AND with read value from the MMIO register.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT16\r
-EFIAPI\r
-MmioBitFieldAnd16 (\r
- IN UINTN Address,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT16 AndData\r
- )\r
-{\r
- return MmioWrite16 (\r
- Address,\r
- BitFieldAnd16 (MmioRead16 (Address), StartBit, EndBit, AndData)\r
- );\r
-}\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
- 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
- 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 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
- @param Address MMIO register to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..15.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..15.\r
- @param AndData The value to AND with read value from the MMIO register.\r
- @param OrData The value to OR with the result of the AND operation.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT16\r
-EFIAPI\r
-MmioBitFieldAndThenOr16 (\r
- IN UINTN Address,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT16 AndData,\r
- IN UINT16 OrData\r
- )\r
-{\r
- return MmioWrite16 (\r
- Address,\r
- BitFieldAndThenOr16 (MmioRead16 (Address), StartBit, EndBit, AndData, OrData)\r
- );\r
-}\r
-\r
-/**\r
- Reads a 32-bit MMIO register, performs a bitwise inclusive 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
- 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
-\r
- @param Address The MMIO register to write.\r
- @param OrData The value to OR with the read value from the MMIO register.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT32\r
-EFIAPI\r
-MmioOr32 (\r
- IN UINTN Address,\r
- IN UINT32 OrData\r
- )\r
-{\r
- return MmioWrite32 (Address, MmioRead32 (Address) | OrData);\r
-}\r
-\r
-/**\r
- Reads a 32-bit MMIO register, performs a bitwise AND, and writes the result\r
- 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, and writes the\r
- result to the 32-bit MMIO register specified by Address. The value written to\r
- the MMIO register is returned. This function must guarantee that all MMIO\r
- read and write operations are serialized.\r
-\r
- If 32-bit MMIO register operations are not supported, 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
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT32\r
-EFIAPI\r
-MmioAnd32 (\r
- IN UINTN Address,\r
- IN UINT32 AndData\r
- )\r
-{\r
- return MmioWrite32 (Address, MmioRead32 (Address) & AndData);\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
-\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
- bitwise OR between the result of the AND operation and the value specified by\r
- OrData, and writes the result to the 32-bit MMIO register specified by\r
- Address. The value written to the MMIO register is returned. This function\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
-\r
- @param Address The MMIO register to write.\r
- @param AndData The value to AND with the read value from the MMIO register.\r
- @param OrData The value to OR with the result of the AND operation.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT32\r
-EFIAPI\r
-MmioAndThenOr32 (\r
- IN UINTN Address,\r
- IN UINT32 AndData,\r
- IN UINT32 OrData\r
- )\r
-{\r
- return MmioWrite32 (Address, (MmioRead32 (Address) & AndData) | OrData);\r
-}\r
-\r
-/**\r
- Reads a bit field of a MMIO register.\r
-\r
- Reads the bit field in a 32-bit MMIO register. The bit field is specified by\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 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
- @param Address MMIO register to read.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..31.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..31.\r
-\r
- @return The value read.\r
-\r
-**/\r
-UINT32\r
-EFIAPI\r
-MmioBitFieldRead32 (\r
- IN UINTN Address,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit\r
- )\r
-{\r
- return BitFieldRead32 (MmioRead32 (Address), StartBit, EndBit);\r
-}\r
-\r
-/**\r
- Writes a bit field to a MMIO register.\r
-\r
- Writes Value to the bit field of the MMIO register. The bit field is\r
- specified by the StartBit and the EndBit. All other bits in the destination\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 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
- @param Address MMIO register to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..31.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..31.\r
- @param Value New value of the bit field.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT32\r
-EFIAPI\r
-MmioBitFieldWrite32 (\r
- IN UINTN Address,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT32 Value\r
- )\r
-{\r
- return MmioWrite32 (\r
- Address,\r
- BitFieldWrite32 (MmioRead32 (Address), StartBit, EndBit, Value)\r
- );\r
-}\r
-\r
-/**\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
- 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 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
- @param Address MMIO register to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..31.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..31.\r
- @param OrData The value to OR with read value from the MMIO register.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT32\r
-EFIAPI\r
-MmioBitFieldOr32 (\r
- IN UINTN Address,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT32 OrData\r
- )\r
-{\r
- return MmioWrite32 (\r
- Address,\r
- BitFieldOr32 (MmioRead32 (Address), StartBit, EndBit, OrData)\r
- );\r
-}\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.\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, and writes the\r
- result to the 32-bit MMIO register specified by Address. The value written to\r
- the MMIO register is returned. This function must guarantee that all MMIO\r
- read and write operations are serialized. Extra left bits in AndData are\r
- stripped.\r
-\r
- If 32-bit MMIO register operations are not supported, 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
- @param Address MMIO register to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..31.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..31.\r
- @param AndData The value to AND with read value from the MMIO register.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT32\r
-EFIAPI\r
-MmioBitFieldAnd32 (\r
- IN UINTN Address,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT32 AndData\r
- )\r
-{\r
- return MmioWrite32 (\r
- Address,\r
- BitFieldAnd32 (MmioRead32 (Address), StartBit, EndBit, AndData)\r
- );\r
-}\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
- 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
- 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 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
- @param Address MMIO register to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..31.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..31.\r
- @param AndData The value to AND with read value from the MMIO register.\r
- @param OrData The value to OR with the result of the AND operation.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT32\r
-EFIAPI\r
-MmioBitFieldAndThenOr32 (\r
- IN UINTN Address,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT32 AndData,\r
- IN UINT32 OrData\r
- )\r
-{\r
- return MmioWrite32 (\r
- Address,\r
- BitFieldAndThenOr32 (MmioRead32 (Address), StartBit, EndBit, AndData, OrData)\r
- );\r
-}\r
-\r
-/**\r
- Reads a 64-bit MMIO register, performs a bitwise inclusive 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
- 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
-\r
- @param Address The MMIO register to write.\r
- @param OrData The value to OR with the read value from the MMIO register.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT64\r
-EFIAPI\r
-MmioOr64 (\r
- IN UINTN Address,\r
- IN UINT64 OrData\r
- )\r
-{\r
- return MmioWrite64 (Address, MmioRead64 (Address) | OrData);\r
-}\r
-\r
-/**\r
- Reads a 64-bit MMIO register, performs a bitwise AND, and writes the result\r
- 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, and writes the\r
- result to the 64-bit MMIO register specified by Address. The value written to\r
- the MMIO register is returned. This function must guarantee that all MMIO\r
- read and write operations are serialized.\r
-\r
- If 64-bit MMIO register operations are not supported, 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
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT64\r
-EFIAPI\r
-MmioAnd64 (\r
- IN UINTN Address,\r
- IN UINT64 AndData\r
- )\r
-{\r
- return MmioWrite64 (Address, MmioRead64 (Address) & AndData);\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
-\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
- bitwise OR between the result of the AND operation and the value specified by\r
- OrData, and writes the result to the 64-bit MMIO register specified by\r
- Address. The value written to the MMIO register is returned. This function\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
-\r
- @param Address The MMIO register to write.\r
- @param AndData The value to AND with the read value from the MMIO register.\r
- @param OrData The value to OR with the result of the AND operation.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT64\r
-EFIAPI\r
-MmioAndThenOr64 (\r
- IN UINTN Address,\r
- IN UINT64 AndData,\r
- IN UINT64 OrData\r
- )\r
-{\r
- return MmioWrite64 (Address, (MmioRead64 (Address) & AndData) | OrData);\r
-}\r
-\r
-/**\r
- Reads a bit field of a MMIO register.\r
-\r
- Reads the bit field in a 64-bit MMIO register. The bit field is specified by\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 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 MMIO register to read.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..63.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..63.\r
-\r
- @return The value read.\r
-\r
-**/\r
-UINT64\r
-EFIAPI\r
-MmioBitFieldRead64 (\r
- IN UINTN Address,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit\r
- )\r
-{\r
- return BitFieldRead64 (MmioRead64 (Address), StartBit, EndBit);\r
-}\r
-\r
-/**\r
- Writes a bit field to a MMIO register.\r
-\r
- Writes Value to the bit field of the MMIO register. The bit field is\r
- specified by the StartBit and the EndBit. All other bits in the destination\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 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 MMIO register to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..63.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..63.\r
- @param Value New value of the bit field.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT64\r
-EFIAPI\r
-MmioBitFieldWrite64 (\r
- IN UINTN Address,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT64 Value\r
- )\r
-{\r
- return MmioWrite64 (\r
- Address,\r
- BitFieldWrite64 (MmioRead64 (Address), StartBit, EndBit, Value)\r
- );\r
-}\r
-\r
-/**\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
- 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 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 MMIO register to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..63.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..63.\r
- @param OrData The value to OR with read value from the MMIO register.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT64\r
-EFIAPI\r
-MmioBitFieldOr64 (\r
- IN UINTN Address,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT64 OrData\r
- )\r
-{\r
- return MmioWrite64 (\r
- Address,\r
- BitFieldOr64 (MmioRead64 (Address), StartBit, EndBit, OrData)\r
- );\r
-}\r
-\r
-/**\r
- Reads a bit field in a 64-bit MMIO register, performs a bitwise AND, 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 AND\r
- between the read result and the value specified by AndData, and writes the\r
- result to the 64-bit MMIO register specified by Address. The value written to\r
- the MMIO register is returned. This function must guarantee that all MMIO\r
- read and write operations are serialized. Extra left bits in AndData are\r
- stripped.\r
-\r
- If 64-bit MMIO register operations are not supported, 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 MMIO register to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..63.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..63.\r
- @param AndData The value to AND with read value from the MMIO register.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT64\r
-EFIAPI\r
-MmioBitFieldAnd64 (\r
- IN UINTN Address,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT64 AndData\r
- )\r
-{\r
- return MmioWrite64 (\r
- Address,\r
- BitFieldAnd64 (MmioRead64 (Address), StartBit, EndBit, AndData)\r
- );\r
-}\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
- 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
- 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 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 MMIO register to write.\r
- @param StartBit The ordinal of the least significant bit in the bit field.\r
- Range 0..63.\r
- @param EndBit The ordinal of the most significant bit in the bit field.\r
- Range 0..63.\r
- @param AndData The value to AND with read value from the MMIO register.\r
- @param OrData The value to OR with the result of the AND operation.\r
-\r
- @return The value written back to the MMIO register.\r
-\r
-**/\r
-UINT64\r
-EFIAPI\r
-MmioBitFieldAndThenOr64 (\r
- IN UINTN Address,\r
- IN UINTN StartBit,\r
- IN UINTN EndBit,\r
- IN UINT64 AndData,\r
- IN UINT64 OrData\r
- )\r
-{\r
- return MmioWrite64 (\r
- Address,\r
- BitFieldAndThenOr64 (MmioRead64 (Address), StartBit, EndBit, AndData, OrData)\r
- );\r
-}\r