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

Minor grammatical work--mostly adding periods. Items with ONLY period added did not have the heading date changed, but Items with content changes had heading copyright dates updated. Sending separately a list of files missing Doxygen @param and @return information. (PENDING)

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10596 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
myronporter
2010-06-24 00:20:35 +00:00
parent c5eef36d69
commit 127010dd96
55 changed files with 293 additions and 293 deletions
Download Patch File Download Diff File Expand all files Collapse all files

138
MdePkg/Library/BaseLib/BaseLibInternals.h
View File

@@ -1,11 +1,11 @@
/** @file
Declaration of internal functions in BaseLib.
Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@@ -46,7 +46,7 @@ InternalMathLShiftU64 (
);
/**
Shifts a 64-bit integer right between 0 and 63 bits. This high bits
Shifts a 64-bit integer right between 0 and 63 bits. The high bits
are filled with zeros. The shifted value is returned.
This function shifts the 64-bit value Operand to the right by Count bits. The
@@ -90,7 +90,7 @@ InternalMathARShiftU64 (
the low bits with the high bits that were rotated.
This function rotates the 64-bit value Operand to the left by Count bits. The
low Count bits are fill with the high Count bits of Operand. The rotated
low Count bits are filled with the high Count bits of Operand. The rotated
value is returned.
@param Operand The 64-bit operand to rotate left.
@@ -111,7 +111,7 @@ InternalMathLRotU64 (
the high bits with the high low bits that were rotated.
This function rotates the 64-bit value Operand to the right by Count bits.
The high Count bits are fill with the low Count bits of Operand. The rotated
The high Count bits are filled with the low Count bits of Operand. The rotated
value is returned.
@param Operand The 64-bit operand to rotate right.
@@ -146,10 +146,10 @@ InternalMathSwapBytes64 (
);
/**
Multiples a 64-bit unsigned integer by a 32-bit unsigned integer
Multiplies a 64-bit unsigned integer by a 32-bit unsigned integer
and generates a 64-bit unsigned result.
This function multiples the 64-bit unsigned value Multiplicand by the 32-bit
This function multiplies the 64-bit unsigned value Multiplicand by the 32-bit
unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
bit unsigned result is returned.
@@ -167,7 +167,7 @@ InternalMathMultU64x32 (
);
/**
Multiples a 64-bit unsigned integer by a 64-bit unsigned integer
Multiplies a 64-bit unsigned integer by a 64-bit unsigned integer
and generates a 64-bit unsigned result.
This function multiples the 64-bit unsigned value Multiplicand by the 64-bit
@@ -356,8 +356,8 @@ InternalSwitchStack (
@param List A pointer to a node in a linked list.
@param Node A pointer to one nod.
@retval TRUE Node is in List
@retval FALSE Node isn't in List, or List is invalid
@retval TRUE Node is in List.
@retval FALSE Node isn't in List, or List is invalid.
**/
BOOLEAN
@@ -488,7 +488,7 @@ InternalLongJump (
Reads and returns the current GDTR descriptor and returns it in Gdtr. This
function is only available on IA-32 and x64.
@param Gdtr Pointer to a GDTR descriptor.
@param Gdtr The pointer to a GDTR descriptor.
**/
VOID
@@ -503,7 +503,7 @@ InternalX86ReadGdtr (
Writes and the current GDTR descriptor specified by Gdtr. This function is
only available on IA-32 and x64.
@param Gdtr Pointer to a GDTR descriptor.
@param Gdtr The pointer to a GDTR descriptor.
**/
VOID
@@ -518,7 +518,7 @@ InternalX86WriteGdtr (
Reads and returns the current IDTR descriptor and returns it in Idtr. This
function is only available on IA-32 and x64.
@param Idtr Pointer to a IDTR descriptor.
@param Idtr The pointer to an IDTR descriptor.
**/
VOID
@@ -533,7 +533,7 @@ InternalX86ReadIdtr (
Writes the current IDTR descriptor and returns it in Idtr. This function is
only available on IA-32 and x64.
@param Idtr Pointer to a IDTR descriptor.
@param Idtr The pointer to an IDTR descriptor.
**/
VOID
@@ -549,7 +549,7 @@ InternalX86WriteIdtr (
Buffer. Buffer must be aligned on a 16-byte boundary. This function is only
available on IA-32 and x64.
@param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
@param Buffer The pointer to a buffer to save the floating point/SSE/SSE2 context.
**/
VOID
@@ -565,7 +565,7 @@ InternalX86FxSave (
by Buffer. Buffer must be aligned on a 16-byte boundary. This function is
only available on IA-32 and x64.
@param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
@param Buffer The pointer to a buffer to save the floating point/SSE/SSE2 context.
**/
VOID
@@ -739,7 +739,7 @@ InternalX86DisablePaging64 (
Reads control register DCR.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_DCR
when its parameter Index is IPF_CONTROL_REGISTER_DCR.
@return The 64-bit control register DCR.
@@ -755,7 +755,7 @@ AsmReadControlRegisterDcr (
Reads control register ITM.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_ITM
when its parameter Index is IPF_CONTROL_REGISTER_ITM.
@return The 64-bit control register ITM.
@@ -771,7 +771,7 @@ AsmReadControlRegisterItm (
Reads control register IVA.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_IVA
when its parameter Index is IPF_CONTROL_REGISTER_IVA.
@return The 64-bit control register IVA.
@@ -787,7 +787,7 @@ AsmReadControlRegisterIva (
Reads control register PTA.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_PTA
when its parameter Index is IPF_CONTROL_REGISTER_PTA.
@return The 64-bit control register PTA.
@@ -803,7 +803,7 @@ AsmReadControlRegisterPta (
Reads control register IPSR.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_IPSR
when its parameter Index is IPF_CONTROL_REGISTER_IPSR.
@return The 64-bit control register IPSR.
@@ -819,7 +819,7 @@ AsmReadControlRegisterIpsr (
Reads control register ISR.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_ISR
when its parameter Index is IPF_CONTROL_REGISTER_ISR.
@return The 64-bit control register ISR.
@@ -835,7 +835,7 @@ AsmReadControlRegisterIsr (
Reads control register IIP.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_IIP
when its parameter Index is IPF_CONTROL_REGISTER_IIP.
@return The 64-bit control register IIP.
@@ -851,7 +851,7 @@ AsmReadControlRegisterIip (
Reads control register IFA.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_IFA
when its parameter Index is IPF_CONTROL_REGISTER_IFA.
@return The 64-bit control register IFA.
@@ -867,7 +867,7 @@ AsmReadControlRegisterIfa (
Reads control register ITIR.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_ITIR
when its parameter Index is IPF_CONTROL_REGISTER_ITIR.
@return The 64-bit control register ITIR.
@@ -883,7 +883,7 @@ AsmReadControlRegisterItir (
Reads control register IIPA.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_IIPA
when its parameter Index is IPF_CONTROL_REGISTER_IIPA.
@return The 64-bit control register IIPA.
@@ -899,7 +899,7 @@ AsmReadControlRegisterIipa (
Reads control register IFS.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_IFS
when its parameter Index is IPF_CONTROL_REGISTER_IFS.
@return The 64-bit control register IFS.
@@ -915,7 +915,7 @@ AsmReadControlRegisterIfs (
Reads control register IIM.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_IIM
when its parameter Index is IPF_CONTROL_REGISTER_IIM.
@return The 64-bit control register IIM.
@@ -931,7 +931,7 @@ AsmReadControlRegisterIim (
Reads control register IHA.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_IHA
when its parameter Index is IPF_CONTROL_REGISTER_IHA.
@return The 64-bit control register IHA.
@@ -947,7 +947,7 @@ AsmReadControlRegisterIha (
Reads control register LID.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_LID
when its parameter Index is IPF_CONTROL_REGISTER_LID.
@return The 64-bit control register LID.
@@ -963,7 +963,7 @@ AsmReadControlRegisterLid (
Reads control register IVR.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_IVR
when its parameter Index is IPF_CONTROL_REGISTER_IVR.
@return The 64-bit control register IVR.
@@ -979,7 +979,7 @@ AsmReadControlRegisterIvr (
Reads control register TPR.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_TPR
when its parameter Index is IPF_CONTROL_REGISTER_TPR.
@return The 64-bit control register TPR.
@@ -995,7 +995,7 @@ AsmReadControlRegisterTpr (
Reads control register EOI.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_EOI
when its parameter Index is IPF_CONTROL_REGISTER_EOI.
@return The 64-bit control register EOI.
@@ -1011,7 +1011,7 @@ AsmReadControlRegisterEoi (
Reads control register IRR0.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_IRR0
when its parameter Index is IPF_CONTROL_REGISTER_IRR0.
@return The 64-bit control register IRR0.
@@ -1027,7 +1027,7 @@ AsmReadControlRegisterIrr0 (
Reads control register IRR1.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_IRR1
when its parameter Index is IPF_CONTROL_REGISTER_IRR1.
@return The 64-bit control register IRR1.
@@ -1043,7 +1043,7 @@ AsmReadControlRegisterIrr1 (
Reads control register IRR2.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_IRR2
when its parameter Index is IPF_CONTROL_REGISTER_IRR2.
@return The 64-bit control register IRR2.
@@ -1059,7 +1059,7 @@ AsmReadControlRegisterIrr2 (
Reads control register IRR3.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_IRR3
when its parameter Index is IPF_CONTROL_REGISTER_IRR3.
@return The 64-bit control register IRR3.
@@ -1075,7 +1075,7 @@ AsmReadControlRegisterIrr3 (
Reads control register ITV.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_ITV
when its parameter Index is IPF_CONTROL_REGISTER_ITV.
@return The 64-bit control register ITV.
@@ -1091,7 +1091,7 @@ AsmReadControlRegisterItv (
Reads control register PMV.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_PMV
when its parameter Index is IPF_CONTROL_REGISTER_PMV.
@return The 64-bit control register PMV.
@@ -1107,7 +1107,7 @@ AsmReadControlRegisterPmv (
Reads control register CMCV.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_CMCV
when its parameter Index is IPF_CONTROL_REGISTER_CMCV.
@return The 64-bit control register CMCV.
@@ -1123,7 +1123,7 @@ AsmReadControlRegisterCmcv (
Reads control register LRR0.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_LRR0
when its parameter Index is IPF_CONTROL_REGISTER_LRR0.
@return The 64-bit control register LRR0.
@@ -1139,7 +1139,7 @@ AsmReadControlRegisterLrr0 (
Reads control register LRR1.
This is a worker function for AsmReadControlRegister()
when its parameter Index is IPF_CONTROL_REGISTER_LRR1
when its parameter Index is IPF_CONTROL_REGISTER_LRR1.
@return The 64-bit control register LRR1.
@@ -1155,7 +1155,7 @@ AsmReadControlRegisterLrr1 (
Reads application register K0.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_K0
when its parameter Index is IPF_APPLICATION_REGISTER_K0.
@return The 64-bit application register K0.
@@ -1172,7 +1172,7 @@ AsmReadApplicationRegisterK0 (
Reads application register K1.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_K1
when its parameter Index is IPF_APPLICATION_REGISTER_K1.
@return The 64-bit application register K1.
@@ -1188,7 +1188,7 @@ AsmReadApplicationRegisterK1 (
Reads application register K2.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_K2
when its parameter Index is IPF_APPLICATION_REGISTER_K2.
@return The 64-bit application register K2.
@@ -1204,7 +1204,7 @@ AsmReadApplicationRegisterK2 (
Reads application register K3.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_K3
when its parameter Index is IPF_APPLICATION_REGISTER_K3.
@return The 64-bit application register K3.
@@ -1220,7 +1220,7 @@ AsmReadApplicationRegisterK3 (
Reads application register K4.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_K4
when its parameter Index is IPF_APPLICATION_REGISTER_K4.
@return The 64-bit application register K4.
@@ -1236,7 +1236,7 @@ AsmReadApplicationRegisterK4 (
Reads application register K5.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_K5
when its parameter Index is IPF_APPLICATION_REGISTER_K5.
@return The 64-bit application register K5.
@@ -1252,7 +1252,7 @@ AsmReadApplicationRegisterK5 (
Reads application register K6.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_K6
when its parameter Index is IPF_APPLICATION_REGISTER_K6.
@return The 64-bit application register K6.
@@ -1268,7 +1268,7 @@ AsmReadApplicationRegisterK6 (
Reads application register K7.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_K7
when its parameter Index is IPF_APPLICATION_REGISTER_K7.
@return The 64-bit application register K7.
@@ -1284,7 +1284,7 @@ AsmReadApplicationRegisterK7 (
Reads application register RSC.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_RSC
when its parameter Index is IPF_APPLICATION_REGISTER_RSC.
@return The 64-bit application register RSC.
@@ -1300,7 +1300,7 @@ AsmReadApplicationRegisterRsc (
Reads application register BSP.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_BSP
when its parameter Index is IPF_APPLICATION_REGISTER_BSP.
@return The 64-bit application register BSP.
@@ -1316,7 +1316,7 @@ AsmReadApplicationRegisterBsp (
Reads application register BSPSTORE.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_BSPSTORE
when its parameter Index is IPF_APPLICATION_REGISTER_BSPSTORE.
@return The 64-bit application register BSPSTORE.
@@ -1332,7 +1332,7 @@ AsmReadApplicationRegisterBspstore (
Reads application register RNAT.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_RNAT
when its parameter Index is IPF_APPLICATION_REGISTER_RNAT.
@return The 64-bit application register RNAT.
@@ -1348,7 +1348,7 @@ AsmReadApplicationRegisterRnat (
Reads application register FCR.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_FCR
when its parameter Index is IPF_APPLICATION_REGISTER_FCR.
@return The 64-bit application register FCR.
@@ -1364,7 +1364,7 @@ AsmReadApplicationRegisterFcr (
Reads application register EFLAG.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_EFLAG
when its parameter Index is IPF_APPLICATION_REGISTER_EFLAG.
@return The 64-bit application register EFLAG.
@@ -1380,7 +1380,7 @@ AsmReadApplicationRegisterEflag (
Reads application register CSD.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_CSD
when its parameter Index is IPF_APPLICATION_REGISTER_CSD.
@return The 64-bit application register CSD.
@@ -1396,7 +1396,7 @@ AsmReadApplicationRegisterCsd (
Reads application register SSD.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_SSD
when its parameter Index is IPF_APPLICATION_REGISTER_SSD.
@return The 64-bit application register SSD.
@@ -1412,7 +1412,7 @@ AsmReadApplicationRegisterSsd (
Reads application register CFLG.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_CFLG
when its parameter Index is IPF_APPLICATION_REGISTER_CFLG.
@return The 64-bit application register CFLG.
@@ -1428,7 +1428,7 @@ AsmReadApplicationRegisterCflg (
Reads application register FSR.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_FSR
when its parameter Index is IPF_APPLICATION_REGISTER_FSR.
@return The 64-bit application register FSR.
@@ -1444,7 +1444,7 @@ AsmReadApplicationRegisterFsr (
Reads application register FIR.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_FIR
when its parameter Index is IPF_APPLICATION_REGISTER_FIR.
@return The 64-bit application register FIR.
@@ -1460,7 +1460,7 @@ AsmReadApplicationRegisterFir (
Reads application register FDR.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_FDR
when its parameter Index is IPF_APPLICATION_REGISTER_FDR.
@return The 64-bit application register FDR.
@@ -1476,7 +1476,7 @@ AsmReadApplicationRegisterFdr (
Reads application register CCV.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_CCV
when its parameter Index is IPF_APPLICATION_REGISTER_CCV.
@return The 64-bit application register CCV.
@@ -1492,7 +1492,7 @@ AsmReadApplicationRegisterCcv (
Reads application register UNAT.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_UNAT
when its parameter Index is IPF_APPLICATION_REGISTER_UNAT.
@return The 64-bit application register UNAT.
@@ -1508,7 +1508,7 @@ AsmReadApplicationRegisterUnat (
Reads application register FPSR.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_FPSR
when its parameter Index is IPF_APPLICATION_REGISTER_FPSR.
@return The 64-bit application register FPSR.
@@ -1524,7 +1524,7 @@ AsmReadApplicationRegisterFpsr (
Reads application register ITC.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_ITC
when its parameter Index is IPF_APPLICATION_REGISTER_ITC.
@return The 64-bit application register ITC.
@@ -1540,7 +1540,7 @@ AsmReadApplicationRegisterItc (
Reads application register PFS.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_PFS
when its parameter Index is IPF_APPLICATION_REGISTER_PFS.
@return The 64-bit application register PFS.
@@ -1556,7 +1556,7 @@ AsmReadApplicationRegisterPfs (
Reads application register LC.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_LC
when its parameter Index is IPF_APPLICATION_REGISTER_LC.
@return The 64-bit application register LC.
@@ -1572,7 +1572,7 @@ AsmReadApplicationRegisterLc (
Reads application register EC.
This is a worker function for AsmReadApplicationRegister()
when its parameter Index is IPF_APPLICATION_REGISTER_EC
when its parameter Index is IPF_APPLICATION_REGISTER_EC.
@return The 64-bit application register EC.