diff options
| author | Peter Lemenkov <lemenkov@gmail.com> | 2018-12-07 11:23:21 +0100 |
|---|---|---|
| committer | Patrick Georgi <pgeorgi@google.com> | 2019-01-17 14:52:33 +0000 |
| commit | 7bbe3bb9f0caf518af89bc18b99cd9ac32ceff3f (patch) | |
| tree | 4be81861c4f9187ef5b4ce0cc1cfd7daeea12dcd /src/vendorcode | |
| parent | d5292bf9a5a1e47a3cbb6393f23c6f021232be02 (diff) | |
vendorcode/{amd,cavium,intel}: Remove trailing whitespace
find src -type f "!" -regex ".*\.\(vbt\|bin\)" -exec sed -i -e "s,\s\+$,,g" {} \;
Change-Id: Ic70cf8524dcd0a0f5700f91b704b3c545dd8a01a
Signed-off-by: Peter Lemenkov <lemenkov@gmail.com>
Reviewed-on: https://review.coreboot.org/c/30959
Reviewed-by: Patrick Georgi <pgeorgi@google.com>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Diffstat (limited to 'src/vendorcode')
395 files changed, 9697 insertions, 9697 deletions
diff --git a/src/vendorcode/amd/agesa/common/Makefile.inc b/src/vendorcode/amd/agesa/common/Makefile.inc index efc42eec13..78dd4fc988 100644 --- a/src/vendorcode/amd/agesa/common/Makefile.inc +++ b/src/vendorcode/amd/agesa/common/Makefile.inc @@ -10,8 +10,8 @@ # * Redistributions in binary form must reproduce the above copyright # notice, this list of conditions and the following disclaimer in the # documentation and/or other materials provided with the distribution. -# * Neither the name of Advanced Micro Devices, Inc. nor the names of -# its contributors may be used to endorse or promote products derived +# * Neither the name of Advanced Micro Devices, Inc. nor the names of +# its contributors may be used to endorse or promote products derived # from this software without specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND diff --git a/src/vendorcode/amd/agesa/f12/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibConfig.esl b/src/vendorcode/amd/agesa/f12/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibConfig.esl index 8aa9a7e67f..a8763dab8f 100644 --- a/src/vendorcode/amd/agesa/f12/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibConfig.esl +++ b/src/vendorcode/amd/agesa/f12/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibConfig.esl @@ -16,7 +16,7 @@ * * Copyright (c) 2011, Advanced Micro Devices, Inc. * All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * Redistributions of source code must retain the above copyright @@ -24,10 +24,10 @@ * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. - * * Neither the name of Advanced Micro Devices, Inc. nor the names of - * its contributors may be used to endorse or promote products derived + * * Neither the name of Advanced Micro Devices, Inc. nor the names of + * its contributors may be used to endorse or promote products derived * from this software without specific prior written permission. - * + * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE diff --git a/src/vendorcode/amd/agesa/f12/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibCore.esl b/src/vendorcode/amd/agesa/f12/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibCore.esl index d4cc767393..782a06fbce 100644 --- a/src/vendorcode/amd/agesa/f12/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibCore.esl +++ b/src/vendorcode/amd/agesa/f12/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibCore.esl @@ -16,7 +16,7 @@ * * Copyright (c) 2011, Advanced Micro Devices, Inc. * All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * Redistributions of source code must retain the above copyright @@ -24,10 +24,10 @@ * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. - * * Neither the name of Advanced Micro Devices, Inc. nor the names of - * its contributors may be used to endorse or promote products derived + * * Neither the name of Advanced Micro Devices, Inc. nor the names of + * its contributors may be used to endorse or promote products derived * from this software without specific prior written permission. - * + * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE diff --git a/src/vendorcode/amd/agesa/f12/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibHotplug.esl b/src/vendorcode/amd/agesa/f12/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibHotplug.esl index bbe7c18f78..e8cdb9e6a5 100644 --- a/src/vendorcode/amd/agesa/f12/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibHotplug.esl +++ b/src/vendorcode/amd/agesa/f12/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibHotplug.esl @@ -16,7 +16,7 @@ * * Copyright (c) 2011, Advanced Micro Devices, Inc. * All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * Redistributions of source code must retain the above copyright @@ -24,10 +24,10 @@ * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. - * * Neither the name of Advanced Micro Devices, Inc. nor the names of - * its contributors may be used to endorse or promote products derived + * * Neither the name of Advanced Micro Devices, Inc. nor the names of + * its contributors may be used to endorse or promote products derived * from this software without specific prior written permission. - * + * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE diff --git a/src/vendorcode/amd/agesa/f12/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibPspp.esl b/src/vendorcode/amd/agesa/f12/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibPspp.esl index 5dcfccebe4..ffc50f8054 100644 --- a/src/vendorcode/amd/agesa/f12/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibPspp.esl +++ b/src/vendorcode/amd/agesa/f12/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibPspp.esl @@ -16,7 +16,7 @@ * * Copyright (c) 2011, Advanced Micro Devices, Inc. * All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * Redistributions of source code must retain the above copyright @@ -24,10 +24,10 @@ * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. - * * Neither the name of Advanced Micro Devices, Inc. nor the names of - * its contributors may be used to endorse or promote products derived + * * Neither the name of Advanced Micro Devices, Inc. nor the names of + * its contributors may be used to endorse or promote products derived * from this software without specific prior written permission. - * + * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE diff --git a/src/vendorcode/amd/agesa/f12/Proc/GNB/Modules/GnbPcieInitLibV1/PcieSmuLib.esl b/src/vendorcode/amd/agesa/f12/Proc/GNB/Modules/GnbPcieInitLibV1/PcieSmuLib.esl index 18709ed55e..27fed7d8e4 100644 --- a/src/vendorcode/amd/agesa/f12/Proc/GNB/Modules/GnbPcieInitLibV1/PcieSmuLib.esl +++ b/src/vendorcode/amd/agesa/f12/Proc/GNB/Modules/GnbPcieInitLibV1/PcieSmuLib.esl @@ -16,7 +16,7 @@ * * Copyright (c) 2011, Advanced Micro Devices, Inc. * All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * Redistributions of source code must retain the above copyright @@ -24,10 +24,10 @@ * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. - * * Neither the name of Advanced Micro Devices, Inc. nor the names of - * its contributors may be used to endorse or promote products derived + * * Neither the name of Advanced Micro Devices, Inc. nor the names of + * its contributors may be used to endorse or promote products derived * from this software without specific prior written permission. - * + * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE @@ -117,7 +117,7 @@ Or (ShiftLeft (Arg0, 3), 0x1, Local0) procNbSmuIndirectRegisterWrite (0x3, Local0, 1) - + if (LAnd (Arg1, 1)) { while (LNotEqual (AND(procNbSmuIndirectRegisterRead (0x3), 0x2), 0x2)) { Store ("--Wait Ack--", Debug) diff --git a/src/vendorcode/amd/agesa/f12/Proc/GNB/PCIe/Family/LN/F12PcieAlib.esl b/src/vendorcode/amd/agesa/f12/Proc/GNB/PCIe/Family/LN/F12PcieAlib.esl index 29696d4951..01c55e87d0 100644 --- a/src/vendorcode/amd/agesa/f12/Proc/GNB/PCIe/Family/LN/F12PcieAlib.esl +++ b/src/vendorcode/amd/agesa/f12/Proc/GNB/PCIe/Family/LN/F12PcieAlib.esl @@ -16,7 +16,7 @@ * * Copyright (c) 2011, Advanced Micro Devices, Inc. * All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * Redistributions of source code must retain the above copyright @@ -24,10 +24,10 @@ * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. - * * Neither the name of Advanced Micro Devices, Inc. nor the names of - * its contributors may be used to endorse or promote products derived + * * Neither the name of Advanced Micro Devices, Inc. nor the names of + * its contributors may be used to endorse or promote products derived * from this software without specific prior written permission. - * + * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE @@ -139,7 +139,7 @@ DefinitionBlock ( procSmuRcuWrite (0x8490, Local0) } } - Name (AD0A, 1) + Name (AD0A, 1) #ifdef ALTVDDNB_SUPPORT /*----------------------------------------------------------------------------------------*/ /** diff --git a/src/vendorcode/amd/agesa/f12/gcccar.inc b/src/vendorcode/amd/agesa/f12/gcccar.inc index 6a8045198d..95dd74d6cb 100644 --- a/src/vendorcode/amd/agesa/f12/gcccar.inc +++ b/src/vendorcode/amd/agesa/f12/gcccar.inc @@ -259,7 +259,7 @@ MSR_MASK = ((1 << MTRR_DEF_TYPE_EN)+(1 << MTRR_DEF_TYPE_FIX_EN)) jnz node_core_exit # Br if yes mov $((1 << FLAG_UNKNOWN_FAMILY)+(1 << FLAG_IS_PRIMARY)), %esi # No, Set error code, Only let BSP continue - + mov $APIC_BASE_ADDRESS, %ecx # MSR:0000_001B _RDMSR bt $APIC_BSC, %eax # Is this the BSC? @@ -978,7 +978,7 @@ fam15_enable_stack_hook_exit: btr $DIS_HW_PF, %eax # Turn on hardware prefetches #.endif # End workaround for erratum 498 0: - _WRMSR + _WRMSR #-------------------------------------------------------------------------- # Begin critical sequence in which EAX, BX, ECX, and EDX must be preserved. #-------------------------------------------------------------------------- diff --git a/src/vendorcode/amd/agesa/f14/Makefile.inc b/src/vendorcode/amd/agesa/f14/Makefile.inc index 2cc3957227..bfe5d74347 100644 --- a/src/vendorcode/amd/agesa/f14/Makefile.inc +++ b/src/vendorcode/amd/agesa/f14/Makefile.inc @@ -10,8 +10,8 @@ # * Redistributions in binary form must reproduce the above copyright # notice, this list of conditions and the following disclaimer in the # documentation and/or other materials provided with the distribution. -# * Neither the name of Advanced Micro Devices, Inc. nor the names of -# its contributors may be used to endorse or promote products derived +# * Neither the name of Advanced Micro Devices, Inc. nor the names of +# its contributors may be used to endorse or promote products derived # from this software without specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND diff --git a/src/vendorcode/amd/agesa/f14/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibConfig.esl b/src/vendorcode/amd/agesa/f14/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibConfig.esl index 5150ee1d22..9140d6fb6b 100644 --- a/src/vendorcode/amd/agesa/f14/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibConfig.esl +++ b/src/vendorcode/amd/agesa/f14/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibConfig.esl @@ -16,7 +16,7 @@ * * Copyright (c) 2011, Advanced Micro Devices, Inc. * All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * Redistributions of source code must retain the above copyright @@ -24,10 +24,10 @@ * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. - * * Neither the name of Advanced Micro Devices, Inc. nor the names of - * its contributors may be used to endorse or promote products derived + * * Neither the name of Advanced Micro Devices, Inc. nor the names of + * its contributors may be used to endorse or promote products derived * from this software without specific prior written permission. - * + * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE @@ -38,7 +38,7 @@ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - * + * * *************************************************************************** * */ diff --git a/src/vendorcode/amd/agesa/f14/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibCore.esl b/src/vendorcode/amd/agesa/f14/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibCore.esl index ab67b9e02e..463093c6b1 100644 --- a/src/vendorcode/amd/agesa/f14/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibCore.esl +++ b/src/vendorcode/amd/agesa/f14/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibCore.esl @@ -16,7 +16,7 @@ * * Copyright (c) 2011, Advanced Micro Devices, Inc. * All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * Redistributions of source code must retain the above copyright @@ -24,10 +24,10 @@ * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. - * * Neither the name of Advanced Micro Devices, Inc. nor the names of - * its contributors may be used to endorse or promote products derived + * * Neither the name of Advanced Micro Devices, Inc. nor the names of + * its contributors may be used to endorse or promote products derived * from this software without specific prior written permission. - * + * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE @@ -38,7 +38,7 @@ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - * + * * *************************************************************************** * */ @@ -67,7 +67,7 @@ * PCIe port info * */ - + Name ( AD07, Package () { @@ -100,19 +100,19 @@ Method (ALIB, 2, NotSerialized) { If (Lequal (Arg0, 0x1)) { return (procPsppReportAcDsState (Arg1)) - } + } If (LEqual (Arg0, 0x2)) { return (procPsppPerformanceRequest (Arg1)) - } + } If (LEqual (Arg0, 0x3)) { return (procPsppControl (Arg1)) - } + } If (LEqual (Arg0, 0x4)) { return (procPcieSetBusWidth (Arg1)) - } + } If (LEqual (Arg0, 0x5)) { return (procAlibInit ()) - } + } If (LEqual (Arg0, 0x6)) { return (procPciePortHotplug (Arg1)) } @@ -180,7 +180,7 @@ procPciDwordWrite (Arg0, Arg1, Local0) } - Mutex(varPciePortAccessMutex, 0) + Mutex(varPciePortAccessMutex, 0) /*----------------------------------------------------------------------------------------*/ /** * Read PCIe port indirect register @@ -194,7 +194,7 @@ Store (ShiftLeft (Add( Arg0, 2), 3), Local0) procPciDwordWrite (Local0, 0xe0, Arg1) Store (procPciDwordRead (Local0, 0xe4), Local0) - Release (varPciePortAccessMutex) + Release (varPciePortAccessMutex) return (Local0) } @@ -281,7 +281,7 @@ /*----------------------------------------------------------------------------------------*/ /** - * + * * * Arg0 - Port ID * Retval - buffer that represent port data set @@ -320,7 +320,7 @@ /*----------------------------------------------------------------------------------------*/ /** - * + * * * Arg0 - Aspm * Arg1 - 0: Read, 1: Write @@ -336,7 +336,7 @@ IndexField (PMRI, PMRD, ByteAcc, NoLock, Preserve) { Offset(0xE0), // IO Base address of A-Link Express/ A-Link Bridge register - ABAR, 32, + ABAR, 32, } OperationRegion (ACFG, SystemIO, ABAR, 0x8) Field (ACFG, DWordAcc, Nolock, Preserve) //AB_INDX/AB_DATA diff --git a/src/vendorcode/amd/agesa/f14/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibHotplug.esl b/src/vendorcode/amd/agesa/f14/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibHotplug.esl index 5fa1a9774e..c2eede930c 100644 --- a/src/vendorcode/amd/agesa/f14/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibHotplug.esl +++ b/src/vendorcode/amd/agesa/f14/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibHotplug.esl @@ -24,8 +24,8 @@ * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. -* * Neither the name of Advanced Micro Devices, Inc. nor the names of -* its contributors may be used to endorse or promote products derived +* * Neither the name of Advanced Micro Devices, Inc. nor the names of +* its contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND @@ -446,7 +446,7 @@ Name (varLinkWidthBuffer, Buffer () {0, 1, 2, 4, 8, 12, 16}) Store (Concatenate ("Lane Bitmap : ", ToHexString (varLaneBitmapOrMaskLocal3), varStringBuffer), Debug) if (Lequal (Arg3, 1)) { Store (0, varLaneBitmapOrMaskLocal3) - } + } procIndirectRegisterRMW (0x0, 0xE0, Or (ShiftLeft (varWrapperId, 16), 0x8023), varLaneBitmapAndMaskLocal4, varLaneBitmapOrMaskLocal3); Stall (10) Store ("PcieLaneEnableControl Exit", Debug) diff --git a/src/vendorcode/amd/agesa/f14/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibPspp.esl b/src/vendorcode/amd/agesa/f14/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibPspp.esl index 2bfabc9077..fe968a154d 100644 --- a/src/vendorcode/amd/agesa/f14/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibPspp.esl +++ b/src/vendorcode/amd/agesa/f14/Proc/GNB/Modules/GnbPcieAlibV1/PcieAlibPspp.esl @@ -24,8 +24,8 @@ * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. -* * Neither the name of Advanced Micro Devices, Inc. nor the names of -* its contributors may be used to endorse or promote products derived +* * Neither the name of Advanced Micro Devices, Inc. nor the names of +* its contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND diff --git a/src/vendorcode/amd/agesa/f14/Proc/GNB/Modules/GnbPcieInitLibV1/PcieSmuLib.esl b/src/vendorcode/amd/agesa/f14/Proc/GNB/Modules/GnbPcieInitLibV1/PcieSmuLib.esl index 43b1d62de0..5acf1c7d0c 100644 --- a/src/vendorcode/amd/agesa/f14/Proc/GNB/Modules/GnbPcieInitLibV1/PcieSmuLib.esl +++ b/src/vendorcode/amd/agesa/f14/Proc/GNB/Modules/GnbPcieInitLibV1/PcieSmuLib.esl @@ -16,7 +16,7 @@ * * Copyright (c) 2011, Advanced Micro Devices, Inc. * All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * Redistributions of source code must retain the above copyright @@ -24,10 +24,10 @@ * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. - * * Neither the name of Advanced Micro Devices, Inc. nor the names of - * its contributors may be used to endorse or promote products derived + * * Neither the name of Advanced Micro Devices, Inc. nor the names of + * its contributors may be used to endorse or promote products derived * from this software without specific prior written permission. - * + * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE @@ -38,7 +38,7 @@ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - * + * * *************************************************************************** * */ @@ -118,7 +118,7 @@ Or (ShiftLeft (Arg0, 3), 0x1, Local0) procNbSmuIndirectRegisterWrite (0x3, Local0, 1) - + if (LAnd (Arg1, 1)) { while (LNotEqual (AND(procNbSmuIndirectRegisterRead (0x3), 0x2), 0x2)) { Store ("--Wait Ack--", Debug) diff --git a/src/vendorcode/amd/agesa/f14/Proc/GNB/PCIe/Family/0x14/F14PcieAlib.esl b/src/vendorcode/amd/agesa/f14/Proc/GNB/PCIe/Family/0x14/F14PcieAlib.esl index fbfea63d62..16f895bfa5 100644 --- a/src/vendorcode/amd/agesa/f14/Proc/GNB/PCIe/Family/0x14/F14PcieAlib.esl +++ b/src/vendorcode/amd/agesa/f14/Proc/GNB/PCIe/Family/0x14/F14PcieAlib.esl @@ -16,7 +16,7 @@ * * Copyright (c) 2011, Advanced Micro Devices, Inc. * All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * Redistributions of source code must retain the above copyright @@ -24,10 +24,10 @@ * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. - * * Neither the name of Advanced Micro Devices, Inc. nor the names of - * its contributors may be used to endorse or promote products derived + * * Neither the name of Advanced Micro Devices, Inc. nor the names of + * its contributors may be used to endorse or promote products derived * from this software without specific prior written permission. - * + * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE @@ -38,7 +38,7 @@ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - * + * * *************************************************************************** * */ @@ -79,7 +79,7 @@ DefinitionBlock ( //This is a battery ¡¥idle¡¦ state along with a ¡¥perf¡¦ state that will be programmed to the max LCLK achievable at the Gen2 VID And (Local0, 0xFFFFFFA0, Local0) Or (Local0, 0xA0, Local0) - + } else { if (LEqual (Arg1, 0)) { //If AC, & if only Gen1 supported, activate state DPM0 and DPM1 @@ -104,7 +104,7 @@ DefinitionBlock ( * * Arg0 - Start Lane ID * Arg1 - End Lane ID - * Arg2 - Power ON(1) / OFF(0) + * Arg2 - Power ON(1) / OFF(0) */ Method (procPcieLanePowerControl, 3, NotSerialized) { // stub function @@ -115,7 +115,7 @@ DefinitionBlock ( * Adjust PLL settings stub * * Arg0 - 1 - GEN1 2 - GEN2 - * + * */ Method (procPcieAdjustPll, 1, NotSerialized) { //stub function diff --git a/src/vendorcode/cavium/bdk/libbdk-boot/bdk-boot-qlm.c b/src/vendorcode/cavium/bdk/libbdk-boot/bdk-boot-qlm.c index 73bdca0363..0f75da2567 100644 --- a/src/vendorcode/cavium/bdk/libbdk-boot/bdk-boot-qlm.c +++ b/src/vendorcode/cavium/bdk/libbdk-boot/bdk-boot-qlm.c @@ -423,7 +423,7 @@ static void boot_init_qlm_mode(void) } } } - /* + /* * Check if QLM autoconfig from DIP switch settings is requested */ else if (bdk_config_get_int(BDK_CONFIG_QLM_DIP_AUTO_CONFIG)) diff --git a/src/vendorcode/cavium/bdk/libbdk-dram/bdk-dram-address.c b/src/vendorcode/cavium/bdk/libbdk-dram/bdk-dram-address.c index acefe1751c..bcbbc48c84 100644 --- a/src/vendorcode/cavium/bdk/libbdk-dram/bdk-dram-address.c +++ b/src/vendorcode/cavium/bdk/libbdk-dram/bdk-dram-address.c @@ -170,7 +170,7 @@ bdk_dram_address_construct_info(bdk_node_t node, int lmc, int dimm, if (lmcx_control.s.xor_bank) new_bank ^= EXTRACT(address, 12 + xbits, bank_width); INSERT(address, new_bank, bank_lsb, bank_width); - + /* Determine the actual C bits from the input LMC controller arg */ /* The input LMC number was probably aliased with other fields */ BDK_CSR_INIT(l2c_ctl, node, BDK_L2C_CTL); diff --git a/src/vendorcode/cavium/bdk/libbdk-dram/bdk-dram-config.c b/src/vendorcode/cavium/bdk/libbdk-dram/bdk-dram-config.c index 2ec7a1aaac..1cf01a26e0 100644 --- a/src/vendorcode/cavium/bdk/libbdk-dram/bdk-dram-config.c +++ b/src/vendorcode/cavium/bdk/libbdk-dram/bdk-dram-config.c @@ -75,7 +75,7 @@ int bdk_dram_config(int node, int ddr_clock_override) } /** - * Do all the DRAM Margin tests + * Do all the DRAM Margin tests * * @param node Node to test * diff --git a/src/vendorcode/cavium/bdk/libbdk-dram/bdk-dram-size.c b/src/vendorcode/cavium/bdk/libbdk-dram/bdk-dram-size.c index eecb34879c..dd412c7892 100644 --- a/src/vendorcode/cavium/bdk/libbdk-dram/bdk-dram-size.c +++ b/src/vendorcode/cavium/bdk/libbdk-dram/bdk-dram-size.c @@ -136,7 +136,7 @@ int __bdk_dram_get_num_bank_bits(bdk_node_t node, int lmc) if (__bdk_dram_is_lmc_in_dreset(node, lmc)) // check LMCn return 0; BDK_CSR_INIT(lmcx_config, node, BDK_LMCX_CONFIG(lmc)); // sample LMCn - int bank_width = (__bdk_dram_is_ddr4(node, lmc) && (lmcx_config.s.bg2_enable)) ? 4 : 3; + int bank_width = (__bdk_dram_is_ddr4(node, lmc) && (lmcx_config.s.bg2_enable)) ? 4 : 3; return bank_width; } diff --git a/src/vendorcode/cavium/bdk/libbdk-dram/bdk-dram-test.c b/src/vendorcode/cavium/bdk/libbdk-dram/bdk-dram-test.c index 8215789112..5e6e4bcf11 100644 --- a/src/vendorcode/cavium/bdk/libbdk-dram/bdk-dram-test.c +++ b/src/vendorcode/cavium/bdk/libbdk-dram/bdk-dram-test.c @@ -380,7 +380,7 @@ static int __bdk_dram_run_test(const dram_test_info_t *test_info, uint64_t start /* Wait for threads to finish, with progress */ int cur_count; uint64_t cur_time; - uint64_t period = bdk_clock_get_rate(bdk_numa_local(), BDK_CLOCK_TIME) * TIMEOUT_SECS; // FIXME? + uint64_t period = bdk_clock_get_rate(bdk_numa_local(), BDK_CLOCK_TIME) * TIMEOUT_SECS; // FIXME? uint64_t timeout = bdk_clock_get_count(BDK_CLOCK_TIME) + period; do { cur_count = bdk_atomic_get64(&dram_test_thread_done); @@ -652,7 +652,7 @@ static void __bdk_dram_report_address_decode_new(uint64_t address, uint64_t orig * @param data Data read from memory * @param correct Correct data * @param burst Which burst this is from, informational only - * @param fails -1 for no retries done, >= 0 number of failures during retries + * @param fails -1 for no retries done, >= 0 number of failures during retries * * @return Zero if a message was logged, non-zero if the error limit has been reached */ @@ -691,7 +691,7 @@ void __bdk_dram_report_error(uint64_t address, uint64_t data, uint64_t correct, * @param address2 Second address involved in the failure * @param data2 Data from second address * @param burst Which burst this is from, informational only - * @param fails -1 for no retries done, >= 0 number of failures during retries + * @param fails -1 for no retries done, >= 0 number of failures during retries * * @return Zero if a message was logged, non-zero if the error limit has been reached */ diff --git a/src/vendorcode/cavium/bdk/libbdk-hal/bdk-config.c b/src/vendorcode/cavium/bdk/libbdk-hal/bdk-config.c index 91f05d3ae7..8e348d0175 100644 --- a/src/vendorcode/cavium/bdk/libbdk-hal/bdk-config.c +++ b/src/vendorcode/cavium/bdk/libbdk-hal/bdk-config.c @@ -498,7 +498,7 @@ bdk_config_info_t config_info[] = { .min_value = 0, .max_value = 1, }, - + [BDK_CONFIG_QLM_MODE] = { .format = "QLM-MODE.N%d.QLM%d", /* Parameters: Node, QLM */ .ctype = BDK_CONFIG_TYPE_STR, diff --git a/src/vendorcode/cavium/bdk/libbdk-hal/if/bdk-if-phy-marvell.c b/src/vendorcode/cavium/bdk/libbdk-hal/if/bdk-if-phy-marvell.c index e8f3a009dd..0efe6975e5 100644 --- a/src/vendorcode/cavium/bdk/libbdk-hal/if/bdk-if-phy-marvell.c +++ b/src/vendorcode/cavium/bdk/libbdk-hal/if/bdk-if-phy-marvell.c @@ -81,7 +81,7 @@ static void setup_marvell_phy(bdk_node_t node, int mdio_bus, int mdio_addr) phy_status = bdk_mdio_read(node, mdio_bus, mdio_addr, 22); if (phy_status < 0) return; - + phy_status = bdk_mdio_read(node, mdio_bus, mdio_addr, 17); if (phy_status < 0) return; @@ -99,14 +99,14 @@ int bdk_if_phy_marvell_setup(bdk_node_t node, int qlm, int mdio_bus, int phy_add /* Check that the GSER mode is SGMII */ /* Switch the marvell PHY to the correct mode */ bdk_qlm_modes_t qlm_mode = bdk_qlm_get_mode(node, qlm); - + BDK_TRACE(PHY,"%s: QLM:%d QLM_MODE:%d\n",__FUNCTION__, qlm, qlm_mode); - + if ((qlm_mode != BDK_QLM_MODE_SGMII_1X1) && (qlm_mode != BDK_QLM_MODE_SGMII_2X1)) return 0; - BDK_TRACE(PHY,"%s: Detected Marvell Phy in SGMII mode\n", __FUNCTION__); + BDK_TRACE(PHY,"%s: Detected Marvell Phy in SGMII mode\n", __FUNCTION__); for (int port = 0; port < 2; port++) { setup_marvell_phy(node, mdio_bus, phy_addr + port); diff --git a/src/vendorcode/cavium/bdk/libbdk-hal/if/bdk-if-phy-vetesse-8514.c b/src/vendorcode/cavium/bdk/libbdk-hal/if/bdk-if-phy-vetesse-8514.c index 4d6ef8d25d..26c4fd45a1 100644 --- a/src/vendorcode/cavium/bdk/libbdk-hal/if/bdk-if-phy-vetesse-8514.c +++ b/src/vendorcode/cavium/bdk/libbdk-hal/if/bdk-if-phy-vetesse-8514.c @@ -90,7 +90,7 @@ static void vitesse_init_script(bdk_node_t node, int mdio_bus, int phy_addr) uint16_t reg_addr; uint16_t reg_val; uint16_t mask; - + BDK_TRACE(PHY,"In %s\n",__FUNCTION__); BDK_TRACE(PHY,"Loading init script for VSC8514\n"); @@ -122,20 +122,20 @@ static void vitesse_program(bdk_node_t node, int mdio_bus, int phy_addr) /** * Setup Vitesse PHYs - * This function sets up one port in a Vitesse VSC8514 + * This function sets up one port in a Vitesse VSC8514 */ static void setup_vitesse_phy(bdk_node_t node, int mdio_bus, int phy_addr) { /*setting MAC if*/ bdk_mdio_write(node, mdio_bus, phy_addr, 31, VSC_PHY_GPIO_PAGE); - wr_masked(node,mdio_bus,phy_addr, 19, 0x4000, 0xc000); + wr_masked(node,mdio_bus,phy_addr, 19, 0x4000, 0xc000); bdk_mdio_write(node, mdio_bus, phy_addr, 18, 0x80e0); /*Setting media if*/ bdk_mdio_write(node, mdio_bus, phy_addr, 31, VSC_PHY_STD_PAGE); // Reg23, 10:8 Select copper, CAT5 copper only wr_masked(node,mdio_bus,phy_addr, 23, 0x0000, 0x0700); - + // Reg0:15, soft Reset wr_masked(node,mdio_bus,phy_addr, 0, 0x8000, 0x8000); int time_out = 100; @@ -159,9 +159,9 @@ static void setup_vitesse_phy(bdk_node_t node, int mdio_bus, int phy_addr) bdk_mdio_write(node, mdio_bus, phy_addr, 16, 0x80); // Select main registers bdk_mdio_write(node, mdio_bus, phy_addr, 31, VSC_PHY_STD_PAGE); - + /* - + if (LOOP_INTERNAL) { reg0 = bdk_mdio_read(node, mdio_bus, phy_addr, 0); @@ -176,7 +176,7 @@ static void setup_vitesse_phy(bdk_node_t node, int mdio_bus, int phy_addr) reg23 = bdk_insert(reg23, 1, 3, 1); bdk_mdio_write(node, mdio_bus, phy_addr, 23, reg23); } - + // Dump registers if (false) diff --git a/src/vendorcode/cavium/bdk/libbdk-hal/if/bdk-if-phy-vetesse-xfi.c b/src/vendorcode/cavium/bdk/libbdk-hal/if/bdk-if-phy-vetesse-xfi.c index b6f052ad47..77ba4c4233 100644 --- a/src/vendorcode/cavium/bdk/libbdk-hal/if/bdk-if-phy-vetesse-xfi.c +++ b/src/vendorcode/cavium/bdk/libbdk-hal/if/bdk-if-phy-vetesse-xfi.c @@ -48,10 +48,10 @@ BDK_REQUIRE_DEFINE(XFI); /* Rate Select Settings -Mode State : 6/8 -Rate Select State : 0 -RSEL1 : 0 -RSEL0 : 0 +Mode State : 6/8 +Rate Select State : 0 +RSEL1 : 0 +RSEL0 : 0 Ref Clock Gen(MHz) : 156.25 Data Rate(Gbps) : 10.3125 Description : 10 GbE @@ -60,60 +60,60 @@ Description : 10 GbE Data Rate Detection Configuration Registers Mode Pin Settings: -Mode State : 0 -MODE1 : 0 -MODE0 : 0 +Mode State : 0 +MODE1 : 0 +MODE0 : 0 Mode : Two-wire serial interface mode LOS Pin Strap Mode Settings -Mode State : 2/6/8 -State : 4 +Mode State : 2/6/8 +State : 4 LOS1 : Float -LOS0 : Float -LOS Amplitude(mVpp) : 20 +LOS0 : Float +LOS Amplitude(mVpp) : 20 LOS Hysteresis(dB) : 2 Input Equalization Retimer Mode Settings Mode State : 6/8 -EQ State : 0 -EQ1 : 0 -EQ0 : 0 -EQ(dB) : Auto -DFE : Auto +EQ State : 0 +EQ1 : 0 +EQ0 : 0 +EQ(dB) : Auto +DFE : Auto Comment : Full Auto Input Equalization Re-Driver Mode Settings -Mode State : -EQ State : 0 -EQ1 : 0 -EQ0 : 0 -EQ(dB) : Auto -DFE : APowered Down +Mode State : +EQ State : 0 +EQ1 : 0 +EQ0 : 0 +EQ(dB) : Auto +DFE : APowered Down Comment : Analog EQ Only Output De-Emphasis Retimer Mode Settings -Mode State : 6/8 -DE State : 3 -TX1 : Float -TX0 : 0 -PRE c(-1) mA : -1 +Mode State : 6/8 +DE State : 3 +TX1 : Float +TX0 : 0 +PRE c(-1) mA : -1 MAIN c( 0) mA : 15 -POST c(+1) mA : 4 +POST c(+1) mA : 4 DC Amplitude(mV): 500 De-Emphasis(dB) : -6.02 -Comment : +Comment : Output De-Emphasis Re-Driver Mode Settings -Mode State : 2 -DE State : 3 -TX1 : Float -TX0 : 0 -Frequency(Gbps) : 10.3125 +Mode State : 2 +DE State : 3 +TX1 : Float +TX0 : 0 +Frequency(Gbps) : 10.3125 DC Amplitude(mV): 600 -De-Emphasis(dB) : 4 +De-Emphasis(dB) : 4 Comment : 10GbE @@ -181,10 +181,10 @@ Page Reg Position Mask val RegFieldName 0x00 0x97 b09 0x0200 1 PD_OD 0x00 0xA0 b11 0x0800 1 PD_LOS 0x00 0xA4 b15 0x8000 1 PD_CH -0x00 0xB5 b07 0x0080 1 PD_INBUF -0x00 0xB9 b15 0x8000 1 ASYN_SYNN +0x00 0xB5 b07 0x0080 1 PD_INBUF +0x00 0xB9 b15 0x8000 1 ASYN_SYNN 0x00 0xB9 b09 0x0200 1 PD_OD -0x00 0xBF b07 0x0080 1 PD_INBUF +0x00 0xBF b07 0x0080 1 PD_INBUF 0x00 0xF0 b15 0x8000 1 ASYN_SYNN 0x00 0xF0 b09 0x0200 1 PD_OD 0x00 0xF6 b07 0x0080 1 PD_INBUF diff --git a/src/vendorcode/cavium/bdk/libdram/dram-init-ddr3.c b/src/vendorcode/cavium/bdk/libdram/dram-init-ddr3.c index 3a6d5abb14..306678759d 100644 --- a/src/vendorcode/cavium/bdk/libdram/dram-init-ddr3.c +++ b/src/vendorcode/cavium/bdk/libdram/dram-init-ddr3.c @@ -80,7 +80,7 @@ #define USE_ORIG_TEST_DRAM_BYTE 1 // collect and print LMC utilization using SWL software algorithm -#define ENABLE_SW_WLEVEL_UTILIZATION 0 +#define ENABLE_SW_WLEVEL_UTILIZATION 0 #define COUNT_RL_CANDIDATES 1 @@ -224,7 +224,7 @@ change_wr_deskew_ena(bdk_node_t node, int ddr_interface_num, int new_state) { bdk_lmcx_dll_ctl3_t ddr_dll_ctl3; int saved_wr_deskew_ena; - + // return original WR_DESKEW_ENA setting ddr_dll_ctl3.u = BDK_CSR_READ(node, BDK_LMCX_DLL_CTL3(ddr_interface_num)); saved_wr_deskew_ena = !!GET_DDR_DLL_CTL3(wr_deskew_ena); @@ -270,15 +270,15 @@ Validate_Read_Deskew_Training(bdk_node_t node, int rank_mask, int ddr_interface_ uint64_t bl_mask[2]; // enough for 128 values int bit_values; #endif - deskew_data_t dskdat; + deskew_data_t dskdat; int bit_index; int16_t flags, deskew; const char *fc = " ?-=+*#&"; int saved_wr_deskew_ena; int bit_last; - + // save original WR_DESKEW_ENA setting, and disable it for read deskew - saved_wr_deskew_ena = change_wr_deskew_ena(node, ddr_interface_num, 0); + saved_wr_deskew_ena = change_wr_deskew_ena(node, ddr_interface_num, 0); lmc_config.u = BDK_CSR_READ(node, BDK_LMCX_CONFIG(ddr_interface_num)); byte_limit = ((!lmc_config.s.mode32b) ? 8 : 4) + lmc_config.s.ecc_ena; @@ -407,7 +407,7 @@ Validate_Read_Deskew_Training(bdk_node_t node, int rank_mask, int ddr_interface_ // just for completeness, allow print of the stuck values bitmask after the bytelane print if ((bit_values < 3) && print_enable) { VB_PRT(VBL_DEV, "N%d.LMC%d: Deskew byte %d STUCK on value 0x%016lx.%016lx\n", - node, ddr_interface_num, byte_lane, + node, ddr_interface_num, byte_lane, bl_mask[1], bl_mask[0]); } #endif @@ -415,7 +415,7 @@ Validate_Read_Deskew_Training(bdk_node_t node, int rank_mask, int ddr_interface_ } /* for (byte_lane = 0; byte_lane < byte_limit; byte_lane++) */ // restore original WR_DESKEW_ENA setting - change_wr_deskew_ena(node, ddr_interface_num, saved_wr_deskew_ena); + change_wr_deskew_ena(node, ddr_interface_num, saved_wr_deskew_ena); return; } @@ -433,13 +433,13 @@ unsigned short load_dac_override(int node, int ddr_interface_num, ddr_dll_ctl3.s.bit_select = 0x9; /* No-op */ DRAM_CSR_WRITE(node, BDK_LMCX_DLL_CTL3(ddr_interface_num), ddr_dll_ctl3.u); - + ddr_dll_ctl3.s.bit_select = 0xC; /* Vref bypass setting load */ DRAM_CSR_WRITE(node, BDK_LMCX_DLL_CTL3(ddr_interface_num), ddr_dll_ctl3.u); - + ddr_dll_ctl3.s.bit_select = 0xD; /* Vref bypass on. */ DRAM_CSR_WRITE(node, BDK_LMCX_DLL_CTL3(ddr_interface_num), ddr_dll_ctl3.u); - + ddr_dll_ctl3.s.bit_select = 0x9; /* No-op */ DRAM_CSR_WRITE(node, BDK_LMCX_DLL_CTL3(ddr_interface_num), ddr_dll_ctl3.u); @@ -545,9 +545,9 @@ Perform_Offset_Training(bdk_node_t node, int rank_mask, int ddr_interface_num) /* * 6.9.8 LMC Offset Training - * + * * LMC requires input-receiver offset training. - * + * * 1. Write LMC(0)_PHY_CTL[DAC_ON] = 1 */ lmc_phy_ctl.u = BDK_CSR_READ(node, BDK_LMCX_PHY_CTL(ddr_interface_num)); @@ -576,7 +576,7 @@ Perform_Offset_Training(bdk_node_t node, int rank_mask, int ddr_interface_num) /* * 2. Write LMC(0)_SEQ_CTL[SEQ_SEL] = 0x0B and * LMC(0)_SEQ_CTL[INIT_START] = 1. - * + * * 3. Wait for LMC(0)_SEQ_CTL[SEQ_COMPLETE] to be set to 1. */ perform_octeon3_ddr3_sequence(node, rank_mask, ddr_interface_num, 0x0B); /* Offset training sequence */ @@ -590,9 +590,9 @@ Perform_Internal_VREF_Training(bdk_node_t node, int rank_mask, int ddr_interface /* * 6.9.9 LMC Internal Vref Training - * + * * LMC requires input-reference-voltage training. - * + * * 1. Write LMC(0)_EXT_CONFIG[VREFINT_SEQ_DESKEW] = 0. */ ext_config.u = BDK_CSR_READ(node, BDK_LMCX_EXT_CONFIG(ddr_interface_num)); @@ -606,7 +606,7 @@ Perform_Internal_VREF_Training(bdk_node_t node, int rank_mask, int ddr_interface /* * 2. Write LMC(0)_SEQ_CTL[SEQ_SEL] = 0x0a and * LMC(0)_SEQ_CTL[INIT_START] = 1. - * + * * 3. Wait for LMC(0)_SEQ_CTL[SEQ_COMPLETE] to be set to 1. */ perform_octeon3_ddr3_sequence(node, rank_mask, ddr_interface_num, 0x0A); /* LMC Internal Vref Training */ @@ -646,7 +646,7 @@ process_samples_average(int16_t *bytes, int num_samples, int lmc, int lane_no) ret = trunc; else if (sadj & 1) ret = sadj; - else + else ret = trunc + 1; dbg_avg(" -> %3d\n", ret); @@ -678,7 +678,7 @@ Perform_Read_Deskew_Training(bdk_node_t node, int rank_mask, int ddr_interface_n VB_PRT(VBL_FAE, "N%d.LMC%d: Performing Read Deskew Training.\n", node, ddr_interface_num); // save original WR_DESKEW_ENA setting, and disable it for read deskew - saved_wr_deskew_ena = change_wr_deskew_ena(node, ddr_interface_num, 0); + saved_wr_deskew_ena = change_wr_deskew_ena(node, ddr_interface_num, 0); sat_retries = 0; lock_retries_total = 0; @@ -718,9 +718,9 @@ Perform_Read_Deskew_Training(bdk_node_t node, int rank_mask, int ddr_interface_n /* * 6.9.10 LMC Deskew Training - * + * * LMC requires input-read-data deskew training. - * + * * 1. Write LMC(0)_EXT_CONFIG[VREFINT_SEQ_DESKEW] = 1. */ VB_PRT(VBL_SEQ, "N%d.LMC%d: Performing LMC sequence: Set vrefint_seq_deskew = 1\n", @@ -731,7 +731,7 @@ Perform_Read_Deskew_Training(bdk_node_t node, int rank_mask, int ddr_interface_n /* * 2. Write LMC(0)_SEQ_CTL[SEQ_SEL] = 0x0A and * LMC(0)_SEQ_CTL[INIT_START] = 1. - * + * * 3. Wait for LMC(0)_SEQ_CTL[SEQ_COMPLETE] to be set to 1. */ DRAM_CSR_MODIFY(phy_ctl, node, BDK_LMCX_PHY_CTL(ddr_interface_num), @@ -742,7 +742,7 @@ Perform_Read_Deskew_Training(bdk_node_t node, int rank_mask, int ddr_interface_n perform_read_deskew_training: // maybe perform the NORMAL deskew training sequence multiple times before looking at lock status - for (loops = 0; loops < normal_loops; loops++) { + for (loops = 0; loops < normal_loops; loops++) { DRAM_CSR_MODIFY(phy_ctl, node, BDK_LMCX_PHY_CTL(ddr_interface_num), phy_ctl.s.phy_dsk_reset = 0); /* Normal Deskew sequence */ perform_octeon3_ddr3_sequence(node, rank_mask, ddr_interface_num, 0x0A); /* LMC Deskew Training */ @@ -823,7 +823,7 @@ Perform_Read_Deskew_Training(bdk_node_t node, int rank_mask, int ddr_interface_n sat_retries-1, lock_retries_total); // restore original WR_DESKEW_ENA setting - change_wr_deskew_ena(node, ddr_interface_num, saved_wr_deskew_ena); + change_wr_deskew_ena(node, ddr_interface_num, saved_wr_deskew_ena); if ((dsk_counts.nibrng_errs != 0) || (dsk_counts.nibunl_errs != 0)) { debug_print("N%d.LMC%d: NIBBLE ERROR(S) found, returning FAULT\n", @@ -831,7 +831,7 @@ Perform_Read_Deskew_Training(bdk_node_t node, int rank_mask, int ddr_interface_n return -1; // we did retry locally, they did not help } - // NOTE: we (currently) always print one last training validation before starting Read Leveling... + // NOTE: we (currently) always print one last training validation before starting Read Leveling... return 0; } @@ -907,7 +907,7 @@ Set_Write_Deskew_Settings(bdk_node_t node, int ddr_interface_num, int value) VB_PRT(VBL_DEV2, "N%d.LMC%d: SetWriteDeskew: WRITE %d\n", node, ddr_interface_num, value); for (bit_num = 0; bit_num <= 7; ++bit_num) { - + // write a bit-deskew value to all bit-lanes of all bytes ddr_dll_ctl3.u = BDK_CSR_READ(node, BDK_LMCX_DLL_CTL3(ddr_interface_num)); SET_DDR_DLL_CTL3(bit_select, bit_num); @@ -949,13 +949,13 @@ Neutral_Write_Deskew_Setup(bdk_node_t node, int ddr_interface_num) { // first: NO-OP, Select all bytes, Disable write bit-deskew ddr_print("N%d.LMC%d: NEUTRAL Write Deskew Setup: first: NOOP\n", node, ddr_interface_num); - do_write_deskew_op(node, ddr_interface_num, BS_NOOP, ALL_BYTES, 0); + do_write_deskew_op(node, ddr_interface_num, BS_NOOP, ALL_BYTES, 0); //Get_Deskew_Settings(node, ddr_interface_num, &dskdat); //Display_Deskew_Data(node, ddr_interface_num, &dskdat, VBL_NORM); // enable write bit-deskew and RESET the settings ddr_print("N%d.LMC%d: NEUTRAL Write Deskew Setup: wr_ena: RESET\n", node, ddr_interface_num); - do_write_deskew_op(node, ddr_interface_num, BS_RESET, ALL_BYTES, 1); + do_write_deskew_op(node, ddr_interface_num, BS_RESET, ALL_BYTES, 1); //Get_Deskew_Settings(node, ddr_interface_num, &dskdat); //Display_Deskew_Data(node, ddr_interface_num, &dskdat, VBL_NORM); } @@ -982,20 +982,20 @@ Perform_Write_Deskew_Training(bdk_node_t node, int ddr_interface_num) // first: NO-OP, Select all bytes, Disable write bit-deskew ddr_print("N%d.LMC%d: WriteDeskewConfig: first: NOOP\n", node, ddr_interface_num); - do_write_deskew_op(node, ddr_interface_num, BS_NOOP, ALL_BYTES, 0); + do_write_deskew_op(node, ddr_interface_num, BS_NOOP, ALL_BYTES, 0); //Get_Deskew_Settings(node, ddr_interface_num, &dskdat); //Display_Deskew_Data(node, ddr_interface_num, &dskdat, VBL_NORM); // enable write bit-deskew and RESET the settings ddr_print("N%d.LMC%d: WriteDeskewConfig: wr_ena: RESET\n", node, ddr_interface_num); - do_write_deskew_op(node, ddr_interface_num, BS_RESET, ALL_BYTES, 1); + do_write_deskew_op(node, ddr_interface_num, BS_RESET, ALL_BYTES, 1); //Get_Deskew_Settings(node, ddr_interface_num, &dskdat); //Display_Deskew_Data(node, ddr_interface_num, &dskdat, VBL_NORM); #if 0 // enable write bit-deskew and REUSE read bit-deskew settings ddr_print("N%d.LMC%d: WriteDeskewConfig: wr_ena: REUSE\n", node, ddr_interface_num); - do_write_deskew_op(node, ddr_interface_num, BS_REUSE, ALL_BYTES, 1); + do_write_deskew_op(node, ddr_interface_num, BS_REUSE, ALL_BYTES, 1); Get_Deskew_Settings(node, ddr_interface_num, &dskdat); Display_Deskew_Data(node, ddr_interface_num, &dskdat, VBL_NORM); #endif @@ -1107,7 +1107,7 @@ Perform_Write_Deskew_Training(bdk_node_t node, int ddr_interface_num) // last: NO-OP, Select all bytes, MUST leave write bit-deskew enabled ddr_print("N%d.LMC%d: WriteDeskewConfig: last: wr_ena: NOOP\n", node, ddr_interface_num); - do_write_deskew_op(node, ddr_interface_num, BS_NOOP, ALL_BYTES, 1); + do_write_deskew_op(node, ddr_interface_num, BS_NOOP, ALL_BYTES, 1); //Get_Deskew_Settings(node, ddr_interface_num, &dskdat); //Display_Deskew_Data(node, ddr_interface_num, &dskdat, VBL_NORM); @@ -1115,7 +1115,7 @@ Perform_Write_Deskew_Training(bdk_node_t node, int ddr_interface_num) // FIXME: disable/delete this when write bit-deskew works... // final: NO-OP, Select all bytes, do NOT leave write bit-deskew enabled ddr_print("N%d.LMC%d: WriteDeskewConfig: final: read: NOOP\n", node, ddr_interface_num); - do_write_deskew_op(node, ddr_interface_num, BS_NOOP, ALL_BYTES, 0); + do_write_deskew_op(node, ddr_interface_num, BS_NOOP, ALL_BYTES, 0); Get_Deskew_Settings(node, ddr_interface_num, &dskdat); Display_Deskew_Data(node, ddr_interface_num, &dskdat, VBL_NORM); #endif @@ -1291,7 +1291,7 @@ compute_vref_value(bdk_node_t node, int ddr_interface_num, BDK_CSR_INIT(lmc_config, node, BDK_LMCX_CONFIG(ddr_interface_num)); /* New computed Vref = existing computed Vref – X - + The value of X is depending on different conditions. Both #122 and #139 are 2Rx4 RDIMM, while #124 is stacked die 2Rx4, so I conclude the results into two conditions: @@ -1315,7 +1315,7 @@ compute_vref_value(bdk_node_t node, int ddr_interface_num, } // we have adjusted it, so print it out if verbosity is right VB_PRT(VBL_TME, "N%d.LMC%d.R%d: adjusting computed vref from %2d (0x%02x) to %2d (0x%02x)\n", - node, ddr_interface_num, rankx, + node, ddr_interface_num, rankx, saved_final_vref_value, saved_final_vref_value, computed_final_vref_value, computed_final_vref_value); } @@ -1505,7 +1505,7 @@ validate_ddr3_rlevel_bitmask(rlevel_bitmask_t *rlevel_bitmask_p, int ddr_type) extras++; // count the number of extra bits } } - + /* Penalize any extra 1's beyond the maximum desired mask */ if (extras > 0) toolong = RLEVEL_BITMASK_TOOLONG_ERROR * ((1 << extras) - 1); @@ -1634,13 +1634,13 @@ Validate_HW_WL_Settings(bdk_node_t node, int ddr_interface_num, { int wl[9], byte, errors; - // arrange the sequences so + // arrange the sequences so int useq[] = { 0,1,2,3,8,4,5,6,7,-1 }; // index 0 has byte 0, etc, ECC in middle int rseq1[] = { 8,3,2,1,0,-1 }; // index 0 is ECC, then go down int rseq2[] = { 4,5,6,7,-1 }; // index 0 has byte 4, then go up int useqno[] = { 0,1,2,3,4,5,6,7,-1 }; // index 0 has byte 0, etc, no ECC int rseq1no[] = { 3,2,1,0,-1 }; // index 0 is byte 3, then go down, no ECC - + // in the CSR, bytes 0-7 are always data, byte 8 is ECC for (byte = 0; byte < 8+ecc_ena; byte++) { wl[byte] = (get_wlevel_rank_struct(lmc_wlevel_rank, byte) >> 1) & 3; // preprocess :-) @@ -1683,7 +1683,7 @@ static int get_rlevel_rank_struct(bdk_lmcx_rlevel_rankx_t *lmc_rlevel_rank, } #endif -static void unpack_rlevel_settings(int ddr_interface_bytemask, int ecc_ena, +static void unpack_rlevel_settings(int ddr_interface_bytemask, int ecc_ena, rlevel_byte_data_t *rlevel_byte, bdk_lmcx_rlevel_rankx_t lmc_rlevel_rank) { @@ -1713,11 +1713,11 @@ static void unpack_rlevel_settings(int ddr_interface_bytemask, int ecc_ena, rlevel_byte[0].delay = lmc_rlevel_rank.cn83xx.byte0; } -static void pack_rlevel_settings(int ddr_interface_bytemask, int ecc_ena, +static void pack_rlevel_settings(int ddr_interface_bytemask, int ecc_ena, rlevel_byte_data_t *rlevel_byte, bdk_lmcx_rlevel_rankx_t *final_rlevel_rank) { - bdk_lmcx_rlevel_rankx_t lmc_rlevel_rank = *final_rlevel_rank; + bdk_lmcx_rlevel_rankx_t lmc_rlevel_rank = *final_rlevel_rank; if ((ddr_interface_bytemask & 0xff) == 0xff) { if (ecc_ena) { @@ -1808,7 +1808,7 @@ static int nonsequential_delays(rlevel_byte_data_t *rlevel_byte, } delay_inc = _abs(delay_diff); // how big was the delay change, if any - + /* Even if the trend did not change to the opposite direction, check for the magnitude of the change, and scale the penalty by the amount that the size is larger than the provided limit. @@ -1954,9 +1954,9 @@ display_RL_with_computed(bdk_node_t node, int ddr_interface_num, bdk_lmcx_rlevel // control #define SKIP_SKIPPING 1 -static const char *with_rodt_canned_msgs[4] = { " ", "SKIPPING ", "BEST ROW ", "BEST SCORE" }; +static const char *with_rodt_canned_msgs[4] = { " ", "SKIPPING ", "BEST ROW ", "BEST SCORE" }; -static void display_RL_with_RODT(bdk_node_t node, int ddr_interface_num, +static void display_RL_with_RODT(bdk_node_t node, int ddr_interface_num, bdk_lmcx_rlevel_rankx_t lmc_rlevel_rank, int rank, int score, int nom_ohms, int rodt_ohms, int flag) { @@ -1969,9 +1969,9 @@ static void display_RL_with_RODT(bdk_node_t node, int ddr_interface_num, if (nom_ohms < 0) { snprintf(set_buf, sizeof(set_buf), " RODT %3d ", rodt_ohms); } else { - snprintf(set_buf, sizeof(set_buf), "NOM %3d RODT %3d", nom_ohms, rodt_ohms); + snprintf(set_buf, sizeof(set_buf), "NOM %3d RODT %3d", nom_ohms, rodt_ohms); } - + VB_PRT(VBL_TME, "N%d.LMC%d.R%d: Rlevel %s %s : %5d %5d %5d %5d %5d %5d %5d %5d %5d (%d)\n", node, ddr_interface_num, rank, set_buf, msg_buf, @@ -2249,7 +2249,7 @@ void perform_octeon3_ddr3_sequence(bdk_node_t node, int rank_mask, int ddr_inter * LMC(0)_SEQ_CTL[SEQ_SEL,INIT_START] = 1 with a single CSR write * operation. LMC(0)_CONFIG[RANKMASK] bits should be set to indicate * the ranks that will participate in the sequence. - * + * * The LMC(0)_SEQ_CTL[SEQ_SEL] value should select power-up/init or * selfrefresh exit, depending on whether the DRAM parts are in * self-refresh and whether their contents should be preserved. While @@ -2257,7 +2257,7 @@ void perform_octeon3_ddr3_sequence(bdk_node_t node, int rank_mask, int ddr_inter * transactions. When the sequence is complete, hardware sets the * LMC(0)_CONFIG[INIT_STATUS] bits for the ranks that have been * initialized. - * + * * If power-up/init is selected immediately following a DRESET * assertion, LMC executes the sequence described in the "Reset and * Initialization Procedure" section of the JEDEC DDR3 @@ -2270,16 +2270,16 @@ void perform_octeon3_ddr3_sequence(bdk_node_t node, int rank_mask, int ddr_inter * the first DDR3 mode register write operation. * LMC(0)_DIMM_CTL[DIMM*_WMASK] should be cleared to 0 if the * corresponding DIMM is not present. - * + * * If self-refresh exit is selected, LMC executes the required SRX * command followed by a refresh and ZQ calibration. Section 4.5 * describes behavior of a REF + ZQCS. LMC does not write the DDR3 * mode registers as part of this sequence, and the mode register * parameters must match at self-refresh entry and exit times. - * + * * 4. Read LMC(0)_SEQ_CTL and wait for LMC(0)_SEQ_CTL[SEQ_COMPLETE] to be * set. - * + * * 5. Read LMC(0)_CONFIG[INIT_STATUS] and confirm that all ranks have * been initialized. */ @@ -2351,8 +2351,8 @@ void ddr4_mrw(bdk_node_t node, int ddr_interface_num, int rank, lmc_mr_mpr_ctl.s.mr_wr_rank = rank; //lmc_mr_mpr_ctl.s.mr_wr_pda_mask = //lmc_mr_mpr_ctl.s.mr_wr_pda_enable = - //lmc_mr_mpr_ctl.s.mpr_loc = - //lmc_mr_mpr_ctl.s.mpr_wr = + //lmc_mr_mpr_ctl.s.mpr_loc = + //lmc_mr_mpr_ctl.s.mpr_wr = //lmc_mr_mpr_ctl.s.mpr_bit_select = //lmc_mr_mpr_ctl.s.mpr_byte_select = //lmc_mr_mpr_ctl.s.mpr_whole_byte_enable = @@ -3032,7 +3032,7 @@ int init_octeon3_ddr3_interface(bdk_node_t node, if ((s = lookup_env_parameter("ddr_deskew_validation_delay")) != NULL) { deskew_validation_delay = strtoul(s, NULL, 0); } - // this one is in Perform_Read_Deskew_Training and controls lock retries + // this one is in Perform_Read_Deskew_Training and controls lock retries if ((s = lookup_env_parameter("ddr_lock_retries")) != NULL) { default_lock_retry_limit = strtoul(s, NULL, 0); } @@ -3164,7 +3164,7 @@ int init_octeon3_ddr3_interface(bdk_node_t node, // FIXME: print non-zero monolithic device definition ddr_print("DDR4: Package Type MONOLITHIC: %d die, signal load %d\n", ((spd_package >> 4) & 7) + 1, (spd_package & 3)); - } + } asymmetric = (spd_org >> 6) & 1; if (asymmetric) { @@ -3208,7 +3208,7 @@ int init_octeon3_ddr3_interface(bdk_node_t node, ddr_print("DDR4: RDIMM Register Manufacturer ID 0x%x Revision 0x%x\n", spd_mfgr_id, spd_register_rev); - // RAWCARD A or B must be bit 7=0 and bits 4-0 either 00000(A) or 00001(B) + // RAWCARD A or B must be bit 7=0 and bits 4-0 either 00000(A) or 00001(B) spd_rawcard_AorB = ((spd_rawcard & 0x9fUL) <= 1); } } else { @@ -3762,14 +3762,14 @@ int init_octeon3_ddr3_interface(bdk_node_t node, /* * 6.9.7 Early LMC Initialization - * + * * All of DDR PLL, LMC CK, and LMC DRESET initializations must be * completed prior to starting this LMC initialization sequence. - * + * * Perform the following five substeps for early LMC initialization: - * + * * 1. Software must ensure there are no pending DRAM transactions. - * + * * 2. Write LMC(0)_CONFIG, LMC(0)_CONTROL, LMC(0)_TIMING_PARAMS0, * LMC(0)_TIMING_PARAMS1, LMC(0)_MODEREG_PARAMS0, * LMC(0)_MODEREG_PARAMS1, LMC(0)_DUAL_MEMCFG, LMC(0)_NXM, @@ -5073,7 +5073,7 @@ int init_octeon3_ddr3_interface(bdk_node_t node, perform_internal_vref_training: - for (sample = 0; sample < num_samples; sample++) { + for (sample = 0; sample < num_samples; sample++) { dac_eval_retries = 0; @@ -5265,48 +5265,48 @@ int init_octeon3_ddr3_interface(bdk_node_t node, /* * 6.9.11 LMC Write Leveling - * + * * LMC supports an automatic write leveling like that described in the * JEDEC DDR3 specifications separately per byte-lane. - * + * * All of DDR PLL, LMC CK, LMC DRESET, and early LMC initializations must * be completed prior to starting this LMC write-leveling sequence. - * + * * There are many possible procedures that will write-level all the * attached DDR3 DRAM parts. One possibility is for software to simply * write the desired values into LMC(0)_WLEVEL_RANK(0..3). This section * describes one possible sequence that uses LMC's autowrite-leveling * capabilities. - * + * * 1. If the DQS/DQ delays on the board may be more than the ADD/CMD * delays, then ensure that LMC(0)_CONFIG[EARLY_DQX] is set at this * point. - * + * * Do the remaining steps 2-7 separately for each rank i with attached * DRAM. - * + * * 2. Write LMC(0)_WLEVEL_RANKi = 0. - * + * * 3. For ×8 parts: - * + * * Without changing any other fields in LMC(0)_WLEVEL_CTL, write * LMC(0)_WLEVEL_CTL[LANEMASK] to select all byte lanes with attached * DRAM. - * + * * For ×16 parts: - * + * * Without changing any other fields in LMC(0)_WLEVEL_CTL, write * LMC(0)_WLEVEL_CTL[LANEMASK] to select all even byte lanes with * attached DRAM. - * + * * 4. Without changing any other fields in LMC(0)_CONFIG, - * + * * o write LMC(0)_SEQ_CTL[SEQ_SEL] to select write-leveling - * + * * o write LMC(0)_CONFIG[RANKMASK] = (1 << i) - * + * * o write LMC(0)_SEQ_CTL[INIT_START] = 1 - * + * * LMC will initiate write-leveling at this point. Assuming * LMC(0)_WLEVEL_CTL [SSET] = 0, LMC first enables write-leveling on * the selected DRAM rank via a DDR3 MR1 write, then sequences through @@ -5315,17 +5315,17 @@ int init_octeon3_ddr3_interface(bdk_node_t node, * LMC(0)_WLEVEL_RANKi[BYTE*<4:3>] = 0, increasing by 1/8 CK each * setting, covering a total distance of one CK, then disables the * write-leveling via another DDR3 MR1 write. - * + * * After the sequence through 16 delay settings is complete: - * + * * o LMC sets LMC(0)_WLEVEL_RANKi[STATUS] = 3 - * + * * o LMC sets LMC(0)_WLEVEL_RANKi[BYTE*<2:0>] (for all ranks selected * by LMC(0)_WLEVEL_CTL[LANEMASK]) to indicate the first write * leveling result of 1 that followed result of 0 during the * sequence, except that the LMC always writes * LMC(0)_WLEVEL_RANKi[BYTE*<0>]=0. - * + * * o Software can read the eight write-leveling results from the first * pass through the delay settings by reading * LMC(0)_WLEVEL_DBG[BITMASK] (after writing @@ -5333,66 +5333,66 @@ int init_octeon3_ddr3_interface(bdk_node_t node, * results from the second pass through the eight delay * settings. They should often be identical to the * LMC(0)_WLEVEL_DBG[BITMASK] results, though.) - * + * * 5. Wait until LMC(0)_WLEVEL_RANKi[STATUS] != 2. - * + * * LMC will have updated LMC(0)_WLEVEL_RANKi[BYTE*<2:0>] for all byte * lanes selected by LMC(0)_WLEVEL_CTL[LANEMASK] at this point. * LMC(0)_WLEVEL_RANKi[BYTE*<4:3>] will still be the value that * software wrote in substep 2 above, which is 0. - * + * * 6. For ×16 parts: - * + * * Without changing any other fields in LMC(0)_WLEVEL_CTL, write * LMC(0)_WLEVEL_CTL[LANEMASK] to select all odd byte lanes with * attached DRAM. - * + * * Repeat substeps 4 and 5 with this new LMC(0)_WLEVEL_CTL[LANEMASK] * setting. Skip to substep 7 if this has already been done. - * + * * For ×8 parts: - * + * * Skip this substep. Go to substep 7. - * + * * 7. Calculate LMC(0)_WLEVEL_RANKi[BYTE*<4:3>] settings for all byte * lanes on all ranks with attached DRAM. - * + * * At this point, all byte lanes on rank i with attached DRAM should * have been write-leveled, and LMC(0)_WLEVEL_RANKi[BYTE*<2:0>] has * the result for each byte lane. - * + * * But note that the DDR3 write-leveling sequence will only determine * the delay modulo the CK cycle time, and cannot determine how many * additional CK cycles of delay are present. Software must calculate * the number of CK cycles, or equivalently, the * LMC(0)_WLEVEL_RANKi[BYTE*<4:3>] settings. - * + * * This BYTE*<4:3> calculation is system/board specific. - * + * * Many techniques can be used to calculate write-leveling BYTE*<4:3> values, * including: - * + * * o Known values for some byte lanes. - * + * * o Relative values for some byte lanes relative to others. - * + * * For example, suppose lane X is likely to require a larger * write-leveling delay than lane Y. A BYTEX<2:0> value that is much * smaller than the BYTEY<2:0> value may then indicate that the * required lane X delay wrapped into the next CK, so BYTEX<4:3> * should be set to BYTEY<4:3>+1. - * + * * When ECC DRAM is not present (i.e. when DRAM is not attached to the * DDR_CBS_0_* and DDR_CB<7:0> chip signals, or the DDR_DQS_<4>_* and * DDR_DQ<35:32> chip signals), write LMC(0)_WLEVEL_RANK*[BYTE8] = * LMC(0)_WLEVEL_RANK*[BYTE0], using the final calculated BYTE0 value. * Write LMC(0)_WLEVEL_RANK*[BYTE4] = LMC(0)_WLEVEL_RANK*[BYTE0], * using the final calculated BYTE0 value. - * + * * 8. Initialize LMC(0)_WLEVEL_RANK* values for all unused ranks. - * + * * Let rank i be a rank with attached DRAM. - * + * * For all ranks j that do not have attached DRAM, set * LMC(0)_WLEVEL_RANKj = LMC(0)_WLEVEL_RANKi. */ @@ -5794,18 +5794,18 @@ int init_octeon3_ddr3_interface(bdk_node_t node, /* * 6.9.12 LMC Read Leveling - * + * * LMC supports an automatic read-leveling separately per byte-lane using * the DDR3 multipurpose register predefined pattern for system * calibration defined in the JEDEC DDR3 specifications. - * + * * All of DDR PLL, LMC CK, and LMC DRESET, and early LMC initializations * must be completed prior to starting this LMC read-leveling sequence. - * + * * Software could simply write the desired read-leveling values into * LMC(0)_RLEVEL_RANK(0..3). This section describes a sequence that uses * LMC's autoread-leveling capabilities. - * + * * When LMC does the read-leveling sequence for a rank, it first enables * the DDR3 multipurpose register predefined pattern for system * calibration on the selected DRAM rank via a DDR3 MR3 write, then @@ -5814,13 +5814,13 @@ int init_octeon3_ddr3_interface(bdk_node_t node, * operation. LMC determines the pass or fail of each of the 64 settings * independently for each byte lane, then writes appropriate * LMC(0)_RLEVEL_RANK(0..3)[BYTE*] values for the rank. - * + * * After read-leveling for a rank, software can read the 64 pass/fail * indications for one byte lane via LMC(0)_RLEVEL_DBG[BITMASK]. Software * can observe all pass/fail results for all byte lanes in a rank via * separate read-leveling sequences on the rank with different * LMC(0)_RLEVEL_CTL[BYTE] values. - * + * * The 64 pass/fail results will typically have failures for the low * delays, followed by a run of some passing settings, followed by more * failures in the remaining high delays. LMC sets @@ -5834,46 +5834,46 @@ int init_octeon3_ddr3_interface(bdk_node_t node, * the run (rounding earlier when necessary). We expect the read-leveling * sequence to produce good results with the reset values * LMC(0)_RLEVEL_CTL [OFFSET_EN]=1, LMC(0)_RLEVEL_CTL[OFFSET] = 2. - * + * * The read-leveling sequence has the following steps: - * + * * 1. Select desired LMC(0)_RLEVEL_CTL[OFFSET_EN,OFFSET,BYTE] settings. * Do the remaining substeps 2-4 separately for each rank i with * attached DRAM. - * + * * 2. Without changing any other fields in LMC(0)_CONFIG, - * + * * o write LMC(0)_SEQ_CTL[SEQ_SEL] to select read-leveling - * + * * o write LMC(0)_CONFIG[RANKMASK] = (1 << i) - * + * * o write LMC(0)_SEQ_CTL[INIT_START] = 1 - * + * * This initiates the previously-described read-leveling. - * + * * 3. Wait until LMC(0)_RLEVEL_RANKi[STATUS] != 2 - * + * * LMC will have updated LMC(0)_RLEVEL_RANKi[BYTE*] for all byte lanes * at this point. - * + * * If ECC DRAM is not present (i.e. when DRAM is not attached to the * DDR_CBS_0_* and DDR_CB<7:0> chip signals, or the DDR_DQS_<4>_* and * DDR_DQ<35:32> chip signals), write LMC(0)_RLEVEL_RANK*[BYTE8] = * LMC(0)_RLEVEL_RANK*[BYTE0]. Write LMC(0)_RLEVEL_RANK*[BYTE4] = * LMC(0)_RLEVEL_RANK*[BYTE0]. - * + * * 4. If desired, consult LMC(0)_RLEVEL_DBG[BITMASK] and compare to * LMC(0)_RLEVEL_RANKi[BYTE*] for the lane selected by * LMC(0)_RLEVEL_CTL[BYTE]. If desired, modify LMC(0)_RLEVEL_CTL[BYTE] * to a new value and repeat so that all BITMASKs can be observed. - * + * * 5. Initialize LMC(0)_RLEVEL_RANK* values for all unused ranks. - * + * * Let rank i be a rank with attached DRAM. - * + * * For all ranks j that do not have attached DRAM, set * LMC(0)_RLEVEL_RANKj = LMC(0)_RLEVEL_RANKi. - * + * * This read-leveling sequence can help select the proper CN70XX ODT * resistance value (LMC(0)_COMP_CTL2[RODT_CTL]). A hardware-generated * LMC(0)_RLEVEL_RANKi[BYTEj] value (for a used byte lane j) that is @@ -6083,7 +6083,7 @@ int init_octeon3_ddr3_interface(bdk_node_t node, i = 0; while (custom_lmc_config->rlevel_table[i].part != NULL) { debug_print("DIMM part number:\"%s\", SPD: \"%s\"\n", custom_lmc_config->rlevel_table[i].part, part_number); - if ((strcmp(part_number, custom_lmc_config->rlevel_table[i].part) == 0) + if ((strcmp(part_number, custom_lmc_config->rlevel_table[i].part) == 0) && (_abs(custom_lmc_config->rlevel_table[i].speed - 2*ddr_hertz/(1000*1000)) < 10 )) { ddr_print("Using hard-coded read leveling for DIMM part number: \"%s\"\n", part_number); @@ -6290,7 +6290,7 @@ int init_octeon3_ddr3_interface(bdk_node_t node, rlevel_bitmask[7].bm = octeon_read_lmcx_ddr3_rlevel_dbg(node, ddr_interface_num, 7); /* B-side complete */ - + update_rlevel_rank_struct(&lmc_rlevel_rank, 0, lmc_rlevel_rank_aside.cn83xx.byte0); update_rlevel_rank_struct(&lmc_rlevel_rank, 1, lmc_rlevel_rank_aside.cn83xx.byte1); update_rlevel_rank_struct(&lmc_rlevel_rank, 2, lmc_rlevel_rank_aside.cn83xx.byte2); @@ -6390,7 +6390,7 @@ int init_octeon3_ddr3_interface(bdk_node_t node, #else rlevel_rank_errors = rlevel_bitmask_errors + rlevel_nonseq_errors; #endif - + // print original sample here only if we are not really averaging or picking best // also do not print if we were redoing the NONSEQ score for using COMPUTED if (!redoing_nonseq_errs && ((rlevel_avg_loops < 2) || dram_is_verbose(VBL_DEV2))) { @@ -6833,7 +6833,7 @@ int init_octeon3_ddr3_interface(bdk_node_t node, best_rank_ohms = next_ohms; best_rankx = orankx; lmc_rlevel_rank.u = rlevel_scoreboard[rtt_nom][rodt_ctl][orankx].setting; - + } /* for (int orankx = 0; orankx < dimm_count * 4; orankx++) */ } /* for (rodt_ctl = max_rodt_ctl; rodt_ctl >= min_rodt_ctl; --rodt_ctl) */ } /* for (rtt_idx = min_rtt_nom_idx; rtt_idx <= max_rtt_nom_idx; ++rtt_idx) */ @@ -7233,7 +7233,7 @@ int init_octeon3_ddr3_interface(bdk_node_t node, if (delay_value >= 0) { if (ties != 0) { if (ties & (1UL << (int)new_byte)) { - // leave choice as new_byte if any tied one is the same... + // leave choice as new_byte if any tied one is the same... delay_value = (int)new_byte; @@ -7251,7 +7251,7 @@ int init_octeon3_ddr3_interface(bdk_node_t node, if (delay_value != (int)new_byte) { delay_count = rank_perfect_counts[rankx].count[byte_idx][(int)new_byte]; VB_PRT(VBL_DEV, "N%d.LMC%d.R%d: PERFECT: Byte %d: DIFF from %d (%d), USING %d (%d)\n", - node, ddr_interface_num, rankx, byte_idx, (int)new_byte, + node, ddr_interface_num, rankx, byte_idx, (int)new_byte, delay_count, delay_value, delay_max); new_byte = (uint64_t)delay_value; // FIXME: make this optional via envvar? } else { @@ -7522,7 +7522,7 @@ int init_octeon3_ddr3_interface(bdk_node_t node, /* Get the measured_vref setting from the config, check for an override... */ /* NOTE: measured_vref=1 (ON) means force use of MEASURED Vref... */ - // NOTE: measured VREF can only be done for DDR4 + // NOTE: measured VREF can only be done for DDR4 if (ddr_type == DDR4_DRAM) { measured_vref_flag = custom_lmc_config->measured_vref; if ((s = lookup_env_parameter("ddr_measured_vref")) != NULL) { @@ -7650,7 +7650,7 @@ int init_octeon3_ddr3_interface(bdk_node_t node, } else { vrlo = 1; vvlo -= VREF_RANGE2_LIMIT; } - + int vvhi = best_vref_values_start + best_vref_values_count - 1; int vrhi; if (vvhi < VREF_RANGE2_LIMIT) { @@ -7678,7 +7678,7 @@ int init_octeon3_ddr3_interface(bdk_node_t node, ddr_print("N%d.LMC%d.R%d: Vref Using Default :" " %2d <----- %2d (0x%02x) -----> %2d, range%1d\n", node, ddr_interface_num, rankx, - final_vref_value, final_vref_value, + final_vref_value, final_vref_value, final_vref_value, final_vref_value, final_vref_range+1); } } @@ -7890,7 +7890,7 @@ int init_octeon3_ddr3_interface(bdk_node_t node, if (!measured_vref_flag) { test_byte8 &= ~1; /* Use only even settings, rounding down... */ - // do validity check on the calculated ECC delay value + // do validity check on the calculated ECC delay value // this depends on the DIMM type if (spd_rdimm) { // RDIMM if (spd_dimm_type != 5) { // but not mini-RDIMM @@ -8155,7 +8155,7 @@ int init_octeon3_ddr3_interface(bdk_node_t node, // do the test if (sw_wlevel_hw) { - errors = run_best_hw_patterns(node, ddr_interface_num, rank_addr, + errors = run_best_hw_patterns(node, ddr_interface_num, rank_addr, DBTRAIN_TEST, NULL) & 0x0ff; } else { #if USE_ORIG_TEST_DRAM_BYTE @@ -8323,7 +8323,7 @@ int init_octeon3_ddr3_interface(bdk_node_t node, process_custom_dll_offsets(node, ddr_interface_num, "ddr_dll_write_offset", custom_lmc_config->dll_write_offset, "ddr%d_dll_write_offset_byte%d", 1); - process_custom_dll_offsets(node, ddr_interface_num, "ddr_dll_read_offset", + process_custom_dll_offsets(node, ddr_interface_num, "ddr_dll_read_offset", custom_lmc_config->dll_read_offset, "ddr%d_dll_read_offset_byte%d", 2); // we want to train write bit-deskew here... @@ -8337,29 +8337,29 @@ int init_octeon3_ddr3_interface(bdk_node_t node, /* * 6.9.14 Final LMC Initialization - * + * * Early LMC initialization, LMC write-leveling, and LMC read-leveling * must be completed prior to starting this final LMC initialization. - * + * * LMC hardware updates the LMC(0)_SLOT_CTL0, LMC(0)_SLOT_CTL1, * LMC(0)_SLOT_CTL2 CSRs with minimum values based on the selected * readleveling and write-leveling settings. Software should not write * the final LMC(0)_SLOT_CTL0, LMC(0)_SLOT_CTL1, and LMC(0)_SLOT_CTL2 * values until after the final read-leveling and write-leveling settings * are written. - * + * * Software must ensure the LMC(0)_SLOT_CTL0, LMC(0)_SLOT_CTL1, and * LMC(0)_SLOT_CTL2 CSR values are appropriate for this step. These CSRs * select the minimum gaps between read operations and write operations * of various types. - * + * * Software must not reduce the values in these CSR fields below the * values previously selected by the LMC hardware (during write-leveling * and read-leveling steps above). - * + * * All sections in this chapter may be used to derive proper settings for * these registers. - * + * * For minimal read latency, L2C_CTL[EF_ENA,EF_CNT] should be programmed * properly. This should be done prior to the first read. */ diff --git a/src/vendorcode/cavium/bdk/libdram/dram-internal.h b/src/vendorcode/cavium/bdk/libdram/dram-internal.h index 0b4e8fb3da..02bf0d01f1 100644 --- a/src/vendorcode/cavium/bdk/libdram/dram-internal.h +++ b/src/vendorcode/cavium/bdk/libdram/dram-internal.h @@ -72,7 +72,7 @@ // 1. looking for the best sample score // 2. averaging the samples into a composite score // symbol PICK_BEST_RANK_SCORE_NOT_AVG is used to choose -// (see dram-init-ddr3.c: +// (see dram-init-ddr3.c: #define RLEVEL_AVG_LOOPS_DEFAULT 3 #define PICK_BEST_RANK_SCORE_NOT_AVG 1 @@ -125,7 +125,7 @@ extern int dram_tuning_mem_xor(bdk_node_t node, int ddr_interface_num, uint64_t // "mode" arg #define DBTRAIN_TEST 0 -#define DBTRAIN_DBI 1 +#define DBTRAIN_DBI 1 #define DBTRAIN_LFSR 2 extern int test_dram_byte_hw(bdk_node_t node, int ddr_interface_num, uint64_t p, int mode, uint64_t *xor_data); diff --git a/src/vendorcode/cavium/bdk/libdram/dram-spd.c b/src/vendorcode/cavium/bdk/libdram/dram-spd.c index 329ae98901..2a55e107d2 100644 --- a/src/vendorcode/cavium/bdk/libdram/dram-spd.c +++ b/src/vendorcode/cavium/bdk/libdram/dram-spd.c @@ -155,7 +155,7 @@ int read_spd(bdk_node_t node, const dimm_config_t *dimm_config, int spd_field) if (bank) { bdk_twsix_write_ia(node, bus, 0x36 | 0, 0, 2, 1, 0); } - + return data; } else diff --git a/src/vendorcode/cavium/bdk/libdram/dram-tune-ddr3.c b/src/vendorcode/cavium/bdk/libdram/dram-tune-ddr3.c index 2c6a105dae..385aceec50 100644 --- a/src/vendorcode/cavium/bdk/libdram/dram-tune-ddr3.c +++ b/src/vendorcode/cavium/bdk/libdram/dram-tune-ddr3.c @@ -46,7 +46,7 @@ #include <libbdk-hal/bdk-rng.h> #include <libbdk-os/bdk-init.h> -// if enhanced verbosity levels are defined, use them +// if enhanced verbosity levels are defined, use them #if defined(VB_PRT) #define ddr_print2(format, ...) VB_PRT(VBL_FAE, format, ##__VA_ARGS__) #define ddr_print3(format, ...) VB_PRT(VBL_TME, format, ##__VA_ARGS__) @@ -149,7 +149,7 @@ static const uint64_t *dram_tune_test_pattern = test_pattern_1; // set this to 1 to shorten the testing to exit when all byte lanes have errors // having this at 0 forces the testing to take place over the entire range every iteration, -// hopefully ensuring an even load on the memory subsystem +// hopefully ensuring an even load on the memory subsystem #define EXIT_WHEN_ALL_LANES_HAVE_ERRORS 0 #define DEFAULT_TEST_BURSTS 5 // FIXME: this is what works so far...// FIXME: was 7 @@ -198,7 +198,7 @@ get_speed_bin(bdk_node_t node, int lmc) ret = 1; } - debug_print("N%d.LMC%d: %s: returning bin %d for MTS %d\n", + debug_print("N%d.LMC%d: %s: returning bin %d for MTS %d\n", node, lmc, __FUNCTION__, ret, mts_speed); return ret; @@ -260,13 +260,13 @@ int dram_tuning_mem_xor(bdk_node_t node, int lmc, uint64_t p, uint64_t bitmask, #define I_INC (1ULL << 3) #define I_MAX (1ULL << 7) - debug_print("N%d.LMC%d: dram_tuning_mem_xor: phys_addr=0x%lx\n", + debug_print("N%d.LMC%d: dram_tuning_mem_xor: phys_addr=0x%lx\n", node, lmc, p); #if 0 int ix; // add this loop to fill memory with the test pattern first - // loops are ordered so that only entire cachelines are written + // loops are ordered so that only entire cachelines are written for (ii = 0; ii < II_MAX; ii += II_INC) { // FIXME? extend the range of memory tested!! for (k = 0; k < K_MAX; k += K_INC) { for (j = 0; j < J_MAX; j += J_INC) { @@ -329,7 +329,7 @@ int dram_tuning_mem_xor(bdk_node_t node, int lmc, uint64_t p, uint64_t bitmask, BDK_DCACHE_INVALIDATE; - debug_print("N%d.LMC%d: dram_tuning_mem_xor: done INIT loop\n", + debug_print("N%d.LMC%d: dram_tuning_mem_xor: done INIT loop\n", node, lmc); /* Make a series of passes over the memory areas. */ @@ -384,7 +384,7 @@ int dram_tuning_mem_xor(bdk_node_t node, int lmc, uint64_t p, uint64_t bitmask, BDK_DCACHE_INVALIDATE; - debug_print("N%d.LMC%d: dram_tuning_mem_xor: done MODIFY loop\n", + debug_print("N%d.LMC%d: dram_tuning_mem_xor: done MODIFY loop\n", node, lmc); #if ENABLE_PREFETCH @@ -460,7 +460,7 @@ int dram_tuning_mem_xor(bdk_node_t node, int lmc, uint64_t p, uint64_t bitmask, } } /* for (ii = 0; ii < (1ULL << 31); ii += (1ULL << 29)) */ - debug_print("N%d.LMC%d: dram_tuning_mem_xor: done TEST loop\n", + debug_print("N%d.LMC%d: dram_tuning_mem_xor: done TEST loop\n", node, lmc); } /* for (int burst = 0; burst < dram_tune_use_bursts; burst++) */ @@ -534,7 +534,7 @@ run_dram_tuning_threads(bdk_node_t node, int num_lmcs, uint64_t bytemask) /* Wait for threads to finish, with progress */ int cur_count; uint64_t cur_time; - uint64_t period = bdk_clock_get_rate(bdk_numa_local(), BDK_CLOCK_TIME) * TIMEOUT_SECS; // FIXME? + uint64_t period = bdk_clock_get_rate(bdk_numa_local(), BDK_CLOCK_TIME) * TIMEOUT_SECS; // FIXME? uint64_t timeout = bdk_clock_get_count(BDK_CLOCK_TIME) + period; do { // bdk_thread_yield(); /* FIXME(dhendrix): don't yield... */ @@ -854,7 +854,7 @@ auto_set_dll_offset(bdk_node_t node, int dll_offset_mode, } /* for (lmc = 0; lmc < num_lmcs; lmc++) */ // FIXME: only when verbose, or only when there are errors? - // run the test one last time + // run the test one last time // print whether there are errors or not, but only when verbose... bdk_watchdog_poke(); debug_print("N%d: %s: Start running test one last time\n", node, __FUNCTION__); @@ -912,7 +912,7 @@ int perform_dll_offset_tuning(bdk_node_t node, int dll_offset_mode, int do_tune) loops = strtoul(s, NULL, 0); } - // see if we want to change the granularity of the byte_offset sampling + // see if we want to change the granularity of the byte_offset sampling if ((s = getenv("ddr_tune_use_gran"))) { dram_tune_use_gran = strtoul(s, NULL, 0); } @@ -1018,7 +1018,7 @@ int perform_dll_offset_tuning(bdk_node_t node, int dll_offset_mode, int do_tune) limit_l2_ways(node, ways, ways_print); #endif - // perform cleanup on all active LMCs + // perform cleanup on all active LMCs debug_print("N%d: %s: starting LMCs cleanup.\n", node, __FUNCTION__); for (lmc = 0; lmc < num_lmcs; lmc++) { @@ -1420,7 +1420,7 @@ hw_assist_test_dll_offset(bdk_node_t node, int dll_offset_mode, ddr_print("%5d ", new_best_offset[byte]); else ddr_print("(byte %d) %5d ", byte, new_best_offset[byte]); - + #if 1 // done with testing, load up the best offsets we found... @@ -1433,7 +1433,7 @@ hw_assist_test_dll_offset(bdk_node_t node, int dll_offset_mode, ddr_print("\n"); #if 0 - // run the test one last time + // run the test one last time // print whether there are errors or not, but only when verbose... tot_errors = run_test_dram_byte_threads(node, num_lmcs, bytemask); printf("N%d.LMC%d: Bytelane %d DLL %s Offset Final Test: errors 0x%x\n", diff --git a/src/vendorcode/cavium/bdk/libdram/lib_octeon_shared.c b/src/vendorcode/cavium/bdk/libdram/lib_octeon_shared.c index 747c0e8767..7ee91c27c3 100644 --- a/src/vendorcode/cavium/bdk/libdram/lib_octeon_shared.c +++ b/src/vendorcode/cavium/bdk/libdram/lib_octeon_shared.c @@ -460,7 +460,7 @@ int test_dram_byte_hw(bdk_node_t node, int ddr_interface_num, // FIXME: K iterations set to 4 for now. // FIXME: decrement to increase interations. - // FIXME: must be no less than 22 to stay above an LMC hash field. + // FIXME: must be no less than 22 to stay above an LMC hash field. int kshift = 26; const char *s; @@ -560,8 +560,8 @@ int test_dram_byte_hw(bdk_node_t node, int ddr_interface_num, dbtrain_ctl.s.column_a = col; dbtrain_ctl.s.row_a = row; dbtrain_ctl.s.bg = (bank >> 2) & 3; - dbtrain_ctl.s.prank = (dimm * 2) + prank; // FIXME? - dbtrain_ctl.s.lrank = lrank; // FIXME? + dbtrain_ctl.s.prank = (dimm * 2) + prank; // FIXME? + dbtrain_ctl.s.lrank = lrank; // FIXME? dbtrain_ctl.s.activate = (mode == DBTRAIN_DBI); dbtrain_ctl.s.write_ena = 1; dbtrain_ctl.s.read_cmd_count = 31; // max count pass 1.x @@ -892,7 +892,7 @@ int initialize_ddr_clock(bdk_node_t node, * * 13. DRAM Vref Training for DDR4 * - * 14. Final LMC initialization + * 14. Final LMC initialization * * CN88XX supports two modes: * @@ -1014,7 +1014,7 @@ int initialize_ddr_clock(bdk_node_t node, ddr_print("LMC0: override DDR_PLL_CTL[dclk_invert] to %d\n", ddr_pll_ctl.cn83xx.dclk_invert); } - + // always write LMC0 CSR, it must be active DRAM_CSR_WRITE(node, BDK_LMCX_DDR_PLL_CTL(0), ddr_pll_ctl.u); ddr_print("%-45s : 0x%016llx\n", "LMC0: DDR_PLL_CTL", ddr_pll_ctl.u); @@ -1719,8 +1719,8 @@ static void dbi_switchover_interface(int node, int lmc) read_DAC_DBI_settings(node, lmc, /*DBI*/0, dbi_settings); display_DAC_DBI_settings(node, lmc, /* DBI */0, ecc_ena, dbi_settings, " INIT"); - - /* 2. set DBI related CSRs as below and issue MR write. + + /* 2. set DBI related CSRs as below and issue MR write. MODEREG_PARAMS3.WR_DBI=1 MODEREG_PARAMS3.RD_DBI=1 PHY_CTL.DBI_MODE_ENA=1 @@ -1738,7 +1738,7 @@ static void dbi_switchover_interface(int node, int lmc) /* there are two options for data to send. Lets start with (1) and could move to (2) in the future: - + 1) DBTRAIN_CTL[LFSR_PATTERN_SEL] = 0 (or for older chips where this does not exist) set data directly in these reigsters. this will yield a clk/2 pattern: GENERAL_PURPOSE0.DATA == 64'h00ff00ff00ff00ff; @@ -1756,10 +1756,10 @@ static void dbi_switchover_interface(int node, int lmc) DRAM_CSR_WRITE(node, BDK_LMCX_GENERAL_PURPOSE1(lmc), dbi_pattern[1]); DRAM_CSR_WRITE(node, BDK_LMCX_GENERAL_PURPOSE2(lmc), dbi_pattern[2]); - /* + /* 3. adjust cas_latency (only necessary if RD_DBI is set). here is my code for doing this: - + if (csr_model.MODEREG_PARAMS3.RD_DBI.value == 1) begin case (csr_model.MODEREG_PARAMS0.CL.value) 0,1,2,3,4: csr_model.MODEREG_PARAMS0.CL.value += 2; // CL 9-13 -> 11-15 @@ -1774,7 +1774,7 @@ static void dbi_switchover_interface(int node, int lmc) 7: csr_model.MODEREG_PARAMS0.CL.value = 14; // 16->19 8: csr_model.MODEREG_PARAMS0.CL.value = 15; // 18->21 default: - `cn_fatal(("Error mem_cfg (%s) CL (%d) with RD_DBI=1, I am not sure what to do.", + `cn_fatal(("Error mem_cfg (%s) CL (%d) with RD_DBI=1, I am not sure what to do.", mem_cfg, csr_model.MODEREG_PARAMS3.RD_DBI.value)) endcase end @@ -2056,7 +2056,7 @@ int octeon_ddr_initialize(bdk_node_t node, continue; try_again: - // if we are LMC0 + // if we are LMC0 if (interface_index == 0) { // if we are asking for 100 MHz refclk, we can only get it via alternate, so switch to it if (ddr_ref_hertz == 100000000) { diff --git a/src/vendorcode/cavium/bdk/libdram/libdram.c b/src/vendorcode/cavium/bdk/libdram/libdram.c index bebd5200f9..9b2f2e871e 100644 --- a/src/vendorcode/cavium/bdk/libdram/libdram.c +++ b/src/vendorcode/cavium/bdk/libdram/libdram.c @@ -157,13 +157,13 @@ static int bdk_libdram_tune_node(int node) // Automatically tune the data byte DLL read offsets // always done by default, but allow use of HW-assist - // NOTE: HW-assist will also tune the ECC byte + // NOTE: HW-assist will also tune the ECC byte BDK_TRACE(DRAM, "N%d: Starting DLL Read Offset Tuning for LMCs\n", node); if (!do_dllro_hw || (lmc_config.s.mode32b != 0)) { - errs = perform_dll_offset_tuning(node, 2, /* tune */1); + errs = perform_dll_offset_tuning(node, 2, /* tune */1); } else { - errs = perform_HW_dll_offset_tuning(node, /* read */2, 0x0A/* all bytelanes */); + errs = perform_HW_dll_offset_tuning(node, /* read */2, 0x0A/* all bytelanes */); } BDK_TRACE(DRAM, "N%d: Finished DLL Read Offset Tuning for LMCs, %d errors)\n", node, errs); @@ -183,10 +183,10 @@ static int bdk_libdram_tune_node(int node) // disabled by default for now, does not seem to be needed much? // Automatically tune the ECC byte DLL read offsets // FIXME? allow override of the filtering - // FIXME? allow programmatic override, not via envvar? + // FIXME? allow programmatic override, not via envvar? if (do_eccdll && !do_dllro_hw && (lmc_config.s.mode32b == 0)) { // do not do HW-assist twice for ECC BDK_TRACE(DRAM, "N%d: Starting ECC DLL Read Offset Tuning for LMCs\n", node); - errs = perform_HW_dll_offset_tuning(node, 2, 8/* ECC bytelane */); + errs = perform_HW_dll_offset_tuning(node, 2, 8/* ECC bytelane */); BDK_TRACE(DRAM, "N%d: Finished ECC DLL Read Offset Tuning for LMCs, %d errors\n", node, errs); tot_errs += errs; @@ -207,7 +207,7 @@ static int bdk_libdram_tune_node(int node) // FIXME: DDR3 is not tuned static const uint32_t ddr_speed_filter[2][2][2] = { - [IS_DDR4] = { + [IS_DDR4] = { [IS_RDIMM] = { [IS_1SLOT] = 940, [IS_2SLOT] = 800 @@ -473,7 +473,7 @@ int libdram_tune(int node) ddr_print("N%d: %s: non-zero node, not worrying about L2C lock status\n", node, __FUNCTION__); } - // make sure to clear memory and any ECC errs when done... + // make sure to clear memory and any ECC errs when done... bdk_dram_clear_mem(node); bdk_dram_clear_ecc(node); @@ -498,7 +498,7 @@ int libdram_margin_write_voltage(int node) // call the margining routine tot_errs = perform_margin_write_voltage(node); - // make sure to clear memory and any ECC errs when done... + // make sure to clear memory and any ECC errs when done... bdk_dram_clear_mem(node); bdk_dram_clear_ecc(node); @@ -523,7 +523,7 @@ int libdram_margin_read_voltage(int node) // call the margining routine tot_errs = perform_margin_read_voltage(node); - // make sure to clear memory and any ECC errs when done... + // make sure to clear memory and any ECC errs when done... bdk_dram_clear_mem(node); bdk_dram_clear_ecc(node); @@ -548,7 +548,7 @@ int libdram_margin_write_timing(int node) // call the tuning routine, tell it we are margining not tuning... tot_errs = perform_dll_offset_tuning(node, /* write offsets */1, /* margin */0); - // make sure to clear memory and any ECC errs when done... + // make sure to clear memory and any ECC errs when done... bdk_dram_clear_mem(node); bdk_dram_clear_ecc(node); @@ -573,7 +573,7 @@ int libdram_margin_read_timing(int node) // call the tuning routine, tell it we are margining not tuning... tot_errs = perform_dll_offset_tuning(node, /* read offsets */2, /* margin */0); - // make sure to clear memory and any ECC errs when done... + // make sure to clear memory and any ECC errs when done... bdk_dram_clear_mem(node); bdk_dram_clear_ecc(node); @@ -596,7 +596,7 @@ int libdram_margin(int node) const char *risk[2] = { "Low Risk", "Needs Review" }; int l2c_is_locked = bdk_l2c_is_locked(node); - // for now, no margining on 81xx, until we can reduce the dynamic runtime size... + // for now, no margining on 81xx, until we can reduce the dynamic runtime size... if (CAVIUM_IS_MODEL(CAVIUM_CN81XX)) { printf("Sorry, margining is not available on 81xx yet...\n"); return 0; @@ -637,7 +637,7 @@ int libdram_margin(int node) >>> N0: Read Timing Margin : Low Risk >>> N0: Write Timing Margin : Low Risk >>> N0: Read Voltage Margin : Low Risk - >>> N0: Write Voltage Margin : Low Risk + >>> N0: Write Voltage Margin : Low Risk */ printf(" \n"); printf("-------------------------------------\n"); @@ -647,7 +647,7 @@ int libdram_margin(int node) printf("N%d: Write Timing Margin : %s\n", node, risk[!!ret_wt]); // these may not have been done due to DDR3 and/or THUNDER pass 1.x - // FIXME? would it be better to print an appropriate message here? + // FIXME? would it be better to print an appropriate message here? if (ret_rv != -1) printf("N%d: Read Voltage Margin : %s\n", node, risk[!!ret_rv]); if (ret_wv != -1) printf("N%d: Write Voltage Margin : %s\n", node, risk[!!ret_wv]); diff --git a/src/vendorcode/cavium/include/bdk/libbdk-arch/bdk-asm.h b/src/vendorcode/cavium/include/bdk/libbdk-arch/bdk-asm.h index 4206247c2a..e4e4f447f2 100644 --- a/src/vendorcode/cavium/include/bdk/libbdk-arch/bdk-asm.h +++ b/src/vendorcode/cavium/include/bdk/libbdk-arch/bdk-asm.h @@ -85,7 +85,7 @@ #define BDK_CACHE_WB_L2(address) { asm volatile ("sys " BDK_SYS_CVMCACHE_WB_L2 ", %0" : : "r" (address)); } // Push to memory, don't invalidate, don't unlock #define BDK_CACHE_LCK_L2(address) { asm volatile ("sys " BDK_SYS_CVMCACHE_LCK_L2 ", %0" : : "r" (address)); } // Lock into L2 #define BDK_DCACHE_INVALIDATE { asm volatile ("sys " BDK_SYS_CVMCACHE_INVALL_DC ", xzr"); } // Invalidate the entire Dcache on local core -#define BDK_CACHE_LTG_L2_INDEXED(encoded) { asm volatile ("sys " BDK_SYS_CVMCACHE_LTG_L2_INDEXED ", %0" : : "r" (encoded)); } // Load L2 TAG, index by set/way +#define BDK_CACHE_LTG_L2_INDEXED(encoded) { asm volatile ("sys " BDK_SYS_CVMCACHE_LTG_L2_INDEXED ", %0" : : "r" (encoded)); } // Load L2 TAG, index by set/way #define BDK_STORE_PAIR(ptr, data1, data2) { asm volatile ("stp %x[d1], %x[d2], [%[b]]" : [mem] "+m" (*(__uint128_t*)ptr) : [b] "r" (ptr), [d1] "r" (data1), [d2] "r" (data2)); } diff --git a/src/vendorcode/cavium/include/bdk/libdram/libdram-config.h b/src/vendorcode/cavium/include/bdk/libdram/libdram-config.h index aa5c256d58..3e44471e6b 100644 --- a/src/vendorcode/cavium/include/bdk/libdram/libdram-config.h +++ b/src/vendorcode/cavium/include/bdk/libdram/libdram-config.h @@ -163,7 +163,7 @@ typedef struct { the delays of adjacent bytes. A value of 0 disables this check. - .fprch2 Front Porch Enable: When set, the turn-off + .fprch2 Front Porch Enable: When set, the turn-off time for the default DDR_DQ/DQS drivers is FPRCH2 CKs earlier. 00 = 0 CKs 01 = 1 CKs diff --git a/src/vendorcode/intel/edk2/UDK2017/IntelFsp2Pkg/Include/FspEas/FspApi.h b/src/vendorcode/intel/edk2/UDK2017/IntelFsp2Pkg/Include/FspEas/FspApi.h index fb536db530..29c98ee163 100644 --- a/src/vendorcode/intel/edk2/UDK2017/IntelFsp2Pkg/Include/FspEas/FspApi.h +++ b/src/vendorcode/intel/edk2/UDK2017/IntelFsp2Pkg/Include/FspEas/FspApi.h @@ -216,7 +216,7 @@ EFI_STATUS and defined for each FSP binary. This will be documented in Integration guide with each FSP release. After FspMemInit completes its execution, it passes the pointer to the HobList and - returns to the boot loader from where it was called. BootLoader is responsible to + returns to the boot loader from where it was called. BootLoader is responsible to migrate it's stack and data to Memory. FspMemoryInit, TempRamExit and FspSiliconInit APIs provide an alternate method to complete the silicon initialization and provides bootloader an opportunity to get diff --git a/src/vendorcode/intel/edk2/UDK2017/IntelFsp2Pkg/Include/Guid/FspHeaderFile.h b/src/vendorcode/intel/edk2/UDK2017/IntelFsp2Pkg/Include/Guid/FspHeaderFile.h index 070eee8fcf..472880f0c6 100644 --- a/src/vendorcode/intel/edk2/UDK2017/IntelFsp2Pkg/Include/Guid/FspHeaderFile.h +++ b/src/vendorcode/intel/edk2/UDK2017/IntelFsp2Pkg/Include/Guid/FspHeaderFile.h @@ -144,7 +144,7 @@ typedef struct { /// UINT8 Reserved; /// - /// Byte 0x0A: FSP producer identification string + /// Byte 0x0A: FSP producer identification string /// CHAR8 FspProducerId[6]; /// diff --git a/src/vendorcode/intel/edk2/UDK2017/IntelFsp2Pkg/Include/Library/FspCommonLib.h b/src/vendorcode/intel/edk2/UDK2017/IntelFsp2Pkg/Include/Library/FspCommonLib.h index fb25f6e5c2..e75e2e1adc 100644 --- a/src/vendorcode/intel/edk2/UDK2017/IntelFsp2Pkg/Include/Library/FspCommonLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/IntelFsp2Pkg/Include/Library/FspCommonLib.h @@ -268,7 +268,7 @@ SetFspApiCallingIndex ( /** This function gets FSP Phase StatusCode. - + @retval StatusCode **/ UINT32 diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Arm/ProcessorBind.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Arm/ProcessorBind.h index 4659352f28..a14b90e647 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Arm/ProcessorBind.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Arm/ProcessorBind.h @@ -3,13 +3,13 @@ Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR> Portions copyright (c) 2008 - 2009, Apple Inc. 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -35,7 +35,7 @@ #define UNREACHABLE() #endif -#if _MSC_EXTENSIONS +#if _MSC_EXTENSIONS // // use Microsoft* C compiler dependent integer width types // @@ -52,7 +52,7 @@ typedef signed char INT8; #else // - // Assume standard ARM alignment. + // Assume standard ARM alignment. // Need to check portability of long long // typedef unsigned long long UINT64; @@ -121,7 +121,7 @@ typedef INT32 INTN; // use the correct C calling convention. All protocol member functions and // EFI intrinsics are required to modify their member functions with EFIAPI. // -#define EFIAPI +#define EFIAPI // When compiling with Clang, we still use GNU as for the assembler, so we still // need to define the GCC_ASM* macros. @@ -142,34 +142,34 @@ typedef INT32 INTN; #define GCC_ASM_EXPORT(func__) \ .global _CONCATENATE (__USER_LABEL_PREFIX__, func__) ;\ - .type ASM_PFX(func__), %function + .type ASM_PFX(func__), %function #define GCC_ASM_IMPORT(func__) \ .extern _CONCATENATE (__USER_LABEL_PREFIX__, func__) - + #else // - // .type not supported by Apple Xcode tools + // .type not supported by Apple Xcode tools // - #define INTERWORK_FUNC(func__) + #define INTERWORK_FUNC(func__) #define GCC_ASM_EXPORT(func__) \ .globl _CONCATENATE (__USER_LABEL_PREFIX__, func__) \ - - #define GCC_ASM_IMPORT(name) + + #define GCC_ASM_IMPORT(name) #endif #endif /** Return the pointer to the first instruction of a function given a function pointer. - On ARM CPU architectures, these two pointer values are the same, + On ARM CPU architectures, these two pointer values are the same, so the implementation of this macro is very simple. - + @param FunctionPointer A pointer to a function. @return The pointer to the first instruction of a function given a function pointer. - + **/ #define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer) diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Base.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Base.h index 972aee38af..694a94dd41 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Base.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Base.h @@ -65,8 +65,8 @@ VERIFY_SIZE_OF (CHAR16, 2); // // The following three enum types are used to verify that the compiler -// configuration for enum types is compliant with Section 2.3.1 of the -// UEFI 2.3 Specification. These enum types and enum values are not +// configuration for enum types is compliant with Section 2.3.1 of the +// UEFI 2.3 Specification. These enum types and enum values are not // intended to be used. A prefix of '__' is used avoid conflicts with // other types. // @@ -766,7 +766,7 @@ typedef CHAR8 *VA_LIST; This macro initializes Dest as a copy of Start, as if the VA_START macro had been applied to Dest followed by the same sequence of uses of the VA_ARG macro as had previously been used to reach - the present state of Start. + the present state of Start. @param Dest VA_LIST used to traverse the list of arguments. @param Start VA_LIST used to traverse the list of arguments. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ebc/ProcessorBind.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ebc/ProcessorBind.h index ca46b80561..9b533a218b 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ebc/ProcessorBind.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ebc/ProcessorBind.h @@ -5,13 +5,13 @@ specific functions in this file. Copyright (c) 2006 - 2013, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -91,7 +91,7 @@ typedef unsigned long UINTN; /// A value of native width with the highest bit set. /// Scalable macro to set the most significant bit in a natural number. /// -#define MAX_BIT (1ULL << (sizeof (INTN) * 8 - 1)) +#define MAX_BIT (1ULL << (sizeof (INTN) * 8 - 1)) /// /// A value of native width with the two highest bits set. /// Scalable macro to set the most 2 significant bits in a natural number. @@ -130,14 +130,14 @@ typedef unsigned long UINTN; /// If EFIAPI is already defined, then we use that definition. /// #else -#define EFIAPI +#define EFIAPI #endif /** Return the pointer to the first instruction of a function given a function pointer. - On EBC architectures, these two pointer values are the same, + On EBC architectures, these two pointer values are the same, so the implementation of this macro is very simple. - + @param FunctionPointer A pointer to a function. @return The pointer to the first instruction of a function given a function pointer. @@ -148,5 +148,5 @@ typedef unsigned long UINTN; #define __USER_LABEL_PREFIX__ #endif -#endif +#endif diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/Acpi.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/Acpi.h index 3897ae62ff..5cb4ec5261 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/Acpi.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/Acpi.h @@ -2,17 +2,17 @@ GUIDs used for ACPI entries in the EFI system table These GUIDs point the ACPI tables as defined in the ACPI specifications. - ACPI 2.0 specification defines the ACPI 2.0 GUID. UEFI 2.0 defines the + ACPI 2.0 specification defines the ACPI 2.0 GUID. UEFI 2.0 defines the ACPI 2.0 Table GUID and ACPI Table GUID. Copyright (c) 2006 - 2009, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUIDs defined in UEFI 2.0 spec. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/Apriori.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/Apriori.h index 6d4fc74d40..680ee31271 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/Apriori.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/Apriori.h @@ -4,13 +4,13 @@ the dependency grammar. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUID introduced in PI Version 1.0. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/AprioriFileName.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/AprioriFileName.h index d99893887d..eac2385bcb 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/AprioriFileName.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/AprioriFileName.h @@ -4,13 +4,13 @@ volume. Copyright (c) 2006 - 2009, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUID introduced in PI Version 1.0. @@ -24,7 +24,7 @@ { 0x1b45cc0a, 0x156a, 0x428a, { 0x62, 0XAF, 0x49, 0x86, 0x4d, 0xa0, 0xe6, 0xe6 } } -/// +/// /// This file must be of type EFI_FV_FILETYPE_FREEFORM and must /// contain a single section of type EFI_SECTION_RAW. For details on /// firmware volumes, firmware file types, and firmware file section @@ -33,7 +33,7 @@ typedef struct { /// /// An array of zero or more EFI_GUID type entries that match the file names of PEIM - /// modules in the same Firmware Volume. The maximum number of entries. + /// modules in the same Firmware Volume. The maximum number of entries. /// EFI_GUID FileNamesWithinVolume[1]; } PEI_APRIORI_FILE_CONTENTS; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/CapsuleReport.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/CapsuleReport.h index 051a41bde9..2a40d936b0 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/CapsuleReport.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/CapsuleReport.h @@ -1,6 +1,6 @@ /** @file Guid & data structure used for Capsule process result variables - + Copyright (c) 2015, 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 @@ -84,14 +84,14 @@ typedef struct { /// /// In case of capsule loaded from disk, the zero-terminated array containing file name of capsule that was processed. - /// In case of capsule submitted directly to UpdateCapsule() there is no file name, and this field is required to contain a single 16-bit zero character + /// In case of capsule submitted directly to UpdateCapsule() there is no file name, and this field is required to contain a single 16-bit zero character /// which is included in VariableTotalSize. /// /// CHAR16 CapsuleFileName[]; /// /// - /// This field will contain a zero-terminated CHAR16 string containing the text representation of the device path of device publishing Firmware Management Protocol + /// This field will contain a zero-terminated CHAR16 string containing the text representation of the device path of device publishing Firmware Management Protocol /// (if present). In case where device path is not present and the target is not otherwise known to firmware, or when payload was blocked by policy, or skipped, /// this field is required to contain a single 16-bit zero character which is included in VariableTotalSize. /// diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/DebugImageInfoTable.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/DebugImageInfoTable.h index 553ebd2588..977ce155ac 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/DebugImageInfoTable.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/DebugImageInfoTable.h @@ -2,13 +2,13 @@ GUID and related data structures used with the Debug Image Info Table. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUID defined in UEFI 2.0 spec. @@ -35,7 +35,7 @@ typedef struct { UINT64 Signature; ///< A constant UINT64 that has the value EFI_SYSTEM_TABLE_SIGNATURE - EFI_PHYSICAL_ADDRESS EfiSystemTableBase; ///< The physical address of the EFI system table. + EFI_PHYSICAL_ADDRESS EfiSystemTableBase; ///< The physical address of the EFI system table. UINT32 Crc32; ///< A 32-bit CRC value that is used to verify the EFI_SYSTEM_TABLE_POINTER structure is valid. } EFI_SYSTEM_TABLE_POINTER; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/DxeServices.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/DxeServices.h index be2b5b3e96..5ecc358f83 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/DxeServices.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/DxeServices.h @@ -2,13 +2,13 @@ GUID used to identify the DXE Services Table Copyright (c) 2006 - 2009, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUID introduced in PI Version 1.0. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/EventGroup.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/EventGroup.h index 04ee0e0fda..a4eb706451 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/EventGroup.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/EventGroup.h @@ -2,20 +2,20 @@ GUIDs for gBS->CreateEventEx Event Groups. Defined in UEFI spec 2.0 and PI 1.2.1. Copyright (c) 2006 - 2012, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ #ifndef __EVENT_GROUP_GUID__ #define __EVENT_GROUP_GUID__ - + #define EFI_EVENT_GROUP_EXIT_BOOT_SERVICES \ { 0x27abf055, 0xb1b8, 0x4c26, { 0x80, 0x48, 0x74, 0x8f, 0x37, 0xba, 0xa2, 0xdf } } diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/EventLegacyBios.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/EventLegacyBios.h index f69aa18f9a..570554dad7 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/EventLegacyBios.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/EventLegacyBios.h @@ -1,16 +1,16 @@ /** @file - GUID is the name of events used with CreateEventEx in order to be notified + GUID is the name of events used with CreateEventEx in order to be notified when the EFI boot manager is about to boot a legacy boot option. - Events of this type are notificated just before Int19h is invoked. + Events of this type are notificated just before Int19h is invoked. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUID introduced in PI Version 1.0. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FileInfo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FileInfo.h index 5a2e081b46..145727539d 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FileInfo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FileInfo.h @@ -4,13 +4,13 @@ This GUID is defined in UEFI specification. 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FileSystemInfo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FileSystemInfo.h index f666ae5571..69e417ab30 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FileSystemInfo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FileSystemInfo.h @@ -4,13 +4,13 @@ This GUID is defined in UEFI specification. 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FileSystemVolumeLabelInfo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FileSystemVolumeLabelInfo.h index 0f41f9a34e..7d34b8746b 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FileSystemVolumeLabelInfo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FileSystemVolumeLabelInfo.h @@ -4,13 +4,13 @@ This GUID is defined in UEFI specification. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FirmwareContentsSigned.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FirmwareContentsSigned.h index c13a21eb13..c3b59a30ec 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FirmwareContentsSigned.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FirmwareContentsSigned.h @@ -2,13 +2,13 @@ GUID is used to define the signed section. Copyright (c) 2013, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUID introduced in PI Version 1.2.1. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FirmwareFileSystem2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FirmwareFileSystem2.h index 9e12fd6084..1aaa3b1092 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FirmwareFileSystem2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FirmwareFileSystem2.h @@ -2,13 +2,13 @@ Guid used to define the Firmware File System 2. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUIDs introduced in PI Version 1.0. @@ -18,18 +18,18 @@ #ifndef __FIRMWARE_FILE_SYSTEM2_GUID_H__ #define __FIRMWARE_FILE_SYSTEM2_GUID_H__ -/// -/// The firmware volume header contains a data field for +/// +/// The firmware volume header contains a data field for /// the file system GUID -/// +/// #define EFI_FIRMWARE_FILE_SYSTEM2_GUID \ { 0x8c8ce578, 0x8a3d, 0x4f1c, { 0x99, 0x35, 0x89, 0x61, 0x85, 0xc3, 0x2d, 0xd3 } } /// -/// A Volume Top File (VTF) is a file that must be -/// located such that the last byte of the file is +/// A Volume Top File (VTF) is a file that must be +/// located such that the last byte of the file is /// also the last byte of the firmware volume -/// +/// #define EFI_FFS_VOLUME_TOP_FILE_GUID \ { 0x1BA0062E, 0xC779, 0x4582, { 0x85, 0x66, 0x33, 0x6A, 0xE8, 0xF7, 0x8F, 0x9 } } diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FirmwareFileSystem3.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FirmwareFileSystem3.h index 37ee56a97a..c264b4d53f 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FirmwareFileSystem3.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/FirmwareFileSystem3.h @@ -2,13 +2,13 @@ Guid used to define the Firmware File System 3. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUIDs introduced in PI Version 1.0. @@ -18,7 +18,7 @@ #ifndef __FIRMWARE_FILE_SYSTEM3_GUID_H__ #define __FIRMWARE_FILE_SYSTEM3_GUID_H__ -/// +/// /// The firmware volume header contains a data field for the file system GUID /// {5473C07A-3DCB-4dca-BD6F-1E9689E7349A} /// diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/GlobalVariable.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/GlobalVariable.h index a0be1a94c6..9f402d53b2 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/GlobalVariable.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/GlobalVariable.h @@ -2,13 +2,13 @@ GUID for EFI (NVRAM) Variables. Copyright (c) 2006 - 2016, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUID defined in UEFI 2.1 diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/Gpt.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/Gpt.h index af2b1a12f8..9f774fd007 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/Gpt.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/Gpt.h @@ -1,17 +1,17 @@ /** @file Guids used for the GPT (GUID Partition Table) - GPT defines a new disk partitioning scheme and also describes - usage of the legacy Master Boot Record (MBR) partitioning scheme. + GPT defines a new disk partitioning scheme and also describes + usage of the legacy Master Boot Record (MBR) partitioning scheme. Copyright (c) 2006 - 2007, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUIDs defined in UEFI 2.1 spec. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/HiiFormMapMethodGuid.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/HiiFormMapMethodGuid.h index 8b37807f3d..ab508fd3c9 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/HiiFormMapMethodGuid.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/HiiFormMapMethodGuid.h @@ -2,13 +2,13 @@ Guid used to identify HII FormMap configuration method. Copyright (c) 2009, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUID defined in UEFI 2.2 spec. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/HiiKeyBoardLayout.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/HiiKeyBoardLayout.h index c2619713ed..0e02e6afe4 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/HiiKeyBoardLayout.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/HiiKeyBoardLayout.h @@ -1,15 +1,15 @@ /** @file HII keyboard layout GUID as defined in UEFI2.1 specification - + Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUIDs defined in UEFI 2.1 spec. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/HiiPlatformSetupFormset.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/HiiPlatformSetupFormset.h index 2503879a4c..375212fae4 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/HiiPlatformSetupFormset.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/HiiPlatformSetupFormset.h @@ -1,15 +1,15 @@ /** @file - GUID indicates that the form set contains forms designed to be used + GUID indicates that the form set contains forms designed to be used for platform configuration and this form set will be displayed. 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. @par Revision Reference: GUID defined in UEFI 2.1. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/HobList.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/HobList.h index 94c1a58e0f..e24dc4b330 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/HobList.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/HobList.h @@ -4,13 +4,13 @@ These GUIDs point the HOB List passed from PEI to DXE. Copyright (c) 2006 - 2009, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUID introduced in PI Version 1.0. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/ImageAuthentication.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/ImageAuthentication.h index a81b79b838..e43ac738c5 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/ImageAuthentication.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/ImageAuthentication.h @@ -319,7 +319,7 @@ typedef struct { /// Zero or more image signatures. If the image contained no signatures, /// then this field is empty. /// EFI_SIGNATURE_LIST Signature; - /// + /// } EFI_IMAGE_EXECUTION_INFO; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/MdePkgTokenSpace.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/MdePkgTokenSpace.h index 70896ef67d..04ce32fc26 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/MdePkgTokenSpace.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/MdePkgTokenSpace.h @@ -1,5 +1,5 @@ /** @file - GUID for MdePkg PCD Token Space + GUID for MdePkg PCD Token Space Copyright (c) 2009, Intel Corporation. All rights reserved.<BR> This program and the accompanying materials diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/MemoryAllocationHob.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/MemoryAllocationHob.h index 788920c480..fb067571bc 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/MemoryAllocationHob.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/MemoryAllocationHob.h @@ -2,13 +2,13 @@ GUIDs for HOBs used in memory allcation Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUIDs introduced in PI Version 1.0. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/MemoryOverwriteControl.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/MemoryOverwriteControl.h index 35f6343d37..539195179d 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/MemoryOverwriteControl.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/MemoryOverwriteControl.h @@ -1,20 +1,20 @@ /** @file - GUID used for MemoryOverwriteRequestControl UEFI variable defined in + GUID used for MemoryOverwriteRequestControl UEFI variable defined in TCG Platform Reset Attack Mitigation Specification 1.00. See http://trustedcomputinggroup.org for the latest specification - The purpose of the MemoryOverwriteRequestControl UEFI variable is to give users (e.g., OS, loader) the ability to - indicate to the platform that secrets are present in memory and that the platform firmware must clear memory upon - a restart. The OS loader should not create the variable. Rather, the firmware is required to create it. + The purpose of the MemoryOverwriteRequestControl UEFI variable is to give users (e.g., OS, loader) the ability to + indicate to the platform that secrets are present in memory and that the platform firmware must clear memory upon + a restart. The OS loader should not create the variable. Rather, the firmware is required to create it. Copyright (c) 2009, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -27,17 +27,17 @@ } /// -/// Variable name is "MemoryOverwriteRequestControl" and it is a 1 byte unsigned value. -/// The attributes should be: -/// EFI_VARIABLE_NON_VOLATILE | -/// EFI_VARIABLE_BOOTSERVICE_ACCESS | -/// EFI_VARIABLE_RUNTIME_ACCESS +/// Variable name is "MemoryOverwriteRequestControl" and it is a 1 byte unsigned value. +/// The attributes should be: +/// EFI_VARIABLE_NON_VOLATILE | +/// EFI_VARIABLE_BOOTSERVICE_ACCESS | +/// EFI_VARIABLE_RUNTIME_ACCESS /// #define MEMORY_OVERWRITE_REQUEST_VARIABLE_NAME L"MemoryOverwriteRequestControl" /// /// 0 = Firmware MUST clear the MOR bit -/// 1 = Firmware MUST set the MOR bit +/// 1 = Firmware MUST set the MOR bit /// #define MOR_CLEAR_MEMORY_BIT_MASK 0x01 diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/Mps.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/Mps.h index 4d4692e3be..0e282a0d75 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/Mps.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/Mps.h @@ -4,13 +4,13 @@ included to support Itanium-based platform power on. So don't use it if you don't have too. Copyright (c) 2006, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUIDs defined in UEFI 2.0 spec. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/PcAnsi.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/PcAnsi.h index 7ff878d7f1..8f312542de 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/PcAnsi.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/PcAnsi.h @@ -2,13 +2,13 @@ Terminal Device Path Vendor Guid. Copyright (c) 2006 - 2009, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUIDs defined in UEFI 2.0 spec. @@ -42,7 +42,7 @@ { \ 0x37499a9d, 0x542f, 0x4c89, {0xa0, 0x26, 0x35, 0xda, 0x14, 0x20, 0x94, 0xe4 } \ } - + #define EFI_SAS_DEVICE_PATH_GUID \ { \ 0xd487ddb4, 0x008b, 0x11d9, {0xaf, 0xdc, 0x00, 0x10, 0x83, 0xff, 0xca, 0x4d } \ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/SalSystemTable.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/SalSystemTable.h index 8994ee7bdf..f72cccd50e 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/SalSystemTable.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/SalSystemTable.h @@ -5,13 +5,13 @@ the system. Copyright (c) 2006 - 2009, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUIDs defined in UEFI 2.0 spec. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/SmBios.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/SmBios.h index 05e11b7b63..a18bf2215a 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/SmBios.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/SmBios.h @@ -6,13 +6,13 @@ tables. Copyright (c) 2006 - 2015, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUIDs defined in UEFI 2.5 spec. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/StatusCodeDataTypeId.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/StatusCodeDataTypeId.h index 8bbc3315bc..84fbb0bd15 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/StatusCodeDataTypeId.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/StatusCodeDataTypeId.h @@ -11,7 +11,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: - These GUIDs and structures are defined in UEFI Platform Initialization Specification 1.2 + These GUIDs and structures are defined in UEFI Platform Initialization Specification 1.2 Volume 3: Shared Architectural Elements **/ @@ -38,12 +38,12 @@ typedef enum { /// EfiStringUnicode, /// - /// An EFI_STATUS_CODE_STRING_TOKEN representing the string. The actual + /// An EFI_STATUS_CODE_STRING_TOKEN representing the string. The actual /// string can be obtained by querying the HII Database /// EfiStringToken } EFI_STRING_TYPE; - + /// /// Specifies the format of the data in EFI_STATUS_CODE_STRING_DATA.String. /// @@ -60,7 +60,7 @@ typedef struct { /// EFI_STRING_ID Token; } EFI_STATUS_CODE_STRING_TOKEN; - + typedef union { /// /// ASCII formatted string. @@ -75,11 +75,11 @@ typedef union { /// EFI_STATUS_CODE_STRING_TOKEN Hii; } EFI_STATUS_CODE_STRING; - + /// -/// This data type defines a string type of extended data. A string can accompany -/// any status code. The string can provide additional information about the -/// status code. The string can be ASCII, Unicode, or a Human Interface Infrastructure +/// This data type defines a string type of extended data. A string can accompany +/// any status code. The string can provide additional information about the +/// status code. The string can be ASCII, Unicode, or a Human Interface Infrastructure /// (HII) token/GUID pair. /// typedef struct { @@ -89,14 +89,14 @@ typedef struct { /// sizeof (EFI_STATUS_CODE_STRING_DATA) - HeaderSize, and /// DataHeader.Type should be /// EFI_STATUS_CODE_DATA_TYPE_STRING_GUID. - /// - EFI_STATUS_CODE_DATA DataHeader; + /// + EFI_STATUS_CODE_DATA DataHeader; /// /// Specifies the format of the data in String. /// EFI_STRING_TYPE StringType; /// - /// A pointer to the extended data. The data follows the format specified by + /// A pointer to the extended data. The data follows the format specified by /// StringType. /// EFI_STATUS_CODE_STRING String; @@ -123,7 +123,7 @@ extern EFI_GUID gEfiStatusCodeDataTypeStringGuid; { 0x335984bd, 0xe805, 0x409a, { 0xb8, 0xf8, 0xd2, 0x7e, 0xce, 0x5f, 0xf7, 0xa6 } } /// -/// Extended data about the device path, which is used for many errors and +/// Extended data about the device path, which is used for many errors and /// progress codes to point to the device. /// /// The device path is used to point to the physical device in case there is more than one device @@ -148,7 +148,7 @@ typedef struct { /// EFI_STATUS_CODE_DATA DataHeader; /// - /// The device path to the controller or the hardware device. Note that this parameter is a + /// The device path to the controller or the hardware device. Note that this parameter is a /// variable-length device path structure and not a pointer to such a structure. This structure is /// populated only if it is a physical device. For virtual devices, the Size field in DataHeader /// is set to zero and this field is not populated. @@ -183,7 +183,7 @@ typedef struct { /// /// This structure defines extended data describing a PCI resource allocation error. /// -/// @par Note: +/// @par Note: /// The following structure contains variable-length fields and cannot be defined as a C-style /// structure. /// @@ -209,7 +209,7 @@ typedef struct { /// /// DevicePathSize should be zero if it is a virtual device that is not associated with /// a device path. Otherwise, this parameter is the length of the variable-length - /// DevicePath. + /// DevicePath. /// UINT16 DevicePathSize; /// @@ -223,9 +223,9 @@ typedef struct { /// UINT16 AllocResSize; /// - /// The device path to the controller or the hardware device that did not get the requested - /// resources. Note that this parameter is the variable-length device path structure and not - /// a pointer to this structure. + /// The device path to the controller or the hardware device that did not get the requested + /// resources. Note that this parameter is the variable-length device path structure and not + /// a pointer to this structure. /// // EFI_DEVICE_PATH_PROTOCOL DevicePath; /// @@ -234,7 +234,7 @@ typedef struct { /// // UINT8 ReqRes[]; /// - /// The allocated resources in the format of an ACPI 2.0 resource descriptor. This + /// The allocated resources in the format of an ACPI 2.0 resource descriptor. This /// parameter is not a pointer; it is the complete resource descriptor. /// // UINT8 AllocRes[]; @@ -244,7 +244,7 @@ typedef struct { /// This structure provides a calculation for base-10 representations. /// /// Not consistent with PI 1.2 Specification. -/// This data type is not defined in the PI 1.2 Specification, but is +/// This data type is not defined in the PI 1.2 Specification, but is /// required by several of the other data structures in this file. /// typedef struct { @@ -253,16 +253,16 @@ typedef struct { /// INT16 Value; /// - /// The INT16 number by which to raise the base-2 calculation. + /// The INT16 number by which to raise the base-2 calculation. /// INT16 Exponent; } EFI_EXP_BASE10_DATA; /// -/// This structure provides the voltage at the time of error. It also provides -/// the threshold value indicating the minimum or maximum voltage that is considered -/// an error. If the voltage is less then the threshold, the error indicates that the -/// voltage fell below the minimum acceptable value. If the voltage is greater then the threshold, +/// This structure provides the voltage at the time of error. It also provides +/// the threshold value indicating the minimum or maximum voltage that is considered +/// an error. If the voltage is less then the threshold, the error indicates that the +/// voltage fell below the minimum acceptable value. If the voltage is greater then the threshold, /// the error indicates that the voltage rose above the maximum acceptable value. /// typedef struct { @@ -312,7 +312,7 @@ typedef struct { /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be /// sizeof (EFI_COMPUTING_UNIT_TIMER_EXPIRED_ERROR_DATA) - /// HeaderSize, and DataHeader.Type should be - /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID. + /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID. /// EFI_STATUS_CODE_DATA DataHeader; /// @@ -341,11 +341,11 @@ typedef struct { /// /// This structure defines extended data for processor mismatch errors. /// -/// This provides information to indicate which processors mismatch, and how they mismatch. The -/// status code contains the instance number of the processor that is in error. This structure's -/// Instance indicates the second processor that does not match. This differentiation allows the -/// consumer to determine which two processors do not match. The Attributes indicate what -/// mismatch is being reported. Because Attributes is a bit field, more than one mismatch can be +/// This provides information to indicate which processors mismatch, and how they mismatch. The +/// status code contains the instance number of the processor that is in error. This structure's +/// Instance indicates the second processor that does not match. This differentiation allows the +/// consumer to determine which two processors do not match. The Attributes indicate what +/// mismatch is being reported. Because Attributes is a bit field, more than one mismatch can be /// reported with one error code. /// typedef struct { @@ -354,23 +354,23 @@ typedef struct { /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be /// sizeof (EFI_ HOST_PROCESSOR_MISMATCH_ERROR_DATA) - /// HeaderSize , and DataHeader.Type should be - /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID. + /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID. /// EFI_STATUS_CODE_DATA DataHeader; /// /// The unit number of the computing unit that does not match. - /// + /// UINT32 Instance; - /// - /// The attributes describing the failure. - /// + /// + /// The attributes describing the failure. + /// UINT16 Attributes; } EFI_HOST_PROCESSOR_MISMATCH_ERROR_DATA; /// /// This structure provides details about the computing unit thermal failure. /// -/// This structure provides the temperature at the time of error. It also provides the threshold value +/// This structure provides the temperature at the time of error. It also provides the threshold value /// indicating the minimum temperature that is considered an error. /// typedef struct { @@ -379,7 +379,7 @@ typedef struct { /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be /// sizeof (EFI_COMPUTING_UNIT_THERMAL_ERROR_DATA) - /// HeaderSize , and DataHeader.Type should be - /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID. + /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID. /// EFI_STATUS_CODE_DATA DataHeader; /// @@ -429,7 +429,7 @@ typedef struct { typedef UINT32 EFI_CPU_STATE_CHANGE_CAUSE; /// -/// The reasons that the processor is disabled. +/// The reasons that the processor is disabled. /// Used to fill in EFI_COMPUTING_UNIT_CPU_DISABLED_ERROR_DATA.Cause. /// ///@{ @@ -447,8 +447,8 @@ typedef UINT32 EFI_CPU_STATE_CHANGE_CAUSE; /// /// This structure provides information about the disabled computing unit. /// -/// This structure provides details as to why and how the computing unit was disabled. The causes -/// should cover the typical reasons a processor would be disabled. How the processor was disabled is +/// This structure provides details as to why and how the computing unit was disabled. The causes +/// should cover the typical reasons a processor would be disabled. How the processor was disabled is /// important because there are distinct differences between hardware and software disabling. /// typedef struct { @@ -461,12 +461,12 @@ typedef struct { /// EFI_STATUS_CODE_DATA DataHeader; /// - /// The reason for disabling the processor. - /// + /// The reason for disabling the processor. + /// UINT32 Cause; /// - /// TRUE if the processor is disabled via software means such as not listing it in the ACPI tables. - /// Such a processor will respond to Interprocessor Interrupts (IPIs). FALSE if the processor is hardware + /// TRUE if the processor is disabled via software means such as not listing it in the ACPI tables. + /// Such a processor will respond to Interprocessor Interrupts (IPIs). FALSE if the processor is hardware /// disabled, which means it is invisible to software and will not respond to IPIs. /// BOOLEAN SoftwareDisabled; @@ -504,8 +504,8 @@ typedef UINT8 EFI_MEMORY_ERROR_OPERATION; ///@} /// -/// This structure provides specific details about the memory error that was detected. It provides -/// enough information so that consumers can identify the exact failure and provides enough +/// This structure provides specific details about the memory error that was detected. It provides +/// enough information so that consumers can identify the exact failure and provides enough /// information to enable corrective action if necessary. /// typedef struct { @@ -513,7 +513,7 @@ typedef struct { /// The data header identifying the data. DataHeader.HeaderSize should be /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be /// sizeof (EFI_MEMORY_EXTENDED_ERROR_DATA) - HeaderSize, and - /// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID. + /// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID. /// EFI_STATUS_CODE_DATA DataHeader; /// @@ -521,18 +521,18 @@ typedef struct { /// EFI_MEMORY_ERROR_GRANULARITY Granularity; /// - /// The operation that resulted in the error being detected. + /// The operation that resulted in the error being detected. /// EFI_MEMORY_ERROR_OPERATION Operation; /// - /// The error syndrome, vendor-specific ECC syndrome, or CRC data associated with + /// The error syndrome, vendor-specific ECC syndrome, or CRC data associated with /// the error. If unknown, should be initialized to 0. - /// Inconsistent with specification here: + /// Inconsistent with specification here: /// This field in StatusCodes spec0.9 is defined as UINT32, keep code unchanged. /// UINTN Syndrome; /// - /// The physical address of the error. + /// The physical address of the error. /// EFI_PHYSICAL_ADDRESS Address; /// @@ -543,31 +543,31 @@ typedef struct { /// /// A definition to describe that the operation is performed on multiple devices within the array. -/// May be used for EFI_STATUS_CODE_DIMM_NUMBER.Array and EFI_STATUS_CODE_DIMM_NUMBER.Device. +/// May be used for EFI_STATUS_CODE_DIMM_NUMBER.Array and EFI_STATUS_CODE_DIMM_NUMBER.Device. /// #define EFI_MULTIPLE_MEMORY_DEVICE_OPERATION 0xfffe /// /// A definition to describe that the operation is performed on all devices within the array. -/// May be used for EFI_STATUS_CODE_DIMM_NUMBER.Array and EFI_STATUS_CODE_DIMM_NUMBER.Device. +/// May be used for EFI_STATUS_CODE_DIMM_NUMBER.Array and EFI_STATUS_CODE_DIMM_NUMBER.Device. /// #define EFI_ALL_MEMORY_DEVICE_OPERATION 0xffff /// /// A definition to describe that the operation is performed on multiple arrays. -/// May be used for EFI_STATUS_CODE_DIMM_NUMBER.Array and EFI_STATUS_CODE_DIMM_NUMBER.Device. +/// May be used for EFI_STATUS_CODE_DIMM_NUMBER.Array and EFI_STATUS_CODE_DIMM_NUMBER.Device. /// #define EFI_MULTIPLE_MEMORY_ARRAY_OPERATION 0xfffe /// /// A definition to describe that the operation is performed on all the arrays. -/// May be used for EFI_STATUS_CODE_DIMM_NUMBER.Array and EFI_STATUS_CODE_DIMM_NUMBER.Device. +/// May be used for EFI_STATUS_CODE_DIMM_NUMBER.Array and EFI_STATUS_CODE_DIMM_NUMBER.Device. /// #define EFI_ALL_MEMORY_ARRAY_OPERATION 0xffff /// -/// This extended data provides some context that consumers can use to locate a DIMM within the -/// overall memory scheme. +/// This extended data provides some context that consumers can use to locate a DIMM within the +/// overall memory scheme. /// /// This extended data provides some context that consumers can use to locate a DIMM within the /// overall memory scheme. The Array and Device numbers may indicate a specific DIMM, or they @@ -595,7 +595,7 @@ typedef struct { /// This structure defines extended data describing memory modules that do not match. /// /// This extended data may be used to convey the specifics of memory modules that do not match. -/// +/// typedef struct { /// /// The data header identifying the data. DataHeader.HeaderSize should be @@ -606,7 +606,7 @@ typedef struct { /// EFI_STATUS_CODE_DATA DataHeader; /// - /// The instance number of the memory module that does not match. + /// The instance number of the memory module that does not match. /// EFI_STATUS_CODE_DIMM_NUMBER Instance; } EFI_MEMORY_MODULE_MISMATCH_ERROR_DATA; @@ -614,7 +614,7 @@ typedef struct { /// /// This structure defines extended data describing a memory range. /// -/// This extended data may be used to convey the specifics of a memory range. Ranges are specified +/// This extended data may be used to convey the specifics of a memory range. Ranges are specified /// with a start address and a length. /// typedef struct { @@ -622,11 +622,11 @@ typedef struct { /// The data header identifying the data. DataHeader.HeaderSize should be /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be /// sizeof (EFI_MEMORY_RANGE_EXTENDED_DATA) - HeaderSize, and - /// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID. + /// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID. /// EFI_STATUS_CODE_DATA DataHeader; /// - /// The starting address of the memory range. + /// The starting address of the memory range. /// EFI_PHYSICAL_ADDRESS Start; /// @@ -647,7 +647,7 @@ typedef struct { /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be /// sizeof (EFI_DEBUG_ASSERT_DATA) - HeaderSize , and /// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID. - /// + /// EFI_STATUS_CODE_DATA DataHeader; /// /// The line number of the source file where the fault was generated. @@ -658,7 +658,7 @@ typedef struct { /// UINT32 FileNameSize; /// - /// A pointer to a NULL-terminated ASCII or Unicode string that represents + /// A pointer to a NULL-terminated ASCII or Unicode string that represents /// the file name of the source file where the fault was generated. /// EFI_STATUS_CODE_STRING_DATA *FileName; @@ -691,7 +691,7 @@ typedef union { /// EFI_SYSTEM_CONTEXT_X64 is defined in the /// EFI_DEBUG_SUPPORT_PROTOCOL in the UEFI Specification. /// - EFI_SYSTEM_CONTEXT_X64 SystemContextX64; + EFI_SYSTEM_CONTEXT_X64 SystemContextX64; /// /// The context of the ARM processor when the exception was generated. Type /// EFI_SYSTEM_CONTEXT_ARM is defined in the @@ -713,11 +713,11 @@ typedef struct { /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be /// sizeof (EFI_STATUS_CODE_EXCEP_EXTENDED_DATA) - HeaderSize, /// and DataHeader.Type should be - /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID. + /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID. /// EFI_STATUS_CODE_DATA DataHeader; /// - /// The system context. + /// The system context. /// EFI_STATUS_CODE_EXCEP_SYSTEM_CONTEXT Context; } EFI_STATUS_CODE_EXCEP_EXTENDED_DATA; @@ -729,33 +729,33 @@ typedef struct { /// the UEFI Driver Binding Protocol. /// typedef struct { - /// + /// /// The data header identifying the data. DataHeader.HeaderSize should be /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be /// sizeof (EFI_STATUS_CODE_START_EXTENDED_DATA) - HeaderSize, /// and DataHeader.Type should be - /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID. + /// EFI_STATUS_CODE_SPECIFIC_DATA_GUID. /// EFI_STATUS_CODE_DATA DataHeader; /// - /// The controller handle. + /// The controller handle. /// EFI_HANDLE ControllerHandle; /// /// The driver binding handle. /// EFI_HANDLE DriverBindingHandle; - /// - /// The size of the RemainingDevicePath. It is zero if the Start() function is + /// + /// The size of the RemainingDevicePath. It is zero if the Start() function is /// called with RemainingDevicePath = NULL. The UEFI Specification allows /// that the Start() function of bus drivers can be called in this way. /// UINT16 DevicePathSize; /// - /// Matches the RemainingDevicePath parameter being passed to the Start() function. - /// Note that this parameter is the variable-length device path and not a pointer + /// Matches the RemainingDevicePath parameter being passed to the Start() function. + /// Note that this parameter is the variable-length device path and not a pointer /// to the device path. - /// + /// // EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath; } EFI_STATUS_CODE_START_EXTENDED_DATA; @@ -771,7 +771,7 @@ typedef struct { /// The data header identifying the data. DataHeader.HeaderSize should be /// sizeof (EFI_STATUS_CODE_DATA), DataHeader.Size should be /// sizeof (EFI_LEGACY_OPROM_EXTENDED_DATA) - HeaderSize, and - /// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID. + /// DataHeader.Type should be EFI_STATUS_CODE_SPECIFIC_DATA_GUID. /// EFI_STATUS_CODE_DATA DataHeader; /// @@ -779,7 +779,7 @@ typedef struct { /// EFI_HANDLE DeviceHandle; /// - /// The base address of the shadowed legacy ROM image. May or may not point to the shadow RAM area. + /// The base address of the shadowed legacy ROM image. May or may not point to the shadow RAM area. /// EFI_PHYSICAL_ADDRESS RomImageBase; } EFI_LEGACY_OPROM_EXTENDED_DATA; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/VectorHandoffTable.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/VectorHandoffTable.h index 256b34550f..eb800967a0 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/VectorHandoffTable.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Guid/VectorHandoffTable.h @@ -1,15 +1,15 @@ /** @file GUID for system configuration table entry that points to the table - in case an entity in DXE wishes to update/change the vector table contents. + in case an entity in DXE wishes to update/change the vector table contents. Copyright (c) 2013, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUID defined in PI 1.2.1 spec. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ia32/ProcessorBind.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ia32/ProcessorBind.h index 5d6ebeba1a..69eba6565b 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ia32/ProcessorBind.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ia32/ProcessorBind.h @@ -2,13 +2,13 @@ Processor or Compiler specific defines and types for IA-32 architecture. Copyright (c) 2006 - 2017, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -100,17 +100,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. // // -// This warning is for potentially uninitialized local variable, and it may cause false +// This warning is for potentially uninitialized local variable, and it may cause false // positive issues in VS2013 and VS2015 build // #pragma warning ( disable : 4701 ) - + // -// This warning is for potentially uninitialized local pointer variable, and it may cause +// This warning is for potentially uninitialized local pointer variable, and it may cause // false positive issues in VS2013 and VS2015 build // #pragma warning ( disable : 4703 ) - + #endif #endif @@ -168,7 +168,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /// 1-byte signed value. /// typedef signed char INT8; -#else +#else /// /// 8-byte unsigned value. /// @@ -275,17 +275,17 @@ typedef INT32 INTN; #elif defined(_MSC_EXTENSIONS) /// /// Microsoft* compiler specific method for EFIAPI calling convention. - /// - #define EFIAPI __cdecl + /// + #define EFIAPI __cdecl #elif defined(__GNUC__) /// /// GCC specific method for EFIAPI calling convention. - /// - #define EFIAPI __attribute__((cdecl)) + /// + #define EFIAPI __attribute__((cdecl)) #else /// /// The default for a non Microsoft* or GCC compiler is to assume the EFI ABI - /// is the standard. + /// is the standard. /// #define EFIAPI #endif @@ -300,13 +300,13 @@ typedef INT32 INTN; /** Return the pointer to the first instruction of a function given a function pointer. - On IA-32 CPU architectures, these two pointer values are the same, + On IA-32 CPU architectures, these two pointer values are the same, so the implementation of this macro is very simple. - + @param FunctionPointer A pointer to a function. @return The pointer to the first instruction of a function given a function pointer. - + **/ #define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer) diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi10.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi10.h index 5a17db6ac5..49b7258c55 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi10.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi10.h @@ -1,14 +1,14 @@ -/** @file +/** @file ACPI 1.0b definitions from the ACPI Specification, revision 1.0b Copyright (c) 2006 - 2011, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ #ifndef _ACPI_1_0_H_ @@ -357,7 +357,7 @@ typedef struct { #define EFI_ACPI_DMA_SPEED_TYPE_A 0x20 #define EFI_ACPI_DMA_SPEED_TYPE_B 0x40 #define EFI_ACPI_DMA_SPEED_TYPE_F 0x60 - + #define EFI_ACPI_DMA_BUS_MASTER_MASK 0x04 #define EFI_ACPI_DMA_BUS_MASTER 0x04 @@ -403,7 +403,7 @@ typedef struct { // // Root System Description Table -// No definition needed as it is a common description table header, the same with +// No definition needed as it is a common description table header, the same with // EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT32 table pointers. // diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi20.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi20.h index d84b7db7b7..8cd3a71dbf 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi20.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi20.h @@ -1,14 +1,14 @@ -/** @file +/** @file ACPI 2.0 definitions from the ACPI Specification, revision 2.0 Copyright (c) 2006 - 2011, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ #ifndef _ACPI_2_0_H_ @@ -103,7 +103,7 @@ typedef struct { // // Root System Description Table -// No definition needed as it is a common description table header, the same with +// No definition needed as it is a common description table header, the same with // EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT32 table pointers. // @@ -114,7 +114,7 @@ typedef struct { // // Extended System Description Table -// No definition needed as it is a common description table header, the same with +// No definition needed as it is a common description table header, the same with // EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT64 table pointers. // diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi30.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi30.h index d510d8b934..0a470f2db7 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi30.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi30.h @@ -1,14 +1,14 @@ -/** @file +/** @file ACPI 3.0 definitions from the ACPI Specification Revision 3.0b October 10, 2006 Copyright (c) 2006 - 2011, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ #ifndef _ACPI_3_0_H_ @@ -128,7 +128,7 @@ typedef struct { // // Root System Description Table -// No definition needed as it is a common description table header, the same with +// No definition needed as it is a common description table header, the same with // EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT32 table pointers. // @@ -139,7 +139,7 @@ typedef struct { // // Extended System Description Table -// No definition needed as it is a common description table header, the same with +// No definition needed as it is a common description table header, the same with // EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT64 table pointers. // @@ -597,7 +597,7 @@ typedef struct { /// /// "RSD PTR " Root System Description Pointer /// -#define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ') +#define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ') /// /// "APIC" Multiple APIC Description Table diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi40.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi40.h index 94ae5fc567..30ecdb536f 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi40.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi40.h @@ -1,14 +1,14 @@ -/** @file +/** @file ACPI 4.0 definitions from the ACPI Specification Revision 4.0a April 5, 2010 Copyright (c) 2010 - 2011, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ #ifndef _ACPI_4_0_H_ @@ -86,7 +86,7 @@ typedef struct { // // Root System Description Table -// No definition needed as it is a common description table header, the same with +// No definition needed as it is a common description table header, the same with // EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT32 table pointers. // @@ -97,7 +97,7 @@ typedef struct { // // Extended System Description Table -// No definition needed as it is a common description table header, the same with +// No definition needed as it is a common description table header, the same with // EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT64 table pointers. // @@ -1132,7 +1132,7 @@ typedef struct { /// /// "RSD PTR " Root System Description Pointer /// -#define EFI_ACPI_4_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ') +#define EFI_ACPI_4_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ') /// /// "APIC" Multiple APIC Description Table diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi50.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi50.h index a371c9ade1..34834153e6 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi50.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi50.h @@ -1,15 +1,15 @@ -/** @file +/** @file ACPI 5.0 definitions from the ACPI Specification Revision 5.0a November 13, 2013. Copyright (c) 2014 Hewlett-Packard Development Company, L.P.<BR> Copyright (c) 2011 - 2014, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ #ifndef _ACPI_5_0_H_ @@ -208,7 +208,7 @@ typedef struct { // // Root System Description Table -// No definition needed as it is a common description table header, the same with +// No definition needed as it is a common description table header, the same with // EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT32 table pointers. // @@ -219,7 +219,7 @@ typedef struct { // // Extended System Description Table -// No definition needed as it is a common description table header, the same with +// No definition needed as it is a common description table header, the same with // EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT64 table pointers. // @@ -1876,7 +1876,7 @@ typedef struct { /// /// "RSD PTR " Root System Description Pointer /// -#define EFI_ACPI_5_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ') +#define EFI_ACPI_5_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ') /// /// "APIC" Multiple APIC Description Table diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi51.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi51.h index 457706befd..48c9239a0c 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi51.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi51.h @@ -1,16 +1,16 @@ -/** @file +/** @file ACPI 5.1 definitions from the ACPI Specification Revision 5.1 Errata B January, 2016. Copyright (c) 2014 Hewlett-Packard Development Company, L.P.<BR> Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR> (C) Copyright 2015 Hewlett Packard Enterprise Development LP<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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ #ifndef _ACPI_5_1_H_ @@ -89,7 +89,7 @@ typedef struct { // // Root System Description Table -// No definition needed as it is a common description table header, the same with +// No definition needed as it is a common description table header, the same with // EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT32 table pointers. // @@ -100,7 +100,7 @@ typedef struct { // // Extended System Description Table -// No definition needed as it is a common description table header, the same with +// No definition needed as it is a common description table header, the same with // EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT64 table pointers. // @@ -1874,7 +1874,7 @@ typedef struct { UINT8 CommandComplete:1; UINT8 SciDoorbell:1; UINT8 Error:1; - UINT8 PlatformNotification:1; + UINT8 PlatformNotification:1; UINT8 Reserved:4; UINT8 Reserved1; } EFI_ACPI_5_1_PCCT_GENERIC_SHARED_MEMORY_REGION_STATUS; @@ -1892,7 +1892,7 @@ typedef struct { /// /// "RSD PTR " Root System Description Pointer /// -#define EFI_ACPI_5_1_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ') +#define EFI_ACPI_5_1_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ') /// /// "APIC" Multiple APIC Description Table diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi60.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi60.h index 6bc9b0e1f6..aad2f989f1 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi60.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi60.h @@ -1,15 +1,15 @@ -/** @file +/** @file ACPI 6.0 definitions from the ACPI Specification Revision 6.0 Errata A January, 2016. Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR> (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ #ifndef _ACPI_6_0_H_ @@ -88,7 +88,7 @@ typedef struct { // // Root System Description Table -// No definition needed as it is a common description table header, the same with +// No definition needed as it is a common description table header, the same with // EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT32 table pointers. // @@ -99,7 +99,7 @@ typedef struct { // // Extended System Description Table -// No definition needed as it is a common description table header, the same with +// No definition needed as it is a common description table header, the same with // EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT64 table pointers. // @@ -2063,7 +2063,7 @@ typedef struct { UINT8 CommandComplete:1; UINT8 SciDoorbell:1; UINT8 Error:1; - UINT8 PlatformNotification:1; + UINT8 PlatformNotification:1; UINT8 Reserved:4; UINT8 Reserved1; } EFI_ACPI_6_0_PCCT_GENERIC_SHARED_MEMORY_REGION_STATUS; @@ -2125,7 +2125,7 @@ typedef struct { /// /// "RSD PTR " Root System Description Pointer /// -#define EFI_ACPI_6_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ') +#define EFI_ACPI_6_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ') /// /// "APIC" Multiple APIC Description Table diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi61.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi61.h index 71a2f02508..63738ad21c 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi61.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Acpi61.h @@ -1,15 +1,15 @@ -/** @file +/** @file ACPI 6.1 definitions from the ACPI Specification Revision 6.1 January, 2016. Copyright (c) 2016 - 2017, Intel Corporation. All rights reserved.<BR> (C) Copyright 2016 Hewlett Packard Enterprise Development LP<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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ #ifndef _ACPI_6_1_H_ @@ -88,7 +88,7 @@ typedef struct { // // Root System Description Table -// No definition needed as it is a common description table header, the same with +// No definition needed as it is a common description table header, the same with // EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT32 table pointers. // @@ -99,7 +99,7 @@ typedef struct { // // Extended System Description Table -// No definition needed as it is a common description table header, the same with +// No definition needed as it is a common description table header, the same with // EFI_ACPI_DESCRIPTION_HEADER, followed by a variable number of UINT64 table pointers. // @@ -2095,7 +2095,7 @@ typedef struct { UINT8 CommandComplete:1; UINT8 SciDoorbell:1; UINT8 Error:1; - UINT8 PlatformNotification:1; + UINT8 PlatformNotification:1; UINT8 Reserved:4; UINT8 Reserved1; } EFI_ACPI_6_1_PCCT_GENERIC_SHARED_MEMORY_REGION_STATUS; @@ -2157,7 +2157,7 @@ typedef struct { /// /// "RSD PTR " Root System Description Pointer /// -#define EFI_ACPI_6_1_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ') +#define EFI_ACPI_6_1_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ') /// /// "APIC" Multiple APIC Description Table diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/AlertStandardFormatTable.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/AlertStandardFormatTable.h index e7658541a3..886bca7219 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/AlertStandardFormatTable.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/AlertStandardFormatTable.h @@ -1,14 +1,14 @@ -/** @file +/** @file ACPI Alert Standard Format Description Table ASF! as described in the ASF2.0 Specification Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ #ifndef _ALERT_STANDARD_FORMAT_TABLE_H_ @@ -31,7 +31,7 @@ typedef struct { } EFI_ACPI_ASF_RECORD_HEADER; /// -/// This structure contains information that identifies the system's type +/// This structure contains information that identifies the system's type /// and configuration /// typedef struct { @@ -84,7 +84,7 @@ typedef struct { UINT8 DeviceAddress; UINT8 Command; UINT8 DataValue; -} EFI_ACPI_ASF_CONTROLDATA; +} EFI_ACPI_ASF_CONTROLDATA; /// /// Alert Remote Control System Actions diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Atapi.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Atapi.h index cb1fae429f..d54d0429ff 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Atapi.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Atapi.h @@ -3,12 +3,12 @@ that dealing with ATA/ATAPI interface. Copyright (c) 2007 - 2016, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +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. **/ @@ -21,59 +21,59 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /// /// ATA5_IDENTIFY_DATA is defined in ATA-5. /// (This structure is provided mainly for backward-compatibility support. -/// Old drivers may reference fields that are marked "obsolete" in -/// ATA_IDENTIFY_DATA, which currently conforms to ATA-8.) +/// Old drivers may reference fields that are marked "obsolete" in +/// ATA_IDENTIFY_DATA, which currently conforms to ATA-8.) /// -typedef struct { +typedef struct { UINT16 config; ///< General Configuration. UINT16 cylinders; ///< Number of Cylinders. - UINT16 reserved_2; - UINT16 heads; ///< Number of logical heads. - UINT16 vendor_data1; - UINT16 vendor_data2; - UINT16 sectors_per_track; - UINT16 vendor_specific_7_9[3]; - CHAR8 SerialNo[20]; ///< ASCII - UINT16 vendor_specific_20_21[2]; - UINT16 ecc_bytes_available; - CHAR8 FirmwareVer[8]; ///< ASCII - CHAR8 ModelName[40]; ///< ASCII - UINT16 multi_sector_cmd_max_sct_cnt; - UINT16 reserved_48; - UINT16 capabilities; - UINT16 reserved_50; - UINT16 pio_cycle_timing; - UINT16 reserved_52; - UINT16 field_validity; - UINT16 current_cylinders; - UINT16 current_heads; - UINT16 current_sectors; - UINT16 CurrentCapacityLsb; - UINT16 CurrentCapacityMsb; - UINT16 reserved_59; - UINT16 user_addressable_sectors_lo; - UINT16 user_addressable_sectors_hi; - UINT16 reserved_62; - UINT16 multi_word_dma_mode; - UINT16 advanced_pio_modes; - UINT16 min_multi_word_dma_cycle_time; - UINT16 rec_multi_word_dma_cycle_time; - UINT16 min_pio_cycle_time_without_flow_control; - UINT16 min_pio_cycle_time_with_flow_control; - UINT16 reserved_69_79[11]; - UINT16 major_version_no; - UINT16 minor_version_no; - UINT16 command_set_supported_82; ///< word 82 - UINT16 command_set_supported_83; ///< word 83 - UINT16 command_set_feature_extn; ///< word 84 - UINT16 command_set_feature_enb_85; ///< word 85 - UINT16 command_set_feature_enb_86; ///< word 86 - UINT16 command_set_feature_default; ///< word 87 - UINT16 ultra_dma_mode; ///< word 88 - UINT16 reserved_89_127[39]; - UINT16 security_status; - UINT16 vendor_data_129_159[31]; - UINT16 reserved_160_255[96]; + UINT16 reserved_2; + UINT16 heads; ///< Number of logical heads. + UINT16 vendor_data1; + UINT16 vendor_data2; + UINT16 sectors_per_track; + UINT16 vendor_specific_7_9[3]; + CHAR8 SerialNo[20]; ///< ASCII + UINT16 vendor_specific_20_21[2]; + UINT16 ecc_bytes_available; + CHAR8 FirmwareVer[8]; ///< ASCII + CHAR8 ModelName[40]; ///< ASCII + UINT16 multi_sector_cmd_max_sct_cnt; + UINT16 reserved_48; + UINT16 capabilities; + UINT16 reserved_50; + UINT16 pio_cycle_timing; + UINT16 reserved_52; + UINT16 field_validity; + UINT16 current_cylinders; + UINT16 current_heads; + UINT16 current_sectors; + UINT16 CurrentCapacityLsb; + UINT16 CurrentCapacityMsb; + UINT16 reserved_59; + UINT16 user_addressable_sectors_lo; + UINT16 user_addressable_sectors_hi; + UINT16 reserved_62; + UINT16 multi_word_dma_mode; + UINT16 advanced_pio_modes; + UINT16 min_multi_word_dma_cycle_time; + UINT16 rec_multi_word_dma_cycle_time; + UINT16 min_pio_cycle_time_without_flow_control; + UINT16 min_pio_cycle_time_with_flow_control; + UINT16 reserved_69_79[11]; + UINT16 major_version_no; + UINT16 minor_version_no; + UINT16 command_set_supported_82; ///< word 82 + UINT16 command_set_supported_83; ///< word 83 + UINT16 command_set_feature_extn; ///< word 84 + UINT16 command_set_feature_enb_85; ///< word 85 + UINT16 command_set_feature_enb_86; ///< word 86 + UINT16 command_set_feature_default; ///< word 87 + UINT16 ultra_dma_mode; ///< word 88 + UINT16 reserved_89_127[39]; + UINT16 security_status; + UINT16 vendor_data_129_159[31]; + UINT16 reserved_160_255[96]; } ATA5_IDENTIFY_DATA; /// @@ -86,50 +86,50 @@ typedef struct { UINT16 obsolete_1; UINT16 specific_config; ///< Specific Configuration. UINT16 obsolete_3; - UINT16 retired_4_5[2]; + UINT16 retired_4_5[2]; UINT16 obsolete_6; UINT16 cfa_reserved_7_8[2]; - UINT16 retired_9; + UINT16 retired_9; CHAR8 SerialNo[20]; ///< word 10~19 - UINT16 retired_20_21[2]; - UINT16 obsolete_22; + UINT16 retired_20_21[2]; + UINT16 obsolete_22; CHAR8 FirmwareVer[8]; ///< word 23~26 CHAR8 ModelName[40]; ///< word 27~46 UINT16 multi_sector_cmd_max_sct_cnt; - UINT16 trusted_computing_support; + UINT16 trusted_computing_support; UINT16 capabilities_49; UINT16 capabilities_50; - UINT16 obsolete_51_52[2]; - UINT16 field_validity; - UINT16 obsolete_54_58[5]; + UINT16 obsolete_51_52[2]; + UINT16 field_validity; + UINT16 obsolete_54_58[5]; UINT16 multi_sector_setting; - UINT16 user_addressable_sectors_lo; - UINT16 user_addressable_sectors_hi; - UINT16 obsolete_62; - UINT16 multi_word_dma_mode; - UINT16 advanced_pio_modes; - UINT16 min_multi_word_dma_cycle_time; - UINT16 rec_multi_word_dma_cycle_time; - UINT16 min_pio_cycle_time_without_flow_control; - UINT16 min_pio_cycle_time_with_flow_control; + UINT16 user_addressable_sectors_lo; + UINT16 user_addressable_sectors_hi; + UINT16 obsolete_62; + UINT16 multi_word_dma_mode; + UINT16 advanced_pio_modes; + UINT16 min_multi_word_dma_cycle_time; + UINT16 rec_multi_word_dma_cycle_time; + UINT16 min_pio_cycle_time_without_flow_control; + UINT16 min_pio_cycle_time_with_flow_control; UINT16 additional_supported; ///< word 69 UINT16 reserved_70; UINT16 reserved_71_74[4]; ///< Reserved for IDENTIFY PACKET DEVICE cmd. - UINT16 queue_depth; + UINT16 queue_depth; UINT16 serial_ata_capabilities; UINT16 reserved_77; ///< Reserved for Serial ATA UINT16 serial_ata_features_supported; UINT16 serial_ata_features_enabled; - UINT16 major_version_no; - UINT16 minor_version_no; + UINT16 major_version_no; + UINT16 minor_version_no; UINT16 command_set_supported_82; ///< word 82 UINT16 command_set_supported_83; ///< word 83 UINT16 command_set_feature_extn; ///< word 84 UINT16 command_set_feature_enb_85; ///< word 85 UINT16 command_set_feature_enb_86; ///< word 86 UINT16 command_set_feature_default; ///< word 87 - UINT16 ultra_dma_mode; ///< word 88 - UINT16 time_for_security_erase_unit; + UINT16 ultra_dma_mode; ///< word 88 + UINT16 time_for_security_erase_unit; UINT16 time_for_enhanced_security_erase_unit; UINT16 advanced_power_management_level; UINT16 master_password_identifier; @@ -154,7 +154,7 @@ typedef struct { UINT16 reserved_121_126[6]; UINT16 obsolete_127; UINT16 security_status; ///< word 128 - UINT16 vendor_specific_129_159[31]; + UINT16 vendor_specific_129_159[31]; UINT16 cfa_power_mode; ///< word 160 UINT16 reserved_for_compactflash_161_167[7]; UINT16 device_nominal_form_factor; @@ -239,7 +239,7 @@ typedef struct { UINT16 reserved_95_107[13]; UINT16 world_wide_name[4]; ///< word 108~111 UINT16 reserved_for_128bit_wwn_112_115[4]; - UINT16 reserved_116_118[3]; + UINT16 reserved_116_118[3]; UINT16 command_and_feature_sets_supported; ///< word 119 UINT16 command_and_feature_sets_supported_enabled; UINT16 reserved_121_124[4]; @@ -458,7 +458,7 @@ typedef struct { /// /// ATAPI_PACKET_COMMAND is not defined in the ATA specification. -/// We add it here for the convenience of ATA/ATAPI module writers. +/// We add it here for the convenience of ATA/ATAPI module writers. /// typedef union { UINT16 Data16[6]; @@ -477,7 +477,7 @@ typedef union { #define ATAPI_MAX_DMA_CMD_SECTORS 0x100 // ATA/ATAPI Signature equates -#define ATA_SIGNATURE 0x0101 ///< defined in ACS-3 +#define ATA_SIGNATURE 0x0101 ///< defined in ACS-3 #define ATAPI_SIGNATURE 0xeb14 ///< defined in ACS-3 #define ATAPI_SIGNATURE_32 0xeb140101 ///< defined in ACS-3 @@ -521,11 +521,11 @@ typedef union { #define ATA_CMD_GET_CONFIGURATION 0x46 ///< defined in ATAPI Multimedia Devices #define ATA_GCCD_RT_FIELD_VALUE_ALL 0x00 ///< defined in ATAPI Multimedia Devices #define ATA_GCCD_RT_FIELD_VALUE_CURRENT 0x01 ///< defined in ATAPI Multimedia Devices - #define ATA_GCCD_RT_FIELD_VALUE_SINGLE 0x02 ///< defined in ATAPI Multimedia Devices - #define ATA_GCCD_RT_FIELD_VALUE_RESERVED 0x03 ///< defined in ATAPI Multimedia Devices - + #define ATA_GCCD_RT_FIELD_VALUE_SINGLE 0x02 ///< defined in ATAPI Multimedia Devices + #define ATA_GCCD_RT_FIELD_VALUE_RESERVED 0x03 ///< defined in ATAPI Multimedia Devices + #define ATA_FEATURE_LIST_PROFILE_LIST 0x0000 ///< defined in ATAPI Multimedia Devices - #define ATA_FEATURE_LIST_CORE 0x0001 ///< defined in ATAPI Multimedia Devices + #define ATA_FEATURE_LIST_CORE 0x0001 ///< defined in ATAPI Multimedia Devices #define ATA_FEATURE_LIST_MORPHING 0x0002 ///< defined in ATAPI Multimedia Devices #define ATA_FEATURE_LIST_REMOVEABLE_MEDIUM 0x0003 ///< defined in ATAPI Multimedia Devices #define ATA_FEATURE_LIST_WRITE_PROTECT 0x0004 ///< defined in ATAPI Multimedia Devices @@ -549,33 +549,33 @@ typedef union { // #define ATA_CMD_IDENTIFY_DRIVE 0xec ///< defined from ATA-3 #define ATA_CMD_READ_BUFFER 0xe4 ///< defined from ATA-1 -#define ATA_CMD_READ_SECTORS 0x20 ///< defined from ATA-1 +#define ATA_CMD_READ_SECTORS 0x20 ///< defined from ATA-1 #define ATA_CMD_READ_SECTORS_WITH_RETRY 0x21 ///< defined from ATA-1, obsoleted from ATA-5 #define ATA_CMD_READ_LONG 0x22 ///< defined from ATA-1, obsoleted from ATA-5 #define ATA_CMD_READ_LONG_WITH_RETRY 0x23 ///< defined from ATA-1, obsoleted from ATA-5 #define ATA_CMD_READ_SECTORS_EXT 0x24 ///< defined from ATA-6 -#define ATA_CMD_READ_MULTIPLE 0xc4 ///< defined in ACS-3 -#define ATA_CMD_READ_MULTIPLE_EXT 0x29 ///< defined in ACS-3 -#define ATA_CMD_READ_LOG_EXT 0x2f ///< defined in ACS-3 +#define ATA_CMD_READ_MULTIPLE 0xc4 ///< defined in ACS-3 +#define ATA_CMD_READ_MULTIPLE_EXT 0x29 ///< defined in ACS-3 +#define ATA_CMD_READ_LOG_EXT 0x2f ///< defined in ACS-3 // // Class 2: PIO Data-Out Commands // #define ATA_CMD_FORMAT_TRACK 0x50 ///< defined from ATA-1, obsoleted from ATA-4 -#define ATA_CMD_WRITE_BUFFER 0xe8 ///< defined from ATA-1 +#define ATA_CMD_WRITE_BUFFER 0xe8 ///< defined from ATA-1 #define ATA_CMD_WRITE_SECTORS 0x30 ///< defined from ATA-1 #define ATA_CMD_WRITE_SECTORS_WITH_RETRY 0x31 ///< defined from ATA-1, obsoleted from ATA-5 #define ATA_CMD_WRITE_LONG 0x32 ///< defined from ATA-1, obsoleted from ATA-5 #define ATA_CMD_WRITE_LONG_WITH_RETRY 0x33 ///< defined from ATA-1, obsoleted from ATA-5 #define ATA_CMD_WRITE_VERIFY 0x3c ///< defined from ATA-1, obsoleted from ATA-5 #define ATA_CMD_WRITE_SECTORS_EXT 0x34 ///< defined from ATA-6 -#define ATA_CMD_WRITE_MULTIPLE 0xc5 ///< defined in ACS-3 -#define ATA_CMD_WRITE_MULTIPLE_EXT 0x39 ///< defined in ACS-3 +#define ATA_CMD_WRITE_MULTIPLE 0xc5 ///< defined in ACS-3 +#define ATA_CMD_WRITE_MULTIPLE_EXT 0x39 ///< defined in ACS-3 // // Class 3 No Data Command // -#define ATA_CMD_ACK_MEDIA_CHANGE 0xdb ///< defined from ATA-1, obsoleted from ATA-5 +#define ATA_CMD_ACK_MEDIA_CHANGE 0xdb ///< defined from ATA-1, obsoleted from ATA-5 #define ATA_CMD_BOOT_POST_BOOT 0xdc ///< defined from ATA-1, obsoleted from ATA-3 #define ATA_CMD_BOOT_PRE_BOOT 0xdd ///< defined from ATA-1, obsoleted from ATA-3 #define ATA_CMD_CHECK_POWER_MODE 0x98 ///< defined from ATA-1, obsoleted from ATA-4 @@ -599,39 +599,39 @@ typedef union { #define ATA_CMD_STANDBY_ALIAS 0xe2 ///< defined from ATA-1 #define ATA_CMD_STANDBY_IMMEDIATE 0x94 ///< defined from ATA-1, obsoleted from ATA-4 #define ATA_CMD_STANDBY_IMMEDIATE_ALIAS 0xe0 ///< defined from ATA-1 -#define ATA_CMD_SLEEP 0xe6 ///< defined in ACS-3 -#define ATA_CMD_READ_NATIVE_MAX_ADDRESS 0xf8 ///< defined in ATA-6 -#define ATA_CMD_READ_NATIVE_MAX_ADDRESS_EXT 0x27 ///< defined in ATA-6 +#define ATA_CMD_SLEEP 0xe6 ///< defined in ACS-3 +#define ATA_CMD_READ_NATIVE_MAX_ADDRESS 0xf8 ///< defined in ATA-6 +#define ATA_CMD_READ_NATIVE_MAX_ADDRESS_EXT 0x27 ///< defined in ATA-6 // // Set Features Sub Command // -#define ATA_SUB_CMD_ENABLE_VOLATILE_WRITE_CACHE 0x02 ///< defined in ACS-3 -#define ATA_SUB_CMD_SET_TRANSFER_MODE 0x03 ///< defined in ACS-3 -#define ATA_SUB_CMD_ENABLE_APM 0x05 ///< defined in ACS-3 -#define ATA_SUB_CMD_ENABLE_PUIS 0x06 ///< defined in ACS-3 -#define ATA_SUB_CMD_PUIS_SET_DEVICE_SPINUP 0x07 ///< defined in ACS-3 -#define ATA_SUB_CMD_ENABLE_WRITE_READ_VERIFY 0x0b ///< defined in ACS-3 -#define ATA_SUB_CMD_ENABLE_SATA_FEATURE 0x10 ///< defined in ACS-3 -#define ATA_SUB_CMD_DISABLE_MEDIA_STATUS_NOTIFICATION 0x31 ///< defined in ACS-3 -#define ATA_SUB_CMD_ENABLE_FREE_FALL_CONTROL 0x41 ///< defined in ACS-3 -#define ATA_SUB_CMD_ACOUSTIC_MANAGEMENT_ENABLE 0x42 ///< defined in ACS-3 -#define ATA_SUB_CMD_SET_MAX_HOST_INTERFACE_SECTOR_TIMES 0x43 ///< defined in ACS-3 -#define ATA_SUB_CMD_EXTENDED_POWER_CONDITIONS 0x4a ///< defined in ACS-3 -#define ATA_SUB_CMD_DISABLE_READ_LOOK_AHEAD 0x55 ///< defined in ACS-3 -#define ATA_SUB_CMD_EN_DIS_DSN_FEATURE 0x63 ///< defined in ACS-3 -#define ATA_SUB_CMD_DISABLE_REVERT_TO_POWER_ON_DEFAULTS 0x66 ///< defined in ACS-3 -#define ATA_SUB_CMD_DISABLE_VOLATILE_WRITE_CACHE 0x82 ///< defined in ACS-3 -#define ATA_SUB_CMD_DISABLE_APM 0x85 ///< defined in ACS-3 -#define ATA_SUB_CMD_DISABLE_PUIS 0x86 ///< defined in ACS-3 -#define ATA_SUB_CMD_DISABLE_WRITE_READ_VERIFY 0x8b ///< defined in ACS-3 -#define ATA_SUB_CMD_DISABLE_SATA_FEATURE 0x90 ///< defined in ACS-3 -#define ATA_SUB_CMD_ENABLE_MEDIA_STATUS_NOTIFICATION 0x95 ///< defined in ACS-3 -#define ATA_SUB_CMD_ENABLE_READ_LOOK_AHEAD 0xaa ///< defined in ACS-3 -#define ATA_SUB_CMD_DISABLE_FREE_FALL_CONTROL 0xc1 ///< defined in ACS-3 -#define ATA_SUB_CMD_ACOUSTIC_MANAGEMENT_DISABLE 0xc2 ///< defined in ACS-3 -#define ATA_SUB_CMD_EN_DIS_SENSE_DATA_REPORTING 0xc3 ///< defined in ACS-3 -#define ATA_SUB_CMD_ENABLE_REVERT_TO_POWER_ON_DEFAULTS 0xcc ///< defined in ACS-3 +#define ATA_SUB_CMD_ENABLE_VOLATILE_WRITE_CACHE 0x02 ///< defined in ACS-3 +#define ATA_SUB_CMD_SET_TRANSFER_MODE 0x03 ///< defined in ACS-3 +#define ATA_SUB_CMD_ENABLE_APM 0x05 ///< defined in ACS-3 +#define ATA_SUB_CMD_ENABLE_PUIS 0x06 ///< defined in ACS-3 +#define ATA_SUB_CMD_PUIS_SET_DEVICE_SPINUP 0x07 ///< defined in ACS-3 +#define ATA_SUB_CMD_ENABLE_WRITE_READ_VERIFY 0x0b ///< defined in ACS-3 +#define ATA_SUB_CMD_ENABLE_SATA_FEATURE 0x10 ///< defined in ACS-3 +#define ATA_SUB_CMD_DISABLE_MEDIA_STATUS_NOTIFICATION 0x31 ///< defined in ACS-3 +#define ATA_SUB_CMD_ENABLE_FREE_FALL_CONTROL 0x41 ///< defined in ACS-3 +#define ATA_SUB_CMD_ACOUSTIC_MANAGEMENT_ENABLE 0x42 ///< defined in ACS-3 +#define ATA_SUB_CMD_SET_MAX_HOST_INTERFACE_SECTOR_TIMES 0x43 ///< defined in ACS-3 +#define ATA_SUB_CMD_EXTENDED_POWER_CONDITIONS 0x4a ///< defined in ACS-3 +#define ATA_SUB_CMD_DISABLE_READ_LOOK_AHEAD 0x55 ///< defined in ACS-3 +#define ATA_SUB_CMD_EN_DIS_DSN_FEATURE 0x63 ///< defined in ACS-3 +#define ATA_SUB_CMD_DISABLE_REVERT_TO_POWER_ON_DEFAULTS 0x66 ///< defined in ACS-3 +#define ATA_SUB_CMD_DISABLE_VOLATILE_WRITE_CACHE 0x82 ///< defined in ACS-3 +#define ATA_SUB_CMD_DISABLE_APM 0x85 ///< defined in ACS-3 +#define ATA_SUB_CMD_DISABLE_PUIS 0x86 ///< defined in ACS-3 +#define ATA_SUB_CMD_DISABLE_WRITE_READ_VERIFY 0x8b ///< defined in ACS-3 +#define ATA_SUB_CMD_DISABLE_SATA_FEATURE 0x90 ///< defined in ACS-3 +#define ATA_SUB_CMD_ENABLE_MEDIA_STATUS_NOTIFICATION 0x95 ///< defined in ACS-3 +#define ATA_SUB_CMD_ENABLE_READ_LOOK_AHEAD 0xaa ///< defined in ACS-3 +#define ATA_SUB_CMD_DISABLE_FREE_FALL_CONTROL 0xc1 ///< defined in ACS-3 +#define ATA_SUB_CMD_ACOUSTIC_MANAGEMENT_DISABLE 0xc2 ///< defined in ACS-3 +#define ATA_SUB_CMD_EN_DIS_SENSE_DATA_REPORTING 0xc3 ///< defined in ACS-3 +#define ATA_SUB_CMD_ENABLE_REVERT_TO_POWER_ON_DEFAULTS 0xcc ///< defined in ACS-3 // // S.M.A.R.T @@ -640,13 +640,13 @@ typedef union { #define ATA_CONSTANT_C2 0xc2 ///< reserved #define ATA_CONSTANT_4F 0x4f ///< reserved -#define ATA_SMART_READ_DATA 0xd0 ///< defined in ACS-3 +#define ATA_SMART_READ_DATA 0xd0 ///< defined in ACS-3 -#define ATA_SMART_AUTOSAVE 0xd2 ///< defined in ACS-3 +#define ATA_SMART_AUTOSAVE 0xd2 ///< defined in ACS-3 #define ATA_AUTOSAVE_DISABLE_ATTR 0x00 #define ATA_AUTOSAVE_ENABLE_ATTR 0xf1 -#define ATA_SMART_EXECUTE_OFFLINE_IMMEDIATE 0xd4 ///< defined in ACS-3 +#define ATA_SMART_EXECUTE_OFFLINE_IMMEDIATE 0xd4 ///< defined in ACS-3 #define ATA_EXECUTE_SMART_OFFLINE_ROUTINE 0x00 ///< defined in ACS-3 #define ATA_EXECUTE_SMART_OFFLINE_SHORT_SELFTEST 0x01 ///< defined in ACS-3 #define ATA_EXECUTE_SMART_OFFLINE_EXTENDED_SELFTEST 0x02 ///< defined in ACS-3 @@ -658,25 +658,25 @@ typedef union { #define ATA_EXECUTE_SMART_CAPTIVE_CONVEYANCE_SELFTEST 0x83 ///< defined in ACS-3 #define ATA_EXECUTE_SMART_CAPTIVE_SELECTIVE_SELFTEST 0x84 ///< defined in ACS-3 -#define ATA_SMART_READLOG 0xd5 ///< defined in ACS-3 -#define ATA_SMART_WRITELOG 0xd6 ///< defined in ACS-3 +#define ATA_SMART_READLOG 0xd5 ///< defined in ACS-3 +#define ATA_SMART_WRITELOG 0xd6 ///< defined in ACS-3 #define ATA_SMART_ENABLE_OPERATION 0xd8 ///< reserved -#define ATA_SMART_DISABLE_OPERATION 0xd9 ///< defined in ACS-3 +#define ATA_SMART_DISABLE_OPERATION 0xd9 ///< defined in ACS-3 #define ATA_SMART_RETURN_STATUS 0xda ///< defined from ATA-3 -#define ATA_SMART_THRESHOLD_NOT_EXCEEDED_VALUE 0xc24f ///< defined in ACS-3 -#define ATA_SMART_THRESHOLD_EXCEEDED_VALUE 0x2cf4 ///< defined in ACS-3 +#define ATA_SMART_THRESHOLD_NOT_EXCEEDED_VALUE 0xc24f ///< defined in ACS-3 +#define ATA_SMART_THRESHOLD_EXCEEDED_VALUE 0x2cf4 ///< defined in ACS-3 // SMART Log Definitions -#define ATA_SMART_LOG_DIRECTORY 0x00 ///< defined in ACS-3 -#define ATA_SMART_SUM_SMART_ERROR_LOG 0x01 ///< defined in ACS-3 -#define ATA_SMART_COMP_SMART_ERROR_LOG 0x02 ///< defined in ACS-3 -#define ATA_SMART_EXT_COMP_SMART_ERROR_LOG 0x03 ///< defined in ACS-3 -#define ATA_SMART_SMART_SELFTEST_LOG 0x06 ///< defined in ACS-3 -#define ATA_SMART_EXT_SMART_SELFTEST_LOG 0x07 ///< defined in ACS-3 -#define ATA_SMART_SELECTIVE_SELFTEST_LOG 0x09 ///< defined in ACS-3 -#define ATA_SMART_HOST_VENDOR_SPECIFIC 0x80 ///< defined in ACS-3 -#define ATA_SMART_DEVICE_VENDOR_SPECIFIC 0xa0 ///< defined in ACS-3 +#define ATA_SMART_LOG_DIRECTORY 0x00 ///< defined in ACS-3 +#define ATA_SMART_SUM_SMART_ERROR_LOG 0x01 ///< defined in ACS-3 +#define ATA_SMART_COMP_SMART_ERROR_LOG 0x02 ///< defined in ACS-3 +#define ATA_SMART_EXT_COMP_SMART_ERROR_LOG 0x03 ///< defined in ACS-3 +#define ATA_SMART_SMART_SELFTEST_LOG 0x06 ///< defined in ACS-3 +#define ATA_SMART_EXT_SMART_SELFTEST_LOG 0x07 ///< defined in ACS-3 +#define ATA_SMART_SELECTIVE_SELFTEST_LOG 0x09 ///< defined in ACS-3 +#define ATA_SMART_HOST_VENDOR_SPECIFIC 0x80 ///< defined in ACS-3 +#define ATA_SMART_DEVICE_VENDOR_SPECIFIC 0xa0 ///< defined in ACS-3 // // Class 4: DMA Command @@ -687,18 +687,18 @@ typedef union { #define ATA_CMD_WRITE_DMA 0xca ///< defined from ATA-1 #define ATA_CMD_WRITE_DMA_WITH_RETRY 0xcb ///< defined from ATA-1, obsoleted from ATA- #define ATA_CMD_WRITE_DMA_EXT 0x35 ///< defined from ATA-6 - + // // ATA Security commands // -#define ATA_CMD_SECURITY_SET_PASSWORD 0xf1 ///< defined in ACS-3 -#define ATA_CMD_SECURITY_UNLOCK 0xf2 ///< defined in ACS-3 -#define ATA_CMD_SECURITY_ERASE_PREPARE 0xf3 ///< defined in ACS-3 -#define ATA_CMD_SECURITY_ERASE_UNIT 0xf4 ///< defined in ACS-3 -#define ATA_CMD_SECURITY_FREEZE_LOCK 0xf5 ///< defined in ACS-3 -#define ATA_CMD_SECURITY_DISABLE_PASSWORD 0xf6 ///< defined in ACS-3 +#define ATA_CMD_SECURITY_SET_PASSWORD 0xf1 ///< defined in ACS-3 +#define ATA_CMD_SECURITY_UNLOCK 0xf2 ///< defined in ACS-3 +#define ATA_CMD_SECURITY_ERASE_PREPARE 0xf3 ///< defined in ACS-3 +#define ATA_CMD_SECURITY_ERASE_UNIT 0xf4 ///< defined in ACS-3 +#define ATA_CMD_SECURITY_FREEZE_LOCK 0xf5 ///< defined in ACS-3 +#define ATA_CMD_SECURITY_DISABLE_PASSWORD 0xf6 ///< defined in ACS-3 -#define ATA_SECURITY_BUFFER_LENGTH 512 ///< defined in ACS-3 +#define ATA_SECURITY_BUFFER_LENGTH 512 ///< defined in ACS-3 // // ATA Device Config Overlay @@ -712,19 +712,19 @@ typedef union { // // ATA Trusted Computing Feature Set Commands // -#define ATA_CMD_TRUSTED_NON_DATA 0x5b ///< defined in ACS-3 -#define ATA_CMD_TRUSTED_RECEIVE 0x5c ///< defined in ACS-3 -#define ATA_CMD_TRUSTED_RECEIVE_DMA 0x5d ///< defined in ACS-3 -#define ATA_CMD_TRUSTED_SEND 0x5e ///< defined in ACS-3 -#define ATA_CMD_TRUSTED_SEND_DMA 0x5f ///< defined in ACS-3 +#define ATA_CMD_TRUSTED_NON_DATA 0x5b ///< defined in ACS-3 +#define ATA_CMD_TRUSTED_RECEIVE 0x5c ///< defined in ACS-3 +#define ATA_CMD_TRUSTED_RECEIVE_DMA 0x5d ///< defined in ACS-3 +#define ATA_CMD_TRUSTED_SEND 0x5e ///< defined in ACS-3 +#define ATA_CMD_TRUSTED_SEND_DMA 0x5f ///< defined in ACS-3 // // ATA Trusted Receive Fields // -#define ATA_TR_RETURN_SECURITY_PROTOCOL_INFORMATION 0x00 ///< defined in ACS-3 -#define ATA_TR_SECURITY_PROTOCOL_JEDEC_RESERVED 0xec ///< defined in ACS-3 -#define ATA_TR_SECURITY_PROTOCOL_SDCARD_RESERVED 0xed ///< defined in ACS-3 -#define ATA_TR_SECURITY_PROTOCOL_IEEE1667_RESERVED 0xee ///< defined in ACS-3 +#define ATA_TR_RETURN_SECURITY_PROTOCOL_INFORMATION 0x00 ///< defined in ACS-3 +#define ATA_TR_SECURITY_PROTOCOL_JEDEC_RESERVED 0xec ///< defined in ACS-3 +#define ATA_TR_SECURITY_PROTOCOL_SDCARD_RESERVED 0xed ///< defined in ACS-3 +#define ATA_TR_SECURITY_PROTOCOL_IEEE1667_RESERVED 0xee ///< defined in ACS-3 // // Equates used for Acoustic Flags @@ -732,18 +732,18 @@ typedef union { #define ATA_ACOUSTIC_LEVEL_BYPASS 0xff ///< defined from ATA-6 #define ATA_ACOUSTIC_LEVEL_MAXIMUM_PERFORMANCE 0xfe ///< defined from ATA-6 #define ATA_ACOUSTIC_LEVEL_QUIET 0x80 ///< defined from ATA-6 - + // // Equates used for DiPM Support // -#define ATA_CMD_DIPM_SUB 0x03 // defined in ACS-3 : Count value in SetFeature identification : 03h Device-initiated interface power state transitions - #define ATA_DIPM_ENABLE 0x10 // defined in ACS-3 - #define ATA_DIPM_DISABLE 0x90 // defined in ACS-3 +#define ATA_CMD_DIPM_SUB 0x03 // defined in ACS-3 : Count value in SetFeature identification : 03h Device-initiated interface power state transitions + #define ATA_DIPM_ENABLE 0x10 // defined in ACS-3 + #define ATA_DIPM_DISABLE 0x90 // defined in ACS-3 // // Equates used for DevSleep Support // -#define ATA_CMD_DEVSLEEP_SUB 0x09 // defined in SATA 3.2 Gold Spec : Count value in SetFeature identification : 09h Device Sleep +#define ATA_CMD_DEVSLEEP_SUB 0x09 // defined in SATA 3.2 Gold Spec : Count value in SetFeature identification : 09h Device Sleep #define ATA_DEVSLEEP_ENABLE 0x10 // defined in SATA 3.2 Gold Spec #define ATA_DEVSLEEP_DISABLE 0x90 // defined in SATA 3.2 Gold Spec @@ -765,7 +765,7 @@ typedef union { /// Default content of device control register, disable INT, /// Bit3 is set to 1 according ATA-1 /// -#define ATA_DEFAULT_CTL (0x0a) +#define ATA_DEFAULT_CTL (0x0a) /// /// Default context of Device/Head Register, /// Bit7 and Bit5 are set to 1 for back-compatibilities. @@ -778,9 +778,9 @@ typedef union { // // Sense Key, Additional Sense Codes and Additional Sense Code Qualifier -// defined in MultiMedia Commands (MMC, MMC-2) +// defined in MultiMedia Commands (MMC, MMC-2) // -// Sense Key +// Sense Key // #define ATA_SK_NO_SENSE (0x0) #define ATA_SK_RECOVERY_ERROR (0x1) @@ -825,7 +825,7 @@ typedef union { // // Error Register -// +// #define ATA_ERRREG_BBK BIT7 ///< Bad block detected defined from ATA-1, obsoleted from ATA-2 #define ATA_ERRREG_UNC BIT6 ///< Uncorrectable Data defined from ATA-1, obsoleted from ATA-4 #define ATA_ERRREG_MC BIT5 ///< Media Change defined from ATA-1, obsoleted from ATA-4 diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/DebugPort2Table.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/DebugPort2Table.h index 03331069fc..d48b85497a 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/DebugPort2Table.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/DebugPort2Table.h @@ -1,5 +1,5 @@ -/** @file - ACPI debug port 2 table definition, defined at +/** @file + ACPI debug port 2 table definition, defined at Microsoft DebugPort2Specification. Copyright (c) 2012, Intel Corporation. All rights reserved.<BR> diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/DebugPortTable.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/DebugPortTable.h index 99791c5133..cf0a741c2c 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/DebugPortTable.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/DebugPortTable.h @@ -1,5 +1,5 @@ -/** @file - ACPI debug port table definition, defined at +/** @file + ACPI debug port table definition, defined at Microsoft DebugPortSpecification. Copyright (c) 2012, Intel Corporation. All rights reserved.<BR> diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/ElTorito.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/ElTorito.h index 3a3d018ac7..a23668e2d3 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/ElTorito.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/ElTorito.h @@ -1,18 +1,18 @@ /** @file - ElTorito Partitions Format Definition. - This file includes some defintions from + ElTorito Partitions Format Definition. + This file includes some defintions from 1. "El Torito" Bootable CD-ROM Format Specification, Version 1.0. - 2. Volume and File Structure of CDROM for Information Interchange, + 2. Volume and File Structure of CDROM for Information Interchange, Standard ECMA-119. (IS0 9660) Copyright (c) 2006 - 2008, 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 - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +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 + +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -57,13 +57,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #pragma pack(1) -/// +/// /// CD-ROM Volume Descriptor -/// -typedef union { +/// +typedef union { struct { - UINT8 Type; - CHAR8 Id[5]; ///< "CD001" + UINT8 Type; + CHAR8 Id[5]; ///< "CD001" CHAR8 Reserved[82]; } Unknown; @@ -72,29 +72,29 @@ typedef union { /// struct { UINT8 Type; ///< Must be 0 - CHAR8 Id[5]; ///< "CD001" - UINT8 Version; ///< Must be 1 - CHAR8 SystemId[32]; ///< "EL TORITO SPECIFICATION" - CHAR8 Unused[32]; ///< Must be 0 + CHAR8 Id[5]; ///< "CD001" + UINT8 Version; ///< Must be 1 + CHAR8 SystemId[32]; ///< "EL TORITO SPECIFICATION" + CHAR8 Unused[32]; ///< Must be 0 UINT8 EltCatalog[4]; ///< Absolute pointer to first sector of Boot Catalog CHAR8 Unused2[13]; ///< Must be 0 } BootRecordVolume; - + /// /// Primary Volumn Descriptor, defined in ISO 9660. /// struct { - UINT8 Type; + UINT8 Type; CHAR8 Id[5]; ///< "CD001" - UINT8 Version; + UINT8 Version; UINT8 Unused; ///< Must be 0 - CHAR8 SystemId[32]; - CHAR8 VolumeId[32]; - UINT8 Unused2[8]; ///< Must be 0 + CHAR8 SystemId[32]; + CHAR8 VolumeId[32]; + UINT8 Unused2[8]; ///< Must be 0 UINT32 VolSpaceSize[2]; ///< the number of Logical Blocks } PrimaryVolume; -} CDROM_VOLUME_DESCRIPTOR; +} CDROM_VOLUME_DESCRIPTOR; /// /// Catalog Entry diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/HighPrecisionEventTimerTable.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/HighPrecisionEventTimerTable.h index 97b1c45edf..82df13ce59 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/HighPrecisionEventTimerTable.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/HighPrecisionEventTimerTable.h @@ -1,15 +1,15 @@ /** @file ACPI high precision event timer table definition, at www.intel.com Specification name is IA-PC HPET (High Precision Event Timers) Specification. - + Copyright (c) 2007 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ #ifndef _HIGH_PRECISION_EVENT_TIMER_TABLE_H_ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Hsti.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Hsti.h index 711e2523e1..f8cfdd1a83 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Hsti.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Hsti.h @@ -25,8 +25,8 @@ #define PLATFORM_SECURITY_ROLE_PLATFORM_REFERENCE 0x00000001 // IHV #define PLATFORM_SECURITY_ROLE_PLATFORM_IBV 0x00000002 -#define PLATFORM_SECURITY_ROLE_IMPLEMENTOR_OEM 0x00000003 -#define PLATFORM_SECURITY_ROLE_IMPLEMENTOR_ODM 0x00000004 +#define PLATFORM_SECURITY_ROLE_IMPLEMENTOR_OEM 0x00000003 +#define PLATFORM_SECURITY_ROLE_IMPLEMENTOR_ODM 0x00000004 typedef struct { // diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Http11.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Http11.h index 797e74e4d4..9b91afeead 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Http11.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Http11.h @@ -1,8 +1,8 @@ /** @file - Hypertext Transfer Protocol -- HTTP/1.1 Standard definitions, from RFC 2616 + Hypertext Transfer Protocol -- HTTP/1.1 Standard definitions, from RFC 2616 + + This file contains common HTTP 1.1 definitions from RFC 2616 - This file contains common HTTP 1.1 definitions from RFC 2616 - (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR> This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License @@ -20,7 +20,7 @@ /// /// HTTP Version (currently HTTP 1.1) -/// +/// /// The version of an HTTP message is indicated by an HTTP-Version field /// in the first line of the message. /// @@ -28,7 +28,7 @@ /// /// HTTP Request Method definitions -/// +/// /// The Method token indicates the method to be performed on the /// resource identified by the Request-URI. The method is case-sensitive. /// @@ -50,27 +50,27 @@ /// /// Accept Request Header -/// The Accept request-header field can be used to specify certain media types which are -/// acceptable for the response. Accept headers can be used to indicate that the request -/// is specifically limited to a small set of desired types, as in the case of a request +/// The Accept request-header field can be used to specify certain media types which are +/// acceptable for the response. Accept headers can be used to indicate that the request +/// is specifically limited to a small set of desired types, as in the case of a request /// for an in-line image. /// #define HTTP_HEADER_ACCEPT "Accept" -/// +/// /// Accept-Charset Request Header -/// The Accept-Charset request-header field can be used to indicate what character sets -/// are acceptable for the response. This field allows clients capable of understanding -/// more comprehensive or special-purpose character sets to signal that capability to a +/// The Accept-Charset request-header field can be used to indicate what character sets +/// are acceptable for the response. This field allows clients capable of understanding +/// more comprehensive or special-purpose character sets to signal that capability to a /// server which is capable of representing documents in those character sets. /// #define HTTP_HEADER_ACCEPT_CHARSET "Accept-Charset" -/// +/// /// Accept-Language Request Header -/// The Accept-Language request-header field is similar to Accept, -/// but restricts the set of natural languages that are preferred +/// The Accept-Language request-header field is similar to Accept, +/// but restricts the set of natural languages that are preferred /// as a response to the request. /// #define HTTP_HEADER_ACCEPT_LANGUAGE "Accept-Language" @@ -83,39 +83,39 @@ #define HTTP_HEADER_ACCEPT_RANGES "Accept-Ranges" -/// +/// /// Accept-Encoding Request Header -/// The Accept-Encoding request-header field is similar to Accept, +/// The Accept-Encoding request-header field is similar to Accept, /// but restricts the content-codings that are acceptable in the response. /// #define HTTP_HEADER_ACCEPT_ENCODING "Accept-Encoding" /// /// Content-Encoding Header -/// The Content-Encoding entity-header field is used as a modifier to the media-type. -/// When present, its value indicates what additional content codings have been applied -/// to the entity-body, and thus what decoding mechanisms must be applied in order to -/// obtain the media-type referenced by the Content-Type header field. Content-Encoding -/// is primarily used to allow a document to be compressed without losing the identity +/// The Content-Encoding entity-header field is used as a modifier to the media-type. +/// When present, its value indicates what additional content codings have been applied +/// to the entity-body, and thus what decoding mechanisms must be applied in order to +/// obtain the media-type referenced by the Content-Type header field. Content-Encoding +/// is primarily used to allow a document to be compressed without losing the identity /// of its underlying media type. /// #define HTTP_HEADER_CONTENT_ENCODING "Content-Encoding" -/// +/// /// HTTP Content-Encoding Compression types /// #define HTTP_CONTENT_ENCODING_IDENTITY "identity" /// No transformation is used. This is the default value for content coding. #define HTTP_CONTENT_ENCODING_GZIP "gzip" /// Content-Encoding: GNU zip format (described in RFC 1952). -#define HTTP_CONTENT_ENCODING_COMPRESS "compress" /// encoding format produced by the common UNIX file compression program "compress". -#define HTTP_CONTENT_ENCODING_DEFLATE "deflate" /// The "zlib" format defined in RFC 1950 in combination with the "deflate" +#define HTTP_CONTENT_ENCODING_COMPRESS "compress" /// encoding format produced by the common UNIX file compression program "compress". +#define HTTP_CONTENT_ENCODING_DEFLATE "deflate" /// The "zlib" format defined in RFC 1950 in combination with the "deflate" /// compression mechanism described in RFC 1951. /// /// Content-Type Header -/// The Content-Type entity-header field indicates the media type of the entity-body sent to -/// the recipient or, in the case of the HEAD method, the media type that would have been sent +/// The Content-Type entity-header field indicates the media type of the entity-body sent to +/// the recipient or, in the case of the HEAD method, the media type that would have been sent /// had the request been a GET. /// #define HTTP_HEADER_CONTENT_TYPE "Content-Type" @@ -124,12 +124,12 @@ // #define HTTP_CONTENT_TYPE_APP_JSON "application/json" #define HTTP_CONTENT_TYPE_APP_OCTET_STREAM "application/octet-stream" - + #define HTTP_CONTENT_TYPE_TEXT_HTML "text/html" #define HTTP_CONTENT_TYPE_TEXT_PLAIN "text/plain" #define HTTP_CONTENT_TYPE_TEXT_CSS "text/css" #define HTTP_CONTENT_TYPE_TEXT_XML "text/xml" - + #define HTTP_CONTENT_TYPE_IMAGE_GIF "image/gif" #define HTTP_CONTENT_TYPE_IMAGE_JPEG "image/jpeg" #define HTTP_CONTENT_TYPE_IMAGE_PNG "image/png" @@ -138,17 +138,17 @@ /// /// Content-Length Header -/// The Content-Length entity-header field indicates the size of the entity-body, -/// in decimal number of OCTETs, sent to the recipient or, in the case of the HEAD +/// The Content-Length entity-header field indicates the size of the entity-body, +/// in decimal number of OCTETs, sent to the recipient or, in the case of the HEAD /// method, the size of the entity-body that would have been sent had the request been a GET. /// #define HTTP_HEADER_CONTENT_LENGTH "Content-Length" - + /// /// Transfer-Encoding Header -/// The Transfer-Encoding general-header field indicates what (if any) type of transformation -/// has been applied to the message body in order to safely transfer it between the sender -/// and the recipient. This differs from the content-coding in that the transfer-coding +/// The Transfer-Encoding general-header field indicates what (if any) type of transformation +/// has been applied to the message body in order to safely transfer it between the sender +/// and the recipient. This differs from the content-coding in that the transfer-coding /// is a property of the message, not of the entity. /// #define HTTP_HEADER_TRANSFER_ENCODING "Transfer-Encoding" @@ -156,14 +156,14 @@ /// /// User Agent Request Header -/// -/// The User-Agent request-header field contains information about the user agent originating -/// the request. This is for statistical purposes, the tracing of protocol violations, and -/// automated recognition of user agents for the sake of tailoring responses to avoid -/// particular user agent limitations. User agents SHOULD include this field with requests. -/// The field can contain multiple product tokens and comments identifying the agent and any -/// subproducts which form a significant part of the user agent. -/// By convention, the product tokens are listed in order of their significance for +/// +/// The User-Agent request-header field contains information about the user agent originating +/// the request. This is for statistical purposes, the tracing of protocol violations, and +/// automated recognition of user agents for the sake of tailoring responses to avoid +/// particular user agent limitations. User agents SHOULD include this field with requests. +/// The field can contain multiple product tokens and comments identifying the agent and any +/// subproducts which form a significant part of the user agent. +/// By convention, the product tokens are listed in order of their significance for /// identifying the application. /// #define HTTP_HEADER_USER_AGENT "User-Agent" @@ -171,49 +171,49 @@ /// /// Host Request Header /// -/// The Host request-header field specifies the Internet host and port number of the resource -/// being requested, as obtained from the original URI given by the user or referring resource +/// The Host request-header field specifies the Internet host and port number of the resource +/// being requested, as obtained from the original URI given by the user or referring resource /// #define HTTP_HEADER_HOST "Host" /// /// Location Response Header -/// -/// The Location response-header field is used to redirect the recipient to a location other than -/// the Request-URI for completion of the request or identification of a new resource. -/// For 201 (Created) responses, the Location is that of the new resource which was created by -/// the request. For 3xx responses, the location SHOULD indicate the server's preferred URI for +/// +/// The Location response-header field is used to redirect the recipient to a location other than +/// the Request-URI for completion of the request or identification of a new resource. +/// For 201 (Created) responses, the Location is that of the new resource which was created by +/// the request. For 3xx responses, the location SHOULD indicate the server's preferred URI for /// automatic redirection to the resource. The field value consists of a single absolute URI. /// #define HTTP_HEADER_LOCATION "Location" /// /// The If-Match request-header field is used with a method to make it conditional. -/// A client that has one or more entities previously obtained from the resource -/// can verify that one of those entities is current by including a list of their -/// associated entity tags in the If-Match header field. -/// The purpose of this feature is to allow efficient updates of cached information -/// with a minimum amount of transaction overhead. It is also used, on updating requests, -/// to prevent inadvertent modification of the wrong version of a resource. +/// A client that has one or more entities previously obtained from the resource +/// can verify that one of those entities is current by including a list of their +/// associated entity tags in the If-Match header field. +/// The purpose of this feature is to allow efficient updates of cached information +/// with a minimum amount of transaction overhead. It is also used, on updating requests, +/// to prevent inadvertent modification of the wrong version of a resource. /// As a special case, the value "*" matches any current entity of the resource. /// #define HTTP_HEADER_IF_MATCH "If-Match" /// -/// The If-None-Match request-header field is used with a method to make it conditional. -/// A client that has one or more entities previously obtained from the resource can verify -/// that none of those entities is current by including a list of their associated entity -/// tags in the If-None-Match header field. The purpose of this feature is to allow efficient -/// updates of cached information with a minimum amount of transaction overhead. It is also used -/// to prevent a method (e.g. PUT) from inadvertently modifying an existing resource when the +/// The If-None-Match request-header field is used with a method to make it conditional. +/// A client that has one or more entities previously obtained from the resource can verify +/// that none of those entities is current by including a list of their associated entity +/// tags in the If-None-Match header field. The purpose of this feature is to allow efficient +/// updates of cached information with a minimum amount of transaction overhead. It is also used +/// to prevent a method (e.g. PUT) from inadvertently modifying an existing resource when the /// client believes that the resource does not exist. /// #define HTTP_HEADER_IF_NONE_MATCH "If-None-Match" -/// +/// /// Authorization Request Header /// The Authorization field value consists of credentials /// containing the authentication information of the user agent for @@ -223,8 +223,8 @@ /// /// ETAG Response Header -/// The ETag response-header field provides the current value of the entity tag -/// for the requested variant. +/// The ETag response-header field provides the current value of the entity tag +/// for the requested variant. /// #define HTTP_HEADER_ETAG "ETag" diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/IScsiBootFirmwareTable.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/IScsiBootFirmwareTable.h index d542b2c412..92dc29fcca 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/IScsiBootFirmwareTable.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/IScsiBootFirmwareTable.h @@ -1,15 +1,15 @@ /** @file The definition for iSCSI Boot Firmware Table, it's defined in Microsoft's - iSCSI Boot Firmware Table(iBFT) as Defined in ACPI 3.0b Specification. - + iSCSI Boot Firmware Table(iBFT) as Defined in ACPI 3.0b Specification. + Copyright (c) 2006 - 2013, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -58,7 +58,7 @@ typedef struct { } EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_HEADER; /// -/// Common Header of Boot Firmware Table Structure +/// Common Header of Boot Firmware Table Structure /// typedef struct { UINT8 StructureId; @@ -78,7 +78,7 @@ typedef struct { UINT16 NIC0Offset; UINT16 Target0Offset; UINT16 NIC1Offset; - UINT16 Target1Offset; + UINT16 Target1Offset; } EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_CONTROL_STRUCTURE; #define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_CONTROL_STRUCTURE_VERSION 0x1 @@ -100,8 +100,8 @@ typedef struct { #define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_INITIATOR_STRUCTURE_VERSION 0x1 -#define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_INITIATOR_STRUCTURE_FLAG_BLOCK_VALID BIT0 -#define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_INITIATOR_STRUCTURE_FLAG_BOOT_SELECTED BIT1 +#define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_INITIATOR_STRUCTURE_FLAG_BLOCK_VALID BIT0 +#define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_INITIATOR_STRUCTURE_FLAG_BOOT_SELECTED BIT1 /// /// NIC Structure diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/LegacyBiosMpTable.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/LegacyBiosMpTable.h index 41045bd976..25c9b350c4 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/LegacyBiosMpTable.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/LegacyBiosMpTable.h @@ -1,17 +1,17 @@ /** @file Defives data structures per MultiProcessor Specification Ver 1.4. - - The MultiProcessor Specification defines an enhancement to the standard + + The MultiProcessor Specification defines an enhancement to the standard to which PC manufacturers design DOS-compatible systems. Copyright (c) 2007 - 2011, 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 - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +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 + +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Mbr.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Mbr.h index 302e44d773..9aaca7d4f9 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Mbr.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Mbr.h @@ -2,13 +2,13 @@ Legacy Master Boot Record Format Definition. Copyright (c) 2006 - 2008, 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 +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 - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/MemoryMappedConfigurationSpaceAccessTable.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/MemoryMappedConfigurationSpaceAccessTable.h index d855d9b271..fc62234c2e 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/MemoryMappedConfigurationSpaceAccessTable.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/MemoryMappedConfigurationSpaceAccessTable.h @@ -1,16 +1,16 @@ /** @file - ACPI memory mapped configuration space access table definition, defined at + ACPI memory mapped configuration space access table definition, defined at in the PCI Firmware Specification, version 3.0. Specification is available at http://www.pcisig.com. - + Copyright (c) 2007 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ #ifndef _MEMORY_MAPPED_CONFIGURATION_SPACE_ACCESS_TABLE_H_ @@ -35,7 +35,7 @@ typedef struct { } EFI_ACPI_MEMORY_MAPPED_ENHANCED_CONFIGURATION_SPACE_BASE_ADDRESS_ALLOCATION_STRUCTURE; /// -/// MCFG Table header definition. The rest of the table +/// MCFG Table header definition. The rest of the table /// must be defined in a platform specific manner. /// typedef struct { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/MemoryOverwriteRequestControlLock.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/MemoryOverwriteRequestControlLock.h index 415c134779..ca756cd256 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/MemoryOverwriteRequestControlLock.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/MemoryOverwriteRequestControlLock.h @@ -1,5 +1,5 @@ /** @file - Support for Microsoft Secure MOR implementation, defined at + Support for Microsoft Secure MOR implementation, defined at Microsoft Secure MOR implementation. https://msdn.microsoft.com/en-us/library/windows/hardware/mt270973(v=vs.85).aspx diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Pal.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Pal.h index 5dc26a2f7b..ba852c2b78 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Pal.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Pal.h @@ -2,13 +2,13 @@ Main PAL API's defined in Intel Itanium Architecture Software Developer's Manual. Copyright (c) 2006 - 2012, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -1152,7 +1152,7 @@ typedef struct { ///< be enabled or disabled by ///< PAL_PROC_SET_FEATURES. The ///< corresponding argument is ignored. - + UINT64 NoPresentPmi:1; ///< Bit37, No INIT, PMI, and LINT pins ///< present. Denotes the absence of INIT, ///< PMI, LINT0 and LINT1 pins on the @@ -1163,7 +1163,7 @@ typedef struct { ///< enabled or disabled by ///< PAL_PROC_SET_FEATURES. The corresponding ///< argument is ignored. - + UINT64 NoSimpleImpInUndefinedIns:1; ///< Bit38, No Simple ///< implementation of ///< unimplemented instruction @@ -1432,7 +1432,7 @@ typedef struct { ///< bit has no effect if BERR ///< signalling is disabled. (See ///< PAL_BUS_GET/SET_FEATURES) - + UINT64 EnableBerrPromotion:1; ///< Bit63. Enable BERR promotion. When ///< 1, the Bus Error (BERR) signal is ///< promoted to the Bus Initialization @@ -1757,15 +1757,15 @@ typedef struct { UINT64 FailedInInsCache:1; ///< Bit11, Failure located in the ///< instruction cache. - + UINT64 Mesi:3; ///< Bit14:12, 0 - cache line is invalid. 1 - cache ///< line is held shared. 2 - cache line is held ///< exclusive. 3 - cache line is modified. All other ///< values are reserved. - + UINT64 MesiIsValid:1; ///< Bit15, The mesi field in the cache_check ///< parameter is valid. - + UINT64 FailedWay:5; ///< Bit20:16, Failure located in the way of ///< the cache indicated by this value. @@ -2288,7 +2288,7 @@ typedef struct { ///< ignored or generate an illegal argument in ///< procedure calls if the caller sets these ///< bits. - + UINT64 ControlSupport:1; ///< This bit defines if an implementation ///< supports control of the PAL self-tests ///< via the self-test control word. If diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Pci.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Pci.h index e5954dbce7..d794f4c62e 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Pci.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Pci.h @@ -2,13 +2,13 @@ Support for the latest PCI standard. Copyright (c) 2006 - 2014, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Pci22.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Pci22.h index 65ab051b46..ab29e15760 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Pci22.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Pci22.h @@ -9,13 +9,13 @@ Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR> Copyright (c) 2014 - 2015, Hewlett-Packard Development Company, L.P.<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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -116,8 +116,8 @@ typedef union { PCI_TYPE01 Bridge; } PCI_TYPE_GENERIC; -/// -/// CardBus Conroller Configuration Space, +/// +/// CardBus Conroller Configuration Space, /// Section 4.5.1, PC Card Standard. 8.0 /// typedef struct { @@ -158,7 +158,7 @@ typedef struct { #define PCI_CLASS_MASS_STORAGE_OTHER 0x80 #define PCI_CLASS_NETWORK 0x02 -#define PCI_CLASS_NETWORK_ETHERNET 0x00 +#define PCI_CLASS_NETWORK_ETHERNET 0x00 #define PCI_CLASS_NETWORK_TOKENRING 0x01 #define PCI_CLASS_NETWORK_FDDI 0x02 #define PCI_CLASS_NETWORK_ATM 0x03 @@ -171,7 +171,7 @@ typedef struct { #define PCI_IF_VGA_8514 0x01 #define PCI_CLASS_DISPLAY_XGA 0x01 #define PCI_CLASS_DISPLAY_3D 0x02 -#define PCI_CLASS_DISPLAY_OTHER 0x80 +#define PCI_CLASS_DISPLAY_OTHER 0x80 #define PCI_CLASS_MEDIA 0x04 #define PCI_CLASS_MEDIA_VIDEO 0x00 @@ -199,7 +199,7 @@ typedef struct { #define PCI_CLASS_BRIDGE_OTHER 0x80 #define PCI_CLASS_BRIDGE_ISA_PDECODE 0x80 -#define PCI_CLASS_SCC 0x07 ///< Simple communications controllers +#define PCI_CLASS_SCC 0x07 ///< Simple communications controllers #define PCI_SUBCLASS_SERIAL 0x00 #define PCI_IF_GENERIC_XT 0x00 #define PCI_IF_16450 0x01 @@ -228,8 +228,8 @@ typedef struct { #define PCI_IF_8259_PIC 0x00 #define PCI_IF_ISA_PIC 0x01 #define PCI_IF_EISA_PIC 0x02 -#define PCI_IF_APIC_CONTROLLER 0x10 ///< I/O APIC interrupt controller , 32 bye none-prefectable memory. -#define PCI_IF_APIC_CONTROLLER2 0x20 +#define PCI_IF_APIC_CONTROLLER 0x10 ///< I/O APIC interrupt controller , 32 bye none-prefectable memory. +#define PCI_IF_APIC_CONTROLLER2 0x20 #define PCI_SUBCLASS_DMA 0x01 #define PCI_IF_8237_DMA 0x00 #define PCI_IF_ISA_DMA 0x01 @@ -297,25 +297,25 @@ typedef struct { #define PCI_SECURITY_CONTROLLER 0x10 ///< Encryption and decryption controller #define PCI_SUBCLASS_NET_COMPUT 0x00 -#define PCI_SUBCLASS_ENTERTAINMENT 0x10 +#define PCI_SUBCLASS_ENTERTAINMENT 0x10 #define PCI_SUBCLASS_SECURITY_OTHER 0x80 #define PCI_CLASS_DPIO 0x11 #define PCI_SUBCLASS_DPIO 0x00 #define PCI_SUBCLASS_DPIO_OTHER 0x80 -/** +/** Macro that checks whether the Base Class code of device matched. @param _p Specified device. @param c Base Class code needs matching. @retval TRUE Base Class code matches the specified device. - @retval FALSE Base Class code doesn't match the specified device. + @retval FALSE Base Class code doesn't match the specified device. **/ #define IS_CLASS1(_p, c) ((_p)->Hdr.ClassCode[2] == (c)) -/** +/** Macro that checks whether the Base Class code and Sub-Class code of device matched. @param _p Specified device. @@ -323,11 +323,11 @@ typedef struct { @param s Sub-Class code needs matching. @retval TRUE Base Class code and Sub-Class code match the specified device. - @retval FALSE Base Class code and Sub-Class code don't match the specified device. + @retval FALSE Base Class code and Sub-Class code don't match the specified device. **/ #define IS_CLASS2(_p, c, s) (IS_CLASS1 (_p, c) && ((_p)->Hdr.ClassCode[1] == (s))) -/** +/** Macro that checks whether the Base Class code, Sub-Class code and Interface code of device matched. @param _p Specified device. @@ -336,12 +336,12 @@ typedef struct { @param p Interface code needs matching. @retval TRUE Base Class code, Sub-Class code and Interface code match the specified device. - @retval FALSE Base Class code, Sub-Class code and Interface code don't match the specified device. + @retval FALSE Base Class code, Sub-Class code and Interface code don't match the specified device. **/ #define IS_CLASS3(_p, c, s, p) (IS_CLASS2 (_p, c, s) && ((_p)->Hdr.ClassCode[0] == (p))) -/** +/** Macro that checks whether device is a display controller. @param _p Specified device. @@ -351,7 +351,7 @@ typedef struct { **/ #define IS_PCI_DISPLAY(_p) IS_CLASS1 (_p, PCI_CLASS_DISPLAY) -/** +/** Macro that checks whether device is a VGA-compatible controller. @param _p Specified device. @@ -361,7 +361,7 @@ typedef struct { **/ #define IS_PCI_VGA(_p) IS_CLASS3 (_p, PCI_CLASS_DISPLAY, PCI_CLASS_DISPLAY_VGA, PCI_IF_VGA_VGA) -/** +/** Macro that checks whether device is an 8514-compatible controller. @param _p Specified device. @@ -371,7 +371,7 @@ typedef struct { **/ #define IS_PCI_8514(_p) IS_CLASS3 (_p, PCI_CLASS_DISPLAY, PCI_CLASS_DISPLAY_VGA, PCI_IF_VGA_8514) -/** +/** Macro that checks whether device is built before the Class Code field was defined. @param _p Specified device. @@ -381,7 +381,7 @@ typedef struct { **/ #define IS_PCI_OLD(_p) IS_CLASS1 (_p, PCI_CLASS_OLD) -/** +/** Macro that checks whether device is a VGA-compatible device built before the Class Code field was defined. @param _p Specified device. @@ -391,7 +391,7 @@ typedef struct { **/ #define IS_PCI_OLD_VGA(_p) IS_CLASS2 (_p, PCI_CLASS_OLD, PCI_CLASS_OLD_VGA) -/** +/** Macro that checks whether device is an IDE controller. @param _p Specified device. @@ -401,7 +401,7 @@ typedef struct { **/ #define IS_PCI_IDE(_p) IS_CLASS2 (_p, PCI_CLASS_MASS_STORAGE, PCI_CLASS_MASS_STORAGE_IDE) -/** +/** Macro that checks whether device is a SCSI bus controller. @param _p Specified device. @@ -411,7 +411,7 @@ typedef struct { **/ #define IS_PCI_SCSI(_p) IS_CLASS2 (_p, PCI_CLASS_MASS_STORAGE, PCI_CLASS_MASS_STORAGE_SCSI) -/** +/** Macro that checks whether device is a RAID controller. @param _p Specified device. @@ -421,7 +421,7 @@ typedef struct { **/ #define IS_PCI_RAID(_p) IS_CLASS2 (_p, PCI_CLASS_MASS_STORAGE, PCI_CLASS_MASS_STORAGE_RAID) -/** +/** Macro that checks whether device is an ISA bridge. @param _p Specified device. @@ -431,7 +431,7 @@ typedef struct { **/ #define IS_PCI_LPC(_p) IS_CLASS2 (_p, PCI_CLASS_BRIDGE, PCI_CLASS_BRIDGE_ISA) -/** +/** Macro that checks whether device is a PCI-to-PCI bridge. @param _p Specified device. @@ -441,7 +441,7 @@ typedef struct { **/ #define IS_PCI_P2P(_p) IS_CLASS3 (_p, PCI_CLASS_BRIDGE, PCI_CLASS_BRIDGE_P2P, PCI_IF_BRIDGE_P2P) -/** +/** Macro that checks whether device is a Subtractive Decode PCI-to-PCI bridge. @param _p Specified device. @@ -451,7 +451,7 @@ typedef struct { **/ #define IS_PCI_P2P_SUB(_p) IS_CLASS3 (_p, PCI_CLASS_BRIDGE, PCI_CLASS_BRIDGE_P2P, PCI_IF_BRIDGE_P2P_SUBTRACTIVE) -/** +/** Macro that checks whether device is a 16550-compatible serial controller. @param _p Specified device. @@ -461,7 +461,7 @@ typedef struct { **/ #define IS_PCI_16550_SERIAL(_p) IS_CLASS3 (_p, PCI_CLASS_SCC, PCI_SUBCLASS_SERIAL, PCI_IF_16550) -/** +/** Macro that checks whether device is a Universal Serial Bus controller. @param _p Specified device. @@ -473,7 +473,7 @@ typedef struct { #define IS_PCI_USB(_p) IS_CLASS2 (_p, PCI_CLASS_SERIAL, PCI_CLASS_SERIAL_USB) // -// the definition of Header Type +// the definition of Header Type // #define HEADER_TYPE_DEVICE 0x00 #define HEADER_TYPE_PCI_TO_PCI_BRIDGE 0x01 @@ -483,7 +483,7 @@ typedef struct { // Mask of Header type // #define HEADER_LAYOUT_CODE 0x7f -/** +/** Macro that checks whether device is a PCI-PCI bridge. @param _p Specified device. @@ -493,7 +493,7 @@ typedef struct { **/ #define IS_PCI_BRIDGE(_p) (((_p)->Hdr.HeaderType & HEADER_LAYOUT_CODE) == (HEADER_TYPE_PCI_TO_PCI_BRIDGE)) -/** +/** Macro that checks whether device is a CardBus bridge. @param _p Specified device. @@ -503,7 +503,7 @@ typedef struct { **/ #define IS_CARDBUS_BRIDGE(_p) (((_p)->Hdr.HeaderType & HEADER_LAYOUT_CODE) == (HEADER_TYPE_CARDBUS_BRIDGE)) -/** +/** Macro that checks whether device is a multiple functions device. @param _p Specified device. @@ -548,17 +548,17 @@ typedef struct { // // defined in PCI-to-PCI Bridge Architecture Specification // -#define PCI_BRIDGE_PRIMARY_BUS_REGISTER_OFFSET 0x18 -#define PCI_BRIDGE_SECONDARY_BUS_REGISTER_OFFSET 0x19 -#define PCI_BRIDGE_SUBORDINATE_BUS_REGISTER_OFFSET 0x1a +#define PCI_BRIDGE_PRIMARY_BUS_REGISTER_OFFSET 0x18 +#define PCI_BRIDGE_SECONDARY_BUS_REGISTER_OFFSET 0x19 +#define PCI_BRIDGE_SUBORDINATE_BUS_REGISTER_OFFSET 0x1a #define PCI_BRIDGE_SECONDARY_LATENCY_TIMER_OFFSET 0x1b -#define PCI_BRIDGE_STATUS_REGISTER_OFFSET 0x1E -#define PCI_BRIDGE_CONTROL_REGISTER_OFFSET 0x3E +#define PCI_BRIDGE_STATUS_REGISTER_OFFSET 0x1E +#define PCI_BRIDGE_CONTROL_REGISTER_OFFSET 0x3E /// /// Interrupt Line "Unknown" or "No connection" value defined for x86 based system /// -#define PCI_INT_LINE_UNKNOWN 0xFF +#define PCI_INT_LINE_UNKNOWN 0xFF /// /// PCI Access Data Format @@ -770,7 +770,7 @@ typedef struct { } EFI_PCI_CAPABILITY_MSI64; /// -/// Capability EFI_PCI_CAPABILITY_ID_HOTPLUG, +/// Capability EFI_PCI_CAPABILITY_ID_HOTPLUG, /// CompactPCI Hot Swap Specification PICMG 2.1, R1.0 /// typedef struct { @@ -789,8 +789,8 @@ typedef struct { /// /// EFI PCI Option ROM definitions -/// -#define EFI_ROOT_BRIDGE_LIST 'eprb' +/// +#define EFI_ROOT_BRIDGE_LIST 'eprb' #define EFI_PCI_EXPANSION_ROM_HEADER_EFISIGNATURE 0x0EF1 ///< defined in UEFI Spec. #define PCI_EXPANSION_ROM_HEADER_SIGNATURE 0xaa55 diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Pci23.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Pci23.h index 43f4ac99d3..0e5745adeb 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Pci23.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Pci23.h @@ -2,13 +2,13 @@ Support for PCI 2.3 standard. Copyright (c) 2006 - 2012, 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. + 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. - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -96,7 +96,7 @@ #pragma pack(1) /// -/// PCI-X Capabilities List, +/// PCI-X Capabilities List, /// Section 7.2, PCI-X Addendum to the PCI Local Bus Specification, Revision 1.0b. /// typedef struct { @@ -106,7 +106,7 @@ typedef struct { } EFI_PCI_CAPABILITY_PCIX; /// -/// PCI-X Bridge Capabilities List, +/// PCI-X Bridge Capabilities List, /// Section 8.6.2, PCI-X Addendum to the PCI Local Bus Specification, Revision 1.0b. /// typedef struct { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Pci30.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Pci30.h index 57bd5a4179..c36abd52ba 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Pci30.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Pci30.h @@ -2,13 +2,13 @@ Support for PCI 3.0 standard. Copyright (c) 2006 - 2012, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/PciCodeId.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/PciCodeId.h index 31b6b8ec5d..973767988e 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/PciCodeId.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/PciCodeId.h @@ -3,13 +3,13 @@ revision 1.3. Copyright (c) 2012, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/PciExpress21.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/PciExpress21.h index d1f20001e4..2305b9dd99 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/PciExpress21.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/PciExpress21.h @@ -2,14 +2,14 @@ Support for the latest PCI standard. Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR> - (C) Copyright 2016 Hewlett Packard Enterprise Development LP<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 - - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + (C) Copyright 2016 Hewlett Packard Enterprise Development LP<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 + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/PciExpress30.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/PciExpress30.h index 5ab7feb8d6..829f14f75c 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/PciExpress30.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/PciExpress30.h @@ -4,13 +4,13 @@ This header file may not define all structures. Please extend as required. Copyright (c) 2014 - 2016, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/PeImage.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/PeImage.h index 3af3edbd8e..254e5d2ec2 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/PeImage.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/PeImage.h @@ -1,21 +1,21 @@ /** @file - EFI image format for PE32, PE32+ and TE. Please note some data structures are - different for PE32 and PE32+. EFI_IMAGE_NT_HEADERS32 is for PE32 and - EFI_IMAGE_NT_HEADERS64 is for PE32+. + EFI image format for PE32, PE32+ and TE. Please note some data structures are + different for PE32 and PE32+. EFI_IMAGE_NT_HEADERS32 is for PE32 and + EFI_IMAGE_NT_HEADERS64 is for PE32+. - This file is coded to the Visual Studio, Microsoft Portable Executable and + This file is coded to the Visual Studio, Microsoft Portable Executable and Common Object File Format Specification, Revision 8.3 - February 6, 2013. This file also includes some definitions in PI Specification, Revision 1.0. Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR> Portions copyright (c) 2008 - 2009, Apple Inc. 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. +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. -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -134,12 +134,12 @@ typedef struct { /// /// @attention -/// EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC means PE32 and +/// EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC means PE32 and /// EFI_IMAGE_OPTIONAL_HEADER32 must be used. The data structures only vary /// after NT additional fields. /// #define EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC 0x10b - + /// /// Optional Header Standard Fields for PE32. /// @@ -185,7 +185,7 @@ typedef struct { /// /// @attention -/// EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC means PE32+ and +/// EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC means PE32+ and /// EFI_IMAGE_OPTIONAL_HEADER64 must be used. The data structures only vary /// after NT additional fields. /// @@ -296,7 +296,7 @@ typedef struct { /// Size of EFI_IMAGE_SECTION_HEADER. /// #define EFI_IMAGE_SIZEOF_SECTION_HEADER 40 - + // // Section Flags Values // @@ -304,12 +304,12 @@ typedef struct { #define EFI_IMAGE_SCN_CNT_CODE BIT5 ///< 0x00000020 #define EFI_IMAGE_SCN_CNT_INITIALIZED_DATA BIT6 ///< 0x00000040 #define EFI_IMAGE_SCN_CNT_UNINITIALIZED_DATA BIT7 ///< 0x00000080 - + #define EFI_IMAGE_SCN_LNK_OTHER BIT8 ///< 0x00000100 ///< Reserved. #define EFI_IMAGE_SCN_LNK_INFO BIT9 ///< 0x00000200 ///< Section contains comments or some other type of information. #define EFI_IMAGE_SCN_LNK_REMOVE BIT11 ///< 0x00000800 ///< Section contents will not become part of image. #define EFI_IMAGE_SCN_LNK_COMDAT BIT12 ///< 0x00001000 - + #define EFI_IMAGE_SCN_ALIGN_1BYTES BIT20 ///< 0x00100000 #define EFI_IMAGE_SCN_ALIGN_2BYTES BIT21 ///< 0x00200000 #define EFI_IMAGE_SCN_ALIGN_4BYTES (BIT20|BIT21) ///< 0x00300000 @@ -317,7 +317,7 @@ typedef struct { #define EFI_IMAGE_SCN_ALIGN_16BYTES (BIT20|BIT22) ///< 0x00500000 #define EFI_IMAGE_SCN_ALIGN_32BYTES (BIT21|BIT22) ///< 0x00600000 #define EFI_IMAGE_SCN_ALIGN_64BYTES (BIT20|BIT21|BIT22) ///< 0x00700000 - + #define EFI_IMAGE_SCN_MEM_DISCARDABLE BIT25 ///< 0x02000000 #define EFI_IMAGE_SCN_MEM_NOT_CACHED BIT26 ///< 0x04000000 #define EFI_IMAGE_SCN_MEM_NOT_PAGED BIT27 ///< 0x08000000 @@ -415,7 +415,7 @@ typedef struct { #define EFI_IMAGE_COMDAT_SELECT_SAME_SIZE 3 #define EFI_IMAGE_COMDAT_SELECT_EXACT_MATCH 4 #define EFI_IMAGE_COMDAT_SELECT_ASSOCIATIVE 5 - + // // the following values only be referred in PeCoff, not defined in PECOFF. // @@ -450,9 +450,9 @@ typedef struct { #define EFI_IMAGE_REL_I386_SECREL 0x000B #define EFI_IMAGE_REL_I386_REL32 0x0014 ///< PC-relative 32-bit reference to the symbols virtual address. -// +// // x64 processor relocation types. -// +// #define IMAGE_REL_AMD64_ABSOLUTE 0x0000 #define IMAGE_REL_AMD64_ADDR64 0x0001 #define IMAGE_REL_AMD64_ADDR32 0x0002 diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Sal.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Sal.h index cda4e28bcd..c42d8ff014 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Sal.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Sal.h @@ -3,13 +3,13 @@ Layer Specification Revision 3.2 (December 2003) 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -17,16 +17,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define __SAL_API_H__ /// -/// SAL return status type +/// SAL return status type /// typedef INTN EFI_SAL_STATUS; /// -/// Call completed without error. +/// Call completed without error. /// #define EFI_SAL_SUCCESS ((EFI_SAL_STATUS) 0) /// -/// Call completed without error, but some information was lost due to overflow. +/// Call completed without error, but some information was lost due to overflow. /// #define EFI_SAL_OVERFLOW ((EFI_SAL_STATUS) 1) /// @@ -34,7 +34,7 @@ typedef INTN EFI_SAL_STATUS; /// #define EFI_SAL_WARM_BOOT_NEEDED ((EFI_SAL_STATUS) 2) /// -/// More information is available for retrieval. +/// More information is available for retrieval. /// #define EFI_SAL_MORE_RECORDS ((EFI_SAL_STATUS) 3) /// @@ -46,15 +46,15 @@ typedef INTN EFI_SAL_STATUS; /// #define EFI_SAL_INVALID_ARGUMENT ((EFI_SAL_STATUS) - 2) /// -/// Call completed without error. +/// Call completed without error. /// #define EFI_SAL_ERROR ((EFI_SAL_STATUS) - 3) /// -/// Virtual address not registered. +/// Virtual address not registered. /// #define EFI_SAL_VIRTUAL_ADDRESS_ERROR ((EFI_SAL_STATUS) - 4) /// -/// No information available. +/// No information available. /// #define EFI_SAL_NO_INFORMATION ((EFI_SAL_STATUS) - 5) /// @@ -213,7 +213,7 @@ typedef struct { // // Parameter of EFI_SAL_GET_STATE_INFO, EFI_SAL_GET_STATE_INFO_SIZE, and EFI_SAL_CLEAR_STATE_INFO -// +// // Type of information // #define EFI_SAL_MCA_STATE_INFO 0x0 @@ -345,8 +345,8 @@ typedef struct _SAL_UPDATE_PAL_INFO_BLOCK { #pragma pack(1) typedef struct { /// - /// The ASCII string representation of "SST_" that confirms the presence of the table. - /// + /// The ASCII string representation of "SST_" that confirms the presence of the table. + /// UINT32 Signature; /// /// The length of the entire table in bytes, starting from offset zero and including the @@ -470,7 +470,7 @@ typedef struct { UINT64 NumberOfProcessors; UINT64 LocalIDRegister; } SAL_COHERENCE_DOMAIN_INFO; - + /// /// Format of Purge Translation Cache Coherence Domain Entry. /// @@ -504,7 +504,7 @@ typedef struct { UINT8 CheckSum; } EFI_SAL_FIT_ENTRY; // -// FIT Types +// FIT Types // #define EFI_SAL_FIT_FIT_HEADER_TYPE 0x00 #define EFI_SAL_FIT_PAL_B_TYPE 0x01 diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Scsi.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Scsi.h index 6de1cfd978..5739b282b2 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Scsi.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Scsi.h @@ -2,13 +2,13 @@ Support for SCSI-2 standard Copyright (c) 2006 - 2016, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -346,9 +346,9 @@ typedef struct { UINT8 BlockSize0; UINT8 Protection; UINT8 LogicPerPhysical; - UINT8 LowestAlignLogic2; - UINT8 LowestAlignLogic1; - UINT8 Reserved[16]; + UINT8 LowestAlignLogic2; + UINT8 LowestAlignLogic1; + UINT8 Reserved[16]; } EFI_SCSI_DISK_CAPACITY_DATA16; typedef struct { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/SerialPortConsoleRedirectionTable.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/SerialPortConsoleRedirectionTable.h index e3fe03e319..55468337af 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/SerialPortConsoleRedirectionTable.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/SerialPortConsoleRedirectionTable.h @@ -1,17 +1,17 @@ /** @file ACPI Serial Port Console Redirection Table as defined by Microsoft in http://www.microsoft.com/whdc/system/platform/server/spcr.mspx - + Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR> (C) Copyright 2015 Hewlett Packard Enterprise Development LP<BR> Copyright (c) 2014 - 2016, ARM Limited. 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ #ifndef _SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_H_ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/SmBios.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/SmBios.h index c35bad569c..3c00f44bbf 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/SmBios.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/SmBios.h @@ -3,13 +3,13 @@ Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR> (C) Copyright 2015-2017 Hewlett Packard Enterprise Development LP<BR> -This program and the accompanying materials are licensed and made available under -the terms and conditions of the BSD License that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -101,10 +101,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /// /// Inactive type is added from SMBIOS 2.2. Reference SMBIOS 2.6, chapter 3.3.43. -/// Upper-level software that interprets the SMBIOS structure-table should bypass an +/// Upper-level software that interprets the SMBIOS structure-table should bypass an /// Inactive structure just like a structure type that the software does not recognize. /// -#define SMBIOS_TYPE_INACTIVE 0x007E +#define SMBIOS_TYPE_INACTIVE 0x007E /// /// End-of-table type is added from SMBIOS 2.2. Reference SMBIOS 2.6, chapter 3.3.44. @@ -117,7 +117,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /// /// Types 0 through 127 (7Fh) are reserved for and defined by this -/// specification. Types 128 through 256 (80h to FFh) are available for system- and OEM-specific information. +/// specification. Types 128 through 256 (80h to FFh) are available for system- and OEM-specific information. /// typedef UINT8 SMBIOS_TYPE; @@ -225,8 +225,8 @@ typedef struct { UINT32 PrinterIsSupported :1; UINT32 CgaMonoIsSupported :1; UINT32 NecPc98 :1; - UINT32 ReservedForVendor :32; ///< Bits 32-63. Bits 32-47 reserved for BIOS vendor - ///< and bits 48-63 reserved for System Vendor. + UINT32 ReservedForVendor :32; ///< Bits 32-63. Bits 32-47 reserved for BIOS vendor + ///< and bits 48-63 reserved for System Vendor. } MISC_BIOS_CHARACTERISTICS; /// @@ -300,7 +300,7 @@ typedef struct { /// /// System Wake-up Type. /// -typedef enum { +typedef enum { SystemWakeupTypeReserved = 0x00, SystemWakeupTypeOther = 0x01, SystemWakeupTypeUnknown = 0x02, @@ -314,10 +314,10 @@ typedef enum { /// /// System Information (Type 1). -/// -/// The information in this structure defines attributes of the overall system and is +/// +/// The information in this structure defines attributes of the overall system and is /// intended to be associated with the Component ID group of the system's MIF. -/// An SMBIOS implementation is associated with a single system instance and contains +/// An SMBIOS implementation is associated with a single system instance and contains /// one and only one System Information (Type 1) structure. /// typedef struct { @@ -333,7 +333,7 @@ typedef struct { } SMBIOS_TABLE_TYPE1; /// -/// Base Board - Feature Flags. +/// Base Board - Feature Flags. /// typedef struct { UINT8 Motherboard :1; @@ -347,7 +347,7 @@ typedef struct { /// /// Base Board - Board Type. /// -typedef enum { +typedef enum { BaseBoardTypeUnknown = 0x1, BaseBoardTypeOther = 0x2, BaseBoardTypeServerBlade = 0x3, @@ -366,7 +366,7 @@ typedef enum { /// /// Base Board (or Module) Information (Type 2). /// -/// The information in this structure defines attributes of a system baseboard - +/// The information in this structure defines attributes of a system baseboard - /// for example a motherboard, planar, or server blade or other standard system module. /// typedef struct { @@ -387,7 +387,7 @@ typedef struct { /// /// System Enclosure or Chassis Types /// -typedef enum { +typedef enum { MiscChassisTypeOther = 0x01, MiscChassisTypeUnknown = 0x02, MiscChassisTypeDeskTop = 0x03, @@ -429,7 +429,7 @@ typedef enum { /// /// System Enclosure or Chassis States . /// -typedef enum { +typedef enum { ChassisStateOther = 0x01, ChassisStateUnknown = 0x02, ChassisStateSafe = 0x03, @@ -441,7 +441,7 @@ typedef enum { /// /// System Enclosure or Chassis Security Status. /// -typedef enum { +typedef enum { ChassisSecurityStatusOther = 0x01, ChassisSecurityStatusUnknown = 0x02, ChassisSecurityStatusNone = 0x03, @@ -462,11 +462,11 @@ typedef struct { /// /// System Enclosure or Chassis (Type 3). /// -/// The information in this structure defines attributes of the system's mechanical enclosure(s). -/// For example, if a system included a separate enclosure for its peripheral devices, +/// The information in this structure defines attributes of the system's mechanical enclosure(s). +/// For example, if a system included a separate enclosure for its peripheral devices, /// two structures would be returned: one for the main, system enclosure and the second for /// the peripheral device enclosure. The additions to this structure in v2.1 of this specification -/// support the population of the CIM_Chassis class. +/// support the population of the CIM_Chassis class. /// typedef struct { SMBIOS_STRUCTURE Hdr; @@ -514,29 +514,29 @@ typedef enum { /// Processor Information - Processor Family. /// typedef enum { - ProcessorFamilyOther = 0x01, + ProcessorFamilyOther = 0x01, ProcessorFamilyUnknown = 0x02, - ProcessorFamily8086 = 0x03, + ProcessorFamily8086 = 0x03, ProcessorFamily80286 = 0x04, - ProcessorFamilyIntel386 = 0x05, + ProcessorFamilyIntel386 = 0x05, ProcessorFamilyIntel486 = 0x06, ProcessorFamily8087 = 0x07, ProcessorFamily80287 = 0x08, - ProcessorFamily80387 = 0x09, + ProcessorFamily80387 = 0x09, ProcessorFamily80487 = 0x0A, - ProcessorFamilyPentium = 0x0B, + ProcessorFamilyPentium = 0x0B, ProcessorFamilyPentiumPro = 0x0C, ProcessorFamilyPentiumII = 0x0D, ProcessorFamilyPentiumMMX = 0x0E, ProcessorFamilyCeleron = 0x0F, ProcessorFamilyPentiumIIXeon = 0x10, - ProcessorFamilyPentiumIII = 0x11, + ProcessorFamilyPentiumIII = 0x11, ProcessorFamilyM1 = 0x12, ProcessorFamilyM2 = 0x13, ProcessorFamilyIntelCeleronM = 0x14, ProcessorFamilyIntelPentium4Ht = 0x15, ProcessorFamilyAmdDuron = 0x18, - ProcessorFamilyK5 = 0x19, + ProcessorFamilyK5 = 0x19, ProcessorFamilyK6 = 0x1A, ProcessorFamilyK6_2 = 0x1B, ProcessorFamilyK6_3 = 0x1C, @@ -630,7 +630,7 @@ typedef enum { ProcessorFamilyAmdPhenomFxQuadCore = 0x8C, ProcessorFamilyAmdPhenomX4QuadCore = 0x8D, ProcessorFamilyAmdPhenomX2DualCore = 0x8E, - ProcessorFamilyAmdAthlonX2DualCore = 0x8F, + ProcessorFamilyAmdAthlonX2DualCore = 0x8F, ProcessorFamilyPARISC = 0x90, ProcessorFamilyPaRisc8500 = 0x91, ProcessorFamilyPaRisc8000 = 0x92, @@ -677,7 +677,7 @@ typedef enum { ProcessorFamilyIntelCore2DuoMobile = 0xC4, ProcessorFamilyIntelCore2SoloMobile = 0xC5, ProcessorFamilyIntelCoreI7 = 0xC6, - ProcessorFamilyDualCoreIntelCeleron = 0xC7, + ProcessorFamilyDualCoreIntelCeleron = 0xC7, ProcessorFamilyIBM390 = 0xC8, ProcessorFamilyG4 = 0xC9, ProcessorFamilyG5 = 0xCA, @@ -736,12 +736,12 @@ typedef enum { } PROCESSOR_FAMILY2_DATA; /// -/// Processor Information - Voltage. +/// Processor Information - Voltage. /// typedef struct { - UINT8 ProcessorVoltageCapability5V :1; - UINT8 ProcessorVoltageCapability3_3V :1; - UINT8 ProcessorVoltageCapability2_9V :1; + UINT8 ProcessorVoltageCapability5V :1; + UINT8 ProcessorVoltageCapability3_3V :1; + UINT8 ProcessorVoltageCapability2_9V :1; UINT8 ProcessorVoltageCapabilityReserved :1; ///< Bit 3, must be zero. UINT8 ProcessorVoltageReserved :3; ///< Bits 4-6, must be zero. UINT8 ProcessorVoltageIndicateLegacy :1; @@ -865,13 +865,13 @@ typedef struct { /// /// Processor Information (Type 4). /// -/// The information in this structure defines the attributes of a single processor; -/// a separate structure instance is provided for each system processor socket/slot. -/// For example, a system with an IntelDX2 processor would have a single +/// The information in this structure defines the attributes of a single processor; +/// a separate structure instance is provided for each system processor socket/slot. +/// For example, a system with an IntelDX2 processor would have a single /// structure instance, while a system with an IntelSX2 processor would have a structure -/// to describe the main CPU, and a second structure to describe the 80487 co-processor. +/// to describe the main CPU, and a second structure to describe the 80487 co-processor. /// -typedef struct { +typedef struct { SMBIOS_STRUCTURE Hdr; SMBIOS_TABLE_STRING Socket; UINT8 ProcessorType; ///< The enumeration value from PROCESSOR_TYPE_DATA. @@ -913,7 +913,7 @@ typedef struct { /// /// Memory Controller Error Detecting Method. /// -typedef enum { +typedef enum { ErrorDetectingMethodOther = 0x01, ErrorDetectingMethodUnknown = 0x02, ErrorDetectingMethodNone = 0x03, @@ -940,7 +940,7 @@ typedef struct { /// /// Memory Controller Information - Interleave Support. /// -typedef enum { +typedef enum { MemoryInterleaveOther = 0x01, MemoryInterleaveUnknown = 0x02, MemoryInterleaveOneWay = 0x03, @@ -965,10 +965,10 @@ typedef struct { /// /// Memory Controller Information (Type 5, Obsolete). /// -/// The information in this structure defines the attributes of the system's memory controller(s) -/// and the supported attributes of any memory-modules present in the sockets controlled by -/// this controller. -/// Note: This structure, and its companion Memory Module Information (Type 6, Obsolete), +/// The information in this structure defines the attributes of the system's memory controller(s) +/// and the supported attributes of any memory-modules present in the sockets controlled by +/// this controller. +/// Note: This structure, and its companion Memory Module Information (Type 6, Obsolete), /// are obsolete starting with version 2.1 of this specification. The Physical Memory Array (Type 16) /// and Memory Device (Type 17) structures should be used instead. BIOS providers might /// choose to implement both memory description types to allow existing DMI browsers @@ -979,7 +979,7 @@ typedef struct { UINT8 ErrDetectMethod; ///< The enumeration value from MEMORY_ERROR_DETECT_METHOD. MEMORY_ERROR_CORRECT_CAPABILITY ErrCorrectCapability; UINT8 SupportInterleave; ///< The enumeration value from MEMORY_SUPPORT_INTERLEAVE_TYPE. - UINT8 CurrentInterleave; ///< The enumeration value from MEMORY_SUPPORT_INTERLEAVE_TYPE . + UINT8 CurrentInterleave; ///< The enumeration value from MEMORY_SUPPORT_INTERLEAVE_TYPE . UINT8 MaxMemoryModuleSize; MEMORY_SPEED_TYPE SupportSpeed; UINT16 SupportMemoryType; @@ -1017,11 +1017,11 @@ typedef struct { /// /// Memory Module Information (Type 6, Obsolete) /// -/// One Memory Module Information structure is included for each memory-module socket +/// One Memory Module Information structure is included for each memory-module socket /// in the system. The structure describes the speed, type, size, and error status -/// of each system memory module. The supported attributes of each module are described -/// by the "owning" Memory Controller Information structure. -/// Note: This structure, and its companion Memory Controller Information (Type 5, Obsolete), +/// of each system memory module. The supported attributes of each module are described +/// by the "owning" Memory Controller Information structure. +/// Note: This structure, and its companion Memory Controller Information (Type 5, Obsolete), /// are obsolete starting with version 2.1 of this specification. The Physical Memory Array (Type 16) /// and Memory Device (Type 17) structures should be used instead. /// @@ -1063,7 +1063,7 @@ typedef enum { } CACHE_ERROR_TYPE_DATA; /// -/// Cache Information - System Cache Type. +/// Cache Information - System Cache Type. /// typedef enum { CacheTypeOther = 0x01, @@ -1074,7 +1074,7 @@ typedef enum { } CACHE_TYPE_DATA; /// -/// Cache Information - Associativity. +/// Cache Information - Associativity. /// typedef enum { CacheAssociativityOther = 0x01, @@ -1096,7 +1096,7 @@ typedef enum { /// /// Cache Information (Type 7). /// -/// The information in this structure defines the attributes of CPU cache device in the system. +/// The information in this structure defines the attributes of CPU cache device in the system. /// One structure is specified for each such device, whether the device is internal to /// or external to the CPU module. Cache modules can be associated with a processor structure /// in one or two ways, depending on the SMBIOS version. @@ -1121,7 +1121,7 @@ typedef struct { } SMBIOS_TABLE_TYPE7; /// -/// Port Connector Information - Connector Types. +/// Port Connector Information - Connector Types. /// typedef enum { PortConnectorTypeNone = 0x00, @@ -1168,7 +1168,7 @@ typedef enum { } MISC_PORT_CONNECTOR_TYPE; /// -/// Port Connector Information - Port Types +/// Port Connector Information - Port Types /// typedef enum { PortTypeNone = 0x00, @@ -1213,8 +1213,8 @@ typedef enum { /// /// Port Connector Information (Type 8). /// -/// The information in this structure defines the attributes of a system port connector, -/// e.g. parallel, serial, keyboard, or mouse ports. The port's type and connector information +/// The information in this structure defines the attributes of a system port connector, +/// e.g. parallel, serial, keyboard, or mouse ports. The port's type and connector information /// are provided. One structure is present for each port provided by the system. /// typedef struct { @@ -1321,7 +1321,7 @@ typedef enum { } MISC_SLOT_USAGE; /// -/// System Slots - Slot Length. +/// System Slots - Slot Length. /// typedef enum { SlotLengthOther = 0x01, @@ -1331,7 +1331,7 @@ typedef enum { } MISC_SLOT_LENGTH; /// -/// System Slots - Slot Characteristics 1. +/// System Slots - Slot Characteristics 1. /// typedef struct { UINT8 CharacteristicsUnknown :1; @@ -1344,7 +1344,7 @@ typedef struct { UINT8 ModemRingResumeSupported:1; } MISC_SLOT_CHARACTERISTICS1; /// -/// System Slots - Slot Characteristics 2. +/// System Slots - Slot Characteristics 2. /// typedef struct { UINT8 PmeSignalSupported :1; @@ -1356,7 +1356,7 @@ typedef struct { /// /// System Slots (Type 9) /// -/// The information in this structure defines the attributes of a system slot. +/// The information in this structure defines the attributes of a system slot. /// One structure is provided for each slot in the system. /// /// @@ -1379,7 +1379,7 @@ typedef struct { } SMBIOS_TABLE_TYPE9; /// -/// On Board Devices Information - Device Types. +/// On Board Devices Information - Device Types. /// typedef enum { OnBoardDeviceTypeOther = 0x01, @@ -1406,10 +1406,10 @@ typedef struct { /// /// On Board Devices Information (Type 10, obsolete). /// -/// Note: This structure is obsolete starting with version 2.6 specification; the Onboard Devices Extended -/// Information (Type 41) structure should be used instead . BIOS providers can choose to implement both -/// types to allow existing SMBIOS browsers to properly display the system's onboard devices information. -/// The information in this structure defines the attributes of devices that are onboard (soldered onto) +/// Note: This structure is obsolete starting with version 2.6 specification; the Onboard Devices Extended +/// Information (Type 41) structure should be used instead . BIOS providers can choose to implement both +/// types to allow existing SMBIOS browsers to properly display the system's onboard devices information. +/// The information in this structure defines the attributes of devices that are onboard (soldered onto) /// a system element, usually the baseboard. In general, an entry in this table implies that the BIOS /// has some level of control over the enabling of the associated device for use by the system. /// @@ -1420,8 +1420,8 @@ typedef struct { /// /// OEM Strings (Type 11). -/// This structure contains free form strings defined by the OEM. Examples of this are: -/// Part Numbers for Reference Documents for the system, contact information for the manufacturer, etc. +/// This structure contains free form strings defined by the OEM. Examples of this are: +/// Part Numbers for Reference Documents for the system, contact information for the manufacturer, etc. /// typedef struct { SMBIOS_STRUCTURE Hdr; @@ -1431,7 +1431,7 @@ typedef struct { /// /// System Configuration Options (Type 12). /// -/// This structure contains information required to configure the base board's Jumpers and Switches. +/// This structure contains information required to configure the base board's Jumpers and Switches. /// typedef struct { SMBIOS_STRUCTURE Hdr; @@ -1442,8 +1442,8 @@ typedef struct { /// /// BIOS Language Information (Type 13). /// -/// The information in this structure defines the installable language attributes of the BIOS. -/// +/// The information in this structure defines the installable language attributes of the BIOS. +/// typedef struct { SMBIOS_STRUCTURE Hdr; UINT8 InstallableLanguages; @@ -1463,9 +1463,9 @@ typedef struct { /// /// Group Associations (Type 14). /// -/// The Group Associations structure is provided for OEMs who want to specify -/// the arrangement or hierarchy of certain components (including other Group Associations) -/// within the system. +/// The Group Associations structure is provided for OEMs who want to specify +/// the arrangement or hierarchy of certain components (including other Group Associations) +/// within the system. /// typedef struct { SMBIOS_STRUCTURE Hdr; @@ -1475,7 +1475,7 @@ typedef struct { /// /// System Event Log - Event Log Types. -/// +/// typedef enum { EventLogTypeReserved = 0x00, EventLogTypeSingleBitECC = 0x01, @@ -1506,8 +1506,8 @@ typedef enum { } EVENT_LOG_TYPE_DATA; /// -/// System Event Log - Variable Data Format Types. -/// +/// System Event Log - Variable Data Format Types. +/// typedef enum { EventLogVariableNone = 0x00, EventLogVariableHandle = 0x01, @@ -1515,7 +1515,7 @@ typedef enum { EventLogVariableMutilEventHandle = 0x03, EventLogVariablePOSTResultBitmap = 0x04, EventLogVariableSysManagementType = 0x05, - EventLogVariableMutliEventSysManagmentType = 0x06, + EventLogVariableMutliEventSysManagmentType = 0x06, EventLogVariableUnused = 0x07, EventLogVariableOEMAssigned = 0x80 } EVENT_LOG_VARIABLE_DATA; @@ -1531,10 +1531,10 @@ typedef struct { /// /// System Event Log (Type 15). /// -/// The presence of this structure within the SMBIOS data returned for a system indicates -/// that the system supports an event log. An event log is a fixed-length area within a -/// non-volatile storage element, starting with a fixed-length (and vendor-specific) header -/// record, followed by one or more variable-length log records. +/// The presence of this structure within the SMBIOS data returned for a system indicates +/// that the system supports an event log. An event log is a fixed-length area within a +/// non-volatile storage element, starting with a fixed-length (and vendor-specific) header +/// record, followed by one or more variable-length log records. /// typedef struct { SMBIOS_STRUCTURE Hdr; @@ -1585,7 +1585,7 @@ typedef enum { } MEMORY_ARRAY_USE; /// -/// Physical Memory Array - Error Correction Types. +/// Physical Memory Array - Error Correction Types. /// typedef enum { MemoryErrorCorrectionOther = 0x01, @@ -1600,8 +1600,8 @@ typedef enum { /// /// Physical Memory Array (Type 16). /// -/// This structure describes a collection of memory devices that operate -/// together to form a memory address space. +/// This structure describes a collection of memory devices that operate +/// together to form a memory address space. /// typedef struct { SMBIOS_STRUCTURE Hdr; @@ -1693,10 +1693,10 @@ typedef struct { /// /// Memory Device (Type 17). /// -/// This structure describes a single memory device that is part of +/// This structure describes a single memory device that is part of /// a larger Physical Memory Array (Type 16). -/// Note: If a system includes memory-device sockets, the SMBIOS implementation -/// includes a Memory Device structure instance for each slot, whether or not the +/// Note: If a system includes memory-device sockets, the SMBIOS implementation +/// includes a Memory Device structure instance for each slot, whether or not the /// socket is currently populated. /// typedef struct { @@ -1719,7 +1719,7 @@ typedef struct { SMBIOS_TABLE_STRING PartNumber; // // Add for smbios 2.6 - // + // UINT8 Attributes; // // Add for smbios 2.7 @@ -1735,9 +1735,9 @@ typedef struct { } SMBIOS_TABLE_TYPE17; /// -/// 32-bit Memory Error Information - Error Type. +/// 32-bit Memory Error Information - Error Type. /// -typedef enum { +typedef enum { MemoryErrorOther = 0x01, MemoryErrorUnknown = 0x02, MemoryErrorOk = 0x03, @@ -1755,9 +1755,9 @@ typedef enum { } MEMORY_ERROR_TYPE; /// -/// 32-bit Memory Error Information - Error Granularity. +/// 32-bit Memory Error Information - Error Granularity. /// -typedef enum { +typedef enum { MemoryGranularityOther = 0x01, MemoryGranularityOtherUnknown = 0x02, MemoryGranularityDeviceLevel = 0x03, @@ -1765,9 +1765,9 @@ typedef enum { } MEMORY_ERROR_GRANULARITY; /// -/// 32-bit Memory Error Information - Error Operation. +/// 32-bit Memory Error Information - Error Operation. /// -typedef enum { +typedef enum { MemoryErrorOperationOther = 0x01, MemoryErrorOperationUnknown = 0x02, MemoryErrorOperationRead = 0x03, @@ -1777,8 +1777,8 @@ typedef enum { /// /// 32-bit Memory Error Information (Type 18). -/// -/// This structure identifies the specifics of an error that might be detected +/// +/// This structure identifies the specifics of an error that might be detected /// within a Physical Memory Array. /// typedef struct { @@ -1795,7 +1795,7 @@ typedef struct { /// /// Memory Array Mapped Address (Type 19). /// -/// This structure provides the address mapping for a Physical Memory Array. +/// This structure provides the address mapping for a Physical Memory Array. /// One structure is present for each contiguous address range described. /// typedef struct { @@ -1814,8 +1814,8 @@ typedef struct { /// /// Memory Device Mapped Address (Type 20). /// -/// This structure maps memory address space usually to a device-level granularity. -/// One structure is present for each contiguous address range described. +/// This structure maps memory address space usually to a device-level granularity. +/// One structure is present for each contiguous address range described. /// typedef struct { SMBIOS_STRUCTURE Hdr; @@ -1868,9 +1868,9 @@ typedef enum { /// /// Built-in Pointing Device (Type 21). /// -/// This structure describes the attributes of the built-in pointing device for the +/// This structure describes the attributes of the built-in pointing device for the /// system. The presence of this structure does not imply that the built-in -/// pointing device is active for the system's use! +/// pointing device is active for the system's use! /// typedef struct { SMBIOS_STRUCTURE Hdr; @@ -1882,7 +1882,7 @@ typedef struct { /// /// Portable Battery - Device Chemistry /// -typedef enum { +typedef enum { PortableBatteryDeviceChemistryOther = 0x01, PortableBatteryDeviceChemistryUnknown = 0x02, PortableBatteryDeviceChemistryLeadAcid = 0x03, @@ -1896,8 +1896,8 @@ typedef enum { /// /// Portable Battery (Type 22). /// -/// This structure describes the attributes of the portable battery(s) for the system. -/// The structure contains the static attributes for the group. Each structure describes +/// This structure describes the attributes of the portable battery(s) for the system. +/// The structure contains the static attributes for the group. Each structure describes /// a single battery pack's attributes. /// typedef struct { @@ -1922,11 +1922,11 @@ typedef struct { /// /// System Reset (Type 23) /// -/// This structure describes whether Automatic System Reset functions enabled (Status). +/// This structure describes whether Automatic System Reset functions enabled (Status). /// If the system has a watchdog Timer and the timer is not reset (Timer Reset) -/// before the Interval elapses, an automatic system reset will occur. The system will re-boot -/// according to the Boot Option. This function may repeat until the Limit is reached, at which time -/// the system will re-boot according to the Boot Option at Limit. +/// before the Interval elapses, an automatic system reset will occur. The system will re-boot +/// according to the Boot Option. This function may repeat until the Limit is reached, at which time +/// the system will re-boot according to the Boot Option at Limit. /// typedef struct { SMBIOS_STRUCTURE Hdr; @@ -1940,7 +1940,7 @@ typedef struct { /// /// Hardware Security (Type 24). /// -/// This structure describes the system-wide hardware security settings. +/// This structure describes the system-wide hardware security settings. /// typedef struct { SMBIOS_STRUCTURE Hdr; @@ -1950,10 +1950,10 @@ typedef struct { /// /// System Power Controls (Type 25). /// -/// This structure describes the attributes for controlling the main power supply to the system. -/// Software that interprets this structure uses the month, day, hour, minute, and second values -/// to determine the number of seconds until the next power-on of the system. The presence of -/// this structure implies that a timed power-on facility is available for the system. +/// This structure describes the attributes for controlling the main power supply to the system. +/// Software that interprets this structure uses the month, day, hour, minute, and second values +/// to determine the number of seconds until the next power-on of the system. The presence of +/// this structure implies that a timed power-on facility is available for the system. /// typedef struct { SMBIOS_STRUCTURE Hdr; @@ -1975,7 +1975,7 @@ typedef struct { /// /// Voltage Probe (Type 26) /// -/// This describes the attributes for a voltage probe in the system. +/// This describes the attributes for a voltage probe in the system. /// Each structure describes a single voltage probe. /// typedef struct { @@ -2002,9 +2002,9 @@ typedef struct { /// /// Cooling Device (Type 27) /// -/// This structure describes the attributes for a cooling device in the system. -/// Each structure describes a single cooling device. -/// +/// This structure describes the attributes for a cooling device in the system. +/// Each structure describes a single cooling device. +/// typedef struct { SMBIOS_STRUCTURE Hdr; UINT16 TemperatureProbeHandle; @@ -2029,8 +2029,8 @@ typedef struct { /// /// Temperature Probe (Type 28). /// -/// This structure describes the attributes for a temperature probe in the system. -/// Each structure describes a single temperature probe. +/// This structure describes the attributes for a temperature probe in the system. +/// Each structure describes a single temperature probe. /// typedef struct { SMBIOS_STRUCTURE Hdr; @@ -2057,7 +2057,7 @@ typedef struct { /// Electrical Current Probe (Type 29). /// /// This structure describes the attributes for an electrical current probe in the system. -/// Each structure describes a single electrical current probe. +/// Each structure describes a single electrical current probe. /// typedef struct { SMBIOS_STRUCTURE Hdr; @@ -2075,9 +2075,9 @@ typedef struct { /// /// Out-of-Band Remote Access (Type 30). /// -/// This structure describes the attributes and policy settings of a hardware facility -/// that may be used to gain remote access to a hardware system when the operating system -/// is not available due to power-down status, hardware failures, or boot failures. +/// This structure describes the attributes and policy settings of a hardware facility +/// that may be used to gain remote access to a hardware system when the operating system +/// is not available due to power-down status, hardware failures, or boot failures. /// typedef struct { SMBIOS_STRUCTURE Hdr; @@ -2088,8 +2088,8 @@ typedef struct { /// /// Boot Integrity Services (BIS) Entry Point (Type 31). /// -/// Structure type 31 (decimal) is reserved for use by the Boot Integrity Services (BIS). -/// +/// Structure type 31 (decimal) is reserved for use by the Boot Integrity Services (BIS). +/// typedef struct { SMBIOS_STRUCTURE Hdr; UINT8 Checksum; @@ -2122,12 +2122,12 @@ typedef enum { /// /// System Boot Information (Type 32). /// -/// The client system firmware, e.g. BIOS, communicates the System Boot Status to the -/// client's Pre-boot Execution Environment (PXE) boot image or OS-present management -/// application via this structure. When used in the PXE environment, for example, -/// this code identifies the reason the PXE was initiated and can be used by boot-image -/// software to further automate an enterprise's PXE sessions. For example, an enterprise -/// could choose to automatically download a hardware-diagnostic image to a client whose +/// The client system firmware, e.g. BIOS, communicates the System Boot Status to the +/// client's Pre-boot Execution Environment (PXE) boot image or OS-present management +/// application via this structure. When used in the PXE environment, for example, +/// this code identifies the reason the PXE was initiated and can be used by boot-image +/// software to further automate an enterprise's PXE sessions. For example, an enterprise +/// could choose to automatically download a hardware-diagnostic image to a client whose /// reason code indicated either a firmware- or operating system-detected hardware failure. /// typedef struct { @@ -2139,9 +2139,9 @@ typedef struct { /// /// 64-bit Memory Error Information (Type 33). /// -/// This structure describes an error within a Physical Memory Array, +/// This structure describes an error within a Physical Memory Array, /// when the error address is above 4G (0xFFFFFFFF). -/// +/// typedef struct { SMBIOS_STRUCTURE Hdr; UINT8 ErrorType; ///< The enumeration value from MEMORY_ERROR_TYPE. @@ -2154,7 +2154,7 @@ typedef struct { } SMBIOS_TABLE_TYPE33; /// -/// Management Device - Type. +/// Management Device - Type. /// typedef enum { ManagementDeviceTypeOther = 0x01, @@ -2173,7 +2173,7 @@ typedef enum { } MISC_MANAGEMENT_DEVICE_TYPE; /// -/// Management Device - Address Type. +/// Management Device - Address Type. /// typedef enum { ManagementDeviceAddressTypeOther = 0x01, @@ -2186,7 +2186,7 @@ typedef enum { /// /// Management Device (Type 34). /// -/// The information in this structure defines the attributes of a Management Device. +/// The information in this structure defines the attributes of a Management Device. /// A Management Device might control one or more fans or voltage, current, or temperature /// probes as defined by one or more Management Device Component structures. /// @@ -2201,8 +2201,8 @@ typedef struct { /// /// Management Device Component (Type 35) /// -/// This structure associates a cooling device or environmental probe with structures -/// that define the controlling hardware device and (optionally) the component's thresholds. +/// This structure associates a cooling device or environmental probe with structures +/// that define the controlling hardware device and (optionally) the component's thresholds. /// typedef struct { SMBIOS_STRUCTURE Hdr; @@ -2215,8 +2215,8 @@ typedef struct { /// /// Management Device Threshold Data (Type 36). /// -/// The information in this structure defines threshold information for -/// a component (probe or cooling-unit) contained within a Management Device. +/// The information in this structure defines threshold information for +/// a component (probe or cooling-unit) contained within a Management Device. /// typedef struct { SMBIOS_STRUCTURE Hdr; @@ -2250,7 +2250,7 @@ typedef enum { /// Memory Channel (Type 37) /// /// The information in this structure provides the correlation between a Memory Channel -/// and its associated Memory Devices. Each device presents one or more loads to the channel. +/// and its associated Memory Devices. Each device presents one or more loads to the channel. /// The sum of all device loads cannot exceed the channel's defined maximum. /// typedef struct { @@ -2331,10 +2331,10 @@ typedef struct { } SMBIOS_TABLE_TYPE39; /// -/// Additional Information Entry Format. +/// Additional Information Entry Format. /// -typedef struct { - UINT8 EntryLength; +typedef struct { + UINT8 EntryLength; UINT16 ReferencedHandle; UINT8 ReferencedOffset; SMBIOS_TABLE_STRING EntryString; @@ -2344,13 +2344,13 @@ typedef struct { /// /// Additional Information (Type 40). /// -/// This structure is intended to provide additional information for handling unspecified -/// enumerated values and interim field updates in another structure. +/// This structure is intended to provide additional information for handling unspecified +/// enumerated values and interim field updates in another structure. /// typedef struct { SMBIOS_STRUCTURE Hdr; UINT8 NumberOfAdditionalInformationEntries; - ADDITIONAL_INFORMATION_ENTRY AdditionalInfoEntries[1]; + ADDITIONAL_INFORMATION_ENTRY AdditionalInfoEntries[1]; } SMBIOS_TABLE_TYPE40; /// @@ -2372,10 +2372,10 @@ typedef enum{ /// /// Onboard Devices Extended Information (Type 41). /// -/// The information in this structure defines the attributes of devices that -/// are onboard (soldered onto) a system element, usually the baseboard. -/// In general, an entry in this table implies that the BIOS has some level of -/// control over the enabling of the associated device for use by the system. +/// The information in this structure defines the attributes of devices that +/// are onboard (soldered onto) a system element, usually the baseboard. +/// In general, an entry in this table implies that the BIOS has some level of +/// control over the enabling of the associated device for use by the system. /// typedef struct { SMBIOS_STRUCTURE Hdr; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/SmBus.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/SmBus.h index be6851800c..cca49cffe1 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/SmBus.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/SmBus.h @@ -3,13 +3,13 @@ and defined in PI1.0 specification volume 5. Copyright (c) 2007 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/TcgPhysicalPresence.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/TcgPhysicalPresence.h index 23d7a09c44..769358815a 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/TcgPhysicalPresence.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/TcgPhysicalPresence.h @@ -2,12 +2,12 @@ TCG Physical Presence definition. Copyright (c) 2015, 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 +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 -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -65,7 +65,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define TCG_PHYSICAL_PRESENCE_ENABLE 1 #define TCG_PHYSICAL_PRESENCE_DISABLE 2 #define TCG_PHYSICAL_PRESENCE_ACTIVATE 3 -#define TCG_PHYSICAL_PRESENCE_DEACTIVATE 4 +#define TCG_PHYSICAL_PRESENCE_DEACTIVATE 4 #define TCG_PHYSICAL_PRESENCE_CLEAR 5 #define TCG_PHYSICAL_PRESENCE_ENABLE_ACTIVATE 6 #define TCG_PHYSICAL_PRESENCE_DEACTIVATE_DISABLE 7 diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Tpm12.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Tpm12.h index 0736c02a80..464450c5b2 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Tpm12.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/Tpm12.h @@ -1,15 +1,15 @@ -/** @file +/** @file TPM Specification data structures (TCG TPM Specification Version 1.2 Revision 103) See http://trustedcomputinggroup.org for latest specification updates 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -155,8 +155,8 @@ typedef UINT32 TPM_KEY_CONTROL; /// typedef UINT32 TPM_NV_INDEX; /// -/// The family ID. Family IDs are automatically assigned a sequence number by the TPM. -/// A trusted process can set the FamilyID value in an individual row to NULL, which +/// The family ID. Family IDs are automatically assigned a sequence number by the TPM. +/// A trusted process can set the FamilyID value in an individual row to NULL, which /// invalidates that row. The family ID resets to NULL on each change of TPM Owner. /// typedef UINT32 TPM_FAMILY_ID; @@ -826,7 +826,7 @@ typedef struct tdTPM_STANY_FLAGS{ #define TPM_AF_TOSPRESENT ((TPM_CAPABILITY_AREA) 4) // -// All those structures defined in section 7.4, 7.5, 7.6 are not normative and +// All those structures defined in section 7.4, 7.5, 7.6 are not normative and // thus no definitions here // // Part 2, section 7.4: TPM_PERMANENT_DATA @@ -901,7 +901,7 @@ typedef struct tdTPM_STANY_FLAGS{ // // Part 2, section 8: PCR Structures -// +// /// /// Part 2, section 8.1: TPM_PCR_SELECTION @@ -1039,7 +1039,7 @@ typedef struct tdTPM_BOUND_DATA { // // Part 2 section 10: TPM_KEY complex -// +// // // Section 10.1, 10.4, and 10.5 have been defined previously diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/UefiTcgPlatform.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/UefiTcgPlatform.h index 0a7469ad41..9986eafc93 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/UefiTcgPlatform.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/UefiTcgPlatform.h @@ -190,7 +190,7 @@ typedef struct { typedef struct tdEFI_GPT_DATA { EFI_PARTITION_TABLE_HEADER EfiPartitionHeader; - UINTN NumberOfPartitions; + UINTN NumberOfPartitions; EFI_PARTITION_ENTRY Partitions[1]; } EFI_GPT_DATA; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/WatchdogActionTable.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/WatchdogActionTable.h index 124a5e7775..03f202ba5e 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/WatchdogActionTable.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/WatchdogActionTable.h @@ -1,15 +1,15 @@ -/** @file +/** @file ACPI Watchdog Action Table (WADT) as defined at Microsoft Hardware Watchdog Timers Design Specification. Copyright (c) 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -36,8 +36,8 @@ typedef struct { UINT32 TimerPeriod; UINT32 MaxCount; UINT32 MinCount; - UINT8 WatchdogFlags; - UINT8 Reserved_61[3]; + UINT8 WatchdogFlags; + UINT8 Reserved_61[3]; UINT32 NumberWatchdogInstructionEntries; } EFI_ACPI_WATCHDOG_ACTION_1_0_TABLE; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/WatchdogResourceTable.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/WatchdogResourceTable.h index a0b0cf2c18..63ab635425 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/WatchdogResourceTable.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/WatchdogResourceTable.h @@ -1,15 +1,15 @@ -/** @file +/** @file ACPI Watchdog Resource Table (WDRT) as defined at Microsoft Windows Hardware Developer Central. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ #ifndef _WATCHDOG_RESOURCE_TABLE_H_ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/WindowsSmmSecurityMitigationTable.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/WindowsSmmSecurityMitigationTable.h index 390a3c8372..eb50338030 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/WindowsSmmSecurityMitigationTable.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/WindowsSmmSecurityMitigationTable.h @@ -3,7 +3,7 @@ @ https://msdn.microsoft.com/windows/hardware/drivers/bringup/acpi-system-description-tables#wsmt Copyright (c) 2016, Intel Corporation. All rights reserved.<BR> - This program and the accompanying materials + 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 diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/WindowsUxCapsule.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/WindowsUxCapsule.h index 611c8f6377..d283bf2e60 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/WindowsUxCapsule.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/IndustryStandard/WindowsUxCapsule.h @@ -3,7 +3,7 @@ Windows UEFI Firmware Update Platform specification Copyright (c) 2015, Intel Corporation. All rights reserved.<BR> - This program and the accompanying materials + 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 diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ipf/ProcessorBind.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ipf/ProcessorBind.h index 8ed5c78401..c95fd84685 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ipf/ProcessorBind.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ipf/ProcessorBind.h @@ -2,7 +2,7 @@ Processor or Compiler specific defines and types for Intel Itanium(TM) processors. Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR> -This program and the accompanying materials are licensed and made available +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. @@ -266,7 +266,7 @@ typedef INT64 INTN; #elif defined(_MSC_EXTENSIONS) /// /// Microsoft* compiler-specific method for EFIAPI calling convention. - /// + /// #define EFIAPI __cdecl #else #define EFIAPI @@ -298,16 +298,16 @@ typedef struct { /** Return the pointer to the first instruction of a function given a function pointer. - For Itanium processors, all function calls are made through a PLABEL, so a pointer to a function - is actually a pointer to a PLABEL. The pointer to the first instruction of the function - is contained within the PLABEL. This macro may be used to retrieve a pointer to the first - instruction of a function independent of the CPU architecture being used. This is very + For Itanium processors, all function calls are made through a PLABEL, so a pointer to a function + is actually a pointer to a PLABEL. The pointer to the first instruction of the function + is contained within the PLABEL. This macro may be used to retrieve a pointer to the first + instruction of a function independent of the CPU architecture being used. This is very useful when printing function addresses through DEBUG() macros. - + @param FunctionPointer A pointer to a function. @return The pointer to the first instruction of a function given a function pointer. - + **/ #define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(((EFI_PLABEL *)(FunctionPointer))->EntryPoint) diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/BaseLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/BaseLib.h index 173b1899c0..173f77bf3a 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/BaseLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/BaseLib.h @@ -257,7 +257,7 @@ StrnSizeS ( @retval RETURN_INVALID_PARAMETER If Destination is NULL. If Source is NULL. If PcdMaximumUnicodeStringLength is not zero, - and DestMax is greater than + and DestMax is greater than PcdMaximumUnicodeStringLength. If DestMax is 0. @retval RETURN_ACCESS_DENIED If Source and Destination overlap. @@ -290,12 +290,12 @@ StrCpyS ( @param Length The maximum number of Unicode characters to copy. @retval RETURN_SUCCESS String is copied. - @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than + @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than MIN(StrLen(Source), Length). @retval RETURN_INVALID_PARAMETER If Destination is NULL. If Source is NULL. If PcdMaximumUnicodeStringLength is not zero, - and DestMax is greater than + and DestMax is greater than PcdMaximumUnicodeStringLength. If DestMax is 0. @retval RETURN_ACCESS_DENIED If Source and Destination overlap. @@ -327,14 +327,14 @@ StrnCpyS ( @param Source A pointer to a Null-terminated Unicode string. @retval RETURN_SUCCESS String is appended. - @retval RETURN_BAD_BUFFER_SIZE If DestMax is NOT greater than + @retval RETURN_BAD_BUFFER_SIZE If DestMax is NOT greater than StrLen(Destination). @retval RETURN_BUFFER_TOO_SMALL If (DestMax - StrLen(Destination)) is NOT greater than StrLen(Source). @retval RETURN_INVALID_PARAMETER If Destination is NULL. If Source is NULL. If PcdMaximumUnicodeStringLength is not zero, - and DestMax is greater than + and DestMax is greater than PcdMaximumUnicodeStringLength. If DestMax is 0. @retval RETURN_ACCESS_DENIED If Source and Destination overlap. @@ -375,7 +375,7 @@ StrCatS ( @retval RETURN_INVALID_PARAMETER If Destination is NULL. If Source is NULL. If PcdMaximumUnicodeStringLength is not zero, - and DestMax is greater than + and DestMax is greater than PcdMaximumUnicodeStringLength. If DestMax is 0. @retval RETURN_ACCESS_DENIED If Source and Destination overlap. @@ -690,7 +690,7 @@ AsciiStrnSizeS ( @retval RETURN_INVALID_PARAMETER If Destination is NULL. If Source is NULL. If PcdMaximumAsciiStringLength is not zero, - and DestMax is greater than + and DestMax is greater than PcdMaximumAsciiStringLength. If DestMax is 0. @retval RETURN_ACCESS_DENIED If Source and Destination overlap. @@ -721,12 +721,12 @@ AsciiStrCpyS ( @param Length The maximum number of Ascii characters to copy. @retval RETURN_SUCCESS String is copied. - @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than + @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than MIN(StrLen(Source), Length). @retval RETURN_INVALID_PARAMETER If Destination is NULL. If Source is NULL. If PcdMaximumAsciiStringLength is not zero, - and DestMax is greater than + and DestMax is greater than PcdMaximumAsciiStringLength. If DestMax is 0. @retval RETURN_ACCESS_DENIED If Source and Destination overlap. @@ -756,14 +756,14 @@ AsciiStrnCpyS ( @param Source A pointer to a Null-terminated Ascii string. @retval RETURN_SUCCESS String is appended. - @retval RETURN_BAD_BUFFER_SIZE If DestMax is NOT greater than + @retval RETURN_BAD_BUFFER_SIZE If DestMax is NOT greater than StrLen(Destination). @retval RETURN_BUFFER_TOO_SMALL If (DestMax - StrLen(Destination)) is NOT greater than StrLen(Source). @retval RETURN_INVALID_PARAMETER If Destination is NULL. If Source is NULL. If PcdMaximumAsciiStringLength is not zero, - and DestMax is greater than + and DestMax is greater than PcdMaximumAsciiStringLength. If DestMax is 0. @retval RETURN_ACCESS_DENIED If Source and Destination overlap. @@ -802,7 +802,7 @@ AsciiStrCatS ( @retval RETURN_INVALID_PARAMETER If Destination is NULL. If Source is NULL. If PcdMaximumAsciiStringLength is not zero, - and DestMax is greater than + and DestMax is greater than PcdMaximumAsciiStringLength. If DestMax is 0. @retval RETURN_ACCESS_DENIED If Source and Destination overlap. @@ -1083,7 +1083,7 @@ StrCpy ( /** [ATTENTION] This function is deprecated for security reason. - Copies up to a specified length from one Null-terminated Unicode string to + Copies up to a specified length from one Null-terminated Unicode string to another Null-terminated Unicode string and returns the new Unicode string. This function copies the contents of the Unicode string Source to the Unicode @@ -1099,7 +1099,7 @@ StrCpy ( If Length > 0 and Source is NULL, then ASSERT(). If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT(). If Source and Destination overlap, then ASSERT(). - If PcdMaximumUnicodeStringLength is not zero, and Length is greater than + If PcdMaximumUnicodeStringLength is not zero, and Length is greater than PcdMaximumUnicodeStringLength, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and Source contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator, @@ -1149,7 +1149,7 @@ StrLen ( Returns the size of a Null-terminated Unicode string in bytes, including the Null terminator. - This function returns the size, in bytes, of the Null-terminated Unicode string + This function returns the size, in bytes, of the Null-terminated Unicode string specified by String. If String is NULL, then ASSERT(). @@ -1209,7 +1209,7 @@ StrCmp ( /** Compares up to a specified length the contents of two Null-terminated Unicode strings, and returns the difference between the first mismatched Unicode characters. - + This function compares the Null-terminated Unicode string FirstString to the Null-terminated Unicode string SecondString. At most, Length Unicode characters will be compared. If Length is 0, then 0 is returned. If @@ -1294,8 +1294,8 @@ StrCat ( /** [ATTENTION] This function is deprecated for security reason. - Concatenates up to a specified length one Null-terminated Unicode to the end - of another Null-terminated Unicode string, and returns the concatenated + Concatenates up to a specified length one Null-terminated Unicode to the end + of another Null-terminated Unicode string, and returns the concatenated Unicode string. This function concatenates two Null-terminated Unicode strings. The contents @@ -1311,7 +1311,7 @@ StrCat ( If Length > 0 and Source is NULL, then ASSERT(). If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT(). If Source and Destination overlap, then ASSERT(). - If PcdMaximumUnicodeStringLength is not zero, and Length is greater than + If PcdMaximumUnicodeStringLength is not zero, and Length is greater than PcdMaximumUnicodeStringLength, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and Destination contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the @@ -1451,7 +1451,7 @@ EFIAPI StrDecimalToUint64 ( IN CONST CHAR16 *String ); - + /** Convert a Null-terminated Unicode hexadecimal string to a value of type UINTN. @@ -1468,7 +1468,7 @@ StrDecimalToUint64 ( The function will ignore the pad space, which includes spaces or tab characters, before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the - first valid hexadecimal digit. Then, the function stops at the first character + first valid hexadecimal digit. Then, the function stops at the first character that is a not a valid hexadecimal character or NULL, whichever one comes first. If String is NULL, then ASSERT(). @@ -1952,7 +1952,7 @@ AsciiStrCpy ( /** [ATTENTION] This function is deprecated for security reason. - Copies up to a specified length one Null-terminated ASCII string to another + Copies up to a specified length one Null-terminated ASCII string to another Null-terminated ASCII string and returns the new ASCII string. This function copies the contents of the ASCII string Source to the ASCII @@ -1965,7 +1965,7 @@ AsciiStrCpy ( If Destination is NULL, then ASSERT(). If Source is NULL, then ASSERT(). If Source and Destination overlap, then ASSERT(). - If PcdMaximumAsciiStringLength is not zero, and Length is greater than + If PcdMaximumAsciiStringLength is not zero, and Length is greater than PcdMaximumAsciiStringLength, then ASSERT(). If PcdMaximumAsciiStringLength is not zero, and Source contains more than PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator, @@ -2119,7 +2119,7 @@ AsciiStriCmp ( If Length > 0 and FirstString is NULL, then ASSERT(). If Length > 0 and SecondString is NULL, then ASSERT(). - If PcdMaximumAsciiStringLength is not zero, and Length is greater than + If PcdMaximumAsciiStringLength is not zero, and Length is greater than PcdMaximumAsciiStringLength, then ASSERT(). If PcdMaximumAsciiStringLength is not zero, and FirstString contains more than PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator, @@ -2131,7 +2131,7 @@ AsciiStriCmp ( @param FirstString The pointer to a Null-terminated ASCII string. @param SecondString The pointer to a Null-terminated ASCII string. @param Length The maximum number of ASCII characters for compare. - + @retval ==0 FirstString is identical to SecondString. @retval !=0 FirstString is not identical to SecondString. @@ -2187,8 +2187,8 @@ AsciiStrCat ( /** [ATTENTION] This function is deprecated for security reason. - Concatenates up to a specified length one Null-terminated ASCII string to - the end of another Null-terminated ASCII string, and returns the + Concatenates up to a specified length one Null-terminated ASCII string to + the end of another Null-terminated ASCII string, and returns the concatenated ASCII string. This function concatenates two Null-terminated ASCII strings. The contents @@ -2957,7 +2957,7 @@ InsertHeadList ( If ListHead is NULL, then ASSERT(). If Entry is NULL, then ASSERT(). - If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or + If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead(), then ASSERT(). If PcdMaximumLinkedListLength is not zero, and prior to insertion the number of nodes in ListHead, including the ListHead node, is greater than or @@ -2981,12 +2981,12 @@ InsertTailList ( /** Retrieves the first node of a doubly linked list. - Returns the first node of a doubly linked list. List must have been + Returns the first node of a doubly linked list. List must have been initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead(). If List is empty, then List is returned. If List is NULL, then ASSERT(). - If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or + If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead(), then ASSERT(). If PcdMaximumLinkedListLength is not zero, and the number of nodes in List, including the List node, is greater than or equal to @@ -3008,13 +3008,13 @@ GetFirstNode ( /** Retrieves the next node of a doubly linked list. - Returns the node of a doubly linked list that follows Node. + Returns the node of a doubly linked list that follows Node. List must have been initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead(). If List is empty, then List is returned. If List is NULL, then ASSERT(). If Node is NULL, then ASSERT(). - If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or + If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead(), then ASSERT(). If PcdMaximumLinkedListLength is not zero, and List contains more than PcdMaximumLinkedListLength nodes, then ASSERT(). @@ -3033,27 +3033,27 @@ GetNextNode ( IN CONST LIST_ENTRY *Node ); - + /** Retrieves the previous node of a doubly linked list. - - Returns the node of a doubly linked list that precedes Node. + + Returns the node of a doubly linked list that precedes Node. List must have been initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead(). If List is empty, then List is returned. - + If List is NULL, then ASSERT(). If Node is NULL, then ASSERT(). - If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or + If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead(), then ASSERT(). If PcdMaximumLinkedListLength is not zero, and List contains more than PcdMaximumLinkedListLength nodes, then ASSERT(). If PcdVerifyNodeInList is TRUE and Node is not a node in List, then ASSERT(). - + @param List A pointer to the head node of a doubly linked list. @param Node A pointer to a node in the doubly linked list. - + @return The pointer to the previous node if one exists. Otherwise List is returned. - + **/ LIST_ENTRY * EFIAPI @@ -3062,7 +3062,7 @@ GetPreviousNode ( IN CONST LIST_ENTRY *Node ); - + /** Checks to see if a doubly linked list is empty or not. @@ -3070,7 +3070,7 @@ GetPreviousNode ( zero nodes, this function returns TRUE. Otherwise, it returns FALSE. If ListHead is NULL, then ASSERT(). - If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or + If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead(), then ASSERT(). If PcdMaximumLinkedListLength is not zero, and the number of nodes in List, including the List node, is greater than or equal to @@ -3100,12 +3100,12 @@ IsListEmpty ( If List is NULL, then ASSERT(). If Node is NULL, then ASSERT(). - If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead(), + If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead(), then ASSERT(). If PcdMaximumLinkedListLength is not zero, and the number of nodes in List, including the List node, is greater than or equal to PcdMaximumLinkedListLength, then ASSERT(). - If PcdVerifyNodeInList is TRUE and Node is not a node in List the and Node is not equal + If PcdVerifyNodeInList is TRUE and Node is not a node in List the and Node is not equal to List, then ASSERT(). @param List A pointer to the head node of a doubly linked list. @@ -3162,12 +3162,12 @@ IsNodeAtEnd ( Otherwise, the location of the FirstEntry node is swapped with the location of the SecondEntry node in a doubly linked list. SecondEntry must be in the same double linked list as FirstEntry and that double linked list must have - been initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead(). + been initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead(). SecondEntry is returned after the nodes are swapped. If FirstEntry is NULL, then ASSERT(). If SecondEntry is NULL, then ASSERT(). - If PcdVerifyNodeInList is TRUE and SecondEntry and FirstEntry are not in the + If PcdVerifyNodeInList is TRUE and SecondEntry and FirstEntry are not in the same linked list, then ASSERT(). If PcdMaximumLinkedListLength is not zero, and the number of nodes in the linked list containing the FirstEntry and SecondEntry nodes, including @@ -3176,7 +3176,7 @@ IsNodeAtEnd ( @param FirstEntry A pointer to a node in a linked list. @param SecondEntry A pointer to another node in the same linked list. - + @return SecondEntry. **/ @@ -3744,7 +3744,7 @@ DivU64x64Remainder ( function returns the 64-bit signed quotient. It is the caller's responsibility to not call this function with a Divisor of 0. - If Divisor is 0, then the quotient and remainder should be assumed to be + If Divisor is 0, then the quotient and remainder should be assumed to be the largest negative integer. If Divisor is 0, then ASSERT(). @@ -4076,7 +4076,7 @@ BitFieldAnd8 ( bitwise OR, and returns the result. Performs a bitwise AND between the bit field specified by StartBit and EndBit - in Operand and the value specified by AndData, followed by a bitwise + in Operand and the value specified by AndData, followed by a bitwise OR with value specified by OrData. All other bits in Operand are preserved. The new 8-bit value is returned. @@ -4243,7 +4243,7 @@ BitFieldAnd16 ( bitwise OR, and returns the result. Performs a bitwise AND between the bit field specified by StartBit and EndBit - in Operand and the value specified by AndData, followed by a bitwise + in Operand and the value specified by AndData, followed by a bitwise OR with value specified by OrData. All other bits in Operand are preserved. The new 16-bit value is returned. @@ -4410,7 +4410,7 @@ BitFieldAnd32 ( bitwise OR, and returns the result. Performs a bitwise AND between the bit field specified by StartBit and EndBit - in Operand and the value specified by AndData, followed by a bitwise + in Operand and the value specified by AndData, followed by a bitwise OR with value specified by OrData. All other bits in Operand are preserved. The new 32-bit value is returned. @@ -4577,7 +4577,7 @@ BitFieldAnd64 ( bitwise OR, and returns the result. Performs a bitwise AND between the bit field specified by StartBit and EndBit - in Operand and the value specified by AndData, followed by a bitwise + in Operand and the value specified by AndData, followed by a bitwise OR with value specified by OrData. All other bits in Operand are preserved. The new 64-bit value is returned. @@ -4892,11 +4892,11 @@ MemoryFence ( If JumpBuffer is NULL, then ASSERT(). For Itanium processors, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT(). - + NOTE: The structure BASE_LIBRARY_JUMP_BUFFER is CPU architecture specific. The same structure must never be used for more than one CPU architecture context. - For example, a BASE_LIBRARY_JUMP_BUFFER allocated by an IA-32 module must never be used from an x64 module. - SetJump()/LongJump() is not currently supported for the EBC processor type. + For example, a BASE_LIBRARY_JUMP_BUFFER allocated by an IA-32 module must never be used from an x64 module. + SetJump()/LongJump() is not currently supported for the EBC processor type. @param JumpBuffer A pointer to CPU context buffer. @@ -5058,9 +5058,9 @@ CpuPause ( function. @param NewStack A pointer to the new stack to use for the EntryPoint function. - @param ... This variable argument list is ignored for IA-32, x64, and - EBC architectures. For Itanium processors, this variable - argument list is expected to contain a single parameter of + @param ... This variable argument list is ignored for IA-32, x64, and + EBC architectures. For Itanium processors, this variable + argument list is expected to contain a single parameter of type VOID * that specifies the new backing store pointer. @@ -5104,19 +5104,19 @@ EFIAPI CpuDeadLoop ( VOID ); - + #if defined (MDE_CPU_IPF) /** Flush a range of cache lines in the cache coherency domain of the calling CPU. - Flushes the cache lines specified by Address and Length. If Address is not aligned - on a cache line boundary, then entire cache line containing Address is flushed. - If Address + Length is not aligned on a cache line boundary, then the entire cache - line containing Address + Length - 1 is flushed. This function may choose to flush - the entire cache if that is more efficient than flushing the specified range. If - Length is 0, the no cache lines are flushed. Address is returned. + Flushes the cache lines specified by Address and Length. If Address is not aligned + on a cache line boundary, then entire cache line containing Address is flushed. + If Address + Length is not aligned on a cache line boundary, then the entire cache + line containing Address + Length - 1 is flushed. This function may choose to flush + the entire cache if that is more efficient than flushing the specified range. If + Length is 0, the no cache lines are flushed. Address is returned. This function is only available on Itanium processors. If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT(). @@ -5177,8 +5177,8 @@ AsmFci ( /** Reads the current value of a Processor Identifier Register (CPUID). - - Reads and returns the current value of Processor Identifier Register specified by Index. + + Reads and returns the current value of Processor Identifier Register specified by Index. The Index of largest implemented CPUID (One less than the number of implemented CPUID registers) is determined by CPUID [3] bits {7:0}. No parameter checking is performed on Index. If the Index value is beyond the @@ -5234,8 +5234,8 @@ AsmWritePsr ( /** Reads the current value of 64-bit Kernel Register #0 (KR0). - - Reads and returns the current value of KR0. + + Reads and returns the current value of KR0. This function is only available on Itanium processors. @return The current value of KR0. @@ -5251,7 +5251,7 @@ AsmReadKr0 ( /** Reads the current value of 64-bit Kernel Register #1 (KR1). - Reads and returns the current value of KR1. + Reads and returns the current value of KR1. This function is only available on Itanium processors. @return The current value of KR1. @@ -5267,7 +5267,7 @@ AsmReadKr1 ( /** Reads the current value of 64-bit Kernel Register #2 (KR2). - Reads and returns the current value of KR2. + Reads and returns the current value of KR2. This function is only available on Itanium processors. @return The current value of KR2. @@ -5283,7 +5283,7 @@ AsmReadKr2 ( /** Reads the current value of 64-bit Kernel Register #3 (KR3). - Reads and returns the current value of KR3. + Reads and returns the current value of KR3. This function is only available on Itanium processors. @return The current value of KR3. @@ -5299,9 +5299,9 @@ AsmReadKr3 ( /** Reads the current value of 64-bit Kernel Register #4 (KR4). - Reads and returns the current value of KR4. + Reads and returns the current value of KR4. This function is only available on Itanium processors. - + @return The current value of KR4. **/ @@ -5315,7 +5315,7 @@ AsmReadKr4 ( /** Reads the current value of 64-bit Kernel Register #5 (KR5). - Reads and returns the current value of KR5. + Reads and returns the current value of KR5. This function is only available on Itanium processors. @return The current value of KR5. @@ -5331,7 +5331,7 @@ AsmReadKr5 ( /** Reads the current value of 64-bit Kernel Register #6 (KR6). - Reads and returns the current value of KR6. + Reads and returns the current value of KR6. This function is only available on Itanium processors. @return The current value of KR6. @@ -5347,7 +5347,7 @@ AsmReadKr6 ( /** Reads the current value of 64-bit Kernel Register #7 (KR7). - Reads and returns the current value of KR7. + Reads and returns the current value of KR7. This function is only available on Itanium processors. @return The current value of KR7. @@ -5362,8 +5362,8 @@ AsmReadKr7 ( /** Write the current value of 64-bit Kernel Register #0 (KR0). - - Writes the current value of KR0. The 64-bit value written to + + Writes the current value of KR0. The 64-bit value written to the KR0 is returned. This function is only available on Itanium processors. @param Value The 64-bit value to write to KR0. @@ -5381,7 +5381,7 @@ AsmWriteKr0 ( /** Write the current value of 64-bit Kernel Register #1 (KR1). - Writes the current value of KR1. The 64-bit value written to + Writes the current value of KR1. The 64-bit value written to the KR1 is returned. This function is only available on Itanium processors. @param Value The 64-bit value to write to KR1. @@ -5399,7 +5399,7 @@ AsmWriteKr1 ( /** Write the current value of 64-bit Kernel Register #2 (KR2). - Writes the current value of KR2. The 64-bit value written to + Writes the current value of KR2. The 64-bit value written to the KR2 is returned. This function is only available on Itanium processors. @param Value The 64-bit value to write to KR2. @@ -5417,7 +5417,7 @@ AsmWriteKr2 ( /** Write the current value of 64-bit Kernel Register #3 (KR3). - Writes the current value of KR3. The 64-bit value written to + Writes the current value of KR3. The 64-bit value written to the KR3 is returned. This function is only available on Itanium processors. @param Value The 64-bit value to write to KR3. @@ -5435,7 +5435,7 @@ AsmWriteKr3 ( /** Write the current value of 64-bit Kernel Register #4 (KR4). - Writes the current value of KR4. The 64-bit value written to + Writes the current value of KR4. The 64-bit value written to the KR4 is returned. This function is only available on Itanium processors. @param Value The 64-bit value to write to KR4. @@ -5453,7 +5453,7 @@ AsmWriteKr4 ( /** Write the current value of 64-bit Kernel Register #5 (KR5). - Writes the current value of KR5. The 64-bit value written to + Writes the current value of KR5. The 64-bit value written to the KR5 is returned. This function is only available on Itanium processors. @param Value The 64-bit value to write to KR5. @@ -5471,7 +5471,7 @@ AsmWriteKr5 ( /** Write the current value of 64-bit Kernel Register #6 (KR6). - Writes the current value of KR6. The 64-bit value written to + Writes the current value of KR6. The 64-bit value written to the KR6 is returned. This function is only available on Itanium processors. @param Value The 64-bit value to write to KR6. @@ -5489,7 +5489,7 @@ AsmWriteKr6 ( /** Write the current value of 64-bit Kernel Register #7 (KR7). - Writes the current value of KR7. The 64-bit value written to + Writes the current value of KR7. The 64-bit value written to the KR7 is returned. This function is only available on Itanium processors. @param Value The 64-bit value to write to KR7. @@ -5506,7 +5506,7 @@ AsmWriteKr7 ( /** Reads the current value of Interval Timer Counter Register (ITC). - + Reads and returns the current value of ITC. This function is only available on Itanium processors. @@ -5522,8 +5522,8 @@ AsmReadItc ( /** Reads the current value of Interval Timer Vector Register (ITV). - - Reads and returns the current value of ITV. + + Reads and returns the current value of ITV. This function is only available on Itanium processors. @return The current value of ITV. @@ -5538,7 +5538,7 @@ AsmReadItv ( /** Reads the current value of Interval Timer Match Register (ITM). - + Reads and returns the current value of ITM. This function is only available on Itanium processors. @@ -5553,8 +5553,8 @@ AsmReadItm ( /** Writes the current value of 64-bit Interval Timer Counter Register (ITC). - - Writes the current value of ITC. The 64-bit value written to the ITC is returned. + + Writes the current value of ITC. The 64-bit value written to the ITC is returned. This function is only available on Itanium processors. @param Value The 64-bit value to write to ITC. @@ -5571,8 +5571,8 @@ AsmWriteItc ( /** Writes the current value of 64-bit Interval Timer Match Register (ITM). - - Writes the current value of ITM. The 64-bit value written to the ITM is returned. + + Writes the current value of ITM. The 64-bit value written to the ITM is returned. This function is only available on Itanium processors. @param Value The 64-bit value to write to ITM. @@ -5589,8 +5589,8 @@ AsmWriteItm ( /** Writes the current value of 64-bit Interval Timer Vector Register (ITV). - - Writes the current value of ITV. The 64-bit value written to the ITV is returned. + + Writes the current value of ITV. The 64-bit value written to the ITV is returned. No parameter checking is performed on Value. All bits of Value corresponding to reserved fields of ITV must be 0 or a Reserved Register/Field fault may occur. The caller must either guarantee that Value is valid, or the caller must set up @@ -5611,7 +5611,7 @@ AsmWriteItv ( /** Reads the current value of Default Control Register (DCR). - + Reads and returns the current value of DCR. This function is only available on Itanium processors. @return The current value of DCR. @@ -5626,7 +5626,7 @@ AsmReadDcr ( /** Reads the current value of Interruption Vector Address Register (IVA). - + Reads and returns the current value of IVA. This function is only available on Itanium processors. @return The current value of IVA. @@ -5640,7 +5640,7 @@ AsmReadIva ( /** Reads the current value of Page Table Address Register (PTA). - + Reads and returns the current value of PTA. This function is only available on Itanium processors. @return The current value of PTA. @@ -5655,8 +5655,8 @@ AsmReadPta ( /** Writes the current value of 64-bit Default Control Register (DCR). - - Writes the current value of DCR. The 64-bit value written to the DCR is returned. + + Writes the current value of DCR. The 64-bit value written to the DCR is returned. No parameter checking is performed on Value. All bits of Value corresponding to reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur. The caller must either guarantee that Value is valid, or the caller must set up @@ -5677,8 +5677,8 @@ AsmWriteDcr ( /** Writes the current value of 64-bit Interruption Vector Address Register (IVA). - - Writes the current value of IVA. The 64-bit value written to the IVA is returned. + + Writes the current value of IVA. The 64-bit value written to the IVA is returned. The size of vector table is 32 K bytes and is 32 K bytes aligned the low 15 bits of Value is ignored when written. This function is only available on Itanium processors. @@ -5697,8 +5697,8 @@ AsmWriteIva ( /** Writes the current value of 64-bit Page Table Address Register (PTA). - - Writes the current value of PTA. The 64-bit value written to the PTA is returned. + + Writes the current value of PTA. The 64-bit value written to the PTA is returned. No parameter checking is performed on Value. All bits of Value corresponding to reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur. The caller must either guarantee that Value is valid, or the caller must set up @@ -5718,7 +5718,7 @@ AsmWritePta ( /** Reads the current value of Local Interrupt ID Register (LID). - + Reads and returns the current value of LID. This function is only available on Itanium processors. @return The current value of LID. @@ -5733,8 +5733,8 @@ AsmReadLid ( /** Reads the current value of External Interrupt Vector Register (IVR). - - Reads and returns the current value of IVR. This function is only available on Itanium processors. + + Reads and returns the current value of IVR. This function is only available on Itanium processors. @return The current value of IVR. @@ -5748,8 +5748,8 @@ AsmReadIvr ( /** Reads the current value of Task Priority Register (TPR). - - Reads and returns the current value of TPR. This function is only available on Itanium processors. + + Reads and returns the current value of TPR. This function is only available on Itanium processors. @return The current value of TPR. @@ -5763,8 +5763,8 @@ AsmReadTpr ( /** Reads the current value of External Interrupt Request Register #0 (IRR0). - - Reads and returns the current value of IRR0. This function is only available on Itanium processors. + + Reads and returns the current value of IRR0. This function is only available on Itanium processors. @return The current value of IRR0. @@ -5778,8 +5778,8 @@ AsmReadIrr0 ( /** Reads the current value of External Interrupt Request Register #1 (IRR1). - - Reads and returns the current value of IRR1. This function is only available on Itanium processors. + + Reads and returns the current value of IRR1. This function is only available on Itanium processors. @return The current value of IRR1. @@ -5793,7 +5793,7 @@ AsmReadIrr1 ( /** Reads the current value of External Interrupt Request Register #2 (IRR2). - + Reads and returns the current value of IRR2. This function is only available on Itanium processors. @return The current value of IRR2. @@ -5808,8 +5808,8 @@ AsmReadIrr2 ( /** Reads the current value of External Interrupt Request Register #3 (IRR3). - - Reads and returns the current value of IRR3. This function is only available on Itanium processors. + + Reads and returns the current value of IRR3. This function is only available on Itanium processors. @return The current value of IRR3. @@ -5823,8 +5823,8 @@ AsmReadIrr3 ( /** Reads the current value of Performance Monitor Vector Register (PMV). - - Reads and returns the current value of PMV. This function is only available on Itanium processors. + + Reads and returns the current value of PMV. This function is only available on Itanium processors. @return The current value of PMV. @@ -5838,7 +5838,7 @@ AsmReadPmv ( /** Reads the current value of Corrected Machine Check Vector Register (CMCV). - + Reads and returns the current value of CMCV. This function is only available on Itanium processors. @return The current value of CMCV. @@ -5853,8 +5853,8 @@ AsmReadCmcv ( /** Reads the current value of Local Redirection Register #0 (LRR0). - - Reads and returns the current value of LRR0. This function is only available on Itanium processors. + + Reads and returns the current value of LRR0. This function is only available on Itanium processors. @return The current value of LRR0. @@ -5868,7 +5868,7 @@ AsmReadLrr0 ( /** Reads the current value of Local Redirection Register #1 (LRR1). - + Reads and returns the current value of LRR1. This function is only available on Itanium processors. @return The current value of LRR1. @@ -5883,8 +5883,8 @@ AsmReadLrr1 ( /** Writes the current value of 64-bit Page Local Interrupt ID Register (LID). - - Writes the current value of LID. The 64-bit value written to the LID is returned. + + Writes the current value of LID. The 64-bit value written to the LID is returned. No parameter checking is performed on Value. All bits of Value corresponding to reserved fields of LID must be 0 or a Reserved Register/Field fault may occur. The caller must either guarantee that Value is valid, or the caller must set up @@ -5905,8 +5905,8 @@ AsmWriteLid ( /** Writes the current value of 64-bit Task Priority Register (TPR). - - Writes the current value of TPR. The 64-bit value written to the TPR is returned. + + Writes the current value of TPR. The 64-bit value written to the TPR is returned. No parameter checking is performed on Value. All bits of Value corresponding to reserved fields of TPR must be 0 or a Reserved Register/Field fault may occur. The caller must either guarantee that Value is valid, or the caller must set up @@ -5927,7 +5927,7 @@ AsmWriteTpr ( /** Performs a write operation on End OF External Interrupt Register (EOI). - + Writes a value of 0 to the EOI Register. This function is only available on Itanium processors. **/ @@ -5940,8 +5940,8 @@ AsmWriteEoi ( /** Writes the current value of 64-bit Performance Monitor Vector Register (PMV). - - Writes the current value of PMV. The 64-bit value written to the PMV is returned. + + Writes the current value of PMV. The 64-bit value written to the PMV is returned. No parameter checking is performed on Value. All bits of Value corresponding to reserved fields of PMV must be 0 or a Reserved Register/Field fault may occur. The caller must either guarantee that Value is valid, or the caller must set up @@ -5962,8 +5962,8 @@ AsmWritePmv ( /** Writes the current value of 64-bit Corrected Machine Check Vector Register (CMCV). - - Writes the current value of CMCV. The 64-bit value written to the CMCV is returned. + + Writes the current value of CMCV. The 64-bit value written to the CMCV is returned. No parameter checking is performed on Value. All bits of Value corresponding to reserved fields of CMCV must be 0 or a Reserved Register/Field fault may occur. The caller must either guarantee that Value is valid, or the caller must set up @@ -5984,8 +5984,8 @@ AsmWriteCmcv ( /** Writes the current value of 64-bit Local Redirection Register #0 (LRR0). - - Writes the current value of LRR0. The 64-bit value written to the LRR0 is returned. + + Writes the current value of LRR0. The 64-bit value written to the LRR0 is returned. No parameter checking is performed on Value. All bits of Value corresponding to reserved fields of LRR0 must be 0 or a Reserved Register/Field fault may occur. The caller must either guarantee that Value is valid, or the caller must set up @@ -6006,8 +6006,8 @@ AsmWriteLrr0 ( /** Writes the current value of 64-bit Local Redirection Register #1 (LRR1). - - Writes the current value of LRR1. The 64-bit value written to the LRR1 is returned. + + Writes the current value of LRR1. The 64-bit value written to the LRR1 is returned. No parameter checking is performed on Value. All bits of Value corresponding to reserved fields of LRR1 must be 0 or a Reserved Register/Field fault may occur. The caller must either guarantee that Value is valid, or the caller must @@ -6028,7 +6028,7 @@ AsmWriteLrr1 ( /** Reads the current value of Instruction Breakpoint Register (IBR). - + The Instruction Breakpoint Registers are used in pairs. The even numbered registers contain breakpoint addresses, and the odd numbered registers contain breakpoint mask conditions. At least four instruction registers pairs are implemented @@ -6321,9 +6321,9 @@ AsmReadSp ( /** Reads a 64-bit control register. - Reads and returns the control register specified by Index. The valid Index valued + Reads and returns the control register specified by Index. The valid Index valued are defined above in "Related Definitions". - If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only + If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only available on Itanium processors. @param Index The index of the control register to read. @@ -6372,9 +6372,9 @@ AsmReadControlRegister ( /** Reads a 64-bit application register. - Reads and returns the application register specified by Index. The valid Index + Reads and returns the application register specified by Index. The valid Index valued are defined above in "Related Definitions". - If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only + If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only available on Itanium processors. @param Index The index of the application register to read. @@ -6400,13 +6400,13 @@ AsmReadApplicationRegister ( @param Index The 8-bit Machine Specific Register index to read. - @return The current value of the Machine Specific Register specified by Index. + @return The current value of the Machine Specific Register specified by Index. **/ UINT64 EFIAPI AsmReadMsr ( - IN UINT8 Index + IN UINT8 Index ); @@ -6422,14 +6422,14 @@ AsmReadMsr ( @param Index The 8-bit Machine Specific Register index to write. @param Value The 64-bit value to write to the Machine Specific Register. - @return The 64-bit value to write to the Machine Specific Register. + @return The 64-bit value to write to the Machine Specific Register. **/ UINT64 EFIAPI AsmWriteMsr ( - IN UINT8 Index, - IN UINT64 Value + IN UINT8 Index, + IN UINT64 Value ); @@ -6749,7 +6749,7 @@ typedef union { struct { UINT64 Uint64; UINT64 Uint64_1; - } Uint128; + } Uint128; } IA32_IDT_GATE_DESCRIPTOR; #pragma pack (1) @@ -7157,8 +7157,8 @@ AsmMsrBitFieldRead32 ( Writes Value to a bit field in the lower 32-bits of a 64-bit MSR. The bit field is specified by the StartBit and the EndBit. All other bits in the destination MSR are preserved. The lower 32-bits of the MSR written is - returned. The caller must either guarantee that Index and the data written - is valid, or the caller must set up exception handlers to catch the exceptions. + returned. The caller must either guarantee that Index and the data written + is valid, or the caller must set up exception handlers to catch the exceptions. This function is only available on IA-32 and x64. If StartBit is greater than 31, then ASSERT(). @@ -7401,7 +7401,7 @@ AsmMsrAnd64 ( /** - Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise + Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise OR, and writes the result back to the 64-bit MSR. Reads the 64-bit MSR specified by Index, performs a bitwise AND between read @@ -7466,8 +7466,8 @@ AsmMsrBitFieldRead64 ( Writes Value to a bit field in a 64-bit MSR. The bit field is specified by the StartBit and the EndBit. All other bits in the destination MSR are - preserved. The MSR written is returned. The caller must either guarantee - that Index and the data written is valid, or the caller must set up exception + preserved. The MSR written is returned. The caller must either guarantee + that Index and the data written is valid, or the caller must set up exception handlers to catch the exceptions. This function is only available on IA-32 and x64. If StartBit is greater than 63, then ASSERT(). @@ -8879,7 +8879,7 @@ AsmDisablePaging64 ( in ExtraStackSize. If parameters are passed to the 16-bit real mode code, then the actual minimum stack size is ExtraStackSize plus the maximum number of bytes that need to be passed to the 16-bit real mode code. - + If RealModeBufferSize is NULL, then ASSERT(). If ExtraStackSize is NULL, then ASSERT(). @@ -8903,7 +8903,7 @@ AsmGetThunk16Properties ( Prepares all structures a code required to use AsmThunk16(). Prepares all structures and code required to use AsmThunk16(). - + This interface is limited to be used in either physical mode or virtual modes with paging enabled where the virtual to physical mappings for ThunkContext.RealModeBuffer is mapped 1:1. @@ -8927,43 +8927,43 @@ AsmPrepareThunk16 ( AsmPrepareThunk16() must be called with ThunkContext before this function is used. This function must be called with interrupts disabled. - The register state from the RealModeState field of ThunkContext is restored just prior - to calling the 16-bit real mode entry point. This includes the EFLAGS field of RealModeState, + The register state from the RealModeState field of ThunkContext is restored just prior + to calling the 16-bit real mode entry point. This includes the EFLAGS field of RealModeState, which is used to set the interrupt state when a 16-bit real mode entry point is called. Control is transferred to the 16-bit real mode entry point specified by the CS and Eip fields of RealModeState. - The stack is initialized to the SS and ESP fields of RealModeState. Any parameters passed to - the 16-bit real mode code must be populated by the caller at SS:ESP prior to calling this function. + The stack is initialized to the SS and ESP fields of RealModeState. Any parameters passed to + the 16-bit real mode code must be populated by the caller at SS:ESP prior to calling this function. The 16-bit real mode entry point is invoked with a 16-bit CALL FAR instruction, - so when accessing stack contents, the 16-bit real mode code must account for the 16-bit segment - and 16-bit offset of the return address that were pushed onto the stack. The 16-bit real mode entry - point must exit with a RETF instruction. The register state is captured into RealModeState immediately + so when accessing stack contents, the 16-bit real mode code must account for the 16-bit segment + and 16-bit offset of the return address that were pushed onto the stack. The 16-bit real mode entry + point must exit with a RETF instruction. The register state is captured into RealModeState immediately after the RETF instruction is executed. - - If EFLAGS specifies interrupts enabled, or any of the 16-bit real mode code enables interrupts, - or any of the 16-bit real mode code makes a SW interrupt, then the caller is responsible for making sure - the IDT at address 0 is initialized to handle any HW or SW interrupts that may occur while in 16-bit real mode. - - If EFLAGS specifies interrupts enabled, or any of the 16-bit real mode code enables interrupts, - then the caller is responsible for making sure the 8259 PIC is in a state compatible with 16-bit real mode. + + If EFLAGS specifies interrupts enabled, or any of the 16-bit real mode code enables interrupts, + or any of the 16-bit real mode code makes a SW interrupt, then the caller is responsible for making sure + the IDT at address 0 is initialized to handle any HW or SW interrupts that may occur while in 16-bit real mode. + + If EFLAGS specifies interrupts enabled, or any of the 16-bit real mode code enables interrupts, + then the caller is responsible for making sure the 8259 PIC is in a state compatible with 16-bit real mode. This includes the base vectors, the interrupt masks, and the edge/level trigger mode. - - If THUNK_ATTRIBUTE_BIG_REAL_MODE is set in the ThunkAttributes field of ThunkContext, then the user code + + If THUNK_ATTRIBUTE_BIG_REAL_MODE is set in the ThunkAttributes field of ThunkContext, then the user code is invoked in big real mode. Otherwise, the user code is invoked in 16-bit real mode with 64KB segment limits. - - If neither THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 nor THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL are set in - ThunkAttributes, then it is assumed that the user code did not enable the A20 mask, and no attempt is made to + + If neither THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 nor THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL are set in + ThunkAttributes, then it is assumed that the user code did not enable the A20 mask, and no attempt is made to disable the A20 mask. - - If THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 is set and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL is clear in - ThunkAttributes, then attempt to use the INT 15 service to disable the A20 mask. If this INT 15 call fails, + + If THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 is set and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL is clear in + ThunkAttributes, then attempt to use the INT 15 service to disable the A20 mask. If this INT 15 call fails, then attempt to disable the A20 mask by directly accessing the 8042 keyboard controller I/O ports. - - If THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 is clear and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL is set in + + If THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 is clear and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL is set in ThunkAttributes, then attempt to disable the A20 mask by directly accessing the 8042 keyboard controller I/O ports. - + If ThunkContext is NULL, then ASSERT(). If AsmPrepareThunk16() was not previously called with ThunkContext, then ASSERT(). - If both THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL are set in + If both THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL are set in ThunkAttributes, then ASSERT(). This interface is limited to be used in either physical mode or virtual modes with paging enabled where the diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/BaseMemoryLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/BaseMemoryLib.h index 31a403c56a..1a2eff14d1 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/BaseMemoryLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/BaseMemoryLib.h @@ -1,13 +1,13 @@ /** @file Provides copy memory, fill memory, zero memory, and GUID functions. - - The Base Memory Library provides optimized implementations for common memory-based operations. - These functions should be used in place of coding your own loops to do equivalent common functions. - This allows optimized library implementations to help increase performance. + + The Base Memory Library provides optimized implementations for common memory-based operations. + These functions should be used in place of coding your own loops to do equivalent common functions. + This allows optimized library implementations to help increase performance. Copyright (c) 2006 - 2016, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php. @@ -25,7 +25,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. This function copies Length bytes from SourceBuffer to DestinationBuffer, and returns DestinationBuffer. The implementation must be reentrant, and it must handle the case where SourceBuffer overlaps DestinationBuffer. - + If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - SourceBuffer + 1), then ASSERT(). @@ -48,7 +48,7 @@ CopyMem ( Fills a target buffer with a byte value, and returns the target buffer. This function fills Length bytes of Buffer with Value, and returns Buffer. - + If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). @param Buffer The memory to set. @@ -178,7 +178,7 @@ SetMemN ( Fills a target buffer with zeros, and returns the target buffer. This function fills Length bytes of Buffer with zeros, and returns Buffer. - + If Length > 0 and Buffer is NULL, then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). @@ -202,7 +202,7 @@ ZeroMem ( If all Length bytes of the two buffers are identical, then 0 is returned. Otherwise, the value returned is the first mismatched byte in SourceBuffer subtracted from the first mismatched byte in DestinationBuffer. - + If Length > 0 and DestinationBuffer is NULL, then ASSERT(). If Length > 0 and SourceBuffer is NULL, then ASSERT(). If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT(). @@ -215,7 +215,7 @@ ZeroMem ( @return 0 All Length bytes of the two buffers are identical. @retval Non-zero The first mismatched byte in SourceBuffer subtracted from the first mismatched byte in DestinationBuffer. - + **/ INTN EFIAPI @@ -233,7 +233,7 @@ CompareMem ( address to the highest address for an 8-bit value that matches Value. If a match is found, then a pointer to the matching byte in the target buffer is returned. If no match is found, then NULL is returned. If Length is 0, then NULL is returned. - + If Length > 0 and Buffer is NULL, then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). @@ -260,7 +260,7 @@ ScanMem8 ( address to the highest address for a 16-bit value that matches Value. If a match is found, then a pointer to the matching byte in the target buffer is returned. If no match is found, then NULL is returned. If Length is 0, then NULL is returned. - + If Length > 0 and Buffer is NULL, then ASSERT(). If Buffer is not aligned on a 16-bit boundary, then ASSERT(). If Length is not aligned on a 16-bit boundary, then ASSERT(). @@ -289,7 +289,7 @@ ScanMem16 ( address to the highest address for a 32-bit value that matches Value. If a match is found, then a pointer to the matching byte in the target buffer is returned. If no match is found, then NULL is returned. If Length is 0, then NULL is returned. - + If Length > 0 and Buffer is NULL, then ASSERT(). If Buffer is not aligned on a 32-bit boundary, then ASSERT(). If Length is not aligned on a 32-bit boundary, then ASSERT(). @@ -318,7 +318,7 @@ ScanMem32 ( address to the highest address for a 64-bit value that matches Value. If a match is found, then a pointer to the matching byte in the target buffer is returned. If no match is found, then NULL is returned. If Length is 0, then NULL is returned. - + If Length > 0 and Buffer is NULL, then ASSERT(). If Buffer is not aligned on a 64-bit boundary, then ASSERT(). If Length is not aligned on a 64-bit boundary, then ASSERT(). @@ -340,14 +340,14 @@ ScanMem64 ( ); /** - Scans a target buffer for a UINTN sized value, and returns a pointer to the matching + Scans a target buffer for a UINTN sized value, and returns a pointer to the matching UINTN sized value in the target buffer. This function searches target the buffer specified by Buffer and Length from the lowest address to the highest address for a UINTN sized value that matches Value. If a match is found, then a pointer to the matching byte in the target buffer is returned. If no match is found, then NULL is returned. If Length is 0, then NULL is returned. - + If Length > 0 and Buffer is NULL, then ASSERT(). If Buffer is not aligned on a UINTN boundary, then ASSERT(). If Length is not aligned on a UINTN boundary, then ASSERT(). @@ -367,13 +367,13 @@ ScanMemN ( IN UINTN Length, IN UINTN Value ); - + /** Copies a source GUID to a destination GUID. This function copies the contents of the 128-bit GUID specified by SourceGuid to DestinationGuid, and returns DestinationGuid. - + If DestinationGuid is NULL, then ASSERT(). If SourceGuid is NULL, then ASSERT(). @@ -395,7 +395,7 @@ CopyGuid ( This function compares Guid1 to Guid2. If the GUIDs are identical then TRUE is returned. If there are any bit differences in the two GUIDs, then FALSE is returned. - + If Guid1 is NULL, then ASSERT(). If Guid2 is NULL, then ASSERT(). @@ -422,7 +422,7 @@ CompareGuid ( GUID value that matches Guid. If a match is found, then a pointer to the matching GUID in the target buffer is returned. If no match is found, then NULL is returned. If Length is 0, then NULL is returned. - + If Length > 0 and Buffer is NULL, then ASSERT(). If Buffer is not aligned on a 32-bit boundary, then ASSERT(). If Length is not aligned on a 128-bit boundary, then ASSERT(). diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/CacheMaintenanceLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/CacheMaintenanceLib.h index b2c6258a32..87f3fa74fc 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/CacheMaintenanceLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/CacheMaintenanceLib.h @@ -1,9 +1,9 @@ /** @file Provides services to maintain instruction and data caches. - + The Cache Maintenance Library provides abstractions for basic processor cache operations. It removes the need to use assembly in C code. - + Copyright (c) 2006 - 2008, 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 diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/CpuLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/CpuLib.h index 662e4d9ce6..9809b4893a 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/CpuLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/CpuLib.h @@ -1,7 +1,7 @@ /** @file Provides CPU architecture specific functions that can not be defined in the Base Library due to dependencies on the PAL Library - + The CPU Library provides services to flush CPU TLBs and place the CPU in a sleep state. The implementation of these services on Itanium processors requires the use of PAL Calls. PAL Calls require PEI and DXE specific mechanisms to look up PAL Entry Point. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DebugLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DebugLib.h index a26b635a22..2bfba052f6 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DebugLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DebugLib.h @@ -1,6 +1,6 @@ /** @file Provides services to print debug and assert messages to a debug output device. - + The Debug library supports debug print and asserts based on a combination of macros and code. The debug library can be turned on and off so that the debug code does not increase the size of an image. @@ -9,8 +9,8 @@ defined, then debug and assert related macros wrapped by it are the NULL implementations. Copyright (c) 2006 - 2016, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php. @@ -80,15 +80,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** Prints a debug message to the debug output device if the specified error level is enabled. - If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function - GetDebugPrintErrorLevel (), then print the message specified by Format and the + If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function + GetDebugPrintErrorLevel (), then print the message specified by Format and the associated variable argument list to the debug output device. If Format is NULL, then ASSERT(). @param ErrorLevel The error level of the debug message. @param Format The format string for the debug message to print. - @param ... The variable argument list whose contents are accessed + @param ... The variable argument list whose contents are accessed based on the format string specified by Format. **/ @@ -102,14 +102,14 @@ DebugPrint ( /** - Prints an assert message containing a filename, line number, and description. + Prints an assert message containing a filename, line number, and description. This may be followed by a breakpoint or a dead loop. Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n" - to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of - PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if - DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then - CpuDeadLoop() is called. If neither of these bits are set, then this function + to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of + PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if + DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then + CpuDeadLoop() is called. If neither of these bits are set, then this function returns immediately after the message is printed to the debug output device. DebugAssert() must actively prevent recursion. If DebugAssert() is called while processing another DebugAssert(), then DebugAssert() must return immediately. @@ -134,14 +134,14 @@ DebugAssert ( /** Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer. - This function fills Length bytes of Buffer with the value specified by + This function fills Length bytes of Buffer with the value specified by PcdDebugClearMemoryValue, and returns Buffer. If Buffer is NULL, then ASSERT(). - If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). + If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). @param Buffer The pointer to the target buffer to be filled with PcdDebugClearMemoryValue. - @param Length The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. + @param Length The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. @return Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue. @@ -157,7 +157,7 @@ DebugClearMemory ( /** Returns TRUE if ASSERT() macros are enabled. - This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of + This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set. Otherwise, FALSE is returned. @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set. @@ -171,10 +171,10 @@ DebugAssertEnabled ( ); -/** +/** Returns TRUE if DEBUG() macros are enabled. - This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of + This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set. Otherwise, FALSE is returned. @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set. @@ -188,10 +188,10 @@ DebugPrintEnabled ( ); -/** +/** Returns TRUE if DEBUG_CODE() macros are enabled. - This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of + This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set. Otherwise, FALSE is returned. @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set. @@ -205,10 +205,10 @@ DebugCodeEnabled ( ); -/** +/** Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled. - This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of + This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set. Otherwise, FALSE is returned. @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set. @@ -236,7 +236,7 @@ DebugPrintLevelEnabled ( IN CONST UINTN ErrorLevel ); -/** +/** Internal worker macro that calls DebugAssert(). This macro calls DebugAssert(), passing in the filename, line number, and an @@ -248,15 +248,15 @@ DebugPrintLevelEnabled ( #define _ASSERT(Expression) DebugAssert (__FILE__, __LINE__, #Expression) -/** +/** Internal worker macro that calls DebugPrint(). - This macro calls DebugPrint() passing in the debug error level, a format + This macro calls DebugPrint() passing in the debug error level, a format string, and a variable argument list. __VA_ARGS__ is not supported by EBC compiler, Microsoft Visual Studio .NET 2003 and Microsoft Windows Server 2003 Driver Development Kit (Microsoft WINDDK) version 3790.1830. - @param Expression Expression containing an error level, a format string, + @param Expression Expression containing an error level, a format string, and a variable argument list based on the format string. **/ @@ -273,19 +273,19 @@ DebugPrintLevelEnabled ( #define _DEBUG(Expression) DebugPrint Expression #endif -/** +/** Macro that calls DebugAssert() if an expression evaluates to FALSE. - If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED - bit of PcdDebugProperyMask is set, then this macro evaluates the Boolean - expression specified by Expression. If Expression evaluates to FALSE, then - DebugAssert() is called passing in the source filename, source line number, + If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED + bit of PcdDebugProperyMask is set, then this macro evaluates the Boolean + expression specified by Expression. If Expression evaluates to FALSE, then + DebugAssert() is called passing in the source filename, source line number, and Expression. @param Expression Boolean expression. **/ -#if !defined(MDEPKG_NDEBUG) +#if !defined(MDEPKG_NDEBUG) #define ASSERT(Expression) \ do { \ if (DebugAssertEnabled ()) { \ @@ -299,19 +299,19 @@ DebugPrintLevelEnabled ( #define ASSERT(Expression) #endif -/** +/** Macro that calls DebugPrint(). - If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED - bit of PcdDebugProperyMask is set, then this macro passes Expression to + If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED + bit of PcdDebugProperyMask is set, then this macro passes Expression to DebugPrint(). - @param Expression Expression containing an error level, a format string, + @param Expression Expression containing an error level, a format string, and a variable argument list based on the format string. - + **/ -#if !defined(MDEPKG_NDEBUG) +#if !defined(MDEPKG_NDEBUG) #define DEBUG(Expression) \ do { \ if (DebugPrintEnabled ()) { \ @@ -322,13 +322,13 @@ DebugPrintLevelEnabled ( #define DEBUG(Expression) #endif -/** +/** Macro that calls DebugAssert() if an EFI_STATUS evaluates to an error code. - If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED - bit of PcdDebugProperyMask is set, then this macro evaluates the EFI_STATUS - value specified by StatusParameter. If StatusParameter is an error code, - then DebugAssert() is called passing in the source filename, source line + If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED + bit of PcdDebugProperyMask is set, then this macro evaluates the EFI_STATUS + value specified by StatusParameter. If StatusParameter is an error code, + then DebugAssert() is called passing in the source filename, source line number, and StatusParameter. @param StatusParameter EFI_STATUS value to evaluate. @@ -375,23 +375,23 @@ DebugPrintLevelEnabled ( #define ASSERT_RETURN_ERROR(StatusParameter) #endif -/** - Macro that calls DebugAssert() if a protocol is already installed in the +/** + Macro that calls DebugAssert() if a protocol is already installed in the handle database. - If MDEPKG_NDEBUG is defined or the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit + If MDEPKG_NDEBUG is defined or the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear, then return. - If Handle is NULL, then a check is made to see if the protocol specified by Guid - is present on any handle in the handle database. If Handle is not NULL, then - a check is made to see if the protocol specified by Guid is present on the - handle specified by Handle. If the check finds the protocol, then DebugAssert() + If Handle is NULL, then a check is made to see if the protocol specified by Guid + is present on any handle in the handle database. If Handle is not NULL, then + a check is made to see if the protocol specified by Guid is present on the + handle specified by Handle. If the check finds the protocol, then DebugAssert() is called passing in the source filename, source line number, and Guid. If Guid is NULL, then ASSERT(). - @param Handle The handle to check for the protocol. This is an optional - parameter that may be NULL. If it is NULL, then the entire + @param Handle The handle to check for the protocol. This is an optional + parameter that may be NULL. If it is NULL, then the entire handle database is searched. @param Guid The pointer to a protocol GUID. @@ -421,32 +421,32 @@ DebugPrintLevelEnabled ( /** Macro that marks the beginning of debug source code. - If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, + If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, then this macro marks the beginning of source code that is included in a module. - Otherwise, the source lines between DEBUG_CODE_BEGIN() and DEBUG_CODE_END() + Otherwise, the source lines between DEBUG_CODE_BEGIN() and DEBUG_CODE_END() are not included in a module. **/ #define DEBUG_CODE_BEGIN() do { if (DebugCodeEnabled ()) { UINT8 __DebugCodeLocal -/** +/** The macro that marks the end of debug source code. - If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, - then this macro marks the end of source code that is included in a module. - Otherwise, the source lines between DEBUG_CODE_BEGIN() and DEBUG_CODE_END() + If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, + then this macro marks the end of source code that is included in a module. + Otherwise, the source lines between DEBUG_CODE_BEGIN() and DEBUG_CODE_END() are not included in a module. **/ #define DEBUG_CODE_END() __DebugCodeLocal = 0; __DebugCodeLocal++; } } while (FALSE) -/** +/** The macro that declares a section of debug source code. - If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, - then the source code specified by Expression is included in a module. + If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, + then the source code specified by Expression is included in a module. Otherwise, the source specified by Expression is not included in a module. **/ @@ -456,10 +456,10 @@ DebugPrintLevelEnabled ( DEBUG_CODE_END () -/** +/** The macro that calls DebugClearMemory() to clear a buffer to a default value. - If the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set, + If the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set, then this macro calls DebugClearMemory() passing in Address and Length. @param Address The pointer to a buffer. @@ -475,42 +475,42 @@ DebugPrintLevelEnabled ( /** - Macro that calls DebugAssert() if the containing record does not have a - matching signature. If the signatures matches, then a pointer to the data - structure that contains a specified field of that data structure is returned. - This is a lightweight method hide information by placing a public data - structure inside a larger private data structure and using a pointer to the + Macro that calls DebugAssert() if the containing record does not have a + matching signature. If the signatures matches, then a pointer to the data + structure that contains a specified field of that data structure is returned. + This is a lightweight method hide information by placing a public data + structure inside a larger private data structure and using a pointer to the public data structure to retrieve a pointer to the private data structure. - If MDEPKG_NDEBUG is defined or the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit + If MDEPKG_NDEBUG is defined or the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear, then this macro computes the offset, in bytes, - of the field specified by Field from the beginning of the data structure specified - by TYPE. This offset is subtracted from Record, and is used to return a pointer + of the field specified by Field from the beginning of the data structure specified + by TYPE. This offset is subtracted from Record, and is used to return a pointer to a data structure of the type specified by TYPE. If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit - of PcdDebugProperyMask is set, then this macro computes the offset, in bytes, - of field specified by Field from the beginning of the data structure specified + of PcdDebugProperyMask is set, then this macro computes the offset, in bytes, + of field specified by Field from the beginning of the data structure specified by TYPE. This offset is subtracted from Record, and is used to compute a pointer - to a data structure of the type specified by TYPE. The Signature field of the - data structure specified by TYPE is compared to TestSignature. If the signatures - match, then a pointer to the pointer to a data structure of the type specified by - TYPE is returned. If the signatures do not match, then DebugAssert() is called - with a description of "CR has a bad signature" and Record is returned. + to a data structure of the type specified by TYPE. The Signature field of the + data structure specified by TYPE is compared to TestSignature. If the signatures + match, then a pointer to the pointer to a data structure of the type specified by + TYPE is returned. If the signatures do not match, then DebugAssert() is called + with a description of "CR has a bad signature" and Record is returned. - If the data type specified by TYPE does not contain the field specified by Field, + If the data type specified by TYPE does not contain the field specified by Field, then the module will not compile. - If TYPE does not contain a field called Signature, then the module will not + If TYPE does not contain a field called Signature, then the module will not compile. - @param Record The pointer to the field specified by Field within a data + @param Record The pointer to the field specified by Field within a data structure of type TYPE. - @param TYPE The name of the data structure type to return This - data structure must contain the field specified by Field. + @param TYPE The name of the data structure type to return This + data structure must contain the field specified by Field. - @param Field The name of the field in the data structure specified + @param Field The name of the field in the data structure specified by TYPE to which Record points. @param TestSignature The 32-bit signature value to match. @@ -525,5 +525,5 @@ DebugPrintLevelEnabled ( #define CR(Record, TYPE, Field, TestSignature) \ BASE_CR (Record, TYPE, Field) #endif - + #endif diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DebugPrintErrorLevelLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DebugPrintErrorLevelLib.h index 496f07b54d..784eb08f10 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DebugPrintErrorLevelLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DebugPrintErrorLevelLib.h @@ -28,9 +28,9 @@ GetDebugPrintErrorLevel ( /** Sets the global debug print error level mask fpr the entire platform. - + @param ErrorLevel Global debug print error level - + @retval TRUE The debug print error level mask was successfully set. @retval FALSE The debug print error level mask could not be set. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DevicePathLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DevicePathLib.h index 61fa19ce69..a5edf13e80 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DevicePathLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DevicePathLib.h @@ -1,12 +1,12 @@ /** @file Provides library functions to construct and parse UEFI Device Paths. - This library provides defines, macros, and functions to help create and parse + This library provides defines, macros, and functions to help create and parse EFI_DEVICE_PATH_PROTOCOL structures. Copyright (c) 2006 - 2013, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php. @@ -81,9 +81,9 @@ DevicePathSubType ( /** Returns the 16-bit Length field of a device path node. - Returns the 16-bit Length field of the device path node specified by Node. + Returns the 16-bit Length field of the device path node specified by Node. Node is not required to be aligned on a 16-bit boundary, so it is recommended - that a function such as ReadUnaligned16() be used to extract the contents of + that a function such as ReadUnaligned16() be used to extract the contents of the Length field. If Node is NULL, then ASSERT(). @@ -119,12 +119,12 @@ NextDevicePathNode ( /** Determines if a device path node is an end node of a device path. - This includes nodes that are the end of a device path instance and nodes that + This includes nodes that are the end of a device path instance and nodes that are the end of an entire device path. - Determines if the device path node specified by Node is an end node of a device path. - This includes nodes that are the end of a device path instance and nodes that are the - end of an entire device path. If Node represents an end node of a device path, + Determines if the device path node specified by Node is an end node of a device path. + This includes nodes that are the end of a device path instance and nodes that are the + end of an entire device path. If Node represents an end node of a device path, then TRUE is returned. Otherwise, FALSE is returned. If Node is NULL, then ASSERT(). @@ -133,7 +133,7 @@ NextDevicePathNode ( @retval TRUE The device path node specified by Node is an end node of a device path. @retval FALSE The device path node specified by Node is not an end node of a device path. - + **/ BOOLEAN EFIAPI @@ -186,8 +186,8 @@ IsDevicePathEndInstance ( /** Sets the length, in bytes, of a device path node. - Sets the length of the device path node specified by Node to the value specified - by NodeLength. NodeLength is returned. Node is not required to be aligned on + Sets the length of the device path node specified by Node to the value specified + by NodeLength. NodeLength is returned. Node is not required to be aligned on a 16-bit boundary, so it is recommended that a function such as WriteUnaligned16() be used to set the contents of the Length field. @@ -211,15 +211,15 @@ SetDevicePathNodeLength ( /** Fills in all the fields of a device path node that is the end of an entire device path. - Fills in all the fields of a device path node specified by Node so Node represents - the end of an entire device path. The Type field of Node is set to - END_DEVICE_PATH_TYPE, the SubType field of Node is set to - END_ENTIRE_DEVICE_PATH_SUBTYPE, and the Length field of Node is set to - END_DEVICE_PATH_LENGTH. Node is not required to be aligned on a 16-bit boundary, - so it is recommended that a function such as WriteUnaligned16() be used to set - the contents of the Length field. + Fills in all the fields of a device path node specified by Node so Node represents + the end of an entire device path. The Type field of Node is set to + END_DEVICE_PATH_TYPE, the SubType field of Node is set to + END_ENTIRE_DEVICE_PATH_SUBTYPE, and the Length field of Node is set to + END_DEVICE_PATH_LENGTH. Node is not required to be aligned on a 16-bit boundary, + so it is recommended that a function such as WriteUnaligned16() be used to set + the contents of the Length field. - If Node is NULL, then ASSERT(). + If Node is NULL, then ASSERT(). @param Node A pointer to a device path node data structure. @@ -233,7 +233,7 @@ SetDevicePathEndNode ( /** Returns the size of a device path in bytes. - This function returns the size, in bytes, of the device path data structure + This function returns the size, in bytes, of the device path data structure specified by DevicePath including the end of device path node. If DevicePath is NULL or invalid, then 0 is returned. @@ -255,15 +255,15 @@ GetDevicePathSize ( This function allocates space for a new copy of the device path specified by DevicePath. If DevicePath is NULL, then NULL is returned. If the memory is successfully allocated, then the contents of DevicePath are copied to the newly allocated buffer, and a pointer to that buffer - is returned. Otherwise, NULL is returned. - The memory for the new device path is allocated from EFI boot services memory. - It is the responsibility of the caller to free the memory allocated. - + is returned. Otherwise, NULL is returned. + The memory for the new device path is allocated from EFI boot services memory. + It is the responsibility of the caller to free the memory allocated. + @param DevicePath A pointer to a device path data structure. @retval NULL DevicePath is NULL or invalid. @retval Others A pointer to the duplicated device path. - + **/ EFI_DEVICE_PATH_PROTOCOL * EFIAPI @@ -276,18 +276,18 @@ DuplicateDevicePath ( This function creates a new device path by appending a copy of SecondDevicePath to a copy of FirstDevicePath in a newly allocated buffer. Only the end-of-device-path device node from - SecondDevicePath is retained. The newly created device path is returned. - If FirstDevicePath is NULL, then it is ignored, and a duplicate of SecondDevicePath is returned. - If SecondDevicePath is NULL, then it is ignored, and a duplicate of FirstDevicePath is returned. + SecondDevicePath is retained. The newly created device path is returned. + If FirstDevicePath is NULL, then it is ignored, and a duplicate of SecondDevicePath is returned. + If SecondDevicePath is NULL, then it is ignored, and a duplicate of FirstDevicePath is returned. If both FirstDevicePath and SecondDevicePath are NULL, then a copy of an end-of-device-path is - returned. + returned. If there is not enough memory for the newly allocated buffer, then NULL is returned. The memory for the new device path is allocated from EFI boot services memory. It is the responsibility of the caller to free the memory allocated. @param FirstDevicePath A pointer to a device path data structure. @param SecondDevicePath A pointer to a device path data structure. - + @retval NULL If there is not enough memory for the newly allocated buffer. @retval NULL If FirstDevicePath or SecondDevicePath is invalid. @retval Others A pointer to the new device path if success. @@ -312,7 +312,7 @@ AppendDevicePath ( node is returned. If both DevicePathNode and DevicePath are NULL then a copy of an end-of-device-path device node is returned. - If there is not enough memory to allocate space for the new device path, then NULL is returned. + If there is not enough memory to allocate space for the new device path, then NULL is returned. The memory is allocated from EFI boot services memory. It is the responsibility of the caller to free the memory allocated. @@ -321,7 +321,7 @@ AppendDevicePath ( @retval NULL There is not enough memory for the new device path. @retval Others A pointer to the new device path if success. - A copy of DevicePathNode followed by an end-of-device-path node + A copy of DevicePathNode followed by an end-of-device-path node if both FirstDevicePath and SecondDevicePath are NULL. A copy of an end-of-device-path node if both FirstDevicePath and SecondDevicePath are NULL. @@ -336,18 +336,18 @@ AppendDevicePathNode ( /** Creates a new device path by appending the specified device path instance to the specified device path. - + This function creates a new device path by appending a copy of the device path instance specified by DevicePathInstance to a copy of the device path secified by DevicePath in a allocated buffer. The end-of-device-path device node is moved after the end of the appended device path instance - and a new end-of-device-path-instance node is inserted between. + and a new end-of-device-path-instance node is inserted between. If DevicePath is NULL, then a copy if DevicePathInstance is returned. If DevicePathInstance is NULL, then NULL is returned. If DevicePath or DevicePathInstance is invalid, then NULL is returned. - If there is not enough memory to allocate space for the new device path, then NULL is returned. + If there is not enough memory to allocate space for the new device path, then NULL is returned. The memory is allocated from EFI boot services memory. It is the responsibility of the caller to free the memory allocated. - + @param DevicePath A pointer to a device path data structure. @param DevicePathInstance A pointer to a device path instance. @@ -370,11 +370,11 @@ AppendDevicePathInstance ( to hold the size of the device path instance copy. If DevicePath is NULL, then NULL is returned. If DevicePath points to a invalid device path, then NULL is returned. - If there is not enough memory to allocate space for the new device path, then NULL is returned. + If there is not enough memory to allocate space for the new device path, then NULL is returned. The memory is allocated from EFI boot services memory. It is the responsibility of the caller to free the memory allocated. If Size is NULL, then ASSERT(). - + @param DevicePath On input, this holds the pointer to the current device path instance. On output, this holds the pointer to the next device path instance or NULL if there are no more device path @@ -399,8 +399,8 @@ GetNextDevicePathInstance ( This function creates a new device node in a newly allocated buffer of size NodeLength and initializes the device path node header with NodeType and NodeSubType. The new device path node is returned. - If NodeLength is smaller than a device path header, then NULL is returned. - If there is not enough memory to allocate space for the new device path, then NULL is returned. + If NodeLength is smaller than a device path header, then NULL is returned. + If there is not enough memory to allocate space for the new device path, then NULL is returned. The memory is allocated from EFI boot services memory. It is the responsibility of the caller to free the memory allocated. @@ -443,7 +443,7 @@ IsDevicePathMultiInstance ( This function returns the device path protocol from the handle specified by Handle. If Handle is NULL or Handle does not contain a device path protocol, then NULL is returned. - + @param Handle The handle from which to retrieve the device path protocol. @return The device path protocol from the handle specified by Handle. @@ -465,7 +465,7 @@ DevicePathFromHandle ( path node for the file specified by FileName is allocated and returned. The memory for the new device path is allocated from EFI boot services memory. It is the responsibility of the caller to free the memory allocated. - + If FileName is NULL, then ASSERT(). If FileName is not aligned on a 16-bit boundary, then ASSERT(). diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DxeCoreEntryPoint.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DxeCoreEntryPoint.h index b0de4ee9ff..0d7586e875 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DxeCoreEntryPoint.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DxeCoreEntryPoint.h @@ -16,13 +16,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define __MODULE_ENTRY_POINT_H__ /// -/// Global variable that contains a pointer to the Hob List passed into the DXE Core entry point. -/// +/// Global variable that contains a pointer to the Hob List passed into the DXE Core entry point. +/// extern VOID *gHobList; /** - The entry point of PE/COFF Image for the DXE Core. + The entry point of PE/COFF Image for the DXE Core. This function is the entry point for the DXE Core. This function is required to call ProcessModuleEntryPointList() and ProcessModuleEntryPointList() is never expected to return. @@ -30,7 +30,7 @@ extern VOID *gHobList; System Table and the image handle for the DXE Core itself have been established. If ProcessModuleEntryPointList() returns, then ASSERT() and halt the system. - @param HobStart Pointer to the beginning of the HOB List passed in from the PEI Phase. + @param HobStart Pointer to the beginning of the HOB List passed in from the PEI Phase. **/ VOID @@ -45,7 +45,7 @@ _ModuleEntryPoint ( This function is required to call _ModuleEntryPoint() passing in HobStart. - @param HobStart Pointer to the beginning of the HOB List passed in from the PEI Phase. + @param HobStart Pointer to the beginning of the HOB List passed in from the PEI Phase. **/ VOID @@ -83,12 +83,12 @@ ProcessLibraryConstructorList ( Autogenerated function that calls a set of module entry points. This function must be called by _ModuleEntryPoint(). - This function calls the set of module entry points. + This function calls the set of module entry points. This function is autogenerated by build tools and those build tools are responsible for collecting the module entry points and calling them in a specified order. - @param HobStart Pointer to the beginning of the HOB List passed in from the PEI Phase. - + @param HobStart Pointer to the beginning of the HOB List passed in from the PEI Phase. + **/ VOID EFIAPI diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DxeServicesLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DxeServicesLib.h index 0ec4fe1a3a..f4b7cd4dc8 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DxeServicesLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DxeServicesLib.h @@ -1,16 +1,16 @@ /** @file - MDE DXE Services Library provides functions that simplify the development of DXE Drivers. + MDE DXE Services Library provides functions that simplify the development of DXE Drivers. These functions help access data from sections of FFS files or from file path. Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR> (C) Copyright 2015 Hewlett Packard Enterprise Development LP<BR> -This program and the accompanying materials are licensed and made available under -the terms and conditions of the BSD License that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that 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. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -18,20 +18,20 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define __DXE_SERVICES_LIB_H__ /** - Searches all the available firmware volumes and returns the first matching FFS section. + Searches all the available firmware volumes and returns the first matching FFS section. This function searches all the firmware volumes for FFS files with FV file type specified by FileType - The order that the firmware volumes is searched is not deterministic. For each available FV a search - is made for FFS file of type FileType. If the FV contains more than one FFS file with the same FileType, - the FileInstance instance will be the matched FFS file. For each FFS file found a search - is made for FFS sections of type SectionType. If the FFS file contains at least SectionInstance instances - of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer. - Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size. - It is the caller's responsibility to use FreePool() to free the allocated buffer. - See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for details on how sections + The order that the firmware volumes is searched is not deterministic. For each available FV a search + is made for FFS file of type FileType. If the FV contains more than one FFS file with the same FileType, + the FileInstance instance will be the matched FFS file. For each FFS file found a search + is made for FFS sections of type SectionType. If the FFS file contains at least SectionInstance instances + of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer. + Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size. + It is the caller's responsibility to use FreePool() to free the allocated buffer. + See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for details on how sections are retrieved from an FFS file based on SectionType and SectionInstance. - If SectionType is EFI_SECTION_TE, and the search with an FFS file fails, + If SectionType is EFI_SECTION_TE, and the search with an FFS file fails, the search will be retried with a section type of EFI_SECTION_PE32. This function must be called with a TPL <= TPL_NOTIFY. @@ -41,9 +41,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @param FileType Indicates the FV file type to search for within all available FVs. @param FileInstance Indicates which file instance within all available FVs specified by FileType. FileInstance starts from zero. - @param SectionType Indicates the FFS section type to search for within the FFS file + @param SectionType Indicates the FFS section type to search for within the FFS file specified by FileType with FileInstance. - @param SectionInstance Indicates which section instance within the FFS file + @param SectionInstance Indicates which section instance within the FFS file specified by FileType with FileInstance to retrieve. SectionInstance starts from zero. @param Buffer On output, a pointer to a callee allocated buffer containing the FFS file section that was found. Is it the caller's responsibility to free this buffer using FreePool(). @@ -53,7 +53,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @retval EFI_NOT_FOUND The specified FFS section could not be found. @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section. @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a device error. - @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the firmware volume that + @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the firmware volume that contains the matching FFS section does not allow reads. **/ EFI_STATUS @@ -68,18 +68,18 @@ GetSectionFromAnyFvByFileType ( ); /** - Searches all the available firmware volumes and returns the first matching FFS section. - - This function searches all the firmware volumes for FFS files with an FFS filename specified by NameGuid. - The order in which the firmware volumes are searched is not deterministic. For each FFS file found, a search - is made for FFS sections of type SectionType. If the FFS file contains at least SectionInstance instances - of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer. - Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size. - It is the caller's responsibility to use FreePool() to free the allocated buffer. - See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for details on how sections + Searches all the available firmware volumes and returns the first matching FFS section. + + This function searches all the firmware volumes for FFS files with an FFS filename specified by NameGuid. + The order in which the firmware volumes are searched is not deterministic. For each FFS file found, a search + is made for FFS sections of type SectionType. If the FFS file contains at least SectionInstance instances + of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer. + Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size. + It is the caller's responsibility to use FreePool() to free the allocated buffer. + See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for details on how sections are retrieved from an FFS file based on SectionType and SectionInstance. - If SectionType is EFI_SECTION_TE, and the search with an FFS file fails, + If SectionType is EFI_SECTION_TE, and the search with an FFS file fails, the search will be retried with a section type of EFI_SECTION_PE32. This function must be called with a TPL <= TPL_NOTIFY. @@ -88,26 +88,26 @@ GetSectionFromAnyFvByFileType ( If Size is NULL, then ASSERT(). - @param NameGuid A pointer to to the FFS filename GUID to search for - within any of the firmware volumes in the platform. - @param SectionType Indicates the FFS section type to search for within + @param NameGuid A pointer to to the FFS filename GUID to search for + within any of the firmware volumes in the platform. + @param SectionType Indicates the FFS section type to search for within the FFS file specified by NameGuid. - @param SectionInstance Indicates which section instance within the FFS file + @param SectionInstance Indicates which section instance within the FFS file specified by NameGuid to retrieve. - @param Buffer On output, a pointer to a callee-allocated buffer - containing the FFS file section that was found. - It is the caller's responsibility to free this + @param Buffer On output, a pointer to a callee-allocated buffer + containing the FFS file section that was found. + It is the caller's responsibility to free this buffer using FreePool(). @param Size On output, a pointer to the size, in bytes, of Buffer. @retval EFI_SUCCESS The specified FFS section was returned. @retval EFI_NOT_FOUND The specified FFS section could not be found. - @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve + @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section. - @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a + @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a device error. - @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the - firmware volume that contains the matching FFS + @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the + firmware volume that contains the matching FFS section does not allow reads. **/ EFI_STATUS @@ -121,49 +121,49 @@ GetSectionFromAnyFv ( ); /** - Searches the firmware volume that the currently executing module was loaded from and returns the first matching FFS section. + Searches the firmware volume that the currently executing module was loaded from and returns the first matching FFS section. - This function searches the firmware volume that the currently executing module was loaded - from for an FFS file with an FFS filename specified by NameGuid. If the FFS file is found, a search - is made for FFS sections of type SectionType. If the FFS file contains at least SectionInstance + This function searches the firmware volume that the currently executing module was loaded + from for an FFS file with an FFS filename specified by NameGuid. If the FFS file is found, a search + is made for FFS sections of type SectionType. If the FFS file contains at least SectionInstance instances of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer. - Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size. - It is the caller's responsibility to use FreePool() to free the allocated buffer. - See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for details on how sections are retrieved from + Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size. + It is the caller's responsibility to use FreePool() to free the allocated buffer. + See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for details on how sections are retrieved from an FFS file based on SectionType and SectionInstance. If the currently executing module was not loaded from a firmware volume, then EFI_NOT_FOUND is returned. - If SectionType is EFI_SECTION_TE, and the search with an FFS file fails, + If SectionType is EFI_SECTION_TE, and the search with an FFS file fails, the search will be retried with a section type of EFI_SECTION_PE32. - + This function must be called with a TPL <= TPL_NOTIFY. If NameGuid is NULL, then ASSERT(). If Buffer is NULL, then ASSERT(). If Size is NULL, then ASSERT(). - @param NameGuid A pointer to to the FFS filename GUID to search for - within the firmware volumes that the currently + @param NameGuid A pointer to to the FFS filename GUID to search for + within the firmware volumes that the currently executing module was loaded from. - @param SectionType Indicates the FFS section type to search for within + @param SectionType Indicates the FFS section type to search for within the FFS file specified by NameGuid. - @param SectionInstance Indicates which section instance within the FFS + @param SectionInstance Indicates which section instance within the FFS file specified by NameGuid to retrieve. - @param Buffer On output, a pointer to a callee allocated buffer - containing the FFS file section that was found. - It is the caller's responsibility to free this buffer + @param Buffer On output, a pointer to a callee allocated buffer + containing the FFS file section that was found. + It is the caller's responsibility to free this buffer using FreePool(). @param Size On output, a pointer to the size, in bytes, of Buffer. @retval EFI_SUCCESS The specified FFS section was returned. @retval EFI_NOT_FOUND The specified FFS section could not be found. - @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve + @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section. - @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a + @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a device error. - @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the - firmware volume that contains the matching FFS - section does not allow reads. + @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the + firmware volume that contains the matching FFS + section does not allow reads. **/ EFI_STATUS EFIAPI @@ -180,43 +180,43 @@ GetSectionFromFv ( Searches the FFS file the currently executing module was loaded from and returns the first matching FFS section. This function searches the FFS file that the currently executing module was loaded from for a FFS sections of type SectionType. - If the FFS file contains at least SectionInstance instances of the FFS section specified by SectionType, - then the SectionInstance instance is returned in Buffer. Buffer is allocated using AllocatePool(), - and the size of the allocated buffer is returned in Size. It is the caller's responsibility - to use FreePool() to free the allocated buffer. See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for + If the FFS file contains at least SectionInstance instances of the FFS section specified by SectionType, + then the SectionInstance instance is returned in Buffer. Buffer is allocated using AllocatePool(), + and the size of the allocated buffer is returned in Size. It is the caller's responsibility + to use FreePool() to free the allocated buffer. See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for details on how sections are retrieved from an FFS file based on SectionType and SectionInstance. If the currently executing module was not loaded from an FFS file, then EFI_NOT_FOUND is returned. - If SectionType is EFI_SECTION_TE, and the search with an FFS file fails, + If SectionType is EFI_SECTION_TE, and the search with an FFS file fails, the search will be retried with a section type of EFI_SECTION_PE32. This function must be called with a TPL <= TPL_NOTIFY. - + If Buffer is NULL, then ASSERT(). If Size is NULL, then ASSERT(). - @param SectionType Indicates the FFS section type to search for within - the FFS file that the currently executing module + @param SectionType Indicates the FFS section type to search for within + the FFS file that the currently executing module was loaded from. - @param SectionInstance Indicates which section instance to retrieve within - the FFS file that the currently executing module + @param SectionInstance Indicates which section instance to retrieve within + the FFS file that the currently executing module was loaded from. - @param Buffer On output, a pointer to a callee allocated buffer - containing the FFS file section that was found. - It is the caller's responsibility to free this buffer + @param Buffer On output, a pointer to a callee allocated buffer + containing the FFS file section that was found. + It is the caller's responsibility to free this buffer using FreePool(). @param Size On output, a pointer to the size, in bytes, of Buffer. @retval EFI_SUCCESS The specified FFS section was returned. @retval EFI_NOT_FOUND The specified FFS section could not be found. - @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve + @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section. - @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a + @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a device error. - @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the - firmware volume that contains the matching FFS - section does not allow reads. - + @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the + firmware volume that contains the matching FFS + section does not allow reads. + **/ EFI_STATUS EFIAPI @@ -229,22 +229,22 @@ GetSectionFromFfs ( /** - Get the image file buffer data and buffer size by its device path. - - Access the file either from a firmware volume, from a file system interface, + Get the image file buffer data and buffer size by its device path. + + Access the file either from a firmware volume, from a file system interface, or from the load file interface. - + Allocate memory to store the found image. The caller is responsible to free memory. If FilePath is NULL, then NULL is returned. If FileSize is NULL, then NULL is returned. If AuthenticationStatus is NULL, then NULL is returned. - @param[in] BootPolicy The policy for Open Image File.If TRUE, - indicates that the request originates from + @param[in] BootPolicy The policy for Open Image File.If TRUE, + indicates that the request originates from the boot manager, and that the boot manager is - attempting to load FilePath as a boot selection. - If FALSE, then FilePath must match an exact + attempting to load FilePath as a boot selection. + If FALSE, then FilePath must match an exact file to be loaded. @param[in] FilePath Pointer to the device path of the file that is abstracted to the file buffer. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DxeServicesTableLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DxeServicesTableLib.h index 0038715530..7fe43b5216 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DxeServicesTableLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/DxeServicesTableLib.h @@ -1,16 +1,16 @@ /** @file Provides a service to retrieve a pointer to the DXE Services Table. Only available to DXE module types. - - This library does not contain any functions or macros. It simply exports a global - pointer to the DXE Services Table as defined in the Platform Initialization Driver - Execution Environment Core Interface Specification. The library constructor must + + This library does not contain any functions or macros. It simply exports a global + pointer to the DXE Services Table as defined in the Platform Initialization Driver + Execution Environment Core Interface Specification. The library constructor must initialize this global pointer to the DX Services Table, so it is available at the - module's entry point. Since there is overhead in looking up the pointer to the DXE - Services Table, only those modules that actually require access to the DXE Services - Table should use this library. This will typically be DXE Drivers that require GCD + module's entry point. Since there is overhead in looking up the pointer to the DXE + Services Table, only those modules that actually require access to the DXE Services + Table should use this library. This will typically be DXE Drivers that require GCD or Dispatcher services. - + Copyright (c) 2006 - 2008, 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 diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/ExtendedSalLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/ExtendedSalLib.h index 710675ff8e..deca57ac2e 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/ExtendedSalLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/ExtendedSalLib.h @@ -19,7 +19,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** Register ESAL Class and its associated global. - + This function Registers one or more Extended SAL services in a given class along with the associated global context. This function is only available prior to ExitBootServices(). @@ -32,7 +32,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @retval EFI_SUCCESS The Extended SAL services were registered. @retval EFI_UNSUPPORTED This function was called after ExitBootServices(). @retval EFI_OUT_OF_RESOURCES There are not enough resources available to register one or more of the specified services. - @retval Other ClassGuid could not be installed onto a new handle. + @retval Other ClassGuid could not be installed onto a new handle. **/ EFI_STATUS @@ -46,7 +46,7 @@ RegisterEsalClass ( /** Calls an Extended SAL Class service that was previously registered with RegisterEsalClass(). - + This function calls an Extended SAL Class service that was previously registered with RegisterEsalClass(). @param ClassGuidLo GUID of function, lower 64-bits @@ -59,11 +59,11 @@ RegisterEsalClass ( @param Arg6 Argument 6 ClassGuid/FunctionId defined @param Arg7 Argument 7 ClassGuid/FunctionId defined @param Arg8 Argument 8 ClassGuid/FunctionId defined - + @retval EFI_SAL_ERROR The address of ExtendedSalProc() can not be determined for the current CPU execution mode. @retval Other See the return status from ExtendedSalProc() in the - EXTENDED_SAL_BOOT_SERVICE_PROTOCOL. + EXTENDED_SAL_BOOT_SERVICE_PROTOCOL. **/ SAL_RETURN_REGS @@ -83,7 +83,7 @@ EsalCall ( /** Wrapper for the EsalStallFunctionId service of Extended SAL Stall Services Class. - + This function is a wrapper for the EsalStallFunctionId service of Extended SAL Stall Services Class. See EsalStallFunctionId of Extended SAL Specification. @@ -102,7 +102,7 @@ EsalStall ( /** Wrapper for the EsalSetNewPalEntryFunctionId service of Extended SAL PAL Services Services Class. - + This function is a wrapper for the EsalSetNewPalEntryFunctionId service of Extended SAL PAL Services Services Class. See EsalSetNewPalEntryFunctionId of Extended SAL Specification. @@ -125,7 +125,7 @@ EsalSetNewPalEntry ( /** Wrapper for the EsalGetNewPalEntryFunctionId service of Extended SAL PAL Services Services Class. - + This function is a wrapper for the EsalGetNewPalEntryFunctionId service of Extended SAL PAL Services Services Class. See EsalGetNewPalEntryFunctionId of Extended SAL Specification. @@ -148,7 +148,7 @@ EsalGetNewPalEntry ( /** Wrapper for the EsalGetStateBufferFunctionId service of Extended SAL MCA Log Services Class. - + This function is a wrapper for the EsalGetStateBufferFunctionId service of Extended SAL MCA Log Services Class. See EsalGetStateBufferFunctionId of Extended SAL Specification. @@ -174,7 +174,7 @@ EsalGetStateBuffer ( /** Wrapper for the EsalSaveStateBufferFunctionId service of Extended SAL MCA Log Services Class. - + This function is a wrapper for the EsalSaveStateBufferFunctionId service of Extended SAL MCA Log Services Class. See EsalSaveStateBufferFunctionId of Extended SAL Specification. @@ -191,7 +191,7 @@ EsalSaveStateBuffer ( /** Wrapper for the EsalGetVectorsFunctionId service of Extended SAL Base Services Class. - + This function is a wrapper for the EsalGetVectorsFunctionId service of Extended SAL Base Services Class. See EsalGetVectorsFunctionId of Extended SAL Specification. @@ -212,7 +212,7 @@ EsalGetVectors ( /** Wrapper for the EsalMcGetParamsFunctionId service of Extended SAL Base Services Class. - + This function is a wrapper for the EsalMcGetParamsFunctionId service of Extended SAL Base Services Class. See EsalMcGetParamsFunctionId of Extended SAL Specification. @@ -235,7 +235,7 @@ EsalMcGetParams ( /** Wrapper for the EsalMcGetParamsFunctionId service of Extended SAL Base Services Class. - + This function is a wrapper for the EsalMcGetParamsFunctionId service of Extended SAL Base Services Class. See EsalMcGetParamsFunctionId of Extended SAL Specification. @@ -252,7 +252,7 @@ EsalMcGetMcParams ( /** Wrapper for the EsalGetMcCheckinFlagsFunctionId service of Extended SAL Base Services Class. - + This function is a wrapper for the EsalGetMcCheckinFlagsFunctionId service of Extended SAL Base Services Class. See EsalGetMcCheckinFlagsFunctionId of Extended SAL Specification. @@ -269,7 +269,7 @@ EsalGetMcCheckinFlags ( /** Wrapper for the EsalAddCpuDataFunctionId service of Extended SAL MP Services Class. - + This function is a wrapper for the EsalAddCpuDataFunctionId service of Extended SAL MP Services Class. See EsalAddCpuDataFunctionId of Extended SAL Specification. @@ -293,7 +293,7 @@ EsalAddCpuData ( /** Wrapper for the EsalRemoveCpuDataFunctionId service of Extended SAL MP Services Class. - + This function is a wrapper for the EsalRemoveCpuDataFunctionId service of Extended SAL MP Services Class. See EsalRemoveCpuDataFunctionId of Extended SAL Specification. @@ -311,7 +311,7 @@ EsalRemoveCpuData ( /** Wrapper for the EsalModifyCpuDataFunctionId service of Extended SAL MP Services Class. - + This function is a wrapper for the EsalModifyCpuDataFunctionId service of Extended SAL MP Services Class. See EsalModifyCpuDataFunctionId of Extended SAL Specification. @@ -335,7 +335,7 @@ EsalModifyCpuData ( /** Wrapper for the EsalGetCpuDataByIdFunctionId service of Extended SAL MP Services Class. - + This function is a wrapper for the EsalGetCpuDataByIdFunctionId service of Extended SAL MP Services Class. See EsalGetCpuDataByIdFunctionId of Extended SAL Specification. @@ -356,7 +356,7 @@ EsalGetCpuDataById ( /** Wrapper for the EsalGetCpuDataByIndexFunctionId service of Extended SAL MP Services Class. - + This function is a wrapper for the EsalGetCpuDataByIndexFunctionId service of Extended SAL MP Services Class. See EsalGetCpuDataByIndexFunctionId of Extended SAL Specification. @@ -377,7 +377,7 @@ EsalGetCpuDataByIndex ( /** Wrapper for the EsalWhoAmIFunctionId service of Extended SAL MP Services Class. - + This function is a wrapper for the EsalWhoAmIFunctionId service of Extended SAL MP Services Class. See EsalWhoAmIFunctionId of Extended SAL Specification. @@ -396,7 +396,7 @@ EsalWhoAmI ( /** Wrapper for the EsalNumProcessors service of Extended SAL MP Services Class. - + This function is a wrapper for the EsalNumProcessors service of Extended SAL MP Services Class. See EsalNumProcessors of Extended SAL Specification. @@ -412,7 +412,7 @@ EsalNumProcessors ( /** Wrapper for the EsalSetMinStateFnctionId service of Extended SAL MP Services Class. - + This function is a wrapper for the EsalSetMinStateFnctionId service of Extended SAL MP Services Class. See EsalSetMinStateFnctionId of Extended SAL Specification. @@ -433,7 +433,7 @@ EsalSetMinState ( /** Wrapper for the EsalGetMinStateFunctionId service of Extended SAL MP Services Class. - + This function is a wrapper for the EsalGetMinStateFunctionId service of Extended SAL MP Services Class. See EsalGetMinStateFunctionId of Extended SAL Specification. @@ -451,7 +451,7 @@ EsalGetMinState ( /** Wrapper for the EsalMcsGetStateInfoFunctionId service of Extended SAL MCA Services Class. - + This function is a wrapper for the EsalMcsGetStateInfoFunctionId service of Extended SAL MCA Services Class. See EsalMcsGetStateInfoFunctionId of Extended SAL Specification. @@ -473,7 +473,7 @@ EsalMcaGetStateInfo ( /** Wrapper for the EsalMcaRegisterCpuFunctionId service of Extended SAL MCA Services Class. - + This function is a wrapper for the EsalMcaRegisterCpuFunctionId service of Extended SAL MCA Services Class. See EsalMcaRegisterCpuFunctionId of Extended SAL Specification. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/ExtractGuidedSectionLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/ExtractGuidedSectionLib.h index ac35a33bcb..e09e0b65f8 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/ExtractGuidedSectionLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/ExtractGuidedSectionLib.h @@ -1,13 +1,13 @@ /** @file - This library provides common functions to process the different guided section data. - - This library provides functions to process GUIDed sections of FFS files. Handlers may - be registered to decode GUIDed sections of FFS files. Services are provided to determine - the set of supported section GUIDs, collection information about a specific GUIDed section, - and decode a specific GUIDed section. - - A library instance that produces this library class may be used to produce a - EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI or a EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL + This library provides common functions to process the different guided section data. + + This library provides functions to process GUIDed sections of FFS files. Handlers may + be registered to decode GUIDed sections of FFS files. Services are provided to determine + the set of supported section GUIDs, collection information about a specific GUIDed section, + and decode a specific GUIDed section. + + A library instance that produces this library class may be used to produce a + EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI or a EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL providing a simple method to extend the number of GUIDed sections types a platform supports. Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR> @@ -27,16 +27,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. Examines a GUIDed section and returns the size of the decoded buffer and the size of an optional scratch buffer required to actually decode the data in a GUIDed section. - Examines a GUIDed section specified by InputSection. + Examines a GUIDed section specified by InputSection. If GUID for InputSection does not match the GUID that this handler supports, - then RETURN_UNSUPPORTED is returned. + then RETURN_UNSUPPORTED is returned. If the required information can not be retrieved from InputSection, then RETURN_INVALID_PARAMETER is returned. If the GUID of InputSection does match the GUID that this handler supports, then the size required to hold the decoded buffer is returned in OututBufferSize, the size of an optional scratch buffer is returned in ScratchSize, and the Attributes field from EFI_GUID_DEFINED_SECTION header of InputSection is returned in SectionAttribute. - + If InputSection is NULL, then ASSERT(). If OutputBufferSize is NULL, then ASSERT(). If ScratchBufferSize is NULL, then ASSERT(). @@ -67,16 +67,16 @@ RETURN_STATUS /** Decodes a GUIDed section into a caller allocated output buffer. - - Decodes the GUIDed section specified by InputSection. - If GUID for InputSection does not match the GUID that this handler supports, then RETURN_UNSUPPORTED is returned. + + Decodes the GUIDed section specified by InputSection. + If GUID for InputSection does not match the GUID that this handler supports, then RETURN_UNSUPPORTED is returned. If the data in InputSection can not be decoded, then RETURN_INVALID_PARAMETER is returned. If the GUID of InputSection does match the GUID that this handler supports, then InputSection is decoded into the buffer specified by OutputBuffer and the authentication status of this decode operation is returned in AuthenticationStatus. If the decoded buffer is identical to the data in InputSection, then OutputBuffer is set to point at the data in InputSection. Otherwise, the decoded data will be placed in caller allocated buffer specified by OutputBuffer. - + If InputSection is NULL, then ASSERT(). If OutputBuffer is NULL, then ASSERT(). If ScratchBuffer is NULL and this decode operation requires a scratch buffer, then ASSERT(). @@ -84,10 +84,10 @@ RETURN_STATUS @param[in] InputSection A pointer to a GUIDed section of an FFS formatted file. - @param[out] OutputBuffer A pointer to a buffer that contains the result of a decode operation. + @param[out] OutputBuffer A pointer to a buffer that contains the result of a decode operation. @param[out] ScratchBuffer A caller allocated buffer that may be required by this function - as a scratch buffer to perform the decode operation. - @param[out] AuthenticationStatus + as a scratch buffer to perform the decode operation. + @param[out] AuthenticationStatus A pointer to the authentication status of the decoded output buffer. See the definition of authentication status in the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI section of the PI Specification. EFI_AUTH_STATUS_PLATFORM_OVERRIDE must @@ -114,7 +114,7 @@ RETURN_STATUS Registers the handlers specified by GetInfoHandler and DecodeHandler with the GUID specified by SectionGuid. If the GUID value specified by SectionGuid has already been registered, then return RETURN_ALREADY_STARTED. If there are not enough resources available to register the handlers then RETURN_OUT_OF_RESOURCES is returned. - + If SectionGuid is NULL, then ASSERT(). If GetInfoHandler is NULL, then ASSERT(). If DecodeHandler is NULL, then ASSERT(). @@ -125,7 +125,7 @@ RETURN_STATUS size of the decoded buffer and the size of an optional scratch buffer required to actually decode the data in a GUIDed section. @param[in] DecodeHandler Pointer to a function that decodes a GUIDed section into a caller - allocated output buffer. + allocated output buffer. @retval RETURN_SUCCESS The handlers were registered. @retval RETURN_OUT_OF_RESOURCES There are not enough resources available to register the handlers. @@ -144,7 +144,7 @@ ExtractGuidedSectionRegisterHandlers ( Sets ExtractHandlerGuidTable so it points at a callee allocated array of registered GUIDs. The total number of GUIDs in the array are returned. Since the array of GUIDs is callee allocated - and caller must treat this array of GUIDs as read-only data. + and caller must treat this array of GUIDs as read-only data. If ExtractHandlerGuidTable is NULL, then ASSERT(). @param[out] ExtractHandlerGuidTable A pointer to the array of GUIDs that have been registered through @@ -165,14 +165,14 @@ ExtractGuidedSectionGetGuidList ( The selected handler is used to retrieve and return the size of the decoded buffer and the size of an optional scratch buffer required to actually decode the data in a GUIDed section. - Examines a GUIDed section specified by InputSection. + Examines a GUIDed section specified by InputSection. If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(), - then RETURN_UNSUPPORTED is returned. - If the GUID of InputSection does match the GUID that this handler supports, then the associated handler + then RETURN_UNSUPPORTED is returned. + If the GUID of InputSection does match the GUID that this handler supports, then the associated handler of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers() is used to retrieve the OututBufferSize, ScratchSize, and Attributes values. The return status from the handler of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER is returned. - + If InputSection is NULL, then ASSERT(). If OutputBufferSize is NULL, then ASSERT(). If ScratchBufferSize is NULL, then ASSERT(). @@ -199,7 +199,7 @@ ExtractGuidedSectionGetInfo ( IN CONST VOID *InputSection, OUT UINT32 *OutputBufferSize, OUT UINT32 *ScratchBufferSize, - OUT UINT16 *SectionAttribute + OUT UINT16 *SectionAttribute ); /** @@ -208,26 +208,26 @@ ExtractGuidedSectionGetInfo ( The selected handler is used to decode the data in a GUIDed section and return the result in a caller allocated output buffer. - Decodes the GUIDed section specified by InputSection. + Decodes the GUIDed section specified by InputSection. If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(), - then RETURN_UNSUPPORTED is returned. + then RETURN_UNSUPPORTED is returned. If the GUID of InputSection does match the GUID that this handler supports, then the associated handler of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers() is used to decode InputSection into the buffer specified by OutputBuffer and the authentication status of this decode operation is returned in AuthenticationStatus. If the decoded buffer is identical to the data in InputSection, then OutputBuffer is set to point at the data in InputSection. Otherwise, the decoded data will be placed in caller allocated buffer specified by OutputBuffer. This function is responsible for computing the EFI_AUTH_STATUS_PLATFORM_OVERRIDE - bit of in AuthenticationStatus. The return status from the handler of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER is returned. - + bit of in AuthenticationStatus. The return status from the handler of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER is returned. + If InputSection is NULL, then ASSERT(). If OutputBuffer is NULL, then ASSERT(). If ScratchBuffer is NULL and this decode operation requires a scratch buffer, then ASSERT(). - If AuthenticationStatus is NULL, then ASSERT(). + If AuthenticationStatus is NULL, then ASSERT(). @param[in] InputSection A pointer to a GUIDed section of an FFS formatted file. - @param[out] OutputBuffer A pointer to a buffer that contains the result of a decode operation. - @param[in] ScratchBuffer A caller allocated buffer that may be required by this function as a scratch buffer to perform the decode operation. - @param[out] AuthenticationStatus + @param[out] OutputBuffer A pointer to a buffer that contains the result of a decode operation. + @param[in] ScratchBuffer A caller allocated buffer that may be required by this function as a scratch buffer to perform the decode operation. + @param[out] AuthenticationStatus A pointer to the authentication status of the decoded output buffer. See the definition of authentication status in the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI section of the PI Specification. @@ -243,27 +243,27 @@ ExtractGuidedSectionDecode ( IN CONST VOID *InputSection, OUT VOID **OutputBuffer, IN VOID *ScratchBuffer, OPTIONAL - OUT UINT32 *AuthenticationStatus + OUT UINT32 *AuthenticationStatus ); /** - Retrieves handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and + Retrieves handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and EXTRACT_GUIDED_SECTION_DECODE_HANDLER for a specific GUID section type. - - Retrieves the handlers associated with SectionGuid and returns them in + + Retrieves the handlers associated with SectionGuid and returns them in GetInfoHandler and DecodeHandler. - If the GUID value specified by SectionGuid has not been registered, then + If the GUID value specified by SectionGuid has not been registered, then return RETURN_NOT_FOUND. - + If SectionGuid is NULL, then ASSERT(). - @param[in] SectionGuid A pointer to the GUID associated with the handlersof the GUIDed + @param[in] SectionGuid A pointer to the GUID associated with the handlersof the GUIDed section type being retrieved. - @param[out] GetInfoHandler Pointer to a function that examines a GUIDed section and returns - the size of the decoded buffer and the size of an optional scratch - buffer required to actually decode the data in a GUIDed section. - This is an optional parameter that may be NULL. If it is NULL, then + @param[out] GetInfoHandler Pointer to a function that examines a GUIDed section and returns + the size of the decoded buffer and the size of an optional scratch + buffer required to actually decode the data in a GUIDed section. + This is an optional parameter that may be NULL. If it is NULL, then the previously registered handler is not returned. @param[out] DecodeHandler Pointer to a function that decodes a GUIDed section into a caller allocated output buffer. This is an optional parameter that may be NULL. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/FileHandleLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/FileHandleLib.h index cbafa4aca8..ca11cd294c 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/FileHandleLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/FileHandleLib.h @@ -249,8 +249,8 @@ FileHandleFlush ( @param[in] DirHandle Handle to open file. @retval EFI_SUCCESS DirHandle is a directory. - @retval EFI_INVALID_PARAMETER DirHandle is NULL. - The file information returns from FileHandleGetInfo is NULL. + @retval EFI_INVALID_PARAMETER DirHandle is NULL. + The file information returns from FileHandleGetInfo is NULL. @retval EFI_NOT_FOUND DirHandle is not a directory. **/ EFI_STATUS @@ -357,8 +357,8 @@ FileHandleSetSize ( /** Function to get a full filename given a EFI_FILE_HANDLE somewhere lower on the - directory 'stack'. If the file is a directory, then append the '\' char at the - end of name string. If it's not a directory, then the last '\' should not be + directory 'stack'. If the file is a directory, then append the '\' char at the + end of name string. If it's not a directory, then the last '\' should not be added. @param[in] Handle Handle to the Directory or File to create path to. @@ -439,11 +439,11 @@ FileHandleReturnLine( /** Function to write a line of text to a file. - - If the file is a Unicode file (with UNICODE file tag) then write the unicode + + If the file is a Unicode file (with UNICODE file tag) then write the unicode text. If the file is an ASCII file then write the ASCII text. - If the size of file is zero (without file tag at the beginning) then write + If the size of file is zero (without file tag at the beginning) then write ASCII text as default. @param[in] Handle FileHandle to write to. @@ -453,7 +453,7 @@ FileHandleReturnLine( @retval EFI_SUCCESS The data was written. Buffer is NULL. @retval EFI_INVALID_PARAMETER Handle is NULL. - @retval EFI_OUT_OF_RESOURCES Unable to allocate temporary space for ASCII + @retval EFI_OUT_OF_RESOURCES Unable to allocate temporary space for ASCII string due to out of resources. @sa FileHandleWrite diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/HobLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/HobLib.h index 04a03cf505..a14d7af398 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/HobLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/HobLib.h @@ -190,7 +190,7 @@ BuildModuleHob ( This function builds a HOB that describes a chunk of system memory. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. - + If there is no additional space for HOB creation, then ASSERT(). @param ResourceType The type of resource described by this HOB. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/IoLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/IoLib.h index 7c27f1cf65..50385f8c46 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/IoLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/IoLib.h @@ -20,14 +20,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** Macro that converts PCI Segment and I/O Port to an address that can be passed to the I/O Library functions. - - Computes an address that is compatible with the I/O Library functions. - The unused upper bits of Segment, and Port are stripped prior to the + + Computes an address that is compatible with the I/O Library functions. + The unused upper bits of Segment, and Port are stripped prior to the generation of the address. - + @param Segment PCI Segment number. Range 0..65535. @param Port I/O Port number. Range 0..65535. - + @return An address that the I/o Library functions need. **/ @@ -178,7 +178,7 @@ IoAnd8 ( ); /** - Reads an 8-bit I/O port, performs a bitwise AND followed by a bitwise + 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 @@ -238,7 +238,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. + 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(). @@ -405,7 +405,7 @@ IoRead16 ( If 16-bit I/O port operations are not supported, then ASSERT(). If Port is not aligned on a 16-bit boundary, then ASSERT(). - + @param Port The I/O port to write. @param Value The value to write to the I/O port. @@ -507,7 +507,7 @@ IoOr16 ( If 16-bit I/O port operations are not supported, then ASSERT(). If Port is not aligned on a 16-bit boundary, then ASSERT(). - + @param Port The I/O port to write. @param AndData The value to AND with the read value from the I/O port. @@ -522,7 +522,7 @@ IoAnd16 ( ); /** - Reads a 16-bit I/O port, performs a bitwise AND followed by a bitwise + 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 @@ -534,7 +534,7 @@ IoAnd16 ( If 16-bit I/O port operations are not supported, then ASSERT(). If Port is not aligned on a 16-bit boundary, then ASSERT(). - + @param Port The I/O port to write. @param AndData The value to AND with the read value from the I/O port. @param OrData The value to OR with the result of the AND operation. @@ -735,7 +735,7 @@ IoBitFieldAndThenOr16 ( If 32-bit I/O port operations are not supported, then ASSERT(). If Port is not aligned on a 32-bit boundary, then ASSERT(). - + @param Port The I/O port to read. @return The value read. @@ -756,7 +756,7 @@ IoRead32 ( If 32-bit I/O port operations are not supported, then ASSERT(). If Port is not aligned on a 32-bit boundary, then ASSERT(). - + @param Port The I/O port to write. @param Value The value to write to the I/O port. @@ -873,7 +873,7 @@ IoAnd32 ( ); /** - Reads a 32-bit I/O port, performs a bitwise AND followed by a bitwise + 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 @@ -1174,7 +1174,7 @@ IoAnd64 ( ); /** - Reads a 64-bit I/O port, performs a bitwise AND followed by a bitwise + 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 @@ -1409,7 +1409,7 @@ MmioRead8 ( @param Address The MMIO register to write. @param Value The value to write to the MMIO register. - + @return Value. **/ @@ -1424,7 +1424,7 @@ MmioWrite8 ( 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 + 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 @@ -1471,7 +1471,7 @@ MmioAnd8 ( ); /** - Reads an 8-bit MMIO register, performs a bitwise AND followed by a bitwise + 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 @@ -1563,7 +1563,7 @@ 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 + 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 @@ -1704,7 +1704,7 @@ MmioRead16 ( @param Address The MMIO register to write. @param Value The value to write to the MMIO register. - + @return Value. **/ @@ -1719,7 +1719,7 @@ MmioWrite16 ( 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 + 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 @@ -1768,7 +1768,7 @@ MmioAnd16 ( ); /** - Reads a 16-bit MMIO register, performs a bitwise AND followed by a bitwise + 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 @@ -1862,7 +1862,7 @@ 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 + 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 @@ -2006,7 +2006,7 @@ MmioRead32 ( @param Address The MMIO register to write. @param Value The value to write to the MMIO register. - + @return Value. **/ @@ -2021,7 +2021,7 @@ MmioWrite32 ( 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 + 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 @@ -2070,7 +2070,7 @@ MmioAnd32 ( ); /** - Reads a 32-bit MMIO register, performs a bitwise AND followed by a bitwise + 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 @@ -2164,7 +2164,7 @@ 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 + 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 @@ -2321,7 +2321,7 @@ MmioWrite64 ( 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 + 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 @@ -2370,7 +2370,7 @@ MmioAnd64 ( ); /** - Reads a 64-bit MMIO register, performs a bitwise AND followed by a bitwise + 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 @@ -2464,7 +2464,7 @@ 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 + 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 @@ -2578,11 +2578,11 @@ MmioBitFieldAndThenOr64 ( /** Copy data from MMIO region to system memory by using 8-bit access. - Copy data from MMIO region specified by starting address StartAddress - to system memory specified by Buffer by using 8-bit access. The total + Copy data from MMIO region specified by starting address StartAddress + to system memory specified by Buffer by using 8-bit access. The total number of byte to be copied is specified by Length. Buffer is returned. - - If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). + + If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). @@ -2604,13 +2604,13 @@ MmioReadBuffer8 ( /** Copy data from MMIO region to system memory by using 16-bit access. - Copy data from MMIO region specified by starting address StartAddress - to system memory specified by Buffer by using 16-bit access. The total + Copy data from MMIO region specified by starting address StartAddress + to system memory specified by Buffer by using 16-bit access. The total number of byte to be copied is specified by Length. Buffer is returned. - + If StartAddress is not aligned on a 16-bit boundary, then ASSERT(). - If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). + If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is not aligned on a 16-bit boundary, then ASSERT(). @@ -2634,13 +2634,13 @@ MmioReadBuffer16 ( /** Copy data from MMIO region to system memory by using 32-bit access. - Copy data from MMIO region specified by starting address StartAddress - to system memory specified by Buffer by using 32-bit access. The total + Copy data from MMIO region specified by starting address StartAddress + to system memory specified by Buffer by using 32-bit access. The total number of byte to be copied is specified by Length. Buffer is returned. - + If StartAddress is not aligned on a 32-bit boundary, then ASSERT(). - If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). + If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is not aligned on a 32-bit boundary, then ASSERT(). @@ -2664,13 +2664,13 @@ MmioReadBuffer32 ( /** Copy data from MMIO region to system memory by using 64-bit access. - Copy data from MMIO region specified by starting address StartAddress - to system memory specified by Buffer by using 64-bit access. The total + Copy data from MMIO region specified by starting address StartAddress + to system memory specified by Buffer by using 64-bit access. The total number of byte to be copied is specified by Length. Buffer is returned. - + If StartAddress is not aligned on a 64-bit boundary, then ASSERT(). - If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). + If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is not aligned on a 64-bit boundary, then ASSERT(). @@ -2694,11 +2694,11 @@ MmioReadBuffer64 ( /** Copy data from system memory to MMIO region by using 8-bit access. - Copy data from system memory specified by Buffer to MMIO region specified - by starting address StartAddress by using 8-bit access. The total number + Copy data from system memory specified by Buffer to MMIO region specified + by starting address StartAddress by using 8-bit access. The total number of byte to be copied is specified by Length. Buffer is returned. - - If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). + + If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT(). @@ -2720,13 +2720,13 @@ MmioWriteBuffer8 ( /** Copy data from system memory to MMIO region by using 16-bit access. - Copy data from system memory specified by Buffer to MMIO region specified - by starting address StartAddress by using 16-bit access. The total number + Copy data from system memory specified by Buffer to MMIO region specified + by starting address StartAddress by using 16-bit access. The total number of byte to be copied is specified by Length. Buffer is returned. - + If StartAddress is not aligned on a 16-bit boundary, then ASSERT(). - If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). + If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT(). If Length is not aligned on a 16-bit boundary, then ASSERT(). @@ -2751,13 +2751,13 @@ MmioWriteBuffer16 ( /** Copy data from system memory to MMIO region by using 32-bit access. - Copy data from system memory specified by Buffer to MMIO region specified - by starting address StartAddress by using 32-bit access. The total number + Copy data from system memory specified by Buffer to MMIO region specified + by starting address StartAddress by using 32-bit access. The total number of byte to be copied is specified by Length. Buffer is returned. - + If StartAddress is not aligned on a 32-bit boundary, then ASSERT(). - If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). + If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT(). If Length is not aligned on a 32-bit boundary, then ASSERT(). @@ -2782,13 +2782,13 @@ MmioWriteBuffer32 ( /** Copy data from system memory to MMIO region by using 64-bit access. - Copy data from system memory specified by Buffer to MMIO region specified - by starting address StartAddress by using 64-bit access. The total number + Copy data from system memory specified by Buffer to MMIO region specified + by starting address StartAddress by using 64-bit access. The total number of byte to be copied is specified by Length. Buffer is returned. - + If StartAddress is not aligned on a 64-bit boundary, then ASSERT(). - If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). + If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT(). If Length is not aligned on a 64-bit boundary, then ASSERT(). diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/MemoryAllocationLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/MemoryAllocationLib.h index 204a8b5123..e25abcb18a 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/MemoryAllocationLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/MemoryAllocationLib.h @@ -1,11 +1,11 @@ /** @file Provides services to allocate and free memory buffers of various memory types and alignments. - - The Memory Allocation Library abstracts various common memory allocation operations. This library - allows code to be written in a phase-independent manner because the allocation of memory in PEI, DXE, - and SMM (for example) is done via a different mechanism. Using a common library interface makes it - much easier to port algorithms from phase to phase. - + + The Memory Allocation Library abstracts various common memory allocation operations. This library + allows code to be written in a phase-independent manner because the allocation of memory in PEI, DXE, + and SMM (for example) is done via a different mechanism. Using a common library interface makes it + much easier to port algorithms from phase to phase. + Copyright (c) 2006 - 2013, 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 @@ -85,11 +85,11 @@ AllocateReservedPages ( must have been allocated on a previous call to the page allocation services of the Memory Allocation Library. If it is not possible to free allocated pages, then this function will perform no actions. - + If Buffer was not allocated with a page allocation function in the Memory Allocation Library, then ASSERT(). If Pages is zero, then ASSERT(). - + @param Buffer Pointer to the buffer of pages to free. @param Pages The number of 4 KB pages to free. @@ -108,7 +108,7 @@ FreePages ( alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is returned. If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned. - + If Alignment is not a power of two and Alignment is not zero, then ASSERT(). If Pages plus EFI_SIZE_TO_PAGES (Alignment) overflows, then ASSERT(). @@ -133,7 +133,7 @@ AllocateAlignedPages ( alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is returned. If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned. - + If Alignment is not a power of two and Alignment is not zero, then ASSERT(). If Pages plus EFI_SIZE_TO_PAGES (Alignment) overflows, then ASSERT(). @@ -158,7 +158,7 @@ AllocateAlignedRuntimePages ( alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is returned. If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned. - + If Alignment is not a power of two and Alignment is not zero, then ASSERT(). If Pages plus EFI_SIZE_TO_PAGES (Alignment) overflows, then ASSERT(). @@ -182,13 +182,13 @@ AllocateAlignedReservedPages ( Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer. Buffer must have been allocated on a previous call to the aligned page allocation services of the Memory - Allocation Library. If it is not possible to free allocated pages, then this function will + Allocation Library. If it is not possible to free allocated pages, then this function will perform no actions. - + If Buffer was not allocated with an aligned page allocation function in the Memory Allocation Library, then ASSERT(). If Pages is zero, then ASSERT(). - + @param Buffer Pointer to the buffer of pages to free. @param Pages The number of 4 KB pages to free. @@ -318,9 +318,9 @@ AllocateReservedZeroPool ( AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned. - + If Buffer is NULL, then ASSERT(). - If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). + If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). @param AllocationSize The number of bytes to allocate and zero. @param Buffer The buffer to copy to the allocated buffer. @@ -342,9 +342,9 @@ AllocateCopyPool ( AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned. - + If Buffer is NULL, then ASSERT(). - If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). + If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). @param AllocationSize The number of bytes to allocate and zero. @param Buffer The buffer to copy to the allocated buffer. @@ -366,9 +366,9 @@ AllocateRuntimeCopyPool ( AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned. - + If Buffer is NULL, then ASSERT(). - If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). + If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). @param AllocationSize The number of bytes to allocate and zero. @param Buffer The buffer to copy to the allocated buffer. @@ -387,18 +387,18 @@ AllocateReservedCopyPool ( Reallocates a buffer of type EfiBootServicesData. Allocates and zeros the number bytes specified by NewSize from memory of type - EfiBootServicesData. If OldBuffer is not NULL, then the smaller of OldSize and - NewSize bytes are copied from OldBuffer to the newly allocated buffer, and - OldBuffer is freed. A pointer to the newly allocated buffer is returned. - If NewSize is 0, then a valid buffer of 0 size is returned. If there is not + EfiBootServicesData. If OldBuffer is not NULL, then the smaller of OldSize and + NewSize bytes are copied from OldBuffer to the newly allocated buffer, and + OldBuffer is freed. A pointer to the newly allocated buffer is returned. + If NewSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned. - + If the allocation of the new buffer is successful and the smaller of NewSize and OldSize is greater than (MAX_ADDRESS - OldBuffer + 1), then ASSERT(). @param OldSize The size, in bytes, of OldBuffer. @param NewSize The size, in bytes, of the buffer to reallocate. - @param OldBuffer The buffer to copy to the allocated buffer. This is an optional + @param OldBuffer The buffer to copy to the allocated buffer. This is an optional parameter that may be NULL. @return A pointer to the allocated buffer or NULL if allocation fails. @@ -416,10 +416,10 @@ ReallocatePool ( Reallocates a buffer of type EfiRuntimeServicesData. Allocates and zeros the number bytes specified by NewSize from memory of type - EfiRuntimeServicesData. If OldBuffer is not NULL, then the smaller of OldSize and - NewSize bytes are copied from OldBuffer to the newly allocated buffer, and - OldBuffer is freed. A pointer to the newly allocated buffer is returned. - If NewSize is 0, then a valid buffer of 0 size is returned. If there is not + EfiRuntimeServicesData. If OldBuffer is not NULL, then the smaller of OldSize and + NewSize bytes are copied from OldBuffer to the newly allocated buffer, and + OldBuffer is freed. A pointer to the newly allocated buffer is returned. + If NewSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned. If the allocation of the new buffer is successful and the smaller of NewSize and OldSize @@ -427,7 +427,7 @@ ReallocatePool ( @param OldSize The size, in bytes, of OldBuffer. @param NewSize The size, in bytes, of the buffer to reallocate. - @param OldBuffer The buffer to copy to the allocated buffer. This is an optional + @param OldBuffer The buffer to copy to the allocated buffer. This is an optional parameter that may be NULL. @return A pointer to the allocated buffer or NULL if allocation fails. @@ -445,10 +445,10 @@ ReallocateRuntimePool ( Reallocates a buffer of type EfiReservedMemoryType. Allocates and zeros the number bytes specified by NewSize from memory of type - EfiReservedMemoryType. If OldBuffer is not NULL, then the smaller of OldSize and - NewSize bytes are copied from OldBuffer to the newly allocated buffer, and - OldBuffer is freed. A pointer to the newly allocated buffer is returned. - If NewSize is 0, then a valid buffer of 0 size is returned. If there is not + EfiReservedMemoryType. If OldBuffer is not NULL, then the smaller of OldSize and + NewSize bytes are copied from OldBuffer to the newly allocated buffer, and + OldBuffer is freed. A pointer to the newly allocated buffer is returned. + If NewSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned. If the allocation of the new buffer is successful and the smaller of NewSize and OldSize @@ -456,7 +456,7 @@ ReallocateRuntimePool ( @param OldSize The size, in bytes, of OldBuffer. @param NewSize The size, in bytes, of the buffer to reallocate. - @param OldBuffer The buffer to copy to the allocated buffer. This is an optional + @param OldBuffer The buffer to copy to the allocated buffer. This is an optional parameter that may be NULL. @return A pointer to the allocated buffer or NULL if allocation fails. @@ -477,7 +477,7 @@ ReallocateReservedPool ( Frees the buffer specified by Buffer. Buffer must have been allocated on a previous call to the pool allocation services of the Memory Allocation Library. If it is not possible to free pool resources, then this function will perform no actions. - + If Buffer was not allocated with a pool allocation function in the Memory Allocation Library, then ASSERT(). diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PalLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PalLib.h index e5c3473c61..b9ec6e1c2a 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PalLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PalLib.h @@ -1,22 +1,22 @@ /** @file Provides library services to make PAL Calls. - + The PAL Library provides a service to make a PAL CALL. This service is identical in functionality to AsmPalCall() in the functions of the Base Library specific to Intel Itanium architecture. The only difference is that the PAL Entry Point is not passed in. Implementations of this library class must manage PAL Entry Point on their own. For example, a PEI implementation can use a PPI to lookup the PAL Entry Point, and a DXE implementation - can contain a constructor to look up the PAL Entry Point from a HOB. This library class + can contain a constructor to look up the PAL Entry Point from a HOB. This library class is only available on Intel Itanium-based platforms. - + Copyright (c) 2006 - 2008, 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 +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 -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PcdLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PcdLib.h index fdb2df87aa..c0e1893f63 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PcdLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PcdLib.h @@ -8,8 +8,8 @@ LibPatchPcdSetPtr() interface. For FeatureFlag/Fixed PCD, the macro interface is translated to a variable or macro that is auto-generated by build tool in module's autogen.h/autogen.c. - The PcdGetXX(), PcdSetXX(), PcdToken(), and PcdGetNextTokenSpace() operations are - only available prior to ExitBootServices(). If access to PCD values are required + The PcdGetXX(), PcdSetXX(), PcdToken(), and PcdGetNextTokenSpace() operations are + only available prior to ExitBootServices(). If access to PCD values are required at runtime, then their values must be collected prior to ExitBootServices(). There are no restrictions on the use of FeaturePcd(), FixedPcdGetXX(), PatchPcdGetXX(), and PatchPcdSetXX(). @@ -127,7 +127,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @param TokenName The name of the PCD token to retrieve a current value for. - @return The Boolean value for the token. + @return The Boolean value for the token. **/ #define FixedPcdGetBool(TokenName) _PCD_VALUE_##TokenName @@ -142,7 +142,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @param TokenName The name of the PCD token to retrieve a current value for. - @return A pointer to the buffer. + @return A pointer to the buffer. **/ #define FixedPcdGetPtr(TokenName) ((VOID *)_PCD_VALUE_##TokenName) @@ -246,7 +246,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @param TokenName The name of the binary patchable PCD token to set the current value for. @param Value The 8-bit value to set. - + @return Return the Value that was set. **/ @@ -320,17 +320,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** Sets a pointer to a binary patchable PCD token buffer based on a token name. - Sets the buffer for the token specified by TokenName. Buffer is returned. + Sets the buffer for the token specified by TokenName. Buffer is returned. If SizeOfBuffer is greater than the maximum size supported by TokenName, then set SizeOfBuffer - to the maximum size supported by TokenName and return NULL to indicate that the set operation - was not actually performed. If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be + to the maximum size supported by TokenName and return NULL to indicate that the set operation + was not actually performed. If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the maximum size supported by TokenName and NULL must be returned. If TokenName is not a valid token in the token space, then the module will not build. If TokenName is not a patchable in module PCD, then the module will not build. - + If SizeOfBuffer is NULL, then ASSERT(). If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT(). - + @param TokenName The name of the binary patchable PCD token to set the current value for. @param SizeOfBuffer A pointer to the size, in bytes, of Buffer. @param Buffer Pointer to the value to set. @@ -348,10 +348,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. ) /** Retrieves an 8-bit PCD token value based on a token name. - + Returns the 8-bit value for the token specified by TokenName. If TokenName is not a valid token in the token space, then the module will not build. - + @param TokenName The name of the PCD token to retrieve a current value for. @return 8-bit value for the token specified by TokenName. @@ -460,10 +460,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** Retrieves the size of the PCD token based on a token name. - + Returns the size of the token specified by TokenName. If TokenName is not a valid token in the token space, then the module will not build. - + @param[in] TokenName The name of the PCD token to retrieve a current value size for. @return Return the size @@ -474,11 +474,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** Retrieve the size of a given PCD token. - - Returns the size of the token specified by TokenNumber and Guid. - If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that designates + Returns the size of the token specified by TokenNumber and Guid. + If Guid is NULL, then ASSERT(). + + @param[in] Guid Pointer to a 128-bit unique value that designates which namespace to retrieve a value from. @param[in] TokenNumber The PCD token number to retrieve a current value size for. @@ -496,7 +496,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @param TokenName The name of the PCD token to retrieve a current value for. @param Value The 8-bit value to set. - + @return Return the Value that was set. **/ @@ -551,17 +551,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** Sets a pointer to a PCD token buffer based on a token name. - Sets the buffer for the token specified by TokenName. Buffer is returned. - If SizeOfBuffer is greater than the maximum size supported by TokenName, - then set SizeOfBuffer to the maximum size supported by TokenName and return NULL - to indicate that the set operation was not actually performed. If SizeOfBuffer - is set to MAX_ADDRESS, then SizeOfBuffer must be set to the maximum size supported + Sets the buffer for the token specified by TokenName. Buffer is returned. + If SizeOfBuffer is greater than the maximum size supported by TokenName, + then set SizeOfBuffer to the maximum size supported by TokenName and return NULL + to indicate that the set operation was not actually performed. If SizeOfBuffer + is set to MAX_ADDRESS, then SizeOfBuffer must be set to the maximum size supported by TokenName and NULL must be returned. If TokenName is not a valid token in the token space, then the module will not build. - + If SizeOfBuffer is NULL, then ASSERT(). If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT(). - + @param TokenName The name of the PCD token to set the current value for. @param SizeOfBuffer A pointer to the size, in bytes, of Buffer. @param Buffer A pointer to the buffer to set. @@ -571,11 +571,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ #define PcdSetPtr(TokenName, SizeOfBuffer, Buffer) \ _PCD_SET_MODE_PTR_##TokenName ((SizeOfBuffer), (Buffer)) - + /** Sets a Boolean PCD token value based on a token name. - Sets the Boolean value for the token specified by TokenName. Value is returned. + Sets the Boolean value for the token specified by TokenName. Value is returned. If TokenName is not a valid token in the token space, then the module will not build. @param TokenName The name of the PCD token to set the current value for. @@ -689,9 +689,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. Returns the token number for the token specified by Guid and TokenName. If TokenName is not a valid token in the token space, then the module will not build. - @param Guid Pointer to a 128-bit unique value that designates + @param Guid Pointer to a 128-bit unique value that designates which namespace to retrieve a value from. - @param TokenName The name of the PCD token to retrieve a current value for. + @param TokenName The name of the PCD token to retrieve a current value for. @return Return the token number. @@ -702,14 +702,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. Retrieves an 8-bit PCD token value based on a GUID and a token name. Returns the 8-bit value for the token specified by Guid and TokenName. - If TokenName is not a valid token in the token space specified by Guid, + If TokenName is not a valid token in the token space specified by Guid, then the module will not build. - + If Guid is NULL, then ASSERT(). - @param Guid Pointer to a 128-bit unique value that designates + @param Guid Pointer to a 128-bit unique value that designates which namespace to retrieve a value from. - @param TokenName The name of the PCD token to retrieve a current value for. + @param TokenName The name of the PCD token to retrieve a current value for. @return An 8-bit PCD token value. @@ -720,14 +720,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. Retrieves a 16-bit PCD token value based on a GUID and a token name. Returns the 16-bit value for the token specified by Guid and TokenName. - If TokenName is not a valid token in the token space specified by Guid, + If TokenName is not a valid token in the token space specified by Guid, then the module will not build. If Guid is NULL, then ASSERT(). - @param Guid Pointer to a 128-bit unique value that designates + @param Guid Pointer to a 128-bit unique value that designates which namespace to retrieve a value from. - @param TokenName The name of the PCD token to retrieve a current value for. + @param TokenName The name of the PCD token to retrieve a current value for. @return A 16-bit PCD token value. @@ -739,14 +739,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. Retrieves a 32-bit PCD token value based on a GUID and a token name. Returns the 32-bit value for the token specified by Guid and TokenName. - If TokenName is not a valid token in the token space specified by Guid, + If TokenName is not a valid token in the token space specified by Guid, then the module will not build. If Guid is NULL, then ASSERT(). - @param Guid Pointer to a 128-bit unique value that designates + @param Guid Pointer to a 128-bit unique value that designates which namespace to retrieve a value from. - @param TokenName The name of the PCD token to retrieve a current value for. + @param TokenName The name of the PCD token to retrieve a current value for. @return A 32-bit PCD token value. @@ -758,14 +758,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. Retrieves a 64-bit PCD token value based on a GUID and a token name. Returns the 64-bit value for the token specified by Guid and TokenName. - If TokenName is not a valid token in the token space specified by Guid, + If TokenName is not a valid token in the token space specified by Guid, then the module will not build. If Guid is NULL, then ASSERT(). - @param Guid Pointer to a 128-bit unique value that designates + @param Guid Pointer to a 128-bit unique value that designates which namespace to retrieve a value from. - @param TokenName The name of the PCD token to retrieve a current value for. + @param TokenName The name of the PCD token to retrieve a current value for. @return A 64-bit PCD token value. @@ -777,14 +777,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. Retrieves a pointer to a PCD token buffer based on a GUID and a token name. Returns a pointer to the buffer for the token specified by Guid and TokenName. - If TokenName is not a valid token in the token space specified by Guid, + If TokenName is not a valid token in the token space specified by Guid, then the module will not build. If Guid is NULL, then ASSERT(). - @param Guid Pointer to a 128-bit unique value that designates + @param Guid Pointer to a 128-bit unique value that designates which namespace to retrieve a value from. - @param TokenName The name of the PCD token to retrieve a current value for. + @param TokenName The name of the PCD token to retrieve a current value for. @return A pointer to a PCD token buffer. @@ -796,14 +796,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. Retrieves a Boolean PCD token value based on a GUID and a token name. Returns the Boolean value for the token specified by Guid and TokenName. - If TokenName is not a valid token in the token space specified by Guid, + If TokenName is not a valid token in the token space specified by Guid, then the module will not build. If Guid is NULL, then ASSERT(). - @param Guid Pointer to a 128-bit unique value that designates + @param Guid Pointer to a 128-bit unique value that designates which namespace to retrieve a value from. - @param TokenName The name of the PCD token to retrieve a current value for. + @param TokenName The name of the PCD token to retrieve a current value for. @return A Boolean PCD token value. @@ -817,15 +817,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. Sets an 8-bit PCD token value based on a GUID and a token name. Sets the 8-bit value for the token specified by Guid and TokenName. Value is returned. - If TokenName is not a valid token in the token space specified by Guid, + If TokenName is not a valid token in the token space specified by Guid, then the module will not build. If Guid is NULL, then ASSERT(). - @param Guid Pointer to a 128-bit unique value that designates + @param Guid Pointer to a 128-bit unique value that designates which namespace to retrieve a value from. @param TokenName The name of the PCD token to set the current value for. - @param Value The 8-bit value to set. + @param Value The 8-bit value to set. @return Return the Value that was set. @@ -837,15 +837,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. Sets a 16-bit PCD token value based on a GUID and a token name. Sets the 16-bit value for the token specified by Guid and TokenName. Value is returned. - If TokenName is not a valid token in the token space specified by Guid, + If TokenName is not a valid token in the token space specified by Guid, then the module will not build. If Guid is NULL, then ASSERT(). - @param Guid Pointer to a 128-bit unique value that designates + @param Guid Pointer to a 128-bit unique value that designates which namespace to retrieve a value from. @param TokenName The name of the PCD token to set the current value for. - @param Value The 16-bit value to set. + @param Value The 16-bit value to set. @return Return the Value that was set. @@ -857,15 +857,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. Sets a 32-bit PCD token value based on a GUID and a token name. Sets the 32-bit value for the token specified by Guid and TokenName. Value is returned. - If TokenName is not a valid token in the token space specified by Guid, + If TokenName is not a valid token in the token space specified by Guid, then the module will not build. If Guid is NULL, then ASSERT(). - @param Guid Pointer to a 128-bit unique value that designates + @param Guid Pointer to a 128-bit unique value that designates which namespace to retrieve a value from. @param TokenName The name of the PCD token to set the current value for. - @param Value The 32-bit value to set. + @param Value The 32-bit value to set. @return Return the Value that was set. @@ -877,15 +877,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. Sets a 64-bit PCD token value based on a GUID and a token name. Sets the 64-bit value for the token specified by Guid and TokenName. Value is returned. - If TokenName is not a valid token in the token space specified by Guid, + If TokenName is not a valid token in the token space specified by Guid, then the module will not build. If Guid is NULL, then ASSERT(). - @param Guid Pointer to a 128-bit unique value that designates + @param Guid Pointer to a 128-bit unique value that designates which namespace to retrieve a value from. @param TokenName The name of the PCD token to set the current value for. - @param Value The 64-bit value to set. + @param Value The 64-bit value to set. @return Return the Value that was set. @@ -896,25 +896,25 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** Sets a pointer to a PCD token buffer based on a GUID and a token name. - Sets the buffer for the token specified by Guid and TokenName. Buffer is returned. - If SizeOfBuffer is greater than the maximum size supported by Guid and TokenName, - then set SizeOfBuffer to the maximum size supported by Guid and TokenName and return - NULL to indicate that the set operation was not actually performed. If SizeOfBuffer + Sets the buffer for the token specified by Guid and TokenName. Buffer is returned. + If SizeOfBuffer is greater than the maximum size supported by Guid and TokenName, + then set SizeOfBuffer to the maximum size supported by Guid and TokenName and return + NULL to indicate that the set operation was not actually performed. If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the maximum size supported by Guid and TokenName and NULL must be returned. - If TokenName is not a valid token in the token space specified by Guid, + If TokenName is not a valid token in the token space specified by Guid, then the module will not build. - + If Guid is NULL, then ASSERT(). If SizeOfBuffer is NULL, then ASSERT(). If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT(). - @param Guid Pointer to a 128-bit unique value that designates + @param Guid Pointer to a 128-bit unique value that designates which namespace to retrieve a value from. @param TokenName The name of the PCD token to set the current value for. - @param SizeOfBuffer A pointer to the size, in bytes, of Buffer. + @param SizeOfBuffer A pointer to the size, in bytes, of Buffer. @param Buffer Pointer to the buffer to set. - + @return Return the pointer to the Buffer that was set. **/ @@ -925,20 +925,20 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** Sets a Boolean PCD token value based on a GUID and a token name. - Sets the Boolean value for the token specified by Guid and TokenName. Value is returned. - If TokenName is not a valid token in the token space specified by Guid, + Sets the Boolean value for the token specified by Guid and TokenName. Value is returned. + If TokenName is not a valid token in the token space specified by Guid, then the module will not build. If Guid is NULL, then ASSERT(). - @param Guid Pointer to a 128-bit unique value that designates + @param Guid Pointer to a 128-bit unique value that designates which namespace to retrieve a value from. - @param TokenName The name of the PCD token to set the current value for. + @param TokenName The name of the PCD token to set the current value for. @param Value The Boolean value to set. @return Return the Value that was set. -**/ +**/ #define PcdSetExBool(Guid, TokenName, Value) \ LibPcdSetExBool((Guid), PcdTokenEx(Guid,TokenName), (Value)) #endif @@ -1088,12 +1088,12 @@ LibPcdSetSku ( /** This function provides a means by which to retrieve a value for a given PCD token. - - Returns the 8-bit value for the token specified by TokenNumber. + + Returns the 8-bit value for the token specified by TokenNumber. @param[in] TokenNumber The PCD token number to retrieve a current value for. - @return Returns the 8-bit value for the token specified by TokenNumber. + @return Returns the 8-bit value for the token specified by TokenNumber. **/ UINT8 @@ -1105,12 +1105,12 @@ LibPcdGet8 ( /** This function provides a means by which to retrieve a value for a given PCD token. - - Returns the 16-bit value for the token specified by TokenNumber. + + Returns the 16-bit value for the token specified by TokenNumber. @param[in] TokenNumber The PCD token number to retrieve a current value for. - @return Returns the 16-bit value for the token specified by TokenNumber. + @return Returns the 16-bit value for the token specified by TokenNumber. **/ UINT16 @@ -1122,8 +1122,8 @@ LibPcdGet16 ( /** This function provides a means by which to retrieve a value for a given PCD token. - - Returns the 32-bit value for the token specified by TokenNumber. + + Returns the 32-bit value for the token specified by TokenNumber. @param[in] TokenNumber The PCD token number to retrieve a current value for. @@ -1139,7 +1139,7 @@ LibPcdGet32 ( /** This function provides a means by which to retrieve a value for a given PCD token. - + Returns the 64-bit value for the token specified by TokenNumber. @param[in] TokenNumber The PCD token number to retrieve a current value for. @@ -1156,7 +1156,7 @@ LibPcdGet64 ( /** This function provides a means by which to retrieve a value for a given PCD token. - + Returns the pointer to the buffer of the token specified by TokenNumber. @param[in] TokenNumber The PCD token number to retrieve a current value for. @@ -1173,15 +1173,15 @@ LibPcdGetPtr ( /** This function provides a means by which to retrieve a value for a given PCD token. - - Returns the Boolean value of the token specified by TokenNumber. + + Returns the Boolean value of the token specified by TokenNumber. @param[in] TokenNumber The PCD token number to retrieve a current value for. - @return Returns the Boolean value of the token specified by TokenNumber. + @return Returns the Boolean value of the token specified by TokenNumber. **/ -BOOLEAN +BOOLEAN EFIAPI LibPcdGetBool ( IN UINTN TokenNumber @@ -1193,7 +1193,7 @@ LibPcdGetBool ( @param[in] TokenNumber The PCD token number to retrieve a current value for. - @return Returns the size of the token specified by TokenNumber. + @return Returns the size of the token specified by TokenNumber. **/ UINTN @@ -1205,12 +1205,12 @@ LibPcdGetSize ( /** This function provides a means by which to retrieve a value for a given PCD token. - + Returns the 8-bit value for the token specified by TokenNumber and Guid. - - If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that designates + If Guid is NULL, then ASSERT(). + + @param[in] Guid Pointer to a 128-bit unique value that designates which namespace to retrieve a value from. @param[in] TokenNumber The PCD token number to retrieve a current value for. @@ -1229,10 +1229,10 @@ LibPcdGetEx8 ( This function provides a means by which to retrieve a value for a given PCD token. Returns the 16-bit value for the token specified by TokenNumber and Guid. - - If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that designates + If Guid is NULL, then ASSERT(). + + @param[in] Guid Pointer to a 128-bit unique value that designates which namespace to retrieve a value from. @param[in] TokenNumber The PCD token number to retrieve a current value for. @@ -1249,9 +1249,9 @@ LibPcdGetEx16 ( /** Returns the 32-bit value for the token specified by TokenNumber and Guid. - If Guid is NULL, then ASSERT(). + If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that designates + @param[in] Guid Pointer to a 128-bit unique value that designates which namespace to retrieve a value from. @param[in] TokenNumber The PCD token number to retrieve a current value for. @@ -1268,12 +1268,12 @@ LibPcdGetEx32 ( /** This function provides a means by which to retrieve a value for a given PCD token. - + Returns the 64-bit value for the token specified by TokenNumber and Guid. - - If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that designates + If Guid is NULL, then ASSERT(). + + @param[in] Guid Pointer to a 128-bit unique value that designates which namespace to retrieve a value from. @param[in] TokenNumber The PCD token number to retrieve a current value for. @@ -1290,12 +1290,12 @@ LibPcdGetEx64 ( /** This function provides a means by which to retrieve a value for a given PCD token. - + Returns the pointer to the buffer of token specified by TokenNumber and Guid. - - If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that designates + If Guid is NULL, then ASSERT(). + + @param[in] Guid Pointer to a 128-bit unique value that designates which namespace to retrieve a value from. @param[in] TokenNumber The PCD token number to retrieve a current value for. @@ -1312,12 +1312,12 @@ LibPcdGetExPtr ( /** This function provides a means by which to retrieve a value for a given PCD token. - - Returns the Boolean value of the token specified by TokenNumber and Guid. - - If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that designates + Returns the Boolean value of the token specified by TokenNumber and Guid. + + If Guid is NULL, then ASSERT(). + + @param[in] Guid Pointer to a 128-bit unique value that designates which namespace to retrieve a value from. @param[in] TokenNumber The PCD token number to retrieve a current value for. @@ -1334,12 +1334,12 @@ LibPcdGetExBool ( /** This function provides a means by which to retrieve the size of a given PCD token. - - Returns the size of the token specified by TokenNumber and Guid. - - If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that designates + Returns the size of the token specified by TokenNumber and Guid. + + If Guid is NULL, then ASSERT(). + + @param[in] Guid Pointer to a 128-bit unique value that designates which namespace to retrieve a value from. @param[in] TokenNumber The PCD token number to retrieve a current value for. @@ -1357,8 +1357,8 @@ LibPcdGetExSize ( #ifndef DISABLE_NEW_DEPRECATED_INTERFACES /** This function provides a means by which to set a value for a given PCD token. - - Sets the 8-bit value for the token specified by TokenNumber + + Sets the 8-bit value for the token specified by TokenNumber to the value specified by Value. Value is returned. @param[in] TokenNumber The PCD token number to set a current value for. @@ -1377,8 +1377,8 @@ LibPcdSet8 ( /** This function provides a means by which to set a value for a given PCD token. - - Sets the 16-bit value for the token specified by TokenNumber + + Sets the 16-bit value for the token specified by TokenNumber to the value specified by Value. Value is returned. @param[in] TokenNumber The PCD token number to set a current value for. @@ -1397,8 +1397,8 @@ LibPcdSet16 ( /** This function provides a means by which to set a value for a given PCD token. - - Sets the 32-bit value for the token specified by TokenNumber + + Sets the 32-bit value for the token specified by TokenNumber to the value specified by Value. Value is returned. @param[in] TokenNumber The PCD token number to set a current value for. @@ -1417,8 +1417,8 @@ LibPcdSet32 ( /** This function provides a means by which to set a value for a given PCD token. - - Sets the 64-bit value for the token specified by TokenNumber + + Sets the 64-bit value for the token specified by TokenNumber to the value specified by Value. Value is returned. @param[in] TokenNumber The PCD token number to set a current value for. @@ -1437,19 +1437,19 @@ LibPcdSet64 ( /** This function provides a means by which to set a value for a given PCD token. - - Sets a buffer for the token specified by TokenNumber to the value - specified by Buffer and SizeOfBuffer. Buffer is returned. - If SizeOfBuffer is greater than the maximum size support by TokenNumber, - then set SizeOfBuffer to the maximum size supported by TokenNumber and + + Sets a buffer for the token specified by TokenNumber to the value + specified by Buffer and SizeOfBuffer. Buffer is returned. + If SizeOfBuffer is greater than the maximum size support by TokenNumber, + then set SizeOfBuffer to the maximum size supported by TokenNumber and return NULL to indicate that the set operation was not actually performed. - If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the + If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the maximum size supported by TokenName and NULL must be returned. - + If SizeOfBuffer is NULL, then ASSERT(). If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT(). - + @param[in] TokenNumber The PCD token number to set a current value for. @param[in, out] SizeOfBuffer The size, in bytes, of Buffer. @param[in] Buffer A pointer to the buffer to set. @@ -1468,8 +1468,8 @@ LibPcdSetPtr ( /** This function provides a means by which to set a value for a given PCD token. - - Sets the Boolean value for the token specified by TokenNumber + + Sets the Boolean value for the token specified by TokenNumber to the value specified by Value. Value is returned. @param[in] TokenNumber The PCD token number to set a current value for. @@ -1488,13 +1488,13 @@ LibPcdSetBool ( /** This function provides a means by which to set a value for a given PCD token. - - Sets the 8-bit value for the token specified by TokenNumber and + + Sets the 8-bit value for the token specified by TokenNumber and Guid to the value specified by Value. Value is returned. If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that + @param[in] Guid Pointer to a 128-bit unique value that designates which namespace to set a value from. @param[in] TokenNumber The PCD token number to set a current value for. @param[in] Value The 8-bit value to set. @@ -1513,13 +1513,13 @@ LibPcdSetEx8 ( /** This function provides a means by which to set a value for a given PCD token. - - Sets the 16-bit value for the token specified by TokenNumber and + + Sets the 16-bit value for the token specified by TokenNumber and Guid to the value specified by Value. Value is returned. If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that + @param[in] Guid Pointer to a 128-bit unique value that designates which namespace to set a value from. @param[in] TokenNumber The PCD token number to set a current value for. @param[in] Value The 16-bit value to set. @@ -1538,13 +1538,13 @@ LibPcdSetEx16 ( /** This function provides a means by which to set a value for a given PCD token. - - Sets the 32-bit value for the token specified by TokenNumber and + + Sets the 32-bit value for the token specified by TokenNumber and Guid to the value specified by Value. Value is returned. If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that + @param[in] Guid Pointer to a 128-bit unique value that designates which namespace to set a value from. @param[in] TokenNumber The PCD token number to set a current value for. @param[in] Value The 32-bit value to set. @@ -1563,13 +1563,13 @@ LibPcdSetEx32 ( /** This function provides a means by which to set a value for a given PCD token. - - Sets the 64-bit value for the token specified by TokenNumber and + + Sets the 64-bit value for the token specified by TokenNumber and Guid to the value specified by Value. Value is returned. If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that + @param[in] Guid Pointer to a 128-bit unique value that designates which namespace to set a value from. @param[in] TokenNumber The PCD token number to set a current value for. @param[in] Value The 64-bit value to set. @@ -1588,18 +1588,18 @@ LibPcdSetEx64 ( /** This function provides a means by which to set a value for a given PCD token. - - Sets a buffer for the token specified by TokenNumber to the value specified by - Buffer and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than - the maximum size support by TokenNumber, then set SizeOfBuffer to the maximum size - supported by TokenNumber and return NULL to indicate that the set operation + + Sets a buffer for the token specified by TokenNumber to the value specified by + Buffer and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than + the maximum size support by TokenNumber, then set SizeOfBuffer to the maximum size + supported by TokenNumber and return NULL to indicate that the set operation was not actually performed. - + If Guid is NULL, then ASSERT(). If SizeOfBuffer is NULL, then ASSERT(). If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT(). - - @param[in] Guid Pointer to a 128-bit unique value that + + @param[in] Guid Pointer to a 128-bit unique value that designates which namespace to set a value from. @param[in] TokenNumber The PCD token number to set a current value for. @param[in, out] SizeOfBuffer The size, in bytes, of Buffer. @@ -1620,13 +1620,13 @@ LibPcdSetExPtr ( /** This function provides a means by which to set a value for a given PCD token. - - Sets the Boolean value for the token specified by TokenNumber and + + Sets the Boolean value for the token specified by TokenNumber and Guid to the value specified by Value. Value is returned. If Guid is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that + @param[in] Guid Pointer to a 128-bit unique value that designates which namespace to set a value from. @param[in] TokenNumber The PCD token number to set a current value for. @param[in] Value The Boolean value to set. @@ -1927,7 +1927,7 @@ LibPcdSetExBoolS ( Secondly, it provides a mechanism for the module that did the registration to intercept the set operation and override the value been set if necessary. After the invocation of the callback function, TokenData will be used by PCD service PEIM or driver to modify th - internal data in PCD database. + internal data in PCD database. @param[in] CallBackGuid The PCD token GUID being set. @param[in] CallBackToken The PCD token number being set. @@ -1947,17 +1947,17 @@ VOID /** Set up a notification function that is called when a specified token is set. - - When the token specified by TokenNumber and Guid is set, - then notification function specified by NotificationFunction is called. + + When the token specified by TokenNumber and Guid is set, + then notification function specified by NotificationFunction is called. If Guid is NULL, then the default token space is used. If NotificationFunction is NULL, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that designates which - namespace to set a value from. If NULL, then the default + @param[in] Guid Pointer to a 128-bit unique value that designates which + namespace to set a value from. If NULL, then the default token space is used. @param[in] TokenNumber The PCD token number to monitor. - @param[in] NotificationFunction The function to call when the token + @param[in] NotificationFunction The function to call when the token specified by Guid and TokenNumber is set. **/ @@ -1972,12 +1972,12 @@ LibPcdCallbackOnSet ( /** Disable a notification function that was established with LibPcdCallbackonSet(). - + Disable a notification function that was previously established with LibPcdCallbackOnSet(). If NotificationFunction is NULL, then ASSERT(). - If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber, + If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber, and NotificationFunction, then ASSERT(). - + @param[in] Guid Specify the GUID token space. @param[in] TokenNumber Specify the token number. @param[in] NotificationFunction The callback function to be unregistered. @@ -1994,24 +1994,24 @@ LibPcdCancelCallback ( /** Retrieves the next token in a token space. - - Retrieves the next PCD token number from the token space specified by Guid. - If Guid is NULL, then the default token space is used. If TokenNumber is 0, - then the first token number is returned. Otherwise, the token number that - follows TokenNumber in the token space is returned. If TokenNumber is the last - token number in the token space, then 0 is returned. - + + Retrieves the next PCD token number from the token space specified by Guid. + If Guid is NULL, then the default token space is used. If TokenNumber is 0, + then the first token number is returned. Otherwise, the token number that + follows TokenNumber in the token space is returned. If TokenNumber is the last + token number in the token space, then 0 is returned. + If TokenNumber is not 0 and is not in the token space specified by Guid, then ASSERT(). - @param[in] Guid Pointer to a 128-bit unique value that designates which namespace + @param[in] Guid Pointer to a 128-bit unique value that designates which namespace to set a value from. If NULL, then the default token space is used. - @param[in] TokenNumber The previous PCD token number. If 0, then retrieves the first PCD + @param[in] TokenNumber The previous PCD token number. If 0, then retrieves the first PCD token number. @return The next valid token number. **/ -UINTN +UINTN EFIAPI LibPcdGetNextToken ( IN CONST GUID *Guid, OPTIONAL @@ -2022,12 +2022,12 @@ LibPcdGetNextToken ( /** Used to retrieve the list of available PCD token space GUIDs. - + Returns the PCD token space GUID that follows TokenSpaceGuid in the list of token spaces in the platform. If TokenSpaceGuid is NULL, then a pointer to the first PCD token spaces returned. If TokenSpaceGuid is the last PCD token space GUID in the list, then NULL is returned. - + @param TokenSpaceGuid Pointer to the a PCD token space GUID @return The next valid token namespace. @@ -2042,24 +2042,24 @@ LibPcdGetNextTokenSpace ( /** Sets a value of a patchable PCD entry that is type pointer. - - Sets the PCD entry specified by PatchVariable to the value specified by Buffer - and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than - MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return - NULL to indicate that the set operation was not actually performed. - If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to + + Sets the PCD entry specified by PatchVariable to the value specified by Buffer + and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than + MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return + NULL to indicate that the set operation was not actually performed. + If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to MaximumDatumSize and NULL must be returned. - + If PatchVariable is NULL, then ASSERT(). If SizeOfBuffer is NULL, then ASSERT(). If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT(). - @param[out] PatchVariable A pointer to the global variable in a module that is + @param[out] PatchVariable A pointer to the global variable in a module that is the target of the set operation. @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable. @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer. @param[in] Buffer A pointer to the buffer to used to set the target variable. - + @return Return the pointer to the Buffer that was set. **/ @@ -2091,7 +2091,7 @@ LibPatchPcdSetPtr ( @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable. @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer. @param[in] Buffer A pointer to the buffer to used to set the target variable. - + @return The status of the set operation. **/ @@ -2106,26 +2106,26 @@ LibPatchPcdSetPtrS ( /** Sets a value and size of a patchable PCD entry that is type pointer. - - Sets the PCD entry specified by PatchVariable to the value specified by Buffer - and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than - MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return - NULL to indicate that the set operation was not actually performed. - If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to + + Sets the PCD entry specified by PatchVariable to the value specified by Buffer + and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than + MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return + NULL to indicate that the set operation was not actually performed. + If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to MaximumDatumSize and NULL must be returned. - + If PatchVariable is NULL, then ASSERT(). If SizeOfPatchVariable is NULL, then ASSERT(). If SizeOfBuffer is NULL, then ASSERT(). If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT(). - @param[out] PatchVariable A pointer to the global variable in a module that is + @param[out] PatchVariable A pointer to the global variable in a module that is the target of the set operation. @param[out] SizeOfPatchVariable A pointer to the size, in bytes, of PatchVariable. @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable. @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer. @param[in] Buffer A pointer to the buffer to used to set the target variable. - + @return Return the pointer to the Buffer that was set. **/ @@ -2160,7 +2160,7 @@ LibPatchPcdSetPtrAndSize ( @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable. @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer. @param[in] Buffer A pointer to the buffer to used to set the target variable. - + @return The status of the set operation. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PciCf8Lib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PciCf8Lib.h index d77f406ebd..9f3795076a 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PciCf8Lib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PciCf8Lib.h @@ -1,8 +1,8 @@ /** @file Provides services to access PCI Configuration Space using the I/O ports 0xCF8 and 0xCFC. - - This library is identical to the PCI Library, except the access method for performing PCI - configuration cycles must be through I/O ports 0xCF8 and 0xCFC. This library only allows + + This library is identical to the PCI Library, except the access method for performing PCI + configuration cycles must be through I/O ports 0xCF8 and 0xCFC. This library only allows access to PCI Segment #0. Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR> @@ -40,20 +40,20 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. (((Offset) & 0xfff) | (((Function) & 0x07) << 12) | (((Device) & 0x1f) << 15) | (((Bus) & 0xff) << 20)) /** - Registers a PCI device so PCI configuration registers may be accessed after + Registers a PCI device so PCI configuration registers may be accessed after SetVirtualAddressMap(). - - Registers the PCI device specified by Address so all the PCI configuration registers + + Registers the PCI device specified by Address so all the PCI configuration registers associated with that PCI device may be accessed after SetVirtualAddressMap() is called. - + If Address > 0x0FFFFFFF, then ASSERT(). If the register specified by Address >= 0x100, then ASSERT(). @param Address Address that encodes the PCI Bus, Device, Function and Register. - + @retval RETURN_SUCCESS The PCI device was registered for runtime access. - @retval RETURN_UNSUPPORTED An attempt was made to call this function + @retval RETURN_UNSUPPORTED An attempt was made to call this function after ExitBootServices(). @retval RETURN_UNSUPPORTED The resources required to access the PCI device at runtime could not be mapped. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PciExpressLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PciExpressLib.h index 445677f72f..7fa5e763d6 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PciExpressLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PciExpressLib.h @@ -1,7 +1,7 @@ /** @file Provides services to access PCI Configuration Space using the MMIO PCI Express window. - - This library is identical to the PCI Library, except the access method for performing PCI + + This library is identical to the PCI Library, except the access method for performing PCI configuration cycles must be through the 256 MB PCI Express MMIO window whose base address is defined by PcdPciExpressBaseAddress. @@ -40,20 +40,20 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define PCI_EXPRESS_LIB_ADDRESS(Bus,Device,Function,Offset) PCI_ECAM_ADDRESS ((Bus), (Device), (Function), (Offset)) /** - Registers a PCI device so PCI configuration registers may be accessed after + Registers a PCI device so PCI configuration registers may be accessed after SetVirtualAddressMap(). - - Registers the PCI device specified by Address so all the PCI configuration - registers associated with that PCI device may be accessed after SetVirtualAddressMap() + + Registers the PCI device specified by Address so all the PCI configuration + registers associated with that PCI device may be accessed after SetVirtualAddressMap() is called. - + If Address > 0x0FFFFFFF, then ASSERT(). @param Address Address that encodes the PCI Bus, Device, Function and Register. - + @retval RETURN_SUCCESS The PCI device was registered for runtime access. - @retval RETURN_UNSUPPORTED An attempt was made to call this function + @retval RETURN_UNSUPPORTED An attempt was made to call this function after ExitBootServices(). @retval RETURN_UNSUPPORTED The resources required to access the PCI device at runtime could not be mapped. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PciLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PciLib.h index 1b1de2904d..33246a1ba7 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PciLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PciLib.h @@ -1,13 +1,13 @@ /** @file Provides services to access PCI Configuration Space. - - These functions perform PCI configuration cycles using the default PCI configuration - access method. This may use I/O ports 0xCF8 and 0xCFC to perform PCI configuration accesses, - or it may use MMIO registers relative to the PcdPciExpressBaseAddress, or it may use some - alternate access method. Modules will typically use the PCI Library for its PCI configuration - accesses. However, if a module requires a mix of PCI access methods, the PCI CF8 Library or - PCI Express Library may be used in conjunction with the PCI Library. The functionality of - these three libraries is identical. The PCI CF8 Library and PCI Express Library simply use + + These functions perform PCI configuration cycles using the default PCI configuration + access method. This may use I/O ports 0xCF8 and 0xCFC to perform PCI configuration accesses, + or it may use MMIO registers relative to the PcdPciExpressBaseAddress, or it may use some + alternate access method. Modules will typically use the PCI Library for its PCI configuration + accesses. However, if a module requires a mix of PCI access methods, the PCI CF8 Library or + PCI Express Library may be used in conjunction with the PCI Library. The functionality of + these three libraries is identical. The PCI CF8 Library and PCI Express Library simply use explicit access methods. Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR> @@ -41,19 +41,19 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. (((Register) & 0xfff) | (((Function) & 0x07) << 12) | (((Device) & 0x1f) << 15) | (((Bus) & 0xff) << 20)) /** - Registers a PCI device so PCI configuration registers may be accessed after + Registers a PCI device so PCI configuration registers may be accessed after SetVirtualAddressMap(). - - Registers the PCI device specified by Address so all the PCI configuration registers + + Registers the PCI device specified by Address so all the PCI configuration registers associated with that PCI device may be accessed after SetVirtualAddressMap() is called. - + If Address > 0x0FFFFFFF, then ASSERT(). @param Address Address that encodes the PCI Bus, Device, Function and Register. - + @retval RETURN_SUCCESS The PCI device was registered for runtime access. - @retval RETURN_UNSUPPORTED An attempt was made to call this function + @retval RETURN_UNSUPPORTED An attempt was made to call this function after ExitBootServices(). @retval RETURN_UNSUPPORTED The resources required to access the PCI device at runtime could not be mapped. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PciSegmentLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PciSegmentLib.h index b1e5301925..a1fc7a1fa6 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PciSegmentLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PciSegmentLib.h @@ -1,11 +1,11 @@ /** @file Provides services to access PCI Configuration Space on a platform with multiple PCI segments. - + The PCI Segment Library function provide services to read, write, and modify the PCI configuration - registers on PCI root bridges on any supported PCI segment. These library services take a single - address parameter that encodes the PCI Segment, PCI Bus, PCI Device, PCI Function, and PCI Register. + registers on PCI root bridges on any supported PCI segment. These library services take a single + address parameter that encodes the PCI Segment, PCI Bus, PCI Device, PCI Function, and PCI Register. The layout of this address parameter is as follows: - + PCI Register: Bits 0..11 PCI Function Bits 12..14 PCI Device Bits 15..19 @@ -13,15 +13,15 @@ Reserved Bits 28..31. Must be 0. PCI Segment Bits 32..47 Reserved Bits 48..63. Must be 0. - + | Reserved (MBZ) | Segment | Reserved (MBZ) | Bus | Device | Function | Register | 63 48 47 32 31 28 27 20 19 15 14 12 11 0 - These functions perform PCI configuration cycles using the default PCI configuration access - method. This may use I/O ports 0xCF8 and 0xCFC to perform PCI configuration accesses, or it - may use MMIO registers relative to the PcdPciExpressBaseAddress, or it may use some alternate - access method. Modules will typically use the PCI Segment Library for its PCI configuration - accesses when PCI Segments other than Segment #0 must be accessed. + These functions perform PCI configuration cycles using the default PCI configuration access + method. This may use I/O ports 0xCF8 and 0xCFC to perform PCI configuration accesses, or it + may use MMIO registers relative to the PcdPciExpressBaseAddress, or it may use some alternate + access method. Modules will typically use the PCI Segment Library for its PCI configuration + accesses when PCI Segments other than Segment #0 must be accessed. Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR> This program and the accompanying materials @@ -71,16 +71,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. ) /** - Register a PCI device so PCI configuration registers may be accessed after + Register a PCI device so PCI configuration registers may be accessed after SetVirtualAddressMap(). - + If any reserved bits in Address are set, then ASSERT(). @param Address Address that encodes the PCI Bus, Device, Function and Register. - + @retval RETURN_SUCCESS The PCI device was registered for runtime access. - @retval RETURN_UNSUPPORTED An attempt was made to call this function + @retval RETURN_UNSUPPORTED An attempt was made to call this function after ExitBootServices(). @retval RETURN_UNSUPPORTED The resources required to access the PCI device at runtime could not be mapped. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeCoffExtraActionLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeCoffExtraActionLib.h index 1b73fc184e..229339e03d 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeCoffExtraActionLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeCoffExtraActionLib.h @@ -1,6 +1,6 @@ /** @file Provides services to perform additional actions when a PE/COFF image is loaded - or unloaded. This is useful for environment where symbols need to be loaded + or unloaded. This is useful for environment where symbols need to be loaded and unloaded to support source level debugging. Copyright (c) 2009, Intel Corporation. All rights reserved.<BR> @@ -37,9 +37,9 @@ PeCoffLoaderRelocateImageExtraAction ( /** Performs additional actions just before a PE/COFF image is unloaded. Any resources that were allocated by PeCoffLoaderRelocateImageExtraAction() must be freed. - + If ImageContext is NULL, then ASSERT(). - + @param ImageContext Pointer to the image context structure that describes the PE/COFF image that is being unloaded. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeCoffGetEntryPointLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeCoffGetEntryPointLib.h index 9ba1732f5b..b120c361da 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeCoffGetEntryPointLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeCoffGetEntryPointLib.h @@ -2,13 +2,13 @@ Provides a service to retrieve the PE/COFF entry point from a PE/COFF image. Copyright (c) 2006 - 2017, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that 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. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -59,7 +59,7 @@ PeCoffLoaderGetMachineType ( /** Returns a pointer to the PDB file name for a PE/COFF image that has been - loaded into system memory with the PE/COFF Loader Library functions. + loaded into system memory with the PE/COFF Loader Library functions. Returns the PDB file name for the PE/COFF image specified by Pe32Data. If the PE/COFF image specified by Pe32Data is not a valid, then NULL is diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeCoffLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeCoffLib.h index 78b8b10dde..5ea4a668c4 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeCoffLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeCoffLib.h @@ -2,17 +2,17 @@ Provides services to load and relocate a PE/COFF image. The PE/COFF Loader Library abstracts the implementation of a PE/COFF loader for - IA-32, x86, IPF, and EBC processor types. The library functions are memory-based + IA-32, x86, IPF, and EBC processor types. The library functions are memory-based and can be ported easily to any environment. - + Copyright (c) 2006 - 2012, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that 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. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -24,7 +24,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. // Return status codes from the PE/COFF Loader services // #define IMAGE_ERROR_SUCCESS 0 -#define IMAGE_ERROR_IMAGE_READ 1 +#define IMAGE_ERROR_IMAGE_READ 1 #define IMAGE_ERROR_INVALID_PE_HEADER_SIGNATURE 2 #define IMAGE_ERROR_INVALID_MACHINE_TYPE 3 #define IMAGE_ERROR_INVALID_SUBSYSTEM 4 @@ -39,30 +39,30 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** Reads contents of a PE/COFF image. - A function of this type reads contents of the PE/COFF image specified by FileHandle. The read - operation copies ReadSize bytes from the PE/COFF image starting at byte offset FileOffset into - the buffer specified by Buffer. The size of the buffer actually read is returned in ReadSize. + A function of this type reads contents of the PE/COFF image specified by FileHandle. The read + operation copies ReadSize bytes from the PE/COFF image starting at byte offset FileOffset into + the buffer specified by Buffer. The size of the buffer actually read is returned in ReadSize. If FileOffset specifies an offset past the end of the PE/COFF image, a ReadSize of 0 is returned. - A function of this type must be registered in the ImageRead field of a PE_COFF_LOADER_IMAGE_CONTEXT - structure for the PE/COFF Loader Library service to function correctly. This function abstracts access - to a PE/COFF image so it can be implemented in an environment specific manner. For example, SEC and PEI - environments may access memory directly to read the contents of a PE/COFF image, and DXE or UEFI - environments may require protocol services to read the contents of PE/COFF image + A function of this type must be registered in the ImageRead field of a PE_COFF_LOADER_IMAGE_CONTEXT + structure for the PE/COFF Loader Library service to function correctly. This function abstracts access + to a PE/COFF image so it can be implemented in an environment specific manner. For example, SEC and PEI + environments may access memory directly to read the contents of a PE/COFF image, and DXE or UEFI + environments may require protocol services to read the contents of PE/COFF image stored on FLASH, disk, or network devices. - + If FileHandle is not a valid handle, then ASSERT(). If ReadSize is NULL, then ASSERT(). If Buffer is NULL, then ASSERT(). @param FileHandle Pointer to the file handle to read the PE/COFF image. @param FileOffset Offset into the PE/COFF image to begin the read operation. - @param ReadSize On input, the size in bytes of the requested read operation. + @param ReadSize On input, the size in bytes of the requested read operation. On output, the number of bytes actually read. @param Buffer Output buffer that contains the data read from the PE/COFF image. - - @retval RETURN_SUCCESS The specified portion of the PE/COFF image was + + @retval RETURN_SUCCESS The specified portion of the PE/COFF image was read and the size return in ReadSize. - @retval RETURN_DEVICE_ERROR The specified portion of the PE/COFF image + @retval RETURN_DEVICE_ERROR The specified portion of the PE/COFF image could not be read due to a device error. **/ @@ -110,8 +110,8 @@ typedef struct { VOID *Handle; /// /// Caller allocated buffer of size FixupDataSize that can be optionally allocated - /// prior to calling PeCoffLoaderRelocateImage(). - /// This buffer is filled with the information used to fix up the image. + /// prior to calling PeCoffLoaderRelocateImage(). + /// This buffer is filled with the information used to fix up the image. /// The fixups have been applied to the image and this entry is just for information. /// VOID *FixupData; @@ -122,7 +122,7 @@ typedef struct { UINT32 SectionAlignment; /// /// Set by PeCoffLoaderGetImageInfo() to offset to the PE/COFF header. - /// If the PE/COFF image does not start with a DOS header, this value is zero. + /// If the PE/COFF image does not start with a DOS header, this value is zero. /// Otherwise, it's the offset to the PE/COFF header. /// UINT32 PeCoffHeaderOffset; @@ -137,7 +137,7 @@ typedef struct { VOID *CodeView; /// /// Set by PeCoffLoaderLoadImage() to point to the PDB entry contained in the CodeView area. - /// The PdbPointer points to the filename of the PDB file used for source-level debug of + /// The PdbPointer points to the filename of the PDB file used for source-level debug of /// the image by a debugger. /// CHAR8 *PdbPointer; @@ -147,20 +147,20 @@ typedef struct { UINTN SizeOfHeaders; /// /// Not used by this library class. Other library classes that layer on top of this library - /// class fill in this value as part of their GetImageInfo call. + /// class fill in this value as part of their GetImageInfo call. /// This allows the caller of the library to know what type of memory needs to be allocated /// to load and relocate the image. /// UINT32 ImageCodeMemoryType; /// - /// Not used by this library class. Other library classes that layer on top of this library + /// Not used by this library class. Other library classes that layer on top of this library /// class fill in this value as part of their GetImageInfo call. /// This allows the caller of the library to know what type of memory needs to be allocated /// to load and relocate the image. /// UINT32 ImageDataMemoryType; /// - /// Set by any of the library functions if they encounter an error. + /// Set by any of the library functions if they encounter an error. /// UINT32 ImageError; /// @@ -182,7 +182,7 @@ typedef struct { /// BOOLEAN RelocationsStripped; /// - /// Set by PeCoffLoaderGetImageInfo() to TRUE if the image is a TE image. + /// Set by PeCoffLoaderGetImageInfo() to TRUE if the image is a TE image. /// For a definition of the TE Image format, see the Platform Initialization Pre-EFI /// Initialization Core Interface Specification. /// @@ -194,28 +194,28 @@ typedef struct { /// PHYSICAL_ADDRESS HiiResourceData; /// - /// Private storage for implementation specific data. + /// Private storage for implementation specific data. /// - UINT64 Context; + UINT64 Context; } PE_COFF_LOADER_IMAGE_CONTEXT; /** Retrieves information about a PE/COFF image. - Computes the PeCoffHeaderOffset, IsTeImage, ImageType, ImageAddress, ImageSize, - DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and - DebugDirectoryEntryRva fields of the ImageContext structure. - If ImageContext is NULL, then return RETURN_INVALID_PARAMETER. - If the PE/COFF image accessed through the ImageRead service in the ImageContext - structure is not a supported PE/COFF image type, then return RETURN_UNSUPPORTED. - If any errors occur while computing the fields of ImageContext, - then the error status is returned in the ImageError field of ImageContext. + Computes the PeCoffHeaderOffset, IsTeImage, ImageType, ImageAddress, ImageSize, + DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and + DebugDirectoryEntryRva fields of the ImageContext structure. + If ImageContext is NULL, then return RETURN_INVALID_PARAMETER. + If the PE/COFF image accessed through the ImageRead service in the ImageContext + structure is not a supported PE/COFF image type, then return RETURN_UNSUPPORTED. + If any errors occur while computing the fields of ImageContext, + then the error status is returned in the ImageError field of ImageContext. If the image is a TE image, then SectionAlignment is set to 0. - The ImageRead and Handle fields of ImageContext structure must be valid prior + The ImageRead and Handle fields of ImageContext structure must be valid prior to invoking this service. - @param ImageContext The pointer to the image context structure that - describes the PE/COFF image that needs to be + @param ImageContext The pointer to the image context structure that + describes the PE/COFF image that needs to be examined by this function. @retval RETURN_SUCCESS The information on the PE/COFF image was collected. @@ -236,12 +236,12 @@ PeCoffLoaderGetImageInfo ( ImageContext as the relocation base address. Otherwise, use the DestinationAddress field of ImageContext as the relocation base address. The caller must allocate the relocation fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function. - - The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, - ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, - DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of + + The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, + ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, + DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of the ImageContext structure must be valid prior to invoking this service. - + If ImageContext is NULL, then ASSERT(). Note that if the platform does not maintain coherency between the instruction cache(s) and the data @@ -272,10 +272,10 @@ PeCoffLoaderRelocateImage ( specified by the ImageAddress and ImageSize fields of ImageContext. The caller must allocate the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function. The EntryPoint, FixupDataSize, CodeView, PdbPointer and HiiResourceData fields of ImageContext are computed. - The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, ImageSize, - DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva + The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, ImageSize, + DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva fields of the ImageContext structure must be valid prior to invoking this service. - + If ImageContext is NULL, then ASSERT(). Note that if the platform does not maintain coherency between the instruction cache(s) and the data @@ -305,25 +305,25 @@ PeCoffLoaderLoadImage ( /** Reads contents of a PE/COFF image from a buffer in system memory. - - This is the default implementation of a PE_COFF_LOADER_READ_FILE function - that assumes FileHandle pointer to the beginning of a PE/COFF image. - This function reads contents of the PE/COFF image that starts at the system memory - address specified by FileHandle. The read operation copies ReadSize bytes from the - PE/COFF image starting at byte offset FileOffset into the buffer specified by Buffer. + + This is the default implementation of a PE_COFF_LOADER_READ_FILE function + that assumes FileHandle pointer to the beginning of a PE/COFF image. + This function reads contents of the PE/COFF image that starts at the system memory + address specified by FileHandle. The read operation copies ReadSize bytes from the + PE/COFF image starting at byte offset FileOffset into the buffer specified by Buffer. The size of the buffer actually read is returned in ReadSize. - + If FileHandle is NULL, then ASSERT(). If ReadSize is NULL, then ASSERT(). If Buffer is NULL, then ASSERT(). @param FileHandle The pointer to base of the input stream @param FileOffset Offset into the PE/COFF image to begin the read operation. - @param ReadSize On input, the size in bytes of the requested read operation. + @param ReadSize On input, the size in bytes of the requested read operation. On output, the number of bytes actually read. @param Buffer Output buffer that contains the data read from the PE/COFF image. - @retval RETURN_SUCCESS The data is read from FileOffset from the Handle into + @retval RETURN_SUCCESS The data is read from FileOffset from the Handle into the buffer. **/ RETURN_STATUS @@ -338,26 +338,26 @@ PeCoffLoaderImageReadFromMemory ( /** Reapply fixups on a fixed up PE32/PE32+ image to allow virtual calling at EFI - runtime. - - This function reapplies relocation fixups to the PE/COFF image specified by ImageBase - and ImageSize so the image will execute correctly when the PE/COFF image is mapped - to the address specified by VirtualImageBase. RelocationData must be identical - to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure + runtime. + + This function reapplies relocation fixups to the PE/COFF image specified by ImageBase + and ImageSize so the image will execute correctly when the PE/COFF image is mapped + to the address specified by VirtualImageBase. RelocationData must be identical + to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure after this PE/COFF image was relocated with PeCoffLoaderRelocateImage(). Note that if the platform does not maintain coherency between the instruction cache(s) and the data cache(s) in hardware, then the caller is responsible for performing cache maintenance operations prior to transferring control to a PE/COFF image that is loaded using this library. - @param ImageBase The base address of a PE/COFF image that has been loaded + @param ImageBase The base address of a PE/COFF image that has been loaded and relocated into system memory. @param VirtImageBase The request virtual address that the PE/COFF image is to be fixed up for. @param ImageSize The size, in bytes, of the PE/COFF image. - @param RelocationData A pointer to the relocation data that was collected when the PE/COFF + @param RelocationData A pointer to the relocation data that was collected when the PE/COFF image was relocated using PeCoffLoaderRelocateImage(). - + **/ VOID EFIAPI @@ -370,15 +370,15 @@ PeCoffLoaderRelocateImageForRuntime ( /** Unloads a loaded PE/COFF image from memory and releases its taken resource. - Releases any environment specific resources that were allocated when the image - specified by ImageContext was loaded using PeCoffLoaderLoadImage(). - + Releases any environment specific resources that were allocated when the image + specified by ImageContext was loaded using PeCoffLoaderLoadImage(). + For NT32 emulator, the PE/COFF image loaded by system needs to release. - For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded, + For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded, this function can simply return RETURN_SUCCESS. - + If ImageContext is NULL, then ASSERT(). - + @param ImageContext Pointer to the image context structure that describes the PE/COFF image to be unloaded. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeiCoreEntryPoint.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeiCoreEntryPoint.h index 11c68bae67..fd8e1f6ba1 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeiCoreEntryPoint.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeiCoreEntryPoint.h @@ -34,7 +34,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @param SecCoreData Points to a data structure containing information about the PEI core's operating environment, such as the size and location of - temporary RAM, the stack location and the BFV location. + temporary RAM, the stack location and the BFV location. @param PpiList Points to a list of one or more PPI descriptors to be installed initially by the PEI core. An empty PPI list consists of a single @@ -46,7 +46,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ VOID -EFIAPI +EFIAPI _ModuleEntryPoint( IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData, IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList @@ -59,7 +59,7 @@ _ModuleEntryPoint( @param SecCoreData Points to a data structure containing information about the PEI core's operating environment, such as the size and location of temporary RAM, - the stack location and the BFV location. + the stack location and the BFV location. @param PpiList Points to a list of one or more PPI descriptors to be installed initially by the PEI core. An empty PPI list consists of a single @@ -84,7 +84,7 @@ EfiMain ( This function must be called by the PEI Core once an initial PEI Services Table has been established. This function calls the set of library constructors for the set of library instances that a module depends on. This include library instances that a module depends on directly and library - instances that a module depends on indirectly through other libraries. + instances that a module depends on indirectly through other libraries. This function is autogenerated by build tools and those build tools are responsible for collecting the set of library instances, determining which ones have constructors, and calling the library constructors in the proper order based upon the dependencies of each of the library instances. @@ -107,13 +107,13 @@ ProcessLibraryConstructorList ( Autogenerated function that calls a set of module entry points. This function must be called by _ModuleEntryPoint(). - This function calls the set of module entry points. + This function calls the set of module entry points. This function is autogenerated by build tools and those build tools are responsible for collecting the module entry points and calling them in a specified order. @param SecCoreData Points to a data structure containing information about the PEI core's operating environment, such as the size and location of - temporary RAM, the stack location and the BFV location. + temporary RAM, the stack location and the BFV location. @param PpiList Points to a list of one or more PPI descriptors to be installed initially by the PEI core. An empty PPI list consists of a single @@ -121,7 +121,7 @@ ProcessLibraryConstructorList ( As part of its initialization phase, the PEI Foundation will add these SEC-hosted PPIs to its PPI database such that both the PEI Foundation and any modules can leverage the associated service calls - and/or code in these early PPIs. + and/or code in these early PPIs. @param Context A pointer to a private context structure defined by the PEI Core implementation. The implementation of _ModuleEntryPoint() must set this parameter is NULL to indicate that this is the first PEI phase. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeiServicesLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeiServicesLib.h index 4593f5c825..295623b1e4 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeiServicesLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeiServicesLib.h @@ -225,7 +225,7 @@ PeiServicesFfsFindSectionData ( @param SectionType The value of the section type to find. @param SectionInstance Section instance to find. - @param FileHandle A pointer to the file header that contains the set + @param FileHandle A pointer to the file header that contains the set of sections to be searched. @param SectionData A pointer to the discovered section, if successful. @param AuthenticationStatus A pointer to the authentication status for this section. @@ -337,9 +337,9 @@ PeiServicesResetSystem ( /** - This service is a wrapper for the PEI Service FfsFindByName(), except the pointer to the PEI Services - Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface - Specification for details. + This service is a wrapper for the PEI Service FfsFindByName(), except the pointer to the PEI Services + Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface + Specification for details. @param FileName A pointer to the name of the file to find within the firmware volume. @@ -347,7 +347,7 @@ PeiServicesResetSystem ( @param VolumeHandle The firmware volume to search FileHandle Upon exit, points to the found file's handle or NULL if it could not be found. - @param FileHandle Pointer to found file handle + @param FileHandle Pointer to found file handle @retval EFI_SUCCESS File was found. @@ -367,9 +367,9 @@ PeiServicesFfsFindFileByName ( /** - This service is a wrapper for the PEI Service FfsGetFileInfo(), except the pointer to the PEI Services - Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface - Specification for details. + This service is a wrapper for the PEI Service FfsGetFileInfo(), except the pointer to the PEI Services + Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface + Specification for details. @param FileHandle Handle of the file. @@ -377,15 +377,15 @@ PeiServicesFfsFindFileByName ( information. @retval EFI_SUCCESS File information returned. - + @retval EFI_INVALID_PARAMETER If FileHandle does not represent a valid file. - + @retval EFI_INVALID_PARAMETER If FileInfo is NULL. - + **/ EFI_STATUS -EFIAPI +EFIAPI PeiServicesFfsGetFileInfo ( IN CONST EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_FV_FILE_INFO *FileInfo @@ -402,12 +402,12 @@ PeiServicesFfsGetFileInfo ( information. @retval EFI_SUCCESS File information returned. - + @retval EFI_INVALID_PARAMETER If FileHandle does not represent a valid file. - + @retval EFI_INVALID_PARAMETER If FileInfo is NULL. - + **/ EFI_STATUS EFIAPI @@ -417,9 +417,9 @@ PeiServicesFfsGetFileInfo2 ( ); /** - This service is a wrapper for the PEI Service FfsGetVolumeInfo(), except the pointer to the PEI Services - Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface - Specification for details. + This service is a wrapper for the PEI Service FfsGetVolumeInfo(), except the pointer to the PEI Services + Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface + Specification for details. @param VolumeHandle Handle of the volume. @@ -427,10 +427,10 @@ PeiServicesFfsGetFileInfo2 ( information. @retval EFI_SUCCESS File information returned. - + @retval EFI_INVALID_PARAMETER If FileHandle does not represent a valid file. - + @retval EFI_INVALID_PARAMETER If FileInfo is NULL. **/ @@ -443,13 +443,13 @@ PeiServicesFfsGetVolumeInfo ( /** - This service is a wrapper for the PEI Service RegisterForShadow(), except the pointer to the PEI Services - Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface - Specification for details. + This service is a wrapper for the PEI Service RegisterForShadow(), except the pointer to the PEI Services + Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface + Specification for details. @param FileHandle PEIM's file handle. Must be the currently executing PEIM. - + @retval EFI_SUCCESS The PEIM was successfully registered for shadowing. @@ -467,25 +467,25 @@ PeiServicesRegisterForShadow ( /** Install a EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance so the PEI Core will be notified about a new firmware volume. - - This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO_PPI using + + This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO_PPI using the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance. If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO_PPI, then ASSERT(). If the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI can not be installed, then ASSERT(). - + @param FvFormat Unique identifier of the format of the memory-mapped firmware volume. - This parameter is optional and may be NULL. + This parameter is optional and may be NULL. If NULL is specified, the EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed. - @param FvInfo Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume. - The format of this buffer is specific to the FvFormat. For memory-mapped firmware volumes, + @param FvInfo Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume. + The format of this buffer is specific to the FvFormat. For memory-mapped firmware volumes, this typically points to the first byte of the firmware volume. - @param FvInfoSize The size, in bytes, of FvInfo. For memory-mapped firmware volumes, + @param FvInfoSize The size, in bytes, of FvInfo. For memory-mapped firmware volumes, this is typically the size of the firmware volume. - @param ParentFvName If the new firmware volume originated from a file in a different firmware volume, + @param ParentFvName If the new firmware volume originated from a file in a different firmware volume, then this parameter specifies the GUID name of the originating firmware volume. Otherwise, this parameter must be NULL. - @param ParentFileName If the new firmware volume originated from a file in a different firmware volume, + @param ParentFileName If the new firmware volume originated from a file in a different firmware volume, then this parameter specifies the GUID file name of the originating firmware file. Otherwise, this parameter must be NULL. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeiServicesTablePointerLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeiServicesTablePointerLib.h index f1aa0d4bf3..0232b61b05 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeiServicesTablePointerLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeiServicesTablePointerLib.h @@ -18,10 +18,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** Retrieves the cached value of the PEI Services Table pointer. - Returns the cached value of the PEI Services Table pointer in a CPU specific manner - as specified in the CPU binding section of the Platform Initialization Pre-EFI + Returns the cached value of the PEI Services Table pointer in a CPU specific manner + as specified in the CPU binding section of the Platform Initialization Pre-EFI Initialization Core Interface Specification. - + If the cached PEI Services Table pointer is NULL, then ASSERT(). @return The pointer to PeiServices. @@ -34,14 +34,14 @@ GetPeiServicesTablePointer ( ); /** - Caches a pointer PEI Services Table. - - Caches the pointer to the PEI Services Table specified by PeiServicesTablePointer - in a CPU specific manner as specified in the CPU binding section of the Platform Initialization - Pre-EFI Initialization Core Interface Specification. - + Caches a pointer PEI Services Table. + + Caches the pointer to the PEI Services Table specified by PeiServicesTablePointer + in a CPU specific manner as specified in the CPU binding section of the Platform Initialization + Pre-EFI Initialization Core Interface Specification. + If PeiServicesTablePointer is NULL, then ASSERT(). - + @param PeiServicesTablePointer The address of PeiServices pointer. **/ VOID @@ -51,16 +51,16 @@ SetPeiServicesTablePointer ( ); /** - Perform CPU specific actions required to migrate the PEI Services Table + Perform CPU specific actions required to migrate the PEI Services Table pointer from temporary RAM to permanent RAM. - For IA32 CPUs, the PEI Services Table pointer is stored in the 4 bytes + For IA32 CPUs, the PEI Services Table pointer is stored in the 4 bytes immediately preceding the Interrupt Descriptor Table (IDT) in memory. - For X64 CPUs, the PEI Services Table pointer is stored in the 8 bytes + For X64 CPUs, the PEI Services Table pointer is stored in the 8 bytes immediately preceding the Interrupt Descriptor Table (IDT) in memory. For Itanium and ARM CPUs, a the PEI Services Table Pointer is stored in - a dedicated CPU register. This means that there is no memory storage - associated with storing the PEI Services Table pointer, so no additional + a dedicated CPU register. This means that there is no memory storage + associated with storing the PEI Services Table pointer, so no additional migration actions are required for Itanium or ARM CPUs. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeimEntryPoint.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeimEntryPoint.h index 8364a0582e..46f26cdbb1 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeimEntryPoint.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PeimEntryPoint.h @@ -16,7 +16,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define __MODULE_ENTRY_POINT_H__ /// -/// Declare the EFI/UEFI Specification Revision to which this driver is implemented +/// Declare the EFI/UEFI Specification Revision to which this driver is implemented /// extern CONST UINT32 _gPeimRevision; @@ -24,11 +24,11 @@ extern CONST UINT32 _gPeimRevision; /** The entry point of PE/COFF Image for a PEIM. - This function is the entry point for a PEIM. This function must call ProcessLibraryConstructorList() + This function is the entry point for a PEIM. This function must call ProcessLibraryConstructorList() and ProcessModuleEntryPointList(). The return value from ProcessModuleEntryPointList() is returned. If _gPeimRevision is not zero and PeiServices->Hdr.Revision is less than _gPeimRevison, then ASSERT(). - @param FileHandle Handle of the file being invoked. + @param FileHandle Handle of the file being invoked. @param PeiServices Describes the list of possible PEI Services. @retval EFI_SUCCESS The PEIM executed normally. @@ -44,10 +44,10 @@ _ModuleEntryPoint ( /** Required by the EBC compiler and identical in functionality to _ModuleEntryPoint(). - + This function is required to call _ModuleEntryPoint() passing in FileHandle and PeiServices. - @param FileHandle Handle of the file being invoked. + @param FileHandle Handle of the file being invoked. @param PeiServices Describes the list of possible PEI Services. @retval EFI_SUCCESS The PEIM executed normally. @@ -68,7 +68,7 @@ EfiMain ( This function must be called by _ModuleEntryPoint(). This function calls the set of library constructors for the set of library instances that a module depends on. This includes library instances that a module depends on directly and library - instances that a module depends on indirectly through other libraries. + instances that a module depends on indirectly through other libraries. This function is autogenerated by build tools and those build tools are responsible for collecting the set of library instances, determine which ones have constructors, and calling the library constructors in the proper order based upon each of the library instances own dependencies. @@ -88,16 +88,16 @@ ProcessLibraryConstructorList ( Autogenerated function that calls a set of module entry points. This function must be called by _ModuleEntryPoint(). - This function calls the set of module entry points. + This function calls the set of module entry points. This function is autogenerated by build tools and those build tools are responsible for collecting the module entry points and calling them in a specified order. - @param FileHandle Handle of the file being invoked. + @param FileHandle Handle of the file being invoked. @param PeiServices Describes the list of possible PEI Services. @retval EFI_SUCCESS The PEIM executed normally. @retval !EFI_SUCCESS The PEIM failed to execute normally. - + **/ EFI_STATUS EFIAPI diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PerformanceLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PerformanceLib.h index 28dfc6a8d4..67273918b4 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PerformanceLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PerformanceLib.h @@ -21,8 +21,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED 0x00000001 /** - Creates a record for the beginning of a performance measurement. - + Creates a record for the beginning of a performance measurement. + Creates a record that contains the Handle, Token, and Module. If TimeStamp is not zero, then TimeStamp is added to the record as the start time. If TimeStamp is zero, then this function reads the current time stamp @@ -51,8 +51,8 @@ StartPerformanceMeasurement ( ); /** - Fills in the end time of a performance measurement. - + Fills in the end time of a performance measurement. + Looks up the record that matches Handle, Token, and Module. If the record can not be found then return RETURN_NOT_FOUND. If the record is found and TimeStamp is not zero, @@ -83,7 +83,7 @@ EndPerformanceMeasurement ( ); /** - Attempts to retrieve a performance measurement log entry from the performance measurement log. + Attempts to retrieve a performance measurement log entry from the performance measurement log. It can also retrieve the log created by StartPerformanceMeasurementEx and EndPerformanceMeasurementEx, and then eliminate the Identifier. @@ -108,9 +108,9 @@ EndPerformanceMeasurement ( 0, then the first performance measurement log entry is retrieved. On exit, the key of the next performance lof entry entry. @param Handle Pointer to environment specific context used to identify the component - being measured. + being measured. @param Token Pointer to a Null-terminated ASCII string that identifies the component - being measured. + being measured. @param Module Pointer to a Null-terminated ASCII string that identifies the module being measured. @param StartTimeStamp Pointer to the 64-bit time stamp that was recorded when the measurement @@ -124,7 +124,7 @@ EndPerformanceMeasurement ( UINTN EFIAPI GetPerformanceMeasurement ( - IN UINTN LogEntryKey, + IN UINTN LogEntryKey, OUT CONST VOID **Handle, OUT CONST CHAR8 **Token, OUT CONST CHAR8 **Module, @@ -244,7 +244,7 @@ EndPerformanceMeasurementEx ( UINTN EFIAPI GetPerformanceMeasurementEx ( - IN UINTN LogEntryKey, + IN UINTN LogEntryKey, OUT CONST VOID **Handle, OUT CONST CHAR8 **Token, OUT CONST CHAR8 **Module, @@ -254,8 +254,8 @@ GetPerformanceMeasurementEx ( ); /** - Returns TRUE if the performance measurement macros are enabled. - + Returns TRUE if the performance measurement macros are enabled. + This function returns TRUE if the PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED bit of PcdPerformanceLibraryPropertyMask is set. Otherwise FALSE is returned. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PostCodeLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PostCodeLib.h index bfc0b22707..0d758ef3dc 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PostCodeLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PostCodeLib.h @@ -21,14 +21,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** Sends a 32-bit value to a POST card. - Sends the 32-bit value specified by Value to a POST card, and returns Value. - Some implementations of this library function may perform I/O operations - directly to a POST card device. Other implementations may send Value to - ReportStatusCode(), and the status code reporting mechanism will eventually + Sends the 32-bit value specified by Value to a POST card, and returns Value. + Some implementations of this library function may perform I/O operations + directly to a POST card device. Other implementations may send Value to + ReportStatusCode(), and the status code reporting mechanism will eventually display the 32-bit value on the status reporting device. - - PostCode() must actively prevent recursion. If PostCode() is called while - processing another Post Code Library function, then + + PostCode() must actively prevent recursion. If PostCode() is called while + processing another Post Code Library function, then PostCode() must return Value immediately. @param Value The 32-bit value to write to the POST card. @@ -47,21 +47,21 @@ PostCode ( Sends a 32-bit value to a POST and associated ASCII string. Sends the 32-bit value specified by Value to a POST card, and returns Value. - If Description is not NULL, then the ASCII string specified by Description is - also passed to the handler that displays the POST card value. Some - implementations of this library function may perform I/O operations directly - to a POST card device. Other implementations may send Value to ReportStatusCode(), - and the status code reporting mechanism will eventually display the 32-bit - value on the status reporting device. - - PostCodeWithDescription()must actively prevent recursion. If - PostCodeWithDescription() is called while processing another any other Post - Code Library function, then PostCodeWithDescription() must return Value + If Description is not NULL, then the ASCII string specified by Description is + also passed to the handler that displays the POST card value. Some + implementations of this library function may perform I/O operations directly + to a POST card device. Other implementations may send Value to ReportStatusCode(), + and the status code reporting mechanism will eventually display the 32-bit + value on the status reporting device. + + PostCodeWithDescription()must actively prevent recursion. If + PostCodeWithDescription() is called while processing another any other Post + Code Library function, then PostCodeWithDescription() must return Value immediately. @param Value The 32-bit value to write to the POST card. - @param Description Pointer to an ASCII string that is a description of the - POST code value. This is an optional parameter that may + @param Description Pointer to an ASCII string that is a description of the + POST code value. This is an optional parameter that may be NULL. @return The 32-bit value to write to the POST card. @@ -78,12 +78,12 @@ PostCodeWithDescription ( /** Returns TRUE if POST Codes are enabled. - This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_ENABLED + This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_ENABLED bit of PcdPostCodePropertyMask is set. Otherwise FALSE is returned. - @retval TRUE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of + @retval TRUE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of PcdPostCodeProperyMask is set. - @retval FALSE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of + @retval FALSE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of PcdPostCodeProperyMask is clear. **/ @@ -116,7 +116,7 @@ PostCodeDescriptionEnabled ( /** Sends a 32-bit value to a POST card. - If POST codes are enabled in PcdPostCodeProperyMask, then call PostCode() + If POST codes are enabled in PcdPostCodeProperyMask, then call PostCode() passing in Value. Value is returned. @param Value The 32-bit value to write to the POST card. @@ -129,13 +129,13 @@ PostCodeDescriptionEnabled ( /** Sends a 32-bit value to a POST and associated ASCII string. - If POST codes and POST code descriptions are enabled in - PcdPostCodeProperyMask, then call PostCodeWithDescription() passing in - Value and Description. If only POST codes are enabled, then call PostCode() + If POST codes and POST code descriptions are enabled in + PcdPostCodeProperyMask, then call PostCodeWithDescription() passing in + Value and Description. If only POST codes are enabled, then call PostCode() passing in Value. Value is returned. @param Value The 32-bit value to write to the POST card. - @param Description Pointer to an ASCII string that is a description of the + @param Description Pointer to an ASCII string that is a description of the POST code value. @return Value The 32-bit value to write to the POST card. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PrintLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PrintLib.h index 1ffcfaea73..216d732148 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PrintLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/PrintLib.h @@ -3,44 +3,44 @@ Unicode and ASCII strings are supported. Copyright (c) 2006 - 2017, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at 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. - The Print Library functions provide a simple means to produce formatted output - strings. Many of the output functions use a format string to describe how to - format the output of variable arguments. The format string consists of normal - text and argument descriptors. There are no restrictions for how the normal - text and argument descriptors can be mixed. The following end of line(EOL) + The Print Library functions provide a simple means to produce formatted output + strings. Many of the output functions use a format string to describe how to + format the output of variable arguments. The format string consists of normal + text and argument descriptors. There are no restrictions for how the normal + text and argument descriptors can be mixed. The following end of line(EOL) translations must be performed on the contents of the format string: - + - '\\r' is translated to '\\r' - '\\r\\n' is translated to '\\r\\n' - - '\\n' is translated to '\\r\\n' + - '\\n' is translated to '\\r\\n' - '\\n\\r' is translated to '\\r\\n' - - This does not follow the ANSI C standard for sprint(). The format of argument - descriptors is described below. The ANSI C standard for sprint() has been - followed for some of the format types, and has not been followed for others. + + This does not follow the ANSI C standard for sprint(). The format of argument + descriptors is described below. The ANSI C standard for sprint() has been + followed for some of the format types, and has not been followed for others. The exceptions are noted below. %[flags][width][.precision]type [flags]: - - - - - The field is left justified. If not flag is not specified, then the + - - + - The field is left justified. If not flag is not specified, then the field is right justified. - - space + - space - Prefix a space character to a number. Only valid for types X, x, and d. - - + - - Prefix a plus character to a number. Only valid for types X, x, and d. + - + + - Prefix a plus character to a number. Only valid for types X, x, and d. If both space and + are specified, then space is ignored. - 0 - - Pad with 0 characters to the left of a number. Only valid for types + - Pad with 0 characters to the left of a number. Only valid for types X, x, and d. - , - Place a comma every 3rd digit of the number. Only valid for type d. @@ -53,20 +53,20 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. [width]: - * - - The width of the field is specified by a UINTN argument in the + - The width of the field is specified by a UINTN argument in the argument list. - number - - The number specified as a decimal value represents the width of + - The number specified as a decimal value represents the width of the field. - NOTE: If [width] is not specified, then a field width of 0 is assumed. [.precision]: - * - - The precision of the field is specified by a UINTN argument in the + - The precision of the field is specified by a UINTN argument in the argument list. - number - - The number specified as a decimal value represents the precision of + - The number specified as a decimal value represents the precision of the field. - NOTE: If [.precision] is not specified, then a precision of 0 is assumed. @@ -75,102 +75,102 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - % - Print a %%. - c - - The argument is a Unicode character. ASCII characters can be printed + - The argument is a Unicode character. ASCII characters can be printed using this type too by making sure bits 8..15 of the argument are set to 0. - x - - The argument is an unsigned hexadecimal number. The characters used are 0..9 and - A..F. If the flag 'L' is not specified, then the argument is assumed + - The argument is an unsigned hexadecimal number. The characters used are 0..9 and + A..F. If the flag 'L' is not specified, then the argument is assumed to be size int. This does not follow ANSI C. - X - - The argument is an unsigned hexadecimal number and the number is padded with - zeros. This is equivalent to a format string of "0x". If the flag - 'L' is not specified, then the argument is assumed to be size int. + - The argument is an unsigned hexadecimal number and the number is padded with + zeros. This is equivalent to a format string of "0x". If the flag + 'L' is not specified, then the argument is assumed to be size int. This does not follow ANSI C. - d - - The argument is a signed decimal number. If the flag 'L' is not specified, - then the argument is assumed to be size int. + - The argument is a signed decimal number. If the flag 'L' is not specified, + then the argument is assumed to be size int. - u - - The argument is a unsigned decimal number. If the flag 'L' is not specified, + - The argument is a unsigned decimal number. If the flag 'L' is not specified, then the argument is assumed to be size int. - p - - The argument is a pointer that is a (VOID *), and it is printed as an + - The argument is a pointer that is a (VOID *), and it is printed as an unsigned hexadecimal number The characters used are 0..9 and A..F. - a - - The argument is a pointer to an ASCII string. + - The argument is a pointer to an ASCII string. This does not follow ANSI C. - S, s - - The argument is a pointer to a Unicode string. + - The argument is a pointer to a Unicode string. This does not follow ANSI C. - g - - The argument is a pointer to a GUID structure. The GUID is printed - in the format XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX. + - The argument is a pointer to a GUID structure. The GUID is printed + in the format XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX. This does not follow ANSI C. - t - - The argument is a pointer to an EFI_TIME structure. The time and - date are printed in the format "mm/dd/yyyy hh:mm" where mm is the - month zero padded, dd is the day zero padded, yyyy is the year zero - padded, hh is the hour zero padded, and mm is minutes zero padded. - This does not follow ANSI C. + - The argument is a pointer to an EFI_TIME structure. The time and + date are printed in the format "mm/dd/yyyy hh:mm" where mm is the + month zero padded, dd is the day zero padded, yyyy is the year zero + padded, hh is the hour zero padded, and mm is minutes zero padded. + This does not follow ANSI C. - r - - The argument is a RETURN_STATUS value. This value is converted to - a string following the table below. This does not follow ANSI C. - - RETURN_SUCCESS + - The argument is a RETURN_STATUS value. This value is converted to + a string following the table below. This does not follow ANSI C. + - RETURN_SUCCESS - "Success" - - RETURN_LOAD_ERROR + - RETURN_LOAD_ERROR - "Load Error" - - RETURN_INVALID_PARAMETER + - RETURN_INVALID_PARAMETER - "Invalid Parameter" - - RETURN_UNSUPPORTED + - RETURN_UNSUPPORTED - "Unsupported" - - RETURN_BAD_BUFFER_SIZE + - RETURN_BAD_BUFFER_SIZE - "Bad Buffer Size" - - RETURN_BUFFER_TOO_SMALL + - RETURN_BUFFER_TOO_SMALL - "Buffer Too Small" - - RETURN_NOT_READY + - RETURN_NOT_READY - "Not Ready" - - RETURN_DEVICE_ERROR + - RETURN_DEVICE_ERROR - "Device Error" - - RETURN_WRITE_PROTECTED + - RETURN_WRITE_PROTECTED - "Write Protected" - - RETURN_OUT_OF_RESOURCES + - RETURN_OUT_OF_RESOURCES - "Out of Resources" - - RETURN_VOLUME_CORRUPTED + - RETURN_VOLUME_CORRUPTED - "Volume Corrupt" - - RETURN_VOLUME_FULL + - RETURN_VOLUME_FULL - "Volume Full" - - RETURN_NO_MEDIA + - RETURN_NO_MEDIA - "No Media" - - RETURN_MEDIA_CHANGED + - RETURN_MEDIA_CHANGED - "Media changed" - - RETURN_NOT_FOUND + - RETURN_NOT_FOUND - "Not Found" - - RETURN_ACCESS_DENIED + - RETURN_ACCESS_DENIED - "Access Denied" - - RETURN_NO_RESPONSE + - RETURN_NO_RESPONSE - "No Response" - - RETURN_NO_MAPPING + - RETURN_NO_MAPPING - "No mapping" - - RETURN_TIMEOUT + - RETURN_TIMEOUT - "Time out" - - RETURN_NOT_STARTED + - RETURN_NOT_STARTED - "Not started" - - RETURN_ALREADY_STARTED + - RETURN_ALREADY_STARTED - "Already started" - - RETURN_ABORTED + - RETURN_ABORTED - "Aborted" - - RETURN_ICMP_ERROR + - RETURN_ICMP_ERROR - "ICMP Error" - - RETURN_TFTP_ERROR + - RETURN_TFTP_ERROR - "TFTP Error" - - RETURN_PROTOCOL_ERROR + - RETURN_PROTOCOL_ERROR - "Protocol Error" - - RETURN_WARN_UNKNOWN_GLYPH + - RETURN_WARN_UNKNOWN_GLYPH - "Warning Unknown Glyph" - - RETURN_WARN_DELETE_FAILURE + - RETURN_WARN_DELETE_FAILURE - "Warning Delete Failure" - - RETURN_WARN_WRITE_FAILURE + - RETURN_WARN_WRITE_FAILURE - "Warning Write Failure" - - RETURN_WARN_BUFFER_TOO_SMALL + - RETURN_WARN_BUFFER_TOO_SMALL - "Warning Buffer Too Small" **/ @@ -180,9 +180,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /// /// Define the maximum number of characters that are required to -/// encode with a NULL terminator a decimal, hexadecimal, GUID, +/// encode with a NULL terminator a decimal, hexadecimal, GUID, /// or TIME value. -/// +/// /// Maximum Length Decimal String = 28 /// "-9,223,372,036,854,775,808" /// Maximum Length Hexadecimal String = 17 @@ -195,7 +195,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define MAXIMUM_VALUE_CHARACTERS 38 /// -/// Flags bitmask values use in UnicodeValueToString() and +/// Flags bitmask values use in UnicodeValueToString() and /// AsciiValueToString() /// #define LEFT_JUSTIFY 0x01 @@ -497,26 +497,26 @@ UnicodeSPrintAsciiFormat ( [ATTENTION] This function is deprecated for security reason. Converts a decimal value to a Null-terminated Unicode string. - - Converts the decimal number specified by Value to a Null-terminated Unicode - string specified by Buffer containing at most Width characters. No padding of spaces + + Converts the decimal number specified by Value to a Null-terminated Unicode + string specified by Buffer containing at most Width characters. No padding of spaces is ever performed. If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed. The number of Unicode characters in Buffer is returned, not including the Null-terminator. If the conversion contains more than Width characters, then only the first - Width characters are returned, and the total number of characters + Width characters are returned, and the total number of characters required to perform the conversion is returned. - Additional conversion parameters are specified in Flags. - + Additional conversion parameters are specified in Flags. + The Flags bit LEFT_JUSTIFY is always ignored. All conversions are left justified in Buffer. If Width is 0, PREFIX_ZERO is ignored in Flags. If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas are inserted every 3rd digit starting from the right. - If RADIX_HEX is set in Flags, then the output buffer will be + If RADIX_HEX is set in Flags, then the output buffer will be formatted in hexadecimal format. If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in Buffer is a '-'. - If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, - then Buffer is padded with '0' characters so the combination of the optional '-' + If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, + then Buffer is padded with '0' characters so the combination of the optional '-' sign character, '0' characters, digit characters for Value, and the Null-terminator add up to Width characters. If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT(). @@ -532,7 +532,7 @@ UnicodeSPrintAsciiFormat ( @param Value The 64-bit signed value to convert to a string. @param Width The maximum number of Unicode characters to place in Buffer, not including the Null-terminator. - + @return The number of Unicode characters in Buffer, not including the Null-terminator. **/ @@ -894,29 +894,29 @@ AsciiSPrintUnicodeFormat ( [ATTENTION] This function is deprecated for security reason. Converts a decimal value to a Null-terminated ASCII string. - - Converts the decimal number specified by Value to a Null-terminated ASCII string - specified by Buffer containing at most Width characters. No padding of spaces + + Converts the decimal number specified by Value to a Null-terminated ASCII string + specified by Buffer containing at most Width characters. No padding of spaces is ever performed. If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed. The number of ASCII characters in Buffer is returned, not including the Null-terminator. If the conversion contains more than Width characters, then only the first Width characters are returned, and the total number of characters required to perform the conversion is returned. - Additional conversion parameters are specified in Flags. + Additional conversion parameters are specified in Flags. The Flags bit LEFT_JUSTIFY is always ignored. All conversions are left justified in Buffer. If Width is 0, PREFIX_ZERO is ignored in Flags. If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas are inserted every 3rd digit starting from the right. - If RADIX_HEX is set in Flags, then the output buffer will be + If RADIX_HEX is set in Flags, then the output buffer will be formatted in hexadecimal format. If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in Buffer is a '-'. - If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, - then Buffer is padded with '0' characters so the combination of the optional '-' + If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, + then Buffer is padded with '0' characters so the combination of the optional '-' sign character, '0' characters, digit characters for Value, and the Null-terminator add up to Width characters. - + If Buffer is NULL, then ASSERT(). If unsupported bits are set in Flags, then ASSERT(). If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT(). @@ -928,7 +928,7 @@ AsciiSPrintUnicodeFormat ( @param Value The 64-bit signed value to convert to a string. @param Width The maximum number of ASCII characters to place in Buffer, not including the Null-terminator. - + @return The number of ASCII characters in Buffer, not including the Null-terminator. **/ @@ -1003,7 +1003,7 @@ AsciiValueToStringS ( ); /** - Returns the number of characters that would be produced by if the formatted + Returns the number of characters that would be produced by if the formatted output were produced not including the Null-terminator. If FormatString is not aligned on a 16-bit boundary, then ASSERT(). @@ -1016,7 +1016,7 @@ AsciiValueToStringS ( @param[in] FormatString A Null-terminated Unicode format string. @param[in] Marker VA_LIST marker for the variable argument list. - @return The number of characters that would be produced, not including the + @return The number of characters that would be produced, not including the Null-terminator. **/ UINTN @@ -1027,7 +1027,7 @@ SPrintLength ( ); /** - Returns the number of characters that would be produced by if the formatted + Returns the number of characters that would be produced by if the formatted output were produced not including the Null-terminator. If FormatString is NULL, then ASSERT() and 0 is returned. @@ -1038,7 +1038,7 @@ SPrintLength ( @param[in] FormatString A Null-terminated ASCII format string. @param[in] Marker VA_LIST marker for the variable argument list. - @return The number of characters that would be produced, not including the + @return The number of characters that would be produced, not including the Null-terminator. **/ UINTN diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/ReportStatusCodeLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/ReportStatusCodeLib.h index 0fe55ca7d0..dc0ef83d00 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/ReportStatusCodeLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/ReportStatusCodeLib.h @@ -2,8 +2,8 @@ Provides services to log status code records. 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php. @@ -29,21 +29,21 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** Converts a status code to an 8-bit POST code value. - Converts the status code specified by CodeType and Value to an 8-bit POST code - and returns the 8-bit POST code in PostCode. If CodeType is an - EFI_PROGRESS_CODE or CodeType is an EFI_ERROR_CODE, then bits 0..4 of PostCode - are set to bits 16..20 of Value, and bits 5..7 of PostCode are set to bits - 24..26 of Value., and TRUE is returned. Otherwise, FALSE is returned. + Converts the status code specified by CodeType and Value to an 8-bit POST code + and returns the 8-bit POST code in PostCode. If CodeType is an + EFI_PROGRESS_CODE or CodeType is an EFI_ERROR_CODE, then bits 0..4 of PostCode + are set to bits 16..20 of Value, and bits 5..7 of PostCode are set to bits + 24..26 of Value., and TRUE is returned. Otherwise, FALSE is returned. If PostCode is NULL, then ASSERT(). @param CodeType The type of status code being converted. @param Value The status code value being converted. - @param PostCode A pointer to the 8-bit POST code value to return. + @param PostCode A pointer to the 8-bit POST code value to return. - @retval TRUE The status code specified by CodeType and Value was converted + @retval TRUE The status code specified by CodeType and Value was converted to an 8-bit POST code and returned in PostCode. - @retval FALSE The status code specified by CodeType and Value could not be + @retval FALSE The status code specified by CodeType and Value could not be converted to an 8-bit POST code value. **/ @@ -60,15 +60,15 @@ CodeTypeToPostCode ( Extracts ASSERT() information from a status code structure. Converts the status code specified by CodeType, Value, and Data to the ASSERT() - arguments specified by Filename, Description, and LineNumber. If CodeType is - an EFI_ERROR_CODE, and CodeType has a severity of EFI_ERROR_UNRECOVERED, and - Value has an operation mask of EFI_SW_EC_ILLEGAL_SOFTWARE_STATE, extract - Filename, Description, and LineNumber from the optional data area of the - status code buffer specified by Data. The optional data area of Data contains - a Null-terminated ASCII string for the FileName, followed by a Null-terminated - ASCII string for the Description, followed by a 32-bit LineNumber. If the - ASSERT() information could be extracted from Data, then return TRUE. - Otherwise, FALSE is returned. + arguments specified by Filename, Description, and LineNumber. If CodeType is + an EFI_ERROR_CODE, and CodeType has a severity of EFI_ERROR_UNRECOVERED, and + Value has an operation mask of EFI_SW_EC_ILLEGAL_SOFTWARE_STATE, extract + Filename, Description, and LineNumber from the optional data area of the + status code buffer specified by Data. The optional data area of Data contains + a Null-terminated ASCII string for the FileName, followed by a Null-terminated + ASCII string for the Description, followed by a 32-bit LineNumber. If the + ASSERT() information could be extracted from Data, then return TRUE. + Otherwise, FALSE is returned. If Data is NULL, then ASSERT(). If Filename is NULL, then ASSERT(). @@ -77,15 +77,15 @@ CodeTypeToPostCode ( @param CodeType The type of status code being converted. @param Value The status code value being converted. - @param Data The pointer to status code data buffer. + @param Data The pointer to status code data buffer. @param Filename The pointer to the source file name that generated the ASSERT(). @param Description The pointer to the description of the ASSERT(). @param LineNumber The pointer to source line number that generated the ASSERT(). - @retval TRUE The status code specified by CodeType, Value, and Data was - converted ASSERT() arguments specified by Filename, Description, + @retval TRUE The status code specified by CodeType, Value, and Data was + converted ASSERT() arguments specified by Filename, Description, and LineNumber. - @retval FALSE The status code specified by CodeType, Value, and Data could + @retval FALSE The status code specified by CodeType, Value, and Data could not be converted to ASSERT() arguments. **/ @@ -93,8 +93,8 @@ BOOLEAN EFIAPI ReportStatusCodeExtractAssertInfo ( IN EFI_STATUS_CODE_TYPE CodeType, - IN EFI_STATUS_CODE_VALUE Value, - IN CONST EFI_STATUS_CODE_DATA *Data, + IN EFI_STATUS_CODE_VALUE Value, + IN CONST EFI_STATUS_CODE_DATA *Data, OUT CHAR8 **Filename, OUT CHAR8 **Description, OUT UINT32 *LineNumber @@ -104,13 +104,13 @@ ReportStatusCodeExtractAssertInfo ( /** Extracts DEBUG() information from a status code structure. - Converts the status code specified by Data to the DEBUG() arguments specified - by ErrorLevel, Marker, and Format. If type GUID in Data is - EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID, then extract ErrorLevel, Marker, and - Format from the optional data area of the status code buffer specified by Data. - The optional data area of Data contains a 32-bit ErrorLevel followed by Marker - which is 12 UINTN parameters, followed by a Null-terminated ASCII string for - the Format. If the DEBUG() information could be extracted from Data, then + Converts the status code specified by Data to the DEBUG() arguments specified + by ErrorLevel, Marker, and Format. If type GUID in Data is + EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID, then extract ErrorLevel, Marker, and + Format from the optional data area of the status code buffer specified by Data. + The optional data area of Data contains a 32-bit ErrorLevel followed by Marker + which is 12 UINTN parameters, followed by a Null-terminated ASCII string for + the Format. If the DEBUG() information could be extracted from Data, then return TRUE. Otherwise, FALSE is returned. If Data is NULL, then ASSERT(). @@ -118,22 +118,22 @@ ReportStatusCodeExtractAssertInfo ( If Marker is NULL, then ASSERT(). If Format is NULL, then ASSERT(). - @param Data The pointer to status code data buffer. + @param Data The pointer to status code data buffer. @param ErrorLevel The pointer to error level mask for a debug message. @param Marker The pointer to the variable argument list associated with Format. - @param Format The pointer to a Null-terminated ASCII format string of a + @param Format The pointer to a Null-terminated ASCII format string of a debug message. - @retval TRUE The status code specified by Data was converted DEBUG() arguments + @retval TRUE The status code specified by Data was converted DEBUG() arguments specified by ErrorLevel, Marker, and Format. - @retval FALSE The status code specified by Data could not be converted to + @retval FALSE The status code specified by Data could not be converted to DEBUG() arguments. **/ BOOLEAN EFIAPI ReportStatusCodeExtractDebugInfo ( - IN CONST EFI_STATUS_CODE_DATA *Data, + IN CONST EFI_STATUS_CODE_DATA *Data, OUT UINT32 *ErrorLevel, OUT BASE_LIST *Marker, OUT CHAR8 **Format @@ -143,20 +143,20 @@ ReportStatusCodeExtractDebugInfo ( /** Reports a status code. - Reports the status code specified by the parameters Type and Value. Status - code also require an instance, caller ID, and extended data. This function - passed in a zero instance, NULL extended data, and a caller ID of - gEfiCallerIdGuid, which is the GUID for the module. - - ReportStatusCode()must actively prevent recursion. If ReportStatusCode() + Reports the status code specified by the parameters Type and Value. Status + code also require an instance, caller ID, and extended data. This function + passed in a zero instance, NULL extended data, and a caller ID of + gEfiCallerIdGuid, which is the GUID for the module. + + ReportStatusCode()must actively prevent recursion. If ReportStatusCode() is called while processing another any other Report Status Code Library function, then ReportStatusCode() must return immediately. - @param Type Status code type. + @param Type Status code type. @param Value Status code value. @retval EFI_SUCCESS The status code was reported. - @retval EFI_DEVICE_ERROR There status code could not be reported due to a + @retval EFI_DEVICE_ERROR There status code could not be reported due to a device error. @retval EFI_UNSUPPORTED The report status code is not supported. @@ -172,26 +172,26 @@ ReportStatusCode ( /** Reports a status code with a Device Path Protocol as the extended data. - Allocates and fills in the extended data section of a status code with the - Device Path Protocol specified by DevicePath. This function is responsible - for allocating a buffer large enough for the standard header and the device + Allocates and fills in the extended data section of a status code with the + Device Path Protocol specified by DevicePath. This function is responsible + for allocating a buffer large enough for the standard header and the device path. The standard header is filled in with an implementation dependent GUID. The status code is reported with a zero instance and a caller ID of gEfiCallerIdGuid. - ReportStatusCodeWithDevicePath()must actively prevent recursion. If - ReportStatusCodeWithDevicePath() is called while processing another any other - Report Status Code Library function, then ReportStatusCodeWithDevicePath() + ReportStatusCodeWithDevicePath()must actively prevent recursion. If + ReportStatusCodeWithDevicePath() is called while processing another any other + Report Status Code Library function, then ReportStatusCodeWithDevicePath() must return EFI_DEVICE_ERROR immediately. If DevicePath is NULL, then ASSERT(). - @param Type The status code type. + @param Type The status code type. @param Value The status code value. @param DevicePath The pointer to the Device Path Protocol to be reported. - @retval EFI_SUCCESS The status code was reported with the extended + @retval EFI_SUCCESS The status code was reported with the extended data specified by DevicePath. - @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the + @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the extended data section. @retval EFI_UNSUPPORTED The report status code is not supported. @retval EFI_DEVICE_ERROR A call to a Report Status Code Library function @@ -210,32 +210,32 @@ ReportStatusCodeWithDevicePath ( /** Reports a status code with an extended data buffer. - Allocates and fills in the extended data section of a status code with the - extended data specified by ExtendedData and ExtendedDataSize. ExtendedData - is assumed to be one of the data structures specified in Related Definitions. - These data structure do not have the standard header, so this function is - responsible for allocating a buffer large enough for the standard header and - the extended data passed into this function. The standard header is filled - in with an implementation dependent GUID. The status code is reported + Allocates and fills in the extended data section of a status code with the + extended data specified by ExtendedData and ExtendedDataSize. ExtendedData + is assumed to be one of the data structures specified in Related Definitions. + These data structure do not have the standard header, so this function is + responsible for allocating a buffer large enough for the standard header and + the extended data passed into this function. The standard header is filled + in with an implementation dependent GUID. The status code is reported with a zero instance and a caller ID of gEfiCallerIdGuid. - ReportStatusCodeWithExtendedData()must actively prevent recursion. If - ReportStatusCodeWithExtendedData() is called while processing another any other - Report Status Code Library function, then ReportStatusCodeWithExtendedData() + ReportStatusCodeWithExtendedData()must actively prevent recursion. If + ReportStatusCodeWithExtendedData() is called while processing another any other + Report Status Code Library function, then ReportStatusCodeWithExtendedData() must return EFI_DEVICE_ERROR immediately. If ExtendedData is NULL, then ASSERT(). If ExtendedDataSize is 0, then ASSERT(). - @param Type The status code type. + @param Type The status code type. @param Value The status code value. @param ExtendedData The pointer to the extended data buffer to be reported. - @param ExtendedDataSize The size, in bytes, of the extended data buffer to + @param ExtendedDataSize The size, in bytes, of the extended data buffer to be reported. - @retval EFI_SUCCESS The status code was reported with the extended + @retval EFI_SUCCESS The status code was reported with the extended data specified by ExtendedData and ExtendedDataSize. - @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the + @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the extended data section. @retval EFI_UNSUPPORTED The report status code is not supported. @retval EFI_DEVICE_ERROR A call to a Report Status Code Library function @@ -255,39 +255,39 @@ ReportStatusCodeWithExtendedData ( /** Reports a status code with full parameters. - The function reports a status code. If ExtendedData is NULL and ExtendedDataSize - is 0, then an extended data buffer is not reported. If ExtendedData is not - NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated. - ExtendedData is assumed not have the standard status code header, so this function - is responsible for allocating a buffer large enough for the standard header and - the extended data passed into this function. The standard header is filled in - with a GUID specified by ExtendedDataGuid. If ExtendedDataGuid is NULL, then a - GUID of gEfiStatusCodeSpecificDataGuid is used. The status code is reported with - an instance specified by Instance and a caller ID specified by CallerId. If + The function reports a status code. If ExtendedData is NULL and ExtendedDataSize + is 0, then an extended data buffer is not reported. If ExtendedData is not + NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated. + ExtendedData is assumed not have the standard status code header, so this function + is responsible for allocating a buffer large enough for the standard header and + the extended data passed into this function. The standard header is filled in + with a GUID specified by ExtendedDataGuid. If ExtendedDataGuid is NULL, then a + GUID of gEfiStatusCodeSpecificDataGuid is used. The status code is reported with + an instance specified by Instance and a caller ID specified by CallerId. If CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used. - ReportStatusCodeEx()must actively prevent recursion. If ReportStatusCodeEx() - is called while processing another any other Report Status Code Library function, + ReportStatusCodeEx()must actively prevent recursion. If ReportStatusCodeEx() + is called while processing another any other Report Status Code Library function, then ReportStatusCodeEx() must return EFI_DEVICE_ERROR immediately. If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT(). If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT(). - @param Type The status code type. + @param Type The status code type. @param Value The status code value. @param Instance The status code instance number. - @param CallerId The pointer to a GUID that identifies the caller of this - function. If this parameter is NULL, then a caller + @param CallerId The pointer to a GUID that identifies the caller of this + function. If this parameter is NULL, then a caller ID of gEfiCallerIdGuid is used. - @param ExtendedDataGuid The pointer to the GUID for the extended data buffer. - If this parameter is NULL, then a the status code + @param ExtendedDataGuid The pointer to the GUID for the extended data buffer. + If this parameter is NULL, then a the status code standard header is filled in with an implementation dependent GUID. - @param ExtendedData The pointer to the extended data buffer. This is an + @param ExtendedData The pointer to the extended data buffer. This is an optional parameter that may be NULL. @param ExtendedDataSize The size, in bytes, of the extended data buffer. @retval EFI_SUCCESS The status code was reported. - @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate + @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the extended data section if it was specified. @retval EFI_UNSUPPORTED The report status code is not supported. @retval EFI_DEVICE_ERROR A call to a Report Status Code Library function @@ -310,12 +310,12 @@ ReportStatusCodeEx ( /** Returns TRUE if status codes of type EFI_PROGRESS_CODE are enabled - This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED + This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned. - @retval TRUE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of + @retval TRUE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is set. - @retval FALSE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of + @retval FALSE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is clear. **/ @@ -329,12 +329,12 @@ ReportProgressCodeEnabled ( /** Returns TRUE if status codes of type EFI_ERROR_CODE are enabled - This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED + This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is set. Otherwise, FALSE is returned. - @retval TRUE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of + @retval TRUE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is set. - @retval FALSE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of + @retval FALSE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is clear. **/ @@ -348,12 +348,12 @@ ReportErrorCodeEnabled ( /** Returns TRUE if status codes of type EFI_DEBUG_CODE are enabled - This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED + This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned. - @retval TRUE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of + @retval TRUE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is set. - @retval FALSE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of + @retval FALSE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is clear. **/ @@ -367,11 +367,11 @@ ReportDebugCodeEnabled ( /** Reports a status code with minimal parameters if the status code type is enabled. - If the status code type specified by Type is enabled in - PcdReportStatusCodeProperyMask, then call ReportStatusCode() passing in Type + If the status code type specified by Type is enabled in + PcdReportStatusCodeProperyMask, then call ReportStatusCode() passing in Type and Value. - @param Type The status code type. + @param Type The status code type. @param Value The status code value. @retval EFI_SUCCESS The status code was reported. @@ -390,20 +390,20 @@ ReportDebugCodeEnabled ( /** - Reports a status code with a Device Path Protocol as the extended data if the + Reports a status code with a Device Path Protocol as the extended data if the status code type is enabled. - If the status code type specified by Type is enabled in - PcdReportStatusCodeProperyMask, then call ReportStatusCodeWithDevicePath() + If the status code type specified by Type is enabled in + PcdReportStatusCodeProperyMask, then call ReportStatusCodeWithDevicePath() passing in Type, Value, and DevicePath. - @param Type The status code type. + @param Type The status code type. @param Value The status code value. @param DevicePath Pointer to the Device Path Protocol to be reported. - @retval EFI_SUCCESS The status code was reported with the extended + @retval EFI_SUCCESS The status code was reported with the extended data specified by DevicePath. - @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the + @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the extended data section. @retval EFI_UNSUPPORTED The report status code is not supported. @retval EFI_DEVICE_ERROR A call to a Report Status Code Library function @@ -421,22 +421,22 @@ ReportDebugCodeEnabled ( /** - Reports a status code with an extended data buffer if the status code type + Reports a status code with an extended data buffer if the status code type is enabled. - If the status code type specified by Type is enabled in - PcdReportStatusCodeProperyMask, then call ReportStatusCodeWithExtendedData() + If the status code type specified by Type is enabled in + PcdReportStatusCodeProperyMask, then call ReportStatusCodeWithExtendedData() passing in Type, Value, ExtendedData, and ExtendedDataSize. - @param Type The status code type. + @param Type The status code type. @param Value The status code value. @param ExtendedData The pointer to the extended data buffer to be reported. @param ExtendedDataSize The size, in bytes, of the extended data buffer to be reported. - @retval EFI_SUCCESS The status code was reported with the extended + @retval EFI_SUCCESS The status code was reported with the extended data specified by ExtendedData and ExtendedDataSize. - @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the + @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the extended data section. @retval EFI_UNSUPPORTED The report status code is not supported. @retval EFI_DEVICE_ERROR A call to a Report Status Code Library function @@ -455,25 +455,25 @@ ReportDebugCodeEnabled ( /** Reports a status code specifying all parameters if the status code type is enabled. - If the status code type specified by Type is enabled in - PcdReportStatusCodeProperyMask, then call ReportStatusCodeEx() passing in Type, + If the status code type specified by Type is enabled in + PcdReportStatusCodeProperyMask, then call ReportStatusCodeEx() passing in Type, Value, Instance, CallerId, ExtendedDataGuid, ExtendedData, and ExtendedDataSize. - @param Type The status code type. + @param Type The status code type. @param Value The status code value. @param Instance The status code instance number. - @param CallerId The pointer to a GUID that identifies the caller of this - function. If this parameter is NULL, then a caller + @param CallerId The pointer to a GUID that identifies the caller of this + function. If this parameter is NULL, then a caller ID of gEfiCallerIdGuid is used. - @param ExtendedDataGuid Pointer to the GUID for the extended data buffer. - If this parameter is NULL, then a the status code + @param ExtendedDataGuid Pointer to the GUID for the extended data buffer. + If this parameter is NULL, then a the status code standard header is filled in with an implementation dependent GUID. - @param ExtendedData Pointer to the extended data buffer. This is an + @param ExtendedData Pointer to the extended data buffer. This is an optional parameter that may be NULL. @param ExtendedDataSize The size, in bytes, of the extended data buffer. @retval EFI_SUCCESS The status code was reported. - @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the + @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the extended data section if it was specified. @retval EFI_UNSUPPORTED The report status code is not supported. @retval EFI_DEVICE_ERROR A call to a Report Status Code Library function diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/ResourcePublicationLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/ResourcePublicationLib.h index c15f58f48e..436bade0b3 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/ResourcePublicationLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/ResourcePublicationLib.h @@ -21,9 +21,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. Declares that the system memory buffer specified by MemoryBegin and MemoryLength as permanent memory that may be used for general purpose use by software. The amount of memory available to software may be less than MemoryLength - if published memory has alignment restrictions. + if published memory has alignment restrictions. If MemoryLength is 0, then ASSERT(). - If MemoryLength is greater than (MAX_ADDRESS - MemoryBegin + 1), then ASSERT(). + If MemoryLength is greater than (MAX_ADDRESS - MemoryBegin + 1), then ASSERT(). @param MemoryBegin The start address of the memory being declared. @param MemoryLength The number of bytes of memory being declared. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/S3BootScriptLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/S3BootScriptLib.h index 160a6d869a..885fed44a1 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/S3BootScriptLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/S3BootScriptLib.h @@ -1,8 +1,8 @@ -/** @file - Defines library APIs used by modules to save EFI Boot Script Opcodes. - These OpCode will be restored by S3 related modules. - Note that some of the API defined in the Library class may not - be provided in the Framework version library instance, which means some of these +/** @file + Defines library APIs used by modules to save EFI Boot Script Opcodes. + These OpCode will be restored by S3 related modules. + Note that some of the API defined in the Library class may not + be provided in the Framework version library instance, which means some of these APIs cannot be used if the underlying firmware is Framework and not PI. Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR> @@ -43,14 +43,14 @@ (((UINTN) Device) << 16) | \ (((UINTN) Function) << 8) | \ (((UINTN) (Register)) < 256 ? ((UINTN) (Register)) : (UINT64) (LShiftU64 ((UINT64) (Register), 32)))) - + /// /// S3 Boot Script Width. /// typedef enum { S3BootScriptWidthUint8, ///< 8-bit operation. S3BootScriptWidthUint16, ///< 16-bit operation. - S3BootScriptWidthUint32, ///< 32-bit operation. + S3BootScriptWidthUint32, ///< 32-bit operation. S3BootScriptWidthUint64, ///< 64-bit operation. S3BootScriptWidthFifoUint8, ///< 8-bit FIFO operation. S3BootScriptWidthFifoUint16, ///< 16-bit FIFO operation. @@ -71,7 +71,7 @@ typedef enum { @param[in] Count The number of I/O operations to perform. @param[in] Buffer The source buffer from which to write data. - @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform + @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform the operation. @retval RETURN_SUCCESS The opcode was added. @@ -94,7 +94,7 @@ S3BootScriptSaveIoWrite ( @param[in] DataMask A pointer to the data mask to be AND-ed with the data read from the register. - @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform + @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform the operation. @retval RETURN_SUCCESS The opcode was added. @@ -116,7 +116,7 @@ S3BootScriptSaveIoReadWrite ( @param[in] Count The number of memory operations to perform. @param[in] Buffer The source buffer from which to write the data. - @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform + @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform the operation. @retval RETURN_SUCCESS The opcode was added. **/ @@ -133,13 +133,13 @@ S3BootScriptSaveMemWrite ( Adds a record for a memory modify operation into a specified boot script table. @param[in] Width The width of the I/O operations. - @param[in] Address The base address of the memory operations. Address needs + @param[in] Address The base address of the memory operations. Address needs alignment, if required @param[in] Data A pointer to the data to be OR-ed. - @param[in] DataMask A pointer to the data mask to be AND-ed with the data + @param[in] DataMask A pointer to the data mask to be AND-ed with the data read from the register. - @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform + @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform the operation. @retval RETURN_SUCCESS The opcode was added. **/ @@ -160,7 +160,7 @@ S3BootScriptSaveMemReadWrite ( @param[in] Count The number of PCI operations to perform. @param[in] Buffer The source buffer from which to write the data. - @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform + @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform the operation. @retval RETURN_SUCCESS The opcode was added. **/ @@ -181,7 +181,7 @@ S3BootScriptSavePciCfgWrite ( @param[in] Data A pointer to the data to be OR-ed.The size depends on Width. @param[in] DataMask A pointer to the data mask to be AND-ed. - @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform + @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform the operation. @retval RETURN__SUCCESS The opcode was added. **/ @@ -203,7 +203,7 @@ S3BootScriptSavePciCfgReadWrite ( @param[in] Count The number of PCI operations to perform. @param[in] Buffer The source buffer from which to write the data. - @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform + @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform the operation. @retval RETURN_SUCCESS The opcode was added. **/ @@ -226,7 +226,7 @@ S3BootScriptSavePciCfg2Write ( @param[in] Data A pointer to the data to be OR-ed. The size depends on Width. @param[in] DataMask A pointer to the data mask to be AND-ed. - @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform + @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform the operation. @retval RETURN_SUCCESS The opcode was added. **/ @@ -243,23 +243,23 @@ S3BootScriptSavePciCfg2ReadWrite ( /** Adds a record for an SMBus command execution into a specified boot script table. - @param[in] SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS + @param[in] SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC. - @param[in] Operation Indicates which particular SMBus protocol it will use + @param[in] Operation Indicates which particular SMBus protocol it will use to execute the SMBus transactions. - @param[in] Length A pointer to signify the number of bytes that this + @param[in] Length A pointer to signify the number of bytes that this operation will do. - @param[in] Buffer Contains the value of data to execute to the SMBUS + @param[in] Buffer Contains the value of data to execute to the SMBUS slave device. - - @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform + + @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform the operation. @retval RETURN_SUCCESS The opcode was added. **/ RETURN_STATUS EFIAPI S3BootScriptSaveSmbusExecute ( - IN UINTN SmBusAddress, + IN UINTN SmBusAddress, IN EFI_SMBUS_OPERATION Operation, IN UINTN *Length, IN VOID *Buffer @@ -269,8 +269,8 @@ S3BootScriptSaveSmbusExecute ( Adds a record for an execution stall on the processor into a specified boot script table. @param[in] Duration The duration in microseconds of the stall. - - @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform + + @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform the operation. @retval RETURN_SUCCESS The opcode was added. **/ @@ -284,10 +284,10 @@ S3BootScriptSaveStall ( Adds a record for dispatching specified arbitrary code into a specified boot script table. @param[in] EntryPoint The entry point of the code to be dispatched. - @param[in] Context The argument to be passed into the EntryPoint of the code + @param[in] Context The argument to be passed into the EntryPoint of the code to be dispatched. - - @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform + + @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform the operation. @retval RETURN_SUCCESS The opcode was added. **/ @@ -302,8 +302,8 @@ S3BootScriptSaveDispatch2 ( Adds a record for dispatching specified arbitrary code into a specified boot script table. @param[in] EntryPoint The entry point of the code to be dispatched. - - @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform + + @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform the operation. @retval RETURN_SUCCESS The opcode was added. **/ @@ -314,7 +314,7 @@ S3BootScriptSaveDispatch ( ); /** - Adds a record for memory reads of the memory location and continues when the exit + Adds a record for memory reads of the memory location and continues when the exit criteria is satisfied, or after a defined duration. Please aware, below interface is different with PI specification, Vol 5: @@ -324,13 +324,13 @@ S3BootScriptSaveDispatch ( @param[in] Width The width of the memory operations. @param[in] Address The base address of the memory operations. - @param[in] BitMask A pointer to the bit mask to be AND-ed with the data read + @param[in] BitMask A pointer to the bit mask to be AND-ed with the data read from the register. @param[in] BitValue A pointer to the data value after to be Masked. @param[in] Duration The duration in microseconds of the stall. @param[in] LoopTimes The times of the register polling. - @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform + @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform the operation. @retval RETURN_SUCCESS The opcode was added. @@ -347,13 +347,13 @@ S3BootScriptSaveMemPoll ( ); /** - Store arbitrary information in the boot script table. This opcode is a no-op on + Store arbitrary information in the boot script table. This opcode is a no-op on dispatch and is only used for debugging script issues. - + @param[in] InformationLength Length of the data in bytes @param[in] Information Information to be logged in the boot scrpit - - @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform + + @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform the operation. @retval RETURN_SUCCESS The opcode was added. @@ -361,27 +361,27 @@ S3BootScriptSaveMemPoll ( RETURN_STATUS EFIAPI S3BootScriptSaveInformation ( - IN UINT32 InformationLength, + IN UINT32 InformationLength, IN VOID *Information ); /** Adds a record for I/O reads the I/O location and continues when the exit criteria is satisfied, or after a defined duration. - - @param Width The width of the I/O operations. + + @param Width The width of the I/O operations. @param Address The base address of the I/O operations. @param Data The comparison value used for the polling exit criteria. - @param DataMask The mask used for the polling criteria. The bits in - the bytes below Width which are zero in Data are + @param DataMask The mask used for the polling criteria. The bits in + the bytes below Width which are zero in Data are ignored when polling the memory address. - @param Delay The number of 100ns units to poll. Note that timer - available may be of insufficient granularity, so the + @param Delay The number of 100ns units to poll. Note that timer + available may be of insufficient granularity, so the delay may be longer. - @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform the + @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform the operation. @retval RETURN_SUCCESS The opcode was added. - @note The FRAMEWORK version implementation does not support this API + @note The FRAMEWORK version implementation does not support this API **/ RETURN_STATUS EFIAPI @@ -389,29 +389,29 @@ S3BootScriptSaveIoPoll ( IN S3_BOOT_SCRIPT_LIB_WIDTH Width, IN UINT64 Address, IN VOID *Data, - IN VOID *DataMask, - IN UINT64 Delay + IN VOID *DataMask, + IN UINT64 Delay ); /** - Adds a record for PCI configuration space reads and continues when the exit + Adds a record for PCI configuration space reads and continues when the exit criteria is satisfied ,or after a defined duration. - @param Width The width of the I/O operations. + @param Width The width of the I/O operations. @param Address The address within the PCI configuration space. - @param Data The comparison value used for the polling exit + @param Data The comparison value used for the polling exit criteria. - @param DataMask Mask used for the polling criteria. The bits in + @param DataMask Mask used for the polling criteria. The bits in the bytes below Width which are zero in Data are ignored when polling the memory address. - @param Delay The number of 100ns units to poll. Note that timer - available may be of insufficient granularity, so the + @param Delay The number of 100ns units to poll. Note that timer + available may be of insufficient granularity, so the delay may be longer. - @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform the + @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform the operation. @retval RETURN_SUCCESS The opcode was added. - @note The FRAMEWORK version implementation does not support this API + @note The FRAMEWORK version implementation does not support this API **/ RETURN_STATUS EFIAPI @@ -423,27 +423,27 @@ S3BootScriptSavePciPoll ( IN UINT64 Delay ); /** - Adds a record for PCI configuration space reads and continues when the exit criteria + Adds a record for PCI configuration space reads and continues when the exit criteria is satisfied, or after a defined duration. - @param Width The width of the I/O operations. + @param Width The width of the I/O operations. @param Segment The PCI segment number for Address. @param Address The address within the PCI configuration space. - @param Data The comparison value used for the polling exit + @param Data The comparison value used for the polling exit criteria. - @param DataMask Mask used for the polling criteria. The bits in + @param DataMask Mask used for the polling criteria. The bits in the bytes below Width which are zero in Data are ignored when polling the memory address - @param Delay The number of 100ns units to poll. Note that timer - available may be of insufficient granularity so the delay + @param Delay The number of 100ns units to poll. Note that timer + available may be of insufficient granularity so the delay may be longer. - @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform the + @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform the operation. @retval RETURN_SUCCESS The opcode was added. - @note A known Limitations in the implementation: When interpreting the opcode + @note A known Limitations in the implementation: When interpreting the opcode EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE_OPCODE, EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE_OPCODE - and EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL_OPCODE, the 'Segment' parameter is assumed as + and EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL_OPCODE, the 'Segment' parameter is assumed as Zero, or else, assert. The FRAMEWORK version implementation does not support this API. @@ -459,13 +459,13 @@ S3BootScriptSavePci2Poll ( IN UINT64 Delay ); /** - Save ASCII string information specified by Buffer to boot script with opcode + Save ASCII string information specified by Buffer to boot script with opcode EFI_BOOT_SCRIPT_INFORMATION_OPCODE. - @param[in] String The Null-terminated ASCII string to store into the S3 boot + @param[in] String The Null-terminated ASCII string to store into the S3 boot script table. - @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform + @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table to perform the operation. @retval RETURN_SUCCESS The opcode was added. @@ -477,27 +477,27 @@ S3BootScriptSaveInformationAsciiString ( ); /** - This is an function to close the S3 boot script table. The function could only - be called in BOOT time phase. To comply with the Framework spec definition on + This is an function to close the S3 boot script table. The function could only + be called in BOOT time phase. To comply with the Framework spec definition on EFI_BOOT_SCRIPT_SAVE_PROTOCOL.CloseTable(), this function will fulfill following things: 1. Closes the specified boot script table - 2. It allocates a new memory pool to duplicate all the boot scripts in the specified table. - Once this function is called, the table maintained by the library will be destroyed + 2. It allocates a new memory pool to duplicate all the boot scripts in the specified table. + Once this function is called, the table maintained by the library will be destroyed after it is copied into the allocated pool. - 3. Any attempts to add a script record after calling this function will cause a + 3. Any attempts to add a script record after calling this function will cause a new table to be created by the library. - 4. The base address of the allocated pool will be returned in Address. Note that - after using the boot script table, the CALLER is responsible for freeing the - pool that is allocated by this function. + 4. The base address of the allocated pool will be returned in Address. Note that + after using the boot script table, the CALLER is responsible for freeing the + pool that is allocated by this function. - In Spec PI1.1, this EFI_BOOT_SCRIPT_SAVE_PROTOCOL.CloseTable() is retired. This + In Spec PI1.1, this EFI_BOOT_SCRIPT_SAVE_PROTOCOL.CloseTable() is retired. This API is supplied here to meet the requirements of the Framework Spec. - + If anyone does call CloseTable() on a real platform, then the caller is responsible - for figuring out how to get the script to run on an S3 resume because the boot script + for figuring out how to get the script to run on an S3 resume because the boot script maintained by the lib will be destroyed. - - @return the base address of the new copy of the boot script table. + + @return the base address of the new copy of the boot script table. **/ UINT8* @@ -510,7 +510,7 @@ S3BootScriptCloseTable ( Executes the S3 boot script table. @retval RETURN_SUCCESS The boot script table was executed successfully. - @retval RETURN_UNSUPPORTED Invalid script table or opcode. + @retval RETURN_UNSUPPORTED Invalid script table or opcode. **/ RETURN_STATUS @@ -519,25 +519,25 @@ S3BootScriptExecute ( VOID ); /** - Move the last boot script entry to the position + Move the last boot script entry to the position - @param BeforeOrAfter Specifies whether the opcode is stored before - (TRUE) or after (FALSE) the positionin the boot - script table specified by Position. If Position - is NULL or points to NULL then the new opcode is - inserted at the beginning of the table (if TRUE) + @param BeforeOrAfter Specifies whether the opcode is stored before + (TRUE) or after (FALSE) the positionin the boot + script table specified by Position. If Position + is NULL or points to NULL then the new opcode is + inserted at the beginning of the table (if TRUE) or end of the table (if FALSE). - @param Position On entry, specifies the position in the boot script - table where the opcode will be inserted, either - before or after, depending on BeforeOrAfter. On - exit, specifies the position of the inserted opcode + @param Position On entry, specifies the position in the boot script + table where the opcode will be inserted, either + before or after, depending on BeforeOrAfter. On + exit, specifies the position of the inserted opcode in the boot script table. @retval RETURN_OUT_OF_RESOURCES The table is not available. - @retval RETURN_INVALID_PARAMETER The Position is not a valid position in the + @retval RETURN_INVALID_PARAMETER The Position is not a valid position in the boot script table. @retval RETURN_SUCCESS The opcode was inserted. - @note The FRAMEWORK version implementation does not support this API. + @note The FRAMEWORK version implementation does not support this API. **/ RETURN_STATUS EFIAPI @@ -549,28 +549,28 @@ S3BootScriptMoveLastOpcode ( Find a label within the boot script table and, if not present, optionally create it. @param BeforeOrAfter Specifies whether the opcode is stored before (TRUE) - or after (FALSE) the position in the boot script table + or after (FALSE) the position in the boot script table specified by Position. - @param CreateIfNotFound Specifies whether the label will be created if the + @param CreateIfNotFound Specifies whether the label will be created if the label does not exists (TRUE) or not (FALSE). - @param Position On entry, specifies the position in the boot script - table where the opcode will be inserted, either - before or after, depending on BeforeOrAfter. On exit, - specifies the positionof the inserted opcode in + @param Position On entry, specifies the position in the boot script + table where the opcode will be inserted, either + before or after, depending on BeforeOrAfter. On exit, + specifies the positionof the inserted opcode in the boot script table. - @param Label Points to the label which will be inserted in the + @param Label Points to the label which will be inserted in the boot script table. - @retval EFI_SUCCESS The operation succeeded. A record was added into + @retval EFI_SUCCESS The operation succeeded. A record was added into the specified script table. - @retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script - is not supported. If the opcode is unknow or not + @retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script + is not supported. If the opcode is unknow or not supported because of the PCD Feature Flags. @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script. - @note The FRAMEWORK version implementation does not support this API + @note The FRAMEWORK version implementation does not support this API **/ RETURN_STATUS -EFIAPI +EFIAPI S3BootScriptLabel ( IN BOOLEAN BeforeOrAfter, IN BOOLEAN CreateIfNotFound, @@ -585,14 +585,14 @@ S3BootScriptLabel ( @retval EFI_SUCCESS The operation succeeded. A record was added into the specified script table. - @retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script + @retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script is not supported. If the opcode is unknow or not s upported because of the PCD Feature Flags. @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script. - @note The FRAMEWORK version implementation does not support this API + @note The FRAMEWORK version implementation does not support this API **/ RETURN_STATUS -EFIAPI +EFIAPI S3BootScriptCompare ( IN UINT8 *Position1, IN UINT8 *Position2, diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/S3IoLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/S3IoLib.h index 5905eaf719..182b7981b1 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/S3IoLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/S3IoLib.h @@ -1,7 +1,7 @@ /** @file I/O and MMIO Library Services that do I/O and also enable the I/O operation to be replayed during an S3 resume. This library class maps directly on top - of the IoLib class. + of the IoLib class. Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR> @@ -117,7 +117,7 @@ S3IoAnd8 ( /** Reads an 8-bit I/O port, performs a bitwise AND followed by a bitwise - inclusive OR, writes the result back to the 8-bit I/O port, and saves + inclusive OR, writes the result back to the 8-bit I/O port, and saves the value in the S3 script to be replayed on S3 resume. Reads the 8-bit I/O port specified by Port, performs a bitwise AND between @@ -179,7 +179,7 @@ S3IoBitFieldRead8 ( 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. + register are preserved. The value written to the I/O port is returned. Remaining bits in Value are stripped. If 8-bit I/O port operations are not supported, then ASSERT(). @@ -209,7 +209,7 @@ S3IoBitFieldWrite8 ( /** Reads a bit field in an 8-bit port, performs a bitwise OR, writes the - result back to the bit field in the 8-bit port, and saves the value in the + result back to the bit field in the 8-bit port, and saves the value in the S3 script to be replayed on S3 resume. Reads the 8-bit I/O port specified by Port, performs a bitwise OR @@ -245,7 +245,7 @@ S3IoBitFieldOr8 ( /** Reads a bit field in an 8-bit port, performs a bitwise AND, writes the - result back to the bit field in the 8-bit port, and saves the value in the + result back to the bit field in the 8-bit port, and saves the value in the S3 script to be replayed on S3 resume. Reads the 8-bit I/O port specified by Port, performs a bitwise AND between @@ -365,7 +365,7 @@ S3IoWrite16 ( /** Reads a 16-bit I/O port, performs a bitwise OR, writes the - result back to the 16-bit I/O port, and saves the value in the S3 script to + result back to the 16-bit I/O port, and saves the value in the S3 script to be replayed on S3 resume. Reads the 16-bit I/O port specified by Port, performs a bitwise OR @@ -474,7 +474,7 @@ S3IoBitFieldRead16 ( ); /** - Writes a bit field to an I/O register, and saves the value in the S3 script + Writes a bit field to an I/O register, and saves the value in the S3 script to be replayed on S3 resume. Writes Value to the bit field of the I/O register. The bit field is specified @@ -509,7 +509,7 @@ S3IoBitFieldWrite16 ( /** Reads a bit field in a 16-bit port, performs a bitwise OR, writes the - result back to the bit field in the 16-bit port, and saves the value in the + result back to the bit field in the 16-bit port, and saves the value in the S3 script to be replayed on S3 resume. Reads the 16-bit I/O port specified by Port, performs a bitwise OR @@ -545,7 +545,7 @@ S3IoBitFieldOr16 ( /** Reads a bit field in a 16-bit port, performs a bitwise AND, writes the - result back to the bit field in the 16-bit port, and saves the value in the + result back to the bit field in the 16-bit port, and saves the value in the S3 script to be replayed on S3 resume. Reads the 16-bit I/O port specified by Port, performs a bitwise AND between @@ -582,7 +582,7 @@ S3IoBitFieldAnd16 ( /** Reads a bit field in a 16-bit port, performs a bitwise AND followed by a bitwise OR, writes the result back to the bit field in the - 16-bit port, and saves the value in the S3 script to be replayed on S3 + 16-bit port, and saves the value in the S3 script to be replayed on S3 resume. Reads the 16-bit I/O port specified by Port, performs a bitwise AND followed @@ -666,7 +666,7 @@ S3IoWrite32 ( /** Reads a 32-bit I/O port, performs a bitwise OR, writes the - result back to the 32-bit I/O port, and saves the value in the S3 script to + result back to the 32-bit I/O port, and saves the value in the S3 script to be replayed on S3 resume. Reads the 32-bit I/O port specified by Port, performs a bitwise OR @@ -718,7 +718,7 @@ S3IoAnd32 ( /** Reads a 32-bit I/O port, performs a bitwise AND followed by a bitwise - inclusive OR, writes the result back to the 32-bit I/O port, and saves + inclusive OR, writes the result back to the 32-bit I/O port, and saves the value in the S3 script to be replayed on S3 resume. Reads the 32-bit I/O port specified by Port, performs a bitwise AND between @@ -810,7 +810,7 @@ S3IoBitFieldWrite32 ( /** Reads a bit field in a 32-bit port, performs a bitwise OR, writes the - result back to the bit field in the 32-bit port, and saves the value in the + result back to the bit field in the 32-bit port, and saves the value in the S3 script to be replayed on S3 resume. Reads the 32-bit I/O port specified by Port, performs a bitwise OR @@ -846,7 +846,7 @@ S3IoBitFieldOr32 ( /** Reads a bit field in a 32-bit port, performs a bitwise AND, writes the - result back to the bit field in the 32-bit port, and saves the value in the + result back to the bit field in the 32-bit port, and saves the value in the S3 script to be replayed on S3 resume. Reads the 32-bit I/O port specified by Port, performs a bitwise AND between @@ -883,7 +883,7 @@ S3IoBitFieldAnd32 ( /** Reads a bit field in a 32-bit port, performs a bitwise AND followed by a bitwise OR, writes the result back to the bit field in the - 32-bit port, and saves the value in the S3 script to be replayed on S3 + 32-bit port, and saves the value in the S3 script to be replayed on S3 resume. Reads the 32-bit I/O port specified by Port, performs a bitwise AND followed @@ -967,7 +967,7 @@ S3IoWrite64 ( /** Reads a 64-bit I/O port, performs a bitwise OR, writes the - result back to the 64-bit I/O port, and saves the value in the S3 script to + result back to the 64-bit I/O port, and saves the value in the S3 script to be replayed on S3 resume. Reads the 64-bit I/O port specified by Port, performs a bitwise OR @@ -1111,7 +1111,7 @@ S3IoBitFieldWrite64 ( /** Reads a bit field in a 64-bit port, performs a bitwise OR, writes the - result back to the bit field in the 64-bit port, and saves the value in the + result back to the bit field in the 64-bit port, and saves the value in the S3 script to be replayed on S3 resume. Reads the 64-bit I/O port specified by Port, performs a bitwise OR @@ -1147,7 +1147,7 @@ S3IoBitFieldOr64 ( /** Reads a bit field in a 64-bit port, performs a bitwise AND, writes the - result back to the bit field in the 64-bit port, and saves the value in the + result back to the bit field in the 64-bit port, and saves the value in the S3 script to be replayed on S3 resume. Reads the 64-bit I/O port specified by Port, performs a bitwise AND between @@ -1184,7 +1184,7 @@ S3IoBitFieldAnd64 ( /** Reads a bit field in a 64-bit port, performs a bitwise AND followed by a bitwise OR, writes the result back to the bit field in the - 64-bit port, and saves the value in the S3 script to be replayed on S3 + 64-bit port, and saves the value in the S3 script to be replayed on S3 resume. Reads the 64-bit I/O port specified by Port, performs a bitwise AND followed @@ -1223,7 +1223,7 @@ S3IoBitFieldAndThenOr64 ( ); /** - Reads an 8-bit MMIO register, and saves the value in the S3 script to be + Reads an 8-bit MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Reads the 8-bit MMIO register specified by Address. The 8-bit read value is @@ -1244,7 +1244,7 @@ S3MmioRead8 ( ); /** - Writes an 8-bit MMIO register, and saves the value in the S3 script to be + Writes an 8-bit MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Writes the 8-bit MMIO register specified by Address with the value specified @@ -1268,7 +1268,7 @@ S3MmioWrite8 ( /** Reads an 8-bit MMIO register, performs a bitwise OR, writes the - result back to the 8-bit MMIO register, and saves the value in the S3 script + result back to the 8-bit MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Reads the 8-bit MMIO register specified by Address, performs a bitwise @@ -1294,7 +1294,7 @@ S3MmioOr8 ( /** Reads an 8-bit MMIO register, performs a bitwise AND, writes the result - back to the 8-bit MMIO register, and saves the value in the S3 script to be + back to the 8-bit MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Reads the 8-bit MMIO register specified by Address, performs a bitwise AND @@ -1320,7 +1320,7 @@ S3MmioAnd8 ( /** Reads an 8-bit MMIO register, performs a bitwise AND followed by a bitwise - inclusive OR, writes the result back to the 8-bit MMIO register, and saves + inclusive OR, writes the result back to the 8-bit MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Reads the 8-bit MMIO register specified by Address, performs a bitwise AND @@ -1410,7 +1410,7 @@ S3MmioBitFieldWrite8 ( ); /** - Reads a bit field in an 8-bit MMIO register, performs a bitwise OR, + Reads a bit field in an 8-bit MMIO register, performs a bitwise OR, writes the result back to the bit field in the 8-bit MMIO register, and saves the value in the S3 script to be replayed on S3 resume. @@ -1571,7 +1571,7 @@ S3MmioWrite16 ( /** Reads a 16-bit MMIO register, performs a bitwise OR, writes the - result back to the 16-bit MMIO register, and saves the value in the S3 script + result back to the 16-bit MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Reads the 16-bit MMIO register specified by Address, performs a bitwise @@ -1597,7 +1597,7 @@ S3MmioOr16 ( /** Reads a 16-bit MMIO register, performs a bitwise AND, writes the result - back to the 16-bit MMIO register, and saves the value in the S3 script to be + back to the 16-bit MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Reads the 16-bit MMIO register specified by Address, performs a bitwise AND @@ -1623,7 +1623,7 @@ S3MmioAnd16 ( /** Reads a 16-bit MMIO register, performs a bitwise AND followed by a bitwise - inclusive OR, writes the result back to the 16-bit MMIO register, and + inclusive OR, writes the result back to the 16-bit MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Reads the 16-bit MMIO register specified by Address, performs a bitwise AND @@ -1713,8 +1713,8 @@ S3MmioBitFieldWrite16 ( ); /** - Reads a bit field in a 16-bit MMIO register, performs a bitwise OR, - writes the result back to the bit field in the 16-bit MMIO register, and + Reads a bit field in a 16-bit MMIO register, performs a bitwise OR, + writes the result back to the bit field in the 16-bit MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Reads the 16-bit MMIO register specified by Address, performs a bitwise @@ -1751,7 +1751,7 @@ S3MmioBitFieldOr16 ( /** Reads a bit field in a 16-bit MMIO register, performs a bitwise AND, and - writes the result back to the bit field in the 16-bit MMIO register and + writes the result back to the bit field in the 16-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume. Reads the 16-bit MMIO register specified by Address, performs a bitwise AND @@ -1828,7 +1828,7 @@ S3MmioBitFieldAndThenOr16 ( ); /** - Reads a 32-bit MMIO register saves the value in the S3 script to be + Reads a 32-bit MMIO register saves the value in the S3 script to be replayed on S3 resume. Reads the 32-bit MMIO register specified by Address. The 32-bit read value is @@ -1849,7 +1849,7 @@ S3MmioRead32 ( ); /** - Writes a 32-bit MMIO register, and saves the value in the S3 script to be + Writes a 32-bit MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Writes the 32-bit MMIO register specified by Address with the value specified @@ -1873,7 +1873,7 @@ S3MmioWrite32 ( /** Reads a 32-bit MMIO register, performs a bitwise OR, writes the - result back to the 32-bit MMIO register, and saves the value in the S3 script + result back to the 32-bit MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Reads the 32-bit MMIO register specified by Address, performs a bitwise @@ -1899,7 +1899,7 @@ S3MmioOr32 ( /** Reads a 32-bit MMIO register, performs a bitwise AND, writes the result - back to the 32-bit MMIO register, and saves the value in the S3 script to be + back to the 32-bit MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Reads the 32-bit MMIO register specified by Address, performs a bitwise AND @@ -1925,7 +1925,7 @@ S3MmioAnd32 ( /** Reads a 32-bit MMIO register, performs a bitwise AND followed by a bitwise - inclusive OR, writes the result back to the 32-bit MMIO register, and + inclusive OR, writes the result back to the 32-bit MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Reads the 32-bit MMIO register specified by Address, performs a bitwise AND @@ -1953,7 +1953,7 @@ S3MmioAndThenOr32 ( ); /** - Reads a bit field of a MMIO register, and saves the value in the S3 script + Reads a bit field of a MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Reads the bit field in a 32-bit MMIO register. The bit field is specified by @@ -1982,7 +1982,7 @@ S3MmioBitFieldRead32 ( ); /** - Writes a bit field to a MMIO register, and saves the value in the S3 script + Writes a bit field to a MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Writes Value to the bit field of the MMIO register. The bit field is @@ -2015,8 +2015,8 @@ S3MmioBitFieldWrite32 ( ); /** - Reads a bit field in a 32-bit MMIO register, performs a bitwise OR, - writes the result back to the bit field in the 32-bit MMIO register, and + Reads a bit field in a 32-bit MMIO register, performs a bitwise OR, + writes the result back to the bit field in the 32-bit MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Reads the 32-bit MMIO register specified by Address, performs a bitwise @@ -2053,7 +2053,7 @@ S3MmioBitFieldOr32 ( /** Reads a bit field in a 32-bit MMIO register, performs a bitwise AND, and - writes the result back to the bit field in the 32-bit MMIO register and + writes the result back to the bit field in the 32-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume. Reads the 32-bit MMIO register specified by Address, performs a bitwise AND @@ -2130,7 +2130,7 @@ S3MmioBitFieldAndThenOr32 ( ); /** - Reads a 64-bit MMIO register, and saves the value in the S3 script to be + Reads a 64-bit MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Reads the 64-bit MMIO register specified by Address. The 64-bit read value is @@ -2151,7 +2151,7 @@ S3MmioRead64 ( ); /** - Writes a 64-bit MMIO register, and saves the value in the S3 script to be + Writes a 64-bit MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Writes the 64-bit MMIO register specified by Address with the value specified @@ -2175,7 +2175,7 @@ S3MmioWrite64 ( /** Reads a 64-bit MMIO register, performs a bitwise OR, writes the - result back to the 64-bit MMIO register, and saves the value in the S3 script + result back to the 64-bit MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Reads the 64-bit MMIO register specified by Address, performs a bitwise @@ -2201,7 +2201,7 @@ S3MmioOr64 ( /** Reads a 64-bit MMIO register, performs a bitwise AND, writes the result - back to the 64-bit MMIO register, and saves the value in the S3 script to be + back to the 64-bit MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Reads the 64-bit MMIO register specified by Address, performs a bitwise AND @@ -2227,7 +2227,7 @@ S3MmioAnd64 ( /** Reads a 64-bit MMIO register, performs a bitwise AND followed by a bitwise - inclusive OR, writes the result back to the 64-bit MMIO register, and + inclusive OR, writes the result back to the 64-bit MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Reads the 64-bit MMIO register specified by Address, performs a bitwise AND @@ -2317,8 +2317,8 @@ S3MmioBitFieldWrite64 ( ); /** - Reads a bit field in a 64-bit MMIO register, performs a bitwise OR, - writes the result back to the bit field in the 64-bit MMIO register, and + Reads a bit field in a 64-bit MMIO register, performs a bitwise OR, + writes the result back to the bit field in the 64-bit MMIO register, and saves the value in the S3 script to be replayed on S3 resume. Reads the 64-bit MMIO register specified by Address, performs a bitwise @@ -2435,11 +2435,11 @@ S3MmioBitFieldAndThenOr64 ( Copies data from MMIO region to system memory by using 8-bit access, and saves the value in the S3 script to be replayed on S3 resume. - Copy data from MMIO region specified by starting address StartAddress - to system memory specified by Buffer by using 8-bit access. The total + Copy data from MMIO region specified by starting address StartAddress + to system memory specified by Buffer by using 8-bit access. The total number of bytes to be copied is specified by Length. Buffer is returned. - - If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). + + If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). @@ -2462,13 +2462,13 @@ S3MmioReadBuffer8 ( Copies data from MMIO region to system memory by using 16-bit access, and saves the value in the S3 script to be replayed on S3 resume. - Copy data from MMIO region specified by starting address StartAddress - to system memory specified by Buffer by using 16-bit access. The total + Copy data from MMIO region specified by starting address StartAddress + to system memory specified by Buffer by using 16-bit access. The total number of bytes to be copied is specified by Length. Buffer is returned. - + If StartAddress is not aligned on a 16-bit boundary, then ASSERT(). - If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). + If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is not aligned on a 16-bit boundary, then ASSERT(). @@ -2493,13 +2493,13 @@ S3MmioReadBuffer16 ( Copies data from MMIO region to system memory by using 32-bit access, and saves the value in the S3 script to be replayed on S3 resume. - Copy data from MMIO region specified by starting address StartAddress - to system memory specified by Buffer by using 32-bit access. The total + Copy data from MMIO region specified by starting address StartAddress + to system memory specified by Buffer by using 32-bit access. The total number of byte to be copied is specified by Length. Buffer is returned. - + If StartAddress is not aligned on a 32-bit boundary, then ASSERT(). - If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). + If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is not aligned on a 32-bit boundary, then ASSERT(). @@ -2524,13 +2524,13 @@ S3MmioReadBuffer32 ( Copies data from MMIO region to system memory by using 64-bit access, and saves the value in the S3 script to be replayed on S3 resume. - Copy data from MMIO region specified by starting address StartAddress - to system memory specified by Buffer by using 64-bit access. The total + Copy data from MMIO region specified by starting address StartAddress + to system memory specified by Buffer by using 64-bit access. The total number of byte to be copied is specified by Length. Buffer is returned. - + If StartAddress is not aligned on a 64-bit boundary, then ASSERT(). - If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). + If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is not aligned on a 64-bit boundary, then ASSERT(). @@ -2555,11 +2555,11 @@ S3MmioReadBuffer64 ( Copies data from system memory to MMIO region by using 8-bit access, and saves the value in the S3 script to be replayed on S3 resume. - Copy data from system memory specified by Buffer to MMIO region specified - by starting address StartAddress by using 8-bit access. The total number + Copy data from system memory specified by Buffer to MMIO region specified + by starting address StartAddress by using 8-bit access. The total number of byte to be copied is specified by Length. Buffer is returned. - - If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). + + If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT(). @@ -2582,13 +2582,13 @@ S3MmioWriteBuffer8 ( Copies data from system memory to MMIO region by using 16-bit access, and saves the value in the S3 script to be replayed on S3 resume. - Copy data from system memory specified by Buffer to MMIO region specified - by starting address StartAddress by using 16-bit access. The total number + Copy data from system memory specified by Buffer to MMIO region specified + by starting address StartAddress by using 16-bit access. The total number of bytes to be copied is specified by Length. Buffer is returned. - + If StartAddress is not aligned on a 16-bit boundary, then ASSERT(). - If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). + If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT(). If Length is not aligned on a 16-bit boundary, then ASSERT(). @@ -2614,13 +2614,13 @@ S3MmioWriteBuffer16 ( Copies data from system memory to MMIO region by using 32-bit access, and saves the value in the S3 script to be replayed on S3 resume. - Copy data from system memory specified by Buffer to MMIO region specified - by starting address StartAddress by using 32-bit access. The total number + Copy data from system memory specified by Buffer to MMIO region specified + by starting address StartAddress by using 32-bit access. The total number of bytes to be copied is specified by Length. Buffer is returned. - + If StartAddress is not aligned on a 32-bit boundary, then ASSERT(). - If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). + If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT(). If Length is not aligned on a 32-bit boundary, then ASSERT(). @@ -2643,16 +2643,16 @@ S3MmioWriteBuffer32 ( ); /** - Copies data from system memory to MMIO region by using 64-bit access, + Copies data from system memory to MMIO region by using 64-bit access, and saves the value in the S3 script to be replayed on S3 resume. - Copy data from system memory specified by Buffer to MMIO region specified - by starting address StartAddress by using 64-bit access. The total number + Copy data from system memory specified by Buffer to MMIO region specified + by starting address StartAddress by using 64-bit access. The total number of bytes to be copied is specified by Length. Buffer is returned. - + If StartAddress is not aligned on a 64-bit boundary, then ASSERT(). - If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). + If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT(). If Length is not aligned on a 64-bit boundary, then ASSERT(). diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/S3PciLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/S3PciLib.h index 3d8f497f99..ff53a78506 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/S3PciLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/S3PciLib.h @@ -1,7 +1,7 @@ /** @file The PCI configuration Library Services that carry out PCI configuration and enable the PCI operations to be replayed during an S3 resume. This library class - maps directly on top of the PciLib class. + maps directly on top of the PciLib class. Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR> @@ -36,8 +36,8 @@ (((Register) & 0xfff) | (((Function) & 0x07) << 12) | (((Device) & 0x1f) << 15) | (((Bus) & 0xff) << 20)) /** - - Reads and returns the 8-bit PCI configuration register specified by Address, + + Reads and returns the 8-bit PCI configuration register specified by Address, and saves the value in the S3 script to be replayed on S3 resume. This function must guarantee that all PCI read and write operations are serialized. @@ -813,7 +813,7 @@ S3PciAndThenOr32 ( If StartBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). - + @param[in] Address The PCI configuration register to read. @param[in] StartBit The ordinal of the least significant bit in the bit field. Range 0..31. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/S3StallLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/S3StallLib.h index e723d18bda..d1fff8cdd4 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/S3StallLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/S3StallLib.h @@ -1,7 +1,7 @@ /** @file Stall Services that perform stalls and also enable the Stall operatation to be replayed during an S3 resume. This library class maps directly on top - of the Timer class. + of the Timer class. Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR> diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SalLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SalLib.h index 94e4af8e59..166a01ff3b 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SalLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SalLib.h @@ -19,8 +19,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** Makes a SAL procedure call. - - This is a wrapper function to make a SAL procedure call. + + This is a wrapper function to make a SAL procedure call. No parameter checking is performed on the 8 input parameters, but there are some common rules that the caller should follow when making a SAL call. Any address passed to SAL as buffers diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SerialPortLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SerialPortLib.h index f56b76debd..5639d88a69 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SerialPortLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SerialPortLib.h @@ -21,11 +21,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** Initialize the serial device hardware. - + If no initialization is required, then return RETURN_SUCCESS. If the serial device was successfully initialized, then return RETURN_SUCCESS. If the serial device could not be initialized, then return RETURN_DEVICE_ERROR. - + @retval RETURN_SUCCESS The serial device was initialized. @retval RETURN_DEVICE_ERROR The serial device could not be initialized. @@ -37,19 +37,19 @@ SerialPortInitialize ( ); /** - Write data from buffer to serial device. - - Writes NumberOfBytes data bytes from Buffer to the serial device. + Write data from buffer to serial device. + + Writes NumberOfBytes data bytes from Buffer to the serial device. The number of bytes actually written to the serial device is returned. If the return value is less than NumberOfBytes, then the write operation failed. - If Buffer is NULL, then ASSERT(). + If Buffer is NULL, then ASSERT(). If NumberOfBytes is zero, then return 0. @param Buffer Pointer to the data buffer to be written. @param NumberOfBytes Number of bytes to written to the serial device. @retval 0 NumberOfBytes is 0. - @retval >0 The number of bytes written to the serial device. + @retval >0 The number of bytes written to the serial device. If this value is less than NumberOfBytes, then the write operation failed. **/ @@ -63,11 +63,11 @@ SerialPortWrite ( /** Read data from serial device and save the datas in buffer. - + Reads NumberOfBytes data bytes from a serial device into the buffer - specified by Buffer. The number of bytes actually read is returned. + specified by Buffer. The number of bytes actually read is returned. If the return value is less than NumberOfBytes, then the rest operation failed. - If Buffer is NULL, then ASSERT(). + If Buffer is NULL, then ASSERT(). If NumberOfBytes is zero, then return 0. @param Buffer Pointer to the data buffer to store the data read from the serial device. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SmbusLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SmbusLib.h index 35bf932ac6..c237876d9c 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SmbusLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SmbusLib.h @@ -23,7 +23,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. Computes an address that is compatible with the SMBUS Library functions. The unused upper bits of SlaveAddress, Command, and Length are stripped prior to the generation of the address. - + @param SlaveAddress SMBUS Slave Address. Range 0..127. @param Command SMBUS Command. Range 0..255. @param Length SMBUS Data Length. Range 0..32. @@ -39,36 +39,36 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** Macro that returns the SMBUS Slave Address value from an SmBusAddress Parameter value. - - @param SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC + + @param SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC **/ #define SMBUS_LIB_SLAVE_ADDRESS(SmBusAddress) (((SmBusAddress) >> 1) & 0x7f) /** Macro that returns the SMBUS Command value from an SmBusAddress Parameter value. - + @param SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC **/ #define SMBUS_LIB_COMMAND(SmBusAddress) (((SmBusAddress) >> 8) & 0xff) /** Macro that returns the SMBUS Data Length value from an SmBusAddress Parameter value. - - @param SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC + + @param SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC **/ #define SMBUS_LIB_LENGTH(SmBusAddress) (((SmBusAddress) >> 16) & 0x3f) /** Macro that returns the SMBUS PEC value from an SmBusAddress Parameter value. - - @param SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC + + @param SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC **/ #define SMBUS_LIB_PEC(SmBusAddress) ((BOOLEAN) (((SmBusAddress) & BIT22) != 0)) /** Macro that returns the set of reserved bits from an SmBusAddress Parameter value. - - @param SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC + + @param SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC **/ #define SMBUS_LIB_RESERVED(SmBusAddress) ((SmBusAddress) & ~(BIT23 - 2)) @@ -282,7 +282,7 @@ SmBusWriteDataByte ( If Status is not NULL, then the status of the executed command is returned in Status. If Length in SmBusAddress is not zero, then ASSERT(). If any reserved bits of SmBusAddress are set, then ASSERT(). - + @param SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC. @param Status Return status for the executed command. @@ -424,7 +424,7 @@ SmBusReadBlock ( The SMBUS slave address, SMBUS command, and SMBUS length fields of SmBusAddress are required. Bytes are written to the SMBUS from Buffer. The number of bytes written is returned, and will never return a value larger than 32-bytes. - If Status is not NULL, then the status of the executed command is returned in Status. + If Status is not NULL, then the status of the executed command is returned in Status. If Length in SmBusAddress is zero or greater than 32, then ASSERT(). If Buffer is NULL, then ASSERT(). If any reserved bits of SmBusAddress are set, then ASSERT(). diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SmmLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SmmLib.h index 999c410384..7e79171ec9 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SmmLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SmmLib.h @@ -1,16 +1,16 @@ /** @file Library class name: SmmLib - - SMM Library Services that abstracts both S/W SMI generation and detection. + + SMM Library Services that abstracts both S/W SMI generation and detection. Copyright (c) 2007 - 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -19,7 +19,7 @@ /** - Triggers an SMI at boot time. + Triggers an SMI at boot time. This function triggers a software SMM interrupt at boot time. @@ -32,7 +32,7 @@ TriggerBootServiceSoftwareSmi ( /** - Triggers an SMI at run time. + Triggers an SMI at run time. This function triggers a software SMM interrupt at run time. @@ -45,7 +45,7 @@ TriggerRuntimeSoftwareSmi ( /** - Test if a boot time software SMI happened. + Test if a boot time software SMI happened. This function tests if a software SMM interrupt happened. If a software SMM interrupt happened and it was triggered at boot time, it returns TRUE. Otherwise, it returns FALSE. @@ -62,7 +62,7 @@ IsBootServiceSoftwareSmi ( /** - Test if a run time software SMI happened. + Test if a run time software SMI happened. This function tests if a software SMM interrupt happened. If a software SMM interrupt happened and it was triggered at run time, it returns TRUE. Otherwise, it returns FALSE. @@ -78,8 +78,8 @@ IsRuntimeSoftwareSmi ( ); /** - Clear APM SMI Status Bit; Set the EOS bit. - + Clear APM SMI Status Bit; Set the EOS bit. + **/ VOID EFIAPI diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SmmMemLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SmmMemLib.h index d460ae9577..712bb0302a 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SmmMemLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SmmMemLib.h @@ -4,7 +4,7 @@ The SMM Mem Library provides function for checking if buffer is outside SMRAM and valid. It also provides functions for copy data from SMRAM to non-SMRAM, from non-SMRAM to SMRAM, from non-SMRAM to non-SMRAM, or set data in non-SMRAM. - + Copyright (c) 2015, 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 @@ -68,7 +68,7 @@ SmmCopyMemToSmram ( If the check passes, it copies memory and returns EFI_SUCCESS. If the check fails, it returns EFI_SECURITY_VIOLATION. The implementation must be reentrant. - + @param DestinationBuffer The pointer to the destination buffer of the memory copy. @param SourceBuffer The pointer to the source buffer of the memory copy. @param Length The number of bytes to copy from SourceBuffer to DestinationBuffer. @@ -93,7 +93,7 @@ SmmCopyMemFromSmram ( If the check passes, it copies memory and returns EFI_SUCCESS. If the check fails, it returns EFI_SECURITY_VIOLATION. The implementation must be reentrant, and it must handle the case where source buffer overlaps destination buffer. - + @param DestinationBuffer The pointer to the destination buffer of the memory copy. @param SourceBuffer The pointer to the source buffer of the memory copy. @param Length The number of bytes to copy from SourceBuffer to DestinationBuffer. @@ -118,11 +118,11 @@ SmmCopyMem ( It checks if target buffer is valid per processor architecture and not overlap with SMRAM. If the check passes, it fills memory and returns EFI_SUCCESS. If the check fails, it returns EFI_SECURITY_VIOLATION. - + @param Buffer The memory to set. @param Length The number of bytes to set. @param Value The value with which to fill Length bytes of Buffer. - + @retval EFI_SECURITY_VIOLATION The Buffer is invalid per processor architecture or overlap with SMRAM. @retval EFI_SUCCESS Memory is set. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SmmPeriodicSmiLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SmmPeriodicSmiLib.h index dee4d98f55..38999905fb 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SmmPeriodicSmiLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SmmPeriodicSmiLib.h @@ -19,15 +19,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** This function returns a pointer to a table of supported periodic - SMI tick periods in 100 ns units sorted from largest to smallest. - The table contains a array of UINT64 values terminated by a tick + SMI tick periods in 100 ns units sorted from largest to smallest. + The table contains a array of UINT64 values terminated by a tick period value of 0. The returned table must be treated as read-only data and must not be freed. - - @return A pointer to a table of UINT64 tick period values in - 100ns units sorted from largest to smallest terminated + + @return A pointer to a table of UINT64 tick period values in + 100ns units sorted from largest to smallest terminated by a tick period of 0. - + **/ UINT64 * EFIAPI @@ -53,30 +53,30 @@ PeriodicSmiExecutionTime ( ); /** - This function returns control back to the SMM Foundation. When the next + This function returns control back to the SMM Foundation. When the next periodic SMI for the currently executing handler is triggered, the periodic SMI handler will restarted from its registered DispatchFunction entry point. - If this function is not called from within an enabled periodic SMI handler, + If this function is not called from within an enabled periodic SMI handler, then control is returned to the calling function. **/ VOID -EFIAPI +EFIAPI PeriodicSmiExit ( VOID ); /** - This function yields control back to the SMM Foundation. When the next + This function yields control back to the SMM Foundation. When the next periodic SMI for the currently executing handler is triggered, the periodic - SMI handler will be resumed and this function will return. Use of this + SMI handler will be resumed and this function will return. Use of this function requires a seperate stack for the periodic SMI handler. A non zero - stack size must be specified in PeriodicSmiEnable() for this function to be - used. - + stack size must be specified in PeriodicSmiEnable() for this function to be + used. + If the stack size passed into PeriodicSmiEnable() was zero, the 0 is returned. - - If this function is not called from within an enabled periodic SMI handler, + + If this function is not called from within an enabled periodic SMI handler, then 0 is returned. @return The actual time in 100ns units elapsed since this function was @@ -84,21 +84,21 @@ PeriodicSmiExit ( **/ UINT64 -EFIAPI +EFIAPI PeriodicSmiYield ( VOID ); /** - This function is a prototype for a periodic SMI handler function + This function is a prototype for a periodic SMI handler function that may be enabled with PeriodicSmiEnable() and disabled with PeriodicSmiDisable(). @param[in] Context Content registered with PeriodicSmiEnable(). @param[in] ElapsedTime The actual time in 100ns units elapsed since - this function was called. A value of 0 indicates + this function was called. A value of 0 indicates an unknown amount of time. - + **/ typedef VOID @@ -106,48 +106,48 @@ VOID IN CONST VOID *Context OPTIONAL, IN UINT64 ElapsedTime ); - + /** This function enables a periodic SMI handler. - - @param[in, out] DispatchHandle A pointer to the handle associated with the - enabled periodic SMI handler. This is an - optional parameter that may be NULL. If it is - NULL, then the handle will not be returned, - which means that the periodic SMI handler can + + @param[in, out] DispatchHandle A pointer to the handle associated with the + enabled periodic SMI handler. This is an + optional parameter that may be NULL. If it is + NULL, then the handle will not be returned, + which means that the periodic SMI handler can never be disabled. @param[in] DispatchFunction A pointer to a periodic SMI handler function. @param[in] Context Optional content to pass into DispatchFunction. - @param[in] TickPeriod The requested tick period in 100ns units that + @param[in] TickPeriod The requested tick period in 100ns units that control should be givien to the periodic SMI handler. Must be one of the supported values returned by PeriodicSmiSupportedPickPeriod(). @param[in] Cpu Specifies the CPU that is required to execute - the periodic SMI handler. If Cpu is - PERIODIC_SMI_LIBRARY_ANY_CPU, then the periodic - SMI handler will always be executed on the SMST - CurrentlyExecutingCpu, which may vary across - periodic SMIs. If Cpu is between 0 and the SMST + the periodic SMI handler. If Cpu is + PERIODIC_SMI_LIBRARY_ANY_CPU, then the periodic + SMI handler will always be executed on the SMST + CurrentlyExecutingCpu, which may vary across + periodic SMIs. If Cpu is between 0 and the SMST NumberOfCpus, then the periodic SMI will always be executed on the requested CPU. @param[in] StackSize The size, in bytes, of the stack to allocate for use by the periodic SMI handler. If 0, then the default stack will be used. - + @retval EFI_INVALID_PARAMETER DispatchFunction is NULL. - @retval EFI_UNSUPPORTED TickPeriod is not a supported tick period. The - supported tick periods can be retrieved using + @retval EFI_UNSUPPORTED TickPeriod is not a supported tick period. The + supported tick periods can be retrieved using PeriodicSmiSupportedTickPeriod(). - @retval EFI_INVALID_PARAMETER Cpu is not PERIODIC_SMI_LIBRARY_ANY_CPU or in + @retval EFI_INVALID_PARAMETER Cpu is not PERIODIC_SMI_LIBRARY_ANY_CPU or in the range 0 to SMST NumberOfCpus. - @retval EFI_OUT_OF_RESOURCES There are not enough resources to enable the + @retval EFI_OUT_OF_RESOURCES There are not enough resources to enable the periodic SMI handler. - @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate the + @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate the stack speficied by StackSize. @retval EFI_SUCCESS The periodic SMI handler was enabled. - + **/ -EFI_STATUS +EFI_STATUS EFIAPI PeriodicSmiEnable ( IN OUT EFI_HANDLE *DispatchHandle, OPTIONAL @@ -161,24 +161,24 @@ PeriodicSmiEnable ( /** This function disables a periodic SMI handler that has been previously enabled with PeriodicSmiEnable(). - - @param[in] DispatchHandle A handle associated with a previously enabled periodic + + @param[in] DispatchHandle A handle associated with a previously enabled periodic SMI handler. This is an optional parameter that may be NULL. If it is NULL, then the active periodic SMI handlers is disabled. @retval FALSE DispatchHandle is NULL and there is no active periodic SMI handler. - @retval FALSE The periodic SMI handler specified by DispatchHandle has + @retval FALSE The periodic SMI handler specified by DispatchHandle has not been enabled with PeriodicSmiEnable(). - @retval TRUE The periodic SMI handler specified by DispatchHandle has + @retval TRUE The periodic SMI handler specified by DispatchHandle has been disabled. If DispatchHandle is NULL, then the active periodic SMI handler has been disabled. - + **/ -BOOLEAN +BOOLEAN EFIAPI PeriodicSmiDisable ( IN EFI_HANDLE DispatchHandle OPTIONAL ); - + #endif diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SmmServicesTableLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SmmServicesTableLib.h index b8c0d5660f..cc228a574f 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SmmServicesTableLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SmmServicesTableLib.h @@ -24,14 +24,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. extern EFI_SMM_SYSTEM_TABLE2 *gSmst; /** - This function allows the caller to determine if the driver is executing in + This function allows the caller to determine if the driver is executing in System Management Mode(SMM). - This function returns TRUE if the driver is executing in SMM and FALSE if the + This function returns TRUE if the driver is executing in SMM and FALSE if the driver is not executing in SMM. @retval TRUE The driver is executing in System Management Mode (SMM). - @retval FALSE The driver is not executing in System Management Mode (SMM). + @retval FALSE The driver is not executing in System Management Mode (SMM). **/ BOOLEAN diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SynchronizationLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SynchronizationLib.h index bfdf6f4222..247af0c3e7 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SynchronizationLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/SynchronizationLib.h @@ -26,7 +26,7 @@ typedef volatile UINTN SPIN_LOCK; optimal spin lock performance. This function retrieves the spin lock alignment requirements for optimal - performance on a given CPU architecture. The spin lock alignment is byte alignment. + performance on a given CPU architecture. The spin lock alignment is byte alignment. It must be a power of two and is returned by this function. If there are no alignment requirements, then 1 must be returned. The spin lock synchronization functions must function correctly if the spin lock size and alignment values diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiApplicationEntryPoint.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiApplicationEntryPoint.h index c84282397c..ccfc5fbac5 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiApplicationEntryPoint.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiApplicationEntryPoint.h @@ -16,7 +16,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define __UEFI_APPLICATION_ENTRY_POINT_H__ /// -/// Declare the EFI/UEFI Specification Revision to which this driver is implemented +/// Declare the EFI/UEFI Specification Revision to which this driver is implemented /// extern CONST UINT32 _gUefiDriverRevision; @@ -47,7 +47,7 @@ _ModuleEntryPoint ( /** - Required by the EBC compiler and identical in functionality to _ModuleEntryPoint(). + Required by the EBC compiler and identical in functionality to _ModuleEntryPoint(). @param ImageHandle The image handle of the UEFI Application. @param SystemTable A pointer to the EFI System Table. @@ -67,13 +67,13 @@ EfiMain ( /** Invokes the library destructors for all dependent libraries and terminates - the UEFI Application. + the UEFI Application. This function calls ProcessLibraryDestructorList() and the EFI Boot Service Exit() with a status specified by Status. @param Status Status returned by the application that is exiting. - + **/ VOID EFIAPI @@ -89,7 +89,7 @@ Exit ( This function must be called by _ModuleEntryPoint(). This function calls the set of library constructors for the set of library instances that a module depends on. This includes library instances that a module depends on - directly and library instances that a module depends on indirectly through other libraries. + directly and library instances that a module depends on indirectly through other libraries. This function is autogenerated by build tools and those build tools are responsible for collecting the set of library instances, determine which ones have constructors, and calling the library constructors in the proper order based upon each of the library @@ -97,7 +97,7 @@ Exit ( @param ImageHandle The image handle of the UEFI Application. @param SystemTable A pointer to the EFI System Table. - + **/ VOID EFIAPI @@ -114,7 +114,7 @@ ProcessLibraryConstructorList ( This function may be called by _ModuleEntryPoint()or Exit(). This function calls the set of library destructors for the set of library instances that a module depends on. This includes library instances that a module depends on - directly and library instances that a module depends on indirectly through other libraries. + directly and library instances that a module depends on indirectly through other libraries. This function is autogenerated by build tools and those build tools are responsible for collecting the set of library instances, determine which ones have destructors, and calling the library destructors in the proper order based upon each of the library @@ -134,7 +134,7 @@ ProcessLibraryDestructorList ( /** This function calls the set of module entry points. It must be called by _ModuleEntryPoint(). - This function is autogenerated by build tools and those build tools are + This function is autogenerated by build tools and those build tools are responsible for collecting the module entry points and calling them in a specified order. @param ImageHandle The image handle of the UEFI Application. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiDecompressLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiDecompressLib.h index 2a7a91e5c1..ea859474b6 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiDecompressLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiDecompressLib.h @@ -1,9 +1,9 @@ /** @file Provides services to decompress a buffer using the UEFI Decompress algorithm. - The UEFI Decompress Library enables the decompression of objects that - were compressed using the UEFI compression scheme. The UEFI Decompress - Library is independent of environment and requires the caller to allocate + The UEFI Decompress Library enables the decompression of objects that + were compressed using the UEFI compression scheme. The UEFI Decompress + Library is independent of environment and requires the caller to allocate all required memory buffers. Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR> @@ -21,18 +21,18 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define __UEFI_DECPOMPRESS_LIB_H__ /** - Given a compressed source buffer, this function retrieves the size of - the uncompressed buffer and the size of the scratch buffer required + Given a compressed source buffer, this function retrieves the size of + the uncompressed buffer and the size of the scratch buffer required to decompress the compressed source buffer. - Retrieves the size of the uncompressed buffer and the temporary scratch buffer + Retrieves the size of the uncompressed buffer and the temporary scratch buffer required to decompress the buffer specified by Source and SourceSize. If the size of the uncompressed buffer or the size of the scratch buffer cannot - be determined from the compressed data specified by Source and SourceData, + be determined from the compressed data specified by Source and SourceData, then RETURN_INVALID_PARAMETER is returned. Otherwise, the size of the uncompressed buffer is returned in DestinationSize, the size of the scratch buffer is returned in ScratchSize, and RETURN_SUCCESS is returned. - This function does not have scratch buffer available to perform a thorough + This function does not have scratch buffer available to perform a thorough checking of the validity of the source data. It just retrieves the "Original Size" field from the beginning bytes of the source data and output it as DestinationSize. And ScratchSize is specific to the decompression implementation. @@ -47,16 +47,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. that will be generated when the compressed buffer specified by Source and SourceSize is decompressed. @param ScratchSize A pointer to the size, in bytes, of the scratch buffer that - is required to decompress the compressed buffer specified + is required to decompress the compressed buffer specified by Source and SourceSize. - @retval RETURN_SUCCESS The size of the uncompressed data was returned - in DestinationSize and the size of the scratch + @retval RETURN_SUCCESS The size of the uncompressed data was returned + in DestinationSize and the size of the scratch buffer was returned in ScratchSize. - @retval RETURN_INVALID_PARAMETER - The size of the uncompressed data or the size of - the scratch buffer cannot be determined from - the compressed data specified by Source + @retval RETURN_INVALID_PARAMETER + The size of the uncompressed data or the size of + the scratch buffer cannot be determined from + the compressed data specified by Source and SourceSize. **/ RETURN_STATUS @@ -74,10 +74,10 @@ UefiDecompressGetInfo ( Extracts decompressed data to its original form. This function is designed so that the decompression algorithm can be implemented without using any memory services. As a result, this function is not allowed to - call any memory allocation services in its implementation. It is the caller's + call any memory allocation services in its implementation. It is the caller's responsibility to allocate and free the Destination and Scratch buffers. - If the compressed source data specified by Source is successfully decompressed - into Destination, then RETURN_SUCCESS is returned. If the compressed source data + If the compressed source data specified by Source is successfully decompressed + into Destination, then RETURN_SUCCESS is returned. If the compressed source data specified by Source is not in a valid compressed data format, then RETURN_INVALID_PARAMETER is returned. @@ -88,13 +88,13 @@ UefiDecompressGetInfo ( @param Source The source buffer containing the compressed data. @param Destination The destination buffer to store the decompressed data @param Scratch A temporary scratch buffer that is used to perform the decompression. - This is an optional parameter that may be NULL if the + This is an optional parameter that may be NULL if the required scratch buffer size is 0. - - @retval RETURN_SUCCESS Decompression completed successfully, and + + @retval RETURN_SUCCESS Decompression completed successfully, and the uncompressed buffer is returned in Destination. - @retval RETURN_INVALID_PARAMETER - The source buffer specified by Source is corrupted + @retval RETURN_INVALID_PARAMETER + The source buffer specified by Source is corrupted (not in a valid compressed format). **/ RETURN_STATUS diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiDriverEntryPoint.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiDriverEntryPoint.h index f0812bc272..a8b162e544 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiDriverEntryPoint.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiDriverEntryPoint.h @@ -22,18 +22,18 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. extern CONST UINT32 _gDxeRevision; /// -/// Declare the EFI/UEFI Specification Revision to which this driver is implemented +/// Declare the EFI/UEFI Specification Revision to which this driver is implemented /// extern CONST UINT32 _gUefiDriverRevision; /// -/// Declare the number of unload handler in the image. +/// Declare the number of unload handler in the image. /// extern CONST UINT8 _gDriverUnloadImageCount; /** - The entry point of PE/COFF Image for a DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver. + The entry point of PE/COFF Image for a DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver. This function is the entry point for a DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver. This function must call ProcessLibraryConstructorList() and @@ -64,7 +64,7 @@ _ModuleEntryPoint ( /** - Required by the EBC compiler and identical in functionality to _ModuleEntryPoint(). + Required by the EBC compiler and identical in functionality to _ModuleEntryPoint(). This function is required to call _ModuleEntryPoint() passing in ImageHandle, and SystemTable. @@ -86,7 +86,7 @@ EfiMain ( /** Invokes the library destructors for all dependent libraries and terminates the - DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver. + DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver. This function calls ProcessLibraryDestructorList() and the EFI Boot Service Exit() with a status specified by Status. @@ -108,7 +108,7 @@ ExitDriver ( This function must be called by _ModuleEntryPoint(). This function calls the set of library constructors for the set of library instances that a module depends on. This includes library instances that a module depends on - directly and library instances that a module depends on indirectly through other libraries. + directly and library instances that a module depends on indirectly through other libraries. This function is autogenerated by build tools and those build tools are responsible for collecting the set of library instances, determine which ones have constructors, and calling the library constructors in the proper order based upon each of the library @@ -133,7 +133,7 @@ ProcessLibraryConstructorList ( This function may be called by _ModuleEntryPoint() or ExitDriver(). This function calls the set of library destructors for the set of library instances that a module depends on. This includes library instances that a module depends on - directly and library instances that a module depends on indirectly through other libraries. + directly and library instances that a module depends on indirectly through other libraries. This function is autogenerated by build tools and those build tools are responsible for collecting the set of library instances, determine which ones have destructors, and calling the library destructors in the proper order based upon each of the library instances own dependencies. @@ -154,7 +154,7 @@ ProcessLibraryDestructorList ( Autogenerated function that calls a set of module entry points. This function must be called by _ModuleEntryPoint(). - This function calls the set of module entry points. + This function calls the set of module entry points. This function is autogenerated by build tools and those build tools are responsible for collecting the module entry points and calling them in a specified order. @@ -176,7 +176,7 @@ ProcessModuleEntryPointList ( Autogenerated function that calls a set of module unload handlers. This function must be called from the unload handler registered by _ModuleEntryPoint(). - This function calls the set of module unload handlers. + This function calls the set of module unload handlers. This function is autogenerated by build tools and those build tools are responsible for collecting the module unload handlers and calling them in a specified order. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiLib.h index 0e9ac67f99..b77c28acb0 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiLib.h @@ -2,10 +2,10 @@ Provides library functions for common UEFI operations. Only available to DXE and UEFI module types. - The UEFI Library provides functions and macros that simplify the development of - UEFI Drivers and UEFI Applications. These functions and macros help manage EFI - events, build simple locks utilizing EFI Task Priority Levels (TPLs), install - EFI Driver Model related protocols, manage Unicode string tables for UEFI Drivers, + The UEFI Library provides functions and macros that simplify the development of + UEFI Drivers and UEFI Applications. These functions and macros help manage EFI + events, build simple locks utilizing EFI Task Priority Levels (TPLs), install + EFI Driver Model related protocols, manage Unicode string tables for UEFI Drivers, and print messages on the console output and standard error devices. Note that a reserved macro named MDEPKG_NDEBUG is introduced for the intention @@ -13,8 +13,8 @@ defined, then debug and assert related macros wrapped by it are the NULL implementations. Copyright (c) 2006 - 2017, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php. @@ -54,7 +54,7 @@ typedef enum { } EFI_LOCK_STATE; /// -/// EFI Lock +/// EFI Lock /// typedef struct { EFI_TPL Tpl; @@ -99,8 +99,8 @@ typedef struct { #define EFI_TIMER_PERIOD_SECONDS(Seconds) MultU64x32((UINT64)(Seconds), 10000000) /** - Macro that returns the a pointer to the next EFI_MEMORY_DESCRIPTOR in an array - returned from GetMemoryMap(). + Macro that returns the a pointer to the next EFI_MEMORY_DESCRIPTOR in an array + returned from GetMemoryMap(). @param MemoryDescriptor A pointer to an EFI_MEMORY_DESCRIPTOR. @@ -115,7 +115,7 @@ typedef struct { /** Retrieves a pointer to the system configuration table from the EFI System Table based on a specified GUID. - + This function searches the list of configuration tables stored in the EFI System Table for a table with a GUID that matches TableGuid. If a match is found, then a pointer to the configuration table is returned in Table, and EFI_SUCCESS is returned. If a matching GUID @@ -132,7 +132,7 @@ typedef struct { **/ EFI_STATUS EFIAPI -EfiGetSystemConfigurationTable ( +EfiGetSystemConfigurationTable ( IN EFI_GUID *TableGuid, OUT VOID **Table ); @@ -146,7 +146,7 @@ EfiGetSystemConfigurationTable ( no instances of ProtocolGuid in the handle database at the time this function is invoked, then the notification function is still executed one time. In addition, every time a protocol of type ProtocolGuid instance is installed or reinstalled, the notification function is also - executed. This function returns the notification event that was created. + executed. This function returns the notification event that was created. If ProtocolGuid is NULL, then ASSERT(). If NotifyTpl is not a legal TPL value, then ASSERT(). If NotifyFunction is NULL, then ASSERT(). @@ -159,7 +159,7 @@ EfiGetSystemConfigurationTable ( @param NotifyContext The context parameter to pass to NotifyFunction. @param Registration A pointer to a memory location to receive the registration value. This value is passed to LocateHandle() to obtain new handles that - have been added that support the ProtocolGuid-specified protocol. + have been added that support the ProtocolGuid-specified protocol. @return The notification event that was created. @@ -179,7 +179,7 @@ EfiCreateProtocolNotifyEvent( This function creates an event using NotifyTpl, NoifyFunction, and NotifyContext. This event is signaled with EfiNamedEventSignal(). This provides the ability for one or more - listeners on the same event named by the GUID specified by Name. + listeners on the same event named by the GUID specified by Name. If Name is NULL, then ASSERT(). If NotifyTpl is not a legal TPL value, then ASSERT(). If NotifyFunction is NULL, then ASSERT(). @@ -187,7 +187,7 @@ EfiCreateProtocolNotifyEvent( @param Name Supplies GUID name of the event. @param NotifyTpl Supplies the task priority level of the event notifications. @param NotifyFunction Supplies the function to notify when the event is signaled. - @param NotifyContext The context parameter to pass to NotifyFunction. + @param NotifyContext The context parameter to pass to NotifyFunction. @param Registration A pointer to a memory location to receive the registration value. @retval EFI_SUCCESS A named event was created. @@ -257,13 +257,13 @@ EfiEventEmptyFunction ( IN VOID *Context ); -/** +/** Returns the current TPL. - This function returns the current TPL. There is no EFI service to directly - retrieve the current TPL. Instead, the RaiseTPL() function is used to raise - the TPL to TPL_HIGH_LEVEL. This will return the current TPL. The TPL level - can then immediately be restored back to the current TPL level with a call + This function returns the current TPL. There is no EFI service to directly + retrieve the current TPL. Instead, the RaiseTPL() function is used to raise + the TPL to TPL_HIGH_LEVEL. This will return the current TPL. The TPL level + can then immediately be restored back to the current TPL level with a call to RestoreTPL(). @return The current TPL. @@ -278,8 +278,8 @@ EfiGetCurrentTpl ( /** Initializes a basic mutual exclusion lock. - This function initializes a basic mutual exclusion lock to the released state - and returns the lock. Each lock provides mutual exclusion access at its task + This function initializes a basic mutual exclusion lock to the released state + and returns the lock. Each lock provides mutual exclusion access at its task priority level. Since there is no preemption or multiprocessor support in EFI, acquiring the lock only consists of raising to the locks TPL. If Lock is NULL, then ASSERT(). @@ -301,8 +301,8 @@ EfiInitializeLock ( /** Initializes a basic mutual exclusion lock. - This macro initializes the contents of a basic mutual exclusion lock to the - released state. Each lock provides mutual exclusion access at its task + This macro initializes the contents of a basic mutual exclusion lock to the + released state. Each lock provides mutual exclusion access at its task priority level. Since there is no preemption or multiprocessor support in EFI, acquiring the lock only consists of raising to the locks TPL. @@ -318,10 +318,10 @@ EfiInitializeLock ( /** Macro that calls DebugAssert() if an EFI_LOCK structure is not in the locked state. - If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED - bit of PcdDebugProperyMask is set, then this macro evaluates the EFI_LOCK + If MDEPKG_NDEBUG is not defined and the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED + bit of PcdDebugProperyMask is set, then this macro evaluates the EFI_LOCK structure specified by Lock. If Lock is not in the locked state, then - DebugAssert() is called passing in the source filename, source line number, + DebugAssert() is called passing in the source filename, source line number, and Lock. If Lock is NULL, then ASSERT(). @@ -329,7 +329,7 @@ EfiInitializeLock ( @param LockParameter A pointer to the lock to acquire. **/ -#if !defined(MDEPKG_NDEBUG) +#if !defined(MDEPKG_NDEBUG) #define ASSERT_LOCKED(LockParameter) \ do { \ if (DebugAssertEnabled ()) { \ @@ -347,8 +347,8 @@ EfiInitializeLock ( /** Acquires ownership of a lock. - This function raises the system's current task priority level to the task - priority level of the mutual exclusion lock. Then, it places the lock in the + This function raises the system's current task priority level to the task + priority level of the mutual exclusion lock. Then, it places the lock in the acquired state. If Lock is NULL, then ASSERT(). If Lock is not initialized, then ASSERT(). @@ -388,8 +388,8 @@ EfiAcquireLockOrFail ( /** Releases ownership of a lock. - This function transitions a mutual exclusion lock from the acquired state to - the released state, and restores the system's task priority level to its + This function transitions a mutual exclusion lock from the acquired state to + the released state, and restores the system's task priority level to its previous level. If Lock is NULL, then ASSERT(). If Lock is not initialized, then ASSERT(). @@ -411,7 +411,7 @@ EfiReleaseLock ( currently managing the controller specified by ControllerHandle. This test is performed by evaluating if the protocol specified by ProtocolGuid is present on ControllerHandle and is was opened by DriverBindingHandle with an - attribute of EFI_OPEN_PROTOCOL_BY_DRIVER. + attribute of EFI_OPEN_PROTOCOL_BY_DRIVER. If ProtocolGuid is NULL, then ASSERT(). @param ControllerHandle A handle for a controller to test. @@ -444,10 +444,10 @@ EfiTestManagedDevice ( ChildHandle with an attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER. If ProtocolGuid is NULL, then ASSERT(). - @param ControllerHandle A handle for a (parent) controller to test. + @param ControllerHandle A handle for a (parent) controller to test. @param ChildHandle A child handle to test. @param ProtocolGuid Supplies the protocol that the child controller - opens on its parent controller. + opens on its parent controller. @retval EFI_SUCCESS ChildHandle is a child of the ControllerHandle. @retval EFI_UNSUPPORTED ChildHandle is not a child of the @@ -469,26 +469,26 @@ EfiTestChildHandle ( UnicodeStringTable that matches the language code specified by Language, then it is returned in UnicodeString. - @param Language A pointer to the ISO 639-2 language code for the + @param Language A pointer to the ISO 639-2 language code for the Unicode string to look up and return. - @param SupportedLanguages A pointer to the set of ISO 639-2 language codes - that the Unicode string table supports. Language + @param SupportedLanguages A pointer to the set of ISO 639-2 language codes + that the Unicode string table supports. Language must be a member of this set. @param UnicodeStringTable A pointer to the table of Unicode strings. @param UnicodeString A pointer to the Unicode string from UnicodeStringTable that matches the language specified by Language. - @retval EFI_SUCCESS The Unicode string that matches the language + @retval EFI_SUCCESS The Unicode string that matches the language specified by Language was found - in the table of Unicode strings UnicodeStringTable, + in the table of Unicode strings UnicodeStringTable, and it was returned in UnicodeString. @retval EFI_INVALID_PARAMETER Language is NULL. @retval EFI_INVALID_PARAMETER UnicodeString is NULL. @retval EFI_UNSUPPORTED SupportedLanguages is NULL. @retval EFI_UNSUPPORTED UnicodeStringTable is NULL. - @retval EFI_UNSUPPORTED The language specified by Language is not a + @retval EFI_UNSUPPORTED The language specified by Language is not a member of SupportedLanguages. - @retval EFI_UNSUPPORTED The language specified by Language is not + @retval EFI_UNSUPPORTED The language specified by Language is not supported by UnicodeStringTable. **/ @@ -513,7 +513,7 @@ LookupUnicodeString ( return. If Iso639Language is TRUE, then this ASCII string is not assumed to be Null-terminated, and only the first three characters are used. If Iso639Language is FALSE, then this ASCII - string must be Null-terminated. + string must be Null-terminated. @param SupportedLanguages A pointer to a Null-terminated ASCII string that contains a set of ISO 639-2 or RFC 4646 language codes that the Unicode string table supports. Language must be a member of this set. @@ -533,11 +533,11 @@ LookupUnicodeString ( @retval EFI_SUCCESS The Unicode string that matches the language specified by Language was found in the table of Unicode strings UnicodeStringTable, and it was returned in UnicodeString. - @retval EFI_INVALID_PARAMETER Language is NULL. - @retval EFI_INVALID_PARAMETER UnicodeString is NULL. - @retval EFI_UNSUPPORTED SupportedLanguages is NULL. - @retval EFI_UNSUPPORTED UnicodeStringTable is NULL. - @retval EFI_UNSUPPORTED The language specified by Language is not a member of SupportedLanguages. + @retval EFI_INVALID_PARAMETER Language is NULL. + @retval EFI_INVALID_PARAMETER UnicodeString is NULL. + @retval EFI_UNSUPPORTED SupportedLanguages is NULL. + @retval EFI_UNSUPPORTED UnicodeStringTable is NULL. + @retval EFI_UNSUPPORTED The language specified by Language is not a member of SupportedLanguages. @retval EFI_UNSUPPORTED The language specified by Language is not supported by UnicodeStringTable. **/ @@ -554,13 +554,13 @@ LookupUnicodeString2 ( /** This function adds a Unicode string to UnicodeStringTable. - If Language is a member of SupportedLanguages then UnicodeString is added to - UnicodeStringTable. New buffers are allocated for both Language and - UnicodeString. The contents of Language and UnicodeString are copied into - these new buffers. These buffers are automatically freed when + If Language is a member of SupportedLanguages then UnicodeString is added to + UnicodeStringTable. New buffers are allocated for both Language and + UnicodeString. The contents of Language and UnicodeString are copied into + these new buffers. These buffers are automatically freed when FreeUnicodeStringTable() is called. - @param Language A pointer to the ISO 639-2 language code for the Unicode + @param Language A pointer to the ISO 639-2 language code for the Unicode string to add. @param SupportedLanguages A pointer to the set of ISO 639-2 language codes that the Unicode string table supports. @@ -568,19 +568,19 @@ LookupUnicodeString2 ( @param UnicodeStringTable A pointer to the table of Unicode strings. @param UnicodeString A pointer to the Unicode string to add. - @retval EFI_SUCCESS The Unicode string that matches the language - specified by Language was found in the table of - Unicode strings UnicodeStringTable, and it was + @retval EFI_SUCCESS The Unicode string that matches the language + specified by Language was found in the table of + Unicode strings UnicodeStringTable, and it was returned in UnicodeString. @retval EFI_INVALID_PARAMETER Language is NULL. @retval EFI_INVALID_PARAMETER UnicodeString is NULL. @retval EFI_INVALID_PARAMETER UnicodeString is an empty string. @retval EFI_UNSUPPORTED SupportedLanguages is NULL. - @retval EFI_ALREADY_STARTED A Unicode string with language Language is + @retval EFI_ALREADY_STARTED A Unicode string with language Language is already present in UnicodeStringTable. - @retval EFI_OUT_OF_RESOURCES There is not enough memory to add another + @retval EFI_OUT_OF_RESOURCES There is not enough memory to add another Unicode string to UnicodeStringTable. - @retval EFI_UNSUPPORTED The language specified by Language is not a + @retval EFI_UNSUPPORTED The language specified by Language is not a member of SupportedLanguages. **/ @@ -617,21 +617,21 @@ AddUnicodeString ( RFC 4646 language codes separated by ';'. @param UnicodeStringTable A pointer to the table of Unicode strings. Type EFI_UNICODE_STRING_TABLE is defined in "Related Definitions". - @param UnicodeString A pointer to the Unicode string to add. + @param UnicodeString A pointer to the Unicode string to add. @param Iso639Language Specifies the supported language code format. If it is TRUE, then Language and SupportedLanguages follow ISO 639-2 language code format. Otherwise, they follow RFC 4646 language code format. @retval EFI_SUCCESS The Unicode string that matches the language specified by Language was found in the table of Unicode strings UnicodeStringTable, - and it was returned in UnicodeString. - @retval EFI_INVALID_PARAMETER Language is NULL. - @retval EFI_INVALID_PARAMETER UnicodeString is NULL. - @retval EFI_INVALID_PARAMETER UnicodeString is an empty string. - @retval EFI_UNSUPPORTED SupportedLanguages is NULL. + and it was returned in UnicodeString. + @retval EFI_INVALID_PARAMETER Language is NULL. + @retval EFI_INVALID_PARAMETER UnicodeString is NULL. + @retval EFI_INVALID_PARAMETER UnicodeString is an empty string. + @retval EFI_UNSUPPORTED SupportedLanguages is NULL. @retval EFI_ALREADY_STARTED A Unicode string with language Language is already present in - UnicodeStringTable. - @retval EFI_OUT_OF_RESOURCES There is not enough memory to add another Unicode string UnicodeStringTable. + UnicodeStringTable. + @retval EFI_OUT_OF_RESOURCES There is not enough memory to add another Unicode string UnicodeStringTable. @retval EFI_UNSUPPORTED The language specified by Language is not a member of SupportedLanguages. **/ @@ -649,7 +649,7 @@ AddUnicodeString2 ( This function frees the table of Unicode strings in UnicodeStringTable. If UnicodeStringTable is NULL, then EFI_SUCCESS is returned. - Otherwise, each language code, and each Unicode string in the Unicode string + Otherwise, each language code, and each Unicode string in the Unicode string table are freed, and EFI_SUCCESS is returned. @param UnicodeStringTable A pointer to the table of Unicode strings. @@ -668,8 +668,8 @@ FreeUnicodeStringTable ( /** [ATTENTION] This function will be deprecated for security reason. - Returns a pointer to an allocated buffer that contains the contents of a - variable retrieved through the UEFI Runtime Service GetVariable(). The + Returns a pointer to an allocated buffer that contains the contents of a + variable retrieved through the UEFI Runtime Service GetVariable(). The returned buffer is allocated using AllocatePool(). The caller is responsible for freeing this buffer with FreePool(). @@ -694,10 +694,10 @@ GetVariable ( /** [ATTENTION] This function will be deprecated for security reason. - Returns a pointer to an allocated buffer that contains the contents of a - variable retrieved through the UEFI Runtime Service GetVariable(). This + Returns a pointer to an allocated buffer that contains the contents of a + variable retrieved through the UEFI Runtime Service GetVariable(). This function always uses the EFI_GLOBAL_VARIABLE GUID to retrieve variables. - The returned buffer is allocated using AllocatePool(). The caller is + The returned buffer is allocated using AllocatePool(). The caller is responsible for freeing this buffer with FreePool(). If Name is NULL, then ASSERT(). @@ -718,8 +718,8 @@ GetEfiGlobalVariable ( /** - Returns the status whether get the variable success. The function retrieves - variable through the UEFI Runtime Service GetVariable(). The + Returns the status whether get the variable success. The function retrieves + variable through the UEFI Runtime Service GetVariable(). The returned buffer is allocated using AllocatePool(). The caller is responsible for freeing this buffer with FreePool(). @@ -747,10 +747,10 @@ GetVariable2 ( ); /** - Returns a pointer to an allocated buffer that contains the contents of a - variable retrieved through the UEFI Runtime Service GetVariable(). This + Returns a pointer to an allocated buffer that contains the contents of a + variable retrieved through the UEFI Runtime Service GetVariable(). This function always uses the EFI_GLOBAL_VARIABLE GUID to retrieve variables. - The returned buffer is allocated using AllocatePool(). The caller is + The returned buffer is allocated using AllocatePool(). The caller is responsible for freeing this buffer with FreePool(). If Name is NULL, then ASSERT(). @@ -774,76 +774,76 @@ GetEfiGlobalVariable2 ( ); /** - Returns a pointer to an allocated buffer that contains the best matching language - from a set of supported languages. - - This function supports both ISO 639-2 and RFC 4646 language codes, but language - code types may not be mixed in a single call to this function. The language - code returned is allocated using AllocatePool(). The caller is responsible for + Returns a pointer to an allocated buffer that contains the best matching language + from a set of supported languages. + + This function supports both ISO 639-2 and RFC 4646 language codes, but language + code types may not be mixed in a single call to this function. The language + code returned is allocated using AllocatePool(). The caller is responsible for freeing the allocated buffer using FreePool(). This function supports a variable - argument list that allows the caller to pass in a prioritized list of language - codes to test against all the language codes in SupportedLanguages. + argument list that allows the caller to pass in a prioritized list of language + codes to test against all the language codes in SupportedLanguages. If SupportedLanguages is NULL, then ASSERT(). @param[in] SupportedLanguages A pointer to a Null-terminated ASCII string that - contains a set of language codes in the format + contains a set of language codes in the format specified by Iso639Language. @param[in] Iso639Language If TRUE, then all language codes are assumed to be in ISO 639-2 format. If FALSE, then all language codes are assumed to be in RFC 4646 language format - @param[in] ... A variable argument list that contains pointers to + @param[in] ... A variable argument list that contains pointers to Null-terminated ASCII strings that contain one or more language codes in the format specified by Iso639Language. The first language code from each of these language code lists is used to determine if it is an exact or - close match to any of the language codes in + close match to any of the language codes in SupportedLanguages. Close matches only apply to RFC 4646 language codes, and the matching algorithm from RFC 4647 - is used to determine if a close match is present. If + is used to determine if a close match is present. If an exact or close match is found, then the matching language code from SupportedLanguages is returned. If no matches are found, then the next variable argument - parameter is evaluated. The variable argument list + parameter is evaluated. The variable argument list is terminated by a NULL. @retval NULL The best matching language could not be found in SupportedLanguages. - @retval NULL There are not enough resources available to return the best matching + @retval NULL There are not enough resources available to return the best matching language. - @retval Other A pointer to a Null-terminated ASCII string that is the best matching + @retval Other A pointer to a Null-terminated ASCII string that is the best matching language in SupportedLanguages. **/ CHAR8 * EFIAPI GetBestLanguage ( - IN CONST CHAR8 *SupportedLanguages, + IN CONST CHAR8 *SupportedLanguages, IN BOOLEAN Iso639Language, ... ); /** - Draws a dialog box to the console output device specified by + Draws a dialog box to the console output device specified by ConOut defined in the EFI_SYSTEM_TABLE and waits for a keystroke - from the console input device specified by ConIn defined in the + from the console input device specified by ConIn defined in the EFI_SYSTEM_TABLE. If there are no strings in the variable argument list, then ASSERT(). If all the strings in the variable argument list are empty, then ASSERT(). @param[in] Attribute Specifies the foreground and background color of the popup. - @param[out] Key A pointer to the EFI_KEY value of the key that was + @param[out] Key A pointer to the EFI_KEY value of the key that was pressed. This is an optional parameter that may be NULL. If it is NULL then no wait for a keypress will be performed. @param[in] ... The variable argument list that contains pointers to Null- - terminated Unicode strings to display in the dialog box. + terminated Unicode strings to display in the dialog box. The variable argument list is terminated by a NULL. **/ VOID EFIAPI CreatePopUp ( - IN UINTN Attribute, + IN UINTN Attribute, OUT EFI_INPUT_KEY *Key, OPTIONAL ... ); @@ -875,13 +875,13 @@ GetGlyphWidth ( of the Unicode characters in String can not be determined, then 0 is returned. The display width of String can be computed by summing the display widths of each Unicode character in String. Unicode characters that are narrow glyphs have a width of 1, and Unicode - characters that are width glyphs have a width of 2. + characters that are width glyphs have a width of 2. If String is not aligned on a 16-bit boundary, then ASSERT(). @param String A pointer to a Null-terminated Unicode string. @return The display length of the Null-terminated Unicode string specified by String. - + **/ UINTN EFIAPI @@ -894,7 +894,7 @@ UnicodeStringDisplayLength ( // /** Create, Signal, and Close the Ready to Boot event using EfiSignalEventReadyToBoot(). - + This function abstracts the signaling of the Ready to Boot Event. The Framework moved from a proprietary to UEFI 2.0 based mechanism. This library abstracts the caller from how this event is created to prevent to code form having to change with the @@ -947,8 +947,8 @@ EfiCreateEventLegacyBoot ( /** Create an EFI event in the Legacy Boot Event Group and allows - the caller to specify a notification function. - + the caller to specify a notification function. + This function abstracts the creation of the Legacy Boot Event. The Framework moved from a proprietary to UEFI 2.0 based mechanism. This library abstracts the caller from how this event is created to prevent @@ -977,10 +977,10 @@ EfiCreateEventLegacyBootEx ( Create an EFI event in the Ready To Boot Event Group. Prior to UEFI 2.0 this was done via a non-standard UEFI extension, and this library - abstracts the implementation mechanism of this event from the caller. - This function abstracts the creation of the Ready to Boot Event. The Framework - moved from a proprietary to UEFI 2.0-based mechanism. This library abstracts - the caller from how this event is created to prevent the code form having to + abstracts the implementation mechanism of this event from the caller. + This function abstracts the creation of the Ready to Boot Event. The Framework + moved from a proprietary to UEFI 2.0-based mechanism. This library abstracts + the caller from how this event is created to prevent the code form having to change with the version of the specification supported. If ReadyToBootEvent is NULL, then ASSERT(). @@ -998,8 +998,8 @@ EfiCreateEventReadyToBoot ( /** Create an EFI event in the Ready To Boot Event Group and allows - the caller to specify a notification function. - + the caller to specify a notification function. + This function abstracts the creation of the Ready to Boot Event. The Framework moved from a proprietary to UEFI 2.0 based mechanism. This library abstracts the caller from how this event is created to prevent @@ -1026,16 +1026,16 @@ EfiCreateEventReadyToBootEx ( /** Initialize a Firmware Volume (FV) Media Device Path node. - - The Framework FwVol Device Path changed to conform to the UEFI 2.0 specification. - This library function abstracts initializing a device path node. - Initialize the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure. This device - path changed in the DXE CIS version 0.92 in a non back ward compatible way to - not conflict with the UEFI 2.0 specification. This function abstracts the + + The Framework FwVol Device Path changed to conform to the UEFI 2.0 specification. + This library function abstracts initializing a device path node. + Initialize the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure. This device + path changed in the DXE CIS version 0.92 in a non back ward compatible way to + not conflict with the UEFI 2.0 specification. This function abstracts the differences from the caller. If FvDevicePathNode is NULL, then ASSERT(). If NameGuid is NULL, then ASSERT(). - + @param FvDevicePathNode The pointer to a FV device path node to initialize @param NameGuid FV file name to use in FvDevicePathNode @@ -1048,14 +1048,14 @@ EfiInitializeFwVolDevicepathNode ( ); /** - Check to see if the Firmware Volume (FV) Media Device Path is valid - - The Framework FwVol Device Path changed to conform to the UEFI 2.0 specification. + Check to see if the Firmware Volume (FV) Media Device Path is valid + + The Framework FwVol Device Path changed to conform to the UEFI 2.0 specification. This library function abstracts validating a device path node. - Check the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure to see if it's valid. - If it is valid, then return the GUID file name from the device path node. Otherwise, - return NULL. This device path changed in the DXE CIS version 0.92 in a non backward - compatible way to not conflict with the UEFI 2.0 specification. This function abstracts + Check the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure to see if it's valid. + If it is valid, then return the GUID file name from the device path node. Otherwise, + return NULL. This device path changed in the DXE CIS version 0.92 in a non backward + compatible way to not conflict with the UEFI 2.0 specification. This function abstracts the differences from the caller. If FvDevicePathNode is NULL, then ASSERT(). @@ -1071,23 +1071,23 @@ EfiGetNameGuidFromFwVolDevicePathNode ( IN CONST MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *FvDevicePathNode ); -/** - Prints a formatted Unicode string to the console output device specified by +/** + Prints a formatted Unicode string to the console output device specified by ConOut defined in the EFI_SYSTEM_TABLE. - This function prints a formatted Unicode string to the console output device - specified by ConOut in EFI_SYSTEM_TABLE and returns the number of Unicode - characters that printed to ConOut. If the length of the formatted Unicode - string is greater than PcdUefiLibMaxPrintBufferSize, then only the first + This function prints a formatted Unicode string to the console output device + specified by ConOut in EFI_SYSTEM_TABLE and returns the number of Unicode + characters that printed to ConOut. If the length of the formatted Unicode + string is greater than PcdUefiLibMaxPrintBufferSize, then only the first PcdUefiLibMaxPrintBufferSize characters are sent to ConOut. If Format is NULL, then ASSERT(). If Format is not aligned on a 16-bit boundary, then ASSERT(). If gST->ConOut is NULL, then ASSERT(). @param Format A null-terminated Unicode format string. - @param ... The variable argument list whose contents are accessed based + @param ... The variable argument list whose contents are accessed based on the format string specified by Format. - + @return Number of Unicode characters printed to ConOut. **/ @@ -1098,23 +1098,23 @@ Print ( ... ); -/** - Prints a formatted Unicode string to the console output device specified by +/** + Prints a formatted Unicode string to the console output device specified by StdErr defined in the EFI_SYSTEM_TABLE. - This function prints a formatted Unicode string to the console output device - specified by StdErr in EFI_SYSTEM_TABLE and returns the number of Unicode - characters that printed to StdErr. If the length of the formatted Unicode - string is greater than PcdUefiLibMaxPrintBufferSize, then only the first + This function prints a formatted Unicode string to the console output device + specified by StdErr in EFI_SYSTEM_TABLE and returns the number of Unicode + characters that printed to StdErr. If the length of the formatted Unicode + string is greater than PcdUefiLibMaxPrintBufferSize, then only the first PcdUefiLibMaxPrintBufferSize characters are sent to StdErr. If Format is NULL, then ASSERT(). If Format is not aligned on a 16-bit boundary, then ASSERT(). If gST->StdErr is NULL, then ASSERT(). @param Format A null-terminated Unicode format string. - @param ... The variable argument list whose contents are accessed based + @param ... The variable argument list whose contents are accessed based on the format string specified by Format. - + @return Number of Unicode characters printed to StdErr. **/ @@ -1125,22 +1125,22 @@ ErrorPrint ( ... ); -/** - Prints a formatted ASCII string to the console output device specified by +/** + Prints a formatted ASCII string to the console output device specified by ConOut defined in the EFI_SYSTEM_TABLE. - This function prints a formatted ASCII string to the console output device - specified by ConOut in EFI_SYSTEM_TABLE and returns the number of ASCII - characters that printed to ConOut. If the length of the formatted ASCII - string is greater than PcdUefiLibMaxPrintBufferSize, then only the first + This function prints a formatted ASCII string to the console output device + specified by ConOut in EFI_SYSTEM_TABLE and returns the number of ASCII + characters that printed to ConOut. If the length of the formatted ASCII + string is greater than PcdUefiLibMaxPrintBufferSize, then only the first PcdUefiLibMaxPrintBufferSize characters are sent to ConOut. If Format is NULL, then ASSERT(). If gST->ConOut is NULL, then ASSERT(). @param Format A null-terminated ASCII format string. - @param ... The variable argument list whose contents are accessed based + @param ... The variable argument list whose contents are accessed based on the format string specified by Format. - + @return Number of ASCII characters printed to ConOut. **/ @@ -1151,22 +1151,22 @@ AsciiPrint ( ... ); -/** - Prints a formatted ASCII string to the console output device specified by +/** + Prints a formatted ASCII string to the console output device specified by StdErr defined in the EFI_SYSTEM_TABLE. - This function prints a formatted ASCII string to the console output device - specified by StdErr in EFI_SYSTEM_TABLE and returns the number of ASCII - characters that printed to StdErr. If the length of the formatted ASCII - string is greater than PcdUefiLibMaxPrintBufferSize, then only the first + This function prints a formatted ASCII string to the console output device + specified by StdErr in EFI_SYSTEM_TABLE and returns the number of ASCII + characters that printed to StdErr. If the length of the formatted ASCII + string is greater than PcdUefiLibMaxPrintBufferSize, then only the first PcdUefiLibMaxPrintBufferSize characters are sent to StdErr. If Format is NULL, then ASSERT(). If gST->StdErr is NULL, then ASSERT(). @param Format A null-terminated ASCII format string. - @param ... The variable argument list whose contents are accessed based + @param ... The variable argument list whose contents are accessed based on the format string specified by Format. - + @return Number of ASCII characters printed to ConErr. **/ @@ -1179,22 +1179,22 @@ AsciiErrorPrint ( /** - Prints a formatted Unicode string to a graphics console device specified by + Prints a formatted Unicode string to a graphics console device specified by ConsoleOutputHandle defined in the EFI_SYSTEM_TABLE at the given (X,Y) coordinates. - This function prints a formatted Unicode string to the graphics console device - specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of - Unicode characters displayed, not including partial characters that may be clipped + This function prints a formatted Unicode string to the graphics console device + specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of + Unicode characters displayed, not including partial characters that may be clipped by the right edge of the display. If the length of the formatted Unicode string is - greater than PcdUefiLibMaxPrintBufferSize, then at most the first + greater than PcdUefiLibMaxPrintBufferSize, then at most the first PcdUefiLibMaxPrintBufferSize characters are printed. The EFI_HII_FONT_PROTOCOL - is used to convert the string to a bitmap using the glyphs registered with the + is used to convert the string to a bitmap using the glyphs registered with the HII database. No wrapping is performed, so any portions of the string the fall outside the active display region will not be displayed. - If a graphics console device is not associated with the ConsoleOutputHandle + If a graphics console device is not associated with the ConsoleOutputHandle defined in the EFI_SYSTEM_TABLE then no string is printed, and 0 is returned. - If the EFI_HII_FONT_PROTOCOL is not present in the handle database, then no + If the EFI_HII_FONT_PROTOCOL is not present in the handle database, then no string is printed, and 0 is returned. If Format is NULL, then ASSERT(). If Format is not aligned on a 16-bit boundary, then ASSERT(). @@ -1207,13 +1207,13 @@ AsciiErrorPrint ( then the foreground color of the current ConOut device in the EFI_SYSTEM_TABLE is used. @param BackGround The background color of the string being printed. This is - an optional parameter that may be NULL. If it is NULL, + an optional parameter that may be NULL. If it is NULL, then the background color of the current ConOut device in the EFI_SYSTEM_TABLE is used. - @param Format A null-terminated Unicode format string. See Print Library + @param Format A null-terminated Unicode format string. See Print Library for the supported format string syntax. - @param ... Variable argument list whose contents are accessed based on - the format string specified by Format. + @param ... Variable argument list whose contents are accessed based on + the format string specified by Format. @return The number of Unicode characters printed. @@ -1230,22 +1230,22 @@ PrintXY ( ); /** - Prints a formatted ASCII string to a graphics console device specified by + Prints a formatted ASCII string to a graphics console device specified by ConsoleOutputHandle defined in the EFI_SYSTEM_TABLE at the given (X,Y) coordinates. - This function prints a formatted ASCII string to the graphics console device - specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of - ASCII characters displayed, not including partial characters that may be clipped + This function prints a formatted ASCII string to the graphics console device + specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of + ASCII characters displayed, not including partial characters that may be clipped by the right edge of the display. If the length of the formatted ASCII string is - greater than PcdUefiLibMaxPrintBufferSize, then at most the first + greater than PcdUefiLibMaxPrintBufferSize, then at most the first PcdUefiLibMaxPrintBufferSize characters are printed. The EFI_HII_FONT_PROTOCOL - is used to convert the string to a bitmap using the glyphs registered with the + is used to convert the string to a bitmap using the glyphs registered with the HII database. No wrapping is performed, so any portions of the string the fall outside the active display region will not be displayed. - If a graphics console device is not associated with the ConsoleOutputHandle + If a graphics console device is not associated with the ConsoleOutputHandle defined in the EFI_SYSTEM_TABLE then no string is printed, and 0 is returned. - If the EFI_HII_FONT_PROTOCOL is not present in the handle database, then no + If the EFI_HII_FONT_PROTOCOL is not present in the handle database, then no string is printed, and 0 is returned. If Format is NULL, then ASSERT(). If gST->ConsoleOutputHandle is NULL, then ASSERT(). @@ -1257,13 +1257,13 @@ PrintXY ( then the foreground color of the current ConOut device in the EFI_SYSTEM_TABLE is used. @param BackGround The background color of the string being printed. This is - an optional parameter that may be NULL. If it is NULL, + an optional parameter that may be NULL. If it is NULL, then the background color of the current ConOut device in the EFI_SYSTEM_TABLE is used. - @param Format A null-terminated ASCII format string. See Print Library + @param Format A null-terminated ASCII format string. See Print Library for the supported format string syntax. - @param ... The variable argument list whose contents are accessed based on - the format string specified by Format. + @param ... The variable argument list whose contents are accessed based on + the format string specified by Format. @return The number of ASCII characters printed. @@ -1281,13 +1281,13 @@ AsciiPrintXY ( /** Installs and completes the initialization of a Driver Binding Protocol instance. - + Installs the Driver Binding Protocol specified by DriverBinding onto the handle specified by DriverBindingHandle. If DriverBindingHandle is NULL, then DriverBinding is installed onto a newly created handle. DriverBindingHandle is typically the same as the driver's ImageHandle, but it can be different if the driver produces multiple - Driver Binding Protocols. - If DriverBinding is NULL, then ASSERT(). + Driver Binding Protocols. + If DriverBinding is NULL, then ASSERT(). If DriverBinding can not be installed onto a handle, then ASSERT(). @param ImageHandle The image handle of the driver. @@ -1320,10 +1320,10 @@ EfiLibInstallDriverBinding ( Protocols onto the driver's DriverBindingHandle. If DriverBindingHandle is NULL, then the protocols are installed onto a newly created handle. DriverBindingHandle is typically the same as the driver's ImageHandle, but it can be different if the - driver produces multiple Driver Binding Protocols. - If DriverBinding is NULL, then ASSERT(). + driver produces multiple Driver Binding Protocols. + If DriverBinding is NULL, then ASSERT(). If the installation fails, then ASSERT(). - + @param ImageHandle The image handle of the driver. @param SystemTable The EFI System Table that was passed to the driver's entry point. @param DriverBinding A Driver Binding Protocol instance that this driver is producing. @@ -1358,8 +1358,8 @@ EfiLibInstallAllDriverProtocols ( optional Component Name and optional Component Name 2 protocols onto the driver's DriverBindingHandle. If DriverBindingHandle is NULL, then the protocols are installed onto a newly created handle. DriverBindingHandle is typically the same as the driver's - ImageHandle, but it can be different if the driver produces multiple Driver Binding Protocols. - If DriverBinding is NULL, then ASSERT(). + ImageHandle, but it can be different if the driver produces multiple Driver Binding Protocols. + If DriverBinding is NULL, then ASSERT(). If the installation fails, then ASSERT(). @param ImageHandle The image handle of the driver. @@ -1394,8 +1394,8 @@ EfiLibInstallDriverBindingComponentName2 ( Component Name, optional Component Name 2, optional Driver Configuration, optional Driver Configuration 2, optional Driver Diagnostic, and optional Driver Diagnostic 2 Protocols onto the driver's DriverBindingHandle. DriverBindingHandle is typically the same as the driver's ImageHandle, but it can be different if the driver - produces multiple Driver Binding Protocols. - If DriverBinding is NULL, then ASSERT(). + produces multiple Driver Binding Protocols. + If DriverBinding is NULL, then ASSERT(). If the installation fails, then ASSERT(). @@ -1430,25 +1430,25 @@ EfiLibInstallAllDriverProtocols2 ( IN CONST EFI_DRIVER_DIAGNOSTICS2_PROTOCOL *DriverDiagnostics2 OPTIONAL ); -/** +/** Appends a formatted Unicode string to a Null-terminated Unicode string - - This function appends a formatted Unicode string to the Null-terminated + + This function appends a formatted Unicode string to the Null-terminated Unicode string specified by String. String is optional and may be NULL. - Storage for the formatted Unicode string returned is allocated using + Storage for the formatted Unicode string returned is allocated using AllocatePool(). The pointer to the appended string is returned. The caller is responsible for freeing the returned string. - + If String is not NULL and not aligned on a 16-bit boundary, then ASSERT(). If FormatString is NULL, then ASSERT(). If FormatString is not aligned on a 16-bit boundary, then ASSERT(). - + @param[in] String A Null-terminated Unicode string. @param[in] FormatString A Null-terminated Unicode format string. @param[in] Marker VA_LIST marker for the variable argument list. @retval NULL There was not enough available memory. - @return Null-terminated Unicode string is that is the formatted + @return Null-terminated Unicode string is that is the formatted string appended to String. **/ CHAR16* @@ -1459,27 +1459,27 @@ CatVSPrint ( IN VA_LIST Marker ); -/** +/** Appends a formatted Unicode string to a Null-terminated Unicode string - - This function appends a formatted Unicode string to the Null-terminated + + This function appends a formatted Unicode string to the Null-terminated Unicode string specified by String. String is optional and may be NULL. - Storage for the formatted Unicode string returned is allocated using + Storage for the formatted Unicode string returned is allocated using AllocatePool(). The pointer to the appended string is returned. The caller is responsible for freeing the returned string. - + If String is not NULL and not aligned on a 16-bit boundary, then ASSERT(). If FormatString is NULL, then ASSERT(). If FormatString is not aligned on a 16-bit boundary, then ASSERT(). - + @param[in] String A Null-terminated Unicode string. @param[in] FormatString A Null-terminated Unicode format string. - @param[in] ... The variable argument list whose contents are - accessed based on the format string specified by + @param[in] ... The variable argument list whose contents are + accessed based on the format string specified by FormatString. @retval NULL There was not enough available memory. - @return Null-terminated Unicode string is that is the formatted + @return Null-terminated Unicode string is that is the formatted string appended to String. **/ CHAR16 * diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiRuntimeLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiRuntimeLib.h index 77e9141148..43258083e6 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiRuntimeLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiRuntimeLib.h @@ -3,8 +3,8 @@ Only available to DXE and UEFI module types. Copyright (c) 2006 - 2017, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php. @@ -34,7 +34,7 @@ EfiAtRuntime ( ); /** - This function allows the caller to determine if UEFI SetVirtualAddressMap() has been called. + This function allows the caller to determine if UEFI SetVirtualAddressMap() has been called. This function returns TRUE after all the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE functions have executed as a result of the OS calling SetVirtualAddressMap(). Prior to this time FALSE @@ -342,7 +342,7 @@ EfiResetSystem ( ); /** - This service is a wrapper for the UEFI Runtime Service ConvertPointer(). + This service is a wrapper for the UEFI Runtime Service ConvertPointer(). The ConvertPointer() function is used by an EFI component during the SetVirtualAddressMap() operation. ConvertPointer()must be called using physical address pointers during the execution of SetVirtualAddressMap(). @@ -370,7 +370,7 @@ EfiConvertPointer ( Determines the new virtual address that is to be used on subsequent memory accesses. For IA32, x64, and EBC, this service is a wrapper for the UEFI Runtime Service - ConvertPointer(). See the UEFI Specification for details. + ConvertPointer(). See the UEFI Specification for details. For IPF, this function interprets Address as a pointer to an EFI_PLABEL structure and both the EntryPoint and GP fields of an EFI_PLABEL are converted from physical to virtiual addressing. Since IPF allows the GP to point to an address outside diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiScsiLib.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiScsiLib.h index 5257f76584..6de2c4fa8f 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiScsiLib.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Library/UefiScsiLib.h @@ -6,13 +6,13 @@ This library class depends on SCSI I/O Protocol defined in UEFI Specification and SCSI-2 industry standard. Copyright (c) 2006 - 2015, 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 +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 -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -52,7 +52,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. optional and may be NULL. @param[in, out] SenseDataLength On input, a pointer to the length in bytes of the SenseData buffer. On output, a pointer to - the number of bytes written to the SenseData buffer. + the number of bytes written to the SenseData buffer. @param[out] HostAdapterStatus The status of the SCSI Host Controller that produces the SCSI bus containing the SCSI target specified by ScsiIo when the SCSI Request Packet was executed. @@ -62,7 +62,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. by ScsiIo when the SCSI Request Packet was executed on the SCSI Host Controller. See the EFI SCSI I/O Protocol in the UEFI Specification for details on - the possible return values. + the possible return values. @retval EFI_SUCCESS The command was executed successfully. See HostAdapterStatus, TargetStatus, SenseDataLength, @@ -135,7 +135,7 @@ ScsiTestUnitReadyCommand ( If SenseDataLength is 0, then this parameter is optional and may be NULL. @param[in, out] SenseDataLength On input, the length in bytes of the SenseData buffer. - On output, the number of bytes written to the SenseData buffer. + On output, the number of bytes written to the SenseData buffer. @param[out] HostAdapterStatus The status of the SCSI Host Controller that produces the SCSI bus containing the SCSI target specified by ScsiIo when the SCSI @@ -147,12 +147,12 @@ ScsiTestUnitReadyCommand ( executed on the SCSI Host Controller. See the EFI SCSI I/O Protocol in the UEFI Specification for details on the possible - return values. + return values. @param[in, out] InquiryDataBuffer A pointer to inquiry data that was generated by the execution of the SCSI Request Packet. This buffer must be allocated by the caller. If InquiryDataLength is 0, then this parameter - is optional and may be NULL. + is optional and may be NULL. @param[in, out] InquiryDataLength On input, a pointer to the length in bytes of the InquiryDataBuffer buffer. On output, a pointer to the number of bytes @@ -160,7 +160,7 @@ ScsiTestUnitReadyCommand ( @param[in] EnableVitalProductData If TRUE, then the supported vital product data is returned in InquiryDataBuffer. If FALSE, then the standard inquiry data is - returned in InquiryDataBuffer. + returned in InquiryDataBuffer. @retval EFI_SUCCESS The command was executed successfully. See HostAdapterStatus, TargetStatus, SenseDataLength, and SenseData in that order @@ -237,7 +237,7 @@ ScsiInquiryCommand ( If SenseDataLength is 0, then this parameter is optional and may be NULL. @param[in, out] SenseDataLength On input, the length in bytes of the SenseData buffer. - On output, the number of bytes written to the SenseData buffer. + On output, the number of bytes written to the SenseData buffer. @param[out] HostAdapterStatus The status of the SCSI Host Controller that produces the SCSI bus containing the SCSI target specified by ScsiIo when the SCSI @@ -249,12 +249,12 @@ ScsiInquiryCommand ( executed on the SCSI Host Controller. See the EFI SCSI I/O Protocol in the UEFI Specification for details on the possible - return values. + return values. @param[in, out] InquiryDataBuffer A pointer to inquiry data that was generated by the execution of the SCSI Request Packet. This buffer must be allocated by the caller. If InquiryDataLength is 0, then this parameter - is optional and may be NULL. + is optional and may be NULL. @param[in, out] InquiryDataLength On input, a pointer to the length in bytes of the InquiryDataBuffer buffer. On output, a pointer to the number of bytes @@ -344,7 +344,7 @@ ScsiInquiryCommandEx ( If SenseDataLength is 0, then this parameter is optional and may be NULL. @param[in, out] SenseDataLength On input, the length in bytes of the SenseData buffer. - On output, the number of bytes written to the SenseData buffer. + On output, the number of bytes written to the SenseData buffer. @param[out] HostAdapterStatus The status of the SCSI Host Controller that produces the SCSI bus containing the SCSI target specified by ScsiIo when the SCSI Request Packet @@ -360,14 +360,14 @@ ScsiInquiryCommandEx ( execution of the SCSI Request Packet. This buffer must be allocated by the caller. If DataLength is 0, then this parameter is optional - and may be NULL. + and may be NULL. @param[in, out] DataLength On input, a pointer to the length in bytes of the DataBuffer buffer. On output, a pointer to the number of bytes written to the DataBuffer - buffer. + buffer. @param[in] DBDField Specifies the DBD field of the CDB for this SCSI Command. - @param[in] PageControl Specifies the PC field of the CDB for this SCSI Command. - @param[in] PageCode Specifies the Page Control field of the CDB for this SCSI Command. + @param[in] PageControl Specifies the PC field of the CDB for this SCSI Command. + @param[in] PageCode Specifies the Page Control field of the CDB for this SCSI Command. @retval EFI_SUCCESS The command was executed successfully. See HostAdapterStatus, TargetStatus, SenseDataLength, diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiDependency.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiDependency.h index da2cfee5f5..4f8e6b86c3 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiDependency.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiDependency.h @@ -2,13 +2,13 @@ Present the dependency expression values in PI. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: PI Version 1.0 @@ -17,16 +17,16 @@ #ifndef __PI_DEPENDENCY_H__ #define __PI_DEPENDENCY_H__ -/// +/// /// If present, this must be the first and only opcode, /// EFI_DEP_BEFORE may be used by DXE and SMM drivers. -/// +/// #define EFI_DEP_BEFORE 0x00 -/// +/// /// If present, this must be the first and only opcode, /// EFI_DEP_AFTER may be used by DXE and SMM drivers. -/// +/// #define EFI_DEP_AFTER 0x01 #define EFI_DEP_PUSH 0x02 @@ -38,10 +38,10 @@ #define EFI_DEP_END 0x08 -/// +/// /// If present, this must be the first opcode, /// EFI_DEP_SOR is only used by DXE driver. -/// +/// #define EFI_DEP_SOR 0x09 -#endif +#endif diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiDxeCis.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiDxeCis.h index 70a34af138..0c2c84f231 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiDxeCis.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiDxeCis.h @@ -2,13 +2,13 @@ Include file matches things in PI. Copyright (c) 2006 - 2017, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that 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. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: PI Version 1.6 @@ -49,8 +49,8 @@ typedef enum { /// EfiGcdMemoryTypeMemoryMappedIo, /// - /// A memory region that is visible to the boot processor. - /// This memory supports byte-addressable non-volatility. + /// A memory region that is visible to the boot processor. + /// This memory supports byte-addressable non-volatility. /// EfiGcdMemoryTypePersistent, // @@ -89,7 +89,7 @@ typedef enum { /// /// The type of allocation to perform. -/// +/// typedef enum { /// /// The GCD memory space map is searched from the lowest address up to the highest address @@ -97,22 +97,22 @@ typedef enum { /// EfiGcdAllocateAnySearchBottomUp, /// - /// The GCD memory space map is searched from the lowest address up + /// The GCD memory space map is searched from the lowest address up /// to the specified MaxAddress looking for unallocated memory ranges. /// EfiGcdAllocateMaxAddressSearchBottomUp, /// - /// The GCD memory space map is checked to see if the memory range starting + /// The GCD memory space map is checked to see if the memory range starting /// at the specified Address is available. /// EfiGcdAllocateAddress, /// - /// The GCD memory space map is searched from the highest address down to the lowest address + /// The GCD memory space map is searched from the highest address down to the lowest address /// looking for unallocated memory ranges. /// EfiGcdAllocateAnySearchTopDown, /// - /// The GCD memory space map is searched from the specified MaxAddress + /// The GCD memory space map is searched from the specified MaxAddress /// down to the lowest address looking for unallocated memory ranges. /// EfiGcdAllocateMaxAddressSearchTopDown, @@ -121,35 +121,35 @@ typedef enum { /// /// EFI_GCD_MEMORY_SPACE_DESCRIPTOR. -/// +/// typedef struct { /// /// The physical address of the first byte in the memory region. Type /// EFI_PHYSICAL_ADDRESS is defined in the AllocatePages() function /// description in the UEFI 2.0 specification. - /// + /// EFI_PHYSICAL_ADDRESS BaseAddress; /// /// The number of bytes in the memory region. - /// + /// UINT64 Length; /// /// The bit mask of attributes that the memory region is capable of supporting. The bit /// mask of available attributes is defined in the GetMemoryMap() function description /// in the UEFI 2.0 specification. - /// + /// UINT64 Capabilities; /// /// The bit mask of attributes that the memory region is currently using. The bit mask of /// available attributes is defined in GetMemoryMap(). - /// + /// UINT64 Attributes; /// /// Type of the memory region. Type EFI_GCD_MEMORY_TYPE is defined in the /// AddMemorySpace() function description. - /// + /// EFI_GCD_MEMORY_TYPE GcdMemoryType; /// @@ -157,7 +157,7 @@ typedef struct { /// PhysicalStart and NumberOfBytes. If this field is NULL, then the memory /// resource is not currently allocated. Type EFI_HANDLE is defined in /// InstallProtocolInterface() in the UEFI 2.0 specification. - /// + /// EFI_HANDLE ImageHandle; /// @@ -166,19 +166,19 @@ typedef struct { /// field is NULL, then the memory resource is not associated with a device that is /// described by a device handle. Type EFI_HANDLE is defined in /// InstallProtocolInterface() in the UEFI 2.0 specification. - /// + /// EFI_HANDLE DeviceHandle; } EFI_GCD_MEMORY_SPACE_DESCRIPTOR; /// /// EFI_GCD_IO_SPACE_DESCRIPTOR. -/// +/// typedef struct { /// /// Physical address of the first byte in the I/O region. Type /// EFI_PHYSICAL_ADDRESS is defined in the AllocatePages() function /// description in the UEFI 2.0 specification. - /// + /// EFI_PHYSICAL_ADDRESS BaseAddress; /// @@ -186,18 +186,18 @@ typedef struct { /// UINT64 Length; - /// + /// /// Type of the I/O region. Type EFI_GCD_IO_TYPE is defined in the /// AddIoSpace() function description. - /// + /// EFI_GCD_IO_TYPE GcdIoType; - /// + /// /// The image handle of the agent that allocated the I/O resource described by /// PhysicalStart and NumberOfBytes. If this field is NULL, then the I/O /// resource is not currently allocated. Type EFI_HANDLE is defined in /// InstallProtocolInterface() in the UEFI 2.0 specification. - /// + /// EFI_HANDLE ImageHandle; /// @@ -206,7 +206,7 @@ typedef struct { /// the I/O resource is not associated with a device that is described by a device handle. /// Type EFI_HANDLE is defined in InstallProtocolInterface() in the UEFI /// 2.0 specification. - /// + /// EFI_HANDLE DeviceHandle; } EFI_GCD_IO_SPACE_DESCRIPTOR; @@ -220,7 +220,7 @@ typedef struct { of the memory resource being added. @param Length The size, in bytes, of the memory resource that is being added. - @param Capabilities The bit mask of attributes that the memory + @param Capabilities The bit mask of attributes that the memory resource region supports. @retval EFI_SUCCESS The memory resource was added to the global @@ -228,13 +228,13 @@ typedef struct { @retval EFI_INVALID_PARAMETER GcdMemoryType is invalid. @retval EFI_INVALID_PARAMETER Length is zero. @retval EFI_OUT_OF_RESOURCES There are not enough system resources to add - the memory resource to the global coherency + the memory resource to the global coherency domain of the processor. @retval EFI_UNSUPPORTED The processor does not support one or more bytes - of the memory resource range specified by + of the memory resource range specified by BaseAddress and Length. @retval EFI_ACCESS_DENIED One or more bytes of the memory resource range - specified by BaseAddress and Length conflicts + specified by BaseAddress and Length conflicts with a memory resource range that was previously added to the global coherency domain of the processor. @retval EFI_ACCESS_DENIED One or more bytes of the memory resource range @@ -262,7 +262,7 @@ EFI_STATUS @param Length The size in bytes of the memory resource range that is being allocated. @param BaseAddress A pointer to a physical address to allocate. - @param Imagehandle The image handle of the agent that is allocating + @param Imagehandle The image handle of the agent that is allocating the memory resource. @param DeviceHandle The device handle for which the memory resource is being allocated. @@ -302,7 +302,7 @@ EFI_STATUS @retval EFI_SUCCESS The memory resource was freed from the global coherency domain of the processor. - @retval EFI_INVALID_PARAMETER Length is zero. + @retval EFI_INVALID_PARAMETER Length is zero. @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory resource range specified by BaseAddress and Length. @retval EFI_NOT_FOUND The memory resource range specified by BaseAddress and @@ -327,7 +327,7 @@ EFI_STATUS @retval EFI_SUCCESS The memory resource was removed from the global coherency domain of the processor. - @retval EFI_INVALID_PARAMETER Length is zero. + @retval EFI_INVALID_PARAMETER Length is zero. @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory resource range specified by BaseAddress and Length. @retval EFI_NOT_FOUND One or more bytes of the memory resource range specified by @@ -374,7 +374,7 @@ EFI_STATUS @param Attributes The bit mask of attributes to set for the memory region. @retval EFI_SUCCESS The attributes were set for the memory region. - @retval EFI_INVALID_PARAMETER Length is zero. + @retval EFI_INVALID_PARAMETER Length is zero. @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory resource range specified by BaseAddress and Length. @retval EFI_UNSUPPORTED The bit mask of attributes is not support for the memory resource @@ -610,8 +610,8 @@ EFI_STATUS /** Loads and executed DXE drivers from firmware volumes. - The Dispatch() function searches for DXE drivers in firmware volumes that have been - installed since the last time the Dispatch() service was called. It then evaluates + The Dispatch() function searches for DXE drivers in firmware volumes that have been + installed since the last time the Dispatch() service was called. It then evaluates the dependency expressions of all the DXE drivers and loads and executes those DXE drivers whose dependency expression evaluate to TRUE. This service must interact with the Security Architectural Protocol to authenticate DXE drivers before they are executed. @@ -679,7 +679,7 @@ EFI_STATUS @retval EFI_VOLUME_CORRUPTED The firmware volume described by FirmwareVolumeHeader and Size is corrupted. @retval EFI_OUT_OF_RESOURCES There are not enough system resources available to produce the - EFI_FIRMWARE_VOLUME_PROTOCOL and EFI_DEVICE_PATH_PROTOCOL + EFI_FIRMWARE_VOLUME_PROTOCOL and EFI_DEVICE_PATH_PROTOCOL for the firmware volume described by FirmwareVolumeHeader and Size. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiI2c.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiI2c.h index 4aa55f5e3e..d7abd505b4 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiI2c.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiI2c.h @@ -2,13 +2,13 @@ Include file matches things in PI. Copyright (c) 2013, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that 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. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: PI Version 1.3 diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiMultiPhase.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiMultiPhase.h index 1669740484..08f1fcbdf9 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiMultiPhase.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiMultiPhase.h @@ -2,13 +2,13 @@ Include file matches things in PI for multiple module types. Copyright (c) 2006 - 2015, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that 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. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: These elements are defined in UEFI Platform Initialization Specification 1.2. @@ -30,10 +30,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. Produces an error code in the range reserved for use by the Platform Initialization Architecture Specification. - The supported 32-bit range is 0xA0000000-0xBFFFFFFF - The supported 64-bit range is 0xA000000000000000-0xBFFFFFFFFFFFFFFF + The supported 32-bit range is 0xA0000000-0xBFFFFFFF + The supported 64-bit range is 0xA000000000000000-0xBFFFFFFFFFFFFFFF - @param StatusCode The status code value to convert into a warning code. + @param StatusCode The status code value to convert into a warning code. StatusCode must be in the range 0x00000000..0x1FFFFFFF. @return The value specified by StatusCode in the PI reserved range. @@ -47,7 +47,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define EFI_REQUEST_UNLOAD_IMAGE DXE_ERROR (1) /// -/// If this value is returned by an API, it means the capability is not yet +/// If this value is returned by an API, it means the capability is not yet /// installed/available/ready to use. /// #define EFI_NOT_AVAILABLE_YET DXE_ERROR (2) @@ -66,9 +66,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /// #define PI_ENCODE_ERROR(a) (MAX_BIT | (MAX_BIT >> 2) | (a)) -/// +/// /// Return status codes defined in SMM CIS. -/// +/// #define EFI_INTERRUPT_PENDING PI_ENCODE_ERROR (0) #define EFI_WARN_INTERRUPT_SOURCE_PENDING PI_ENCODE_WARNING (0) @@ -76,7 +76,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /// /// Bitmask of values for Authentication Status. -/// Authentication Status is returned from EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL +/// Authentication Status is returned from EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL /// and the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI /// /// xx00 Image was not signed. @@ -123,7 +123,7 @@ typedef struct { /// Designates the address of the MMRAM, as seen by software executing on the /// processors. This address may or may not match PhysicalStart. /// - EFI_PHYSICAL_ADDRESS CpuStart; + EFI_PHYSICAL_ADDRESS CpuStart; /// /// Describes the number of bytes in the MMRAM region. /// diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiPeiCis.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiPeiCis.h index 1c72b10c01..8427675b43 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiPeiCis.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiPeiCis.h @@ -2,14 +2,14 @@ PI PEI master include file. This file should match the PI spec. Copyright (c) 2006 - 2017, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that 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. + +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: PI Version 1.6. @@ -24,22 +24,22 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /// /// The handles of EFI FV. -/// +/// typedef VOID *EFI_PEI_FV_HANDLE; /// /// The handles of EFI FFS. -/// +/// typedef VOID *EFI_PEI_FILE_HANDLE; /// /// Declare the forward reference data structure for EFI_PEI_SERVICE. -/// +/// typedef struct _EFI_PEI_SERVICES EFI_PEI_SERVICES; /// /// Declare the forward reference data structure for EFI_PEI_NOTIFY_DESCRIPTOR. -/// +/// typedef struct _EFI_PEI_NOTIFY_DESCRIPTOR EFI_PEI_NOTIFY_DESCRIPTOR; @@ -48,8 +48,8 @@ typedef struct _EFI_PEI_NOTIFY_DESCRIPTOR EFI_PEI_NOTIFY_DESCRIPTOR; /** - The PEI Dispatcher will invoke each PEIM one time. During this pass, the PEI - Dispatcher will pass control to the PEIM at the AddressOfEntryPoint in the PE Header. + The PEI Dispatcher will invoke each PEIM one time. During this pass, the PEI + Dispatcher will pass control to the PEIM at the AddressOfEntryPoint in the PE Header. @param FileHandle Pointer to the FFS file header. @param PeiServices Describes the list of possible PEI Services. @@ -95,7 +95,7 @@ EFI_STATUS /// /// The data structure through which a PEIM describes available services to the PEI Foundation. -/// +/// typedef struct { /// /// This field is a set of flags describing the characteristics of this imported table entry. @@ -112,10 +112,10 @@ typedef struct { VOID *Ppi; } EFI_PEI_PPI_DESCRIPTOR; -/// -/// The data structure in a given PEIM that tells the PEI +/// +/// The data structure in a given PEIM that tells the PEI /// Foundation where to invoke the notification service. -/// +/// struct _EFI_PEI_NOTIFY_DESCRIPTOR { /// /// Details if the type of notification are callback or dispatch. @@ -147,9 +147,9 @@ typedef union { } EFI_PEI_DESCRIPTOR; /** - This service is the first one provided by the PEI Foundation. This function - installs an interface in the PEI PPI database by GUID. The purpose of the - service is to publish an interface that other parties can use to call + This service is the first one provided by the PEI Foundation. This function + installs an interface in the PEI PPI database by GUID. The purpose of the + service is to publish an interface that other parties can use to call additional PEIMs. @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table @@ -157,8 +157,8 @@ typedef union { @param PpiList A pointer to the list of interfaces that the caller shall install. @retval EFI_SUCCESS The interface was successfully installed. - @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI - descriptors in the list do not have the + @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI + descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field. @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database. @@ -171,10 +171,10 @@ EFI_STATUS ); /** - This function reinstalls an interface in the PEI PPI database by GUID. - The purpose of the service is to publish an interface that other parties - can use to replace a same-named interface in the protocol database - with a different interface. + This function reinstalls an interface in the PEI PPI database by GUID. + The purpose of the service is to publish an interface that other parties + can use to replace a same-named interface in the protocol database + with a different interface. @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. @@ -182,7 +182,7 @@ EFI_STATUS @param NewPpi A pointer to the new interfaces that the caller shall install. @retval EFI_SUCCESS The interface was successfully installed. - @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the + @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field. @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database. @retval EFI_NOT_FOUND The PPI for which the reinstallation was requested has not been installed. @@ -197,7 +197,7 @@ EFI_STATUS ); /** - This function locates an interface in the PEI PPI database by GUID. + This function locates an interface in the PEI PPI database by GUID. @param PeiServices An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation. @param Guid A pointer to the GUID whose corresponding interface needs to be found. @@ -220,16 +220,16 @@ EFI_STATUS ); /** - This function installs a notification service to be called back when a - given interface is installed or reinstalled. The purpose of the service - is to publish an interface that other parties can use to call additional PPIs + This function installs a notification service to be called back when a + given interface is installed or reinstalled. The purpose of the service + is to publish an interface that other parties can use to call additional PPIs that may materialize later. @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation @param NotifyList A pointer to the list of notification interfaces that the caller shall install. @retval EFI_SUCCESS The interface was successfully installed. - @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL, or any of the PEI PPI descriptors in the + @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL, or any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES bit set in the Flags field. @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database. @@ -274,7 +274,7 @@ EFI_STATUS ); /** - This function returns the pointer to the list of Hand-Off Blocks (HOBs) in memory. + This function returns the pointer to the list of Hand-Off Blocks (HOBs) in memory. @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation @param HobList A pointer to the list of HOBs that the PEI Foundation will initialize @@ -312,8 +312,8 @@ EFI_STATUS ); /** - The purpose of the service is to abstract the capability of the PEI - Foundation to discover instances of firmware volumes in the system. + The purpose of the service is to abstract the capability of the PEI + Foundation to discover instances of firmware volumes in the system. This service enables PEIMs to discover additional firmware volumes. The PEI Foundation uses this service to abstract the locations and formats of various firmware volumes. These volumes include @@ -449,7 +449,7 @@ EFI_STATUS ); /** - The purpose of the service is to publish an interface that allows + The purpose of the service is to publish an interface that allows PEIMs to allocate memory ranges that are managed by the PEI Foundation. Prior to InstallPeiMemory() being called, PEI will allocate pages from the heap. @@ -460,12 +460,12 @@ EFI_STATUS @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. @param MemoryType The type of memory to allocate. @param Pages The number of contiguous 4 KB pages to allocate. - @param Memory A pointer to a physical address. On output, the address is set to the base + @param Memory A pointer to a physical address. On output, the address is set to the base of the page range that was allocated. @retval EFI_SUCCESS The memory range was successfully allocated. @retval EFI_OUT_OF_RESOURCES The pages could not be allocated. - @retval EFI_INVALID_PARAMETER The type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode, + @retval EFI_INVALID_PARAMETER The type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode, EfiRuntimeServicesData, EfiBootServicesCode, EfiBootServicesData, EfiACPIReclaimMemory, EfiReservedMemoryType, or EfiACPIMemoryNVS. @@ -501,7 +501,7 @@ EFI_STATUS ); /** - The purpose of this service is to publish an interface that + The purpose of this service is to publish an interface that allows PEIMs to allocate memory ranges that are managed by the PEI Foundation. @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. @@ -597,7 +597,7 @@ EFI_STATUS This service resets the entire platform, including all processors and devices, and reboots the system. - This service will never return EFI_SUCCESS. + This service will never return EFI_SUCCESS. @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. @@ -739,7 +739,7 @@ typedef struct { @retval EFI_INVALID_PARAMETER FileHandle does not represent a valid file. @retval EFI_INVALID_PARAMETER FileInfo is NULL. - + **/ typedef EFI_STATUS @@ -839,7 +839,7 @@ EFI_STATUS @param FileHandle PEIM's file handle. Must be the currently executing PEIM. - + @retval EFI_SUCCESS The PEIM was successfully registered for shadowing. @retval EFI_ALREADY_STARTED The PEIM was previously @@ -861,8 +861,8 @@ EFI_STATUS #define PEI_SPECIFICATION_MAJOR_REVISION 1 #define PEI_SPECIFICATION_MINOR_REVISION 60 /// -/// Specification inconsistency here: -/// In the PI1.0 spec, PEI_SERVICES_SIGNATURE is defined as 0x5652455320494550. But +/// Specification inconsistency here: +/// In the PI1.0 spec, PEI_SERVICES_SIGNATURE is defined as 0x5652455320494550. But /// to pass a multiple tool chain, it appends an ULL. /// // @@ -870,14 +870,14 @@ EFI_STATUS // #define PEI_SERVICES_SIGNATURE 0x5652455320494550ULL /// -/// Specification inconsistency here: -/// In the PI1.0 specification, there is a typo error in PEI_SERVICES_REVISION. In the specification the defintion is +/// Specification inconsistency here: +/// In the PI1.0 specification, there is a typo error in PEI_SERVICES_REVISION. In the specification the defintion is /// #define ((PEI_SPECIFICATION_MAJOR_REVISION<<16) |(PEI_SPECIFICATION_MINOR_REVISION)) /// and it should be as follows: /// #define PEI_SERVICES_REVISION ((PEI_SPECIFICATION_MAJOR_REVISION<<16) | (PEI_SPECIFICATION_MINOR_REVISION)) -/// +/// /// EFI_PEI_SERVICES is a collection of functions whose implementation is provided by the PEI /// Foundation. These services fall into various classes, including the following: /// - Managing the boot mode @@ -963,63 +963,63 @@ struct _EFI_PEI_SERVICES { /// EFI_SEC_PEI_HAND_OFF structure holds information about /// PEI core's operating environment, such as the size of location of /// temporary RAM, the stack location and BFV location. -/// +/// typedef struct _EFI_SEC_PEI_HAND_OFF { /// /// Size of the data structure. - /// + /// UINT16 DataSize; /// - /// Points to the first byte of the boot firmware volume, - /// which the PEI Dispatcher should search for + /// Points to the first byte of the boot firmware volume, + /// which the PEI Dispatcher should search for /// PEI modules. - /// + /// VOID *BootFirmwareVolumeBase; /// /// Size of the boot firmware volume, in bytes. - /// + /// UINTN BootFirmwareVolumeSize; /// /// Points to the first byte of the temporary RAM. - /// + /// VOID *TemporaryRamBase; /// /// Size of the temporary RAM, in bytes. - /// + /// UINTN TemporaryRamSize; /// - /// Points to the first byte of the temporary RAM - /// available for use by the PEI Foundation. The area - /// described by PeiTemporaryRamBase and PeiTemporaryRamSize + /// Points to the first byte of the temporary RAM + /// available for use by the PEI Foundation. The area + /// described by PeiTemporaryRamBase and PeiTemporaryRamSize /// must not extend outside beyond the area described by /// TemporaryRamBase & TemporaryRamSize. This area should not - /// overlap with the area reported by StackBase and + /// overlap with the area reported by StackBase and /// StackSize. /// VOID *PeiTemporaryRamBase; /// - /// The size of the available temporary RAM available for + /// The size of the available temporary RAM available for /// use by the PEI Foundation, in bytes. - /// + /// UINTN PeiTemporaryRamSize; /// - /// Points to the first byte of the stack. - /// This are may be part of the memory described by - /// TemporaryRamBase and TemporaryRamSize + /// Points to the first byte of the stack. + /// This are may be part of the memory described by + /// TemporaryRamBase and TemporaryRamSize /// or may be an entirely separate area. - /// + /// VOID *StackBase; /// /// Size of the stack, in bytes. - /// + /// UINTN StackSize; } EFI_SEC_PEI_HAND_OFF; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiS3BootScript.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiS3BootScript.h index 466f084ee0..e4ce6880ac 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiS3BootScript.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiS3BootScript.h @@ -1,5 +1,5 @@ /** @file - This file contains the boot script defintions that are shared between the + This file contains the boot script defintions that are shared between the Boot Script Executor PPI and the Boot Script Save Protocol. Copyright (c) 2009, Intel Corporation. All rights reserved.<BR> diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiSmmCis.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiSmmCis.h index eb9f13f13e..087ec4d60e 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiSmmCis.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiSmmCis.h @@ -69,24 +69,24 @@ typedef EFI_MM_INTERRUPT_UNREGISTER EFI_SMM_INTERRUPT_UNREGISTER; typedef struct _EFI_SMM_ENTRY_CONTEXT { EFI_SMM_STARTUP_THIS_AP SmmStartupThisAp; /// - /// A number between zero and the NumberOfCpus field. This field designates which + /// A number between zero and the NumberOfCpus field. This field designates which /// processor is executing the SMM Foundation. /// UINTN CurrentlyExecutingCpu; /// - /// The number of possible processors in the platform. This is a 1 based + /// The number of possible processors in the platform. This is a 1 based /// counter. This does not indicate the number of processors that entered SMM. /// UINTN NumberOfCpus; /// - /// Points to an array, where each element describes the number of bytes in the - /// corresponding save state specified by CpuSaveState. There are always - /// NumberOfCpus entries in the array. + /// Points to an array, where each element describes the number of bytes in the + /// corresponding save state specified by CpuSaveState. There are always + /// NumberOfCpus entries in the array. /// UINTN *CpuSaveStateSize; /// - /// Points to an array, where each element is a pointer to a CPU save state. The - /// corresponding element in CpuSaveStateSize specifies the number of bytes in the + /// Points to an array, where each element is a pointer to a CPU save state. The + /// corresponding element in CpuSaveStateSize specifies the number of bytes in the /// save state area. There are always NumberOfCpus entries in the array. /// VOID **CpuSaveState; @@ -106,8 +106,8 @@ VOID /// /// System Management System Table (SMST) /// -/// The System Management System Table (SMST) is a table that contains a collection of common -/// services for managing SMRAM allocation and providing basic I/O services. These services are +/// The System Management System Table (SMST) is a table that contains a collection of common +/// services for managing SMRAM allocation and providing basic I/O services. These services are /// intended for both preboot and runtime usage. /// struct _EFI_SMM_SYSTEM_TABLE2 { @@ -150,7 +150,7 @@ struct _EFI_SMM_SYSTEM_TABLE2 { /// /// - /// A number between zero and and the NumberOfCpus field. This field designates + /// A number between zero and and the NumberOfCpus field. This field designates /// which processor is executing the SMM infrastructure. /// UINTN CurrentlyExecutingCpu; @@ -159,14 +159,14 @@ struct _EFI_SMM_SYSTEM_TABLE2 { /// UINTN NumberOfCpus; /// - /// Points to an array, where each element describes the number of bytes in the - /// corresponding save state specified by CpuSaveState. There are always - /// NumberOfCpus entries in the array. + /// Points to an array, where each element describes the number of bytes in the + /// corresponding save state specified by CpuSaveState. There are always + /// NumberOfCpus entries in the array. /// UINTN *CpuSaveStateSize; /// - /// Points to an array, where each element is a pointer to a CPU save state. The - /// corresponding element in CpuSaveStateSize specifies the number of bytes in the + /// Points to an array, where each element is a pointer to a CPU save state. The + /// corresponding element in CpuSaveStateSize specifies the number of bytes in the /// save state area. There are always NumberOfCpus entries in the array. /// VOID **CpuSaveState; @@ -180,8 +180,8 @@ struct _EFI_SMM_SYSTEM_TABLE2 { /// UINTN NumberOfTableEntries; /// - /// A pointer to the UEFI Configuration Tables. The number of entries in the table is - /// NumberOfTableEntries. + /// A pointer to the UEFI Configuration Tables. The number of entries in the table is + /// NumberOfTableEntries. /// EFI_CONFIGURATION_TABLE *SmmConfigurationTable; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiStatusCode.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiStatusCode.h index 7eebb34518..e555caf08f 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiStatusCode.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Pi/PiStatusCode.h @@ -2,16 +2,16 @@ StatusCode related definitions in PI. Copyright (c) 2009 - 2017, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that 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. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: - These status codes are defined in UEFI Platform Initialization Specification 1.2, + These status codes are defined in UEFI Platform Initialization Specification 1.2, Volume 3: Shared Architectural Elements. **/ @@ -133,7 +133,7 @@ typedef struct { #define EFI_SOFTWARE 0x03000000 ///@} -/// +/// /// Computing Unit Subclass definitions. /// Values of 8-127 are reserved for future use by this specification. /// Values of 128-255 are reserved for OEM use. @@ -1187,9 +1187,9 @@ typedef struct { /// definitions in the EFI specification. /// ///@{ -#define EFI_SW_EC_ARM_RESET EXCEPT_ARM_RESET -#define EFI_SW_EC_ARM_UNDEFINED_INSTRUCTION EXCEPT_ARM_UNDEFINED_INSTRUCTION -#define EFI_SW_EC_ARM_SOFTWARE_INTERRUPT EXCEPT_ARM_SOFTWARE_INTERRUPT +#define EFI_SW_EC_ARM_RESET EXCEPT_ARM_RESET +#define EFI_SW_EC_ARM_UNDEFINED_INSTRUCTION EXCEPT_ARM_UNDEFINED_INSTRUCTION +#define EFI_SW_EC_ARM_SOFTWARE_INTERRUPT EXCEPT_ARM_SOFTWARE_INTERRUPT #define EFI_SW_EC_ARM_PREFETCH_ABORT EXCEPT_ARM_PREFETCH_ABORT #define EFI_SW_EC_ARM_DATA_ABORT EXCEPT_ARM_DATA_ABORT #define EFI_SW_EC_ARM_RESERVED EXCEPT_ARM_RESERVED diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/PiDxe.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/PiDxe.h index 57ac130d45..d799f54b10 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/PiDxe.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/PiDxe.h @@ -3,12 +3,12 @@ Root include file for Mde Package DXE_CORE, DXE, RUNTIME, SMM, SAL type modules. 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +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. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/PiPei.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/PiPei.h index d35341251e..cdbc24da15 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/PiPei.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/PiPei.h @@ -4,15 +4,15 @@ This is the include file for any module of type PEIM. PEIM modules only use types defined via this include file and can - be ported easily to any environment. + be ported easily to any environment. 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +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. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/PiSmm.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/PiSmm.h index 0e3d8ebcfb..1a188622b6 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/PiSmm.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/PiSmm.h @@ -3,12 +3,12 @@ Root include file for Mde Package SMM modules. Copyright (c) 2009 - 2017, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +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. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/BlockIo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/BlockIo.h index 7331855f57..85600bae0b 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/BlockIo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/BlockIo.h @@ -1,26 +1,26 @@ /** @file - Provides the services required to access a block I/O device during PEI recovery + Provides the services required to access a block I/O device during PEI recovery boot mode. - The Recovery Module PPI and the Device Recovery Module PPI are device neutral. - This PPI is device specific and addresses the most common form of recovery + The Recovery Module PPI and the Device Recovery Module PPI are device neutral. + This PPI is device specific and addresses the most common form of recovery media-block I/O devices such as legacy floppy, CD-ROM, or IDE devices. - The Recovery Block I/O PPI is used to access block devices. Because the Recovery - Block I/O PPIs that are provided by the PEI ATAPI driver and PEI legacy floppy + The Recovery Block I/O PPI is used to access block devices. Because the Recovery + Block I/O PPIs that are provided by the PEI ATAPI driver and PEI legacy floppy driver are the same, here we define a set of general PPIs for both drivers to use. - + Copyright (c) 2007 - 2015, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that 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, +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: - This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 1: + This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 1: Pre-EFI Initalization Core Interface. **/ @@ -50,7 +50,7 @@ typedef UINT64 EFI_PEI_LBA; /// EFI_PEI_BLOCK_DEVICE_TYPE /// typedef enum { - LegacyFloppy = 0, ///< The recovery device is a floppy. + LegacyFloppy = 0, ///< The recovery device is a floppy. IdeCDROM = 1, ///< The recovery device is an IDE CD-ROM IdeLS120 = 2, ///< The recovery device is an IDE LS-120 UsbMassStorage= 3, ///< The recovery device is a USB Mass Storage device @@ -61,22 +61,22 @@ typedef enum { } EFI_PEI_BLOCK_DEVICE_TYPE; /// -/// Specification inconsistency here: +/// Specification inconsistency here: /// PEI_BLOCK_IO_MEDIA has been changed to EFI_PEI_BLOCK_IO_MEDIA. -/// Inconsistency exists in UEFI Platform Initialization Specification 1.2 -/// Volume 1: Pre-EFI Initalization Core Interface, where all referrences to -/// this structure name are with the "EFI_" prefix, except for the definition -/// which is without "EFI_". So the name of PEI_BLOCK_IO_MEDIA is taken as the -/// exception, and EFI_PEI_BLOCK_IO_MEDIA is used to comply with most of +/// Inconsistency exists in UEFI Platform Initialization Specification 1.2 +/// Volume 1: Pre-EFI Initalization Core Interface, where all referrences to +/// this structure name are with the "EFI_" prefix, except for the definition +/// which is without "EFI_". So the name of PEI_BLOCK_IO_MEDIA is taken as the +/// exception, and EFI_PEI_BLOCK_IO_MEDIA is used to comply with most of /// the specification. /// typedef struct { /// - /// The type of media device being referenced by DeviceIndex. + /// The type of media device being referenced by DeviceIndex. /// EFI_PEI_BLOCK_DEVICE_TYPE DeviceType; /// - /// A flag that indicates if media is present. This flag is always set for + /// A flag that indicates if media is present. This flag is always set for /// nonremovable media devices. /// BOOLEAN MediaPresent; @@ -93,16 +93,16 @@ typedef struct { /** Gets the count of block I/O devices that one specific block driver detects. - This function is used for getting the count of block I/O devices that one + This function is used for getting the count of block I/O devices that one specific block driver detects. To the PEI ATAPI driver, it returns the number - of all the detected ATAPI devices it detects during the enumeration process. - To the PEI legacy floppy driver, it returns the number of all the legacy - devices it finds during its enumeration process. If no device is detected, - then the function will return zero. - - @param[in] PeiServices General-purpose services that are available + of all the detected ATAPI devices it detects during the enumeration process. + To the PEI legacy floppy driver, it returns the number of all the legacy + devices it finds during its enumeration process. If no device is detected, + then the function will return zero. + + @param[in] PeiServices General-purpose services that are available to every PEIM. - @param[in] This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI + @param[in] This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance. @param[out] NumberBlockDevices The number of block I/O devices discovered. @@ -120,41 +120,41 @@ EFI_STATUS /** Gets a block device's media information. - This function will provide the caller with the specified block device's media - information. If the media changes, calling this function will update the media + This function will provide the caller with the specified block device's media + information. If the media changes, calling this function will update the media information accordingly. @param[in] PeiServices General-purpose services that are available to every PEIM @param[in] This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance. - @param[in] DeviceIndex Specifies the block device to which the function wants - to talk. Because the driver that implements Block I/O - PPIs will manage multiple block devices, the PPIs that - want to talk to a single device must specify the + @param[in] DeviceIndex Specifies the block device to which the function wants + to talk. Because the driver that implements Block I/O + PPIs will manage multiple block devices, the PPIs that + want to talk to a single device must specify the device index that was assigned during the enumeration - process. This index is a number from one to + process. This index is a number from one to NumberBlockDevices. - @param[out] MediaInfo The media information of the specified block media. - The caller is responsible for the ownership of this + @param[out] MediaInfo The media information of the specified block media. + The caller is responsible for the ownership of this data structure. - @par Note: - The MediaInfo structure describes an enumeration of possible block device - types. This enumeration exists because no device paths are actually passed - across interfaces that describe the type or class of hardware that is publishing + @par Note: + The MediaInfo structure describes an enumeration of possible block device + types. This enumeration exists because no device paths are actually passed + across interfaces that describe the type or class of hardware that is publishing the block I/O interface. This enumeration will allow for policy decisions - in the Recovery PEIM, such as "Try to recover from legacy floppy first, - LS-120 second, CD-ROM third." If there are multiple partitions abstracted - by a given device type, they should be reported in ascending order; this - order also applies to nested partitions, such as legacy MBR, where the - outermost partitions would have precedence in the reporting order. The - same logic applies to systems such as IDE that have precedence relationships - like "Master/Slave" or "Primary/Secondary". The master device should be + in the Recovery PEIM, such as "Try to recover from legacy floppy first, + LS-120 second, CD-ROM third." If there are multiple partitions abstracted + by a given device type, they should be reported in ascending order; this + order also applies to nested partitions, such as legacy MBR, where the + outermost partitions would have precedence in the reporting order. The + same logic applies to systems such as IDE that have precedence relationships + like "Master/Slave" or "Primary/Secondary". The master device should be reported first, the slave second. - - @retval EFI_SUCCESS Media information about the specified block device + + @retval EFI_SUCCESS Media information about the specified block device was obtained successfully. - @retval EFI_DEVICE_ERROR Cannot get the media information due to a hardware + @retval EFI_DEVICE_ERROR Cannot get the media information due to a hardware error. **/ @@ -170,31 +170,31 @@ EFI_STATUS /** Reads the requested number of blocks from the specified block device. - The function reads the requested number of blocks from the device. All the + The function reads the requested number of blocks from the device. All the blocks are read, or an error is returned. If there is no media in the device, the function returns EFI_NO_MEDIA. - @param[in] PeiServices General-purpose services that are available to + @param[in] PeiServices General-purpose services that are available to every PEIM. @param[in] This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance. - @param[in] DeviceIndex Specifies the block device to which the function wants - to talk. Because the driver that implements Block I/O - PPIs will manage multiple block devices, PPIs that - want to talk to a single device must specify the device - index that was assigned during the enumeration process. + @param[in] DeviceIndex Specifies the block device to which the function wants + to talk. Because the driver that implements Block I/O + PPIs will manage multiple block devices, PPIs that + want to talk to a single device must specify the device + index that was assigned during the enumeration process. This index is a number from one to NumberBlockDevices. @param[in] StartLBA The starting logical block address (LBA) to read from on the device @param[in] BufferSize The size of the Buffer in bytes. This number must be a multiple of the intrinsic block size of the device. @param[out] Buffer A pointer to the destination buffer for the data. - The caller is responsible for the ownership of the + The caller is responsible for the ownership of the buffer. - + @retval EFI_SUCCESS The data was read correctly from the device. - @retval EFI_DEVICE_ERROR The device reported an error while attempting + @retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the read operation. - @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not + @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid, or the buffer is not properly aligned. @retval EFI_NO_MEDIA There is no media in the device. @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of @@ -221,12 +221,12 @@ struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI { /// Gets the number of block I/O devices that the specific block driver manages. /// EFI_PEI_GET_NUMBER_BLOCK_DEVICES GetNumberOfBlockDevices; - + /// /// Gets the specified media information. /// EFI_PEI_GET_DEVICE_MEDIA_INFORMATION GetBlockDeviceMediaInfo; - + /// /// Reads the requested number of blocks from the specified block device. /// diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/BootInRecoveryMode.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/BootInRecoveryMode.h index 8671d5141d..b9f1616283 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/BootInRecoveryMode.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/BootInRecoveryMode.h @@ -1,15 +1,15 @@ /** @file - This PPI is installed by the platform PEIM to designate that a recovery boot + This PPI is installed by the platform PEIM to designate that a recovery boot is in progress. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.0. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Capsule.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Capsule.h index 2cc64c5142..fbafe52a11 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Capsule.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Capsule.h @@ -1,12 +1,12 @@ /** @file - Defines the APIs that enable PEI services to work with + Defines the APIs that enable PEI services to work with the underlying capsule capabilities of the platform. Copyright (c) 2015, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that 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. @@ -38,23 +38,23 @@ typedef struct _EFI_PEI_CAPSULE_PPI EFI_PEI_CAPSULE_PPI; typedef struct _EFI_PEI_CAPSULE_PPI PEI_CAPSULE_PPI; /** - Upon determining that there is a capsule to operate on, this service - will use a series of EFI_CAPSULE_BLOCK_DESCRIPTOR entries to determine - the current location of the various capsule fragments and coalesce them - into a contiguous region of system memory. + Upon determining that there is a capsule to operate on, this service + will use a series of EFI_CAPSULE_BLOCK_DESCRIPTOR entries to determine + the current location of the various capsule fragments and coalesce them + into a contiguous region of system memory. @param[in] PeiServices Pointer to the PEI Services Table. @param[out] MemoryBase Pointer to the base of a block of memory into which the buffers will be coalesced. - On output, this variable will hold the base address + On output, this variable will hold the base address of a coalesced capsule. @param[out] MemorySize Size of the memory region pointed to by MemoryBase. On output, this variable will contain the size of the coalesced capsule. - @retval EFI_NOT_FOUND If: boot modecould not be determined, or the - boot mode is not flash-update, or the capsule descriptors were not found. - @retval EFI_BUFFER_TOO_SMALL The capsule could not be coalesced in the provided memory region. - @retval EFI_SUCCESS There was no capsule, or the capsule was processed successfully. + @retval EFI_NOT_FOUND If: boot modecould not be determined, or the + boot mode is not flash-update, or the capsule descriptors were not found. + @retval EFI_BUFFER_TOO_SMALL The capsule could not be coalesced in the provided memory region. + @retval EFI_SUCCESS There was no capsule, or the capsule was processed successfully. **/ typedef @@ -66,12 +66,12 @@ EFI_STATUS ); /** - Determine if a capsule needs to be processed. + Determine if a capsule needs to be processed. The means by which the presence of a capsule is determined is platform - specific. For example, an implementation could be driven by the presence - of a Capsule EFI Variable containing a list of EFI_CAPSULE_BLOCK_DESCRIPTOR + specific. For example, an implementation could be driven by the presence + of a Capsule EFI Variable containing a list of EFI_CAPSULE_BLOCK_DESCRIPTOR entries. If present, return EFI_SUCCESS, otherwise return EFI_NOT_FOUND. - + @param[in] PeiServices Pointer to the PEI Services Table. @retval EFI_SUCCESS If a capsule is available. @@ -87,9 +87,9 @@ EFI_STATUS /** The Capsule PPI service that gets called after memory is available. The capsule coalesce function, which must be called first, returns a base - address and size. Once the memory init PEIM has discovered memory, - it should call this function and pass in the base address and size - returned by the Coalesce() function. Then this function can create a + address and size. Once the memory init PEIM has discovered memory, + it should call this function and pass in the base address and size + returned by the Coalesce() function. Then this function can create a capsule HOB and return. @par Notes: @@ -97,7 +97,7 @@ EFI_STATUS actual capsule update. @param[in] PeiServices Pointer to the PEI Services Table. - @param[in] CapsuleBase Address returned by the capsule coalesce function. + @param[in] CapsuleBase Address returned by the capsule coalesce function. @param[in] CapsuleSize Value returned by the capsule coalesce function. @retval EFI_VOLUME_CORRUPTED CapsuleBase does not appear to point to a @@ -110,13 +110,13 @@ EFI_STATUS (EFIAPI *EFI_PEI_CAPSULE_CREATE_STATE)( IN EFI_PEI_SERVICES **PeiServices, IN VOID *CapsuleBase, - IN UINTN CapsuleSize + IN UINTN CapsuleSize ); /// /// This PPI provides several services in PEI to work with the underlying -/// capsule capabilities of the platform. These services include the ability -/// for PEI to coalesce a capsule from a scattered set of memory locations +/// capsule capabilities of the platform. These services include the ability +/// for PEI to coalesce a capsule from a scattered set of memory locations /// into a contiguous space in memory, detect if a capsule is present for /// processing, and once memory is available, create a HOB for the capsule. /// diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/CpuIo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/CpuIo.h index 410a75b27b..2a110f32d1 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/CpuIo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/CpuIo.h @@ -1,19 +1,19 @@ /** @file - This PPI provides a set of memory and I/O-based services. + This PPI provides a set of memory and I/O-based services. The perspective of the services is that of the processor, not the bus or system. 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that 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, +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.0. - + **/ #ifndef __PEI_CPUIO_PPI_H__ @@ -86,7 +86,7 @@ typedef struct { /** 8-bit I/O read operations. - @param[in] PeiServices An indirect pointer to the PEI Services Table published + @param[in] PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. @param[in] This The pointer to local data for the interface. @param[in] Address The physical address of the access. @@ -105,7 +105,7 @@ UINT8 /** 16-bit I/O read operations. - @param[in] PeiServices An indirect pointer to the PEI Services Table published + @param[in] PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. @param[in] This The pointer to local data for the interface. @param[in] Address The physical address of the access. @@ -124,7 +124,7 @@ UINT16 /** 32-bit I/O read operations. - @param[in] PeiServices An indirect pointer to the PEI Services Table published + @param[in] PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. @param[in] This The pointer to local data for the interface. @param[in] Address The physical address of the access. @@ -143,7 +143,7 @@ UINT32 /** 64-bit I/O read operations. - @param[in] PeiServices An indirect pointer to the PEI Services Table published + @param[in] PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. @param[in] This The pointer to local data for the interface. @param[in] Address The physical address of the access. @@ -162,7 +162,7 @@ UINT64 /** 8-bit I/O write operations. - @param[in] PeiServices An indirect pointer to the PEI Services Table published + @param[in] PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. @param[in] This The pointer to local data for the interface. @param[in] Address The physical address of the access. @@ -181,7 +181,7 @@ VOID /** 16-bit I/O write operations. - @param[in] PeiServices An indirect pointer to the PEI Services Table published + @param[in] PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. @param[in] This The pointer to local data for the interface. @param[in] Address The physical address of the access. @@ -200,7 +200,7 @@ VOID /** 32-bit I/O write operations. - @param[in] PeiServices An indirect pointer to the PEI Services Table published + @param[in] PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. @param[in] This The pointer to local data for the interface. @param[in] Address The physical address of the access. @@ -219,7 +219,7 @@ VOID /** 64-bit I/O write operations. - @param[in] PeiServices An indirect pointer to the PEI Services Table published + @param[in] PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. @param[in] This The pointer to local data for the interface. @param[in] Address The physical address of the access. @@ -238,7 +238,7 @@ VOID /** 8-bit memory read operations. - @param[in] PeiServices An indirect pointer to the PEI Services Table published + @param[in] PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. @param[in] This The pointer to local data for the interface. @param[in] Address The physical address of the access. @@ -257,7 +257,7 @@ UINT8 /** 16-bit memory read operations. - @param[in] PeiServices An indirect pointer to the PEI Services Table published + @param[in] PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. @param[in] This The pointer to local data for the interface. @param[in] Address The physical address of the access. @@ -276,7 +276,7 @@ UINT16 /** 32-bit memory read operations. - @param[in] PeiServices An indirect pointer to the PEI Services Table published + @param[in] PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. @param[in] This The pointer to local data for the interface. @param[in] Address The physical address of the access. @@ -295,7 +295,7 @@ UINT32 /** 64-bit memory read operations. - @param[in] PeiServices An indirect pointer to the PEI Services Table published + @param[in] PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. @param[in] This The pointer to local data for the interface. @param[in] Address The physical address of the access. @@ -314,7 +314,7 @@ UINT64 /** 8-bit memory write operations. - @param[in] PeiServices An indirect pointer to the PEI Services Table published + @param[in] PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. @param[in] This The pointer to local data for the interface. @param[in] Address The physical address of the access. @@ -333,7 +333,7 @@ VOID /** 16-bit memory write operations. - @param[in] PeiServices An indirect pointer to the PEI Services Table published + @param[in] PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. @param[in] This The pointer to local data for the interface. @param[in] Address The physical address of the access. @@ -352,7 +352,7 @@ VOID /** 32-bit memory write operations. - @param[in] PeiServices An indirect pointer to the PEI Services Table published + @param[in] PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. @param[in] This The pointer to local data for the interface. @param[in] Address The physical address of the access. @@ -371,7 +371,7 @@ VOID /** 64-bit memory write operations. - @param[in] PeiServices An indirect pointer to the PEI Services Table published + @param[in] PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation. @param[in] This The pointer to local data for the interface. @param[in] Address The physical address of the access. @@ -389,7 +389,7 @@ VOID /// /// EFI_PEI_CPU_IO_PPI provides a set of memory and I/O-based services. -/// The perspective of the services is that of the processor, not that of the +/// The perspective of the services is that of the processor, not that of the /// bus or system. /// struct _EFI_PEI_CPU_IO_PPI { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Decompress.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Decompress.h index 49678e9dbe..23fd3c7313 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Decompress.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Decompress.h @@ -2,13 +2,13 @@ Provides decompression services to the PEI Foundatoin. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.0. @@ -23,9 +23,9 @@ typedef struct _EFI_PEI_DECOMPRESS_PPI EFI_PEI_DECOMPRESS_PPI; -/** +/** Decompress a single compression section in a firmware file. - + Decompresses the data in a compressed section and returns it as a series of standard PI Firmware File Sections. The required memory is allocated from permanent memory. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/DeviceRecoveryModule.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/DeviceRecoveryModule.h index 6f3a2174ca..84613b201b 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/DeviceRecoveryModule.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/DeviceRecoveryModule.h @@ -20,7 +20,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: - This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 1: + This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 1: Pre-EFI Initalization Core Interface **/ @@ -39,18 +39,18 @@ typedef struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI EFI_PEI_DEVICE_RECOVERY_MODUL Returns the number of DXE capsules residing on the device. This function searches for DXE capsules from the associated device and returns - the number and maximum size in bytes of the capsules discovered. Entry 1 is - assumed to be the highest load priority and entry N is assumed to be the lowest + the number and maximum size in bytes of the capsules discovered. Entry 1 is + assumed to be the highest load priority and entry N is assumed to be the lowest priority. - @param[in] PeiServices General-purpose services that are available + @param[in] PeiServices General-purpose services that are available to every PEIM @param[in] This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance. - @param[out] NumberRecoveryCapsules Pointer to a caller-allocated UINTN. On - output, *NumberRecoveryCapsules contains - the number of recovery capsule images - available for retrieval from this PEIM + @param[out] NumberRecoveryCapsules Pointer to a caller-allocated UINTN. On + output, *NumberRecoveryCapsules contains + the number of recovery capsule images + available for retrieval from this PEIM instance. @retval EFI_SUCCESS One or more capsules were discovered. @@ -72,18 +72,18 @@ EFI_STATUS This function gets the size and type of the capsule specified by CapsuleInstance. @param[in] PeiServices General-purpose services that are available to every PEIM - @param[in] This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI + @param[in] This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance. - @param[in] CapsuleInstance Specifies for which capsule instance to retrieve - the information. This parameter must be between - one and the value returned by GetNumberRecoveryCapsules() + @param[in] CapsuleInstance Specifies for which capsule instance to retrieve + the information. This parameter must be between + one and the value returned by GetNumberRecoveryCapsules() in NumberRecoveryCapsules. - @param[out] Size A pointer to a caller-allocated UINTN in which - the size of the requested recovery module is + @param[out] Size A pointer to a caller-allocated UINTN in which + the size of the requested recovery module is returned. - @param[out] CapsuleType A pointer to a caller-allocated EFI_GUID in which - the type of the requested recovery capsule is - returned. The semantic meaning of the value + @param[out] CapsuleType A pointer to a caller-allocated EFI_GUID in which + the type of the requested recovery capsule is + returned. The semantic meaning of the value returned is defined by the implementation. @retval EFI_SUCCESS One or more capsules were discovered. @@ -107,12 +107,12 @@ EFI_STATUS This function, by whatever mechanism, retrieves a DXE capsule from some device and loads it into memory. Note that the published interface is device neutral. - @param[in] PeiServices General-purpose services that are available + @param[in] PeiServices General-purpose services that are available to every PEIM @param[in] This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance. @param[in] CapsuleInstance Specifies which capsule instance to retrieve. - @param[out] Buffer Specifies a caller-allocated buffer in which + @param[out] Buffer Specifies a caller-allocated buffer in which the requested recovery capsule will be returned. @retval EFI_SUCCESS The capsule was loaded correctly. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/DxeIpl.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/DxeIpl.h index 3d3d1f3c4d..547c8b542c 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/DxeIpl.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/DxeIpl.h @@ -3,13 +3,13 @@ When the PEI core is done it calls the DXE IPL PPI to load the DXE Foundation. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.0. @@ -27,7 +27,7 @@ typedef struct _EFI_DXE_IPL_PPI EFI_DXE_IPL_PPI; /** - The architectural PPI that the PEI Foundation invokes when + The architectural PPI that the PEI Foundation invokes when there are no additional PEIMs to invoke. This function is invoked by the PEI Foundation. @@ -46,7 +46,7 @@ typedef struct _EFI_DXE_IPL_PPI EFI_DXE_IPL_PPI; @param HobList Pointer to the list of Hand-Off Block (HOB) entries. @retval EFI_SUCCESS Upon this return code, the PEI Foundation should enter - some exception handling.Under normal circumstances, + some exception handling.Under normal circumstances, the DXE IPL PPI should not return. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/EndOfPeiPhase.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/EndOfPeiPhase.h index b123c79dcd..dabb25f8d2 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/EndOfPeiPhase.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/EndOfPeiPhase.h @@ -1,17 +1,17 @@ /** @file - This PPI will be installed at the end of PEI for all boot paths, including - normal, recovery, and S3. It allows for PEIMs to possibly quiesce hardware, - build handoff information for the next phase of execution, + This PPI will be installed at the end of PEI for all boot paths, including + normal, recovery, and S3. It allows for PEIMs to possibly quiesce hardware, + build handoff information for the next phase of execution, or provide some terminal processing behavior. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.0. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/FirmwareVolume.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/FirmwareVolume.h index 37eaa2129e..2a110ce3ae 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/FirmwareVolume.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/FirmwareVolume.h @@ -2,13 +2,13 @@ This file provides functions for accessing a memory-mapped firmware volume of a specific format. Copyright (c) 2006 - 2013, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is from PI Version 1.0 errata. @@ -22,7 +22,7 @@ /// The GUID for this PPI is the same as the firmware volume format GUID. /// The FV format can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for a user-defined /// format. The EFI_FIRMWARE_FILE_SYSTEM2_GUID is the PI Firmware Volume format. -/// +/// typedef struct _EFI_PEI_FIRMWARE_VOLUME_PPI EFI_PEI_FIRMWARE_VOLUME_PPI; @@ -36,15 +36,15 @@ typedef struct _EFI_PEI_FIRMWARE_VOLUME_PPI EFI_PEI_FIRMWARE_VOLUME_PPI; buffer which contains the necessary information for creating the firmware volume handle. Normally, these values are derived from the EFI_FIRMWARE_VOLUME_INFO_PPI. - - + + @param This Points to this instance of the EFI_PEI_FIRMWARE_VOLUME_PPI. @param Buffer Points to the start of the buffer. @param BufferSize Size of the buffer. @param FvHandle Points to the returned firmware volume handle. The firmware volume handle must - be unique within the system. + be unique within the system. @retval EFI_SUCCESS Firmware volume handle created. @retval EFI_VOLUME_CORRUPTED Volume was corrupt. @@ -62,7 +62,7 @@ EFI_STATUS /** Finds the next file of the specified type. - This service enables PEI modules to discover additional firmware files. + This service enables PEI modules to discover additional firmware files. The FileHandle must be unique within the system. @param This Points to this instance of the @@ -80,20 +80,20 @@ EFI_STATUS @retval EFI_SUCCESS The file was found. @retval EFI_NOT_FOUND The file was not found. FileHandle contains NULL. -**/ +**/ typedef EFI_STATUS -(EFIAPI *EFI_PEI_FV_FIND_FILE_TYPE)( - IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, - IN EFI_FV_FILETYPE SearchType, +(EFIAPI *EFI_PEI_FV_FIND_FILE_TYPE)( + IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, + IN EFI_FV_FILETYPE SearchType, IN EFI_PEI_FV_HANDLE FvHandle, - IN OUT EFI_PEI_FILE_HANDLE *FileHandle + IN OUT EFI_PEI_FILE_HANDLE *FileHandle ); /** - Find a file within a volume by its name. - + Find a file within a volume by its name. + This service searches for files with a specific name, within either the specified firmware volume or all firmware volumes. @@ -131,8 +131,8 @@ EFI_STATUS This function returns information about a specific file, including its file name, type, attributes, starting - address and size. - + address and size. + @param This Points to this instance of the EFI_PEI_FIRMWARE_VOLUME_PPI. @param FileHandle Handle of the file. @@ -143,13 +143,13 @@ EFI_STATUS @retval EFI_INVALID_PARAMETER If FileHandle does not represent a valid file. @retval EFI_INVALID_PARAMETER If FileInfo is NULL. - -**/ + +**/ typedef EFI_STATUS (EFIAPI *EFI_PEI_FV_GET_FILE_INFO)( - IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, - IN EFI_PEI_FILE_HANDLE FileHandle, + IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, + IN EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_FV_FILE_INFO *FileInfo ); @@ -158,7 +158,7 @@ EFI_STATUS This function returns information about a specific file, including its file name, type, attributes, starting - address, size and authentication status. + address, size and authentication status. @param This Points to this instance of the EFI_PEI_FIRMWARE_VOLUME_PPI. @@ -175,14 +175,14 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_PEI_FV_GET_FILE_INFO2)( - IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, + IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, IN EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_FV_FILE_INFO2 *FileInfo ); /** This function returns information about the firmware volume. - + @param This Points to this instance of the EFI_PEI_FIRMWARE_VOLUME_PPI. @param FvHandle Handle to the firmware handle. @@ -193,21 +193,21 @@ EFI_STATUS @retval EFI_INVALID_PARAMETER FvHandle does not indicate a valid firmware volume or VolumeInfo is NULL. -**/ +**/ typedef EFI_STATUS (EFIAPI *EFI_PEI_FV_GET_INFO)( - IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, - IN EFI_PEI_FV_HANDLE FvHandle, + IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, + IN EFI_PEI_FV_HANDLE FvHandle, OUT EFI_FV_INFO *VolumeInfo ); /** Find the next matching section in the firmware file. - + This service enables PEI modules to discover sections of a given type within a valid file. - + @param This Points to this instance of the EFI_PEI_FIRMWARE_VOLUME_PPI. @param SearchType A filter to find only sections of this @@ -216,7 +216,7 @@ EFI_STATUS search. @param SectionData Updated upon return to point to the section found. - + @retval EFI_SUCCESS Section was found. @retval EFI_NOT_FOUND Section of the specified type was not found. SectionData contains NULL. @@ -291,4 +291,4 @@ struct _EFI_PEI_FIRMWARE_VOLUME_PPI { extern EFI_GUID gEfiPeiFirmwareVolumePpiGuid; -#endif +#endif diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/FirmwareVolumeInfo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/FirmwareVolumeInfo.h index b26685519e..379dfc8491 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/FirmwareVolumeInfo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/FirmwareVolumeInfo.h @@ -2,13 +2,13 @@ This file provides location and format of a firmware volume. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.0. @@ -26,9 +26,9 @@ typedef struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI EFI_PEI_FIRMWARE_VOLUME_INFO_PPI; /// -/// This PPI describes the location and format of a firmware volume. -/// The FvFormat can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for -/// a user-defined format. The EFI_FIRMWARE_FILE_SYSTEM2_GUID is +/// This PPI describes the location and format of a firmware volume. +/// The FvFormat can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for +/// a user-defined format. The EFI_FIRMWARE_FILE_SYSTEM2_GUID is /// the PI Firmware Volume format. /// struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/FirmwareVolumeInfo2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/FirmwareVolumeInfo2.h index 4e2259299a..7ef620be6c 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/FirmwareVolumeInfo2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/FirmwareVolumeInfo2.h @@ -2,13 +2,13 @@ This file provides location, format and authentication status of a firmware volume. Copyright (c) 2013, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.3 errata. @@ -26,9 +26,9 @@ typedef struct _EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI; /// -/// This PPI describes the location and format of a firmware volume. -/// The FvFormat can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for -/// a user-defined format. The EFI_FIRMWARE_FILE_SYSTEM2_GUID is +/// This PPI describes the location and format of a firmware volume. +/// The FvFormat can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for +/// a user-defined format. The EFI_FIRMWARE_FILE_SYSTEM2_GUID is /// the PI Firmware Volume format. /// struct _EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/GuidedSectionExtraction.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/GuidedSectionExtraction.h index 6eb16daa95..af5c0867b3 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/GuidedSectionExtraction.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/GuidedSectionExtraction.h @@ -1,17 +1,17 @@ /** @file - If a GUID-defined section is encountered when doing section extraction, - the PEI Foundation or the EFI_PEI_FILE_LOADER_PPI instance - calls the appropriate instance of the GUIDed Section Extraction PPI - to extract the section stream contained therein. + If a GUID-defined section is encountered when doing section extraction, + the PEI Foundation or the EFI_PEI_FILE_LOADER_PPI instance + calls the appropriate instance of the GUIDed Section Extraction PPI + to extract the section stream contained therein. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.0. @@ -22,15 +22,15 @@ #define __EFI_GUIDED_SECTION_EXTRACTION_PPI_H__ // -// Typically, protocol interface structures are identified -// by associating them with a GUID. Each instance of -// a protocol with a given GUID must have -// the same interface structure. While all instances of -// the GUIDed Section Extraction PPI must have -// the same interface structure, they do not all have -// te same GUID. The GUID that is associated with -// an instance of the GUIDed Section Extraction Protocol -// is used to correlate it with the GUIDed section type +// Typically, protocol interface structures are identified +// by associating them with a GUID. Each instance of +// a protocol with a given GUID must have +// the same interface structure. While all instances of +// the GUIDed Section Extraction PPI must have +// the same interface structure, they do not all have +// te same GUID. The GUID that is associated with +// an instance of the GUIDed Section Extraction Protocol +// is used to correlate it with the GUIDed section type // that it is intended to process. // @@ -39,7 +39,7 @@ typedef struct _EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI EFI_PEI_GUIDED_SECTION_E /** - Processes the input section and returns the data contained therein + Processes the input section and returns the data contained therein along with the authentication status. The ExtractSection() function processes the input section and @@ -70,7 +70,7 @@ typedef struct _EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI EFI_PEI_GUIDED_SECTION_E reflect the status of the extraction operation. If the function returns anything other than EFI_SUCCESS, the value of *AuthenticationStatus is undefined. - + @retval EFI_SUCCESS The InputSection was successfully processed and the section contents were returned. @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process the request. @@ -93,7 +93,7 @@ EFI_STATUS /// calls the appropriate instance of the GUIDed Section /// Extraction PPI to extract the section stream contained /// therein. -/// +/// struct _EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI { EFI_PEI_EXTRACT_GUIDED_SECTION ExtractSection; }; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/I2cMaster.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/I2cMaster.h index acc4405f74..99e9d9f72d 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/I2cMaster.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/I2cMaster.h @@ -1,15 +1,15 @@ /** @file - This PPI manipulates the I2C host controller to perform transactions as a master + This PPI manipulates the I2C host controller to perform transactions as a master on the I2C bus using the current state of any switches or multiplexers in the I2C bus. Copyright (c) 2013, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.3. @@ -28,16 +28,16 @@ typedef struct _EFI_PEI_I2C_MASTER_PPI EFI_PEI_I2C_MASTER_PPI; /** Set the frequency for the I2C clock line. - + @param This Pointer to an EFI_PEI_I2C_MASTER_PPI structure. @param BusClockHertz Pointer to the requested I2C bus clock frequency in Hertz. - Upon return this value contains the actual frequency + Upon return this value contains the actual frequency in use by the I2C controller. @retval EFI_SUCCESS The bus frequency was set successfully. @retval EFI_INVALID_PARAMETER BusClockHertz is NULL @retval EFI_UNSUPPORTED The controller does not support this frequency. - + **/ typedef EFI_STATUS @@ -48,12 +48,12 @@ EFI_STATUS /** Reset the I2C controller and configure it for use. - + @param This Pointer to an EFI_PEI_I2C_MASTER_PPI structure. @retval EFI_SUCCESS The reset completed successfully. @retval EFI_DEVICE_ERROR The reset operation failed. - + **/ typedef EFI_STATUS @@ -63,12 +63,12 @@ EFI_STATUS /** Start an I2C transaction on the host controller. - + @param This Pointer to an EFI_PEI_I2C_MASTER_PPI structure. @param SlaveAddress Address of the device on the I2C bus. - Set the I2C_ADDRESSING_10_BIT when using 10-bit addresses, + Set the I2C_ADDRESSING_10_BIT when using 10-bit addresses, clear this bit for 7-bit addressing. - Bits 0-6 are used for 7-bit I2C slave addresses and + Bits 0-6 are used for 7-bit I2C slave addresses and bits 0-9 are used for 10-bit I2C slave addresses. @param RequestPacket Pointer to an EFI_I2C_REQUEST_PACKET structure describing the I2C transaction. @@ -81,7 +81,7 @@ EFI_STATUS @retval EFI_NOT_FOUND Reserved bit set in the SlaveAddress parameter @retval EFI_OUT_OF_RESOURCES Insufficient memory for I2C transaction @retval EFI_UNSUPPORTED The controller does not support the requested transaction. - + **/ typedef EFI_STATUS diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/IsaHc.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/IsaHc.h index 16be828ec5..c7b209fd4e 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/IsaHc.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/IsaHc.h @@ -2,13 +2,13 @@ This PPI opens or closes an I/O aperture in a ISA HOST controller. Copyright (c) 2015, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is from PI Version 1.2.1. @@ -33,10 +33,10 @@ typedef struct _EFI_ISA_HC_PPI *PEFI_ISA_HC_PPI; addresses specified by IoAddress to IoAddress + IoLength - 1. It is possible that more than one caller may be assigned to the same aperture. It may be possible that a single hardware aperture may be used for more than - one device. This function tracks the number of times that each aperture is + one device. This function tracks the number of times that each aperture is referenced, and doesa not close the hardware aperture (via CloseIoAperture()) until there are no more references to it. - + @param This A pointer to this instance of the EFI_ISA_HC_PPI. @param IoAddress An unsigned integer that specifies the first byte of the I/O space required. @@ -74,7 +74,7 @@ EFI_STATUS call to OpenIoAperture(). @retval EFI_SUCCESS The I/O aperture was closed successfully. -**/ +**/ typedef EFI_STATUS (EFIAPI *EFI_PEI_ISA_HC_CLOSE_IO) ( @@ -116,4 +116,4 @@ struct _EFI_ISA_HC_PPI { extern EFI_GUID gEfiIsaHcPpiGuid; -#endif +#endif diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/LoadFile.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/LoadFile.h index 243976c3c4..bd224c2288 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/LoadFile.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/LoadFile.h @@ -1,14 +1,14 @@ /** @file - Load image file from fv to memory. + Load image file from fv to memory. Copyright (c) 2006 - 2013, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.0. @@ -29,7 +29,7 @@ typedef struct _EFI_PEI_LOAD_FILE_PPI EFI_PEI_LOAD_FILE_PPI; This service is the single member function of EFI_LOAD_FILE_PPI. This service separates image loading and relocating from the PEI Foundation. - + @param This Interface pointer that implements the Load File PPI instance. @param FileHandle File handle of the file to load. @@ -47,7 +47,7 @@ typedef struct _EFI_PEI_LOAD_FILE_PPI EFI_PEI_LOAD_FILE_PPI; @retval EFI_INVALID_PARAMETER EntryPoint was NULL. @retval EFI_UNSUPPORTED An image requires relocations or is not memory mapped. - @retval EFI_WARN_BUFFER_TOO_SMALL + @retval EFI_WARN_BUFFER_TOO_SMALL There is not enough heap to allocate the requested size. This will not prevent the XIP image from being invoked. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/LoadImage.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/LoadImage.h index 59966e068f..5d80673451 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/LoadImage.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/LoadImage.h @@ -1,15 +1,15 @@ /** @file - The file describes the PPI which notifies other drivers + The file describes the PPI which notifies other drivers of the PEIM being initialized by the PEI Dispatcher. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.0. @@ -27,7 +27,7 @@ typedef struct _EFI_PEI_LOADED_IMAGE_PPI EFI_PEI_LOADED_IMAGE_PPI; /// /// This interface is installed by the PEI Dispatcher after the image has been -/// loaded and after all security checks have been performed, +/// loaded and after all security checks have been performed, /// to notify other PEIMs of the files which are being loaded. /// struct _EFI_PEI_LOADED_IMAGE_PPI { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/MasterBootMode.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/MasterBootMode.h index 2d071fa334..9f377f4f1a 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/MasterBootMode.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/MasterBootMode.h @@ -1,18 +1,18 @@ /** @file This file declares Boot Mode PPI. - The Master Boot Mode PPI is installed by a PEIM to signal that a final - boot has been determined and set. This signal is useful in that PEIMs + The Master Boot Mode PPI is installed by a PEIM to signal that a final + boot has been determined and set. This signal is useful in that PEIMs with boot-mode-specific behavior can put this PPI in their dependency expression. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.0. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/MemoryDiscovered.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/MemoryDiscovered.h index df7a3d81b6..3fb25db5b7 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/MemoryDiscovered.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/MemoryDiscovered.h @@ -1,18 +1,18 @@ /** @file This file declares Memory Discovered PPI. - This PPI is published by the PEI Foundation when the main memory is installed. + This PPI is published by the PEI Foundation when the main memory is installed. It is essentially a PPI with no associated interface. Its purpose is to be used - as a signal for other PEIMs who can register for a notification on its installation. + as a signal for other PEIMs who can register for a notification on its installation. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.0. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Pcd.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Pcd.h index 05b59048d6..0c03d98337 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Pcd.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Pcd.h @@ -1,19 +1,19 @@ /** @file Native Platform Configuration Database (PCD) PPI - + Different with the EFI_PCD_PPI defined in PI 1.2 specification, the native - PCD PPI provide interfaces for dynamic and dynamic-ex type PCD. + PCD PPI provide interfaces for dynamic and dynamic-ex type PCD. The interfaces for dynamic type PCD do not require the token space guid as parameter, but interfaces for dynamic-ex type PCD require token space guid as parameter. Copyright (c) 2006 - 2013, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that 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. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -29,27 +29,27 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** Sets the SKU value for subsequent calls to set or get PCD token values. - SetSku() sets the SKU Id to be used for subsequent calls to set or get PCD values. + SetSku() sets the SKU Id to be used for subsequent calls to set or get PCD values. SetSku() is normally called only once by the system. - For each item (token), the database can hold a single value that applies to all SKUs, - or multiple values, where each value is associated with a specific SKU Id. Items with multiple, - SKU-specific values are called SKU enabled. - - The SKU Id of zero is reserved as a default. The valid SkuId range is 1 to 255. - For tokens that are not SKU enabled, the system ignores any set SKU Id and works with the - single value for that token. For SKU-enabled tokens, the system will use the SKU Id set by the - last call to SetSku(). If no SKU Id is set or the currently set SKU Id isn't valid for the specified token, - the system uses the default SKU Id. If the system attempts to use the default SKU Id and no value has been + For each item (token), the database can hold a single value that applies to all SKUs, + or multiple values, where each value is associated with a specific SKU Id. Items with multiple, + SKU-specific values are called SKU enabled. + + The SKU Id of zero is reserved as a default. The valid SkuId range is 1 to 255. + For tokens that are not SKU enabled, the system ignores any set SKU Id and works with the + single value for that token. For SKU-enabled tokens, the system will use the SKU Id set by the + last call to SetSku(). If no SKU Id is set or the currently set SKU Id isn't valid for the specified token, + the system uses the default SKU Id. If the system attempts to use the default SKU Id and no value has been set for that Id, the results are unpredictable. - @param[in] SkuId The SKU value that will be used when the PCD service will retrieve and + @param[in] SkuId The SKU value that will be used when the PCD service will retrieve and set values associated with a PCD token. @retval VOID **/ -typedef +typedef VOID (EFIAPI *PCD_PPI_SET_SKU)( IN UINTN SkuId @@ -60,13 +60,13 @@ VOID /** Retrieves an 8-bit value for a given PCD token. - Retrieves the current byte-sized value for a PCD token number. + Retrieves the current byte-sized value for a PCD token number. If the TokenNumber is invalid, the results are unpredictable. - - @param[in] TokenNumber The PCD token number. + + @param[in] TokenNumber The PCD token number. @return The UINT8 value. - + **/ typedef UINT8 @@ -79,13 +79,13 @@ UINT8 /** Retrieves a 16-bit value for a given PCD token. - Retrieves the current 16-bit value for a PCD token number. + Retrieves the current 16-bit value for a PCD token number. If the TokenNumber is invalid, the results are unpredictable. - - @param[in] TokenNumber The PCD token number. + + @param[in] TokenNumber The PCD token number. @return The UINT16 value. - + **/ typedef UINT16 @@ -98,13 +98,13 @@ UINT16 /** Retrieves a 32-bit value for a given PCD token. - Retrieves the current 32-bit value for a PCD token number. + Retrieves the current 32-bit value for a PCD token number. If the TokenNumber is invalid, the results are unpredictable. - - @param[in] TokenNumber The PCD token number. + + @param[in] TokenNumber The PCD token number. @return The UINT32 value. - + **/ typedef UINT32 @@ -117,13 +117,13 @@ UINT32 /** Retrieves a 64-bit value for a given PCD token. - Retrieves the current 64-bit value for a PCD token number. + Retrieves the current 64-bit value for a PCD token number. If the TokenNumber is invalid, the results are unpredictable. - - @param[in] TokenNumber The PCD token number. + + @param[in] TokenNumber The PCD token number. @return The UINT64 value. - + **/ typedef UINT64 @@ -136,15 +136,15 @@ UINT64 /** Retrieves a pointer to a value for a given PCD token. - Retrieves the current pointer to the buffer for a PCD token number. - Do not make any assumptions about the alignment of the pointer that - is returned by this function call. If the TokenNumber is invalid, + Retrieves the current pointer to the buffer for a PCD token number. + Do not make any assumptions about the alignment of the pointer that + is returned by this function call. If the TokenNumber is invalid, the results are unpredictable. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @return The pointer to the buffer to be retrived. - + **/ typedef VOID * @@ -157,15 +157,15 @@ VOID * /** Retrieves a Boolean value for a given PCD token. - Retrieves the current boolean value for a PCD token number. - Do not make any assumptions about the alignment of the pointer that - is returned by this function call. If the TokenNumber is invalid, + Retrieves the current boolean value for a PCD token number. + Do not make any assumptions about the alignment of the pointer that + is returned by this function call. If the TokenNumber is invalid, the results are unpredictable. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @return The Boolean value. - + **/ typedef BOOLEAN @@ -178,13 +178,13 @@ BOOLEAN /** Retrieves the size of the value for a given PCD token. - Retrieves the current size of a particular PCD token. + Retrieves the current size of a particular PCD token. If the TokenNumber is invalid, the results are unpredictable. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @return The size of the value for the PCD token. - + **/ typedef UINTN @@ -197,16 +197,16 @@ UINTN /** Retrieves an 8-bit value for a given PCD token and token space. - Retrieves the 8-bit value of a particular PCD token. + Retrieves the 8-bit value of a particular PCD token. If the TokenNumber is invalid or the token space - specified by Guid does not exist, the results are + specified by Guid does not exist, the results are unpredictable. @param[in] Guid The token space for the token number. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @return The size 8-bit value for the PCD token. - + **/ typedef UINT8 @@ -220,16 +220,16 @@ UINT8 /** Retrieves a 16-bit value for a given PCD token and token space. - Retrieves the 16-bit value of a particular PCD token. + Retrieves the 16-bit value of a particular PCD token. If the TokenNumber is invalid or the token space - specified by Guid does not exist, the results are + specified by Guid does not exist, the results are unpredictable. @param[in] Guid The token space for the token number. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @return The size 16-bit value for the PCD token. - + **/ typedef UINT16 @@ -243,16 +243,16 @@ UINT16 /** Retrieves a 32-bit value for a given PCD token and token space. - Retrieves the 32-bit value of a particular PCD token. + Retrieves the 32-bit value of a particular PCD token. If the TokenNumber is invalid or the token space - specified by Guid does not exist, the results are + specified by Guid does not exist, the results are unpredictable. @param[in] Guid The token space for the token number. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @return The size 32-bit value for the PCD token. - + **/ typedef UINT32 @@ -266,16 +266,16 @@ UINT32 /** Retrieves a 64-bit value for a given PCD token and token space. - Retrieves the 64-bit value of a particular PCD token. + Retrieves the 64-bit value of a particular PCD token. If the TokenNumber is invalid or the token space - specified by Guid does not exist, the results are + specified by Guid does not exist, the results are unpredictable. @param[in] Guid The token space for the token number. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @return The size 64-bit value for the PCD token. - + **/ typedef UINT64 @@ -289,16 +289,16 @@ UINT64 /** Retrieves a pointer to a value for a given PCD token and token space. - Retrieves the current pointer to the buffer for a PCD token number. - Do not make any assumptions about the alignment of the pointer that - is returned by this function call. If the TokenNumber is invalid, + Retrieves the current pointer to the buffer for a PCD token number. + Do not make any assumptions about the alignment of the pointer that + is returned by this function call. If the TokenNumber is invalid, the results are unpredictable. @param[in] Guid The token space for the token number. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @return The pointer to the buffer to be retrived. - + **/ typedef VOID * @@ -312,16 +312,16 @@ VOID * /** Retrieves an Boolean value for a given PCD token and token space. - Retrieves the Boolean value of a particular PCD token. + Retrieves the Boolean value of a particular PCD token. If the TokenNumber is invalid or the token space - specified by Guid does not exist, the results are + specified by Guid does not exist, the results are unpredictable. @param[in] Guid The token space for the token number. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @return The size Boolean value for the PCD token. - + **/ typedef BOOLEAN @@ -335,14 +335,14 @@ BOOLEAN /** Retrieves the size of the value for a given PCD token and token space. - Retrieves the current size of a particular PCD token. + Retrieves the current size of a particular PCD token. If the TokenNumber is invalid, the results are unpredictable. @param[in] Guid The token space for the token number. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @return The size of the value for the PCD token. - + **/ typedef UINTN @@ -356,19 +356,19 @@ UINTN /** Sets an 8-bit value for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -382,19 +382,19 @@ EFI_STATUS /** Sets a 16-bit value for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -408,19 +408,19 @@ EFI_STATUS /** Sets a 32-bit value for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -434,19 +434,19 @@ EFI_STATUS /** Sets a 64-bit value for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -458,23 +458,23 @@ EFI_STATUS /** Sets a value of a specified size for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. - @param[in] TokenNumber The PCD token number. - @param[in, out] SizeOfValue A pointer to the length of the value being set for the PCD token. - On input, if the SizeOfValue is greater than the maximum size supported - for this TokenNumber then the output value of SizeOfValue will reflect + @param[in] TokenNumber The PCD token number. + @param[in, out] SizeOfValue A pointer to the length of the value being set for the PCD token. + On input, if the SizeOfValue is greater than the maximum size supported + for this TokenNumber then the output value of SizeOfValue will reflect the maximum size supported for this TokenNumber. @param[in] Buffer The buffer to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -487,19 +487,19 @@ EFI_STATUS /** Sets an Boolean value for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -513,20 +513,20 @@ EFI_STATUS /** Sets an 8-bit value for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -541,20 +541,20 @@ EFI_STATUS /** Sets a 16-bit value for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -569,20 +569,20 @@ EFI_STATUS /** Sets a 32-bit value for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -597,20 +597,20 @@ EFI_STATUS /** Sets a 64-bit value for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -625,24 +625,24 @@ EFI_STATUS /** Sets a value of a specified size for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. - @param[in] TokenNumber The PCD token number. - @param[in, out] SizeOfValue A pointer to the length of the value being set for the PCD token. - On input, if the SizeOfValue is greater than the maximum size supported - for this TokenNumber then the output value of SizeOfValue will reflect + @param[in] TokenNumber The PCD token number. + @param[in, out] SizeOfValue A pointer to the length of the value being set for the PCD token. + On input, if the SizeOfValue is greater than the maximum size supported + for this TokenNumber then the output value of SizeOfValue will reflect the maximum size supported for this TokenNumber. @param[in] Buffer The buffer to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -656,20 +656,20 @@ EFI_STATUS /** Sets an Boolean value for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -684,11 +684,11 @@ EFI_STATUS /** Callback on SET function prototype definition. - This notification function serves two purposes. Firstly, it notifies the module - which did the registration that the value of this PCD token has been set. Secondly, - it provides a mechanism for the module which did the registration to intercept the set - operation and override the value been set if necessary. After the invocation of the - callback function, TokenData will be used by PCD service PEIM to modify the internal data + This notification function serves two purposes. Firstly, it notifies the module + which did the registration that the value of this PCD token has been set. Secondly, + it provides a mechanism for the module which did the registration to intercept the set + operation and override the value been set if necessary. After the invocation of the + callback function, TokenData will be used by PCD service PEIM to modify the internal data in PCD database. @param[in] CallBackGuid The PCD token GUID being set. @@ -713,11 +713,11 @@ VOID /** Specifies a function to be called anytime the value of a designated token is changed. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. - @param[in] CallBackFunction The function prototype called when the value associated with the CallBackToken is set. + @param[in] CallBackFunction The function prototype called when the value associated with the CallBackToken is set. - @retval EFI_SUCCESS The PCD service has successfully established a call event + @retval EFI_SUCCESS The PCD service has successfully established a call event for the CallBackToken requested. @retval EFI_NOT_FOUND The PCD service could not find the referenced token number. @@ -735,11 +735,11 @@ EFI_STATUS /** Cancels a previously set callback function for a particular PCD token number. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. - @param[in] CallBackFunction The function prototype called when the value associated with the CallBackToken is set. + @param[in] CallBackFunction The function prototype called when the value associated with the CallBackToken is set. - @retval EFI_SUCCESS The PCD service has successfully established a call event + @retval EFI_SUCCESS The PCD service has successfully established a call event for the CallBackToken requested. @retval EFI_NOT_FOUND The PCD service could not find the referenced token number. @@ -755,31 +755,31 @@ EFI_STATUS /** - Retrieves the next valid token number in a given namespace. - - This is useful since the PCD infrastructure contains a sparse list of token numbers, - and one cannot a priori know what token numbers are valid in the database. - - If TokenNumber is 0 and Guid is not NULL, then the first token from the token space specified by Guid is returned. - If TokenNumber is not 0 and Guid is not NULL, then the next token in the token space specified by Guid is returned. - If TokenNumber is 0 and Guid is NULL, then the first token in the default token space is returned. - If TokenNumber is not 0 and Guid is NULL, then the next token in the default token space is returned. - The token numbers in the default token space may not be related to token numbers in token spaces that are named by Guid. - If the next token number can be retrieved, then it is returned in TokenNumber, and EFI_SUCCESS is returned. - If TokenNumber represents the last token number in the token space specified by Guid, then EFI_NOT_FOUND is returned. + Retrieves the next valid token number in a given namespace. + + This is useful since the PCD infrastructure contains a sparse list of token numbers, + and one cannot a priori know what token numbers are valid in the database. + + If TokenNumber is 0 and Guid is not NULL, then the first token from the token space specified by Guid is returned. + If TokenNumber is not 0 and Guid is not NULL, then the next token in the token space specified by Guid is returned. + If TokenNumber is 0 and Guid is NULL, then the first token in the default token space is returned. + If TokenNumber is not 0 and Guid is NULL, then the next token in the default token space is returned. + The token numbers in the default token space may not be related to token numbers in token spaces that are named by Guid. + If the next token number can be retrieved, then it is returned in TokenNumber, and EFI_SUCCESS is returned. + If TokenNumber represents the last token number in the token space specified by Guid, then EFI_NOT_FOUND is returned. If TokenNumber is not present in the token space specified by Guid, then EFI_NOT_FOUND is returned. - @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. - This is an optional parameter that may be NULL. If this parameter is NULL, then a request + @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. + This is an optional parameter that may be NULL. If this parameter is NULL, then a request is being made to retrieve tokens from the default token space. @param[in, out] TokenNumber A pointer to the PCD token number to use to find the subsequent token number. - + @retval EFI_SUCCESS The PCD service has retrieved the next valid token number. @retval EFI_NOT_FOUND The PCD service could not find data from the requested token number. **/ -typedef +typedef EFI_STATUS (EFIAPI *PCD_PPI_GET_NEXT_TOKEN)( IN CONST EFI_GUID *Guid, OPTIONAL @@ -799,7 +799,7 @@ EFI_STATUS token namespace on the platform. If *Guid is NULL, then the GUID of the first token space of the current platform is returned. If the search cannot locate the next valid token namespace, an error is returned and the value of *Guid is undefined. - + @retval EFI_SUCCESS The PCD service retrieved the value requested. @retval EFI_NOT_FOUND The PCD service could not find the next valid token namespace. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/PcdInfo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/PcdInfo.h index a06fff13fc..1ebbef43f2 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/PcdInfo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/PcdInfo.h @@ -2,9 +2,9 @@ Native Platform Configuration Database (PCD) INFO PPI The PPI that provides additional information about items that reside in the PCD database. - + Different with the EFI_GET_PCD_INFO_PPI defined in PI 1.2.1 specification, - the native PCD INFO PPI provide interfaces for dynamic and dynamic-ex type PCD. + the native PCD INFO PPI provide interfaces for dynamic and dynamic-ex type PCD. The interfaces for dynamic type PCD do not require the token space guid as parameter, but interfaces for dynamic-ex type PCD require token space guid as parameter. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/PciCfg2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/PciCfg2.h index ea95478754..9c8a158385 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/PciCfg2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/PciCfg2.h @@ -1,7 +1,7 @@ /** @file This file declares PciCfg2 PPI. - This ppi Provides platform or chipset-specific access to + This ppi Provides platform or chipset-specific access to the PCI configuration space for a specific PCI segment. Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR> @@ -124,7 +124,7 @@ EFI_STATUS /** - Performs a read-modify-write operation on the contents + Performs a read-modify-write operation on the contents from a given location in the PCI configuration space. @param PeiServices An indirect pointer to the PEI Services Table diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/ReadOnlyVariable2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/ReadOnlyVariable2.h index 5ff68eecea..f24bd35709 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/ReadOnlyVariable2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/ReadOnlyVariable2.h @@ -3,13 +3,13 @@ This ppi permits read-only access to the UEFI variable store during the PEI phase. Copyright (c) 2006 - 2017, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that 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. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.0. @@ -28,8 +28,8 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE2_PPI EFI_PEI_READ_ONLY_VARIABLE2_PPI /** This service retrieves a variable's value using its name and GUID. - Read the specified variable from the UEFI variable store. If the Data - buffer is too small to hold the contents of the variable, + Read the specified variable from the UEFI variable store. If the Data + buffer is too small to hold the contents of the variable, the error EFI_BUFFER_TOO_SMALL is returned and DataSize is set to the required buffer size to obtain the data. @@ -45,8 +45,8 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE2_PPI EFI_PEI_READ_ONLY_VARIABLE2_PPI @retval EFI_SUCCESS The variable was read successfully. @retval EFI_NOT_FOUND The variable was not found. - @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the resulting data. - DataSize is updated with the size required for + @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the resulting data. + DataSize is updated with the size required for the specified variable. @retval EFI_INVALID_PARAMETER VariableName, VariableGuid, DataSize or Data is NULL. @retval EFI_DEVICE_ERROR The variable could not be retrieved because of a device error. @@ -67,11 +67,11 @@ EFI_STATUS /** Return the next variable name and GUID. - This function is called multiple times to retrieve the VariableName - and VariableGuid of all variables currently available in the system. - On each call, the previous results are passed into the interface, - and, on return, the interface returns the data for the next - interface. When the entire variable list has been returned, + This function is called multiple times to retrieve the VariableName + and VariableGuid of all variables currently available in the system. + On each call, the previous results are passed into the interface, + and, on return, the interface returns the data for the next + interface. When the entire variable list has been returned, EFI_NOT_FOUND is returned. @param This A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI. @@ -81,7 +81,7 @@ EFI_STATUS @param VariableName On entry, a pointer to a null-terminated string that is the variable's name. On return, points to the next variable's null-terminated name string. - @param VariableGuid On entry, a pointer to an EFI_GUID that is the variable's GUID. + @param VariableGuid On entry, a pointer to an EFI_GUID that is the variable's GUID. On return, a pointer to the next variable's GUID. @retval EFI_SUCCESS The variable was read successfully. @@ -104,8 +104,8 @@ EFI_STATUS ); /// -/// This PPI provides a lightweight, read-only variant of the full EFI -/// variable services. +/// This PPI provides a lightweight, read-only variant of the full EFI +/// variable services. /// struct _EFI_PEI_READ_ONLY_VARIABLE2_PPI { EFI_PEI_GET_VARIABLE2 GetVariable; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/RecoveryModule.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/RecoveryModule.h index 2987facca8..d4b94aac7f 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/RecoveryModule.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/RecoveryModule.h @@ -4,7 +4,7 @@ A module that produces this PPI has many roles and is responsible for the following: -# Calling the driver recovery PPI EFI_PEI_DEVICE_RECOVERY_MODULE_PPI. - GetNumberRecoveryCapsules() to determine if one or more DXE recovery + GetNumberRecoveryCapsules() to determine if one or more DXE recovery entities exist. -# If no capsules exist, then performing appropriate error handling. -# Allocating a buffer of MaxRecoveryCapsuleSize as determined by @@ -16,21 +16,21 @@ -# If the load failed, performing appropriate error handling. -# Performing security checks for a loaded DXE recovery capsule. -# If the security checks failed, then logging the failure in a data HOB. - -# If the security checks failed, then determining the next - EFI_PEI_DEVICE_RECOVERY_MODULE_PPI.LoadRecoveryCapsule()capsule number; + -# If the security checks failed, then determining the next + EFI_PEI_DEVICE_RECOVERY_MODULE_PPI.LoadRecoveryCapsule()capsule number; otherwise, go to step 11. - -# If more DXE recovery capsules exist, then go to step 5; otherwise, perform + -# If more DXE recovery capsules exist, then go to step 5; otherwise, perform error handling. -# Decomposing the capsule loaded by EFI_PEI_DEVICE_RECOVERY_MODULE_PPI. - LoadRecoveryCapsule() into its components. It is assumed that the path - parameters are redundant for recovery and Setup parameters are either + LoadRecoveryCapsule() into its components. It is assumed that the path + parameters are redundant for recovery and Setup parameters are either redundant or canned. - -# Invalidating all HOB entries for updateable firmware volume entries. + -# Invalidating all HOB entries for updateable firmware volume entries. This invalidation prevents possible errant drivers from being executed. - -# Updating the HOB table with the recovery DXE firmware volume information + -# Updating the HOB table with the recovery DXE firmware volume information generated from the capsule decomposition. - -# Returning to the PEI Dispatcher. - + -# Returning to the PEI Dispatcher. + Copyright (c) 2007 - 2011, 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 @@ -41,7 +41,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: - This PPI is defined in UEFI Platform Initialization Specification 1.2 Errata B Volume 1: + This PPI is defined in UEFI Platform Initialization Specification 1.2 Errata B Volume 1: Pre-EFI Initalization Core Interface **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/ReportStatusCodeHandler.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/ReportStatusCodeHandler.h index 40dfd2f72d..6bb5ee29f1 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/ReportStatusCodeHandler.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/ReportStatusCodeHandler.h @@ -1,6 +1,6 @@ /** @file This PPI provides registering and unregistering services to status code consumers. - + Copyright (c) 2007 - 2009, 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 @@ -33,19 +33,19 @@ EFI_STATUS /** Register the callback function for ReportStatusCode() notification. - + When this function is called the function pointer is added to an internal list and any future calls to ReportStatusCode() will be forwarded to the Callback function. @param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is called when a call to ReportStatusCode() occurs. - + @retval EFI_SUCCESS Function was successfully registered. @retval EFI_INVALID_PARAMETER The callback function was NULL. @retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be registered. @retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again. - + **/ typedef EFI_STATUS @@ -55,16 +55,16 @@ EFI_STATUS /** Remove a previously registered callback function from the notification list. - + ReportStatusCode() messages will no longer be forwarded to the Callback function. - + @param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is to be unregistered. @retval EFI_SUCCESS The function was successfully unregistered. @retval EFI_INVALID_PARAMETER The callback function was NULL. @retval EFI_NOT_FOUND The callback function was not found to be unregistered. - + **/ typedef EFI_STATUS diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Reset.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Reset.h index 9cafbdcdc5..5440da110e 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Reset.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Reset.h @@ -1,17 +1,17 @@ /** @file This file declares Reset PPI used to reset the platform. - - This PPI is installed by some platform- or chipset-specific PEIM that + + This PPI is installed by some platform- or chipset-specific PEIM that abstracts the Reset Service to other agents. Copyright (c) 2006 - 2009, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.0. @@ -29,11 +29,11 @@ // // EFI_PEI_RESET_PPI.ResetSystem() is equivalent to the // PEI Service ResetSystem(). -// It is introduced in PIPeiCis.h. +// It is introduced in PIPeiCis.h. // /// -/// This PPI provides provide a simple reset service. +/// This PPI provides provide a simple reset service. /// typedef struct { EFI_PEI_RESET_SYSTEM ResetSystem; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/S3Resume2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/S3Resume2.h index 2645c22975..a33be3f4cf 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/S3Resume2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/S3Resume2.h @@ -1,12 +1,12 @@ /** @file This PPI produces functions to interpret and execute the PI boot script table. - + This PPI is published by a PEIM and provides for the restoration of the platform's - configuration when resuming from the ACPI S3 power state. The ability to execute - the boot script may depend on the availability of other PPIs. For example, if - the boot script includes an SMBus command, this PEIM looks for the relevant PPI - that is able to execute that command. - + configuration when resuming from the ACPI S3 power state. The ability to execute + the boot script may depend on the availability of other PPIs. For example, if + the boot script includes an SMBus command, this PEIM looks for the relevant PPI + that is able to execute that command. + Copyright (c) 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 @@ -17,7 +17,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: - This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 5: + This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 5: Standards **/ @@ -42,30 +42,30 @@ typedef struct _EFI_PEI_S3_RESUME2_PPI EFI_PEI_S3_RESUME2_PPI; Restores the platform to its preboot configuration for an S3 resume and jumps to the OS waking vector. - This function will restore the platform to its pre-boot configuration that was + This function will restore the platform to its pre-boot configuration that was pre-stored in the boot script table and transfer control to OS waking vector. - Upon invocation, this function is responsible for locating the following + Upon invocation, this function is responsible for locating the following information before jumping to OS waking vector: - ACPI tables - boot script table - any other information that it needs - - The S3RestoreConfig() function then executes the pre-stored boot script table - and transitions the platform to the pre-boot state. The boot script is recorded + + The S3RestoreConfig() function then executes the pre-stored boot script table + and transitions the platform to the pre-boot state. The boot script is recorded during regular boot using the EFI_S3_SAVE_STATE_PROTOCOL.Write() and - EFI_S3_SMM_SAVE_STATE_PROTOCOL.Write() functions. Finally, this function - transfers control to the OS waking vector. If the OS supports only a real-mode - waking vector, this function will switch from flat mode to real mode before - jumping to the waking vector. If all platform pre-boot configurations are - successfully restored and all other necessary information is ready, this - function will never return and instead will directly jump to the OS waking - vector. If this function returns, it indicates that the attempt to resume - from the ACPI S3 sleep state failed. - + EFI_S3_SMM_SAVE_STATE_PROTOCOL.Write() functions. Finally, this function + transfers control to the OS waking vector. If the OS supports only a real-mode + waking vector, this function will switch from flat mode to real mode before + jumping to the waking vector. If all platform pre-boot configurations are + successfully restored and all other necessary information is ready, this + function will never return and instead will directly jump to the OS waking + vector. If this function returns, it indicates that the attempt to resume + from the ACPI S3 sleep state failed. + @param[in] This Pointer to this instance of the PEI_S3_RESUME_PPI @retval EFI_ABORTED Execution of the S3 resume boot script table failed. - @retval EFI_NOT_FOUND Some necessary information that is used for the S3 + @retval EFI_NOT_FOUND Some necessary information that is used for the S3 resume boot path could not be located. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/SecHobData.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/SecHobData.h index 4cd965294c..d8b6e9ddee 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/SecHobData.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/SecHobData.h @@ -1,7 +1,7 @@ /** @file This file declares Sec Hob Data PPI. - This PPI provides a way for the SEC code to pass zero or more HOBs in a HOB list. + This PPI provides a way for the SEC code to pass zero or more HOBs in a HOB list. Copyright (c) 2017, Intel Corporation. All rights reserved.<BR> This program and the accompanying materials are licensed and made available under diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Security2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Security2.h index 0265974921..77be3d4bc6 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Security2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Security2.h @@ -1,18 +1,18 @@ /** @file This file declares Pei Security2 PPI. - This PPI is installed by some platform PEIM that abstracts the security - policy to the PEI Foundation, namely the case of a PEIM's authentication + This PPI is installed by some platform PEIM that abstracts the security + policy to the PEI Foundation, namely the case of a PEIM's authentication state being returned during the PEI section extraction process. Copyright (c) 2006 - 2013, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.0. @@ -29,7 +29,7 @@ typedef struct _EFI_PEI_SECURITY2_PPI EFI_PEI_SECURITY2_PPI; /** - Allows the platform builder to implement a security policy + Allows the platform builder to implement a security policy in response to varying file authentication states. This service is published by some platform PEIM. The purpose of @@ -48,13 +48,13 @@ typedef struct _EFI_PEI_SECURITY2_PPI EFI_PEI_SECURITY2_PPI; particular EFI_PEI_SECURITY2_PPI instance. @param AuthenticationStatus Authentication status of the file. xx00 Image was not signed. - xxx1 Platform security policy override. + xxx1 Platform security policy override. Assumes same meaning as 0010 (the image was signed, the signature was tested, and the signature passed authentication test). - 0010 Image was signed, the signature was tested, + 0010 Image was signed, the signature was tested, and the signature passed authentication test. 0110 Image was signed and the signature was not tested. - 1010 Image was signed, the signature was tested, + 1010 Image was signed, the signature was tested, and the signature failed the authentication test. @param FvHandle Handle of the volume in which the file resides. This allows different policies diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Smbus2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Smbus2.h index 633394faa1..4d2815650a 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Smbus2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Smbus2.h @@ -1,16 +1,16 @@ /** @file This file declares Smbus2 PPI. - This PPI provides the basic I/O interfaces that a PEIM uses to access its + This PPI provides the basic I/O interfaces that a PEIM uses to access its SMBus controller and the slave devices attached to it. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.0. @@ -29,28 +29,28 @@ typedef struct _EFI_PEI_SMBUS2_PPI EFI_PEI_SMBUS2_PPI; /** - Executes an SMBus operation to an SMBus controller. Returns when either + Executes an SMBus operation to an SMBus controller. Returns when either the command has been executed or an error is encountered in doing the operation. @param This A pointer to the EFI_PEI_SMBUS2_PPI instance. @param SlaveAddress The SMBUS hardware address to which the SMBUS device is preassigned or allocated. - @param Command This command is transmitted by the SMBus host controller to the SMBus slave - device and the interpretation is SMBus slave device specific. - It can mean the offset to a list of functions inside + @param Command This command is transmitted by the SMBus host controller to the SMBus slave + device and the interpretation is SMBus slave device specific. + It can mean the offset to a list of functions inside an SMBus slave device. Not all operations or slave devices support this command's registers. - @param Operation Signifies which particular SMBus hardware protocol instance that it - will use to execute the SMBus transactions. - This SMBus hardware protocol is defined by the System Management Bus (SMBus) + @param Operation Signifies which particular SMBus hardware protocol instance that it + will use to execute the SMBus transactions. + This SMBus hardware protocol is defined by the System Management Bus (SMBus) Specification and is not related to UEFI. @param PecCheck Defines if Packet Error Code (PEC) checking is required for this operation. - @param Length Signifies the number of bytes that this operation will do. + @param Length Signifies the number of bytes that this operation will do. The maximum number of bytes can be revision specific and operation specific. This parameter will contain the actual number of bytes that are executed for this operation. Not all operations require this argument. - @param Buffer Contains the value of data to execute to the SMBus slave device. - Not all operations require this argument. + @param Buffer Contains the value of data to execute to the SMBus slave device. + Not all operations require this argument. The length of this buffer is identified by Length. @@ -83,8 +83,8 @@ EFI_STATUS ); /** - The ArpDevice() function enumerates the entire bus or enumerates a specific - device that is identified by SmbusUdid. + The ArpDevice() function enumerates the entire bus or enumerates a specific + device that is identified by SmbusUdid. @param This A pointer to the EFI_PEI_SMBUS2_PPI instance. @param ArpAll A Boolean expression that indicates if the host drivers need @@ -116,8 +116,8 @@ EFI_STATUS ); /** - The GetArpMap() function returns the mapping of all the SMBus devices - that are enumerated by the SMBus host driver. + The GetArpMap() function returns the mapping of all the SMBus devices + that are enumerated by the SMBus host driver. @param This A pointer to the EFI_PEI_SMBUS2_PPI instance. @param Length Size of the buffer that contains the SMBus device map. @@ -159,7 +159,7 @@ EFI_STATUS ); /** - The Notify() function registers all the callback functions to allow the + The Notify() function registers all the callback functions to allow the bus driver to call these functions when the SlaveAddress/Data pair happens. @param This A pointer to the EFI_PEI_SMBUS2_PPI instance. @@ -184,7 +184,7 @@ EFI_STATUS ); /// -/// Provides the basic I/O interfaces that a PEIM uses to access +/// Provides the basic I/O interfaces that a PEIM uses to access /// its SMBus controller and the slave devices attached to it. /// struct _EFI_PEI_SMBUS2_PPI { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Stall.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Stall.h index 94a68c2e39..3bf5d63ca7 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Stall.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/Stall.h @@ -4,13 +4,13 @@ This ppi abstracts the blocking stall service to other agents. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.0. @@ -26,7 +26,7 @@ typedef struct _EFI_PEI_STALL_PPI EFI_PEI_STALL_PPI; /** - The Stall() function provides a blocking stall for at least the number + The Stall() function provides a blocking stall for at least the number of microseconds stipulated in the final argument of the API. @param PeiServices An indirect pointer to the PEI Services Table @@ -46,7 +46,7 @@ EFI_STATUS ); /// -/// This service provides a simple, blocking stall with platform-specific resolution. +/// This service provides a simple, blocking stall with platform-specific resolution. /// struct _EFI_PEI_STALL_PPI { /// diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/StatusCode.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/StatusCode.h index 30a53304fd..60ede4650b 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/StatusCode.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/StatusCode.h @@ -3,13 +3,13 @@ This ppi provides a service that allows PEIMs to report status codes. Copyright (c) 2006 - 2009, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.0. @@ -25,7 +25,7 @@ // // EFI_PEI_PROGRESS_CODE_PPI.ReportStatusCode() is equivalent to the // PEI Service ReportStatusCode(). -// It is introduced in PIPeiCis.h. +// It is introduced in PIPeiCis.h. // /// diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/SuperIo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/SuperIo.h index 9f129ffc98..3e562e96e0 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/SuperIo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/SuperIo.h @@ -2,13 +2,13 @@ This PPI provides the super I/O register access functionality. Copyright (c) 2015, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is from PI Version 1.2.1. @@ -34,7 +34,7 @@ typedef UINT16 EFI_SIO_REGISTER; /** Read a Super I/O register. - + The register is specified as an 8-bit logical device number and an 8-bit register value. The logical device numbers for specific SIO devices can be determined using the Info member of the PPI structure. @@ -47,8 +47,8 @@ typedef UINT16 EFI_SIO_REGISTER; track the current state of the configuration mode (if any) and turn on configuration mode (if necessary) prior to register access. - @param Register A value specifying the logical device number (bits 15:8) - and the register to read (bits 7:0). The logical device + @param Register A value specifying the logical device number (bits 15:8) + and the register to read (bits 7:0). The logical device number of EFI_SIO_LDN_GLOBAL indicates that global registers will be used. @param IoData A pointer to the returned register value. @@ -85,8 +85,8 @@ EFI_STATUS track the current state of the configuration mode (if any) and turn on configuration mode (if necessary) prior to register access. - @param Register A value specifying the logical device number (bits 15:8) - and the register to read (bits 7:0). The logical device + @param Register A value specifying the logical device number (bits 15:8) + and the register to read (bits 7:0). The logical device number of EFI_SIO_LDN_GLOBAL indicates that global registers will be used. @param IoData A pointer to the returned register value. @@ -97,7 +97,7 @@ EFI_STATUS @retval EFI_INVALID_PARAMETERS Register was out of range for this device. @retval EFI_INVALID_PARAMETERS IoData was NULL @retval EFI_DEVICE_ERROR There was a device fault or the device was not present. -**/ +**/ typedef EFI_STATUS (EFIAPI *EFI_PEI_SIO_REGISTER_WRITE)( @@ -129,7 +129,7 @@ EFI_STATUS @retval EFI_SUCCESS The operation completed successfully. @retval EFI_INVALID_PARAMETERS Command is NULL. -**/ +**/ typedef EFI_STATUS (EFIAPI *EFI_PEI_SIO_REGISTER_MODIFY)( @@ -186,4 +186,4 @@ struct _EFI_SIO_PPI { extern EFI_GUID gEfiSioPpiGuid; -#endif +#endif diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/TemporaryRamDone.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/TemporaryRamDone.h index 349dac88b5..1fe2a8387b 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/TemporaryRamDone.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/TemporaryRamDone.h @@ -3,13 +3,13 @@ The PPI that provides a service to disable the use of Temporary RAM. Copyright (c) 2013, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.2.1. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/TemporaryRamSupport.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/TemporaryRamSupport.h index 87e5dbd156..41685a26ca 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/TemporaryRamSupport.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/TemporaryRamSupport.h @@ -3,13 +3,13 @@ This Ppi provides the service that migrates temporary RAM into permanent memory. Copyright (c) 2006 - 2011, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.0. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/VectorHandoffInfo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/VectorHandoffInfo.h index fba0856bce..316788d90a 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/VectorHandoffInfo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/VectorHandoffInfo.h @@ -4,16 +4,16 @@ This is an optional PPI that may be produced by SEC. If present, it provides a description of the interrupt and/or exception vectors that were established - in the SEC Phase and need to persist into PEI and DXE. + in the SEC Phase and need to persist into PEI and DXE. Copyright (c) 2013, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is introduced in PI Version 1.2.1. @@ -53,7 +53,7 @@ typedef struct { // UINT32 Attribute; // - // The GUID identifies the party who created the entry. For the + // The GUID identifies the party who created the entry. For the // EFI_VECTOR_HANDOFF_DO_NOT_HOOK case, this establishes the single owner. // EFI_GUID Owner; @@ -61,7 +61,7 @@ typedef struct { /// /// Provides a description of the interrupt and/or exception vectors that -/// were established in the SEC Phase and need to persist into PEI and DXE. +/// were established in the SEC Phase and need to persist into PEI and DXE. /// typedef struct _EFI_PEI_VECTOR_HANDOFF_INFO_PPI { // diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AbsolutePointer.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AbsolutePointer.h index 42693ab20b..87f7d47f61 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AbsolutePointer.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AbsolutePointer.h @@ -1,15 +1,15 @@ /** @file The file provides services that allow information about an absolute pointer device to be retrieved. - + Copyright (c) 2006 - 2012, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -38,25 +38,25 @@ typedef struct { UINT64 AbsoluteMinX; ///< The Absolute Minimum of the device on the x-axis UINT64 AbsoluteMinY; ///< The Absolute Minimum of the device on the y axis. UINT64 AbsoluteMinZ; ///< The Absolute Minimum of the device on the z-axis - UINT64 AbsoluteMaxX; ///< The Absolute Maximum of the device on the x-axis. If 0, and the + UINT64 AbsoluteMaxX; ///< The Absolute Maximum of the device on the x-axis. If 0, and the ///< AbsoluteMinX is 0, then the pointer device does not support a xaxis - UINT64 AbsoluteMaxY; ///< The Absolute Maximum of the device on the y -axis. If 0, and the + UINT64 AbsoluteMaxY; ///< The Absolute Maximum of the device on the y -axis. If 0, and the ///< AbsoluteMinX is 0, then the pointer device does not support a yaxis. - UINT64 AbsoluteMaxZ; ///< The Absolute Maximum of the device on the z-axis. If 0 , and the + UINT64 AbsoluteMaxZ; ///< The Absolute Maximum of the device on the z-axis. If 0 , and the ///< AbsoluteMinX is 0, then the pointer device does not support a zaxis - UINT32 Attributes; ///< The following bits are set as needed (or'd together) to indicate the - ///< capabilities of the device supported. The remaining bits are undefined + UINT32 Attributes; ///< The following bits are set as needed (or'd together) to indicate the + ///< capabilities of the device supported. The remaining bits are undefined ///< and should be 0 } EFI_ABSOLUTE_POINTER_MODE; /// -/// If set, indicates this device supports an alternate button input. -/// +/// If set, indicates this device supports an alternate button input. +/// #define EFI_ABSP_SupportsAltActive 0x00000001 /// /// If set, indicates this device returns pressure data in parameter CurrentZ. -/// +/// #define EFI_ABSP_SupportsPressureAsZ 0x00000002 @@ -80,7 +80,7 @@ typedef struct { device during reset. @retval EFI_SUCCESS The device was reset. - + @retval EFI_DEVICE_ERROR The device is not functioning correctly and could not be reset. @@ -95,11 +95,11 @@ EFI_STATUS /// /// This bit is set if the touch sensor is active. /// -#define EFI_ABSP_TouchActive 0x00000001 +#define EFI_ABSP_TouchActive 0x00000001 /// /// This bit is set if the alt sensor, such as pen-side button, is active -/// +/// #define EFI_ABS_AltActive 0x00000002 @@ -108,29 +108,29 @@ EFI_STATUS **/ typedef struct { /// - /// The unsigned position of the activation on the x axis. If the AboluteMinX - /// and the AboluteMaxX fields of the EFI_ABSOLUTE_POINTER_MODE structure are + /// The unsigned position of the activation on the x axis. If the AboluteMinX + /// and the AboluteMaxX fields of the EFI_ABSOLUTE_POINTER_MODE structure are /// both 0, then this pointer device does not support an x-axis, and this field /// must be ignored. /// UINT64 CurrentX; - + /// - /// The unsigned position of the activation on the y axis. If the AboluteMinY - /// and the AboluteMaxY fields of the EFI_ABSOLUTE_POINTER_MODE structure are + /// The unsigned position of the activation on the y axis. If the AboluteMinY + /// and the AboluteMaxY fields of the EFI_ABSOLUTE_POINTER_MODE structure are /// both 0, then this pointer device does not support an y-axis, and this field - /// must be ignored. + /// must be ignored. /// UINT64 CurrentY; - + /// - /// The unsigned position of the activation on the z axis, or the pressure - /// measurement. If the AboluteMinZ and the AboluteMaxZ fields of the - /// EFI_ABSOLUTE_POINTER_MODE structure are both 0, then this pointer device - /// does not support an z-axis, and this field must be ignored. + /// The unsigned position of the activation on the z axis, or the pressure + /// measurement. If the AboluteMinZ and the AboluteMaxZ fields of the + /// EFI_ABSOLUTE_POINTER_MODE structure are both 0, then this pointer device + /// does not support an z-axis, and this field must be ignored. /// UINT64 CurrentZ; - + /// /// Bits are set to 1 in this structure item to indicate that device buttons are /// active. @@ -188,7 +188,7 @@ struct _EFI_ABSOLUTE_POINTER_PROTOCOL { EFI_ABSOLUTE_POINTER_RESET Reset; EFI_ABSOLUTE_POINTER_GET_STATE GetState; /// - /// Event to use with WaitForEvent() to wait for input from the pointer device. + /// Event to use with WaitForEvent() to wait for input from the pointer device. /// EFI_EVENT WaitForInput; /// diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AcpiSystemDescriptionTable.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AcpiSystemDescriptionTable.h index b98862f6d8..d120dde203 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AcpiSystemDescriptionTable.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AcpiSystemDescriptionTable.h @@ -1,14 +1,14 @@ /** @file This protocol provides services for creating ACPI system description tables. - + Copyright (c) 2006 - 2015, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -17,7 +17,7 @@ #define EFI_ACPI_SDT_PROTOCOL_GUID \ { 0xeb97088e, 0xcfdf, 0x49c6, { 0xbe, 0x4b, 0xd9, 0x6, 0xa5, 0xb2, 0xe, 0x86 }} - + typedef UINT32 EFI_ACPI_TABLE_VERSION; typedef VOID *EFI_ACPI_HANDLE; @@ -27,7 +27,7 @@ typedef VOID *EFI_ACPI_HANDLE; #define EFI_ACPI_TABLE_VERSION_3_0 (1 << 3) #define EFI_ACPI_TABLE_VERSION_4_0 (1 << 4) #define EFI_ACPI_TABLE_VERSION_5_0 (1 << 5) - + typedef UINT32 EFI_ACPI_DATA_TYPE; #define EFI_ACPI_DATA_TYPE_NONE 0 #define EFI_ACPI_DATA_TYPE_OPCODE 1 @@ -36,7 +36,7 @@ typedef UINT32 EFI_ACPI_DATA_TYPE; #define EFI_ACPI_DATA_TYPE_UINT 4 #define EFI_ACPI_DATA_TYPE_STRING 5 #define EFI_ACPI_DATA_TYPE_CHILD 6 - + typedef struct { UINT32 Signature; UINT32 Length; @@ -48,7 +48,7 @@ typedef struct { UINT32 CreatorId; UINT32 CreatorRevision; } EFI_ACPI_SDT_HEADER; - + typedef EFI_STATUS (EFIAPI *EFI_ACPI_NOTIFICATION_FN)( @@ -56,10 +56,10 @@ EFI_STATUS IN EFI_ACPI_TABLE_VERSION Version, ///< The ACPI table's version. IN UINTN TableKey ///< The table key for this ACPI table. ); - + /** Returns a requested ACPI table. - + The GetAcpiTable() function returns a pointer to a buffer containing the ACPI table associated with the Index that was input. The following structures are not considered elements in the list of ACPI tables: @@ -69,20 +69,20 @@ EFI_STATUS Version is updated with a bit map containing all the versions of ACPI of which the table is a member. For tables installed via the EFI_ACPI_TABLE_PROTOCOL.InstallAcpiTable() interface, the function returns the value of EFI_ACPI_STD_PROTOCOL.AcpiVersion. - + @param[in] Index The zero-based index of the table to retrieve. @param[out] Table Pointer for returning the table buffer. @param[out] Version On return, updated with the ACPI versions to which this table belongs. Type EFI_ACPI_TABLE_VERSION is defined in "Related Definitions" in the - EFI_ACPI_SDT_PROTOCOL. + EFI_ACPI_SDT_PROTOCOL. @param[out] TableKey On return, points to the table key for the specified ACPI system definition table. This is identical to the table key used in the EFI_ACPI_TABLE_PROTOCOL. The TableKey can be passed to EFI_ACPI_TABLE_PROTOCOL.UninstallAcpiTable() to uninstall the table. @retval EFI_SUCCESS The function completed successfully. - @retval EFI_NOT_FOUND The requested index is too large and a table was not found. -**/ + @retval EFI_NOT_FOUND The requested index is too large and a table was not found. +**/ typedef EFI_STATUS (EFIAPI *EFI_ACPI_GET_ACPI_TABLE2)( @@ -94,17 +94,17 @@ EFI_STATUS /** Register or unregister a callback when an ACPI table is installed. - + This function registers or unregisters a function which will be called whenever a new ACPI table is installed. - + @param[in] Register If TRUE, then the specified function will be registered. If FALSE, then the specified function will be unregistered. @param[in] Notification Points to the callback function to be registered or unregistered. - + @retval EFI_SUCCESS Callback successfully registered or unregistered. @retval EFI_INVALID_PARAMETER Notification is NULL - @retval EFI_INVALID_PARAMETER Register is FALSE and Notification does not match a known registration function. + @retval EFI_INVALID_PARAMETER Register is FALSE and Notification does not match a known registration function. **/ typedef EFI_STATUS @@ -115,30 +115,30 @@ EFI_STATUS /** Create a handle from an ACPI opcode - + @param[in] Buffer Points to the ACPI opcode. @param[out] Handle Upon return, holds the handle. - + @retval EFI_SUCCESS Success @retval EFI_INVALID_PARAMETER Buffer is NULL or Handle is NULL or Buffer points to an invalid opcode. - + **/ typedef EFI_STATUS (EFIAPI *EFI_ACPI_OPEN)( IN VOID *Buffer, - OUT EFI_ACPI_HANDLE *Handle + OUT EFI_ACPI_HANDLE *Handle ); /** Create a handle for the first ACPI opcode in an ACPI system description table. - + @param[in] TableKey The table key for the ACPI table, as returned by GetTable(). @param[out] Handle On return, points to the newly created ACPI handle. @retval EFI_SUCCESS Handle created successfully. - @retval EFI_NOT_FOUND TableKey does not refer to a valid ACPI table. + @retval EFI_NOT_FOUND TableKey does not refer to a valid ACPI table. **/ typedef EFI_STATUS @@ -149,11 +149,11 @@ EFI_STATUS /** Close an ACPI handle. - + @param[in] Handle Returns the handle. - + @retval EFI_SUCCESS Success - @retval EFI_INVALID_PARAMETER Handle is NULL or does not refer to a valid ACPI object. + @retval EFI_INVALID_PARAMETER Handle is NULL or does not refer to a valid ACPI object. **/ typedef EFI_STATUS @@ -163,14 +163,14 @@ EFI_STATUS /** Return the child ACPI objects. - + @param[in] ParentHandle Parent handle. @param[in, out] Handle On entry, points to the previously returned handle or NULL to start with the first handle. On return, points to the next returned ACPI handle or NULL if there are no child objects. @retval EFI_SUCCESS Success - @retval EFI_INVALID_PARAMETER ParentHandle is NULL or does not refer to a valid ACPI object. + @retval EFI_INVALID_PARAMETER ParentHandle is NULL or does not refer to a valid ACPI object. **/ typedef EFI_STATUS @@ -181,7 +181,7 @@ EFI_STATUS /** Retrieve information about an ACPI object. - + @param[in] Handle ACPI object handle. @param[in] Index Index of the data to retrieve from the object. In general, indexes read from left-to-right in the ACPI encoding, with index 0 always being the ACPI opcode. @@ -189,8 +189,8 @@ EFI_STATUS for the specified index. @param[out] Data Upon return, points to the pointer to the data. @param[out] DataSize Upon return, points to the size of Data. - - @retval + + @retval **/ typedef EFI_STATUS @@ -204,7 +204,7 @@ EFI_STATUS /** Change information about an ACPI object. - + @param[in] Handle ACPI object handle. @param[in] Index Index of the data to retrieve from the object. In general, indexes read from left-to-right in the ACPI encoding, with index 0 always being the ACPI opcode. @@ -228,14 +228,14 @@ EFI_STATUS /** Returns the handle of the ACPI object representing the specified ACPI path - + @param[in] HandleIn Points to the handle of the object representing the starting point for the path search. @param[in] AcpiPath Points to the ACPI path, which conforms to the ACPI encoded path format. @param[out] HandleOut On return, points to the ACPI object which represents AcpiPath, relative to HandleIn. - + @retval EFI_SUCCESS Success - @retval EFI_INVALID_PARAMETER HandleIn is NULL or does not refer to a valid ACPI object. + @retval EFI_INVALID_PARAMETER HandleIn is NULL or does not refer to a valid ACPI object. **/ typedef EFI_STATUS diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AcpiTable.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AcpiTable.h index c608182326..fedaf478b5 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AcpiTable.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AcpiTable.h @@ -1,15 +1,15 @@ /** @file The file provides the protocol to install or remove an ACPI - table from a platform. - + table from a platform. + Copyright (c) 2006 - 2014, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -24,24 +24,24 @@ typedef struct _EFI_ACPI_TABLE_PROTOCOL EFI_ACPI_TABLE_PROTOCOL; /** - The InstallAcpiTable() function allows a caller to install an - ACPI table. When successful, the table will be linked by the - RSDT/XSDT. AcpiTableBuffer specifies the table to be installed. - InstallAcpiTable() will make a copy of the table and insert the - copy into the RSDT/XSDT. InstallAcpiTable() must insert the new - table at the end of the RSDT/XSDT. To prevent namespace - collision, ACPI tables may be created using UEFI ACPI table + The InstallAcpiTable() function allows a caller to install an + ACPI table. When successful, the table will be linked by the + RSDT/XSDT. AcpiTableBuffer specifies the table to be installed. + InstallAcpiTable() will make a copy of the table and insert the + copy into the RSDT/XSDT. InstallAcpiTable() must insert the new + table at the end of the RSDT/XSDT. To prevent namespace + collision, ACPI tables may be created using UEFI ACPI table format. If this protocol is used to install a table with a signature already present in the system, the new table will not replace the existing table. It is a platform implementation decision to add a new table with a signature matching an existing table or disallow duplicate table signatures and - return EFI_ACCESS_DENIED. On successful output, TableKey is - initialized with a unique key. Its value may be used in a - subsequent call to UninstallAcpiTable to remove an ACPI table. - If an EFI application is running at the time of this call, the - relevant EFI_CONFIGURATION_TABLE pointer to the RSDT is no - longer considered valid. + return EFI_ACCESS_DENIED. On successful output, TableKey is + initialized with a unique key. Its value may be used in a + subsequent call to UninstallAcpiTable to remove an ACPI table. + If an EFI application is running at the time of this call, the + relevant EFI_CONFIGURATION_TABLE pointer to the RSDT is no + longer considered valid. @param This A pointer to a EFI_ACPI_TABLE_PROTOCOL. @@ -54,16 +54,16 @@ typedef struct _EFI_ACPI_TABLE_PROTOCOL EFI_ACPI_TABLE_PROTOCOL; @param TableKey Returns a key to refer to the ACPI table. - + @retval EFI_SUCCESS The table was successfully inserted - + @retval EFI_INVALID_PARAMETER Either AcpiTableBuffer is NULL, TableKey is NULL, or AcpiTableBufferSize and the size field embedded in the ACPI table pointed to by AcpiTableBuffer are not in sync. - + @retval EFI_OUT_OF_RESOURCES Insufficient resources exist to complete the request. @retval EFI_ACCESS_DENIED The table signature matches a table already @@ -82,7 +82,7 @@ EFI_STATUS /** - + The UninstallAcpiTable() function allows a caller to remove an ACPI table. The routine will remove its reference from the RSDT/XSDT. A table is referenced by the TableKey parameter @@ -103,7 +103,7 @@ EFI_STATUS @retval EFI_OUT_OF_RESOURCES Insufficient resources exist to complete the request. - + **/ typedef EFI_STATUS diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AdapterInformation.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AdapterInformation.h index daaff3fe04..82b4188987 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AdapterInformation.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AdapterInformation.h @@ -59,9 +59,9 @@ typedef struct _EFI_ADAPTER_INFORMATION_PROTOCOL EFI_ADAPTER_INFORMATION_PROTOCO /// typedef struct { /// - /// Returns the current media state status. MediaState can have any of the following values: - /// EFI_SUCCESS: There is media attached to the network adapter. EFI_NOT_READY: This detects a bounced state. - /// There was media attached to the network adapter, but it was removed and reattached. EFI_NO_MEDIA: There is + /// Returns the current media state status. MediaState can have any of the following values: + /// EFI_SUCCESS: There is media attached to the network adapter. EFI_NOT_READY: This detects a bounced state. + /// There was media attached to the network adapter, but it was removed and reattached. EFI_NO_MEDIA: There is /// not any media attached to the network. /// EFI_STATUS MediaState; @@ -140,7 +140,7 @@ typedef struct { /// /// Returns capability of UNDI to support IPv6 traffic. /// - BOOLEAN Ipv6Support; + BOOLEAN Ipv6Support; } EFI_ADAPTER_INFO_UNDI_IPV6_SUPPORT; /** @@ -148,7 +148,7 @@ typedef struct { This function returns information of type InformationType from the adapter. If an adapter does not support the requested informational type, then - EFI_UNSUPPORTED is returned. + EFI_UNSUPPORTED is returned. @param[in] This A pointer to the EFI_ADAPTER_INFORMATION_PROTOCOL instance. @param[in] InformationType A pointer to an EFI_GUID that defines the contents of InformationBlock. @@ -160,8 +160,8 @@ typedef struct { @retval EFI_UNSUPPORTED The InformationType is not known. @retval EFI_DEVICE_ERROR The device reported an error. @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_INVALID_PARAMETER InformationBlock is NULL. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_INVALID_PARAMETER InformationBlock is NULL. @retval EFI_INVALID_PARAMETER InformationBlockSize is NULL. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Arp.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Arp.h index 0295cc644d..360cb72069 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Arp.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Arp.h @@ -1,22 +1,22 @@ -/** @file +/** @file EFI ARP Protocol Definition - + The EFI ARP Service Binding Protocol is used to locate EFI ARP Protocol drivers to create and destroy child of the driver to communicate with other host using ARP protocol. The EFI ARP Protocol provides services to map IP network address to hardware address used by a data link protocol. - + 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +http://opensource.org/licenses/bsd-license.php. - @par Revision Reference: +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + + @par Revision Reference: This Protocol was introduced in UEFI Specification 2.0. **/ @@ -119,13 +119,13 @@ typedef struct { /** This function is used to assign a station address to the ARP cache for this instance of the ARP driver. - - Each ARP instance has one station address. The EFI_ARP_PROTOCOL driver will - respond to ARP requests that match this registered station address. A call to + + Each ARP instance has one station address. The EFI_ARP_PROTOCOL driver will + respond to ARP requests that match this registered station address. A call to this function with the ConfigData field set to NULL will reset this ARP instance. - - Once a protocol type and station address have been assigned to this ARP instance, - all the following ARP functions will use this information. Attempting to change + + Once a protocol type and station address have been assigned to this ARP instance, + all the following ARP functions will use this information. Attempting to change the protocol type or station address to a configured ARP instance will result in errors. @param This The pointer to the EFI_ARP_PROTOCOL instance. @@ -134,8 +134,8 @@ typedef struct { @retval EFI_SUCCESS The new station address was successfully registered. @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - * This is NULL. - * SwAddressLength is zero when ConfigData is not NULL. + * This is NULL. + * SwAddressLength is zero when ConfigData is not NULL. * StationAddress is NULL when ConfigData is not NULL. @retval EFI_ACCESS_DENIED The SwAddressType, SwAddressLength, or StationAddress is different from the one that is @@ -144,27 +144,27 @@ typedef struct { allocated. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_ARP_CONFIGURE)( IN EFI_ARP_PROTOCOL *This, IN EFI_ARP_CONFIG_DATA *ConfigData OPTIONAL - ); + ); /** This function is used to insert entries into the ARP cache. - ARP cache entries are typically inserted and updated by network protocol drivers - as network traffic is processed. Most ARP cache entries will time out and be - deleted if the network traffic stops. ARP cache entries that were inserted + ARP cache entries are typically inserted and updated by network protocol drivers + as network traffic is processed. Most ARP cache entries will time out and be + deleted if the network traffic stops. ARP cache entries that were inserted by the Add() function may be static (will not time out) or dynamic (will time out). - Default ARP cache timeout values are not covered in most network protocol - specifications (although RFC 1122 comes pretty close) and will only be - discussed in general terms in this specification. The timeout values that are - used in the EFI Sample Implementation should be used only as a guideline. - Final product implementations of the EFI network stack should be tuned for + Default ARP cache timeout values are not covered in most network protocol + specifications (although RFC 1122 comes pretty close) and will only be + discussed in general terms in this specification. The timeout values that are + used in the EFI Sample Implementation should be used only as a guideline. + Final product implementations of the EFI network stack should be tuned for their expected network environments. - + @param This Pointer to the EFI_ARP_PROTOCOL instance. @param DenyFlag Set to TRUE if this entry is a deny entry. Set to FALSE if this entry is a normal entry. @@ -184,10 +184,10 @@ EFI_STATUS @retval EFI_SUCCESS The entry has been added or updated. @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - * This is NULL. - * DenyFlag is FALSE and TargetHwAddress is NULL. - * DenyFlag is FALSE and TargetSwAddress is NULL. - * TargetHwAddress is NULL and TargetSwAddress is NULL. + * This is NULL. + * DenyFlag is FALSE and TargetHwAddress is NULL. + * DenyFlag is FALSE and TargetSwAddress is NULL. + * TargetHwAddress is NULL and TargetSwAddress is NULL. * Neither TargetSwAddress nor TargetHwAddress are NULL when DenyFlag is TRUE. @retval EFI_OUT_OF_RESOURCES The new ARP cache entry could not be allocated. @@ -205,24 +205,24 @@ EFI_STATUS IN VOID *TargetHwAddress OPTIONAL, IN UINT32 TimeoutValue, IN BOOLEAN Overwrite - ); + ); /** This function searches the ARP cache for matching entries and allocates a buffer into which those entries are copied. - - The first part of the allocated buffer is EFI_ARP_FIND_DATA, following which + + The first part of the allocated buffer is EFI_ARP_FIND_DATA, following which are protocol address pairs and hardware address pairs. - When finding a specific protocol address (BySwAddress is TRUE and AddressBuffer - is not NULL), the ARP cache timeout for the found entry is reset if Refresh is - set to TRUE. If the found ARP cache entry is a permanent entry, it is not + When finding a specific protocol address (BySwAddress is TRUE and AddressBuffer + is not NULL), the ARP cache timeout for the found entry is reset if Refresh is + set to TRUE. If the found ARP cache entry is a permanent entry, it is not affected by Refresh. - + @param This The pointer to the EFI_ARP_PROTOCOL instance. @param BySwAddress Set to TRUE to look for matching software protocol addresses. Set to FALSE to look for matching hardware protocol addresses. - @param AddressBuffer The pointer to the address buffer. Set to NULL + @param AddressBuffer The pointer to the address buffer. Set to NULL to match all addresses. @param EntryLength The size of an entry in the entries buffer. @param EntryCount The number of ARP cache entries that are found by @@ -241,7 +241,7 @@ EFI_STATUS @retval EFI_NOT_STARTED The ARP driver instance has not been configured. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_ARP_FIND)( IN EFI_ARP_PROTOCOL *This, @@ -251,7 +251,7 @@ EFI_STATUS OUT UINT32 *EntryCount OPTIONAL, OUT EFI_ARP_FIND_DATA **Entries OPTIONAL, IN BOOLEAN Refresh - ); + ); /** @@ -277,7 +277,7 @@ EFI_STATUS IN EFI_ARP_PROTOCOL *This, IN BOOLEAN BySwAddress, IN VOID *AddressBuffer OPTIONAL - ); + ); /** This function delete all dynamic entries from the ARP cache that match the specified @@ -295,7 +295,7 @@ typedef EFI_STATUS (EFIAPI *EFI_ARP_FLUSH)( IN EFI_ARP_PROTOCOL *This - ); + ); /** This function tries to resolve the TargetSwAddress and optionally returns a @@ -322,22 +322,22 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_ARP_REQUEST)( - IN EFI_ARP_PROTOCOL *This, + IN EFI_ARP_PROTOCOL *This, IN VOID *TargetSwAddress OPTIONAL, IN EFI_EVENT ResolvedEvent OPTIONAL, - OUT VOID *TargetHwAddress - ); + OUT VOID *TargetHwAddress + ); /** This function aborts the previous ARP request (identified by This, TargetSwAddress and ResolvedEvent) that is issued by EFI_ARP_PROTOCOL.Request(). - - If the request is in the internal ARP request queue, the request is aborted - immediately and its ResolvedEvent is signaled. Only an asynchronous address - request needs to be canceled. If TargeSwAddress and ResolveEvent are both - NULL, all the pending asynchronous requests that have been issued by This + + If the request is in the internal ARP request queue, the request is aborted + immediately and its ResolvedEvent is signaled. Only an asynchronous address + request needs to be canceled. If TargeSwAddress and ResolveEvent are both + NULL, all the pending asynchronous requests that have been issued by This instance will be cancelled and their corresponding events will be signaled. - + @param This The pointer to the EFI_ARP_PROTOCOL instance. @param TargetSwAddress The pointer to the protocol address in previous request session. @@ -359,13 +359,13 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_ARP_CANCEL)( - IN EFI_ARP_PROTOCOL *This, + IN EFI_ARP_PROTOCOL *This, IN VOID *TargetSwAddress OPTIONAL, IN EFI_EVENT ResolvedEvent OPTIONAL - ); + ); /// -/// ARP is used to resolve local network protocol addresses into +/// ARP is used to resolve local network protocol addresses into /// network hardware addresses. /// struct _EFI_ARP_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AtaPassThru.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AtaPassThru.h index 1cc596f9e4..820d003f36 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AtaPassThru.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AtaPassThru.h @@ -4,13 +4,13 @@ includes the attributes of the ATA controller. Copyright (c) 2009 - 2016, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -56,7 +56,7 @@ typedef struct _EFI_ATA_COMMAND_BLOCK { UINT8 AtaDeviceHead; UINT8 AtaSectorNumberExp; UINT8 AtaCylinderLowExp; - UINT8 AtaCylinderHighExp; + UINT8 AtaCylinderHighExp; UINT8 AtaFeaturesExp; UINT8 AtaSectorCount; UINT8 AtaSectorCountExp; @@ -73,7 +73,7 @@ typedef struct _EFI_ATA_STATUS_BLOCK { UINT8 AtaDeviceHead; UINT8 AtaSectorNumberExp; UINT8 AtaCylinderLowExp; - UINT8 AtaCylinderHighExp; + UINT8 AtaCylinderHighExp; UINT8 Reserved2; UINT8 AtaSectorCount; UINT8 AtaSectorCountExp; @@ -156,7 +156,7 @@ typedef struct { /// /// On Input, the size, in bytes of OutDataBuffer. On Output, the Number of bytes /// transferred between ATA Controller and the ATA device. If OutTransferLength is - /// larger than the ATA controller can handle, no data will be transferred, + /// larger than the ATA controller can handle, no data will be transferred, /// OutTransferLength will be updated to contain the number of bytes that the ATA /// controller is able to transfer, and EFI_BAD_BUFFER_SIZE will be returned. /// @@ -177,8 +177,8 @@ typedef struct { supports both blocking I/O and non-blocking I/O. The blocking I/O functionality is required, and the non-blocking I/O functionality is optional. - @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. - @param[in] Port The port number of the ATA device to send the command. + @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. + @param[in] Port The port number of the ATA device to send the command. @param[in] PortMultiplierPort The port multiplier port number of the ATA device to send the command. If there is no port multiplier, then specify 0xFFFF. @param[in,out] Packet A pointer to the ATA command to send to the ATA device specified by Port @@ -188,11 +188,11 @@ typedef struct { Event is not NULL and non blocking I/O is supported, then non-blocking I/O is performed, and Event will be signaled when the ATA command completes. - @retval EFI_SUCCESS The ATA command was sent by the host. For bi-directional commands, + @retval EFI_SUCCESS The ATA command was sent by the host. For bi-directional commands, InTransferLength bytes were transferred from InDataBuffer. For write and bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer. @retval EFI_BAD_BUFFER_SIZE The ATA command was not executed. The number of bytes that could be transferred - is returned in InTransferLength. For write and bi-directional commands, + is returned in InTransferLength. For write and bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer. @retval EFI_NOT_READY The ATA command could not be sent because there are too many ATA commands already queued. The caller may retry again later. @@ -230,7 +230,7 @@ EFI_STATUS If Port is the port number of the last port on the ATA controller, then EFI_NOT_FOUND is returned. - @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. + @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. @param[in,out] Port On input, a pointer to the port number on the ATA controller. On output, a pointer to the next port number on the ATA controller. An input value of 0xFFFF retrieves the first port @@ -250,36 +250,36 @@ EFI_STATUS ); /** - Used to retrieve the list of legal port multiplier port numbers for ATA devices on a port of an ATA - controller. These can either be the list of port multiplier ports where ATA devices are actually - present on port or the list of legal port multiplier ports on that port. Regardless, the caller of this - function must probe the port number and port multiplier port number returned to see if an ATA + Used to retrieve the list of legal port multiplier port numbers for ATA devices on a port of an ATA + controller. These can either be the list of port multiplier ports where ATA devices are actually + present on port or the list of legal port multiplier ports on that port. Regardless, the caller of this + function must probe the port number and port multiplier port number returned to see if an ATA device is actually present. - The GetNextDevice() function retrieves the port multiplier port number of an ATA device + The GetNextDevice() function retrieves the port multiplier port number of an ATA device present on a port of an ATA controller. - - If PortMultiplierPort points to a port multiplier port number value that was returned on a + + If PortMultiplierPort points to a port multiplier port number value that was returned on a previous call to GetNextDevice(), then the port multiplier port number of the next ATA device on the port of the ATA controller is returned in PortMultiplierPort, and EFI_SUCCESS is returned. - - If PortMultiplierPort points to 0xFFFF, then the port multiplier port number of the first - ATA device on port of the ATA controller is returned in PortMultiplierPort and + + If PortMultiplierPort points to 0xFFFF, then the port multiplier port number of the first + ATA device on port of the ATA controller is returned in PortMultiplierPort and EFI_SUCCESS is returned. - + If PortMultiplierPort is not 0xFFFF and the value pointed to by PortMultiplierPort was not returned on a previous call to GetNextDevice(), then EFI_INVALID_PARAMETER is returned. - - If PortMultiplierPort is the port multiplier port number of the last ATA device on the port of + + If PortMultiplierPort is the port multiplier port number of the last ATA device on the port of the ATA controller, then EFI_NOT_FOUND is returned. @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. @param[in] Port The port number present on the ATA controller. @param[in,out] PortMultiplierPort On input, a pointer to the port multiplier port number of an - ATA device present on the ATA controller. - If on input a PortMultiplierPort of 0xFFFF is specified, + ATA device present on the ATA controller. + If on input a PortMultiplierPort of 0xFFFF is specified, then the port multiplier port number of the first ATA device is returned. On output, a pointer to the port multiplier port number of the next ATA device present on an ATA controller. @@ -345,7 +345,7 @@ EFI_STATUS The GetDevice() function determines the port and port multiplier port number associated with the ATA device described by DevicePath. If DevicePath is a device path node type that the - ATA Pass Thru driver supports, then the ATA Pass Thru driver will attempt to translate the contents + ATA Pass Thru driver supports, then the ATA Pass Thru driver will attempt to translate the contents DevicePath into a port number and port multiplier port number. If this translation is successful, then that port number and port multiplier port number are returned @@ -353,11 +353,11 @@ EFI_STATUS If DevicePath, Port, or PortMultiplierPort are NULL, then EFI_INVALID_PARAMETER is returned. - If DevicePath is not a device path node type that the ATA Pass Thru driver supports, then + If DevicePath is not a device path node type that the ATA Pass Thru driver supports, then EFI_UNSUPPORTED is returned. - If DevicePath is a device path node type that the ATA Pass Thru driver supports, but there is not - a valid translation from DevicePath to a port number and port multiplier port number, then + If DevicePath is a device path node type that the ATA Pass Thru driver supports, but there is not + a valid translation from DevicePath to a port number and port multiplier port number, then EFI_NOT_FOUND is returned. @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. @@ -423,7 +423,7 @@ EFI_STATUS If this ATA controller does not support a device reset operation, then EFI_UNSUPPORTED is returned. - If Port or PortMultiplierPort are not in a valid range for this ATA controller, then + If Port or PortMultiplierPort are not in a valid range for this ATA controller, then EFI_INVALID_PARAMETER is returned. If a device error occurs while executing that device reset operation, then EFI_DEVICE_ERROR diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AuthenticationInfo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AuthenticationInfo.h index 99e2023591..b607d6b21c 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AuthenticationInfo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/AuthenticationInfo.h @@ -1,16 +1,16 @@ /** @file EFI_AUTHENTICATION_INFO_PROTOCOL as defined in UEFI 2.0. - This protocol is used on any device handle to obtain authentication information + This protocol is used on any device handle to obtain authentication information associated with the physical or logical device. Copyright (c) 2006 - 2011, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -21,7 +21,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. { \ 0x7671d9d0, 0x53db, 0x4173, {0xaa, 0x69, 0x23, 0x27, 0xf2, 0x1f, 0x0b, 0xc7 } \ } - + #define EFI_AUTHENTICATION_CHAP_RADIUS_GUID \ { \ 0xd6062b50, 0x15ca, 0x11da, {0x92, 0x19, 0x00, 0x10, 0x83, 0xff, 0xca, 0x4d } \ @@ -75,7 +75,7 @@ typedef struct { /// UINT8 NasSecret[1]; - /// + /// /// CHAP Initiator Secret Length in bytes on offset NasSecret + NasSecretLength. /// /// UINT16 ChapSecretLength; @@ -181,11 +181,11 @@ typedef struct { responsible for allocating the buffer and it is the caller's responsibility to free buffer when the caller is finished with buffer. - @retval EFI_SUCCESS Successfully retrieved authentication information + @retval EFI_SUCCESS Successfully retrieved authentication information for the given ControllerHandle. - @retval EFI_INVALID_PARAMETER No matching authentication information found for + @retval EFI_INVALID_PARAMETER No matching authentication information found for the given ControllerHandle. - @retval EFI_DEVICE_ERROR The authentication information could not be retrieved + @retval EFI_DEVICE_ERROR The authentication information could not be retrieved due to a hardware error. **/ @@ -203,12 +203,12 @@ EFI_STATUS @param[in] This The pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL. @param[in] ControllerHandle The handle to the Controller. @param[in] Buffer The pointer to the authentication information. - - @retval EFI_SUCCESS Successfully set authentication information for the + + @retval EFI_SUCCESS Successfully set authentication information for the given ControllerHandle. - @retval EFI_UNSUPPORTED If the platform policies do not allow setting of + @retval EFI_UNSUPPORTED If the platform policies do not allow setting of the authentication information. - @retval EFI_DEVICE_ERROR The authentication information could not be configured + @retval EFI_DEVICE_ERROR The authentication information could not be configured due to a hardware error. @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the data. @@ -219,10 +219,10 @@ EFI_STATUS IN EFI_AUTHENTICATION_INFO_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN VOID *Buffer - ); + ); /// -/// This protocol is used on any device handle to obtain authentication +/// This protocol is used on any device handle to obtain authentication /// information associated with the physical or logical device. /// struct _EFI_AUTHENTICATION_INFO_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Bds.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Bds.h index 0ecc66c8ca..731289b149 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Bds.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Bds.h @@ -4,13 +4,13 @@ When the DXE core is done it calls the BDS via this protocol. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -29,19 +29,19 @@ typedef struct _EFI_BDS_ARCH_PROTOCOL EFI_BDS_ARCH_PROTOCOL; /** - This function uses policy data from the platform to determine what operating - system or system utility should be loaded and invoked. This function call - also optionally make the use of user input to determine the operating system - or system utility to be loaded and invoked. When the DXE Core has dispatched - all the drivers on the dispatch queue, this function is called. This - function will attempt to connect the boot devices required to load and invoke - the selected operating system or system utility. During this process, - additional firmware volumes may be discovered that may contain addition DXE - drivers that can be dispatched by the DXE Core. If a boot device cannot be - fully connected, this function calls the DXE Service Dispatch() to allow the - DXE drivers from any newly discovered firmware volumes to be dispatched. - Then the boot device connection can be attempted again. If the same boot - device connection operation fails twice in a row, then that boot device has + This function uses policy data from the platform to determine what operating + system or system utility should be loaded and invoked. This function call + also optionally make the use of user input to determine the operating system + or system utility to be loaded and invoked. When the DXE Core has dispatched + all the drivers on the dispatch queue, this function is called. This + function will attempt to connect the boot devices required to load and invoke + the selected operating system or system utility. During this process, + additional firmware volumes may be discovered that may contain addition DXE + drivers that can be dispatched by the DXE Core. If a boot device cannot be + fully connected, this function calls the DXE Service Dispatch() to allow the + DXE drivers from any newly discovered firmware volumes to be dispatched. + Then the boot device connection can be attempted again. If the same boot + device connection operation fails twice in a row, then that boot device has failed, and should be skipped. This function should never return. @param This The EFI_BDS_ARCH_PROTOCOL instance. @@ -56,11 +56,11 @@ VOID ); /// -/// The EFI_BDS_ARCH_PROTOCOL transfers control from DXE to an operating -/// system or a system utility. If there are not enough drivers initialized -/// when this protocol is used to access the required boot device(s), then -/// this protocol should add drivers to the dispatch queue and return control -/// back to the dispatcher. Once the required boot devices are available, then +/// The EFI_BDS_ARCH_PROTOCOL transfers control from DXE to an operating +/// system or a system utility. If there are not enough drivers initialized +/// when this protocol is used to access the required boot device(s), then +/// this protocol should add drivers to the dispatch queue and return control +/// back to the dispatcher. Once the required boot devices are available, then /// the boot device can be used to load and invoke an OS or a system utility. /// struct _EFI_BDS_ARCH_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Bis.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Bis.h index b3ac58ec03..97dbadfe90 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Bis.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Bis.h @@ -1,18 +1,18 @@ /** @file - The EFI_BIS_PROTOCOL is used to check a digital signature of a data block + The EFI_BIS_PROTOCOL is used to check a digital signature of a data block against a digital certificate for the purpose of an integrity and authorization check. 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +http://opensource.org/licenses/bsd-license.php. - @par Revision Reference: - This Protocol is introduced in EFI Specification 1.10. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + + @par Revision Reference: + This Protocol is introduced in EFI Specification 1.10. **/ @@ -122,32 +122,32 @@ typedef struct { #define BOOT_OBJECT_AUTHORIZATION_PARMSET_GUIDVALUE \ BOOT_OBJECT_AUTHORIZATION_PARMSET_GUID -/** +/** Initializes the BIS service, checking that it is compatible with the version requested by the caller. - After this call, other BIS functions may be invoked. - + After this call, other BIS functions may be invoked. + @param This A pointer to the EFI_BIS_PROTOCOL object. - @param AppHandle The function writes the new BIS_APPLICATION_HANDLE if + @param AppHandle The function writes the new BIS_APPLICATION_HANDLE if successful, otherwise it writes NULL. The caller must eventually - destroy this handle by calling Shutdown(). + destroy this handle by calling Shutdown(). @param InterfaceVersion On input, the caller supplies the major version number of the - interface version desired. - On output, both the major and minor + interface version desired. + On output, both the major and minor version numbers are updated with the major and minor version numbers of the interface. This update is done whether or not the - initialization was successful. - @param TargetAddress Indicates a network or device address of the BIS platform to connect to. + initialization was successful. + @param TargetAddress Indicates a network or device address of the BIS platform to connect to. @retval EFI_SUCCESS The function completed successfully. - @retval EFI_INCOMPATIBLE_VERSION The InterfaceVersion.Major requested by the + @retval EFI_INCOMPATIBLE_VERSION The InterfaceVersion.Major requested by the caller was not compatible with the interface version of the implementation. The InterfaceVersion.Major has been updated with the current interface version. - @retval EFI_UNSUPPORTED This is a local-platform implementation and - TargetAddress.Data was not NULL, or + @retval EFI_UNSUPPORTED This is a local-platform implementation and + TargetAddress.Data was not NULL, or TargetAddress.Data was any other value that was not - supported by the implementation. - @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. + supported by the implementation. + @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. @retval EFI_DEVICE_ERROR One of the following device errors: * The function encountered an unexpected internal failure while initializing a cryptographic software module * No cryptographic software module with compatible version was found @@ -161,51 +161,51 @@ typedef struct { is NULL or an invalid memory reference. Or, the TargetAddress parameter supplied by the caller is NULL or an invalid memory reference. - -**/ + +**/ typedef EFI_STATUS (EFIAPI *EFI_BIS_INITIALIZE)( - IN EFI_BIS_PROTOCOL *This, - OUT BIS_APPLICATION_HANDLE *AppHandle, - IN OUT EFI_BIS_VERSION *InterfaceVersion, - IN EFI_BIS_DATA *TargetAddress + IN EFI_BIS_PROTOCOL *This, + OUT BIS_APPLICATION_HANDLE *AppHandle, + IN OUT EFI_BIS_VERSION *InterfaceVersion, + IN EFI_BIS_DATA *TargetAddress ); -/** - Frees memory structures allocated and returned by other functions in the EFI_BIS protocol. - +/** + Frees memory structures allocated and returned by other functions in the EFI_BIS protocol. + @param AppHandle An opaque handle that identifies the caller's instance of initialization - of the BIS service. - @param ToFree An EFI_BIS_DATA* and associated memory block to be freed. + of the BIS service. + @param ToFree An EFI_BIS_DATA* and associated memory block to be freed. This EFI_BIS_DATA* must have been allocated by one of the other BIS functions. @retval EFI_SUCCESS The function completed successfully. @retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid - application instance handle associated with the EFI_BIS protocol. - @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. + application instance handle associated with the EFI_BIS protocol. + @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. @retval EFI_INVALID_PARAMETER The ToFree parameter is not or is no longer a memory resource - associated with this AppHandle. - -**/ + associated with this AppHandle. + +**/ typedef EFI_STATUS (EFIAPI *EFI_BIS_FREE)( - IN BIS_APPLICATION_HANDLE AppHandle, - IN EFI_BIS_DATA *ToFree + IN BIS_APPLICATION_HANDLE AppHandle, + IN EFI_BIS_DATA *ToFree ); -/** +/** Shuts down an application's instance of the BIS service, invalidating the application handle. After - this call, other BIS functions may no longer be invoked using the application handle value. - + this call, other BIS functions may no longer be invoked using the application handle value. + @param AppHandle An opaque handle that identifies the caller's instance of initialization - of the BIS service. + of the BIS service. @retval EFI_SUCCESS The function completed successfully. @retval EFI_NO_MAPPING The AppHandle parameter is not, or is no longer, a valid - application instance handle associated with the EFI_BIS protocol. - @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. + application instance handle associated with the EFI_BIS protocol. + @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. @retval EFI_DEVICE_ERROR The function encountered an unexpected internal failure while returning resources associated with a cryptographic software module, or while trying to shut down a cryptographic software module. @@ -213,206 +213,206 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_BIS_SHUTDOWN)( - IN BIS_APPLICATION_HANDLE AppHandle + IN BIS_APPLICATION_HANDLE AppHandle ); -/** +/** Retrieves the certificate that has been configured as the identity of the organization designated as the source of authorization for signatures of boot objects. - + @param AppHandle An opaque handle that identifies the caller's instance of initialization - of the BIS service. + of the BIS service. @param Certificate The function writes an allocated EFI_BIS_DATA* containing the Boot Object Authorization Certificate object. The caller must eventually free the memory allocated by this function using the function Free(). @retval EFI_SUCCESS The function completed successfully. @retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid - application instance handle associated with the EFI_BIS protocol. - @retval EFI_NOT_FOUND There is no Boot Object Authorization Certificate currently installed. - @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. + application instance handle associated with the EFI_BIS protocol. + @retval EFI_NOT_FOUND There is no Boot Object Authorization Certificate currently installed. + @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. @retval EFI_INVALID_PARAMETER The Certificate parameter supplied by the caller is NULL or - an invalid memory reference. - -**/ + an invalid memory reference. + +**/ typedef EFI_STATUS (EFIAPI *EFI_BIS_GET_BOOT_OBJECT_AUTHORIZATION_CERTIFICATE)( - IN BIS_APPLICATION_HANDLE AppHandle, - OUT EFI_BIS_DATA **Certificate + IN BIS_APPLICATION_HANDLE AppHandle, + OUT EFI_BIS_DATA **Certificate ); -/** +/** Verifies the integrity and authorization of the indicated data object according to the - indicated credentials. - + indicated credentials. + @param AppHandle An opaque handle that identifies the caller's instance of initialization - of the BIS service. + of the BIS service. @param Credentials A Signed Manifest containing verification information for the indicated - data object. + data object. @param DataObject An in-memory copy of the raw data object to be verified. @param IsVerified The function writes TRUE if the verification succeeded, otherwise - FALSE. - + FALSE. + @retval EFI_SUCCESS The function completed successfully. @retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid - application instance handle associated with the EFI_BIS protocol. - @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. + application instance handle associated with the EFI_BIS protocol. + @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. @retval EFI_INVALID_PARAMETER One or more parameters are invalid. @retval EFI_SECURITY_VIOLATION The signed manifest supplied as the Credentials parameter was invalid (could not be parsed) or Platform-specific authorization failed, etc. - @retval EFI_DEVICE_ERROR An unexpected internal error occurred. - -**/ + @retval EFI_DEVICE_ERROR An unexpected internal error occurred. + +**/ typedef EFI_STATUS (EFIAPI *EFI_BIS_VERIFY_BOOT_OBJECT)( - IN BIS_APPLICATION_HANDLE AppHandle, - IN EFI_BIS_DATA *Credentials, - IN EFI_BIS_DATA *DataObject, - OUT BOOLEAN *IsVerified + IN BIS_APPLICATION_HANDLE AppHandle, + IN EFI_BIS_DATA *Credentials, + IN EFI_BIS_DATA *DataObject, + OUT BOOLEAN *IsVerified ); -/** +/** Retrieves the current status of the Boot Authorization Check Flag. - + @param AppHandle An opaque handle that identifies the caller's instance of initialization - of the BIS service. + of the BIS service. @param CheckIsRequired The function writes the value TRUE if a Boot Authorization Check is - currently required on this platform, otherwise the function writes - FALSE. - + currently required on this platform, otherwise the function writes + FALSE. + @retval EFI_SUCCESS The function completed successfully. @retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid - application instance handle associated with the EFI_BIS protocol. - @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. + application instance handle associated with the EFI_BIS protocol. + @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. @retval EFI_INVALID_PARAMETER The CheckIsRequired parameter supplied by the caller is - NULL or an invalid memory reference. - -**/ + NULL or an invalid memory reference. + +**/ typedef EFI_STATUS (EFIAPI *EFI_BIS_GET_BOOT_OBJECT_AUTHORIZATION_CHECKFLAG)( - IN BIS_APPLICATION_HANDLE AppHandle, - OUT BOOLEAN *CheckIsRequired + IN BIS_APPLICATION_HANDLE AppHandle, + OUT BOOLEAN *CheckIsRequired ); -/** +/** Retrieves a unique token value to be included in the request credential for the next update of any - parameter in the Boot Object Authorization set - - @param AppHandle An opaque handle that identifies the caller's - instance of initialization of the BIS service. - @param UpdateToken The function writes an allocated EFI_BIS_DATA* - containing the newunique update token value. - The caller musteventually free the memory allocated + parameter in the Boot Object Authorization set + + @param AppHandle An opaque handle that identifies the caller's + instance of initialization of the BIS service. + @param UpdateToken The function writes an allocated EFI_BIS_DATA* + containing the newunique update token value. + The caller musteventually free the memory allocated by this function using the function Free(). - + @retval EFI_SUCCESS The function completed successfully. @retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid - application instance handle associated with the EFI_BIS protocol. - @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. + application instance handle associated with the EFI_BIS protocol. + @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. @retval EFI_INVALID_PARAMETER The UpdateToken parameter supplied by the caller is NULL or - an invalid memory reference. - @retval EFI_DEVICE_ERROR An unexpected internal error occurred. - -**/ + an invalid memory reference. + @retval EFI_DEVICE_ERROR An unexpected internal error occurred. + +**/ typedef EFI_STATUS (EFIAPI *EFI_BIS_GET_BOOT_OBJECT_AUTHORIZATION_UPDATE_TOKEN)( - IN BIS_APPLICATION_HANDLE AppHandle, - OUT EFI_BIS_DATA **UpdateToken + IN BIS_APPLICATION_HANDLE AppHandle, + OUT EFI_BIS_DATA **UpdateToken ); -/** +/** Updates one of the configurable parameters of the Boot Object Authorization set. - - @param AppHandle An opaque handle that identifies the caller's - instance of initialization of the BIS service. - @param RequestCredential This is a Signed Manifest with embedded attributes - that carry the details of the requested update. - @param NewUpdateToken The function writes an allocated EFI_BIS_DATA* - containing the new unique update token value. - The caller must eventually free the memory allocated + + @param AppHandle An opaque handle that identifies the caller's + instance of initialization of the BIS service. + @param RequestCredential This is a Signed Manifest with embedded attributes + that carry the details of the requested update. + @param NewUpdateToken The function writes an allocated EFI_BIS_DATA* + containing the new unique update token value. + The caller must eventually free the memory allocated by this function using the function Free(). - - @retval EFI_SUCCESS The function completed successfully. - @retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid - application instance handle associated with the EFI_BIS protocol. - @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_SECURITY_VIOLATION The signed manifest supplied as the RequestCredential parameter - was invalid (could not be parsed) or Platform-specific authorization failed, etc. + + @retval EFI_SUCCESS The function completed successfully. + @retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid + application instance handle associated with the EFI_BIS protocol. + @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + @retval EFI_SECURITY_VIOLATION The signed manifest supplied as the RequestCredential parameter + was invalid (could not be parsed) or Platform-specific authorization failed, etc. @retval EFI_DEVICE_ERROR An unexpected internal error occurred while analyzing the new certificate's key algorithm, or while attempting to retrieve the public key algorithm of the manifest's signer's certificate, - or An unexpected internal error occurred in a cryptographic software module. - -**/ + or An unexpected internal error occurred in a cryptographic software module. + +**/ typedef EFI_STATUS (EFIAPI *EFI_BIS_UPDATE_BOOT_OBJECT_AUTHORIZATION)( - IN BIS_APPLICATION_HANDLE AppHandle, - IN EFI_BIS_DATA *RequestCredential, - OUT EFI_BIS_DATA **NewUpdateToken + IN BIS_APPLICATION_HANDLE AppHandle, + IN EFI_BIS_DATA *RequestCredential, + OUT EFI_BIS_DATA **NewUpdateToken ); -/** +/** Verifies the integrity and authorization of the indicated data object according to the indicated - credentials and authority certificate. - + credentials and authority certificate. + @param AppHandle An opaque handle that identifies the caller's instance of initialization - of the BIS service. + of the BIS service. @param Credentials A Signed Manifest containing verification information for the - indicated data object. + indicated data object. @param DataObject An in-memory copy of the raw data object to be verified. - @param SectionName An ASCII string giving the section name in the + @param SectionName An ASCII string giving the section name in the manifest holding the verification information (in other words, - hash value) that corresponds to DataObject. - @param AuthorityCertificate A digital certificate whose public key must match the signer's - public key which is found in the credentials. + hash value) that corresponds to DataObject. + @param AuthorityCertificate A digital certificate whose public key must match the signer's + public key which is found in the credentials. @param IsVerified The function writes TRUE if the verification was successful. - Otherwise, the function writes FALSE. - - @retval EFI_SUCCESS The function completed successfully. - @retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid - application instance handle associated with the EFI_BIS protocol. - @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + Otherwise, the function writes FALSE. + + @retval EFI_SUCCESS The function completed successfully. + @retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid + application instance handle associated with the EFI_BIS protocol. + @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. @retval EFI_SECURITY_VIOLATION The Credentials.Data supplied by the caller is NULL, - or the AuthorityCertificate supplied by the caller was - invalid (could not be parsed), - or Platform-specific authorization failed, etc. + or the AuthorityCertificate supplied by the caller was + invalid (could not be parsed), + or Platform-specific authorization failed, etc. @retval EFI_DEVICE_ERROR An unexpected internal error occurred while attempting to retrieve the public key algorithm of the manifest's signer's certificate, - or An unexpected internal error occurred in a cryptographic software module. -**/ + or An unexpected internal error occurred in a cryptographic software module. +**/ typedef EFI_STATUS (EFIAPI *EFI_BIS_VERIFY_OBJECT_WITH_CREDENTIAL)( - IN BIS_APPLICATION_HANDLE AppHandle, - IN EFI_BIS_DATA *Credentials, - IN EFI_BIS_DATA *DataObject, - IN EFI_BIS_DATA *SectionName, - IN EFI_BIS_DATA *AuthorityCertificate, - OUT BOOLEAN *IsVerified + IN BIS_APPLICATION_HANDLE AppHandle, + IN EFI_BIS_DATA *Credentials, + IN EFI_BIS_DATA *DataObject, + IN EFI_BIS_DATA *SectionName, + IN EFI_BIS_DATA *AuthorityCertificate, + OUT BOOLEAN *IsVerified ); -/** +/** Retrieves a list of digital certificate identifier, digital signature algorithm, hash algorithm, and keylength - combinations that the platform supports. + combinations that the platform supports. @param AppHandle An opaque handle that identifies the caller's instance of initialization - of the BIS service. + of the BIS service. @param SignatureInfo The function writes an allocated EFI_BIS_DATA* containing the array - of EFI_BIS_SIGNATURE_INFO structures representing the supported + of EFI_BIS_SIGNATURE_INFO structures representing the supported digital certificate identifier, algorithm, and key length combinations. The caller must eventually free the memory allocated by this function using the function Free(). - @retval EFI_SUCCESS The function completed successfully. - @retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid - application instance handle associated with the EFI_BIS protocol. - @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. + @retval EFI_SUCCESS The function completed successfully. + @retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid + application instance handle associated with the EFI_BIS protocol. + @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. @retval EFI_INVALID_PARAMETER The SignatureInfo parameter supplied by the caller is NULL or an invalid memory reference. @retval EFI_DEVICE_ERROR An unexpected internal error occurred in a @@ -424,8 +424,8 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_BIS_GET_SIGNATURE_INFO)( - IN BIS_APPLICATION_HANDLE AppHandle, - OUT EFI_BIS_DATA **SignatureInfo + IN BIS_APPLICATION_HANDLE AppHandle, + OUT EFI_BIS_DATA **SignatureInfo ); /// diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BlockIo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BlockIo.h index 4bc2109db1..33c6991533 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BlockIo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BlockIo.h @@ -5,13 +5,13 @@ DVD-ROMs and floppy drives. Copyright (c) 2006 - 2011, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -27,12 +27,12 @@ typedef struct _EFI_BLOCK_IO_PROTOCOL EFI_BLOCK_IO_PROTOCOL; /// /// Protocol GUID name defined in EFI1.1. -/// +/// #define BLOCK_IO_PROTOCOL EFI_BLOCK_IO_PROTOCOL_GUID /// /// Protocol defined in EFI1.1. -/// +/// typedef EFI_BLOCK_IO_PROTOCOL EFI_BLOCK_IO; /** @@ -68,7 +68,7 @@ EFI_STATUS @retval EFI_NO_MEDIA There is no media in the device. @retval EFI_MEDIA_CHANGED The MediaId does not matched the current device. @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device. - @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid, + @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid, or the buffer is not on proper alignment. **/ @@ -98,7 +98,7 @@ EFI_STATUS @retval EFI_NO_MEDIA There is no media in the device. @retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device. @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device. - @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid, + @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid, or the buffer is not on proper alignment. **/ @@ -135,17 +135,17 @@ typedef struct { /// /// The curent media Id. If the media changes, this value is changed. /// - UINT32 MediaId; - + UINT32 MediaId; + /// /// TRUE if the media is removable; otherwise, FALSE. - /// + /// BOOLEAN RemovableMedia; - + /// /// TRUE if there is a media currently present in the device; /// othersise, FALSE. THis field shows the media present status - /// as of the most recent ReadBlocks() or WriteBlocks() call. + /// as of the most recent ReadBlocks() or WriteBlocks() call. /// BOOLEAN MediaPresent; @@ -154,45 +154,45 @@ typedef struct { /// FALSE. For media with only one partition this would be TRUE. /// BOOLEAN LogicalPartition; - + /// /// TRUE if the media is marked read-only otherwise, FALSE. /// This field shows the read-only status as of the most recent WriteBlocks () call. /// BOOLEAN ReadOnly; - + /// /// TRUE if the WriteBlock () function caches write data. /// - BOOLEAN WriteCaching; - + BOOLEAN WriteCaching; + /// /// The intrinsic block size of the device. If the media changes, then - /// this field is updated. + /// this field is updated. /// - UINT32 BlockSize; - + UINT32 BlockSize; + /// /// Supplies the alignment requirement for any buffer to read or write block(s). /// - UINT32 IoAlign; - + UINT32 IoAlign; + /// /// The last logical block address on the device. - /// If the media changes, then this field is updated. + /// If the media changes, then this field is updated. /// - EFI_LBA LastBlock; + EFI_LBA LastBlock; /// /// Only present if EFI_BLOCK_IO_PROTOCOL.Revision is greater than or equal to - /// EFI_BLOCK_IO_PROTOCOL_REVISION2. Returns the first LBA is aligned to - /// a physical block boundary. + /// EFI_BLOCK_IO_PROTOCOL_REVISION2. Returns the first LBA is aligned to + /// a physical block boundary. /// EFI_LBA LowestAlignedLba; /// /// Only present if EFI_BLOCK_IO_PROTOCOL.Revision is greater than or equal to - /// EFI_BLOCK_IO_PROTOCOL_REVISION2. Returns the number of logical blocks + /// EFI_BLOCK_IO_PROTOCOL_REVISION2. Returns the number of logical blocks /// per physical block. /// UINT32 LogicalBlocksPerPhysicalBlock; @@ -211,7 +211,7 @@ typedef struct { /// /// Revision defined in EFI1.1. -/// +/// #define EFI_BLOCK_IO_INTERFACE_REVISION EFI_BLOCK_IO_PROTOCOL_REVISION /// diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BlockIo2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BlockIo2.h index 0e4bb289cf..cc9db3d870 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BlockIo2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BlockIo2.h @@ -6,13 +6,13 @@ manner. Copyright (c) 2011, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -69,7 +69,7 @@ EFI_STATUS /** Read BufferSize bytes from Lba into Buffer. - + This function reads the requested number of blocks from the device. All the blocks are read, or an error is returned. If EFI_DEVICE_ERROR, EFI_NO_MEDIA,_or EFI_MEDIA_CHANGED is returned and @@ -77,13 +77,13 @@ EFI_STATUS not be signaled. @param[in] This Indicates a pointer to the calling context. - @param[in] MediaId Id of the media, changes every time the media is + @param[in] MediaId Id of the media, changes every time the media is replaced. @param[in] Lba The starting Logical Block Address to read from. @param[in, out] Token A pointer to the token associated with the transaction. - @param[in] BufferSize Size of Buffer, must be a multiple of device block size. - @param[out] Buffer A pointer to the destination buffer for the data. The - caller is responsible for either having implicit or + @param[in] BufferSize Size of Buffer, must be a multiple of device block size. + @param[out] Buffer A pointer to the destination buffer for the data. The + caller is responsible for either having implicit or explicit ownership of the buffer. @retval EFI_SUCCESS The read request was queued if Token->Event is @@ -95,7 +95,7 @@ EFI_STATUS @retval EFI_MEDIA_CHANGED The MediaId is not for the current media. @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of the intrinsic block size of the device. - @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid, + @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid, or the buffer is not on proper alignment. @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. @@ -136,7 +136,7 @@ EFI_STATUS @retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device. @retval EFI_DEVICE_ERROR The device reported an error while performing the write. @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device. - @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid, + @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid, or the buffer is not on proper alignment. @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. @@ -155,10 +155,10 @@ EFI_STATUS /** Flush the Block Device. - + If EFI_DEVICE_ERROR, EFI_NO_MEDIA,_EFI_WRITE_PROTECTED or EFI_MEDIA_CHANGED is returned and non-blocking I/O is being used, the Event associated with - this request will not be signaled. + this request will not be signaled. @param[in] This Indicates a pointer to the calling context. @param[in,out] Token A pointer to the token associated with the transaction @@ -189,9 +189,9 @@ EFI_STATUS /// struct _EFI_BLOCK_IO2_PROTOCOL { /// - /// A pointer to the EFI_BLOCK_IO_MEDIA data for this device. + /// A pointer to the EFI_BLOCK_IO_MEDIA data for this device. /// Type EFI_BLOCK_IO_MEDIA is defined in BlockIo.h. - /// + /// EFI_BLOCK_IO_MEDIA *Media; EFI_BLOCK_RESET_EX Reset; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BluetoothConfig.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BluetoothConfig.h index cd72d2f6bc..eb14aac791 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BluetoothConfig.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BluetoothConfig.h @@ -3,15 +3,15 @@ This protocol abstracts user interface configuration for Bluetooth device. Copyright (c) 2015 - 2017, 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 that accompanies this distribution. + This program and the accompanying materials are licensed and made available under + the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php. - - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + 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. - @par Revision Reference: + @par Revision Reference: This Protocol is introduced in UEFI Specification 2.7 **/ @@ -25,7 +25,7 @@ { \ 0x62960cf3, 0x40ff, 0x4263, { 0xa7, 0x7c, 0xdf, 0xde, 0xbd, 0x19, 0x1b, 0x4b } \ } - + typedef struct _EFI_BLUETOOTH_CONFIG_PROTOCOL EFI_BLUETOOTH_CONFIG_PROTOCOL; typedef UINT32 EFI_BLUETOOTH_CONFIG_REMOTE_DEVICE_STATE_TYPE; @@ -41,7 +41,7 @@ typedef struct { /// BLUETOOTH_ADDRESS BDAddr; /// - /// State of the remote deive + /// State of the remote deive /// UINT8 RemoteDeviceState; /// @@ -113,12 +113,12 @@ typedef enum { /// typedef enum { /// - /// For SSP - passkey entry. Input buffer is Passkey (4 bytes). No output buffer. + /// For SSP - passkey entry. Input buffer is Passkey (4 bytes). No output buffer. /// See Bluetooth HCI command for detail. /// EfiBluetoothCallbackTypeUserPasskeyNotification, /// - /// For SSP - just work and numeric comparison. Input buffer is numeric value (4 bytes). + /// For SSP - just work and numeric comparison. Input buffer is numeric value (4 bytes). /// Output buffer is BOOLEAN (1 byte). See Bluetooth HCI command for detail. /// EfiBluetoothCallbackTypeUserConfirmationRequest, @@ -127,7 +127,7 @@ typedef enum { /// EfiBluetoothCallbackTypeOOBDataRequest, /// - /// For legacy paring. No input buffer. Output buffer is PIN code( <= 16 bytes). + /// For legacy paring. No input buffer. Output buffer is PIN code( <= 16 bytes). /// See Bluetooth HCI command for detail. /// EfiBluetoothCallbackTypePinCodeRequest, @@ -139,44 +139,44 @@ typedef enum { /// typedef enum { /// - /// This callback is called when Bluetooth receive Disconnection_Complete event. Input buffer is Event + /// This callback is called when Bluetooth receive Disconnection_Complete event. Input buffer is Event /// Parameters of Disconnection_Complete Event defined in Bluetooth specification. /// EfiBluetoothConnCallbackTypeDisconnected, /// - /// This callback is called when Bluetooth receive Connection_Complete event. Input buffer is Event + /// This callback is called when Bluetooth receive Connection_Complete event. Input buffer is Event /// Parameters of Connection_Complete Event defined in Bluetooth specification. /// EfiBluetoothConnCallbackTypeConnected, /// - /// This callback is called when Bluetooth receive Authentication_Complete event. Input buffer is Event + /// This callback is called when Bluetooth receive Authentication_Complete event. Input buffer is Event /// Parameters of Authentication_Complete Event defined in Bluetooth specification. /// EfiBluetoothConnCallbackTypeAuthenticated, /// - /// This callback is called when Bluetooth receive Encryption_Change event. Input buffer is Event + /// This callback is called when Bluetooth receive Encryption_Change event. Input buffer is Event /// Parameters of Encryption_Change Event defined in Bluetooth specification. /// EfiBluetoothConnCallbackTypeEncrypted } EFI_BLUETOOTH_CONNECT_COMPLETE_CALLBACK_TYPE; - + /** Initialize Bluetooth host controller and local device. @param This Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance. @retval EFI_SUCCESS The Bluetooth host controller and local device is initialized successfully. - @retval EFI_DEVICE_ERROR A hardware error occurred trying to initialize the Bluetooth host controller + @retval EFI_DEVICE_ERROR A hardware error occurred trying to initialize the Bluetooth host controller and local device. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_INIT)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This ); - + /** Callback function, it is called if a Bluetooth device is found during scan process. @@ -194,16 +194,16 @@ EFI_STATUS IN VOID *Context, IN EFI_BLUETOOTH_SCAN_CALLBACK_INFORMATION *CallbackInfo ); - + /** Scan Bluetooth device. @param This Pointer to the EFI_BLUETOOTH_CONFIG_PROTOCOL instance. - @param ReScan If TRUE, a new scan request is submitted no matter there is scan result before. - If FALSE and there is scan result, the previous scan result is returned and no scan request + @param ReScan If TRUE, a new scan request is submitted no matter there is scan result before. + If FALSE and there is scan result, the previous scan result is returned and no scan request is submitted. @param ScanType Bluetooth scan type, Inquiry and/or Page. See Bluetooth specification for detail. - @param Callback The callback function. This function is called if a Bluetooth device is found during scan + @param Callback The callback function. This function is called if a Bluetooth device is found during scan process. @param Context Data passed into Callback function. This is optional parameter and may be NULL. @@ -211,7 +211,7 @@ EFI_STATUS @retval EFI_DEVICE_ERROR A hardware error occurred trying to scan the Bluetooth device. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_SCAN)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, @@ -220,7 +220,7 @@ EFI_STATUS IN EFI_BLUETOOTH_CONFIG_SCAN_CALLBACK_FUNCTION Callback, IN VOID *Context ); - + /** Connect a Bluetooth device. @@ -233,7 +233,7 @@ EFI_STATUS @retval EFI_DEVICE_ERROR A hardware error occurred trying to connect the Bluetooth device. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_CONNECT)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, @@ -253,14 +253,14 @@ EFI_STATUS @retval EFI_DEVICE_ERROR A hardware error occurred trying to disconnect the Bluetooth device. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_DISCONNECT)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, IN BLUETOOTH_ADDRESS *BD_ADDR, IN UINT8 Reason ); - + /** Get Bluetooth configuration data. @@ -280,7 +280,7 @@ EFI_STATUS *DataSize has been updated with the size needed to complete the request. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_GET_DATA)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, @@ -288,7 +288,7 @@ EFI_STATUS IN OUT UINTN *DataSize, IN OUT VOID *Data ); - + /** Set Bluetooth configuration data. @@ -305,7 +305,7 @@ EFI_STATUS @retval EFI_BUFFER_TOO_SMALL Cannot set configuration data. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_SET_DATA)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, @@ -313,7 +313,7 @@ EFI_STATUS IN UINTN DataSize, IN VOID *Data ); - + /** Get remove Bluetooth device configuration data. @@ -334,7 +334,7 @@ EFI_STATUS *DataSize has been updated with the size needed to complete the request. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_GET_REMOTE_DATA)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, @@ -343,7 +343,7 @@ EFI_STATUS IN OUT UINTN *DataSize, IN OUT VOID *Data ); - + /** The callback function for PIN code. @@ -352,14 +352,14 @@ EFI_STATUS @param CallbackType Callback type in EFI_BLUETOOTH_PIN_CALLBACK_TYPE. @param InputBuffer A pointer to the buffer of data that is input from callback caller. @param InputBufferSize Indicates the size, in bytes, of the data buffer specified by InputBuffer. - @param OutputBuffer A pointer to the buffer of data that will be output from callback callee. + @param OutputBuffer A pointer to the buffer of data that will be output from callback callee. Callee allocates this buffer by using EFI Boot Service AllocatePool(). @param OutputBufferSize Indicates the size, in bytes, of the data buffer specified by OutputBuffer. @retval EFI_SUCCESS The callback function complete successfully. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_PIN_CALLBACK_FUNCTION)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, @@ -370,7 +370,7 @@ EFI_STATUS OUT VOID **OutputBuffer, OUT UINTN *OutputBufferSize ); - + /** Register PIN callback function. @@ -381,7 +381,7 @@ EFI_STATUS @retval EFI_SUCCESS The PIN callback function is registered successfully. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_PIN_CALLBACK)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, @@ -400,7 +400,7 @@ EFI_STATUS @retval EFI_SUCCESS The callback function complete successfully. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_GET_LINK_KEY_CALLBACK_FUNCTION)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, @@ -408,7 +408,7 @@ EFI_STATUS IN BLUETOOTH_ADDRESS *BDAddr, OUT UINT8 LinkKey[BLUETOOTH_HCI_LINK_KEY_SIZE] ); - + /** Register get link key callback function. @@ -419,14 +419,14 @@ EFI_STATUS @retval EFI_SUCCESS The link key callback function is registered successfully. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_GET_LINK_KEY_CALLBACK)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, IN EFI_BLUETOOTH_CONFIG_REGISTER_GET_LINK_KEY_CALLBACK_FUNCTION Callback, IN VOID *Context ); - + /** The callback function to set link key. @@ -438,7 +438,7 @@ EFI_STATUS @retval EFI_SUCCESS The callback function complete successfully. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_SET_LINK_KEY_CALLBACK_FUNCTION)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, @@ -446,7 +446,7 @@ EFI_STATUS IN BLUETOOTH_ADDRESS *BDAddr, IN UINT8 LinkKey[BLUETOOTH_HCI_LINK_KEY_SIZE] ); - + /** Register set link key callback function. @@ -457,14 +457,14 @@ EFI_STATUS @retval EFI_SUCCESS The link key callback function is registered successfully. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_SET_LINK_KEY_CALLBACK)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, IN EFI_BLUETOOTH_CONFIG_REGISTER_SET_LINK_KEY_CALLBACK_FUNCTION Callback, IN VOID *Context ); - + /** The callback function. It is called after connect completed. @@ -478,7 +478,7 @@ EFI_STATUS @retval EFI_SUCCESS The callback function complete successfully. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_CONNECT_COMPLETE_CALLBACK_FUNCTION)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, @@ -488,7 +488,7 @@ EFI_STATUS IN VOID *InputBuffer, IN UINTN InputBufferSize ); - + /** Register link connect complete callback function. @@ -499,14 +499,14 @@ EFI_STATUS @retval EFI_SUCCESS The link connect complete callback function is registered successfully. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_BLUETOOTH_CONFIG_REGISTER_CONNECT_COMPLETE_CALLBACK)( IN EFI_BLUETOOTH_CONFIG_PROTOCOL *This, IN EFI_BLUETOOTH_CONFIG_REGISTER_CONNECT_COMPLETE_CALLBACK_FUNCTION Callback, IN VOID *Context ); - + /// /// This protocol abstracts user interface configuration for Bluetooth device. /// diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BluetoothHc.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BluetoothHc.h index 8311079609..ba0610646b 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BluetoothHc.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BluetoothHc.h @@ -23,7 +23,7 @@ { \ 0xb3930571, 0xbeba, 0x4fc5, { 0x92, 0x3, 0x94, 0x27, 0x24, 0x2e, 0x6a, 0x43 } \ } - + typedef struct _EFI_BLUETOOTH_HC_PROTOCOL EFI_BLUETOOTH_HC_PROTOCOL; /** diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BootManagerPolicy.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BootManagerPolicy.h index f348e3f101..4b94d518b7 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BootManagerPolicy.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BootManagerPolicy.h @@ -5,13 +5,13 @@ to connect devices using platform policy. Copyright (c) 2015, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ #ifndef __BOOT_MANAGER_POLICY_H__ @@ -53,7 +53,7 @@ typedef struct _EFI_BOOT_MANAGER_POLICY_PROTOCOL EFI_BOOT_MANAGER_POLICY_PROTOCO system will be connected using the platforms EFI Boot Manager policy. @param[in] Recursive If TRUE, then ConnectController() is called recursively - until the entire tree of controllers below the + until the entire tree of controllers below the controller specified by DevicePath have been created. If FALSE, then the tree of controllers is only expanded one level. If DevicePath is NULL then Recursive is ignored. @@ -61,7 +61,7 @@ typedef struct _EFI_BOOT_MANAGER_POLICY_PROTOCOL EFI_BOOT_MANAGER_POLICY_PROTOCO @retval EFI_SUCCESS The DevicePath was connected. @retval EFI_NOT_FOUND The DevicePath was not found. @retval EFI_NOT_FOUND No driver was connected to DevicePath. - @retval EFI_SECURITY_VIOLATION The user has no permission to start UEFI device + @retval EFI_SECURITY_VIOLATION The user has no permission to start UEFI device drivers on the DevicePath. @retval EFI_UNSUPPORTED The current TPL is not TPL_APPLICATION. **/ @@ -80,7 +80,7 @@ EFI_STATUS Manager connect a class of devices. If Class is EFI_BOOT_MANAGER_POLICY_CONSOLE_GUID then the Boot Manager will - use platform policy to connect consoles. Some platforms may restrict the + use platform policy to connect consoles. Some platforms may restrict the number of consoles connected as they attempt to fast boot, and calling ConnectDeviceClass() with a Class value of EFI_BOOT_MANAGER_POLICY_CONSOLE_GUID must connect the set of consoles that follow the Boot Manager platform policy, @@ -98,7 +98,7 @@ EFI_STATUS application that called ConnectDeviceClass() may need to use the published protocols to establish the network connection. The Boot Manager can optionally have a policy to establish a network connection. - + If Class is EFI_BOOT_MANAGER_POLICY_CONNECT_ALL_GUID then the Boot Manager will connect all UEFI drivers using the UEFI Boot Service EFI_BOOT_SERVICES.ConnectController(). If the Boot Manager has policy @@ -115,7 +115,7 @@ EFI_STATUS @retval EFI_DEVICE_ERROR Devices were not connected due to an error. @retval EFI_NOT_FOUND The Class is not supported by the platform. @retval EFI_UNSUPPORTED The current TPL is not TPL_APPLICATION. -**/ +**/ typedef EFI_STATUS (EFIAPI *EFI_BOOT_MANAGER_POLICY_CONNECT_DEVICE_CLASS)( diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BusSpecificDriverOverride.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BusSpecificDriverOverride.h index dcaeb9c535..492d5b00a7 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BusSpecificDriverOverride.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/BusSpecificDriverOverride.h @@ -7,13 +7,13 @@ more UEFI drivers. The protocol instance is attached to the handle of the PCI controller. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -34,14 +34,14 @@ typedef struct _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL EFI_BUS_SPECIFIC_DRIV // Prototypes for the Bus Specific Driver Override Protocol // -/** +/** Uses a bus specific algorithm to retrieve a driver image handle for a controller. - + @param This A pointer to the EFI_BUS_SPECIFIC_DRIVER_ - OVERRIDE_PROTOCOL instance. + OVERRIDE_PROTOCOL instance. @param DriverImageHandle On input, a pointer to the previous driver image handle returned - by GetDriver(). On output, a pointer to the next driver - image handle. Passing in a NULL, will return the first driver + by GetDriver(). On output, a pointer to the next driver + image handle. Passing in a NULL, will return the first driver image handle. @retval EFI_SUCCESS A bus specific override driver is returned in DriverImageHandle. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Capsule.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Capsule.h index e35035da6a..d390afa8ca 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Capsule.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Capsule.h @@ -1,13 +1,13 @@ /** @file Capsule Architectural Protocol as defined in PI1.0a Specification VOLUME 2 DXE - The DXE Driver that produces this protocol must be a runtime driver. - The driver is responsible for initializing the CapsuleUpdate() and - QueryCapsuleCapabilities() fields of the UEFI Runtime Services Table. - After the two fields of the UEFI Runtime Services Table have been initialized, - the driver must install the EFI_CAPSULE_ARCH_PROTOCOL_GUID on a new handle - with a NULL interface pointer. The installation of this protocol informs - the DXE Foundation that the Capsule related services are now available and + The DXE Driver that produces this protocol must be a runtime driver. + The driver is responsible for initializing the CapsuleUpdate() and + QueryCapsuleCapabilities() fields of the UEFI Runtime Services Table. + After the two fields of the UEFI Runtime Services Table have been initialized, + the driver must install the EFI_CAPSULE_ARCH_PROTOCOL_GUID on a new handle + with a NULL interface pointer. The installation of this protocol informs + the DXE Foundation that the Capsule related services are now available and that the DXE Foundation must update the 32-bit CRC of the UEFI Runtime Services Table. Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR> diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ComponentName.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ComponentName.h index cdd87fce31..d61c20b1d0 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ComponentName.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ComponentName.h @@ -1,15 +1,15 @@ /** @file EFI Component Name Protocol as defined in the EFI 1.1 specification. - This protocol is used to retrieve user readable names of EFI Drivers + This protocol is used to retrieve user readable names of EFI Drivers and controllers managed by EFI Drivers. Copyright (c) 2006 - 2011, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +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. **/ @@ -110,7 +110,7 @@ EFI_STATUS ); /// -/// This protocol is used to retrieve user readable names of drivers +/// This protocol is used to retrieve user readable names of drivers /// and controllers managed by UEFI Drivers. /// struct _EFI_COMPONENT_NAME_PROTOCOL { @@ -119,7 +119,7 @@ struct _EFI_COMPONENT_NAME_PROTOCOL { /// /// A Null-terminated ASCII string that contains one or more /// ISO 639-2 language codes. This is the list of language codes - /// that this protocol supports. + /// that this protocol supports. /// CHAR8 *SupportedLanguages; }; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ComponentName2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ComponentName2.h index d005b02b87..e20ff6c33d 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ComponentName2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ComponentName2.h @@ -1,16 +1,16 @@ /** @file UEFI Component Name 2 Protocol as defined in the UEFI 2.1 specification. - This protocol is used to retrieve user readable names of drivers + This protocol is used to retrieve user readable names of drivers and controllers managed by UEFI Drivers. Copyright (c) 2006 - 2011, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -32,7 +32,7 @@ typedef struct _EFI_COMPONENT_NAME2_PROTOCOL EFI_COMPONENT_NAME2_PROTOCOL; @param This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL instance. - + @param Language A pointer to a Null-terminated ASCII string array indicating the language. This is the language of the driver name that the caller @@ -42,7 +42,7 @@ typedef struct _EFI_COMPONENT_NAME2_PROTOCOL EFI_COMPONENT_NAME2_PROTOCOL; driver is up to the driver writer. Language is specified in RFC 4646 language code format. - + @param DriverName A pointer to the string to return. This string is the name of the driver specified by This in the language @@ -52,11 +52,11 @@ typedef struct _EFI_COMPONENT_NAME2_PROTOCOL EFI_COMPONENT_NAME2_PROTOCOL; Driver specified by This and the language specified by Language was returned in DriverName. - + @retval EFI_INVALID_PARAMETER Language is NULL. - + @retval EFI_INVALID_PARAMETER DriverName is NULL. - + @retval EFI_UNSUPPORTED The driver specified by This does not support the language specified by Language. @@ -150,7 +150,7 @@ EFI_STATUS ); /// -/// This protocol is used to retrieve user readable names of drivers +/// This protocol is used to retrieve user readable names of drivers /// and controllers managed by UEFI Drivers. /// struct _EFI_COMPONENT_NAME2_PROTOCOL { @@ -162,7 +162,7 @@ struct _EFI_COMPONENT_NAME2_PROTOCOL { /// supported language codes. This is the list of language codes that /// this protocol supports. The number of languages supported by a /// driver is up to the driver writer. SupportedLanguages is - /// specified in RFC 4646 format. + /// specified in RFC 4646 format. /// CHAR8 *SupportedLanguages; }; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Cpu.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Cpu.h index cfb2e75701..b347e33d68 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Cpu.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Cpu.h @@ -4,13 +4,13 @@ This code abstracts the DXE core from processor implementation details. Copyright (c) 2006 - 2016, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -61,14 +61,14 @@ VOID ); /** - This function flushes the range of addresses from Start to Start+Length - from the processor's data cache. If Start is not aligned to a cache line - boundary, then the bytes before Start to the preceding cache line boundary - are also flushed. If Start+Length is not aligned to a cache line boundary, - then the bytes past Start+Length to the end of the next cache line boundary - are also flushed. The FlushType of EfiCpuFlushTypeWriteBackInvalidate must be - supported. If the data cache is fully coherent with all DMA operations, then - this function can just return EFI_SUCCESS. If the processor does not support + This function flushes the range of addresses from Start to Start+Length + from the processor's data cache. If Start is not aligned to a cache line + boundary, then the bytes before Start to the preceding cache line boundary + are also flushed. If Start+Length is not aligned to a cache line boundary, + then the bytes past Start+Length to the end of the next cache line boundary + are also flushed. The FlushType of EfiCpuFlushTypeWriteBackInvalidate must be + supported. If the data cache is fully coherent with all DMA operations, then + this function can just return EFI_SUCCESS. If the processor does not support flushing a range of the data cache, then the entire data cache can be flushed. @param This The EFI_CPU_ARCH_PROTOCOL instance. @@ -98,7 +98,7 @@ EFI_STATUS /** - This function enables interrupt processing by the processor. + This function enables interrupt processing by the processor. @param This The EFI_CPU_ARCH_PROTOCOL instance. @@ -130,8 +130,8 @@ EFI_STATUS /** - This function retrieves the processor's current interrupt state a returns it in - State. If interrupts are currently enabled, then TRUE is returned. If interrupts + This function retrieves the processor's current interrupt state a returns it in + State. If interrupts are currently enabled, then TRUE is returned. If interrupts are currently disabled, then FALSE is returned. @param This The EFI_CPU_ARCH_PROTOCOL instance. @@ -152,9 +152,9 @@ EFI_STATUS /** This function generates an INIT on the processor. If this function succeeds, then the - processor will be reset, and control will not be returned to the caller. If InitType is - not supported by this processor, or the processor cannot programmatically generate an - INIT without help from external hardware, then EFI_UNSUPPORTED is returned. If an error + processor will be reset, and control will not be returned to the caller. If InitType is + not supported by this processor, or the processor cannot programmatically generate an + INIT without help from external hardware, then EFI_UNSUPPORTED is returned. If an error occurs attempting to generate an INIT, then EFI_DEVICE_ERROR is returned. @param This The EFI_CPU_ARCH_PROTOCOL instance. @@ -175,9 +175,9 @@ EFI_STATUS /** - This function registers and enables the handler specified by InterruptHandler for a processor - interrupt or exception type specified by InterruptType. If InterruptHandler is NULL, then the - handler for the processor interrupt or exception type specified by InterruptType is uninstalled. + This function registers and enables the handler specified by InterruptHandler for a processor + interrupt or exception type specified by InterruptType. If InterruptHandler is NULL, then the + handler for the processor interrupt or exception type specified by InterruptType is uninstalled. The installed handler is called once for each processor interrupt or exception. @param This The EFI_CPU_ARCH_PROTOCOL instance. @@ -280,17 +280,17 @@ struct _EFI_CPU_ARCH_PROTOCOL { EFI_CPU_GET_TIMER_VALUE GetTimerValue; EFI_CPU_SET_MEMORY_ATTRIBUTES SetMemoryAttributes; /// - /// The number of timers that are available in a processor. The value in this - /// field is a constant that must not be modified after the CPU Architectural + /// The number of timers that are available in a processor. The value in this + /// field is a constant that must not be modified after the CPU Architectural /// Protocol is installed. All consumers must treat this as a read-only field. /// UINT32 NumberOfTimers; /// - /// The size, in bytes, of the alignment required for DMA buffer allocations. - /// This is typically the size of the largest data cache line in the platform. - /// The value in this field is a constant that must not be modified after the - /// CPU Architectural Protocol is installed. All consumers must treat this as - /// a read-only field. + /// The size, in bytes, of the alignment required for DMA buffer allocations. + /// This is typically the size of the largest data cache line in the platform. + /// The value in this field is a constant that must not be modified after the + /// CPU Architectural Protocol is installed. All consumers must treat this as + /// a read-only field. /// UINT32 DmaBufferAlignment; }; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/CpuIo2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/CpuIo2.h index 49fb470713..e6fd0f2309 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/CpuIo2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/CpuIo2.h @@ -1,13 +1,13 @@ /** @file This files describes the CPU I/O 2 Protocol. - + This protocol provides an I/O abstraction for a system processor. This protocol is used by a PCI root bridge I/O driver to perform memory-mapped I/O and I/O transactions. The I/O or memory primitives can be used by the consumer of the protocol to materialize bus-specific configuration cycles, such as the transitional configuration address and data - ports for PCI. Only drivers that require direct access to the entire system should use this - protocol. - + ports for PCI. Only drivers that require direct access to the entire system should use this + protocol. + Note: This is a boot-services only protocol and it may not be used by runtime drivers after ExitBootServices(). It is different from the Framework CPU I/O Protocol, which is a runtime protocol and can be used by runtime drivers after ExitBootServices(). @@ -22,7 +22,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: - This Protocol is defined in UEFI Platform Initialization Specification 1.2 + This Protocol is defined in UEFI Platform Initialization Specification 1.2 Volume 5: Standards **/ @@ -57,35 +57,35 @@ typedef enum { } EFI_CPU_IO_PROTOCOL_WIDTH; /** - Enables a driver to access registers in the PI CPU I/O space. + Enables a driver to access registers in the PI CPU I/O space. - The Io.Read() and Io.Write() functions enable a driver to access PCI controller - registers in the PI CPU I/O space. + The Io.Read() and Io.Write() functions enable a driver to access PCI controller + registers in the PI CPU I/O space. - The I/O operations are carried out exactly as requested. The caller is responsible - for satisfying any alignment and I/O width restrictions that a PI System on a - platform might require. For example on some platforms, width requests of - EfiCpuIoWidthUint64 do not work. Misaligned buffers, on the other hand, will + The I/O operations are carried out exactly as requested. The caller is responsible + for satisfying any alignment and I/O width restrictions that a PI System on a + platform might require. For example on some platforms, width requests of + EfiCpuIoWidthUint64 do not work. Misaligned buffers, on the other hand, will be handled by the driver. - - If Width is EfiCpuIoWidthUint8, EfiCpuIoWidthUint16, EfiCpuIoWidthUint32, - or EfiCpuIoWidthUint64, then both Address and Buffer are incremented for + + If Width is EfiCpuIoWidthUint8, EfiCpuIoWidthUint16, EfiCpuIoWidthUint32, + or EfiCpuIoWidthUint64, then both Address and Buffer are incremented for each of the Count operations that is performed. - - If Width is EfiCpuIoWidthFifoUint8, EfiCpuIoWidthFifoUint16, - EfiCpuIoWidthFifoUint32, or EfiCpuIoWidthFifoUint64, then only Buffer is - incremented for each of the Count operations that is performed. The read or + + If Width is EfiCpuIoWidthFifoUint8, EfiCpuIoWidthFifoUint16, + EfiCpuIoWidthFifoUint32, or EfiCpuIoWidthFifoUint64, then only Buffer is + incremented for each of the Count operations that is performed. The read or write operation is performed Count times on the same Address. - - If Width is EfiCpuIoWidthFillUint8, EfiCpuIoWidthFillUint16, - EfiCpuIoWidthFillUint32, or EfiCpuIoWidthFillUint64, then only Address is - incremented for each of the Count operations that is performed. The read or + + If Width is EfiCpuIoWidthFillUint8, EfiCpuIoWidthFillUint16, + EfiCpuIoWidthFillUint32, or EfiCpuIoWidthFillUint64, then only Address is + incremented for each of the Count operations that is performed. The read or write operation is performed Count times from the first element of Buffer. @param[in] This A pointer to the EFI_CPU_IO2_PROTOCOL instance. @param[in] Width Signifies the width of the I/O or Memory operation. - @param[in] Address The base address of the I/O operation. - @param[in] Count The number of I/O operations to perform. The number + @param[in] Address The base address of the I/O operation. + @param[in] Count The number of I/O operations to perform. The number of bytes moved is Width size * Count, starting at Address. @param[in, out] Buffer For read operations, the destination buffer to store the results. For write operations, the source buffer from which to write data. @@ -94,7 +94,7 @@ typedef enum { @retval EFI_INVALID_PARAMETER Width is invalid for this PI system. @retval EFI_INVALID_PARAMETER Buffer is NULL. @retval EFI_UNSUPPORTED The Buffer is not aligned for the given Width. - @retval EFI_UNSUPPORTED The address range specified by Address, Width, + @retval EFI_UNSUPPORTED The address range specified by Address, Width, and Count is not valid for this PI system. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DebugPort.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DebugPort.h index ba14591107..732ea60b55 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DebugPort.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DebugPort.h @@ -1,17 +1,17 @@ /** @file - + The file defines the EFI Debugport protocol. This protocol is used by debug agent to communicate with the remote debug host. - + Copyright (c) 2006 - 2013, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -35,14 +35,14 @@ typedef struct _EFI_DEBUGPORT_PROTOCOL EFI_DEBUGPORT_PROTOCOL; // DebugPort member functions // -/** +/** Resets the debugport. - + @param This A pointer to the EFI_DEBUGPORT_PROTOCOL instance. - + @retval EFI_SUCCESS The debugport device was reset and is in usable state. @retval EFI_DEVICE_ERROR The debugport device could not be reset and is unusable. - + **/ typedef EFI_STATUS @@ -50,19 +50,19 @@ EFI_STATUS IN EFI_DEBUGPORT_PROTOCOL *This ); -/** +/** Writes data to the debugport. - + @param This A pointer to the EFI_DEBUGPORT_PROTOCOL instance. @param Timeout The number of microseconds to wait before timing out a write operation. @param BufferSize On input, the requested number of bytes of data to write. On output, the number of bytes of data actually written. - @param Buffer A pointer to a buffer containing the data to write. - + @param Buffer A pointer to a buffer containing the data to write. + @retval EFI_SUCCESS The data was written. @retval EFI_DEVICE_ERROR The device reported an error. @retval EFI_TIMEOUT The data write was stopped due to a timeout. - + **/ typedef EFI_STATUS @@ -73,20 +73,20 @@ EFI_STATUS IN VOID *Buffer ); -/** +/** Reads data from the debugport. - + @param This A pointer to the EFI_DEBUGPORT_PROTOCOL instance. @param Timeout The number of microseconds to wait before timing out a read operation. @param BufferSize On input, the requested number of bytes of data to read. On output, the number of bytes of data actually number of bytes of data read and returned in Buffer. @param Buffer A pointer to a buffer into which the data read will be saved. - + @retval EFI_SUCCESS The data was read. @retval EFI_DEVICE_ERROR The device reported an error. @retval EFI_TIMEOUT The operation was stopped due to a timeout or overrun. - + **/ typedef EFI_STATUS @@ -97,15 +97,15 @@ EFI_STATUS OUT VOID *Buffer ); -/** +/** Checks to see if any data is available to be read from the debugport device. - + @param This A pointer to the EFI_DEBUGPORT_PROTOCOL instance. - + @retval EFI_SUCCESS At least one byte of data is available to be read. @retval EFI_DEVICE_ERROR The debugport device is not functioning correctly. @retval EFI_NOT_READY No data is available to be read. - + **/ typedef EFI_STATUS diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DebugSupport.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DebugSupport.h index 80f87061bd..69834690e6 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DebugSupport.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DebugSupport.h @@ -8,13 +8,13 @@ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR> Portions copyright (c) 2011 - 2013, ARM Ltd. All rights reserved.<BR> -This program and the accompanying materials are licensed and made available under -the terms and conditions of the BSD License that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -183,7 +183,7 @@ typedef struct { UINT8 Xmm6[16]; UINT8 Xmm7[16]; // - // NOTE: UEFI 2.0 spec definition as follows. + // NOTE: UEFI 2.0 spec definition as follows. // UINT8 Reserved11[14 * 16]; } EFI_FX_SAVE_STATE_X64; @@ -626,12 +626,12 @@ typedef union { // DebugSupport callback function prototypes // -/** +/** Registers and enables an exception callback function for the specified exception. - + @param ExceptionType Exception types in EBC, IA-32, x64, or IPF. @param SystemContext Exception content. - + **/ typedef VOID @@ -640,11 +640,11 @@ VOID IN OUT EFI_SYSTEM_CONTEXT SystemContext ); -/** +/** Registers and enables the on-target debug agent's periodic entry point. - + @param SystemContext Exception content. - + **/ typedef VOID @@ -669,16 +669,16 @@ typedef enum { // DebugSupport member function definitions // -/** +/** Returns the maximum value that may be used for the ProcessorIndex parameter in - RegisterPeriodicCallback() and RegisterExceptionCallback(). - + RegisterPeriodicCallback() and RegisterExceptionCallback(). + @param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance. @param MaxProcessorIndex Pointer to a caller-allocated UINTN in which the maximum supported - processor index is returned. - - @retval EFI_SUCCESS The function completed successfully. - + processor index is returned. + + @retval EFI_SUCCESS The function completed successfully. + **/ typedef EFI_STATUS @@ -687,20 +687,20 @@ EFI_STATUS OUT UINTN *MaxProcessorIndex ); -/** +/** Registers a function to be called back periodically in interrupt context. - + @param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance. @param ProcessorIndex Specifies which processor the callback function applies to. @param PeriodicCallback A pointer to a function of type PERIODIC_CALLBACK that is the main periodic entry point of the debug agent. - - @retval EFI_SUCCESS The function completed successfully. + + @retval EFI_SUCCESS The function completed successfully. @retval EFI_ALREADY_STARTED Non-NULL PeriodicCallback parameter when a callback - function was previously registered. - @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback - function. - + function was previously registered. + @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback + function. + **/ typedef EFI_STATUS @@ -710,21 +710,21 @@ EFI_STATUS IN EFI_PERIODIC_CALLBACK PeriodicCallback ); -/** +/** Registers a function to be called when a given processor exception occurs. - + @param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance. @param ProcessorIndex Specifies which processor the callback function applies to. @param ExceptionCallback A pointer to a function of type EXCEPTION_CALLBACK that is called - when the processor exception specified by ExceptionType occurs. - @param ExceptionType Specifies which processor exception to hook. - - @retval EFI_SUCCESS The function completed successfully. + when the processor exception specified by ExceptionType occurs. + @param ExceptionType Specifies which processor exception to hook. + + @retval EFI_SUCCESS The function completed successfully. @retval EFI_ALREADY_STARTED Non-NULL PeriodicCallback parameter when a callback - function was previously registered. - @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback - function. - + function was previously registered. + @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback + function. + **/ typedef EFI_STATUS @@ -735,18 +735,18 @@ EFI_STATUS IN EFI_EXCEPTION_TYPE ExceptionType ); -/** +/** Invalidates processor instruction cache for a memory range. Subsequent execution in this range - causes a fresh memory fetch to retrieve code to be executed. - + causes a fresh memory fetch to retrieve code to be executed. + @param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance. @param ProcessorIndex Specifies which processor's instruction cache is to be invalidated. - @param Start Specifies the physical base of the memory range to be invalidated. + @param Start Specifies the physical base of the memory range to be invalidated. @param Length Specifies the minimum number of bytes in the processor's instruction - cache to invalidate. - - @retval EFI_SUCCESS The function completed successfully. - + cache to invalidate. + + @retval EFI_SUCCESS The function completed successfully. + **/ typedef EFI_STATUS @@ -758,8 +758,8 @@ EFI_STATUS ); /// -/// This protocol provides the services to allow the debug agent to register -/// callback functions that are called either periodically or when specific +/// This protocol provides the services to allow the debug agent to register +/// callback functions that are called either periodically or when specific /// processor exceptions occur. /// struct _EFI_DEBUG_SUPPORT_PROTOCOL { @@ -775,4 +775,4 @@ struct _EFI_DEBUG_SUPPORT_PROTOCOL { extern EFI_GUID gEfiDebugSupportProtocolGuid; -#endif +#endif diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Decompress.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Decompress.h index 965b7d2f45..acc6e816a2 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Decompress.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Decompress.h @@ -2,13 +2,13 @@ The Decompress Protocol Interface as defined in UEFI spec Copyright (c) 2006 - 2014, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -23,16 +23,16 @@ typedef struct _EFI_DECOMPRESS_PROTOCOL EFI_DECOMPRESS_PROTOCOL; /** - The GetInfo() function retrieves the size of the uncompressed buffer - and the temporary scratch buffer required to decompress the buffer + The GetInfo() function retrieves the size of the uncompressed buffer + and the temporary scratch buffer required to decompress the buffer specified by Source and SourceSize. If the size of the uncompressed - buffer or the size of the scratch buffer cannot be determined from - the compressed data specified by Source and SourceData, then + buffer or the size of the scratch buffer cannot be determined from + the compressed data specified by Source and SourceData, then EFI_INVALID_PARAMETER is returned. Otherwise, the size of the uncompressed - buffer is returned in DestinationSize, the size of the scratch buffer is + buffer is returned in DestinationSize, the size of the scratch buffer is returned in ScratchSize, and EFI_SUCCESS is returned. - The GetInfo() function does not have a scratch buffer available to perform + The GetInfo() function does not have a scratch buffer available to perform a thorough checking of the validity of the source data. It just retrieves the 'Original Size' field from the beginning bytes of the source data and output it as DestinationSize. And ScratchSize is specific to the decompression @@ -68,15 +68,15 @@ EFI_STATUS /** The Decompress() function extracts decompressed data to its original form. - This protocol is designed so that the decompression algorithm can be - implemented without using any memory services. As a result, the - Decompress() function is not allowed to call AllocatePool() or - AllocatePages() in its implementation. It is the caller's responsibility + This protocol is designed so that the decompression algorithm can be + implemented without using any memory services. As a result, the + Decompress() function is not allowed to call AllocatePool() or + AllocatePages() in its implementation. It is the caller's responsibility to allocate and free the Destination and Scratch buffers. - If the compressed source data specified by Source and SourceSize is - successfully decompressed into Destination, then EFI_SUCCESS is returned. - If the compressed source data specified by Source and SourceSize is not in + If the compressed source data specified by Source and SourceSize is + successfully decompressed into Destination, then EFI_SUCCESS is returned. + If the compressed source data specified by Source and SourceSize is not in a valid compressed data format, then EFI_INVALID_PARAMETER is returned. @param This A pointer to the EFI_DECOMPRESS_PROTOCOL instance. @@ -87,7 +87,7 @@ EFI_STATUS @param DestinationSize The size of destination buffer. The size of destination buffer needed is obtained from GetInfo(). @param Scratch A temporary scratch buffer that is used to perform the - decompression. + decompression. @param ScratchSize The size of scratch buffer. The size of scratch buffer needed is obtained from GetInfo(). diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DeferredImageLoad.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DeferredImageLoad.h index 4d1bbf0ed4..851c13542b 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DeferredImageLoad.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DeferredImageLoad.h @@ -1,19 +1,19 @@ /** @file UEFI 2.2 Deferred Image Load Protocol definition. - This protocol returns information about images whose load was denied because of security - considerations. This information can be used by the Boot Manager or another agent to reevaluate the - images when the current security profile has been changed, such as when the current user profile + This protocol returns information about images whose load was denied because of security + considerations. This information can be used by the Boot Manager or another agent to reevaluate the + images when the current security profile has been changed, such as when the current user profile changes. There can be more than one instance of this protocol installed. Copyright (c) 2009, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -33,28 +33,28 @@ typedef struct _EFI_DEFERRED_IMAGE_LOAD_PROTOCOL EFI_DEFERRED_IMAGE_LOAD_PROTOC /** Returns information about a deferred image. - This function returns information about a single deferred image. The deferred images are numbered - consecutively, starting with 0. If there is no image which corresponds to ImageIndex, then - EFI_NOT_FOUND is returned. All deferred images may be returned by iteratively calling this + This function returns information about a single deferred image. The deferred images are numbered + consecutively, starting with 0. If there is no image which corresponds to ImageIndex, then + EFI_NOT_FOUND is returned. All deferred images may be returned by iteratively calling this function until EFI_NOT_FOUND is returned. - Image may be NULL and ImageSize set to 0 if the decision to defer execution was made because + Image may be NULL and ImageSize set to 0 if the decision to defer execution was made because of the location of the executable image rather than its actual contents. record handle until - there are no more, at which point UserInfo will point to NULL. + there are no more, at which point UserInfo will point to NULL. @param[in] This Points to this instance of the EFI_DEFERRED_IMAGE_LOAD_PROTOCOL. @param[in] ImageIndex Zero-based index of the deferred index. - @param[out] ImageDevicePath On return, points to a pointer to the device path of the image. - The device path should not be freed by the caller. - @param[out] Image On return, points to the first byte of the image or NULL if the - image is not available. The image should not be freed by the caller - unless LoadImage() has been called successfully. + @param[out] ImageDevicePath On return, points to a pointer to the device path of the image. + The device path should not be freed by the caller. + @param[out] Image On return, points to the first byte of the image or NULL if the + image is not available. The image should not be freed by the caller + unless LoadImage() has been called successfully. @param[out] ImageSize On return, the size of the image, or 0 if the image is not available. - @param[out] BootOption On return, points to TRUE if the image was intended as a boot option - or FALSE if it was not intended as a boot option. - + @param[out] BootOption On return, points to TRUE if the image was intended as a boot option + or FALSE if it was not intended as a boot option. + @retval EFI_SUCCESS Image information returned successfully. @retval EFI_NOT_FOUND ImageIndex does not refer to a valid image. - @retval EFI_INVALID_PARAMETER ImageDevicePath is NULL or Image is NULL or ImageSize is NULL or + @retval EFI_INVALID_PARAMETER ImageDevicePath is NULL or Image is NULL or ImageSize is NULL or BootOption is NULL. **/ typedef diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DeviceIo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DeviceIo.h index d84a6202ef..900ec4075e 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DeviceIo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DeviceIo.h @@ -5,13 +5,13 @@ memory mapped IO, IO, PCI Config space, and DMA. Copyright (c) 2006 - 2009, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -27,16 +27,16 @@ typedef struct _EFI_DEVICE_IO_PROTOCOL EFI_DEVICE_IO_PROTOCOL; /// /// Protocol GUID name defined in EFI1.1. -/// +/// #define DEVICE_IO_PROTOCOL EFI_DEVICE_IO_PROTOCOL_GUID /// /// Protocol defined in EFI1.1. -/// +/// typedef EFI_DEVICE_IO_PROTOCOL EFI_DEVICE_IO_INTERFACE; /// -/// Device IO Access Width +/// Device IO Access Width /// typedef enum { IO_UINT8 = 0, @@ -44,7 +44,7 @@ typedef enum { IO_UINT32 = 2, IO_UINT64 = 3, // - // Below enumerations are added in "Extensible Firmware Interface Specification, + // Below enumerations are added in "Extensible Firmware Interface Specification, // Version 1.10, Specification Update, Version 001". // MMIO_COPY_UINT8 = 4, @@ -53,23 +53,23 @@ typedef enum { MMIO_COPY_UINT64 = 7 } EFI_IO_WIDTH; -/** +/** Enables a driver to access device registers in the appropriate memory or I/O space. - + @param This A pointer to the EFI_DEVICE_IO_INTERFACE instance. - @param Width Signifies the width of the I/O operations. - @param Address The base address of the I/O operations. + @param Width Signifies the width of the I/O operations. + @param Address The base address of the I/O operations. @param Count The number of I/O operations to perform. @param Buffer For read operations, the destination buffer to store the results. For write operations, the source buffer to write data from. If Width is MMIO_COPY_UINT8, MMIO_COPY_UINT16, MMIO_COPY_UINT32, or MMIO_COPY_UINT64, then - Buffer is interpreted as a base address of an I/O operation such as Address. + Buffer is interpreted as a base address of an I/O operation such as Address. @retval EFI_SUCCESS The data was read from or written to the device. - @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. + @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. @retval EFI_INVALID_PARAMETER Width is invalid. - + **/ typedef EFI_STATUS @@ -86,19 +86,19 @@ typedef struct { EFI_DEVICE_IO Write; } EFI_IO_ACCESS; -/** +/** Provides an EFI Device Path for a PCI device with the given PCI configuration space address. - + @param This A pointer to the EFI_DEVICE_IO_INTERFACE instance. @param PciAddress The PCI configuration space address of the device whose Device Path - is going to be returned. + is going to be returned. @param PciDevicePath A pointer to the pointer for the EFI Device Path for PciAddress. - Memory for the Device Path is allocated from the pool. + Memory for the Device Path is allocated from the pool. @retval EFI_SUCCESS The PciDevicePath returns a pointer to a valid EFI Device Path. - @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. + @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. @retval EFI_UNSUPPORTED The PciAddress does not map to a valid EFI Device Path. - + **/ typedef EFI_STATUS @@ -118,7 +118,7 @@ typedef enum { /// A write operation to system memory by a bus master. /// EfiBusMasterWrite, - + /// /// Provides both read and write access to system memory /// by both the processor and a bus master. The buffer is @@ -128,9 +128,9 @@ typedef enum { EfiBusMasterCommonBuffer } EFI_IO_OPERATION_TYPE; -/** +/** Provides the device-specific addresses needed to access system memory. - + @param This A pointer to the EFI_DEVICE_IO_INTERFACE instance. @param Operation Indicates if the bus master is going to read or write to system memory. @param HostAddress The system memory address to map to the device. @@ -141,11 +141,11 @@ typedef enum { @param Mapping A resulting value to pass to Unmap(). @retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes. - @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. + @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. @retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer. @retval EFI_INVALID_PARAMETER The Operation or HostAddress is undefined. @retval EFI_DEVICE_ERROR The system hardware could not map the requested address. - + **/ typedef EFI_STATUS @@ -158,15 +158,15 @@ EFI_STATUS OUT VOID **Mapping ); -/** +/** Completes the Map() operation and releases any corresponding resources. - + @param This A pointer to the EFI_DEVICE_IO_INTERFACE instance. @param Mapping A resulting value to pass to Unmap(). @retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes. @retval EFI_DEVICE_ERROR The system hardware could not map the requested address. - + **/ typedef EFI_STATUS @@ -175,22 +175,22 @@ EFI_STATUS IN VOID *Mapping ); -/** +/** Allocates pages that are suitable for an EFIBusMasterCommonBuffer mapping. - + @param This A pointer to the EFI_DEVICE_IO_INTERFACE instance. @param Type The type allocation to perform. @param MemoryType The type of memory to allocate, EfiBootServicesData or EfiRuntimeServicesData. @param Pages The number of pages to allocate. - @param HostAddress A pointer to store the base address of the allocated range. + @param HostAddress A pointer to store the base address of the allocated range. @retval EFI_SUCCESS The requested memory pages were allocated. @retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated. @retval EFI_INVALID_PARAMETER The requested memory type is invalid. @retval EFI_UNSUPPORTED The requested HostAddress is not supported on - this platform. - + this platform. + **/ typedef EFI_STATUS @@ -202,14 +202,14 @@ EFI_STATUS IN OUT EFI_PHYSICAL_ADDRESS *HostAddress ); -/** +/** Flushes any posted write data to the device. - + @param This A pointer to the EFI_DEVICE_IO_INTERFACE instance. @retval EFI_SUCCESS The buffers were flushed. - @retval EFI_DEVICE_ERROR The buffers were not flushed due to a hardware error. - + @retval EFI_DEVICE_ERROR The buffers were not flushed due to a hardware error. + **/ typedef EFI_STATUS @@ -217,18 +217,18 @@ EFI_STATUS IN EFI_DEVICE_IO_PROTOCOL *This ); -/** +/** Frees pages that were allocated with AllocateBuffer(). - - @param This A pointer to the EFI_DEVICE_IO_INTERFACE instance. + + @param This A pointer to the EFI_DEVICE_IO_INTERFACE instance. @param Pages The number of pages to free. @param HostAddress The base address of the range to free. @retval EFI_SUCCESS The requested memory pages were allocated. @retval EFI_NOT_FOUND The requested memory pages were not allocated with - AllocateBuffer(). + AllocateBuffer(). @retval EFI_INVALID_PARAMETER HostAddress is not page aligned or Pages is invalid. - + **/ typedef EFI_STATUS @@ -239,7 +239,7 @@ EFI_STATUS ); /// -/// This protocol provides the basic Memory, I/O, and PCI interfaces that +/// This protocol provides the basic Memory, I/O, and PCI interfaces that /// are used to abstract accesses to devices. /// struct _EFI_DEVICE_IO_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DevicePath.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DevicePath.h index 81d47c0627..38fbdc8d02 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DevicePath.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DevicePath.h @@ -2,17 +2,17 @@ The device path protocol as defined in UEFI 2.0. The device path represents a programmatic path to a device, - from a software point of view. The path must persist from boot to boot, so + from a software point of view. The path must persist from boot to boot, so it can not contain things like PCI bus numbers that change from boot to boot. Copyright (c) 2006 - 2017, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -39,11 +39,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #pragma pack(1) /** - This protocol can be used on any device handle to obtain generic path/location - information concerning the physical device or logical device. If the handle does - not logically map to a physical device, the handle may not necessarily support - the device path protocol. The device path describes the location of the device - the handle is for. The size of the Device Path can be determined from the structures + This protocol can be used on any device handle to obtain generic path/location + information concerning the physical device or logical device. If the handle does + not logically map to a physical device, the handle may not necessarily support + the device path protocol. The device path describes the location of the device + the handle is for. The size of the Device Path can be determined from the structures that make up the Device Path. **/ typedef struct { @@ -53,20 +53,20 @@ typedef struct { ///< 0x04 Media Device Path. ///< 0x05 BIOS Boot Specification Device Path. ///< 0x7F End of Hardware Device Path. - + UINT8 SubType; ///< Varies by Type ///< 0xFF End Entire Device Path, or ///< 0x01 End This Instance of a Device Path and start a new ///< Device Path. - + UINT8 Length[2]; ///< Specific Device Path data. Type and Sub-Type define ///< type of data. Size of data is included in Length. - + } EFI_DEVICE_PATH_PROTOCOL; /// /// Device Path protocol definition for backward-compatible with EFI1.1. -/// +/// typedef EFI_DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH; /// @@ -1072,8 +1072,8 @@ typedef struct { #define MEDIA_PROTOCOL_DP 0x05 /// -/// The Media Protocol Device Path is used to denote the protocol that is being -/// used in a device path at the location of the path specified. +/// The Media Protocol Device Path is used to denote the protocol that is being +/// used in a device path at the location of the path specified. /// Many protocols are inherent to the style of device path. /// typedef struct { @@ -1268,7 +1268,7 @@ typedef union { SAS_DEVICE_PATH Sas; SASEX_DEVICE_PATH SasEx; NVME_NAMESPACE_DEVICE_PATH NvmeNamespace; - DNS_DEVICE_PATH Dns; + DNS_DEVICE_PATH Dns; URI_DEVICE_PATH Uri; BLUETOOTH_DEVICE_PATH Bluetooth; WIFI_DEVICE_PATH WiFi; @@ -1348,7 +1348,7 @@ typedef union { } EFI_DEV_PATH_PTR; #pragma pack() - + #define END_DEVICE_PATH_TYPE 0x7f #define END_ENTIRE_DEVICE_PATH_SUBTYPE 0xFF #define END_INSTANCE_DEVICE_PATH_SUBTYPE 0x01 diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DevicePathFromText.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DevicePathFromText.h index cbdbc466dc..da9f662c0f 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DevicePathFromText.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DevicePathFromText.h @@ -1,15 +1,15 @@ /** @file - EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL as defined in UEFI 2.0. + EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL as defined in UEFI 2.0. This protocol provides service to convert text to device paths and device nodes. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -39,8 +39,8 @@ typedef EFI_DEVICE_PATH_PROTOCOL* (EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_NODE)( IN CONST CHAR16 *TextDeviceNode - ); - + ); + /** Convert text to the binary representation of a device node. @@ -57,7 +57,7 @@ typedef EFI_DEVICE_PATH_PROTOCOL* (EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_PATH)( IN CONST CHAR16 *TextDevicePath - ); + ); /// /// This protocol converts text to device paths and device nodes. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DevicePathToText.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DevicePathToText.h index 923ee64840..abd8938deb 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DevicePathToText.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DevicePathToText.h @@ -1,15 +1,15 @@ /** @file - EFI_DEVICE_PATH_TO_TEXT_PROTOCOL as defined in UEFI 2.0. + EFI_DEVICE_PATH_TO_TEXT_PROTOCOL as defined in UEFI 2.0. This protocol provides service to convert device nodes and paths to text. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -45,7 +45,7 @@ CHAR16* IN CONST EFI_DEVICE_PATH_PROTOCOL *DeviceNode, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts - ); + ); /** Convert a device path to its text representation. @@ -54,7 +54,7 @@ CHAR16* @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node - is used. + is used. @param AllowShortcuts The AllowShortcuts is FALSE, then the shortcut forms of text representation for a device node cannot be used. @@ -68,7 +68,7 @@ CHAR16* IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts - ); + ); /// /// This protocol converts device paths and device nodes to text. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DevicePathUtilities.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DevicePathUtilities.h index 35fd624f2c..95fde4573c 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DevicePathUtilities.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DevicePathUtilities.h @@ -1,15 +1,15 @@ /** @file - EFI_DEVICE_PATH_UTILITIES_PROTOCOL as defined in UEFI 2.0. + EFI_DEVICE_PATH_UTILITIES_PROTOCOL as defined in UEFI 2.0. Use to create and manipulate device paths and device nodes. 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -30,15 +30,15 @@ @param DevicePath Points to the start of the EFI device path. @return Size Size of the specified device path, in bytes, including the end-of-path tag. - @retval 0 DevicePath is NULL + @retval 0 DevicePath is NULL **/ typedef UINTN (EFIAPI *EFI_DEVICE_PATH_UTILS_GET_DEVICE_PATH_SIZE)( IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath - ); - + ); + /** Create a duplicate of the specified path. @@ -53,11 +53,11 @@ typedef EFI_DEVICE_PATH_PROTOCOL* (EFIAPI *EFI_DEVICE_PATH_UTILS_DUP_DEVICE_PATH)( IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath - ); + ); /** Create a new path by appending the second device path to the first. - If Src1 is NULL and Src2 is non-NULL, then a duplicate of Src2 is returned. + If Src1 is NULL and Src2 is non-NULL, then a duplicate of Src2 is returned. If Src1 is non-NULL and Src2 is NULL, then a duplicate of Src1 is returned. If Src1 and Src2 are both NULL, then a copy of an end-of-device-path is returned. @@ -73,11 +73,11 @@ EFI_DEVICE_PATH_PROTOCOL* (EFIAPI *EFI_DEVICE_PATH_UTILS_APPEND_PATH)( IN CONST EFI_DEVICE_PATH_PROTOCOL *Src1, IN CONST EFI_DEVICE_PATH_PROTOCOL *Src2 - ); - + ); + /** Creates a new path by appending the device node to the device path. - If DeviceNode is NULL then a copy of DevicePath is returned. + If DeviceNode is NULL then a copy of DevicePath is returned. If DevicePath is NULL then a copy of DeviceNode, followed by an end-of-device path device node is returned. If both DeviceNode and DevicePath are NULL then a copy of an end-of-device-path device node is returned. @@ -110,7 +110,7 @@ EFI_DEVICE_PATH_PROTOCOL* (EFIAPI *EFI_DEVICE_PATH_UTILS_APPEND_INSTANCE)( IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePathInstance - ); + ); /** Creates a copy of the current device path instance and returns a pointer to the next device path @@ -119,7 +119,7 @@ EFI_DEVICE_PATH_PROTOCOL* @param DevicePathInstance On input, this holds the pointer to the current device path instance. On output, this holds the pointer to the next device path instance or NULL if there are no more device - path instances in the device path. + path instances in the device path. @param DevicePathInstanceSize On output, this holds the size of the device path instance, in bytes or zero, if DevicePathInstance is NULL. If NULL, then the instance size is not output. @@ -133,7 +133,7 @@ EFI_DEVICE_PATH_PROTOCOL* (EFIAPI *EFI_DEVICE_PATH_UTILS_GET_NEXT_INSTANCE)( IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePathInstance, OUT UINTN *DevicePathInstanceSize - ); + ); /** Creates a device node @@ -156,7 +156,7 @@ EFI_DEVICE_PATH_PROTOCOL* IN UINT8 NodeType, IN UINT8 NodeSubType, IN UINT16 NodeLength -); +); /** Returns whether a device path is multi-instance. @@ -171,11 +171,11 @@ typedef BOOLEAN (EFIAPI *EFI_DEVICE_PATH_UTILS_IS_MULTI_INSTANCE)( IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath - ); - + ); + /// /// This protocol is used to creates and manipulates device paths and device nodes. -/// +/// typedef struct { EFI_DEVICE_PATH_UTILS_GET_DEVICE_PATH_SIZE GetDevicePathSize; EFI_DEVICE_PATH_UTILS_DUP_DEVICE_PATH DuplicateDevicePath; @@ -187,6 +187,6 @@ typedef struct { EFI_DEVICE_PATH_UTILS_CREATE_NODE CreateDeviceNode; } EFI_DEVICE_PATH_UTILITIES_PROTOCOL; -extern EFI_GUID gEfiDevicePathUtilitiesProtocolGuid; +extern EFI_GUID gEfiDevicePathUtilitiesProtocolGuid; #endif diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Dhcp4.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Dhcp4.h index 5dcd47c76b..6cf637826a 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Dhcp4.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Dhcp4.h @@ -5,15 +5,15 @@ drivers and to provide DHCPv4 server and PXE boot server discovery services. 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +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. - @par Revision Reference: + @par Revision Reference: This Protocol was introduced in UEFI Specification 2.0. **/ @@ -82,7 +82,7 @@ typedef struct { /// UINT32 Size; /// - /// Length of the EFI_DHCP4_PACKET from the first byte of the Header field + /// Length of the EFI_DHCP4_PACKET from the first byte of the Header field /// to the last byte of the Option[] field. /// UINT32 Length; @@ -183,24 +183,24 @@ typedef enum{ /// Dhcp4BoundCompleted = 0x08, /// - /// It is time to enter the Dhcp4Renewing state and to contact the server + /// It is time to enter the Dhcp4Renewing state and to contact the server /// that originally issued the network address. No packet is associated with this event. /// Dhcp4EnterRenewing = 0x09, /// - /// It is time to enter the Dhcp4Rebinding state and to contact any server. + /// It is time to enter the Dhcp4Rebinding state and to contact any server. /// No packet is associated with this event. /// Dhcp4EnterRebinding = 0x0a, /// - /// The configured IP address was lost either because the lease has expired, - /// the user released the configuration, or a DHCPNAK packet was received in + /// The configured IP address was lost either because the lease has expired, + /// the user released the configuration, or a DHCPNAK packet was received in /// the Dhcp4Renewing or Dhcp4Rebinding state. No packet is associated with this event. /// Dhcp4AddressLost = 0x0b, /// - /// The DHCP process failed because a DHCPNAK packet was received or the user - /// aborted the DHCP process at a time when the configuration was not available yet. + /// The DHCP process failed because a DHCPNAK packet was received or the user + /// aborted the DHCP process at a time when the configuration was not available yet. /// No packet is associated with this event. /// Dhcp4Fail = 0x0c @@ -208,7 +208,7 @@ typedef enum{ /** Callback routine. - + EFI_DHCP4_CALLBACK is provided by the consumer of the EFI DHCPv4 Protocol driver to intercept events that occurred in the configuration process. This structure provides advanced control of each state transition of the DHCP process. The @@ -257,8 +257,8 @@ typedef struct { /// UINT32 DiscoverTryCount; /// - /// The maximum amount of time (in seconds) to wait for returned packets in each - /// of the retries. Timeout values of zero will default to a timeout value + /// The maximum amount of time (in seconds) to wait for returned packets in each + /// of the retries. Timeout values of zero will default to a timeout value /// of one second. Set to NULL to use default timeout values. /// UINT32 *DiscoverTimeout; @@ -269,21 +269,21 @@ typedef struct { /// UINT32 RequestTryCount; /// - /// The maximum amount of time (in seconds) to wait for return packets in each of the retries. - /// Timeout values of zero will default to a timeout value of one second. + /// The maximum amount of time (in seconds) to wait for return packets in each of the retries. + /// Timeout values of zero will default to a timeout value of one second. /// Set to NULL to use default timeout values. /// UINT32 *RequestTimeout; /// /// For a DHCPDISCOVER, setting this parameter to the previously allocated IP - /// address will cause the EFI DHCPv4 Protocol driver to enter the Dhcp4InitReboot state. + /// address will cause the EFI DHCPv4 Protocol driver to enter the Dhcp4InitReboot state. /// And set this field to 0.0.0.0 to enter the Dhcp4Init state. /// For a DHCPINFORM this parameter should be set to the client network address /// which was assigned to the client during a DHCPDISCOVER. /// EFI_IPv4_ADDRESS ClientAddress; /// - /// The callback function to intercept various events that occurred in + /// The callback function to intercept various events that occurred in /// the DHCP configuration process. Set to NULL to ignore all those events. /// EFI_DHCP4_CALLBACK Dhcp4Callback; @@ -308,7 +308,7 @@ typedef struct { typedef struct { /// - /// The EFI DHCPv4 Protocol driver operating state. + /// The EFI DHCPv4 Protocol driver operating state. /// EFI_DHCP4_STATE State; /// @@ -329,7 +329,7 @@ typedef struct { /// EFI_IPv4_ADDRESS ServerAddress; /// - /// The router IP address that was acquired from the DHCP server. + /// The router IP address that was acquired from the DHCP server. /// May be zero if the server does not offer this address. /// EFI_IPv4_ADDRESS RouterAddress; @@ -338,8 +338,8 @@ typedef struct { /// EFI_IPv4_ADDRESS SubnetMask; /// - /// The lease time (in 1-second units) of the configured IP address. - /// The value 0xFFFFFFFF means that the lease time is infinite. + /// The lease time (in 1-second units) of the configured IP address. + /// The value 0xFFFFFFFF means that the lease time is infinite. /// A default lease of 7 days is used if the DHCP server does not provide a value. /// UINT32 LeaseTime; @@ -356,12 +356,12 @@ typedef struct { /// EFI_IPv4_ADDRESS ListenAddress; /// - /// The subnet mask of above listening unicast/broadcast IP address. + /// The subnet mask of above listening unicast/broadcast IP address. /// Ignored if ListenAddress is a multicast address. /// EFI_IPv4_ADDRESS SubnetMask; /// - /// Alternate station source (or listening) port number. + /// Alternate station source (or listening) port number. /// If zero, then the default station port number (68) will be used. /// UINT16 ListenPort; @@ -374,7 +374,7 @@ typedef struct { /// EFI_STATUS Status; /// - /// If not NULL, the event that will be signaled when the collection process + /// If not NULL, the event that will be signaled when the collection process /// completes. If NULL, this function will busy-wait until the collection process competes. /// EFI_EVENT CompletionEvent; @@ -395,7 +395,7 @@ typedef struct { /// UINT32 ListenPointCount; /// - /// An array of station address and port number pairs that are used as receiving filters. + /// An array of station address and port number pairs that are used as receiving filters. /// The first entry is also used as the source address and source port of the outgoing packet. /// EFI_DHCP4_LISTEN_POINT *ListenPoints; @@ -420,7 +420,7 @@ typedef struct { /** Returns the current operating mode and cached data packet for the EFI DHCPv4 Protocol driver. - + The GetModeData() function returns the current operating mode and cached data packet for the EFI DHCPv4 Protocol driver. @@ -510,7 +510,7 @@ EFI_STATUS time when each event occurs in this process, the callback function that was set by EFI_DHCP4_PROTOCOL.Configure() will be called and the user can take this opportunity to control the process. - + @param This The pointer to the EFI_DHCP4_PROTOCOL instance. @param CompletionEvent If not NULL, it indicates the event that will be signaled when the EFI DHCPv4 Protocol driver is transferred into the @@ -544,7 +544,7 @@ EFI_STATUS /** Extends the lease time by sending a request packet. - + The RenewRebind() function is used to manually extend the lease time when the EFI DHCPv4 Protocol driver is in the Dhcp4Bound state, and the lease time has not expired yet. This function will send a request packet to the previously @@ -617,7 +617,7 @@ EFI_STATUS /** Stops the current address configuration. - + The Stop() function is used to stop the DHCP configuration process. After this function is called successfully, the EFI DHCPv4 Protocol driver is transferred into the Dhcp4Stopped state. EFI_DHCP4_PROTOCOL.Configure() needs to be called @@ -686,7 +686,7 @@ EFI_STATUS /** Transmits a DHCP formatted packet and optionally waits for responses. - + The TransmitReceive() function is used to transmit a DHCP packet and optionally wait for the response from servers. This function does not change the state of the EFI DHCPv4 Protocol driver. It can be used at any time because of this. @@ -719,7 +719,7 @@ EFI_STATUS /** Parses the packed DHCP option data. - + The Parse() function is used to retrieve the option list from a DHCP packet. If *OptionCount isn't zero, and there is enough space for all the DHCP options in the Packet, each element of PacketOptionList is set to point to somewhere in diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Dhcp6.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Dhcp6.h index 8e0ae27eb9..2169e644f4 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Dhcp6.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Dhcp6.h @@ -3,15 +3,15 @@ addresses and other configuration parameters from DHCPv6 servers. Copyright (c) 2008 - 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 - - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - - @par Revision Reference: + 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 + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + + @par Revision Reference: This Protocol is introduced in UEFI Specification 2.2 **/ @@ -31,9 +31,9 @@ typedef struct _EFI_DHCP6_PROTOCOL EFI_DHCP6_PROTOCOL; -typedef enum { +typedef enum { /// - /// The EFI DHCPv6 Protocol instance is configured, and start() needs + /// The EFI DHCPv6 Protocol instance is configured, and start() needs /// to be called /// Dhcp6Init = 0x0, @@ -43,7 +43,7 @@ typedef enum { /// Dhcp6Selecting = 0x1, /// - /// A Request is sent out to the DHCPv6 server, and the EFI DHCPv6 + /// A Request is sent out to the DHCPv6 server, and the EFI DHCPv6 /// Protocol instance is waiting for Reply packet. /// Dhcp6Requesting = 0x2, @@ -54,7 +54,7 @@ typedef enum { /// Dhcp6Declining = 0x3, /// - /// A Confirm packet is sent out to confirm the IPv6 addresses of the + /// A Confirm packet is sent out to confirm the IPv6 addresses of the /// configured IA, and the EFI DHCPv6 Protocol instance is waiting for Reply packet. /// Dhcp6Confirming = 0x4, @@ -80,55 +80,55 @@ typedef enum { } EFI_DHCP6_STATE; typedef enum { - /// + /// /// A Solicit packet is about to be sent. The packet is passed to Dhcp6Callback and /// can be modified or replaced in Dhcp6Callback. /// Dhcp6SendSolicit = 0x0, - /// + /// /// An Advertise packet is received and will be passed to Dhcp6Callback. /// Dhcp6RcvdAdvertise = 0x1, - /// + /// /// It is time for Dhcp6Callback to determine whether select the default Advertise /// packet by RFC 3315 policy, or overwrite it by specific user policy. /// Dhcp6SelectAdvertise = 0x2, - /// + /// /// A Request packet is about to be sent. The packet is passed to Dhcp6Callback and /// can be modified or replaced in Dhcp6Callback. /// Dhcp6SendRequest = 0x3, - /// + /// /// A Reply packet is received and will be passed to Dhcp6Callback. /// Dhcp6RcvdReply = 0x4, - /// + /// /// A Reconfigure packet is received and will be passed to Dhcp6Callback. /// Dhcp6RcvdReconfigure = 0x5, - /// + /// /// A Decline packet is about to be sent. The packet is passed to Dhcp6Callback and /// can be modified or replaced in Dhcp6Callback. /// Dhcp6SendDecline = 0x6, - /// + /// /// A Confirm packet is about to be sent. The packet is passed to Dhcp6Callback and /// can be modified or replaced in Dhcp6Callback. /// Dhcp6SendConfirm = 0x7, - /// + /// /// A Release packet is about to be sent. The packet is passed to Dhcp6Callback and /// can be modified or replaced in Dhcp6Callback. /// Dhcp6SendRelease = 0x8, - /// + /// /// A Renew packet is about to be sent. The packet is passed to Dhcp6Callback and - /// can be modified or replaced in Dhcp6Callback. + /// can be modified or replaced in Dhcp6Callback. /// Dhcp6EnterRenewing = 0x9, - /// - /// A Rebind packet is about to be sent. The packet is passed to Dhcp6Callback and + /// + /// A Rebind packet is about to be sent. The packet is passed to Dhcp6Callback and /// can be modified or replaced in Dhcp6Callback. /// Dhcp6EnterRebinding = 0xa @@ -147,7 +147,7 @@ typedef enum { /// /// EFI_DHCP6_PACKET_OPTION /// defines the format of the DHCPv6 option, See RFC 3315 for more information. -/// This data structure is used to reference option data that is packed in the DHCPv6 packet. +/// This data structure is used to reference option data that is packed in the DHCPv6 packet. /// typedef struct { /// @@ -167,7 +167,7 @@ typedef struct { /// /// EFI_DHCP6_HEADER -/// defines the format of the DHCPv6 header. See RFC 3315 for more information. +/// defines the format of the DHCPv6 header. See RFC 3315 for more information. /// typedef struct{ /// @@ -181,7 +181,7 @@ typedef struct{ } EFI_DHCP6_HEADER; /// -/// EFI_DHCP6_PACKET +/// EFI_DHCP6_PACKET /// defines the format of the DHCPv6 packet. See RFC 3315 for more information. /// typedef struct { @@ -225,19 +225,19 @@ typedef struct { /// UINT32 Irt; /// - /// Maximum retransmission count for one packet. If Mrc is zero, there's no upper limit + /// Maximum retransmission count for one packet. If Mrc is zero, there's no upper limit /// for retransmission count. /// UINT32 Mrc; /// - /// Maximum retransmission timeout for each retry. It's the upper bound of the number of - /// retransmission timeout. If Mrt is zero, there is no upper limit for retransmission + /// Maximum retransmission timeout for each retry. It's the upper bound of the number of + /// retransmission timeout. If Mrt is zero, there is no upper limit for retransmission /// timeout. /// UINT32 Mrt; /// - /// Maximum retransmission duration for one packet. It's the upper bound of the numbers - /// the client may retransmit a message. If Mrd is zero, there's no upper limit for + /// Maximum retransmission duration for one packet. It's the upper bound of the numbers + /// the client may retransmit a message. If Mrd is zero, there's no upper limit for /// retransmission duration. /// UINT32 Mrd; @@ -281,7 +281,7 @@ typedef struct { /// UINT32 IaAddressCount; /// - /// List of the IPv6 addresses of the configured IA. When the state of the configured IA is + /// List of the IPv6 addresses of the configured IA. When the state of the configured IA is /// in Dhcp6Bound, Dhcp6Renewing and Dhcp6Rebinding, the IPv6 addresses are usable. /// EFI_DHCP6_IA_ADDRESS IaAddress[1]; @@ -300,39 +300,39 @@ typedef struct { } EFI_DHCP6_MODE_DATA; /** - EFI_DHCP6_CALLBACK is provided by the consumer of the EFI DHCPv6 Protocol instance to + EFI_DHCP6_CALLBACK is provided by the consumer of the EFI DHCPv6 Protocol instance to intercept events that occurs in the DHCPv6 S.A.R.R process. - @param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance that is used to configure this + @param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance that is used to configure this callback function. @param[in] Context Pointer to the context that is initialized by EFI_DHCP6_PROTOCOL.Configure(). @param[in] CurrentState The current state of the configured IA. @param[in] Dhcp6Event The event that occurs in the current state, which usually means a state transition. @param[in] Packet Pointer to the DHCPv6 packet that is about to be sent or has been received. - The EFI DHCPv6 Protocol instance is responsible for freeing the buffer. - @param[out] NewPacket Pointer to the new DHCPv6 packet to overwrite the Packet. NewPacket can not - share the buffer with Packet. If *NewPacket is not NULL, the EFI DHCPv6 + The EFI DHCPv6 Protocol instance is responsible for freeing the buffer. + @param[out] NewPacket Pointer to the new DHCPv6 packet to overwrite the Packet. NewPacket can not + share the buffer with Packet. If *NewPacket is not NULL, the EFI DHCPv6 Protocol instance is responsible for freeing the buffer. @retval EFI_SUCCESS Tell the EFI DHCPv6 Protocol instance to continue the DHCPv6 S.A.R.R process. - @retval EFI_ABORTED Tell the EFI DHCPv6 Protocol instance to abort the DHCPv6 S.A.R.R process, + @retval EFI_ABORTED Tell the EFI DHCPv6 Protocol instance to abort the DHCPv6 S.A.R.R process, and the state of the configured IA will be transferred to Dhcp6Init. **/ -typedef -EFI_STATUS +typedef +EFI_STATUS (EFIAPI *EFI_DHCP6_CALLBACK)( IN EFI_DHCP6_PROTOCOL *This, IN VOID *Context, IN EFI_DHCP6_STATE CurrentState, IN EFI_DHCP6_EVENT Dhcp6Event, - IN EFI_DHCP6_PACKET *Packet, + IN EFI_DHCP6_PACKET *Packet, OUT EFI_DHCP6_PACKET **NewPacket OPTIONAL ); typedef struct { /// - /// The callback function is to intercept various events that occur in the DHCPv6 S.A.R.R + /// The callback function is to intercept various events that occur in the DHCPv6 S.A.R.R /// process. Set to NULL to ignore all those events. /// EFI_DHCP6_CALLBACK Dhcp6Callback; @@ -345,11 +345,11 @@ typedef struct { /// UINT32 OptionCount; /// - /// List of the DHCPv6 options to be included in Solicit and Request packet. The buffer - /// can be freed after EFI_DHCP6_PROTOCOL.Configure() returns. Ignored if - /// OptionCount is zero. OptionList should not contain Client Identifier option - /// and any IA option, which will be appended by EFI DHCPv6 Protocol instance - /// automatically. + /// List of the DHCPv6 options to be included in Solicit and Request packet. The buffer + /// can be freed after EFI_DHCP6_PROTOCOL.Configure() returns. Ignored if + /// OptionCount is zero. OptionList should not contain Client Identifier option + /// and any IA option, which will be appended by EFI DHCPv6 Protocol instance + /// automatically. /// EFI_DHCP6_PACKET_OPTION **OptionList; /// @@ -357,40 +357,40 @@ typedef struct { /// EFI_DHCP6_IA_DESCRIPTOR IaDescriptor; /// - /// If not NULL, the event will be signaled when any IPv6 address information of the - /// configured IA is updated, including IPv6 address, preferred lifetime and valid - /// lifetime, or the DHCPv6 S.A.R.R process fails. Otherwise, Start(), - /// renewrebind(), decline(), release() and stop() will be blocking + /// If not NULL, the event will be signaled when any IPv6 address information of the + /// configured IA is updated, including IPv6 address, preferred lifetime and valid + /// lifetime, or the DHCPv6 S.A.R.R process fails. Otherwise, Start(), + /// renewrebind(), decline(), release() and stop() will be blocking /// operations, and they will wait for the exchange process completion or failure. /// EFI_EVENT IaInfoEvent; /// - /// If TRUE, the EFI DHCPv6 Protocol instance is willing to accept Reconfigure packet. - /// Otherwise, it will ignore it. Reconfigure Accept option can not be specified through + /// If TRUE, the EFI DHCPv6 Protocol instance is willing to accept Reconfigure packet. + /// Otherwise, it will ignore it. Reconfigure Accept option can not be specified through /// OptionList parameter. /// BOOLEAN ReconfigureAccept; /// - /// If TRUE, the EFI DHCPv6 Protocol instance will send Solicit packet with Rapid - /// Commit option. Otherwise, Rapid Commit option will not be included in Solicit + /// If TRUE, the EFI DHCPv6 Protocol instance will send Solicit packet with Rapid + /// Commit option. Otherwise, Rapid Commit option will not be included in Solicit /// packet. Rapid Commit option can not be specified through OptionList parameter. /// BOOLEAN RapidCommit; /// - /// Parameter to control Solicit packet retransmission behavior. The + /// Parameter to control Solicit packet retransmission behavior. The /// buffer can be freed after EFI_DHCP6_PROTOCOL.Configure() returns. /// EFI_DHCP6_RETRANSMISSION *SolicitRetransmission; } EFI_DHCP6_CONFIG_DATA; /** - EFI_DHCP6_INFO_CALLBACK is provided by the consumer of the EFI DHCPv6 Protocol + EFI_DHCP6_INFO_CALLBACK is provided by the consumer of the EFI DHCPv6 Protocol instance to intercept events that occurs in the DHCPv6 Information Request exchange process. - @param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance that is used to configure this + @param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance that is used to configure this callback function. @param[in] Context Pointer to the context that is initialized in the EFI_DHCP6_PROTOCOL.InfoRequest(). - @param[in] Packet Pointer to Reply packet that has been received. The EFI DHCPv6 Protocol instance is + @param[in] Packet Pointer to Reply packet that has been received. The EFI DHCPv6 Protocol instance is responsible for freeing the buffer. @retval EFI_SUCCESS Tell the EFI DHCPv6 Protocol instance to finish Information Request exchange process. @@ -410,20 +410,20 @@ EFI_STATUS Retrieve the current operating mode data and configuration data for the EFI DHCPv6 Protocol instance. @param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance. - @param[out] Dhcp6ModeData Pointer to the DHCPv6 mode data structure. The caller is responsible for freeing this + @param[out] Dhcp6ModeData Pointer to the DHCPv6 mode data structure. The caller is responsible for freeing this structure and each reference buffer. - @param[out] Dhcp6ConfigData Pointer to the DHCPv6 configuration data structure. The caller is responsible for + @param[out] Dhcp6ConfigData Pointer to the DHCPv6 configuration data structure. The caller is responsible for freeing this structure and each reference buffer. @retval EFI_SUCCESS The mode data was returned. @retval EFI_ACCESS_DENIED The EFI DHCPv6 Protocol instance has not been configured when Dhcp6ConfigData is not NULL. @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE: - - This is NULL. + - This is NULL. - Both Dhcp6ConfigData and Dhcp6ModeData are NULL. **/ -typedef -EFI_STATUS +typedef +EFI_STATUS (EFIAPI *EFI_DHCP6_GET_MODE_DATA)( IN EFI_DHCP6_PROTOCOL *This, OUT EFI_DHCP6_MODE_DATA *Dhcp6ModeData OPTIONAL, @@ -433,15 +433,15 @@ EFI_STATUS /** Initialize or clean up the configuration data for the EFI DHCPv6 Protocol instance. - The Configure() function is used to initialize or clean up the configuration data of the EFI + The Configure() function is used to initialize or clean up the configuration data of the EFI DHCPv6 Protocol instance. - - When Dhcp6CfgData is not NULL and Configure() is called successfully, the - configuration data will be initialized in the EFI DHCPv6 Protocol instance and the state of the + - When Dhcp6CfgData is not NULL and Configure() is called successfully, the + configuration data will be initialized in the EFI DHCPv6 Protocol instance and the state of the configured IA will be transferred into Dhcp6Init. - - When Dhcp6CfgData is NULL and Configure() is called successfully, the configuration + - When Dhcp6CfgData is NULL and Configure() is called successfully, the configuration data will be cleaned up and no IA will be associated with the EFI DHCPv6 Protocol instance. - To update the configuration data for an EFI DCHPv6 Protocol instance, the original data must be + To update the configuration data for an EFI DCHPv6 Protocol instance, the original data must be cleaned up before setting the new configuration data. @param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance. @@ -449,24 +449,24 @@ EFI_STATUS @retval EFI_SUCCESS The mode data was returned. @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE - - This is NULL. + - This is NULL. - OptionCount > 0 and OptionList is NULL. - OptionList is not NULL, and Client Id option, Reconfigure Accept option, Rapid Commit option or any IA option is specified in the OptionList. - IaDescriptor.Type is neither EFI_DHCP6_IA_TYPE_NA nor EFI_DHCP6_IA_TYPE_NA. - IaDescriptor is not unique. - Both IaInfoEvent and SolicitRetransimssion are NULL. - - SolicitRetransmission is not NULL, and both SolicitRetransimssion->Mrc and + - SolicitRetransmission is not NULL, and both SolicitRetransimssion->Mrc and SolicitRetransmission->Mrd are zero. - @retval EFI_ACCESS_DENIED The EFI DHCPv6 Protocol instance has been already configured + @retval EFI_ACCESS_DENIED The EFI DHCPv6 Protocol instance has been already configured when Dhcp6CfgData is not NULL. - The EFI DHCPv6 Protocol instance has already started the + The EFI DHCPv6 Protocol instance has already started the DHCPv6 S.A.R.R when Dhcp6CfgData is NULL. @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_DHCP6_CONFIGURE)( IN EFI_DHCP6_PROTOCOL *This, @@ -476,13 +476,13 @@ EFI_STATUS /** Start the DHCPv6 S.A.R.R process. - The Start() function starts the DHCPv6 S.A.R.R process. This function can be called only when + The Start() function starts the DHCPv6 S.A.R.R process. This function can be called only when the state of the configured IA is in the Dhcp6Init state. If the DHCPv6 S.A.R.R process completes - successfully, the state of the configured IA will be transferred through Dhcp6Selecting and - Dhcp6Requesting to Dhcp6Bound state. The update of the IPv6 addresses will be notified through - EFI_DHCP6_CONFIG_DATA.IaInfoEvent. At the time when each event occurs in this process, the - callback function set by EFI_DHCP6_PROTOCOL.Configure() will be called and the user can take - this opportunity to control the process. If EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL, the + successfully, the state of the configured IA will be transferred through Dhcp6Selecting and + Dhcp6Requesting to Dhcp6Bound state. The update of the IPv6 addresses will be notified through + EFI_DHCP6_CONFIG_DATA.IaInfoEvent. At the time when each event occurs in this process, the + callback function set by EFI_DHCP6_PROTOCOL.Configure() will be called and the user can take + this opportunity to control the process. If EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL, the Start() function call is a blocking operation. It will return after the DHCPv6 S.A.R.R process completes or aborted by users. If the process is aborted by system or network error, the state of the configured IA will be transferred to Dhcp6Init. The Start() function can be called again to @@ -490,10 +490,10 @@ EFI_STATUS @param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance. - @retval EFI_SUCCESS The DHCPv6 S.A.R.R process is completed and at least one IPv6 - address has been bound to the configured IA when - EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL. - The DHCPv6 S.A.R.R process is started when + @retval EFI_SUCCESS The DHCPv6 S.A.R.R process is completed and at least one IPv6 + address has been bound to the configured IA when + EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL. + The DHCPv6 S.A.R.R process is started when EFI_DHCP6_CONFIG_DATA.IaInfoEvent is not NULL. @retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn't been configured. @retval EFI_INVALID_PARAMETER This is NULL. @@ -501,13 +501,13 @@ EFI_STATUS @retval EFI_ALREADY_STARTED The DHCPv6 S.A.R.R process has already started. @retval EFI_DEVICE_ERROR An unexpected network or system error occurred. @retval EFI_NO_RESPONSE The DHCPv6 S.A.R.R process failed because of no response. - @retval EFI_NO_MAPPING No IPv6 address has been bound to the configured IA after the + @retval EFI_NO_MAPPING No IPv6 address has been bound to the configured IA after the DHCPv6 S.A.R.R process. @retval EFI_ABORTED The DHCPv6 S.A.R.R process aborted by user. @retval EFI_NO_MEDIA There was a media error. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_DHCP6_START)( IN EFI_DHCP6_PROTOCOL *This @@ -517,19 +517,19 @@ EFI_STATUS Request configuration information without the assignment of any IA addresses of the client. The InfoRequest() function is used to request configuration information without the assignment - of any IPv6 address of the client. Client sends out Information Request packet to obtain - the required configuration information, and DHCPv6 server responds with Reply packet containing - the information for the client. The received Reply packet will be passed to the user by + of any IPv6 address of the client. Client sends out Information Request packet to obtain + the required configuration information, and DHCPv6 server responds with Reply packet containing + the information for the client. The received Reply packet will be passed to the user by ReplyCallback function. If user returns EFI_NOT_READY from ReplyCallback, the EFI DHCPv6 - Protocol instance will continue to receive other Reply packets unless timeout according to - the Retransmission parameter. Otherwise, the Information Request exchange process will be + Protocol instance will continue to receive other Reply packets unless timeout according to + the Retransmission parameter. Otherwise, the Information Request exchange process will be finished successfully if user returns EFI_SUCCESS from ReplyCallback. @param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance. @param[in] SendClientId If TRUE, the EFI DHCPv6 Protocol instance will build Client Identifier option and include it into Information Request packet. If FALSE, Client Identifier option will not be included. - Client Identifier option can not be specified through OptionList + Client Identifier option can not be specified through OptionList parameter. @param[in] OptionRequest Pointer to the Option Request option in the Information Request packet. Option Request option can not be specified through @@ -543,29 +543,29 @@ EFI_STATUS returns. @param[in] TimeoutEvent If not NULL, this event is signaled when the information request exchange aborted because of no response. If NULL, the function - call is a blocking operation; and it will return after the + call is a blocking operation; and it will return after the information-request exchange process finish or aborted by users. @param[in] ReplyCallback The callback function is to intercept various events that occur in the Information Request exchange process. It should not be set to NULL. @param[in] CallbackContext Pointer to the context that will be passed to ReplyCallback. - @retval EFI_SUCCESS The DHCPv6 S.A.R.R process is completed and at least one IPv6 - @retval EFI_SUCCESS The DHCPv6 information request exchange process completed + @retval EFI_SUCCESS The DHCPv6 S.A.R.R process is completed and at least one IPv6 + @retval EFI_SUCCESS The DHCPv6 information request exchange process completed when TimeoutEvent is NULL. Information Request packet has been sent to DHCPv6 server when TimeoutEvent is not NULL. @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE: - - This is NULL. + - This is NULL. - OptionRequest is NULL or OptionRequest->OpCode is invalid. - OptionCount > 0 and OptionList is NULL. - - OptionList is not NULL, and Client Identify option or + - OptionList is not NULL, and Client Identify option or Option Request option is specified in the OptionList. - Retransimssion is NULL. - Both Retransimssion->Mrc and Retransmission->Mrd are zero. - ReplyCallback is NULL. @retval EFI_DEVICE_ERROR An unexpected network or system error occurred. - @retval EFI_NO_RESPONSE The DHCPv6 information request exchange process failed - because of no response, or not all requested-options are + @retval EFI_NO_RESPONSE The DHCPv6 information request exchange process failed + because of no response, or not all requested-options are responded by DHCPv6 servers when Timeout happened. @retval EFI_ABORTED The DHCPv6 information request exchange process aborted by user. @@ -578,7 +578,7 @@ EFI_STATUS IN EFI_DHCP6_PACKET_OPTION *OptionRequest, IN UINT32 OptionCount, IN EFI_DHCP6_PACKET_OPTION *OptionList[] OPTIONAL, - IN EFI_DHCP6_RETRANSMISSION *Retransmission, + IN EFI_DHCP6_RETRANSMISSION *Retransmission, IN EFI_EVENT TimeoutEvent OPTIONAL, IN EFI_DHCP6_INFO_CALLBACK ReplyCallback, IN VOID *CallbackContext OPTIONAL @@ -588,38 +588,38 @@ EFI_STATUS Manually extend the valid and preferred lifetimes for the IPv6 addresses of the configured IA and update other configuration parameters by sending Renew or Rebind packet. - The RenewRebind() function is used to manually extend the valid and preferred lifetimes for the - IPv6 addresses of the configured IA and update other configuration parameters by sending Renew or - Rebind packet. - - When RebindRequest is FALSE and the state of the configured IA is Dhcp6Bound, it - will send Renew packet to the previously DHCPv6 server and transfer the state of the configured - IA to Dhcp6Renewing. If valid Reply packet received, the state transfers to Dhcp6Bound - and the valid and preferred timer restarts. If fails, the state transfers to Dhcp6Bound but the - timer continues. - - When RebindRequest is TRUE and the state of the configured IA is Dhcp6Bound, it will - send Rebind packet. If valid Reply packet received, the state transfers to Dhcp6Bound and the + The RenewRebind() function is used to manually extend the valid and preferred lifetimes for the + IPv6 addresses of the configured IA and update other configuration parameters by sending Renew or + Rebind packet. + - When RebindRequest is FALSE and the state of the configured IA is Dhcp6Bound, it + will send Renew packet to the previously DHCPv6 server and transfer the state of the configured + IA to Dhcp6Renewing. If valid Reply packet received, the state transfers to Dhcp6Bound + and the valid and preferred timer restarts. If fails, the state transfers to Dhcp6Bound but the + timer continues. + - When RebindRequest is TRUE and the state of the configured IA is Dhcp6Bound, it will + send Rebind packet. If valid Reply packet received, the state transfers to Dhcp6Bound and the valid and preferred timer restarts. If fails, the state transfers to Dhcp6Init and the IA can't be used. @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. - @param[in] RebindRequest If TRUE, it will send Rebind packet and enter the Dhcp6Rebinding state. + @param[in] RebindRequest If TRUE, it will send Rebind packet and enter the Dhcp6Rebinding state. Otherwise, it will send Renew packet and enter the Dhcp6Renewing state. - @retval EFI_SUCCESS The DHCPv6 renew/rebind exchange process has completed and at + @retval EFI_SUCCESS The DHCPv6 renew/rebind exchange process has completed and at least one IPv6 address of the configured IA has been bound again - when EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL. - The EFI DHCPv6 Protocol instance has sent Renew or Rebind packet + when EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL. + The EFI DHCPv6 Protocol instance has sent Renew or Rebind packet when EFI_DHCP6_CONFIG_DATA.IaInfoEvent is not NULL. @retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn't been configured, or the state of the configured IA is not in Dhcp6Bound. - @retval EFI_ALREADY_STARTED The state of the configured IA has already entered Dhcp6Renewing - when RebindRequest is FALSE. - The state of the configured IA has already entered Dhcp6Rebinding + @retval EFI_ALREADY_STARTED The state of the configured IA has already entered Dhcp6Renewing + when RebindRequest is FALSE. + The state of the configured IA has already entered Dhcp6Rebinding when RebindRequest is TRUE. @retval EFI_INVALID_PARAMETER This is NULL. @retval EFI_DEVICE_ERROR An unexpected system or system error occurred. @retval EFI_NO_RESPONSE The DHCPv6 renew/rebind exchange process failed because of no response. - @retval EFI_NO_MAPPING No IPv6 address has been bound to the configured IA after the DHCPv6 + @retval EFI_NO_MAPPING No IPv6 address has been bound to the configured IA after the DHCPv6 renew/rebind exchange process. @retval EFI_ABORTED The DHCPv6 renew/rebind exchange process aborted by user. @@ -635,34 +635,34 @@ EFI_STATUS Inform that one or more IPv6 addresses assigned by a server are already in use by another node. - The Decline() function is used to manually decline the assignment of IPv6 addresses, which - have been already used by another node. If all IPv6 addresses of the configured IA are declined - through this function, the state of the IA will switch through Dhcp6Declining to Dhcp6Init, - otherwise, the state of the IA will restore to Dhcp6Bound after the declining process. The - Decline() can only be called when the IA is in Dhcp6Bound state. If the - EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL, this function is a blocking operation. It + The Decline() function is used to manually decline the assignment of IPv6 addresses, which + have been already used by another node. If all IPv6 addresses of the configured IA are declined + through this function, the state of the IA will switch through Dhcp6Declining to Dhcp6Init, + otherwise, the state of the IA will restore to Dhcp6Bound after the declining process. The + Decline() can only be called when the IA is in Dhcp6Bound state. If the + EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL, this function is a blocking operation. It will return after the declining process finishes, or aborted by user. @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. - @param[in] AddressCount Number of declining IPv6 addresses. + @param[in] AddressCount Number of declining IPv6 addresses. @param[in] Addresses Pointer to the buffer stored all the declining IPv6 addresses. - @retval EFI_SUCCESS The DHCPv6 decline exchange process has completed when + @retval EFI_SUCCESS The DHCPv6 decline exchange process has completed when EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL. - The EFI DHCPv6 Protocol instance has sent Decline packet when + The EFI DHCPv6 Protocol instance has sent Decline packet when EFI_DHCP6_CONFIG_DATA.IaInfoEvent is not NULL. @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE - - This is NULL. + - This is NULL. - AddressCount is zero or Addresses is NULL. - @retval EFI_NOT_FOUND Any specified IPv6 address is not correlated with the configured IA + @retval EFI_NOT_FOUND Any specified IPv6 address is not correlated with the configured IA for this instance. - @retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn't been configured, or the + @retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn't been configured, or the state of the configured IA is not in Dhcp6Bound. @retval EFI_DEVICE_ERROR An unexpected network or system error occurred. @retval EFI_ABORTED The DHCPv6 decline exchange process aborted by user. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_DHCP6_DECLINE)( IN EFI_DHCP6_PROTOCOL *This, @@ -675,32 +675,32 @@ EFI_STATUS The Release() function is used to manually release the one or more IPv6 address. If AddressCount is zero, it will release all IPv6 addresses of the configured IA. If all IPv6 addresses of the IA - are released through this function, the state of the IA will switch through Dhcp6Releasing to + are released through this function, the state of the IA will switch through Dhcp6Releasing to Dhcp6Init, otherwise, the state of the IA will restore to Dhcp6Bound after the releasing process. The Release() can only be called when the IA is in Dhcp6Bound state. If the EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL, the function is a blocking operation. It will return - after the releasing process finishes, or aborted by user. + after the releasing process finishes, or aborted by user. @param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance. - @param[in] AddressCount Number of releasing IPv6 addresses. + @param[in] AddressCount Number of releasing IPv6 addresses. @param[in] Addresses Pointer to the buffer stored all the releasing IPv6 addresses. Ignored if AddressCount is zero. - @retval EFI_SUCCESS The DHCPv6 release exchange process has completed when + @retval EFI_SUCCESS The DHCPv6 release exchange process has completed when EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL. - The EFI DHCPv6 Protocol instance has sent Release packet when + The EFI DHCPv6 Protocol instance has sent Release packet when EFI_DHCP6_CONFIG_DATA.IaInfoEvent is not NULL. @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE - - This is NULL. + - This is NULL. - AddressCount is not zero or Addresses is NULL. @retval EFI_NOT_FOUND Any specified IPv6 address is not correlated with the configured IA for this instance. - @retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn't been configured, or the + @retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn't been configured, or the state of the configured IA is not in Dhcp6Bound. @retval EFI_DEVICE_ERROR An unexpected network or system error occurred. - @retval EFI_ABORTED The DHCPv6 release exchange process aborted by user. + @retval EFI_ABORTED The DHCPv6 release exchange process aborted by user. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_DHCP6_RELEASE)( IN EFI_DHCP6_PROTOCOL *This, @@ -713,7 +713,7 @@ EFI_STATUS The Stop() function is used to stop the DHCPv6 S.A.R.R process. If this function is called successfully, all the IPv6 addresses of the configured IA will be released and the state of - the configured IA will be transferred to Dhcp6Init. + the configured IA will be transferred to Dhcp6Init. @param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance. @@ -725,7 +725,7 @@ EFI_STATUS @retval EFI_INVALID_PARAMETER This is NULL. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_DHCP6_STOP)( IN EFI_DHCP6_PROTOCOL *This @@ -734,7 +734,7 @@ EFI_STATUS /** Parse the option data in the DHCPv6 packet. - The Parse() function is used to retrieve the option list in the DHCPv6 packet. + The Parse() function is used to retrieve the option list in the DHCPv6 packet. @param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance. @@ -751,7 +751,7 @@ EFI_STATUS - Packet is not a well-formed DHCPv6 packet. - OptionCount is NULL. - *OptionCount is not zero and PacketOptionList is NULL. - @retval EFI_BUFFER_TOO_SMALL *OptionCount is smaller than the number of options that were + @retval EFI_BUFFER_TOO_SMALL *OptionCount is smaller than the number of options that were found in the Packet. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DiskInfo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DiskInfo.h index 5e025bdb16..64c718087e 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DiskInfo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DiskInfo.h @@ -1,6 +1,6 @@ /** @file - Provides the basic interfaces to abstract platform information regarding an - IDE controller. + Provides the basic interfaces to abstract platform information regarding an + IDE controller. Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR> This program and the accompanying materials @@ -14,7 +14,7 @@ @par Revision Reference: This Protocol is defined in UEFI Platform Initialization Specification 1.6 Volume 5: Standards - + **/ #ifndef __DISK_INFO_H__ @@ -91,7 +91,7 @@ typedef struct _EFI_DISK_INFO_PROTOCOL EFI_DISK_INFO_PROTOCOL; /** Provides inquiry information for the controller type. - + This function is used by the IDE bus driver to get inquiry data. Data format of Identify data is defined by the Interface GUID. @@ -100,9 +100,9 @@ typedef struct _EFI_DISK_INFO_PROTOCOL EFI_DISK_INFO_PROTOCOL; @param[in,out] InquiryDataSize Pointer to the value for the inquiry data size. @retval EFI_SUCCESS The command was accepted without any errors. - @retval EFI_NOT_FOUND Device does not support this data class - @retval EFI_DEVICE_ERROR Error reading InquiryData from device - @retval EFI_BUFFER_TOO_SMALL InquiryDataSize not big enough + @retval EFI_NOT_FOUND Device does not support this data class + @retval EFI_DEVICE_ERROR Error reading InquiryData from device + @retval EFI_BUFFER_TOO_SMALL InquiryDataSize not big enough **/ typedef @@ -119,16 +119,16 @@ EFI_STATUS This function is used by the IDE bus driver to get identify data. Data format of Identify data is defined by the Interface GUID. - @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL + @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. @param[in,out] IdentifyData Pointer to a buffer for the identify data. @param[in,out] IdentifyDataSize Pointer to the value for the identify data size. @retval EFI_SUCCESS The command was accepted without any errors. - @retval EFI_NOT_FOUND Device does not support this data class - @retval EFI_DEVICE_ERROR Error reading IdentifyData from device - @retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough + @retval EFI_NOT_FOUND Device does not support this data class + @retval EFI_DEVICE_ERROR Error reading IdentifyData from device + @retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough **/ typedef @@ -141,8 +141,8 @@ EFI_STATUS /** Provides sense data information for the controller type. - - This function is used by the IDE bus driver to get sense data. + + This function is used by the IDE bus driver to get sense data. Data format of Sense data is defined by the Interface GUID. @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. @@ -168,7 +168,7 @@ EFI_STATUS /** This function is used by the IDE bus driver to get controller information. - @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. + @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. @param[out] IdeChannel Pointer to the Ide Channel number. Primary or secondary. @param[out] IdeDevice Pointer to the Ide Device number. Master or slave. @@ -189,7 +189,7 @@ EFI_STATUS /// struct _EFI_DISK_INFO_PROTOCOL { /// - /// A GUID that defines the format of buffers for the other member functions + /// A GUID that defines the format of buffers for the other member functions /// of this protocol. /// EFI_GUID Interface; @@ -209,7 +209,7 @@ struct _EFI_DISK_INFO_PROTOCOL { /// EFI_DISK_INFO_SENSE_DATA SenseData; /// - /// Specific controller. + /// Specific controller. /// EFI_DISK_INFO_WHICH_IDE WhichIde; }; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DiskIo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DiskIo.h index 9f2526161c..d4f7b91ec8 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DiskIo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DiskIo.h @@ -6,13 +6,13 @@ Block IO protocol. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -26,14 +26,14 @@ /// /// Protocol GUID name defined in EFI1.1. -/// +/// #define DISK_IO_PROTOCOL EFI_DISK_IO_PROTOCOL_GUID typedef struct _EFI_DISK_IO_PROTOCOL EFI_DISK_IO_PROTOCOL; /// /// Protocol defined in EFI1.1. -/// +/// typedef EFI_DISK_IO_PROTOCOL EFI_DISK_IO; /** @@ -95,7 +95,7 @@ EFI_STATUS /// /// Revision defined in EFI1.1 -/// +/// #define EFI_DISK_IO_INTERFACE_REVISION EFI_DISK_IO_PROTOCOL_REVISION /// diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DiskIo2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DiskIo2.h index c2994c2fac..47a89525b9 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DiskIo2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DiskIo2.h @@ -5,13 +5,13 @@ non-blocking / asynchronous byte-oriented disk operation. Copyright (c) 2013, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Dns4.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Dns4.h index 61c8e5c38a..2ab7ed9151 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Dns4.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Dns4.h @@ -38,23 +38,23 @@ typedef struct _EFI_DNS4_PROTOCOL EFI_DNS4_PROTOCOL; /// typedef struct { /// - /// Count of the DNS servers. When used with GetModeData(), - /// this field is the count of originally configured servers when - /// Configure() was called for this instance. When used with - /// Configure() this is the count of caller-supplied servers. If the - /// DnsServerListCount is zero, the DNS server configuration + /// Count of the DNS servers. When used with GetModeData(), + /// this field is the count of originally configured servers when + /// Configure() was called for this instance. When used with + /// Configure() this is the count of caller-supplied servers. If the + /// DnsServerListCount is zero, the DNS server configuration /// will be retrieved from DHCP server automatically. /// UINTN DnsServerListCount; /// - /// Pointer to DNS server list containing DnsServerListCount entries or NULL - /// if DnsServerListCountis 0. For Configure(), this will be NULL when there are - /// no caller supplied server addresses, and, the DNS instance will retrieve - /// DNS server from DHCP Server. The provided DNS server list is - /// recommended to be filled up in the sequence of preference. When - /// used with GetModeData(), the buffer containing the list will - /// be allocated by the driver implementing this protocol and must be - /// freed by the caller. When used with Configure(), the buffer + /// Pointer to DNS server list containing DnsServerListCount entries or NULL + /// if DnsServerListCountis 0. For Configure(), this will be NULL when there are + /// no caller supplied server addresses, and, the DNS instance will retrieve + /// DNS server from DHCP Server. The provided DNS server list is + /// recommended to be filled up in the sequence of preference. When + /// used with GetModeData(), the buffer containing the list will + /// be allocated by the driver implementing this protocol and must be + /// freed by the caller. When used with Configure(), the buffer /// containing the list will be allocated and released by the caller. /// EFI_IPv4_ADDRESS *DnsServerList; @@ -68,10 +68,10 @@ typedef struct { /// BOOLEAN EnableDnsCache; /// - /// Use the protocol number defined in "Links to UEFI-Related - /// Documents"(http://uefi.org/uefi) under the heading "IANA - /// Protocol Numbers". Only TCP or UDP are supported, and other - /// protocol values are invalid. An implementation can choose to + /// Use the protocol number defined in "Links to UEFI-Related + /// Documents"(http://uefi.org/uefi) under the heading "IANA + /// Protocol Numbers". Only TCP or UDP are supported, and other + /// protocol values are invalid. An implementation can choose to /// support only UDP, or both TCP and UDP. /// UINT8 Protocol; @@ -135,10 +135,10 @@ typedef struct { /// UINT32 DnsServerCount; /// - /// Pointer to common list of addresses of all configured DNS server - /// used by EFI_DNS4_PROTOCOL instances. List will include - /// DNS servers configured by this or any other EFI_DNS4_PROTOCOL instance. - /// The storage for this list is allocated by the driver publishing this + /// Pointer to common list of addresses of all configured DNS server + /// used by EFI_DNS4_PROTOCOL instances. List will include + /// DNS servers configured by this or any other EFI_DNS4_PROTOCOL instance. + /// The storage for this list is allocated by the driver publishing this /// protocol, and must be freed by the caller. /// EFI_IPv4_ADDRESS *DnsServerList; @@ -147,8 +147,8 @@ typedef struct { /// UINT32 DnsCacheCount; /// - /// Pointer to a buffer containing DnsCacheCount DNS Cache - /// entry structures. The storage for this list is allocated by the driver + /// Pointer to a buffer containing DnsCacheCount DNS Cache + /// entry structures. The storage for this list is allocated by the driver /// publishing this protocol and must be freed by caller. /// EFI_DNS4_CACHE_ENTRY *DnsCacheList; @@ -311,7 +311,7 @@ EFI_STATUS @retval EFI_SUCCESS The operation completed successfully. @retval EFI_UNSUPPORTED The designated protocol is not supported. @retval EFI_INVALID_PARAMETER This is NULL. - The StationIp address provided in DnsConfigData is not a + The StationIp address provided in DnsConfigData is not a valid unicast. DnsServerList is NULL while DnsServerListCount is not ZERO. @@ -321,8 +321,8 @@ EFI_STATUS allocated. @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI DNSv4 Protocol instance is not configured. - @retval EFI_ALREADY_STARTED Second call to Configure() with DnsConfigData. To - reconfigure the instance the caller must call Configure() + @retval EFI_ALREADY_STARTED Second call to Configure() with DnsConfigData. To + reconfigure the instance the caller must call Configure() with NULL first to return driver to unconfigured state. **/ typedef @@ -363,7 +363,7 @@ EFI_STATUS /** IPv4 address to host name translation also known as Reverse DNS lookup. - The IpToHostName() function is used to translate the host address to host name. A type PTR + The IpToHostName() function is used to translate the host address to host name. A type PTR query is used to get the primary name of the host. Support of this function is optional. @param[in] This Pointer to EFI_DNS4_PROTOCOL instance. @@ -391,7 +391,7 @@ EFI_STATUS ); /** - Retrieve arbitrary information from the DNS server. + Retrieve arbitrary information from the DNS server. This GeneralLookup() function retrieves arbitrary information from the DNS. The caller supplies a QNAME, QTYPE, and QCLASS, and all of the matching RRs are returned. All diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Dns6.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Dns6.h index bf8814606e..f1f45de94d 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Dns6.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Dns6.h @@ -49,8 +49,8 @@ typedef struct { /// UINT8 Protocol; /// - /// The local IP address to use. Set to zero to let the underlying IPv6 - /// driver choose a source address. If not zero it must be one of the + /// The local IP address to use. Set to zero to let the underlying IPv6 + /// driver choose a source address. If not zero it must be one of the /// configured IP addresses in the underlying IPv6 driver. /// EFI_IPv6_ADDRESS StationIp; @@ -59,23 +59,23 @@ typedef struct { /// UINT16 LocalPort; /// - /// Count of the DNS servers. When used with GetModeData(), - /// this field is the count of originally configured servers when - /// Configure() was called for this instance. When used with - /// Configure() this is the count of caller-supplied servers. If the - /// DnsServerListCount is zero, the DNS server configuration + /// Count of the DNS servers. When used with GetModeData(), + /// this field is the count of originally configured servers when + /// Configure() was called for this instance. When used with + /// Configure() this is the count of caller-supplied servers. If the + /// DnsServerListCount is zero, the DNS server configuration /// will be retrieved from DHCP server automatically. /// UINT32 DnsServerCount; /// /// Pointer to DNS server list containing DnsServerListCount - /// entries or NULL if DnsServerListCount is 0. For Configure(), - /// this will be NULL when there are no caller supplied server addresses - /// and the DNS instance will retrieve DNS server from DHCP Server. - /// The provided DNS server list is recommended to be filled up in the sequence - /// of preference. When used with GetModeData(), the buffer containing the list - /// will be allocated by the driver implementing this protocol and must be - /// freed by the caller. When used with Configure(), the buffer + /// entries or NULL if DnsServerListCount is 0. For Configure(), + /// this will be NULL when there are no caller supplied server addresses + /// and the DNS instance will retrieve DNS server from DHCP Server. + /// The provided DNS server list is recommended to be filled up in the sequence + /// of preference. When used with GetModeData(), the buffer containing the list + /// will be allocated by the driver implementing this protocol and must be + /// freed by the caller. When used with Configure(), the buffer /// containing the list will be allocated and released by the caller. /// EFI_IPv6_ADDRESS *DnsServerList; @@ -123,9 +123,9 @@ typedef struct { /// UINT32 DnsServerCount; /// - /// Pointer to common list of addresses of all configured DNS server used by EFI_DNS6_PROTOCOL - /// instances. List will include DNS servers configured by this or any other EFI_DNS6_PROTOCOL - /// instance. The storage for this list is allocated by the driver publishing this protocol, + /// Pointer to common list of addresses of all configured DNS server used by EFI_DNS6_PROTOCOL + /// instances. List will include DNS servers configured by this or any other EFI_DNS6_PROTOCOL + /// instance. The storage for this list is allocated by the driver publishing this protocol, /// and must be freed by the caller. /// EFI_IPv6_ADDRESS *DnsServerList; @@ -134,8 +134,8 @@ typedef struct { /// UINT32 DnsCacheCount; /// - /// Pointer to a buffer containing DnsCacheCount DNS Cache - /// entry structures. The storage for thislist is allocated by the driver + /// Pointer to a buffer containing DnsCacheCount DNS Cache + /// entry structures. The storage for thislist is allocated by the driver /// publishing this protocol and must be freed by caller. /// EFI_DNS6_CACHE_ENTRY *DnsCacheList; @@ -272,7 +272,7 @@ typedef struct { This function is used to retrieve DNS mode data for this DNS instance. @param[in] This Pointer to EFI_DNS6_PROTOCOL instance. - @param[out] DnsModeData Pointer to the caller-allocated storage for the + @param[out] DnsModeData Pointer to the caller-allocated storage for the EFI_DNS6_MODE_DATA data. @retval EFI_SUCCESS The operation completed successfully. @@ -296,7 +296,7 @@ EFI_STATUS EFI DNSv6 Protocol driver instance. Reset the DNS instance if DnsConfigData is NULL. @param[in] This Pointer to EFI_DNS6_PROTOCOL instance. - @param[in] DnsConfigData Pointer to the configuration data structure. All associated + @param[in] DnsConfigData Pointer to the configuration data structure. All associated storage to be allocated and released by caller. @retval EFI_SUCCESS The operation completed successfully. @@ -308,8 +308,8 @@ EFI_STATUS @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI DNSv6 Protocol instance is not configured. @retval EFI_UNSUPPORTED The designated protocol is not supported. - @retval EFI_ALREADY_STARTED Second call to Configure() with DnsConfigData. To - reconfigure the instance the caller must call Configure() with + @retval EFI_ALREADY_STARTED Second call to Configure() with DnsConfigData. To + reconfigure the instance the caller must call Configure() with NULL first to return driver to unconfigured state. **/ typedef diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverBinding.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverBinding.h index b325c0ccf7..94fe36feb9 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverBinding.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverBinding.h @@ -1,17 +1,17 @@ /** @file UEFI DriverBinding Protocol is defined in UEFI specification. - - This protocol is produced by every driver that follows the UEFI Driver Model, + + This protocol is produced by every driver that follows the UEFI Driver Model, and it is the central component that allows drivers and controllers to be managed. 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -29,33 +29,33 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. typedef struct _EFI_DRIVER_BINDING_PROTOCOL EFI_DRIVER_BINDING_PROTOCOL; /** - Tests to see if this driver supports a given controller. If a child device is provided, + Tests to see if this driver supports a given controller. If a child device is provided, it further tests to see if this driver supports creating a handle for the specified child device. - This function checks to see if the driver specified by This supports the device specified by - ControllerHandle. Drivers will typically use the device path attached to - ControllerHandle and/or the services from the bus I/O abstraction attached to - ControllerHandle to determine if the driver supports ControllerHandle. This function - may be called many times during platform initialization. In order to reduce boot times, the tests - performed by this function must be very small, and take as little time as possible to execute. This - function must not change the state of any hardware devices, and this function must be aware that the - device specified by ControllerHandle may already be managed by the same driver or a - different driver. This function must match its calls to AllocatePages() with FreePages(), - AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol(). - Because ControllerHandle may have been previously started by the same driver, if a protocol is - already in the opened state, then it must not be closed with CloseProtocol(). This is required + This function checks to see if the driver specified by This supports the device specified by + ControllerHandle. Drivers will typically use the device path attached to + ControllerHandle and/or the services from the bus I/O abstraction attached to + ControllerHandle to determine if the driver supports ControllerHandle. This function + may be called many times during platform initialization. In order to reduce boot times, the tests + performed by this function must be very small, and take as little time as possible to execute. This + function must not change the state of any hardware devices, and this function must be aware that the + device specified by ControllerHandle may already be managed by the same driver or a + different driver. This function must match its calls to AllocatePages() with FreePages(), + AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol(). + Because ControllerHandle may have been previously started by the same driver, if a protocol is + already in the opened state, then it must not be closed with CloseProtocol(). This is required to guarantee the state of ControllerHandle is not modified by this function. @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. - @param[in] ControllerHandle The handle of the controller to test. This handle - must support a protocol interface that supplies + @param[in] ControllerHandle The handle of the controller to test. This handle + must support a protocol interface that supplies an I/O abstraction to the driver. - @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This - parameter is ignored by device drivers, and is optional for bus - drivers. For bus drivers, if this parameter is not NULL, then - the bus driver must determine if the bus controller specified - by ControllerHandle and the child controller specified - by RemainingDevicePath are both supported by this + @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This + parameter is ignored by device drivers, and is optional for bus + drivers. For bus drivers, if this parameter is not NULL, then + the bus driver must determine if the bus controller specified + by ControllerHandle and the child controller specified + by RemainingDevicePath are both supported by this bus driver. @retval EFI_SUCCESS The device specified by ControllerHandle and @@ -82,28 +82,28 @@ EFI_STATUS Starts a device controller or a bus controller. The Start() function is designed to be invoked from the EFI boot service ConnectController(). - As a result, much of the error checking on the parameters to Start() has been moved into this - common boot service. It is legal to call Start() from other locations, + As a result, much of the error checking on the parameters to Start() has been moved into this + common boot service. It is legal to call Start() from other locations, but the following calling restrictions must be followed, or the system behavior will not be deterministic. 1. ControllerHandle must be a valid EFI_HANDLE. 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned EFI_DEVICE_PATH_PROTOCOL. 3. Prior to calling Start(), the Supported() function for the driver specified by This must - have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS. + have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS. @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. - @param[in] ControllerHandle The handle of the controller to start. This handle - must support a protocol interface that supplies + @param[in] ControllerHandle The handle of the controller to start. This handle + must support a protocol interface that supplies an I/O abstraction to the driver. - @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This - parameter is ignored by device drivers, and is optional for bus - drivers. For a bus driver, if this parameter is NULL, then handles - for all the children of Controller are created by this driver. - If this parameter is not NULL and the first Device Path Node is - not the End of Device Path Node, then only the handle for the - child device specified by the first Device Path Node of + @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This + parameter is ignored by device drivers, and is optional for bus + drivers. For a bus driver, if this parameter is NULL, then handles + for all the children of Controller are created by this driver. + If this parameter is not NULL and the first Device Path Node is + not the End of Device Path Node, then only the handle for the + child device specified by the first Device Path Node of RemainingDevicePath is created by this driver. - If the first Device Path Node of RemainingDevicePath is + If the first Device Path Node of RemainingDevicePath is the End of Device Path Node, no child handle is created by this driver. @@ -123,10 +123,10 @@ EFI_STATUS /** Stops a device controller or a bus controller. - - The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). - As a result, much of the error checking on the parameters to Stop() has been moved - into this common boot service. It is legal to call Stop() from other locations, + + The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). + As a result, much of the error checking on the parameters to Stop() has been moved + into this common boot service. It is legal to call Stop() from other locations, but the following calling restrictions must be followed, or the system behavior will not be deterministic. 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this same driver's Start() function. @@ -134,13 +134,13 @@ EFI_STATUS EFI_HANDLE. In addition, all of these handles must have been created in this driver's Start() function, and the Start() function must have called OpenProtocol() on ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER. - + @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. - @param[in] ControllerHandle A handle to the device being stopped. The handle must - support a bus specific I/O protocol for the driver + @param[in] ControllerHandle A handle to the device being stopped. The handle must + support a bus specific I/O protocol for the driver to use to stop the device. @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer. - @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL + @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL if NumberOfChildren is 0. @retval EFI_SUCCESS The device was stopped. @@ -157,14 +157,14 @@ EFI_STATUS ); /// -/// This protocol provides the services required to determine if a driver supports a given controller. +/// This protocol provides the services required to determine if a driver supports a given controller. /// If a controller is supported, then it also provides routines to start and stop the controller. /// struct _EFI_DRIVER_BINDING_PROTOCOL { EFI_DRIVER_BINDING_SUPPORTED Supported; EFI_DRIVER_BINDING_START Start; EFI_DRIVER_BINDING_STOP Stop; - + /// /// The version number of the UEFI driver that produced the /// EFI_DRIVER_BINDING_PROTOCOL. This field is used by @@ -178,20 +178,20 @@ struct _EFI_DRIVER_BINDING_PROTOCOL { /// 0xffffffef are reserved for IHV-developed drivers. /// UINT32 Version; - + /// /// The image handle of the UEFI driver that produced this instance /// of the EFI_DRIVER_BINDING_PROTOCOL. /// EFI_HANDLE ImageHandle; - + /// /// The handle on which this instance of the /// EFI_DRIVER_BINDING_PROTOCOL is installed. In most /// cases, this is the same handle as ImageHandle. However, for /// UEFI drivers that produce more than one instance of the /// EFI_DRIVER_BINDING_PROTOCOL, this value may not be - /// the same as ImageHandle. + /// the same as ImageHandle. /// EFI_HANDLE DriverBindingHandle; }; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverConfiguration.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverConfiguration.h index 53c5296720..a395bf9a53 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverConfiguration.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverConfiguration.h @@ -2,13 +2,13 @@ EFI Driver Configuration Protocol Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -24,11 +24,11 @@ { \ 0x107a772b, 0xd5e1, 0x11d4, {0x9a, 0x46, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \ } - + typedef struct _EFI_DRIVER_CONFIGURATION_PROTOCOL EFI_DRIVER_CONFIGURATION_PROTOCOL; /** - Allows the user to set controller specific options for a controller that a + Allows the user to set controller specific options for a controller that a driver is currently managing. @param This A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL instance. @@ -154,9 +154,9 @@ struct _EFI_DRIVER_CONFIGURATION_PROTOCOL { EFI_DRIVER_CONFIGURATION_OPTIONS_VALID OptionsValid; EFI_DRIVER_CONFIGURATION_FORCE_DEFAULTS ForceDefaults; /// - /// A Null-terminated ASCII string that contains one or more - /// ISO 639-2 language codes. This is the list of language - /// codes that this protocol supports. + /// A Null-terminated ASCII string that contains one or more + /// ISO 639-2 language codes. This is the list of language + /// codes that this protocol supports. /// CHAR8 *SupportedLanguages; }; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverConfiguration2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverConfiguration2.h index 1610eb4741..095b6e7735 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverConfiguration2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverConfiguration2.h @@ -2,13 +2,13 @@ UEFI Driver Configuration2 Protocol Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -22,7 +22,7 @@ { \ 0xbfd7dc1d, 0x24f1, 0x40d9, {0x82, 0xe7, 0x2e, 0x09, 0xbb, 0x6b, 0x4e, 0xbe } \ } - + typedef struct _EFI_DRIVER_CONFIGURATION2_PROTOCOL EFI_DRIVER_CONFIGURATION2_PROTOCOL; typedef enum { @@ -55,7 +55,7 @@ typedef enum { #define EFI_DRIVER_CONFIGURATION_PERORMANCE_DEFAULTS 0x00000003 /** - Allows the user to set controller specific options for a controller that a + Allows the user to set controller specific options for a controller that a driver is currently managing. @param This A pointer to the EFI_DRIVER_CONFIGURATION2_PROTOCOL instance. @@ -180,7 +180,7 @@ struct _EFI_DRIVER_CONFIGURATION2_PROTOCOL { EFI_DRIVER_CONFIGURATION2_FORCE_DEFAULTS ForceDefaults; /// /// A Null-terminated ASCII string that contains one or more RFC 4646 - /// language codes. This is the list of language codes that this protocol supports. + /// language codes. This is the list of language codes that this protocol supports. /// CHAR8 *SupportedLanguages; }; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverDiagnostics.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverDiagnostics.h index 431b649223..6335654b83 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverDiagnostics.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverDiagnostics.h @@ -2,13 +2,13 @@ EFI Driver Diagnostics Protocol Copyright (c) 2006 - 2013, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -41,7 +41,7 @@ typedef enum { /// EfiDriverDiagnosticTypeManufacturing= 2, /// - /// This is an optional diagnostic type that would only be used in the situation where an + /// This is an optional diagnostic type that would only be used in the situation where an /// EFI_NOT_READY had been returned by a previous call to RunDiagnostics() /// and there is a desire to cancel the current running diagnostics operation. /// @@ -121,8 +121,8 @@ struct _EFI_DRIVER_DIAGNOSTICS_PROTOCOL { EFI_DRIVER_DIAGNOSTICS_RUN_DIAGNOSTICS RunDiagnostics; /// /// A Null-terminated ASCII string that contains one or more ISO 639-2 - /// language codes. This is the list of language codes that this protocol supports. - /// + /// language codes. This is the list of language codes that this protocol supports. + /// CHAR8 *SupportedLanguages; }; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverDiagnostics2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverDiagnostics2.h index 78d5ec6fe9..c54b7e7a16 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverDiagnostics2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverDiagnostics2.h @@ -2,13 +2,13 @@ UEFI Driver Diagnostics2 Protocol Copyright (c) 2006 - 2011, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -21,7 +21,7 @@ { \ 0x4d330321, 0x025f, 0x4aac, {0x90, 0xd8, 0x5e, 0xd9, 0x00, 0x17, 0x3b, 0x63 } \ } - + typedef struct _EFI_DRIVER_DIAGNOSTICS2_PROTOCOL EFI_DRIVER_DIAGNOSTICS2_PROTOCOL; /** @@ -31,7 +31,7 @@ typedef struct _EFI_DRIVER_DIAGNOSTICS2_PROTOCOL EFI_DRIVER_DIAGNOSTICS2_PROTOC @param ControllerHandle The handle of the controller to run diagnostics on. @param ChildHandle The handle of the child controller to run diagnostics on This is an optional parameter that may be NULL. It will - be NULL for device drivers. It will also be NULL for + be NULL for device drivers. It will also be NULL for bus drivers that wish to run diagnostics on the bus controller. It will not be NULL for a bus driver that wishes to run diagnostics on one of its child controllers. @@ -101,8 +101,8 @@ struct _EFI_DRIVER_DIAGNOSTICS2_PROTOCOL { EFI_DRIVER_DIAGNOSTICS2_RUN_DIAGNOSTICS RunDiagnostics; /// /// A Null-terminated ASCII string that contains one or more RFC 4646 - /// language codes. This is the list of language codes that this protocol supports. - /// + /// language codes. This is the list of language codes that this protocol supports. + /// CHAR8 *SupportedLanguages; }; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverFamilyOverride.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverFamilyOverride.h index 868c773411..e6f8599e5f 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverFamilyOverride.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverFamilyOverride.h @@ -2,13 +2,13 @@ UEFI Driver Family Protocol Copyright (c) 2007 - 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -19,14 +19,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. { \ 0xb1ee129e, 0xda36, 0x4181, { 0x91, 0xf8, 0x4, 0xa4, 0x92, 0x37, 0x66, 0xa7 } \ } - + typedef struct _EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL; // // Prototypes for the Driver Family Override Protocol // -// -/** +// +/** This function returns the version value associated with the driver specified by This. Retrieves the version of the driver that is used by the EFI Boot Service ConnectController() @@ -35,10 +35,10 @@ typedef struct _EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL EFI_DRIVER_FAMILY_OVERRIDE_ the drivers with higher values returned by GetVersion() are higher priority than drivers that return lower values from GetVersion(). - @param This A pointer to the EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL instance. - - @return The version value associated with the driver specified by This. - + @param This A pointer to the EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL instance. + + @return The version value associated with the driver specified by This. + **/ typedef UINT32 @@ -47,15 +47,15 @@ UINT32 ); /// -/// When installed, the Driver Family Override Protocol produces a GUID that represents -/// a family of drivers. Drivers with the same GUID are members of the same family -/// When drivers are connected to controllers, drivers with a higher revision value -/// in the same driver family are connected with a higher priority than drivers +/// When installed, the Driver Family Override Protocol produces a GUID that represents +/// a family of drivers. Drivers with the same GUID are members of the same family +/// When drivers are connected to controllers, drivers with a higher revision value +/// in the same driver family are connected with a higher priority than drivers /// with a lower revision value in the same driver family. The EFI Boot Service -/// Connect Controller uses five rules to build a prioritized list of drivers when +/// Connect Controller uses five rules to build a prioritized list of drivers when /// a request is made to connect a driver to a controller. The Driver Family Protocol -/// rule is between the Platform Specific Driver Override Protocol and above the -/// Bus Specific Driver Override Protocol. +/// rule is between the Platform Specific Driver Override Protocol and above the +/// Bus Specific Driver Override Protocol. /// struct _EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL { EFI_DRIVER_FAMILY_OVERRIDE_GET_VERSION GetVersion; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverHealth.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverHealth.h index d23140d20b..3f12ab10d1 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverHealth.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverHealth.h @@ -5,33 +5,33 @@ the health status for a controller to be retrieved. If a controller is not in a usable state, status messages may be reported to the user, repair operations can be invoked, and the user may be asked to make software and/or hardware configuration changes. - - The Driver Health Protocol is optionally produced by a driver that follows the - EFI Driver Model. If an EFI Driver needs to report health status to the platform, - provide warning or error messages to the user, perform length repair operations, - or request the user to make hardware or software configuration changes, then the + + The Driver Health Protocol is optionally produced by a driver that follows the + EFI Driver Model. If an EFI Driver needs to report health status to the platform, + provide warning or error messages to the user, perform length repair operations, + or request the user to make hardware or software configuration changes, then the Driver Health Protocol must be produced. - - A controller that is managed by driver that follows the EFI Driver Model and - produces the Driver Health Protocol must report the current health of the - controllers that the driver is currently managing. The controller can initially - be healthy, failed, require repair, or require configuration. If a controller - requires configuration, and the user make configuration changes, the controller - may then need to be reconnected or the system may need to be rebooted for the - configuration changes to take affect. + + A controller that is managed by driver that follows the EFI Driver Model and + produces the Driver Health Protocol must report the current health of the + controllers that the driver is currently managing. The controller can initially + be healthy, failed, require repair, or require configuration. If a controller + requires configuration, and the user make configuration changes, the controller + may then need to be reconnected or the system may need to be rebooted for the + configuration changes to take affect. Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved.<BR> - Copyright (c) 2014, Hewlett-Packard Development Company, L.P.<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 + Copyright (c) 2014, Hewlett-Packard Development Company, L.P.<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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: - This Protocol is defined in UEFI Specification 2.3d + This Protocol is defined in UEFI Specification 2.3d **/ @@ -42,7 +42,7 @@ { \ 0x2a534210, 0x9280, 0x41d8, { 0xae, 0x79, 0xca, 0xda, 0x1, 0xa2, 0xb1, 0x27 } \ } - + typedef struct _EFI_DRIVER_HEALTH_PROTOCOL EFI_DRIVER_HEALTH_PROTOCOL; /// @@ -63,12 +63,12 @@ typedef enum { typedef struct { EFI_HII_HANDLE HiiHandle; EFI_STRING_ID StringId; - + /// - /// 64-bit numeric value of the warning/error specified by this message. - /// A value of 0x0000000000000000 is used to indicate that MessageCode is not specified. + /// 64-bit numeric value of the warning/error specified by this message. + /// A value of 0x0000000000000000 is used to indicate that MessageCode is not specified. /// The values 0x0000000000000001 to 0x0fffffffffffffff are reserved for allocation by the UEFI Specification. - /// The values 0x1000000000000000 to 0x1fffffffffffffff are reserved for IHV-developed drivers. + /// The values 0x1000000000000000 to 0x1fffffffffffffff are reserved for IHV-developed drivers. /// The values 0x8000000000000000 to 0x8fffffffffffffff is reserved for platform/OEM drivers. /// All other values are reserved and should not be used. /// @@ -78,11 +78,11 @@ typedef struct { /** Reports the progress of a repair operation - @param[in] Value A value between 0 and Limit that identifies the current + @param[in] Value A value between 0 and Limit that identifies the current progress of the repair operation. - + @param[in] Limit The maximum value of Value for the current repair operation. - For example, a driver that wants to specify progress in + For example, a driver that wants to specify progress in percent would use a Limit value of 100. **/ typedef @@ -93,88 +93,88 @@ EFI_STATUS ); /** - Retrieves the health status of a controller in the platform. This function can also - optionally return warning messages, error messages, and a set of HII Forms that may - be repair a controller that is not proper configured. - + Retrieves the health status of a controller in the platform. This function can also + optionally return warning messages, error messages, and a set of HII Forms that may + be repair a controller that is not proper configured. + @param[in] This A pointer to the EFI_DRIVER_HEALTH_PROTOCOL instance. - @param[in] ControllerHandle The handle of the controller to retrieve the health status - on. This is an optional parameter that may be NULL. If - this parameter is NULL, then the value of ChildHandle is - ignored, and the combined health status of all the devices + @param[in] ControllerHandle The handle of the controller to retrieve the health status + on. This is an optional parameter that may be NULL. If + this parameter is NULL, then the value of ChildHandle is + ignored, and the combined health status of all the devices that the driver is managing is returned. - @param[in] ChildHandle The handle of the child controller to retrieve the health - status on. This is an optional parameter that may be NULL. - This parameter is ignored of ControllerHandle is NULL. It - will be NULL for device drivers. It will also be NULL for - bus drivers when an attempt is made to collect the health - status of the bus controller. If will not be NULL when an - attempt is made to collect the health status for a child + @param[in] ChildHandle The handle of the child controller to retrieve the health + status on. This is an optional parameter that may be NULL. + This parameter is ignored of ControllerHandle is NULL. It + will be NULL for device drivers. It will also be NULL for + bus drivers when an attempt is made to collect the health + status of the bus controller. If will not be NULL when an + attempt is made to collect the health status for a child controller produced by the driver. - @param[out] HealthStatus A pointer to the health status that is returned by this - function. This is an optional parameter that may be NULL. - This parameter is ignored of ControllerHandle is NULL. - The health status for the controller specified by - ControllerHandle and ChildHandle is returned. - - @param[out] MessageList A pointer to an array of warning or error messages associated - with the controller specified by ControllerHandle and - ChildHandle. This is an optional parameter that may be NULL. - MessageList is allocated by this function with the EFI Boot - Service AllocatePool(), and it is the caller's responsibility - to free MessageList with the EFI Boot Service FreePool(). - Each message is specified by tuple of an EFI_HII_HANDLE and - an EFI_STRING_ID. The array of messages is terminated by tuple - containing a EFI_HII_HANDLE with a value of NULL. The - EFI_HII_STRING_PROTOCOL.GetString() function can be used to - retrieve the warning or error message as a Null-terminated - string in a specific language. Messages may be - returned for any of the HealthStatus values except - EfiDriverHealthStatusReconnectRequired and + @param[out] HealthStatus A pointer to the health status that is returned by this + function. This is an optional parameter that may be NULL. + This parameter is ignored of ControllerHandle is NULL. + The health status for the controller specified by + ControllerHandle and ChildHandle is returned. + + @param[out] MessageList A pointer to an array of warning or error messages associated + with the controller specified by ControllerHandle and + ChildHandle. This is an optional parameter that may be NULL. + MessageList is allocated by this function with the EFI Boot + Service AllocatePool(), and it is the caller's responsibility + to free MessageList with the EFI Boot Service FreePool(). + Each message is specified by tuple of an EFI_HII_HANDLE and + an EFI_STRING_ID. The array of messages is terminated by tuple + containing a EFI_HII_HANDLE with a value of NULL. The + EFI_HII_STRING_PROTOCOL.GetString() function can be used to + retrieve the warning or error message as a Null-terminated + string in a specific language. Messages may be + returned for any of the HealthStatus values except + EfiDriverHealthStatusReconnectRequired and EfiDriverHealthStatusRebootRequired. - @param[out] FormHiiHandle A pointer to the HII handle containing the HII form used when - configuration is required. The HII handle is associated with + @param[out] FormHiiHandle A pointer to the HII handle containing the HII form used when + configuration is required. The HII handle is associated with the controller specified by ControllerHandle and ChildHandle. If this is NULL, then no HII form is available. An HII handle - will only be returned with a HealthStatus value of + will only be returned with a HealthStatus value of EfiDriverHealthStatusConfigurationRequired. - @retval EFI_SUCCESS ControllerHandle is NULL, and all the controllers - managed by this driver specified by This have a health - status of EfiDriverHealthStatusHealthy with no warning - messages to be returned. The ChildHandle, HealthStatus, + @retval EFI_SUCCESS ControllerHandle is NULL, and all the controllers + managed by this driver specified by This have a health + status of EfiDriverHealthStatusHealthy with no warning + messages to be returned. The ChildHandle, HealthStatus, MessageList, and FormList parameters are ignored. - @retval EFI_DEVICE_ERROR ControllerHandle is NULL, and one or more of the - controllers managed by this driver specified by This - do not have a health status of EfiDriverHealthStatusHealthy. - The ChildHandle, HealthStatus, MessageList, and + @retval EFI_DEVICE_ERROR ControllerHandle is NULL, and one or more of the + controllers managed by this driver specified by This + do not have a health status of EfiDriverHealthStatusHealthy. + The ChildHandle, HealthStatus, MessageList, and FormList parameters are ignored. - @retval EFI_DEVICE_ERROR ControllerHandle is NULL, and one or more of the - controllers managed by this driver specified by This - have one or more warning and/or error messages. - The ChildHandle, HealthStatus, MessageList, and + @retval EFI_DEVICE_ERROR ControllerHandle is NULL, and one or more of the + controllers managed by this driver specified by This + have one or more warning and/or error messages. + The ChildHandle, HealthStatus, MessageList, and FormList parameters are ignored. - @retval EFI_SUCCESS ControllerHandle is not NULL and the health status - of the controller specified by ControllerHandle and - ChildHandle was returned in HealthStatus. A list - of warning and error messages may be optionally - returned in MessageList, and a list of HII Forms + @retval EFI_SUCCESS ControllerHandle is not NULL and the health status + of the controller specified by ControllerHandle and + ChildHandle was returned in HealthStatus. A list + of warning and error messages may be optionally + returned in MessageList, and a list of HII Forms may be optionally returned in FormList. - @retval EFI_UNSUPPORTED ControllerHandle is not NULL, and the controller - specified by ControllerHandle and ChildHandle is not + @retval EFI_UNSUPPORTED ControllerHandle is not NULL, and the controller + specified by ControllerHandle and ChildHandle is not currently being managed by the driver specified by This. @retval EFI_INVALID_PARAMETER HealthStatus is NULL. - @retval EFI_OUT_OF_RESOURCES MessageList is not NULL, and there are not enough + @retval EFI_OUT_OF_RESOURCES MessageList is not NULL, and there are not enough resource available to allocate memory for MessageList. **/ @@ -190,30 +190,30 @@ EFI_STATUS ); /** - Performs a repair operation on a controller in the platform. This function can - optionally report repair progress information back to the platform. - + Performs a repair operation on a controller in the platform. This function can + optionally report repair progress information back to the platform. + @param[in] This A pointer to the EFI_DRIVER_HEALTH_PROTOCOL instance. @param[in] ControllerHandle The handle of the controller to repair. - @param[in] ChildHandle The handle of the child controller to repair. This is - an optional parameter that may be NULL. It will be NULL - for device drivers. It will also be NULL for bus + @param[in] ChildHandle The handle of the child controller to repair. This is + an optional parameter that may be NULL. It will be NULL + for device drivers. It will also be NULL for bus drivers when an attempt is made to repair a bus controller. - If will not be NULL when an attempt is made to repair a + If will not be NULL when an attempt is made to repair a child controller produced by the driver. - @param[in] RepairNotify A notification function that may be used by a driver to - report the progress of the repair operation. This is - an optional parameter that may be NULL. + @param[in] RepairNotify A notification function that may be used by a driver to + report the progress of the repair operation. This is + an optional parameter that may be NULL. - @retval EFI_SUCCESS An attempt to repair the controller specified by - ControllerHandle and ChildHandle was performed. - The result of the repair operation can bet + @retval EFI_SUCCESS An attempt to repair the controller specified by + ControllerHandle and ChildHandle was performed. + The result of the repair operation can bet determined by calling GetHealthStatus(). - @retval EFI_UNSUPPORTED The driver specified by This is not currently - managing the controller specified by ControllerHandle + @retval EFI_UNSUPPORTED The driver specified by This is not currently + managing the controller specified by ControllerHandle and ChildHandle. - @retval EFI_OUT_OF_RESOURCES There are not enough resources to perform the + @retval EFI_OUT_OF_RESOURCES There are not enough resources to perform the repair operation. */ @@ -228,10 +228,10 @@ EFI_STATUS /// /// When installed, the Driver Health Protocol produces a collection of services -/// that allow the health status for a controller to be retrieved. If a controller -/// is not in a usable state, status messages may be reported to the user, repair -/// operations can be invoked, and the user may be asked to make software and/or -/// hardware configuration changes. +/// that allow the health status for a controller to be retrieved. If a controller +/// is not in a usable state, status messages may be reported to the user, repair +/// operations can be invoked, and the user may be asked to make software and/or +/// hardware configuration changes. /// struct _EFI_DRIVER_HEALTH_PROTOCOL { EFI_DRIVER_HEALTH_GET_HEALTH_STATUS GetHealthStatus; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverSupportedEfiVersion.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverSupportedEfiVersion.h index 2689ddd7f9..31ce0577ad 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverSupportedEfiVersion.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/DriverSupportedEfiVersion.h @@ -5,13 +5,13 @@ cards. Copyright (c) 2006 - 2015, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -24,16 +24,16 @@ /// /// The EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL provides a -/// mechanism for an EFI driver to publish the version of the EFI -/// specification it conforms to. This protocol must be placed on -/// the driver's image handle when the driver's entry point is +/// mechanism for an EFI driver to publish the version of the EFI +/// specification it conforms to. This protocol must be placed on +/// the driver's image handle when the driver's entry point is /// called. /// typedef struct _EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL { /// - /// The size, in bytes, of the entire structure. Future versions of this + /// The size, in bytes, of the entire structure. Future versions of this /// specification may grow the size of the structure. - /// + /// UINT32 Length; /// /// The latest version of the UEFI specification that this driver conforms to. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Eap.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Eap.h index e91deb8670..41bee5b486 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Eap.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Eap.h @@ -1,7 +1,7 @@ /** @file EFI EAP(Extended Authenticaton Protocol) Protocol Definition The EFI EAP Protocol is used to abstract the ability to configure and extend the - EAP framework. + EAP framework. The definitions in this file are defined in UEFI Specification 2.3.1B, which have not been verified by one implementation yet. @@ -14,7 +14,7 @@ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - @par Revision Reference: + @par Revision Reference: This Protocol is introduced in UEFI Specification 2.2 **/ @@ -31,7 +31,7 @@ typedef struct _EFI_EAP_PROTOCOL EFI_EAP_PROTOCOL; /// -/// Type for the identification number assigned to the Port by the +/// Type for the identification number assigned to the Port by the /// System in which the Port resides. /// typedef VOID * EFI_PORT_HANDLE; @@ -61,7 +61,7 @@ typedef VOID * EFI_PORT_HANDLE; @param[in] RequestSize Packet size in bytes for the most recently received EAP-Request packet. @param[in] Buffer Pointer to the buffer to hold the built packet. - @param[in, out] BufferSize Pointer to the buffer size in bytes. + @param[in, out] BufferSize Pointer to the buffer size in bytes. On input, it is the buffer size provided by the caller. On output, it is the buffer size in fact needed to contain the packet. @@ -74,32 +74,32 @@ typedef EFI_STATUS (EFIAPI *EFI_EAP_BUILD_RESPONSE_PACKET)( IN EFI_PORT_HANDLE PortNumber, - IN UINT8 *RequestBuffer, - IN UINTN RequestSize, - IN UINT8 *Buffer, + IN UINT8 *RequestBuffer, + IN UINTN RequestSize, + IN UINT8 *Buffer, IN OUT UINTN *BufferSize ); /** Set the desired EAP authentication method for the Port. - The SetDesiredAuthMethod() function sets the desired EAP authentication method indicated + The SetDesiredAuthMethod() function sets the desired EAP authentication method indicated by EapAuthType for the Port. - - If EapAuthType is an invalid EAP authentication type, then EFI_INVALID_PARAMETER is + + If EapAuthType is an invalid EAP authentication type, then EFI_INVALID_PARAMETER is returned. If the EAP authentication method of EapAuthType is unsupported by the Ports, then it will return EFI_UNSUPPORTED. - The cryptographic strength of EFI_EAP_TYPE_TLS shall be at least of hash strength + The cryptographic strength of EFI_EAP_TYPE_TLS shall be at least of hash strength SHA-256 and RSA key length of at least 2048 bits. - - @param[in] This A pointer to the EFI_EAP_PROTOCOL instance that indicates + + @param[in] This A pointer to the EFI_EAP_PROTOCOL instance that indicates the calling context. - @param[in] EapAuthType The type of the EAP authentication method to register. It should + @param[in] EapAuthType The type of the EAP authentication method to register. It should be the type value defined by RFC. See RFC 2284 for details. @param[in] Handler The handler of the EAP authentication method to register. - @retval EFI_SUCCESS The EAP authentication method of EapAuthType is + @retval EFI_SUCCESS The EAP authentication method of EapAuthType is registered successfully. @retval EFI_INVALID_PARAMETER EapAuthType is an invalid EAP authentication type. @retval EFI_UNSUPPORTED The EAP authentication method of EapAuthType is @@ -109,28 +109,28 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_EAP_SET_DESIRED_AUTHENTICATION_METHOD)( - IN EFI_EAP_PROTOCOL *This, + IN EFI_EAP_PROTOCOL *This, IN UINT8 EapAuthType ); /** - Register an EAP authentication method. + Register an EAP authentication method. + + The RegisterAuthMethod() function registers the user provided EAP authentication method, + the type of which is EapAuthType and the handler of which is Handler. - The RegisterAuthMethod() function registers the user provided EAP authentication method, - the type of which is EapAuthType and the handler of which is Handler. - - If EapAuthType is an invalid EAP authentication type, then EFI_INVALID_PARAMETER is + If EapAuthType is an invalid EAP authentication type, then EFI_INVALID_PARAMETER is returned. - If there is not enough system memory to perform the registration, then + If there is not enough system memory to perform the registration, then EFI_OUT_OF_RESOURCES is returned. - @param[in] This A pointer to the EFI_EAP_PROTOCOL instance that indicates + @param[in] This A pointer to the EFI_EAP_PROTOCOL instance that indicates the calling context. - @param[in] EapAuthType The type of the EAP authentication method to register. It should + @param[in] EapAuthType The type of the EAP authentication method to register. It should be the type value defined by RFC. See RFC 2284 for details. @param[in] Handler The handler of the EAP authentication method to register. - @retval EFI_SUCCESS The EAP authentication method of EapAuthType is + @retval EFI_SUCCESS The EAP authentication method of EapAuthType is registered successfully. @retval EFI_INVALID_PARAMETER EapAuthType is an invalid EAP authentication type. @retval EFI_OUT_OF_RESOURCES There is not enough system memory to perform the registration. @@ -139,17 +139,17 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_EAP_REGISTER_AUTHENTICATION_METHOD)( - IN EFI_EAP_PROTOCOL *This, - IN UINT8 EapAuthType, + IN EFI_EAP_PROTOCOL *This, + IN UINT8 EapAuthType, IN EFI_EAP_BUILD_RESPONSE_PACKET Handler ); /// -/// EFI_EAP_PROTOCOL -/// is used to configure the desired EAP authentication method for the EAP +/// EFI_EAP_PROTOCOL +/// is used to configure the desired EAP authentication method for the EAP /// framework and extend the EAP framework by registering new EAP authentication /// method on a Port. The EAP framework is built on a per-Port basis. Herein, a -/// Port means a NIC. For the details of EAP protocol, please refer to RFC 2284. +/// Port means a NIC. For the details of EAP protocol, please refer to RFC 2284. /// struct _EFI_EAP_PROTOCOL { EFI_EAP_SET_DESIRED_AUTHENTICATION_METHOD SetDesiredAuthMethod; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/EapManagement.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/EapManagement.h index 8fe4afb2a1..8cb5e9b0aa 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/EapManagement.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/EapManagement.h @@ -1,8 +1,8 @@ /** @file EFI EAP Management Protocol Definition The EFI EAP Management Protocol is designed to provide ease of management and - ease of test for EAPOL state machine. It is intended for the supplicant side. - It conforms to IEEE 802.1x specification. + ease of test for EAPOL state machine. It is intended for the supplicant side. + It conforms to IEEE 802.1x specification. The definitions in this file are defined in UEFI Specification 2.2, which have not been verified by one implementation yet. @@ -15,7 +15,7 @@ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - @par Revision Reference: + @par Revision Reference: This Protocol is introduced in UEFI Specification 2.2 **/ @@ -43,22 +43,22 @@ typedef struct _EFI_EAP_MANAGEMENT_PROTOCOL EFI_EAP_MANAGEMENT_PROTOCOL; /// /// EFI_EAPOL_PORT_INFO /// -typedef struct _EFI_EAPOL_PORT_INFO { - /// - /// The identification number assigned to the Port by the System in +typedef struct _EFI_EAPOL_PORT_INFO { + /// + /// The identification number assigned to the Port by the System in /// which the Port resides. - /// + /// EFI_PORT_HANDLE PortNumber; - /// - /// The protocol version number of the EAPOL implementation - /// supported by the Port. - /// + /// + /// The protocol version number of the EAPOL implementation + /// supported by the Port. + /// UINT8 ProtocolVersion; - /// - /// The capabilities of the PAE associated with the Port. This field - /// indicates whether Authenticator functionality, Supplicant + /// + /// The capabilities of the PAE associated with the Port. This field + /// indicates whether Authenticator functionality, Supplicant /// functionality, both, or neither, is supported by the Port's PAE. - /// + /// UINT8 PaeCapabilities; } EFI_EAPOL_PORT_INFO; @@ -77,7 +77,7 @@ typedef enum _EFI_EAPOL_SUPPLICANT_PAE_STATE { } EFI_EAPOL_SUPPLICANT_PAE_STATE; /// -/// Definitions for ValidFieldMask +/// Definitions for ValidFieldMask /// ///@{ #define AUTH_PERIOD_FIELD_VALID 0x01 @@ -90,27 +90,27 @@ typedef enum _EFI_EAPOL_SUPPLICANT_PAE_STATE { /// EFI_EAPOL_SUPPLICANT_PAE_CONFIGURATION /// typedef struct _EFI_EAPOL_SUPPLICANT_PAE_CONFIGURATION { - /// + /// /// Indicates which of the following fields are valid. - /// - UINT8 ValidFieldMask; + /// + UINT8 ValidFieldMask; /// /// The initial value for the authWhile timer. Its default value is 30s. /// - UINTN AuthPeriod; + UINTN AuthPeriod; + /// + /// The initial value for the heldWhile timer. Its default value is 60s. /// - /// The initial value for the heldWhile timer. Its default value is 60s. + UINTN HeldPeriod; /// - UINTN HeldPeriod; + /// The initial value for the startWhen timer. Its default value is 30s. /// - /// The initial value for the startWhen timer. Its default value is 30s. + UINTN StartPeriod; /// - UINTN StartPeriod; - /// - /// The maximum number of successive EAPOL-Start messages will - /// be sent before the Supplicant assumes that there is no + /// The maximum number of successive EAPOL-Start messages will + /// be sent before the Supplicant assumes that there is no /// Authenticator present. Its default value is 3. - /// + /// UINTN MaxStart; } EFI_EAPOL_SUPPLICANT_PAE_CONFIGURATION; @@ -120,17 +120,17 @@ typedef struct _EFI_EAPOL_SUPPLICANT_PAE_CONFIGURATION { typedef struct _EFI_EAPOL_SUPPLICANT_PAE_STATISTICS { /// /// The number of EAPOL frames of any type that have been received by this Supplican. - /// + /// UINTN EapolFramesReceived; /// - /// The number of EAPOL frames of any type that have been transmitted by this Supplicant. + /// The number of EAPOL frames of any type that have been transmitted by this Supplicant. /// UINTN EapolFramesTransmitted; - /// - /// The number of EAPOL Start frames that have been transmitted by this Supplicant. - /// + /// + /// The number of EAPOL Start frames that have been transmitted by this Supplicant. + /// UINTN EapolStartFramesTransmitted; - /// + /// /// The number of EAPOL Logoff frames that have been transmitted by this Supplicant. /// UINTN EapolLogoffFramesTransmitted; @@ -138,48 +138,48 @@ typedef struct _EFI_EAPOL_SUPPLICANT_PAE_STATISTICS { /// The number of EAP Resp/Id frames that have been transmitted by this Supplicant. /// UINTN EapRespIdFramesTransmitted; - /// - /// The number of valid EAP Response frames (other than Resp/Id frames) that have been + /// + /// The number of valid EAP Response frames (other than Resp/Id frames) that have been /// transmitted by this Supplicant. /// UINTN EapResponseFramesTransmitted; - /// + /// /// The number of EAP Req/Id frames that have been received by this Supplicant. - /// + /// UINTN EapReqIdFramesReceived; /// - /// The number of EAP Request frames (other than Rq/Id frames) that have been received + /// The number of EAP Request frames (other than Rq/Id frames) that have been received /// by this Supplicant. /// UINTN EapRequestFramesReceived; /// - /// The number of EAPOL frames that have been received by this Supplicant in which the + /// The number of EAPOL frames that have been received by this Supplicant in which the /// frame type is not recognized. /// UINTN InvalidEapolFramesReceived; - /// - /// The number of EAPOL frames that have been received by this Supplicant in which the + /// + /// The number of EAPOL frames that have been received by this Supplicant in which the /// Packet Body Length field (7.5.5) is invalid. - /// + /// UINTN EapLengthErrorFramesReceived; - /// + /// /// The protocol version number carried in the most recently received EAPOL frame. - /// + /// UINTN LastEapolFrameVersion; - /// + /// /// The source MAC address carried in the most recently received EAPOL frame. - /// + /// UINTN LastEapolFrameSource; } EFI_EAPOL_SUPPLICANT_PAE_STATISTICS; /** - Read the system configuration information associated with the Port. + Read the system configuration information associated with the Port. The GetSystemConfiguration() function reads the system configuration - information associated with the Port, including the value of the + information associated with the Port, including the value of the SystemAuthControl parameter of the System is returned in SystemAuthControl and the Port's information is returned in the buffer pointed to by PortInfo. - The Port's information is optional. + The Port's information is optional. If PortInfo is NULL, then reading the Port's information is ignored. If SystemAuthControl is NULL, then EFI_INVALID_PARAMETER is returned. @@ -187,7 +187,7 @@ typedef struct _EFI_EAPOL_SUPPLICANT_PAE_STATISTICS { @param[in] This A pointer to the EFI_EAP_MANAGEMENT_PROTOCOL instance that indicates the calling context. @param[out] SystemAuthControl Returns the value of the SystemAuthControl - parameter of the System. + parameter of the System. TRUE means Enabled. FALSE means Disabled. @param[out] PortInfo Returns EFI_EAPOL_PORT_INFO structure to describe the Port's information. This parameter can be NULL @@ -202,21 +202,21 @@ typedef struct _EFI_EAPOL_SUPPLICANT_PAE_STATISTICS { typedef EFI_STATUS (EFIAPI *EFI_EAP_GET_SYSTEM_CONFIGURATION)( - IN EFI_EAP_MANAGEMENT_PROTOCOL *This, - OUT BOOLEAN *SystemAuthControl, + IN EFI_EAP_MANAGEMENT_PROTOCOL *This, + OUT BOOLEAN *SystemAuthControl, OUT EFI_EAPOL_PORT_INFO *PortInfo OPTIONAL ); /** - Set the system configuration information associated with the Port. + Set the system configuration information associated with the Port. - The SetSystemConfiguration() function sets the value of the SystemAuthControl + The SetSystemConfiguration() function sets the value of the SystemAuthControl parameter of the System to SystemAuthControl. @param[in] This A pointer to the EFI_EAP_MANAGEMENT_PROTOCOL instance that indicates the calling context. - @param[in] SystemAuthControl The desired value of the SystemAuthControl - parameter of the System. + @param[in] SystemAuthControl The desired value of the SystemAuthControl + parameter of the System. TRUE means Enabled. FALSE means Disabled. @retval EFI_SUCCESS The system configuration information of the @@ -226,7 +226,7 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_EAP_SET_SYSTEM_CONFIGURATION)( - IN EFI_EAP_MANAGEMENT_PROTOCOL *This, + IN EFI_EAP_MANAGEMENT_PROTOCOL *This, IN BOOLEAN SystemAuthControl ); @@ -266,7 +266,7 @@ EFI_STATUS ); /** - Notify the EAPOL state machines for the Port that the user of the System has + Notify the EAPOL state machines for the Port that the user of the System has logged off. The UserLogoff() function notifies the EAPOL state machines for the Port. @@ -290,8 +290,8 @@ EFI_STATUS The GetSupplicantStatus() function reads the status of the Supplicant PAE state machine for the Port, including the current state CurrentState and the configuration of the operational parameters Configuration. The configuration of the operational - parameters is optional. If Configuration is NULL, then reading the configuration - is ignored. The operational parameters in Configuration to be read can also be + parameters is optional. If Configuration is NULL, then reading the configuration + is ignored. The operational parameters in Configuration to be read can also be specified by Configuration.ValidFieldMask. If CurrentState is NULL, then EFI_INVALID_PARAMETER is returned. @@ -303,11 +303,11 @@ EFI_STATUS @param[in, out] Configuration Returns the configuration of the operational parameters of the Supplicant PAE state machine for the Port as required. This parameter can be - NULL to ignore reading the configuration. - On input, Configuration.ValidFieldMask specifies the + NULL to ignore reading the configuration. + On input, Configuration.ValidFieldMask specifies the operational parameters to be read. On output, Configuration returns the configuration - of the required operational parameters. + of the required operational parameters. @retval EFI_SUCCESS The configuration of the operational parameter of the Supplicant PAE state machine for the Port @@ -318,16 +318,16 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_EAP_GET_SUPPLICANT_STATUS)( - IN EFI_EAP_MANAGEMENT_PROTOCOL *This, - OUT EFI_EAPOL_SUPPLICANT_PAE_STATE *CurrentState, + IN EFI_EAP_MANAGEMENT_PROTOCOL *This, + OUT EFI_EAPOL_SUPPLICANT_PAE_STATE *CurrentState, IN OUT EFI_EAPOL_SUPPLICANT_PAE_CONFIGURATION *Configuration OPTIONAL ); /** - Set the configuration of the operational parameter of the Supplicant PAE + Set the configuration of the operational parameter of the Supplicant PAE state machine for the Port. - The SetSupplicantConfiguration() function sets the configuration of the + The SetSupplicantConfiguration() function sets the configuration of the operational Parameter of the Supplicant PAE state machine for the Port to Configuration. The operational parameters in Configuration to be set can be specified by Configuration.ValidFieldMask. @@ -336,7 +336,7 @@ EFI_STATUS @param[in] This A pointer to the EFI_EAP_MANAGEMENT_PROTOCOL instance that indicates the calling context. - @param[in] Configuration The desired configuration of the operational + @param[in] Configuration The desired configuration of the operational parameters of the Supplicant PAE state machine for the Port as required. @@ -349,23 +349,23 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_EAP_SET_SUPPLICANT_CONFIGURATION)( - IN EFI_EAP_MANAGEMENT_PROTOCOL *This, + IN EFI_EAP_MANAGEMENT_PROTOCOL *This, IN EFI_EAPOL_SUPPLICANT_PAE_CONFIGURATION *Configuration ); /** Read the statistical information regarding the operation of the Supplicant - associated with the Port. + associated with the Port. - The GetSupplicantStatistics() function reads the statistical information + The GetSupplicantStatistics() function reads the statistical information Statistics regarding the operation of the Supplicant associated with the Port. - + If Statistics is NULL, then EFI_INVALID_PARAMETER is returned. @param[in] This A pointer to the EFI_EAP_MANAGEMENT_PROTOCOL instance that indicates the calling context. - @param[out] Statistics Returns the statistical information regarding the - operation of the Supplicant for the Port. + @param[out] Statistics Returns the statistical information regarding the + operation of the Supplicant for the Port. @retval EFI_SUCCESS The statistical information regarding the operation of the Supplicant for the Port is read successfully. @@ -375,15 +375,15 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_EAP_GET_SUPPLICANT_STATISTICS)( - IN EFI_EAP_MANAGEMENT_PROTOCOL *This, + IN EFI_EAP_MANAGEMENT_PROTOCOL *This, OUT EFI_EAPOL_SUPPLICANT_PAE_STATISTICS *Statistics ); /// -/// EFI_EAP_MANAGEMENT_PROTOCOL +/// EFI_EAP_MANAGEMENT_PROTOCOL /// is used to control, configure and monitor EAPOL state machine on /// a Port. EAPOL state machine is built on a per-Port basis. Herein, -/// a Port means a NIC. For the details of EAPOL, please refer to +/// a Port means a NIC. For the details of EAPOL, please refer to /// IEEE 802.1x specification. /// struct _EFI_EAP_MANAGEMENT_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ebc.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ebc.h index dd6320d61c..f63c2cd3e8 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ebc.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ebc.h @@ -2,13 +2,13 @@ Describes the protocol interface to the EBC interpreter. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -193,7 +193,7 @@ typedef struct _EFI_EBC_PROTOCOL EFI_EBC_PROTOCOL; /** Creates a thunk for an EBC entry point, returning the address of the thunk. - + A PE32+ EBC image, like any other PE32+ image, contains an optional header that specifies the entry point for image execution. However, for EBC images, this is the entry point of EBC instructions, so is not directly executable by the native processor. Therefore, when an EBC image is @@ -229,7 +229,7 @@ EFI_STATUS @param ImageHandle Image handle of the EBC image that is being unloaded from memory. @retval EFI_SUCCESS The function completed successfully. - @retval EFI_INVALID_PARAMETER Image handle is not recognized as belonging + @retval EFI_INVALID_PARAMETER Image handle is not recognized as belonging to an EBC image that has been executed. **/ typedef @@ -240,7 +240,7 @@ EFI_STATUS ); /** - This is the prototype for the Flush callback routine. A pointer to a routine + This is the prototype for the Flush callback routine. A pointer to a routine of this type is passed to the EBC EFI_EBC_REGISTER_ICACHE_FLUSH protocol service. @param Start The beginning physical address to flush from the processor's instruction cache. @@ -257,7 +257,7 @@ EFI_STATUS ); /** - Registers a callback function that the EBC interpreter calls to flush + Registers a callback function that the EBC interpreter calls to flush the processor instruction cache following creation of thunks. @param This A pointer to the EFI_EBC_PROTOCOL instance. @@ -279,7 +279,7 @@ EFI_STATUS This function is called to get the version of the loaded EBC interpreter. The value and format of the returned version is identical to that returned by the EBC BREAK 1 instruction. - @param This A pointer to the EFI_EBC_PROTOCOL instance. + @param This A pointer to the EFI_EBC_PROTOCOL instance. @param Version Pointer to where to store the returned version of the interpreter. @retval EFI_SUCCESS The function completed successfully. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/EdidActive.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/EdidActive.h index 8e1ec84262..1f6ff052a9 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/EdidActive.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/EdidActive.h @@ -4,13 +4,13 @@ Placed on the video output device child handle that is actively displaying output. Copyright (c) 2006 - 2012, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/EdidDiscovered.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/EdidDiscovered.h index ccaae1bbb3..c10b6ee89a 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/EdidDiscovered.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/EdidDiscovered.h @@ -5,13 +5,13 @@ the EDID information being used for the output device represented by the child handle. Copyright (c) 2006 - 2012, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -33,7 +33,7 @@ typedef struct { /// minimum of 128 bytes. /// UINT32 SizeOfEdid; - + /// /// A pointer to a read-only array of bytes that contains the EDID /// information for an active video output device. This pointer is @@ -41,7 +41,7 @@ typedef struct { /// device. The minimum size of a valid Edid buffer is 128 bytes. /// EDID information is defined in the E-EDID EEPROM /// specification published by VESA (www.vesa.org). - /// + /// UINT8 *Edid; } EFI_EDID_DISCOVERED_PROTOCOL; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/EdidOverride.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/EdidOverride.h index cd847b666d..450c95641f 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/EdidOverride.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/EdidOverride.h @@ -5,13 +5,13 @@ protocol. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -55,13 +55,13 @@ EFI_STATUS ); /// -/// This protocol is produced by the platform to allow the platform to provide +/// This protocol is produced by the platform to allow the platform to provide /// EDID information to the producer of the Graphics Output protocol. /// struct _EFI_EDID_OVERRIDE_PROTOCOL { EFI_EDID_OVERRIDE_PROTOCOL_GET_EDID GetEdid; }; - + extern EFI_GUID gEfiEdidOverrideProtocolGuid; #endif diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ExtendedSalBootService.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ExtendedSalBootService.h index 167201d85a..8b11121afd 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ExtendedSalBootService.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ExtendedSalBootService.h @@ -1,18 +1,18 @@ /** @file Definition of Extended SAL Boot Service Protocol - The Extended SAL Boot Service Protocol provides a mechanisms for platform specific + The Extended SAL Boot Service Protocol provides a mechanisms for platform specific drivers to update the SAL System Table and register Extended SAL Procedures that are callable in physical or virtual mode using the SAL calling convention. Copyright (c) 2009 - 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -36,7 +36,7 @@ typedef struct _EXTENDED_SAL_BOOT_SERVICE_PROTOCOL EXTENDED_SAL_BOOT_SERVICE_PRO the major revision and the lower byte contains the minor revision. @param OemId A pointer to a Null-terminated ASCII string that contains OEM unique string. The string cannot be longer than 32 bytes in total length - @param ProductId A pointer to a Null-terminated ASCII string that uniquely identifies a family of + @param ProductId A pointer to a Null-terminated ASCII string that uniquely identifies a family of compatible products. The string cannot be longer than 32 bytes in total length. @retval EFI_SUCCESS The SAL System Table header was updated successfully. @@ -63,7 +63,7 @@ EFI_STATUS to the SAL System Table. @param This A pointer to the EXTENDED_SAL_BOOT_SERVICE_PROTOCOL instance. - @param TableEntry Pointer to a buffer containing a SAL System Table entry that is EntrySize bytes + @param TableEntry Pointer to a buffer containing a SAL System Table entry that is EntrySize bytes in length. The first byte of the TableEntry describes the type of entry. @param EntrySize The size, in bytes, of TableEntry. @@ -97,7 +97,7 @@ EFI_STATUS @param Arg8 Eighth argument to the Extended SAL procedure. @param VirtualMode TRUE if the Extended SAL Procedure is being invoked in virtual mode. FALSE if the Extended SAL Procedure is being invoked in physical mode. - @param ModuleGlobal A pointer to the global context associated with this Extended SAL Procedure. + @param ModuleGlobal A pointer to the global context associated with this Extended SAL Procedure. @return The result returned from the specified Extended SAL Procedure @@ -115,7 +115,7 @@ SAL_RETURN_REGS IN UINT64 Arg8, IN BOOLEAN VirtualMode, IN VOID *ModuleGlobal OPTIONAL - ); + ); /** Registers an Extended SAL Procedure. @@ -124,16 +124,16 @@ SAL_RETURN_REGS ClassGuidHi, and FunctionId is added to the set of available Extended SAL Procedures. @param This A pointer to the EXTENDED_SAL_BOOT_SERVICE_PROTOCOL instance. - @param ClassGuidLo The lower 64-bits of the class GUID for the Extended SAL Procedure being added. + @param ClassGuidLo The lower 64-bits of the class GUID for the Extended SAL Procedure being added. Each class GUID contains one or more functions specified by a Function ID. - @param ClassGuidHi The upper 64-bits of the class GUID for the Extended SAL Procedure being added. + @param ClassGuidHi The upper 64-bits of the class GUID for the Extended SAL Procedure being added. Each class GUID contains one or more functions specified by a Function ID. - @param FunctionId The Function ID for the Extended SAL Procedure that is being added. This Function - ID is a member of the Extended SAL Procedure class specified by ClassGuidLo + @param FunctionId The Function ID for the Extended SAL Procedure that is being added. This Function + ID is a member of the Extended SAL Procedure class specified by ClassGuidLo and ClassGuidHi. @param InternalSalProc A pointer to the Extended SAL Procedure being added. @param PhysicalModuleGlobal Pointer to a module global structure. This is a physical mode pointer. - This pointer is passed to the Extended SAL Procedure specified by ClassGuidLo, + This pointer is passed to the Extended SAL Procedure specified by ClassGuidLo, ClassGuidHi, FunctionId, and InternalSalProc. If the system is in physical mode, then this pointer is passed unmodified to InternalSalProc. If the system is in virtual mode, then the virtual address associated with this pointer is passed to @@ -157,9 +157,9 @@ EFI_STATUS /** Calls a previously registered Extended SAL Procedure. - This function calls the Extended SAL Procedure specified by ClassGuidLo, ClassGuidHi, - and FunctionId. The set of previously registered Extended SAL Procedures is searched for a - matching ClassGuidLo, ClassGuidHi, and FunctionId. If a match is not found, then + This function calls the Extended SAL Procedure specified by ClassGuidLo, ClassGuidHi, + and FunctionId. The set of previously registered Extended SAL Procedures is searched for a + matching ClassGuidLo, ClassGuidHi, and FunctionId. If a match is not found, then EFI_SAL_NOT_IMPLEMENTED is returned. @param ClassGuidLo The lower 64-bits of the class GUID for the Extended SAL Procedure @@ -175,9 +175,9 @@ EFI_STATUS @param Arg7 Seventh argument to the Extended SAL procedure. @param Arg8 Eighth argument to the Extended SAL procedure. - @retval EFI_SAL_NOT_IMPLEMENTED The Extended SAL Procedure specified by ClassGuidLo, + @retval EFI_SAL_NOT_IMPLEMENTED The Extended SAL Procedure specified by ClassGuidLo, ClassGuidHi, and FunctionId has not been registered. - @retval EFI_SAL_VIRTUAL_ADDRESS_ERROR This function was called in virtual mode before virtual mappings + @retval EFI_SAL_VIRTUAL_ADDRESS_ERROR This function was called in virtual mode before virtual mappings for the specified Extended SAL Procedure are available. @retval Other The result returned from the specified Extended SAL Procedure @@ -198,14 +198,14 @@ SAL_RETURN_REGS ); /// -/// The EXTENDED_SAL_BOOT_SERVICE_PROTOCOL provides a mechanisms for platform specific +/// The EXTENDED_SAL_BOOT_SERVICE_PROTOCOL provides a mechanisms for platform specific /// drivers to update the SAL System Table and register Extended SAL Procedures that are /// callable in physical or virtual mode using the SAL calling convention. /// struct _EXTENDED_SAL_BOOT_SERVICE_PROTOCOL { EXTENDED_SAL_ADD_SST_INFO AddSalSystemTableInfo; EXTENDED_SAL_ADD_SST_ENTRY AddSalSystemTableEntry; - EXTENDED_SAL_REGISTER_INTERNAL_PROC RegisterExtendedSalProc; + EXTENDED_SAL_REGISTER_INTERNAL_PROC RegisterExtendedSalProc; EXTENDED_SAL_PROC ExtendedSalProc; }; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ExtendedSalServiceClasses.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ExtendedSalServiceClasses.h index 126beedacf..080a1546f9 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ExtendedSalServiceClasses.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ExtendedSalServiceClasses.h @@ -2,13 +2,13 @@ The standard set of Extended SAL service classes. Copyright (c) 2009, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -51,7 +51,7 @@ typedef enum { /// ///@{ #define EFI_EXTENDED_SAL_RTC_SERVICES_PROTOCOL_GUID_LO 0x4d02efdb7e97a470 -#define EFI_EXTENDED_SAL_RTC_SERVICES_PROTOCOL_GUID_HI 0x96a27bd29061ce8f +#define EFI_EXTENDED_SAL_RTC_SERVICES_PROTOCOL_GUID_HI 0x96a27bd29061ce8f #define EFI_EXTENDED_SAL_RTC_SERVICES_PROTOCOL_GUID \ { 0x7e97a470, 0xefdb, 0x4d02, {0x8f, 0xce, 0x61, 0x90, 0xd2, 0x7b, 0xa2, 0x96 } } @@ -71,7 +71,7 @@ typedef enum { /// Extended SAL Variable Services Class /// ///@{ -#define EFI_EXTENDED_SAL_VARIABLE_SERVICES_PROTOCOL_GUID_LO 0x4370c6414ecb6c53 +#define EFI_EXTENDED_SAL_VARIABLE_SERVICES_PROTOCOL_GUID_LO 0x4370c6414ecb6c53 #define EFI_EXTENDED_SAL_VARIABLE_SERVICES_PROTOCOL_GUID_HI 0x78836e490e3bb28c #define EFI_EXTENDED_SAL_VARIABLE_SERVICES_PROTOCOL_GUID \ { 0x4ecb6c53, 0xc641, 0x4370, {0x8c, 0xb2, 0x3b, 0x0e, 0x49, 0x6e, 0x83, 0x78 } } @@ -165,7 +165,7 @@ typedef enum { CurrentProcInfoFunctionId, NumProcessorsFunctionId, SetMinStateFunctionId, - GetMinStateFunctionId + GetMinStateFunctionId } EFI_EXTENDED_SAL_MP_SERVICES_FUNC_ID; ///@} @@ -204,7 +204,7 @@ typedef enum { EsalMcGetMcParamsFunctionId, EsalGetMcCheckinFlagsFunctionId, EsalGetPlatformBaseFreqFunctionId, - EsalPhysicalIdInfoFunctionId, + EsalPhysicalIdInfoFunctionId, EsalRegisterPhysicalAddrFunctionId } EFI_EXTENDED_SAL_BASE_SERVICES_FUNC_ID; ///@} diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/FirmwareVolume2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/FirmwareVolume2.h index 00523bf083..3ef4ebbe9f 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/FirmwareVolume2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/FirmwareVolume2.h @@ -1,18 +1,18 @@ /** @file - The Firmware Volume Protocol provides file-level access to the firmware volume. - Each firmware volume driver must produce an instance of the + The Firmware Volume Protocol provides file-level access to the firmware volume. + Each firmware volume driver must produce an instance of the Firmware Volume Protocol if the firmware volume is to be visible to the system during the DXE phase. The Firmware Volume Protocol also provides mechanisms for determining and modifying some attributes of the firmware volume. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: PI Version 1.00. @@ -98,7 +98,7 @@ typedef UINT64 EFI_FV_ATTRIBUTES; undefined. @param This Indicates the EFI_FIRMWARE_VOLUME2_PROTOCOL instance. - + @param FvAttributes Pointer to an EFI_FV_ATTRIBUTES in which the attributes and current settings are returned. @@ -118,7 +118,7 @@ EFI_STATUS /** Modifies the current settings of the firmware volume according to the input parameter. - + The SetVolumeAttributes() function is used to set configurable firmware volume attributes. Only EFI_FV_READ_STATUS, EFI_FV_WRITE_STATUS, and EFI_FV_LOCK_STATUS may be modified, and @@ -136,7 +136,7 @@ EFI_STATUS TPL_NOTIFY is undefined. @param This Indicates the EFI_FIRMWARE_VOLUME2_PROTOCOL instance. - + @param FvAttributes On input, FvAttributes is a pointer to an EFI_FV_ATTRIBUTES containing the desired firmware volume settings. On @@ -145,7 +145,7 @@ EFI_STATUS unsuccessful return, FvAttributes is not modified and the firmware volume settings are not changed. - + @retval EFI_SUCCESS The requested firmware volume attributes were set and the resulting EFI_FV_ATTRIBUTES is returned in @@ -254,13 +254,13 @@ EFI_STATUS undefined. @param This Indicates the EFI_FIRMWARE_VOLUME2_PROTOCOL instance. - + @param NameGuid Pointer to an EFI_GUID, which is the file name. All firmware file names are EFI_GUIDs. A single firmware volume must not have two valid files with the same file name EFI_GUID. - + @param Buffer Pointer to a pointer to a buffer in which the file contents are returned, not including the file header. @@ -268,19 +268,19 @@ EFI_STATUS @param BufferSize Pointer to a caller-allocated UINTN. It indicates the size of the memory represented by Buffer. - + @param FoundType Pointer to a caller-allocated EFI_FV_FILETYPE. - + @param FileAttributes Pointer to a caller-allocated EFI_FV_FILE_ATTRIBUTES. - + @param AuthenticationStatus Pointer to a caller-allocated UINT32 in which the authentication status is returned. - + @retval EFI_SUCCESS The call completed successfully. - + @retval EFI_WARN_BUFFER_TOO_SMALL The buffer is too small to contain the requested output. The buffer is @@ -342,56 +342,56 @@ EFI_STATUS undefined. @param This Indicates the EFI_FIRMWARE_VOLUME2_PROTOCOL instance. - + @param NameGuid Pointer to an EFI_GUID, which indicates the file name from which the requested section will be read. - + @param SectionType Indicates the section type to return. SectionType in conjunction with SectionInstance indicates which section to return. - + @param SectionInstance Indicates which instance of sections with a type of SectionType to return. SectionType in conjunction with SectionInstance indicates which section to return. SectionInstance is zero based. - + @param Buffer Pointer to a pointer to a buffer in which the section contents are returned, not including the section header. - + @param BufferSize Pointer to a caller-allocated UINTN. It indicates the size of the memory represented by Buffer. - + @param AuthenticationStatus Pointer to a caller-allocated UINT32 in which the authentication status is returned. - - + + @retval EFI_SUCCESS The call completed successfully. - + @retval EFI_WARN_BUFFER_TOO_SMALL The caller-allocated buffer is too small to contain the requested output. The buffer is filled and the output is truncated. - + @retval EFI_OUT_OF_RESOURCES An allocation failure occurred. - + @retval EFI_NOT_FOUND The requested file was not found in the firmware volume. EFI_NOT_FOUND The requested section was not found in the specified file. - + @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to access the firmware volume. - + @retval EFI_ACCESS_DENIED The firmware volume is configured to disallow reads. EFI_PROTOCOL_ERROR The requested section was not found, @@ -472,7 +472,7 @@ typedef struct { Architectural Elements 84 August 21, 2006 Version 1.0 WriteFile() is callable only from TPL_NOTIFY and below. Behavior of WriteFile() at any EFI_TPL above TPL_NOTIFY is - undefined. + undefined. @param This Indicates the EFI_FIRMWARE_VOLUME2_PROTOCOL instance. @@ -482,31 +482,31 @@ typedef struct { write in the event of a power failure or other system failure during the write operation. - + @param FileData Pointer to an array of EFI_FV_WRITE_FILE_DATA. Each element of FileData[] represents a file to be written. @retval EFI_SUCCESS The write completed successfully. - + @retval EFI_OUT_OF_RESOURCES The firmware volume does not have enough free space to storefile(s). - + @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to access the firmware volume. - + @retval EFI_WRITE_PROTECTED The firmware volume is configured to disallow writes. - + @retval EFI_NOT_FOUND A delete was requested, but the requested file was not found in the firmware volume. - + @retval EFI_INVALID_PARAMETER A delete was requested with a multiple file write. - + @retval EFI_INVALID_PARAMETER An unsupported WritePolicy was requested. @@ -515,10 +515,10 @@ typedef struct { @retval EFI_INVALID_PARAMETER A file system specific error has occurred. - + **/ typedef -EFI_STATUS +EFI_STATUS (EFIAPI * EFI_FV_WRITE_FILE)( IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL *This, IN UINT32 NumberOfFiles, @@ -528,7 +528,7 @@ EFI_STATUS /** - Retrieves information about the next file in the firmware volume store + Retrieves information about the next file in the firmware volume store that matches the search criteria. GetNextFile() is the interface that is used to search a firmware @@ -547,7 +547,7 @@ EFI_STATUS implementation specific and no semantic content is implied. GetNextFile() is callable only from TPL_NOTIFY and below. Behavior of GetNextFile() at any EFI_TPL above TPL_NOTIFY is - undefined. + undefined. @param This Indicates the EFI_FIRMWARE_VOLUME2_PROTOCOL instance. @@ -600,7 +600,7 @@ EFI_STATUS @retval EFI_ACCESS_DENIED The firmware volume is configured to disallow reads. - + **/ typedef EFI_STATUS @@ -629,29 +629,29 @@ EFI_STATUS @param This A pointer to the EFI_FIRMWARE_VOLUME2_PROTOCOL instance that is the file handle the requested information is for. - + @param InformationType The type identifier for the information being requested. - + @param BufferSize On input, the size of Buffer. On output, the amount of data returned in Buffer. In both cases, the size is measured in bytes. - + @param Buffer A pointer to the data buffer to return. The buffer's type is indicated by InformationType. - - + + @retval EFI_SUCCESS The information was retrieved. - + @retval EFI_UNSUPPORTED The InformationType is not known. - + @retval EFI_NO_MEDIA The device has no medium. - + @retval EFI_DEVICE_ERROR The device reported an error. - + @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. - + @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small to read the current directory entry. BufferSize has been @@ -740,14 +740,14 @@ struct _EFI_FIRMWARE_VOLUME2_PROTOCOL { EFI_FV_READ_SECTION ReadSection; EFI_FV_WRITE_FILE WriteFile; EFI_FV_GET_NEXT_FILE GetNextFile; - + /// /// Data field that indicates the size in bytes /// of the Key input buffer for the - /// GetNextFile() API. + /// GetNextFile() API. /// UINT32 KeySize; - + /// /// Handle of the parent firmware volume. /// diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/FirmwareVolumeBlock.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/FirmwareVolumeBlock.h index 48c06e1439..72c24e3a14 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/FirmwareVolumeBlock.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/FirmwareVolumeBlock.h @@ -2,13 +2,13 @@ This file provides control over block-oriented firmware devices. Copyright (c) 2006 - 2011, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. @par Revision Reference: PI Version 1.0 and 1.2. @@ -21,7 +21,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. // // EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL is defined in PI 1.0 spec and its GUID value // is later updated to be the same as that of EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL -// defined in PI 1.2 spec. +// defined in PI 1.2 spec. // #define EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL_GUID \ { 0x8f644fa9, 0xe850, 0x4db1, {0x9c, 0xe2, 0xb, 0x44, 0x69, 0x8e, 0x8d, 0xa4 } } @@ -31,7 +31,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. typedef struct _EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL; -typedef EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL; +typedef EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL; /** The GetAttributes() function retrieves the attributes and @@ -69,7 +69,7 @@ EFI_STATUS settings of the firmware volume. Type EFI_FVB_ATTRIBUTES_2 is defined in EFI_FIRMWARE_VOLUME_HEADER. - + @retval EFI_SUCCESS The firmware volume attributes were returned. @retval EFI_INVALID_PARAMETER The attributes requested are in @@ -92,14 +92,14 @@ EFI_STATUS only for memory-mapped firmware volumes. @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance. - + @param Address Pointer to a caller-allocated EFI_PHYSICAL_ADDRESS that, on successful return from GetPhysicalAddress(), contains the base address of the firmware volume. - + @retval EFI_SUCCESS The firmware volume base address was returned. - + @retval EFI_UNSUPPORTED The firmware volume is not memory mapped. **/ @@ -130,9 +130,9 @@ EFI_STATUS blocks in this range have a size of BlockSize. - + @retval EFI_SUCCESS The firmware volume base address was returned. - + @retval EFI_INVALID_PARAMETER The requested LBA is out of range. **/ @@ -163,7 +163,7 @@ EFI_STATUS aware that a read may be partially completed. @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance. - + @param Lba The starting logical block index from which to read. @@ -179,15 +179,15 @@ EFI_STATUS @retval EFI_SUCCESS The firmware volume was read successfully, and contents are in Buffer. - + @retval EFI_BAD_BUFFER_SIZE Read attempted across an LBA boundary. On output, NumBytes contains the total number of bytes returned in Buffer. - + @retval EFI_ACCESS_DENIED The firmware volume is in the ReadDisabled state. - + @retval EFI_DEVICE_ERROR The block device is not functioning correctly and could not be read. @@ -215,7 +215,7 @@ EFI_STATUS unpredictability arises because, for a sticky-write firmware volume, a write may negate a bit in the EFI_FVB_ERASE_POLARITY state but cannot flip it back again. Before calling the - Write() function, it is recommended for the caller to first call + Write() function, it is recommended for the caller to first call the EraseBlocks() function to erase the specified block to write. A block erase cycle will transition bits from the (NOT)EFI_FVB_ERASE_POLARITY state back to the @@ -234,29 +234,29 @@ EFI_STATUS returns. @param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance. - + @param Lba The starting logical block index to write to. - + @param Offset Offset into the block at which to begin writing. - + @param NumBytes The pointer to a UINTN. At entry, *NumBytes contains the total size of the buffer. At exit, *NumBytes contains the total number of bytes actually written. - + @param Buffer The pointer to a caller-allocated buffer that contains the source for the write. - + @retval EFI_SUCCESS The firmware volume was written successfully. - + @retval EFI_BAD_BUFFER_SIZE The write was attempted across an LBA boundary. On output, NumBytes contains the total number of bytes actually written. - + @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled state. - + @retval EFI_DEVICE_ERROR The block device is malfunctioning and could not be written. @@ -317,7 +317,7 @@ EFI_STATUS @retval EFI_SUCCESS The erase request successfully completed. - + @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled state. @retval EFI_DEVICE_ERROR The block device is not functioning @@ -326,7 +326,7 @@ EFI_STATUS partially erased. @retval EFI_INVALID_PARAMETER One or more of the LBAs listed in the variable argument list do - not exist in the firmware volume. + not exist in the firmware volume. **/ typedef @@ -355,7 +355,7 @@ struct _EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL{ EFI_FVB_ERASE_BLOCKS EraseBlocks; /// /// The handle of the parent firmware volume. - /// + /// EFI_HANDLE ParentHandle; }; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/FormBrowser2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/FormBrowser2.h index de132f88c0..396891ebad 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/FormBrowser2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/FormBrowser2.h @@ -1,17 +1,17 @@ /** @file This protocol is defined in UEFI spec. - - The EFI_FORM_BROWSER2_PROTOCOL is the interface to call for drivers to + + The EFI_FORM_BROWSER2_PROTOCOL is the interface to call for drivers to leverage the EFI configuration driver interface. - + Copyright (c) 2006 - 2015, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -29,11 +29,11 @@ typedef struct _EFI_FORM_BROWSER2_PROTOCOL EFI_FORM_BROWSER2_PROTOCOL; /** - + @param LeftColumn The value that designates the text column where the browser window will begin from the left-hand side of the screen - + @param RightColumn The value that designates the text column where the browser window will end on the right-hand side of the screen. @@ -44,7 +44,7 @@ typedef struct _EFI_FORM_BROWSER2_PROTOCOL EFI_FORM_BROWSER2_PROTOCOL; @param BottomRow The value that designates the text row from the bottom of the screen where the browser - window will end. + window will end. **/ typedef struct { UINTN LeftColumn; @@ -69,14 +69,14 @@ typedef UINTN EFI_BROWSER_ACTION_REQUEST; /** Initialize the browser to display the specified configuration forms. - This function is the primary interface to the internal forms-based browser. - The forms browser will display forms associated with the specified Handles. - The browser will select all forms in packages which have the specified Type + This function is the primary interface to the internal forms-based browser. + The forms browser will display forms associated with the specified Handles. + The browser will select all forms in packages which have the specified Type and (for EFI_HII_PACKAGE_TYPE_GUID) the specified PackageGuid. @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL instance - @param Handles A pointer to an array of Handles. This value should correspond + @param Handles A pointer to an array of Handles. This value should correspond to the value of the HII form package that is required to be displayed. @param HandleCount The number of Handles specified in Handle. @@ -90,17 +90,17 @@ typedef UINTN EFI_BROWSER_ACTION_REQUEST; displayable page. If this field has a value of 0x0000, then the Forms Browser will render the first enabled form in the form set. - @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in + @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in characters. @param ActionRequest Points to the action recommended by the form. @retval EFI_SUCCESS The function completed successfully - + @retval EFI_NOT_FOUND The variable was not found. - + @retval EFI_INVALID_PARAMETER One of the parameters has an - invalid value. + invalid value. **/ typedef EFI_STATUS @@ -126,7 +126,7 @@ EFI_STATUS @param ResultsDataSize A pointer to the size of the buffer associated with ResultsData. On input, the size in - bytes of ResultsData. On output, the size of data + bytes of ResultsData. On output, the size of data returned in ResultsData. @param ResultsData A string returned from an IFR browser or @@ -148,7 +148,7 @@ EFI_STATUS @retval EFI_SUCCESS The results have been distributed or are awaiting distribution. - + @retval EFI_OUT_OF_RESOURCES The ResultsDataSize specified was too small to contain the results data. @@ -166,7 +166,7 @@ EFI_STATUS ); /// -/// This interface will allow the caller to direct the configuration +/// This interface will allow the caller to direct the configuration /// driver to use either the HII database or use the passed-in packet of data. /// struct _EFI_FORM_BROWSER2_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ftp4.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ftp4.h index 113e84a22d..e38a94b373 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ftp4.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ftp4.h @@ -1,6 +1,6 @@ /** @file EFI FTPv4 (File Transfer Protocol version 4) Protocol Definition - The EFI FTPv4 Protocol is used to locate communication devices that are + The EFI FTPv4 Protocol is used to locate communication devices that are supported by an EFI FTPv4 Protocol driver and to create and destroy instances of the EFI FTPv4 Protocol child protocol driver that can use the underlying communication device. @@ -16,7 +16,7 @@ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - @par Revision Reference: + @par Revision Reference: This Protocol is introduced in UEFI Specification 2.2 **/ @@ -41,103 +41,103 @@ typedef struct _EFI_FTP4_PROTOCOL EFI_FTP4_PROTOCOL; /// EFI_FTP4_CONNECTION_TOKEN /// typedef struct { - /// - /// The Event to signal after the connection is established and Status field is updated - /// by the EFI FTP v4 Protocol driver. The type of Event must be - /// EVENT_NOTIFY_SIGNAL, and its Task Priority Level (TPL) must be lower than or - /// equal to TPL_CALLBACK. If it is set to NULL, this function will not return until the + /// + /// The Event to signal after the connection is established and Status field is updated + /// by the EFI FTP v4 Protocol driver. The type of Event must be + /// EVENT_NOTIFY_SIGNAL, and its Task Priority Level (TPL) must be lower than or + /// equal to TPL_CALLBACK. If it is set to NULL, this function will not return until the /// function completes. - /// - EFI_EVENT Event; + /// + EFI_EVENT Event; /// /// The variable to receive the result of the completed operation. /// EFI_SUCCESS: The FTP connection is established successfully - /// EFI_ACCESS_DENIED: The FTP server denied the access the user's request to access it. - /// EFI_CONNECTION_RESET: The connect fails because the connection is reset either by instance + /// EFI_ACCESS_DENIED: The FTP server denied the access the user's request to access it. + /// EFI_CONNECTION_RESET: The connect fails because the connection is reset either by instance /// itself or communication peer. - /// EFI_TIMEOUT: The connection establishment timer expired and no more specific + /// EFI_TIMEOUT: The connection establishment timer expired and no more specific /// information is available. - /// EFI_NETWORK_UNREACHABLE: The active open fails because an ICMP network unreachable error is - /// received. - /// EFI_HOST_UNREACHABLE: The active open fails because an ICMP host unreachable error is - /// received. - /// EFI_PROTOCOL_UNREACHABLE: The active open fails because an ICMP protocol unreachable error is + /// EFI_NETWORK_UNREACHABLE: The active open fails because an ICMP network unreachable error is + /// received. + /// EFI_HOST_UNREACHABLE: The active open fails because an ICMP host unreachable error is + /// received. + /// EFI_PROTOCOL_UNREACHABLE: The active open fails because an ICMP protocol unreachable error is /// received. - /// EFI_PORT_UNREACHABLE: The connection establishment timer times out and an ICMP port + /// EFI_PORT_UNREACHABLE: The connection establishment timer times out and an ICMP port /// unreachable error is received. - /// EFI_ICMP_ERROR: The connection establishment timer timeout and some other ICMP + /// EFI_ICMP_ERROR: The connection establishment timer timeout and some other ICMP /// error is received. /// EFI_DEVICE_ERROR: An unexpected system or network error occurred. - /// + /// EFI_STATUS Status; } EFI_FTP4_CONNECTION_TOKEN; /// -/// EFI_FTP4_CONFIG_DATA +/// EFI_FTP4_CONFIG_DATA /// typedef struct { - /// - /// Pointer to a ASCII string that contains user name. The caller is + /// + /// Pointer to a ASCII string that contains user name. The caller is /// responsible for freeing Username after GetModeData() is called. - /// + /// UINT8 *Username; - /// - /// Pointer to a ASCII string that contains password. The caller is + /// + /// Pointer to a ASCII string that contains password. The caller is /// responsible for freeing Password after GetModeData() is called. - /// + /// UINT8 *Password; - /// - /// Set it to TRUE to initiate an active data connection. Set it to + /// + /// Set it to TRUE to initiate an active data connection. Set it to /// FALSE to initiate a passive data connection. - /// + /// BOOLEAN Active; - /// + /// /// Boolean value indicating if default network settting used. - /// + /// BOOLEAN UseDefaultSetting; - /// + /// /// IP address of station if UseDefaultSetting is FALSE. - /// + /// EFI_IPv4_ADDRESS StationIp; - /// + /// /// Subnet mask of station if UseDefaultSetting is FALSE. - /// + /// EFI_IPv4_ADDRESS SubnetMask; - /// + /// /// IP address of gateway if UseDefaultSetting is FALSE. - /// + /// EFI_IPv4_ADDRESS GatewayIp; - /// + /// /// IP address of FTPv4 server. - /// + /// EFI_IPv4_ADDRESS ServerIp; - /// - /// FTPv4 server port number of control connection, and the default + /// + /// FTPv4 server port number of control connection, and the default /// value is 21 as convention. - /// + /// UINT16 ServerPort; - /// - /// FTPv4 server port number of data connection. If it is zero, use - /// (ServerPort - 1) by convention. - /// + /// + /// FTPv4 server port number of data connection. If it is zero, use + /// (ServerPort - 1) by convention. + /// UINT16 AltDataPort; - /// - /// A byte indicate the representation type. The right 4 bit is used for + /// + /// A byte indicate the representation type. The right 4 bit is used for /// first parameter, the left 4 bit is use for second parameter /// - For the first parameter, 0x0 = image, 0x1 = EBCDIC, 0x2 = ASCII, 0x3 = local - /// - For the second parameter, 0x0 = Non-print, 0x1 = Telnet format effectors, 0x2 = + /// - For the second parameter, 0x0 = Non-print, 0x1 = Telnet format effectors, 0x2 = /// Carriage Control. /// - If it is a local type, the second parameter is the local byte byte size. /// - If it is a image type, the second parameter is undefined. - /// + /// UINT8 RepType; - /// + /// /// Defines the file structure in FTP used. 0x00 = file, 0x01 = record, 0x02 = page. - /// + /// UINT8 FileStruct; - /// + /// /// Defines the transifer mode used in FTP. 0x00 = stream, 0x01 = Block, 0x02 = Compressed. - /// + /// UINT8 TransMode; } EFI_FTP4_CONFIG_DATA; @@ -149,9 +149,9 @@ typedef struct _EFI_FTP4_COMMAND_TOKEN EFI_FTP4_COMMAND_TOKEN; If it is receiving function that leads to inbound data, the callback function is called when data buffer is full. Then, old data in the data buffer should be flushed and new data is stored from the beginning of data buffer. - If it is a transmit function that lead to outbound data and the size of - Data in daata buffer has been transmitted, this callback function is called to - supply additional data to be transmitted. + If it is a transmit function that lead to outbound data and the size of + Data in daata buffer has been transmitted, this callback function is called to + supply additional data to be transmitted. @param[in] This Pointer to the EFI_FTP4_PROTOCOL instance. @param[in] Token Pointer to the token structure to provide the parameters that @@ -160,8 +160,8 @@ typedef struct _EFI_FTP4_COMMAND_TOKEN EFI_FTP4_COMMAND_TOKEN; **/ typedef -EFI_STATUS -(EFIAPI *EFI_FTP4_DATA_CALLBACK)( +EFI_STATUS +(EFIAPI *EFI_FTP4_DATA_CALLBACK)( IN EFI_FTP4_PROTOCOL *This, IN EFI_FTP4_COMMAND_TOKEN *Token ); @@ -170,57 +170,57 @@ EFI_STATUS /// EFI_FTP4_COMMAND_TOKEN /// struct _EFI_FTP4_COMMAND_TOKEN { - /// - /// The Event to signal after request is finished and Status field - /// is updated by the EFI FTP v4 Protocol driver. The type of Event - /// must be EVT_NOTIFY_SIGNAL, and its Task Priority Level - /// (TPL) must be lower than or equal to TPL_CALLBACK. If it is - /// set to NULL, related function must wait until the function + /// + /// The Event to signal after request is finished and Status field + /// is updated by the EFI FTP v4 Protocol driver. The type of Event + /// must be EVT_NOTIFY_SIGNAL, and its Task Priority Level + /// (TPL) must be lower than or equal to TPL_CALLBACK. If it is + /// set to NULL, related function must wait until the function /// completes. - /// - EFI_EVENT Event; - /// - /// Pointer to a null-terminated ASCII name string. - /// + /// + EFI_EVENT Event; + /// + /// Pointer to a null-terminated ASCII name string. + /// UINT8 *Pathname; - /// + /// /// The size of data buffer in bytes. - /// - UINT64 DataBufferSize; - /// - /// Pointer to the data buffer. Data downloaded from FTP server + /// + UINT64 DataBufferSize; + /// + /// Pointer to the data buffer. Data downloaded from FTP server /// through connection is downloaded here. - /// + /// VOID *DataBuffer; - /// - /// Pointer to a callback function. If it is receiving function that leads - /// to inbound data, the callback function is called when databuffer is - /// full. Then, old data in the data buffer should be flushed and new - /// data is stored from the beginning of data buffer. If it is a transmit - /// function that lead to outbound data and DataBufferSize of - /// Data in DataBuffer has been transmitted, this callback - /// function is called to supply additional data to be transmitted. The - /// size of additional data to be transmitted is indicated in - /// DataBufferSize, again. If there is no data remained, + /// + /// Pointer to a callback function. If it is receiving function that leads + /// to inbound data, the callback function is called when databuffer is + /// full. Then, old data in the data buffer should be flushed and new + /// data is stored from the beginning of data buffer. If it is a transmit + /// function that lead to outbound data and DataBufferSize of + /// Data in DataBuffer has been transmitted, this callback + /// function is called to supply additional data to be transmitted. The + /// size of additional data to be transmitted is indicated in + /// DataBufferSize, again. If there is no data remained, /// DataBufferSize should be set to 0. - /// + /// EFI_FTP4_DATA_CALLBACK DataCallback; - /// + /// /// Pointer to the parameter for DataCallback. - /// + /// VOID *Context; - /// + /// /// The variable to receive the result of the completed operation. /// EFI_SUCCESS: The FTP command is completed successfully. /// EFI_ACCESS_DENIED: The FTP server denied the access to the requested file. /// EFI_CONNECTION_RESET: The connect fails because the connection is reset either /// by instance itself or communication peer. - /// EFI_TIMEOUT: The connection establishment timer expired and no more + /// EFI_TIMEOUT: The connection establishment timer expired and no more /// specific information is available. /// EFI_NETWORK_UNREACHABLE: The active open fails because an ICMP network unreachable - /// error is received. + /// error is received. /// EFI_HOST_UNREACHABLE: The active open fails because an ICMP host unreachable - /// error is received. + /// error is received. /// EFI_PROTOCOL_UNREACHABLE: The active open fails because an ICMP protocol unreachable /// error is received. /// EFI_PORT_UNREACHABLE: The connection establishment timer times out and an ICMP port @@ -236,14 +236,14 @@ struct _EFI_FTP4_COMMAND_TOKEN { Gets the current operational settings. The GetModeData() function reads the current operational settings of this - EFI FTPv4 Protocol driver instance. EFI_FTP4_CONFIG_DATA is defined in the + EFI FTPv4 Protocol driver instance. EFI_FTP4_CONFIG_DATA is defined in the EFI_FTP4_PROTOCOL.Configure. @param[in] This Pointer to the EFI_FTP4_PROTOCOL instance. - @param[out] ModeData Pointer to storage for the EFI FTPv4 Protocol driver + @param[out] ModeData Pointer to storage for the EFI FTPv4 Protocol driver mode data. The string buffers for Username and Password in EFI_FTP4_CONFIG_DATA are allocated by the function, - and the caller should take the responsibility to free the + and the caller should take the responsibility to free the buffer later. @retval EFI_SUCCESS This function is called successfully. @@ -255,8 +255,8 @@ struct _EFI_FTP4_COMMAND_TOKEN { @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. **/ -typedef -EFI_STATUS +typedef +EFI_STATUS (EFIAPI *EFI_FTP4_GET_MODE_DATA)( IN EFI_FTP4_PROTOCOL *This, OUT EFI_FTP4_CONFIG_DATA *ModeData @@ -266,7 +266,7 @@ EFI_STATUS Disconnecting a FTP connection gracefully. The Connect() function will initiate a connection request to the remote FTP server - with the corresponding connection token. If this function returns EFI_SUCCESS, the + with the corresponding connection token. If this function returns EFI_SUCCESS, the connection sequence is initiated successfully. If the connection succeeds or faild due to any error, the Token->Event will be signaled and Token->Status will be updated accordingly. @@ -280,7 +280,7 @@ EFI_STATUS - Token is NULL. - Token->Event is NULL. @retval EFI_NOT_STARTED The EFI FTPv4 Protocol driver has not been started. - @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, + @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet. @retval EFI_OUT_OF_RESOURCES Could not allocate enough resource to finish the operation. @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. @@ -297,7 +297,7 @@ EFI_STATUS Disconnecting a FTP connection gracefully. The Close() function will initiate a close request to the remote FTP server with the - corresponding connection token. If this function returns EFI_SUCCESS, the control + corresponding connection token. If this function returns EFI_SUCCESS, the control connection with the remote FTP server is closed. @param[in] This Pointer to the EFI_FTP4_PROTOCOL instance. @@ -309,7 +309,7 @@ EFI_STATUS - Token is NULL. - Token->Event is NULL. @retval EFI_NOT_STARTED The EFI FTPv4 Protocol driver has not been started. - @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, + @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet. @retval EFI_OUT_OF_RESOURCES Could not allocate enough resource to finish the operation. @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. @@ -325,14 +325,14 @@ EFI_STATUS /** Sets or clears the operational parameters for the FTP child driver. - The Configure() function will configure the connected FTP session with the + The Configure() function will configure the connected FTP session with the configuration setting specified in FtpConfigData. The configuration data can be reset by calling Configure() with FtpConfigData set to NULL. @param[in] This Pointer to the EFI_FTP4_PROTOCOL instance. - @param[in] FtpConfigData Pointer to configuration data that will be assigned to + @param[in] FtpConfigData Pointer to configuration data that will be assigned to the FTP child driver instance. If NULL, the FTP child - driver instance is reset to startup defaults and all + driver instance is reset to startup defaults and all pending transmit and receive requests are flushed. @retval EFI_SUCCESS The FTPv4 driver was configured successfully. @@ -342,13 +342,13 @@ EFI_STATUS - FtpConfigData.FileStruct is invalid. - FtpConfigData.TransMode is invalid. - IP address in FtpConfigData is invalid. - @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, + @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet. @retval EFI_UNSUPPORTED One or more of the configuration parameters are not supported - by this implementation. - @retval EFI_OUT_OF_RESOURCES The EFI FTPv4 Protocol driver instance data could not be + by this implementation. + @retval EFI_OUT_OF_RESOURCES The EFI FTPv4 Protocol driver instance data could not be allocated. - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI FTPv4 + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI FTPv4 Protocol driver instance is not configured. **/ @@ -361,15 +361,15 @@ EFI_STATUS /** - Downloads a file from an FTPv4 server. + Downloads a file from an FTPv4 server. The ReadFile() function is used to initialize and start an FTPv4 download process and optionally wait for completion. When the download operation completes, whether - successfully or not, the Token.Status field is updated by the EFI FTPv4 Protocol + successfully or not, the Token.Status field is updated by the EFI FTPv4 Protocol driver and then Token.Event is signaled (if it is not NULL). Data will be downloaded from the FTPv4 server into Token.DataBuffer. If the file size - is larger than Token.DataBufferSize, Token.DataCallback will be called to allow for + is larger than Token.DataBufferSize, Token.DataCallback will be called to allow for processing data and then new data will be placed at the beginning of Token.DataBuffer. @param[in] This Pointer to the EFI_FTP4_PROTOCOL instance. @@ -384,29 +384,29 @@ EFI_STATUS - Token. DataBuffer is NULL. - Token. DataBufferSize is 0. @retval EFI_NOT_STARTED The EFI FTPv4 Protocol driver has not been started. - @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, + @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet. @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred. **/ -typedef -EFI_STATUS +typedef +EFI_STATUS (EFIAPI *EFI_FTP4_READ_FILE)( IN EFI_FTP4_PROTOCOL *This, IN EFI_FTP4_COMMAND_TOKEN *Token ); /** - Uploads a file from an FTPv4 server. + Uploads a file from an FTPv4 server. The WriteFile() function is used to initialize and start an FTPv4 upload process and optionally wait for completion. When the upload operation completes, whether successfully or not, the Token.Status field is updated by the EFI FTPv4 Protocol driver and then Token.Event is signaled (if it is not NULL). Data to be uploaded to server is stored - into Token.DataBuffer. Token.DataBufferSize is the number bytes to be transferred. + into Token.DataBuffer. Token.DataBufferSize is the number bytes to be transferred. If the file size is larger than Token.DataBufferSize, Token.DataCallback will be called - to allow for processing data and then new data will be placed at the beginning of + to allow for processing data and then new data will be placed at the beginning of Token.DataBuffer. Token.DataBufferSize is updated to reflect the actual number of bytes to be transferred. Token.DataBufferSize is set to 0 by the call back to indicate the completion of data transfer. @@ -424,30 +424,30 @@ EFI_STATUS - Token. DataBuffer is NULL. - Token. DataBufferSize is 0. @retval EFI_NOT_STARTED The EFI FTPv4 Protocol driver has not been started. - @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, + @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet. @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred. **/ -typedef -EFI_STATUS +typedef +EFI_STATUS (EFIAPI *EFI_FTP4_WRITE_FILE)( IN EFI_FTP4_PROTOCOL *This, IN EFI_FTP4_COMMAND_TOKEN *Token ); /** - Download a data file "directory" from a FTPv4 server. May be unsupported in some EFI + Download a data file "directory" from a FTPv4 server. May be unsupported in some EFI implementations. The ReadDirectory() function is used to return a list of files on the FTPv4 server that logically (or operationally) related to Token.Pathname, and optionally wait for completion. - When the download operation completes, whether successfully or not, the Token.Status field + When the download operation completes, whether successfully or not, the Token.Status field is updated by the EFI FTPv4 Protocol driver and then Token.Event is signaled (if it is not NULL). Data will be downloaded from the FTPv4 server into Token.DataBuffer. If the file size is larger than Token.DataBufferSize, Token.DataCallback will be called to allow for processing - data and then new data will be placed at the beginning of Token.DataBuffer. + data and then new data will be placed at the beginning of Token.DataBuffer. @param[in] This Pointer to the EFI_FTP4_PROTOCOL instance. @param[in] Token Pointer to the token structure to provide the parameters that @@ -461,7 +461,7 @@ EFI_STATUS - Token. DataBuffer is NULL. - Token. DataBufferSize is 0. @retval EFI_NOT_STARTED The EFI FTPv4 Protocol driver has not been started. - @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, + @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet. @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred. @@ -475,15 +475,15 @@ EFI_STATUS ); /** - Polls for incoming data packets and processes outgoing data packets. + Polls for incoming data packets and processes outgoing data packets. The Poll() function can be used by network drivers and applications to increase the rate that data packets are moved between the communications device and the transmit and receive queues. In some systems, the periodic timer event in the managed network - driver may not poll the underlying communications device fast enough to transmit + driver may not poll the underlying communications device fast enough to transmit and/or receive all data packets without missing incoming packets or dropping outgoing packets. Drivers and applications that are experiencing packet loss should try calling - the Poll() function more often. + the Poll() function more often. @param[in] This Pointer to the EFI_FTP4_PROTOCOL instance. @@ -502,8 +502,8 @@ EFI_STATUS ); /// -/// EFI_FTP4_PROTOCOL -/// provides basic services for client-side FTP (File Transfer Protocol) +/// EFI_FTP4_PROTOCOL +/// provides basic services for client-side FTP (File Transfer Protocol) /// operations. /// struct _EFI_FTP4_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/GraphicsOutput.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/GraphicsOutput.h index a3432ce1d6..0621b577c5 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/GraphicsOutput.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/GraphicsOutput.h @@ -4,13 +4,13 @@ Abstraction of a very simple graphics device. Copyright (c) 2006 - 2012, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -33,18 +33,18 @@ typedef struct { typedef enum { /// - /// A pixel is 32-bits and byte zero represents red, byte one represents green, - /// byte two represents blue, and byte three is reserved. This is the definition - /// for the physical frame buffer. The byte values for the red, green, and blue - /// components represent the color intensity. This color intensity value range + /// A pixel is 32-bits and byte zero represents red, byte one represents green, + /// byte two represents blue, and byte three is reserved. This is the definition + /// for the physical frame buffer. The byte values for the red, green, and blue + /// components represent the color intensity. This color intensity value range /// from a minimum intensity of 0 to maximum intensity of 255. /// PixelRedGreenBlueReserved8BitPerColor, /// - /// A pixel is 32-bits and byte zero represents blue, byte one represents green, - /// byte two represents red, and byte three is reserved. This is the definition - /// for the physical frame buffer. The byte values for the red, green, and blue - /// components represent the color intensity. This color intensity value range + /// A pixel is 32-bits and byte zero represents blue, byte one represents green, + /// byte two represents red, and byte three is reserved. This is the definition + /// for the physical frame buffer. The byte values for the red, green, and blue + /// components represent the color intensity. This color intensity value range /// from a minimum intensity of 0 to maximum intensity of 255. /// PixelBlueGreenRedReserved8BitPerColor, @@ -64,7 +64,7 @@ typedef enum { typedef struct { /// - /// The version of this data structure. A value of zero represents the + /// The version of this data structure. A value of zero represents the /// EFI_GRAPHICS_OUTPUT_MODE_INFORMATION structure as defined in this specification. /// UINT32 Version; @@ -77,18 +77,18 @@ typedef struct { /// UINT32 VerticalResolution; /// - /// Enumeration that defines the physical format of the pixel. A value of PixelBltOnly + /// Enumeration that defines the physical format of the pixel. A value of PixelBltOnly /// implies that a linear frame buffer is not available for this mode. /// EFI_GRAPHICS_PIXEL_FORMAT PixelFormat; /// - /// This bit-mask is only valid if PixelFormat is set to PixelPixelBitMask. + /// This bit-mask is only valid if PixelFormat is set to PixelPixelBitMask. /// A bit being set defines what bits are used for what purpose such as Red, Green, Blue, or Reserved. /// EFI_PIXEL_BITMASK PixelInformation; /// /// Defines the number of pixel elements per video memory line. - /// + /// UINT32 PixelsPerScanLine; } EFI_GRAPHICS_OUTPUT_MODE_INFORMATION; @@ -116,7 +116,7 @@ EFI_STATUS ); /** - Set the video device into the specified mode and clears the visible portions of + Set the video device into the specified mode and clears the visible portions of the output display to black. @param This The EFI_GRAPHICS_OUTPUT_PROTOCOL instance. @@ -151,47 +151,47 @@ typedef union { /// typedef enum { /// - /// Write data from the BltBuffer pixel (0, 0) - /// directly to every pixel of the video display rectangle - /// (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). - /// Only one pixel will be used from the BltBuffer. Delta is NOT used. + /// Write data from the BltBuffer pixel (0, 0) + /// directly to every pixel of the video display rectangle + /// (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). + /// Only one pixel will be used from the BltBuffer. Delta is NOT used. /// EfiBltVideoFill, - + /// - /// Read data from the video display rectangle - /// (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in - /// the BltBuffer rectangle (DestinationX, DestinationY ) - /// (DestinationX + Width, DestinationY + Height). If DestinationX or - /// DestinationY is not zero then Delta must be set to the length in bytes - /// of a row in the BltBuffer. + /// Read data from the video display rectangle + /// (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in + /// the BltBuffer rectangle (DestinationX, DestinationY ) + /// (DestinationX + Width, DestinationY + Height). If DestinationX or + /// DestinationY is not zero then Delta must be set to the length in bytes + /// of a row in the BltBuffer. /// EfiBltVideoToBltBuffer, - + /// - /// Write data from the BltBuffer rectangle - /// (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the - /// video display rectangle (DestinationX, DestinationY) - /// (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is - /// not zero then Delta must be set to the length in bytes of a row in the + /// Write data from the BltBuffer rectangle + /// (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the + /// video display rectangle (DestinationX, DestinationY) + /// (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is + /// not zero then Delta must be set to the length in bytes of a row in the /// BltBuffer. /// - EfiBltBufferToVideo, - + EfiBltBufferToVideo, + /// /// Copy from the video display rectangle (SourceX, SourceY) - /// (SourceX + Width, SourceY + Height) to the video display rectangle - /// (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). + /// (SourceX + Width, SourceY + Height) to the video display rectangle + /// (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). /// The BltBuffer and Delta are not used in this mode. /// EfiBltVideoToVideo, - + EfiGraphicsOutputBltOperationMax } EFI_GRAPHICS_OUTPUT_BLT_OPERATION; /** Blt a rectangle of pixels on the graphics screen. Blt stands for BLock Transfer. - + @param This Protocol instance pointer. @param BltBuffer The data to transfer to the graphics screen. Size is at least Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL). @@ -250,15 +250,15 @@ typedef struct { /// EFI_PHYSICAL_ADDRESS FrameBufferBase; /// - /// Amount of frame buffer needed to support the active mode as defined by + /// Amount of frame buffer needed to support the active mode as defined by /// PixelsPerScanLine xVerticalResolution x PixelElementSize. /// UINTN FrameBufferSize; } EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE; /// -/// Provides a basic abstraction to set video modes and copy pixels to and from -/// the graphics controller's frame buffer. The linear address of the hardware +/// Provides a basic abstraction to set video modes and copy pixels to and from +/// the graphics controller's frame buffer. The linear address of the hardware /// frame buffer is also exposed so software can write directly to the video hardware. /// struct _EFI_GRAPHICS_OUTPUT_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/GuidedSectionExtraction.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/GuidedSectionExtraction.h index 8f35002cdd..02535ac811 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/GuidedSectionExtraction.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/GuidedSectionExtraction.h @@ -5,13 +5,13 @@ the section stream contained therein. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: PI Version 1.00. @@ -22,14 +22,14 @@ #define __GUID_SECTION_EXTRACTION_PROTOCOL_H__ // -// The protocol interface structures are identified by associating -// them with a GUID. Each instance of a protocol with a given -// GUID must have the same interface structure. While all instances -// of the GUIDed Section Extraction Protocol must have the same -// interface structure, they do not all have the same GUID. The -// GUID that is associated with an instance of the GUIDed Section -// Extraction Protocol is used to correlate it with the GUIDed -// section type that it is intended to process. +// The protocol interface structures are identified by associating +// them with a GUID. Each instance of a protocol with a given +// GUID must have the same interface structure. While all instances +// of the GUIDed Section Extraction Protocol must have the same +// interface structure, they do not all have the same GUID. The +// GUID that is associated with an instance of the GUIDed Section +// Extraction Protocol is used to correlate it with the GUIDed +// section type that it is intended to process. // typedef struct _EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL; @@ -61,9 +61,9 @@ typedef struct _EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL EFI_GUIDED_SECTION_EXTRAC EFI_TPL above TPL_NOTIFY is undefined. Type EFI_TPL is defined in RaiseTPL() in the UEFI 2.0 specification. - + @param This Indicates the EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL instance. - + @param InputSection Buffer containing the input GUIDed section to be processed. OutputBuffer OutputBuffer is allocated from boot services pool diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Hash.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Hash.h index 872dfb7abf..035f4d57aa 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Hash.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Hash.h @@ -1,18 +1,18 @@ /** @file EFI_HASH_SERVICE_BINDING_PROTOCOL as defined in UEFI 2.0. EFI_HASH_PROTOCOL as defined in UEFI 2.0. - The EFI Hash Service Binding Protocol is used to locate hashing services support - provided by a driver and to create and destroy instances of the EFI Hash Protocol + The EFI Hash Service Binding Protocol is used to locate hashing services support + provided by a driver and to create and destroy instances of the EFI Hash Protocol so that a multiple drivers can use the underlying hashing services. Copyright (c) 2006 - 2014, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -23,7 +23,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. { \ 0x42881c98, 0xa4f3, 0x44b0, {0xa3, 0x9d, 0xdf, 0xa1, 0x86, 0x67, 0xd8, 0xcd } \ } - + #define EFI_HASH_PROTOCOL_GUID \ { \ 0xc5184932, 0xdba5, 0x46db, {0xa5, 0xba, 0xcc, 0x0b, 0xda, 0x9c, 0x14, 0x35 } \ @@ -37,17 +37,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define EFI_HASH_ALGORITHM_SHA224_GUID \ { \ 0x8df01a06, 0x9bd5, 0x4bf7, {0xb0, 0x21, 0xdb, 0x4f, 0xd9, 0xcc, 0xf4, 0x5b } \ - } + } #define EFI_HASH_ALGORITHM_SHA256_GUID \ { \ 0x51aa59de, 0xfdf2, 0x4ea3, {0xbc, 0x63, 0x87, 0x5f, 0xb7, 0x84, 0x2e, 0xe9 } \ - } + } #define EFI_HASH_ALGORITHM_SHA384_GUID \ { \ 0xefa96432, 0xde33, 0x4dd2, {0xae, 0xe6, 0x32, 0x8c, 0x33, 0xdf, 0x77, 0x7a } \ - } + } #define EFI_HASH_ALGORITHM_SHA512_GUID \ { \ @@ -106,7 +106,7 @@ typedef union { @retval EFI_SUCCESS Hash size returned successfully. @retval EFI_INVALID_PARAMETER HashSize is NULL or HashAlgorithm is NULL. - @retval EFI_UNSUPPORTED The algorithm specified by HashAlgorithm is not supported + @retval EFI_UNSUPPORTED The algorithm specified by HashAlgorithm is not supported by this driver. **/ @@ -116,7 +116,7 @@ EFI_STATUS IN CONST EFI_HASH_PROTOCOL *This, IN CONST EFI_GUID *HashAlgorithm, OUT UINTN *HashSize - ); + ); /** Creates a hash for the specified message text. @@ -127,13 +127,13 @@ EFI_STATUS existing hash (TRUE). @param[in] Message Points to the start of the message. @param[in] MessageSize The size of Message, in bytes. - @param[in,out] Hash On input, if Extend is TRUE, then this parameter holds a pointer - to a pointer to an array containing the hash to extend. If Extend - is FALSE, then this parameter holds a pointer to a pointer to a - caller-allocated array that will receive the result of the hash - computation. On output (regardless of the value of Extend), the + @param[in,out] Hash On input, if Extend is TRUE, then this parameter holds a pointer + to a pointer to an array containing the hash to extend. If Extend + is FALSE, then this parameter holds a pointer to a pointer to a + caller-allocated array that will receive the result of the hash + computation. On output (regardless of the value of Extend), the array will contain the result of the hash computation. - + @retval EFI_SUCCESS Hash returned successfully. @retval EFI_INVALID_PARAMETER Message or Hash, HashAlgorithm is NULL or MessageSize is 0. MessageSize is not an integer multiple of block size. @@ -150,10 +150,10 @@ EFI_STATUS IN CONST UINT8 *Message, IN UINT64 MessageSize, IN OUT EFI_HASH_OUTPUT *Hash - ); + ); /// -/// This protocol allows creating a hash of an arbitrary message digest +/// This protocol allows creating a hash of an arbitrary message digest /// using one or more hash algorithms. /// struct _EFI_HASH_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiConfigAccess.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiConfigAccess.h index 3b076511c6..7a7c8dcc51 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiConfigAccess.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiConfigAccess.h @@ -1,18 +1,18 @@ /** @file - The EFI HII results processing protocol invokes this type of protocol - when it needs to forward results to a driver's configuration handler. - This protocol is published by drivers providing and requesting + The EFI HII results processing protocol invokes this type of protocol + when it needs to forward results to a driver's configuration handler. + This protocol is published by drivers providing and requesting configuration data from HII. It may only be invoked by HII. - + Copyright (c) 2006 - 2016, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -43,7 +43,7 @@ typedef UINTN EFI_BROWSER_ACTION; #define EFI_BROWSER_ACTION_DEFAULT_FIRMWARE 0x4000 /** - + This function allows the caller to request the current configuration for one or more named elements. The resulting string is in <ConfigAltResp> format. Any and all alternative @@ -64,12 +64,12 @@ typedef UINTN EFI_BROWSER_ACTION; includes the routing information as well as the configurable name / value pairs. It is invalid for this string to be in - <MultiConfigRequest> format. - If a NULL is passed in for the Request field, - all of the settings being abstracted by this function - will be returned in the Results field. In addition, - if a ConfigHdr is passed in with no request elements, - all of the settings being abstracted for that particular + <MultiConfigRequest> format. + If a NULL is passed in for the Request field, + all of the settings being abstracted by this function + will be returned in the Results field. In addition, + if a ConfigHdr is passed in with no request elements, + all of the settings being abstracted for that particular ConfigHdr reference will be returned in the Results Field. @param Progress On return, points to a character in the @@ -95,7 +95,7 @@ typedef UINTN EFI_BROWSER_ACTION; stored awaiting possible future protocols. - @retval EFI_NOT_FOUND A configuration element matching + @retval EFI_NOT_FOUND A configuration element matching the routing data is not found. Progress set to the first character in the routing header. @@ -121,7 +121,7 @@ EFI_STATUS /** - + This function applies changes in a driver's configuration. Input is a Configuration, which has the routing data for this driver followed by name / value configuration pairs. The driver @@ -134,8 +134,8 @@ EFI_STATUS @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. @param Configuration A null-terminated Unicode string in - <ConfigString> format. - + <ConfigString> format. + @param Progress A pointer to a string filled in with the offset of the most recent '&' before the first failing name / value pair (or the @@ -146,16 +146,16 @@ EFI_STATUS @retval EFI_SUCCESS The results have been distributed or are awaiting distribution. - + @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the results that must be stored awaiting possible future protocols. - + @retval EFI_INVALID_PARAMETERS Passing in a NULL for the Results parameter would result in this type of error. - + @retval EFI_NOT_FOUND Target for the specified routing data was not found @@ -169,7 +169,7 @@ EFI_STATUS ); /** - + This function is called to provide results data to the driver. This data consists of a unique key that is used to identify which data is either being passed back or being asked for. @@ -178,7 +178,7 @@ EFI_STATUS @param Action Specifies the type of action taken by the browser. @param QuestionId A unique value which is sent to the original exporting driver so that it can identify the type - of data to expect. The format of the data tends to + of data to expect. The format of the data tends to vary based on the opcode that generated the callback. @param Type The type of value for the question. @param Value A pointer to the data being sent to the original @@ -204,7 +204,7 @@ EFI_STATUS OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest ) ; - + /// /// This protocol provides a callable interface between the HII and /// drivers. Only drivers which provide IFR data to HII are required diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiConfigKeyword.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiConfigKeyword.h index 1c2d3c67dc..28ce904bb5 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiConfigKeyword.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiConfigKeyword.h @@ -1,16 +1,16 @@ /** @file - The file provides the mechanism to set and get the values - associated with a keyword exposed through a x-UEFI- prefixed + The file provides the mechanism to set and get the values + associated with a keyword exposed through a x-UEFI- prefixed configuration language namespace. - + Copyright (c) 2015 - 2016, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -40,18 +40,18 @@ typedef struct _EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL EFI_CONFIG_KEYWORD_HANDLER_P This function accepts a <MultiKeywordResp> formatted string, finds the associated keyword owners, creates a <MultiConfigResp> string from it and forwards it to the EFI_HII_ROUTING_PROTOCOL.RouteConfig function. - - If there is an issue in resolving the contents of the KeywordString, then the - function returns an error and also sets the Progress and ProgressErr with the + + If there is an issue in resolving the contents of the KeywordString, then the + function returns an error and also sets the Progress and ProgressErr with the appropriate information about where the issue occurred and additional data about - the nature of the issue. - + the nature of the issue. + In the case when KeywordString containing multiple keywords, when an EFI_NOT_FOUND error is generated during processing the second or later keyword element, the system - storage associated with earlier keywords is not modified. All elements of the + storage associated with earlier keywords is not modified. All elements of the KeywordString must successfully pass all tests for format and access prior to making any modifications to storage. - + In the case when EFI_DEVICE_ERROR is returned from the processing of a KeywordString containing multiple keywords, the state of storage associated with earlier keywords is undefined. @@ -59,18 +59,18 @@ typedef struct _EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL EFI_CONFIG_KEYWORD_HANDLER_P @param This Pointer to the EFI_KEYWORD_HANDLER _PROTOCOL instance. - @param KeywordString A null-terminated string in <MultiKeywordResp> format. + @param KeywordString A null-terminated string in <MultiKeywordResp> format. - @param Progress On return, points to a character in the KeywordString. - Points to the string's NULL terminator if the request - was successful. Points to the most recent '&' before + @param Progress On return, points to a character in the KeywordString. + Points to the string's NULL terminator if the request + was successful. Points to the most recent '&' before the first failing name / value pair (or the beginning of the string if the failure is in the first name / value pair) if the request was not successful. @param ProgressErr If during the processing of the KeywordString there was - a failure, this parameter gives additional information - about the possible source of the problem. The various + a failure, this parameter gives additional information + about the possible source of the problem. The various errors are defined in "Related Definitions" below. @@ -78,23 +78,23 @@ typedef struct _EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL EFI_CONFIG_KEYWORD_HANDLER_P @retval EFI_INVALID_PARAMETER One or more of the following are TRUE: 1. KeywordString is NULL. - 2. Parsing of the KeywordString resulted in an + 2. Parsing of the KeywordString resulted in an error. See Progress and ProgressErr for more data. - @retval EFI_NOT_FOUND An element of the KeywordString was not found. + @retval EFI_NOT_FOUND An element of the KeywordString was not found. See ProgressErr for more data. - @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. + @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. See ProgressErr for more data. - - @retval EFI_ACCESS_DENIED The action violated system policy. See ProgressErr + + @retval EFI_ACCESS_DENIED The action violated system policy. See ProgressErr for more data. @retval EFI_DEVICE_ERROR An unexpected system error occurred. See ProgressErr for more data. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_CONFIG_KEYWORD_HANDLER_SET_DATA) ( IN EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL *This, @@ -106,56 +106,56 @@ EFI_STATUS /** - This function accepts a <MultiKeywordRequest> formatted string, finds the underlying + This function accepts a <MultiKeywordRequest> formatted string, finds the underlying keyword owners, creates a <MultiConfigRequest> string from it and forwards it to the EFI_HII_ROUTING_PROTOCOL.ExtractConfig function. - + If there is an issue in resolving the contents of the KeywordString, then the function returns an EFI_INVALID_PARAMETER and also set the Progress and ProgressErr with the appropriate information about where the issue occurred and additional data about the nature of the issue. - + In the case when KeywordString is NULL, or contains multiple keywords, or when EFI_NOT_FOUND is generated while processing the keyword elements, the Results string - contains values returned for all keywords processed prior to the keyword generating the + contains values returned for all keywords processed prior to the keyword generating the error but no values for the keyword with error or any following keywords. - + @param This Pointer to the EFI_KEYWORD_HANDLER _PROTOCOL instance. - + @param NameSpaceId A null-terminated string containing the platform configuration language to search through in the system. If a NULL is passed in, then it is assumed that any platform configuration language with the prefix of "x-UEFI-" are searched. - + @param KeywordString A null-terminated string in <MultiKeywordRequest> format. If a - NULL is passed in the KeywordString field, all of the known - keywords in the system for the NameSpaceId specified are + NULL is passed in the KeywordString field, all of the known + keywords in the system for the NameSpaceId specified are returned in the Results field. - + @param Progress On return, points to a character in the KeywordString. Points - to the string's NULL terminator if the request was successful. + to the string's NULL terminator if the request was successful. Points to the most recent '&' before the first failing name / value pair (or the beginning of the string if the failure is in the first name / value pair) if the request was not successful. - + @param ProgressErr If during the processing of the KeywordString there was a - failure, this parameter gives additional information about the + failure, this parameter gives additional information about the possible source of the problem. See the definitions in SetData() for valid value definitions. - + @param Results A null-terminated string in <MultiKeywordResp> format is returned - which has all the values filled in for the keywords in the + which has all the values filled in for the keywords in the KeywordString. This is a callee-allocated field, and must be freed - by the caller after being used. + by the caller after being used. @retval EFI_SUCCESS The specified action was completed successfully. - + @retval EFI_INVALID_PARAMETER One or more of the following are TRUE: 1.Progress, ProgressErr, or Results is NULL. 2.Parsing of the KeywordString resulted in an error. See Progress and ProgressErr for more data. - + @retval EFI_NOT_FOUND An element of the KeywordString was not found. See ProgressErr for more data. @@ -165,7 +165,7 @@ EFI_STATUS @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. See ProgressErr for more data. - + @retval EFI_ACCESS_DENIED The action violated system policy. See ProgressErr for more data. @@ -173,20 +173,20 @@ EFI_STATUS for more data. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_CONFIG_KEYWORD_HANDLER_GET_DATA) ( IN EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL *This, IN CONST EFI_STRING NameSpaceId, OPTIONAL IN CONST EFI_STRING KeywordString, OPTIONAL - OUT EFI_STRING *Progress, + OUT EFI_STRING *Progress, OUT UINT32 *ProgressErr, OUT EFI_STRING *Results ); /// -/// The EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL provides the mechanism -/// to set and get the values associated with a keyword exposed +/// The EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL provides the mechanism +/// to set and get the values associated with a keyword exposed /// through a x-UEFI- prefixed configuration language namespace /// diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiConfigRouting.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiConfigRouting.h index 89f3f9b2db..f412acc92b 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiConfigRouting.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiConfigRouting.h @@ -4,15 +4,15 @@ It then serves as the single point to receive configuration information from configuration applications, routing the results to the appropriate drivers. - + Copyright (c) 2006 - 2013, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -26,7 +26,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL; /** - + This function allows the caller to request the current configuration for one or more named elements from one or more drivers. The resulting string is in the standard HII @@ -84,8 +84,8 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL; for the Request parameter would result in this type of error. The Progress parameter - is set to NULL. - + is set to NULL. + @retval EFI_NOT_FOUND Routing data doesn't match any known driver. Progress set to the "G" in "GUID" of the @@ -100,8 +100,8 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL; error, or the beginning of the string. @retval EFI_INVALID_PARAMETER The ExtractConfig function of the - underlying HII Configuration - Access Protocol returned + underlying HII Configuration + Access Protocol returned EFI_INVALID_PARAMETER. Progress set to most recent & before the error or the beginning of the @@ -118,32 +118,32 @@ EFI_STATUS ); /** - This function allows the caller to request the current configuration + This function allows the caller to request the current configuration for the entirety of the current HII database and returns the data in a null-terminated string. This function allows the caller to request the current configuration for all of the current HII database. The results include both the current and alternate configurations as - described in ExtractConfig() above. - + described in ExtractConfig() above. + @param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance. - + @param Results Null-terminated Unicode string in <MultiConfigAltResp> format which has all values - filled in for the entirety of the current HII - database. String to be allocated by the called + filled in for the entirety of the current HII + database. String to be allocated by the called function. De-allocation is up to the caller. - + @retval EFI_SUCCESS The Results string is filled with the values corresponding to all requested names. - + @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the results that must be stored awaiting possible future protocols. - + @retval EFI_INVALID_PARAMETERS For example, passing in a NULL for the Results parameter would result in this type of @@ -158,7 +158,7 @@ EFI_STATUS ); /** - + This function routes the results of processing forms to the appropriate targets. It scans for <ConfigHdr> within the string and passes the header and subsequent body to the driver whose @@ -182,16 +182,16 @@ EFI_STATUS @retval EFI_SUCCESS The results have been distributed or are awaiting distribution. - + @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the results that must be stored awaiting possible future protocols. - + @retval EFI_INVALID_PARAMETERS Passing in a NULL for the Results parameter would result in this type of error. - + @retval EFI_NOT_FOUND The target for the specified routing data was not found. @@ -206,7 +206,7 @@ EFI_STATUS /** - + This function extracts the current configuration from a block of bytes. To do so, it requires that the ConfigRequest string consists of a list of <BlockName> formatted names. It uses the @@ -228,7 +228,7 @@ EFI_STATUS @param Config The filled-in configuration string. String allocated by the function. Returned only if - call is successful. The null-terminated string + call is successful. The null-terminated string will be <ConfigResp> format. @param Progress A pointer to a string filled in with the @@ -256,7 +256,7 @@ EFI_STATUS @retval EFI_NOT_FOUND The target for the specified routing data was not found. Progress points to the 'G' in "GUID" of the errant routing - data. + data. @retval EFI_DEVICE_ERROR The block is not large enough. Progress undefined. @retval EFI_INVALID_PARAMETER Encountered non <BlockName> @@ -310,7 +310,7 @@ EFI_STATUS @param BlockSize The length of the Block in units of UINT8. On input, this is the size of the Block. On - output, if successful, contains the largest + output, if successful, contains the largest index of the modified byte in the Block, or the required buffer size if the Block is not large enough. @@ -339,7 +339,7 @@ EFI_STATUS @retval EFI_NOT_FOUND Target for the specified routing data was not found. Progress points to the "G" in "GUID" of the errant routing data. - @retval EFI_BUFFER_TOO_SMALL Block not large enough. Progress undefined. + @retval EFI_BUFFER_TOO_SMALL Block not large enough. Progress undefined. BlockSize is updated with the required buffer size. **/ @@ -354,48 +354,48 @@ EFI_STATUS ); /** - This helper function is to be called by drivers to extract portions of + This helper function is to be called by drivers to extract portions of a larger configuration string. - + @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance. @param ConfigResp A null-terminated string in <ConfigAltResp> format. - @param Guid A pointer to the GUID value to search for in the - routing portion of the ConfigResp string when retrieving - the requested data. If Guid is NULL, then all GUID + @param Guid A pointer to the GUID value to search for in the + routing portion of the ConfigResp string when retrieving + the requested data. If Guid is NULL, then all GUID + values will be searched for. + @param Name A pointer to the NAME value to search for in the + routing portion of the ConfigResp string when retrieving + the requested data. If Name is NULL, then all Name values will be searched for. - @param Name A pointer to the NAME value to search for in the - routing portion of the ConfigResp string when retrieving - the requested data. If Name is NULL, then all Name - values will be searched for. - @param DevicePath A pointer to the PATH value to search for in the - routing portion of the ConfigResp string when retrieving - the requested data. If DevicePath is NULL, then all - DevicePath values will be searched for. - @param AltCfgId A pointer to the ALTCFG value to search for in the - routing portion of the ConfigResp string when retrieving - the requested data. If this parameter is NULL, + @param DevicePath A pointer to the PATH value to search for in the + routing portion of the ConfigResp string when retrieving + the requested data. If DevicePath is NULL, then all + DevicePath values will be searched for. + @param AltCfgId A pointer to the ALTCFG value to search for in the + routing portion of the ConfigResp string when retrieving + the requested data. If this parameter is NULL, then the current setting will be retrieved. - @param AltCfgResp A pointer to a buffer which will be allocated by the - function which contains the retrieved string as requested. - This buffer is only allocated if the call was successful. + @param AltCfgResp A pointer to a buffer which will be allocated by the + function which contains the retrieved string as requested. + This buffer is only allocated if the call was successful. The null-terminated string will be <ConfigResp> format. - - @retval EFI_SUCCESS The request succeeded. The requested data was extracted + + @retval EFI_SUCCESS The request succeeded. The requested data was extracted and placed in the newly allocated AltCfgResp buffer. - @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate AltCfgResp. + @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate AltCfgResp. @retval EFI_INVALID_PARAMETER Any parameter is invalid. @retval EFI_NOT_FOUND The target for the specified routing data was not found. **/ typedef -EFI_STATUS +EFI_STATUS (EFIAPI * EFI_HII_GET_ALT_CFG)( - IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This, - IN CONST EFI_STRING ConfigResp, - IN CONST EFI_GUID *Guid, - IN CONST EFI_STRING Name, - IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, + IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This, + IN CONST EFI_STRING ConfigResp, + IN CONST EFI_GUID *Guid, + IN CONST EFI_STRING Name, + IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, IN CONST UINT16 *AltCfgId, - OUT EFI_STRING *AltCfgResp + OUT EFI_STRING *AltCfgResp ); /// diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiDatabase.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiDatabase.h index 435fe1be78..51154a096e 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiDatabase.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiDatabase.h @@ -1,15 +1,15 @@ /** @file The file provides Database manager for HII-related data structures. - + 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -25,7 +25,7 @@ typedef struct _EFI_HII_DATABASE_PROTOCOL EFI_HII_DATABASE_PROTOCOL; /// /// EFI_HII_DATABASE_NOTIFY_TYPE. -/// +/// typedef UINTN EFI_HII_DATABASE_NOTIFY_TYPE; #define EFI_HII_DATABASE_NOTIFY_NEW_PACK 0x00000001 @@ -33,7 +33,7 @@ typedef UINTN EFI_HII_DATABASE_NOTIFY_TYPE; #define EFI_HII_DATABASE_NOTIFY_EXPORT_PACK 0x00000004 #define EFI_HII_DATABASE_NOTIFY_ADD_PACK 0x00000008 /** - + Functions which are registered to receive notification of database events have this prototype. The actual event is encoded in NotifyType. The following table describes how PackageType, @@ -48,8 +48,8 @@ typedef UINTN EFI_HII_DATABASE_NOTIFY_TYPE; field of EFI_HII_PACKAGE_GUID_HEADER. Otherwise, it must be NULL. - @param Package Points to the package referred to by the notification. - + @param Package Points to the package referred to by the notification. + @param Handle The handle of the package list which contains the specified package. @@ -80,7 +80,7 @@ EFI_STATUS be called. For each call to NewPackageList(), there should be a corresponding call to EFI_HII_DATABASE_PROTOCOL.RemovePackageList(). - + @param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance. @param PackageList A pointer to an EFI_HII_PACKAGE_LIST_HEADER structure. @@ -88,7 +88,7 @@ EFI_STATUS @param DriverHandle Associate the package list with this EFI handle. If a NULL is specified, this data will not be associate with any drivers and cannot have a callback induced. - + @param Handle A pointer to the EFI_HII_HANDLE instance. @retval EFI_SUCCESS The package list associated with the @@ -121,10 +121,10 @@ EFI_STATUS be a corresponding call to RemovePackageList. @param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance. - + @param Handle The handle that was registered to the data that is requested for removal. - + @retval EFI_SUCCESS The data associated with the Handle was removed from the HII database. @retval EFI_NOT_FOUND The specified Handle is not in database. @@ -139,7 +139,7 @@ EFI_STATUS /** - + This function updates the existing package list (which has the specified Handle) in the HII databases, using the new package list specified by PackageList. The update process has the @@ -162,18 +162,18 @@ EFI_STATUS ADD_PACK. @param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance. - + @param Handle The handle that was registered to the data that is requested for removal. - + @param PackageList A pointer to an EFI_HII_PACKAGE_LIST package. - + @retval EFI_SUCCESS The HII database was successfully updated. - + @retval EFI_OUT_OF_RESOURCES Unable to allocate enough memory for the updated database. - + @retval EFI_INVALID_PARAMETER PackageList was NULL. @retval EFI_NOT_FOUND The specified Handle is not in database. @@ -188,25 +188,25 @@ EFI_STATUS /** - - This function returns a list of the package handles of the - specified type that are currently active in the database. The - pseudo-type EFI_HII_PACKAGE_TYPE_ALL will cause all package + + This function returns a list of the package handles of the + specified type that are currently active in the database. The + pseudo-type EFI_HII_PACKAGE_TYPE_ALL will cause all package handles to be listed. - + @param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance. - + @param PackageType Specifies the package type of the packages to list or EFI_HII_PACKAGE_TYPE_ALL for all packages to be listed. - + @param PackageGuid If PackageType is EFI_HII_PACKAGE_TYPE_GUID, then this is the pointer to the GUID which must match the Guid field of EFI_HII_PACKAGE_GUID_HEADER. Otherwise, it must be NULL. - + @param HandleBufferLength On input, a pointer to the length of the handle buffer. On output, the length of the handle buffer @@ -258,7 +258,7 @@ EFI_STATUS @param Handle An EFI_HII_HANDLE that corresponds to the desired package list in the HII database to export or NULL to indicate all package lists - should be exported. + should be exported. @param BufferSize On input, a pointer to the length of the buffer. On output, the length of the @@ -267,18 +267,18 @@ EFI_STATUS @param Buffer A pointer to a buffer that will contain the results of the export function. - - + + @retval EFI_SUCCESS Package exported. - + @retval EFI_OUT_OF_RESOURCES BufferSize is too small to hold the package. @retval EFI_NOT_FOUND The specified Handle could not be found in the current database. - + @retval EFI_INVALID_PARAMETER BufferSize was NULL. - - @retval EFI_INVALID_PARAMETER The value referenced by BufferSize was not zero + + @retval EFI_INVALID_PARAMETER The value referenced by BufferSize was not zero and Buffer was NULL. **/ typedef @@ -292,8 +292,8 @@ EFI_STATUS /** - - + + This function registers a function which will be called when specified actions related to packages of the specified type occur in the HII database. By registering a function, other @@ -302,12 +302,12 @@ EFI_STATUS or application which registers a notification should use EFI_HII_DATABASE_PROTOCOL.UnregisterPackageNotify() before exiting. - - + + @param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance. @param PackageType The package type. See - EFI_HII_PACKAGE_TYPE_x in EFI_HII_PACKAGE_HEADER. + EFI_HII_PACKAGE_TYPE_x in EFI_HII_PACKAGE_HEADER. @param PackageGuid If PackageType is EFI_HII_PACKAGE_TYPE_GUID, then this is @@ -355,19 +355,19 @@ EFI_STATUS /** - + Removes the specified HII database package-related notification. - + @param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance. @param NotificationHandle The handle of the notification function being unregistered. - - @retval EFI_SUCCESS Successsfully unregistered the notification. - - @retval EFI_NOT_FOUND The incoming notification handle does not exist + + @retval EFI_SUCCESS Successsfully unregistered the notification. + + @retval EFI_NOT_FOUND The incoming notification handle does not exist in the current hii database. - + **/ typedef EFI_STATUS @@ -378,7 +378,7 @@ EFI_STATUS /** - + This routine retrieves an array of GUID values for each keyboard layout that was previously registered in the system. @@ -388,13 +388,13 @@ EFI_STATUS of the keyboard GUID buffer. On output, the length of the handle buffer that is required for the - handles found. - + handles found. + @param KeyGuidBuffer An array of keyboard layout GUID instances returned. @retval EFI_SUCCESS KeyGuidBuffer was updated successfully. - + @retval EFI_BUFFER_TOO_SMALL The KeyGuidBufferLength parameter indicates that KeyGuidBuffer is too small to @@ -403,7 +403,7 @@ EFI_STATUS with a value that will enable the data to fit. @retval EFI_INVALID_PARAMETER The KeyGuidBufferLength is NULL. - @retval EFI_INVALID_PARAMETER The value referenced by + @retval EFI_INVALID_PARAMETER The value referenced by KeyGuidBufferLength is not zero and KeyGuidBuffer is NULL. @retval EFI_NOT_FOUND There was no keyboard layout. @@ -419,14 +419,14 @@ EFI_STATUS /** - + This routine retrieves the requested keyboard layout. The layout is a physical description of the keys on a keyboard, and the character(s) that are associated with a particular set of key strokes. @param This A pointer to the EFI_HII_PROTOCOL instance. - + @param KeyGuid A pointer to the unique ID associated with a given keyboard layout. If KeyGuid is NULL then the current layout will be retrieved. @@ -434,13 +434,13 @@ EFI_STATUS @param KeyboardLayoutLength On input, a pointer to the length of the KeyboardLayout buffer. On output, the length of the data placed into KeyboardLayout. - + @param KeyboardLayout A pointer to a buffer containing the retrieved keyboard layout. - + @retval EFI_SUCCESS The keyboard layout was retrieved successfully. - + @retval EFI_NOT_FOUND The requested keyboard layout was not found. **/ @@ -454,7 +454,7 @@ EFI_STATUS ); /** - + This routine sets the default keyboard layout to the one referenced by KeyGuid. When this routine is called, an event will be signaled of the EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID @@ -481,21 +481,21 @@ EFI_STATUS ); /** - + Return the EFI handle associated with a package list. - + @param This A pointer to the EFI_HII_PROTOCOL instance. - + @param PackageListHandle An EFI_HII_HANDLE that corresponds to the desired package list in the HIIdatabase. - + @param DriverHandle On return, contains the EFI_HANDLE which was registered with the package list in NewPackageList(). - + @retval EFI_SUCCESS The DriverHandle was returned successfully. - + @retval EFI_INVALID_PARAMETER The PackageListHandle was not valid. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiFont.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiFont.h index b940734496..f7a16dc73c 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiFont.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiFont.h @@ -1,14 +1,14 @@ /** @file The file provides services to retrieve font information. - + 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -27,7 +27,7 @@ typedef VOID *EFI_FONT_HANDLE; /// /// EFI_HII_OUT_FLAGS. -/// +/// typedef UINT32 EFI_HII_OUT_FLAGS; #define EFI_HII_OUT_FLAG_CLIP 0x00000001 @@ -49,12 +49,12 @@ typedef struct _EFI_HII_ROW_INFO { UINTN StartIndex; /// /// The index of the last character in the string which is displayed on the line. - /// If this is the same as StartIndex, then no characters are displayed. + /// If this is the same as StartIndex, then no characters are displayed. /// UINTN EndIndex; UINTN LineHeight; ///< The height of the line, in pixels. UINTN LineWidth; ///< The width of the text on the line, in pixels. - + /// /// The font baseline offset in pixels from the bottom of the row, or 0 if none. /// @@ -80,7 +80,7 @@ typedef UINT32 EFI_FONT_INFO_MASK; // // EFI_FONT_INFO -// +// typedef struct { EFI_HII_FONT_STYLE FontStyle; UINT16 FontSize; ///< character cell height in pixels @@ -103,7 +103,7 @@ typedef struct _EFI_FONT_DISPLAY_INFO { EFI_GRAPHICS_OUTPUT_BLT_PIXEL ForegroundColor; EFI_GRAPHICS_OUTPUT_BLT_PIXEL BackgroundColor; EFI_FONT_INFO_MASK FontInfoMask; - EFI_FONT_INFO FontInfo; + EFI_FONT_INFO FontInfo; } EFI_FONT_DISPLAY_INFO; /** @@ -155,7 +155,7 @@ typedef struct _EFI_FONT_DISPLAY_INFO { @param Flags Describes how the string is to be drawn. - @param String Points to the null-terminated string to be + @param String Points to the null-terminated string to be @param StringInfo Points to the string output information, including the color and font. If NULL, then @@ -203,9 +203,9 @@ typedef struct _EFI_FONT_DISPLAY_INFO { overlap. @retval EFI_SUCCESS The string was successfully updated. - + @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for RowInfoArray or Blt. - + @retval EFI_INVALID_PARAMETER The String or Blt was NULL. @retval EFI_INVALID_PARAMETER Flags were invalid combination. @@ -276,7 +276,7 @@ EFI_STATUS @param Flags Describes how the string is to be drawn. - @param PackageList + @param PackageList The package list in the HII database to search for the specified string. @@ -342,8 +342,8 @@ EFI_STATUS Width was NULL. @retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL. @retval EFI_INVALID_PARAMETER Flags were invalid combination. - @retval EFI_NOT_FOUND The specified PackageList is not in the Database, - or the stringid is not in the specified PackageList. + @retval EFI_NOT_FOUND The specified PackageList is not in the Database, + or the stringid is not in the specified PackageList. **/ typedef @@ -424,26 +424,26 @@ EFI_STATUS to NULL if there are no more matching fonts. @param StringInfoIn Upon entry, points to the font to return - information about. If NULL, then the information + information about. If NULL, then the information about the system default font will be returned. @param StringInfoOut Upon return, contains the matching font's information. If NULL, then no information is returned. This buffer is allocated with a call to the Boot Service AllocatePool(). - It is the caller's responsibility to call the Boot + It is the caller's responsibility to call the Boot Service FreePool() when the caller no longer requires the contents of StringInfoOut. @param String Points to the string which will be tested to determine if all characters are available. If NULL, then any font is acceptable. - + @retval EFI_SUCCESS Matching font returned successfully. - + @retval EFI_NOT_FOUND No matching font was found. @retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the request. - + **/ typedef EFI_STATUS diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiImage.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiImage.h index 3407532ea2..8d7cf8d136 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiImage.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiImage.h @@ -1,14 +1,14 @@ /** @file The file provides services to access to images in the images database. - + Copyright (c) 2006 - 2016, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -25,18 +25,18 @@ typedef struct _EFI_HII_IMAGE_PROTOCOL EFI_HII_IMAGE_PROTOCOL; /// /// Flags in EFI_IMAGE_INPUT -/// +/// #define EFI_IMAGE_TRANSPARENT 0x00000001 /** - + Definition of EFI_IMAGE_INPUT. - + @param Flags Describe image characteristics. If EFI_IMAGE_TRANSPARENT is set, then the image was designed for transparent display. - @param Width Image width, in pixels. + @param Width Image width, in pixels. @param Height Image height, in pixels. @@ -44,7 +44,7 @@ typedef struct _EFI_HII_IMAGE_PROTOCOL EFI_HII_IMAGE_PROTOCOL; top-to-bottom. The size of the bitmap is Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL). - + **/ typedef struct _EFI_IMAGE_INPUT { UINT32 Flags; @@ -60,8 +60,8 @@ typedef struct _EFI_IMAGE_INPUT { owned by PackageList, and returns a new image identifier (ImageId). - @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance. - + @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance. + @param PackageList Handle of the package list where this image will be added. @param ImageId On return, contains the new image id, which is @@ -71,9 +71,9 @@ typedef struct _EFI_IMAGE_INPUT { @retval EFI_SUCCESS The new image was added successfully - + @retval EFI_OUT_OF_RESOURCES Could not add the image. - + @retval EFI_INVALID_PARAMETER Image is NULL or ImageId is NULL. @@ -100,21 +100,21 @@ EFI_STATUS updated to the size of buffer actually required to hold the image. - @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance. - + @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance. + @param PackageList The package list in the HII database to search for the specified image. - + @param ImageId The image's id, which is unique within PackageList. - + @param Image Points to the new image. - + @retval EFI_SUCCESS The image was returned successfully. @retval EFI_NOT_FOUND The image specified by ImageId is not available. Or The specified PackageList is not in the database. - + @retval EFI_INVALID_PARAMETER The Image or Langugae was NULL. @retval EFI_OUT_OF_RESOURCES The bitmap could not be retrieved because there was not enough memory. @@ -131,12 +131,12 @@ EFI_STATUS ); /** - + This function updates the image specified by ImageId in the specified PackageListHandle to the image specified by Image. - @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance. + @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance. @param PackageList The package list containing the images. @@ -145,10 +145,10 @@ EFI_STATUS @param Image Points to the image. @retval EFI_SUCCESS The image was successfully updated. - + @retval EFI_NOT_FOUND The image specified by ImageId is not in the database. - The specified PackageList is not in the database. - + The specified PackageList is not in the database. + @retval EFI_INVALID_PARAMETER The Image or Language was NULL. **/ @@ -176,9 +176,9 @@ typedef UINT32 EFI_HII_DRAW_FLAGS; #define EFI_HII_DIRECT_TO_SCREEN 0x00000080 /** - + Definition of EFI_IMAGE_OUTPUT. - + @param Width Width of the output image. @param Height Height of the output image. @@ -201,7 +201,7 @@ typedef struct _EFI_IMAGE_OUTPUT { /** - + This function renders an image to a bitmap or the screen using the specified color and options. It draws the image on an existing bitmap, allocates a new bitmap or uses the screen. The @@ -216,14 +216,14 @@ typedef struct _EFI_IMAGE_OUTPUT { specified by Bitmap. - @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance. - + @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance. + @param Flags Describes how the image is to be drawn. EFI_HII_DRAW_FLAGS is defined in Related Definitions, below. - - @param Image Points to the image to be displayed. - + + @param Image Points to the image to be displayed. + @param Blt If this points to a non-NULL on entry, this points to the image, which is Width pixels wide and Height pixels high. The image will be drawn onto @@ -259,7 +259,7 @@ EFI_STATUS ); /** - + This function renders an image as a bitmap or to the screen and can clip the image. The bitmap is either supplied by the caller or else is allocated by the function. The images can be drawn @@ -292,7 +292,7 @@ EFI_STATUS directly to the output device specified by Screen. Otherwise the image will be rendered to the bitmap specified by Bitmap. - @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance. + @param This A pointer to the EFI_HII_IMAGE_PROTOCOL instance. @param Flags Describes how the image is to be drawn. @@ -315,14 +315,14 @@ EFI_STATUS pixel in the image. @retval EFI_SUCCESS The image was successfully updated. - + @retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for RowInfoArray or Blt. - - @retval EFI_NOT_FOUND The image specified by ImageId is not in the database. - Or The specified PackageList is not in the database. - - @retval EFI_INVALID_PARAMETER The Blt was NULL. + + @retval EFI_NOT_FOUND The image specified by ImageId is not in the database. + Or The specified PackageList is not in the database. + + @retval EFI_INVALID_PARAMETER The Blt was NULL. **/ typedef diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiPackageList.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiPackageList.h index 3842973281..664bd5598b 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiPackageList.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiPackageList.h @@ -4,15 +4,15 @@ if the image contains a custom PE/COFF resource with the type 'HII'. The protocol's interface pointer points to the HII package list, which is contained in the resource's data. - + Copyright (c) 2009, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiString.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiString.h index 9e9f7ff507..e29ba3a9d5 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiString.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HiiString.h @@ -1,14 +1,14 @@ /** @file The file provides services to manipulate string data. - + Copyright (c) 2006 - 2011, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -25,8 +25,8 @@ typedef struct _EFI_HII_STRING_PROTOCOL EFI_HII_STRING_PROTOCOL; /** This function adds the string String to the group of strings owned by PackageList, with the specified font information StringFontInfo, and returns a new string id. - The new string identifier is guaranteed to be unique within the package list. - That new string identifier is reserved for all languages in the package list. + The new string identifier is guaranteed to be unique within the package list. + That new string identifier is reserved for all languages in the package list. @param This A pointer to the EFI_HII_STRING_PROTOCOL instance. @param PackageList The handle of the package list where this string will @@ -61,7 +61,7 @@ EFI_STATUS IN EFI_HII_HANDLE PackageList, OUT EFI_STRING_ID *StringId, IN CONST CHAR8 *Language, - IN CONST CHAR16 *LanguageName, OPTIONAL + IN CONST CHAR16 *LanguageName, OPTIONAL IN CONST EFI_STRING String, IN CONST EFI_FONT_INFO *StringFontInfo OPTIONAL ); @@ -89,7 +89,7 @@ EFI_STATUS @retval EFI_SUCCESS The string was returned successfully. @retval EFI_NOT_FOUND The string specified by StringId is not available. The specified PackageList is not in the database. - @retval EFI_INVALID_LANGUAGE The string specified by StringId is available but + @retval EFI_INVALID_LANGUAGE The string specified by StringId is available but not in the specified language. @retval EFI_BUFFER_TOO_SMALL The buffer specified by StringSize is too small to hold the string. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Http.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Http.h index 84de6bd37b..1f650763c4 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Http.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Http.h @@ -305,16 +305,16 @@ typedef struct { @param[in] This Pointer to EFI_HTTP_PROTOCOL instance. @param[out] HttpConfigData Point to buffer for operational parameters of this - HTTP instance. It is the responsibility of the caller - to allocate the memory for HttpConfigData and - HttpConfigData->AccessPoint.IPv6Node/IPv4Node. In fact, - it is recommended to allocate sufficient memory to record + HTTP instance. It is the responsibility of the caller + to allocate the memory for HttpConfigData and + HttpConfigData->AccessPoint.IPv6Node/IPv4Node. In fact, + it is recommended to allocate sufficient memory to record IPv6Node since it is big enough for all possibilities. @retval EFI_SUCCESS Operation succeeded. @retval EFI_INVALID_PARAMETER This is NULL. HttpConfigData is NULL. - HttpConfigData->AccessPoint.IPv4Node or + HttpConfigData->AccessPoint.IPv4Node or HttpConfigData->AccessPoint.IPv6Node is NULL. @retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been started. **/ @@ -364,7 +364,7 @@ EFI_STATUS ); /** - The Request() function queues an HTTP request to this HTTP instance, + The Request() function queues an HTTP request to this HTTP instance, similar to Transmit() function in the EFI TCP driver. When the HTTP request is sent successfully, or if there is an error, Status in token will be updated and Event will be signaled. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HttpBootCallback.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HttpBootCallback.h index 93423e15a8..27db2f2275 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HttpBootCallback.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/HttpBootCallback.h @@ -43,7 +43,7 @@ typedef enum { /// HttpBootHttpRequest, /// - /// Data points to an EFI_HTTP_MESSAGE structure, which contians a received HTTP + /// Data points to an EFI_HTTP_MESSAGE structure, which contians a received HTTP /// response message. /// HttpBootHttpResponse, @@ -72,7 +72,7 @@ typedef enum { @param[in] DataLength The length in bytes of the buffer pointed to by Data. @param[in] Data A pointer to the buffer of data, the data type is specified by DataType. - + @retval EFI_SUCCESS Tells the HTTP Boot driver to continue the HTTP Boot process. @retval EFI_ABORTED Tells the HTTP Boot driver to abort the current HTTP Boot process. **/ @@ -87,7 +87,7 @@ EFI_STATUS ); /// -/// EFI HTTP Boot Callback Protocol is invoked when the HTTP Boot driver is about to transmit or +/// EFI HTTP Boot Callback Protocol is invoked when the HTTP Boot driver is about to transmit or /// has received a packet. The EFI HTTP Boot Callback Protocol must be installed on the same handle /// as the Load File Protocol for the HTTP Boot. /// diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/I2cBusConfigurationManagement.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/I2cBusConfigurationManagement.h index b29333e000..225654a936 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/I2cBusConfigurationManagement.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/I2cBusConfigurationManagement.h @@ -1,19 +1,19 @@ /** @file I2C Bus Configuration Management Protocol as defined in the PI 1.3 specification. - The EFI I2C bus configuration management protocol provides platform specific - services that allow the I2C host protocol to reconfigure the switches and multiplexers - and set the clock frequency for the I2C bus. This protocol also enables the I2C host protocol + The EFI I2C bus configuration management protocol provides platform specific + services that allow the I2C host protocol to reconfigure the switches and multiplexers + and set the clock frequency for the I2C bus. This protocol also enables the I2C host protocol to reset an I2C device which may be locking up the I2C bus by holding the clock or data line low. Copyright (c) 2013, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This protocol is from PI Version 1.3. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/I2cEnumerate.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/I2cEnumerate.h index 00f80d0b68..a1e0428746 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/I2cEnumerate.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/I2cEnumerate.h @@ -4,13 +4,13 @@ This protocol supports the enumerations of device on the I2C bus. Copyright (c) 2013, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This protocol is from PI Version 1.3. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/I2cHost.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/I2cHost.h index fcd82de6b9..781021c7d2 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/I2cHost.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/I2cHost.h @@ -1,17 +1,17 @@ /** @file I2C Host Protocol as defined in the PI 1.3 specification. - This protocol provides callers with the ability to do I/O transactions + This protocol provides callers with the ability to do I/O transactions to all of the devices on the I2C bus. Copyright (c) 2013 - 2015, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This protocol is from PI Version 1.3. @@ -50,7 +50,7 @@ typedef struct _EFI_I2C_HOST_PROTOCOL EFI_I2C_HOST_PROTOCOL; This routine must be called at or below TPL_NOTIFY. For synchronous requests this routine must be called at or below TPL_CALLBACK. - + The I2C host protocol uses the concept of I2C bus configurations to describe the I2C bus. An I2C bus configuration is defined as a unique setting of the multiplexers and switches in the I2C bus diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/I2cIo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/I2cIo.h index 4e4267d838..e321ce34c1 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/I2cIo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/I2cIo.h @@ -1,17 +1,17 @@ /** @file I2C I/O Protocol as defined in the PI 1.3 specification. - The EFI I2C I/O protocol enables the user to manipulate a single + The EFI I2C I/O protocol enables the user to manipulate a single I2C device independent of the host controller and I2C design. Copyright (c) 2013 - 2015, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This protocol is from PI Version 1.3. @@ -66,7 +66,7 @@ typedef struct _EFI_I2C_IO_PROTOCOL EFI_I2C_IO_PROTOCOL; The upper layer driver writer provides the following to the platform vendor: - + 1. Vendor specific GUID for the I2C part 2. Guidance on proper construction of the slave address array when the I2C device uses more than one slave address. The I2C bus protocol diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/I2cMaster.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/I2cMaster.h index 26f689788c..809c259231 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/I2cMaster.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/I2cMaster.h @@ -1,17 +1,17 @@ /** @file I2C Master Protocol as defined in the PI 1.3 specification. - This protocol manipulates the I2C host controller to perform transactions as a master + This protocol manipulates the I2C host controller to perform transactions as a master on the I2C bus using the current state of any switches or multiplexers in the I2C bus. Copyright (c) 2013, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This protocol is from PI Version 1.3. @@ -72,7 +72,7 @@ EFI_STATUS @retval EFI_SUCCESS The reset completed successfully. @retval EFI_ALREADY_STARTED The controller is busy with another transaction. @retval EFI_DEVICE_ERROR The reset operation failed. - + **/ typedef EFI_STATUS diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IScsiInitiatorName.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IScsiInitiatorName.h index 5dffaeedf9..7b8e2b81cd 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IScsiInitiatorName.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IScsiInitiatorName.h @@ -1,15 +1,15 @@ /** @file EFI_ISCSI_INITIATOR_NAME_PROTOCOL as defined in UEFI 2.0. - It provides the ability to get and set the iSCSI Initiator Name. + It provides the ability to get and set the iSCSI Initiator Name. Copyright (c) 2006 - 2011, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -39,7 +39,7 @@ typedef struct _EFI_ISCSI_INITIATOR_NAME_PROTOCOL EFI_ISCSI_INITIATOR_NAME_PROTO @retval EFI_DEVICE_ERROR The iSCSI initiator name could not be retrieved due to a hardware error. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_ISCSI_INITIATOR_NAME_GET)( IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This, @@ -47,7 +47,7 @@ EFI_STATUS OUT VOID *Buffer ); - + /** Sets the iSCSI Initiator Name. @@ -71,10 +71,10 @@ typedef EFI_STATUS IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This, IN OUT UINTN *BufferSize, IN VOID *Buffer - ); + ); /// -/// iSCSI Initiator Name Protocol for setting and obtaining the iSCSI Initiator Name. +/// iSCSI Initiator Name Protocol for setting and obtaining the iSCSI Initiator Name. /// struct _EFI_ISCSI_INITIATOR_NAME_PROTOCOL { EFI_ISCSI_INITIATOR_NAME_GET Get; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IdeControllerInit.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IdeControllerInit.h index c099af3084..a3326b7e4b 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IdeControllerInit.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IdeControllerInit.h @@ -1,31 +1,31 @@ /** @file This file declares EFI IDE Controller Init Protocol - + The EFI_IDE_CONTROLLER_INIT_PROTOCOL provides the chipset-specific information to the driver entity. This protocol is mandatory for IDE controllers if the IDE devices behind the controller are to be enumerated by a driver entity. - + There can only be one instance of EFI_IDE_CONTROLLER_INIT_PROTOCOL for each IDE controller in a system. It is installed on the handle that corresponds to the IDE controller. A driver entity that wishes to manage an IDE bus and possibly IDE devices in a system will have to retrieve the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance that is associated with the controller to be managed. - + A device handle for an IDE controller must contain an EFI_DEVICE_PATH_PROTOCOL. Copyright (c) 2007 - 2011, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +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. @par Revision Reference: - This Protocol is defined in UEFI Platform Initialization Specification 1.2 + This Protocol is defined in UEFI Platform Initialization Specification 1.2 Volume 5: Standards. - + **/ #ifndef _EFI_IDE_CONTROLLER_INIT_PROTOCOL_H_ @@ -71,7 +71,7 @@ typedef enum { /// /// The driver entity has completed resetting the devices behind /// the specified channel. This notification can be used to perform - /// any chipset-specific programming. + /// any chipset-specific programming. /// EfiIdeAfterChannelReset, /// @@ -84,13 +84,13 @@ typedef enum { /// /// The driver entity is done with detecting the presence of /// devices behind the specified channel. This notification can be - /// used to perform any chipset-specific programming. + /// used to perform any chipset-specific programming. /// EfiIdeBusAfterDevicePresenceDetection, /// /// The IDE bus is requesting the IDE controller driver to /// reprogram the IDE controller hardware and thereby reset all - /// the mode and timing settings to default settings. + /// the mode and timing settings to default settings. /// EfiIdeResetMode, EfiIdeBusPhaseMaximum @@ -135,11 +135,11 @@ typedef struct { typedef struct { /// /// An enumeration defining various transfer protocols other than the protocols - /// that exist at the time this specification was developed (i.e., PIO, single - /// word DMA, multiword DMA, and UDMA). Each transfer protocol is associated - /// with a mode. The various transfer protocols are defined by the ATA/ATAPI - /// specification. This enumeration makes the interface extensible because we - /// can support new transport protocols beyond UDMA. Type EFI_ATA_EXT_TRANSFER_PROTOCOL + /// that exist at the time this specification was developed (i.e., PIO, single + /// word DMA, multiword DMA, and UDMA). Each transfer protocol is associated + /// with a mode. The various transfer protocols are defined by the ATA/ATAPI + /// specification. This enumeration makes the interface extensible because we + /// can support new transport protocols beyond UDMA. Type EFI_ATA_EXT_TRANSFER_PROTOCOL /// is defined below. /// EFI_ATA_EXT_TRANSFER_PROTOCOL TransferProtocol; @@ -155,7 +155,7 @@ typedef struct { typedef struct { /// /// This field specifies the PIO mode. PIO modes are defined in the ATA/ATAPI - /// specification. The ATA/ATAPI specification defines the enumeration. In + /// specification. The ATA/ATAPI specification defines the enumeration. In /// other words, a value of 1 in this field means PIO mode 1. The actual meaning /// of PIO mode 1 is governed by the ATA/ATAPI specification. Type EFI_ATA_MODE /// is defined below. @@ -168,26 +168,26 @@ typedef struct { /// controllers will not support this transfer mode. The ATA/ATAPI specification defines /// the enumeration. In other words, a value of 1 in this field means single word DMA /// mode 1. The actual meaning of single word DMA mode 1 is governed by the ATA/ - /// ATAPI specification. + /// ATAPI specification. /// EFI_ATA_MODE SingleWordDmaMode; /// /// This field specifies the multiword DMA mode. Various multiword DMA modes are /// defined in the ATA/ATAPI specification. A value of 1 in this field means multiword /// DMA mode 1. The actual meaning of multiword DMA mode 1 is governed by the - /// ATA/ATAPI specification. + /// ATA/ATAPI specification. /// EFI_ATA_MODE MultiWordDmaMode; /// /// This field specifies the ultra DMA (UDMA) mode. UDMA modes are defined in the /// ATA/ATAPI specification. A value of 1 in this field means UDMA mode 1. The - /// actual meaning of UDMA mode 1 is governed by the ATA/ATAPI specification. + /// actual meaning of UDMA mode 1 is governed by the ATA/ATAPI specification. /// EFI_ATA_MODE UdmaMode; /// /// The number of extended-mode bitmap entries. Extended modes describe transfer /// protocols beyond PIO, single word DMA, multiword DMA, and UDMA. This field - /// can be zero and provides extensibility. + /// can be zero and provides extensibility. /// UINT32 ExtModeCount; /// @@ -195,7 +195,7 @@ typedef struct { /// than the ones defined above (i.e., PIO, single word DMA, multiword DMA, and /// UDMA). This field is defined for extensibility. At this time, only one extended /// transfer protocol is defined to cover SATA transfers. Type - /// EFI_ATA_EXTENDED_MODE is defined below. + /// EFI_ATA_EXTENDED_MODE is defined below. /// EFI_ATA_EXTENDED_MODE ExtMode[1]; } EFI_ATA_COLLECTIVE_MODE; @@ -206,16 +206,16 @@ typedef struct { /// The definition of these two structures is not part of the protocol /// definition because the ATA/ATAPI Specification controls the definition /// of all the fields. The ATA/ATAPI Specification can obsolete old fields -/// or redefine existing fields. +/// or redefine existing fields. typedef ATA_IDENTIFY_DATA EFI_ATA_IDENTIFY_DATA; typedef ATAPI_IDENTIFY_DATA EFI_ATAPI_IDENTIFY_DATA; /// /// This flag indicates whether the IDENTIFY data is a response from an ATA device -/// (EFI_ATA_IDENTIFY_DATA) or response from an ATAPI device +/// (EFI_ATA_IDENTIFY_DATA) or response from an ATAPI device /// (EFI_ATAPI_IDENTIFY_DATA). According to the ATA/ATAPI specification, -/// EFI_IDENTIFY_DATA is for an ATA device if bit 15 of the Config field is zero. -/// The Config field is common to both EFI_ATA_IDENTIFY_DATA and +/// EFI_IDENTIFY_DATA is for an ATA device if bit 15 of the Config field is zero. +/// The Config field is common to both EFI_ATA_IDENTIFY_DATA and /// EFI_ATAPI_IDENTIFY_DATA. /// #define EFI_ATAPI_DEVICE_IDENTIFY_DATA 0x8000 @@ -225,8 +225,8 @@ typedef ATAPI_IDENTIFY_DATA EFI_ATAPI_IDENTIFY_DATA; /// typedef union { /// - /// The data that is returned by an ATA device upon successful completion - /// of the ATA IDENTIFY_DEVICE command. + /// The data that is returned by an ATA device upon successful completion + /// of the ATA IDENTIFY_DEVICE command. /// EFI_ATA_IDENTIFY_DATA AtaData; /// @@ -238,34 +238,34 @@ typedef union { /** Returns the information about the specified IDE channel. - + This function can be used to obtain information about a particular IDE channel. - The driver entity uses this information during the enumeration process. - - If Enabled is set to FALSE, the driver entity will not scan the channel. Note + The driver entity uses this information during the enumeration process. + + If Enabled is set to FALSE, the driver entity will not scan the channel. Note that it will not prevent an operating system driver from scanning the channel. - - For most of today's controllers, MaxDevices will either be 1 or 2. For SATA - controllers, this value will always be 1. SATA configurations can contain SATA + + For most of today's controllers, MaxDevices will either be 1 or 2. For SATA + controllers, this value will always be 1. SATA configurations can contain SATA port multipliers. SATA port multipliers behave like SATA bridges and can support - up to 16 devices on the other side. If a SATA port out of the IDE controller - is connected to a port multiplier, MaxDevices will be set to the number of SATA - devices that the port multiplier supports. Because today's port multipliers - support up to fifteen SATA devices, this number can be as large as fifteen. The IDE - bus driver is required to scan for the presence of port multipliers behind an SATA - controller and enumerate up to MaxDevices number of devices behind the port - multiplier. - - In this context, the devices behind a port multiplier constitute a channel. - + up to 16 devices on the other side. If a SATA port out of the IDE controller + is connected to a port multiplier, MaxDevices will be set to the number of SATA + devices that the port multiplier supports. Because today's port multipliers + support up to fifteen SATA devices, this number can be as large as fifteen. The IDE + bus driver is required to scan for the presence of port multipliers behind an SATA + controller and enumerate up to MaxDevices number of devices behind the port + multiplier. + + In this context, the devices behind a port multiplier constitute a channel. + @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. @param[in] Channel Zero-based channel number. - @param[out] Enabled TRUE if this channel is enabled. Disabled channels + @param[out] Enabled TRUE if this channel is enabled. Disabled channels are not scanned to see if any devices are present. @param[out] MaxDevices The maximum number of IDE devices that the bus driver - can expect on this channel. For the ATA/ATAPI - specification, version 6, this number will either be - one or two. For Serial ATA (SATA) configurations with a + can expect on this channel. For the ATA/ATAPI + specification, version 6, this number will either be + one or two. For Serial ATA (SATA) configurations with a port multiplier, this number can be as large as fifteen. @retval EFI_SUCCESS Information was returned without any errors. @@ -284,13 +284,13 @@ EFI_STATUS /** The notifications from the driver entity that it is about to enter a certain phase of the IDE channel enumeration process. - - This function can be used to notify the IDE controller driver to perform - specific actions, including any chipset-specific initialization, so that the - chipset is ready to enter the next phase. Seven notification points are defined - at this time. - - More synchronization points may be added as required in the future. + + This function can be used to notify the IDE controller driver to perform + specific actions, including any chipset-specific initialization, so that the + chipset is ready to enter the next phase. Seven notification points are defined + at this time. + + More synchronization points may be added as required in the future. @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. @param[in] Phase The phase during enumeration. @@ -299,9 +299,9 @@ EFI_STATUS @retval EFI_SUCCESS The notification was accepted without any errors. @retval EFI_UNSUPPORTED Phase is not supported. @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount). - @retval EFI_NOT_READY This phase cannot be entered at this time; for - example, an attempt was made to enter a Phase - without having entered one or more previous + @retval EFI_NOT_READY This phase cannot be entered at this time; for + example, an attempt was made to enter a Phase + without having entered one or more previous Phase. **/ @@ -316,32 +316,32 @@ EFI_STATUS /** Submits the device information to the IDE controller driver. - This function is used by the driver entity to pass detailed information about - a particular device to the IDE controller driver. The driver entity obtains + This function is used by the driver entity to pass detailed information about + a particular device to the IDE controller driver. The driver entity obtains this information by issuing an ATA or ATAPI IDENTIFY_DEVICE command. IdentifyData - is the pointer to the response data buffer. The IdentifyData buffer is owned - by the driver entity, and the IDE controller driver must make a local copy - of the entire buffer or parts of the buffer as needed. The original IdentifyData + is the pointer to the response data buffer. The IdentifyData buffer is owned + by the driver entity, and the IDE controller driver must make a local copy + of the entire buffer or parts of the buffer as needed. The original IdentifyData buffer pointer may not be valid when - + - EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() or - EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() is called at a later point. - - The IDE controller driver may consult various fields of EFI_IDENTIFY_DATA to - compute the optimum mode for the device. These fields are not limited to the - timing information. For example, an implementation of the IDE controller driver - may examine the vendor and type/mode field to match known bad drives. - - The driver entity may submit drive information in any order, as long as it - submits information for all the devices belonging to the enumeration group + + The IDE controller driver may consult various fields of EFI_IDENTIFY_DATA to + compute the optimum mode for the device. These fields are not limited to the + timing information. For example, an implementation of the IDE controller driver + may examine the vendor and type/mode field to match known bad drives. + + The driver entity may submit drive information in any order, as long as it + submits information for all the devices belonging to the enumeration group before EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() is called for any device in that enumeration group. If a device is absent, EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() - should be called with IdentifyData set to NULL. The IDE controller driver may - not have any other mechanism to know whether a device is present or not. Therefore, - setting IdentifyData to NULL does not constitute an error condition. - EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() can be called only once for a - given (Channel, Device) pair. - + should be called with IdentifyData set to NULL. The IDE controller driver may + not have any other mechanism to know whether a device is present or not. Therefore, + setting IdentifyData to NULL does not constitute an error condition. + EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() can be called only once for a + given (Channel, Device) pair. + @param[in] This A pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. @param[in] Channel Zero-based channel number. @param[in] Device Zero-based device number on the Channel. @@ -364,31 +364,31 @@ EFI_STATUS /** Disqualifies specific modes for an IDE device. - This function allows the driver entity or other drivers (such as platform + This function allows the driver entity or other drivers (such as platform drivers) to reject certain timing modes and request the IDE controller driver - to recalculate modes. This function allows the driver entity and the IDE - controller driver to negotiate the timings on a per-device basis. This function - is useful in the case of drives that lie about their capabilities. An example - is when the IDE device fails to accept the timing modes that are calculated + to recalculate modes. This function allows the driver entity and the IDE + controller driver to negotiate the timings on a per-device basis. This function + is useful in the case of drives that lie about their capabilities. An example + is when the IDE device fails to accept the timing modes that are calculated by the IDE controller driver based on the response to the Identify Drive command. - If the driver entity does not want to limit the ATA timing modes and leave that - decision to the IDE controller driver, it can either not call this function for - the given device or call this function and set the Valid flag to FALSE for all + If the driver entity does not want to limit the ATA timing modes and leave that + decision to the IDE controller driver, it can either not call this function for + the given device or call this function and set the Valid flag to FALSE for all modes that are listed in EFI_ATA_COLLECTIVE_MODE. - - The driver entity may disqualify modes for a device in any order and any number + + The driver entity may disqualify modes for a device in any order and any number of times. - - This function can be called multiple times to invalidate multiple modes of the - same type (e.g., Programmed Input/Output [PIO] modes 3 and 4). See the ATA/ATAPI - specification for more information on PIO modes. - + + This function can be called multiple times to invalidate multiple modes of the + same type (e.g., Programmed Input/Output [PIO] modes 3 and 4). See the ATA/ATAPI + specification for more information on PIO modes. + For Serial ATA (SATA) controllers, this member function can be used to disqualify a higher transfer rate mode on a given channel. For example, a platform driver - may inform the IDE controller driver to not use second-generation (Gen2) speeds + may inform the IDE controller driver to not use second-generation (Gen2) speeds for a certain SATA drive. - + @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. @param[in] Channel The zero-based channel number. @param[in] Device The zero-based device number on the Channel. @@ -399,7 +399,7 @@ EFI_STATUS @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount). @retval EFI_INVALID_PARAMETER Device is invalid. @retval EFI_INVALID_PARAMETER IdentifyData is NULL. - + **/ typedef EFI_STATUS @@ -414,39 +414,39 @@ EFI_STATUS Returns the information about the optimum modes for the specified IDE device. This function is used by the driver entity to obtain the optimum ATA modes for - a specific device. The IDE controller driver takes into account the following + a specific device. The IDE controller driver takes into account the following while calculating the mode: - The IdentifyData inputs to EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() - The BadModes inputs to EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() - The driver entity is required to call EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() - for all the devices that belong to an enumeration group before calling - EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() for any device in the same group. - - The IDE controller driver will use controller- and possibly platform-specific - algorithms to arrive at SupportedModes. The IDE controller may base its - decision on user preferences and other considerations as well. This function - may be called multiple times because the driver entity may renegotiate the mode + The driver entity is required to call EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() + for all the devices that belong to an enumeration group before calling + EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() for any device in the same group. + + The IDE controller driver will use controller- and possibly platform-specific + algorithms to arrive at SupportedModes. The IDE controller may base its + decision on user preferences and other considerations as well. This function + may be called multiple times because the driver entity may renegotiate the mode with the IDE controller driver using EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode(). - - The driver entity may collect timing information for various devices in any + + The driver entity may collect timing information for various devices in any order. The driver entity is responsible for making sure that all the dependencies - are satisfied. For example, the SupportedModes information for device A that - was previously returned may become stale after a call to + are satisfied. For example, the SupportedModes information for device A that + was previously returned may become stale after a call to EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() for device B. - - The buffer SupportedModes is allocated by the callee because the caller does - not necessarily know the size of the buffer. The type EFI_ATA_COLLECTIVE_MODE - is defined in a way that allows for future extensibility and can be of variable - length. This memory pool should be deallocated by the caller when it is no - longer necessary. - - The IDE controller driver for a Serial ATA (SATA) controller can use this - member function to force a lower speed (first-generation [Gen1] speeds on a - second-generation [Gen2]-capable hardware). The IDE controller driver can - also allow the driver entity to stay with the speed that has been negotiated + + The buffer SupportedModes is allocated by the callee because the caller does + not necessarily know the size of the buffer. The type EFI_ATA_COLLECTIVE_MODE + is defined in a way that allows for future extensibility and can be of variable + length. This memory pool should be deallocated by the caller when it is no + longer necessary. + + The IDE controller driver for a Serial ATA (SATA) controller can use this + member function to force a lower speed (first-generation [Gen1] speeds on a + second-generation [Gen2]-capable hardware). The IDE controller driver can + also allow the driver entity to stay with the speed that has been negotiated by the physical layer. - + @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. @param[in] Channel A zero-based channel number. @param[in] Device A zero-based device number on the Channel. @@ -454,13 +454,13 @@ EFI_STATUS @retval EFI_SUCCESS SupportedModes was returned. @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount). - @retval EFI_INVALID_PARAMETER Device is invalid. + @retval EFI_INVALID_PARAMETER Device is invalid. @retval EFI_INVALID_PARAMETER SupportedModes is NULL. - @retval EFI_NOT_READY Modes cannot be calculated due to a lack of - data. This error may happen if - EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() - and EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyData() - were not called for at least one drive in the + @retval EFI_NOT_READY Modes cannot be calculated due to a lack of + data. This error may happen if + EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() + and EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyData() + were not called for at least one drive in the same enumeration group. **/ @@ -477,9 +477,9 @@ EFI_STATUS Commands the IDE controller driver to program the IDE controller hardware so that the specified device can operate at the specified mode. - This function is used by the driver entity to instruct the IDE controller - driver to program the IDE controller hardware to the specified modes. This - function can be called only once for a particular device. For a Serial ATA + This function is used by the driver entity to instruct the IDE controller + driver to program the IDE controller hardware to the specified modes. This + function can be called only once for a particular device. For a Serial ATA (SATA) Advanced Host Controller Interface (AHCI) controller, no controller- specific programming may be required. @@ -513,48 +513,48 @@ struct _EFI_IDE_CONTROLLER_INIT_PROTOCOL { /// Returns the information about a specific channel. /// EFI_IDE_CONTROLLER_GET_CHANNEL_INFO GetChannelInfo; - + /// /// The notification that the driver entity is about to enter the - /// specified phase during the enumeration process. + /// specified phase during the enumeration process. /// EFI_IDE_CONTROLLER_NOTIFY_PHASE NotifyPhase; - + /// /// Submits the Drive Identify data that was returned by the device. /// EFI_IDE_CONTROLLER_SUBMIT_DATA SubmitData; - + /// - /// Submits information about modes that should be disqualified. The specified - /// IDE device does not support these modes and these modes should not be + /// Submits information about modes that should be disqualified. The specified + /// IDE device does not support these modes and these modes should not be /// returned by EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() /// EFI_IDE_CONTROLLER_DISQUALIFY_MODE DisqualifyMode; - + /// /// Calculates and returns the optimum mode for a particular IDE device. /// EFI_IDE_CONTROLLER_CALCULATE_MODE CalculateMode; - + /// /// Programs the IDE controller hardware to the default timing or per the modes - /// that were returned by the last call to EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode(). + /// that were returned by the last call to EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode(). /// EFI_IDE_CONTROLLER_SET_TIMING SetTiming; - + /// /// Set to TRUE if the enumeration group includes all the channels that are /// produced by this controller. Set to FALSE if an enumeration group consists of - /// only one channel. + /// only one channel. /// BOOLEAN EnumAll; - + /// /// The number of channels that are produced by this controller. Parallel ATA - /// (PATA) controllers can support up to two channels. Advanced Host Controller + /// (PATA) controllers can support up to two channels. Advanced Host Controller /// Interface (AHCI) Serial ATA (SATA) controllers can support up to 32 channels, - /// each of which can have up to one device. In the presence of a multiplier, + /// each of which can have up to one device. In the presence of a multiplier, /// each channel can have fifteen devices. /// UINT8 ChannelCount; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IncompatiblePciDeviceSupport.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IncompatiblePciDeviceSupport.h index 9a924d4a67..81a94e6629 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IncompatiblePciDeviceSupport.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IncompatiblePciDeviceSupport.h @@ -1,61 +1,61 @@ /** @file This file declares Incompatible PCI Device Support Protocol - - Allows the PCI bus driver to support resource allocation for some PCI devices + + Allows the PCI bus driver to support resource allocation for some PCI devices that do not comply with the PCI Specification. - - @par Note: - This protocol is optional. Only those platforms that implement this protocol - will have the capability to support incompatible PCI devices. The absence of - this protocol can cause the PCI bus driver to configure these incompatible - PCI devices incorrectly. As a result, these devices may not work properly. - + + @par Note: + This protocol is optional. Only those platforms that implement this protocol + will have the capability to support incompatible PCI devices. The absence of + this protocol can cause the PCI bus driver to configure these incompatible + PCI devices incorrectly. As a result, these devices may not work properly. + The EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL is used by the PCI bus driver - to support resource allocation for some PCI devices that do not comply with the - PCI Specification. This protocol can find some incompatible PCI devices and - report their special resource requirements to the PCI bus driver. The generic - PCI bus driver does not have prior knowledge of any incompatible PCI devices. - It interfaces with the EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL to find out - if a device is incompatible and to obtain the special configuration requirements + to support resource allocation for some PCI devices that do not comply with the + PCI Specification. This protocol can find some incompatible PCI devices and + report their special resource requirements to the PCI bus driver. The generic + PCI bus driver does not have prior knowledge of any incompatible PCI devices. + It interfaces with the EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL to find out + if a device is incompatible and to obtain the special configuration requirements for a specific incompatible PCI device. This protocol is optional, and only one instance of this protocol can be present - in the system. If a platform supports this protocol, this protocol is produced - by a Driver Execution Environment (DXE) driver and must be made available before - the Boot Device Selection (BDS) phase. The PCI bus driver will look for the - presence of this protocol before it begins PCI enumeration. If this protocol + in the system. If a platform supports this protocol, this protocol is produced + by a Driver Execution Environment (DXE) driver and must be made available before + the Boot Device Selection (BDS) phase. The PCI bus driver will look for the + presence of this protocol before it begins PCI enumeration. If this protocol exists in a platform, it indicates that the platform has the capability to support - those incompatible PCI devices. However, final support for incompatible PCI - devices still depends on the implementation of the PCI bus driver. The PCI bus - driver may fully, partially, or not even support these incompatible devices. - - During PCI bus enumeration, the PCI bus driver will probe the PCI Base Address - Registers (BARs) for each PCI device regardless of whether the PCI device is - incompatible or not to determine the resource requirements so that the PCI bus - driver can invoke the proper PCI resources for them. Generally, this resource + those incompatible PCI devices. However, final support for incompatible PCI + devices still depends on the implementation of the PCI bus driver. The PCI bus + driver may fully, partially, or not even support these incompatible devices. + + During PCI bus enumeration, the PCI bus driver will probe the PCI Base Address + Registers (BARs) for each PCI device regardless of whether the PCI device is + incompatible or not to determine the resource requirements so that the PCI bus + driver can invoke the proper PCI resources for them. Generally, this resource information includes the following: - Resource type - Resource length - Alignment - + However, some incompatible PCI devices may have special requirements. As a result, - the length or the alignment that is derived through BAR probing may not be exactly - the same as the actual resource requirement of the device. For example, there + the length or the alignment that is derived through BAR probing may not be exactly + the same as the actual resource requirement of the device. For example, there are some devices that request I/O resources at a length of 0x100 from their I/O - BAR, but these incompatible devices will never work correctly if an odd I/O base - address, such as 0x100, 0x300, or 0x500, is assigned to the BAR. Instead, these - devices request an even base address, such as 0x200 or 0x400. The Incompatible - PCI Device Support Protocol can then be used to obtain these special resource - requirements for these incompatible PCI devices. In this way, the PCI bus driver - will take special consideration for these devices during PCI resource allocation + BAR, but these incompatible devices will never work correctly if an odd I/O base + address, such as 0x100, 0x300, or 0x500, is assigned to the BAR. Instead, these + devices request an even base address, such as 0x200 or 0x400. The Incompatible + PCI Device Support Protocol can then be used to obtain these special resource + requirements for these incompatible PCI devices. In this way, the PCI bus driver + will take special consideration for these devices during PCI resource allocation to ensure that they can work correctly. - + This protocol may support the following incompatible PCI BAR types: - I/O or memory length that is different from what the BAR reports - I/O or memory alignment that is different from what the BAR reports - Fixed I/O or memory base address - - See the Conventional PCI Specification 3.0 for the details of how a PCI BAR + + See the Conventional PCI Specification 3.0 for the details of how a PCI BAR reports the resource length and the alignment that it requires. Copyright (c) 2007 - 2009, Intel Corporation. All rights reserved.<BR> @@ -68,7 +68,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: - This Protocol is defined in UEFI Platform Initialization Specification 1.2 + This Protocol is defined in UEFI Platform Initialization Specification 1.2 Volume 5: Standards **/ @@ -92,51 +92,51 @@ typedef struct _EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL EFI_INCOMPATIBLE_PC /** Returns a list of ACPI resource descriptors that detail the special resource configuration requirements for an incompatible PCI device. - - This function returns a list of ACPI resource descriptors that detail the - special resource configuration requirements for an incompatible PCI device. - + + This function returns a list of ACPI resource descriptors that detail the + special resource configuration requirements for an incompatible PCI device. + Prior to bus enumeration, the PCI bus driver will look for the presence of the EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL. Only one instance of this - protocol can be present in the system. For each PCI device that the PCI bus + protocol can be present in the system. For each PCI device that the PCI bus driver discovers, the PCI bus driver calls this function with the device's vendor ID, device ID, revision ID, subsystem vendor ID, and subsystem device ID. If the VendorId, DeviceId, RevisionId, SubsystemVendorId, or SubsystemDeviceId value is set to (UINTN)-1, that field will be ignored. The ID values that are not (UINTN)-1 - will be used to identify the current device. - - This function will only return EFI_SUCCESS. However, if the device is an - incompatible PCI device, a list of ACPI resource descriptors will be returned - in Configuration. Otherwise, NULL will be returned in Configuration instead. - The PCI bus driver does not need to allocate memory for Configuration. However, - it is the PCI bus driver's responsibility to free it. The PCI bus driver then - can configure this device with the information that is derived from this list + will be used to identify the current device. + + This function will only return EFI_SUCCESS. However, if the device is an + incompatible PCI device, a list of ACPI resource descriptors will be returned + in Configuration. Otherwise, NULL will be returned in Configuration instead. + The PCI bus driver does not need to allocate memory for Configuration. However, + it is the PCI bus driver's responsibility to free it. The PCI bus driver then + can configure this device with the information that is derived from this list of resource nodes, rather than the result of BAR probing. - Only the following two resource descriptor types from the ACPI Specification + Only the following two resource descriptor types from the ACPI Specification may be used to describe the incompatible PCI device resource requirements: - QWORD Address Space Descriptor (ACPI 2.0, section 6.4.3.5.1; also ACPI 3.0) - End Tag (ACPI 2.0, section 6.4.2.8; also ACPI 3.0) - The QWORD Address Space Descriptor can describe memory, I/O, and bus number - ranges for dynamic or fixed resources. The configuration of a PCI root bridge - is described with one or more QWORD Address Space Descriptors, followed by an + The QWORD Address Space Descriptor can describe memory, I/O, and bus number + ranges for dynamic or fixed resources. The configuration of a PCI root bridge + is described with one or more QWORD Address Space Descriptors, followed by an End Tag. See the ACPI Specification for details on the field values. - - @param[in] This Pointer to the EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL + + @param[in] This Pointer to the EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL instance. - @param[in] VendorId A unique ID to identify the manufacturer of + @param[in] VendorId A unique ID to identify the manufacturer of the PCI device. See the Conventional PCI Specification 3.0 for details. - @param[in] DeviceId A unique ID to identify the particular PCI - device. See the Conventional PCI Specification + @param[in] DeviceId A unique ID to identify the particular PCI + device. See the Conventional PCI Specification 3.0 for details. - @param[in] RevisionId A PCI device-specific revision identifier. + @param[in] RevisionId A PCI device-specific revision identifier. See the Conventional PCI Specification 3.0 for details. - @param[in] SubsystemVendorId Specifies the subsystem vendor ID. See the + @param[in] SubsystemVendorId Specifies the subsystem vendor ID. See the Conventional PCI Specification 3.0 for details. - @param[in] SubsystemDeviceId Specifies the subsystem device ID. See the + @param[in] SubsystemDeviceId Specifies the subsystem device ID. See the Conventional PCI Specification 3.0 for details. @param[out] Configuration A list of ACPI resource descriptors that detail the configuration requirement. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ip4.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ip4.h index e36f38d8f5..df2a48dc21 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ip4.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ip4.h @@ -6,21 +6,21 @@ - EFI IPv4 Variable (deprecated in UEFI 2.4B) - EFI IPv4 Protocol. The EFI IPv4 Protocol provides basic network IPv4 packet I/O services, - which includes support foR a subset of the Internet Control Message + which includes support foR a subset of the Internet Control Message Protocol (ICMP) and may include support for the Internet Group Management Protocol (IGMP). - + Copyright (c) 2006 - 2014, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. - @par Revision Reference: - This Protocol is introduced in UEFI Specification 2.0. + @par Revision Reference: + This Protocol is introduced in UEFI Specification 2.0. **/ @@ -49,7 +49,7 @@ typedef struct { EFI_HANDLE InstanceHandle; EFI_IPv4_ADDRESS Ip4Address; EFI_IPv4_ADDRESS SubnetMask; -} EFI_IP4_ADDRESS_PAIR; +} EFI_IP4_ADDRESS_PAIR; /// /// EFI_IP4_VARIABLE_DATA is deprecated in the UEFI 2.4B and should not be used any more. @@ -271,7 +271,7 @@ typedef struct { /** Gets the current operational settings for this instance of the EFI IPv4 Protocol driver. - + The GetModeData() function returns the current operational mode data for this driver instance. The data fields in EFI_IP4_MODE_DATA are read only. This function is used optionally to retrieve the operational mode data of underlying @@ -294,11 +294,11 @@ EFI_STATUS OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL, OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL, OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL - ); + ); /** Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance. - + The Configure() function is used to set, change, or reset the operational parameters and filter settings for this EFI IPv4 Protocol instance. Until these parameters have been set, no network traffic can be sent or received by this @@ -307,14 +307,14 @@ EFI_STATUS parameters have been set again. Each EFI IPv4 Protocol instance can be started and stopped independently of each other by enabling or disabling their receive filter settings with the Configure() function. - + When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will be appended as an alias address into the addresses list in the EFI IPv4 Protocol driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL to retrieve the default IPv4 address if it is not available yet. Clients could frequently call GetModeData() to check the status to ensure that the default IPv4 address is ready. - + If operational parameters are reset or changed, any pending transmit and receive requests will be cancelled. Their completion token status will be set to EFI_ABORTED and their events will be signaled. @@ -328,7 +328,7 @@ EFI_STATUS @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: This is NULL. IpConfigData.StationAddress is not a unicast IPv4 address. - IpConfigData.SubnetMask is not a valid IPv4 subnet + IpConfigData.SubnetMask is not a valid IPv4 subnet @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE: A configuration protocol (DHCP, BOOTP, RARP, etc.) could not be located when clients choose to use the default IPv4 @@ -342,20 +342,20 @@ EFI_STATUS Protocol driver instance is not opened. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_IP4_CONFIGURE)( IN EFI_IP4_PROTOCOL *This, IN EFI_IP4_CONFIG_DATA *IpConfigData OPTIONAL - ); + ); /** Joins and leaves multicast groups. - + The Groups() function is used to join and leave multicast group sessions. Joining a group will enable reception of matching multicast packets. Leaving a group will disable the multicast packet reception. - + If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left. @param This The pointer to the EFI_IP4_PROTOCOL instance. @@ -379,32 +379,32 @@ EFI_STATUS @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_IP4_GROUPS)( IN EFI_IP4_PROTOCOL *This, IN BOOLEAN JoinFlag, IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL - ); + ); /** Adds and deletes routing table entries. The Routes() function adds a route to or deletes a route from the routing table. - + Routes are determined by comparing the SubnetAddress with the destination IPv4 address arithmetically AND-ed with the SubnetMask. The gateway address must be on the same subnet as the configured station address. - + The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0. The default route matches all destination IPv4 addresses that do not match any other routes. - + A GatewayAddress that is zero is a nonroute. Packets are sent to the destination IP address if it can be found in the ARP cache or on the local subnet. One automatic nonroute entry will be inserted into the routing table for outgoing packets that are addressed to a local subnet (gateway address of 0.0.0.0). - + Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI IPv4 Protocol instances that use the default IPv4 address will also have copies of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these @@ -435,17 +435,17 @@ EFI_STATUS @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE). @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when DeleteRoute is FALSE). - + **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_IP4_ROUTES)( IN EFI_IP4_PROTOCOL *This, IN BOOLEAN DeleteRoute, IN EFI_IPv4_ADDRESS *SubnetAddress, IN EFI_IPv4_ADDRESS *SubnetMask, - IN EFI_IPv4_ADDRESS *GatewayAddress - ); + IN EFI_IPv4_ADDRESS *GatewayAddress + ); /** Places outgoing data packets into the transmit queue. @@ -465,7 +465,7 @@ EFI_STATUS @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event was already in the transmit queue. @retval EFI_NOT_READY The completion token could not be queued because the transmit - queue is full. + queue is full. @retval EFI_NOT_FOUND Not route is found to destination address. @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data. @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too @@ -476,19 +476,19 @@ EFI_STATUS DoNotFragment is TRUE.) **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_IP4_TRANSMIT)( IN EFI_IP4_PROTOCOL *This, IN EFI_IP4_COMPLETION_TOKEN *Token - ); + ); /** Places a receiving request into the receiving queue. - + The Receive() function places a completion token into the receive packet queue. This function is always asynchronous. - + The Token.Event field in the completion token must be filled in by the caller and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event @@ -515,16 +515,16 @@ EFI_STATUS @retval EFI_ICMP_ERROR An ICMP error packet was received. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_IP4_RECEIVE)( IN EFI_IP4_PROTOCOL *This, IN EFI_IP4_COMPLETION_TOKEN *Token - ); + ); /** Abort an asynchronous transmit or receive request. - + The Cancel() function is used to abort a pending transmit or receive request. If the token is in the transmit or receive request queues, after calling this function, Token->Status will be set to EFI_ABORTED and then Token->Event will @@ -556,16 +556,16 @@ EFI_STATUS (EFIAPI *EFI_IP4_CANCEL)( IN EFI_IP4_PROTOCOL *This, IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL - ); - + ); + /** Polls for incoming data packets and processes outgoing data packets. - + The Poll() function polls for incoming data packets and processes outgoing data packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll() function to increase the rate that data packets are moved between the communications device and the transmit and receive queues. - + In some systems the periodic timer event may not poll the underlying communications device fast enough to transmit and/or receive all data packets without missing incoming packets or dropping outgoing packets. Drivers and applications that are @@ -585,14 +585,14 @@ EFI_STATUS Consider increasing the polling rate. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_IP4_POLL)( IN EFI_IP4_PROTOCOL *This - ); + ); /// -/// The EFI IPv4 Protocol implements a simple packet-oriented interface that can be +/// The EFI IPv4 Protocol implements a simple packet-oriented interface that can be /// used by drivers, daemons, and applications to transmit and receive network packets. /// struct _EFI_IP4_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ip4Config.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ip4Config.h index ece7efb668..d4e517a1c4 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ip4Config.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ip4Config.h @@ -3,15 +3,15 @@ Protocol. Copyright (c) 2006 - 2014, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +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. - - @par Revision Reference: + + @par Revision Reference: This Protocol is introduced in UEFI Specification 2.0. **/ @@ -31,11 +31,11 @@ typedef struct _EFI_IP4_CONFIG_PROTOCOL EFI_IP4_CONFIG_PROTOCOL; (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS) /// -/// EFI_IP4_IPCONFIG_DATA contains the minimum IPv4 configuration data -/// that is needed to start basic network communication. The StationAddress +/// EFI_IP4_IPCONFIG_DATA contains the minimum IPv4 configuration data +/// that is needed to start basic network communication. The StationAddress /// and SubnetMask must be a valid unicast IP address and subnet mask. -/// If RouteTableSize is not zero, then RouteTable contains a properly -/// formatted routing table for the StationAddress/SubnetMask, with the +/// If RouteTableSize is not zero, then RouteTable contains a properly +/// formatted routing table for the StationAddress/SubnetMask, with the /// last entry in the table being the default route. /// typedef struct { @@ -61,47 +61,47 @@ typedef struct { /** Starts running the configuration policy for the EFI IPv4 Protocol driver. - - The Start() function is called to determine and to begin the platform - configuration policy by the EFI IPv4 Protocol driver. This determination may - be as simple as returning EFI_UNSUPPORTED if there is no EFI IPv4 Protocol - driver configuration policy. It may be as involved as loading some defaults - from nonvolatile storage, downloading dynamic data from a DHCP server, and + + The Start() function is called to determine and to begin the platform + configuration policy by the EFI IPv4 Protocol driver. This determination may + be as simple as returning EFI_UNSUPPORTED if there is no EFI IPv4 Protocol + driver configuration policy. It may be as involved as loading some defaults + from nonvolatile storage, downloading dynamic data from a DHCP server, and checking permissions with a site policy server. - Starting the configuration policy is just the beginning. It may finish almost - instantly or it may take several minutes before it fails to retrieve configuration - information from one or more servers. Once the policy is started, drivers - should use the DoneEvent parameter to determine when the configuration policy - has completed. EFI_IP4_CONFIG_PROTOCOL.GetData() must then be called to + Starting the configuration policy is just the beginning. It may finish almost + instantly or it may take several minutes before it fails to retrieve configuration + information from one or more servers. Once the policy is started, drivers + should use the DoneEvent parameter to determine when the configuration policy + has completed. EFI_IP4_CONFIG_PROTOCOL.GetData() must then be called to determine if the configuration succeeded or failed. - Until the configuration completes successfully, EFI IPv4 Protocol driver instances + Until the configuration completes successfully, EFI IPv4 Protocol driver instances that are attempting to use default configurations must return EFI_NO_MAPPING. - Once the configuration is complete, the EFI IPv4 Configuration Protocol driver - signals DoneEvent. The configuration may need to be updated in the future. - Note that in this case the EFI IPv4 Configuration Protocol driver must signal - ReconfigEvent, and all EFI IPv4 Protocol driver instances that are using default - configurations must return EFI_NO_MAPPING until the configuration policy has + Once the configuration is complete, the EFI IPv4 Configuration Protocol driver + signals DoneEvent. The configuration may need to be updated in the future. + Note that in this case the EFI IPv4 Configuration Protocol driver must signal + ReconfigEvent, and all EFI IPv4 Protocol driver instances that are using default + configurations must return EFI_NO_MAPPING until the configuration policy has been rerun. @param This The pointer to the EFI_IP4_CONFIG_PROTOCOL instance. - @param DoneEvent Event that will be signaled when the EFI IPv4 - Protocol driver configuration policy completes + @param DoneEvent Event that will be signaled when the EFI IPv4 + Protocol driver configuration policy completes execution. This event must be of type EVT_NOTIFY_SIGNAL. - @param ReconfigEvent Event that will be signaled when the EFI IPv4 - Protocol driver configuration needs to be updated. + @param ReconfigEvent Event that will be signaled when the EFI IPv4 + Protocol driver configuration needs to be updated. This event must be of type EVT_NOTIFY_SIGNAL. - - @retval EFI_SUCCESS The configuration policy for the EFI IPv4 Protocol + + @retval EFI_SUCCESS The configuration policy for the EFI IPv4 Protocol driver is now running. @retval EFI_INVALID_PARAMETER One or more of the following parameters is NULL: This DoneEvent ReconfigEvent @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. - @retval EFI_ALREADY_STARTED The configuration policy for the EFI IPv4 Protocol + @retval EFI_ALREADY_STARTED The configuration policy for the EFI IPv4 Protocol driver was already started. @retval EFI_DEVICE_ERROR An unexpected system error or network error occurred. - @retval EFI_UNSUPPORTED This interface does not support the EFI IPv4 Protocol + @retval EFI_UNSUPPORTED This interface does not support the EFI IPv4 Protocol driver configuration. **/ @@ -115,18 +115,18 @@ EFI_STATUS /** Stops running the configuration policy for the EFI IPv4 Protocol driver. - - The Stop() function stops the configuration policy for the EFI IPv4 Protocol driver. + + The Stop() function stops the configuration policy for the EFI IPv4 Protocol driver. All configuration data will be lost after calling Stop(). @param This The pointer to the EFI_IP4_CONFIG_PROTOCOL instance. - @retval EFI_SUCCESS The configuration policy for the EFI IPv4 Protocol + @retval EFI_SUCCESS The configuration policy for the EFI IPv4 Protocol driver has been stopped. @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_NOT_STARTED The configuration policy for the EFI IPv4 Protocol + @retval EFI_NOT_STARTED The configuration policy for the EFI IPv4 Protocol driver was not started. - + **/ typedef EFI_STATUS @@ -137,25 +137,25 @@ EFI_STATUS /** Returns the default configuration data (if any) for the EFI IPv4 Protocol driver. - The GetData() function returns the current configuration data for the EFI IPv4 + The GetData() function returns the current configuration data for the EFI IPv4 Protocol driver after the configuration policy has completed. - + @param This The pointer to the EFI_IP4_CONFIG_PROTOCOL instance. - @param IpConfigDataSize On input, the size of the IpConfigData buffer. - On output, the count of bytes that were written + @param IpConfigDataSize On input, the size of the IpConfigData buffer. + On output, the count of bytes that were written into the IpConfigData buffer. - @param IpConfigData The pointer to the EFI IPv4 Configuration Protocol - driver configuration data structure. - Type EFI_IP4_IPCONFIG_DATA is defined in + @param IpConfigData The pointer to the EFI IPv4 Configuration Protocol + driver configuration data structure. + Type EFI_IP4_IPCONFIG_DATA is defined in "Related Definitions" below. @retval EFI_SUCCESS The EFI IPv4 Protocol driver configuration has been returned. @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_NOT_STARTED The configuration policy for the EFI IPv4 Protocol + @retval EFI_NOT_STARTED The configuration policy for the EFI IPv4 Protocol driver is not running. @retval EFI_NOT_READY EFI IPv4 Protocol driver configuration is still running. @retval EFI_ABORTED EFI IPv4 Protocol driver configuration could not complete. - @retval EFI_BUFFER_TOO_SMALL *IpConfigDataSize is smaller than the configuration + @retval EFI_BUFFER_TOO_SMALL *IpConfigDataSize is smaller than the configuration data buffer or IpConfigData is NULL. **/ @@ -168,8 +168,8 @@ EFI_STATUS ); /// -/// The EFI_IP4_CONFIG_PROTOCOL driver performs platform-dependent and policy-dependent -/// configurations for the EFI IPv4 Protocol driver. +/// The EFI_IP4_CONFIG_PROTOCOL driver performs platform-dependent and policy-dependent +/// configurations for the EFI IPv4 Protocol driver. /// struct _EFI_IP4_CONFIG_PROTOCOL { EFI_IP4_CONFIG_START Start; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ip4Config2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ip4Config2.h index c81d4c600f..64d78c2d50 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ip4Config2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ip4Config2.h @@ -33,48 +33,48 @@ typedef struct _EFI_IP4_CONFIG2_PROTOCOL EFI_IP4_CONFIG2_PROTOCOL; /// typedef enum { /// - /// The interface information of the communication device this EFI - /// IPv4 Configuration II Protocol instance manages. This type of - /// data is read only. The corresponding Data is of type + /// The interface information of the communication device this EFI + /// IPv4 Configuration II Protocol instance manages. This type of + /// data is read only. The corresponding Data is of type /// EFI_IP4_CONFIG2_INTERFACE_INFO. /// Ip4Config2DataTypeInterfaceInfo, /// - /// The general configuration policy for the EFI IPv4 network stack - /// running on the communication device this EFI IPv4 - /// Configuration II Protocol instance manages. The policy will - /// affect other configuration settings. The corresponding Data is of + /// The general configuration policy for the EFI IPv4 network stack + /// running on the communication device this EFI IPv4 + /// Configuration II Protocol instance manages. The policy will + /// affect other configuration settings. The corresponding Data is of /// type EFI_IP4_CONFIG2_POLICY. /// Ip4Config2DataTypePolicy, /// - /// The station addresses set manually for the EFI IPv4 network - /// stack. It is only configurable when the policy is - /// Ip4Config2PolicyStatic. The corresponding Data is of - /// type EFI_IP4_CONFIG2_MANUAL_ADDRESS. When DataSize - /// is 0 and Data is NULL, the existing configuration is cleared + /// The station addresses set manually for the EFI IPv4 network + /// stack. It is only configurable when the policy is + /// Ip4Config2PolicyStatic. The corresponding Data is of + /// type EFI_IP4_CONFIG2_MANUAL_ADDRESS. When DataSize + /// is 0 and Data is NULL, the existing configuration is cleared /// from the EFI IPv4 Configuration II Protocol instance. /// Ip4Config2DataTypeManualAddress, /// - /// The gateway addresses set manually for the EFI IPv4 network - /// stack running on the communication device this EFI IPv4 - /// Configuration II Protocol manages. It is not configurable when - /// the policy is Ip4Config2PolicyDhcp. The gateway - /// addresses must be unicast IPv4 addresses. The corresponding + /// The gateway addresses set manually for the EFI IPv4 network + /// stack running on the communication device this EFI IPv4 + /// Configuration II Protocol manages. It is not configurable when + /// the policy is Ip4Config2PolicyDhcp. The gateway + /// addresses must be unicast IPv4 addresses. The corresponding /// Data is a pointer to an array of EFI_IPv4_ADDRESS instances. - /// When DataSize is 0 and Data is NULL, the existing configuration + /// When DataSize is 0 and Data is NULL, the existing configuration /// is cleared from the EFI IPv4 Configuration II Protocol instance. /// Ip4Config2DataTypeGateway, /// - /// The DNS server list for the EFI IPv4 network stack running on - /// the communication device this EFI IPv4 Configuration II - /// Protocol manages. It is not configurable when the policy is - /// Ip4Config2PolicyDhcp. The DNS server addresses must be - /// unicast IPv4 addresses. The corresponding Data is a pointer to - /// an array of EFI_IPv4_ADDRESS instances. When DataSize - /// is 0 and Data is NULL, the existing configuration is cleared + /// The DNS server list for the EFI IPv4 network stack running on + /// the communication device this EFI IPv4 Configuration II + /// Protocol manages. It is not configurable when the policy is + /// Ip4Config2PolicyDhcp. The DNS server addresses must be + /// unicast IPv4 addresses. The corresponding Data is a pointer to + /// an array of EFI_IPv4_ADDRESS instances. When DataSize + /// is 0 and Data is NULL, the existing configuration is cleared /// from the EFI IPv4 Configuration II Protocol instance. /// Ip4Config2DataTypeDnsServer, @@ -95,7 +95,7 @@ typedef struct { /// CHAR16 Name[EFI_IP4_CONFIG2_INTERFACE_INFO_NAME_SIZE]; /// - /// The interface type of the network interface. See RFC 1700, + /// The interface type of the network interface. See RFC 1700, /// section "Number Hardware Type". /// UINT8 IfType; @@ -120,8 +120,8 @@ typedef struct { /// UINT32 RouteTableSize; /// - /// The route table of the IPv4 network stack runs on this interface. - /// Set to NULL if RouteTableSize is zero. Type EFI_IP4_ROUTE_TABLE is defined in + /// The route table of the IPv4 network stack runs on this interface. + /// Set to NULL if RouteTableSize is zero. Type EFI_IP4_ROUTE_TABLE is defined in /// EFI_IP4_PROTOCOL.GetModeData(). /// EFI_IP4_ROUTE_TABLE *RouteTable OPTIONAL; @@ -132,17 +132,17 @@ typedef struct { /// typedef enum { /// - /// Under this policy, the Ip4Config2DataTypeManualAddress, - /// Ip4Config2DataTypeGateway and Ip4Config2DataTypeDnsServer configuration - /// data are required to be set manually. The EFI IPv4 Protocol will get all - /// required configuration such as IPv4 address, subnet mask and + /// Under this policy, the Ip4Config2DataTypeManualAddress, + /// Ip4Config2DataTypeGateway and Ip4Config2DataTypeDnsServer configuration + /// data are required to be set manually. The EFI IPv4 Protocol will get all + /// required configuration such as IPv4 address, subnet mask and /// gateway settings from the EFI IPv4 Configuration II protocol. /// Ip4Config2PolicyStatic, /// - /// Under this policy, the Ip4Config2DataTypeManualAddress, - /// Ip4Config2DataTypeGateway and Ip4Config2DataTypeDnsServer configuration data are - /// not allowed to set via SetData(). All of these configurations are retrieved from DHCP + /// Under this policy, the Ip4Config2DataTypeManualAddress, + /// Ip4Config2DataTypeGateway and Ip4Config2DataTypeDnsServer configuration data are + /// not allowed to set via SetData(). All of these configurations are retrieved from DHCP /// server or other auto-configuration mechanism. /// Ip4Config2PolicyDhcp, @@ -153,58 +153,58 @@ typedef enum { /// EFI_IP4_CONFIG2_MANUAL_ADDRESS /// typedef struct { - /// + /// /// The IPv4 unicast address. /// EFI_IPv4_ADDRESS Address; /// - /// The subnet mask. + /// The subnet mask. /// EFI_IPv4_ADDRESS SubnetMask; } EFI_IP4_CONFIG2_MANUAL_ADDRESS; /** - Set the configuration for the EFI IPv4 network stack running on the communication device this EFI + Set the configuration for the EFI IPv4 network stack running on the communication device this EFI IPv4 Configuration II Protocol instance manages. - This function is used to set the configuration data of type DataType for the EFI IPv4 network stack + This function is used to set the configuration data of type DataType for the EFI IPv4 network stack running on the communication device this EFI IPv4 Configuration II Protocol instance manages. The successfully configured data is valid after system reset or power-off. - The DataSize is used to calculate the count of structure instances in the Data for some + The DataSize is used to calculate the count of structure instances in the Data for some DataType that multiple structure instances are allowed. - This function is always non-blocking. When setting some typeof configuration data, an - asynchronous process is invoked to check the correctness of the data, such as doing address conflict - detection on the manually set local IPv4 address. EFI_NOT_READY is returned immediately to - indicate that such an asynchronous process is invoked and the process is not finished yet. The caller + This function is always non-blocking. When setting some typeof configuration data, an + asynchronous process is invoked to check the correctness of the data, such as doing address conflict + detection on the manually set local IPv4 address. EFI_NOT_READY is returned immediately to + indicate that such an asynchronous process is invoked and the process is not finished yet. The caller willing to get the result of the asynchronous process is required to call RegisterDataNotify() - to register an event on the specified configuration data. Once the event is signaled, the caller can call - GetData()to get back the configuration data in order to know the result. For other types of - configuration data that do not require an asynchronous configuration process, the result of the - operation is immediately returned. + to register an event on the specified configuration data. Once the event is signaled, the caller can call + GetData()to get back the configuration data in order to know the result. For other types of + configuration data that do not require an asynchronous configuration process, the result of the + operation is immediately returned. - @param[in] This Pointer to the EFI_IP4_CONFIG2_PROTOCOL instance. + @param[in] This Pointer to the EFI_IP4_CONFIG2_PROTOCOL instance. @param[in] DataType The type of data to set. @param[in] DataSize Size of the buffer pointed to by Data in bytes. - @param[in] Data The data buffer to set. The type ofthe data buffer is associated - with the DataType. + @param[in] Data The data buffer to set. The type ofthe data buffer is associated + with the DataType. - @retval EFI_SUCCESS The specified configuration data for the EFI IPv4 network stack is set + @retval EFI_SUCCESS The specified configuration data for the EFI IPv4 network stack is set successfully. @retval EFI_INVALID_PARAMETER One or more of the following are TRUE: This is NULL. - One or more fields in Data and DataSize do not match the + One or more fields in Data and DataSize do not match the requirement of the data type indicated by DataType. - @retval EFI_WRITE_PROTECTED The specified configuration data is read-only or the specified configuration + @retval EFI_WRITE_PROTECTED The specified configuration data is read-only or the specified configuration data can not be set under the current policy. @retval EFI_ACCESS_DENIED Another set operation on the specified configuration data is already in process. - @retval EFI_NOT_READY An asynchronous process is invoked to set the specified configuration data and + @retval EFI_NOT_READY An asynchronous process is invoked to set the specified configuration data and the process is not finished yet. - @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type indicated by DataType. + @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type indicated by DataType. @retval EFI_UNSUPPORTED This DataType is not supported. @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. @retval EFI_DEVICE_ERROR An unexpected system error or network error occurred. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_IP4_CONFIG2_SET_DATA) ( IN EFI_IP4_CONFIG2_PROTOCOL *This, @@ -214,35 +214,35 @@ EFI_STATUS ); /** - Get the configuration data for the EFI IPv4 network stack running on the communication device this + Get the configuration data for the EFI IPv4 network stack running on the communication device this EFI IPv4 Configuration II Protocol instance manages. - This function returns the configuration data of type DataType for the EFI IPv4 network stack + This function returns the configuration data of type DataType for the EFI IPv4 network stack running on the communication device this EFI IPv4 Configuration II Protocol instance manages. - The caller is responsible for allocating the buffer usedto return the specified configuration data and + The caller is responsible for allocating the buffer usedto return the specified configuration data and the required size will be returned to the caller if the size of the buffer is too small. - EFI_NOT_READY is returned if the specified configuration data is not ready due to an already in - progress asynchronous configuration process. The caller can call RegisterDataNotify() to - register an event on the specified configuration data. Once the asynchronous configuration process is - finished, the event will be signaled and a subsequent GetData() call will return the specified + EFI_NOT_READY is returned if the specified configuration data is not ready due to an already in + progress asynchronous configuration process. The caller can call RegisterDataNotify() to + register an event on the specified configuration data. Once the asynchronous configuration process is + finished, the event will be signaled and a subsequent GetData() call will return the specified configuration data. - @param[in] This Pointer to the EFI_IP4_CONFIG2_PROTOCOL instance. + @param[in] This Pointer to the EFI_IP4_CONFIG2_PROTOCOL instance. @param[in] DataType The type of data to get. - @param[out] DataSize On input, in bytes, the size of Data. On output, in bytes, the size - of buffer required to store the specified configuration data. - @param[in] Data The data buffer in which the configuration data is returned. The - type of the data buffer is associated with the DataType. Ignored - if DataSize is 0. + @param[out] DataSize On input, in bytes, the size of Data. On output, in bytes, the size + of buffer required to store the specified configuration data. + @param[in] Data The data buffer in which the configuration data is returned. The + type of the data buffer is associated with the DataType. Ignored + if DataSize is 0. @retval EFI_SUCCESS The specified configuration data is got successfully. @retval EFI_INVALID_PARAMETER One or more of the followings are TRUE: This is NULL. DataSize is NULL. Data is NULL if *DataSizeis not zero. - @retval EFI_BUFFER_TOO_SMALL The size of Data is too small for the specified configuration data + @retval EFI_BUFFER_TOO_SMALL The size of Data is too small for the specified configuration data and the required size is returned in DataSize. - @retval EFI_NOT_READY The specified configuration data is not ready due to an already in + @retval EFI_NOT_READY The specified configuration data is not ready due to an already in progress asynchronous configuration process. @retval EFI_NOT_FOUND The specified configuration data is not found. **/ @@ -256,19 +256,19 @@ EFI_STATUS ); /** - Register an event that is to be signaled whenever a configuration process on the specified + Register an event that is to be signaled whenever a configuration process on the specified configuration data is done. - This function registers an event that is to be signaled whenever a configuration process on the + This function registers an event that is to be signaled whenever a configuration process on the specified configuration data is done. An event can be registered for different DataType - simultaneously and the caller is responsible for determining which type of configuration data causes + simultaneously and the caller is responsible for determining which type of configuration data causes the signaling of the event in such case. - @param[in] This Pointer to the EFI_IP4_CONFIG2_PROTOCOL instance. + @param[in] This Pointer to the EFI_IP4_CONFIG2_PROTOCOL instance. @param[in] DataType The type of data to unregister the event for. @param[in] Event The event to register. - @retval EFI_SUCCESS The notification event for the specified configuration data is + @retval EFI_SUCCESS The notification event for the specified configuration data is registered. @retval EFI_INVALID_PARAMETER This is NULL or Event is NULL. @retval EFI_UNSUPPORTED The configuration data type specified by DataType is not supported. @@ -288,7 +288,7 @@ EFI_STATUS This function removes a previously registeredevent for the specified configuration data. - @param[in] This Pointer to the EFI_IP4_CONFIG2_PROTOCOL instance. + @param[in] This Pointer to the EFI_IP4_CONFIG2_PROTOCOL instance. @param[in] DataType The type of data to remove the previously registered event for. @param[in] Event The event to unregister. @@ -305,9 +305,9 @@ EFI_STATUS ); /// -/// The EFI_IP4_CONFIG2_PROTOCOL is designed to be the central repository for the common +/// The EFI_IP4_CONFIG2_PROTOCOL is designed to be the central repository for the common /// configurations and the administrator configurable settings for the EFI IPv4 network stack. -/// An EFI IPv4 Configuration II Protocol instance will be installed on each communication device that +/// An EFI IPv4 Configuration II Protocol instance will be installed on each communication device that /// the EFI IPv4 network stack runs on. /// struct _EFI_IP4_CONFIG2_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ip6Config.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ip6Config.h index 58982fc883..0007e882df 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ip6Config.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Ip6Config.h @@ -27,71 +27,71 @@ typedef struct _EFI_IP6_CONFIG_PROTOCOL EFI_IP6_CONFIG_PROTOCOL; /// /// EFI_IP6_CONFIG_DATA_TYPE /// -typedef enum { - /// - /// The interface information of the communication - /// device this EFI IPv6 Configuration Protocol instance manages. - /// This type of data is read only.The corresponding Data is of type +typedef enum { + /// + /// The interface information of the communication + /// device this EFI IPv6 Configuration Protocol instance manages. + /// This type of data is read only.The corresponding Data is of type /// EFI_IP6_CONFIG_INTERFACE_INFO. - /// + /// Ip6ConfigDataTypeInterfaceInfo, - /// - /// The alternative interface ID for the - /// communication device this EFI IPv6 Configuration Protocol - /// instance manages if the link local IPv6 address generated from - /// the interfaced ID based on the default source the EFI IPv6 - /// Protocol uses is a duplicate address. The length of the interface - /// ID is 64 bit. The corresponding Data is of type + /// + /// The alternative interface ID for the + /// communication device this EFI IPv6 Configuration Protocol + /// instance manages if the link local IPv6 address generated from + /// the interfaced ID based on the default source the EFI IPv6 + /// Protocol uses is a duplicate address. The length of the interface + /// ID is 64 bit. The corresponding Data is of type /// EFI_IP6_CONFIG_INTERFACE_ID. - /// + /// Ip6ConfigDataTypeAltInterfaceId, - /// - /// The general configuration policy for the EFI IPv6 network - /// stack running on the communication device this EFI IPv6 - /// Configuration Protocol instance manages. The policy will affect - /// other configuration settings. The corresponding Data is of type + /// + /// The general configuration policy for the EFI IPv6 network + /// stack running on the communication device this EFI IPv6 + /// Configuration Protocol instance manages. The policy will affect + /// other configuration settings. The corresponding Data is of type /// EFI_IP6_CONFIG_POLICY. /// Ip6ConfigDataTypePolicy, - /// - /// The number of consecutive - /// Neighbor Solicitation messages sent while performing Duplicate - /// Address Detection on a tentative address. A value of zero - /// indicates that Duplicate Address Detection will not be performed - /// on tentative addresses. The corresponding Data is of type + /// + /// The number of consecutive + /// Neighbor Solicitation messages sent while performing Duplicate + /// Address Detection on a tentative address. A value of zero + /// indicates that Duplicate Address Detection will not be performed + /// on tentative addresses. The corresponding Data is of type /// EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS. - /// + /// Ip6ConfigDataTypeDupAddrDetectTransmits, - /// - /// The station addresses set manually for the EFI - /// IPv6 network stack. It is only configurable when the policy is - /// Ip6ConfigPolicyManual. The corresponding Data is a - /// pointer to an array of EFI_IPv6_ADDRESS instances. When - /// DataSize is 0 and Data is NULL, the existing configuration + /// + /// The station addresses set manually for the EFI + /// IPv6 network stack. It is only configurable when the policy is + /// Ip6ConfigPolicyManual. The corresponding Data is a + /// pointer to an array of EFI_IPv6_ADDRESS instances. When + /// DataSize is 0 and Data is NULL, the existing configuration /// is cleared from the EFI IPv6 Configuration Protocol instance. - /// + /// Ip6ConfigDataTypeManualAddress, - /// - /// The gateway addresses set manually for the EFI IPv6 - /// network stack running on the communication device this EFI - /// IPv6 Configuration Protocol manages. It is not configurable when - /// the policy is Ip6ConfigPolicyAutomatic. The gateway - /// addresses must be unicast IPv6 addresses. The corresponding + /// + /// The gateway addresses set manually for the EFI IPv6 + /// network stack running on the communication device this EFI + /// IPv6 Configuration Protocol manages. It is not configurable when + /// the policy is Ip6ConfigPolicyAutomatic. The gateway + /// addresses must be unicast IPv6 addresses. The corresponding /// Data is a pointer to an array of EFI_IPv6_ADDRESS instances. - /// When DataSize is 0 and Data is NULL, the existing configuration + /// When DataSize is 0 and Data is NULL, the existing configuration /// is cleared from the EFI IPv6 Configuration Protocol instance. - /// + /// Ip6ConfigDataTypeGateway, - /// - /// The DNS server list for the EFI IPv6 network stack - /// running on the communication device this EFI IPv6 - /// Configuration Protocol manages. It is not configurable when the - /// policy is Ip6ConfigPolicyAutomatic.The DNS server - /// addresses must be unicast IPv6 addresses. The corresponding + /// + /// The DNS server list for the EFI IPv6 network stack + /// running on the communication device this EFI IPv6 + /// Configuration Protocol manages. It is not configurable when the + /// policy is Ip6ConfigPolicyAutomatic.The DNS server + /// addresses must be unicast IPv6 addresses. The corresponding /// Data is a pointer to an array of EFI_IPv6_ADDRESS instances. - /// When DataSize is 0 and Data is NULL, the existing configuration + /// When DataSize is 0 and Data is NULL, the existing configuration /// is cleared from the EFI IPv6 Configuration Protocol instance. - /// + /// Ip6ConfigDataTypeDnsServer, /// /// The number of this enumeration memebers. @@ -101,7 +101,7 @@ typedef enum { /// /// EFI_IP6_CONFIG_INTERFACE_INFO -/// describes the operational state of the interface this +/// describes the operational state of the interface this /// EFI IPv6 Configuration Protocol instance manages. /// typedef struct { @@ -109,37 +109,37 @@ typedef struct { /// The name of the interface. It is a NULL-terminated string. /// CHAR16 Name[32]; - /// + /// /// The interface type of the network interface. - /// + /// UINT8 IfType; - /// + /// /// The size, in bytes, of the network interface's hardware address. - /// + /// UINT32 HwAddressSize; - /// + /// /// The hardware address for the network interface. - /// + /// EFI_MAC_ADDRESS HwAddress; - /// + /// /// Number of EFI_IP6_ADDRESS_INFO structures pointed to by AddressInfo. - /// + /// UINT32 AddressInfoCount; - /// - /// Pointer to an array of EFI_IP6_ADDRESS_INFO instances - /// which contain the local IPv6 addresses and the corresponding - /// prefix length information. Set to NULL if AddressInfoCount + /// + /// Pointer to an array of EFI_IP6_ADDRESS_INFO instances + /// which contain the local IPv6 addresses and the corresponding + /// prefix length information. Set to NULL if AddressInfoCount /// is zero. - /// + /// EFI_IP6_ADDRESS_INFO *AddressInfo; - /// + /// /// Number of route table entries in the following RouteTable. - /// + /// UINT32 RouteCount; - /// - /// The route table of the IPv6 network stack runs on this interface. - /// Set to NULL if RouteCount is zero. - /// + /// + /// The route table of the IPv6 network stack runs on this interface. + /// Set to NULL if RouteCount is zero. + /// EFI_IP6_ROUTE_TABLE *RouteTable; } EFI_IP6_CONFIG_INTERFACE_INFO; @@ -153,42 +153,42 @@ typedef struct { /// /// EFI_IP6_CONFIG_POLICY -/// defines the general configuration policy the EFI IPv6 +/// defines the general configuration policy the EFI IPv6 /// Configuration Protocol supports. /// typedef enum { /// - /// Under this policy, the IpI6ConfigDataTypeManualAddress, + /// Under this policy, the IpI6ConfigDataTypeManualAddress, /// Ip6ConfigDataTypeGateway and Ip6ConfigDataTypeDnsServer - /// configuration data are required to be set manually. + /// configuration data are required to be set manually. /// The EFI IPv6 Protocol will get all required configuration /// such as address, prefix and gateway settings from the EFI /// IPv6 Configuration protocol. /// - Ip6ConfigPolicyManual, - /// - /// Under this policy, the IpI6ConfigDataTypeManualAddress, + Ip6ConfigPolicyManual, + /// + /// Under this policy, the IpI6ConfigDataTypeManualAddress, /// Ip6ConfigDataTypeGateway and Ip6ConfigDataTypeDnsServer /// configuration data are not allowed to set via SetData(). /// All of these configurations are retrieved from some auto - /// configuration mechanism. - /// The EFI IPv6 Protocol will use the IPv6 stateless address - /// autoconfiguration mechanism and/or the IPv6 stateful address - /// autoconfiguration mechanism described in the related RFCs to + /// configuration mechanism. + /// The EFI IPv6 Protocol will use the IPv6 stateless address + /// autoconfiguration mechanism and/or the IPv6 stateful address + /// autoconfiguration mechanism described in the related RFCs to /// get address and other configuration information - /// + /// Ip6ConfigPolicyAutomatic } EFI_IP6_CONFIG_POLICY; /// /// EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS /// describes the number of consecutive Neighbor Solicitation messages sent -/// while performing Duplicate Address Detection on a tentative address. +/// while performing Duplicate Address Detection on a tentative address. /// The default value for a newly detected communication device is 1. /// typedef struct { UINT32 DupAddrDetectTransmits; ///< The number of consecutive Neighbor Solicitation messages sent. -} EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS; +} EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS; /// /// EFI_IP6_CONFIG_MANUAL_ADDRESS @@ -205,49 +205,49 @@ typedef struct { /** Set the configuration for the EFI IPv6 network stack running on the communication device this EFI IPv6 Configuration Protocol instance manages. - - This function is used to set the configuration data of type DataType for the EFI + + This function is used to set the configuration data of type DataType for the EFI IPv6 network stack running on the communication device this EFI IPv6 Configuration Protocol instance manages. - The DataSize is used to calculate the count of structure instances in the Data for + The DataSize is used to calculate the count of structure instances in the Data for some DataType that multiple structure instances are allowed. - + This function is always non-blocking. When setting some type of configuration data, - an asynchronous process is invoked to check the correctness of the data, such as - doing Duplicate Address Detection on the manually set local IPv6 addresses. + an asynchronous process is invoked to check the correctness of the data, such as + doing Duplicate Address Detection on the manually set local IPv6 addresses. EFI_NOT_READY is returned immediately to indicate that such an asynchronous process is invoked and the process is not finished yet. The caller willing to get the result of the asynchronous process is required to call RegisterDataNotify() to register an - event on the specified configuration data. Once the event is signaled, the caller + event on the specified configuration data. Once the event is signaled, the caller can call GetData() to get back the configuration data in order to know the result. - For other types of configuration data that do not require an asynchronous configuration + For other types of configuration data that do not require an asynchronous configuration process, the result of the operation is immediately returned. @param[in] This Pointer to the EFI_IP6_CONFIG_PROTOCOL instance. - @param[in] DataType The type of data to set. + @param[in] DataType The type of data to set. @param[in] DataSize Size of the buffer pointed to by Data in bytes. @param[in] Data The data buffer to set. The type of the data buffer is associated with the DataType. - - @retval EFI_SUCCESS The specified configuration data for the EFI IPv6 + + @retval EFI_SUCCESS The specified configuration data for the EFI IPv6 network stack is set successfully. @retval EFI_INVALID_PARAMETER One or more of the following are TRUE: - This is NULL. - - One or more fields in Data and DataSize do not match the - requirement of the data type indicated by DataType. - @retval EFI_WRITE_PROTECTED The specified configuration data is read-only or the specified + - One or more fields in Data and DataSize do not match the + requirement of the data type indicated by DataType. + @retval EFI_WRITE_PROTECTED The specified configuration data is read-only or the specified configuration data can not be set under the current policy - @retval EFI_ACCESS_DENIED Another set operation on the specified configuration + @retval EFI_ACCESS_DENIED Another set operation on the specified configuration data is already in process. @retval EFI_NOT_READY An asynchronous process is invoked to set the specified configuration data and the process is not finished yet. - @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type + @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type indicated by DataType. @retval EFI_UNSUPPORTED This DataType is not supported. @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. @retval EFI_DEVICE_ERROR An unexpected system error or network error occurred. - + **/ typedef EFI_STATUS @@ -261,39 +261,39 @@ EFI_STATUS /** Get the configuration data for the EFI IPv6 network stack running on the communication device this EFI IPv6 Configuration Protocol instance manages. - + This function returns the configuration data of type DataType for the EFI IPv6 network stack running on the communication device this EFI IPv6 Configuration Protocol instance manages. The caller is responsible for allocating the buffer used to return the specified configuration data and the required size will be returned to the caller if the size of - the buffer is too small. - - EFI_NOT_READY is returned if the specified configuration data is not ready due to an + the buffer is too small. + + EFI_NOT_READY is returned if the specified configuration data is not ready due to an already in progress asynchronous configuration process. The caller can call RegisterDataNotify() to register an event on the specified configuration data. Once the asynchronous configuration - process is finished, the event will be signaled and a subsequent GetData() call will return + process is finished, the event will be signaled and a subsequent GetData() call will return the specified configuration data. @param[in] This Pointer to the EFI_IP6_CONFIG_PROTOCOL instance. - @param[in] DataType The type of data to get. - @param[in,out] DataSize On input, in bytes, the size of Data. On output, in bytes, the + @param[in] DataType The type of data to get. + @param[in,out] DataSize On input, in bytes, the size of Data. On output, in bytes, the size of buffer required to store the specified configuration data. - @param[in] Data The data buffer in which the configuration data is returned. The + @param[in] Data The data buffer in which the configuration data is returned. The type of the data buffer is associated with the DataType. - + @retval EFI_SUCCESS The specified configuration data is got successfully. @retval EFI_INVALID_PARAMETER One or more of the followings are TRUE: - This is NULL. - DataSize is NULL. - Data is NULL if *DataSize is not zero. - @retval EFI_BUFFER_TOO_SMALL The size of Data is too small for the specified configuration data + @retval EFI_BUFFER_TOO_SMALL The size of Data is too small for the specified configuration data and the required size is returned in DataSize. - @retval EFI_NOT_READY The specified configuration data is not ready due to an already in + @retval EFI_NOT_READY The specified configuration data is not ready due to an already in progress asynchronous configuration process. @retval EFI_NOT_FOUND The specified configuration data is not found. - + **/ typedef EFI_STATUS @@ -307,24 +307,24 @@ EFI_STATUS /** Register an event that is to be signaled whenever a configuration process on the specified configuration data is done. - + This function registers an event that is to be signaled whenever a configuration process on the specified configuration data is done. An event can be registered for different DataType simultaneously and the caller is responsible for determining which type of configuration data causes the signaling of the event in such case. @param[in] This Pointer to the EFI_IP6_CONFIG_PROTOCOL instance. - @param[in] DataType The type of data to unregister the event for. - @param[in] Event The event to register. - - @retval EFI_SUCCESS The notification event for the specified configuration data is + @param[in] DataType The type of data to unregister the event for. + @param[in] Event The event to register. + + @retval EFI_SUCCESS The notification event for the specified configuration data is registered. @retval EFI_INVALID_PARAMETER This is NULL or Event is NULL. - @retval EFI_UNSUPPORTED The configuration data type specified by DataType is not + @retval EFI_UNSUPPORTED The configuration data type specified by DataType is not supported. @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. @retval EFI_ACCESS_DENIED The Event is already registered for the DataType. - + **/ typedef EFI_STATUS @@ -336,18 +336,18 @@ EFI_STATUS /** Remove a previously registered event for the specified configuration data. - + This function removes a previously registered event for the specified configuration data. @param[in] This Pointer to the EFI_IP6_CONFIG_PROTOCOL instance. - @param[in] DataType The type of data to remove the previously registered event for. + @param[in] DataType The type of data to remove the previously registered event for. @param[in] Event The event to unregister. - + @retval EFI_SUCCESS The event registered for the specified configuration data is removed. @retval EFI_INVALID_PARAMETER This is NULL or Event is NULL. - @retval EFI_NOT_FOUND The Event has not been registered for the specified + @retval EFI_NOT_FOUND The Event has not been registered for the specified DataType. - + **/ typedef EFI_STATUS diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IpSec.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IpSec.h index a22326309c..a280ed0c99 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IpSec.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IpSec.h @@ -1,13 +1,13 @@ /** @file EFI IPSEC Protocol Definition The EFI_IPSEC_PROTOCOL is used to abstract the ability to deal with the individual - packets sent and received by the host and provide packet-level security for IP + packets sent and received by the host and provide packet-level security for IP datagram. The EFI_IPSEC2_PROTOCOL is used to abstract the ability to deal with the individual - packets sent and received by the host and provide packet-level security for IP - datagram. In addition, it supports the Option (extension header) processing in - IPsec which doesn't support in EFI_IPSEC_PROTOCOL. It is also recommended to - use EFI_IPSEC2_PROTOCOL instead of EFI_IPSEC_PROTOCOL especially for IPsec Tunnel + packets sent and received by the host and provide packet-level security for IP + datagram. In addition, it supports the Option (extension header) processing in + IPsec which doesn't support in EFI_IPSEC_PROTOCOL. It is also recommended to + use EFI_IPSEC2_PROTOCOL instead of EFI_IPSEC_PROTOCOL especially for IPsec Tunnel Mode. Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR> @@ -19,7 +19,7 @@ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - @par Revision Reference: + @par Revision Reference: The EFI_IPSEC2_PROTOCOL is introduced in UEFI Specification 2.3D. **/ @@ -43,34 +43,34 @@ typedef struct _EFI_IPSEC_PROTOCOL EFI_IPSEC_PROTOCOL; typedef struct _EFI_IPSEC2_PROTOCOL EFI_IPSEC2_PROTOCOL; /// -/// EFI_IPSEC_FRAGMENT_DATA +/// EFI_IPSEC_FRAGMENT_DATA /// defines the instances of packet fragments. /// -typedef struct _EFI_IPSEC_FRAGMENT_DATA { +typedef struct _EFI_IPSEC_FRAGMENT_DATA { UINT32 FragmentLength; VOID *FragmentBuffer; -} EFI_IPSEC_FRAGMENT_DATA; +} EFI_IPSEC_FRAGMENT_DATA; /** - Handles IPsec packet processing for inbound and outbound IP packets. + Handles IPsec packet processing for inbound and outbound IP packets. The EFI_IPSEC_PROCESS process routine handles each inbound or outbound packet. - The behavior is that it can perform one of the following actions: - bypass the packet, discard the packet, or protect the packet. + The behavior is that it can perform one of the following actions: + bypass the packet, discard the packet, or protect the packet. @param[in] This Pointer to the EFI_IPSEC_PROTOCOL instance. @param[in] NicHandle Instance of the network interface. @param[in] IpVer IPV4 or IPV6. @param[in, out] IpHead Pointer to the IP Header. @param[in] LastHead The protocol of the next layer to be processed by IPsec. - @param[in] OptionsBuffer Pointer to the options buffer. + @param[in] OptionsBuffer Pointer to the options buffer. @param[in] OptionsLength Length of the options buffer. - @param[in, out] FragmentTable Pointer to a list of fragments. + @param[in, out] FragmentTable Pointer to a list of fragments. @param[in] FragmentCount Number of fragments. @param[in] TrafficDirection Traffic direction. @param[out] RecycleSignal Event for recycling of resources. - + @retval EFI_SUCCESS The packet was bypassed and all buffers remain the same. @retval EFI_SUCCESS The packet was protected. @retval EFI_ACCESS_DENIED The packet was discarded. @@ -93,9 +93,9 @@ EFI_STATUS ); /// -/// EFI_IPSEC_PROTOCOL +/// EFI_IPSEC_PROTOCOL /// provides the ability for securing IP communications by authenticating -/// and/or encrypting each IP packet in a data stream. +/// and/or encrypting each IP packet in a data stream. // EFI_IPSEC_PROTOCOL can be consumed by both the IPv4 and IPv6 stack. // A user can employ this protocol for IPsec package handling in both IPv4 // and IPv6 environment. @@ -107,72 +107,72 @@ struct _EFI_IPSEC_PROTOCOL { }; /** - Handles IPsec processing for both inbound and outbound IP packets. Compare with - Process() in EFI_IPSEC_PROTOCOL, this interface has the capability to process - Option(Extension Header). + Handles IPsec processing for both inbound and outbound IP packets. Compare with + Process() in EFI_IPSEC_PROTOCOL, this interface has the capability to process + Option(Extension Header). The EFI_IPSEC2_PROCESS process routine handles each inbound or outbound packet. - The behavior is that it can perform one of the following actions: - bypass the packet, discard the packet, or protect the packet. + The behavior is that it can perform one of the following actions: + bypass the packet, discard the packet, or protect the packet. @param[in] This Pointer to the EFI_IPSEC2_PROTOCOL instance. - @param[in] NicHandle Instance of the network interface. + @param[in] NicHandle Instance of the network interface. @param[in] IpVer IP version.IPv4 or IPv6. - @param[in, out] IpHead Pointer to the IP Header it is either + @param[in, out] IpHead Pointer to the IP Header it is either the EFI_IP4_HEADER or EFI_IP6_HEADER. - On input, it contains the IP header. - On output, 1) in tunnel mode and the - traffic direction is inbound, the buffer - will be reset to zero by IPsec; 2) in - tunnel mode and the traffic direction - is outbound, the buffer will reset to - be the tunnel IP header.3) in transport - mode, the related fielders (like payload - length, Next header) in IP header will + On input, it contains the IP header. + On output, 1) in tunnel mode and the + traffic direction is inbound, the buffer + will be reset to zero by IPsec; 2) in + tunnel mode and the traffic direction + is outbound, the buffer will reset to + be the tunnel IP header.3) in transport + mode, the related fielders (like payload + length, Next header) in IP header will be modified according to the condition. @param[in, out] LastHead For IP4, it is the next protocol in IP - header. For IP6 it is the Next Header + header. For IP6 it is the Next Header of the last extension header. - @param[in, out] OptionsBuffer On input, it contains the options - (extensions header) to be processed by + @param[in, out] OptionsBuffer On input, it contains the options + (extensions header) to be processed by IPsec. On output, 1) in tunnel mode and - the traffic direction is outbound, it - will be set to NULL, and that means this - contents was wrapped after inner header - and should not be concatenated after - tunnel header again; 2) in transport - mode and the traffic direction is inbound, - if there are IP options (extension headers) - protected by IPsec, IPsec will concatenate - the those options after the input options - (extension headers); 3) on other situations, - the output of contents of OptionsBuffer - might be same with input's. The caller - should take the responsibility to free + the traffic direction is outbound, it + will be set to NULL, and that means this + contents was wrapped after inner header + and should not be concatenated after + tunnel header again; 2) in transport + mode and the traffic direction is inbound, + if there are IP options (extension headers) + protected by IPsec, IPsec will concatenate + the those options after the input options + (extension headers); 3) on other situations, + the output of contents of OptionsBuffer + might be same with input's. The caller + should take the responsibility to free the buffer both on input and on output. - @param[in, out] OptionsLength On input, the input length of the options - buffer. On output, the output length of + @param[in, out] OptionsLength On input, the input length of the options + buffer. On output, the output length of the options buffer. - @param[in, out] FragmentTable Pointer to a list of fragments. On input, - these fragments contain the IP payload. - On output, 1) in tunnel mode and the traffic - direction is inbound, the fragments contain - the whole IP payload which is from the - IP inner header to the last byte of the - packet; 2) in tunnel mode and the traffic - direction is the outbound, the fragments - contains the whole encapsulated payload - which encapsulates the whole IP payload - between the encapsulated header and - encapsulated trailer fields. 3) in transport - mode and the traffic direction is inbound, - the fragments contains the IP payload - which is from the next layer protocol to - the last byte of the packet; 4) in transport - mode and the traffic direction is outbound, - the fragments contains the whole encapsulated - payload which encapsulates the next layer - protocol information between the encapsulated + @param[in, out] FragmentTable Pointer to a list of fragments. On input, + these fragments contain the IP payload. + On output, 1) in tunnel mode and the traffic + direction is inbound, the fragments contain + the whole IP payload which is from the + IP inner header to the last byte of the + packet; 2) in tunnel mode and the traffic + direction is the outbound, the fragments + contains the whole encapsulated payload + which encapsulates the whole IP payload + between the encapsulated header and + encapsulated trailer fields. 3) in transport + mode and the traffic direction is inbound, + the fragments contains the IP payload + which is from the next layer protocol to + the last byte of the packet; 4) in transport + mode and the traffic direction is outbound, + the fragments contains the whole encapsulated + payload which encapsulates the next layer + protocol information between the encapsulated header and encapsulated trailer fields. @param[in, out] FragmentCount Number of fragments. @param[in] TrafficDirection Traffic direction. @@ -180,7 +180,7 @@ struct _EFI_IPSEC_PROTOCOL { @retval EFI_SUCCESS The packet was processed by IPsec successfully. @retval EFI_ACCESS_DENIED The packet was discarded. - @retval EFI_NOT_READY The IKE negotiation is invoked and the packet + @retval EFI_NOT_READY The IKE negotiation is invoked and the packet was discarded. @retval EFI_INVALID_PARAMETER One or more of following are TRUE: If OptionsBuffer is NULL; @@ -189,23 +189,23 @@ struct _EFI_IPSEC_PROTOCOL { If FragmentCount is NULL. **/ -typedef +typedef EFI_STATUS -(EFIAPI *EFI_IPSEC_PROCESSEXT) ( - IN EFI_IPSEC2_PROTOCOL *This, - IN EFI_HANDLE NicHandle, - IN UINT8 IpVer, - IN OUT VOID *IpHead, - IN OUT UINT8 *LastHead, - IN OUT VOID **OptionsBuffer, - IN OUT UINT32 *OptionsLength, - IN OUT EFI_IPSEC_FRAGMENT_DATA **FragmentTable, - IN OUT UINT32 *FragmentCount, - IN EFI_IPSEC_TRAFFIC_DIR TrafficDirection, +(EFIAPI *EFI_IPSEC_PROCESSEXT) ( + IN EFI_IPSEC2_PROTOCOL *This, + IN EFI_HANDLE NicHandle, + IN UINT8 IpVer, + IN OUT VOID *IpHead, + IN OUT UINT8 *LastHead, + IN OUT VOID **OptionsBuffer, + IN OUT UINT32 *OptionsLength, + IN OUT EFI_IPSEC_FRAGMENT_DATA **FragmentTable, + IN OUT UINT32 *FragmentCount, + IN EFI_IPSEC_TRAFFIC_DIR TrafficDirection, OUT EFI_EVENT *RecycleSignal ); -/// +/// /// EFI_IPSEC2_PROTOCOL /// supports the Option (extension header) processing in IPsec which doesn't support /// in EFI_IPSEC_PROTOCOL. It is also recommended to use EFI_IPSEC2_PROTOCOL instead @@ -213,10 +213,10 @@ EFI_STATUS /// provides the ability for securing IP communications by authenticating and/or /// encrypting each IP packet in a data stream. /// -struct _EFI_IPSEC2_PROTOCOL { +struct _EFI_IPSEC2_PROTOCOL { EFI_IPSEC_PROCESSEXT ProcessExt; -EFI_EVENT DisabledEvent; -BOOLEAN DisabledFlag; +EFI_EVENT DisabledEvent; +BOOLEAN DisabledFlag; }; extern EFI_GUID gEfiIpSecProtocolGuid; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IpSecConfig.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IpSecConfig.h index 4efc2e3d74..57803cf4f2 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IpSecConfig.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IpSecConfig.h @@ -1,6 +1,6 @@ /** @file EFI IPsec Configuration Protocol Definition - The EFI_IPSEC_CONFIG_PROTOCOL provides the mechanism to set and retrieve security and + The EFI_IPSEC_CONFIG_PROTOCOL provides the mechanism to set and retrieve security and policy related information for the EFI IPsec protocol driver. Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR> @@ -12,7 +12,7 @@ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - @par Revision Reference: + @par Revision Reference: This Protocol is introduced in UEFI Specification 2.2 **/ @@ -32,34 +32,34 @@ typedef struct _EFI_IPSEC_CONFIG_PROTOCOL EFI_IPSEC_CONFIG_PROTOCOL; /// EFI_IPSEC_CONFIG_DATA_TYPE /// typedef enum { - /// - /// The IPsec Security Policy Database (aka SPD) setting. In IPsec, - /// an essential element of Security Association (SA) processing is - /// underlying SPD that specifies what services are to be offered to - /// IP datagram and in what fashion. The SPD must be consulted - /// during the processing of all traffic (inbound and outbound), - /// including traffic not protected by IPsec, that traverses the IPsec - /// boundary. With this DataType, SetData() function is to set - /// the SPD entry information, which may add one new entry, delete - /// one existed entry or flush the whole database according to the - /// parameter values. The corresponding Data is of type + /// + /// The IPsec Security Policy Database (aka SPD) setting. In IPsec, + /// an essential element of Security Association (SA) processing is + /// underlying SPD that specifies what services are to be offered to + /// IP datagram and in what fashion. The SPD must be consulted + /// during the processing of all traffic (inbound and outbound), + /// including traffic not protected by IPsec, that traverses the IPsec + /// boundary. With this DataType, SetData() function is to set + /// the SPD entry information, which may add one new entry, delete + /// one existed entry or flush the whole database according to the + /// parameter values. The corresponding Data is of type /// EFI_IPSEC_SPD_DATA - /// + /// IPsecConfigDataTypeSpd, - /// - /// The IPsec Security Association Database (aka SAD) setting. A - /// SA is a simplex connection that affords security services to the - /// traffic carried by it. Security services are afforded to an SA by the - /// use of AH, or ESP, but not both. The corresponding Data is of + /// + /// The IPsec Security Association Database (aka SAD) setting. A + /// SA is a simplex connection that affords security services to the + /// traffic carried by it. Security services are afforded to an SA by the + /// use of AH, or ESP, but not both. The corresponding Data is of /// type EFI_IPSEC_SAD_DATA. - /// + /// IPsecConfigDataTypeSad, - /// - /// The IPsec Peer Authorization Database (aka PAD) setting, which - /// provides the link between the SPD and a security association - /// management protocol. The PAD entry specifies the - /// authentication protocol (e.g. IKEv1, IKEv2) method used and the - /// authentication data. The corresponding Data is of type + /// + /// The IPsec Peer Authorization Database (aka PAD) setting, which + /// provides the link between the SPD and a security association + /// management protocol. The PAD entry specifies the + /// authentication protocol (e.g. IKEv1, IKEv2) method used and the + /// authentication data. The corresponding Data is of type /// EFI_IPSEC_PAD_DATA. /// IPsecConfigDataTypePad, @@ -79,70 +79,70 @@ typedef struct _EFI_IP_ADDRESS_INFO { /// EFI_IPSEC_SPD_SELECTOR /// typedef struct _EFI_IPSEC_SPD_SELECTOR { - /// + /// /// Specifies the actual number of entries in LocalAddress. - /// + /// UINT32 LocalAddressCount; - /// - /// A list of ranges of IPv4 or IPv6 addresses, which refers to the + /// + /// A list of ranges of IPv4 or IPv6 addresses, which refers to the /// addresses being protected by IPsec policy. - /// + /// EFI_IP_ADDRESS_INFO *LocalAddress; - /// + /// /// Specifies the actual number of entries in RemoteAddress. - /// + /// UINT32 RemoteAddressCount; - /// - /// A list of ranges of IPv4 or IPv6 addresses, which are peer entities - /// to LocalAddress. - /// + /// + /// A list of ranges of IPv4 or IPv6 addresses, which are peer entities + /// to LocalAddress. + /// EFI_IP_ADDRESS_INFO *RemoteAddress; - /// - /// Next layer protocol. Obtained from the IPv4 Protocol or the IPv6 - /// Next Header fields. The next layer protocol is whatever comes - /// after any IP extension headers that are present. A zero value is a + /// + /// Next layer protocol. Obtained from the IPv4 Protocol or the IPv6 + /// Next Header fields. The next layer protocol is whatever comes + /// after any IP extension headers that are present. A zero value is a /// wildcard that matches any value in NextLayerProtocol field. - /// - UINT16 NextLayerProtocol; - /// - /// Local Port if the Next Layer Protocol uses two ports (as do TCP, - /// UDP, and others). A zero value is a wildcard that matches any + /// + UINT16 NextLayerProtocol; + /// + /// Local Port if the Next Layer Protocol uses two ports (as do TCP, + /// UDP, and others). A zero value is a wildcard that matches any /// value in LocalPort field. - /// + /// UINT16 LocalPort; - /// - /// A designed port range size. The start port is LocalPort, and - /// the total number of ports is described by LocalPortRange. - /// This field is ignored if NextLayerProtocol does not use - /// ports. - /// + /// + /// A designed port range size. The start port is LocalPort, and + /// the total number of ports is described by LocalPortRange. + /// This field is ignored if NextLayerProtocol does not use + /// ports. + /// UINT16 LocalPortRange; - /// - /// Remote Port if the Next Layer Protocol uses two ports. A zero + /// + /// Remote Port if the Next Layer Protocol uses two ports. A zero /// value is a wildcard that matches any value in RemotePort field. - /// + /// UINT16 RemotePort; - /// - /// A designed port range size. The start port is RemotePort, and - /// the total number of ports is described by RemotePortRange. + /// + /// A designed port range size. The start port is RemotePort, and + /// the total number of ports is described by RemotePortRange. /// This field is ignored if NextLayerProtocol does not use ports. - /// + /// UINT16 RemotePortRange; } EFI_IPSEC_SPD_SELECTOR; - + /// /// EFI_IPSEC_TRAFFIC_DIR /// represents the directionality in an SPD entry. /// typedef enum { /// - /// The EfiIPsecInBound refers to traffic entering an IPsec implementation via + /// The EfiIPsecInBound refers to traffic entering an IPsec implementation via /// the unprotected interface or emitted by the implementation on the unprotected - /// side of the boundary and directed towards the protected interface. + /// side of the boundary and directed towards the protected interface. /// EfiIPsecInBound, /// - /// The EfiIPsecOutBound refers to traffic entering the implementation via + /// The EfiIPsecOutBound refers to traffic entering the implementation via /// the protected interface, or emitted by the implementation on the protected side /// of the boundary and directed toward the unprotected interface. /// @@ -154,54 +154,54 @@ typedef enum { /// represents three possible processing choices. /// typedef enum { - /// + /// /// Refers to traffic that is not allowed to traverse the IPsec boundary. - /// + /// EfiIPsecActionDiscard, - /// - /// Refers to traffic that is allowed to cross the IPsec boundary + /// + /// Refers to traffic that is allowed to cross the IPsec boundary /// without protection. - /// + /// EfiIPsecActionBypass, - /// - /// Refers to traffic that is afforded IPsec protection, and for such - /// traffic the SPD must specify the security protocols to be - /// employed, their mode, security service options, and the - /// cryptographic algorithms to be used. + /// + /// Refers to traffic that is afforded IPsec protection, and for such + /// traffic the SPD must specify the security protocols to be + /// employed, their mode, security service options, and the + /// cryptographic algorithms to be used. /// EfiIPsecActionProtect } EFI_IPSEC_ACTION; /// /// EFI_IPSEC_SA_LIFETIME -/// defines the lifetime of an SA, which represents when a SA must be -/// replaced or terminated. A value of all 0 for each field removes +/// defines the lifetime of an SA, which represents when a SA must be +/// replaced or terminated. A value of all 0 for each field removes /// the limitation of a SA lifetime. /// typedef struct _EFI_IPSEC_SA_LIFETIME { - /// + /// /// The number of bytes to which the IPsec cryptographic algorithm /// can be applied. For ESP, this is the encryption algorithm and for - /// AH, this is the authentication algorithm. The ByteCount + /// AH, this is the authentication algorithm. The ByteCount /// includes pad bytes for cryptographic operations. - /// + /// UINT64 ByteCount; - /// - /// A time interval in second that warns the implementation to + /// + /// A time interval in second that warns the implementation to /// initiate action such as setting up a replacement SA. - /// + /// UINT64 SoftLifetime; - /// - /// A time interval in second when the current SA ends and is + /// + /// A time interval in second when the current SA ends and is /// destroyed. - /// + /// UINT64 HardLifetime; } EFI_IPSEC_SA_LIFETIME; /// /// EFI_IPSEC_MODE -/// There are two modes of IPsec operation: transport mode and tunnel mode. In -/// EfiIPsecTransport mode, AH and ESP provide protection primarily for next layer protocols; +/// There are two modes of IPsec operation: transport mode and tunnel mode. In +/// EfiIPsecTransport mode, AH and ESP provide protection primarily for next layer protocols; /// In EfiIPsecTunnel mode, AH and ESP are applied to tunneled IP packets. /// typedef enum { @@ -226,19 +226,19 @@ typedef enum { /// EFI_IPSEC_TUNNEL_OPTION /// typedef struct _EFI_IPSEC_TUNNEL_OPTION { - /// + /// /// Local tunnel address when IPsec mode is EfiIPsecTunnel. - /// + /// EFI_IP_ADDRESS LocalTunnelAddress; - /// + /// /// Remote tunnel address when IPsec mode is EfiIPsecTunnel. - /// + /// EFI_IP_ADDRESS RemoteTunnelAddress; - /// + /// /// The option of copying the DF bit from an outbound package - /// to the tunnel mode header that it emits, when traffic is - /// carried via a tunnel mode SA. - /// + /// to the tunnel mode header that it emits, when traffic is + /// carried via a tunnel mode SA. + /// EFI_IPSEC_TUNNEL_DF_OPTION DF; } EFI_IPSEC_TUNNEL_OPTION; @@ -247,7 +247,7 @@ typedef struct _EFI_IPSEC_TUNNEL_OPTION { /// typedef enum { EfiIPsecAH, ///< IP Authentication Header protocol which is specified in RFC 4302. - EfiIPsecESP ///< IP Encapsulating Security Payload which is specified in RFC 4303. + EfiIPsecESP ///< IP Encapsulating Security Payload which is specified in RFC 4303. } EFI_IPSEC_PROTOCOL_TYPE; /// @@ -255,48 +255,48 @@ typedef enum { /// describes a policy list for traffic processing. /// typedef struct _EFI_IPSEC_PROCESS_POLICY { - /// - /// Extended Sequence Number. Is this SA using extended sequence + /// + /// Extended Sequence Number. Is this SA using extended sequence /// numbers. 64 bit counter is used if TRUE. - /// + /// BOOLEAN ExtSeqNum; - /// - /// A flag indicating whether overflow of the sequence number - /// counter should generate an auditable event and prevent - /// transmission of additional packets on the SA, or whether rollover + /// + /// A flag indicating whether overflow of the sequence number + /// counter should generate an auditable event and prevent + /// transmission of additional packets on the SA, or whether rollover /// is permitted. - /// + /// BOOLEAN SeqOverflow; - /// - /// Is this SA using stateful fragment checking. TRUE represents + /// + /// Is this SA using stateful fragment checking. TRUE represents /// stateful fragment checking. - /// + /// BOOLEAN FragCheck; - /// - /// A time interval after which a SA must be replaced with a new SA - /// (and new SPI) or terminated. - /// + /// + /// A time interval after which a SA must be replaced with a new SA + /// (and new SPI) or terminated. + /// EFI_IPSEC_SA_LIFETIME SaLifetime; - /// + /// /// IPsec mode: tunnel or transport. - /// + /// EFI_IPSEC_MODE Mode; - /// + /// /// Tunnel Option. TunnelOption is ignored if Mode is EfiIPsecTransport. - /// + /// EFI_IPSEC_TUNNEL_OPTION *TunnelOption; - /// + /// /// IPsec protocol: AH or ESP - /// + /// EFI_IPSEC_PROTOCOL_TYPE Proto; - /// + /// /// Cryptographic algorithm type used for authentication. - /// + /// UINT8 AuthAlgoId; - /// - /// Cryptographic algorithm type used for encryption. EncAlgo is - /// NULL when IPsec protocol is AH. For ESP protocol, EncAlgo - /// can also be used to describe the algorithm if a combined mode + /// + /// Cryptographic algorithm type used for encryption. EncAlgo is + /// NULL when IPsec protocol is AH. For ESP protocol, EncAlgo + /// can also be used to describe the algorithm if a combined mode /// algorithm is used. /// UINT8 EncAlgoId; @@ -307,19 +307,19 @@ typedef struct _EFI_IPSEC_PROCESS_POLICY { /// A triplet to identify an SA, consisting of the following members. /// typedef struct _EFI_IPSEC_SA_ID { - /// - /// Security Parameter Index (aka SPI). An arbitrary 32-bit value - /// that is used by a receiver to identity the SA to which an incoming + /// + /// Security Parameter Index (aka SPI). An arbitrary 32-bit value + /// that is used by a receiver to identity the SA to which an incoming /// package should be bound. - /// + /// UINT32 Spi; - /// + /// /// IPsec protocol: AH or ESP - /// + /// EFI_IPSEC_PROTOCOL_TYPE Proto; - /// - /// Destination IP address. - /// + /// + /// Destination IP address. + /// EFI_IP_ADDRESS DestAddress; } EFI_IPSEC_SA_ID; @@ -330,48 +330,48 @@ typedef struct _EFI_IPSEC_SA_ID { /// EFI_IPSEC_SPD_DATA /// typedef struct _EFI_IPSEC_SPD_DATA { - /// - /// A null-terminated ASCII name string which is used as a symbolic + /// + /// A null-terminated ASCII name string which is used as a symbolic /// identifier for an IPsec Local or Remote address. - /// + /// UINT8 Name[MAX_PEERID_LEN]; - /// - /// Bit-mapped list describing Populate from Packet flags. When - /// creating a SA, if PackageFlag bit is set to TRUE, instantiate - /// the selector from the corresponding field in the package that - /// triggered the creation of the SA, else from the value(s) in the - /// corresponding SPD entry. The PackageFlag bit setting for + /// + /// Bit-mapped list describing Populate from Packet flags. When + /// creating a SA, if PackageFlag bit is set to TRUE, instantiate + /// the selector from the corresponding field in the package that + /// triggered the creation of the SA, else from the value(s) in the + /// corresponding SPD entry. The PackageFlag bit setting for /// corresponding selector field of EFI_IPSEC_SPD_SELECTOR: - /// Bit 0: EFI_IPSEC_SPD_SELECTOR.LocalAddress - /// Bit 1: EFI_IPSEC_SPD_SELECTOR.RemoteAddress - /// Bit 2: - /// EFI_IPSEC_SPD_SELECTOR.NextLayerProtocol - /// Bit 3: EFI_IPSEC_SPD_SELECTOR.LocalPort - /// Bit 4: EFI_IPSEC_SPD_SELECTOR.RemotePort + /// Bit 0: EFI_IPSEC_SPD_SELECTOR.LocalAddress + /// Bit 1: EFI_IPSEC_SPD_SELECTOR.RemoteAddress + /// Bit 2: + /// EFI_IPSEC_SPD_SELECTOR.NextLayerProtocol + /// Bit 3: EFI_IPSEC_SPD_SELECTOR.LocalPort + /// Bit 4: EFI_IPSEC_SPD_SELECTOR.RemotePort /// Others: Reserved. /// UINT32 PackageFlag; - /// + /// /// The traffic direction of data gram. - /// + /// EFI_IPSEC_TRAFFIC_DIR TrafficDirection; - /// - /// Processing choices to indicate which action is required by this - /// policy. - /// + /// + /// Processing choices to indicate which action is required by this + /// policy. + /// EFI_IPSEC_ACTION Action; - /// + /// /// The policy and rule information for a SPD entry. - /// + /// EFI_IPSEC_PROCESS_POLICY *ProcessingPolicy; - /// + /// /// Specifies the actual number of entries in SaId list. - /// + /// UINTN SaIdCount; - /// - /// The SAD entry used for the traffic processing. The + /// + /// The SAD entry used for the traffic processing. The /// existed SAD entry links indicate this is the manual key case. - /// + /// EFI_IPSEC_SA_ID SaId[1]; } EFI_IPSEC_SPD_DATA; @@ -389,9 +389,9 @@ typedef struct _EFI_IPSEC_AH_ALGO_INFO { /// /// EFI_IPSEC_ESP_ALGO_INFO /// The security algorithm selection for IPsec ESP encryption and authentication. -/// The required authentication algorithm is specified in RFC 4305. -/// EncAlgoId fields can also specify an ESP combined mode algorithm -/// (e.g. AES with CCM mode, specified in RFC 4309), which provides both +/// The required authentication algorithm is specified in RFC 4305. +/// EncAlgoId fields can also specify an ESP combined mode algorithm +/// (e.g. AES with CCM mode, specified in RFC 4309), which provides both /// confidentiality and authentication services. /// typedef struct _EFI_IPSEC_ESP_ALGO_INFO { @@ -415,40 +415,40 @@ typedef union { /// EFI_IPSEC_SA_DATA /// typedef struct _EFI_IPSEC_SA_DATA { - /// + /// /// IPsec mode: tunnel or transport. - /// + /// EFI_IPSEC_MODE Mode; - /// - /// Sequence Number Counter. A 64-bit counter used to generate the + /// + /// Sequence Number Counter. A 64-bit counter used to generate the /// sequence number field in AH or ESP headers. - /// + /// UINT64 SNCount; - /// - /// Anti-Replay Window. A 64-bit counter and a bit-map used to + /// + /// Anti-Replay Window. A 64-bit counter and a bit-map used to /// determine whether an inbound AH or ESP packet is a replay. - /// + /// UINT8 AntiReplayWindows; - /// - /// AH/ESP cryptographic algorithm, key and parameters. - /// + /// + /// AH/ESP cryptographic algorithm, key and parameters. + /// EFI_IPSEC_ALGO_INFO AlgoInfo; - /// - /// Lifetime of this SA. - /// + /// + /// Lifetime of this SA. + /// EFI_IPSEC_SA_LIFETIME SaLifetime; - /// - /// Any observed path MTU and aging variables. The Path MTU + /// + /// Any observed path MTU and aging variables. The Path MTU /// processing is defined in section 8 of RFC 4301. - /// + /// UINT32 PathMTU; - /// + /// /// Link to one SPD entry. - /// + /// EFI_IPSEC_SPD_SELECTOR *SpdSelector; - /// - /// Indication of whether it's manually set or negotiated automatically. - /// If ManualSet is FALSE, the corresponding SA entry is inserted through + /// + /// Indication of whether it's manually set or negotiated automatically. + /// If ManualSet is FALSE, the corresponding SA entry is inserted through /// IKE protocol negotiation. /// BOOLEAN ManualSet; @@ -457,41 +457,41 @@ typedef struct _EFI_IPSEC_SA_DATA { /// /// EFI_IPSEC_SA_DATA2 /// -typedef struct _EFI_IPSEC_SA_DATA2 { +typedef struct _EFI_IPSEC_SA_DATA2 { /// /// IPsec mode: tunnel or transport /// - EFI_IPSEC_MODE Mode; + EFI_IPSEC_MODE Mode; /// - /// Sequence Number Counter. A 64-bit counter used to generate the sequence - /// number field in AH or ESP headers. + /// Sequence Number Counter. A 64-bit counter used to generate the sequence + /// number field in AH or ESP headers. /// - UINT64 SNCount; + UINT64 SNCount; /// - /// Anti-Replay Window. A 64-bit counter and a bit-map used to determine + /// Anti-Replay Window. A 64-bit counter and a bit-map used to determine /// whether an inbound AH or ESP packet is a replay. /// - UINT8 AntiReplayWindows; + UINT8 AntiReplayWindows; /// /// AH/ESP cryptographic algorithm, key and parameters. /// - EFI_IPSEC_ALGO_INFO AlgoInfo; + EFI_IPSEC_ALGO_INFO AlgoInfo; /// /// Lifetime of this SA. /// - EFI_IPSEC_SA_LIFETIME SaLifetime; + EFI_IPSEC_SA_LIFETIME SaLifetime; /// - /// Any observed path MTU and aging variables. The Path MTU processing is + /// Any observed path MTU and aging variables. The Path MTU processing is /// defined in section 8 of RFC 4301. /// - UINT32 PathMTU; + UINT32 PathMTU; /// /// Link to one SPD entry /// - EFI_IPSEC_SPD_SELECTOR *SpdSelector; + EFI_IPSEC_SPD_SELECTOR *SpdSelector; /// - /// Indication of whether it's manually set or negotiated automatically. - /// If ManualSet is FALSE, the corresponding SA entry is inserted through IKE + /// Indication of whether it's manually set or negotiated automatically. + /// If ManualSet is FALSE, the corresponding SA entry is inserted through IKE /// protocol negotiation /// BOOLEAN ManualSet; @@ -503,7 +503,7 @@ typedef struct _EFI_IPSEC_SA_DATA2 { /// The tunnel header IP destination address. /// EFI_IP_ADDRESS TunnelDestinationAddress; -} EFI_IPSEC_SA_DATA2; +} EFI_IPSEC_SA_DATA2; /// @@ -514,8 +514,8 @@ typedef struct _EFI_IPSEC_SA_DATA2 { typedef struct _EFI_IPSEC_PAD_ID { /// /// Flag to identify which type of PAD Id is used. - /// - BOOLEAN PeerIdValid; + /// + BOOLEAN PeerIdValid; union { /// /// Pointer to the IPv4 or IPv6 address range. @@ -523,8 +523,8 @@ typedef struct _EFI_IPSEC_PAD_ID { EFI_IP_ADDRESS_INFO IpAddress; /// /// Pointer to a null terminated ASCII string - /// representing the symbolic names. A PeerId can be a DNS - /// name, Distinguished Name, RFC 822 email address or Key ID + /// representing the symbolic names. A PeerId can be a DNS + /// name, Distinguished Name, RFC 822 email address or Key ID /// (specified in section 4.4.3.1 of RFC 4301) /// UINT8 PeerId[MAX_PEERID_LEN]; @@ -533,7 +533,7 @@ typedef struct _EFI_IPSEC_PAD_ID { /// /// EFI_IPSEC_CONFIG_SELECTOR -/// describes the expected IPsec configuration data selector +/// describes the expected IPsec configuration data selector /// of type EFI_IPSEC_CONFIG_DATA_TYPE. /// typedef union { @@ -544,7 +544,7 @@ typedef union { /// /// EFI_IPSEC_AUTH_PROTOCOL_TYPE -/// defines the possible authentication protocol for IPsec +/// defines the possible authentication protocol for IPsec /// security association management. /// typedef enum { @@ -572,64 +572,64 @@ typedef enum { /// EFI_IPSEC_PAD_DATA /// typedef struct _EFI_IPSEC_PAD_DATA { - /// + /// /// Authentication Protocol for IPsec security association management. - /// + /// EFI_IPSEC_AUTH_PROTOCOL_TYPE AuthProtocol; - /// + /// /// Authentication method used. - /// + /// EFI_IPSEC_AUTH_METHOD AuthMethod; - /// - /// The IKE ID payload will be used as a symbolic name for SPD - /// lookup if IkeIdFlag is TRUE. Otherwise, the remote IP + /// + /// The IKE ID payload will be used as a symbolic name for SPD + /// lookup if IkeIdFlag is TRUE. Otherwise, the remote IP /// address provided in traffic selector playloads will be used. - /// + /// BOOLEAN IkeIdFlag; - /// + /// /// The size of Authentication data buffer, in bytes. - /// + /// UINTN AuthDataSize; - /// - /// Buffer for Authentication data, (e.g., the pre-shared secret or the - /// trust anchor relative to which the peer's certificate will be + /// + /// Buffer for Authentication data, (e.g., the pre-shared secret or the + /// trust anchor relative to which the peer's certificate will be /// validated). - /// + /// VOID *AuthData; - /// + /// /// The size of RevocationData, in bytes - /// + /// UINTN RevocationDataSize; - /// - /// Pointer to CRL or OCSP data, if certificates are used for + /// + /// Pointer to CRL or OCSP data, if certificates are used for /// authentication method. - /// + /// VOID *RevocationData; } EFI_IPSEC_PAD_DATA; /** Set the security association, security policy and peer authorization configuration - information for the EFI IPsec driver. + information for the EFI IPsec driver. This function is used to set the IPsec configuration information of type DataType for the EFI IPsec driver. The IPsec configuration data has a unique selector/identifier separately to identify a data entry. The selector structure depends on DataType's definition. Using SetData() with a Data of NULL causes the IPsec configuration data entry identified - by DataType and Selector to be deleted. + by DataType and Selector to be deleted. @param[in] This Pointer to the EFI_IPSEC_CONFIG_PROTOCOL instance. @param[in] DataType The type of data to be set. - @param[in] Selector Pointer to an entry selector on operated configuration data - specified by DataType. A NULL Selector causes the entire + @param[in] Selector Pointer to an entry selector on operated configuration data + specified by DataType. A NULL Selector causes the entire specified-type configuration information to be flushed. - @param[in] Data The data buffer to be set. The structure of the data buffer is + @param[in] Data The data buffer to be set. The structure of the data buffer is associated with the DataType. @param[in] InsertBefore Pointer to one entry selector which describes the expected position the new data entry will be added. If InsertBefore is NULL, the new entry will be appended the end of database. - + @retval EFI_SUCCESS The specified configuration entry data is set successfully. @retval EFI_INVALID_PARAMETER One or more of the following are TRUE: - This is NULL. @@ -648,20 +648,20 @@ EFI_STATUS ); /** - Return the configuration value for the EFI IPsec driver. + Return the configuration value for the EFI IPsec driver. This function lookup the data entry from IPsec database or IKEv2 configuration information. The expected data type and unique identification are described in - DataType and Selector parameters. + DataType and Selector parameters. @param[in] This Pointer to the EFI_IPSEC_CONFIG_PROTOCOL instance. @param[in] DataType The type of data to retrieve. - @param[in] Selector Pointer to an entry selector which is an identifier of the IPsec + @param[in] Selector Pointer to an entry selector which is an identifier of the IPsec configuration data entry. @param[in, out] DataSize On output the size of data returned in Data. - @param[out] Data The buffer to return the contents of the IPsec configuration data. - The type of the data buffer is associated with the DataType. - + @param[out] Data The buffer to return the contents of the IPsec configuration data. + The type of the data buffer is associated with the DataType. + @retval EFI_SUCCESS The specified configuration data is got successfully. @retval EFI_INVALID_PARAMETER One or more of the followings are TRUE: - This is NULL. @@ -685,30 +685,30 @@ EFI_STATUS ); /** - Enumerates the current selector for IPsec configuration data entry. + Enumerates the current selector for IPsec configuration data entry. This function is called multiple times to retrieve the entry Selector in IPsec - configuration database. On each call to GetNextSelector(), the next entry + configuration database. On each call to GetNextSelector(), the next entry Selector are retrieved into the output interface. - - If the entire IPsec configuration database has been iterated, the error + + If the entire IPsec configuration database has been iterated, the error EFI_NOT_FOUND is returned. - If the Selector buffer is too small for the next Selector copy, an - EFI_BUFFER_TOO_SMALL error is returned, and SelectorSize is updated to reflect + If the Selector buffer is too small for the next Selector copy, an + EFI_BUFFER_TOO_SMALL error is returned, and SelectorSize is updated to reflect the size of buffer needed. On the initial call to GetNextSelector() to start the IPsec configuration database - search, a pointer to the buffer with all zero value is passed in Selector. Calls - to SetData() between calls to GetNextSelector may produce unpredictable results. + search, a pointer to the buffer with all zero value is passed in Selector. Calls + to SetData() between calls to GetNextSelector may produce unpredictable results. @param[in] This Pointer to the EFI_IPSEC_CONFIG_PROTOCOL instance. @param[in] DataType The type of IPsec configuration data to retrieve. @param[in, out] SelectorSize The size of the Selector buffer. - @param[in, out] Selector On input, supplies the pointer to last Selector that was + @param[in, out] Selector On input, supplies the pointer to last Selector that was returned by GetNextSelector(). On output, returns one copy of the current entry Selector - of a given DataType. - + of a given DataType. + @retval EFI_SUCCESS The specified configuration data is got successfully. @retval EFI_INVALID_PARAMETER One or more of the followings are TRUE: - This is NULL. @@ -717,7 +717,7 @@ EFI_STATUS @retval EFI_NOT_FOUND The next configuration data entry was not found. @retval EFI_UNSUPPORTED The specified DataType is not supported. @retval EFI_BUFFER_TOO_SMALL The SelectorSize is too small for the result. This parameter - has been updated with the size needed to complete the search + has been updated with the size needed to complete the search request. **/ @@ -732,18 +732,18 @@ EFI_STATUS /** Register an event that is to be signaled whenever a configuration process on the - specified IPsec configuration information is done. + specified IPsec configuration information is done. This function registers an event that is to be signaled whenever a configuration - process on the specified IPsec configuration data is done (e.g. IPsec security + process on the specified IPsec configuration data is done (e.g. IPsec security policy database configuration is ready). An event can be registered for different - DataType simultaneously and the caller is responsible for determining which type - of configuration data causes the signaling of the event in such case. + DataType simultaneously and the caller is responsible for determining which type + of configuration data causes the signaling of the event in such case. @param[in] This Pointer to the EFI_IPSEC_CONFIG_PROTOCOL instance. @param[in] DataType The type of data to be registered the event for. @param[in] Event The event to be registered. - + @retval EFI_SUCCESS The event is registered successfully. @retval EFI_INVALID_PARAMETER This is NULL or Event is NULL. @retval EFI_ACCESS_DENIED The Event is already registered for the DataType. @@ -761,16 +761,16 @@ EFI_STATUS /** Remove the specified event that is previously registered on the specified IPsec - configuration data. + configuration data. - This function removes a previously registered event for the specified configuration data. + This function removes a previously registered event for the specified configuration data. @param[in] This Pointer to the EFI_IPSEC_CONFIG_PROTOCOL instance. @param[in] DataType The configuration data type to remove the registered event for. @param[in] Event The event to be unregistered. - + @retval EFI_SUCCESS The event is removed successfully. - @retval EFI_NOT_FOUND The Event specified by DataType could not be found in the + @retval EFI_NOT_FOUND The Event specified by DataType could not be found in the database. @retval EFI_INVALID_PARAMETER This is NULL or Event is NULL. @retval EFI_UNSUPPORTED The notify registration unsupported or the specified @@ -788,12 +788,12 @@ EFI_STATUS /// /// EFI_IPSEC_CONFIG_PROTOCOL /// provides the ability to set and lookup the IPsec SAD (Security Association Database), -/// SPD (Security Policy Database) data entry and configure the security association -/// management protocol such as IKEv2. This protocol is used as the central +/// SPD (Security Policy Database) data entry and configure the security association +/// management protocol such as IKEv2. This protocol is used as the central /// repository of any policy-specific configuration for EFI IPsec driver. -/// EFI_IPSEC_CONFIG_PROTOCOL can be bound to both IPv4 and IPv6 stack. User can use this +/// EFI_IPSEC_CONFIG_PROTOCOL can be bound to both IPv4 and IPv6 stack. User can use this /// protocol for IPsec configuration in both IPv4 and IPv6 environment. -/// +/// struct _EFI_IPSEC_CONFIG_PROTOCOL { EFI_IPSEC_CONFIG_SET_DATA SetData; EFI_IPSEC_CONFIG_GET_DATA GetData; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IsaHc.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IsaHc.h index bc92675d12..1277e4c837 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IsaHc.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/IsaHc.h @@ -6,13 +6,13 @@ handles opening and closing the apertures which are positively-decoded. Copyright (c) 2015, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This protocol is from PI Version 1.2.1. @@ -76,7 +76,7 @@ EFI_STATUS hardware aperture (via CloseIoAperture()) until there are no more references to it. @param This A pointer to this instance of the EFI_ISA_HC_PROTOCOL. - @param IoApertureHandle The I/O aperture handle previously returned from a + @param IoApertureHandle The I/O aperture handle previously returned from a call to OpenIoAperture(). @retval EFI_SUCCESS The IO aperture was closed successfully. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Kms.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Kms.h index fa0afa132d..eaaefe2920 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Kms.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Kms.h @@ -373,7 +373,7 @@ EFI_STATUS @param[in] This Pointer to the EFI_KMS_PROTOCOL instance. @param[in] Client Pointer to a valid EFI_KMS_CLIENT_INFO structure. - @param[in, out] ClientDataSize Pointer to the size, in bytes, of an arbitrary block of + @param[in, out] ClientDataSize Pointer to the size, in bytes, of an arbitrary block of data specified by the ClientData parameter. This parameter may be NULL, in which case the ClientData parameter will be ignored and no data will be @@ -388,11 +388,11 @@ EFI_STATUS which will be zero if no data is returned from the KMS. @param[in, out] ClientData Pointer to a pointer to an arbitrary block of data of *ClientDataSize that is to be passed directly to the - KMS if it supports the use of client data. This - parameter may be NULL if and only if the + KMS if it supports the use of client data. This + parameter may be NULL if and only if the ClientDataSize parameter is also NULL. Upon return to - the caller, *ClientData points to a block of data of - *ClientDataSize that was returned from the KMS. + the caller, *ClientData points to a block of data of + *ClientDataSize that was returned from the KMS. If the returned value for *ClientDataSize is zero, then the returned value for *ClientData must be NULL and should be ignored by the caller. The KMS protocol @@ -418,7 +418,7 @@ EFI_STATUS IN EFI_KMS_CLIENT_INFO *Client, IN OUT UINTN *ClientDataSize OPTIONAL, IN OUT VOID **ClientData OPTIONAL - ); + ); /** Request that the KMS generate one or more new keys and associate them with key identifiers. @@ -454,7 +454,7 @@ EFI_STATUS type and must be freed by the caller when it is no longer needed. Also, the KeyStatus field must reflect the result of the request relative to that key. - @param[in, out] ClientDataSize Pointer to the size, in bytes, of an arbitrary block of + @param[in, out] ClientDataSize Pointer to the size, in bytes, of an arbitrary block of data specified by the ClientData parameter. This parameter may be NULL, in which case the ClientData parameter will be ignored and no data will be @@ -469,11 +469,11 @@ EFI_STATUS which will be zero if no data is returned from the KMS. @param[in, out] ClientData Pointer to a pointer to an arbitrary block of data of *ClientDataSize that is to be passed directly to the - KMS if it supports the use of client data. This - parameter may be NULL if and only if the + KMS if it supports the use of client data. This + parameter may be NULL if and only if the ClientDataSize parameter is also NULL. Upon return to - the caller, *ClientData points to a block of data of - *ClientDataSize that was returned from the KMS. + the caller, *ClientData points to a block of data of + *ClientDataSize that was returned from the KMS. If the returned value for *ClientDataSize is zero, then the returned value for *ClientData must be NULL and should be ignored by the caller. The KMS protocol @@ -535,12 +535,12 @@ EFI_STATUS On output, the KeyIdentifierSize and KeyIdentifier fields will be unchanged, while the KeyFormat and KeyValue fields will be updated values associated with this key - identifier. Memory for the KeyValue field will be + identifier. Memory for the KeyValue field will be allocated with the BOOT_SERVICES_DATA type and must be freed by the caller when it is no longer needed. Also, the KeyStatus field will reflect the result of the request relative to the individual key descriptor. - @param[in, out] ClientDataSize Pointer to the size, in bytes, of an arbitrary block of + @param[in, out] ClientDataSize Pointer to the size, in bytes, of an arbitrary block of data specified by the ClientData parameter. This parameter may be NULL, in which case the ClientData parameter will be ignored and no data will be @@ -555,11 +555,11 @@ EFI_STATUS which will be zero if no data is returned from the KMS. @param[in, out] ClientData Pointer to a pointer to an arbitrary block of data of *ClientDataSize that is to be passed directly to the - KMS if it supports the use of client data. This - parameter may be NULL if and only if the + KMS if it supports the use of client data. This + parameter may be NULL if and only if the ClientDataSize parameter is also NULL. Upon return to - the caller, *ClientData points to a block of data of - *ClientDataSize that was returned from the KMS. + the caller, *ClientData points to a block of data of + *ClientDataSize that was returned from the KMS. If the returned value for *ClientDataSize is zero, then the returned value for *ClientData must be NULL and should be ignored by the caller. The KMS protocol @@ -626,7 +626,7 @@ EFI_STATUS consistent values to be associated with the given KeyId. On return, the KeyStatus field will reflect the result of the operation for each key request. - @param[in, out] ClientDataSize Pointer to the size, in bytes, of an arbitrary block of + @param[in, out] ClientDataSize Pointer to the size, in bytes, of an arbitrary block of data specified by the ClientData parameter. This parameter may be NULL, in which case the ClientData parameter will be ignored and no data will be @@ -641,11 +641,11 @@ EFI_STATUS which will be zero if no data is returned from the KMS. @param[in, out] ClientData Pointer to a pointer to an arbitrary block of data of *ClientDataSize that is to be passed directly to the - KMS if it supports the use of client data. This - parameter may be NULL if and only if the + KMS if it supports the use of client data. This + parameter may be NULL if and only if the ClientDataSize parameter is also NULL. Upon return to - the caller, *ClientData points to a block of data of - *ClientDataSize that was returned from the KMS. + the caller, *ClientData points to a block of data of + *ClientDataSize that was returned from the KMS. If the returned value for *ClientDataSize is zero, then the returned value for *ClientData must be NULL and should be ignored by the caller. The KMS protocol @@ -711,7 +711,7 @@ EFI_STATUS KeyValue fields are ignored, but should be 0. On return, the KeyStatus field will reflect the result of the operation for each key request. - @param[in, out] ClientDataSize Pointer to the size, in bytes, of an arbitrary block of + @param[in, out] ClientDataSize Pointer to the size, in bytes, of an arbitrary block of data specified by the ClientData parameter. This parameter may be NULL, in which case the ClientData parameter will be ignored and no data will be @@ -726,11 +726,11 @@ EFI_STATUS which will be zero if no data is returned from the KMS. @param[in, out] ClientData Pointer to a pointer to an arbitrary block of data of *ClientDataSize that is to be passed directly to the - KMS if it supports the use of client data. This - parameter may be NULL if and only if the + KMS if it supports the use of client data. This + parameter may be NULL if and only if the ClientDataSize parameter is also NULL. Upon return to - the caller, *ClientData points to a block of data of - *ClientDataSize that was returned from the KMS. + the caller, *ClientData points to a block of data of + *ClientDataSize that was returned from the KMS. If the returned value for *ClientDataSize is zero, then the returned value for *ClientData must be NULL and should be ignored by the caller. The KMS protocol @@ -789,7 +789,7 @@ EFI_STATUS On input, the fields in the structure should be NULL. On output, the attribute fields will have updated values for attributes associated with this key identifier. - @param[in, out] ClientDataSize Pointer to the size, in bytes, of an arbitrary block of + @param[in, out] ClientDataSize Pointer to the size, in bytes, of an arbitrary block of data specified by the ClientData parameter. This parameter may be NULL, in which case the ClientData parameter will be ignored and no data will be @@ -804,11 +804,11 @@ EFI_STATUS which will be zero if no data is returned from the KMS. @param[in, out] ClientData Pointer to a pointer to an arbitrary block of data of *ClientDataSize that is to be passed directly to the - KMS if it supports the use of client data. This - parameter may be NULL if and only if the + KMS if it supports the use of client data. This + parameter may be NULL if and only if the ClientDataSize parameter is also NULL. Upon return to - the caller, *ClientData points to a block of data of - *ClientDataSize that was returned from the KMS. + the caller, *ClientData points to a block of data of + *ClientDataSize that was returned from the KMS. If the returned value for *ClientDataSize is zero, then the returned value for *ClientData must be NULL and should be ignored by the caller. The KMS protocol @@ -876,7 +876,7 @@ EFI_STATUS are completely filled in. On return the KeyAttributeStatus field will reflect the result of the operation for each key attribute request. - @param[in, out] ClientDataSize Pointer to the size, in bytes, of an arbitrary block of + @param[in, out] ClientDataSize Pointer to the size, in bytes, of an arbitrary block of data specified by the ClientData parameter. This parameter may be NULL, in which case the ClientData parameter will be ignored and no data will be @@ -891,11 +891,11 @@ EFI_STATUS which will be zero if no data is returned from the KMS. @param[in, out] ClientData Pointer to a pointer to an arbitrary block of data of *ClientDataSize that is to be passed directly to the - KMS if it supports the use of client data. This - parameter may be NULL if and only if the + KMS if it supports the use of client data. This + parameter may be NULL if and only if the ClientDataSize parameter is also NULL. Upon return to - the caller, *ClientData points to a block of data of - *ClientDataSize that was returned from the KMS. + the caller, *ClientData points to a block of data of + *ClientDataSize that was returned from the KMS. If the returned value for *ClientDataSize is zero, then the returned value for *ClientData must be NULL and should be ignored by the caller. The KMS protocol @@ -967,7 +967,7 @@ EFI_STATUS are completely filled in. On return the KeyAttributeStatus field will reflect the result of the operation for each key attribute request. - @param[in, out] ClientDataSize Pointer to the size, in bytes, of an arbitrary block of + @param[in, out] ClientDataSize Pointer to the size, in bytes, of an arbitrary block of data specified by the ClientData parameter. This parameter may be NULL, in which case the ClientData parameter will be ignored and no data will be @@ -982,11 +982,11 @@ EFI_STATUS which will be zero if no data is returned from the KMS. @param[in, out] ClientData Pointer to a pointer to an arbitrary block of data of *ClientDataSize that is to be passed directly to the - KMS if it supports the use of client data. This - parameter may be NULL if and only if the + KMS if it supports the use of client data. This + parameter may be NULL if and only if the ClientDataSize parameter is also NULL. Upon return to - the caller, *ClientData points to a block of data of - *ClientDataSize that was returned from the KMS. + the caller, *ClientData points to a block of data of + *ClientDataSize that was returned from the KMS. If the returned value for *ClientDataSize is zero, then the returned value for *ClientData must be NULL and should be ignored by the caller. The KMS protocol @@ -1064,7 +1064,7 @@ EFI_STATUS caller when it is no longer needed. Also, the KeyStatus field of each descriptor will reflect the result of the request relative to that key descriptor. - @param[in, out] ClientDataSize Pointer to the size, in bytes, of an arbitrary block of + @param[in, out] ClientDataSize Pointer to the size, in bytes, of an arbitrary block of data specified by the ClientData parameter. This parameter may be NULL, in which case the ClientData parameter will be ignored and no data will be @@ -1079,11 +1079,11 @@ EFI_STATUS which will be zero if no data is returned from the KMS. @param[in, out] ClientData Pointer to a pointer to an arbitrary block of data of *ClientDataSize that is to be passed directly to the - KMS if it supports the use of client data. This - parameter may be NULL if and only if the + KMS if it supports the use of client data. This + parameter may be NULL if and only if the ClientDataSize parameter is also NULL. Upon return to - the caller, *ClientData points to a block of data of - *ClientDataSize that was returned from the KMS. + the caller, *ClientData points to a block of data of + *ClientDataSize that was returned from the KMS. If the returned value for *ClientDataSize is zero, then the returned value for *ClientData must be NULL and should be ignored by the caller. The KMS protocol diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/LegacyRegion2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/LegacyRegion2.h index 6f553bd7ad..76231b5b9a 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/LegacyRegion2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/LegacyRegion2.h @@ -12,7 +12,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: - This Protocol is defined in UEFI Platform Initialization Specification 1.2 + This Protocol is defined in UEFI Platform Initialization Specification 1.2 Volume 5: Standards **/ @@ -31,9 +31,9 @@ typedef struct _EFI_LEGACY_REGION2_PROTOCOL EFI_LEGACY_REGION2_PROTOCOL; /** Modify the hardware to allow (decode) or disallow (not decode) memory reads in a region. - If the On parameter evaluates to TRUE, this function enables memory reads in the address range + If the On parameter evaluates to TRUE, this function enables memory reads in the address range Start to (Start + Length - 1). - If the On parameter evaluates to FALSE, this function disables memory reads in the address range + If the On parameter evaluates to FALSE, this function disables memory reads in the address range Start to (Start + Length - 1). @param This[in] Indicates the EFI_LEGACY_REGION2_PROTOCOL instance. @@ -96,7 +96,7 @@ EFI_STATUS /** Modify the hardware to disallow memory attribute changes in a region. - This function makes the attributes of a region read only. Once a region is boot-locked with this + This function makes the attributes of a region read only. Once a region is boot-locked with this function, the read and write attributes of that region cannot be changed until a power cycle has reset the boot-lock attribute. Calls to Decode(), Lock() and Unlock() will have no effect. @@ -131,7 +131,7 @@ EFI_STATUS /** Modify the hardware to allow memory writes in a region. - This function changes the attributes of a memory range to allow writes. + This function changes the attributes of a memory range to allow writes. @param This[in] Indicates the EFI_LEGACY_REGION2_PROTOCOL instance. @param Start[in] The beginning of the physical address of the region whose @@ -195,9 +195,9 @@ typedef struct { /** Get region information for the attributes of the Legacy Region. - This function is used to discover the granularity of the attributes for the memory in the legacy + This function is used to discover the granularity of the attributes for the memory in the legacy region. Each attribute may have a different granularity and the granularity may not be the same - for all memory ranges in the legacy region. + for all memory ranges in the legacy region. @param This[in] Indicates the EFI_LEGACY_REGION2_PROTOCOL instance. @param DescriptorCount[out] The number of region descriptor entries returned in the Descriptor @@ -220,8 +220,8 @@ EFI_STATUS ); -/// -/// The EFI_LEGACY_REGION2_PROTOCOL is used to abstract the hardware control of the memory +/// +/// The EFI_LEGACY_REGION2_PROTOCOL is used to abstract the hardware control of the memory /// attributes of the Option ROM shadowing region, 0xC0000 to 0xFFFFF. /// There are three memory attributes that can be modified through this protocol: read, write and /// boot-lock. These protocols may be set in any combination. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/LoadFile.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/LoadFile.h index 430ddb843d..d936d18885 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/LoadFile.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/LoadFile.h @@ -1,20 +1,20 @@ /** @file Load File protocol as defined in the UEFI 2.0 specification. - The load file protocol exists to supports the addition of new boot devices, - and to support booting from devices that do not map well to file system. + The load file protocol exists to supports the addition of new boot devices, + and to support booting from devices that do not map well to file system. Network boot is done via a LoadFile protocol. UEFI 2.0 can boot from any device that produces a LoadFile protocol. Copyright (c) 2006 - 2016, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -35,7 +35,7 @@ typedef struct _EFI_LOAD_FILE_PROTOCOL EFI_LOAD_FILE_PROTOCOL; /// /// Backward-compatible with EFI1.1 -/// +/// typedef EFI_LOAD_FILE_PROTOCOL EFI_LOAD_FILE_INTERFACE; /** diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/LoadFile2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/LoadFile2.h index cb977fbf3e..ba81fb0538 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/LoadFile2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/LoadFile2.h @@ -1,20 +1,20 @@ /** @file Load File protocol as defined in the UEFI 2.0 specification. - Load file protocol exists to supports the addition of new boot devices, - and to support booting from devices that do not map well to file system. + Load file protocol exists to supports the addition of new boot devices, + and to support booting from devices that do not map well to file system. Network boot is done via a LoadFile protocol. UEFI 2.0 can boot from any device that produces a LoadFile protocol. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -57,7 +57,7 @@ typedef struct _EFI_LOAD_FILE2_PROTOCOL EFI_LOAD_FILE2_PROTOCOL; @retval EFI_NO_RESPONSE The remote system did not respond. @retval EFI_NOT_FOUND The file was not found @retval EFI_ABORTED The file load process was manually canceled. - @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small to read the current + @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small to read the current directory entry. BufferSize has been updated with the size needed to complete the request. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/LoadedImage.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/LoadedImage.h index 53971bc918..12e5e2d756 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/LoadedImage.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/LoadedImage.h @@ -5,13 +5,13 @@ This image handle will contain a Loaded Image Protocol. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -30,7 +30,7 @@ /// /// Protocol GUID defined in EFI1.1. -/// +/// #define LOADED_IMAGE_PROTOCOL EFI_LOADED_IMAGE_PROTOCOL_GUID /// @@ -40,25 +40,25 @@ /// /// Revision defined in EFI1.1. -/// +/// #define EFI_LOADED_IMAGE_INFORMATION_REVISION EFI_LOADED_IMAGE_PROTOCOL_REVISION /// /// Can be used on any image handle to obtain information about the loaded image. /// typedef struct { - UINT32 Revision; ///< Defines the revision of the EFI_LOADED_IMAGE_PROTOCOL structure. + UINT32 Revision; ///< Defines the revision of the EFI_LOADED_IMAGE_PROTOCOL structure. ///< All future revisions will be backward compatible to the current revision. - EFI_HANDLE ParentHandle; ///< Parent image's image handle. NULL if the image is loaded directly from - ///< the firmware's boot manager. + EFI_HANDLE ParentHandle; ///< Parent image's image handle. NULL if the image is loaded directly from + ///< the firmware's boot manager. EFI_SYSTEM_TABLE *SystemTable; ///< the image's EFI system table pointer. // // Source location of image // - EFI_HANDLE DeviceHandle; ///< The device handle that the EFI Image was loaded from. - EFI_DEVICE_PATH_PROTOCOL *FilePath; ///< A pointer to the file path portion specific to DeviceHandle - ///< that the EFI Image was loaded from. + EFI_HANDLE DeviceHandle; ///< The device handle that the EFI Image was loaded from. + EFI_DEVICE_PATH_PROTOCOL *FilePath; ///< A pointer to the file path portion specific to DeviceHandle + ///< that the EFI Image was loaded from. VOID *Reserved; ///< Reserved. DO NOT USE. // @@ -79,7 +79,7 @@ typedef struct { // // For backward-compatible with EFI1.1. -// +// typedef EFI_LOADED_IMAGE_PROTOCOL EFI_LOADED_IMAGE; extern EFI_GUID gEfiLoadedImageProtocolGuid; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ManagedNetwork.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ManagedNetwork.h index 2ac001c4f9..7fc9e74581 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ManagedNetwork.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ManagedNetwork.h @@ -3,15 +3,15 @@ EFI_MANAGED_NETWORK_PROTOCOL as defined in UEFI 2.0. 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +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. - @par Revision Reference: + @par Revision Reference: This Protocol is introduced in UEFI Specification 2.0 **/ @@ -352,7 +352,7 @@ EFI_STATUS ); /// -/// The MNP is used by network applications (and drivers) to +/// The MNP is used by network applications (and drivers) to /// perform raw (unformatted) asynchronous network packet I/O. /// struct _EFI_MANAGED_NETWORK_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/McaInitPmi.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/McaInitPmi.h index c0c66147ea..e5432b8209 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/McaInitPmi.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/McaInitPmi.h @@ -6,12 +6,12 @@ on an Intel Itanium Processor Family based system. Copyright (c) 2009 - 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Metronome.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Metronome.h index 358d94b722..f77b654b45 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Metronome.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Metronome.h @@ -4,13 +4,13 @@ This code abstracts the DXE core to provide delay services. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -29,17 +29,17 @@ typedef struct _EFI_METRONOME_ARCH_PROTOCOL EFI_METRONOME_ARCH_PROTOCOL; /** - The WaitForTick() function waits for the number of ticks specified by - TickNumber from a known time source in the platform. If TickNumber of - ticks are detected, then EFI_SUCCESS is returned. The actual time passed - between entry of this function and the first tick is between 0 and - TickPeriod 100 nS units. If you want to guarantee that at least TickPeriod - time has elapsed, wait for two ticks. This function waits for a hardware - event to determine when a tick occurs. It is possible for interrupt - processing, or exception processing to interrupt the execution of the - WaitForTick() function. Depending on the hardware source for the ticks, it - is possible for a tick to be missed. This function cannot guarantee that - ticks will not be missed. If a timeout occurs waiting for the specified + The WaitForTick() function waits for the number of ticks specified by + TickNumber from a known time source in the platform. If TickNumber of + ticks are detected, then EFI_SUCCESS is returned. The actual time passed + between entry of this function and the first tick is between 0 and + TickPeriod 100 nS units. If you want to guarantee that at least TickPeriod + time has elapsed, wait for two ticks. This function waits for a hardware + event to determine when a tick occurs. It is possible for interrupt + processing, or exception processing to interrupt the execution of the + WaitForTick() function. Depending on the hardware source for the ticks, it + is possible for a tick to be missed. This function cannot guarantee that + ticks will not be missed. If a timeout occurs waiting for the specified number of ticks, then EFI_TIMEOUT is returned. @param This The EFI_METRONOME_ARCH_PROTOCOL instance. @@ -50,7 +50,7 @@ typedef struct _EFI_METRONOME_ARCH_PROTOCOL EFI_METRONOME_ARCH_PROTOCOL; @retval EFI_TIMEOUT A timeout occurred waiting for the specified number of ticks. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_METRONOME_WAIT_FOR_TICK)( IN EFI_METRONOME_ARCH_PROTOCOL *This, @@ -59,18 +59,18 @@ EFI_STATUS /// /// This protocol provides access to a known time source in the platform to the -/// core. The core uses this known time source to produce core services that -/// require calibrated delays. +/// core. The core uses this known time source to produce core services that +/// require calibrated delays. /// struct _EFI_METRONOME_ARCH_PROTOCOL { EFI_METRONOME_WAIT_FOR_TICK WaitForTick; - + /// - /// The period of platform's known time source in 100 nS units. - /// This value on any platform must be at least 10 uS, and must not - /// exceed 200 uS. The value in this field is a constant that must - /// not be modified after the Metronome architectural protocol is - /// installed. All consumers must treat this as a read-only field. + /// The period of platform's known time source in 100 nS units. + /// This value on any platform must be at least 10 uS, and must not + /// exceed 200 uS. The value in this field is a constant that must + /// not be modified after the Metronome architectural protocol is + /// installed. All consumers must treat this as a read-only field. /// UINT32 TickPeriod; }; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/MonotonicCounter.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/MonotonicCounter.h index 1409be2e5f..c3b137d191 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/MonotonicCounter.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/MonotonicCounter.h @@ -4,13 +4,13 @@ This code provides the services required to access the system's monotonic counter 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -22,7 +22,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /// #define EFI_MONOTONIC_COUNTER_ARCH_PROTOCOL_GUID \ {0x1da97072, 0xbddc, 0x4b30, {0x99, 0xf1, 0x72, 0xa0, 0xb5, 0x6f, 0xff, 0x2a} } - + extern EFI_GUID gEfiMonotonicCounterArchProtocolGuid; #endif diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Mtftp4.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Mtftp4.h index e24751dd5a..c7b3c68171 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Mtftp4.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Mtftp4.h @@ -2,12 +2,12 @@ EFI Multicast Trivial File Transfer Protocol Definition Copyright (c) 2006 - 2011, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +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. @par Revision Reference: diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/NetworkInterfaceIdentifier.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/NetworkInterfaceIdentifier.h index 1b7654503d..e8986170bc 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/NetworkInterfaceIdentifier.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/NetworkInterfaceIdentifier.h @@ -74,8 +74,8 @@ struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL { UINT8 MajorVer; ///< Major version number. UINT8 MinorVer; ///< Minor version number. BOOLEAN Ipv6Supported; ///< TRUE if the network interface supports IPv6; otherwise FALSE. - UINT16 IfNum; ///< The network interface number that is being identified by this Network - ///< Interface Identifier Protocol. This field must be less than or + UINT16 IfNum; ///< The network interface number that is being identified by this Network + ///< Interface Identifier Protocol. This field must be less than or ///< equal to the (IFcnt | IFcntExt <<8 ) fields in the !PXE structure. }; @@ -109,7 +109,7 @@ struct undiconfig_table { struct { VOID *NII_InterfacePointer; ///< Pointer to the NII interface structure. VOID *DevicePathPointer; ///< Pointer to the device path for this NIC. - } NII_entry[1]; + } NII_entry[1]; }; extern EFI_GUID gEfiNetworkInterfaceIdentifierProtocolGuid; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/NvmExpressPassthru.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/NvmExpressPassthru.h index 15879e578d..e8e185c9f6 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/NvmExpressPassthru.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/NvmExpressPassthru.h @@ -132,7 +132,7 @@ typedef struct { @param[in] Event If non-blocking I/O is not supported then Event is ignored, and blocking I/O is performed. If Event is NULL, then blocking I/O is performed. If Event is not NULL and non-blocking I/O is supported, then non-blocking I/O is performed, and Event will be signaled when the NVM - Express Command Packet completes. + Express Command Packet completes. @retval EFI_SUCCESS The NVM Express Command Packet was sent by the host. TransferLength bytes were transferred to, or from DataBuffer. @@ -162,7 +162,7 @@ EFI_STATUS Used to retrieve the next namespace ID for this NVM Express controller. The EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL.GetNextNamespace() function retrieves the next valid - namespace ID on this NVM Express controller. + namespace ID on this NVM Express controller. If on input the value pointed to by NamespaceId is 0xFFFFFFFF, then the first valid namespace ID defined on the NVM Express controller is returned in the location pointed to by NamespaceId @@ -206,7 +206,7 @@ EFI_STATUS If the NamespaceId is not valid, then EFI_NOT_FOUND is returned. - If DevicePath is NULL, then EFI_INVALID_PARAMETER is returned. + If DevicePath is NULL, then EFI_INVALID_PARAMETER is returned. If there are not enough resources to allocate the device path node, then EFI_OUT_OF_RESOURCES is returned. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Pcd.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Pcd.h index e75b4e513b..c5c4838d0c 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Pcd.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Pcd.h @@ -2,18 +2,18 @@ Native Platform Configuration Database (PCD) Protocol Different with the EFI_PCD_PROTOCOL defined in PI 1.2 specification, the native - PCD protocol provide interfaces for dynamic and dynamic-ex type PCD. + PCD protocol provide interfaces for dynamic and dynamic-ex type PCD. The interfaces in dynamic type PCD do not require the token space guid as parameter, but interfaces in dynamic-ex type PCD require token space guid as parameter. - + Copyright (c) 2006 - 2013, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -31,26 +31,26 @@ extern EFI_GUID gPcdProtocolGuid; /** Sets the SKU value for subsequent calls to set or get PCD token values. - SetSku() sets the SKU Id to be used for subsequent calls to set or get PCD values. + SetSku() sets the SKU Id to be used for subsequent calls to set or get PCD values. SetSku() is normally called only once by the system. - For each item (token), the database can hold a single value that applies to all SKUs, - or multiple values, where each value is associated with a specific SKU Id. Items with multiple, - SKU-specific values are called SKU enabled. - - The SKU Id of zero is reserved as a default. The valid SkuId range is 1 to 255. - For tokens that are not SKU enabled, the system ignores any set SKU Id and works with the - single value for that token. For SKU-enabled tokens, the system will use the SKU Id set by the - last call to SetSku(). If no SKU Id is set or the currently set SKU Id isn't valid for the specified token, - the system uses the default SKU Id. If the system attempts to use the default SKU Id and no value has been + For each item (token), the database can hold a single value that applies to all SKUs, + or multiple values, where each value is associated with a specific SKU Id. Items with multiple, + SKU-specific values are called SKU enabled. + + The SKU Id of zero is reserved as a default. The valid SkuId range is 1 to 255. + For tokens that are not SKU enabled, the system ignores any set SKU Id and works with the + single value for that token. For SKU-enabled tokens, the system will use the SKU Id set by the + last call to SetSku(). If no SKU Id is set or the currently set SKU Id isn't valid for the specified token, + the system uses the default SKU Id. If the system attempts to use the default SKU Id and no value has been set for that Id, the results are unpredictable. - @param[in] SkuId The SKU value that will be used when the PCD service will retrieve and + @param[in] SkuId The SKU value that will be used when the PCD service will retrieve and set values associated with a PCD token. **/ -typedef +typedef VOID (EFIAPI *PCD_PROTOCOL_SET_SKU)( IN UINTN SkuId @@ -61,13 +61,13 @@ VOID /** Retrieves an 8-bit value for a given PCD token. - Retrieves the current byte-sized value for a PCD token number. + Retrieves the current byte-sized value for a PCD token number. If the TokenNumber is invalid, the results are unpredictable. - - @param[in] TokenNumber The PCD token number. + + @param[in] TokenNumber The PCD token number. @return The UINT8 value. - + **/ typedef UINT8 @@ -80,13 +80,13 @@ UINT8 /** Retrieves a 16-bit value for a given PCD token. - Retrieves the current 16-bit value for a PCD token number. + Retrieves the current 16-bit value for a PCD token number. If the TokenNumber is invalid, the results are unpredictable. - - @param[in] TokenNumber The PCD token number. + + @param[in] TokenNumber The PCD token number. @return The UINT16 value. - + **/ typedef UINT16 @@ -99,13 +99,13 @@ UINT16 /** Retrieves a 32-bit value for a given PCD token. - Retrieves the current 32-bit value for a PCD token number. + Retrieves the current 32-bit value for a PCD token number. If the TokenNumber is invalid, the results are unpredictable. - - @param[in] TokenNumber The PCD token number. + + @param[in] TokenNumber The PCD token number. @return The UINT32 value. - + **/ typedef UINT32 @@ -118,13 +118,13 @@ UINT32 /** Retrieves a 64-bit value for a given PCD token. - Retrieves the current 64-bit value for a PCD token number. + Retrieves the current 64-bit value for a PCD token number. If the TokenNumber is invalid, the results are unpredictable. - - @param[in] TokenNumber The PCD token number. + + @param[in] TokenNumber The PCD token number. @return The UINT64 value. - + **/ typedef UINT64 @@ -137,15 +137,15 @@ UINT64 /** Retrieves a pointer to a value for a given PCD token. - Retrieves the current pointer to the buffer for a PCD token number. - Do not make any assumptions about the alignment of the pointer that - is returned by this function call. If the TokenNumber is invalid, + Retrieves the current pointer to the buffer for a PCD token number. + Do not make any assumptions about the alignment of the pointer that + is returned by this function call. If the TokenNumber is invalid, the results are unpredictable. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @return The pointer to the buffer to be retrived. - + **/ typedef VOID * @@ -158,15 +158,15 @@ VOID * /** Retrieves a Boolean value for a given PCD token. - Retrieves the current boolean value for a PCD token number. - Do not make any assumptions about the alignment of the pointer that - is returned by this function call. If the TokenNumber is invalid, + Retrieves the current boolean value for a PCD token number. + Do not make any assumptions about the alignment of the pointer that + is returned by this function call. If the TokenNumber is invalid, the results are unpredictable. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @return The Boolean value. - + **/ typedef BOOLEAN @@ -179,13 +179,13 @@ BOOLEAN /** Retrieves the size of the value for a given PCD token. - Retrieves the current size of a particular PCD token. + Retrieves the current size of a particular PCD token. If the TokenNumber is invalid, the results are unpredictable. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @return The size of the value for the PCD token. - + **/ typedef UINTN @@ -198,16 +198,16 @@ UINTN /** Retrieves an 8-bit value for a given PCD token. - Retrieves the 8-bit value of a particular PCD token. + Retrieves the 8-bit value of a particular PCD token. If the TokenNumber is invalid or the token space - specified by Guid does not exist, the results are + specified by Guid does not exist, the results are unpredictable. @param[in] Guid The token space for the token number. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @return The size 8-bit value for the PCD token. - + **/ typedef UINT8 @@ -221,16 +221,16 @@ UINT8 /** Retrieves a 16-bit value for a given PCD token. - Retrieves the 16-bit value of a particular PCD token. + Retrieves the 16-bit value of a particular PCD token. If the TokenNumber is invalid or the token space - specified by Guid does not exist, the results are + specified by Guid does not exist, the results are unpredictable. @param[in] Guid The token space for the token number. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @return The size 16-bit value for the PCD token. - + **/ typedef UINT16 @@ -244,16 +244,16 @@ UINT16 /** Retrieves a 32-bit value for a given PCD token. - Retrieves the 32-bit value of a particular PCD token. + Retrieves the 32-bit value of a particular PCD token. If the TokenNumber is invalid or the token space - specified by Guid does not exist, the results are + specified by Guid does not exist, the results are unpredictable. @param[in] Guid The token space for the token number. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @return The size 32-bit value for the PCD token. - + **/ typedef UINT32 @@ -267,16 +267,16 @@ UINT32 /** Retrieves an 64-bit value for a given PCD token. - Retrieves the 64-bit value of a particular PCD token. + Retrieves the 64-bit value of a particular PCD token. If the TokenNumber is invalid or the token space - specified by Guid does not exist, the results are + specified by Guid does not exist, the results are unpredictable. @param[in] Guid The token space for the token number. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @return The size 64-bit value for the PCD token. - + **/ typedef UINT64 @@ -290,16 +290,16 @@ UINT64 /** Retrieves a pointer to a value for a given PCD token. - Retrieves the current pointer to the buffer for a PCD token number. - Do not make any assumptions about the alignment of the pointer that - is returned by this function call. If the TokenNumber is invalid, + Retrieves the current pointer to the buffer for a PCD token number. + Do not make any assumptions about the alignment of the pointer that + is returned by this function call. If the TokenNumber is invalid, the results are unpredictable. @param[in] Guid The token space for the token number. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @return The pointer to the buffer to be retrieved. - + **/ typedef VOID * @@ -313,16 +313,16 @@ VOID * /** Retrieves a Boolean value for a given PCD token. - Retrieves the Boolean value of a particular PCD token. + Retrieves the Boolean value of a particular PCD token. If the TokenNumber is invalid or the token space - specified by Guid does not exist, the results are + specified by Guid does not exist, the results are unpredictable. @param[in] Guid The token space for the token number. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @return The size Boolean value for the PCD token. - + **/ typedef BOOLEAN @@ -336,14 +336,14 @@ BOOLEAN /** Retrieves the size of the value for a given PCD token. - Retrieves the current size of a particular PCD token. + Retrieves the current size of a particular PCD token. If the TokenNumber is invalid, the results are unpredictable. @param[in] Guid The token space for the token number. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @return The size of the value for the PCD token. - + **/ typedef UINTN @@ -357,19 +357,19 @@ UINTN /** Sets an 8-bit value for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -383,19 +383,19 @@ EFI_STATUS /** Sets a 16-bit value for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -409,19 +409,19 @@ EFI_STATUS /** Sets a 32-bit value for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -435,19 +435,19 @@ EFI_STATUS /** Sets a 64-bit value for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -461,23 +461,23 @@ EFI_STATUS /** Sets a value of a specified size for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. - @param[in] TokenNumber The PCD token number. - @param[in, out] SizeOfBuffer A pointer to the length of the value being set for the PCD token. - On input, if the SizeOfValue is greater than the maximum size supported - for this TokenNumber then the output value of SizeOfValue will reflect + @param[in] TokenNumber The PCD token number. + @param[in, out] SizeOfBuffer A pointer to the length of the value being set for the PCD token. + On input, if the SizeOfValue is greater than the maximum size supported + for this TokenNumber then the output value of SizeOfValue will reflect the maximum size supported for this TokenNumber. @param[in] Buffer The buffer to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -492,19 +492,19 @@ EFI_STATUS /** Sets a Boolean value for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -518,20 +518,20 @@ EFI_STATUS /** Sets an 8-bit value for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -546,20 +546,20 @@ EFI_STATUS /** Sets an 16-bit value for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -574,20 +574,20 @@ EFI_STATUS /** Sets a 32-bit value for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -602,20 +602,20 @@ EFI_STATUS /** Sets a 64-bit value for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -630,24 +630,24 @@ EFI_STATUS /** Sets a value of a specified size for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. - @param[in] TokenNumber The PCD token number. - @param[in, out] SizeOfBuffer A pointer to the length of the value being set for the PCD token. - On input, if the SizeOfValue is greater than the maximum size supported - for this TokenNumber then the output value of SizeOfValue will reflect + @param[in] TokenNumber The PCD token number. + @param[in, out] SizeOfBuffer A pointer to the length of the value being set for the PCD token. + On input, if the SizeOfValue is greater than the maximum size supported + for this TokenNumber then the output value of SizeOfValue will reflect the maximum size supported for this TokenNumber. @param[in] Buffer The buffer to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -663,20 +663,20 @@ EFI_STATUS /** Sets a Boolean value for a given PCD token. - When the PCD service sets a value, it will check to ensure that the - size of the value being set is compatible with the Token's existing definition. + When the PCD service sets a value, it will check to ensure that the + size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Value The value to set for the PCD token. @retval EFI_SUCCESS The procedure returned successfully. - @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. + @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data + being set was incompatible with a call to this function. Use GetSize() to retrieve the size of the target data. @retval EFI_NOT_FOUND The PCD service could not find the requested token number. - + **/ typedef EFI_STATUS @@ -685,18 +685,18 @@ EFI_STATUS IN UINTN TokenNumber, IN BOOLEAN Value ); - + /** Callback on SET function prototype definition. - This notification function serves two purposes. - Firstly, it notifies the module which did the registration that the value - of this PCD token has been set. Secondly, it provides a mechanism for the - module that did the registration to intercept the set operation and override - the value that has been set, if necessary. After the invocation of the callback function, - TokenData will be used by PCD service DXE driver to modify the internal data in + This notification function serves two purposes. + Firstly, it notifies the module which did the registration that the value + of this PCD token has been set. Secondly, it provides a mechanism for the + module that did the registration to intercept the set operation and override + the value that has been set, if necessary. After the invocation of the callback function, + TokenData will be used by PCD service DXE driver to modify the internal data in PCD database. @param[in] CallBackGuid The PCD token GUID being set. @@ -721,11 +721,11 @@ VOID /** Specifies a function to be called anytime the value of a designated token is changed. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. - @param[in] CallBackFunction The function prototype called when the value associated with the CallBackToken is set. + @param[in] CallBackFunction The function prototype called when the value associated with the CallBackToken is set. - @retval EFI_SUCCESS The PCD service has successfully established a call event + @retval EFI_SUCCESS The PCD service has successfully established a call event for the CallBackToken requested. @retval EFI_NOT_FOUND The PCD service could not find the referenced token number. @@ -743,11 +743,11 @@ EFI_STATUS /** Cancels a previously set callback function for a particular PCD token number. - @param[in] TokenNumber The PCD token number. + @param[in] TokenNumber The PCD token number. @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. - @param[in] CallBackFunction The function prototype called when the value associated with the CallBackToken is set. + @param[in] CallBackFunction The function prototype called when the value associated with the CallBackToken is set. - @retval EFI_SUCCESS The PCD service has successfully established a call event + @retval EFI_SUCCESS The PCD service has successfully established a call event for the CallBackToken requested. @retval EFI_NOT_FOUND The PCD service could not find the referenced token number. @@ -763,32 +763,32 @@ EFI_STATUS /** - Retrieves the next valid token number in a given namespace. - - This is useful since the PCD infrastructure contains a sparse list of token numbers, + Retrieves the next valid token number in a given namespace. + + This is useful since the PCD infrastructure contains a sparse list of token numbers, and one cannot a priori know what token numbers are valid in the database. - - If TokenNumber is 0 and Guid is not NULL, then the first token from the token space specified by Guid is returned. - If TokenNumber is not 0 and Guid is not NULL, then the next token in the token space specified by Guid is returned. - If TokenNumber is 0 and Guid is NULL, then the first token in the default token space is returned. - If TokenNumber is not 0 and Guid is NULL, then the next token in the default token space is returned. - The token numbers in the default token space may not be related to token numbers in token spaces that are named by Guid. - If the next token number can be retrieved, then it is returned in TokenNumber, and EFI_SUCCESS is returned. - If TokenNumber represents the last token number in the token space specified by Guid, then EFI_NOT_FOUND is returned. + + If TokenNumber is 0 and Guid is not NULL, then the first token from the token space specified by Guid is returned. + If TokenNumber is not 0 and Guid is not NULL, then the next token in the token space specified by Guid is returned. + If TokenNumber is 0 and Guid is NULL, then the first token in the default token space is returned. + If TokenNumber is not 0 and Guid is NULL, then the next token in the default token space is returned. + The token numbers in the default token space may not be related to token numbers in token spaces that are named by Guid. + If the next token number can be retrieved, then it is returned in TokenNumber, and EFI_SUCCESS is returned. + If TokenNumber represents the last token number in the token space specified by Guid, then EFI_NOT_FOUND is returned. If TokenNumber is not present in the token space specified by Guid, then EFI_NOT_FOUND is returned. - @param[in] Guid The 128-bit unique value that designates the namespace from which to retrieve the next token. - This is an optional parameter that may be NULL. If this parameter is NULL, then a request is + @param[in] Guid The 128-bit unique value that designates the namespace from which to retrieve the next token. + This is an optional parameter that may be NULL. If this parameter is NULL, then a request is being made to retrieve tokens from the default token space. - @param[in,out] TokenNumber - A pointer to the PCD token number to use to find the subsequent token number. + @param[in,out] TokenNumber + A pointer to the PCD token number to use to find the subsequent token number. @retval EFI_SUCCESS The PCD service has retrieved the next valid token number. @retval EFI_NOT_FOUND The PCD service could not find data from the requested token number. **/ -typedef +typedef EFI_STATUS (EFIAPI *PCD_PROTOCOL_GET_NEXT_TOKEN)( IN CONST EFI_GUID *Guid, OPTIONAL @@ -813,7 +813,7 @@ EFI_STATUS @retval EFI_NOT_FOUND The PCD service could not find the next valid token namespace. **/ -typedef +typedef EFI_STATUS (EFIAPI *PCD_PROTOCOL_GET_NEXT_TOKENSPACE)( IN OUT CONST EFI_GUID **Guid diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PcdInfo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PcdInfo.h index e34967e0a3..e83199f601 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PcdInfo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PcdInfo.h @@ -4,7 +4,7 @@ The protocol that provides additional information about items that reside in the PCD database. Different with the EFI_GET_PCD_INFO_PROTOCOL defined in PI 1.2.1 specification, - the native PCD INFO PROTOCOL provide interfaces for dynamic and dynamic-ex type PCD. + the native PCD INFO PROTOCOL provide interfaces for dynamic and dynamic-ex type PCD. The interfaces for dynamic type PCD do not require the token space guid as parameter, but interfaces for dynamic-ex type PCD require token space guid as parameter. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h index 2d41ac1529..310763fbf5 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h @@ -1,21 +1,21 @@ /** @file - This file declares PCI Host Bridge Resource Allocation Protocol which - provides the basic interfaces to abstract a PCI host bridge resource allocation. + This file declares PCI Host Bridge Resource Allocation Protocol which + provides the basic interfaces to abstract a PCI host bridge resource allocation. This protocol is mandatory if the system includes PCI devices. - + Copyright (c) 2007 - 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +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. @par Revision Reference: - This Protocol is defined in UEFI Platform Initialization Specification 1.2 + This Protocol is defined in UEFI Platform Initialization Specification 1.2 Volume 5: Standards. - + **/ #ifndef _PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_H_ @@ -56,14 +56,14 @@ typedef struct _EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL EFI_PCI_HOST_BR #define EFI_PCI_HOST_BRIDGE_MEM64_DECODE 2 /// -/// A UINT64 value that contains the status of a PCI resource requested +/// A UINT64 value that contains the status of a PCI resource requested /// in the Configuration parameter returned by GetProposedResources() /// The legal values are EFI_RESOURCE_SATISFIED and EFI_RESOURCE_NOT_SATISFIED /// typedef UINT64 EFI_RESOURCE_ALLOCATION_STATUS; /// -/// The request of this resource type could be fulfilled. Used in the +/// The request of this resource type could be fulfilled. Used in the /// Configuration parameter returned by GetProposedResources() to identify /// a PCI resources request that can be satisfied. /// @@ -71,7 +71,7 @@ typedef UINT64 EFI_RESOURCE_ALLOCATION_STATUS; /// /// The request of this resource type could not be fulfilled for its -/// absence in the host bridge resource pool. Used in the Configuration parameter +/// absence in the host bridge resource pool. Used in the Configuration parameter /// returned by GetProposedResources() to identify a PCI resources request that /// can not be satisfied. /// @@ -92,45 +92,45 @@ typedef enum { /// /// The bus allocation phase is about to begin. No specific action /// is required here. This notification can be used to perform any - /// chipset specific programming. + /// chipset specific programming. /// EfiPciHostBridgeBeginBusAllocation, /// /// The bus allocation and bus programming phase is complete. No specific /// action is required here. This notification can be used to perform any - /// chipset specific programming. + /// chipset specific programming. /// EfiPciHostBridgeEndBusAllocation, - + /// /// The resource allocation phase is about to begin.No specific action is - /// required here. This notification can be used to perform any chipset specific programming. + /// required here. This notification can be used to perform any chipset specific programming. /// EfiPciHostBridgeBeginResourceAllocation, - + /// /// Allocate resources per previously submitted requests for all the PCI Root /// Bridges. These resource settings are returned on the next call to - /// GetProposedResources(). + /// GetProposedResources(). /// EfiPciHostBridgeAllocateResources, - + /// /// Program the Host Bridge hardware to decode previously allocated resources /// (proposed resources) for all the PCI Root Bridges. /// EfiPciHostBridgeSetResources, - + /// /// De-allocate previously allocated resources previously for all the PCI - /// Root Bridges and reset the I/O and memory apertures to initial state. + /// Root Bridges and reset the I/O and memory apertures to initial state. /// EfiPciHostBridgeFreeResources, - + /// /// The resource allocation phase is completed. No specific action is required - /// here. This notification can be used to perform any chipset specific programming. + /// here. This notification can be used to perform any chipset specific programming. /// EfiPciHostBridgeEndResourceAllocation, @@ -158,30 +158,30 @@ typedef enum { /// /// This notification is sent before the PCI enumerator probes BAR registers - /// for every valid PCI function. + /// for every valid PCI function. /// EfiPciBeforeResourceCollection } EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE; /** - These are the notifications from the PCI bus driver that it is about to enter a certain phase of the PCI + These are the notifications from the PCI bus driver that it is about to enter a certain phase of the PCI enumeration process. - @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL + @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance. @param[in] Phase The phase during enumeration. @retval EFI_SUCCESS The notification was accepted without any errors. @retval EFI_INVALID_PARAMETER The Phase is invalid. - @retval EFI_NOT_READY This phase cannot be entered at this time. For example, this error - is valid for a Phase of EfiPciHostBridgeAllocateResources if - SubmitResources() has not been called for one or more + @retval EFI_NOT_READY This phase cannot be entered at this time. For example, this error + is valid for a Phase of EfiPciHostBridgeAllocateResources if + SubmitResources() has not been called for one or more PCI root bridges before this call. - @retval EFI_DEVICE_ERROR Programming failed due to a hardware error. This error is valid for + @retval EFI_DEVICE_ERROR Programming failed due to a hardware error. This error is valid for a Phase of EfiPciHostBridgeSetResources. - @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. + @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. This error is valid for a Phase of EfiPciHostBridgeAllocateResources - if the previously submitted resource requests cannot be fulfilled or were only + if the previously submitted resource requests cannot be fulfilled or were only partially fulfilled **/ @@ -195,15 +195,15 @@ EFI_STATUS /** Returns the device handle of the next PCI root bridge that is associated with this host bridge. - @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL + @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance. - @param[in,out] RootBridgeHandle Returns the device handle of the next PCI root bridge. On input, it holds the - RootBridgeHandle that was returned by the most recent call to - GetNextRootBridge(). If RootBridgeHandle is NULL on input, the handle + @param[in,out] RootBridgeHandle Returns the device handle of the next PCI root bridge. On input, it holds the + RootBridgeHandle that was returned by the most recent call to + GetNextRootBridge(). If RootBridgeHandle is NULL on input, the handle for the first PCI root bridge is returned. @retval EFI_SUCCESS The requested attribute information was returned. - @retval EFI_INVALID_PARAMETER RootBridgeHandle is not an EFI_HANDLE that was returned + @retval EFI_INVALID_PARAMETER RootBridgeHandle is not an EFI_HANDLE that was returned on a previous call to GetNextRootBridge(). @retval EFI_NOT_FOUND There are no more PCI root bridge device handles. @@ -218,7 +218,7 @@ EFI_STATUS /** Returns the allocation attributes of a PCI root bridge. - @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL + @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance. @param[in] RootBridgeHandle The device handle of the PCI root bridge in which the caller is interested. @param[out] Attribute The pointer to attributes of the PCI root bridge. @@ -239,12 +239,12 @@ EFI_STATUS /** Sets up the specified PCI root bridge for the bus enumeration process. - @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL + @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance. @param[in] RootBridgeHandle The PCI root bridge to be set up. @param[out] Configuration The pointer to the pointer to the PCI bus resource descriptor. - @retval EFI_SUCCESS The PCI root bridge was set up and the bus range was returned in + @retval EFI_SUCCESS The PCI root bridge was set up and the bus range was returned in Configuration. @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle. @retval EFI_DEVICE_ERROR Programming failed due to a hardware error. @@ -263,20 +263,20 @@ EFI_STATUS Programs the PCI root bridge hardware so that it decodes the specified PCI bus range. @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL - instance. + instance. @param[in] RootBridgeHandle The PCI root bridge whose bus range is to be programmed. @param[in] Configuration The pointer to the PCI bus resource descriptor. @retval EFI_SUCCESS The bus range for the PCI root bridge was programmed. @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle. @retval EFI_INVALID_PARAMETER Configuration is NULL - @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI (2.0 & 3.0) + @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI (2.0 & 3.0) resource descriptor. @retval EFI_INVALID_PARAMETER Configuration does not include a valid ACPI 2.0 bus resource descriptor. - @retval EFI_INVALID_PARAMETER Configuration includes valid ACPI (2.0 & 3.0) resource + @retval EFI_INVALID_PARAMETER Configuration includes valid ACPI (2.0 & 3.0) resource descriptors other than bus descriptors. - @retval EFI_INVALID_PARAMETER Configuration contains one or more invalid ACPI resource + @retval EFI_INVALID_PARAMETER Configuration contains one or more invalid ACPI resource descriptors. @retval EFI_INVALID_PARAMETER "Address Range Minimum" is invalid for this root bridge. @retval EFI_INVALID_PARAMETER "Address Range Length" is invalid for this root bridge. @@ -294,26 +294,26 @@ EFI_STATUS /** Submits the I/O and memory resource requirements for the specified PCI root bridge. - @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL + @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance. - @param[in] RootBridgeHandle The PCI root bridge whose I/O and memory resource requirements are being + @param[in] RootBridgeHandle The PCI root bridge whose I/O and memory resource requirements are being submitted. @param[in] Configuration The pointer to the PCI I/O and PCI memory resource descriptor. - @retval EFI_SUCCESS The I/O and memory resource requests for a PCI root bridge were + @retval EFI_SUCCESS The I/O and memory resource requests for a PCI root bridge were accepted. @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle. @retval EFI_INVALID_PARAMETER Configuration is NULL. - @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI (2.0 & 3.0) + @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI (2.0 & 3.0) resource descriptor. - @retval EFI_INVALID_PARAMETER Configuration includes requests for one or more resource - types that are not supported by this PCI root bridge. This error will - happen if the caller did not combine resources according to + @retval EFI_INVALID_PARAMETER Configuration includes requests for one or more resource + types that are not supported by this PCI root bridge. This error will + happen if the caller did not combine resources according to Attributes that were returned by GetAllocAttributes(). @retval EFI_INVALID_PARAMETER "Address Range Maximum" is invalid. @retval EFI_INVALID_PARAMETER "Address Range Length" is invalid for this PCI root bridge. @retval EFI_INVALID_PARAMETER "Address Space Granularity" is invalid for this PCI root bridge. - + **/ typedef EFI_STATUS @@ -326,7 +326,7 @@ EFI_STATUS /** Returns the proposed resource settings for the specified PCI root bridge. - @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL + @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance. @param[in] RootBridgeHandle The PCI root bridge handle. @param[out] Configuration The pointer to the pointer to the PCI I/O and memory resource descriptor. @@ -346,8 +346,8 @@ EFI_STATUS ); /** - Provides the hooks from the PCI bus driver to every PCI controller (device/function) at various - stages of the PCI enumeration process that allow the host bridge driver to preinitialize individual + Provides the hooks from the PCI bus driver to every PCI controller (device/function) at various + stages of the PCI enumeration process that allow the host bridge driver to preinitialize individual PCI controllers before enumeration. @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance. @@ -357,10 +357,10 @@ EFI_STATUS @retval EFI_SUCCESS The requested parameters were returned. @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle. - @retval EFI_INVALID_PARAMETER Phase is not a valid phase that is defined in + @retval EFI_INVALID_PARAMETER Phase is not a valid phase that is defined in EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE. - @retval EFI_DEVICE_ERROR Programming failed due to a hardware error. The PCI enumerator - should not enumerate this device, including its child devices if it is + @retval EFI_DEVICE_ERROR Programming failed due to a hardware error. The PCI enumerator + should not enumerate this device, including its child devices if it is a PCI-to-PCI bridge. **/ @@ -382,43 +382,43 @@ struct _EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL { /// a certain phase during the enumeration process. /// EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_NOTIFY_PHASE NotifyPhase; - + /// /// Retrieves the device handle for the next PCI root bridge that is produced by the - /// host bridge to which this instance of the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL is attached. + /// host bridge to which this instance of the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL is attached. /// EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_GET_NEXT_ROOT_BRIDGE GetNextRootBridge; - + /// /// Retrieves the allocation-related attributes of a PCI root bridge. /// EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_GET_ATTRIBUTES GetAllocAttributes; - + /// /// Sets up a PCI root bridge for bus enumeration. /// EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_START_BUS_ENUMERATION StartBusEnumeration; - + /// /// Sets up the PCI root bridge so that it decodes a specific range of bus numbers. /// EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_SET_BUS_NUMBERS SetBusNumbers; - + /// /// Submits the resource requirements for the specified PCI root bridge. /// EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_SUBMIT_RESOURCES SubmitResources; - + /// /// Returns the proposed resource assignment for the specified PCI root bridges. /// EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_GET_PROPOSED_RESOURCES GetProposedResources; - + /// /// Provides hooks from the PCI bus driver to every PCI controller /// (device/function) at various stages of the PCI enumeration process that /// allow the host bridge driver to preinitialize individual PCI controllers - /// before enumeration. + /// before enumeration. /// EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_PREPROCESS_CONTROLLER PreprocessController; }; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciHotPlugInit.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciHotPlugInit.h index 6570177382..52466d0945 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciHotPlugInit.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciHotPlugInit.h @@ -1,43 +1,43 @@ /** @file This file declares EFI PCI Hot Plug Init Protocol. - - This protocol provides the necessary functionality to initialize the Hot Plug - Controllers (HPCs) and the buses that they control. This protocol also provides + + This protocol provides the necessary functionality to initialize the Hot Plug + Controllers (HPCs) and the buses that they control. This protocol also provides information regarding resource padding. - - @par Note: + + @par Note: This protocol is required only on platforms that support one or more PCI Hot - Plug* slots or CardBus sockets. + Plug* slots or CardBus sockets. The EFI_PCI_HOT_PLUG_INIT_PROTOCOL provides a mechanism for the PCI bus enumerator - to properly initialize the HPCs and CardBus sockets that require initialization. - The HPC initialization takes place before the PCI enumeration process is complete. - There cannot be more than one instance of this protocol in a system. This protocol - is installed on its own separate handle. - - Because the system may include multiple HPCs, one instance of this protocol - should represent all of them. The protocol functions use the device path of - the HPC to identify the HPC. When the PCI bus enumerator finds a root HPC, it + to properly initialize the HPCs and CardBus sockets that require initialization. + The HPC initialization takes place before the PCI enumeration process is complete. + There cannot be more than one instance of this protocol in a system. This protocol + is installed on its own separate handle. + + Because the system may include multiple HPCs, one instance of this protocol + should represent all of them. The protocol functions use the device path of + the HPC to identify the HPC. When the PCI bus enumerator finds a root HPC, it will call EFI_PCI_HOT_PLUG_INIT_PROTOCOL.InitializeRootHpc(). If InitializeRootHpc() - is unable to initialize a root HPC, the PCI enumerator will ignore that root HPC - and continue the enumeration process. If the HPC is not initialized, the devices + is unable to initialize a root HPC, the PCI enumerator will ignore that root HPC + and continue the enumeration process. If the HPC is not initialized, the devices that it controls may not be initialized, and no resource padding will be provided. - From the standpoint of the PCI bus enumerator, HPCs are divided into the following + From the standpoint of the PCI bus enumerator, HPCs are divided into the following two classes: - Root HPC: - These HPCs must be initialized by calling InitializeRootHpc() during the - enumeration process. These HPCs will also require resource padding. The - platform code must have a priori knowledge of these devices and must know - how to initialize them. There may not be any way to access their PCI + These HPCs must be initialized by calling InitializeRootHpc() during the + enumeration process. These HPCs will also require resource padding. The + platform code must have a priori knowledge of these devices and must know + how to initialize them. There may not be any way to access their PCI configuration space before the PCI enumerator programs all the upstream - bridges and thus enables the path to these devices. The PCI bus enumerator - is responsible for determining the PCI bus address of the HPC before it + bridges and thus enables the path to these devices. The PCI bus enumerator + is responsible for determining the PCI bus address of the HPC before it calls InitializeRootHpc(). - Nonroot HPC: - These HPCs will not need explicit initialization during enumeration process. - These HPCs will require resource padding. The platform code does not have + These HPCs will not need explicit initialization during enumeration process. + These HPCs will require resource padding. The platform code does not have to have a priori knowledge of these devices. Copyright (c) 2007 - 2009, Intel Corporation. All rights reserved.<BR> @@ -50,7 +50,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: - This Protocol is defined in UEFI Platform Initialization Specification 1.2 + This Protocol is defined in UEFI Platform Initialization Specification 1.2 Volume 5: Standards **/ @@ -77,15 +77,15 @@ typedef struct _EFI_PCI_HOT_PLUG_INIT_PROTOCOL EFI_PCI_HOT_PLUG_INIT_PROTOCOL; typedef UINT16 EFI_HPC_STATE; /// -/// The HPC initialization function was called and the HPC completed -/// initialization, but it was not enabled for some reason. The HPC may be -/// disabled in hardware, or it may be disabled due to user preferences, +/// The HPC initialization function was called and the HPC completed +/// initialization, but it was not enabled for some reason. The HPC may be +/// disabled in hardware, or it may be disabled due to user preferences, /// hardware failure, or other reasons. No resource padding is required. /// #define EFI_HPC_STATE_INITIALIZED 0x01 /// -/// The HPC initialization function was called, the HPC completed +/// The HPC initialization function was called, the HPC completed /// initialization, and it was enabled. Resource padding is required. /// #define EFI_HPC_STATE_ENABLED 0x02 @@ -95,18 +95,18 @@ typedef UINT16 EFI_HPC_STATE; /// typedef struct{ /// - /// + /// /// The device path to the root HPC. An HPC cannot control its parent buses. - /// The PCI bus driver requires this information so that it can pass the - /// correct HpcPciAddress to the InitializeRootHpc() and GetResourcePadding() - /// functions. + /// The PCI bus driver requires this information so that it can pass the + /// correct HpcPciAddress to the InitializeRootHpc() and GetResourcePadding() + /// functions. /// EFI_DEVICE_PATH_PROTOCOL *HpcDevicePath; /// - /// The device path to the Hot Plug Bus (HPB) that is controlled by the root - /// HPC. The PCI bus driver uses this information to check if a particular PCI - /// bus has hot-plug slots. The device path of a PCI bus is the same as the - /// device path of its parent. For Standard(PCI) Hot Plug Controllers (SHPCs) + /// The device path to the Hot Plug Bus (HPB) that is controlled by the root + /// HPC. The PCI bus driver uses this information to check if a particular PCI + /// bus has hot-plug slots. The device path of a PCI bus is the same as the + /// device path of its parent. For Standard(PCI) Hot Plug Controllers (SHPCs) /// and PCI Express*, HpbDevicePath is the same as HpcDevicePath. /// EFI_DEVICE_PATH_PROTOCOL *HpbDevicePath; @@ -131,7 +131,7 @@ typedef enum { /// strategy may reduce the total amount of padding, but requires /// reprogramming of PCI-to-PCI bridges in a hot-add event. If the hotplug /// bus is behind a PCI-to-PCI bridge, the PCI-to-PCI bridge - /// apertures do not indicate the padding for that bus. + /// apertures do not indicate the padding for that bus. /// EfiPaddingPciRootBridge } EFI_HPC_PADDING_ATTRIBUTES; @@ -140,14 +140,14 @@ typedef enum { Returns a list of root Hot Plug Controllers (HPCs) that require initialization during the boot process. - This procedure returns a list of root HPCs. The PCI bus driver must initialize - these controllers during the boot process. The PCI bus driver may or may not be - able to detect these HPCs. If the platform includes a PCI-to-CardBus bridge, it - can be included in this list if it requires initialization. The HpcList must be - self consistent. An HPC cannot control any of its parent buses. Only one HPC can - control a PCI bus. Because this list includes only root HPCs, no HPC in the list - can be a child of another HPC. This policy must be enforced by the - EFI_PCI_HOT_PLUG_INIT_PROTOCOL. The PCI bus driver may not check for such + This procedure returns a list of root HPCs. The PCI bus driver must initialize + these controllers during the boot process. The PCI bus driver may or may not be + able to detect these HPCs. If the platform includes a PCI-to-CardBus bridge, it + can be included in this list if it requires initialization. The HpcList must be + self consistent. An HPC cannot control any of its parent buses. Only one HPC can + control a PCI bus. Because this list includes only root HPCs, no HPC in the list + can be a child of another HPC. This policy must be enforced by the + EFI_PCI_HOT_PLUG_INIT_PROTOCOL. The PCI bus driver may not check for such invalid conditions. The callee allocates the buffer HpcList @param[in] This Pointer to the EFI_PCI_HOT_PLUG_INIT_PROTOCOL instance. @@ -156,7 +156,7 @@ typedef enum { elements in this list. @retval EFI_SUCCESS HpcList was returned. - @retval EFI_OUT_OF_RESOURCES HpcList was not returned due to insufficient + @retval EFI_OUT_OF_RESOURCES HpcList was not returned due to insufficient resources. @retval EFI_INVALID_PARAMETER HpcCount is NULL or HpcList is NULL. @@ -172,26 +172,26 @@ EFI_STATUS /** Initializes one root Hot Plug Controller (HPC). This process may causes initialization of its subordinate buses. - - This function initializes the specified HPC. At the end of initialization, - the hot-plug slots or sockets (controlled by this HPC) are powered and are - connected to the bus. All the necessary registers in the HPC are set up. For - a Standard (PCI) Hot Plug Controller (SHPC), the registers that must be set - up are defined in the PCI Standard Hot Plug Controller and Subsystem - Specification. + + This function initializes the specified HPC. At the end of initialization, + the hot-plug slots or sockets (controlled by this HPC) are powered and are + connected to the bus. All the necessary registers in the HPC are set up. For + a Standard (PCI) Hot Plug Controller (SHPC), the registers that must be set + up are defined in the PCI Standard Hot Plug Controller and Subsystem + Specification. @param[in] This Pointer to the EFI_PCI_HOT_PLUG_INIT_PROTOCOL instance. @param[in] HpcDevicePath The device path to the HPC that is being initialized. @param[in] HpcPciAddress The address of the HPC function on the PCI bus. - @param[in] Event The event that should be signaled when the HPC - initialization is complete. Set to NULL if the - caller wants to wait until the entire initialization + @param[in] Event The event that should be signaled when the HPC + initialization is complete. Set to NULL if the + caller wants to wait until the entire initialization process is complete. - @param[out] HpcState The state of the HPC hardware. The state is + @param[out] HpcState The state of the HPC hardware. The state is EFI_HPC_STATE_INITIALIZED or EFI_HPC_STATE_ENABLED. @retval EFI_SUCCESS If Event is NULL, the specific HPC was successfully - initialized. If Event is not NULL, Event will be + initialized. If Event is not NULL, Event will be signaled at a later time when initialization is complete. @retval EFI_UNSUPPORTED This instance of EFI_PCI_HOT_PLUG_INIT_PROTOCOL does not support the specified HPC. @@ -215,10 +215,10 @@ EFI_STATUS by the specified Hot Plug Controller (HPC). This function returns the resource padding that is required by the PCI bus that - is controlled by the specified HPC. This member function is called for all the - root HPCs and nonroot HPCs that are detected by the PCI bus enumerator. This - function will be called before PCI resource allocation is completed. This function - must be called after all the root HPCs, with the possible exception of a + is controlled by the specified HPC. This member function is called for all the + root HPCs and nonroot HPCs that are detected by the PCI bus enumerator. This + function will be called before PCI resource allocation is completed. This function + must be called after all the root HPCs, with the possible exception of a PCI-to-CardBus bridge, have completed initialization. @param[in] This Pointer to the EFI_PCI_HOT_PLUG_INIT_PROTOCOL instance. @@ -261,12 +261,12 @@ struct _EFI_PCI_HOT_PLUG_INIT_PROTOCOL { /// Returns a list of root HPCs and the buses that they control. /// EFI_GET_ROOT_HPC_LIST GetRootHpcList; - + /// /// Initializes the specified root HPC. /// EFI_INITIALIZE_ROOT_HPC InitializeRootHpc; - + /// /// Returns the resource padding that is required by the HPC. /// diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciHotPlugRequest.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciHotPlugRequest.h index c96b789b56..f2c520b0ce 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciHotPlugRequest.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciHotPlugRequest.h @@ -1,46 +1,46 @@ /** @file - Provides services to notify the PCI bus driver that some events have happened - in a hot-plug controller (such as a PC Card socket, or PHPC), and to ask the + Provides services to notify the PCI bus driver that some events have happened + in a hot-plug controller (such as a PC Card socket, or PHPC), and to ask the PCI bus driver to create or destroy handles for PCI-like devices. - A hot-plug capable PCI bus driver should produce the EFI PCI Hot Plug Request + A hot-plug capable PCI bus driver should produce the EFI PCI Hot Plug Request protocol. When a PCI device or a PCI-like device (for example, 32-bit PC Card) - is installed after PCI bus does the enumeration, the PCI bus driver can be + is installed after PCI bus does the enumeration, the PCI bus driver can be notified through this protocol. For example, when a 32-bit PC Card is inserted into the PC Card socket, the PC Card bus driver can call interface of this protocol to notify PCI bus driver to allocate resource and create handles for this PC Card. - - The EFI_PCI_HOTPLUG_REQUEST_PROTOCOL is installed by the PCI bus driver on a - separate handle when PCI bus driver starts up. There is only one instance in + + The EFI_PCI_HOTPLUG_REQUEST_PROTOCOL is installed by the PCI bus driver on a + separate handle when PCI bus driver starts up. There is only one instance in the system. Any driver that wants to use this protocol must locate it globally. - The EFI_PCI_HOTPLUG_REQUEST_PROTOCOL allows the driver of hot-plug controller, - for example, PC Card Bus driver, to notify PCI bus driver that an event has - happened in the hot-plug controller, and the PCI bus driver is requested to - create (add) or destroy (remove) handles for the specified PCI-like devices. - For example, when a 32-bit PC Card is inserted, this protocol interface will - be called with an add operation, and the PCI bus driver will enumerate and - start the devices inserted; when a 32-bit PC Card is removed, this protocol - interface will be called with a remove operation, and the PCI bus driver will - stop the devices and destroy their handles. The existence of this protocol + The EFI_PCI_HOTPLUG_REQUEST_PROTOCOL allows the driver of hot-plug controller, + for example, PC Card Bus driver, to notify PCI bus driver that an event has + happened in the hot-plug controller, and the PCI bus driver is requested to + create (add) or destroy (remove) handles for the specified PCI-like devices. + For example, when a 32-bit PC Card is inserted, this protocol interface will + be called with an add operation, and the PCI bus driver will enumerate and + start the devices inserted; when a 32-bit PC Card is removed, this protocol + interface will be called with a remove operation, and the PCI bus driver will + stop the devices and destroy their handles. The existence of this protocol represents the capability of the PCI bus driver. If this protocol exists in - system, it means PCI bus driver is hot-plug capable, thus together with the + system, it means PCI bus driver is hot-plug capable, thus together with the effort of PC Card bus driver, hot-plug of PC Card can be supported. Otherwise, - the hot-plug capability is not provided. - + the hot-plug capability is not provided. + Copyright (c) 2006 - 2009, 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 - - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + 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 + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: - This Protocol is defined in UEFI Platform Initialization Specification 1.2 + This Protocol is defined in UEFI Platform Initialization Specification 1.2 Volume 5: Standards - + **/ #ifndef __PCI_HOTPLUG_REQUEST_H_ @@ -61,7 +61,7 @@ typedef struct _EFI_PCI_HOTPLUG_REQUEST_PROTOCOL EFI_PCI_HOTPLUG_REQUEST_PROTOC /// /// Enumeration of PCI hot plug operations -/// +/// typedef enum { /// /// The PCI bus driver is requested to create handles for the specified devices. @@ -78,65 +78,65 @@ typedef enum { /** This function is used to notify PCI bus driver that some events happened in a - hot-plug controller, and the PCI bus driver is requested to start or stop + hot-plug controller, and the PCI bus driver is requested to start or stop specified PCI-like devices. - + This function allows the PCI bus driver to be notified to act as requested when - a hot-plug event has happened on the hot-plug controller. Currently, the + a hot-plug event has happened on the hot-plug controller. Currently, the operations include add operation and remove operation. If it is a add operation, - the PCI bus driver will enumerate, allocate resources for devices behind the + the PCI bus driver will enumerate, allocate resources for devices behind the hot-plug controller, and create handle for the device specified by RemainingDevicePath. - The RemainingDevicePath is an optional parameter. If it is not NULL, only the - specified device is started; if it is NULL, all devices behind the hot-plug - controller are started. The newly created handles of PC Card functions are + The RemainingDevicePath is an optional parameter. If it is not NULL, only the + specified device is started; if it is NULL, all devices behind the hot-plug + controller are started. The newly created handles of PC Card functions are returned in the ChildHandleBuffer, together with the number of child handle in NumberOfChildren. If it is a remove operation, when NumberOfChildren contains a non-zero value, child handles specified in ChildHandleBuffer are stopped and destroyed; otherwise, PCI bus driver is notified to stop managing the controller - handle. - - @param[in] This A pointer to the EFI_PCI_HOTPLUG_REQUEST_PROTOCOL + handle. + + @param[in] This A pointer to the EFI_PCI_HOTPLUG_REQUEST_PROTOCOL instance. - @param[in] Operation The operation the PCI bus driver is requested - to make. + @param[in] Operation The operation the PCI bus driver is requested + to make. @param[in] Controller The handle of the hot-plug controller. @param[in] RemainingDevicePath The remaining device path for the PCI-like hot-plug device. It only contains device - path nodes behind the hot-plug controller. + path nodes behind the hot-plug controller. It is an optional parameter and only valid - when the Operation is a add operation. If - it is NULL, all devices behind the PC Card + when the Operation is a add operation. If + it is NULL, all devices behind the PC Card socket are started. - @param[in,out] NumberOfChildren The number of child handles. For an add + @param[in,out] NumberOfChildren The number of child handles. For an add operation, it is an output parameter. For a remove operation, it's an input parameter. When it contains a non-zero value, children handles specified in ChildHandleBuffer are - destroyed. Otherwise, PCI bus driver is - notified to stop managing the controller + destroyed. Otherwise, PCI bus driver is + notified to stop managing the controller handle. - @param[in,out] ChildHandleBuffer The buffer which contains the child handles. - For an add operation, it is an output - parameter and contains all newly created + @param[in,out] ChildHandleBuffer The buffer which contains the child handles. + For an add operation, it is an output + parameter and contains all newly created child handles. For a remove operation, it contains child handles to be destroyed when NumberOfChildren contains a non-zero value. It can be NULL when NumberOfChildren is 0. It's the caller's responsibility to allocate and free memory for this buffer. - - @retval EFI_SUCCESS The handles for the specified device have been - created or destroyed as requested, and for an - add operation, the new handles are returned in + + @retval EFI_SUCCESS The handles for the specified device have been + created or destroyed as requested, and for an + add operation, the new handles are returned in ChildHandleBuffer. @retval EFI_INVALID_PARAMETER Operation is not a legal value. @retval EFI_INVALID_PARAMETER Controller is NULL or not a valid handle. @retval EFI_INVALID_PARAMETER NumberOfChildren is NULL. - @retval EFI_INVALID_PARAMETER ChildHandleBuffer is NULL while Operation is - remove and NumberOfChildren contains a non-zero + @retval EFI_INVALID_PARAMETER ChildHandleBuffer is NULL while Operation is + remove and NumberOfChildren contains a non-zero value. @retval EFI_INVALID_PARAMETER ChildHandleBuffer is NULL while Operation is add. - @retval EFI_OUT_OF_RESOURCES There are no enough resources to start the + @retval EFI_OUT_OF_RESOURCES There are no enough resources to start the devices. **/ typedef @@ -151,15 +151,15 @@ EFI_STATUS ); /// -/// Provides services to notify PCI bus driver that some events have happened in -/// a hot-plug controller (for example, PC Card socket, or PHPC), and ask PCI bus +/// Provides services to notify PCI bus driver that some events have happened in +/// a hot-plug controller (for example, PC Card socket, or PHPC), and ask PCI bus /// driver to create or destroy handles for the PCI-like devices. /// struct _EFI_PCI_HOTPLUG_REQUEST_PROTOCOL { /// - /// Notify the PCI bus driver that some events have happened in a hot-plug - /// controller (for example, PC Card socket, or PHPC), and ask PCI bus driver - /// to create or destroy handles for the PCI-like devices. See Section 0 for + /// Notify the PCI bus driver that some events have happened in a hot-plug + /// controller (for example, PC Card socket, or PHPC), and ask PCI bus driver + /// to create or destroy handles for the PCI-like devices. See Section 0 for /// a detailed description. /// EFI_PCI_HOTPLUG_REQUEST_NOTIFY Notify; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciIo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciIo.h index 6c51e85750..94a5ab9b1f 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciIo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciIo.h @@ -1,15 +1,15 @@ /** @file - EFI PCI I/O Protocol provides the basic Memory, I/O, PCI configuration, + EFI PCI I/O Protocol provides the basic Memory, I/O, PCI configuration, and DMA interfaces that a driver uses to access its PCI controller. Copyright (c) 2006 - 2017, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -126,27 +126,27 @@ typedef enum { EfiPciIoAttributeOperationMaximum } EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION; -/** +/** Reads from the memory space of a PCI controller. Returns either when the polling exit criteria is - satisfied or after a defined duration. - + satisfied or after a defined duration. + @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. @param Width Signifies the width of the memory or I/O operations. @param BarIndex The BAR index of the standard PCI Configuration header to use as the - base address for the memory operation to perform. + base address for the memory operation to perform. @param Offset The offset within the selected BAR to start the memory operation. @param Mask Mask used for the polling criteria. @param Value The comparison value used for the polling exit criteria. @param Delay The number of 100 ns units to poll. @param Result Pointer to the last value read from the memory location. - + @retval EFI_SUCCESS The last data returned from the access matched the poll exit criteria. @retval EFI_UNSUPPORTED BarIndex not valid for this PCI controller. @retval EFI_UNSUPPORTED Offset is not valid for the BarIndex of this PCI controller. @retval EFI_TIMEOUT Delay expired before a match occurred. @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - + **/ typedef EFI_STATUS @@ -161,25 +161,25 @@ EFI_STATUS OUT UINT64 *Result ); -/** +/** Enable a PCI driver to access PCI controller registers in the PCI memory or I/O space. - + @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. @param Width Signifies the width of the memory or I/O operations. @param BarIndex The BAR index of the standard PCI Configuration header to use as the - base address for the memory or I/O operation to perform. - @param Offset The offset within the selected BAR to start the memory or I/O operation. + base address for the memory or I/O operation to perform. + @param Offset The offset within the selected BAR to start the memory or I/O operation. @param Count The number of memory or I/O operations to perform. @param Buffer For read operations, the destination buffer to store the results. For write - operations, the source buffer to write data from. - + operations, the source buffer to write data from. + @retval EFI_SUCCESS The data was read from or written to the PCI controller. @retval EFI_UNSUPPORTED BarIndex not valid for this PCI controller. @retval EFI_UNSUPPORTED The address range specified by Offset, Width, and Count is not - valid for the PCI BAR specified by BarIndex. + valid for the PCI BAR specified by BarIndex. @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - + **/ typedef EFI_STATUS @@ -203,23 +203,23 @@ typedef struct { EFI_PCI_IO_PROTOCOL_IO_MEM Write; } EFI_PCI_IO_PROTOCOL_ACCESS; -/** +/** Enable a PCI driver to access PCI controller registers in PCI configuration space. - - @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. + + @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. @param Width Signifies the width of the memory operations. @param Offset The offset within the PCI configuration space for the PCI controller. @param Count The number of PCI configuration operations to perform. @param Buffer For read operations, the destination buffer to store the results. For write operations, the source buffer to write data from. - - + + @retval EFI_SUCCESS The data was read from or written to the PCI controller. @retval EFI_UNSUPPORTED The address range specified by Offset, Width, and Count is not valid for the PCI configuration header of the PCI controller. - @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. - @retval EFI_INVALID_PARAMETER Buffer is NULL or Width is invalid. - + @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. + @retval EFI_INVALID_PARAMETER Buffer is NULL or Width is invalid. + **/ typedef EFI_STATUS @@ -242,33 +242,33 @@ typedef struct { EFI_PCI_IO_PROTOCOL_CONFIG Write; } EFI_PCI_IO_PROTOCOL_CONFIG_ACCESS; -/** +/** Enables a PCI driver to copy one region of PCI memory space to another region of PCI memory space. - + @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. @param Width Signifies the width of the memory operations. @param DestBarIndex The BAR index in the standard PCI Configuration header to use as the - base address for the memory operation to perform. + base address for the memory operation to perform. @param DestOffset The destination offset within the BAR specified by DestBarIndex to - start the memory writes for the copy operation. + start the memory writes for the copy operation. @param SrcBarIndex The BAR index in the standard PCI Configuration header to use as the - base address for the memory operation to perform. + base address for the memory operation to perform. @param SrcOffset The source offset within the BAR specified by SrcBarIndex to start - the memory reads for the copy operation. + the memory reads for the copy operation. @param Count The number of memory operations to perform. Bytes moved is Width - size * Count, starting at DestOffset and SrcOffset. - + size * Count, starting at DestOffset and SrcOffset. + @retval EFI_SUCCESS The data was copied from one memory region to another memory region. @retval EFI_UNSUPPORTED DestBarIndex not valid for this PCI controller. @retval EFI_UNSUPPORTED SrcBarIndex not valid for this PCI controller. @retval EFI_UNSUPPORTED The address range specified by DestOffset, Width, and Count - is not valid for the PCI BAR specified by DestBarIndex. + is not valid for the PCI BAR specified by DestBarIndex. @retval EFI_UNSUPPORTED The address range specified by SrcOffset, Width, and Count is - not valid for the PCI BAR specified by SrcBarIndex. + not valid for the PCI BAR specified by SrcBarIndex. @retval EFI_INVALID_PARAMETER Width is invalid. @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. - + **/ typedef EFI_STATUS @@ -282,24 +282,24 @@ EFI_STATUS IN UINTN Count ); -/** +/** Provides the PCI controller-specific addresses needed to access system memory. - + @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. @param Operation Indicates if the bus master is going to read or write to system memory. @param HostAddress The system memory address to map to the PCI controller. @param NumberOfBytes On input the number of bytes to map. On output the number of bytes - that were mapped. + that were mapped. @param DeviceAddress The resulting map address for the bus master PCI controller to use to - access the hosts HostAddress. + access the hosts HostAddress. @param Mapping A resulting value to pass to Unmap(). - + @retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes. - @retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer. + @retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer. @retval EFI_INVALID_PARAMETER One or more parameters are invalid. @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. @retval EFI_DEVICE_ERROR The system hardware could not map the requested address. - + **/ typedef EFI_STATUS @@ -312,15 +312,15 @@ EFI_STATUS OUT VOID **Mapping ); -/** +/** Completes the Map() operation and releases any corresponding resources. - - @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. + + @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. @param Mapping The mapping value returned from Map(). - + @retval EFI_SUCCESS The range was unmapped. @retval EFI_DEVICE_ERROR The data was not committed to the target system memory. - + **/ typedef EFI_STATUS @@ -329,25 +329,25 @@ EFI_STATUS IN VOID *Mapping ); -/** +/** Allocates pages that are suitable for an EfiPciIoOperationBusMasterCommonBuffer or EfiPciOperationBusMasterCommonBuffer64 mapping. - + @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. @param Type This parameter is not used and must be ignored. @param MemoryType The type of memory to allocate, EfiBootServicesData or - EfiRuntimeServicesData. - @param Pages The number of pages to allocate. + EfiRuntimeServicesData. + @param Pages The number of pages to allocate. @param HostAddress A pointer to store the base system memory address of the - allocated range. + allocated range. @param Attributes The requested bit mask of attributes for the allocated range. - + @retval EFI_SUCCESS The requested memory pages were allocated. @retval EFI_UNSUPPORTED Attributes is unsupported. The only legal attribute bits are MEMORY_WRITE_COMBINE, MEMORY_CACHED and DUAL_ADDRESS_CYCLE. @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated. - + @retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated. + **/ typedef EFI_STATUS @@ -360,17 +360,17 @@ EFI_STATUS IN UINT64 Attributes ); -/** +/** Frees memory that was allocated with AllocateBuffer(). - - @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. - @param Pages The number of pages to free. - @param HostAddress The base system memory address of the allocated range. - + + @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. + @param Pages The number of pages to free. + @param HostAddress The base system memory address of the allocated range. + @retval EFI_SUCCESS The requested memory pages were freed. @retval EFI_INVALID_PARAMETER The memory range specified by HostAddress and Pages was not allocated with AllocateBuffer(). - + **/ typedef EFI_STATUS @@ -380,16 +380,16 @@ EFI_STATUS IN VOID *HostAddress ); -/** +/** Flushes all PCI posted write transactions from a PCI host bridge to system memory. - - @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. - + + @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. + @retval EFI_SUCCESS The PCI posted write transactions were flushed from the PCI host - bridge to system memory. + bridge to system memory. @retval EFI_DEVICE_ERROR The PCI posted write transactions were not flushed from the PCI - host bridge due to a hardware error. - + host bridge due to a hardware error. + **/ typedef EFI_STATUS @@ -397,18 +397,18 @@ EFI_STATUS IN EFI_PCI_IO_PROTOCOL *This ); -/** +/** Retrieves this PCI controller's current PCI bus number, device number, and function number. - - @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. + + @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. @param SegmentNumber The PCI controller's current PCI segment number. @param BusNumber The PCI controller's current PCI bus number. @param DeviceNumber The PCI controller's current PCI device number. @param FunctionNumber The PCI controller's current PCI function number. - - @retval EFI_SUCCESS The PCI controller location was returned. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - + + @retval EFI_SUCCESS The PCI controller location was returned. + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + **/ typedef EFI_STATUS @@ -420,24 +420,24 @@ EFI_STATUS OUT UINTN *FunctionNumber ); -/** +/** Performs an operation on the attributes that this PCI controller supports. The operations include - getting the set of supported attributes, retrieving the current attributes, setting the current - attributes, enabling attributes, and disabling attributes. - - @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. + getting the set of supported attributes, retrieving the current attributes, setting the current + attributes, enabling attributes, and disabling attributes. + + @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. @param Operation The operation to perform on the attributes for this PCI controller. @param Attributes The mask of attributes that are used for Set, Enable, and Disable - operations. + operations. @param Result A pointer to the result mask of attributes that are returned for the Get - and Supported operations. - + and Supported operations. + @retval EFI_SUCCESS The operation on the PCI controller's attributes was completed. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_UNSUPPORTED one or more of the bits set in + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + @retval EFI_UNSUPPORTED one or more of the bits set in Attributes are not supported by this PCI controller or one of its parent bridges when Operation is Set, Enable or Disable. - + **/ typedef EFI_STATUS @@ -459,7 +459,7 @@ EFI_STATUS setting for this BAR with SetBarAttributes(). @param Resources A pointer to the resource descriptors that describe the current configuration of this BAR of the PCI controller. - + @retval EFI_SUCCESS If Supports is not NULL, then the attributes that the PCI controller supports are returned in Supports. If Resources is not NULL, then the resource descriptors that the PCI @@ -478,29 +478,29 @@ EFI_STATUS OUT VOID **Resources OPTIONAL ); -/** +/** Sets the attributes for a range of a BAR on a PCI controller. - - @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. + + @param This A pointer to the EFI_PCI_IO_PROTOCOL instance. @param Attributes The mask of attributes to set for the resource range specified by - BarIndex, Offset, and Length. + BarIndex, Offset, and Length. @param BarIndex The BAR index of the standard PCI Configuration header to use as the base address for resource range. The legal range for this field is 0..5. @param Offset A pointer to the BAR relative base address of the resource range to be - modified by the attributes specified by Attributes. + modified by the attributes specified by Attributes. @param Length A pointer to the length of the resource range to be modified by the - attributes specified by Attributes. - - @retval EFI_SUCCESS The set of attributes specified by Attributes for the resource - range specified by BarIndex, Offset, and Length were + attributes specified by Attributes. + + @retval EFI_SUCCESS The set of attributes specified by Attributes for the resource + range specified by BarIndex, Offset, and Length were set on the PCI controller, and the actual resource range is returned - in Offset and Length. + in Offset and Length. @retval EFI_INVALID_PARAMETER Offset or Length is NULL. @retval EFI_UNSUPPORTED BarIndex not valid for this PCI controller. @retval EFI_OUT_OF_RESOURCES There are not enough resources to set the attributes on the - resource range specified by BarIndex, Offset, and - Length. - + resource range specified by BarIndex, Offset, and + Length. + **/ typedef EFI_STATUS @@ -513,11 +513,11 @@ EFI_STATUS ); /// -/// The EFI_PCI_IO_PROTOCOL provides the basic Memory, I/O, PCI configuration, -/// and DMA interfaces used to abstract accesses to PCI controllers. -/// There is one EFI_PCI_IO_PROTOCOL instance for each PCI controller on a PCI bus. -/// A device driver that wishes to manage a PCI controller in a system will have to -/// retrieve the EFI_PCI_IO_PROTOCOL instance that is associated with the PCI controller. +/// The EFI_PCI_IO_PROTOCOL provides the basic Memory, I/O, PCI configuration, +/// and DMA interfaces used to abstract accesses to PCI controllers. +/// There is one EFI_PCI_IO_PROTOCOL instance for each PCI controller on a PCI bus. +/// A device driver that wishes to manage a PCI controller in a system will have to +/// retrieve the EFI_PCI_IO_PROTOCOL instance that is associated with the PCI controller. /// struct _EFI_PCI_IO_PROTOCOL { EFI_PCI_IO_PROTOCOL_POLL_IO_MEM PollMem; @@ -535,20 +535,20 @@ struct _EFI_PCI_IO_PROTOCOL { EFI_PCI_IO_PROTOCOL_ATTRIBUTES Attributes; EFI_PCI_IO_PROTOCOL_GET_BAR_ATTRIBUTES GetBarAttributes; EFI_PCI_IO_PROTOCOL_SET_BAR_ATTRIBUTES SetBarAttributes; - + /// /// The size, in bytes, of the ROM image. /// UINT64 RomSize; /// - /// A pointer to the in memory copy of the ROM image. The PCI Bus Driver is responsible - /// for allocating memory for the ROM image, and copying the contents of the ROM to memory. - /// The contents of this buffer are either from the PCI option ROM that can be accessed - /// through the ROM BAR of the PCI controller, or it is from a platform-specific location. - /// The Attributes() function can be used to determine from which of these two sources + /// A pointer to the in memory copy of the ROM image. The PCI Bus Driver is responsible + /// for allocating memory for the ROM image, and copying the contents of the ROM to memory. + /// The contents of this buffer are either from the PCI option ROM that can be accessed + /// through the ROM BAR of the PCI controller, or it is from a platform-specific location. + /// The Attributes() function can be used to determine from which of these two sources /// the RomImage buffer was initialized. - /// + /// VOID *RomImage; }; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciPlatform.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciPlatform.h index 056f92b1ef..313cf0bc4f 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciPlatform.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciPlatform.h @@ -1,20 +1,20 @@ /** @file - This file declares PlatfromOpRom protocols that provide the interface between - the PCI bus driver/PCI Host Bridge Resource Allocation driver and a platform-specific - driver to describe the unique features of a platform. + This file declares PlatfromOpRom protocols that provide the interface between + the PCI bus driver/PCI Host Bridge Resource Allocation driver and a platform-specific + driver to describe the unique features of a platform. This protocol is optional. - + Copyright (c) 2007 - 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +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. @par Revision Reference: - This Protocol is defined in UEFI Platform Initialization Specification 1.2 + This Protocol is defined in UEFI Platform Initialization Specification 1.2 Volume 5: Standards **/ @@ -320,16 +320,16 @@ EFI_STATUS /// struct _EFI_PCI_PLATFORM_PROTOCOL { /// - /// The notification from the PCI bus enumerator to the platform that it is about to + /// The notification from the PCI bus enumerator to the platform that it is about to /// enter a certain phase during the enumeration process. /// EFI_PCI_PLATFORM_PHASE_NOTIFY PlatformNotify; /// - /// The notification from the PCI bus enumerator to the platform for each PCI + /// The notification from the PCI bus enumerator to the platform for each PCI /// controller at several predefined points during PCI controller initialization. - /// + /// EFI_PCI_PLATFORM_PREPROCESS_CONTROLLER PlatformPrepController; - /// + /// /// Retrieves the platform policy regarding enumeration. /// EFI_PCI_PLATFORM_GET_PLATFORM_POLICY GetPlatformPolicy; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciRootBridgeIo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciRootBridgeIo.h index 11ea71033f..93d9633a98 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciRootBridgeIo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PciRootBridgeIo.h @@ -1,18 +1,18 @@ /** @file PCI Root Bridge I/O protocol as defined in the UEFI 2.0 specification. - PCI Root Bridge I/O protocol is used by PCI Bus Driver to perform PCI Memory, PCI I/O, - and PCI Configuration cycles on a PCI Root Bridge. It also provides services to perform + PCI Root Bridge I/O protocol is used by PCI Bus Driver to perform PCI Memory, PCI I/O, + and PCI Configuration cycles on a PCI Root Bridge. It also provides services to perform defferent types of bus mastering DMA. Copyright (c) 2006 - 2017, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -122,23 +122,23 @@ typedef struct { UINT32 ExtendedRegister; } EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS; -/** +/** Reads from the I/O space of a PCI Root Bridge. Returns when either the polling exit criteria is satisfied or after a defined duration. - + @param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL. @param Width Signifies the width of the memory or I/O operations. - @param Address The base address of the memory or I/O operations. + @param Address The base address of the memory or I/O operations. @param Mask Mask used for the polling criteria. @param Value The comparison value used for the polling exit criteria. @param Delay The number of 100 ns units to poll. @param Result Pointer to the last value read from the memory location. - + @retval EFI_SUCCESS The last data returned from the access matched the poll exit criteria. @retval EFI_TIMEOUT Delay expired before a match occurred. @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - + **/ typedef EFI_STATUS @@ -152,20 +152,20 @@ EFI_STATUS OUT UINT64 *Result ); -/** +/** Enables a PCI driver to access PCI controller registers in the PCI root bridge memory space. - + @param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL. @param Width Signifies the width of the memory operations. - @param Address The base address of the memory operations. + @param Address The base address of the memory operations. @param Count The number of memory operations to perform. @param Buffer For read operations, the destination buffer to store the results. For write - operations, the source buffer to write data from. - - @retval EFI_SUCCESS The data was read from or written to the PCI root bridge. + operations, the source buffer to write data from. + + @retval EFI_SUCCESS The data was read from or written to the PCI root bridge. @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - + **/ typedef EFI_STATUS @@ -188,20 +188,20 @@ typedef struct { EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_IO_MEM Write; } EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ACCESS; -/** +/** Enables a PCI driver to copy one region of PCI root bridge memory space to another region of PCI - root bridge memory space. - + root bridge memory space. + @param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL instance. @param Width Signifies the width of the memory operations. - @param DestAddress The destination address of the memory operation. - @param SrcAddress The source address of the memory operation. - @param Count The number of memory operations to perform. - - @retval EFI_SUCCESS The data was copied from one memory region to another memory region. + @param DestAddress The destination address of the memory operation. + @param SrcAddress The source address of the memory operation. + @param Count The number of memory operations to perform. + + @retval EFI_SUCCESS The data was copied from one memory region to another memory region. @retval EFI_INVALID_PARAMETER Width is invalid for this PCI root bridge. @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. - + **/ typedef EFI_STATUS @@ -213,25 +213,25 @@ EFI_STATUS IN UINTN Count ); -/** +/** Provides the PCI controller-specific addresses required to access system memory from a - DMA bus master. - + DMA bus master. + @param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL. @param Operation Indicates if the bus master is going to read or write to system memory. @param HostAddress The system memory address to map to the PCI controller. @param NumberOfBytes On input the number of bytes to map. On output the number of bytes - that were mapped. + that were mapped. @param DeviceAddress The resulting map address for the bus master PCI controller to use to - access the hosts HostAddress. + access the hosts HostAddress. @param Mapping A resulting value to pass to Unmap(). - + @retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes. - @retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer. + @retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer. @retval EFI_INVALID_PARAMETER One or more parameters are invalid. @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. @retval EFI_DEVICE_ERROR The system hardware could not map the requested address. - + **/ typedef EFI_STATUS @@ -244,16 +244,16 @@ EFI_STATUS OUT VOID **Mapping ); -/** +/** Completes the Map() operation and releases any corresponding resources. - + @param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL. @param Mapping The mapping value returned from Map(). - + @retval EFI_SUCCESS The range was unmapped. @retval EFI_INVALID_PARAMETER Mapping is not a value that was returned by Map(). @retval EFI_DEVICE_ERROR The data was not committed to the target system memory. - + **/ typedef EFI_STATUS @@ -262,25 +262,25 @@ EFI_STATUS IN VOID *Mapping ); -/** +/** Allocates pages that are suitable for an EfiPciOperationBusMasterCommonBuffer or - EfiPciOperationBusMasterCommonBuffer64 mapping. - + EfiPciOperationBusMasterCommonBuffer64 mapping. + @param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL. @param Type This parameter is not used and must be ignored. @param MemoryType The type of memory to allocate, EfiBootServicesData or - EfiRuntimeServicesData. - @param Pages The number of pages to allocate. + EfiRuntimeServicesData. + @param Pages The number of pages to allocate. @param HostAddress A pointer to store the base system memory address of the - allocated range. + allocated range. @param Attributes The requested bit mask of attributes for the allocated range. - + @retval EFI_SUCCESS The requested memory pages were allocated. @retval EFI_UNSUPPORTED Attributes is unsupported. The only legal attribute bits are - MEMORY_WRITE_COMBINE and MEMORY_CACHED. + MEMORY_WRITE_COMBINE and MEMORY_CACHED. @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated. - + @retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated. + **/ typedef EFI_STATUS @@ -293,17 +293,17 @@ EFI_STATUS IN UINT64 Attributes ); -/** +/** Frees memory that was allocated with AllocateBuffer(). - + @param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL. - @param Pages The number of pages to free. - @param HostAddress The base system memory address of the allocated range. - + @param Pages The number of pages to free. + @param HostAddress The base system memory address of the allocated range. + @retval EFI_SUCCESS The requested memory pages were freed. @retval EFI_INVALID_PARAMETER The memory range specified by HostAddress and Pages was not allocated with AllocateBuffer(). - + **/ typedef EFI_STATUS @@ -313,16 +313,16 @@ EFI_STATUS IN VOID *HostAddress ); -/** +/** Flushes all PCI posted write transactions from a PCI host bridge to system memory. - + @param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL. - + @retval EFI_SUCCESS The PCI posted write transactions were flushed from the PCI host - bridge to system memory. + bridge to system memory. @retval EFI_DEVICE_ERROR The PCI posted write transactions were not flushed from the PCI - host bridge due to a hardware error. - + host bridge due to a hardware error. + **/ typedef EFI_STATUS @@ -330,23 +330,23 @@ EFI_STATUS IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *This ); -/** +/** Gets the attributes that a PCI root bridge supports setting with SetAttributes(), and the - attributes that a PCI root bridge is currently using. - + attributes that a PCI root bridge is currently using. + @param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL. @param Supports A pointer to the mask of attributes that this PCI root bridge supports - setting with SetAttributes(). + setting with SetAttributes(). @param Attributes A pointer to the mask of attributes that this PCI root bridge is currently - using. - - @retval EFI_SUCCESS If Supports is not NULL, then the attributes that the PCI root - bridge supports is returned in Supports. If Attributes is + using. + + @retval EFI_SUCCESS If Supports is not NULL, then the attributes that the PCI root + bridge supports is returned in Supports. If Attributes is not NULL, then the attributes that the PCI root bridge is currently - using is returned in Attributes. + using is returned in Attributes. @retval EFI_INVALID_PARAMETER Both Supports and Attributes are NULL. - - + + **/ typedef EFI_STATUS @@ -356,26 +356,26 @@ EFI_STATUS OUT UINT64 *Attributes ); -/** +/** Sets attributes for a resource range on a PCI root bridge. - + @param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL. @param Attributes The mask of attributes to set. @param ResourceBase A pointer to the base address of the resource range to be modified by the attributes specified by Attributes. @param ResourceLength A pointer to the length of the resource range to be modified by the - attributes specified by Attributes. - - @retval EFI_SUCCESS The set of attributes specified by Attributes for the resource - range specified by ResourceBase and ResourceLength + attributes specified by Attributes. + + @retval EFI_SUCCESS The set of attributes specified by Attributes for the resource + range specified by ResourceBase and ResourceLength were set on the PCI root bridge, and the actual resource range is - returned in ResuourceBase and ResourceLength. + returned in ResuourceBase and ResourceLength. @retval EFI_UNSUPPORTED A bit is set in Attributes that is not supported by the PCI Root - Bridge. - @retval EFI_OUT_OF_RESOURCES There are not enough resources to set the attributes on the - resource range specified by BaseAddress and Length. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - + Bridge. + @retval EFI_OUT_OF_RESOURCES There are not enough resources to set the attributes on the + resource range specified by BaseAddress and Length. + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + **/ typedef EFI_STATUS @@ -386,10 +386,10 @@ EFI_STATUS IN OUT UINT64 *ResourceLength ); -/** +/** Retrieves the current resource settings of this PCI root bridge in the form of a set of ACPI resource descriptors. - + @param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL. @param Resources A pointer to the resource descriptors that describe the current configuration of this PCI root bridge. @@ -408,8 +408,8 @@ EFI_STATUS ); /// -/// Provides the basic Memory, I/O, PCI configuration, and DMA interfaces that are -/// used to abstract accesses to PCI controllers behind a PCI Root Bridge Controller. +/// Provides the basic Memory, I/O, PCI configuration, and DMA interfaces that are +/// used to abstract accesses to PCI controllers behind a PCI Root Bridge Controller. /// struct _EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL { /// @@ -430,7 +430,7 @@ struct _EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL { EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GET_ATTRIBUTES GetAttributes; EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_SET_ATTRIBUTES SetAttributes; EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_CONFIGURATION Configuration; - + /// /// The segment number that this PCI root bridge resides. /// diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PlatformDriverOverride.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PlatformDriverOverride.h index c84d12d1f0..40807026da 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PlatformDriverOverride.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PlatformDriverOverride.h @@ -2,13 +2,13 @@ Platform Driver Override protocol as defined in the UEFI 2.1 specification. Copyright (c) 2006 - 2011, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -29,24 +29,24 @@ typedef struct _EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL EFI_PLATFORM_DRIVER_OVERR // Prototypes for the Platform Driver Override Protocol // -/** +/** Retrieves the image handle of the platform override driver for a controller in the system. - + @param This A pointer to the EFI_PLATFORM_DRIVER_OVERRIDE_ - PROTOCOL instance. + PROTOCOL instance. @param ControllerHandle The device handle of the controller to check if a driver override - exists. + exists. @param DriverImageHandle On input, a pointer to the previous driver image handle returned - by GetDriver(). On output, a pointer to the next driver - image handle. - + by GetDriver(). On output, a pointer to the next driver + image handle. + @retval EFI_SUCCESS The driver override for ControllerHandle was returned in - DriverImageHandle. + DriverImageHandle. @retval EFI_NOT_FOUND A driver override for ControllerHandle was not found. @retval EFI_INVALID_PARAMETER The handle specified by ControllerHandle is NULL. @retval EFI_INVALID_PARAMETER DriverImageHandle is not a handle that was returned on a - previous call to GetDriver(). - + previous call to GetDriver(). + **/ typedef EFI_STATUS @@ -56,25 +56,25 @@ EFI_STATUS IN OUT EFI_HANDLE *DriverImageHandle ); -/** +/** Retrieves the device path of the platform override driver for a controller in the system. - + @param This A pointer to the EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL instance. @param ControllerHandle The device handle of the controller to check if a driver override - exists. + exists. @param DriverImagePath On input, a pointer to the previous driver device path returned by GetDriverPath(). On output, a pointer to the next driver device path. Passing in a pointer to NULL will return the first driver device path for ControllerHandle. - + @retval EFI_SUCCESS The driver override for ControllerHandle was returned in - DriverImageHandle. - @retval EFI_UNSUPPORTED The operation is not supported. + DriverImageHandle. + @retval EFI_UNSUPPORTED The operation is not supported. @retval EFI_NOT_FOUND A driver override for ControllerHandle was not found. @retval EFI_INVALID_PARAMETER The handle specified by ControllerHandle is NULL. @retval EFI_INVALID_PARAMETER DriverImagePath is not a device path that was returned on a - previous call to GetDriverPath(). - + previous call to GetDriverPath(). + **/ typedef EFI_STATUS @@ -84,31 +84,31 @@ EFI_STATUS IN OUT EFI_DEVICE_PATH_PROTOCOL **DriverImagePath ); -/** +/** Used to associate a driver image handle with a device path that was returned on a prior call to the - GetDriverPath() service. This driver image handle will then be available through the - GetDriver() service. - + GetDriverPath() service. This driver image handle will then be available through the + GetDriver() service. + @param This A pointer to the EFI_PLATFORM_DRIVER_OVERRIDE_ - PROTOCOL instance. - @param ControllerHandle The device handle of the controller. + PROTOCOL instance. + @param ControllerHandle The device handle of the controller. @param DriverImagePath A pointer to the driver device path that was returned in a prior - call to GetDriverPath(). + call to GetDriverPath(). @param DriverImageHandle The driver image handle that was returned by LoadImage() - when the driver specified by DriverImagePath was loaded - into memory. - - @retval EFI_SUCCESS The association between DriverImagePath and + when the driver specified by DriverImagePath was loaded + into memory. + + @retval EFI_SUCCESS The association between DriverImagePath and DriverImageHandle was established for the controller specified - by ControllerHandle. - @retval EFI_UNSUPPORTED The operation is not supported. + by ControllerHandle. + @retval EFI_UNSUPPORTED The operation is not supported. @retval EFI_NOT_FOUND DriverImagePath is not a device path that was returned on a prior - call to GetDriverPath() for the controller specified by - ControllerHandle. + call to GetDriverPath() for the controller specified by + ControllerHandle. @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. @retval EFI_INVALID_PARAMETER DriverImagePath is not a valid device path. @retval EFI_INVALID_PARAMETER DriverImageHandle is not a valid image handle. - + **/ typedef EFI_STATUS @@ -120,13 +120,13 @@ EFI_STATUS ); /// -/// This protocol matches one or more drivers to a controller. A platform driver -/// produces this protocol, and it is installed on a separate handle. This protocol -/// is used by the ConnectController() boot service to select the best driver -/// for a controller. All of the drivers returned by this protocol have a higher -/// precedence than drivers found from an EFI Bus Specific Driver Override Protocol -/// or drivers found from the general UEFI driver Binding search algorithm. If more -/// than one driver is returned by this protocol, then the drivers are returned in +/// This protocol matches one or more drivers to a controller. A platform driver +/// produces this protocol, and it is installed on a separate handle. This protocol +/// is used by the ConnectController() boot service to select the best driver +/// for a controller. All of the drivers returned by this protocol have a higher +/// precedence than drivers found from an EFI Bus Specific Driver Override Protocol +/// or drivers found from the general UEFI driver Binding search algorithm. If more +/// than one driver is returned by this protocol, then the drivers are returned in /// order from highest precedence to lowest precedence. /// struct _EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h index 8343cb8bea..f21e1bed99 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h @@ -1,18 +1,18 @@ /** @file UEFI Platform to Driver Configuration Protocol is defined in UEFI specification. - - This is a protocol that is optionally produced by the platform and optionally consumed - by a UEFI Driver in its Start() function. This protocol allows the driver to receive + + This is a protocol that is optionally produced by the platform and optionally consumed + by a UEFI Driver in its Start() function. This protocol allows the driver to receive configuration information as part of being started. Copyright (c) 2006 - 2016, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -58,10 +58,10 @@ typedef struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL EFI_PLATFORM_TO_DR increment the Instance value by one for each successive call to Query. @param This A pointer to the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL instance. - + @param ControllerHandle The handle the platform will return configuration information about. - + @param ChildHandle The handle of the child controller to return information on. This is an optional parameter that may be NULL. It will be @@ -70,8 +70,8 @@ typedef struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL EFI_PLATFORM_TO_DR the bus controller. It will not be NULL for a bus driver that attempts to get options for one of its child controllers. - - + + @param Instance Pointer to the Instance value. Zero means return the first query data. The caller should increment this value by one each time to retrieve @@ -148,26 +148,26 @@ typedef enum { /// configuration settings. /// EfiPlatformConfigurationActionNone = 0, - + /// /// The driver has detected that the controller specified - /// by ControllerHandle is not in a usable state and + /// by ControllerHandle is not in a usable state and /// needs to be stopped. The calling agent can use the /// DisconnectControservice to perform this operation, and - /// it should be performed as soon as possible. + /// it should be performed as soon as possible. /// EfiPlatformConfigurationActionStopController = 1, - + /// /// This controller specified by ControllerHandle needs to /// be stopped and restarted before it can be used again. /// The calling agent can use the DisconnectController() /// and ConnectController() services to perform this /// operation. The restart operation can be delayed until - /// all of the configuration options have been set. + /// all of the configuration options have been set. /// EfiPlatformConfigurationActionRestartController = 2, - + /// /// A configuration change has been made that requires the /// platform to be restarted before the controller @@ -175,7 +175,7 @@ typedef enum { /// calling agent can use the ResetSystem() services to /// perform this operation. The restart operation can be /// delayed until all of the configuration options have - /// been set. + /// been set. /// EfiPlatformConfigurationActionRestartPlatform = 3, @@ -188,8 +188,8 @@ typedef enum { /// are required before this controller can be used again /// with the updated configuration settings, but these /// configuration settings are not guaranteed to persist - /// after ControllerHandle is stopped. - /// + /// after ControllerHandle is stopped. + /// EfiPlatformConfigurationActionNvramFailed = 4, /// @@ -249,17 +249,17 @@ typedef enum { @param ConfigurationAction The driver tells the platform what action is required for ParameterBlock to take effect. - - + + @retval EFI_SUCCESS The platform return parameter information for ControllerHandle. - + @retval EFI_NOT_FOUND Instance was not found. - + @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. - + @retval EFI_INVALID_PARAMETER Instance is zero. - + **/ typedef EFI_STATUS @@ -298,7 +298,7 @@ struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL { {0x345ecc0e, 0xcb6, 0x4b75, { 0xbb, 0x57, 0x1b, 0x12, 0x9c, 0x47, 0x33,0x3e } } /** - + ParameterTypeGuid provides the support for parameters communicated through the DMTF SM CLP Specification 1.0 Final Standard to be used to configure the UEFI driver. In this @@ -311,8 +311,8 @@ struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL { **/ typedef struct { CHAR8 *CLPCommand; ///< A pointer to the null-terminated UTF-8 string that specifies the DMTF SM CLP command - ///< line that the driver is required to parse and process when this function is called. - ///< See the DMTF SM CLP Specification 1.0 Final Standard for details on the + ///< line that the driver is required to parse and process when this function is called. + ///< See the DMTF SM CLP Specification 1.0 Final Standard for details on the ///< format and syntax of the CLP command line string. CLPCommand buffer ///< is allocated by the producer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOOL. UINT32 CLPCommandLength; ///< The length of the CLP Command in bytes. @@ -329,20 +329,20 @@ typedef struct { ///< the SM CLP Coutput option requested by the caller is not supported by the ///< UEFI Driver). CLPReturnString buffer is allocated by the consumer of the ///< EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL and undefined prior to the call to - ///< Response(). + ///< Response(). UINT32 CLPReturnStringLength; ///< The length of the CLP return status string in bytes. UINT8 CLPCmdStatus; ///< SM CLP Command Status (see DMTF SM CLP Specification 1.0 Final Standard - ///< Table 4) CLPErrorValue SM CLP Processing Error Value (see DMTF SM ///< CLP Specification 1.0 Final Standard - Table 6). This field is filled in by - ///< the consumer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC - ///< OL and undefined prior to the call to Response(). + ///< the consumer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC + ///< OL and undefined prior to the call to Response(). UINT8 CLPErrorValue; ///< SM CLP Processing Error Value (see DMTF SM CLP Specification 1.0 Final Standard - Table 6). - ///< This field is filled in by the consumer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL and undefined prior to the call to Response(). + ///< This field is filled in by the consumer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL and undefined prior to the call to Response(). UINT16 CLPMsgCode; ///< Bit 15: OEM Message Code Flag 0 = Message Code is an SM CLP Probable ///< Cause Value. (see SM CLP Specification Table 11) 1 = Message Code is OEM ///< Specific Bits 14-0: Message Code This field is filled in by the consumer of ///< the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL and undefined prior to the call to - ///< Response(). + ///< Response(). } EFI_CONFIGURE_CLP_PARAMETER_BLK; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PxeBaseCode.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PxeBaseCode.h index 497d972047..1b91465d23 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PxeBaseCode.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PxeBaseCode.h @@ -1,18 +1,18 @@ /** @file - EFI PXE Base Code Protocol definitions, which is used to access PXE-compatible + EFI PXE Base Code Protocol definitions, which is used to access PXE-compatible devices for network access and network booting. 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +http://opensource.org/licenses/bsd-license.php. - @par Revision Reference: - This Protocol is introduced in EFI Specification 1.10. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + + @par Revision Reference: + This Protocol is introduced in EFI Specification 1.10. **/ #ifndef __PXE_BASE_CODE_PROTOCOL_H__ @@ -30,7 +30,7 @@ typedef struct _EFI_PXE_BASE_CODE_PROTOCOL EFI_PXE_BASE_CODE_PROTOCOL; /// /// Protocol defined in EFI1.1. -/// +/// typedef EFI_PXE_BASE_CODE_PROTOCOL EFI_PXE_BASE_CODE; /// @@ -146,14 +146,14 @@ typedef UINT16 EFI_PXE_BASE_CODE_UDP_PORT; #define EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL 0x0000 // -// PXE Tag definition that identifies the processor +// PXE Tag definition that identifies the processor // and programming environment of the client system. // These identifiers are defined by IETF: // http://www.ietf.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xml // #if defined (MDE_CPU_IA32) #define EFI_PXE_CLIENT_SYSTEM_ARCHITECTURE 0x0006 -#elif defined (MDE_CPU_IPF) +#elif defined (MDE_CPU_IPF) #define EFI_PXE_CLIENT_SYSTEM_ARCHITECTURE 0x0002 #elif defined (MDE_CPU_X64) #define EFI_PXE_CLIENT_SYSTEM_ARCHITECTURE 0x0007 @@ -263,7 +263,7 @@ typedef union { /// /// EFI_PXE_BASE_CODE_MODE. -/// The data values in this structure are read-only and +/// The data values in this structure are read-only and /// are updated by the code that produces the /// EFI_PXE_BASE_CODE_PROTOCOL functions. /// @@ -308,7 +308,7 @@ typedef struct { // PXE Base Code Interface Function definitions // -/** +/** Enables the use of the PXE Base Code Protocol functions. This function enables the use of the PXE Base Code Protocol functions. If the @@ -355,22 +355,22 @@ typedef struct { TftpErrorZero-filled. MakeCallbacksSet to TRUE if the PXE Base Code Callback Protocol is available. Set to FALSE if the PXE Base Code Callback Protocol is not available. - + @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance. @param UseIpv6 Specifies the type of IP addresses that are to be used during the session - that is being started. Set to TRUE for IPv6 addresses, and FALSE for - IPv4 addresses. - + that is being started. Set to TRUE for IPv6 addresses, and FALSE for + IPv4 addresses. + @retval EFI_SUCCESS The PXE Base Code Protocol was started. - @retval EFI_DEVICE_ERROR The network device encountered an error during this oper + @retval EFI_DEVICE_ERROR The network device encountered an error during this oper @retval EFI_UNSUPPORTED UseIpv6 is TRUE, but the Ipv6Supported field of the - EFI_PXE_BASE_CODE_MODE structure is FALSE. - @retval EFI_ALREADY_STARTED The PXE Base Code Protocol is already in the started state. + EFI_PXE_BASE_CODE_MODE structure is FALSE. + @retval EFI_ALREADY_STARTED The PXE Base Code Protocol is already in the started state. @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid - EFI_PXE_BASE_CODE_PROTOCOL structure. - @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory or other resources to start the - PXE Base Code Protocol. - + EFI_PXE_BASE_CODE_PROTOCOL structure. + @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory or other resources to start the + PXE Base Code Protocol. + **/ typedef EFI_STATUS @@ -379,22 +379,22 @@ EFI_STATUS IN BOOLEAN UseIpv6 ); -/** +/** Disables the use of the PXE Base Code Protocol functions. This function stops all activity on the network device. All the resources allocated in Start() are released, the Started field of the EFI_PXE_BASE_CODE_MODE structure is set to FALSE and EFI_SUCCESS is returned. If the Started field of the EFI_PXE_BASE_CODE_MODE structure is already FALSE, then EFI_NOT_STARTED will be returned. - + @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance. - + @retval EFI_SUCCESS The PXE Base Code Protocol was stopped. - @retval EFI_NOT_STARTED The PXE Base Code Protocol is already in the stopped state. + @retval EFI_NOT_STARTED The PXE Base Code Protocol is already in the stopped state. @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid - EFI_PXE_BASE_CODE_PROTOCOL structure. - @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. - + EFI_PXE_BASE_CODE_PROTOCOL structure. + @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. + **/ typedef EFI_STATUS @@ -402,7 +402,7 @@ EFI_STATUS IN EFI_PXE_BASE_CODE_PROTOCOL *This ); -/** +/** Attempts to complete a DHCPv4 D.O.R.A. (discover / offer / request / acknowledge) or DHCPv6 S.A.R.R (solicit / advertise / request / reply) sequence. @@ -418,22 +418,22 @@ EFI_STATUS caller. If the DHCP sequence does not complete, then EFI_TIMEOUT will be returned. If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then the DHCP sequence will be stopped and EFI_ABORTED will be returned. - + @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance. @param SortOffers TRUE if the offers received should be sorted. Set to FALSE to try the - offers in the order that they are received. - + offers in the order that they are received. + @retval EFI_SUCCESS Valid DHCP has completed. @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state. @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid - EFI_PXE_BASE_CODE_PROTOCOL structure. - @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. + EFI_PXE_BASE_CODE_PROTOCOL structure. + @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete the DHCP Protocol. @retval EFI_ABORTED The callback function aborted the DHCP Protocol. @retval EFI_TIMEOUT The DHCP Protocol timed out. @retval EFI_ICMP_ERROR An ICMP error packet was received during the DHCP session. @retval EFI_NO_RESPONSE Valid PXE offer was not received. - + **/ typedef EFI_STATUS @@ -442,7 +442,7 @@ EFI_STATUS IN BOOLEAN SortOffers ); -/** +/** Attempts to complete the PXE Boot Server and/or boot image discovery sequence. This function attempts to complete the PXE Boot Server and/or boot image discovery @@ -464,26 +464,26 @@ EFI_STATUS additional details on the implementation of the Discovery sequence. If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then the Discovery sequence is stopped and EFI_ABORTED will be returned. - + @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance. @param Type The type of bootstrap to perform. @param Layer The pointer to the boot server layer number to discover, which must be - PXE_BOOT_LAYER_INITIAL when a new server type is being - discovered. - @param UseBis TRUE if Boot Integrity Services are to be used. FALSE otherwise. + PXE_BOOT_LAYER_INITIAL when a new server type is being + discovered. + @param UseBis TRUE if Boot Integrity Services are to be used. FALSE otherwise. @param Info The pointer to a data structure that contains additional information on the - type of discovery operation that is to be performed. - + type of discovery operation that is to be performed. + @retval EFI_SUCCESS The Discovery sequence has been completed. @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete Discovery. @retval EFI_ABORTED The callback function aborted the Discovery sequence. @retval EFI_TIMEOUT The Discovery sequence timed out. @retval EFI_ICMP_ERROR An ICMP error packet was received during the PXE discovery - session. - + session. + **/ typedef EFI_STATUS @@ -495,7 +495,7 @@ EFI_STATUS IN EFI_PXE_BASE_CODE_DISCOVER_INFO *Info OPTIONAL ); -/** +/** Used to perform TFTP and MTFTP services. This function is used to perform TFTP and MTFTP services. This includes the @@ -540,31 +540,31 @@ EFI_STATUS IP address preceding the filename of the form %d.%d.%d.%d for IP v4. The final entry is itself null-terminated, so that the final information string is terminated with two null octets. - + @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance. @param Operation The type of operation to perform. - @param BufferPtr A pointer to the data buffer. + @param BufferPtr A pointer to the data buffer. @param Overwrite Only used on write file operations. TRUE if a file on a remote server can - be overwritten. + be overwritten. @param BufferSize For get-file-size operations, *BufferSize returns the size of the - requested file. + requested file. @param BlockSize The requested block size to be used during a TFTP transfer. @param ServerIp The TFTP / MTFTP server IP address. @param Filename A Null-terminated ASCII string that specifies a directory name or a file - name. + name. @param Info The pointer to the MTFTP information. - @param DontUseBuffer Set to FALSE for normal TFTP and MTFTP read file operation. - + @param DontUseBuffer Set to FALSE for normal TFTP and MTFTP read file operation. + @retval EFI_SUCCESS The TFTP/MTFTP operation was completed. @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. - @retval EFI_BUFFER_TOO_SMALL The buffer is not large enough to complete the read operation. + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. + @retval EFI_BUFFER_TOO_SMALL The buffer is not large enough to complete the read operation. @retval EFI_ABORTED The callback function aborted the TFTP/MTFTP operation. @retval EFI_TIMEOUT The TFTP/MTFTP operation timed out. @retval EFI_ICMP_ERROR An ICMP error packet was received during the MTFTP session. @retval EFI_TFTP_ERROR A TFTP error packet was received during the MTFTP session. - + **/ typedef EFI_STATUS @@ -581,7 +581,7 @@ EFI_STATUS IN BOOLEAN DontUseBuffer ); -/** +/** Writes a UDP packet to the network interface. This function writes a UDP packet specified by the (optional HeaderPtr and) @@ -594,29 +594,29 @@ EFI_STATUS the IcmpErrorReceived field is set to TRUE, the IcmpError field is filled in and EFI_ICMP_ERROR will be returned. If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will be returned. - + @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance. - @param OpFlags The UDP operation flags. + @param OpFlags The UDP operation flags. @param DestIp The destination IP address. - @param DestPort The destination UDP port number. - @param GatewayIp The gateway IP address. + @param DestPort The destination UDP port number. + @param GatewayIp The gateway IP address. @param SrcIp The source IP address. @param SrcPort The source UDP port number. @param HeaderSize An optional field which may be set to the length of a header at - HeaderPtr to be prefixed to the data at BufferPtr. + HeaderPtr to be prefixed to the data at BufferPtr. @param HeaderPtr If HeaderSize is not NULL, a pointer to a header to be prefixed to the - data at BufferPtr. + data at BufferPtr. @param BufferSize A pointer to the size of the data at BufferPtr. @param BufferPtr A pointer to the data to be written. - + @retval EFI_SUCCESS The UDP Write operation was completed. @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_BAD_BUFFER_SIZE The buffer is too long to be transmitted. + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + @retval EFI_BAD_BUFFER_SIZE The buffer is too long to be transmitted. @retval EFI_ABORTED The callback function aborted the UDP Write operation. @retval EFI_TIMEOUT The UDP Write operation timed out. - @retval EFI_ICMP_ERROR An ICMP error packet was received during the UDP write session. - + @retval EFI_ICMP_ERROR An ICMP error packet was received during the UDP write session. + **/ typedef EFI_STATUS @@ -634,7 +634,7 @@ EFI_STATUS IN VOID *BufferPtr ); -/** +/** Reads a UDP packet from the network interface. This function reads a UDP packet from a network interface. The data contents @@ -649,28 +649,28 @@ EFI_STATUS Depending on the values of OpFlags and the DestIp, DestPort, SrcIp, and SrcPort input values, different types of UDP packet receive filtering will be performed. The following tables summarize these receive filter operations. - + @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance. - @param OpFlags The UDP operation flags. + @param OpFlags The UDP operation flags. @param DestIp The destination IP address. @param DestPort The destination UDP port number. @param SrcIp The source IP address. @param SrcPort The source UDP port number. @param HeaderSize An optional field which may be set to the length of a header at - HeaderPtr to be prefixed to the data at BufferPtr. + HeaderPtr to be prefixed to the data at BufferPtr. @param HeaderPtr If HeaderSize is not NULL, a pointer to a header to be prefixed to the - data at BufferPtr. + data at BufferPtr. @param BufferSize A pointer to the size of the data at BufferPtr. @param BufferPtr A pointer to the data to be read. - + @retval EFI_SUCCESS The UDP Read operation was completed. @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. @retval EFI_BUFFER_TOO_SMALL The packet is larger than Buffer can hold. @retval EFI_ABORTED The callback function aborted the UDP Read operation. - @retval EFI_TIMEOUT The UDP Read operation timed out. - + @retval EFI_TIMEOUT The UDP Read operation timed out. + **/ typedef EFI_STATUS @@ -687,9 +687,9 @@ EFI_STATUS IN VOID *BufferPtr ); -/** +/** Updates the IP receive filters of a network device and enables software filtering. - + The NewFilter field is used to modify the network device's current IP receive filter settings and to enable a software filter. This function updates the IpFilter field of the EFI_PXE_BASE_CODE_MODE structure with the contents of NewIpFilter. @@ -710,14 +710,14 @@ EFI_STATUS The IPlist field is used to enable IPs other than the StationIP. They may be multicast or unicast. If IPcnt is set as well as EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP, then both the StationIP and the IPs from the IPlist will be used. - + @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance. @param NewFilter The pointer to the new set of IP receive filters. - + @retval EFI_SUCCESS The IP receive filter settings were updated. @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + **/ typedef EFI_STATUS @@ -726,9 +726,9 @@ EFI_STATUS IN EFI_PXE_BASE_CODE_IP_FILTER *NewFilter ); -/** +/** Uses the ARP protocol to resolve a MAC address. - + This function uses the ARP protocol to resolve a MAC address. The UsingIpv6 field of the EFI_PXE_BASE_CODE_MODE structure is used to determine if IPv4 or IPv6 addresses are being used. The IP address specified by IpAddr is used to resolve @@ -741,19 +741,19 @@ EFI_STATUS to resolve an address, then EFI_TIMEOUT is returned. If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED is returned. - + @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance. @param IpAddr The pointer to the IP address that is used to resolve a MAC address. @param MacAddr If not NULL, a pointer to the MAC address that was resolved with the - ARP protocol. - + ARP protocol. + @retval EFI_SUCCESS The IP or MAC address was resolved. @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. @retval EFI_ABORTED The callback function aborted the ARP Protocol. @retval EFI_TIMEOUT The ARP Protocol encountered a timeout condition. - + **/ typedef EFI_STATUS @@ -763,9 +763,9 @@ EFI_STATUS IN EFI_MAC_ADDRESS *MacAddr OPTIONAL ); -/** +/** Updates the parameters that affect the operation of the PXE Base Code Protocol. - + This function sets parameters that affect the operation of the PXE Base Code Protocol. The parameter specified by NewAutoArp is used to control the generation of ARP protocol packets. If NewAutoArp is TRUE, then ARP Protocol packets will be generated @@ -777,23 +777,23 @@ EFI_STATUS the EFI_PXE_BASE_CODE_MODE structure to NewAutoArp. The SetParameters() call must be invoked after a Callback Protocol is installed to enable the use of callbacks. - + @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance. @param NewAutoArp If not NULL, a pointer to a value that specifies whether to replace the - current value of AutoARP. + current value of AutoARP. @param NewSendGUID If not NULL, a pointer to a value that specifies whether to replace the - current value of SendGUID. + current value of SendGUID. @param NewTTL If not NULL, a pointer to be used in place of the current value of TTL, - the "time to live" field of the IP header. + the "time to live" field of the IP header. @param NewToS If not NULL, a pointer to be used in place of the current value of ToS, - the "type of service" field of the IP header. + the "type of service" field of the IP header. @param NewMakeCallback If not NULL, a pointer to a value that specifies whether to replace the - current value of the MakeCallback field of the Mode structure. - + current value of the MakeCallback field of the Mode structure. + @retval EFI_SUCCESS The new parameters values were updated. @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + **/ typedef EFI_STATUS @@ -806,9 +806,9 @@ EFI_STATUS IN BOOLEAN *NewMakeCallback OPTIONAL ); -/** +/** Updates the station IP address and/or subnet mask values of a network device. - + This function updates the station IP address and/or subnet mask values of a network device. The NewStationIp field is used to modify the network device's current IP address. @@ -819,15 +819,15 @@ EFI_STATUS mask. If NewSubnetMask is NULL, then the current subnet mask will not be modified. Otherwise, this function updates the SubnetMask field of the EFI_PXE_BASE_CODE_MODE structure with NewSubnetMask. - + @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance. - @param NewStationIp The pointer to the new IP address to be used by the network device. - @param NewSubnetMask The pointer to the new subnet mask to be used by the network device. - + @param NewStationIp The pointer to the new IP address to be used by the network device. + @param NewSubnetMask The pointer to the new subnet mask to be used by the network device. + @retval EFI_SUCCESS The new station IP address and/or subnet mask were updated. @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + **/ typedef EFI_STATUS @@ -837,36 +837,36 @@ EFI_STATUS IN EFI_IP_ADDRESS *NewSubnetMask OPTIONAL ); -/** +/** Updates the contents of the cached DHCP and Discover packets. - + The pointers to the new packets are used to update the contents of the cached packets in the EFI_PXE_BASE_CODE_MODE structure. - + @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance. @param NewDhcpDiscoverValid The pointer to a value that will replace the current - DhcpDiscoverValid field. + DhcpDiscoverValid field. @param NewDhcpAckReceived The pointer to a value that will replace the current - DhcpAckReceived field. + DhcpAckReceived field. @param NewProxyOfferReceived The pointer to a value that will replace the current - ProxyOfferReceived field. - @param NewPxeDiscoverValid The pointer to a value that will replace the current - ProxyOfferReceived field. + ProxyOfferReceived field. + @param NewPxeDiscoverValid The pointer to a value that will replace the current + ProxyOfferReceived field. @param NewPxeReplyReceived The pointer to a value that will replace the current - PxeReplyReceived field. + PxeReplyReceived field. @param NewPxeBisReplyReceived The pointer to a value that will replace the current - PxeBisReplyReceived field. - @param NewDhcpDiscover The pointer to the new cached DHCP Discover packet contents. + PxeBisReplyReceived field. + @param NewDhcpDiscover The pointer to the new cached DHCP Discover packet contents. @param NewDhcpAck The pointer to the new cached DHCP Ack packet contents. @param NewProxyOffer The pointer to the new cached Proxy Offer packet contents. @param NewPxeDiscover The pointer to the new cached PXE Discover packet contents. @param NewPxeReply The pointer to the new cached PXE Reply packet contents. @param NewPxeBisReply The pointer to the new cached PXE BIS Reply packet contents. - + @retval EFI_SUCCESS The cached packet contents were updated. @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state. @retval EFI_INVALID_PARAMETER This is NULL or not point to a valid EFI_PXE_BASE_CODE_PROTOCOL structure. - + **/ typedef EFI_STATUS @@ -893,7 +893,7 @@ EFI_STATUS // // Revision defined in EFI1.1 -// +// #define EFI_PXE_BASE_CODE_INTERFACE_REVISION EFI_PXE_BASE_CODE_PROTOCOL_REVISION /// @@ -906,8 +906,8 @@ EFI_STATUS /// struct _EFI_PXE_BASE_CODE_PROTOCOL { /// - /// The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must - /// be backwards compatible. If a future version is not backwards compatible + /// The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must + /// be backwards compatible. If a future version is not backwards compatible /// it is not the same GUID. /// UINT64 Revision; @@ -931,4 +931,4 @@ struct _EFI_PXE_BASE_CODE_PROTOCOL { extern EFI_GUID gEfiPxeBaseCodeProtocolGuid; -#endif +#endif diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h index f653fdf7ff..c796a9e3a7 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h @@ -1,17 +1,17 @@ /** @file - It is invoked when the PXE Base Code Protocol is about to transmit, has received, + It is invoked when the PXE Base Code Protocol is about to transmit, has received, or is waiting to receive a packet. 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +http://opensource.org/licenses/bsd-license.php. - @par Revision Reference: +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + + @par Revision Reference: This Protocol is introduced in EFI Specification 1.10 **/ @@ -45,7 +45,7 @@ typedef struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL EFI_PXE_BASE_CODE_CALLBACK_ /// /// EFI1.1 Protocol name. -/// +/// typedef EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL EFI_PXE_BASE_CODE_CALLBACK; /// @@ -73,10 +73,10 @@ typedef enum { EFI_PXE_BASE_CODE_CALLBACK_STATUS_LAST } EFI_PXE_BASE_CODE_CALLBACK_STATUS; -/** +/** Callback function that is invoked when the PXE Base Code Protocol is about to transmit, has - received, or is waiting to receive a packet. - + received, or is waiting to receive a packet. + This function is invoked when the PXE Base Code Protocol is about to transmit, has received, or is waiting to receive a packet. Parameters Function and Received specify the type of event. Parameters PacketLen and Packet specify the packet that generated the event. If these fields @@ -86,22 +86,22 @@ typedef enum { the polling nature of UEFI device drivers, a callback function should not execute for more than 5 ms. The SetParameters() function must be called after a Callback Protocol is installed to enable the use of callbacks. - + @param This The pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance. - @param Function The PXE Base Code Protocol function that is waiting for an event. + @param Function The PXE Base Code Protocol function that is waiting for an event. @param Received TRUE if the callback is being invoked due to a receive event. FALSE if - the callback is being invoked due to a transmit event. + the callback is being invoked due to a transmit event. @param PacketLen The length, in bytes, of Packet. This field will have a value of zero if - this is a wait for receive event. + this is a wait for receive event. @param Packet If Received is TRUE, a pointer to the packet that was just received; - otherwise a pointer to the packet that is about to be transmitted. - - @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE if Function specifies a continue operation + otherwise a pointer to the packet that is about to be transmitted. + + @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE if Function specifies a continue operation @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT if Function specifies an abort operation - + **/ -typedef -EFI_PXE_BASE_CODE_CALLBACK_STATUS +typedef +EFI_PXE_BASE_CODE_CALLBACK_STATUS (EFIAPI *EFI_PXE_CALLBACK)( IN EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL *This, IN EFI_PXE_BASE_CODE_FUNCTION Function, @@ -111,13 +111,13 @@ EFI_PXE_BASE_CODE_CALLBACK_STATUS ); /// -/// Protocol that is invoked when the PXE Base Code Protocol is about +/// Protocol that is invoked when the PXE Base Code Protocol is about /// to transmit, has received, or is waiting to receive a packet. /// struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL { /// - /// The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must - /// be backwards compatible. If a future version is not backwards compatible + /// The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must + /// be backwards compatible. If a future version is not backwards compatible /// it is not the same GUID. /// UINT64 Revision; @@ -126,5 +126,5 @@ struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL { extern EFI_GUID gEfiPxeBaseCodeCallbackProtocolGuid; -#endif +#endif diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/RealTimeClock.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/RealTimeClock.h index 7a70ae37a5..12ce8df18a 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/RealTimeClock.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/RealTimeClock.h @@ -5,20 +5,20 @@ Time and date related EFI runtime services. The GetTime (), SetTime (), GetWakeupTime (), and SetWakeupTime () UEFI 2.0 - services are added to the EFI system table and the - EFI_REAL_TIME_CLOCK_ARCH_PROTOCOL_GUID protocol is registered with a NULL + services are added to the EFI system table and the + EFI_REAL_TIME_CLOCK_ARCH_PROTOCOL_GUID protocol is registered with a NULL pointer. No CRC of the EFI system table is required, since that is done in the DXE core. Copyright (c) 2006 - 2009, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ReportStatusCodeHandler.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ReportStatusCodeHandler.h index 5926e551d8..678d9c3963 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ReportStatusCodeHandler.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ReportStatusCodeHandler.h @@ -1,7 +1,7 @@ /** @file - This protocol provide registering and unregistering services to status code + This protocol provide registering and unregistering services to status code consumers while in DXE. - + Copyright (c) 2007 - 2009, 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 @@ -33,7 +33,7 @@ EFI_STATUS /** Register the callback function for ReportStatusCode() notification. - + When this function is called the function pointer is added to an internal list and any future calls to ReportStatusCode() will be forwarded to the Callback function. During the bootservices, this is the callback for which this service can be invoked. The report status code router @@ -47,16 +47,16 @@ EFI_STATUS 2. not unregister at exit boot services so that the router will still have its callback address 3. the caller must be self-contained (eg. Not call out into any boot-service interfaces) and be runtime safe, in general. - + @param[in] Callback A pointer to a function of type EFI_RSC_HANDLER_CALLBACK that is called when a call to ReportStatusCode() occurs. - @param[in] Tpl TPL at which callback can be safely invoked. - + @param[in] Tpl TPL at which callback can be safely invoked. + @retval EFI_SUCCESS Function was successfully registered. @retval EFI_INVALID_PARAMETER The callback function was NULL. @retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be registered. - @retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again. + @retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again. **/ typedef EFI_STATUS @@ -67,16 +67,16 @@ EFI_STATUS /** Remove a previously registered callback function from the notification list. - + A callback function must be unregistered before it is deallocated. It is important that any registered callbacks that are not runtime complaint be unregistered when ExitBootServices() is called. - + @param[in] Callback A pointer to a function of type EFI_RSC_HANDLER_CALLBACK that is to be unregistered. - + @retval EFI_SUCCESS The function was successfully unregistered. @retval EFI_INVALID_PARAMETER The callback function was NULL. - @retval EFI_NOT_FOUND The callback function was not found to be unregistered. + @retval EFI_NOT_FOUND The callback function was not found to be unregistered. **/ typedef EFI_STATUS diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Reset.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Reset.h index bcd9329ba0..8afdc644ae 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Reset.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Reset.h @@ -3,17 +3,17 @@ Used to provide ResetSystem runtime services - The ResetSystem () UEFI 2.0 service is added to the EFI system table and the + The ResetSystem () UEFI 2.0 service is added to the EFI system table and the EFI_RESET_ARCH_PROTOCOL_GUID protocol is registered with a NULL pointer. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Rng.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Rng.h index 95cfdc95d7..dbdfe7acf8 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Rng.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Rng.h @@ -1,6 +1,6 @@ /** @file EFI_RNG_PROTOCOL as defined in UEFI 2.4. - The UEFI Random Number Generator Protocol is used to provide random bits for use + The UEFI Random Number Generator Protocol is used to provide random bits for use in applications, or entropy for seeding other random number generators. Copyright (c) 2013, Intel Corporation. All rights reserved.<BR> @@ -29,7 +29,7 @@ typedef struct _EFI_RNG_PROTOCOL EFI_RNG_PROTOCOL; /// /// A selection of EFI_RNG_PROTOCOL algorithms. -/// The algorithms listed are optional, not meant to be exhaustive and be argmented by +/// The algorithms listed are optional, not meant to be exhaustive and be argmented by /// vendors or other industry standards. /// @@ -78,7 +78,7 @@ typedef EFI_GUID EFI_RNG_ALGORITHM; Returns information about the random number generation implementation. @param[in] This A pointer to the EFI_RNG_PROTOCOL instance. - @param[in,out] RNGAlgorithmListSize On input, the size in bytes of RNGAlgorithmList. + @param[in,out] RNGAlgorithmListSize On input, the size in bytes of RNGAlgorithmList. On output with a return code of EFI_SUCCESS, the size in bytes of the data returned in RNGAlgorithmList. On output with a return code of EFI_BUFFER_TOO_SMALL, @@ -137,7 +137,7 @@ EFI_STATUS ); /// -/// The Random Number Generator (RNG) protocol provides random bits for use in +/// The Random Number Generator (RNG) protocol provides random bits for use in /// applications, or entropy for seeding other random number generators. /// struct _EFI_RNG_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Runtime.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Runtime.h index 21e9b75fb7..17e1bb9028 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Runtime.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Runtime.h @@ -1,23 +1,23 @@ /** @file Runtime Architectural Protocol as defined in PI Specification VOLUME 2 DXE - Allows the runtime functionality of the DXE Foundation to be contained - in a separate driver. It also provides hooks for the DXE Foundation to - export information that is needed at runtime. As such, this protocol allows - services to the DXE Foundation to manage runtime drivers and events. - This protocol also implies that the runtime services required to transition - to virtual mode, SetVirtualAddressMap() and ConvertPointer(), have been - registered into the UEFI Runtime Table in the UEFI System Table. This protocol + Allows the runtime functionality of the DXE Foundation to be contained + in a separate driver. It also provides hooks for the DXE Foundation to + export information that is needed at runtime. As such, this protocol allows + services to the DXE Foundation to manage runtime drivers and events. + This protocol also implies that the runtime services required to transition + to virtual mode, SetVirtualAddressMap() and ConvertPointer(), have been + registered into the UEFI Runtime Table in the UEFI System Table. This protocol must be produced by a runtime DXE driver and may only be consumed by the DXE Foundation. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -33,7 +33,7 @@ typedef struct _EFI_RUNTIME_ARCH_PROTOCOL EFI_RUNTIME_ARCH_PROTOCOL; /// -/// LIST_ENTRY from BaseType +/// LIST_ENTRY from BaseType /// typedef LIST_ENTRY EFI_LIST_ENTRY; @@ -44,7 +44,7 @@ typedef struct _EFI_RUNTIME_IMAGE_ENTRY EFI_RUNTIME_IMAGE_ENTRY; /// struct _EFI_RUNTIME_IMAGE_ENTRY { /// - /// Start of image that has been loaded in memory. It is a pointer + /// Start of image that has been loaded in memory. It is a pointer /// to either the DOS header or PE header of the image. /// VOID *ImageBase; @@ -101,13 +101,13 @@ struct _EFI_RUNTIME_EVENT_ENTRY { }; /// -/// Allows the runtime functionality of the DXE Foundation to be contained in a -/// separate driver. It also provides hooks for the DXE Foundation to export -/// information that is needed at runtime. As such, this protocol allows the DXE -/// Foundation to manage runtime drivers and events. This protocol also implies -/// that the runtime services required to transition to virtual mode, -/// SetVirtualAddressMap() and ConvertPointer(), have been registered into the -/// EFI Runtime Table in the EFI System Partition. This protocol must be produced +/// Allows the runtime functionality of the DXE Foundation to be contained in a +/// separate driver. It also provides hooks for the DXE Foundation to export +/// information that is needed at runtime. As such, this protocol allows the DXE +/// Foundation to manage runtime drivers and events. This protocol also implies +/// that the runtime services required to transition to virtual mode, +/// SetVirtualAddressMap() and ConvertPointer(), have been registered into the +/// EFI Runtime Table in the EFI System Partition. This protocol must be produced /// by a runtime DXE driver and may only be consumed by the DXE Foundation. /// struct _EFI_RUNTIME_ARCH_PROTOCOL { @@ -115,8 +115,8 @@ struct _EFI_RUNTIME_ARCH_PROTOCOL { EFI_LIST_ENTRY EventHead; ///< A list of type EFI_RUNTIME_EVENT_ENTRY. UINTN MemoryDescriptorSize; ///< Size of a memory descriptor that is returned by GetMemoryMap(). UINT32 MemoryDesciptorVersion; ///< Version of a memory descriptor that is returned by GetMemoryMap(). - UINTN MemoryMapSize;///< Size of the memory map in bytes contained in MemoryMapPhysical and MemoryMapVirtual. - EFI_MEMORY_DESCRIPTOR *MemoryMapPhysical; ///< Pointer to a runtime buffer that contains a copy of + UINTN MemoryMapSize;///< Size of the memory map in bytes contained in MemoryMapPhysical and MemoryMapVirtual. + EFI_MEMORY_DESCRIPTOR *MemoryMapPhysical; ///< Pointer to a runtime buffer that contains a copy of ///< the memory map returned via GetMemoryMap(). EFI_MEMORY_DESCRIPTOR *MemoryMapVirtual; ///< Pointer to MemoryMapPhysical that is updated to virtual mode after SetVirtualAddressMap(). BOOLEAN VirtualMode; ///< Boolean that is TRUE if SetVirtualAddressMap() has been called. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/S3SaveState.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/S3SaveState.h index c25e103f76..6593e25507 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/S3SaveState.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/S3SaveState.h @@ -1,21 +1,21 @@ /** @file S3 Save State Protocol as defined in PI1.2 Specification VOLUME 5 Standard. - This protocol is used by DXE PI module to store or record various IO operations + This protocol is used by DXE PI module to store or record various IO operations to be replayed during an S3 resume. This protocol is not required for all platforms. - + Copyright (c) 2009 - 2011, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: - This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 5: + This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 5: Standards **/ @@ -33,20 +33,20 @@ typedef struct _EFI_S3_SAVE_STATE_PROTOCOL EFI_S3_SAVE_STATE_PROTOCOL; /** Record operations that need to be replayed during an S3 resume. - + This function is used to store an OpCode to be replayed as part of the S3 resume boot path. It is assumed this protocol has platform specific mechanism to store the OpCode set and replay them during the S3 resume. - + @param[in] This A pointer to the EFI_S3_SAVE_STATE_PROTOCOL instance. @param[in] OpCode The operation code (opcode) number. @param[in] ... Argument list that is specific to each opcode. See the following subsections for the definition of each opcode. - + @retval EFI_SUCCESS The operation succeeded. A record was added into the specified - script table. + script table. @retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script is not supported. - @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script. + @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script. **/ typedef EFI_STATUS @@ -58,7 +58,7 @@ EFI_STATUS /** Record operations that need to be replayed during an S3 resume. - + This function is used to store an OpCode to be replayed as part of the S3 resume boot path. It is assumed this protocol has platform specific mechanism to store the OpCode set and replay them during the S3 resume. @@ -66,14 +66,14 @@ EFI_STATUS NULL then that position is after the last opcode in the table (BeforeOrAfter is TRUE) or before the first opcode in the table (BeforeOrAfter is FALSE). The position which is pointed to by Position upon return can be used for subsequent insertions. - + This function has a variable parameter list. The exact parameter list depends on the OpCode that is passed into the function. If an unsupported OpCode or illegal parameter list is passed in, this function returns EFI_INVALID_PARAMETER. If there are not enough resources available for storing more scripts, this function returns EFI_OUT_OF_RESOURCES. OpCode values of 0x80 - 0xFE are reserved for implementation specific functions. - + @param[in] This A pointer to the EFI_S3_SAVE_STATE_PROTOCOL instance. @param[in] BeforeOrAfter Specifies whether the opcode is stored before (TRUE) or after (FALSE) the position in the boot script table specified by Position. If Position is NULL or points to @@ -85,12 +85,12 @@ EFI_STATUS @param[in] OpCode The operation code (opcode) number. See "Related Definitions" in Write() for the defined opcode types. @param[in] ... Argument list that is specific to each opcode. See the following subsections for the - definition of each opcode. - + definition of each opcode. + @retval EFI_SUCCESS The operation succeeded. An opcode was added into the script. @retval EFI_INVALID_PARAMETER The Opcode is an invalid opcode value. @retval EFI_INVALID_PARAMETER The Position is not a valid position in the boot script table. - @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script table. + @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script table. **/ typedef EFI_STATUS @@ -104,14 +104,14 @@ EFI_STATUS /** Find a label within the boot script table and, if not present, optionally create it. - + If the label Label is already exists in the boot script table, then no new label is created, the position of the Label is returned in *Position and EFI_SUCCESS is returned. If the label Label does not already exist and CreateIfNotFound is TRUE, then it will be created before or after the specified position and EFI_SUCCESS is returned. If the label Label does not already exist and CreateIfNotFound is FALSE, then EFI_NOT_FOUND is returned. - + @param[in] This A pointer to the EFI_S3_SAVE_STATE_PROTOCOL instance. @param[in] BeforeOrAfter Specifies whether the label is stored before (TRUE) or after (FALSE) the position in the boot script table specified by Position. If Position is NULL or points to @@ -122,7 +122,7 @@ EFI_STATUS either before or after, depending on BeforeOrAfter. On exit, specifies the position of the inserted label in the boot script table. @param[in] Label Points to the label which will be inserted in the boot script table. - + @retval EFI_SUCCESS The label already exists or was inserted. @retval EFI_NOT_FOUND The label did not already exist and CreateifNotFound was FALSE. @retval EFI_INVALID_PARAMETER The Label is NULL or points to an empty string. @@ -141,16 +141,16 @@ EFI_STATUS /** Compare two positions in the boot script table and return their relative position. - + This function compares two positions in the boot script table and returns their relative positions. If Position1 is before Position2, then -1 is returned. If Position1 is equal to Position2, then 0 is returned. If Position1 is after Position2, then 1 is returned. - + @param[in] This A pointer to the EFI_S3_SAVE_STATE_PROTOCOL instance. @param[in] Position1 The positions in the boot script table to compare. @param[in] Position2 The positions in the boot script table to compare. @param[out] RelativePosition On return, points to the result of the comparison. - + @retval EFI_SUCCESS The operation succeeded. @retval EFI_INVALID_PARAMETER The Position1 or Position2 is not a valid position in the boot script table. @retval EFI_INVALID_PARAMETER The RelativePosition is NULL. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/S3SmmSaveState.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/S3SmmSaveState.h index 3cdfec7a17..a6267bc8e4 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/S3SmmSaveState.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/S3SmmSaveState.h @@ -13,19 +13,19 @@ EFI_OUT_OF_RESOURCES may be returned from a runtime call. It is the responsibility of the platform to ensure enough memory resource exists to save the system state. It is recommended that runtime calls be minimized by the caller. - + Copyright (c) 2009, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: - This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 5: - Standards + This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 5: + Standards **/ @@ -36,11 +36,11 @@ #define EFI_S3_SMM_SAVE_STATE_PROTOCOL_GUID \ {0x320afe62, 0xe593, 0x49cb, { 0xa9, 0xf1, 0xd4, 0xc2, 0xf4, 0xaf, 0x1, 0x4c }} - + typedef EFI_S3_SAVE_STATE_PROTOCOL EFI_S3_SMM_SAVE_STATE_PROTOCOL; extern EFI_GUID gEfiS3SmmSaveStateProtocolGuid; - + #endif // __S3_SMM_SAVE_STATE_H__ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ScsiIo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ScsiIo.h index 833fb1ceef..baf9bc18f3 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ScsiIo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ScsiIo.h @@ -1,17 +1,17 @@ /** @file EFI_SCSI_IO_PROTOCOL as defined in UEFI 2.0. - This protocol is used by code, typically drivers, running in the EFI boot - services environment to access SCSI devices. In particular, functions for + This protocol is used by code, typically drivers, running in the EFI boot + services environment to access SCSI devices. In particular, functions for managing devices on SCSI buses are defined here. Copyright (c) 2006 - 2013, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -301,12 +301,12 @@ struct _EFI_SCSI_IO_PROTOCOL { EFI_SCSI_IO_PROTOCOL_GET_DEVICE_LOCATION GetDeviceLocation; EFI_SCSI_IO_PROTOCOL_RESET_BUS ResetBus; EFI_SCSI_IO_PROTOCOL_RESET_DEVICE ResetDevice; - EFI_SCSI_IO_PROTOCOL_EXEC_SCSI_COMMAND ExecuteScsiCommand; + EFI_SCSI_IO_PROTOCOL_EXEC_SCSI_COMMAND ExecuteScsiCommand; /// - /// Supplies the alignment requirement for any buffer used in a data transfer. - /// IoAlign values of 0 and 1 mean that the buffer can be placed anywhere in memory. - /// Otherwise, IoAlign must be a power of 2, and the requirement is that the + /// Supplies the alignment requirement for any buffer used in a data transfer. + /// IoAlign values of 0 and 1 mean that the buffer can be placed anywhere in memory. + /// Otherwise, IoAlign must be a power of 2, and the requirement is that the /// start address of a buffer must be evenly divisible by IoAlign with no remainder. /// UINT32 IoAlign; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ScsiPassThru.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ScsiPassThru.h index baf0d2bfc7..bd8d211bfd 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ScsiPassThru.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ScsiPassThru.h @@ -1,21 +1,21 @@ /** @file SCSI Pass Through protocol as defined in EFI 1.1. - This protocol allows information about a SCSI channel to be collected, + This protocol allows information about a SCSI channel to be collected, and allows SCSI Request Packets to be sent to any SCSI devices on a SCSI - channel even if those devices are not boot devices. This protocol is attached - to the device handle of each SCSI channel in a system that the protocol - supports, and can be used for diagnostics. It may also be used to build + channel even if those devices are not boot devices. This protocol is attached + to the device handle of each SCSI channel in a system that the protocol + supports, and can be used for diagnostics. It may also be used to build a Block I/O driver for SCSI hard drives and SCSI CD-ROM or DVD drives to allow those devices to become boot devices. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -149,9 +149,9 @@ typedef struct { } EFI_SCSI_PASS_THRU_MODE; /** - Sends a SCSI Request Packet to a SCSI device that is attached to - the SCSI channel. This function supports both blocking I/O and - non-blocking I/O. The blocking I/O functionality is required, + Sends a SCSI Request Packet to a SCSI device that is attached to + the SCSI channel. This function supports both blocking I/O and + non-blocking I/O. The blocking I/O functionality is required, and the non-blocking I/O functionality is optional. @param This Protocol instance pointer. @@ -198,7 +198,7 @@ typedef struct { Request Packet to execute. See HostAdapterStatus, TargetStatus, SenseDataLength, and SenseData in that order for additional status information. - + **/ typedef EFI_STATUS @@ -211,7 +211,7 @@ EFI_STATUS ); /** - Used to retrieve the list of legal Target IDs for SCSI devices + Used to retrieve the list of legal Target IDs for SCSI devices on a SCSI channel. @param This Protocol instance pointer. @@ -243,7 +243,7 @@ EFI_STATUS ); /** - Used to allocate and build a device path node for a SCSI device + Used to allocate and build a device path node for a SCSI device on a SCSI channel. @param This Protocol instance pointer. @@ -311,7 +311,7 @@ EFI_STATUS ); /** - Resets a SCSI channel.This operation resets all the + Resets a SCSI channel.This operation resets all the SCSI devices connected to the SCSI channel. @param This Protocol instance pointer. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ScsiPassThruExt.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ScsiPassThruExt.h index a9d4047e0e..fc7e16ed7c 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ScsiPassThruExt.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ScsiPassThruExt.h @@ -1,16 +1,16 @@ /** @file EFI_EXT_SCSI_PASS_THRU_PROTOCOL as defined in UEFI 2.0. - This protocol provides services that allow SCSI Pass Thru commands + This protocol provides services that allow SCSI Pass Thru commands to be sent to SCSI devices attached to a SCSI channel. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -148,9 +148,9 @@ typedef struct { } EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET; /** - Sends a SCSI Request Packet to a SCSI device that is attached to the SCSI channel. This function + Sends a SCSI Request Packet to a SCSI device that is attached to the SCSI channel. This function supports both blocking I/O and nonblocking I/O. The blocking I/O functionality is required, and the - nonblocking I/O functionality is optional. + nonblocking I/O functionality is optional. @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. @param Target The Target is an array of size TARGET_MAX_BYTES and it represents @@ -196,14 +196,14 @@ EFI_STATUS IN UINT64 Lun, IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet, IN EFI_EVENT Event OPTIONAL - ); + ); /** - Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These + Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal - Target Ids and LUNs for the SCSI channel. Regardless, the caller of this function must probe the - Target ID and LUN returned to see if a SCSI device is actually present at that location on the SCSI - channel. + Target Ids and LUNs for the SCSI channel. Regardless, the caller of this function must probe the + Target ID and LUN returned to see if a SCSI device is actually present at that location on the SCSI + channel. @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. @param Target On input, a pointer to the Target ID (an array of size @@ -230,7 +230,7 @@ EFI_STATUS IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, IN OUT UINT8 **Target, IN OUT UINT64 *Lun - ); + ); /** Used to allocate and build a device path node for a SCSI device on a SCSI channel. @@ -294,7 +294,7 @@ EFI_STATUS IN EFI_DEVICE_PATH_PROTOCOL *DevicePath, OUT UINT8 **Target, OUT UINT64 *Lun - ); + ); /** Resets a SCSI channel. This operation resets all the SCSI devices connected to the SCSI channel. @@ -311,8 +311,8 @@ typedef EFI_STATUS (EFIAPI *EFI_EXT_SCSI_PASS_THRU_RESET_CHANNEL)( IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This - ); - + ); + /** Resets a SCSI logical unit that is connected to a SCSI channel. @@ -338,13 +338,13 @@ EFI_STATUS IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, IN UINT8 *Target, IN UINT64 Lun - ); + ); /** - Used to retrieve the list of legal Target IDs for SCSI devices on a SCSI channel. These can either + Used to retrieve the list of legal Target IDs for SCSI devices on a SCSI channel. These can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal Target IDs - for the SCSI channel. Regardless, the caller of this function must probe the Target ID returned to - see if a SCSI device is actually present at that location on the SCSI channel. + for the SCSI channel. Regardless, the caller of this function must probe the Target ID returned to + see if a SCSI device is actually present at that location on the SCSI channel. @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. @param Target (TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel. @@ -367,12 +367,12 @@ EFI_STATUS (EFIAPI *EFI_EXT_SCSI_PASS_THRU_GET_NEXT_TARGET)( IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, IN OUT UINT8 **Target - ); + ); /// -/// The EFI_EXT_SCSI_PASS_THRU_PROTOCOL provides information about a SCSI channel -/// and the ability to send SCI Request Packets to any SCSI device attached to -/// that SCSI channel. The information includes the Target ID of the host controller +/// The EFI_EXT_SCSI_PASS_THRU_PROTOCOL provides information about a SCSI channel +/// and the ability to send SCI Request Packets to any SCSI device attached to +/// that SCSI channel. The information includes the Target ID of the host controller /// on the SCSI channel and the attributes of the SCSI channel. /// struct _EFI_EXT_SCSI_PASS_THRU_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Security.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Security.h index 54c51fa432..449939e1af 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Security.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Security.h @@ -1,9 +1,9 @@ /** @file Security Architectural Protocol as defined in PI Specification VOLUME 2 DXE - Used to provide Security services. Specifically, dependening upon the - authentication state of a discovered driver in a Firmware Volume, the - portable DXE Core Dispatcher will call into the Security Architectural + Used to provide Security services. Specifically, dependening upon the + authentication state of a discovered driver in a Firmware Volume, the + portable DXE Core Dispatcher will call into the Security Architectural Protocol (SAP) with the authentication state of the driver. This call-out allows for OEM-specific policy decisions to be made, such @@ -11,17 +11,17 @@ an unsigned driver or failed signature check, or other exception response. The SAP can also change system behavior by having the DXE core put a driver - in the Schedule-On-Request (SOR) state. This will allow for later disposition + in the Schedule-On-Request (SOR) state. This will allow for later disposition of the driver by platform agent, such as Platform BDS. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -37,31 +37,31 @@ typedef struct _EFI_SECURITY_ARCH_PROTOCOL EFI_SECURITY_ARCH_PROTOCOL; /** - The EFI_SECURITY_ARCH_PROTOCOL (SAP) is used to abstract platform-specific - policy from the DXE core response to an attempt to use a file that returns a - given status for the authentication check from the section extraction protocol. + The EFI_SECURITY_ARCH_PROTOCOL (SAP) is used to abstract platform-specific + policy from the DXE core response to an attempt to use a file that returns a + given status for the authentication check from the section extraction protocol. - The possible responses in a given SAP implementation may include locking - flash upon failure to authenticate, attestation logging for all signed drivers, - and other exception operations. The File parameter allows for possible logging + The possible responses in a given SAP implementation may include locking + flash upon failure to authenticate, attestation logging for all signed drivers, + and other exception operations. The File parameter allows for possible logging within the SAP of the driver. If File is NULL, then EFI_INVALID_PARAMETER is returned. - If the file specified by File with an authentication status specified by + If the file specified by File with an authentication status specified by AuthenticationStatus is safe for the DXE Core to use, then EFI_SUCCESS is returned. - If the file specified by File with an authentication status specified by - AuthenticationStatus is not safe for the DXE Core to use under any circumstances, + If the file specified by File with an authentication status specified by + AuthenticationStatus is not safe for the DXE Core to use under any circumstances, then EFI_ACCESS_DENIED is returned. - If the file specified by File with an authentication status specified by - AuthenticationStatus is not safe for the DXE Core to use right now, but it - might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is + If the file specified by File with an authentication status specified by + AuthenticationStatus is not safe for the DXE Core to use right now, but it + might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is returned. @param This The EFI_SECURITY_ARCH_PROTOCOL instance. - @param AuthenticationStatus + @param AuthenticationStatus This is the authentication type returned from the Section Extraction protocol. See the Section Extraction Protocol Specification for details on this type. @@ -81,7 +81,7 @@ typedef struct _EFI_SECURITY_ARCH_PROTOCOL EFI_SECURITY_ARCH_PROTOCOL; used for any purpose. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_SECURITY_FILE_AUTHENTICATION_STATE)( IN CONST EFI_SECURITY_ARCH_PROTOCOL *This, @@ -91,7 +91,7 @@ EFI_STATUS /// /// The EFI_SECURITY_ARCH_PROTOCOL is used to abstract platform-specific policy -/// from the DXE core. This includes locking flash upon failure to authenticate, +/// from the DXE core. This includes locking flash upon failure to authenticate, /// attestation logging, and other exception operations. /// struct _EFI_SECURITY_ARCH_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Security2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Security2.h index a8d7915690..440094478e 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Security2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Security2.h @@ -4,27 +4,27 @@ Abstracts security-specific functions from the DXE Foundation of UEFI Image Verification, Trusted Computing Group (TCG) measured boot, and User Identity policy for image loading and consoles. This protocol must be produced by a boot service or runtime DXE driver. - + This protocol is optional and must be published prior to the EFI_SECURITY_ARCH_PROTOCOL. As a result, the same driver must publish both of these interfaces. - + When both Security and Security2 Architectural Protocols are published, LoadImage must use them in accordance with the following rules: The Security2 protocol must be used on every image being loaded. - The Security protocol must be used after the Securiy2 protocol and only on images that + The Security protocol must be used after the Securiy2 protocol and only on images that have been read using Firmware Volume protocol. When only Security architectural protocol is published, LoadImage must use it on every image being loaded. Copyright (c) 2012, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -36,7 +36,7 @@ /// #define EFI_SECURITY2_ARCH_PROTOCOL_GUID \ { 0x94ab2f58, 0x1438, 0x4ef1, {0x91, 0x52, 0x18, 0x94, 0x1a, 0x3a, 0x0e, 0x68 } } - + typedef struct _EFI_SECURITY2_ARCH_PROTOCOL EFI_SECURITY2_ARCH_PROTOCOL; /** @@ -51,7 +51,7 @@ typedef struct _EFI_SECURITY2_ARCH_PROTOCOL EFI_SECURITY2_ARCH_PROTOCOL; these cases. If the FileBuffer is NULL, the interface will determine if the DevicePath can be connected in order to support the User Identification policy. - + @param This The EFI_SECURITY2_ARCH_PROTOCOL instance. @param File A pointer to the device path of the file that is being dispatched. This will optionally be used for logging. @@ -60,7 +60,7 @@ typedef struct _EFI_SECURITY2_ARCH_PROTOCOL EFI_SECURITY2_ARCH_PROTOCOL; @param BootPolicy A boot policy that was used to call LoadImage() UEFI service. If FileAuthentication() is invoked not from the LoadImage(), BootPolicy must be set to FALSE. - + @retval EFI_SUCCESS The file specified by DevicePath and non-NULL FileBuffer did authenticate, and the platform policy dictates that the DXE Foundation may use the file. @@ -84,7 +84,7 @@ typedef struct _EFI_SECURITY2_ARCH_PROTOCOL EFI_SECURITY2_ARCH_PROTOCOL; drivers from the device path specified by DevicePath. The image has been added into the list of the deferred images. **/ -typedef EFI_STATUS (EFIAPI *EFI_SECURITY2_FILE_AUTHENTICATION) ( +typedef EFI_STATUS (EFIAPI *EFI_SECURITY2_FILE_AUTHENTICATION) ( IN CONST EFI_SECURITY2_ARCH_PROTOCOL *This, IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, IN VOID *FileBuffer, diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SecurityPolicy.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SecurityPolicy.h index ceff5ac227..65cae19f3d 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SecurityPolicy.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SecurityPolicy.h @@ -2,13 +2,13 @@ Security Policy protocol as defined in PI Specification VOLUME 2 DXE Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SerialIo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SerialIo.h index 873e209b01..2282ed31da 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SerialIo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SerialIo.h @@ -5,13 +5,13 @@ could be much more generic. Copyright (c) 2006 - 2015, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -25,7 +25,7 @@ /// /// Protocol GUID defined in EFI1.1. -/// +/// #define SERIAL_IO_PROTOCOL EFI_SERIAL_IO_PROTOCOL_GUID typedef struct _EFI_SERIAL_IO_PROTOCOL EFI_SERIAL_IO_PROTOCOL; @@ -33,7 +33,7 @@ typedef struct _EFI_SERIAL_IO_PROTOCOL EFI_SERIAL_IO_PROTOCOL; /// /// Backward-compatible with EFI1.1. -/// +/// typedef EFI_SERIAL_IO_PROTOCOL SERIAL_IO_INTERFACE; /// @@ -92,7 +92,7 @@ typedef enum { Reset the serial device. @param This Protocol instance pointer. - + @retval EFI_SUCCESS The device was reset. @retval EFI_DEVICE_ERROR The serial device could not be reset. @@ -104,7 +104,7 @@ EFI_STATUS ); /** - Sets the baud rate, receive FIFO depth, transmit/receice time out, parity, + Sets the baud rate, receive FIFO depth, transmit/receice time out, parity, data bits, and stop bits on a serial device. @param This Protocol instance pointer. @@ -165,7 +165,7 @@ EFI_STATUS @param This Protocol instance pointer. @param Control A pointer to return the current Control signals from the serial device. - + @retval EFI_SUCCESS The control bits were read from the serial device. @retval EFI_DEVICE_ERROR The serial device is not functioning correctly. @@ -221,33 +221,33 @@ EFI_STATUS /** @par Data Structure Description: - The data values in SERIAL_IO_MODE are read-only and are updated by the code + The data values in SERIAL_IO_MODE are read-only and are updated by the code that produces the SERIAL_IO_PROTOCOL member functions. @param ControlMask A mask for the Control bits that the device supports. The device must always support the Input Buffer Empty control bit. - + @param TimeOut If applicable, the number of microseconds to wait before timing out a Read or Write operation. - + @param BaudRate If applicable, the current baud rate setting of the device; otherwise, baud rate has the value of zero to indicate that device runs at the device's designed speed. - + @param ReceiveFifoDepth The number of characters the device will buffer on input - + @param DataBits The number of characters the device will buffer on input - + @param Parity - If applicable, this is the EFI_PARITY_TYPE that is computed or + If applicable, this is the EFI_PARITY_TYPE that is computed or checked as each character is transmitted or reveived. If the device does not support parity the value is the default parity value. - + @param StopBits If applicable, the EFI_STOP_BITS_TYPE number of stop bits per character. If the device does not support stop bits the value is @@ -272,14 +272,14 @@ typedef struct { #define SERIAL_IO_INTERFACE_REVISION EFI_SERIAL_IO_PROTOCOL_REVISION /// -/// The Serial I/O protocol is used to communicate with UART-style serial devices. -/// These can be standard UART serial ports in PC-AT systems, serial ports attached +/// The Serial I/O protocol is used to communicate with UART-style serial devices. +/// These can be standard UART serial ports in PC-AT systems, serial ports attached /// to a USB interface, or potentially any character-based I/O device. /// struct _EFI_SERIAL_IO_PROTOCOL { /// - /// The revision to which the EFI_SERIAL_IO_PROTOCOL adheres. All future revisions - /// must be backwards compatible. If a future version is not backwards compatible, + /// The revision to which the EFI_SERIAL_IO_PROTOCOL adheres. All future revisions + /// must be backwards compatible. If a future version is not backwards compatible, /// it is not the same GUID. /// UINT32 Revision; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ServiceBinding.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ServiceBinding.h index 546a0d0973..533fcde876 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ServiceBinding.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ServiceBinding.h @@ -1,18 +1,18 @@ -/** @file +/** @file UEFI Service Binding Protocol is defined in UEFI specification. The file defines the generic Service Binding Protocol functions. - It provides services that are required to create and destroy child + It provides services that are required to create and destroy child handles that support a given set of protocols. Copyright (c) 2006 - 2016, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -26,14 +26,14 @@ typedef struct _EFI_SERVICE_BINDING_PROTOCOL EFI_SERVICE_BINDING_PROTOCOL; /** Creates a child handle and installs a protocol. - - The CreateChild() function installs a protocol on ChildHandle. - If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. + + The CreateChild() function installs a protocol on ChildHandle. + If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle. @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. @param ChildHandle Pointer to the handle of the child to create. If it is NULL, - then a new handle is created. If it is a pointer to an existing UEFI handle, + then a new handle is created. If it is a pointer to an existing UEFI handle, then the protocol is added to the existing UEFI handle. @retval EFI_SUCCES The protocol was added to ChildHandle. @@ -52,9 +52,9 @@ EFI_STATUS /** Destroys a child handle with a protocol installed on it. - - The DestroyChild() function does the opposite of CreateChild(). It removes a protocol - that was installed by CreateChild() from ChildHandle. If the removed protocol is the + + The DestroyChild() function does the opposite of CreateChild(). It removes a protocol + that was installed by CreateChild() from ChildHandle. If the removed protocol is the last protocol on ChildHandle, then ChildHandle is destroyed. @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. @@ -76,14 +76,14 @@ EFI_STATUS ); /// -/// The EFI_SERVICE_BINDING_PROTOCOL provides member functions to create and destroy -/// child handles. A driver is responsible for adding protocols to the child handle -/// in CreateChild() and removing protocols in DestroyChild(). It is also required -/// that the CreateChild() function opens the parent protocol BY_CHILD_CONTROLLER +/// The EFI_SERVICE_BINDING_PROTOCOL provides member functions to create and destroy +/// child handles. A driver is responsible for adding protocols to the child handle +/// in CreateChild() and removing protocols in DestroyChild(). It is also required +/// that the CreateChild() function opens the parent protocol BY_CHILD_CONTROLLER /// to establish the parent-child relationship, and closes the protocol in DestroyChild(). -/// The pseudo code for CreateChild() and DestroyChild() is provided to specify the -/// required behavior, not to specify the required implementation. Each consumer of -/// a software protocol is responsible for calling CreateChild() when it requires the +/// The pseudo code for CreateChild() and DestroyChild() is provided to specify the +/// required behavior, not to specify the required implementation. Each consumer of +/// a software protocol is responsible for calling CreateChild() when it requires the /// protocol and calling DestroyChild() when it is finished with that protocol. /// struct _EFI_SERVICE_BINDING_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Shell.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Shell.h index c54e901714..f1610def48 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Shell.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Shell.h @@ -547,7 +547,7 @@ CONST CHAR16 * ); /** - Gets the environment variable and Attributes, or list of environment variables. Can be + Gets the environment variable and Attributes, or list of environment variables. Can be used instead of GetEnv(). This function returns the current value of the specified environment variable and @@ -555,18 +555,18 @@ CONST CHAR16 * variables will be returned. @param[in] Name A pointer to the environment variable name. If Name is NULL, - then the function will return all of the defined shell + then the function will return all of the defined shell environment variables. In the case where multiple environment - variables are being returned, each variable will be terminated + variables are being returned, each variable will be terminated by a NULL, and the list will be terminated by a double NULL. @param[out] Attributes If not NULL, a pointer to the returned attributes bitmask for the environment variable. In the case where Name is NULL, and multiple environment variables are being returned, Attributes is undefined. - @retval NULL The environment variable doesn't exist. - @return The environment variable's value. The returned pointer does not - need to be freed by the caller. + @retval NULL The environment variable doesn't exist. + @return The environment variable's value. The returned pointer does not + need to be freed by the caller. **/ typedef CONST CHAR16 * diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ShellDynamicCommand.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ShellDynamicCommand.h index da2055d2d5..c3ec09bd5c 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ShellDynamicCommand.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/ShellDynamicCommand.h @@ -73,7 +73,7 @@ CHAR16* /// EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL protocol structure. struct _EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL { - + CONST CHAR16 *CommandName; SHELL_COMMAND_HANDLER Handler; SHELL_COMMAND_GETHELP GetHelp; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SimpleFileSystem.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SimpleFileSystem.h index cf39e83c2c..37888d51bc 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SimpleFileSystem.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SimpleFileSystem.h @@ -1,20 +1,20 @@ /** @file SimpleFileSystem protocol as defined in the UEFI 2.0 specification. - The SimpleFileSystem protocol is the programmatic access to the FAT (12,16,32) - file system specified in UEFI 2.0. It can also be used to abstract a file + The SimpleFileSystem protocol is the programmatic access to the FAT (12,16,32) + file system specified in UEFI 2.0. It can also be used to abstract a file system other than FAT. UEFI 2.0 can boot from any valid EFI image contained in a SimpleFileSystem. Copyright (c) 2006 - 2014, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -33,12 +33,12 @@ typedef struct _EFI_FILE_PROTOCOL *EFI_FILE_HANDLE; /// /// Protocol GUID name defined in EFI1.1. -/// +/// #define SIMPLE_FILE_SYSTEM_PROTOCOL EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID /// /// Protocol name defined in EFI1.1. -/// +/// typedef EFI_SIMPLE_FILE_SYSTEM_PROTOCOL EFI_FILE_IO_INTERFACE; typedef EFI_FILE_PROTOCOL EFI_FILE; @@ -73,7 +73,7 @@ EFI_STATUS /// /// Revision defined in EFI1.1 -/// +/// #define EFI_FILE_IO_INTERFACE_REVISION EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL { @@ -99,7 +99,7 @@ struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL { and "..". @param OpenMode The mode to open the file. The only valid combinations that the file may be opened with are: Read, Read/Write, or Create/Read/Write. - @param Attributes Only valid for EFI_FILE_MODE_CREATE, in which case these are the + @param Attributes Only valid for EFI_FILE_MODE_CREATE, in which case these are the attribute bits for the newly created file. @retval EFI_SUCCESS The file was opened. @@ -147,7 +147,7 @@ EFI_STATUS /** Closes a specified file handle. - @param This A pointer to the EFI_FILE_PROTOCOL instance that is the file + @param This A pointer to the EFI_FILE_PROTOCOL instance that is the file handle to close. @retval EFI_SUCCESS The file was closed. @@ -345,7 +345,7 @@ EFI_STATUS /** Flushes all modified data associated with a file to a device. - @param This A pointer to the EFI_FILE_PROTOCOL instance that is the file + @param This A pointer to the EFI_FILE_PROTOCOL instance that is the file handle to flush. @retval EFI_SUCCESS The data was flushed. @@ -409,7 +409,7 @@ typedef struct { and "..". @param OpenMode The mode to open the file. The only valid combinations that the file may be opened with are: Read, Read/Write, or Create/Read/Write. - @param Attributes Only valid for EFI_FILE_MODE_CREATE, in which case these are the + @param Attributes Only valid for EFI_FILE_MODE_CREATE, in which case these are the attribute bits for the newly created file. @param Token A pointer to the token associated with the transaction. @@ -488,13 +488,13 @@ typedef EFI_STATUS (EFIAPI *EFI_FILE_WRITE_EX) ( IN EFI_FILE_PROTOCOL *This, - IN OUT EFI_FILE_IO_TOKEN *Token + IN OUT EFI_FILE_IO_TOKEN *Token ); /** Flushes all modified data associated with a file to a device. - @param This A pointer to the EFI_FILE_PROTOCOL instance that is the file + @param This A pointer to the EFI_FILE_PROTOCOL instance that is the file handle to flush. @param Token A pointer to the token associated with the transaction. @@ -523,19 +523,19 @@ EFI_STATUS // // Revision defined in EFI1.1. -// +// #define EFI_FILE_REVISION EFI_FILE_PROTOCOL_REVISION /// /// The EFI_FILE_PROTOCOL provides file IO access to supported file systems. -/// An EFI_FILE_PROTOCOL provides access to a file's or directory's contents, -/// and is also a reference to a location in the directory tree of the file system -/// in which the file resides. With any given file handle, other files may be opened +/// An EFI_FILE_PROTOCOL provides access to a file's or directory's contents, +/// and is also a reference to a location in the directory tree of the file system +/// in which the file resides. With any given file handle, other files may be opened /// relative to this file's location, yielding new file handles. /// struct _EFI_FILE_PROTOCOL { /// - /// The version of the EFI_FILE_PROTOCOL interface. The version specified + /// The version of the EFI_FILE_PROTOCOL interface. The version specified /// by this specification is EFI_FILE_PROTOCOL_LATEST_REVISION. /// Future versions are required to be backward compatible to version 1.0. /// diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SimpleNetwork.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SimpleNetwork.h index 0dda83aaaf..f5f1ef8213 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SimpleNetwork.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SimpleNetwork.h @@ -1,5 +1,5 @@ /** @file - The EFI_SIMPLE_NETWORK_PROTOCOL provides services to initialize a network interface, + The EFI_SIMPLE_NETWORK_PROTOCOL provides services to initialize a network interface, transmit packets, receive packets, and close a network interface. Basic network device abstraction. @@ -10,16 +10,16 @@ ... Copyright (c) 2006 - 2016, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +http://opensource.org/licenses/bsd-license.php. - @par Revision Reference: - This Protocol is introduced in EFI Specification 1.10. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + + @par Revision Reference: + This Protocol is introduced in EFI Specification 1.10. **/ @@ -36,7 +36,7 @@ typedef struct _EFI_SIMPLE_NETWORK_PROTOCOL EFI_SIMPLE_NETWORK_PROTOCOL; /// /// Protocol defined in EFI1.1. -/// +/// typedef EFI_SIMPLE_NETWORK_PROTOCOL EFI_SIMPLE_NETWORK; /// @@ -288,8 +288,8 @@ EFI_STATUS ); /** - Resets a network adapter and allocates the transmit and receive buffers - required by the network interface; optionally, also requests allocation + Resets a network adapter and allocates the transmit and receive buffers + required by the network interface; optionally, also requests allocation of additional transmit and receive buffers. @param This The protocol instance pointer. @@ -322,8 +322,8 @@ EFI_STATUS ); /** - Resets a network adapter and re-initializes it with the parameters that were - provided in the previous call to Initialize(). + Resets a network adapter and re-initializes it with the parameters that were + provided in the previous call to Initialize(). @param This The protocol instance pointer. @param ExtendedVerification Indicates that the driver may perform a more @@ -345,7 +345,7 @@ EFI_STATUS ); /** - Resets a network adapter and leaves it in a state that is safe for + Resets a network adapter and leaves it in a state that is safe for another driver to initialize. @param This Protocol instance pointer. @@ -482,7 +482,7 @@ EFI_STATUS ); /** - Performs read and write operations on the NVRAM device attached to a + Performs read and write operations on the NVRAM device attached to a network interface. @param This The protocol instance pointer. @@ -512,7 +512,7 @@ EFI_STATUS ); /** - Reads the current interrupt status and recycled transmit buffer status from + Reads the current interrupt status and recycled transmit buffer status from a network interface. @param This The protocol instance pointer. @@ -570,7 +570,7 @@ EFI_STATUS @retval EFI_SUCCESS The packet was placed on the transmit queue. @retval EFI_NOT_STARTED The network interface has not been started. - @retval EFI_NOT_READY The network interface is too busy to accept this transmit request. + @retval EFI_NOT_READY The network interface is too busy to accept this transmit request. @retval EFI_BUFFER_TOO_SMALL The BufferSize parameter is too small. @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value. @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. @@ -637,19 +637,19 @@ EFI_STATUS // // Revision defined in EFI1.1 -// +// #define EFI_SIMPLE_NETWORK_INTERFACE_REVISION EFI_SIMPLE_NETWORK_PROTOCOL_REVISION /// -/// The EFI_SIMPLE_NETWORK_PROTOCOL protocol is used to initialize access -/// to a network adapter. Once the network adapter initializes, -/// the EFI_SIMPLE_NETWORK_PROTOCOL protocol provides services that +/// The EFI_SIMPLE_NETWORK_PROTOCOL protocol is used to initialize access +/// to a network adapter. Once the network adapter initializes, +/// the EFI_SIMPLE_NETWORK_PROTOCOL protocol provides services that /// allow packets to be transmitted and received. /// struct _EFI_SIMPLE_NETWORK_PROTOCOL { /// - /// Revision of the EFI_SIMPLE_NETWORK_PROTOCOL. All future revisions must - /// be backwards compatible. If a future version is not backwards compatible + /// Revision of the EFI_SIMPLE_NETWORK_PROTOCOL. All future revisions must + /// be backwards compatible. If a future version is not backwards compatible /// it is not the same GUID. /// UINT64 Revision; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SimplePointer.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SimplePointer.h index d8c0757f62..ae9f77ac08 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SimplePointer.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SimplePointer.h @@ -4,13 +4,13 @@ Abstraction of a very simple pointer device like a mouse or trackball. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -78,17 +78,17 @@ typedef struct { BOOLEAN RightButton; } EFI_SIMPLE_POINTER_MODE; -/** +/** Resets the pointer device hardware. - + @param This A pointer to the EFI_SIMPLE_POINTER_PROTOCOL - instance. + instance. @param ExtendedVerification Indicates that the driver may perform a more exhaustive - verification operation of the device during reset. - + verification operation of the device during reset. + @retval EFI_SUCCESS The device was reset. - @retval EFI_DEVICE_ERROR The device is not functioning correctly and could not be reset. - + @retval EFI_DEVICE_ERROR The device is not functioning correctly and could not be reset. + **/ typedef EFI_STATUS @@ -97,19 +97,19 @@ EFI_STATUS IN BOOLEAN ExtendedVerification ); -/** +/** Retrieves the current state of a pointer device. - + @param This A pointer to the EFI_SIMPLE_POINTER_PROTOCOL - instance. + instance. @param State A pointer to the state information on the pointer device. - + @retval EFI_SUCCESS The state of the pointer device was returned in State. @retval EFI_NOT_READY The state of the pointer device has not changed since the last call to - GetState(). + GetState(). @retval EFI_DEVICE_ERROR A device error occurred while attempting to retrieve the pointer device's - current state. - + current state. + **/ typedef EFI_STATUS @@ -119,10 +119,10 @@ EFI_STATUS ); /// -/// The EFI_SIMPLE_POINTER_PROTOCOL provides a set of services for a pointer -/// device that can use used as an input device from an application written -/// to this specification. The services include the ability to reset the -/// pointer device, retrieve get the state of the pointer device, and +/// The EFI_SIMPLE_POINTER_PROTOCOL provides a set of services for a pointer +/// device that can use used as an input device from an application written +/// to this specification. The services include the ability to reset the +/// pointer device, retrieve get the state of the pointer device, and /// retrieve the capabilities of the pointer device. /// struct _EFI_SIMPLE_POINTER_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SimpleTextOut.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SimpleTextOut.h index 4d2612c0a9..ec0ecae370 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SimpleTextOut.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SimpleTextOut.h @@ -7,13 +7,13 @@ of multiple physical devices. Copyright (c) 2006 - 2015, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -27,14 +27,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /// /// Protocol GUID defined in EFI1.1. -/// +/// #define SIMPLE_TEXT_OUTPUT_PROTOCOL EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID typedef struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL; /// /// Backward-compatible with EFI1.1. -/// +/// typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SIMPLE_TEXT_OUTPUT_INTERFACE; // @@ -125,8 +125,8 @@ typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SIMPLE_TEXT_OUTPUT_INTERFACE; #define EFI_WHITE (EFI_BLUE | EFI_GREEN | EFI_RED | EFI_BRIGHT) // -// Macro to accept color values in their raw form to create -// a value that represents both a foreground and background +// Macro to accept color values in their raw form to create +// a value that represents both a foreground and background // color in a single byte. // For Foreground, and EFI_* value is valid from EFI_BLACK(0x00) to // EFI_WHITE (0x0F). @@ -148,7 +148,7 @@ typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SIMPLE_TEXT_OUTPUT_INTERFACE; // // We currently define attributes from 0 - 7F for color manipulations -// To internally handle the local display characteristics for a particular character, +// To internally handle the local display characteristics for a particular character, // Bit 7 signifies the local glyph representation for a character. If turned on, glyphs will be // pulled from the wide glyph database and will display locally as a wide character (16 X 19 versus 8 X 19) // If bit 7 is off, the narrow glyph database will be used. This does NOT affect information that is sent to @@ -201,7 +201,7 @@ EFI_STATUS ); /** - Verifies that all characters in a string can be output to the + Verifies that all characters in a string can be output to the target device. @param This The protocol instance pointer. @@ -231,7 +231,7 @@ EFI_STATUS requested ModeNumber. @param Rows Returns the geometry of the text output device for the requested ModeNumber. - + @retval EFI_SUCCESS The requested mode information was returned. @retval EFI_DEVICE_ERROR The device had an error and could not complete the request. @retval EFI_UNSUPPORTED The mode number was not valid. @@ -286,11 +286,11 @@ EFI_STATUS ); /** - Clears the output device(s) display to the currently selected background + Clears the output device(s) display to the currently selected background color. @param This The protocol instance pointer. - + @retval EFI_SUCCESS The operation completed successfully. @retval EFI_DEVICE_ERROR The device had an error and could not complete the request. @retval EFI_UNSUPPORTED The output device is not in a valid text mode. @@ -385,9 +385,9 @@ typedef struct { } EFI_SIMPLE_TEXT_OUTPUT_MODE; /// -/// The SIMPLE_TEXT_OUTPUT protocol is used to control text-based output devices. -/// It is the minimum required protocol for any handle supplied as the ConsoleOut -/// or StandardError device. In addition, the minimum supported text mode of such +/// The SIMPLE_TEXT_OUTPUT protocol is used to control text-based output devices. +/// It is the minimum required protocol for any handle supplied as the ConsoleOut +/// or StandardError device. In addition, the minimum supported text mode of such /// devices is at least 80 x 25 characters. /// struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Smbios.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Smbios.h index d03380cdea..5db6de51c1 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Smbios.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Smbios.h @@ -1,7 +1,7 @@ /** @file SMBIOS Protocol as defined in PI1.2 Specification VOLUME 5 Standard. - SMBIOS protocol allows consumers to log SMBIOS data records, and enables the producer + SMBIOS protocol allows consumers to log SMBIOS data records, and enables the producer to create the SMBIOS tables for a platform. This protocol provides an interface to add, remove or discover SMBIOS records. The driver which @@ -14,13 +14,13 @@ The SMBIOS protocol can only be called a TPL < TPL_NOTIFY. Copyright (c) 2006 - 2011, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -84,12 +84,12 @@ typedef SMBIOS_TABLE_STRING EFI_SMBIOS_STRING; typedef SMBIOS_TYPE EFI_SMBIOS_TYPE; typedef SMBIOS_HANDLE EFI_SMBIOS_HANDLE; typedef SMBIOS_STRUCTURE EFI_SMBIOS_TABLE_HEADER; - + typedef struct _EFI_SMBIOS_PROTOCOL EFI_SMBIOS_PROTOCOL; /** Add an SMBIOS record. - + This function allows any agent to add SMBIOS records. The caller is responsible for ensuring Record is formatted in a way that matches the version of the SMBIOS specification as defined in the MajorRevision and MinorRevision fields of the EFI_SMBIOS_PROTOCOL. @@ -100,7 +100,7 @@ typedef struct _EFI_SMBIOS_PROTOCOL EFI_SMBIOS_PROTOCOL; directly following the last string. The number of optional strings is not defined by the formatted area, but is fixed by the call to Add(). A string can be a place holder, but it must not be a NULL string as two NULL strings look like the double-null that terminates the structure. - + @param[in] This The EFI_SMBIOS_PROTOCOL instance. @param[in] ProducerHandle The handle of the controller or driver associated with the SMBIOS information. NULL means no handle. @param[in, out] SmbiosHandle On entry, the handle of the SMBIOS record to add. If FFFEh, then a unique handle @@ -110,7 +110,7 @@ typedef struct _EFI_SMBIOS_PROTOCOL EFI_SMBIOS_PROTOCOL; determined by EFI_SMBIOS_TABLE_HEADER.Type. The size of the formatted area is defined by EFI_SMBIOS_TABLE_HEADER.Length and either followed by a double-null (0x0000) or a set of null terminated strings and a null. - + @retval EFI_SUCCESS Record was added. @retval EFI_OUT_OF_RESOURCES Record was not added. @retval EFI_ALREADY_STARTED The SmbiosHandle passed in was already in use. @@ -126,19 +126,19 @@ EFI_STATUS /** Update the string associated with an existing SMBIOS record. - + This function allows the update of specific SMBIOS strings. The number of valid strings for any SMBIOS record is defined by how many strings were present when Add() was called. - + @param[in] This The EFI_SMBIOS_PROTOCOL instance. @param[in] SmbiosHandle SMBIOS Handle of structure that will have its string updated. @param[in] StringNumber The non-zero string number of the string to update. @param[in] String Update the StringNumber string with String. - + @retval EFI_SUCCESS SmbiosHandle had its StringNumber String updated. @retval EFI_INVALID_PARAMETER SmbiosHandle does not exist. @retval EFI_UNSUPPORTED String was not added because it is longer than the SMBIOS Table supports. - @retval EFI_NOT_FOUND The StringNumber.is not valid for this SMBIOS record. + @retval EFI_NOT_FOUND The StringNumber.is not valid for this SMBIOS record. **/ typedef EFI_STATUS @@ -151,12 +151,12 @@ EFI_STATUS /** Remove an SMBIOS record. - + This function removes an SMBIOS record using the handle specified by SmbiosHandle. - + @param[in] This The EFI_SMBIOS_PROTOCOL instance. @param[in] SmbiosHandle The handle of the SMBIOS record to remove. - + @retval EFI_SUCCESS SMBIOS record was removed. @retval EFI_INVALID_PARAMETER SmbiosHandle does not specify a valid SMBIOS record. **/ @@ -169,10 +169,10 @@ EFI_STATUS /** Allow the caller to discover all or some of the SMBIOS records. - + This function allows all of the SMBIOS records to be discovered. It's possible to find only the SMBIOS records that match the optional Type argument. - + @param[in] This The EFI_SMBIOS_PROTOCOL instance. @param[in, out] SmbiosHandle On entry, points to the previous handle of the SMBIOS record. On exit, points to the next SMBIOS record handle. If it is FFFEh on entry, then the first SMBIOS record @@ -207,7 +207,7 @@ struct _EFI_SMBIOS_PROTOCOL { UINT8 MajorVersion; ///< The major revision of the SMBIOS specification supported. UINT8 MinorVersion; ///< The minor revision of the SMBIOS specification supported. }; - + extern EFI_GUID gEfiSmbiosProtocolGuid; - + #endif // __SMBIOS_PROTOCOL_H__ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmbusHc.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmbusHc.h index d5620d7a6c..6372a4c0a7 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmbusHc.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmbusHc.h @@ -1,15 +1,15 @@ /** @file - The file provides basic SMBus host controller management + The file provides basic SMBus host controller management and basic data transactions over the SMBus. Copyright (c) 2006 - 2011, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: PI Version 1.00. @@ -27,13 +27,13 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL; /** - + The Execute() function provides a standard way to execute an operation as defined in the System Management Bus (SMBus) Specification. The resulting transaction will be either that the SMBus slave devices accept this transaction or that this - function returns with error. - + function returns with error. + @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance. SlaveAddress The SMBus slave address of the device with which to communicate. Type @@ -65,8 +65,8 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL; @param PecCheck Defines if Packet Error Code (PEC) checking is required for this operation. SMBus Host Controller Code Definitions Version 1.0 - August 21, 2006 13 - + August 21, 2006 13 + @param Length Signifies the number of bytes that this operation will do. The maximum number of bytes can be revision specific and operation specific. This field @@ -78,8 +78,8 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL; SMBus slave device. Not all operations require this argument. The length of this buffer is identified by Length. - - + + @retval EFI_SUCCESS The last data that was returned from the access matched the poll exit criteria. @@ -113,7 +113,7 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL; values. @retval EFI_UNSUPPORTED The SMBus operation or PEC is not - supported. + supported. @retval EFI_BUFFER_TOO_SMALL Buffer is not sufficient for this operation. @@ -134,10 +134,10 @@ EFI_STATUS /** - - The ArpDevice() function provides a standard way for a device driver to + + The ArpDevice() function provides a standard way for a device driver to enumerate the entire SMBus or specific devices on the bus. - + @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance. @param ArpAll A Boolean expression that indicates if the @@ -183,7 +183,7 @@ EFI_STATUS @retval EFI_UNSUPPORTED ArpDevice, GetArpMap, and Notify are not implemented by this driver. - + **/ typedef EFI_STATUS @@ -196,23 +196,23 @@ EFI_STATUS /** - The GetArpMap() function returns the mapping of all the SMBus devices + The GetArpMap() function returns the mapping of all the SMBus devices that were enumerated by the SMBus host driver. - + @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance. - + @param Length Size of the buffer that contains the SMBus device map. - + @param SmbusDeviceMap The pointer to the device map as enumerated by the SMBus controller driver. - + @retval EFI_SUCCESS The SMBus returned the current device map. - + @retval EFI_UNSUPPORTED ArpDevice, GetArpMap, and Notify are not implemented by this driver. - + **/ typedef EFI_STATUS @@ -224,13 +224,13 @@ EFI_STATUS /** The notify function does some actions. - + @param SlaveAddress The SMBUS hardware address to which the SMBUS device is preassigned or allocated. @param Data Data of the SMBus host notify command that the caller wants to be called. - + @return EFI_STATUS **/ typedef @@ -242,13 +242,13 @@ EFI_STATUS /** - + The Notify() function registers all the callback functions to - allow the bus driver to call these functions when the + allow the bus driver to call these functions when the SlaveAddress/Data pair happens. - + @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance. - + @param SlaveAddress Address that the host controller detects as sending a message and calls all the registered function. @@ -261,7 +261,7 @@ EFI_STATUS Data pair. @retval EFI_SUCCESS NotifyFunction was registered. - + @retval EFI_UNSUPPORTED ArpDevice, GetArpMap, and Notify are not implemented by this driver. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmAccess2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmAccess2.h index f202d557aa..4b5619b0b4 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmAccess2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmAccess2.h @@ -5,20 +5,20 @@ It abstracts the location and characteristics of SMRAM. The expectation is that the north bridge or memory controller would publish this protocol. - The principal functionality found in the memory controller includes the following: + The principal functionality found in the memory controller includes the following: - Exposing the SMRAM to all non-SMM agents, or the "open" state - Shrouding the SMRAM to all but the SMM agents, or the "closed" state - - Preserving the system integrity, or "locking" the SMRAM, such that the settings cannot be - perturbed by either boot service or runtime agents + - Preserving the system integrity, or "locking" the SMRAM, such that the settings cannot be + perturbed by either boot service or runtime agents Copyright (c) 2009 - 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmBase2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmBase2.h index 393ce679ac..1d8b447584 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmBase2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmBase2.h @@ -5,13 +5,13 @@ whether the driver is being invoked inside SMRAM or outside of SMRAM. Copyright (c) 2009 - 2017, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -27,13 +27,13 @@ typedef struct _EFI_SMM_BASE2_PROTOCOL EFI_SMM_BASE2_PROTOCOL; /** Service to indicate whether the driver is currently executing in the SMM Initialization phase. - - This service is used to indicate whether the driver is currently executing in the SMM Initialization - phase. For SMM drivers, this will return TRUE in InSmram while inside the driver's entry point and + + This service is used to indicate whether the driver is currently executing in the SMM Initialization + phase. For SMM drivers, this will return TRUE in InSmram while inside the driver's entry point and otherwise FALSE. For combination SMM/DXE drivers, this will return FALSE in the DXE launch. For the SMM launch, it behaves as an SMM driver. - @param[in] This The EFI_SMM_BASE2_PROTOCOL instance. + @param[in] This The EFI_SMM_BASE2_PROTOCOL instance. @param[out] InSmram Pointer to a Boolean which, on return, indicates that the driver is currently executing inside of SMRAM (TRUE) or outside of SMRAM (FALSE). @@ -51,8 +51,8 @@ EFI_STATUS /** Returns the location of the System Management Service Table (SMST). - This function returns the location of the System Management Service Table (SMST). The use of the - API is such that a driver can discover the location of the SMST in its entry point and then cache it in + This function returns the location of the System Management Service Table (SMST). The use of the + API is such that a driver can discover the location of the SMST in its entry point and then cache it in some driver global variable so that the SMST can be invoked in subsequent handlers. @param[in] This The EFI_SMM_BASE2_PROTOCOL instance. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmCommunication.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmCommunication.h index 189dd72f40..367e398f6c 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmCommunication.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmCommunication.h @@ -1,17 +1,17 @@ /** @file EFI SMM Communication Protocol as defined in the PI 1.2 specification. - This protocol provides a means of communicating between drivers outside of SMM and SMI - handlers inside of SMM. + This protocol provides a means of communicating between drivers outside of SMM and SMI + handlers inside of SMM. Copyright (c) 2009 - 2017, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmConfiguration.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmConfiguration.h index e26112cca9..9ffdeafa1f 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmConfiguration.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmConfiguration.h @@ -5,15 +5,15 @@ 1) report the portions of SMRAM regions which cannot be used for the SMRAM heap. 2) register the SMM Foundation entry point with the processor code. The entry point will be invoked by the SMM processor entry code. - + Copyright (c) 2009 - 2017, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -30,12 +30,12 @@ /// typedef struct _EFI_SMM_RESERVED_SMRAM_REGION { /// - /// Starting address of the reserved SMRAM area, as it appears while SMRAM is open. + /// Starting address of the reserved SMRAM area, as it appears while SMRAM is open. /// Ignored if SmramReservedSize is 0. /// EFI_PHYSICAL_ADDRESS SmramReservedStart; /// - /// Number of bytes occupied by the reserved SMRAM area. A size of zero indicates the + /// Number of bytes occupied by the reserved SMRAM area. A size of zero indicates the /// last SMRAM area. /// UINT64 SmramReservedSize; @@ -45,13 +45,13 @@ typedef struct _EFI_SMM_CONFIGURATION_PROTOCOL EFI_SMM_CONFIGURATION_PROTOCOL; /** Register the SMM Foundation entry point. - - This function registers the SMM Foundation entry point with the processor code. This entry point + + This function registers the SMM Foundation entry point with the processor code. This entry point will be invoked by the SMM Processor entry code. @param[in] This The EFI_SMM_CONFIGURATION_PROTOCOL instance. @param[in] SmmEntryPoint SMM Foundation entry point. - + @retval EFI_SUCCESS Success to register SMM Entry Point. @retval EFI_INVALID_PARAMETER SmmEntryPoint is NULL. **/ @@ -64,10 +64,10 @@ EFI_STATUS /// /// The EFI SMM Configuration Protocol is a mandatory protocol published by a DXE CPU driver to -/// indicate which areas within SMRAM are reserved for use by the CPU for any purpose, +/// indicate which areas within SMRAM are reserved for use by the CPU for any purpose, /// such as stack, save state or SMM entry point. /// -/// The RegisterSmmEntry() function allows the SMM IPL DXE driver to register the SMM +/// The RegisterSmmEntry() function allows the SMM IPL DXE driver to register the SMM /// Foundation entry point with the SMM entry vector code. /// struct _EFI_SMM_CONFIGURATION_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmControl2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmControl2.h index 9e558c25c3..90ed7eecf6 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmControl2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmControl2.h @@ -3,22 +3,22 @@ This protocol is used initiate synchronous SMI activations. This protocol could be published by a processor driver to abstract the SMI IPI or a driver which abstracts the ASIC that is supporting the - APM port. Because of the possibility of performing SMI IPI transactions, the ability to generate this + APM port. Because of the possibility of performing SMI IPI transactions, the ability to generate this event from a platform chipset agent is an optional capability for both IA-32 and x64-based systems. - The EFI_SMM_CONTROL2_PROTOCOL is produced by a runtime driver. It provides an - abstraction of the platform hardware that generates an SMI. There are often I/O ports that, when - accessed, will generate the SMI. Also, the hardware optionally supports the periodic generation of + The EFI_SMM_CONTROL2_PROTOCOL is produced by a runtime driver. It provides an + abstraction of the platform hardware that generates an SMI. There are often I/O ports that, when + accessed, will generate the SMI. Also, the hardware optionally supports the periodic generation of these signals. Copyright (c) 2009 - 2017, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmCpu.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmCpu.h index fc9fc04bca..364f08ff96 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmCpu.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmCpu.h @@ -1,19 +1,19 @@ /** @file EFI SMM CPU Protocol as defined in the PI 1.2 specification. - This protocol allows SMM drivers to access architecture-standard registers from any of the CPU - save state areas. In some cases, difference processors provide the same information in the save state, - but not in the same format. These so-called pseudo-registers provide this information in a standard - format. + This protocol allows SMM drivers to access architecture-standard registers from any of the CPU + save state areas. In some cases, difference processors provide the same information in the save state, + but not in the same format. These so-called pseudo-registers provide this information in a standard + format. Copyright (c) 2009 - 2017, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmGpiDispatch2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmGpiDispatch2.h index 7bec318662..086b9587a2 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmGpiDispatch2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmGpiDispatch2.h @@ -2,11 +2,11 @@ SMM General Purpose Input (GPI) Dispatch2 Protocol as defined in PI 1.1 Specification Volume 4 System Management Mode Core Interface. - This protocol provides the parent dispatch service for the General Purpose Input + This protocol provides the parent dispatch service for the General Purpose Input (GPI) SMI source generator. - The EFI_SMM_GPI_DISPATCH2_PROTOCOL provides the ability to install child handlers for the - given event types. Several inputs can be enabled. This purpose of this interface is to generate an + The EFI_SMM_GPI_DISPATCH2_PROTOCOL provides the ability to install child handlers for the + given event types. Several inputs can be enabled. This purpose of this interface is to generate an SMI in response to any of these inputs having a true value provided. Copyright (c) 2009 - 2017, Intel Corporation. All rights reserved.<BR> diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmPciRootBridgeIo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmPciRootBridgeIo.h index 506befc261..743b546c0c 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmPciRootBridgeIo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmPciRootBridgeIo.h @@ -22,8 +22,8 @@ #define EFI_SMM_PCI_ROOT_BRIDGE_IO_PROTOCOL_GUID EFI_MM_PCI_ROOT_BRIDGE_IO_PROTOCOL_GUID /// -/// This protocol provides the same functionality as the PCI Root Bridge I/O Protocol defined in the -/// UEFI 2.1 Specifcation, section 13.2, except that the functions for Map() and Unmap() may return +/// This protocol provides the same functionality as the PCI Root Bridge I/O Protocol defined in the +/// UEFI 2.1 Specifcation, section 13.2, except that the functions for Map() and Unmap() may return /// EFI_UNSUPPORTED. /// typedef EFI_MM_PCI_ROOT_BRIDGE_IO_PROTOCOL EFI_SMM_PCI_ROOT_BRIDGE_IO_PROTOCOL; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmPeriodicTimerDispatch2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmPeriodicTimerDispatch2.h index a52daa03c7..bc69d98084 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmPeriodicTimerDispatch2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmPeriodicTimerDispatch2.h @@ -47,21 +47,21 @@ /// typedef struct { /// - /// The minimum period of time in 100 nanosecond units that the child gets called. The + /// The minimum period of time in 100 nanosecond units that the child gets called. The /// child will be called back after a time greater than the time Period. /// UINT64 Period; /// - /// The period of time interval between SMIs. Children of this interface should use this - /// field when registering for periodic timer intervals when a finer granularity periodic + /// The period of time interval between SMIs. Children of this interface should use this + /// field when registering for periodic timer intervals when a finer granularity periodic /// SMI is desired. /// UINT64 SmiTickInterval; } EFI_SMM_PERIODIC_TIMER_REGISTER_CONTEXT; /// -/// The DispatchFunction will be called with Context set to the same value as was passed into -/// Register() in RegisterContext and with CommBuffer pointing to an instance of +/// The DispatchFunction will be called with Context set to the same value as was passed into +/// Register() in RegisterContext and with CommBuffer pointing to an instance of /// EFI_SMM_PERIODIC_TIMER_CONTEXT and CommBufferSize pointing to its size. /// typedef EFI_MM_PERIODIC_TIMER_CONTEXT EFI_SMM_PERIODIC_TIMER_CONTEXT; @@ -71,22 +71,22 @@ typedef struct _EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL EFI_SMM_PERIODIC_TIME /** Register a child SMI source dispatch function for SMM periodic timer. - This service registers a function (DispatchFunction) which will be called when at least the - amount of time specified by RegisterContext has elapsed. On return, DispatchHandle + This service registers a function (DispatchFunction) which will be called when at least the + amount of time specified by RegisterContext has elapsed. On return, DispatchHandle contains a unique handle which may be used later to unregister the function using UnRegister(). - The DispatchFunction will be called with Context set to the same value as was passed into - this function in RegisterContext and with CommBuffer pointing to an instance of + The DispatchFunction will be called with Context set to the same value as was passed into + this function in RegisterContext and with CommBuffer pointing to an instance of EFI_SMM_PERIODIC_TIMER_CONTEXT and CommBufferSize pointing to its size. @param[in] This Pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL instance. @param[in] DispatchFunction Function to register for handler when at least the specified amount - of time has elapsed. + of time has elapsed. @param[in] RegisterContext Pointer to the dispatch function's context. The caller fills this context in before calling the register function to indicate to the register function the period at which the dispatch function should be invoked. - @param[out] DispatchHandle Handle generated by the dispatcher to track the function instance. + @param[out] DispatchHandle Handle generated by the dispatcher to track the function instance. @retval EFI_SUCCESS The dispatch function has been successfully registered and the SMI source has been enabled. @@ -107,7 +107,7 @@ EFI_STATUS /** Unregisters a periodic timer service. - This service removes the handler associated with DispatchHandle so that it will no longer be + This service removes the handler associated with DispatchHandle so that it will no longer be called when the time has elapsed. @param[in] This Pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL instance. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmReportStatusCodeHandler.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmReportStatusCodeHandler.h index 498954ba23..222ebe7a71 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmReportStatusCodeHandler.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmReportStatusCodeHandler.h @@ -1,6 +1,6 @@ /** @file This protocol provides registering and unregistering services to status code consumers while in DXE SMM. - + Copyright (c) 2007 - 2017, 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 diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmStatusCode.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmStatusCode.h index 6c89493c5c..66919e5b8b 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmStatusCode.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmStatusCode.h @@ -1,16 +1,16 @@ /** @file EFI SMM Status Code Protocol as defined in the PI 1.2 specification. - This protocol provides the basic status code services while in SMM. + This protocol provides the basic status code services while in SMM. Copyright (c) 2009 - 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmSwDispatch2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmSwDispatch2.h index 6018ac73da..276699f484 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmSwDispatch2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SmmSwDispatch2.h @@ -33,9 +33,9 @@ typedef struct { } EFI_SMM_SW_REGISTER_CONTEXT; /// -/// The DispatchFunction will be called with Context set to the same value as was passed into +/// The DispatchFunction will be called with Context set to the same value as was passed into /// this function in RegisterContext and with CommBuffer (and CommBufferSize) pointing -/// to an instance of EFI_SMM_SW_CONTEXT indicating the index of the CPU which generated the +/// to an instance of EFI_SMM_SW_CONTEXT indicating the index of the CPU which generated the /// software SMI. /// typedef struct { @@ -58,14 +58,14 @@ typedef struct _EFI_SMM_SW_DISPATCH2_PROTOCOL EFI_SMM_SW_DISPATCH2_PROTOCOL; /** Register a child SMI source dispatch function for the specified software SMI. - This service registers a function (DispatchFunction) which will be called when the software - SMI source specified by RegisterContext->SwSmiCpuIndex is detected. On return, - DispatchHandle contains a unique handle which may be used later to unregister the function + This service registers a function (DispatchFunction) which will be called when the software + SMI source specified by RegisterContext->SwSmiCpuIndex is detected. On return, + DispatchHandle contains a unique handle which may be used later to unregister the function using UnRegister(). @param[in] This Pointer to the EFI_SMM_SW_DISPATCH2_PROTOCOL instance. - @param[in] DispatchFunction Function to register for handler when the specified software - SMI is generated. + @param[in] DispatchFunction Function to register for handler when the specified software + SMI is generated. @param[in, out] RegisterContext Pointer to the dispatch function's context. The caller fills this context in before calling the register function to indicate to the register @@ -96,7 +96,7 @@ EFI_STATUS /** Unregister a child SMI source dispatch function for the specified software SMI. - This service removes the handler associated with DispatchHandle so that it will no longer be + This service removes the handler associated with DispatchHandle so that it will no longer be called in response to a software SMI. @param[in] This Pointer to the EFI_SMM_SW_DISPATCH2_PROTOCOL instance. @@ -115,15 +115,15 @@ EFI_STATUS /// /// Interface structure for the SMM Software SMI Dispatch Protocol. /// -/// The EFI_SMM_SW_DISPATCH2_PROTOCOL provides the ability to install child handlers for the -/// given software. These handlers will respond to software interrupts, and the maximum software +/// The EFI_SMM_SW_DISPATCH2_PROTOCOL provides the ability to install child handlers for the +/// given software. These handlers will respond to software interrupts, and the maximum software /// interrupt in the EFI_SMM_SW_REGISTER_CONTEXT is denoted by MaximumSwiValue. /// struct _EFI_SMM_SW_DISPATCH2_PROTOCOL { EFI_SMM_SW_REGISTER2 Register; EFI_SMM_SW_UNREGISTER2 UnRegister; /// - /// A read-only field that describes the maximum value that can be used in the + /// A read-only field that describes the maximum value that can be used in the /// EFI_SMM_SW_DISPATCH2_PROTOCOL.Register() service. /// UINTN MaximumSwiValue; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/StatusCode.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/StatusCode.h index d5c62260a0..57df4184af 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/StatusCode.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/StatusCode.h @@ -2,13 +2,13 @@ Status code Runtime Protocol as defined in PI Specification 1.4a VOLUME 2 DXE Copyright (c) 2006 - 2016, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/StorageSecurityCommand.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/StorageSecurityCommand.h index 3fa6cbcd8e..4f806afd4f 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/StorageSecurityCommand.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/StorageSecurityCommand.h @@ -149,7 +149,7 @@ EFI_STATUS of the security protocol command. A Timeout value of 0 means that this function will wait indefinitely for the security protocol command to execute. If Timeout is greater - than zero, then this function will return EFI_TIMEOUT if the + than zero, then this function will return EFI_TIMEOUT if the time required to execute the receive data command is greater than Timeout. @param SecurityProtocolId The value of the "Security Protocol" parameter of the security protocol command to be sent. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SuperIo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SuperIo.h index f9714e2d1f..a645dc2576 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SuperIo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SuperIo.h @@ -6,13 +6,13 @@ routine of the Super I/O driver, the device is disabled and Super I/O protocol is uninstalled. 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -33,12 +33,12 @@ typedef struct { UINT8 AndMask; ///< Bitwise AND mask. UINT8 OrMask; ///< Bitwise OR mask. } EFI_SIO_REGISTER_MODIFY; - + typedef struct _EFI_SIO_PROTOCOL EFI_SIO_PROTOCOL; - + /** Provides a low level access to the registers for the Super I/O. - + @param[in] This Indicates a pointer to the calling context. @param[in] Write Specifies the type of the register operation. If this parameter is TRUE, Value is interpreted as an input parameter and the operation is a register write. If this parameter @@ -53,13 +53,13 @@ typedef struct _EFI_SIO_PROTOCOL EFI_SIO_PROTOCOL; @param[in] Register Register number. @param[in, out] Value If Write is TRUE, Value is a pointer to the buffer containing the byte of data to be written to the Super I/O register. If Write is FALSE, Value is a pointer to the - destination buffer for the byte of data to be read from the Super I/O register. + destination buffer for the byte of data to be read from the Super I/O register. @retval EFI_SUCCESS The operation completed successfully @retval EFI_INVALID_PARAMETER The Value is NULL @retval EFI_INVALID_PARAMETER Invalid Register number - -**/ + +**/ typedef EFI_STATUS (EFIAPI *EFI_SIO_REGISTER_ACCESS)( @@ -69,36 +69,36 @@ EFI_STATUS IN UINT8 Register, IN OUT UINT8 *Value ); - + /** Provides an interface to get a list of the current resources consumed by the device in the ACPI Resource Descriptor format. - + GetResources() returns a list of resources currently consumed by the device. The ResourceList is a pointer to the buffer containing resource descriptors for the device. The descriptors are in the format of Small or Large ACPI resource descriptor as defined by ACPI specification (2.0 & 3.0). The buffer of resource descriptors is terminated with the 'End tag' resource descriptor. - + @param[in] This Indicates a pointer to the calling context. @param[out] ResourceList A pointer to an ACPI resource descriptor list that defines the current resources used by the device. Type ACPI_RESOURCE_HEADER_PTR is defined in the "Related Definitions" below. - + @retval EFI_SUCCESS The operation completed successfully @retval EFI_INVALID_PARAMETER ResourceList is NULL - -**/ + +**/ typedef EFI_STATUS (EFIAPI *EFI_SIO_GET_RESOURCES)( IN CONST EFI_SIO_PROTOCOL *This, OUT ACPI_RESOURCE_HEADER_PTR *ResourceList ); - + /** Sets the resources for the device. - + @param[in] This Indicates a pointer to the calling context. @param[in] ResourceList Pointer to the ACPI resource descriptor list. Type ACPI_RESOURCE_HEADER_PTR is defined in the "Related Definitions" section of @@ -107,35 +107,35 @@ EFI_STATUS @retval EFI_SUCCESS The operation completed successfully @retval EFI_INVALID_PARAMETER ResourceList is invalid @retval EFI_ACCESS_DENIED Some of the resources in ResourceList are in use - -**/ + +**/ typedef EFI_STATUS (EFIAPI *EFI_SIO_SET_RESOURCES)( IN CONST EFI_SIO_PROTOCOL *This, IN ACPI_RESOURCE_HEADER_PTR ResourceList ); - + /** Provides a collection of resource descriptor lists. Each resource descriptor list in the collection defines a combination of resources that can potentially be used by the device. - + @param[in] This Indicates a pointer to the calling context. @param[out] ResourceCollection Collection of the resource descriptor lists. - + @retval EFI_SUCCESS The operation completed successfully @retval EFI_INVALID_PARAMETER ResourceCollection is NULL -**/ +**/ typedef EFI_STATUS (EFIAPI *EFI_SIO_POSSIBLE_RESOURCES)( IN CONST EFI_SIO_PROTOCOL *This, OUT ACPI_RESOURCE_HEADER_PTR *ResourceCollection ); - + /** Provides an interface for a table based programming of the Super I/O registers. - + The Modify() function provides an interface for table based programming of the Super I/O registers. This function can be used to perform programming of multiple Super I/O registers with a single function call. For each table entry, the Register is read, its content is bitwise ANDed with @@ -148,12 +148,12 @@ EFI_STATUS @param[in] Command A pointer to an array of NumberOfCommands EFI_SIO_REGISTER_MODIFY structures. Each structure specifies a single Super I/O register modify operation. Type EFI_SIO_REGISTER_MODIFY is defined in the "Related Definitions" below. - @param[in] NumberOfCommands Number of elements in the Command array. - + @param[in] NumberOfCommands Number of elements in the Command array. + @retval EFI_SUCCESS The operation completed successfully @retval EFI_INVALID_PARAMETER Command is NULL - -**/ + +**/ typedef EFI_STATUS (EFIAPI *EFI_SIO_MODIFY)( @@ -161,14 +161,14 @@ EFI_STATUS IN CONST EFI_SIO_REGISTER_MODIFY *Command, IN UINTN NumberOfCommands ); - + struct _EFI_SIO_PROTOCOL { EFI_SIO_REGISTER_ACCESS RegisterAccess; EFI_SIO_GET_RESOURCES GetResources; EFI_SIO_SET_RESOURCES SetResources; EFI_SIO_POSSIBLE_RESOURCES PossibleResources; EFI_SIO_MODIFY Modify; -}; +}; extern EFI_GUID gEfiSioProtocolGuid; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SuperIoControl.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SuperIoControl.h index 0bcfb5a473..4c3d03daac 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SuperIoControl.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/SuperIoControl.h @@ -4,13 +4,13 @@ driver model. Copyright (c) 2015, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This protocol is from PI Version 1.2.1. @@ -38,7 +38,7 @@ typedef struct _EFI_SIO_CONTROL_PROTOCOL *PEFI_SIO_CONTROL_PROTOCOL; @retval EFI_SUCCESS The device is enabled successfully. @retval EFI_OUT_OF_RESOURCES The device could not be enabled because there - were insufficient resources either for the device + were insufficient resources either for the device itself or for the records needed to track the device. @retval EFI_ALREADY_STARTED The device is already enabled. @retval EFI_UNSUPPORTED The device cannot be enabled. @@ -61,7 +61,7 @@ EFI_STATUS @retval EFI_SUCCESS The device is disabled successfully. @retval EFI_OUT_OF_RESOURCES The device could not be disabled because there - were insufficient resources either for the device + were insufficient resources either for the device itself or for the records needed to track the device. @retval EFI_ALREADY_STARTED The device is already disabled. @retval EFI_UNSUPPORTED The device cannot be disabled. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/TapeIo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/TapeIo.h index 74c7b3f658..bdfe244c3f 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/TapeIo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/TapeIo.h @@ -3,13 +3,13 @@ Provide services to control and access a tape device. 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -70,13 +70,13 @@ typedef struct _EFI_TAPE_HEADER { from the media. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_TAPE_READ)( IN EFI_TAPE_IO_PROTOCOL *This, IN OUT UINTN *BufferSize, OUT VOID *Buffer - ); + ); /** Writes to the tape. @@ -106,14 +106,14 @@ EFI_STATUS from the media. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_TAPE_WRITE)( IN EFI_TAPE_IO_PROTOCOL *This, IN UINTN *BufferSize, IN VOID *Buffer - ); - + ); + /** Rewinds the tape. @@ -129,11 +129,11 @@ EFI_STATUS @retval EFI_DEVICE_ERROR A device error occurred while attempting to reposition the media. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_TAPE_REWIND)( IN EFI_TAPE_IO_PROTOCOL *This - ); + ); /** @@ -143,7 +143,7 @@ EFI_STATUS @param Direction Direction and number of data blocks or filemarks to space over on media. @param Type Type of mark to space over on media. The following Type marks are mandatory: - BLOCK type : 0 + BLOCK type : 0 FILEMARK type : 1 @retval EFI_SUCCESS The media was successfully repositioned. @@ -166,7 +166,7 @@ EFI_STATUS IN EFI_TAPE_IO_PROTOCOL *This, IN INTN Direction, IN UINTN Type - ); + ); /** @@ -187,12 +187,12 @@ EFI_STATUS @retval EFI_DEVICE_ERROR A device error occurred while attempting to transfer data from the media. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_TAPE_WRITEFM)( IN EFI_TAPE_IO_PROTOCOL *This, IN UINTN Count - ); + ); /** @@ -210,17 +210,17 @@ EFI_STATUS @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the bus and/or device. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_TAPE_RESET)( IN EFI_TAPE_IO_PROTOCOL *This, IN BOOLEAN ExtendedVerification - ); + ); /// -/// The EFI_TAPE_IO_PROTOCOL provides basic sequential operations for tape devices. -/// These include read, write, rewind, space, write filemarks and reset functions. -/// Per this specification, a boot application uses the services of this protocol +/// The EFI_TAPE_IO_PROTOCOL provides basic sequential operations for tape devices. +/// These include read, write, rewind, space, write filemarks and reset functions. +/// Per this specification, a boot application uses the services of this protocol /// to load the bootloader image from tape. /// struct _EFI_TAPE_IO_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Tcg2Protocol.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Tcg2Protocol.h index 042bdffa1f..02dadcbc25 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Tcg2Protocol.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Tcg2Protocol.h @@ -3,12 +3,12 @@ See http://trustedcomputinggroup.org for the latest specification Copyright (c) 2015, 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 +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 -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -44,13 +44,13 @@ typedef struct tdEFI_TCG2_BOOT_SERVICE_CAPABILITY { // // Version of the EFI_TCG2_BOOT_SERVICE_CAPABILITY structure itself. // For this version of the protocol, the Major version shall be set to 1 - // and the Minor version shall be set to 1. + // and the Minor version shall be set to 1. // EFI_TCG2_VERSION StructureVersion; // // Version of the EFI TCG2 protocol. // For this version of the protocol, the Major version shall be set to 1 - // and the Minor version shall be set to 1. + // and the Minor version shall be set to 1. // EFI_TCG2_VERSION ProtocolVersion; // @@ -116,7 +116,7 @@ typedef struct tdEFI_TCG2_BOOT_SERVICE_CAPABILITY { typedef struct { // - // Size of the event header itself (sizeof(EFI_TCG2_EVENT_HEADER)). + // Size of the event header itself (sizeof(EFI_TCG2_EVENT_HEADER)). // UINT32 HeaderSize; // @@ -124,18 +124,18 @@ typedef struct { // UINT16 HeaderVersion; // - // Index of the PCR that shall be extended (0 - 23). + // Index of the PCR that shall be extended (0 - 23). // TCG_PCRINDEX PCRIndex; // - // Type of the event that shall be extended (and optionally logged). + // Type of the event that shall be extended (and optionally logged). // TCG_EVENTTYPE EventType; } EFI_TCG2_EVENT_HEADER; typedef struct tdEFI_TCG2_EVENT { // - // Total size of the event including the Size component, the header and the Event data. + // Total size of the event including the Size component, the header and the Event data. // UINT32 Size; EFI_TCG2_EVENT_HEADER Header; @@ -157,11 +157,11 @@ typedef struct tdEFI_TCG2_EVENT { @retval EFI_SUCCESS Operation completed successfully. @retval EFI_DEVICE_ERROR The command was unsuccessful. - The ProtocolCapability variable will not be populated. + The ProtocolCapability variable will not be populated. @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect. The ProtocolCapability variable will not be populated. @retval EFI_BUFFER_TOO_SMALL The ProtocolCapability variable is too small to hold the full response. - It will be partially populated (required Size field will be set). + It will be partially populated (required Size field will be set). **/ typedef EFI_STATUS @@ -172,7 +172,7 @@ EFI_STATUS /** The EFI_TCG2_PROTOCOL Get Event Log function call allows a caller to - retrieve the address of a given event log and its last entry. + retrieve the address of a given event log and its last entry. @param[in] This Indicates the calling context @param[in] EventLogFormat The type of the event log for which the information is requested. @@ -200,13 +200,13 @@ EFI_STATUS /** The EFI_TCG2_PROTOCOL HashLogExtendEvent function call provides callers with an opportunity to extend and optionally log events without requiring - knowledge of actual TPM commands. + knowledge of actual TPM commands. The extend operation will occur even if this function cannot create an event - log entry (e.g. due to the event log being full). + log entry (e.g. due to the event log being full). @param[in] This Indicates the calling context @param[in] Flags Bitmap providing additional information. - @param[in] DataToHash Physical address of the start of the data buffer to be hashed. + @param[in] DataToHash Physical address of the start of the data buffer to be hashed. @param[in] DataToHashLen The length in bytes of the buffer referenced by DataToHash. @param[in] EfiTcgEvent Pointer to data buffer containing information about the event. @@ -238,7 +238,7 @@ EFI_STATUS @retval EFI_SUCCESS The command byte stream was successfully sent to the device and a response was successfully received. @retval EFI_DEVICE_ERROR The command was not successfully sent to the device or a response was not successfully received from the device. @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect. - @retval EFI_BUFFER_TOO_SMALL The output parameter block is too small. + @retval EFI_BUFFER_TOO_SMALL The output parameter block is too small. **/ typedef EFI_STATUS @@ -257,7 +257,7 @@ EFI_STATUS @param[out] ActivePcrBanks Pointer to the variable receiving the bitmap of currently active PCR banks. @retval EFI_SUCCESS The bitmap of active PCR banks was stored in the ActivePcrBanks parameter. - @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect. + @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect. **/ typedef EFI_STATUS diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/TcgService.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/TcgService.h index 7e8ba0c256..5abe5f9b30 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/TcgService.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/TcgService.h @@ -3,12 +3,12 @@ See http://trustedcomputinggroup.org for the latest specification Copyright (c) 2007 - 2014, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +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. **/ @@ -19,7 +19,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include <IndustryStandard/UefiTcgPlatform.h> #define EFI_TCG_PROTOCOL_GUID \ - {0xf541796d, 0xa62e, 0x4954, { 0xa7, 0x75, 0x95, 0x84, 0xf6, 0x1b, 0x9c, 0xdd } } + {0xf541796d, 0xa62e, 0x4954, { 0xa7, 0x75, 0x95, 0x84, 0xf6, 0x1b, 0x9c, 0xdd } } typedef struct _EFI_TCG_PROTOCOL EFI_TCG_PROTOCOL; @@ -32,9 +32,9 @@ typedef struct { typedef struct _TCG_EFI_BOOT_SERVICE_CAPABILITY { UINT8 Size; /// Size of this structure. - TCG_VERSION StructureVersion; + TCG_VERSION StructureVersion; TCG_VERSION ProtocolSpecVersion; - UINT8 HashAlgorithmBitmap; /// Hash algorithms . + UINT8 HashAlgorithmBitmap; /// Hash algorithms . /// This protocol is capable of : 01=SHA-1. BOOLEAN TPMPresentFlag; /// 00h = TPM not present. BOOLEAN TPMDeactivatedFlag; /// 01h = TPM currently deactivated. @@ -43,22 +43,22 @@ typedef struct _TCG_EFI_BOOT_SERVICE_CAPABILITY { typedef UINT32 TCG_ALGORITHM_ID; /** - This service provides EFI protocol capability information, state information + This service provides EFI protocol capability information, state information about the TPM, and Event Log state information. @param This Indicates the calling context - @param ProtocolCapability The callee allocates memory for a TCG_BOOT_SERVICE_CAPABILITY - structure and fills in the fields with the EFI protocol + @param ProtocolCapability The callee allocates memory for a TCG_BOOT_SERVICE_CAPABILITY + structure and fills in the fields with the EFI protocol capability information and the current TPM state information. - @param TCGFeatureFlags This is a pointer to the feature flags. No feature - flags are currently defined so this parameter - MUST be set to 0. However, in the future, - feature flags may be defined that, for example, + @param TCGFeatureFlags This is a pointer to the feature flags. No feature + flags are currently defined so this parameter + MUST be set to 0. However, in the future, + feature flags may be defined that, for example, enable hash algorithm agility. @param EventLogLocation This is a pointer to the address of the event log in memory. - @param EventLogLastEntry If the Event Log contains more than one entry, - this is a pointer to the address of the start of - the last entry in the event log in memory. + @param EventLogLastEntry If the Event Log contains more than one entry, + this is a pointer to the address of the start of + the last entry in the event log in memory. @retval EFI_SUCCESS The operation completed successfully. @retval EFI_INVALID_PARAMETER ProtocolCapability does not match TCG capability. @@ -76,14 +76,14 @@ EFI_STATUS /** This service abstracts the capability to do a hash operation on a data buffer. - + @param This Indicates the calling context. @param HashData The pointer to the data buffer to be hashed. @param HashDataLen The length of the data buffer to be hashed. @param AlgorithmId Identification of the Algorithm to use for the hashing operation. @param HashedDataLen Resultant length of the hashed data. @param HashedDataResult Resultant buffer of the hashed data. - + @retval EFI_SUCCESS The operation completed successfully. @retval EFI_INVALID_PARAMETER HashDataLen is NULL. @retval EFI_INVALID_PARAMETER HashDataLenResult is NULL. @@ -106,15 +106,15 @@ EFI_STATUS This service abstracts the capability to add an entry to the Event Log. @param This Indicates the calling context - @param TCGLogData The pointer to the start of the data buffer containing - the TCG_PCR_EVENT data structure. All fields in + @param TCGLogData The pointer to the start of the data buffer containing + the TCG_PCR_EVENT data structure. All fields in this structure are properly filled by the caller. @param EventNumber The event number of the event just logged. - @param Flags Indicates additional flags. Only one flag has been - defined at this time, which is 0x01 and means the - extend operation should not be performed. All - other bits are reserved. - + @param Flags Indicates additional flags. Only one flag has been + defined at this time, which is 0x01 and means the + extend operation should not be performed. All + other bits are reserved. + @retval EFI_SUCCESS The operation completed successfully. @retval EFI_OUT_OF_RESOURCES Insufficient memory in the event log to complete this action. **/ @@ -155,17 +155,17 @@ EFI_STATUS This service abstracts the capability to do a hash operation on a data buffer, extend a specific TPM PCR with the hash result, and add an entry to the Event Log @param This Indicates the calling context - @param HashData The physical address of the start of the data buffer + @param HashData The physical address of the start of the data buffer to be hashed, extended, and logged. @param HashDataLen The length, in bytes, of the buffer referenced by HashData @param AlgorithmId Identification of the Algorithm to use for the hashing operation - @param TCGLogData The physical address of the start of the data + @param TCGLogData The physical address of the start of the data buffer containing the TCG_PCR_EVENT data structure. @param EventNumber The event number of the event just logged. - @param EventLogLastEntry The physical address of the first byte of the entry - just placed in the Event Log. If the Event Log was - empty when this function was called then this physical - address will be the same as the physical address of + @param EventLogLastEntry The physical address of the first byte of the entry + just placed in the Event Log. If the Event Log was + empty when this function was called then this physical + address will be the same as the physical address of the start of the Event Log. @retval EFI_SUCCESS The operation completed successfully. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Tcp4.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Tcp4.h index 49d279b013..1193edf438 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Tcp4.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Tcp4.h @@ -5,12 +5,12 @@ The EFI TCPv4 Protocol provides services to send and receive data stream. Copyright (c) 2006 - 2014, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +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. @par Revision Reference: diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Timer.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Timer.h index 29d65215b1..26b17969d3 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Timer.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Timer.h @@ -4,13 +4,13 @@ This code is used to provide the timer tick for the DXE core. Copyright (c) 2006 - 2016, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -29,10 +29,10 @@ typedef struct _EFI_TIMER_ARCH_PROTOCOL EFI_TIMER_ARCH_PROTOCOL; /** - This function of this type is called when a timer interrupt fires. This + This function of this type is called when a timer interrupt fires. This function executes at TPL_HIGH_LEVEL. The DXE Core will register a function - of this type to be called for the timer interrupt, so it can know how much - time has passed. This information is used to signal timer based events. + of this type to be called for the timer interrupt, so it can know how much + time has passed. This information is used to signal timer based events. @param Time Time since the last timer interrupt in 100 ns units. This will typically be TimerPeriod, but if a timer interrupt is missed, and the @@ -49,16 +49,16 @@ VOID ); /** - This function registers the handler NotifyFunction so it is called every time - the timer interrupt fires. It also passes the amount of time since the last - handler call to the NotifyFunction. If NotifyFunction is NULL, then the - handler is unregistered. If the handler is registered, then EFI_SUCCESS is - returned. If the CPU does not support registering a timer interrupt handler, - then EFI_UNSUPPORTED is returned. If an attempt is made to register a handler - when a handler is already registered, then EFI_ALREADY_STARTED is returned. - If an attempt is made to unregister a handler when a handler is not registered, - then EFI_INVALID_PARAMETER is returned. If an error occurs attempting to - register the NotifyFunction with the timer interrupt, then EFI_DEVICE_ERROR + This function registers the handler NotifyFunction so it is called every time + the timer interrupt fires. It also passes the amount of time since the last + handler call to the NotifyFunction. If NotifyFunction is NULL, then the + handler is unregistered. If the handler is registered, then EFI_SUCCESS is + returned. If the CPU does not support registering a timer interrupt handler, + then EFI_UNSUPPORTED is returned. If an attempt is made to register a handler + when a handler is already registered, then EFI_ALREADY_STARTED is returned. + If an attempt is made to unregister a handler when a handler is not registered, + then EFI_INVALID_PARAMETER is returned. If an error occurs attempting to + register the NotifyFunction with the timer interrupt, then EFI_DEVICE_ERROR is returned. @param This The EFI_TIMER_ARCH_PROTOCOL instance. @@ -77,7 +77,7 @@ VOID @retval EFI_DEVICE_ERROR The timer handler could not be registered. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_TIMER_REGISTER_HANDLER)( IN EFI_TIMER_ARCH_PROTOCOL *This, @@ -85,17 +85,17 @@ EFI_STATUS ); /** - This function adjusts the period of timer interrupts to the value specified - by TimerPeriod. If the timer period is updated, then the selected timer - period is stored in EFI_TIMER.TimerPeriod, and EFI_SUCCESS is returned. If - the timer hardware is not programmable, then EFI_UNSUPPORTED is returned. - If an error occurs while attempting to update the timer period, then the - timer hardware will be put back in its state prior to this call, and - EFI_DEVICE_ERROR is returned. If TimerPeriod is 0, then the timer interrupt - is disabled. This is not the same as disabling the CPU's interrupts. - Instead, it must either turn off the timer hardware, or it must adjust the - interrupt controller so that a CPU interrupt is not generated when the timer - interrupt fires. + This function adjusts the period of timer interrupts to the value specified + by TimerPeriod. If the timer period is updated, then the selected timer + period is stored in EFI_TIMER.TimerPeriod, and EFI_SUCCESS is returned. If + the timer hardware is not programmable, then EFI_UNSUPPORTED is returned. + If an error occurs while attempting to update the timer period, then the + timer hardware will be put back in its state prior to this call, and + EFI_DEVICE_ERROR is returned. If TimerPeriod is 0, then the timer interrupt + is disabled. This is not the same as disabling the CPU's interrupts. + Instead, it must either turn off the timer hardware, or it must adjust the + interrupt controller so that a CPU interrupt is not generated when the timer + interrupt fires. @param This The EFI_TIMER_ARCH_PROTOCOL instance. @param TimerPeriod The rate to program the timer interrupt in 100 nS units. If @@ -110,7 +110,7 @@ EFI_STATUS @retval EFI_DEVICE_ERROR The timer period could not be changed due to a device error. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_TIMER_SET_TIMER_PERIOD)( IN EFI_TIMER_ARCH_PROTOCOL *This, @@ -118,9 +118,9 @@ EFI_STATUS ); /** - This function retrieves the period of timer interrupts in 100 ns units, - returns that value in TimerPeriod, and returns EFI_SUCCESS. If TimerPeriod - is NULL, then EFI_INVALID_PARAMETER is returned. If a TimerPeriod of 0 is + This function retrieves the period of timer interrupts in 100 ns units, + returns that value in TimerPeriod, and returns EFI_SUCCESS. If TimerPeriod + is NULL, then EFI_INVALID_PARAMETER is returned. If a TimerPeriod of 0 is returned, then the timer is currently disabled. @param This The EFI_TIMER_ARCH_PROTOCOL instance. @@ -131,7 +131,7 @@ EFI_STATUS @retval EFI_INVALID_PARAMETER TimerPeriod is NULL. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_TIMER_GET_TIMER_PERIOD)( IN EFI_TIMER_ARCH_PROTOCOL *This, @@ -139,12 +139,12 @@ EFI_STATUS ); /** - This function generates a soft timer interrupt. If the platform does not support soft - timer interrupts, then EFI_UNSUPPORTED is returned. Otherwise, EFI_SUCCESS is returned. - If a handler has been registered through the EFI_TIMER_ARCH_PROTOCOL.RegisterHandler() - service, then a soft timer interrupt will be generated. If the timer interrupt is - enabled when this service is called, then the registered handler will be invoked. The - registered handler should not be able to distinguish a hardware-generated timer + This function generates a soft timer interrupt. If the platform does not support soft + timer interrupts, then EFI_UNSUPPORTED is returned. Otherwise, EFI_SUCCESS is returned. + If a handler has been registered through the EFI_TIMER_ARCH_PROTOCOL.RegisterHandler() + service, then a soft timer interrupt will be generated. If the timer interrupt is + enabled when this service is called, then the registered handler will be invoked. The + registered handler should not be able to distinguish a hardware-generated timer interrupt from a software-generated timer interrupt. @param This The EFI_TIMER_ARCH_PROTOCOL instance. @@ -153,7 +153,7 @@ EFI_STATUS @retval EFI_UNSUPPORTED The platform does not support the generation of soft timer interrupts. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_TIMER_GENERATE_SOFT_INTERRUPT)( IN EFI_TIMER_ARCH_PROTOCOL *This @@ -161,11 +161,11 @@ EFI_STATUS /// -/// This protocol provides the services to initialize a periodic timer +/// This protocol provides the services to initialize a periodic timer /// interrupt, and to register a handler that is called each time the timer /// interrupt fires. It may also provide a service to adjust the rate of the -/// periodic timer interrupt. When a timer interrupt occurs, the handler is -/// passed the amount of time that has passed since the previous timer +/// periodic timer interrupt. When a timer interrupt occurs, the handler is +/// passed the amount of time that has passed since the previous timer /// interrupt. /// struct _EFI_TIMER_ARCH_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Timestamp.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Timestamp.h index 9746903922..5ac44bbd03 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Timestamp.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Timestamp.h @@ -1,19 +1,19 @@ /** @file - EFI Timestamp Protocol as defined in UEFI2.4 Specification. + EFI Timestamp Protocol as defined in UEFI2.4 Specification. Used to provide a platform independent interface for retrieving a high resolution timestamp counter. - + Copyright (c) 2013, 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 - - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - - @par Revision Reference: - This Protocol is introduced in UEFI Specification 2.4 - + 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 + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + + @par Revision Reference: + This Protocol is introduced in UEFI Specification 2.4 + **/ #ifndef __EFI_TIME_STAMP_PROTOCOL_H__ @@ -32,30 +32,30 @@ typedef struct _EFI_TIMESTAMP_PROTOCOL EFI_TIMESTAMP_PROTOCOL; /// EFI_TIMESTAMP_PROPERTIES /// typedef struct { - /// + /// /// The frequency of the timestamp counter in Hz. - /// + /// UINT64 Frequency; - /// + /// /// The value that the timestamp counter ends with immediately before it rolls over. /// For example, a 64-bit free running counter would have an EndValue of 0xFFFFFFFFFFFFFFFF. /// A 24-bit free running counter would have an EndValue of 0xFFFFFF. /// UINT64 EndValue; } EFI_TIMESTAMP_PROPERTIES; - + /** Retrieves the current value of a 64-bit free running timestamp counter. - + The counter shall count up in proportion to the amount of time that has passed. The counter value will always roll over to zero. The properties of the counter can be retrieved from GetProperties(). The caller should be prepared for the function to return the same value twice across successive calls. The counter value will not go backwards other than when wrapping, as defined by EndValue in GetProperties(). - The frequency of the returned timestamp counter value must remain constant. Power management operations that - affect clocking must not change the returned counter frequency. The quantization of counter value updates may + The frequency of the returned timestamp counter value must remain constant. Power management operations that + affect clocking must not change the returned counter frequency. The quantization of counter value updates may vary as long as the value reflecting time passed remains consistent. - @param None. + @param None. @retval The current value of the free running timestamp counter. @@ -71,13 +71,13 @@ UINT64 @param[out] Properties The properties of the timestamp counter. - @retval EFI_SUCCESS The properties were successfully retrieved. - @retval EFI_DEVICE_ERROR An error occurred trying to retrieve the properties of the timestamp - counter subsystem. Properties is not pedated. + @retval EFI_SUCCESS The properties were successfully retrieved. + @retval EFI_DEVICE_ERROR An error occurred trying to retrieve the properties of the timestamp + counter subsystem. Properties is not pedated. @retval EFI_INVALID_PARAMETER Properties is NULL. **/ -typedef +typedef EFI_STATUS (EFIAPI *TIMESTAMP_GET_PROPERTIES)( OUT EFI_TIMESTAMP_PROPERTIES *Properties @@ -87,7 +87,7 @@ EFI_STATUS /// /// EFI_TIMESTAMP_PROTOCOL -/// The protocol provides a platform independent interface for retrieving a high resolution +/// The protocol provides a platform independent interface for retrieving a high resolution /// timestamp counter. /// struct _EFI_TIMESTAMP_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/TrEEProtocol.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/TrEEProtocol.h index d98cedcee6..67b54fe51a 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/TrEEProtocol.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/TrEEProtocol.h @@ -2,12 +2,12 @@ This protocol is defined to abstract TPM2 hardware access in boot phase. Copyright (c) 2013 - 2016, 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 +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 -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -35,19 +35,19 @@ typedef UINT32 TREE_EVENT_LOG_FORMAT; typedef struct _TREE_BOOT_SERVICE_CAPABILITY { // - // Allocated size of the structure passed in + // Allocated size of the structure passed in // UINT8 Size; // // Version of the TREE_BOOT_SERVICE_CAPABILITY structure itself. // For this version of the protocol, the Major version shall be set to 1 - // and the Minor version shall be set to 0. + // and the Minor version shall be set to 0. // TREE_VERSION StructureVersion; // // Version of the TrEE protocol. // For this version of the protocol, the Major version shall be set to 1 - // and the Minor version shall be set to 0. + // and the Minor version shall be set to 0. // TREE_VERSION ProtocolVersion; // @@ -59,20 +59,20 @@ typedef struct _TREE_BOOT_SERVICE_CAPABILITY { // TREE_EVENT_LOG_BITMAP SupportedEventLogs; // - // False = TrEE not present + // False = TrEE not present // BOOLEAN TrEEPresentFlag; // - // Max size (in bytes) of a command that can be sent to the TrEE + // Max size (in bytes) of a command that can be sent to the TrEE // UINT16 MaxCommandSize; // - // Max size (in bytes) of a response that can be provided by the TrEE + // Max size (in bytes) of a response that can be provided by the TrEE // UINT16 MaxResponseSize; // // 4-byte Vendor ID (see Trusted Computing Group, "TCG Vendor ID Registry," - // Version 1.0, Revision 0.1, August 31, 2007, "TPM Capabilities Vendor ID" section) + // Version 1.0, Revision 0.1, August 31, 2007, "TPM Capabilities Vendor ID" section) // UINT32 ManufacturerID; } TREE_BOOT_SERVICE_CAPABILITY_1_0; @@ -103,7 +103,7 @@ typedef UINT32 TrEE_EVENTTYPE; typedef struct { // - // Size of the event header itself (sizeof(TrEE_EVENT_HEADER)). + // Size of the event header itself (sizeof(TrEE_EVENT_HEADER)). // UINT32 HeaderSize; // @@ -111,18 +111,18 @@ typedef struct { // UINT16 HeaderVersion; // - // Index of the PCR that shall be extended (0 - 23). + // Index of the PCR that shall be extended (0 - 23). // TrEE_PCRINDEX PCRIndex; // - // Type of the event that shall be extended (and optionally logged). + // Type of the event that shall be extended (and optionally logged). // TrEE_EVENTTYPE EventType; } TrEE_EVENT_HEADER; typedef struct { // - // Total size of the event including the Size component, the header and the Event data. + // Total size of the event including the Size component, the header and the Event data. // UINT32 Size; TrEE_EVENT_HEADER Header; @@ -144,11 +144,11 @@ typedef struct { @retval EFI_SUCCESS Operation completed successfully. @retval EFI_DEVICE_ERROR The command was unsuccessful. - The ProtocolCapability variable will not be populated. + The ProtocolCapability variable will not be populated. @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect. The ProtocolCapability variable will not be populated. @retval EFI_BUFFER_TOO_SMALL The ProtocolCapability variable is too small to hold the full response. - It will be partially populated (required Size field will be set). + It will be partially populated (required Size field will be set). **/ typedef EFI_STATUS @@ -159,7 +159,7 @@ EFI_STATUS /** The EFI_TREE_PROTOCOL Get Event Log function call allows a caller to - retrieve the address of a given event log and its last entry. + retrieve the address of a given event log and its last entry. @param[in] This Indicates the calling context @param[in] EventLogFormat The type of the event log for which the information is requested. @@ -187,13 +187,13 @@ EFI_STATUS /** The EFI_TREE_PROTOCOL HashLogExtendEvent function call provides callers with an opportunity to extend and optionally log events without requiring - knowledge of actual TPM commands. + knowledge of actual TPM commands. The extend operation will occur even if this function cannot create an event - log entry (e.g. due to the event log being full). + log entry (e.g. due to the event log being full). @param[in] This Indicates the calling context @param[in] Flags Bitmap providing additional information. - @param[in] DataToHash Physical address of the start of the data buffer to be hashed. + @param[in] DataToHash Physical address of the start of the data buffer to be hashed. @param[in] DataToHashLen The length in bytes of the buffer referenced by DataToHash. @param[in] Event Pointer to data buffer containing information about the event. @@ -225,7 +225,7 @@ EFI_STATUS @retval EFI_SUCCESS The command byte stream was successfully sent to the device and a response was successfully received. @retval EFI_DEVICE_ERROR The command was not successfully sent to the device or a response was not successfully received from the device. @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect. - @retval EFI_BUFFER_TOO_SMALL The output parameter block is too small. + @retval EFI_BUFFER_TOO_SMALL The output parameter block is too small. **/ typedef EFI_STATUS diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Udp4.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Udp4.h index 9163866a0b..4020e58419 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Udp4.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Udp4.h @@ -1,20 +1,20 @@ /** @file UDP4 Service Binding Protocol as defined in UEFI specification. - The EFI UDPv4 Protocol provides simple packet-oriented services - to transmit and receive UDP packets. + The EFI UDPv4 Protocol provides simple packet-oriented services + to transmit and receive UDP packets. Copyright (c) 2006 - 2014, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +http://opensource.org/licenses/bsd-license.php. - @par Revision Reference: - This Protocol is introduced in UEFI Specification 2.0. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + + @par Revision Reference: + This Protocol is introduced in UEFI Specification 2.0. **/ @@ -35,8 +35,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 0x3ad9df29, 0x4501, 0x478d, {0xb1, 0xf8, 0x7f, 0x7f, 0xe7, 0x0e, 0x50, 0xf3 } \ } -typedef struct _EFI_UDP4_PROTOCOL EFI_UDP4_PROTOCOL; - +typedef struct _EFI_UDP4_PROTOCOL EFI_UDP4_PROTOCOL; + /// /// EFI_UDP4_SERVICE_POINT is deprecated in the UEFI 2.4B and should not be used any more. /// The definition in here is only present to provide backwards compatability. @@ -47,7 +47,7 @@ typedef struct { UINT16 LocalPort; EFI_IPv4_ADDRESS RemoteAddress; UINT16 RemotePort; -} EFI_UDP4_SERVICE_POINT; +} EFI_UDP4_SERVICE_POINT; /// /// EFI_UDP4_VARIABLE_DATA is deprecated in the UEFI 2.4B and should not be used any more. @@ -101,7 +101,7 @@ typedef struct { EFI_UDP4_SESSION_DATA *UdpSessionData; //OPTIONAL EFI_IPv4_ADDRESS *GatewayAddress; //OPTIONAL UINT32 DataLength; - UINT32 FragmentCount; + UINT32 FragmentCount; EFI_UDP4_FRAGMENT_DATA FragmentTable[1]; } EFI_UDP4_TRANSMIT_DATA; @@ -152,13 +152,13 @@ EFI_STATUS OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL, OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL, OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL - ); - + ); + /** Initializes, changes, or resets the operational parameters for this instance of the EFI UDPv4 Protocol. - + The Configure() function is used to do the following: * Initialize and start this instance of the EFI UDPv4 Protocol. * Change the filtering rules and operational parameters. @@ -190,7 +190,7 @@ EFI_STATUS @retval EFI_OUT_OF_RESOURCES The EFI UDPv4 Protocol driver cannot allocate memory for this EFI UDPv4 Protocol instance. @retval EFI_DEVICE_ERROR An unexpected network or system error occurred and this instance - was not opened. + was not opened. **/ typedef @@ -198,11 +198,11 @@ EFI_STATUS (EFIAPI *EFI_UDP4_CONFIGURE)( IN EFI_UDP4_PROTOCOL *This, IN EFI_UDP4_CONFIG_DATA *UdpConfigData OPTIONAL - ); + ); /** Joins and leaves multicast groups. - + The Groups() function is used to enable and disable the multicast group filtering. If the JoinFlag is FALSE and the MulticastAddress is NULL, then all currently joined groups are left. @@ -235,11 +235,11 @@ EFI_STATUS IN EFI_UDP4_PROTOCOL *This, IN BOOLEAN JoinFlag, IN EFI_IPv4_ADDRESS *MulticastAddress OPTIONAL - ); + ); /** Adds and deletes routing table entries. - + The Routes() function adds a route to or deletes a route from the routing table. Routes are determined by comparing the SubnetAddress with the destination IP address and arithmetically AND-ing it with the SubnetMask. The gateway address @@ -283,11 +283,11 @@ EFI_STATUS IN EFI_IPv4_ADDRESS *SubnetAddress, IN EFI_IPv4_ADDRESS *SubnetMask, IN EFI_IPv4_ADDRESS *GatewayAddress - ); + ); /** Polls for incoming data packets and processes outgoing data packets. - + The Poll() function can be used by network drivers and applications to increase the rate that data packets are moved between the communications device and the transmit and receive queues. @@ -309,11 +309,11 @@ typedef EFI_STATUS (EFIAPI *EFI_UDP4_POLL)( IN EFI_UDP4_PROTOCOL *This - ); + ); /** Places an asynchronous receive request into the receiving queue. - + The Receive() function places a completion token into the receive packet queue. This function is always asynchronous. The caller must fill in the Token.Event field in the completion token, and this @@ -347,11 +347,11 @@ EFI_STATUS (EFIAPI *EFI_UDP4_RECEIVE)( IN EFI_UDP4_PROTOCOL *This, IN EFI_UDP4_COMPLETION_TOKEN *Token - ); + ); /** Queues outgoing data packets into the transmit queue. - + The Transmit() function places a sending request to this instance of the EFI UDPv4 Protocol, alongside the transmit data that was filled by the user. Whenever the packet in the token is sent out or some errors occur, the Token.Event will @@ -384,11 +384,11 @@ EFI_STATUS (EFIAPI *EFI_UDP4_TRANSMIT)( IN EFI_UDP4_PROTOCOL *This, IN EFI_UDP4_COMPLETION_TOKEN *Token - ); + ); /** Aborts an asynchronous transmit or receive request. - + The Cancel() function is used to abort a pending transmit or receive request. If the token is in the transmit or receive request queues, after calling this function, Token.Status will be set to EFI_ABORTED and then Token.Event will be @@ -419,13 +419,13 @@ EFI_STATUS (EFIAPI *EFI_UDP4_CANCEL)( IN EFI_UDP4_PROTOCOL *This, IN EFI_UDP4_COMPLETION_TOKEN *Token OPTIONAL - ); + ); /// -/// The EFI_UDP4_PROTOCOL defines an EFI UDPv4 Protocol session that can be used -/// by any network drivers, applications, or daemons to transmit or receive UDP packets. -/// This protocol instance can either be bound to a specified port as a service or -/// connected to some remote peer as an active client. Each instance has its own settings, +/// The EFI_UDP4_PROTOCOL defines an EFI UDPv4 Protocol session that can be used +/// by any network drivers, applications, or daemons to transmit or receive UDP packets. +/// This protocol instance can either be bound to a specified port as a service or +/// connected to some remote peer as an active client. Each instance has its own settings, /// such as the routing table and group table, which are independent from each other. /// struct _EFI_UDP4_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Udp6.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Udp6.h index e1e1dc694e..485b2a1830 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Udp6.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Udp6.h @@ -4,15 +4,15 @@ UDP packets. Copyright (c) 2008 - 2014, 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 - - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - - @par Revision Reference: + 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 + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + + @par Revision Reference: This Protocol is introduced in UEFI Specification 2.2 **/ @@ -57,7 +57,7 @@ typedef struct { /// EFI_IPv6_ADDRESS RemoteAddress; /// - /// The port number in host byte order on which the remote host is + /// The port number in host byte order on which the remote host is /// listening. Maybe zero if it is not connected to any remote host. /// UINT16 RemotePort; @@ -115,7 +115,7 @@ typedef struct { /// EFI_IPv6_ADDRESS DestinationAddress; /// - /// Port to which this packet is sent. When sending packet, it'll be + /// Port to which this packet is sent. When sending packet, it'll be /// ignored if it is zero. /// UINT16 DestinationPort; @@ -168,7 +168,7 @@ typedef struct { /// /// The port number to which this EFI UDPv6 Protocol instance is bound. If a client /// of the EFI UDPv6 Protocol does not care about the port number, set StationPort - /// to zero. The EFI UDPv6 Protocol driver will assign a random port number to transmitted + /// to zero. The EFI UDPv6 Protocol driver will assign a random port number to transmitted /// UDP packets. Ignored it if AcceptAnyPort is TRUE. /// UINT16 StationPort; @@ -219,8 +219,8 @@ typedef struct { /// packets, the CompletionToken.Packet.RxData field is updated to this incoming packet and /// the CompletionToken.Event is signaled. The EFI UDPv6 Protocol client must signal the /// RecycleSignal after processing the packet. -/// FragmentTable could contain multiple buffers that are not in the continuous memory locations. -/// The EFI UDPv6 Protocol client might need to combine two or more buffers in FragmentTable to +/// FragmentTable could contain multiple buffers that are not in the continuous memory locations. +/// The EFI UDPv6 Protocol client might need to combine two or more buffers in FragmentTable to /// form their own protocol header. /// typedef struct { @@ -271,15 +271,15 @@ typedef struct { /// - EFI_SUCCESS: The receive or transmit operation completed successfully. /// - EFI_ABORTED: The receive or transmit was aborted. /// - EFI_TIMEOUT: The transmit timeout expired. - /// - EFI_NETWORK_UNREACHABLE: The destination network is unreachable. RxData is set to + /// - EFI_NETWORK_UNREACHABLE: The destination network is unreachable. RxData is set to /// NULL in this situation. - /// - EFI_HOST_UNREACHABLE: The destination host is unreachable. RxData is set to NULL in + /// - EFI_HOST_UNREACHABLE: The destination host is unreachable. RxData is set to NULL in /// this situation. - /// - EFI_PROTOCOL_UNREACHABLE: The UDP protocol is unsupported in the remote system. + /// - EFI_PROTOCOL_UNREACHABLE: The UDP protocol is unsupported in the remote system. /// RxData is set to NULL in this situation. - /// - EFI_PORT_UNREACHABLE: No service is listening on the remote port. RxData is set to + /// - EFI_PORT_UNREACHABLE: No service is listening on the remote port. RxData is set to /// NULL in this situation. - /// - EFI_ICMP_ERROR: Some other Internet Control Message Protocol (ICMP) error report was + /// - EFI_ICMP_ERROR: Some other Internet Control Message Protocol (ICMP) error report was /// received. For example, packets are being sent too fast for the destination to receive them /// and the destination sent an ICMP source quench report. RxData is set to NULL in this situation. /// - EFI_DEVICE_ERROR: An unexpected system or network error occurred. @@ -304,7 +304,7 @@ typedef struct { The GetModeData() function copies the current operational settings of this EFI UDPv6 Protocol instance into user-supplied buffers. This function is used optionally to retrieve the operational - mode data of underlying networks or drivers. + mode data of underlying networks or drivers. @param[in] This Pointer to the EFI_UDP6_PROTOCOL instance. @param[out] Udp6ConfigData The buffer in which the current UDP configuration data is returned. @@ -330,13 +330,13 @@ EFI_STATUS ); /** - Initializes, changes, or resets the operational parameters for this instance of the EFI UDPv6 + Initializes, changes, or resets the operational parameters for this instance of the EFI UDPv6 Protocol. The Configure() function is used to do the following: - Initialize and start this instance of the EFI UDPv6 Protocol. - Change the filtering rules and operational parameters. - - Reset this instance of the EFI UDPv6 Protocol. + - Reset this instance of the EFI UDPv6 Protocol. Until these parameters are initialized, no network traffic can be sent or received by this instance. This instance can be also reset by calling Configure() with UdpConfigData set to NULL. @@ -350,7 +350,7 @@ EFI_STATUS @param[in] UdpConfigData Pointer to the buffer contained the configuration data. @retval EFI_SUCCESS The configuration settings were set, changed, or reset successfully. - @retval EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source + @retval EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source address for this instance, but no source address was available for use. @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE: - This is NULL. @@ -363,7 +363,7 @@ EFI_STATUS ReceiveTimeout, and TransmitTimeout can be reconfigured without stopping the current instance of the EFI UDPv6 Protocol. @retval EFI_ACCESS_DENIED UdpConfigData.AllowDuplicatePort is FALSE and UdpConfigData.StationPort - is already used by other instance. + is already used by other instance. @retval EFI_OUT_OF_RESOURCES The EFI UDPv6 Protocol driver cannot allocate memory for this EFI UDPv6 Protocol instance. @retval EFI_DEVICE_ERROR An unexpected network or system error occurred and this instance was not @@ -418,7 +418,7 @@ EFI_STATUS receive the notification and transmitting status. @param[in] This Pointer to the EFI_UDP6_PROTOCOL instance. - @param[in] Token Pointer to the completion token that will be placed into the + @param[in] Token Pointer to the completion token that will be placed into the transmit queue. @retval EFI_SUCCESS The data has been queued for transmission. @@ -440,12 +440,12 @@ EFI_STATUS fields is NULL. - Token.Packet.TxData.UdpSessionData.DestinationAddress is not zero and is not valid unicast Ipv6 address if UdpSessionData is not NULL. - - Token.Packet.TxData.UdpSessionData is NULL and this instance's + - Token.Packet.TxData.UdpSessionData is NULL and this instance's UdpConfigData.RemoteAddress is unspecified. - Token.Packet.TxData.UdpSessionData.DestinationAddress is non-zero when DestinationAddress is configured as non-zero when doing Configure() for this EFI Udp6 protocol instance. - - Token.Packet.TxData.UdpSesionData.DestinationAddress is zero when + - Token.Packet.TxData.UdpSesionData.DestinationAddress is zero when DestinationAddress is unspecified when doing Configure() for this EFI Udp6 protocol instance. @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event was already @@ -469,7 +469,7 @@ EFI_STATUS The Receive() function places a completion token into the receive packet queue. This function is always asynchronous. - The caller must fill in the Token.Event field in the completion token, and this field cannot be + The caller must fill in the Token.Event field in the completion token, and this field cannot be NULL. When the receive operation completes, the EFI UDPv6 Protocol driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event is signaled. Providing a proper notification function and context for the event will enable the user to receive @@ -487,11 +487,11 @@ EFI_STATUS - This is NULL. - Token is NULL. - Token.Event is NULL. - @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system + @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system resources (usually memory). @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI UDPv6 Protocol instance has been reset to startup defaults. - @retval EFI_ACCESS_DENIED A receive completion token with the same Token.Event was already in + @retval EFI_ACCESS_DENIED A receive completion token with the same Token.Event was already in the receive queue. @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full. @@ -547,7 +547,7 @@ EFI_STATUS @retval EFI_SUCCESS Incoming or outgoing data was processed. @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue. Consider increasing the polling rate. @@ -563,7 +563,7 @@ EFI_STATUS /// applications, or daemons to transmit or receive UDP packets. This protocol instance can either be /// bound to a specified port as a service or connected to some remote peer as an active client. /// Each instance has its own settings, such as group table, that are independent from each other. -/// +/// struct _EFI_UDP6_PROTOCOL { EFI_UDP6_GET_MODE_DATA GetModeData; EFI_UDP6_CONFIGURE Configure; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UgaDraw.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UgaDraw.h index f501a6c17f..1bebb0181e 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UgaDraw.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UgaDraw.h @@ -92,26 +92,26 @@ typedef enum { ///< directly to every pixel of the video display rectangle ///< (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). ///< Only one pixel will be used from the BltBuffer. Delta is NOT used. - + EfiUgaVideoToBltBuffer, ///< Read data from the video display rectangle ///< (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in ///< the BltBuffer rectangle (DestinationX, DestinationY ) ///< (DestinationX + Width, DestinationY + Height). If DestinationX or ///< DestinationY is not zero then Delta must be set to the length in bytes ///< of a row in the BltBuffer. - + EfiUgaBltBufferToVideo, ///< Write data from the BltBuffer rectangle ///< (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the ///< video display rectangle (DestinationX, DestinationY) ///< (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is ///< not zero then Delta must be set to the length in bytes of a row in the ///< BltBuffer. - + EfiUgaVideoToVideo, ///< Copy from the video display rectangle (SourceX, SourceY) ///< (SourceX + Width, SourceY + Height) .to the video display rectangle ///< (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). ///< The BltBuffer and Delta are not used in this mode. - + EfiUgaBltMax ///< Maxmimum value for enumration value of Blt operation. If a Blt operation ///< larger or equal to this enumration value, it is invalid. } EFI_UGA_BLT_OPERATION; @@ -152,8 +152,8 @@ EFI_STATUS ); /// -/// This protocol provides a basic abstraction to set video modes and -/// copy pixels to and from the graphics controller's frame buffer. +/// This protocol provides a basic abstraction to set video modes and +/// copy pixels to and from the graphics controller's frame buffer. /// struct _EFI_UGA_DRAW_PROTOCOL { EFI_UGA_DRAW_PROTOCOL_GET_MODE GetMode; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UgaIo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UgaIo.h index 9638a72240..c3bd8c102d 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UgaIo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UgaIo.h @@ -2,15 +2,15 @@ UGA IO protocol from the EFI 1.10 specification. Abstraction of a very simple graphics device. - + Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -90,15 +90,15 @@ typedef struct { /** Dynamically allocate storage for a child UGA_DEVICE. - @param[in] This The EFI_UGA_IO_PROTOCOL instance. + @param[in] This The EFI_UGA_IO_PROTOCOL instance. @param[in] ParentDevice ParentDevice specifies a pointer to the parent device of Device. @param[in] DeviceData A pointer to UGA_DEVICE_DATA returned from a call to DispatchService() - with a UGA_DEVICE of Parent and an IoRequest of type UgaIoGetChildDevice. - @param[in] RunTimeContext Context to associate with Device. + with a UGA_DEVICE of Parent and an IoRequest of type UgaIoGetChildDevice. + @param[in] RunTimeContext Context to associate with Device. @param[out] Device The Device returns a dynamically allocated child UGA_DEVICE object for ParentDevice. The caller is responsible for deleting Device. - + @retval EFI_SUCCESS Device was returned. @retval EFI_INVALID_PARAMETER One of the arguments was not valid. @retval EFI_DEVICE_ERROR The device had an error and could not complete the request. @@ -118,12 +118,12 @@ EFI_STATUS /** Delete a dynamically allocated child UGA_DEVICE object that was allocated via CreateDevice(). - @param[in] This The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is + @param[in] This The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is defined in Section 10.7. @param[in] Device The Device points to a UGA_DEVICE object that was dynamically allocated via a CreateDevice() call. - + @retval EFI_SUCCESS Device was returned. @retval EFI_INVALID_PARAMETER The Device was not allocated via CreateDevice(). @@ -138,23 +138,23 @@ EFI_STATUS /** This is the main UGA service dispatch routine for all UGA_IO_REQUEST s. - @param pDevice pDevice specifies a pointer to a device object associated with a - device enumerated by a pIoRequest->ioRequestCode of type - UgaIoGetChildDevice. The root device for the EFI_UGA_IO_PROTOCOL + @param pDevice pDevice specifies a pointer to a device object associated with a + device enumerated by a pIoRequest->ioRequestCode of type + UgaIoGetChildDevice. The root device for the EFI_UGA_IO_PROTOCOL is represented by pDevice being set to NULL. - @param pIoRequest + @param pIoRequest pIoRequest points to a caller allocated buffer that contains data defined by pIoRequest->ioRequestCode. See Related Definitions for - a definition of UGA_IO_REQUEST_CODE s and their associated data + a definition of UGA_IO_REQUEST_CODE s and their associated data structures. @return UGA_STATUS **/ -typedef UGA_STATUS +typedef UGA_STATUS (EFIAPI *PUGA_FW_SERVICE_DISPATCH)( - IN PUGA_DEVICE pDevice, + IN PUGA_DEVICE pDevice, IN OUT PUGA_IO_REQUEST pIoRequest ); diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UnicodeCollation.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UnicodeCollation.h index 96cff3444e..82e2d1ffc5 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UnicodeCollation.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UnicodeCollation.h @@ -1,16 +1,16 @@ /** @file Unicode Collation protocol that follows the UEFI 2.0 specification. - This protocol is used to allow code running in the boot services environment + This protocol is used to allow code running in the boot services environment to perform lexical comparison functions on Unicode strings for given languages. Copyright (c) 2006 - 2011, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. **/ @@ -32,12 +32,12 @@ typedef struct _EFI_UNICODE_COLLATION_PROTOCOL EFI_UNICODE_COLLATION_PROTOCOL; /// /// Protocol GUID name defined in EFI1.1. -/// +/// #define UNICODE_COLLATION_PROTOCOL EFI_UNICODE_COLLATION_PROTOCOL_GUID /// /// Protocol defined in EFI1.1. -/// +/// typedef EFI_UNICODE_COLLATION_PROTOCOL UNICODE_COLLATION_INTERFACE; /// @@ -69,7 +69,7 @@ INTN ); /** - Performs a case-insensitive comparison of a Null-terminated + Performs a case-insensitive comparison of a Null-terminated pattern string and a Null-terminated string. @param This A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance. @@ -89,7 +89,7 @@ BOOLEAN ); /** - Converts all the characters in a Null-terminated string to + Converts all the characters in a Null-terminated string to lower case characters. @param This A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance. @@ -119,7 +119,7 @@ VOID ); /** - Converts an 8.3 FAT file name in an OEM character set to a Null-terminated + Converts an 8.3 FAT file name in an OEM character set to a Null-terminated string. @param This A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance. @@ -140,13 +140,13 @@ VOID ); /** - Converts a Null-terminated string to legal characters in a FAT - filename using an OEM character set. + Converts a Null-terminated string to legal characters in a FAT + filename using an OEM character set. @param This A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance. @param String A pointer to a Null-terminated string. @param FatSize The size of the string Fat in bytes. - @param Fat A pointer to a string that contains the converted version of + @param Fat A pointer to a string that contains the converted version of String using legal FAT characters from an OEM character set. @retval TRUE One or more conversions failed and were substituted with '_' @@ -163,8 +163,8 @@ BOOLEAN ); /// -/// The EFI_UNICODE_COLLATION_PROTOCOL is used to perform case-insensitive -/// comparisons of strings. +/// The EFI_UNICODE_COLLATION_PROTOCOL is used to perform case-insensitive +/// comparisons of strings. /// struct _EFI_UNICODE_COLLATION_PROTOCOL { EFI_UNICODE_COLLATION_STRICOLL StriColl; @@ -177,7 +177,7 @@ struct _EFI_UNICODE_COLLATION_PROTOCOL { // EFI_UNICODE_COLLATION_FATTOSTR FatToStr; EFI_UNICODE_COLLATION_STRTOFAT StrToFat; - + /// /// A Null-terminated ASCII string array that contains one or more language codes. /// When this field is used for UnicodeCollation2, it is specified in RFC 4646 format. diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Usb2HostController.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Usb2HostController.h index 6a0e7be80a..bdfee9a0b3 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Usb2HostController.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Usb2HostController.h @@ -1,7 +1,7 @@ /** @file EFI_USB2_HC_PROTOCOL as defined in UEFI 2.0. - The USB Host Controller Protocol is used by code, typically USB bus drivers, - running in the EFI boot services environment, to perform data transactions over + The USB Host Controller Protocol is used by code, typically USB bus drivers, + running in the EFI boot services environment, to perform data transactions over a USB bus. In addition, it provides an abstraction for the root hub of the USB bus. Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR> @@ -37,7 +37,7 @@ typedef struct { } EFI_USB_PORT_STATUS; /// -/// EFI_USB_PORT_STATUS.PortStatus bit definition +/// EFI_USB_PORT_STATUS.PortStatus bit definition /// #define USB_PORT_STAT_CONNECTION 0x0001 #define USB_PORT_STAT_ENABLE 0x0002 @@ -51,7 +51,7 @@ typedef struct { #define USB_PORT_STAT_OWNER 0x2000 /// -/// EFI_USB_PORT_STATUS.PortChangeStatus bit definition +/// EFI_USB_PORT_STATUS.PortChangeStatus bit definition /// #define USB_PORT_STAT_C_CONNECTION 0x0001 #define USB_PORT_STAT_C_ENABLE 0x0002 @@ -62,7 +62,7 @@ typedef struct { /// /// Usb port features value -/// Each value indicates its bit index in the port status and status change bitmaps, +/// Each value indicates its bit index in the port status and status change bitmaps, /// if combines these two bitmaps into a 32-bit bitmap. /// typedef enum { @@ -158,7 +158,7 @@ typedef enum { ///< Explicitly set by software. 3) ///< Triggered by a fatal error such as ///< consistency check failure. - + EfiUsbHcStateOperational, ///< The host controller is in an ///< operational state. When in ///< this state, the host @@ -166,7 +166,7 @@ typedef enum { ///< traffic. This state must be ///< explicitly set to enable the ///< USB bus traffic. - + EfiUsbHcStateSuspend, ///< The host controller is in the ///< suspend state. No USB ///< transactions can occur while in @@ -176,7 +176,7 @@ typedef enum { ///< set by software. 2) Triggered ///< when there is no bus traffic for ///< 3 microseconds. - + EfiUsbHcStateMaximum ///< Maximum value for enumration value of HC status. } EFI_USB_HC_STATE; @@ -413,30 +413,30 @@ EFI_STATUS /** Submits isochronous transfer to an isochronous endpoint of a USB device. - This function is used to submit isochronous transfer to a target endpoint of a USB device. - The target endpoint is specified by DeviceAddressand EndpointAddress. Isochronous transfers are - used when working with isochronous date. It provides periodic, continuous communication between - the host and a device. Isochronous transfers can beused only by full-speed, high-speed, and + This function is used to submit isochronous transfer to a target endpoint of a USB device. + The target endpoint is specified by DeviceAddressand EndpointAddress. Isochronous transfers are + used when working with isochronous date. It provides periodic, continuous communication between + the host and a device. Isochronous transfers can beused only by full-speed, high-speed, and super-speed devices. - High-speed isochronous transfers can be performed using multiple data buffers. The number of + High-speed isochronous transfers can be performed using multiple data buffers. The number of buffers that are actually prepared for the transfer is specified by DataBuffersNumber. For full-speed isochronous transfers this value is ignored. Data represents a list of pointers to the data buffers. For full-speed isochronous transfers only the data pointed by Data[0]shall be used. For high-speed isochronous transfers and for the split transactions depending on DataLengththere several data buffers canbe used. For the - high-speed isochronous transfers the total number of buffers must not exceed EFI_USB_MAX_ISO_BUFFER_NUM. + high-speed isochronous transfers the total number of buffers must not exceed EFI_USB_MAX_ISO_BUFFER_NUM. For split transactions performed on full-speed device by high-speed host controller the total number of buffers is limited to EFI_USB_MAX_ISO_BUFFER_NUM1. - If the isochronous transfer is successful, then EFI_SUCCESSis returned. The isochronous transfer + If the isochronous transfer is successful, then EFI_SUCCESSis returned. The isochronous transfer is designed to be completed within one USB frame time, if it cannot be completed, EFI_TIMEOUT is returned. If an error other than timeout occurs during the USB transfer, then EFI_DEVICE_ERROR is returned and the detailed status code will be returned in TransferResult. EFI_INVALID_PARAMETERis returned if one of the following conditionsis satisfied: - - Data is NULL. + - Data is NULL. - DataLength is 0. - DeviceSpeed is not one of the supported values listed above. - MaximumPacketLength is invalid. MaximumPacketLength must be 1023 or less for full-speed devices, @@ -447,7 +447,7 @@ EFI_STATUS @param DeviceAddress Represents the address of the target device on the USB. @param EndPointAddress The combination of an endpoint number and an endpoint direction of the target USB device. - @param DeviceSpeed Indicates device speed. The supported values are EFI_USB_SPEED_FULL, + @param DeviceSpeed Indicates device speed. The supported values are EFI_USB_SPEED_FULL, EFI_USB_SPEED_HIGH, or EFI_USB_SPEED_SUPER. @param MaximumPacketLength Indicates the maximum packet size the target endpoint is capable of sending or receiving. @@ -497,7 +497,7 @@ EFI_STATUS between the host and a device. Isochronous transfers can be used only by full-speed, high-speed, and super-speed devices. - High-speed isochronous transfers can be performed using multiple data buffers. The number of + High-speed isochronous transfers can be performed using multiple data buffers. The number of buffers that are actually prepared for the transfer is specified by DataBuffersNumber. For full-speed isochronous transfers this value is ignored. @@ -510,17 +510,17 @@ EFI_STATUS number of buffers is limited to EFI_USB_MAX_ISO_BUFFER_NUM1. EFI_INVALID_PARAMETER is returned if one of the following conditionsis satisfied: - - Data is NULL. + - Data is NULL. - DataLength is 0. - DeviceSpeed is not one of the supported values listed above. - - MaximumPacketLength is invalid. MaximumPacketLength must be 1023 or less for full-speed + - MaximumPacketLength is invalid. MaximumPacketLength must be 1023 or less for full-speed devices and 1024 or less for high-speed and super-speed devices. @param This A pointer to the EFI_USB2_HC_PROTOCOL instance. @param DeviceAddress Represents the address of the target device on the USB. @param EndPointAddress The combination of an endpoint number and an endpoint direction of the target USB device. - @param DeviceSpeed Indicates device speed. The supported values are EFI_USB_SPEED_FULL, + @param DeviceSpeed Indicates device speed. The supported values are EFI_USB_SPEED_FULL, EFI_USB_SPEED_HIGH, or EFI_USB_SPEED_SUPER. @param MaximumPacketLength Indicates the maximum packet size the target endpoint is capable of sending or receiving. @@ -622,11 +622,11 @@ EFI_STATUS ); /// -/// The EFI_USB2_HC_PROTOCOL provides USB host controller management, basic -/// data transactions over a USB bus, and USB root hub access. A device driver -/// that wishes to manage a USB bus in a system retrieves the EFI_USB2_HC_PROTOCOL -/// instance that is associated with the USB bus to be managed. A device handle -/// for a USB host controller will minimally contain an EFI_DEVICE_PATH_PROTOCOL +/// The EFI_USB2_HC_PROTOCOL provides USB host controller management, basic +/// data transactions over a USB bus, and USB root hub access. A device driver +/// that wishes to manage a USB bus in a system retrieves the EFI_USB2_HC_PROTOCOL +/// instance that is associated with the USB bus to be managed. A device handle +/// for a USB host controller will minimally contain an EFI_DEVICE_PATH_PROTOCOL /// instance, and an EFI_USB2_HC_PROTOCOL instance. /// struct _EFI_USB2_HC_PROTOCOL { @@ -643,18 +643,18 @@ struct _EFI_USB2_HC_PROTOCOL { EFI_USB2_HC_PROTOCOL_GET_ROOTHUB_PORT_STATUS GetRootHubPortStatus; EFI_USB2_HC_PROTOCOL_SET_ROOTHUB_PORT_FEATURE SetRootHubPortFeature; EFI_USB2_HC_PROTOCOL_CLEAR_ROOTHUB_PORT_FEATURE ClearRootHubPortFeature; - + /// - /// The major revision number of the USB host controller. The revision information - /// indicates the release of the Universal Serial Bus Specification with which the + /// The major revision number of the USB host controller. The revision information + /// indicates the release of the Universal Serial Bus Specification with which the /// host controller is compliant. /// UINT16 MajorRevision; /// - /// The minor revision number of the USB host controller. The revision information - /// indicates the release of the Universal Serial Bus Specification with which the - /// host controller is compliant. + /// The minor revision number of the USB host controller. The revision information + /// indicates the release of the Universal Serial Bus Specification with which the + /// host controller is compliant. /// UINT16 MinorRevision; }; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UsbHostController.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UsbHostController.h index 2196903a0f..917b70af31 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UsbHostController.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UsbHostController.h @@ -1,18 +1,18 @@ /** @file EFI_USB_HC_PROTOCOL as defined in EFI 1.10. - The USB Host Controller Protocol is used by code, typically USB bus drivers, - running in the EFI boot services environment, to perform data transactions + The USB Host Controller Protocol is used by code, typically USB bus drivers, + running in the EFI boot services environment, to perform data transactions over a USB bus. In addition, it provides an abstraction for the root hub of the USB bus. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -35,18 +35,18 @@ typedef struct _EFI_USB_HC_PROTOCOL EFI_USB_HC_PROTOCOL; // Protocol definitions // -/** +/** Provides software reset for the USB host controller. - + @param This A pointer to the EFI_USB_HC_PROTOCOL instance. @param Attributes A bit mask of the reset operation to perform. - + @retval EFI_SUCCESS The reset operation succeeded. @retval EFI_UNSUPPORTED The type of reset specified by Attributes is not currently supported - by the host controller hardware. + by the host controller hardware. @retval EFI_INVALID_PARAMETER Attributes is not valid. @retval EFI_DEVICE_ERROR An error was encountered while attempting to perform the reset operation. - + **/ typedef EFI_STATUS @@ -55,18 +55,18 @@ EFI_STATUS IN UINT16 Attributes ); -/** +/** Retrieves current state of the USB host controller. - + @param This A pointer to the EFI_USB_HC_PROTOCOL instance. @param State A pointer to the EFI_USB_HC_STATE data structure that - indicates current state of the USB host controller. - + indicates current state of the USB host controller. + @retval EFI_SUCCESS The state information of the host controller was returned in State. @retval EFI_INVALID_PARAMETER State is NULL. @retval EFI_DEVICE_ERROR An error was encountered while attempting to retrieve the host controller's - current state. - + current state. + **/ typedef EFI_STATUS @@ -75,17 +75,17 @@ EFI_STATUS OUT EFI_USB_HC_STATE *State ); -/** +/** Sets the USB host controller to a specific state. - + @param This A pointer to the EFI_USB_HC_PROTOCOL instance. - @param State Indicates the state of the host controller that will be set. - + @param State Indicates the state of the host controller that will be set. + @retval EFI_SUCCESS The USB host controller was successfully placed in the state specified by - State. + State. @retval EFI_INVALID_PARAMETER State is NULL. - @retval EFI_DEVICE_ERROR Failed to set the state specified by State due to device error. - + @retval EFI_DEVICE_ERROR Failed to set the state specified by State due to device error. + **/ typedef EFI_STATUS @@ -94,36 +94,36 @@ EFI_STATUS IN EFI_USB_HC_STATE State ); -/** +/** Submits control transfer to a target USB device. - + @param This A pointer to the EFI_USB_HC_PROTOCOL instance. @param DeviceAddress Represents the address of the target device on the USB, which is - assigned during USB enumeration. + assigned during USB enumeration. @param IsSlowDevice Indicates whether the target device is slow device or full-speed - device. - @param MaximumPacketLength Indicates the maximum packet size that the default control - transfer endpoint is capable of sending or receiving. + device. + @param MaximumPacketLength Indicates the maximum packet size that the default control + transfer endpoint is capable of sending or receiving. @param Request A pointer to the USB device request that will be sent to the USB device. - @param TransferDirection Specifies the data direction for the transfer. There are three + @param TransferDirection Specifies the data direction for the transfer. There are three values available, EfiUsbDataIn, EfiUsbDataOut and EfiUsbNoData. - @param Data A pointer to the buffer of data that will be transmitted to USB - device or received from USB device. + @param Data A pointer to the buffer of data that will be transmitted to USB + device or received from USB device. @param DataLength On input, indicates the size, in bytes, of the data buffer specified - by Data. On output, indicates the amount of data actually - transferred. + by Data. On output, indicates the amount of data actually + transferred. @param TimeOut Indicates the maximum time, in milliseconds, which the transfer - is allowed to complete. - @param TransferResult A pointer to the detailed result information generated by this + is allowed to complete. + @param TransferResult A pointer to the detailed result information generated by this control transfer. - + @retval EFI_SUCCESS The control transfer was completed successfully. - @retval EFI_OUT_OF_RESOURCES The control transfer could not be completed due to a lack of resources. + @retval EFI_OUT_OF_RESOURCES The control transfer could not be completed due to a lack of resources. @retval EFI_INVALID_PARAMETER Some parameters are invalid. @retval EFI_TIMEOUT The control transfer failed due to timeout. @retval EFI_DEVICE_ERROR The control transfer failed due to host controller or device error. - + **/ typedef EFI_STATUS @@ -140,36 +140,36 @@ EFI_STATUS OUT UINT32 *TransferResult ); -/** +/** Submits bulk transfer to a bulk endpoint of a USB device. - + @param This A pointer to the EFI_USB_HC_PROTOCOL instance. @param DeviceAddress Represents the address of the target device on the USB, which is - assigned during USB enumeration. - @param EndPointAddress The combination of an endpoint number and an endpoint - direction of the target USB device. Each endpoint address - supports data transfer in one direction except the control - endpoint (whose default endpoint address is 0). It is the - caller's responsibility to make sure that the EndPointAddress - represents a bulk endpoint. - @param MaximumPacketLength Indicates the maximum packet size that the default control - transfer endpoint is capable of sending or receiving. - @param Data A pointer to the buffer of data that will be transmitted to USB - device or received from USB device. + assigned during USB enumeration. + @param EndPointAddress The combination of an endpoint number and an endpoint + direction of the target USB device. Each endpoint address + supports data transfer in one direction except the control + endpoint (whose default endpoint address is 0). It is the + caller's responsibility to make sure that the EndPointAddress + represents a bulk endpoint. + @param MaximumPacketLength Indicates the maximum packet size that the default control + transfer endpoint is capable of sending or receiving. + @param Data A pointer to the buffer of data that will be transmitted to USB + device or received from USB device. @param DataLength On input, indicates the size, in bytes, of the data buffer specified - by Data. On output, indicates the amount of data actually - transferred. - @param DataToggle A pointer to the data toggle value. + by Data. On output, indicates the amount of data actually + transferred. + @param DataToggle A pointer to the data toggle value. @param TimeOut Indicates the maximum time, in milliseconds, which the transfer - is allowed to complete. + is allowed to complete. @param TransferResult A pointer to the detailed result information of the bulk transfer. - + @retval EFI_SUCCESS The bulk transfer was completed successfully. - @retval EFI_OUT_OF_RESOURCES The bulk transfer could not be completed due to a lack of resources. + @retval EFI_OUT_OF_RESOURCES The bulk transfer could not be completed due to a lack of resources. @retval EFI_INVALID_PARAMETER Some parameters are invalid. @retval EFI_TIMEOUT The bulk transfer failed due to timeout. @retval EFI_DEVICE_ERROR The bulk transfer failed due to host controller or device error. - + **/ typedef EFI_STATUS @@ -185,47 +185,47 @@ EFI_STATUS OUT UINT32 *TransferResult ); -/** +/** Submits an asynchronous interrupt transfer to an interrupt endpoint of a USB device. - + @param This A pointer to the EFI_USB_HC_PROTOCOL instance. @param DeviceAddress Represents the address of the target device on the USB, which is - assigned during USB enumeration. + assigned during USB enumeration. @param EndPointAddress The combination of an endpoint number and an endpoint direction of the target USB device. Each endpoint address supports data transfer in one direction except the control endpoint (whose default endpoint address is zero). It is the caller's responsibility to make sure that the - EndPointAddress represents an interrupt endpoint. + EndPointAddress represents an interrupt endpoint. @param IsSlowDevice Indicates whether the target device is slow device or full-speed - device. - @param MaximumPacketLength Indicates the maximum packet size that the default control - transfer endpoint is capable of sending or receiving. - @param IsNewTransfer If TRUE, an asynchronous interrupt pipe is built between the host - and the target interrupt endpoint. If FALSE, the specified asynchronous - interrupt pipe is canceled. If TRUE, and an interrupt transfer exists - for the target end point, then EFI_INVALID_PARAMETER is returned. - @param DataToggle A pointer to the data toggle value. On input, it is valid when - IsNewTransfer is TRUE, and it indicates the initial data toggle - value the asynchronous interrupt transfer should adopt. On output, - it is valid when IsNewTransfer is FALSE, and it is updated to indicate - the data toggle value of the subsequent asynchronous interrupt transfer. + device. + @param MaximumPacketLength Indicates the maximum packet size that the default control + transfer endpoint is capable of sending or receiving. + @param IsNewTransfer If TRUE, an asynchronous interrupt pipe is built between the host + and the target interrupt endpoint. If FALSE, the specified asynchronous + interrupt pipe is canceled. If TRUE, and an interrupt transfer exists + for the target end point, then EFI_INVALID_PARAMETER is returned. + @param DataToggle A pointer to the data toggle value. On input, it is valid when + IsNewTransfer is TRUE, and it indicates the initial data toggle + value the asynchronous interrupt transfer should adopt. On output, + it is valid when IsNewTransfer is FALSE, and it is updated to indicate + the data toggle value of the subsequent asynchronous interrupt transfer. @param PollingInterval Indicates the interval, in milliseconds, that the asynchronous - interrupt transfer is polled. + interrupt transfer is polled. @param DataLength Indicates the length of data to be received at the rate specified by - PollingInterval from the target asynchronous interrupt - endpoint. This parameter is only required when IsNewTransfer is TRUE. - @param CallBackFunction The Callback function. This function is called at the rate specified by - PollingInterval. This parameter is only required when IsNewTransfer is TRUE. + PollingInterval from the target asynchronous interrupt + endpoint. This parameter is only required when IsNewTransfer is TRUE. + @param CallBackFunction The Callback function. This function is called at the rate specified by + PollingInterval. This parameter is only required when IsNewTransfer is TRUE. @param Context The context that is passed to the CallBackFunction. - + @retval EFI_SUCCESS The asynchronous interrupt transfer request has been successfully - submitted or canceled. - @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. + submitted or canceled. + @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. @retval EFI_INVALID_PARAMETER Some parameters are invalid. @retval EFI_TIMEOUT The bulk transfer failed due to timeout. @retval EFI_DEVICE_ERROR The bulk transfer failed due to host controller or device error. - + **/ typedef EFI_STATUS @@ -243,41 +243,41 @@ EFI_STATUS IN VOID *Context OPTIONAL ); -/** +/** Submits synchronous interrupt transfer to an interrupt endpoint of a USB device. - + @param This A pointer to the EFI_USB_HC_PROTOCOL instance. @param DeviceAddress Represents the address of the target device on the USB, which is - assigned during USB enumeration. + assigned during USB enumeration. @param EndPointAddress The combination of an endpoint number and an endpoint direction of the target USB device. Each endpoint address supports data transfer in one direction except the control endpoint (whose default endpoint address is zero). It is the caller's responsibility to make sure that the - EndPointAddress represents an interrupt endpoint. + EndPointAddress represents an interrupt endpoint. @param IsSlowDevice Indicates whether the target device is slow device or full-speed - device. - @param MaximumPacketLength Indicates the maximum packet size that the default control - transfer endpoint is capable of sending or receiving. + device. + @param MaximumPacketLength Indicates the maximum packet size that the default control + transfer endpoint is capable of sending or receiving. @param Data A pointer to the buffer of data that will be transmitted to USB - device or received from USB device. asynchronous interrupt pipe is canceled. + device or received from USB device. asynchronous interrupt pipe is canceled. @param DataLength On input, the size, in bytes, of the data buffer specified by Data. - On output, the number of bytes transferred. - @param DataToggle A pointer to the data toggle value. On input, it indicates the initial - data toggle value the synchronous interrupt transfer should adopt; - on output, it is updated to indicate the data toggle value of the - subsequent synchronous interrupt transfer. - @param TimeOut Indicates the maximum time, in milliseconds, which the transfer - is allowed to complete. + On output, the number of bytes transferred. + @param DataToggle A pointer to the data toggle value. On input, it indicates the initial + data toggle value the synchronous interrupt transfer should adopt; + on output, it is updated to indicate the data toggle value of the + subsequent synchronous interrupt transfer. + @param TimeOut Indicates the maximum time, in milliseconds, which the transfer + is allowed to complete. @param TransferResult A pointer to the detailed result information from the synchronous interrupt transfer. - + @retval EFI_SUCCESS The synchronous interrupt transfer was completed successfully. - @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. + @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. @retval EFI_INVALID_PARAMETER Some parameters are invalid. @retval EFI_TIMEOUT The synchronous interrupt transfer failed due to timeout. @retval EFI_DEVICE_ERROR The synchronous interrupt transfer failed due to host controller or device error. - + **/ typedef EFI_STATUS @@ -294,33 +294,33 @@ EFI_STATUS OUT UINT32 *TransferResult ); -/** +/** Submits isochronous transfer to an isochronous endpoint of a USB device. - + @param This A pointer to the EFI_USB_HC_PROTOCOL instance. @param DeviceAddress Represents the address of the target device on the USB, which is - assigned during USB enumeration. + assigned during USB enumeration. @param EndPointAddress The combination of an endpoint number and an endpoint direction of the target USB device. Each endpoint address supports data transfer in one direction except the control endpoint (whose default endpoint address is 0). It is the caller's responsibility to make sure that the EndPointAddress - represents an isochronous endpoint. - @param MaximumPacketLength Indicates the maximum packet size that the default control - transfer endpoint is capable of sending or receiving. + represents an isochronous endpoint. + @param MaximumPacketLength Indicates the maximum packet size that the default control + transfer endpoint is capable of sending or receiving. @param Data A pointer to the buffer of data that will be transmitted to USB - device or received from USB device. asynchronous interrupt pipe is canceled. + device or received from USB device. asynchronous interrupt pipe is canceled. @param DataLength Specifies the length, in bytes, of the data to be sent to or received - from the USB device. + from the USB device. @param TransferResult A pointer to the detailed result information from the isochronous transfer. - + @retval EFI_SUCCESS The isochronous transfer was completed successfully. - @retval EFI_OUT_OF_RESOURCES The isochronous could not be completed due to a lack of resources. + @retval EFI_OUT_OF_RESOURCES The isochronous could not be completed due to a lack of resources. @retval EFI_INVALID_PARAMETER Some parameters are invalid. @retval EFI_TIMEOUT The isochronous transfer failed due to timeout. @retval EFI_DEVICE_ERROR The isochronous transfer failed due to host controller or device error. - + **/ typedef EFI_STATUS @@ -334,36 +334,36 @@ EFI_STATUS OUT UINT32 *TransferResult ); -/** +/** Submits nonblocking isochronous transfer to an isochronous endpoint of a USB device. - + @param This A pointer to the EFI_USB_HC_PROTOCOL instance. @param DeviceAddress Represents the address of the target device on the USB, which is - assigned during USB enumeration. + assigned during USB enumeration. @param EndPointAddress The combination of an endpoint number and an endpoint direction of the target USB device. Each endpoint address supports data transfer in one direction except the control endpoint (whose default endpoint address is zero). It is the caller's responsibility to make sure that the - EndPointAddress represents an isochronous endpoint. - @param MaximumPacketLength Indicates the maximum packet size that the default control - transfer endpoint is capable of sending or receiving. For isochronous - endpoints, this value is used to reserve the bus time in the schedule, + EndPointAddress represents an isochronous endpoint. + @param MaximumPacketLength Indicates the maximum packet size that the default control + transfer endpoint is capable of sending or receiving. For isochronous + endpoints, this value is used to reserve the bus time in the schedule, required for the perframe data payloads. The pipe may, on an ongoing basis, - actually use less bandwidth than that reserved. + actually use less bandwidth than that reserved. @param Data A pointer to the buffer of data that will be transmitted to USB - device or received from USB device. asynchronous interrupt pipe is canceled. + device or received from USB device. asynchronous interrupt pipe is canceled. @param DataLength Specifies the length, in bytes, of the data to be sent to or received - from the USB device. + from the USB device. @param IsochronousCallback The Callback function.This function is called if the requested isochronous transfer is completed. @param Context Data passed to the IsochronousCallback function. This is an optional parameter and may be NULL. - + @retval EFI_SUCCESS The asynchronous isochronous transfer was completed successfully. - @retval EFI_OUT_OF_RESOURCES The asynchronous isochronous could not be completed due to a lack of resources. + @retval EFI_OUT_OF_RESOURCES The asynchronous isochronous could not be completed due to a lack of resources. @retval EFI_INVALID_PARAMETER Some parameters are invalid. - + **/ typedef EFI_STATUS @@ -378,16 +378,16 @@ EFI_STATUS IN VOID *Context OPTIONAL ); -/** +/** Retrieves the number of root hub ports. - + @param This A pointer to the EFI_USB_HC_PROTOCOL instance. - @param PortNumber A pointer to the number of the root hub ports. - + @param PortNumber A pointer to the number of the root hub ports. + @retval EFI_SUCCESS The port number was retrieved successfully. @retval EFI_DEVICE_ERROR An error was encountered while attempting to retrieve the port number. @retval EFI_INVALID_PARAMETER PortNumber is NULL. - + **/ typedef EFI_STATUS @@ -396,20 +396,20 @@ EFI_STATUS OUT UINT8 *PortNumber ); -/** +/** Retrieves the current status of a USB root hub port. - + @param This A pointer to the EFI_USB_HC_PROTOCOL instance. @param PortNumber Specifies the root hub port from which the status is to be retrieved. This value is zero based. For example, if a root hub has two ports, then the first port is numbered 0, and the second port is numbered 1. - @param PortStatus A pointer to the current port status bits and port status change bits. - + @param PortStatus A pointer to the current port status bits and port status change bits. + @retval EFI_SUCCESS The status of the USB root hub port specified by PortNumber - was returned in PortStatus. + was returned in PortStatus. @retval EFI_INVALID_PARAMETER PortNumber is invalid. - + **/ typedef EFI_STATUS @@ -419,9 +419,9 @@ EFI_STATUS OUT EFI_USB_PORT_STATUS *PortStatus ); -/** +/** Sets a feature for the specified root hub port. - + @param This A pointer to the EFI_USB_HC_PROTOCOL instance. @param PortNumber Specifies the root hub port from which the status is to be retrieved. This value is zero based. For example, if a root hub has two ports, @@ -429,11 +429,11 @@ EFI_STATUS numbered 1. @param PortFeature Indicates the feature selector associated with the feature set request. - + @retval EFI_SUCCESS The feature specified by PortFeature was set for the USB - root hub port specified by PortNumber. + root hub port specified by PortNumber. @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid for this function. - + **/ typedef EFI_STATUS @@ -443,9 +443,9 @@ EFI_STATUS IN EFI_USB_PORT_FEATURE PortFeature ); -/** +/** Clears a feature for the specified root hub port. - + @param This A pointer to the EFI_USB_HC_PROTOCOL instance. @param PortNumber Specifies the root hub port from which the status is to be retrieved. This value is zero based. For example, if a root hub has two ports, @@ -453,11 +453,11 @@ EFI_STATUS numbered 1. @param PortFeature Indicates the feature selector associated with the feature clear request. - + @retval EFI_SUCCESS The feature specified by PortFeature was cleared for the USB - root hub port specified by PortNumber. + root hub port specified by PortNumber. @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid for this function. - + **/ typedef EFI_STATUS @@ -473,7 +473,7 @@ EFI_STATUS /// over a USB bus, and USB root hub access. A device driver that wishes to manage a USB bus in a /// system retrieves the EFI_USB_HC_PROTOCOL instance that is associated with the USB bus to be /// managed. A device handle for a USB host controller will minimally contain an -/// EFI_DEVICE_PATH_PROTOCOL instance, and an EFI_USB_HC_PROTOCOL instance. +/// EFI_DEVICE_PATH_PROTOCOL instance, and an EFI_USB_HC_PROTOCOL instance. /// struct _EFI_USB_HC_PROTOCOL { EFI_USB_HC_PROTOCOL_RESET Reset; @@ -490,16 +490,16 @@ struct _EFI_USB_HC_PROTOCOL { EFI_USB_HC_PROTOCOL_SET_ROOTHUB_PORT_FEATURE SetRootHubPortFeature; EFI_USB_HC_PROTOCOL_CLEAR_ROOTHUB_PORT_FEATURE ClearRootHubPortFeature; /// - /// The major revision number of the USB host controller. The revision information - /// indicates the release of the Universal Serial Bus Specification with which the + /// The major revision number of the USB host controller. The revision information + /// indicates the release of the Universal Serial Bus Specification with which the /// host controller is compliant. - /// + /// UINT16 MajorRevision; /// - /// The minor revision number of the USB host controller. The revision information - /// indicates the release of the Universal Serial Bus Specification with which the - /// host controller is compliant. - /// + /// The minor revision number of the USB host controller. The revision information + /// indicates the release of the Universal Serial Bus Specification with which the + /// host controller is compliant. + /// UINT16 MinorRevision; }; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UsbIo.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UsbIo.h index cc7263b6aa..c95c6627ad 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UsbIo.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UsbIo.h @@ -1,10 +1,10 @@ /** @file EFI Usb I/O Protocol as defined in UEFI specification. - This protocol is used by code, typically drivers, running in the EFI - boot services environment to access USB devices like USB keyboards, - mice and mass storage devices. In particular, functions for managing devices + This protocol is used by code, typically drivers, running in the EFI + boot services environment to access USB devices like USB keyboards, + mice and mass storage devices. In particular, functions for managing devices on USB buses are defined here. - + Copyright (c) 2006 - 2008, 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 @@ -134,13 +134,13 @@ EFI_STATUS typically used to transfer large amounts of data to/from USB devices. @param This A pointer to the EFI_USB_IO_PROTOCOL instance. - @param DeviceEndpoint The destination USB device endpoint to which the - device request is being sent. DeviceEndpoint must - be between 0x01 and 0x0F or between 0x81 and 0x8F, - otherwise EFI_INVALID_PARAMETER is returned. If - the endpoint is not a BULK endpoint, EFI_INVALID_PARAMETER - is returned. The MSB of this parameter indicates - the endpoint direction. The number "1" stands for + @param DeviceEndpoint The destination USB device endpoint to which the + device request is being sent. DeviceEndpoint must + be between 0x01 and 0x0F or between 0x81 and 0x8F, + otherwise EFI_INVALID_PARAMETER is returned. If + the endpoint is not a BULK endpoint, EFI_INVALID_PARAMETER + is returned. The MSB of this parameter indicates + the endpoint direction. The number "1" stands for an IN endpoint, and "0" stands for an OUT endpoint. @param Data A pointer to the buffer of data that will be transmitted to USB device or received from USB device. @@ -148,8 +148,8 @@ EFI_STATUS On input, the size, in bytes, of the data buffer specified by Data. On output, the number of bytes that were actually transferred. @param Timeout Indicating the transfer should be completed within this time frame. - The units are in milliseconds. If Timeout is 0, then the - caller must wait for the function to be completed until + The units are in milliseconds. If Timeout is 0, then the + caller must wait for the function to be completed until EFI_SUCCESS or EFI_DEVICE_ERROR is returned. @param Status This parameter indicates the USB transfer status. @@ -178,27 +178,27 @@ EFI_STATUS a fixed rate. @param This A pointer to the EFI_USB_IO_PROTOCOL instance. - @param DeviceEndpoint The destination USB device endpoint to which the - device request is being sent. DeviceEndpoint must - be between 0x01 and 0x0F or between 0x81 and 0x8F, - otherwise EFI_INVALID_PARAMETER is returned. If - the endpoint is not a BULK endpoint, EFI_INVALID_PARAMETER - is returned. The MSB of this parameter indicates - the endpoint direction. The number "1" stands for + @param DeviceEndpoint The destination USB device endpoint to which the + device request is being sent. DeviceEndpoint must + be between 0x01 and 0x0F or between 0x81 and 0x8F, + otherwise EFI_INVALID_PARAMETER is returned. If + the endpoint is not a BULK endpoint, EFI_INVALID_PARAMETER + is returned. The MSB of this parameter indicates + the endpoint direction. The number "1" stands for an IN endpoint, and "0" stands for an OUT endpoint. @param IsNewTransfer If TRUE, a new transfer will be submitted to USB controller. If FALSE, the interrupt transfer is deleted from the device's interrupt transfer queue. @param PollingInterval Indicates the periodic rate, in milliseconds, that the transfer is to be - executed.This parameter is required when IsNewTransfer is TRUE. The - value must be between 1 to 255, otherwise EFI_INVALID_PARAMETER is returned. + executed.This parameter is required when IsNewTransfer is TRUE. The + value must be between 1 to 255, otherwise EFI_INVALID_PARAMETER is returned. The units are in milliseconds. @param DataLength Specifies the length, in bytes, of the data to be received from the USB device. This parameter is only required when IsNewTransfer is TRUE. @param InterruptCallback The Callback function. This function is called if the asynchronous - interrupt transfer is completed. This parameter is required + interrupt transfer is completed. This parameter is required when IsNewTransfer is TRUE. - @param Context Data passed to the InterruptCallback function. This is an optional + @param Context Data passed to the InterruptCallback function. This is an optional parameter and may be NULL. @retval EFI_SUCCESS The asynchronous USB transfer request transfer has been successfully executed. @@ -221,21 +221,21 @@ EFI_STATUS This function is used to manage a USB device with an interrupt transfer pipe. @param This A pointer to the EFI_USB_IO_PROTOCOL instance. - @param DeviceEndpoint The destination USB device endpoint to which the - device request is being sent. DeviceEndpoint must - be between 0x01 and 0x0F or between 0x81 and 0x8F, - otherwise EFI_INVALID_PARAMETER is returned. If - the endpoint is not a BULK endpoint, EFI_INVALID_PARAMETER - is returned. The MSB of this parameter indicates - the endpoint direction. The number "1" stands for + @param DeviceEndpoint The destination USB device endpoint to which the + device request is being sent. DeviceEndpoint must + be between 0x01 and 0x0F or between 0x81 and 0x8F, + otherwise EFI_INVALID_PARAMETER is returned. If + the endpoint is not a BULK endpoint, EFI_INVALID_PARAMETER + is returned. The MSB of this parameter indicates + the endpoint direction. The number "1" stands for an IN endpoint, and "0" stands for an OUT endpoint. @param Data A pointer to the buffer of data that will be transmitted to USB device or received from USB device. @param DataLength On input, then size, in bytes, of the buffer Data. On output, the amount of data actually transferred. - @param Timeout The time out, in seconds, for this transfer. If Timeout is 0, - then the caller must wait for the function to be completed - until EFI_SUCCESS or EFI_DEVICE_ERROR is returned. If the + @param Timeout The time out, in seconds, for this transfer. If Timeout is 0, + then the caller must wait for the function to be completed + until EFI_SUCCESS or EFI_DEVICE_ERROR is returned. If the transfer is not completed in this time frame, then EFI_TIMEOUT is returned. @param Status This parameter indicates the USB transfer status. @@ -261,13 +261,13 @@ EFI_STATUS transfer is typically used to transfer streaming data. @param This A pointer to the EFI_USB_IO_PROTOCOL instance. - @param DeviceEndpoint The destination USB device endpoint to which the - device request is being sent. DeviceEndpoint must - be between 0x01 and 0x0F or between 0x81 and 0x8F, - otherwise EFI_INVALID_PARAMETER is returned. If - the endpoint is not a BULK endpoint, EFI_INVALID_PARAMETER - is returned. The MSB of this parameter indicates - the endpoint direction. The number "1" stands for + @param DeviceEndpoint The destination USB device endpoint to which the + device request is being sent. DeviceEndpoint must + be between 0x01 and 0x0F or between 0x81 and 0x8F, + otherwise EFI_INVALID_PARAMETER is returned. If + the endpoint is not a BULK endpoint, EFI_INVALID_PARAMETER + is returned. The MSB of this parameter indicates + the endpoint direction. The number "1" stands for an IN endpoint, and "0" stands for an OUT endpoint. @param Data A pointer to the buffer of data that will be transmitted to USB device or received from USB device. @@ -296,19 +296,19 @@ EFI_STATUS transfer is typically used to transfer streaming data. @param This A pointer to the EFI_USB_IO_PROTOCOL instance. - @param DeviceEndpoint The destination USB device endpoint to which the - device request is being sent. DeviceEndpoint must - be between 0x01 and 0x0F or between 0x81 and 0x8F, - otherwise EFI_INVALID_PARAMETER is returned. If - the endpoint is not a BULK endpoint, EFI_INVALID_PARAMETER - is returned. The MSB of this parameter indicates - the endpoint direction. The number "1" stands for + @param DeviceEndpoint The destination USB device endpoint to which the + device request is being sent. DeviceEndpoint must + be between 0x01 and 0x0F or between 0x81 and 0x8F, + otherwise EFI_INVALID_PARAMETER is returned. If + the endpoint is not a BULK endpoint, EFI_INVALID_PARAMETER + is returned. The MSB of this parameter indicates + the endpoint direction. The number "1" stands for an IN endpoint, and "0" stands for an OUT endpoint. @param Data A pointer to the buffer of data that will be transmitted to USB device or received from USB device. @param DataLength The size, in bytes, of the data buffer specified by Data. This is an optional parameter and may be NULL. - @param IsochronousCallback The IsochronousCallback() function.This function is + @param IsochronousCallback The IsochronousCallback() function.This function is called if the requested isochronous transfer is completed. @param Context Data passed to the IsochronousCallback() function. @@ -432,9 +432,9 @@ EFI_STATUS @param LangID The Language ID for the string being retrieved. @param StringID The ID of the string being retrieved. @param String A pointer to a buffer allocated by this function with - AllocatePool() to store the string.If this function - returns EFI_SUCCESS, it stores the string the caller - wants to get. The caller should release the string + AllocatePool() to store the string.If this function + returns EFI_SUCCESS, it stores the string the caller + wants to get. The caller should release the string buffer with FreePool() after the string is not used any more. @retval EFI_SUCCESS The string was retrieved successfully. @@ -456,9 +456,9 @@ EFI_STATUS @param This A pointer to the EFI_USB_IO_PROTOCOL instance. @param LangIDTable Language ID for the string the caller wants to get. - This is a 16-bit ID defined by Microsoft. This - buffer pointer is allocated and maintained by - the USB Bus Driver, the caller should not modify + This is a 16-bit ID defined by Microsoft. This + buffer pointer is allocated and maintained by + the USB Bus Driver, the caller should not modify its contents. @param TableSize The size, in bytes, of the table LangIDTable. @@ -474,11 +474,11 @@ EFI_STATUS ); /// -/// The EFI_USB_IO_PROTOCOL provides four basic transfers types described -/// in the USB 1.1 Specification. These include control transfer, interrupt -/// transfer, bulk transfer and isochronous transfer. The EFI_USB_IO_PROTOCOL -/// also provides some basic USB device/controller management and configuration -/// interfaces. A USB device driver uses the services of this protocol to manage USB devices. +/// The EFI_USB_IO_PROTOCOL provides four basic transfers types described +/// in the USB 1.1 Specification. These include control transfer, interrupt +/// transfer, bulk transfer and isochronous transfer. The EFI_USB_IO_PROTOCOL +/// also provides some basic USB device/controller management and configuration +/// interfaces. A USB device driver uses the services of this protocol to manage USB devices. /// struct _EFI_USB_IO_PROTOCOL { // diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UserCredential.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UserCredential.h index 6dea643587..964ceea311 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UserCredential.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UserCredential.h @@ -5,13 +5,13 @@ Attached to a device handle, this protocol identifies a single means of identifying the user. Copyright (c) 2009 - 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -31,16 +31,16 @@ typedef struct _EFI_USER_CREDENTIAL_PROTOCOL EFI_USER_CREDENTIAL_PROTOCOL; Enroll a user on a credential provider. This function enrolls and deletes a user profile using this credential provider. If a user profile - is successfully enrolled, it calls the User Manager Protocol function Notify() to notify the user - manager driver that credential information has changed. If an enrolled user does exist, delete the + is successfully enrolled, it calls the User Manager Protocol function Notify() to notify the user + manager driver that credential information has changed. If an enrolled user does exist, delete the user on the credential provider. @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL. @param[in] User The user profile to enroll. - + @retval EFI_SUCCESS User profile was successfully enrolled. - @retval EFI_ACCESS_DENIED Current user profile does not permit enrollment on the user profile - handle. Either the user profile cannot enroll on any user profile or + @retval EFI_ACCESS_DENIED Current user profile does not permit enrollment on the user profile + handle. Either the user profile cannot enroll on any user profile or cannot enroll on a user profile other than the current user profile. @retval EFI_UNSUPPORTED This credential provider does not support enrollment in the pre-OS. @retval EFI_DEVICE_ERROR The new credential could not be created because of a device error. @@ -56,19 +56,19 @@ EFI_STATUS /** Returns the user interface information used during user identification. - This function returns information about the form used when interacting with the user during user - identification. The form is the first enabled form in the form-set class - EFI_HII_USER_CREDENTIAL_FORMSET_GUID installed on the HII handle HiiHandle. If - the user credential provider does not require a form to identify the user, then this function should + This function returns information about the form used when interacting with the user during user + identification. The form is the first enabled form in the form-set class + EFI_HII_USER_CREDENTIAL_FORMSET_GUID installed on the HII handle HiiHandle. If + the user credential provider does not require a form to identify the user, then this function should return EFI_NOT_FOUND. @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL. @param[out] Hii On return, holds the HII database handle. @param[out] FormSetId On return, holds the identifier of the form set which contains the form used during user identification. - @param[out] FormId On return, holds the identifier of the form used during user + @param[out] FormId On return, holds the identifier of the form used during user identification. - + @retval EFI_SUCCESS Form returned successfully. @retval EFI_NOT_FOUND Form not returned. @retval EFI_INVALID_PARAMETER Hii is NULL or FormSetId is NULL or FormId is NULL. @@ -85,19 +85,19 @@ EFI_STATUS /** Returns bitmap used to describe the credential provider type. - This optional function returns a bitmap which is less than or equal to the number of pixels specified - by Width and Height. If no such bitmap exists, then EFI_NOT_FOUND is returned. + This optional function returns a bitmap which is less than or equal to the number of pixels specified + by Width and Height. If no such bitmap exists, then EFI_NOT_FOUND is returned. @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL. @param[in, out] Width On entry, points to the desired bitmap width. If NULL then no bitmap - information will be returned. On exit, points to the width of the + information will be returned. On exit, points to the width of the bitmap returned. - @param[in, out] Height On entry, points to the desired bitmap height. If NULL then no bitmap - information will be returned. On exit, points to the height of the + @param[in, out] Height On entry, points to the desired bitmap height. If NULL then no bitmap + information will be returned. On exit, points to the height of the bitmap returned - @param[out] Hii On return, holds the HII database handle. - @param[out] Image On return, holds the HII image identifier. - + @param[out] Hii On return, holds the HII database handle. + @param[out] Image On return, holds the HII image identifier. + @retval EFI_SUCCESS Image identifier returned successfully. @retval EFI_NOT_FOUND Image identifier not returned. @retval EFI_INVALID_PARAMETER Hii is NULL or Image is NULL. @@ -115,13 +115,13 @@ EFI_STATUS /** Returns string used to describe the credential provider type. - This function returns a string which describes the credential provider. If no such string exists, then - EFI_NOT_FOUND is returned. + This function returns a string which describes the credential provider. If no such string exists, then + EFI_NOT_FOUND is returned. @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL. @param[out] Hii On return, holds the HII database handle. @param[out] String On return, holds the HII string identifier. - + @retval EFI_SUCCESS String identifier returned successfully. @retval EFI_NOT_FOUND String identifier not returned. @retval EFI_INVALID_PARAMETER Hii is NULL or String is NULL. @@ -137,21 +137,21 @@ EFI_STATUS /** Return the user identifier associated with the currently authenticated user. - This function returns the user identifier of the user authenticated by this credential provider. This - function is called after the credential-related information has been submitted on a form OR after a + This function returns the user identifier of the user authenticated by this credential provider. This + function is called after the credential-related information has been submitted on a form OR after a call to Default() has returned that this credential is ready to log on. @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL. - @param[in] User The user profile handle of the user profile currently being considered - by the user identity manager. If NULL, then no user profile is currently + @param[in] User The user profile handle of the user profile currently being considered + by the user identity manager. If NULL, then no user profile is currently under consideration. - @param[out] Identifier On return, points to the user identifier. - + @param[out] Identifier On return, points to the user identifier. + @retval EFI_SUCCESS User identifier returned successfully. @retval EFI_NOT_READY No user identifier can be returned. @retval EFI_ACCESS_DENIED The user has been locked out of this user credential. - @retval EFI_NOT_FOUND User is not NULL, and the specified user handle can't be found in user - profile database + @retval EFI_NOT_FOUND User is not NULL, and the specified user handle can't be found in user + profile database @retval EFI_INVALID_PARAMETER Identifier is NULL. **/ typedef @@ -165,13 +165,13 @@ EFI_STATUS /** Indicate that user interface interaction has begun for the specified credential. - This function is called when a credential provider is selected by the user. If AutoLogon returns - FALSE, then the user interface will be constructed by the User Identity Manager. + This function is called when a credential provider is selected by the user. If AutoLogon returns + FALSE, then the user interface will be constructed by the User Identity Manager. @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL. - @param[out] AutoLogon On return, points to the credential provider's capabilities after - the credential provider has been selected by the user. - + @param[out] AutoLogon On return, points to the credential provider's capabilities after + the credential provider has been selected by the user. + @retval EFI_SUCCESS Credential provider successfully selected. @retval EFI_INVALID_PARAMETER AutoLogon is NULL. **/ @@ -180,7 +180,7 @@ EFI_STATUS (EFIAPI *EFI_CREDENTIAL_SELECT)( IN CONST EFI_USER_CREDENTIAL_PROTOCOL *This, OUT EFI_CREDENTIAL_LOGON_FLAGS *AutoLogon - ); + ); /** Indicate that user interface interaction has ended for the specified credential. @@ -188,7 +188,7 @@ EFI_STATUS This function is called when a credential provider is deselected by the user. @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL. - + @retval EFI_SUCCESS Credential provider successfully deselected. **/ typedef @@ -200,16 +200,16 @@ EFI_STATUS /** Return the default logon behavior for this user credential. - This function reports the default login behavior regarding this credential provider. + This function reports the default login behavior regarding this credential provider. @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL. - @param[out] AutoLogon On return, holds whether the credential provider should be - used by default to automatically log on the user. - + @param[out] AutoLogon On return, holds whether the credential provider should be + used by default to automatically log on the user. + @retval EFI_SUCCESS Default information successfully returned. @retval EFI_INVALID_PARAMETER AutoLogon is NULL. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_CREDENTIAL_DEFAULT)( IN CONST EFI_USER_CREDENTIAL_PROTOCOL *This, @@ -219,22 +219,22 @@ EFI_STATUS /** Return information attached to the credential provider. - This function returns user information. + This function returns user information. @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL. - @param[in] UserInfo Handle of the user information data record. - @param[out] Info On entry, points to a buffer of at least *InfoSize bytes. On exit, holds the user - information. If the buffer is too small to hold the information, then - EFI_BUFFER_TOO_SMALL is returned and InfoSize is updated to contain the + @param[in] UserInfo Handle of the user information data record. + @param[out] Info On entry, points to a buffer of at least *InfoSize bytes. On exit, holds the user + information. If the buffer is too small to hold the information, then + EFI_BUFFER_TOO_SMALL is returned and InfoSize is updated to contain the number of bytes actually required. - @param[in,out] InfoSize On entry, points to the size of Info. On return, points to the size of the user - information. - + @param[in,out] InfoSize On entry, points to the size of Info. On return, points to the size of the user + information. + @retval EFI_SUCCESS Information returned successfully. - @retval EFI_BUFFER_TOO_SMALL The size specified by InfoSize is too small to hold all of the user + @retval EFI_BUFFER_TOO_SMALL The size specified by InfoSize is too small to hold all of the user information. The size required is returned in *InfoSize. @retval EFI_NOT_FOUND The specified UserInfo does not refer to a valid user info handle. - @retval EFI_INVALID_PARAMETER Info is NULL or InfoSize is NULL. + @retval EFI_INVALID_PARAMETER Info is NULL or InfoSize is NULL. **/ typedef EFI_STATUS @@ -248,15 +248,15 @@ EFI_STATUS /** Enumerate all of the user information records on the credential provider. - This function returns the next user information record. To retrieve the first user information record - handle, point UserInfo at a NULL. Each subsequent call will retrieve another user information - record handle until there are no more, at which point UserInfo will point to NULL. + This function returns the next user information record. To retrieve the first user information record + handle, point UserInfo at a NULL. Each subsequent call will retrieve another user information + record handle until there are no more, at which point UserInfo will point to NULL. @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL. - @param[in,out] UserInfo On entry, points to the previous user information handle or NULL to - start enumeration. On exit, points to the next user information handle + @param[in,out] UserInfo On entry, points to the previous user information handle or NULL to + start enumeration. On exit, points to the next user information handle or NULL if there is no more user information. - + @retval EFI_SUCCESS User information returned. @retval EFI_NOT_FOUND No more user information found. @retval EFI_INVALID_PARAMETER UserInfo is NULL. @@ -279,7 +279,7 @@ struct _EFI_USER_CREDENTIAL_PROTOCOL { EFI_CREDENTIAL_TILE Tile; EFI_CREDENTIAL_TITLE Title; EFI_CREDENTIAL_USER User; - EFI_CREDENTIAL_SELECT Select; + EFI_CREDENTIAL_SELECT Select; EFI_CREDENTIAL_DESELECT Deselect; EFI_CREDENTIAL_DEFAULT Default; EFI_CREDENTIAL_GET_INFO GetInfo; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UserCredential2.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UserCredential2.h index ed3423b47f..b30ca293a9 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UserCredential2.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UserCredential2.h @@ -4,13 +4,13 @@ Attached to a device handle, this protocol identifies a single means of identifying the user. Copyright (c) 2009 - 2011, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -29,16 +29,16 @@ typedef struct _EFI_USER_CREDENTIAL2_PROTOCOL EFI_USER_CREDENTIAL2_PROTOCOL; /** Enroll a user on a credential provider. - This function enrolls a user on this credential provider. If the user exists on this credential - provider, update the user information on this credential provider; otherwise add the user information + This function enrolls a user on this credential provider. If the user exists on this credential + provider, update the user information on this credential provider; otherwise add the user information on credential provider. @param[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL. @param[in] User The user profile to enroll. - + @retval EFI_SUCCESS User profile was successfully enrolled. - @retval EFI_ACCESS_DENIED Current user profile does not permit enrollment on the user profile - handle. Either the user profile cannot enroll on any user profile or + @retval EFI_ACCESS_DENIED Current user profile does not permit enrollment on the user profile + handle. Either the user profile cannot enroll on any user profile or cannot enroll on a user profile other than the current user profile. @retval EFI_UNSUPPORTED This credential provider does not support enrollment in the pre-OS. @retval EFI_DEVICE_ERROR The new credential could not be created because of a device error. @@ -54,19 +54,19 @@ EFI_STATUS /** Returns the user interface information used during user identification. - This function returns information about the form used when interacting with the user during user - identification. The form is the first enabled form in the form-set class - EFI_HII_USER_CREDENTIAL_FORMSET_GUID installed on the HII handle HiiHandle. If - the user credential provider does not require a form to identify the user, then this function should + This function returns information about the form used when interacting with the user during user + identification. The form is the first enabled form in the form-set class + EFI_HII_USER_CREDENTIAL_FORMSET_GUID installed on the HII handle HiiHandle. If + the user credential provider does not require a form to identify the user, then this function should return EFI_NOT_FOUND. @param[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL. @param[out] Hii On return, holds the HII database handle. @param[out] FormSetId On return, holds the identifier of the form set which contains the form used during user identification. - @param[out] FormId On return, holds the identifier of the form used during user + @param[out] FormId On return, holds the identifier of the form used during user identification. - + @retval EFI_SUCCESS Form returned successfully. @retval EFI_NOT_FOUND Form not returned. @retval EFI_INVALID_PARAMETER Hii is NULL or FormSetId is NULL or FormId is NULL. @@ -83,19 +83,19 @@ EFI_STATUS /** Returns bitmap used to describe the credential provider type. - This optional function returns a bitmap which is less than or equal to the number of pixels specified - by Width and Height. If no such bitmap exists, then EFI_NOT_FOUND is returned. + This optional function returns a bitmap which is less than or equal to the number of pixels specified + by Width and Height. If no such bitmap exists, then EFI_NOT_FOUND is returned. @param[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL. @param[in, out] Width On entry, points to the desired bitmap width. If NULL then no bitmap - information will be returned. On exit, points to the width of the + information will be returned. On exit, points to the width of the bitmap returned. - @param[in, out] Height On entry, points to the desired bitmap height. If NULL then no bitmap - information will be returned. On exit, points to the height of the + @param[in, out] Height On entry, points to the desired bitmap height. If NULL then no bitmap + information will be returned. On exit, points to the height of the bitmap returned - @param[out] Hii On return, holds the HII database handle. - @param[out] Image On return, holds the HII image identifier. - + @param[out] Hii On return, holds the HII database handle. + @param[out] Image On return, holds the HII image identifier. + @retval EFI_SUCCESS Image identifier returned successfully. @retval EFI_NOT_FOUND Image identifier not returned. @retval EFI_INVALID_PARAMETER Hii is NULL or Image is NULL. @@ -113,13 +113,13 @@ EFI_STATUS /** Returns string used to describe the credential provider type. - This function returns a string which describes the credential provider. If no such string exists, then - EFI_NOT_FOUND is returned. + This function returns a string which describes the credential provider. If no such string exists, then + EFI_NOT_FOUND is returned. @param[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL. @param[out] Hii On return, holds the HII database handle. @param[out] String On return, holds the HII string identifier. - + @retval EFI_SUCCESS String identifier returned successfully. @retval EFI_NOT_FOUND String identifier not returned. @retval EFI_INVALID_PARAMETER Hii is NULL or String is NULL. @@ -135,21 +135,21 @@ EFI_STATUS /** Return the user identifier associated with the currently authenticated user. - This function returns the user identifier of the user authenticated by this credential provider. This - function is called after the credential-related information has been submitted on a form OR after a + This function returns the user identifier of the user authenticated by this credential provider. This + function is called after the credential-related information has been submitted on a form OR after a call to Default() has returned that this credential is ready to log on. @param[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL. - @param[in] User The user profile handle of the user profile currently being considered - by the user identity manager. If NULL, then no user profile is currently + @param[in] User The user profile handle of the user profile currently being considered + by the user identity manager. If NULL, then no user profile is currently under consideration. - @param[out] Identifier On return, points to the user identifier. - + @param[out] Identifier On return, points to the user identifier. + @retval EFI_SUCCESS User identifier returned successfully. @retval EFI_NOT_READY No user identifier can be returned. @retval EFI_ACCESS_DENIED The user has been locked out of this user credential. - @retval EFI_NOT_FOUND User is not NULL, and the specified user handle can't be found in user - profile database + @retval EFI_NOT_FOUND User is not NULL, and the specified user handle can't be found in user + profile database @retval EFI_INVALID_PARAMETER Identifier is NULL. **/ typedef @@ -163,13 +163,13 @@ EFI_STATUS /** Indicate that user interface interaction has begun for the specified credential. - This function is called when a credential provider is selected by the user. If AutoLogon returns - FALSE, then the user interface will be constructed by the User Identity Manager. + This function is called when a credential provider is selected by the user. If AutoLogon returns + FALSE, then the user interface will be constructed by the User Identity Manager. @param[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL. - @param[out] AutoLogon On return, points to the credential provider's capabilities after - the credential provider has been selected by the user. - + @param[out] AutoLogon On return, points to the credential provider's capabilities after + the credential provider has been selected by the user. + @retval EFI_SUCCESS Credential provider successfully selected. @retval EFI_INVALID_PARAMETER AutoLogon is NULL. **/ @@ -178,7 +178,7 @@ EFI_STATUS (EFIAPI *EFI_CREDENTIAL2_SELECT)( IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *This, OUT EFI_CREDENTIAL_LOGON_FLAGS *AutoLogon - ); + ); /** Indicate that user interface interaction has ended for the specified credential. @@ -186,7 +186,7 @@ EFI_STATUS This function is called when a credential provider is deselected by the user. @param[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL. - + @retval EFI_SUCCESS Credential provider successfully deselected. **/ typedef @@ -198,16 +198,16 @@ EFI_STATUS /** Return the default logon behavior for this user credential. - This function reports the default login behavior regarding this credential provider. + This function reports the default login behavior regarding this credential provider. @param[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL. - @param[out] AutoLogon On return, holds whether the credential provider should be - used by default to automatically log on the user. - + @param[out] AutoLogon On return, holds whether the credential provider should be + used by default to automatically log on the user. + @retval EFI_SUCCESS Default information successfully returned. @retval EFI_INVALID_PARAMETER AutoLogon is NULL. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_CREDENTIAL2_DEFAULT)( IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *This, @@ -217,22 +217,22 @@ EFI_STATUS /** Return information attached to the credential provider. - This function returns user information. + This function returns user information. @param[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL. - @param[in] UserInfo Handle of the user information data record. - @param[out] Info On entry, points to a buffer of at least *InfoSize bytes. On exit, holds the user - information. If the buffer is too small to hold the information, then - EFI_BUFFER_TOO_SMALL is returned and InfoSize is updated to contain the + @param[in] UserInfo Handle of the user information data record. + @param[out] Info On entry, points to a buffer of at least *InfoSize bytes. On exit, holds the user + information. If the buffer is too small to hold the information, then + EFI_BUFFER_TOO_SMALL is returned and InfoSize is updated to contain the number of bytes actually required. - @param[in,out] InfoSize On entry, points to the size of Info. On return, points to the size of the user - information. - + @param[in,out] InfoSize On entry, points to the size of Info. On return, points to the size of the user + information. + @retval EFI_SUCCESS Information returned successfully. - @retval EFI_BUFFER_TOO_SMALL The size specified by InfoSize is too small to hold all of the user + @retval EFI_BUFFER_TOO_SMALL The size specified by InfoSize is too small to hold all of the user information. The size required is returned in *InfoSize. @retval EFI_NOT_FOUND The specified UserInfo does not refer to a valid user info handle. - @retval EFI_INVALID_PARAMETER Info is NULL or InfoSize is NULL. + @retval EFI_INVALID_PARAMETER Info is NULL or InfoSize is NULL. **/ typedef EFI_STATUS @@ -246,15 +246,15 @@ EFI_STATUS /** Enumerate all of the user information records on the credential provider. - This function returns the next user information record. To retrieve the first user information record - handle, point UserInfo at a NULL. Each subsequent call will retrieve another user information - record handle until there are no more, at which point UserInfo will point to NULL. + This function returns the next user information record. To retrieve the first user information record + handle, point UserInfo at a NULL. Each subsequent call will retrieve another user information + record handle until there are no more, at which point UserInfo will point to NULL. @param[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL. - @param[in,out] UserInfo On entry, points to the previous user information handle or NULL to - start enumeration. On exit, points to the next user information handle + @param[in,out] UserInfo On entry, points to the previous user information handle or NULL to + start enumeration. On exit, points to the next user information handle or NULL if there is no more user information. - + @retval EFI_SUCCESS User information returned. @retval EFI_NOT_FOUND No more user information found. @retval EFI_INVALID_PARAMETER UserInfo is NULL. @@ -269,21 +269,21 @@ EFI_STATUS /** Delete a user on this credential provider. - This function deletes a user on this credential provider. + This function deletes a user on this credential provider. @param[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL. @param[in] User The user profile handle to delete. @retval EFI_SUCCESS User profile was successfully deleted. - @retval EFI_ACCESS_DENIED Current user profile does not permit deletion on the user profile handle. - Either the user profile cannot delete on any user profile or cannot delete - on a user profile other than the current user profile. + @retval EFI_ACCESS_DENIED Current user profile does not permit deletion on the user profile handle. + Either the user profile cannot delete on any user profile or cannot delete + on a user profile other than the current user profile. @retval EFI_UNSUPPORTED This credential provider does not support deletion in the pre-OS. @retval EFI_DEVICE_ERROR The new credential could not be deleted because of a device error. @retval EFI_INVALID_PARAMETER User does not refer to a valid user profile handle. **/ -typedef -EFI_STATUS +typedef +EFI_STATUS (EFIAPI *EFI_CREDENTIAL2_DELETE)( IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *This, IN EFI_USER_PROFILE_HANDLE User @@ -300,13 +300,13 @@ struct _EFI_USER_CREDENTIAL2_PROTOCOL { EFI_CREDENTIAL2_TILE Tile; EFI_CREDENTIAL2_TITLE Title; EFI_CREDENTIAL2_USER User; - EFI_CREDENTIAL2_SELECT Select; + EFI_CREDENTIAL2_SELECT Select; EFI_CREDENTIAL2_DESELECT Deselect; EFI_CREDENTIAL2_DEFAULT Default; EFI_CREDENTIAL2_GET_INFO GetInfo; EFI_CREDENTIAL2_GET_NEXT_INFO GetNextInfo; EFI_CREDENTIAL_CAPABILITIES Capabilities; - EFI_CREDENTIAL2_DELETE Delete; + EFI_CREDENTIAL2_DELETE Delete; }; extern EFI_GUID gEfiUserCredential2ProtocolGuid; diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UserManager.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UserManager.h index 73fa672a59..f703fe60dc 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UserManager.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/UserManager.h @@ -4,13 +4,13 @@ This protocol manages user profiles. Copyright (c) 2009 - 2011, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -53,7 +53,7 @@ typedef UINT16 EFI_USER_INFO_ATTRIBS; /// typedef struct { /// - /// The user credential identifier associated with this user information or else Nil if the + /// The user credential identifier associated with this user information or else Nil if the /// information is not associated with any specific credential. /// EFI_GUID Credential; @@ -95,7 +95,7 @@ typedef UINT64 EFI_CREDENTIAL_CAPABILITIES; #define EFI_CREDENTIAL_CAPABILITIES_ENROLL 0x0000000000000001 /// -/// Credential logon flags +/// Credential logon flags /// typedef UINT32 EFI_CREDENTIAL_LOGON_FLAGS; #define EFI_CREDENTIAL_LOGON_FLAG_AUTO 0x00000001 @@ -159,7 +159,7 @@ typedef CHAR16 *EFI_USER_INFO_CREDENTIAL_PROVIDER_NAME; /// #define EFI_USER_INFO_PKCS11_RECORD 0x0A /// -/// Provides standard biometric information in the format specified by the ISO 19785 (Common +/// Provides standard biometric information in the format specified by the ISO 19785 (Common /// Biometric Exchange Formats Framework) specification. /// #define EFI_USER_INFO_CBEFF_RECORD 0x0B @@ -170,7 +170,7 @@ typedef VOID *EFI_USER_INFO_CBEFF; #define EFI_USER_INFO_FAR_RECORD 0x0C typedef UINT8 EFI_USER_INFO_FAR; /// -/// Indicates how many attempts the user has to with a particular credential before the system prevents +/// Indicates how many attempts the user has to with a particular credential before the system prevents /// further attempts. /// #define EFI_USER_INFO_RETRY_RECORD 0x0D @@ -192,12 +192,12 @@ typedef EFI_USER_INFO_ACCESS_CONTROL EFI_USER_INFO_ACCESS_POLICY; /// /// -/// Forbids the user from booting or loading executables from the specified device path or any child +/// Forbids the user from booting or loading executables from the specified device path or any child /// device paths. /// #define EFI_USER_INFO_ACCESS_FORBID_LOAD 0x00000001 /// -/// Permits the user from booting or loading executables from the specified device path or any child +/// Permits the user from booting or loading executables from the specified device path or any child /// device paths. /// Note: in-consistency between code and the UEFI 2.3 specification here. /// The definition EFI_USER_INFO_ACCESS_PERMIT_BOOT in the specification should be typo and wait for @@ -258,7 +258,7 @@ typedef UINT32 EFI_USER_INFO_ACCESS_BOOT_ORDER_HDR; /// #define EFI_USER_INFO_ACCESS_BOOT_ORDER_REPLACE 0x00000002 /// -/// The Boot Manager will not attempt find a default boot device +/// The Boot Manager will not attempt find a default boot device /// when the default boot order is does not lead to a bootable device. /// #define EFI_USER_INFO_ACCESS_BOOT_ORDER_NODEFAULT 0x00000010 @@ -269,7 +269,7 @@ typedef UINT32 EFI_USER_INFO_ACCESS_BOOT_ORDER_HDR; #define EFI_USER_INFO_IDENTITY_POLICY_RECORD 0x0F typedef struct { - UINT32 Type; ///< Specifies either an operator or a data item. + UINT32 Type; ///< Specifies either an operator or a data item. UINT32 Length; ///< The length of this block, in bytes, including this header. } EFI_USER_INFO_IDENTITY_POLICY; @@ -303,13 +303,13 @@ typedef struct _EFI_USER_MANAGER_PROTOCOL EFI_USER_MANAGER_PROTOCOL; /** Create a new user profile. - This function creates a new user profile with only a new user identifier attached and returns its + This function creates a new user profile with only a new user identifier attached and returns its handle. The user profile is non-volatile, but the handle User can change across reboots. @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL. - @param[out] User On return, points to the new user profile handle. + @param[out] User On return, points to the new user profile handle. The user profile handle is unique only during this boot. - + @retval EFI_SUCCESS User profile was successfully created. @retval EFI_ACCESS_DENIED Current user does not have sufficient permissions to create a user profile. @retval EFI_UNSUPPORTED Creation of new user profiles is not supported. @@ -326,7 +326,7 @@ EFI_STATUS Delete an existing user profile. @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL. - @param[in] User User profile handle. + @param[in] User User profile handle. @retval EFI_SUCCESS User profile was successfully deleted. @retval EFI_ACCESS_DENIED Current user does not have sufficient permissions to delete a user @@ -344,16 +344,16 @@ EFI_STATUS /** Enumerate all of the enrolled users on the platform. - This function returns the next enrolled user profile. To retrieve the first user profile handle, point - User at a NULL. Each subsequent call will retrieve another user profile handle until there are no - more, at which point User will point to NULL. + This function returns the next enrolled user profile. To retrieve the first user profile handle, point + User at a NULL. Each subsequent call will retrieve another user profile handle until there are no + more, at which point User will point to NULL. @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL. - @param[in,out] User On entry, points to the previous user profile handle or NULL to + @param[in,out] User On entry, points to the previous user profile handle or NULL to start enumeration. On exit, points to the next user profile handle or NULL if there are no more user profiles. - @retval EFI_SUCCESS Next enrolled user profile successfully returned. + @retval EFI_SUCCESS Next enrolled user profile successfully returned. @retval EFI_ACCESS_DENIED Next enrolled user profile was not successfully returned. @retval EFI_INVALID_PARAMETER The User parameter is NULL. **/ @@ -370,7 +370,7 @@ EFI_STATUS @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL. @param[out] CurrentUser On return, points to the current user profile handle. - @retval EFI_SUCCESS Current user profile handle returned successfully. + @retval EFI_SUCCESS Current user profile handle returned successfully. @retval EFI_INVALID_PARAMETER The CurrentUser parameter is NULL. **/ typedef @@ -384,9 +384,9 @@ EFI_STATUS Identify a user. Identify the user and, if authenticated, returns the user handle and changes the current user profile. - All user information marked as private in a previously selected profile is no longer available for - inspection. - Whenever the current user profile is changed then the an event with the GUID + All user information marked as private in a previously selected profile is no longer available for + inspection. + Whenever the current user profile is changed then the an event with the GUID EFI_EVENT_GROUP_USER_PROFILE_CHANGED is signaled. @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL. @@ -406,26 +406,26 @@ EFI_STATUS /** Find a user using a user information record. - This function searches all user profiles for the specified user information record. The search starts - with the user information record handle following UserInfo and continues until either the + This function searches all user profiles for the specified user information record. The search starts + with the user information record handle following UserInfo and continues until either the information is found or there are no more user profiles. - A match occurs when the Info.InfoType field matches the user information record type and the + A match occurs when the Info.InfoType field matches the user information record type and the user information record data matches the portion of Info. @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL. - @param[in,out] User On entry, points to the previously returned user profile handle or NULL to start - searching with the first user profile. On return, points to the user profile handle or + @param[in,out] User On entry, points to the previously returned user profile handle or NULL to start + searching with the first user profile. On return, points to the user profile handle or NULL if not found. - @param[in,out] UserInfo On entry, points to the previously returned user information handle or NULL to start - searching with the first. On return, points to the user information handle of the user - information record or NULL if not found. Can be NULL, in which case only one user - information record per user can be returned. - @param[in] Info Points to the buffer containing the user information to be compared to the user - information record. If the user information record data is empty, then only the user - information record type is compared. + @param[in,out] UserInfo On entry, points to the previously returned user information handle or NULL to start + searching with the first. On return, points to the user information handle of the user + information record or NULL if not found. Can be NULL, in which case only one user + information record per user can be returned. + @param[in] Info Points to the buffer containing the user information to be compared to the user + information record. If the user information record data is empty, then only the user + information record type is compared. If InfoSize is 0, then the user information record must be empty. - @param[in] InfoSize The size of Info, in bytes. + @param[in] InfoSize The size of Info, in bytes. @retval EFI_SUCCESS User information was found. User points to the user profile handle and UserInfo points to the user information handle. @@ -445,15 +445,15 @@ EFI_STATUS /** Called by credential provider to notify of information change. - This function allows the credential provider to notify the User Identity Manager when user status + This function allows the credential provider to notify the User Identity Manager when user status has changed. - If the User Identity Manager doesn't support asynchronous changes in credentials, then this function - should return EFI_UNSUPPORTED. - If current user does not exist, and the credential provider can identify a user, then make the user + If the User Identity Manager doesn't support asynchronous changes in credentials, then this function + should return EFI_UNSUPPORTED. + If current user does not exist, and the credential provider can identify a user, then make the user to be current user and signal the EFI_EVENT_GROUP_USER_PROFILE_CHANGED event. - If current user already exists, and the credential provider can identify another user, then switch + If current user already exists, and the credential provider can identify another user, then switch current user to the newly identified user, and signal the EFI_EVENT_GROUP_USER_PROFILE_CHANGED event. - If current user was identified by this credential provider and now the credential provider cannot identify + If current user was identified by this credential provider and now the credential provider cannot identify current user, then logout current user and signal the EFI_EVENT_GROUP_USER_PROFILE_CHANGED event. @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL. @@ -474,30 +474,30 @@ EFI_STATUS /** Return information attached to the user. - This function returns user information. The format of the information is described in User - Information. The function may return EFI_ACCESS_DENIED if the information is marked private - and the handle specified by User is not the current user profile. The function may return - EFI_ACCESS_DENIED if the information is marked protected and the information is associated + This function returns user information. The format of the information is described in User + Information. The function may return EFI_ACCESS_DENIED if the information is marked private + and the handle specified by User is not the current user profile. The function may return + EFI_ACCESS_DENIED if the information is marked protected and the information is associated with a credential provider for which the user has not been authenticated. @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL. - @param[in] User Handle of the user whose profile will be retrieved. - @param[in] UserInfo Handle of the user information data record. - @param[out] Info On entry, points to a buffer of at least *InfoSize bytes. On exit, holds the user - information. If the buffer is too small to hold the information, then - EFI_BUFFER_TOO_SMALL is returned and InfoSize is updated to contain the - number of bytes actually required. - @param[in,out] InfoSize On entry, points to the size of Info. On return, points to the size of the user - information. + @param[in] User Handle of the user whose profile will be retrieved. + @param[in] UserInfo Handle of the user information data record. + @param[out] Info On entry, points to a buffer of at least *InfoSize bytes. On exit, holds the user + information. If the buffer is too small to hold the information, then + EFI_BUFFER_TOO_SMALL is returned and InfoSize is updated to contain the + number of bytes actually required. + @param[in,out] InfoSize On entry, points to the size of Info. On return, points to the size of the user + information. @retval EFI_SUCCESS Information returned successfully. @retval EFI_ACCESS_DENIED The information about the specified user cannot be accessed by the current user. - @retval EFI_BUFFER_TOO_SMALL The number of bytes specified by *InfoSize is too small to hold + @retval EFI_BUFFER_TOO_SMALL The number of bytes specified by *InfoSize is too small to hold the returned data. The actual size required is returned in *InfoSize. @retval EFI_NOT_FOUND User does not refer to a valid user profile or UserInfo does not refer to a valid user info handle. @retval EFI_INVALID_PARAMETER Info is NULL or InfoSize is NULL. -**/ +**/ typedef EFI_STATUS (EFIAPI *EFI_USER_PROFILE_GET_INFO)( @@ -511,33 +511,33 @@ EFI_STATUS /** Add or update user information. - This function changes user information. If NULL is pointed to by UserInfo, then a new user - information record is created and its handle is returned in UserInfo. Otherwise, the existing one is + This function changes user information. If NULL is pointed to by UserInfo, then a new user + information record is created and its handle is returned in UserInfo. Otherwise, the existing one is replaced. - If EFI_USER_INFO_IDENTITY_POLICY_RECORD is changed, it is the caller's responsibility to keep it to + If EFI_USER_INFO_IDENTITY_POLICY_RECORD is changed, it is the caller's responsibility to keep it to be synced with the information on credential providers. - If EFI_USER_INFO_EXCLUSIVE is specified in Info and a user information record of the same - type already exists in the user profile, then EFI_ACCESS_DENIED will be returned and + If EFI_USER_INFO_EXCLUSIVE is specified in Info and a user information record of the same + type already exists in the user profile, then EFI_ACCESS_DENIED will be returned and UserInfo will point to the handle of the existing record. @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL. - @param[in] User Handle of the user whose profile will be retrieved. - @param[in,out] UserInfo Handle of the user information data record. - @param[in] Info On entry, points to a buffer of at least *InfoSize bytes. On exit, holds the user - information. If the buffer is too small to hold the information, then - EFI_BUFFER_TOO_SMALL is returned and InfoSize is updated to contain the - number of bytes actually required. - @param[in] InfoSize On entry, points to the size of Info. On return, points to the size of the user - information. + @param[in] User Handle of the user whose profile will be retrieved. + @param[in,out] UserInfo Handle of the user information data record. + @param[in] Info On entry, points to a buffer of at least *InfoSize bytes. On exit, holds the user + information. If the buffer is too small to hold the information, then + EFI_BUFFER_TOO_SMALL is returned and InfoSize is updated to contain the + number of bytes actually required. + @param[in] InfoSize On entry, points to the size of Info. On return, points to the size of the user + information. @retval EFI_SUCCESS Information returned successfully. @retval EFI_ACCESS_DENIED The record is exclusive. - @retval EFI_SECURITY_VIOLATION The current user does not have permission to change the specified + @retval EFI_SECURITY_VIOLATION The current user does not have permission to change the specified user profile or user information record. @retval EFI_NOT_FOUND User does not refer to a valid user profile or UserInfo does not refer to a valid user info handle. - @retval EFI_INVALID_PARAMETER UserInfo is NULL or Info is NULL. -**/ + @retval EFI_INVALID_PARAMETER UserInfo is NULL or Info is NULL. +**/ typedef EFI_STATUS (EFIAPI *EFI_USER_PROFILE_SET_INFO)( @@ -559,8 +559,8 @@ EFI_STATUS @retval EFI_SUCCESS User information deleted successfully. @retval EFI_NOT_FOUND User information record UserInfo does not exist in the user profile. - @retval EFI_ACCESS_DENIED The current user does not have permission to delete this user information. -**/ + @retval EFI_ACCESS_DENIED The current user does not have permission to delete this user information. +**/ typedef EFI_STATUS (EFIAPI *EFI_USER_PROFILE_DELETE_INFO)( @@ -572,9 +572,9 @@ EFI_STATUS /** Enumerate user information of all the enrolled users on the platform. - This function returns the next user information record. To retrieve the first user information record - handle, point UserInfo at a NULL. Each subsequent call will retrieve another user information - record handle until there are no more, at which point UserInfo will point to NULL. + This function returns the next user information record. To retrieve the first user information record + handle, point UserInfo at a NULL. Each subsequent call will retrieve another user information + record handle until there are no more, at which point UserInfo will point to NULL. @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL. @param[in] User Handle of the user whose information will be deleted. @@ -583,7 +583,7 @@ EFI_STATUS @retval EFI_SUCCESS User information returned. @retval EFI_NOT_FOUND No more user information found. @retval EFI_INVALID_PARAMETER UserInfo is NULL. -**/ +**/ typedef EFI_STATUS (EFIAPI *EFI_USER_PROFILE_GET_NEXT_INFO)( diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Variable.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Variable.h index c9e86026f7..62af8c2cff 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Variable.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/Variable.h @@ -1,33 +1,33 @@ /** @file Variable Architectural Protocol as defined in PI Specification VOLUME 2 DXE - This provides the services required to get and set environment variables. This - protocol must be produced by a runtime DXE driver and may be consumed only by - the DXE Foundation. The DXE driver that produces this protocol must be a runtime - driver. This driver is responsible for initializing the GetVariable(), + This provides the services required to get and set environment variables. This + protocol must be produced by a runtime DXE driver and may be consumed only by + the DXE Foundation. The DXE driver that produces this protocol must be a runtime + driver. This driver is responsible for initializing the GetVariable(), GetNextVariableName(), and SetVariable() fields of the UEFI Runtime Services Table. - After the three fields of the UEFI Runtime Services Table have been initialized, - the driver must install the EFI_VARIABLE_ARCH_PROTOCOL_GUID on a new handle with - a NULL interface pointer. The installation of this protocol informs the DXE Foundation - that the read-only and the volatile environment variable related services are - now available and that the DXE Foundation must update the 32-bit CRC of the UEFI - Runtime Services Table. The full complement of environment variable services are - not available until both this protocol and EFI_VARIABLE_WRITE_ARCH_PROTOCOL are - installed. DXE drivers that require read-only access or read/write access to volatile - environment variables must have this architectural protocol in their dependency - expressions. DXE drivers that require write access to nonvolatile environment - variables must have the EFI_VARIABLE_WRITE_ARCH_PROTOCOL in their dependency + After the three fields of the UEFI Runtime Services Table have been initialized, + the driver must install the EFI_VARIABLE_ARCH_PROTOCOL_GUID on a new handle with + a NULL interface pointer. The installation of this protocol informs the DXE Foundation + that the read-only and the volatile environment variable related services are + now available and that the DXE Foundation must update the 32-bit CRC of the UEFI + Runtime Services Table. The full complement of environment variable services are + not available until both this protocol and EFI_VARIABLE_WRITE_ARCH_PROTOCOL are + installed. DXE drivers that require read-only access or read/write access to volatile + environment variables must have this architectural protocol in their dependency + expressions. DXE drivers that require write access to nonvolatile environment + variables must have the EFI_VARIABLE_WRITE_ARCH_PROTOCOL in their dependency expressions. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -42,4 +42,4 @@ extern EFI_GUID gEfiVariableArchProtocolGuid; -#endif +#endif diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/VariableWrite.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/VariableWrite.h index 96971d9e85..08ca413aac 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/VariableWrite.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/VariableWrite.h @@ -1,33 +1,33 @@ /** @file Variable Write Architectural Protocol as defined in PI Specification VOLUME 2 DXE - This provides the services required to set nonvolatile environment variables. - This protocol must be produced by a runtime DXE driver and may be consumed only + This provides the services required to set nonvolatile environment variables. + This protocol must be produced by a runtime DXE driver and may be consumed only by the DXE Foundation. - The DXE driver that produces this protocol must be a runtime driver. This driver + The DXE driver that produces this protocol must be a runtime driver. This driver may update the SetVariable() field of the UEFI Runtime Services Table. - - After the UEFI Runtime Services Table has been initialized, the driver must - install the EFI_VARIABLE_WRITE_ARCH_PROTOCOL_GUID on a new handle with a NULL - interface pointer. The installation of this protocol informs the DXE Foundation - that the write services for nonvolatile environment variables are now available - and that the DXE Foundation must update the 32-bit CRC of the UEFI Runtime Services - Table. The full complement of environment variable services are not available - until both this protocol and EFI_VARIABLE_ARCH_PROTOCOL are installed. DXE drivers + + After the UEFI Runtime Services Table has been initialized, the driver must + install the EFI_VARIABLE_WRITE_ARCH_PROTOCOL_GUID on a new handle with a NULL + interface pointer. The installation of this protocol informs the DXE Foundation + that the write services for nonvolatile environment variables are now available + and that the DXE Foundation must update the 32-bit CRC of the UEFI Runtime Services + Table. The full complement of environment variable services are not available + until both this protocol and EFI_VARIABLE_ARCH_PROTOCOL are installed. DXE drivers that require read-only access or read/write access to volatile environment variables must have the EFI_VARIABLE_WRITE_ARCH_PROTOCOL in their dependency expressions. - DXE drivers that require write access to nonvolatile environment variables must - have this architectural protocol in their dependency expressions. - + DXE drivers that require write access to nonvolatile environment variables must + have this architectural protocol in their dependency expressions. + Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -42,4 +42,4 @@ extern EFI_GUID gEfiVariableWriteArchProtocolGuid; -#endif +#endif diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/VlanConfig.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/VlanConfig.h index 5d980a6421..5aca1b3123 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/VlanConfig.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/VlanConfig.h @@ -10,7 +10,7 @@ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - @par Revision Reference: + @par Revision Reference: This Protocol is introduced in UEFI Specification 2.2 **/ @@ -37,28 +37,28 @@ typedef struct { /** - Create a VLAN device or modify the configuration parameter of an + Create a VLAN device or modify the configuration parameter of an already-configured VLAN. The Set() function is used to create a new VLAN device or change the VLAN - configuration parameters. If the VlanId hasn't been configured in the + configuration parameters. If the VlanId hasn't been configured in the physical Ethernet device, a new VLAN device will be created. If a VLAN with this VlanId is already configured, then related configuration will be updated - as the input parameters. - + as the input parameters. + If VlanId is zero, the VLAN device will send and receive untagged frames. Otherwise, the VLAN device will send and receive VLAN-tagged frames containing the VlanId. If VlanId is out of scope of (0-4094), EFI_INVALID_PARAMETER is returned. - If Priority is out of the scope of (0-7), then EFI_INVALID_PARAMETER is returned. - If there is not enough system memory to perform the registration, then + If Priority is out of the scope of (0-7), then EFI_INVALID_PARAMETER is returned. + If there is not enough system memory to perform the registration, then EFI_OUT_OF_RESOURCES is returned. @param[in] This Points to the EFI_VLAN_CONFIG_PROTOCOL. - @param[in] VlanId A unique identifier (1-4094) of the VLAN which is being created + @param[in] VlanId A unique identifier (1-4094) of the VLAN which is being created or modified, or zero (0). - @param[in] Priority 3 bit priority in VLAN header. Priority 0 is default value. If + @param[in] Priority 3 bit priority in VLAN header. Priority 0 is default value. If VlanId is zero (0), Priority is ignored. - + @retval EFI_SUCCESS The VLAN is successfully configured. @retval EFI_INVALID_PARAMETER One or more of following conditions is TRUE: - This is NULL. @@ -79,14 +79,14 @@ EFI_STATUS Find configuration information for specified VLAN or all configured VLANs. The Find() function is used to find the configuration information for matching - VLAN and allocate a buffer into which those entries are copied. + VLAN and allocate a buffer into which those entries are copied. @param[in] This Points to the EFI_VLAN_CONFIG_PROTOCOL. @param[in] VlanId Pointer to VLAN identifier. Set to NULL to find all configured VLANs. @param[out] NumberOfVlan The number of VLANs which is found by the specified criteria. @param[out] Entries The buffer which receive the VLAN configuration. - + @retval EFI_SUCCESS The VLAN is successfully found. @retval EFI_INVALID_PARAMETER One or more of following conditions is TRUE: - This is NULL. @@ -106,13 +106,13 @@ EFI_STATUS /** Remove the configured VLAN device. - The Remove() function is used to remove the specified VLAN device. + The Remove() function is used to remove the specified VLAN device. If the VlanId is out of the scope of (0-4094), EFI_INVALID_PARAMETER is returned. - If specified VLAN hasn't been previously configured, EFI_NOT_FOUND is returned. + If specified VLAN hasn't been previously configured, EFI_NOT_FOUND is returned. @param[in] This Points to the EFI_VLAN_CONFIG_PROTOCOL. @param[in] VlanId Identifier (0-4094) of the VLAN to be removed. - + @retval EFI_SUCCESS The VLAN is successfully removed. @retval EFI_INVALID_PARAMETER One or more of following conditions is TRUE: - This is NULL. @@ -129,7 +129,7 @@ EFI_STATUS /// /// EFI_VLAN_CONFIG_PROTOCOL -/// provide manageability interface for VLAN setting. The intended +/// provide manageability interface for VLAN setting. The intended /// VLAN tagging implementation is IEEE802.1Q. /// struct _EFI_VLAN_CONFIG_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/WatchdogTimer.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/WatchdogTimer.h index b48f943db2..3dd0c03cff 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/WatchdogTimer.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Protocol/WatchdogTimer.h @@ -4,13 +4,13 @@ Used to provide system watchdog timer services Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ #ifndef __ARCH_PROTOCOL_WATCHDOG_TIMER_H__ @@ -28,7 +28,7 @@ typedef struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL EFI_WATCHDOG_TIMER_ARCH_PROTOCOL; /** - A function of this type is called when the watchdog timer fires if a + A function of this type is called when the watchdog timer fires if a handler has been registered. @param Time The time in 100 ns units that has passed since the watchdog @@ -45,15 +45,15 @@ VOID ); /** - This function registers a handler that is to be invoked when the watchdog - timer fires. By default, the EFI_WATCHDOG_TIMER protocol will call the - Runtime Service ResetSystem() when the watchdog timer fires. If a - NotifyFunction is registered, then the NotifyFunction will be called before - the Runtime Service ResetSystem() is called. If NotifyFunction is NULL, then - the watchdog handler is unregistered. If a watchdog handler is registered, - then EFI_SUCCESS is returned. If an attempt is made to register a handler - when a handler is already registered, then EFI_ALREADY_STARTED is returned. - If an attempt is made to uninstall a handler when a handler is not installed, + This function registers a handler that is to be invoked when the watchdog + timer fires. By default, the EFI_WATCHDOG_TIMER protocol will call the + Runtime Service ResetSystem() when the watchdog timer fires. If a + NotifyFunction is registered, then the NotifyFunction will be called before + the Runtime Service ResetSystem() is called. If NotifyFunction is NULL, then + the watchdog handler is unregistered. If a watchdog handler is registered, + then EFI_SUCCESS is returned. If an attempt is made to register a handler + when a handler is already registered, then EFI_ALREADY_STARTED is returned. + If an attempt is made to uninstall a handler when a handler is not installed, then return EFI_INVALID_PARAMETER. @param This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance. @@ -68,7 +68,7 @@ VOID previously registered. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_WATCHDOG_TIMER_REGISTER_HANDLER)( IN EFI_WATCHDOG_TIMER_ARCH_PROTOCOL *This, @@ -76,8 +76,8 @@ EFI_STATUS ); /** - This function sets the amount of time to wait before firing the watchdog - timer to TimerPeriod 100 nS units. If TimerPeriod is 0, then the watchdog + This function sets the amount of time to wait before firing the watchdog + timer to TimerPeriod 100 nS units. If TimerPeriod is 0, then the watchdog timer is disabled. @param This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance. @@ -91,7 +91,7 @@ EFI_STATUS error. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_WATCHDOG_TIMER_SET_TIMER_PERIOD)( IN EFI_WATCHDOG_TIMER_ARCH_PROTOCOL *This, @@ -99,8 +99,8 @@ EFI_STATUS ); /** - This function retrieves the amount of time the system will wait before firing - the watchdog timer. This period is returned in TimerPeriod, and EFI_SUCCESS + This function retrieves the amount of time the system will wait before firing + the watchdog timer. This period is returned in TimerPeriod, and EFI_SUCCESS is returned. If TimerPeriod is NULL, then EFI_INVALID_PARAMETER is returned. @param This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance. @@ -113,7 +113,7 @@ EFI_STATUS @retval EFI_INVALID_PARAMETER TimerPeriod is NULL. **/ -typedef +typedef EFI_STATUS (EFIAPI *EFI_WATCHDOG_TIMER_GET_TIMER_PERIOD)( IN EFI_WATCHDOG_TIMER_ARCH_PROTOCOL *This, @@ -122,14 +122,14 @@ EFI_STATUS /// -/// This protocol provides the services required to implement the Boot Service -/// SetWatchdogTimer(). It provides a service to set the amount of time to wait -/// before firing the watchdog timer, and it also provides a service to register -/// a handler that is invoked when the watchdog timer fires. This protocol can -/// implement the watchdog timer by using the event and timer Boot Services, or -/// it can make use of custom hardware. When the watchdog timer fires, control -/// will be passed to a handler if one has been registered. If no handler has -/// been registered, or the registered handler returns, then the system will be +/// This protocol provides the services required to implement the Boot Service +/// SetWatchdogTimer(). It provides a service to set the amount of time to wait +/// before firing the watchdog timer, and it also provides a service to register +/// a handler that is invoked when the watchdog timer fires. This protocol can +/// implement the watchdog timer by using the event and timer Boot Services, or +/// it can make use of custom hardware. When the watchdog timer fires, control +/// will be passed to a handler if one has been registered. If no handler has +/// been registered, or the registered handler returns, then the system will be /// reset by calling the Runtime Service ResetSystem(). /// struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL { diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi.h index 4b21013177..2abbb767a0 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi.h @@ -2,17 +2,17 @@ Root include file for Mde Package UEFI, UEFI_APPLICATION type modules. - This is the include file for any module of type UEFI and UEFI_APPLICATION. Uefi modules only use - types defined via this include file and can be ported easily to any - environment. + This is the include file for any module of type UEFI and UEFI_APPLICATION. Uefi modules only use + types defined via this include file and can be ported easily to any + environment. 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +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. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiAcpiDataTable.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiAcpiDataTable.h index 109fb57b0f..389a72ce93 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiAcpiDataTable.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiAcpiDataTable.h @@ -2,12 +2,12 @@ UEFI ACPI Data Table Definition. Copyright (c) 2011 - 2017, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +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. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiBaseType.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiBaseType.h index 10dc6c4489..37221746ae 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiBaseType.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiBaseType.h @@ -4,12 +4,12 @@ Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR> Portions copyright (c) 2011 - 2016, ARM Ltd. All rights reserved.<BR> -This program and the accompanying materials are licensed and made available under -the terms and conditions of the BSD License that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +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. **/ @@ -114,44 +114,44 @@ typedef union { /// /// Enumeration of EFI_STATUS. -///@{ -#define EFI_SUCCESS RETURN_SUCCESS -#define EFI_LOAD_ERROR RETURN_LOAD_ERROR -#define EFI_INVALID_PARAMETER RETURN_INVALID_PARAMETER -#define EFI_UNSUPPORTED RETURN_UNSUPPORTED -#define EFI_BAD_BUFFER_SIZE RETURN_BAD_BUFFER_SIZE -#define EFI_BUFFER_TOO_SMALL RETURN_BUFFER_TOO_SMALL -#define EFI_NOT_READY RETURN_NOT_READY -#define EFI_DEVICE_ERROR RETURN_DEVICE_ERROR -#define EFI_WRITE_PROTECTED RETURN_WRITE_PROTECTED -#define EFI_OUT_OF_RESOURCES RETURN_OUT_OF_RESOURCES -#define EFI_VOLUME_CORRUPTED RETURN_VOLUME_CORRUPTED -#define EFI_VOLUME_FULL RETURN_VOLUME_FULL -#define EFI_NO_MEDIA RETURN_NO_MEDIA -#define EFI_MEDIA_CHANGED RETURN_MEDIA_CHANGED -#define EFI_NOT_FOUND RETURN_NOT_FOUND -#define EFI_ACCESS_DENIED RETURN_ACCESS_DENIED -#define EFI_NO_RESPONSE RETURN_NO_RESPONSE -#define EFI_NO_MAPPING RETURN_NO_MAPPING -#define EFI_TIMEOUT RETURN_TIMEOUT -#define EFI_NOT_STARTED RETURN_NOT_STARTED -#define EFI_ALREADY_STARTED RETURN_ALREADY_STARTED -#define EFI_ABORTED RETURN_ABORTED -#define EFI_ICMP_ERROR RETURN_ICMP_ERROR -#define EFI_TFTP_ERROR RETURN_TFTP_ERROR -#define EFI_PROTOCOL_ERROR RETURN_PROTOCOL_ERROR -#define EFI_INCOMPATIBLE_VERSION RETURN_INCOMPATIBLE_VERSION -#define EFI_SECURITY_VIOLATION RETURN_SECURITY_VIOLATION -#define EFI_CRC_ERROR RETURN_CRC_ERROR +///@{ +#define EFI_SUCCESS RETURN_SUCCESS +#define EFI_LOAD_ERROR RETURN_LOAD_ERROR +#define EFI_INVALID_PARAMETER RETURN_INVALID_PARAMETER +#define EFI_UNSUPPORTED RETURN_UNSUPPORTED +#define EFI_BAD_BUFFER_SIZE RETURN_BAD_BUFFER_SIZE +#define EFI_BUFFER_TOO_SMALL RETURN_BUFFER_TOO_SMALL +#define EFI_NOT_READY RETURN_NOT_READY +#define EFI_DEVICE_ERROR RETURN_DEVICE_ERROR +#define EFI_WRITE_PROTECTED RETURN_WRITE_PROTECTED +#define EFI_OUT_OF_RESOURCES RETURN_OUT_OF_RESOURCES +#define EFI_VOLUME_CORRUPTED RETURN_VOLUME_CORRUPTED +#define EFI_VOLUME_FULL RETURN_VOLUME_FULL +#define EFI_NO_MEDIA RETURN_NO_MEDIA +#define EFI_MEDIA_CHANGED RETURN_MEDIA_CHANGED +#define EFI_NOT_FOUND RETURN_NOT_FOUND +#define EFI_ACCESS_DENIED RETURN_ACCESS_DENIED +#define EFI_NO_RESPONSE RETURN_NO_RESPONSE +#define EFI_NO_MAPPING RETURN_NO_MAPPING +#define EFI_TIMEOUT RETURN_TIMEOUT +#define EFI_NOT_STARTED RETURN_NOT_STARTED +#define EFI_ALREADY_STARTED RETURN_ALREADY_STARTED +#define EFI_ABORTED RETURN_ABORTED +#define EFI_ICMP_ERROR RETURN_ICMP_ERROR +#define EFI_TFTP_ERROR RETURN_TFTP_ERROR +#define EFI_PROTOCOL_ERROR RETURN_PROTOCOL_ERROR +#define EFI_INCOMPATIBLE_VERSION RETURN_INCOMPATIBLE_VERSION +#define EFI_SECURITY_VIOLATION RETURN_SECURITY_VIOLATION +#define EFI_CRC_ERROR RETURN_CRC_ERROR #define EFI_END_OF_MEDIA RETURN_END_OF_MEDIA #define EFI_END_OF_FILE RETURN_END_OF_FILE #define EFI_INVALID_LANGUAGE RETURN_INVALID_LANGUAGE #define EFI_COMPROMISED_DATA RETURN_COMPROMISED_DATA #define EFI_HTTP_ERROR RETURN_HTTP_ERROR -#define EFI_WARN_UNKNOWN_GLYPH RETURN_WARN_UNKNOWN_GLYPH -#define EFI_WARN_DELETE_FAILURE RETURN_WARN_DELETE_FAILURE -#define EFI_WARN_WRITE_FAILURE RETURN_WARN_WRITE_FAILURE +#define EFI_WARN_UNKNOWN_GLYPH RETURN_WARN_UNKNOWN_GLYPH +#define EFI_WARN_DELETE_FAILURE RETURN_WARN_DELETE_FAILURE +#define EFI_WARN_WRITE_FAILURE RETURN_WARN_WRITE_FAILURE #define EFI_WARN_BUFFER_TOO_SMALL RETURN_WARN_BUFFER_TOO_SMALL #define EFI_WARN_STALE_DATA RETURN_WARN_STALE_DATA #define EFI_WARN_FILE_SYSTEM RETURN_WARN_FILE_SYSTEM @@ -159,7 +159,7 @@ typedef union { /// /// Define macro to encode the status code. -/// +/// #define EFIERR(_a) ENCODE_ERROR(_a) #define EFI_ERROR(A) RETURN_ERROR(A) @@ -168,7 +168,7 @@ typedef union { /// ICMP error definitions ///@{ #define EFI_NETWORK_UNREACHABLE EFIERR(100) -#define EFI_HOST_UNREACHABLE EFIERR(101) +#define EFI_HOST_UNREACHABLE EFIERR(101) #define EFI_PROTOCOL_UNREACHABLE EFIERR(102) #define EFI_PORT_UNREACHABLE EFIERR(103) ///@} @@ -193,8 +193,8 @@ typedef union { /** Macro that converts a size, in bytes, to a number of EFI_PAGESs. - @param Size A size in bytes. This parameter is assumed to be type UINTN. - Passing in a parameter that is larger than UINTN may produce + @param Size A size in bytes. This parameter is assumed to be type UINTN. + Passing in a parameter that is larger than UINTN may produce unexpected results. @return The number of EFI_PAGESs associated with the number of bytes specified @@ -206,13 +206,13 @@ typedef union { /** Macro that converts a number of EFI_PAGEs to a size in bytes. - @param Pages The number of EFI_PAGES. This parameter is assumed to be - type UINTN. Passing in a parameter that is larger than + @param Pages The number of EFI_PAGES. This parameter is assumed to be + type UINTN. Passing in a parameter that is larger than UINTN may produce unexpected results. - @return The number of bytes associated with the number of EFI_PAGEs specified + @return The number of bytes associated with the number of EFI_PAGEs specified by Pages. - + **/ #define EFI_PAGES_TO_SIZE(Pages) ((Pages) << EFI_PAGE_SHIFT) @@ -252,21 +252,21 @@ typedef union { #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \ (((Machine) == EFI_IMAGE_MACHINE_IA32) || ((Machine) == EFI_IMAGE_MACHINE_EBC)) -#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_X64) +#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_X64) #elif defined (MDE_CPU_IPF) #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \ (((Machine) == EFI_IMAGE_MACHINE_IA64) || ((Machine) == EFI_IMAGE_MACHINE_EBC)) -#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE) +#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE) #elif defined (MDE_CPU_X64) #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \ (((Machine) == EFI_IMAGE_MACHINE_X64) || ((Machine) == EFI_IMAGE_MACHINE_EBC)) -#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_IA32) +#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_IA32) #elif defined (MDE_CPU_ARM) @@ -285,11 +285,11 @@ typedef union { /// /// This is just to make sure you can cross compile with the EBC compiler. -/// It does not make sense to have a PE loader coded in EBC. +/// It does not make sense to have a PE loader coded in EBC. /// #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_EBC) -#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE) +#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE) #else #error Unknown Processor Type diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiGpt.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiGpt.h index aa3c9bec0b..5aa2ee2fb8 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiGpt.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiGpt.h @@ -2,12 +2,12 @@ EFI Guid Partition Table Format Definition. Copyright (c) 2006 - 2011, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +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. **/ @@ -22,7 +22,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define PRIMARY_PART_HEADER_LBA 1 /// /// EFI Partition Table Signature: "EFI PART". -/// +/// #define EFI_PTAB_HEADER_ID SIGNATURE_64 ('E','F','I',' ','P','A','R','T') #pragma pack(1) @@ -119,7 +119,7 @@ typedef struct { /// this partition. By not producing an EFI_BLOCK_IO_PROTOCOL partition, file system /// mappings will not be created for this partition in UEFI. /// Bit 2: This bit is set aside to let systems with traditional PC-AT BIOS firmware implementations - /// inform certain limited, special-purpose software running on these systems that a GPT + /// inform certain limited, special-purpose software running on these systems that a GPT /// partition may be bootable. The UEFI boot manager must ignore this bit when selecting /// a UEFI-compliant application, e.g., an OS loader. /// Bits 3-47: Undefined and must be zero. Reserved for expansion by future versions of the UEFI diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiInternalFormRepresentation.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiInternalFormRepresentation.h index 389c12c1f0..4da31dd274 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiInternalFormRepresentation.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiInternalFormRepresentation.h @@ -5,13 +5,13 @@ Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR> (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR> -This program and the accompanying materials are licensed and made available under -the terms and conditions of the BSD License that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -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. +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. @par Revision Reference: These definitions are from UEFI 2.1 and 2.2. @@ -67,7 +67,7 @@ typedef struct { // // Value of HII package type -// +// #define EFI_HII_PACKAGE_TYPE_ALL 0x00 #define EFI_HII_PACKAGE_TYPE_GUID 0x01 #define EFI_HII_PACKAGE_FORMS 0x02 @@ -100,7 +100,7 @@ typedef struct { /// typedef struct { /// - /// The Unicode representation of the glyph. The term weight is the + /// The Unicode representation of the glyph. The term weight is the /// technical term for a character code. /// CHAR16 UnicodeWeight; @@ -109,7 +109,7 @@ typedef struct { /// UINT8 Attributes; /// - /// The column major glyph representation of the character. Bits + /// The column major glyph representation of the character. Bits /// with values of one indicate that the corresponding pixel is to be /// on when normally displayed; those with zero are off. /// @@ -117,12 +117,12 @@ typedef struct { } EFI_NARROW_GLYPH; /// -/// The EFI_WIDE_GLYPH has a preferred dimension (w x h) of 16 x 19 pixels, which is large enough +/// The EFI_WIDE_GLYPH has a preferred dimension (w x h) of 16 x 19 pixels, which is large enough /// to accommodate logographic characters. /// typedef struct { /// - /// The Unicode representation of the glyph. The term weight is the + /// The Unicode representation of the glyph. The term weight is the /// technical term for a character code. /// CHAR16 UnicodeWeight; @@ -131,20 +131,20 @@ typedef struct { /// UINT8 Attributes; /// - /// The column major glyph representation of the character. Bits - /// with values of one indicate that the corresponding pixel is to be + /// The column major glyph representation of the character. Bits + /// with values of one indicate that the corresponding pixel is to be /// on when normally displayed; those with zero are off. /// UINT8 GlyphCol1[EFI_GLYPH_HEIGHT]; /// - /// The column major glyph representation of the character. Bits - /// with values of one indicate that the corresponding pixel is to be + /// The column major glyph representation of the character. Bits + /// with values of one indicate that the corresponding pixel is to be /// on when normally displayed; those with zero are off. /// UINT8 GlyphCol2[EFI_GLYPH_HEIGHT]; /// - /// Ensures that sizeof (EFI_WIDE_GLYPH) is twice the - /// sizeof (EFI_NARROW_GLYPH). The contents of Pad must + /// Ensures that sizeof (EFI_WIDE_GLYPH) is twice the + /// sizeof (EFI_NARROW_GLYPH). The contents of Pad must /// be zero. /// UINT8 Pad[3]; @@ -268,7 +268,7 @@ typedef struct _EFI_HII_GIBT_GLYPH_BLOCK { typedef struct _EFI_HII_GIBT_GLYPHS_BLOCK { EFI_HII_GLYPH_BLOCK Header; EFI_HII_GLYPH_INFO Cell; - UINT16 Count; + UINT16 Count; UINT8 BitmapData[1]; } EFI_HII_GIBT_GLYPHS_BLOCK; @@ -845,7 +845,7 @@ typedef struct _EFI_IFR_DEFAULTSTORE { } EFI_IFR_DEFAULTSTORE; // -// Default Identifier of default store +// Default Identifier of default store // #define EFI_HII_DEFAULT_CLASS_STANDARD 0x0000 #define EFI_HII_DEFAULT_CLASS_MANUFACTURING 0x0001 @@ -1498,12 +1498,12 @@ typedef struct _EFI_IFR_SECURITY { typedef struct _EFI_IFR_FORM_MAP_METHOD { /// - /// The string identifier which provides the human-readable name of + /// The string identifier which provides the human-readable name of /// the configuration method for this standards map form. /// EFI_STRING_ID MethodTitle; /// - /// Identifier which uniquely specifies the configuration methods + /// Identifier which uniquely specifies the configuration methods /// associated with this standards map form. /// EFI_GUID MethodIdentifier; @@ -1511,8 +1511,8 @@ typedef struct _EFI_IFR_FORM_MAP_METHOD { typedef struct _EFI_IFR_FORM_MAP { /// - /// The sequence that defines the type of opcode as well as the length - /// of the opcode being defined. Header.OpCode = EFI_IFR_FORM_MAP_OP. + /// The sequence that defines the type of opcode as well as the length + /// of the opcode being defined. Header.OpCode = EFI_IFR_FORM_MAP_OP. /// EFI_IFR_OP_HEADER Header; /// @@ -1527,13 +1527,13 @@ typedef struct _EFI_IFR_FORM_MAP { typedef struct _EFI_IFR_SET { /// - /// The sequence that defines the type of opcode as well as the length - /// of the opcode being defined. Header.OpCode = EFI_IFR_SET_OP. + /// The sequence that defines the type of opcode as well as the length + /// of the opcode being defined. Header.OpCode = EFI_IFR_SET_OP. /// EFI_IFR_OP_HEADER Header; /// - /// Specifies the identifier of a previously declared variable store to - /// use when storing the question's value. + /// Specifies the identifier of a previously declared variable store to + /// use when storing the question's value. /// EFI_VARSTORE_ID VarStoreId; union { @@ -1547,20 +1547,20 @@ typedef struct _EFI_IFR_SET { UINT16 VarOffset; } VarStoreInfo; /// - /// Specifies the type used for storage. + /// Specifies the type used for storage. /// UINT8 VarStoreType; } EFI_IFR_SET; typedef struct _EFI_IFR_GET { /// - /// The sequence that defines the type of opcode as well as the length - /// of the opcode being defined. Header.OpCode = EFI_IFR_GET_OP. + /// The sequence that defines the type of opcode as well as the length + /// of the opcode being defined. Header.OpCode = EFI_IFR_GET_OP. /// EFI_IFR_OP_HEADER Header; /// - /// Specifies the identifier of a previously declared variable store to - /// use when retrieving the value. + /// Specifies the identifier of a previously declared variable store to + /// use when retrieving the value. /// EFI_VARSTORE_ID VarStoreId; union { @@ -1574,7 +1574,7 @@ typedef struct _EFI_IFR_GET { UINT16 VarOffset; } VarStoreInfo; /// - /// Specifies the type used for storage. + /// Specifies the type used for storage. /// UINT8 VarStoreType; } EFI_IFR_GET; @@ -1598,9 +1598,9 @@ typedef struct _EFI_IFR_MAP { /// /// Each enumeration values maps a physical key on a keyboard. /// -typedef enum { +typedef enum { EfiKeyLCtrl, - EfiKeyA0, + EfiKeyA0, EfiKeyLAlt, EfiKeySpaceBar, EfiKeyA2, @@ -1728,8 +1728,8 @@ typedef struct { /// CHAR16 ShiftedAltGrUnicode; /// - /// Modifier keys are defined to allow for special functionality that is not necessarily - /// accomplished by a printable character. Many of these modifier keys are flags to toggle + /// Modifier keys are defined to allow for special functionality that is not necessarily + /// accomplished by a printable character. Many of these modifier keys are flags to toggle /// certain state bits on and off inside of a keyboard driver. /// UINT16 Modifier; @@ -1737,7 +1737,7 @@ typedef struct { } EFI_KEY_DESCRIPTOR; /// -/// A key which is affected by all the standard shift modifiers. +/// A key which is affected by all the standard shift modifiers. /// Most keys would be expected to have this bit active. /// #define EFI_AFFECTED_BY_STANDARD_SHIFT 0x0001 @@ -1830,7 +1830,7 @@ typedef struct { /// typedef struct _EFI_IFR_ANIMATION { /// - /// Standard opcode header, where Header.OpCode is + /// Standard opcode header, where Header.OpCode is /// EFI_IFR_ANIMATION_OP. /// EFI_IFR_OP_HEADER Header; @@ -1849,7 +1849,7 @@ typedef struct _EFI_HII_ANIMATION_PACKAGE_HDR { /// EFI_HII_PACKAGE_HEADER Header; /// - /// Offset, relative to this header, of the animation information. If + /// Offset, relative to this header, of the animation information. If /// this is zero, then there are no animation sequences in the package. /// UINT32 AnimationInfoOffset; @@ -1933,23 +1933,23 @@ typedef struct _EFI_HII_AIBT_EXT4_BLOCK { typedef struct _EFI_HII_ANIMATION_CELL { /// - /// The X offset from the upper left hand corner of the logical + /// The X offset from the upper left hand corner of the logical /// window to position the indexed image. /// UINT16 OffsetX; /// - /// The Y offset from the upper left hand corner of the logical + /// The Y offset from the upper left hand corner of the logical /// window to position the indexed image. /// UINT16 OffsetY; /// - /// The image to display at the specified offset from the upper left + /// The image to display at the specified offset from the upper left /// hand corner of the logical window. /// EFI_IMAGE_ID ImageId; /// - /// The number of milliseconds to delay after displaying the indexed - /// image and before continuing on to the next linked image. If value + /// The number of milliseconds to delay after displaying the indexed + /// image and before continuing on to the next linked image. If value /// is zero, no delay. /// UINT16 Delay; @@ -1961,11 +1961,11 @@ typedef struct _EFI_HII_ANIMATION_CELL { /// typedef struct _EFI_HII_AIBT_OVERLAY_IMAGES_BLOCK { /// - /// This is image that is to be reference by the image protocols, if the - /// animation function is not supported or disabled. This image can - /// be one particular image from the animation sequence (if any one - /// of the animation frames has a complete image) or an alternate - /// image that can be displayed alone. If the value is zero, no image + /// This is image that is to be reference by the image protocols, if the + /// animation function is not supported or disabled. This image can + /// be one particular image from the animation sequence (if any one + /// of the animation frames has a complete image) or an alternate + /// image that can be displayed alone. If the value is zero, no image /// is displayed. /// EFI_IMAGE_ID DftImageId; @@ -1978,7 +1978,7 @@ typedef struct _EFI_HII_AIBT_OVERLAY_IMAGES_BLOCK { /// UINT16 Height; /// - /// The number of EFI_HII_ANIMATION_CELL contained in the + /// The number of EFI_HII_ANIMATION_CELL contained in the /// animation sequence. /// UINT16 CellCount; @@ -1990,16 +1990,16 @@ typedef struct _EFI_HII_AIBT_OVERLAY_IMAGES_BLOCK { /// /// An animation block to describe an animation sequence that does not cycle, -/// and where the logical window is cleared to the specified color before +/// and where the logical window is cleared to the specified color before /// the next image is displayed. /// typedef struct _EFI_HII_AIBT_CLEAR_IMAGES_BLOCK { /// - /// This is image that is to be reference by the image protocols, if the - /// animation function is not supported or disabled. This image can - /// be one particular image from the animation sequence (if any one - /// of the animation frames has a complete image) or an alternate - /// image that can be displayed alone. If the value is zero, no image + /// This is image that is to be reference by the image protocols, if the + /// animation function is not supported or disabled. This image can + /// be one particular image from the animation sequence (if any one + /// of the animation frames has a complete image) or an alternate + /// image that can be displayed alone. If the value is zero, no image /// is displayed. /// EFI_IMAGE_ID DftImageId; @@ -2012,12 +2012,12 @@ typedef struct _EFI_HII_AIBT_CLEAR_IMAGES_BLOCK { /// UINT16 Height; /// - /// The number of EFI_HII_ANIMATION_CELL contained in the + /// The number of EFI_HII_ANIMATION_CELL contained in the /// animation sequence. /// UINT16 CellCount; /// - /// The color to clear the logical window to before displaying the + /// The color to clear the logical window to before displaying the /// indexed image. /// EFI_HII_RGB_PIXEL BackgndColor; @@ -2029,16 +2029,16 @@ typedef struct _EFI_HII_AIBT_CLEAR_IMAGES_BLOCK { /// /// An animation block to describe an animation sequence that does not cycle, -/// and where the screen is restored to the original state before the next +/// and where the screen is restored to the original state before the next /// image is displayed. /// typedef struct _EFI_HII_AIBT_RESTORE_SCRN_BLOCK { /// - /// This is image that is to be reference by the image protocols, if the - /// animation function is not supported or disabled. This image can - /// be one particular image from the animation sequence (if any one - /// of the animation frames has a complete image) or an alternate - /// image that can be displayed alone. If the value is zero, no image + /// This is image that is to be reference by the image protocols, if the + /// animation function is not supported or disabled. This image can + /// be one particular image from the animation sequence (if any one + /// of the animation frames has a complete image) or an alternate + /// image that can be displayed alone. If the value is zero, no image /// is displayed. /// EFI_IMAGE_ID DftImageId; @@ -2051,7 +2051,7 @@ typedef struct _EFI_HII_AIBT_RESTORE_SCRN_BLOCK { /// UINT16 Height; /// - /// The number of EFI_HII_ANIMATION_CELL contained in the + /// The number of EFI_HII_ANIMATION_CELL contained in the /// animation sequence. /// UINT16 CellCount; @@ -2069,14 +2069,14 @@ typedef EFI_HII_AIBT_OVERLAY_IMAGES_BLOCK EFI_HII_AIBT_OVERLAY_IMAGES_LOOP_BLOC /// /// An animation block to describe an animation sequence that continuously cycles, -/// and where the logical window is cleared to the specified color before +/// and where the logical window is cleared to the specified color before /// the next image is displayed. /// typedef EFI_HII_AIBT_CLEAR_IMAGES_BLOCK EFI_HII_AIBT_CLEAR_IMAGES_LOOP_BLOCK; /// /// An animation block to describe an animation sequence that continuously cycles, -/// and where the screen is restored to the original state before +/// and where the screen is restored to the original state before /// the next image is displayed. /// typedef EFI_HII_AIBT_RESTORE_SCRN_BLOCK EFI_HII_AIBT_RESTORE_SCRN_LOOP_BLOCK; @@ -2086,7 +2086,7 @@ typedef EFI_HII_AIBT_RESTORE_SCRN_BLOCK EFI_HII_AIBT_RESTORE_SCRN_LOOP_BLOCK; /// typedef struct _EFI_HII_AIBT_DUPLICATE_BLOCK { /// - /// The previously defined animation ID with the exact same + /// The previously defined animation ID with the exact same /// animation information. /// EFI_ANIMATION_ID AnimationId; @@ -2121,7 +2121,7 @@ typedef struct _EFI_HII_AIBT_SKIP2_BLOCK { /// token usages. /// /// -/// STRING_TOKEN is not defined in UEFI specification. But it is placed +/// STRING_TOKEN is not defined in UEFI specification. But it is placed /// here for the easy access by C files and VFR source files. /// #define STRING_TOKEN(t) t diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiMultiPhase.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiMultiPhase.h index 73daf8bc24..0a0f52704c 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiMultiPhase.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiMultiPhase.h @@ -83,7 +83,7 @@ typedef enum { /// EfiPalCode, /// - /// A memory region that operates as EfiConventionalMemory, + /// A memory region that operates as EfiConventionalMemory, /// however it happens to also support byte-addressable non-volatility. /// EfiPersistentMemory, diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiPxe.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiPxe.h index aad1d3577d..ca82a97bdb 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiPxe.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiPxe.h @@ -4,12 +4,12 @@ are needed for porting PXE to EFI. Copyright (c) 2006 - 2016, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +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. @par Revision Reference: diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiSpec.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiSpec.h index b82bcd98c3..540fd56b99 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiSpec.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Uefi/UefiSpec.h @@ -6,12 +6,12 @@ by this include file. Copyright (c) 2006 - 2017, 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 that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +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. **/ @@ -35,7 +35,7 @@ typedef enum { /// AllocateAnyPages, /// - /// Allocate any available range of pages whose uppermost address is less than + /// Allocate any available range of pages whose uppermost address is less than /// or equal to a specified maximum address. /// AllocateMaxAddress, @@ -79,7 +79,7 @@ typedef enum { #define EFI_MEMORY_XP 0x0000000000004000ULL #define EFI_MEMORY_RO 0x0000000000020000ULL // -// Physical memory persistence attribute. +// Physical memory persistence attribute. // The memory region supports byte-addressable non-volatility. // #define EFI_MEMORY_NV 0x0000000000008000ULL @@ -129,7 +129,7 @@ typedef struct { UINT64 NumberOfPages; /// /// Attributes of the memory region that describe the bit mask of capabilities - /// for that memory region, and not necessarily the current settings for that + /// for that memory region, and not necessarily the current settings for that /// memory region. /// UINT64 Attribute; @@ -313,8 +313,8 @@ EFI_STATUS @retval EFI_NOT_FOUND 1) There are no EFI_DRIVER_BINDING_PROTOCOL instances present in the system. 2) No drivers were connected to ControllerHandle. - @retval EFI_SECURITY_VIOLATION - The user has no permission to start UEFI device drivers on the device path + @retval EFI_SECURITY_VIOLATION + The user has no permission to start UEFI device drivers on the device path associated with the ControllerHandle or specified by the RemainingDevicePath. **/ typedef @@ -702,13 +702,13 @@ EFI_STATUS @param[in] VendorGuid A unique identifier for the vendor. @param[in] Attributes Attributes bitmask to set for the variable. @param[in] DataSize The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE or - EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero - causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is - set, then a SetVariable() call with a DataSize of zero will not cause any change to - the variable value (the timestamp associated with the variable may be updated however - even if no new data value is provided,see the description of the - EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not - be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated). + EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero + causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is + set, then a SetVariable() call with a DataSize of zero will not cause any change to + the variable value (the timestamp associated with the variable may be updated however + even if no new data value is provided,see the description of the + EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not + be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated). @param[in] Data The contents for the variable. @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as @@ -722,7 +722,7 @@ EFI_STATUS @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted. @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS being set, but the AuthInfo does NOT pass the validation check carried out by the firmware. - + @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found. **/ @@ -870,10 +870,10 @@ EFI_STATUS @retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not understood. @retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error. - @retval EFI_ACCESS_DENIED Image was not loaded because the platform policy prohibits the + @retval EFI_ACCESS_DENIED Image was not loaded because the platform policy prohibits the image from being loaded. NULL is returned in *ImageHandle. - @retval EFI_SECURITY_VIOLATION Image was loaded and an ImageHandle was created with a - valid EFI_LOADED_IMAGE_PROTOCOL. However, the current + @retval EFI_SECURITY_VIOLATION Image was loaded and an ImageHandle was created with a + valid EFI_LOADED_IMAGE_PROTOCOL. However, the current platform policy specifies that the image should not be started. **/ typedef @@ -912,15 +912,15 @@ EFI_STATUS /** Terminates a loaded EFI image and returns control to boot services. - @param[in] ImageHandle Handle that identifies the image. This parameter is passed to the + @param[in] ImageHandle Handle that identifies the image. This parameter is passed to the image on entry. @param[in] ExitStatus The image's exit code. @param[in] ExitDataSize The size, in bytes, of ExitData. Ignored if ExitStatus is EFI_SUCCESS. @param[in] ExitData The pointer to a data buffer that includes a Null-terminated string, - optionally followed by additional binary data. The string is a - description that the caller may use to further indicate the reason - for the image's exit. ExitData is only valid if ExitStatus - is something other than EFI_SUCCESS. The ExitData buffer + optionally followed by additional binary data. The string is a + description that the caller may use to further indicate the reason + for the image's exit. ExitData is only valid if ExitStatus + is something other than EFI_SUCCESS. The ExitData buffer must be allocated by calling AllocatePool(). @retval EFI_SUCCESS The image specified by ImageHandle was unloaded. @@ -1454,7 +1454,7 @@ typedef enum { /// ByRegisterNotify, /// - /// Retrieve the set of handles from the handle database that support a + /// Retrieve the set of handles from the handle database that support a /// specified protocol. /// ByProtocol @@ -1683,10 +1683,10 @@ typedef struct { @retval EFI_INVALID_PARAMETER CapsuleCount is 0. @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error. @retval EFI_UNSUPPORTED The capsule type is not supported on this platform. - @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has been previously called this error indicates the capsule - is compatible with this platform but is not capable of being submitted or processed + @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has been previously called this error indicates the capsule + is compatible with this platform but is not capable of being submitted or processed in runtime. The caller may resubmit the capsule prior to ExitBootServices(). - @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has not been previously called then this error indicates + @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has not been previously called then this error indicates the capsule is compatible with this platform but there are insufficient resources to process. **/ @@ -1714,10 +1714,10 @@ EFI_STATUS @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and MaximumCapsuleSize and ResetType are undefined. @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL. - @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has been previously called this error indicates the capsule - is compatible with this platform but is not capable of being submitted or processed + @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has been previously called this error indicates the capsule + is compatible with this platform but is not capable of being submitted or processed in runtime. The caller may resubmit the capsule prior to ExitBootServices(). - @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has not been previously called then this error indicates + @retval EFI_OUT_OF_RESOURCES When ExitBootServices() has not been previously called then this error indicates the capsule is compatible with this platform but there are insufficient resources to process. **/ diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/X64/ProcessorBind.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/X64/ProcessorBind.h index 7a449b055f..b19223b0e3 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/X64/ProcessorBind.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/X64/ProcessorBind.h @@ -2,13 +2,13 @@ Processor or Compiler specific defines and types x64 (Intel 64, AMD64). Copyright (c) 2006 - 2017, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -114,17 +114,17 @@ // // -// This warning is for potentially uninitialized local variable, and it may cause false +// This warning is for potentially uninitialized local variable, and it may cause false // positive issues in VS2013 and VS2015 build // #pragma warning ( disable : 4701 ) - + // -// This warning is for potentially uninitialized local pointer variable, and it may cause +// This warning is for potentially uninitialized local pointer variable, and it may cause // false positive issues in VS2013 and VS2015 build // #pragma warning ( disable : 4703 ) - + #endif #endif @@ -289,24 +289,24 @@ typedef INT64 INTN; #elif defined(_MSC_EXTENSIONS) /// /// Microsoft* compiler specific method for EFIAPI calling convention. - /// - #define EFIAPI __cdecl + /// + #define EFIAPI __cdecl #elif defined(__GNUC__) /// /// Define the standard calling convention regardless of optimization level. /// The GCC support assumes a GCC compiler that supports the EFI ABI. The EFI - /// ABI is much closer to the x64 Microsoft* ABI than standard x64 (x86-64) - /// GCC ABI. Thus a standard x64 (x86-64) GCC compiler can not be used for - /// x64. Warning the assembly code in the MDE x64 does not follow the correct + /// ABI is much closer to the x64 Microsoft* ABI than standard x64 (x86-64) + /// GCC ABI. Thus a standard x64 (x86-64) GCC compiler can not be used for + /// x64. Warning the assembly code in the MDE x64 does not follow the correct /// ABI for the standard x64 (x86-64) GCC. /// - #define EFIAPI + #define EFIAPI #else /// /// The default for a non Microsoft* or GCC compiler is to assume the EFI ABI - /// is the standard. + /// is the standard. /// - #define EFIAPI + #define EFIAPI #endif #if defined(__GNUC__) @@ -319,13 +319,13 @@ typedef INT64 INTN; /** Return the pointer to the first instruction of a function given a function pointer. - On x64 CPU architectures, these two pointer values are the same, + On x64 CPU architectures, these two pointer values are the same, so the implementation of this macro is very simple. - + @param FunctionPointer A pointer to a function. @return The pointer to the first instruction of a function given a function pointer. - + **/ #define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer) diff --git a/src/vendorcode/intel/edk2/uefi_2.4/MdePkg/Include/Guid/FirmwareFileSystem2.h b/src/vendorcode/intel/edk2/uefi_2.4/MdePkg/Include/Guid/FirmwareFileSystem2.h index 9e12fd6084..1aaa3b1092 100644 --- a/src/vendorcode/intel/edk2/uefi_2.4/MdePkg/Include/Guid/FirmwareFileSystem2.h +++ b/src/vendorcode/intel/edk2/uefi_2.4/MdePkg/Include/Guid/FirmwareFileSystem2.h @@ -2,13 +2,13 @@ Guid used to define the Firmware File System 2. Copyright (c) 2006 - 2008, 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 + 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 - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUIDs introduced in PI Version 1.0. @@ -18,18 +18,18 @@ #ifndef __FIRMWARE_FILE_SYSTEM2_GUID_H__ #define __FIRMWARE_FILE_SYSTEM2_GUID_H__ -/// -/// The firmware volume header contains a data field for +/// +/// The firmware volume header contains a data field for /// the file system GUID -/// +/// #define EFI_FIRMWARE_FILE_SYSTEM2_GUID \ { 0x8c8ce578, 0x8a3d, 0x4f1c, { 0x99, 0x35, 0x89, 0x61, 0x85, 0xc3, 0x2d, 0xd3 } } /// -/// A Volume Top File (VTF) is a file that must be -/// located such that the last byte of the file is +/// A Volume Top File (VTF) is a file that must be +/// located such that the last byte of the file is /// also the last byte of the firmware volume -/// +/// #define EFI_FFS_VOLUME_TOP_FILE_GUID \ { 0x1BA0062E, 0xC779, 0x4582, { 0x85, 0x66, 0x33, 0x6A, 0xE8, 0xF7, 0x8F, 0x9 } } diff --git a/src/vendorcode/intel/edk2/uefi_2.4/MdePkg/Include/IndustryStandard/PeImage.h b/src/vendorcode/intel/edk2/uefi_2.4/MdePkg/Include/IndustryStandard/PeImage.h index 3af3edbd8e..254e5d2ec2 100644 --- a/src/vendorcode/intel/edk2/uefi_2.4/MdePkg/Include/IndustryStandard/PeImage.h +++ b/src/vendorcode/intel/edk2/uefi_2.4/MdePkg/Include/IndustryStandard/PeImage.h @@ -1,21 +1,21 @@ /** @file - EFI image format for PE32, PE32+ and TE. Please note some data structures are - different for PE32 and PE32+. EFI_IMAGE_NT_HEADERS32 is for PE32 and - EFI_IMAGE_NT_HEADERS64 is for PE32+. + EFI image format for PE32, PE32+ and TE. Please note some data structures are + different for PE32 and PE32+. EFI_IMAGE_NT_HEADERS32 is for PE32 and + EFI_IMAGE_NT_HEADERS64 is for PE32+. - This file is coded to the Visual Studio, Microsoft Portable Executable and + This file is coded to the Visual Studio, Microsoft Portable Executable and Common Object File Format Specification, Revision 8.3 - February 6, 2013. This file also includes some definitions in PI Specification, Revision 1.0. Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR> Portions copyright (c) 2008 - 2009, Apple Inc. 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. +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. -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -134,12 +134,12 @@ typedef struct { /// /// @attention -/// EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC means PE32 and +/// EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC means PE32 and /// EFI_IMAGE_OPTIONAL_HEADER32 must be used. The data structures only vary /// after NT additional fields. /// #define EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC 0x10b - + /// /// Optional Header Standard Fields for PE32. /// @@ -185,7 +185,7 @@ typedef struct { /// /// @attention -/// EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC means PE32+ and +/// EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC means PE32+ and /// EFI_IMAGE_OPTIONAL_HEADER64 must be used. The data structures only vary /// after NT additional fields. /// @@ -296,7 +296,7 @@ typedef struct { /// Size of EFI_IMAGE_SECTION_HEADER. /// #define EFI_IMAGE_SIZEOF_SECTION_HEADER 40 - + // // Section Flags Values // @@ -304,12 +304,12 @@ typedef struct { #define EFI_IMAGE_SCN_CNT_CODE BIT5 ///< 0x00000020 #define EFI_IMAGE_SCN_CNT_INITIALIZED_DATA BIT6 ///< 0x00000040 #define EFI_IMAGE_SCN_CNT_UNINITIALIZED_DATA BIT7 ///< 0x00000080 - + #define EFI_IMAGE_SCN_LNK_OTHER BIT8 ///< 0x00000100 ///< Reserved. #define EFI_IMAGE_SCN_LNK_INFO BIT9 ///< 0x00000200 ///< Section contains comments or some other type of information. #define EFI_IMAGE_SCN_LNK_REMOVE BIT11 ///< 0x00000800 ///< Section contents will not become part of image. #define EFI_IMAGE_SCN_LNK_COMDAT BIT12 ///< 0x00001000 - + #define EFI_IMAGE_SCN_ALIGN_1BYTES BIT20 ///< 0x00100000 #define EFI_IMAGE_SCN_ALIGN_2BYTES BIT21 ///< 0x00200000 #define EFI_IMAGE_SCN_ALIGN_4BYTES (BIT20|BIT21) ///< 0x00300000 @@ -317,7 +317,7 @@ typedef struct { #define EFI_IMAGE_SCN_ALIGN_16BYTES (BIT20|BIT22) ///< 0x00500000 #define EFI_IMAGE_SCN_ALIGN_32BYTES (BIT21|BIT22) ///< 0x00600000 #define EFI_IMAGE_SCN_ALIGN_64BYTES (BIT20|BIT21|BIT22) ///< 0x00700000 - + #define EFI_IMAGE_SCN_MEM_DISCARDABLE BIT25 ///< 0x02000000 #define EFI_IMAGE_SCN_MEM_NOT_CACHED BIT26 ///< 0x04000000 #define EFI_IMAGE_SCN_MEM_NOT_PAGED BIT27 ///< 0x08000000 @@ -415,7 +415,7 @@ typedef struct { #define EFI_IMAGE_COMDAT_SELECT_SAME_SIZE 3 #define EFI_IMAGE_COMDAT_SELECT_EXACT_MATCH 4 #define EFI_IMAGE_COMDAT_SELECT_ASSOCIATIVE 5 - + // // the following values only be referred in PeCoff, not defined in PECOFF. // @@ -450,9 +450,9 @@ typedef struct { #define EFI_IMAGE_REL_I386_SECREL 0x000B #define EFI_IMAGE_REL_I386_REL32 0x0014 ///< PC-relative 32-bit reference to the symbols virtual address. -// +// // x64 processor relocation types. -// +// #define IMAGE_REL_AMD64_ABSOLUTE 0x0000 #define IMAGE_REL_AMD64_ADDR64 0x0001 #define IMAGE_REL_AMD64_ADDR32 0x0002 diff --git a/src/vendorcode/intel/fsp/fsp1_1/IntelFspPkg/Include/FspApi.h b/src/vendorcode/intel/fsp/fsp1_1/IntelFspPkg/Include/FspApi.h index 6a621d688c..44777f5745 100644 --- a/src/vendorcode/intel/fsp/fsp1_1/IntelFspPkg/Include/FspApi.h +++ b/src/vendorcode/intel/fsp/fsp1_1/IntelFspPkg/Include/FspApi.h @@ -218,7 +218,7 @@ EFI_STATUS and defined for each FSP binary. This will be documented in Integration guide with each FSP release. After FspMemInit completes its execution, it passes the pointer to the HobList and - returns to the boot loader from where it was called. Bootloader is responsible to + returns to the boot loader from where it was called. Bootloader is responsible to migrate it's stack and data to Memory. FspMemoryInit, TempRamExit and FspSiliconInit APIs provide an alternate method to complete the silicon initialization and provides bootloader an opportunity to get diff --git a/src/vendorcode/intel/fsp/fsp1_1/skylake/FspUpdVpd.h b/src/vendorcode/intel/fsp/fsp1_1/skylake/FspUpdVpd.h index 32b926a6d4..fddc168701 100644 --- a/src/vendorcode/intel/fsp/fsp1_1/skylake/FspUpdVpd.h +++ b/src/vendorcode/intel/fsp/fsp1_1/skylake/FspUpdVpd.h @@ -693,7 +693,7 @@ typedef struct { UINT8 LanLtrEnable; /** Offset 0x033D - SATA eSATASpeedLimit - When enabled, BIOS will configure the PxSCTL.SPD to 2 to limit the eSATA port speed. 0: disable, 1: enable. + When enabled, BIOS will configure the PxSCTL.SPD to 2 to limit the eSATA port speed. 0: disable, 1: enable. $EN_DIS **/ UINT8 eSATASpeedLimit; @@ -1030,7 +1030,7 @@ typedef struct { } UPD_DATA_REGION; #define FSP_IMAGE_ID 0x245053464C4B5324 /* '$SKLFSP$' */ -#define FSP_IMAGE_REV 0x01090000 +#define FSP_IMAGE_REV 0x01090000 /** VPD data structure **/ @@ -1054,7 +1054,7 @@ typedef struct { UINT8 UnusedVpdSpace0[32]; /** Offset 0x0030 - PcdSerialIoUartDebugEnable - Enable SerialIo Uart debug library with/without initializing SerialIo Uart device in FSP. + Enable SerialIo Uart debug library with/without initializing SerialIo Uart device in FSP. 0:Disable, 1:Enable and Initialize, 2:Enable without Initializing **/ UINT8 PcdSerialIoUartDebugEnable; diff --git a/src/vendorcode/intel/fsp/fsp2_0/cannonlake/FspmUpd.h b/src/vendorcode/intel/fsp/fsp2_0/cannonlake/FspmUpd.h index 1bac0b8240..a625f00dbc 100644 --- a/src/vendorcode/intel/fsp/fsp2_0/cannonlake/FspmUpd.h +++ b/src/vendorcode/intel/fsp/fsp2_0/cannonlake/FspmUpd.h @@ -998,7 +998,7 @@ typedef struct { /** Offset 0x020D - Processor Early Power On Configuration FCLK setting <b>0: 800 MHz (ULT/ULX)</b>. <b>1: 1 GHz (DT/Halo)</b>. Not supported on ULT/ULX.- 2: 400 MHz. - 3: Reserved - 0:800 MHz, 1: 1 GHz, 2: 400 MHz, 3: Reserved + 0:800 MHz, 1: 1 GHz, 2: 400 MHz, 3: Reserved **/ UINT8 FClkFrequency; @@ -2133,18 +2133,18 @@ typedef struct { /** Offset 0x04F7 - TcritMax Maximum Critical Temperature in Centigrade of the On-DIMM Thermal Sensor. TCRITMax has to be greater than THIGHMax .\n - Critical temperature will be TcritMax + Critical temperature will be TcritMax **/ UINT8 TsodTcritMax; -/** Offset 0x04F8 - Event mode +/** Offset 0x04F8 - Event mode Disable:Comparator mode.\n Enable:Interrupt mode $EN_DIS **/ UINT8 TsodEventMode; -/** Offset 0x04F9 - EVENT polarity +/** Offset 0x04F9 - EVENT polarity Disable:Active LOW.\n Enable:Active HIGH $EN_DIS @@ -2609,7 +2609,7 @@ typedef struct { /** Offset 0x059B - ChipsetInit HECI message Enable/Disable. 0: Disable, 1: enable, Enable or disable ChipsetInit HECI message. - If disabled, it prevents from sending ChipsetInit HECI message. + If disabled, it prevents from sending ChipsetInit HECI message. $EN_DIS **/ UINT8 ChipsetInitMessage; diff --git a/src/vendorcode/intel/fsp/fsp2_0/cannonlake/FspsUpd.h b/src/vendorcode/intel/fsp/fsp2_0/cannonlake/FspsUpd.h index d03a844037..3ead9b194a 100644 --- a/src/vendorcode/intel/fsp/fsp2_0/cannonlake/FspsUpd.h +++ b/src/vendorcode/intel/fsp/fsp2_0/cannonlake/FspsUpd.h @@ -500,8 +500,8 @@ typedef struct { **/ UINT8 PchCnviMfUart1Type; -/** Offset 0x014C - Espi Lgmr Memory Range decode - This option enables or disables espi lgmr +/** Offset 0x014C - Espi Lgmr Memory Range decode + This option enables or disables espi lgmr $EN_DIS **/ UINT8 PchEspiLgmrEnable; @@ -836,7 +836,7 @@ typedef struct { /** Offset 0x025F - PCIE RP Disable Gen2PLL Shutdown and L1 Clock Gating Enable PCIE RP Disable Gen2PLL Shutdown and L1 Clock Gating Enable Workaround needed for - Alpine ridge + Alpine ridge **/ UINT8 PcieRootPortGen2PllL1CgDisable[24]; @@ -1611,7 +1611,7 @@ typedef struct { Select 'Auto', it will be auto-configured according to probe type. Select 'Enabled' will disable SLP_S0# assertion whereas 'Disabled' will enable SLP_S0# assertion when debug is enabled. \n - Note: This BIOS option should keep 'Auto', other options are intended for advanced + Note: This BIOS option should keep 'Auto', other options are intended for advanced configuration only. 0:Disabled, 1:Enabled, 2:Auto **/ @@ -1622,7 +1622,7 @@ typedef struct { keep PMC default settings. Or select the desired debug probe type for S0ix Override settings.\n Reminder: DCI OOB (aka BSSB) uses CCA probe.\n - Note: This BIOS option should keep 'Auto', other options are intended for advanced + Note: This BIOS option should keep 'Auto', other options are intended for advanced configuration only. 0:No Change, 1:DCI OOB, 2:USB2 DbC, 3:Auto **/ @@ -2218,7 +2218,7 @@ typedef struct { /** Offset 0x0785 - SendEcCmd SendEcCmd function pointer. \n - @code typedef EFI_STATUS (EFIAPI *PLATFORM_SEND_EC_COMMAND) (IN EC_COMMAND_TYPE + @code typedef EFI_STATUS (EFIAPI *PLATFORM_SEND_EC_COMMAND) (IN EC_COMMAND_TYPE EcCmdType, IN UINT8 EcCmd, IN UINT8 SendData, IN OUT UINT8 *ReceiveData); @endcode **/ UINT64 SendEcCmd; @@ -2310,7 +2310,7 @@ typedef struct { **/ UINT32 Signature; -/** Offset 0x07B1 - Enable/Disable Device 7 +/** Offset 0x07B1 - Enable/Disable Device 7 Enable: Device 7 enabled, Disable (Default): Device 7 disabled $EN_DIS **/ diff --git a/src/vendorcode/intel/fsp/fsp2_0/cannonlake/FsptUpd.h b/src/vendorcode/intel/fsp/fsp2_0/cannonlake/FsptUpd.h index eeba7ae50b..90fae70158 100644 --- a/src/vendorcode/intel/fsp/fsp2_0/cannonlake/FsptUpd.h +++ b/src/vendorcode/intel/fsp/fsp2_0/cannonlake/FsptUpd.h @@ -68,7 +68,7 @@ typedef struct { typedef struct { /** Offset 0x0040 - PcdSerialIoUartDebugEnable - Enable SerialIo Uart debug library with/without initializing SerialIo Uart device in FSP. + Enable SerialIo Uart debug library with/without initializing SerialIo Uart device in FSP. 0:Disable, 1:Enable and Initialize, 2:Enable without Initializing **/ UINT8 PcdSerialIoUartDebugEnable; @@ -96,12 +96,12 @@ typedef struct { UINT32 PcdSerialIoUartInputClock; /** Offset 0x0048 - Pci Express Base Address - Base address to be programmed for Pci Express + Base address to be programmed for Pci Express **/ UINT64 PcdPciExpressBaseAddress; /** Offset 0x0050 - Pci Express Region Length - Region Length to be programmed for Pci Express + Region Length to be programmed for Pci Express **/ UINT32 PcdPciExpressRegionLength; |