sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Make comments match the Spec.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6876 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
gikidy
2008-12-05 09:50:02 +00:00
parent 3c39934be2
commit 62991af27f
20 changed files with 541 additions and 548 deletions
Download Patch File Download Diff File Expand all files Collapse all files

131
MdePkg/Include/Library/IoLib.h
View File

@@ -76,10 +76,10 @@ IoWrite8 (
);
/**
Reads an 8-bit I/O port, performs a bitwise inclusive OR, and writes the
Reads an 8-bit I/O port, performs a bitwise OR, and writes the
result back to the 8-bit I/O port.
Reads the 8-bit I/O port specified by Port, performs a bitwise inclusive OR
Reads the 8-bit I/O port specified by Port, performs a bitwise OR
between the read result and the value specified by OrData, and writes the
result to the 8-bit I/O port specified by Port. The value written to the I/O
port is returned. This function must guarantee that all I/O read and write
@@ -126,8 +126,8 @@ IoAnd8 (
);
/**
Reads an 8-bit I/O port, performs a bitwise AND followed by a bitwise
inclusive OR, and writes the result back to the 8-bit I/O port.
Reads an 8-bit I/O port, performs a bitwise AND followed by a bitwise
OR, and writes the result back to the 8-bit I/O port.
Reads the 8-bit I/O port specified by Port, performs a bitwise AND between
the read result and the value specified by AndData, performs a bitwise OR
@@ -186,8 +186,7 @@ IoBitFieldRead8 (
Writes Value to the bit field of the I/O register. The bit field is specified
by the StartBit and the EndBit. All other bits in the destination I/O
register are preserved. The value written to the I/O port is returned. Extra
left bits in Value are stripped.
register are preserved. The value written to the I/O port is returned.
If 8-bit I/O port operations are not supported, then ASSERT().
If StartBit is greater than 7, then ASSERT().
@@ -217,7 +216,7 @@ IoBitFieldWrite8 (
Reads a bit field in an 8-bit port, performs a bitwise OR, and writes the
result back to the bit field in the 8-bit port.
Reads the 8-bit I/O port specified by Port, performs a bitwise inclusive OR
Reads the 8-bit I/O port specified by Port, performs a bitwise OR
between the read result and the value specified by OrData, and writes the
result to the 8-bit I/O port specified by Port. The value written to the I/O
port is returned. This function must guarantee that all I/O read and write
@@ -283,11 +282,11 @@ IoBitFieldAnd8 (
/**
Reads a bit field in an 8-bit port, performs a bitwise AND followed by a
bitwise inclusive OR, and writes the result back to the bit field in the
bitwise OR, and writes the result back to the bit field in the
8-bit port.
Reads the 8-bit I/O port specified by Port, performs a bitwise AND followed
by a bitwise inclusive OR between the read result and the value specified by
by a bitwise OR between the read result and the value specified by
AndData, and writes the result to the 8-bit I/O port specified by Port. The
value written to the I/O port is returned. This function must guarantee that
all I/O read and write operations are serialized. Extra left bits in both
@@ -364,10 +363,10 @@ IoWrite16 (
);
/**
Reads a 16-bit I/O port, performs a bitwise inclusive OR, and writes the
Reads a 16-bit I/O port, performs a bitwise OR, and writes the
result back to the 16-bit I/O port.
Reads the 16-bit I/O port specified by Port, performs a bitwise inclusive OR
Reads the 16-bit I/O port specified by Port, performs a bitwise OR
between the read result and the value specified by OrData, and writes the
result to the 16-bit I/O port specified by Port. The value written to the I/O
port is returned. This function must guarantee that all I/O read and write
@@ -416,8 +415,8 @@ IoAnd16 (
);
/**
Reads a 16-bit I/O port, performs a bitwise AND followed by a bitwise
inclusive OR, and writes the result back to the 16-bit I/O port.
Reads a 16-bit I/O port, performs a bitwise AND followed by a bitwise
OR, and writes the result back to the 16-bit I/O port.
Reads the 16-bit I/O port specified by Port, performs a bitwise AND between
the read result and the value specified by AndData, performs a bitwise OR
@@ -510,7 +509,7 @@ IoBitFieldWrite16 (
Reads a bit field in a 16-bit port, performs a bitwise OR, and writes the
result back to the bit field in the 16-bit port.
Reads the 16-bit I/O port specified by Port, performs a bitwise inclusive OR
Reads the 16-bit I/O port specified by Port, performs a bitwise OR
between the read result and the value specified by OrData, and writes the
result to the 16-bit I/O port specified by Port. The value written to the I/O
port is returned. This function must guarantee that all I/O read and write
@@ -578,11 +577,11 @@ IoBitFieldAnd16 (
/**
Reads a bit field in a 16-bit port, performs a bitwise AND followed by a
bitwise inclusive OR, and writes the result back to the bit field in the
bitwise OR, and writes the result back to the bit field in the
16-bit port.
Reads the 16-bit I/O port specified by Port, performs a bitwise AND followed
by a bitwise inclusive OR between the read result and the value specified by
by a bitwise OR between the read result and the value specified by
AndData, and writes the result to the 16-bit I/O port specified by Port. The
value written to the I/O port is returned. This function must guarantee that
all I/O read and write operations are serialized. Extra left bits in both
@@ -660,10 +659,10 @@ IoWrite32 (
);
/**
Reads a 32-bit I/O port, performs a bitwise inclusive OR, and writes the
Reads a 32-bit I/O port, performs a bitwise OR, and writes the
result back to the 32-bit I/O port.
Reads the 32-bit I/O port specified by Port, performs a bitwise inclusive OR
Reads the 32-bit I/O port specified by Port, performs a bitwise OR
between the read result and the value specified by OrData, and writes the
result to the 32-bit I/O port specified by Port. The value written to the I/O
port is returned. This function must guarantee that all I/O read and write
@@ -712,8 +711,8 @@ IoAnd32 (
);
/**
Reads a 32-bit I/O port, performs a bitwise AND followed by a bitwise
inclusive OR, and writes the result back to the 32-bit I/O port.
Reads a 32-bit I/O port, performs a bitwise AND followed by a bitwise
OR, and writes the result back to the 32-bit I/O port.
Reads the 32-bit I/O port specified by Port, performs a bitwise AND between
the read result and the value specified by AndData, performs a bitwise OR
@@ -806,7 +805,7 @@ IoBitFieldWrite32 (
Reads a bit field in a 32-bit port, performs a bitwise OR, and writes the
result back to the bit field in the 32-bit port.
Reads the 32-bit I/O port specified by Port, performs a bitwise inclusive OR
Reads the 32-bit I/O port specified by Port, performs a bitwise OR
between the read result and the value specified by OrData, and writes the
result to the 32-bit I/O port specified by Port. The value written to the I/O
port is returned. This function must guarantee that all I/O read and write
@@ -874,11 +873,11 @@ IoBitFieldAnd32 (
/**
Reads a bit field in a 32-bit port, performs a bitwise AND followed by a
bitwise inclusive OR, and writes the result back to the bit field in the
bitwise OR, and writes the result back to the bit field in the
32-bit port.
Reads the 32-bit I/O port specified by Port, performs a bitwise AND followed
by a bitwise inclusive OR between the read result and the value specified by
by a bitwise OR between the read result and the value specified by
AndData, and writes the result to the 32-bit I/O port specified by Port. The
value written to the I/O port is returned. This function must guarantee that
all I/O read and write operations are serialized. Extra left bits in both
@@ -956,10 +955,10 @@ IoWrite64 (
);
/**
Reads a 64-bit I/O port, performs a bitwise inclusive OR, and writes the
Reads a 64-bit I/O port, performs a bitwise OR, and writes the
result back to the 64-bit I/O port.
Reads the 64-bit I/O port specified by Port, performs a bitwise inclusive OR
Reads the 64-bit I/O port specified by Port, performs a bitwise OR
between the read result and the value specified by OrData, and writes the
result to the 64-bit I/O port specified by Port. The value written to the I/O
port is returned. This function must guarantee that all I/O read and write
@@ -1008,8 +1007,8 @@ IoAnd64 (
);
/**
Reads a 64-bit I/O port, performs a bitwise AND followed by a bitwise
inclusive OR, and writes the result back to the 64-bit I/O port.
Reads a 64-bit I/O port, performs a bitwise AND followed by a bitwise
OR, and writes the result back to the 64-bit I/O port.
Reads the 64-bit I/O port specified by Port, performs a bitwise AND between
the read result and the value specified by AndData, performs a bitwise OR
@@ -1102,7 +1101,7 @@ IoBitFieldWrite64 (
Reads a bit field in a 64-bit port, performs a bitwise OR, and writes the
result back to the bit field in the 64-bit port.
Reads the 64-bit I/O port specified by Port, performs a bitwise inclusive OR
Reads the 64-bit I/O port specified by Port, performs a bitwise OR
between the read result and the value specified by OrData, and writes the
result to the 64-bit I/O port specified by Port. The value written to the I/O
port is returned. This function must guarantee that all I/O read and write
@@ -1170,11 +1169,11 @@ IoBitFieldAnd64 (
/**
Reads a bit field in a 64-bit port, performs a bitwise AND followed by a
bitwise inclusive OR, and writes the result back to the bit field in the
bitwise OR, and writes the result back to the bit field in the
64-bit port.
Reads the 64-bit I/O port specified by Port, performs a bitwise AND followed
by a bitwise inclusive OR between the read result and the value specified by
by a bitwise OR between the read result and the value specified by
AndData, and writes the result to the 64-bit I/O port specified by Port. The
value written to the I/O port is returned. This function must guarantee that
all I/O read and write operations are serialized. Extra left bits in both
@@ -1248,11 +1247,11 @@ MmioWrite8 (
);
/**
Reads an 8-bit MMIO register, performs a bitwise inclusive OR, and writes the
Reads an 8-bit MMIO register, performs a bitwise OR, and writes the
result back to the 8-bit MMIO register.
Reads the 8-bit MMIO register specified by Address, performs a bitwise
inclusive OR between the read result and the value specified by OrData, and
Reads the 8-bit MMIO register specified by Address, performs a bitwise
OR between the read result and the value specified by OrData, and
writes the result to the 8-bit MMIO register specified by Address. The value
written to the MMIO register is returned. This function must guarantee that
all MMIO read and write operations are serialized.
@@ -1298,8 +1297,8 @@ MmioAnd8 (
);
/**
Reads an 8-bit MMIO register, performs a bitwise AND followed by a bitwise
inclusive OR, and writes the result back to the 8-bit MMIO register.
Reads an 8-bit MMIO register, performs a bitwise AND followed by a bitwise
OR, and writes the result back to the 8-bit MMIO register.
Reads the 8-bit MMIO register specified by Address, performs a bitwise AND
between the read result and the value specified by AndData, performs a
@@ -1389,8 +1388,8 @@ MmioBitFieldWrite8 (
Reads a bit field in an 8-bit MMIO register, performs a bitwise OR, and
writes the result back to the bit field in the 8-bit MMIO register.
Reads the 8-bit MMIO register specified by Address, performs a bitwise
inclusive OR between the read result and the value specified by OrData, and
Reads the 8-bit MMIO register specified by Address, performs a bitwise
OR between the read result and the value specified by OrData, and
writes the result to the 8-bit MMIO register specified by Address. The value
written to the MMIO register is returned. This function must guarantee that
all MMIO read and write operations are serialized. Extra left bits in OrData
@@ -1457,11 +1456,11 @@ MmioBitFieldAnd8 (
/**
Reads a bit field in an 8-bit MMIO register, performs a bitwise AND followed
by a bitwise inclusive OR, and writes the result back to the bit field in the
by a bitwise OR, and writes the result back to the bit field in the
8-bit MMIO register.
Reads the 8-bit MMIO register specified by Address, performs a bitwise AND
followed by a bitwise inclusive OR between the read result and the value
followed by a bitwise OR between the read result and the value
specified by AndData, and writes the result to the 8-bit MMIO register
specified by Address. The value written to the MMIO register is returned.
This function must guarantee that all MMIO read and write operations are
@@ -1536,11 +1535,11 @@ MmioWrite16 (
);
/**
Reads a 16-bit MMIO register, performs a bitwise inclusive OR, and writes the
Reads a 16-bit MMIO register, performs a bitwise OR, and writes the
result back to the 16-bit MMIO register.
Reads the 16-bit MMIO register specified by Address, performs a bitwise
inclusive OR between the read result and the value specified by OrData, and
Reads the 16-bit MMIO register specified by Address, performs a bitwise
OR between the read result and the value specified by OrData, and
writes the result to the 16-bit MMIO register specified by Address. The value
written to the MMIO register is returned. This function must guarantee that
all MMIO read and write operations are serialized.
@@ -1588,8 +1587,8 @@ MmioAnd16 (
);
/**
Reads a 16-bit MMIO register, performs a bitwise AND followed by a bitwise
inclusive OR, and writes the result back to the 16-bit MMIO register.
Reads a 16-bit MMIO register, performs a bitwise AND followed by a bitwise
OR, and writes the result back to the 16-bit MMIO register.
Reads the 16-bit MMIO register specified by Address, performs a bitwise AND
between the read result and the value specified by AndData, performs a
@@ -1681,8 +1680,8 @@ MmioBitFieldWrite16 (
Reads a bit field in a 16-bit MMIO register, performs a bitwise OR, and
writes the result back to the bit field in the 16-bit MMIO register.
Reads the 16-bit MMIO register specified by Address, performs a bitwise
inclusive OR between the read result and the value specified by OrData, and
Reads the 16-bit MMIO register specified by Address, performs a bitwise
OR between the read result and the value specified by OrData, and
writes the result to the 16-bit MMIO register specified by Address. The value
written to the MMIO register is returned. This function must guarantee that
all MMIO read and write operations are serialized. Extra left bits in OrData
@@ -1751,11 +1750,11 @@ MmioBitFieldAnd16 (
/**
Reads a bit field in a 16-bit MMIO register, performs a bitwise AND followed
by a bitwise inclusive OR, and writes the result back to the bit field in the
by a bitwise OR, and writes the result back to the bit field in the
16-bit MMIO register.
Reads the 16-bit MMIO register specified by Address, performs a bitwise AND
followed by a bitwise inclusive OR between the read result and the value
followed by a bitwise OR between the read result and the value
specified by AndData, and writes the result to the 16-bit MMIO register
specified by Address. The value written to the MMIO register is returned.
This function must guarantee that all MMIO read and write operations are
@@ -1831,11 +1830,11 @@ MmioWrite32 (
);
/**
Reads a 32-bit MMIO register, performs a bitwise inclusive OR, and writes the
Reads a 32-bit MMIO register, performs a bitwise OR, and writes the
result back to the 32-bit MMIO register.
Reads the 32-bit MMIO register specified by Address, performs a bitwise
inclusive OR between the read result and the value specified by OrData, and
Reads the 32-bit MMIO register specified by Address, performs a bitwise
OR between the read result and the value specified by OrData, and
writes the result to the 32-bit MMIO register specified by Address. The value
written to the MMIO register is returned. This function must guarantee that
all MMIO read and write operations are serialized.
@@ -1883,8 +1882,8 @@ MmioAnd32 (
);
/**
Reads a 32-bit MMIO register, performs a bitwise AND followed by a bitwise
inclusive OR, and writes the result back to the 32-bit MMIO register.
Reads a 32-bit MMIO register, performs a bitwise AND followed by a bitwise
OR, and writes the result back to the 32-bit MMIO register.
Reads the 32-bit MMIO register specified by Address, performs a bitwise AND
between the read result and the value specified by AndData, performs a
@@ -1976,8 +1975,8 @@ MmioBitFieldWrite32 (
Reads a bit field in a 32-bit MMIO register, performs a bitwise OR, and
writes the result back to the bit field in the 32-bit MMIO register.
Reads the 32-bit MMIO register specified by Address, performs a bitwise
inclusive OR between the read result and the value specified by OrData, and
Reads the 32-bit MMIO register specified by Address, performs a bitwise
OR between the read result and the value specified by OrData, and
writes the result to the 32-bit MMIO register specified by Address. The value
written to the MMIO register is returned. This function must guarantee that
all MMIO read and write operations are serialized. Extra left bits in OrData
@@ -2046,11 +2045,11 @@ MmioBitFieldAnd32 (
/**
Reads a bit field in a 32-bit MMIO register, performs a bitwise AND followed
by a bitwise inclusive OR, and writes the result back to the bit field in the
by a bitwise OR, and writes the result back to the bit field in the
32-bit MMIO register.
Reads the 32-bit MMIO register specified by Address, performs a bitwise AND
followed by a bitwise inclusive OR between the read result and the value
followed by a bitwise OR between the read result and the value
specified by AndData, and writes the result to the 32-bit MMIO register
specified by Address. The value written to the MMIO register is returned.
This function must guarantee that all MMIO read and write operations are
@@ -2126,11 +2125,11 @@ MmioWrite64 (
);
/**
Reads a 64-bit MMIO register, performs a bitwise inclusive OR, and writes the
Reads a 64-bit MMIO register, performs a bitwise OR, and writes the
result back to the 64-bit MMIO register.
Reads the 64-bit MMIO register specified by Address, performs a bitwise
inclusive OR between the read result and the value specified by OrData, and
Reads the 64-bit MMIO register specified by Address, performs a bitwise
OR between the read result and the value specified by OrData, and
writes the result to the 64-bit MMIO register specified by Address. The value
written to the MMIO register is returned. This function must guarantee that
all MMIO read and write operations are serialized.
@@ -2178,8 +2177,8 @@ MmioAnd64 (
);
/**
Reads a 64-bit MMIO register, performs a bitwise AND followed by a bitwise
inclusive OR, and writes the result back to the 64-bit MMIO register.
Reads a 64-bit MMIO register, performs a bitwise AND followed by a bitwise
OR, and writes the result back to the 64-bit MMIO register.
Reads the 64-bit MMIO register specified by Address, performs a bitwise AND
between the read result and the value specified by AndData, performs a
@@ -2271,8 +2270,8 @@ MmioBitFieldWrite64 (
Reads a bit field in a 64-bit MMIO register, performs a bitwise OR, and
writes the result back to the bit field in the 64-bit MMIO register.
Reads the 64-bit MMIO register specified by Address, performs a bitwise
inclusive OR between the read result and the value specified by OrData, and
Reads the 64-bit MMIO register specified by Address, performs a bitwise
OR between the read result and the value specified by OrData, and
writes the result to the 64-bit MMIO register specified by Address. The value
written to the MMIO register is returned. This function must guarantee that
all MMIO read and write operations are serialized. Extra left bits in OrData
@@ -2341,11 +2340,11 @@ MmioBitFieldAnd64 (
/**
Reads a bit field in a 64-bit MMIO register, performs a bitwise AND followed
by a bitwise inclusive OR, and writes the result back to the bit field in the
by a bitwise OR, and writes the result back to the bit field in the
64-bit MMIO register.
Reads the 64-bit MMIO register specified by Address, performs a bitwise AND
followed by a bitwise inclusive OR between the read result and the value
followed by a bitwise OR between the read result and the value
specified by AndData, and writes the result to the 64-bit MMIO register
specified by Address. The value written to the MMIO register is returned.
This function must guarantee that all MMIO read and write operations are