From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mx0a-0031df01.pphosted.com (mx0a-0031df01.pphosted.com [205.220.168.131]) by mx.groups.io with SMTP id smtpd.web10.21658.1676918779715281702 for ; Mon, 20 Feb 2023 10:46:19 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@quicinc.com header.s=qcppdkim1 header.b=HX8i2JWY; spf=permerror, err=parse error for token &{10 18 %{ir}.%{v}.%{d}.spf.has.pphosted.com}: invalid domain name (domain: quicinc.com, ip: 205.220.168.131, mailfrom: quic_rcran@quicinc.com) Received: from pps.filterd (m0279863.ppops.net [127.0.0.1]) by mx0a-0031df01.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 31KHxQZ8032754; Mon, 20 Feb 2023 18:46:12 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=quicinc.com; h=from : to : cc : subject : date : message-id : mime-version : content-transfer-encoding : content-type; s=qcppdkim1; bh=W1ULbdQLMg2uRC2dHr9BS/zfJxatWuTJ2wTLjZoJQ+8=; b=HX8i2JWYgpmpfZT8YZqlZzVXTwDTnNd1mZcG+0RTw+it9rPVnwBaquHEPK/yLSq9+im7 icr8JTEWPRoh495C8DtmhALgUDULymjC7EKSggOGWPdw4TA+4jKNs3zojZnWSRw1wg2F aM0Kp5qF+xxeKWtr4Ds+QxnAm9+nv/2xXV4S5BpiiL0QC8Q4Joiiiz98lTFO5qXbGIJH yOFY0Y1oOs0HJfHk/PpnWd3HpHbPSNXC/UzsXEAMHUr6JnNJ0T7HjprXkUKxEYeGfQ2p y9WHGNIt0V6AdCDklk5KYX1jt9uJ/JMRlkd3w3skkW8yx1KbzR8ULdqUGS4ZzyoNg7hG KQ== Received: from nalasppmta05.qualcomm.com (Global_NAT1.qualcomm.com [129.46.96.20]) by mx0a-0031df01.pphosted.com (PPS) with ESMTPS id 3ntpw9nmcf-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Mon, 20 Feb 2023 18:46:11 +0000 Received: from nalasex01a.na.qualcomm.com (nalasex01a.na.qualcomm.com [10.47.209.196]) by NALASPPMTA05.qualcomm.com (8.17.1.5/8.17.1.5) with ESMTPS id 31KIkBCK032202 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Mon, 20 Feb 2023 18:46:11 GMT Received: from linbox.qualcomm.com (10.80.80.8) by nalasex01a.na.qualcomm.com (10.47.209.196) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.41; Mon, 20 Feb 2023 10:46:10 -0800 From: "Rebecca Cran" To: , Michael D Kinney , Liming Gao , Zhiguang Liu CC: Rebecca Cran Subject: [PATCH 1/1] MdePkg: Remove whitespace in doxygen param passing direction [in,out] Date: Mon, 20 Feb 2023 11:45:56 -0700 Message-ID: <20230220184556.1024570-1-rebecca@quicinc.com> X-Mailer: git-send-email 2.30.2 MIME-Version: 1.0 X-Originating-IP: [10.80.80.8] X-ClientProxiedBy: nasanex01a.na.qualcomm.com (10.52.223.231) To nalasex01a.na.qualcomm.com (10.47.209.196) X-QCInternal: smtphost X-Proofpoint-Virus-Version: vendor=nai engine=6200 definitions=5800 signatures=585085 X-Proofpoint-ORIG-GUID: 3pusjLZI9_xSEJZKGIxMkiRDwAMF_mvo X-Proofpoint-GUID: 3pusjLZI9_xSEJZKGIxMkiRDwAMF_mvo X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.219,Aquarius:18.0.930,Hydra:6.0.562,FMLib:17.11.170.22 definitions=2023-02-20_15,2023-02-20_02,2023-02-09_01 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 mlxlogscore=999 clxscore=1015 spamscore=0 adultscore=0 impostorscore=0 phishscore=0 mlxscore=0 suspectscore=0 malwarescore=0 priorityscore=1501 bulkscore=0 lowpriorityscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2212070000 definitions=main-2302200172 Content-Transfer-Encoding: 8bit Content-Type: text/plain There isn't supposed to be whitespace for "@param [in,out]" between "in" and "out". clang generates the following warning: test.c:8:9: warning: whitespace is not allowed in parameter passing direction [-Wdocumentation-pedantic] @param [in, out] argv Array of arguments. ^~~~~~~~~ [in,out] Update the documentation blocks in MdePkg. Signed-off-by: Rebecca Cran --- MdePkg/Include/Library/BaseLib.h | 4 +- MdePkg/Include/Library/FileHandleLib.h | 12 +- MdePkg/Include/Library/PcdLib.h | 14 +-- MdePkg/Include/Library/SmmPeriodicSmiLib.h | 2 +- MdePkg/Include/Library/UefiScsiLib.h | 124 ++++++++++---------- MdePkg/Include/Ppi/CpuIo.h | 2 +- MdePkg/Include/Ppi/Graphics.h | 2 +- MdePkg/Include/Ppi/Pcd.h | 10 +- MdePkg/Include/Ppi/PiPcd.h | 2 +- MdePkg/Include/Protocol/AcpiSystemDescriptionTable.h | 2 +- MdePkg/Include/Protocol/BlockIo2.h | 4 +- MdePkg/Include/Protocol/BlockIoCrypto.h | 6 +- MdePkg/Include/Protocol/BluetoothHc.h | 4 +- MdePkg/Include/Protocol/BluetoothIo.h | 4 +- MdePkg/Include/Protocol/BluetoothLeConfig.h | 10 +- MdePkg/Include/Protocol/CcMeasurement.h | 2 +- MdePkg/Include/Protocol/CpuIo2.h | 2 +- MdePkg/Include/Protocol/Eap.h | 2 +- MdePkg/Include/Protocol/EapConfiguration.h | 4 +- MdePkg/Include/Protocol/EapManagement.h | 2 +- MdePkg/Include/Protocol/EapManagement2.h | 8 +- MdePkg/Include/Protocol/EraseBlock.h | 2 +- MdePkg/Include/Protocol/FirmwareManagement.h | 6 +- MdePkg/Include/Protocol/I2cEnumerate.h | 2 +- MdePkg/Include/Protocol/IpSec.h | 16 +-- MdePkg/Include/Protocol/IpSecConfig.h | 6 +- MdePkg/Include/Protocol/Kms.h | 72 ++++++------ MdePkg/Include/Protocol/MmCommunication2.h | 6 +- MdePkg/Include/Protocol/MmSwDispatch.h | 2 +- MdePkg/Include/Protocol/Mtftp6.h | 2 +- MdePkg/Include/Protocol/Pcd.h | 8 +- MdePkg/Include/Protocol/PiPcd.h | 2 +- MdePkg/Include/Protocol/S3SaveState.h | 4 +- MdePkg/Include/Protocol/Shell.h | 8 +- MdePkg/Include/Protocol/SmartCardEdge.h | 12 +- MdePkg/Include/Protocol/SmartCardReader.h | 10 +- MdePkg/Include/Protocol/Smbios.h | 4 +- MdePkg/Include/Protocol/SmmSwDispatch2.h | 2 +- MdePkg/Include/Protocol/SuperIo.h | 2 +- MdePkg/Include/Protocol/Supplicant.h | 6 +- MdePkg/Include/Protocol/Tcg2Protocol.h | 2 +- MdePkg/Include/Protocol/Tls.h | 8 +- MdePkg/Include/Protocol/TlsConfig.h | 4 +- MdePkg/Include/Protocol/UfsDeviceConfig.h | 10 +- MdePkg/Include/Protocol/UsbFunctionIo.h | 12 +- MdePkg/Include/Protocol/UserCredential.h | 4 +- MdePkg/Include/Protocol/UserCredential2.h | 4 +- MdePkg/Include/Uefi/UefiSpec.h | 22 ++-- MdePkg/Library/BaseExtractGuidedSectionLib/BaseExtractGuidedSectionLib.c | 2 +- MdePkg/Library/BaseLib/QuickSort.c | 2 +- MdePkg/Library/BasePcdLibNull/PcdLib.c | 12 +- MdePkg/Library/BasePeCoffLib/LoongArch/PeCoffLoaderEx.c | 8 +- MdePkg/Library/DxePcdLib/DxePcdLib.c | 12 +- MdePkg/Library/PeiExtractGuidedSectionLib/PeiExtractGuidedSectionLib.c | 2 +- MdePkg/Library/PeiPcdLib/PeiPcdLib.c | 12 +- MdePkg/Library/SmmIoLib/SmmIoLib.c | 4 +- MdePkg/Library/SmmPeriodicSmiLib/SmmPeriodicSmiLib.c | 8 +- MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.c | 12 +- MdePkg/Library/UefiScsiLib/UefiScsiLib.c | 124 ++++++++++---------- 59 files changed, 329 insertions(+), 329 deletions(-) diff --git a/MdePkg/Include/Library/BaseLib.h b/MdePkg/Include/Library/BaseLib.h index 8f2df76c29a3..0dee0f58aa75 100644 --- a/MdePkg/Include/Library/BaseLib.h +++ b/MdePkg/Include/Library/BaseLib.h @@ -2482,7 +2482,7 @@ BcdToDecimal8 ( /** Removes the last directory or file entry in a path. - @param[in, out] Path The pointer to the path to modify. + @param[in,out] Path The pointer to the path to modify. @retval FALSE Nothing was found to remove. @retval TRUE A directory or file was removed. @@ -2930,7 +2930,7 @@ INTN if Count is < 2 then perform no action. - @param[in, out] BufferToSort on call a Buffer of (possibly sorted) elements + @param[in,out] BufferToSort on call a Buffer of (possibly sorted) elements on return a buffer of sorted elements @param[in] Count the number of elements in the buffer to sort @param[in] ElementSize Size of an element in bytes diff --git a/MdePkg/Include/Library/FileHandleLib.h b/MdePkg/Include/Library/FileHandleLib.h index 1a238edee38c..2ea97c317c27 100644 --- a/MdePkg/Include/Library/FileHandleLib.h +++ b/MdePkg/Include/Library/FileHandleLib.h @@ -78,7 +78,7 @@ FileHandleSetInfo ( EFI_FILE_INFO is the structure returned as the directory entry. @param[in] FileHandle The opened file handle. - @param[in, out] BufferSize On input, the size of buffer in bytes. On return, + @param[in,out] BufferSize On input, the size of buffer in bytes. On return, the number of bytes written. @param[out] Buffer The buffer to put read data into. @@ -109,7 +109,7 @@ FileHandleRead ( opened directories are not supported. @param[in] FileHandle The opened file for writing. - @param[in, out] BufferSize On input, the number of bytes in Buffer. On output, + @param[in,out] BufferSize On input, the number of bytes in Buffer. On output, the number of bytes written. @param[in] Buffer The buffer containing data to write is stored. @@ -381,15 +381,15 @@ FileHandleGetFileName ( read a CHAR_NULL character will be returned in buffer. @param[in] Handle FileHandle to read from. - @param[in, out] Buffer The pointer to buffer to read into. - @param[in, out] Size The pointer to number of bytes in Buffer. + @param[in,out] Buffer The pointer to buffer to read into. + @param[in,out] Size The pointer to number of bytes in Buffer. @param[in] Truncate If the buffer is large enough, this has no effect. If the buffer is is too small and Truncate is TRUE, the line will be truncated. If the buffer is is too small and Truncate is FALSE, then no read will occur. - @param[in, out] Ascii Boolean value for indicating whether the file is + @param[in,out] Ascii Boolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE). @retval EFI_SUCCESS The operation was successful. The line is stored in @@ -418,7 +418,7 @@ FileHandleReadLine ( maintained and not changed for all operations with the same file. @param[in] Handle FileHandle to read from. - @param[in, out] Ascii Boolean value for indicating whether the file is + @param[in,out] Ascii Boolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE). @return The line of text from the file. diff --git a/MdePkg/Include/Library/PcdLib.h b/MdePkg/Include/Library/PcdLib.h index 4b103f0753c5..86739a3b2bd1 100644 --- a/MdePkg/Include/Library/PcdLib.h +++ b/MdePkg/Include/Library/PcdLib.h @@ -1158,7 +1158,7 @@ LibPcdSet64S ( 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,out] SizeOfBuffer The size, in bytes, of Buffer. @param[in] Buffer A pointer to the buffer to set. @return The status of the set operation. @@ -1303,7 +1303,7 @@ LibPcdSetEx64S ( @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. + @param[in,out] SizeOfBuffer The size, in bytes, of Buffer. @param[in] Buffer A pointer to the buffer to set. @return The status of the set operation. @@ -1354,7 +1354,7 @@ LibPcdSetExBoolS ( @param[in] CallBackGuid The PCD token GUID being set. @param[in] CallBackToken The PCD token number being set. - @param[in, out] TokenData A pointer to the token data being set. + @param[in,out] TokenData A pointer to the token data being set. @param[in] TokenDataSize The size, in bytes, of the data being set. **/ @@ -1474,7 +1474,7 @@ LibPcdGetNextTokenSpace ( @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,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. @@ -1506,7 +1506,7 @@ LibPatchPcdSetPtr ( @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,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. @@ -1540,7 +1540,7 @@ LibPatchPcdSetPtrS ( 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,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. @@ -1575,7 +1575,7 @@ LibPatchPcdSetPtrAndSize ( 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,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/MdePkg/Include/Library/SmmPeriodicSmiLib.h b/MdePkg/Include/Library/SmmPeriodicSmiLib.h index 83d9bdde0eb8..dd3745d65af8 100644 --- a/MdePkg/Include/Library/SmmPeriodicSmiLib.h +++ b/MdePkg/Include/Library/SmmPeriodicSmiLib.h @@ -104,7 +104,7 @@ VOID /** This function enables a periodic SMI handler. - @param[in, out] DispatchHandle A pointer to the handle associated with the + @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, diff --git a/MdePkg/Include/Library/UefiScsiLib.h b/MdePkg/Include/Library/UefiScsiLib.h index da6ac2df68e7..90db37456ad2 100644 --- a/MdePkg/Include/Library/UefiScsiLib.h +++ b/MdePkg/Include/Library/UefiScsiLib.h @@ -39,12 +39,12 @@ SPDX-License-Identifier: BSD-2-Clause-Patent is greater than zero, then this function will return EFI_TIMEOUT if the time required to execute the SCSI Request Packet is greater than Timeout. - @param[in, out] SenseData A pointer to sense data that was generated by + @param[in,out] SenseData A pointer to sense data that was generated by the execution of the SCSI Request Packet. This buffer must be allocated by the caller. If SenseDataLength is 0, then this parameter is optional and may be NULL. - @param[in, out] SenseDataLength On input, a pointer to the length in bytes of + @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. @param[out] HostAdapterStatus The status of the SCSI Host Controller that produces @@ -122,12 +122,12 @@ ScsiTestUnitReadyCommand ( If Timeout is greater than zero, then this function will return EFI_TIMEOUT if the time required to execute the SCSI Request Packet is greater than Timeout. - @param[in, out] SenseData A pointer to sense data that was generated + @param[in,out] SenseData A pointer to sense data that was generated by the execution of the SCSI Request Packet. This buffer must be allocated by the caller. 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. + @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. @param[out] HostAdapterStatus The status of the SCSI Host Controller that produces the SCSI bus containing the SCSI @@ -141,12 +141,12 @@ ScsiTestUnitReadyCommand ( See the EFI SCSI I/O Protocol in the UEFI Specification for details on the possible return values. - @param[in, out] InquiryDataBuffer A pointer to inquiry data that was generated + @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. - @param[in, out] InquiryDataLength On input, a pointer to the length in bytes + @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 written to the InquiryDataBuffer buffer. @@ -223,12 +223,12 @@ ScsiInquiryCommand ( If Timeout is greater than zero, then this function will return EFI_TIMEOUT if the time required to execute the SCSI Request Packet is greater than Timeout. - @param[in, out] SenseData A pointer to sense data that was generated + @param[in,out] SenseData A pointer to sense data that was generated by the execution of the SCSI Request Packet. This buffer must be allocated by the caller. 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. + @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. @param[out] HostAdapterStatus The status of the SCSI Host Controller that produces the SCSI bus containing the SCSI @@ -242,12 +242,12 @@ ScsiInquiryCommand ( See the EFI SCSI I/O Protocol in the UEFI Specification for details on the possible return values. - @param[in, out] InquiryDataBuffer A pointer to inquiry data that was generated + @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. - @param[in, out] InquiryDataLength On input, a pointer to the length in bytes + @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 written to the InquiryDataBuffer buffer. @@ -329,12 +329,12 @@ ScsiInquiryCommandEx ( If Timeout is greater than zero, then this function will return EFI_TIMEOUT if the time required to execute the SCSI Request Packet is greater than Timeout. - @param[in, out] SenseData A pointer to sense data that was generated + @param[in,out] SenseData A pointer to sense data that was generated by the execution of the SCSI Request Packet. This buffer must be allocated by the caller. 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. + @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. @param[out] HostAdapterStatus The status of the SCSI Host Controller that produces the SCSI bus containing the SCSI target @@ -347,12 +347,12 @@ ScsiInquiryCommandEx ( on the SCSI Host Controller. See the EFI SCSI I/O Protocol in the UEFI Specification for details on the possible return values. - @param[in, out] DataBuffer A pointer to data that was generated by the + @param[in,out] DataBuffer A pointer to data that was generated by the 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. - @param[in, out] DataLength On input, a pointer to the length in bytes of + @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. @@ -420,8 +420,8 @@ ScsiModeSense10Command ( @param[in] ScsiIo A pointer to SCSI IO protocol. @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. @@ -469,12 +469,12 @@ ScsiRequestSenseCommand ( @param[in] ScsiIo A pointer to SCSI IO protocol. @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. - @param[in, out] DataBuffer A pointer to a data buffer. - @param[in, out] DataLength The length of data buffer. + @param[in,out] DataBuffer A pointer to a data buffer. + @param[in,out] DataLength The length of data buffer. @param[in] Pmi Partial medium indicator. @retval EFI_SUCCESS Command is executed successfully. @@ -527,12 +527,12 @@ ScsiReadCapacityCommand ( @param[in] ScsiIo A pointer to SCSI IO protocol. @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. - @param[in, out] DataBuffer A pointer to a data buffer. - @param[in, out] DataLength The length of data buffer. + @param[in,out] DataBuffer A pointer to a data buffer. + @param[in,out] DataLength The length of data buffer. @param[in] Pmi Partial medium indicator. @retval EFI_SUCCESS Command is executed successfully. @@ -586,12 +586,12 @@ ScsiReadCapacity16Command ( @param[in] ScsiIo A pointer to SCSI IO protocol. @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. - @param[in, out] DataBuffer Read 10 command data. - @param[in, out] DataLength The length of data buffer. + @param[in,out] DataBuffer Read 10 command data. + @param[in,out] DataLength The length of data buffer. @param[in] StartLba The start address of LBA. @param[in] SectorSize The number of contiguous logical blocks of data that shall be transferred. @@ -646,12 +646,12 @@ ScsiRead10Command ( @param[in] ScsiIo SCSI IO Protocol to use @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. - @param[in, out] DataBuffer A pointer to a data buffer. - @param[in, out] DataLength The length of data buffer. + @param[in,out] DataBuffer A pointer to a data buffer. + @param[in,out] DataLength The length of data buffer. @param[in] StartLba The start address of LBA. @param[in] SectorSize The number of contiguous logical blocks of data that shall be transferred. @@ -706,12 +706,12 @@ ScsiWrite10Command ( @param[in] ScsiIo A pointer to SCSI IO protocol. @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. - @param[in, out] DataBuffer Read 16 command data. - @param[in, out] DataLength The length of data buffer. + @param[in,out] DataBuffer Read 16 command data. + @param[in,out] DataLength The length of data buffer. @param[in] StartLba The start address of LBA. @param[in] SectorSize The number of contiguous logical blocks of data that shall be transferred. @@ -766,12 +766,12 @@ ScsiRead16Command ( @param[in] ScsiIo SCSI IO Protocol to use @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. - @param[in, out] DataBuffer A pointer to a data buffer. - @param[in, out] DataLength The length of data buffer. + @param[in,out] DataBuffer A pointer to a data buffer. + @param[in,out] DataLength The length of data buffer. @param[in] StartLba The start address of LBA. @param[in] SectorSize The number of contiguous logical blocks of data that shall be transferred. @@ -825,8 +825,8 @@ ScsiWrite16Command ( @param[in] ScsiIo SCSI IO Protocol to use. @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. @param[in] SecurityProtocol The Security Protocol to use. @@ -834,7 +834,7 @@ ScsiWrite16Command ( @param[in] Inc512 If TRUE, 512 increment (INC_512) bit will be set for the SECURITY PROTOCOL IN command. @param[in] DataLength The size in bytes of the data buffer. - @param[in, out] DataBuffer A pointer to a data buffer. + @param[in,out] DataBuffer A pointer to a data buffer. @param[out] TransferLength A pointer to a buffer to store the size in bytes of the data written to the data buffer. @@ -889,8 +889,8 @@ ScsiSecurityProtocolInCommand ( @param[in] ScsiIo SCSI IO Protocol to use. @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. @param[in] SecurityProtocol The Security Protocol to use. @@ -898,7 +898,7 @@ ScsiSecurityProtocolInCommand ( @param[in] Inc512 If TRUE, 512 increment (INC_512) bit will be set for the SECURITY PROTOCOL OUT command. @param[in] DataLength The size in bytes of the transfer data. - @param[in, out] DataBuffer A pointer to a data buffer. + @param[in,out] DataBuffer A pointer to a data buffer. @retval EFI_SUCCESS Command is executed successfully. @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire DataBuffer could @@ -960,12 +960,12 @@ ScsiSecurityProtocolOutCommand ( @param[in] ScsiIo A pointer to SCSI IO protocol. @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. - @param[in, out] DataBuffer Read 16 command data. - @param[in, out] DataLength The length of data buffer. + @param[in,out] DataBuffer Read 16 command data. + @param[in,out] DataLength The length of data buffer. @param[in] StartLba The start address of LBA. @param[in] SectorSize The number of contiguous logical blocks of data that shall be transferred. @@ -1049,12 +1049,12 @@ ScsiRead10CommandEx ( @param[in] ScsiIo SCSI IO Protocol to use @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. - @param[in, out] DataBuffer A pointer to a data buffer. - @param[in, out] DataLength The length of data buffer. + @param[in,out] DataBuffer A pointer to a data buffer. + @param[in,out] DataLength The length of data buffer. @param[in] StartLba The start address of LBA. @param[in] SectorSize The number of contiguous logical blocks of data that shall be transferred. @@ -1138,12 +1138,12 @@ ScsiWrite10CommandEx ( @param[in] ScsiIo A pointer to SCSI IO protocol. @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. - @param[in, out] DataBuffer Read 16 command data. - @param[in, out] DataLength The length of data buffer. + @param[in,out] DataBuffer Read 16 command data. + @param[in,out] DataLength The length of data buffer. @param[in] StartLba The start address of LBA. @param[in] SectorSize The number of contiguous logical blocks of data that shall be transferred. @@ -1227,12 +1227,12 @@ ScsiRead16CommandEx ( @param[in] ScsiIo SCSI IO Protocol to use @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. - @param[in, out] DataBuffer A pointer to a data buffer. - @param[in, out] DataLength The length of data buffer. + @param[in,out] DataBuffer A pointer to a data buffer. + @param[in,out] DataLength The length of data buffer. @param[in] StartLba The start address of LBA. @param[in] SectorSize The number of contiguous logical blocks of data that shall be transferred. diff --git a/MdePkg/Include/Ppi/CpuIo.h b/MdePkg/Include/Ppi/CpuIo.h index 193a78e3c256..5e2ca4edbc22 100644 --- a/MdePkg/Include/Ppi/CpuIo.h +++ b/MdePkg/Include/Ppi/CpuIo.h @@ -46,7 +46,7 @@ typedef enum { @param[in] Width The width of the access. Enumerated in bytes. @param[in] Address The physical address of the access. @param[in] Count The number of accesses to perform. - @param[in, out] Buffer A pointer to the buffer of data. + @param[in,out] Buffer A pointer to the buffer of data. @retval EFI_SUCCESS The function completed successfully. @retval EFI_NOT_YET_AVAILABLE The service has not been installed. diff --git a/MdePkg/Include/Ppi/Graphics.h b/MdePkg/Include/Ppi/Graphics.h index 3854f6c371c2..e8c1bc14b0ac 100644 --- a/MdePkg/Include/Ppi/Graphics.h +++ b/MdePkg/Include/Ppi/Graphics.h @@ -48,7 +48,7 @@ EFI_STATUS The GraphicsPpiGetMode returns the mode information supported by the Graphics PEI Module. - @param[in, out] Mode Pointer to EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE data. + @param[in,out] Mode Pointer to EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE data. @retval EFI_SUCCESS Valid mode information was returned. @retval EFI_INVALID_PARAMETER The Mode parameter is not valid. diff --git a/MdePkg/Include/Ppi/Pcd.h b/MdePkg/Include/Ppi/Pcd.h index d36a7f106cc8..3e6556314d1b 100644 --- a/MdePkg/Include/Ppi/Pcd.h +++ b/MdePkg/Include/Ppi/Pcd.h @@ -420,7 +420,7 @@ EFI_STATUS 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. + @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. @@ -578,7 +578,7 @@ EFI_STATUS @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. + @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. @@ -638,7 +638,7 @@ EFI_STATUS @param[in] CallBackGuid The PCD token GUID being set. @param[in] CallBackToken The PCD token number being set. - @param[in, out] TokenData A pointer to the token data being set. + @param[in,out] TokenData A pointer to the token data being set. @param[in] TokenDataSize The size, in bytes, of the data being set. @retval VOID @@ -712,7 +712,7 @@ EFI_STATUS @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. + @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. @@ -731,7 +731,7 @@ EFI_STATUS Gets the next valid token namespace for a given namespace. This is useful to traverse the valid token namespaces on a platform. - @param[in, out] Guid An indirect pointer to EFI_GUID. On input it designates a known token + @param[in,out] Guid An indirect pointer to EFI_GUID. On input it designates a known token namespace from which the search will start. On output, it designates the next valid 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 diff --git a/MdePkg/Include/Ppi/PiPcd.h b/MdePkg/Include/Ppi/PiPcd.h index 8d0f95eb27cc..8b137f2ca9e2 100644 --- a/MdePkg/Include/Ppi/PiPcd.h +++ b/MdePkg/Include/Ppi/PiPcd.h @@ -387,7 +387,7 @@ EFI_STATUS Gets the next valid token namespace for a given namespace. This is useful to traverse the valid token namespaces on a platform. - @param[in, out] Guid An indirect pointer to EFI_GUID. On input it designates a known token + @param[in,out] Guid An indirect pointer to EFI_GUID. On input it designates a known token namespace from which the search will start. On output, it designates the next valid 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 diff --git a/MdePkg/Include/Protocol/AcpiSystemDescriptionTable.h b/MdePkg/Include/Protocol/AcpiSystemDescriptionTable.h index 9e134200da54..f25c3a7cd641 100644 --- a/MdePkg/Include/Protocol/AcpiSystemDescriptionTable.h +++ b/MdePkg/Include/Protocol/AcpiSystemDescriptionTable.h @@ -162,7 +162,7 @@ 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 + @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. diff --git a/MdePkg/Include/Protocol/BlockIo2.h b/MdePkg/Include/Protocol/BlockIo2.h index d25f51f73354..9bd5e7a6ddd9 100644 --- a/MdePkg/Include/Protocol/BlockIo2.h +++ b/MdePkg/Include/Protocol/BlockIo2.h @@ -72,7 +72,7 @@ EFI_STATUS @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,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 @@ -116,7 +116,7 @@ EFI_STATUS @param[in] Lba The starting logical block address to be written. The caller is responsible for writing to only legitimate locations. - @param[in, out] Token A pointer to the token associated with the transaction. + @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[in] Buffer A pointer to the source buffer for the data. diff --git a/MdePkg/Include/Protocol/BlockIoCrypto.h b/MdePkg/Include/Protocol/BlockIoCrypto.h index bcc0ed40beff..f15cde32f61b 100644 --- a/MdePkg/Include/Protocol/BlockIoCrypto.h +++ b/MdePkg/Include/Protocol/BlockIoCrypto.h @@ -356,7 +356,7 @@ EFI_STATUS @param[in] MediaId The media ID that the read request is for. @param[in] LBA The starting logical block address to read from on the device. - @param[in, out] Token A pointer to the token associated with the transaction. + @param[in,out] Token A pointer to the token associated with the transaction. @param[in] BufferSize The size of the Buffer in bytes. This 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 @@ -423,7 +423,7 @@ EFI_STATUS @param[in] MediaId The media ID that the read request is for. @param[in] LBA The starting logical block address to read from on the device. - @param[in, out] Token A pointer to the token associated with the transaction. + @param[in,out] Token A pointer to the token associated with the transaction. @param[in] BufferSize The size of the Buffer in bytes. This must be a multiple of the intrinsic block size of the device. @param[in] Buffer A pointer to the source buffer for the data. @@ -482,7 +482,7 @@ EFI_STATUS will not be signaled. @param[in] This Pointer to the EFI_BLOCK_IO_CRYPTO_PROTOCOL instance. - @param[in, out] Token A pointer to the token associated with the transaction. + @param[in,out] Token A pointer to the token associated with the transaction. @retval EFI_SUCCESS The flush request was queued if Event is not NULL. All outstanding data was written correctly to the device if diff --git a/MdePkg/Include/Protocol/BluetoothHc.h b/MdePkg/Include/Protocol/BluetoothHc.h index d75cb08f8928..29faf36fb7b7 100644 --- a/MdePkg/Include/Protocol/BluetoothHc.h +++ b/MdePkg/Include/Protocol/BluetoothHc.h @@ -164,7 +164,7 @@ EFI_STATUS capability. @param[in] This Pointer to the EFI_BLUETOOTH_HC_PROTOCOL instance. - @param[in, out] BufferSize On input, indicates the size, in bytes, of the data buffer + @param[in,out] BufferSize On input, indicates the size, in bytes, of the data buffer specified by Buffer. On output, indicates the amount of data actually transferred. @param[in] Buffer A pointer to the buffer of data that will be transmitted to @@ -200,7 +200,7 @@ EFI_STATUS ACL data packet, including Handle, PB flag, BC flag, data length, and data. @param[in] This Pointer to the EFI_BLUETOOTH_HC_PROTOCOL instance. - @param[in, out] BufferSize On input, indicates the size, in bytes, of the data buffer + @param[in,out] BufferSize On input, indicates the size, in bytes, of the data buffer specified by Buffer. On output, indicates the amount of data actually transferred. @param[out] Buffer A pointer to the buffer of data that will be received from diff --git a/MdePkg/Include/Protocol/BluetoothIo.h b/MdePkg/Include/Protocol/BluetoothIo.h index 620bfbc961cc..b4f6aee73e55 100644 --- a/MdePkg/Include/Protocol/BluetoothIo.h +++ b/MdePkg/Include/Protocol/BluetoothIo.h @@ -105,7 +105,7 @@ EFI_STATUS Send L2CAP message (including L2CAP header). @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance. - @param[in, out] BufferSize On input, indicates the size, in bytes, of the data buffer specified by Buffer. + @param[in,out] BufferSize On input, indicates the size, in bytes, of the data buffer specified by Buffer. On output, indicates the amount of data actually transferred. @param[in] Buffer A pointer to the buffer of data that will be transmitted to Bluetooth L2CAP layer. @param[in] Timeout Indicating the transfer should be completed within this time frame. The units are in @@ -212,7 +212,7 @@ EFI_STATUS @param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance. @param[in] Handle A handle created by EFI_BLUETOOTH_IO_PROTOCOL.L2CapConnect indicates which channel to send. - @param[in, out] BufferSize On input, indicates the size, in bytes, of the data buffer specified by Buffer. + @param[in,out] BufferSize On input, indicates the size, in bytes, of the data buffer specified by Buffer. On output, indicates the amount of data actually transferred. @param[in] Buffer A pointer to the buffer of data that will be transmitted to Bluetooth L2CAP layer. @param[in] Timeout Indicating the transfer should be completed within this time frame. The units are in diff --git a/MdePkg/Include/Protocol/BluetoothLeConfig.h b/MdePkg/Include/Protocol/BluetoothLeConfig.h index 6331e60a8655..2ec8a48fc551 100644 --- a/MdePkg/Include/Protocol/BluetoothLeConfig.h +++ b/MdePkg/Include/Protocol/BluetoothLeConfig.h @@ -234,9 +234,9 @@ EFI_STATUS @param[in] This Pointer to the EFI_BLUETOOTH_LE_CONFIG_PROTOCOL instance. @param[in] DataType Configuration data type. - @param[in, out] DataSize On input, indicates the size, in bytes, of the data buffer specified by Data. + @param[in,out] DataSize On input, indicates the size, in bytes, of the data buffer specified by Data. On output, indicates the amount of data actually returned. - @param[in, out] Data A pointer to the buffer of data that will be returned. + @param[in,out] Data A pointer to the buffer of data that will be returned. @retval EFI_SUCCESS The BluetoothLE configuration data is returned successfully. @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: @@ -293,9 +293,9 @@ EFI_STATUS @param[in] This Pointer to the EFI_BLUETOOTH_LE_CONFIG_PROTOCOL instance. @param[in] DataType Configuration data type. @param[in] BDAddr Remote BluetoothLE device address. - @param[in, out] DataSize On input, indicates the size, in bytes, of the data buffer specified by Data. + @param[in,out] DataSize On input, indicates the size, in bytes, of the data buffer specified by Data. On output, indicates the amount of data actually returned. - @param[in, out] Data A pointer to the buffer of data that will be returned. + @param[in,out] Data A pointer to the buffer of data that will be returned. @retval EFI_SUCCESS The remote BluetoothLE device configuration data is returned successfully. @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: @@ -464,7 +464,7 @@ typedef enum { @param[in] BDAddr Remote BluetoothLE device address. For Local device setting, it should be NULL. @param[in] DataType Data type in EFI_BLUETOOTH_LE_SMP_DATA_TYPE. - @param[in, out] DataSize On input, indicates the size, in bytes, of the data buffer specified + @param[in,out] DataSize On input, indicates the size, in bytes, of the data buffer specified by Data. On output, indicates the amount of data actually returned. @param[out] Data A pointer to the buffer of data that will be returned. diff --git a/MdePkg/Include/Protocol/CcMeasurement.h b/MdePkg/Include/Protocol/CcMeasurement.h index 4bf21fc42fa0..555356d56d66 100644 --- a/MdePkg/Include/Protocol/CcMeasurement.h +++ b/MdePkg/Include/Protocol/CcMeasurement.h @@ -139,7 +139,7 @@ typedef struct { capability information and state information. @param[in] This Indicates the calling context - @param[in, out] ProtocolCapability The caller allocates memory for a EFI_CC_BOOT_SERVICE_CAPABILITY + @param[in,out] ProtocolCapability The caller allocates memory for a EFI_CC_BOOT_SERVICE_CAPABILITY structure and sets the size field to the size of the structure allocated. The callee fills in the fields with the EFI CC BOOT Service capability information and the current CC information. diff --git a/MdePkg/Include/Protocol/CpuIo2.h b/MdePkg/Include/Protocol/CpuIo2.h index 39ddda62bfcf..baddbeb51de5 100644 --- a/MdePkg/Include/Protocol/CpuIo2.h +++ b/MdePkg/Include/Protocol/CpuIo2.h @@ -81,7 +81,7 @@ typedef enum { @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. + @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. @retval EFI_SUCCESS The data was read from or written to the PI system. diff --git a/MdePkg/Include/Protocol/Eap.h b/MdePkg/Include/Protocol/Eap.h index 37b94b55c998..2c69772225ad 100644 --- a/MdePkg/Include/Protocol/Eap.h +++ b/MdePkg/Include/Protocol/Eap.h @@ -54,7 +54,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. diff --git a/MdePkg/Include/Protocol/EapConfiguration.h b/MdePkg/Include/Protocol/EapConfiguration.h index 6fcddabcb7b2..4bd100677b55 100644 --- a/MdePkg/Include/Protocol/EapConfiguration.h +++ b/MdePkg/Include/Protocol/EapConfiguration.h @@ -114,8 +114,8 @@ EFI_STATUS @param[in] This Pointer to the EFI_EAP_CONFIGURATION_PROTOCOL instance. @param[in] EapType EAP type. @param[in] DataType Configuration data type. - @param[in, out] Data Pointer to configuration data. - @param[in, out] DataSize Total size of configuration data. On input, it means + @param[in,out] Data Pointer to configuration data. + @param[in,out] DataSize Total size of configuration data. On input, it means the size of Data buffer. On output, it means the size of copied Data buffer if EFI_SUCCESS, and means the size of desired Data buffer if EFI_BUFFER_TOO_SMALL. diff --git a/MdePkg/Include/Protocol/EapManagement.h b/MdePkg/Include/Protocol/EapManagement.h index ea1b0d71e357..20f915e30cf5 100644 --- a/MdePkg/Include/Protocol/EapManagement.h +++ b/MdePkg/Include/Protocol/EapManagement.h @@ -294,7 +294,7 @@ EFI_STATUS instance that indicates the calling context. @param[out] CurrentState Returns the current state of the Supplicant PAE state machine for the Port. - @param[in, out] Configuration Returns the configuration of the operational + @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. diff --git a/MdePkg/Include/Protocol/EapManagement2.h b/MdePkg/Include/Protocol/EapManagement2.h index ab42b04e1a04..768f82b6aab2 100644 --- a/MdePkg/Include/Protocol/EapManagement2.h +++ b/MdePkg/Include/Protocol/EapManagement2.h @@ -33,10 +33,10 @@ typedef struct _EFI_EAP_MANAGEMENT2_PROTOCOL EFI_EAP_MANAGEMENT2_PROTOCOL; MAC layer driver can use MSK to derive more keys, e.g. PMK (Pairwise Master Key). @param[in] This Pointer to the EFI_EAP_MANAGEMENT2_PROTOCOL instance. - @param[in, out] Msk Pointer to MSK (Master Session Key) buffer. - @param[in, out] MskSize MSK buffer size. - @param[in, out] Emsk Pointer to EMSK (Extended Master Session Key) buffer. - @param[in, out] EmskSize EMSK buffer size. + @param[in,out] Msk Pointer to MSK (Master Session Key) buffer. + @param[in,out] MskSize MSK buffer size. + @param[in,out] Emsk Pointer to EMSK (Extended Master Session Key) buffer. + @param[in,out] EmskSize EMSK buffer size. @retval EFI_SUCCESS The operation completed successfully. @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: diff --git a/MdePkg/Include/Protocol/EraseBlock.h b/MdePkg/Include/Protocol/EraseBlock.h index bfa5921400aa..5f71ccdf9a0e 100644 --- a/MdePkg/Include/Protocol/EraseBlock.h +++ b/MdePkg/Include/Protocol/EraseBlock.h @@ -45,7 +45,7 @@ typedef struct { @param[in] LBA The starting logical block address to be erased. The caller is responsible for erasing only legitimate locations. - @param[in, out] Token A pointer to the token associated with the + @param[in,out] Token A pointer to the token associated with the transaction. @param[in] Size The size in bytes to be erased. This must be a multiple of the physical block size of the diff --git a/MdePkg/Include/Protocol/FirmwareManagement.h b/MdePkg/Include/Protocol/FirmwareManagement.h index f37067df3455..3bdebc29accd 100644 --- a/MdePkg/Include/Protocol/FirmwareManagement.h +++ b/MdePkg/Include/Protocol/FirmwareManagement.h @@ -286,12 +286,12 @@ EFI_STATUS The saved copy could later been used, for example, in firmware image recovery or rollback. @param[in] This A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance. - @param[in, out] ImageInfoSize A pointer to the size, in bytes, of the ImageInfo buffer. + @param[in,out] ImageInfoSize A pointer to the size, in bytes, of the ImageInfo buffer. On input, this is the size of the buffer allocated by the caller. On output, it is the size of the buffer returned by the firmware if the buffer was large enough, or the size of the buffer needed to contain the image(s) information if the buffer was too small. - @param[in, out] ImageInfo A pointer to the buffer in which firmware places the current image(s) + @param[in,out] ImageInfo A pointer to the buffer in which firmware places the current image(s) information. The information is an array of EFI_FIRMWARE_IMAGE_DESCRIPTORs. @param[out] DescriptorVersion A pointer to the location in which firmware returns the version number associated with the EFI_FIRMWARE_IMAGE_DESCRIPTOR. @@ -340,7 +340,7 @@ EFI_STATUS @param[in] ImageIndex A unique number identifying the firmware image(s) within the device. The number is between 1 and DescriptorCount. @param[out] Image Points to the buffer where the current image is copied to. - @param[in, out] ImageSize On entry, points to the size of the buffer pointed to by Image, in bytes. + @param[in,out] ImageSize On entry, points to the size of the buffer pointed to by Image, in bytes. On return, points to the length of the image, in bytes. @retval EFI_SUCCESS The device was successfully updated with the new image. diff --git a/MdePkg/Include/Protocol/I2cEnumerate.h b/MdePkg/Include/Protocol/I2cEnumerate.h index e1890e470c62..be07979043ae 100644 --- a/MdePkg/Include/Protocol/I2cEnumerate.h +++ b/MdePkg/Include/Protocol/I2cEnumerate.h @@ -28,7 +28,7 @@ typedef struct _EFI_I2C_ENUMERATE_PROTOCOL EFI_I2C_ENUMERATE_PROTOCOL; @param[in] This The platform data for the next device on the I2C bus was returned successfully. - @param[in, out] Device Pointer to a buffer containing an + @param[in,out] Device Pointer to a buffer containing an EFI_I2C_DEVICE structure. Enumeration is started by setting the initial EFI_I2C_DEVICE structure pointer to NULL. The buffer diff --git a/MdePkg/Include/Protocol/IpSec.h b/MdePkg/Include/Protocol/IpSec.h index 0b5d55a85293..6295bf43d401 100644 --- a/MdePkg/Include/Protocol/IpSec.h +++ b/MdePkg/Include/Protocol/IpSec.h @@ -55,11 +55,11 @@ typedef struct _EFI_IPSEC_FRAGMENT_DATA { @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,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] 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. @@ -111,7 +111,7 @@ struct _EFI_IPSEC_PROTOCOL { @param[in] This Pointer to the EFI_IPSEC2_PROTOCOL instance. @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 @@ -123,10 +123,10 @@ struct _EFI_IPSEC_PROTOCOL { 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 + @param[in,out] LastHead For IP4, it is the next protocol in IP header. For IP6 it is the Next Header of the last extension header. - @param[in, out] OptionsBuffer On input, it contains the options + @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 @@ -143,10 +143,10 @@ struct _EFI_IPSEC_PROTOCOL { 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 + @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, + @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 @@ -167,7 +167,7 @@ struct _EFI_IPSEC_PROTOCOL { 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,out] FragmentCount Number of fragments. @param[in] TrafficDirection Traffic direction. @param[out] RecycleSignal Event for recycling of resources. diff --git a/MdePkg/Include/Protocol/IpSecConfig.h b/MdePkg/Include/Protocol/IpSecConfig.h index 7136060691ca..2c9d3d8ddd45 100644 --- a/MdePkg/Include/Protocol/IpSecConfig.h +++ b/MdePkg/Include/Protocol/IpSecConfig.h @@ -647,7 +647,7 @@ EFI_STATUS @param[in] DataType The type of data to retrieve. @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[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. @@ -692,8 +692,8 @@ EFI_STATUS @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] SelectorSize The size of the Selector buffer. + @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. diff --git a/MdePkg/Include/Protocol/Kms.h b/MdePkg/Include/Protocol/Kms.h index c37fcbb65c63..b63e7d2cbd1b 100644 --- a/MdePkg/Include/Protocol/Kms.h +++ b/MdePkg/Include/Protocol/Kms.h @@ -366,7 +366,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 @@ -379,7 +379,7 @@ EFI_STATUS In all cases, the value upon return to the caller will be the size of the data block returned to the caller, 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 + @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 @@ -419,11 +419,11 @@ 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] KeyDescriptorCount Pointer to a count of the number of key descriptors to be + @param[in,out] KeyDescriptorCount Pointer to a count of the number of key descriptors to be processed by this operation. On return, this number will be updated with the number of key descriptors successfully processed. - @param[in, out] KeyDescriptors Pointer to an array of EFI_KMS_KEY_DESCRIPTOR + @param[in,out] KeyDescriptors Pointer to an array of EFI_KMS_KEY_DESCRIPTOR structures which describe the keys to be generated. On input, the KeyIdentifierSize and the KeyIdentifier may specify an identifier to be used for the key, @@ -447,7 +447,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 @@ -460,7 +460,7 @@ EFI_STATUS In all cases, the value upon return to the caller will be the size of the data block returned to the caller, 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 + @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 @@ -514,11 +514,11 @@ 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] KeyDescriptorCount Pointer to a count of the number of key descriptors to be + @param[in,out] KeyDescriptorCount Pointer to a count of the number of key descriptors to be processed by this operation. On return, this number will be updated with the number of key descriptors successfully processed. - @param[in, out] KeyDescriptors Pointer to an array of EFI_KMS_KEY_DESCRIPTOR + @param[in,out] KeyDescriptors Pointer to an array of EFI_KMS_KEY_DESCRIPTOR structures which describe the keys to be retrieved from the KMS. On input, the KeyIdentifierSize and the KeyIdentifier @@ -533,7 +533,7 @@ EFI_STATUS 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 @@ -546,7 +546,7 @@ EFI_STATUS In all cases, the value upon return to the caller will be the size of the data block returned to the caller, 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 + @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 @@ -602,11 +602,11 @@ 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] KeyDescriptorCount Pointer to a count of the number of key descriptors to be + @param[in,out] KeyDescriptorCount Pointer to a count of the number of key descriptors to be processed by this operation. On normal return, this number will be updated with the number of key descriptors successfully processed. - @param[in, out] KeyDescriptors Pointer to an array of EFI_KMS_KEY_DESCRIPTOR + @param[in,out] KeyDescriptors Pointer to an array of EFI_KMS_KEY_DESCRIPTOR structures which describe the keys to be added. On input, the KeyId field for first key must contain valid identifier data to be used for adding a key to @@ -619,7 +619,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 @@ -632,7 +632,7 @@ EFI_STATUS In all cases, the value upon return to the caller will be the size of the data block returned to the caller, 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 + @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 @@ -688,11 +688,11 @@ 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] KeyDescriptorCount Pointer to a count of the number of key descriptors to be + @param[in,out] KeyDescriptorCount Pointer to a count of the number of key descriptors to be processed by this operation. On normal return, this number will be updated with the number of key descriptors successfully processed. - @param[in, out] KeyDescriptors Pointer to an array of EFI_KMS_KEY_DESCRIPTOR + @param[in,out] KeyDescriptors Pointer to an array of EFI_KMS_KEY_DESCRIPTOR structures which describe the keys to be deleted. On input, the KeyId field for first key must contain valid identifier data to be used for adding a key to @@ -704,7 +704,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 @@ -717,7 +717,7 @@ EFI_STATUS In all cases, the value upon return to the caller will be the size of the data block returned to the caller, 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 + @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 @@ -770,19 +770,19 @@ EFI_STATUS @param[in] Client Pointer to a valid EFI_KMS_CLIENT_INFO structure. @param[in] KeyIdentifierSize Pointer to the size in bytes of the KeyIdentifier variable. @param[in] KeyIdentifier Pointer to the key identifier associated with this key. - @param[in, out] KeyAttributesCount Pointer to the number of EFI_KMS_KEY_ATTRIBUTE + @param[in,out] KeyAttributesCount Pointer to the number of EFI_KMS_KEY_ATTRIBUTE structures associated with the Key identifier. If none are found, the count value is zero on return. On input this value reflects the number of KeyAttributes that may be returned. On output, the value reflects the number of completed KeyAttributes structures found. - @param[in, out] KeyAttributes Pointer to an array of EFI_KMS_KEY_ATTRIBUTE + @param[in,out] KeyAttributes Pointer to an array of EFI_KMS_KEY_ATTRIBUTE structures associated with the Key Identifier. 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 @@ -795,7 +795,7 @@ EFI_STATUS In all cases, the value upon return to the caller will be the size of the data block returned to the caller, 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 + @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 @@ -858,18 +858,18 @@ EFI_STATUS @param[in] Client Pointer to a valid EFI_KMS_CLIENT_INFO structure. @param[in] KeyIdentifierSize Pointer to the size in bytes of the KeyIdentifier variable. @param[in] KeyIdentifier Pointer to the key identifier associated with this key. - @param[in, out] KeyAttributesCount Pointer to the number of EFI_KMS_KEY_ATTRIBUTE + @param[in,out] KeyAttributesCount Pointer to the number of EFI_KMS_KEY_ATTRIBUTE structures to associate with the Key. On normal returns, this number will be updated with the number of key attributes successfully processed. - @param[in, out] KeyAttributes Pointer to an array of EFI_KMS_KEY_ATTRIBUTE + @param[in,out] KeyAttributes Pointer to an array of EFI_KMS_KEY_ATTRIBUTE structures providing the attribute information to associate with the key. On input, the values for the fields in the structure 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 @@ -882,7 +882,7 @@ EFI_STATUS In all cases, the value upon return to the caller will be the size of the data block returned to the caller, 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 + @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 @@ -948,19 +948,19 @@ EFI_STATUS @param[in] Client Pointer to a valid EFI_KMS_CLIENT_INFO structure. @param[in] KeyIdentifierSize Pointer to the size in bytes of the KeyIdentifier variable. @param[in] KeyIdentifier Pointer to the key identifier associated with this key. - @param[in, out] KeyAttributesCount Pointer to the number of EFI_KMS_KEY_ATTRIBUTE + @param[in,out] KeyAttributesCount Pointer to the number of EFI_KMS_KEY_ATTRIBUTE structures to associate with the Key. On input, the count value is one or more. On normal returns, this number will be updated with the number of key attributes successfully processed. - @param[in, out] KeyAttributes Pointer to an array of EFI_KMS_KEY_ATTRIBUTE + @param[in,out] KeyAttributes Pointer to an array of EFI_KMS_KEY_ATTRIBUTE structures providing the attribute information to associate with the key. On input, the values for the fields in the structure 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 @@ -973,7 +973,7 @@ EFI_STATUS In all cases, the value upon return to the caller will be the size of the data block returned to the caller, 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 + @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 @@ -1029,23 +1029,23 @@ 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] KeyAttributesCount Pointer to a count of the number of key attribute structures + @param[in,out] KeyAttributesCount Pointer to a count of the number of key attribute structures that must be matched for each returned key descriptor. On input the count value is one or more. On normal returns, this number will be updated with the number of key attributes successfully processed. - @param[in, out] KeyAttributes Pointer to an array of EFI_KMS_KEY_ATTRIBUTE + @param[in,out] KeyAttributes Pointer to an array of EFI_KMS_KEY_ATTRIBUTE structure to search for. On input, the values for the fields in the structure are completely filled in. On return the KeyAttributeStatus field will reflect the result of the operation for each key attribute request. - @param[in, out] KeyDescriptorCount Pointer to a count of the number of key descriptors matched + @param[in,out] KeyDescriptorCount Pointer to a count of the number of key descriptors matched by this operation. On entry, this number will be zero. On return, this number will be updated to the number of key descriptors successfully found. - @param[in, out] KeyDescriptors Pointer to an array of EFI_KMS_KEY_DESCRIPTOR + @param[in,out] KeyDescriptors Pointer to an array of EFI_KMS_KEY_DESCRIPTOR structures which describe the keys from the KMS having the KeyAttribute(s) specified. On input, this pointer will be NULL. @@ -1057,7 +1057,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 @@ -1070,7 +1070,7 @@ EFI_STATUS In all cases, the value upon return to the caller will be the size of the data block returned to the caller, 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 + @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 diff --git a/MdePkg/Include/Protocol/MmCommunication2.h b/MdePkg/Include/Protocol/MmCommunication2.h index 1b56320c7fff..86f74d9d2fa8 100644 --- a/MdePkg/Include/Protocol/MmCommunication2.h +++ b/MdePkg/Include/Protocol/MmCommunication2.h @@ -28,9 +28,9 @@ typedef struct _EFI_MM_COMMUNICATION2_PROTOCOL EFI_MM_COMMUNICATION2_PROTOCOL; This function provides a service to send and receive messages from a registered UEFI service. @param[in] This The EFI_MM_COMMUNICATION_PROTOCOL instance. - @param[in, out] CommBufferPhysical Physical address of the MM communication buffer - @param[in, out] CommBufferVirtual Virtual address of the MM communication buffer - @param[in, out] CommSize The size of the data buffer being passed in. On exit, the + @param[in,out] CommBufferPhysical Physical address of the MM communication buffer + @param[in,out] CommBufferVirtual Virtual address of the MM communication buffer + @param[in,out] CommSize The size of the data buffer being passed in. On exit, the size of data being returned. Zero if the handler does not wish to reply with any data. This parameter is optional and may be NULL. diff --git a/MdePkg/Include/Protocol/MmSwDispatch.h b/MdePkg/Include/Protocol/MmSwDispatch.h index e7810662ecdb..fdecac020e5e 100644 --- a/MdePkg/Include/Protocol/MmSwDispatch.h +++ b/MdePkg/Include/Protocol/MmSwDispatch.h @@ -62,7 +62,7 @@ typedef struct _EFI_MM_SW_DISPATCH_PROTOCOL EFI_MM_SW_DISPATCH_PROTOCOL; @param[in] This Pointer to the EFI_MM_SW_DISPATCH_PROTOCOL instance. @param[in] DispatchFunction Function to register for handler when the specified software MMI is generated. - @param[in, out] RegisterContext Pointer to the dispatch function's context. + @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 function which Software MMI input value the diff --git a/MdePkg/Include/Protocol/Mtftp6.h b/MdePkg/Include/Protocol/Mtftp6.h index 4abf296c1c01..ce5a1409c943 100644 --- a/MdePkg/Include/Protocol/Mtftp6.h +++ b/MdePkg/Include/Protocol/Mtftp6.h @@ -368,7 +368,7 @@ EFI_STATUS @param[in] This Pointer to the EFI_MTFTP6_PROTOCOL instance. @param[in] Token The token provided in the EFI_MTFTP6_PROTOCOL.WriteFile() by the caller. - @param[in, out] Length Indicates the length of the raw data wanted on input, and the + @param[in,out] Length Indicates the length of the raw data wanted on input, and the length the data available on output. @param[out] Buffer Pointer to the buffer where the data is stored. diff --git a/MdePkg/Include/Protocol/Pcd.h b/MdePkg/Include/Protocol/Pcd.h index 25f73cda1423..56c7f03e2c99 100644 --- a/MdePkg/Include/Protocol/Pcd.h +++ b/MdePkg/Include/Protocol/Pcd.h @@ -424,7 +424,7 @@ EFI_STATUS 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. + @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. @@ -582,7 +582,7 @@ EFI_STATUS @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. + @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. @@ -643,7 +643,7 @@ EFI_STATUS @param[in] CallBackGuid The PCD token GUID being set. @param[in] CallBackToken The PCD token number being set. - @param[in, out] TokenData A pointer to the token data being set. + @param[in,out] TokenData A pointer to the token data being set. @param[in] TokenDataSize The size, in bytes, of the data being set. @retval VOID @@ -737,7 +737,7 @@ EFI_STATUS Gets the next valid token namespace for a given namespace. This is useful to traverse the valid token namespaces on a platform. - @param[in, out] Guid An indirect pointer to EFI_GUID. On input it designates a known token namespace + @param[in,out] Guid An indirect pointer to EFI_GUID. On input it designates a known token namespace from which the search will start. On output, it designates the next valid 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 diff --git a/MdePkg/Include/Protocol/PiPcd.h b/MdePkg/Include/Protocol/PiPcd.h index e26733b5d9db..63b198c63e0e 100644 --- a/MdePkg/Include/Protocol/PiPcd.h +++ b/MdePkg/Include/Protocol/PiPcd.h @@ -379,7 +379,7 @@ EFI_STATUS Gets the next valid token namespace for a given namespace. This is useful to traverse the valid token namespaces on a platform. - @param[in, out] Guid An indirect pointer to EFI_GUID. On input it designates a known token namespace + @param[in,out] Guid An indirect pointer to EFI_GUID. On input it designates a known token namespace from which the search will start. On output, it designates the next valid 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 diff --git a/MdePkg/Include/Protocol/S3SaveState.h b/MdePkg/Include/Protocol/S3SaveState.h index c2b26944fb41..f9f45e0a115a 100644 --- a/MdePkg/Include/Protocol/S3SaveState.h +++ b/MdePkg/Include/Protocol/S3SaveState.h @@ -72,7 +72,7 @@ EFI_STATUS in 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[in, out] Position On entry, specifies the position in the boot script table where the opcode will be + @param[in,out] 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. @param[in] OpCode The operation code (opcode) number. See "Related Definitions" in Write() for the @@ -111,7 +111,7 @@ EFI_STATUS NULL then the new label is inserted at the beginning of the table (if TRUE) or end of the table (if FALSE). @param[in] CreateIfNotFound Specifies whether the label will be created if the label does not exists (TRUE) or not (FALSE). - @param[in, out] Position On entry, specifies the position in the boot script table where the label will be inserted, + @param[in,out] Position On entry, specifies the position in the boot script table where the label will be inserted, 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. diff --git a/MdePkg/Include/Protocol/Shell.h b/MdePkg/Include/Protocol/Shell.h index 5efee49e197a..413dd0e4acbb 100644 --- a/MdePkg/Include/Protocol/Shell.h +++ b/MdePkg/Include/Protocol/Shell.h @@ -734,7 +734,7 @@ EFI_STATUS If there are multiple map names they will be semi-colon seperated in the NULL-terminated string. - @param[in, out] DevicePath On entry, points to a device path pointer. On + @param[in,out] DevicePath On entry, points to a device path pointer. On exit, updates the pointer to point to the portion of the device path after the mapping. @@ -846,7 +846,7 @@ EFI_STATUS @param[in] Path A pointer to the path string. @param[in] OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or EFI_FILE_MODE_WRITE. - @param[in, out] FileList Points to the start of a list of files opened. + @param[in,out] FileList Points to the start of a list of files opened. @retval EFI_SUCCESS Create the file list successfully. @return Can't create the file list. @@ -915,7 +915,7 @@ EFI_STATUS @param[in] FileHandle The opened file handle for read. @param[in] ReadSize On input, the size of Buffer, in bytes. On output, the amount of data read. - @param[in, out] Buffer The buffer in which data is read. + @param[in,out] Buffer The buffer in which data is read. @retval EFI_SUCCESS Data was read. @retval EFI_NO_MEDIA The device has no media. @@ -1157,7 +1157,7 @@ EFI_STATUS Direct writes to opened directories are not supported. @param[in] FileHandle The opened file handle for writing. - @param[in, out] BufferSize On input, size of Buffer. + @param[in,out] BufferSize On input, size of Buffer. @param[in] Buffer The buffer in which data to write. @retval EFI_SUCCESS Data was written. diff --git a/MdePkg/Include/Protocol/SmartCardEdge.h b/MdePkg/Include/Protocol/SmartCardEdge.h index 1251680ec02f..2cf639a32633 100644 --- a/MdePkg/Include/Protocol/SmartCardEdge.h +++ b/MdePkg/Include/Protocol/SmartCardEdge.h @@ -225,13 +225,13 @@ extern EFI_GUID gEfiPaddingRsaesOaepGuid; @param[in] This Indicates a pointer to the calling context. @param[out] NumberAidSupported Number of AIDs this protocol supports. - @param[in, out] AidTableSize On input, number of items allocated for the + @param[in,out] AidTableSize On input, number of items allocated for the AID table. On output, number of items returned by protocol. @param[out] AidTable Table of the AIDs supported by the protocol. @param[out] NumberSCPresent Number of currently present Smart Cards that are supported by protocol. - @param[in, out] CsnTableSize On input, the number of items the buffer CSN + @param[in,out] CsnTableSize On input, the number of items the buffer CSN table can contain. On output, the number of items returned by the protocol. @param[out] CsnTable Table of the CSN of the Smart Card present and @@ -343,7 +343,7 @@ EFI_STATUS @param[in] This Indicates a pointer to the calling context. @param[in] SCardHandle Handle on Smart Card connection. - @param[in, out] ReaderNameLength On input, a pointer to the variable that holds + @param[in,out] ReaderNameLength On input, a pointer to the variable that holds the maximal size, in bytes, of ReaderName. On output, the required size, in bytes, for ReaderName. @param[out] ReaderName A pointer to a NULL terminated string that will @@ -455,7 +455,7 @@ EFI_STATUS @param[in] This Indicates a pointer to the calling context. @param[in] SCardHandle Handle on Smart Card connection. @param[in] DataId The type identifier of the data to get. - @param[in, out] DataSize On input, in bytes, the size of Data. On output, + @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 data. @param[out] Data The data buffer in which the data is returned. @@ -507,7 +507,7 @@ EFI_STATUS @param[in] This Indicates a pointer to the calling context. @param[in] SCardHandle Handle on Smart Card connection. - @param[in, out] CredentialSize On input, in bytes, the size of buffer to store + @param[in,out] CredentialSize On input, in bytes, the size of buffer to store the list of credential. On output, in bytes, the size of buffer required to store the entire list of credentials. @@ -623,7 +623,7 @@ EFI_STATUS - EFI_PADDING_RSAES_OAEP_GUID @param[in] EncryptedSize Size of data to decrypt. @param[in] EncryptedData Data to decrypt - @param[in, out] PlaintextSize On input, in bytes, the size of buffer to store + @param[in,out] PlaintextSize On input, in bytes, the size of buffer to store the decrypted data. On output, in bytes, the size of buffer required to store the decrypted data. diff --git a/MdePkg/Include/Protocol/SmartCardReader.h b/MdePkg/Include/Protocol/SmartCardReader.h index 0ce117c9c764..a65b40932ec5 100644 --- a/MdePkg/Include/Protocol/SmartCardReader.h +++ b/MdePkg/Include/Protocol/SmartCardReader.h @@ -135,13 +135,13 @@ EFI_STATUS @param[in] This Indicates a pointer to the calling context. @param[out] ReaderName A pointer to a NULL terminated string that will contain the reader name. - @param[in, out] ReaderNameLength On input, a pointer to the variablethat holds the + @param[in,out] ReaderNameLength On input, a pointer to the variablethat holds the maximal size, in bytes,of ReaderName. On output, the required size, in bytes, for ReaderName. @param[out] State Current state of the smart card reader. @param[out] CardProtocol Current protocol used to communicate with the smart card. @param[out] Atr A pointer to retrieve the ATR of the smart card. - @param[in, out] AtrLength On input, a pointer to hold the maximum size, in bytes, + @param[in,out] AtrLength On input, a pointer to hold the maximum size, in bytes, of Atr(usually 33). On output, the required size, inbytes, for the smart card ATR. @@ -184,7 +184,7 @@ EFI_STATUS @param[in] CAPDULength Command APDU size, in bytes. @param[out] RAPDU A pointer to a byte array that will contain the Response APDU. - @param[in, out] RAPDULength On input, the maximum size, inbytes, of the Response + @param[in,out] RAPDULength On input, the maximum size, inbytes, of the Response APDU. On output, the size, in bytes, of the Response APDU. @@ -226,7 +226,7 @@ EFI_STATUS @param[in] InBuffer A pointer to the input parameters. @param[in] InBufferLength Size, in bytes, of input parameters. @param[out] OutBuffer A pointer to the output parameters. - @param[in, out] OutBufferLength On input, maximal size, in bytes, to store output + @param[in,out] OutBufferLength On input, maximal size, in bytes, to store output parameters. On output, the size, in bytes, of output parameters. @@ -271,7 +271,7 @@ EFI_STATUS @param[in] Attrib Identifier for the attribute to retrieve. @param[out] OutBuffer A pointer to a buffer that will contain attribute data. - @param[in, out] OutBufferLength On input, maximal size, in bytes, to store + @param[in,out] OutBufferLength On input, maximal size, in bytes, to store attribute data. On output, the size, in bytes, of attribute data. diff --git a/MdePkg/Include/Protocol/Smbios.h b/MdePkg/Include/Protocol/Smbios.h index f9346aac7224..83e8065f6fa3 100644 --- a/MdePkg/Include/Protocol/Smbios.h +++ b/MdePkg/Include/Protocol/Smbios.h @@ -97,7 +97,7 @@ typedef struct _EFI_SMBIOS_PROTOCOL EFI_SMBIOS_PROTOCOL; @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 + @param[in,out] SmbiosHandle On entry, the handle of the SMBIOS record to add. If FFFEh, then a unique handle will be assigned to the SMBIOS record. If the SMBIOS handle is already in use, EFI_ALREADY_STARTED is returned and the SMBIOS record is not updated. @param[in] Record The data for the fixed portion of the SMBIOS record. The format of the record is @@ -168,7 +168,7 @@ EFI_STATUS 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 + @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 handle will be returned. If it returns FFFEh on exit, then there are no more SMBIOS records. @param[in] Type On entry, it points to the type of the next SMBIOS record to return. If NULL, it diff --git a/MdePkg/Include/Protocol/SmmSwDispatch2.h b/MdePkg/Include/Protocol/SmmSwDispatch2.h index d0db953f06b0..27e91b5fb80f 100644 --- a/MdePkg/Include/Protocol/SmmSwDispatch2.h +++ b/MdePkg/Include/Protocol/SmmSwDispatch2.h @@ -60,7 +60,7 @@ typedef struct _EFI_SMM_SW_DISPATCH2_PROTOCOL EFI_SMM_SW_DISPATCH2_PROTOCOL; @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, out] RegisterContext Pointer to the dispatch function's context. + @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 function which Software SMI input value the diff --git a/MdePkg/Include/Protocol/SuperIo.h b/MdePkg/Include/Protocol/SuperIo.h index 802615030c91..bc7655e27281 100644 --- a/MdePkg/Include/Protocol/SuperIo.h +++ b/MdePkg/Include/Protocol/SuperIo.h @@ -45,7 +45,7 @@ typedef struct _EFI_SIO_PROTOCOL EFI_SIO_PROTOCOL; The Super I/O driver must track the current state of the Super I/O and enable the configuration mode of Super I/O if necessary prior to register access. @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 + @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. diff --git a/MdePkg/Include/Protocol/Supplicant.h b/MdePkg/Include/Protocol/Supplicant.h index d78622112583..0c44673482b5 100644 --- a/MdePkg/Include/Protocol/Supplicant.h +++ b/MdePkg/Include/Protocol/Supplicant.h @@ -311,7 +311,7 @@ typedef struct { RequestBuffer is NULL. @param[out] Buffer Pointer to the buffer to hold the built packet. - @param[in, out] BufferSize Pointer to the buffer size in bytes. On + @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. @@ -347,7 +347,7 @@ EFI_STATUS @param[in] This Pointer to the EFI_SUPPLICANT_PROTOCOL instance. - @param[in, out] FragmentTable Pointer to a list of fragment. The caller + @param[in,out] FragmentTable Pointer to a list of fragment. The caller will take responsible to handle the original FragmentTable while it may be reallocated in Supplicant driver. @@ -410,7 +410,7 @@ EFI_STATUS @param[in] DataType The type of data. @param[out] Data Pointer to the buffer to hold the data. Ignored if DataSize is 0. - @param[in, out] DataSize Pointer to the buffer size in bytes. On + @param[in,out] DataSize 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. diff --git a/MdePkg/Include/Protocol/Tcg2Protocol.h b/MdePkg/Include/Protocol/Tcg2Protocol.h index f1326a5ef022..7199b6407666 100644 --- a/MdePkg/Include/Protocol/Tcg2Protocol.h +++ b/MdePkg/Include/Protocol/Tcg2Protocol.h @@ -143,7 +143,7 @@ typedef struct tdEFI_TCG2_EVENT { capability information and state information. @param[in] This Indicates the calling context - @param[in, out] ProtocolCapability The caller allocates memory for a EFI_TCG2_BOOT_SERVICE_CAPABILITY + @param[in,out] ProtocolCapability The caller allocates memory for a EFI_TCG2_BOOT_SERVICE_CAPABILITY structure and sets the size field to the size of the structure allocated. The callee fills in the fields with the EFI protocol capability information and the current EFI TCG2 state information up to the number of fields which diff --git a/MdePkg/Include/Protocol/Tls.h b/MdePkg/Include/Protocol/Tls.h index edcf0e3e728c..24c902530b44 100644 --- a/MdePkg/Include/Protocol/Tls.h +++ b/MdePkg/Include/Protocol/Tls.h @@ -376,8 +376,8 @@ EFI_STATUS @param[in] This Pointer to the EFI_TLS_PROTOCOL instance. @param[in] DataType TLS session data type. - @param[in, out] Data Pointer to session data. - @param[in, out] DataSize Total size of session data. On input, it means + @param[in,out] Data Pointer to session data. + @param[in,out] DataSize Total size of session data. On input, it means the size of Data buffer. On output, it means the size of copied Data buffer if EFI_SUCCESS, and means the size of desired Data buffer if EFI_BUFFER_TOO_SMALL. @@ -422,7 +422,7 @@ EFI_STATUS @param[in] RequestSize Packet size in bytes for the most recently received TLS packet. 0 is only valid when RequestBuffer is NULL. @param[out] Buffer Pointer to the buffer to hold the built packet. - @param[in, out] BufferSize Pointer to the buffer size in bytes. On input, it is + @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. @@ -456,7 +456,7 @@ EFI_STATUS The ProcessPacket () function process each inbound or outbound TLS APP packet. @param[in] This Pointer to the EFI_TLS_PROTOCOL instance. - @param[in, out] FragmentTable Pointer to a list of fragment. The caller will take + @param[in,out] FragmentTable Pointer to a list of fragment. The caller will take responsible to handle the original FragmentTable while it may be reallocated in TLS driver. If CryptMode is EfiTlsEncrypt, on input these fragments contain the TLS diff --git a/MdePkg/Include/Protocol/TlsConfig.h b/MdePkg/Include/Protocol/TlsConfig.h index 8b2a94d41f8e..9b9019338757 100644 --- a/MdePkg/Include/Protocol/TlsConfig.h +++ b/MdePkg/Include/Protocol/TlsConfig.h @@ -87,8 +87,8 @@ EFI_STATUS @param[in] This Pointer to the EFI_TLS_CONFIGURATION_PROTOCOL instance. @param[in] DataType Configuration data type. - @param[in, out] Data Pointer to configuration data. - @param[in, out] DataSize Total size of configuration data. On input, it means + @param[in,out] Data Pointer to configuration data. + @param[in,out] DataSize Total size of configuration data. On input, it means the size of Data buffer. On output, it means the size of copied Data buffer if EFI_SUCCESS, and means the size of desired Data buffer if EFI_BUFFER_TOO_SMALL. diff --git a/MdePkg/Include/Protocol/UfsDeviceConfig.h b/MdePkg/Include/Protocol/UfsDeviceConfig.h index 34676c7831c5..ae0253ae4f64 100644 --- a/MdePkg/Include/Protocol/UfsDeviceConfig.h +++ b/MdePkg/Include/Protocol/UfsDeviceConfig.h @@ -34,8 +34,8 @@ typedef struct _EFI_UFS_DEVICE_CONFIG_PROTOCOL EFI_UFS_DEVICE_CONFIG_PROTOCOL; @param[in] DescId The ID of device descriptor. @param[in] Index The Index of device descriptor. @param[in] Selector The Selector of device descriptor. - @param[in, out] Descriptor The buffer of device descriptor to be read or written. - @param[in, out] DescSize The size of device descriptor buffer. On input, the size, in bytes, + @param[in,out] Descriptor The buffer of device descriptor to be read or written. + @param[in,out] DescSize The size of device descriptor buffer. On input, the size, in bytes, of the data buffer specified by Descriptor. On output, the number of bytes that were actually transferred. @@ -68,7 +68,7 @@ EFI_STATUS @param[in] This The pointer to the EFI_UFS_DEVICE_CONFIG_PROTOCOL instance. @param[in] Read The boolean variable to show r/w direction. @param[in] FlagId The ID of flag to be read or written. - @param[in, out] Flag The buffer to set or clear flag. + @param[in,out] Flag The buffer to set or clear flag. @retval EFI_SUCCESS The flag descriptor is set/clear successfully. @retval EFI_INVALID_PARAMETER This is NULL or Flag is NULL. @@ -96,8 +96,8 @@ EFI_STATUS @param[in] AttrId The ID of Attribute. @param[in] Index The Index of Attribute. @param[in] Selector The Selector of Attribute. - @param[in, out] Attribute The buffer of Attribute to be read or written. - @param[in, out] AttrSize The size of Attribute buffer. On input, the size, in bytes, of the + @param[in,out] Attribute The buffer of Attribute to be read or written. + @param[in,out] AttrSize The size of Attribute buffer. On input, the size, in bytes, of the data buffer specified by Attribute. On output, the number of bytes that were actually transferred. diff --git a/MdePkg/Include/Protocol/UsbFunctionIo.h b/MdePkg/Include/Protocol/UsbFunctionIo.h index e360b604808e..3b0fcba69806 100644 --- a/MdePkg/Include/Protocol/UsbFunctionIo.h +++ b/MdePkg/Include/Protocol/UsbFunctionIo.h @@ -343,7 +343,7 @@ EFI_STATUS @param[in] This A pointer to the EFI_USBFN_IO_PROTOCOL instance. @param[in] EndpointIndex Indicates the endpoint. @param[in] Direction Direction of the endpoint. - @param[in, out] State Boolean, true value indicates that the endpoint + @param[in,out] State Boolean, true value indicates that the endpoint is in a stalled state, false otherwise. @retval EFI_SUCCESS The function returned successfully. @@ -402,7 +402,7 @@ EFI_STATUS @param[in] This A pointer to the EFI_USBFN_IO_PROTOCOL instance. @param[out] Message Indicates the event that initiated this notification. - @param[in, out] PayloadSize On input, the size of the memory pointed by + @param[in,out] PayloadSize On input, the size of the memory pointed by Payload. On output, the amount ofdata returned in Payload. @param[out] Payload A pointer to EFI_USBFN_MESSAGE_PAYLOAD instance @@ -446,14 +446,14 @@ EFI_STATUS @param[in] EndpointIndex Indicates the endpoint on which TX or RX transfer needs to take place. @param[in] Direction Direction of the endpoint. - @param[in, out] BufferSize If Direction is EfiUsbEndpointDirectionDeviceRx: + @param[in,out] BufferSize If Direction is EfiUsbEndpointDirectionDeviceRx: On input, the size of the Bufferin bytes. On output, the amount of data returned in Buffer in bytes. If Direction is EfiUsbEndpointDirectionDeviceTx: On input, the size of the Bufferin bytes. On output, the amount of data transmitted in bytes. - @param[in, out] Buffer If Direction is EfiUsbEndpointDirectionDeviceRx: + @param[in,out] Buffer If Direction is EfiUsbEndpointDirectionDeviceRx: The Buffer to return the received data. If Directionis EfiUsbEndpointDirectionDeviceTx: The Buffer that contains the data to be transmitted. @@ -630,9 +630,9 @@ EFI_STATUS @param[in] Direction Direction of the endpoint. @param[in] PolicyType Policy type the user is trying to retrieve for the specified non-control endpoint. - @param[in, out] BufferSize On input, the size of Bufferin bytes. On output, + @param[in,out] BufferSize On input, the size of Bufferin bytes. On output, the amount of data returned in Bufferin bytes. - @param[in, out] Buffer A pointer to a buffer to return requested endpoint + @param[in,out] Buffer A pointer to a buffer to return requested endpoint policy value. @retval EFI_SUCCESS The function returned successfully. diff --git a/MdePkg/Include/Protocol/UserCredential.h b/MdePkg/Include/Protocol/UserCredential.h index 986cf44994f1..d1d957330493 100644 --- a/MdePkg/Include/Protocol/UserCredential.h +++ b/MdePkg/Include/Protocol/UserCredential.h @@ -83,10 +83,10 @@ EFI_STATUS 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 + @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 bitmap returned. - @param[in, out] Height On entry, points to the desired bitmap height. If NULL then no bitmap + @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. diff --git a/MdePkg/Include/Protocol/UserCredential2.h b/MdePkg/Include/Protocol/UserCredential2.h index fc64ba544a2b..caec534d61ef 100644 --- a/MdePkg/Include/Protocol/UserCredential2.h +++ b/MdePkg/Include/Protocol/UserCredential2.h @@ -81,10 +81,10 @@ EFI_STATUS 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 + @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 bitmap returned. - @param[in, out] Height On entry, points to the desired bitmap height. If NULL then no bitmap + @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. diff --git a/MdePkg/Include/Uefi/UefiSpec.h b/MdePkg/Include/Uefi/UefiSpec.h index 7dfe35b4990b..516f4222d480 100644 --- a/MdePkg/Include/Uefi/UefiSpec.h +++ b/MdePkg/Include/Uefi/UefiSpec.h @@ -169,7 +169,7 @@ typedef struct { 0x80000000..0xFFFFFFFF are reserved for use by UEFI OS loaders that are provided by operating system vendors. @param[in] Pages The number of contiguous 4 KB pages to allocate. - @param[in, out] Memory The pointer to a physical address. On input, the way in which the address is + @param[in,out] Memory The pointer to a physical address. On input, the way in which the address is used depends on the value of Type. @retval EFI_SUCCESS The requested pages were allocated. @@ -214,7 +214,7 @@ EFI_STATUS /** Returns the current memory map. - @param[in, out] MemoryMapSize A pointer to the size, in bytes, of the MemoryMap buffer. + @param[in,out] MemoryMapSize A pointer to the size, in bytes, of the MemoryMap buffer. On input, this is the size of the buffer allocated by the caller. On output, it is the size of the buffer returned by the firmware if the buffer was large enough, or the size of the buffer needed to contain @@ -391,7 +391,7 @@ EFI_STATUS Determines the new virtual address that is to be used on subsequent memory accesses. @param[in] DebugDisposition Supplies type information for the pointer being converted. - @param[in, out] Address A pointer to a pointer that is to be fixed to be the value needed + @param[in,out] Address A pointer to a pointer that is to be fixed to be the value needed for the new virtual address mappings being applied. @retval EFI_SUCCESS The pointer pointed to by Address was modified. @@ -650,7 +650,7 @@ VOID @param[in] VendorGuid A unique identifier for the vendor. @param[out] Attributes If not NULL, a pointer to the memory location to return the attributes bitmask for the variable. - @param[in, out] DataSize On input, the size in bytes of the return Data buffer. + @param[in,out] DataSize On input, the size in bytes of the return Data buffer. On output the size of data returned in Data. @param[out] Data The buffer to return the contents of the variable. May be NULL with a zero DataSize in order to determine the size buffer needed. @@ -679,12 +679,12 @@ EFI_STATUS /** Enumerates the current variable names. - @param[in, out] VariableNameSize The size of the VariableName buffer. The size must be large + @param[in,out] VariableNameSize The size of the VariableName buffer. The size must be large enough to fit input string supplied in VariableName buffer. - @param[in, out] VariableName On input, supplies the last VariableName that was returned + @param[in,out] VariableName On input, supplies the last VariableName that was returned by GetNextVariableName(). On output, returns the Nullterminated string of the current variable. - @param[in, out] VendorGuid On input, supplies the last VendorGuid that was returned by + @param[in,out] VendorGuid On input, supplies the last VendorGuid that was returned by GetNextVariableName(). On output, returns the VendorGuid of the current variable. @@ -1155,7 +1155,7 @@ typedef enum { InstallMultipleProtocolInterfaces() be used in place of InstallProtocolInterface() - @param[in, out] Handle A pointer to the EFI_HANDLE on which the interface is to be installed. + @param[in,out] Handle A pointer to the EFI_HANDLE on which the interface is to be installed. @param[in] Protocol The numeric ID of the protocol interface. @param[in] InterfaceType Indicates whether Interface is supplied in native form. @param[in] Interface A pointer to the protocol interface. @@ -1180,7 +1180,7 @@ EFI_STATUS /** Installs one or more protocol interfaces into the boot services environment. - @param[in, out] Handle The pointer to a handle to install the new protocol interfaces on, + @param[in,out] Handle The pointer to a handle to install the new protocol interfaces on, or a pointer to NULL if a new handle is to be allocated. @param ... A variable argument list containing pairs of protocol GUIDs and protocol interfaces. @@ -1479,7 +1479,7 @@ typedef enum { @param[in] SearchType Specifies which handle(s) are to be returned. @param[in] Protocol Specifies the protocol to search by. @param[in] SearchKey Specifies the search key. - @param[in, out] BufferSize On input, the size in bytes of Buffer. On output, the size in bytes of + @param[in,out] BufferSize On input, the size in bytes of Buffer. On output, the size in bytes of the array returned in Buffer (if the buffer was large enough) or the size, in bytes, of the buffer needed to obtain the array (if the buffer was not large enough). @@ -1509,7 +1509,7 @@ EFI_STATUS Locates the handle to a device on the device path that supports the specified protocol. @param[in] Protocol Specifies the protocol to search for. - @param[in, out] DevicePath On input, a pointer to a pointer to the device path. On output, the device + @param[in,out] DevicePath On input, a pointer to a pointer to the device path. On output, the device path pointer is modified to point to the remaining part of the device path. @param[out] Device A pointer to the returned device handle. diff --git a/MdePkg/Library/BaseExtractGuidedSectionLib/BaseExtractGuidedSectionLib.c b/MdePkg/Library/BaseExtractGuidedSectionLib/BaseExtractGuidedSectionLib.c index e6f479b829f6..dfdee0b5d2c0 100644 --- a/MdePkg/Library/BaseExtractGuidedSectionLib/BaseExtractGuidedSectionLib.c +++ b/MdePkg/Library/BaseExtractGuidedSectionLib/BaseExtractGuidedSectionLib.c @@ -28,7 +28,7 @@ typedef struct { the registered guid and Handler list. When it is initialized, it will be directly returned. Or, HandlerInfo table will be initialized in this function. - @param[in, out] InfoPointer The pointer to the handler information structure. + @param[in,out] InfoPointer The pointer to the handler information structure. @retval RETURN_SUCCESS HandlerInfo table can be used to store guid and function tables. @retval RETURN_OUT_OF_RESOURCES HandlerInfo table address is not writable. diff --git a/MdePkg/Library/BaseLib/QuickSort.c b/MdePkg/Library/BaseLib/QuickSort.c index d9f0e9a0f475..a7b7d0c6cd2b 100644 --- a/MdePkg/Library/BaseLib/QuickSort.c +++ b/MdePkg/Library/BaseLib/QuickSort.c @@ -22,7 +22,7 @@ if Count is < 2 then perform no action. - @param[in, out] BufferToSort on call a Buffer of (possibly sorted) elements + @param[in,out] BufferToSort on call a Buffer of (possibly sorted) elements on return a buffer of sorted elements @param[in] Count the number of elements in the buffer to sort @param[in] ElementSize Size of an element in bytes diff --git a/MdePkg/Library/BasePcdLibNull/PcdLib.c b/MdePkg/Library/BasePcdLibNull/PcdLib.c index a214371c3fdf..39303cf429a7 100644 --- a/MdePkg/Library/BasePcdLibNull/PcdLib.c +++ b/MdePkg/Library/BasePcdLibNull/PcdLib.c @@ -470,7 +470,7 @@ LibPcdSet64S ( 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,out] SizeOfBuffer The size, in bytes, of Buffer. @param[in] Buffer A pointer to the buffer to set. @return The status of the set operation. @@ -645,7 +645,7 @@ LibPcdSetEx64S ( @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. + @param[in,out] SizeOfBuffer The size, in bytes, of Buffer. @param[in] Buffer A pointer to the buffer to set. @return The status of the set operation. @@ -819,7 +819,7 @@ LibPcdGetNextTokenSpace ( @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,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. @@ -870,7 +870,7 @@ LibPatchPcdSetPtr ( @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,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. @@ -923,7 +923,7 @@ LibPatchPcdSetPtrS ( 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,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 been set. @@ -979,7 +979,7 @@ LibPatchPcdSetPtrAndSize ( 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,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/MdePkg/Library/BasePeCoffLib/LoongArch/PeCoffLoaderEx.c b/MdePkg/Library/BasePeCoffLib/LoongArch/PeCoffLoaderEx.c index 417096f33493..63339fb4a627 100644 --- a/MdePkg/Library/BasePeCoffLib/LoongArch/PeCoffLoaderEx.c +++ b/MdePkg/Library/BasePeCoffLib/LoongArch/PeCoffLoaderEx.c @@ -14,8 +14,8 @@ instruction sets. @param[in] Reloc Pointer to the relocation record. - @param[in, out] Fixup Pointer to the address to fix up. - @param[in, out] FixupData Pointer to a buffer to log the fixups. + @param[in,out] Fixup Pointer to the address to fix up. + @param[in,out] FixupData Pointer to a buffer to log the fixups. @param[in] Adjust The offset to adjust the fixup. @return Status code. @@ -117,8 +117,8 @@ PeCoffLoaderImageFormatSupported ( space for runtime calls. @param[in] Reloc The pointer to the relocation record. - @param[in, out] Fixup The pointer to the address to fix up. - @param[in, out] FixupData The pointer to a buffer to log the fixups. + @param[in,out] Fixup The pointer to the address to fix up. + @param[in,out] FixupData The pointer to a buffer to log the fixups. @param[in] Adjust The offset to adjust the fixup. @return Status code. diff --git a/MdePkg/Library/DxePcdLib/DxePcdLib.c b/MdePkg/Library/DxePcdLib/DxePcdLib.c index b2a8bf22a365..c371f26f24c1 100644 --- a/MdePkg/Library/DxePcdLib/DxePcdLib.c +++ b/MdePkg/Library/DxePcdLib/DxePcdLib.c @@ -554,7 +554,7 @@ LibPcdSet64S ( 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,out] SizeOfBuffer The size, in bytes, of Buffer. @param[in] Buffer A pointer to the buffer to set. @return The status of the set operation. @@ -731,7 +731,7 @@ LibPcdSetEx64S ( @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. + @param[in,out] SizeOfBuffer The size, in bytes, of Buffer. @param[in] Buffer A pointer to the buffer to set. @return The status of the set operation. @@ -926,7 +926,7 @@ LibPcdGetNextTokenSpace ( @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,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 been set. @@ -977,7 +977,7 @@ LibPatchPcdSetPtr ( @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,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. @@ -1030,7 +1030,7 @@ LibPatchPcdSetPtrS ( 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,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 been set. @@ -1086,7 +1086,7 @@ LibPatchPcdSetPtrAndSize ( 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,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/MdePkg/Library/PeiExtractGuidedSectionLib/PeiExtractGuidedSectionLib.c b/MdePkg/Library/PeiExtractGuidedSectionLib/PeiExtractGuidedSectionLib.c index c538f157a242..2436e2c8f62e 100644 --- a/MdePkg/Library/PeiExtractGuidedSectionLib/PeiExtractGuidedSectionLib.c +++ b/MdePkg/Library/PeiExtractGuidedSectionLib/PeiExtractGuidedSectionLib.c @@ -28,7 +28,7 @@ typedef struct { Build guid hob for the global memory to store the registered guid and Handler list. If GuidHob exists, HandlerInfo will be directly got from Guid hob data. - @param[in, out] InfoPointer The pointer to pei handler information structure. + @param[in,out] InfoPointer The pointer to pei handler information structure. @retval RETURN_SUCCESS Build Guid hob for the global memory space to store guid and function tables. @retval RETURN_OUT_OF_RESOURCES No enough memory to allocated. diff --git a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c index 166d4a6f32d0..f16c1f8715a0 100644 --- a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c +++ b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c @@ -544,7 +544,7 @@ LibPcdSet64S ( 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,out] SizeOfBuffer The size, in bytes, of Buffer. @param[in] Buffer A pointer to the buffer to set. @return The status of the set operation. @@ -721,7 +721,7 @@ LibPcdSetEx64S ( @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. + @param[in,out] SizeOfBuffer The size, in bytes, of Buffer. @param[in] Buffer A pointer to the buffer to set. @return The status of the set operation. @@ -918,7 +918,7 @@ LibPcdGetNextTokenSpace ( @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,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 been set. @@ -969,7 +969,7 @@ LibPatchPcdSetPtr ( @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,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. @@ -1022,7 +1022,7 @@ LibPatchPcdSetPtrS ( 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,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 been set. @@ -1078,7 +1078,7 @@ LibPatchPcdSetPtrAndSize ( 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,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/MdePkg/Library/SmmIoLib/SmmIoLib.c b/MdePkg/Library/SmmIoLib/SmmIoLib.c index ad4bfff68c8a..070a0c4f7b2a 100644 --- a/MdePkg/Library/SmmIoLib/SmmIoLib.c +++ b/MdePkg/Library/SmmIoLib/SmmIoLib.c @@ -155,9 +155,9 @@ SmmIsMmioValid ( /** Merge continuous entries whose type is EfiGcdMemoryTypeMemoryMappedIo. - @param[in, out] GcdMemoryMap A pointer to the buffer in which firmware places + @param[in,out] GcdMemoryMap A pointer to the buffer in which firmware places the current GCD memory map. - @param[in, out] NumberOfDescriptors A pointer to the number of the + @param[in,out] NumberOfDescriptors A pointer to the number of the GcdMemoryMap buffer. On input, this is the number of the current GCD memory map. On output, it is the number of new GCD memory map after merge. diff --git a/MdePkg/Library/SmmPeriodicSmiLib/SmmPeriodicSmiLib.c b/MdePkg/Library/SmmPeriodicSmiLib/SmmPeriodicSmiLib.c index ff143f00ab9a..1ba604b0cdda 100644 --- a/MdePkg/Library/SmmPeriodicSmiLib/SmmPeriodicSmiLib.c +++ b/MdePkg/Library/SmmPeriodicSmiLib/SmmPeriodicSmiLib.c @@ -723,7 +723,7 @@ PeriodicSmiDispatchFunctionOnCpu ( released to notify the CPU that is running the SMM Foundation that the periodic SMI handler execution has finished its execution. - @param[in, out] Buffer A pointer to the context for the periodic SMI handler. + @param[in,out] Buffer A pointer to the context for the periodic SMI handler. **/ VOID @@ -758,10 +758,10 @@ PeriodicSmiDispatchFunctionWithLock ( SmiHandlerRegister(). @param[in] Context Points to an optional handler context which was specified when the handler was registered. - @param[in, out] CommBuffer A pointer to a collection of data in memory that + @param[in,out] CommBuffer A pointer to a collection of data in memory that will be conveyed from a non-SMM environment into an SMM environment. - @param[in, out] CommBufferSize The size of the CommBuffer. + @param[in,out] CommBufferSize The size of the CommBuffer. @retval EFI_SUCCESS The interrupt was handled and quiesced. No other handlers should still be called. @@ -863,7 +863,7 @@ PeriodicSmiDispatchFunction ( /** This function enables a periodic SMI handler. - @param[in, out] DispatchHandle A pointer to the handle associated with the + @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, diff --git a/MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.c b/MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.c index 86678e965d99..8fe52cab316f 100644 --- a/MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.c +++ b/MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.c @@ -697,8 +697,8 @@ FileHandleSetSize ( if Destination's current length (including NULL terminator) is already more then CurrentSize, then ASSERT() - @param[in, out] Destination The String to append onto - @param[in, out] CurrentSize on call the number of bytes in Destination. On + @param[in,out] Destination The String to append onto + @param[in,out] CurrentSize on call the number of bytes in Destination. On return possibly the new size (still in bytes). if NULL then allocate whatever is needed. @param[in] Source The String to append from @@ -907,7 +907,7 @@ FileHandleGetFileName ( maintained and not changed for all operations with the same file. @param[in] Handle FileHandle to read from. - @param[in, out] Ascii Boolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE); + @param[in,out] Ascii Boolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE); @return The line of text from the file. @@ -951,15 +951,15 @@ FileHandleReturnLine ( read a CHAR_NULL character will be returned in buffer. @param[in] Handle FileHandle to read from. - @param[in, out] Buffer The pointer to buffer to read into. - @param[in, out] Size The pointer to number of bytes in Buffer. + @param[in,out] Buffer The pointer to buffer to read into. + @param[in,out] Size The pointer to number of bytes in Buffer. @param[in] Truncate If the buffer is large enough, this has no effect. If the buffer is is too small and Truncate is TRUE, the line will be truncated. If the buffer is is too small and Truncate is FALSE, then no read will occur. - @param[in, out] Ascii Boolean value for indicating whether the file is + @param[in,out] Ascii Boolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE). @retval EFI_SUCCESS The operation was successful. The line is stored in diff --git a/MdePkg/Library/UefiScsiLib/UefiScsiLib.c b/MdePkg/Library/UefiScsiLib/UefiScsiLib.c index a33cadd71646..af74ab732b21 100644 --- a/MdePkg/Library/UefiScsiLib/UefiScsiLib.c +++ b/MdePkg/Library/UefiScsiLib/UefiScsiLib.c @@ -81,12 +81,12 @@ typedef struct { is greater than zero, then this function will return EFI_TIMEOUT if the time required to execute the SCSI Request Packet is greater than Timeout. - @param[in, out] SenseData A pointer to sense data that was generated by + @param[in,out] SenseData A pointer to sense data that was generated by the execution of the SCSI Request Packet. This buffer must be allocated by the caller. If SenseDataLength is 0, then this parameter is optional and may be NULL. - @param[in, out] SenseDataLength On input, a pointer to the length in bytes of + @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. @param[out] HostAdapterStatus The status of the SCSI Host Controller that produces @@ -199,12 +199,12 @@ ScsiTestUnitReadyCommand ( If Timeout is greater than zero, then this function will return EFI_TIMEOUT if the time required to execute the SCSI Request Packet is greater than Timeout. - @param[in, out] SenseData A pointer to sense data that was generated + @param[in,out] SenseData A pointer to sense data that was generated by the execution of the SCSI Request Packet. This buffer must be allocated by the caller. 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. + @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. @param[out] HostAdapterStatus The status of the SCSI Host Controller that produces the SCSI bus containing the SCSI @@ -218,12 +218,12 @@ ScsiTestUnitReadyCommand ( See the EFI SCSI I/O Protocol in the UEFI Specification for details on the possible return values. - @param[in, out] InquiryDataBuffer A pointer to inquiry data that was generated + @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. - @param[in, out] InquiryDataLength On input, a pointer to the length in bytes + @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 written to the InquiryDataBuffer buffer. @@ -347,12 +347,12 @@ ScsiInquiryCommandEx ( If Timeout is greater than zero, then this function will return EFI_TIMEOUT if the time required to execute the SCSI Request Packet is greater than Timeout. - @param[in, out] SenseData A pointer to sense data that was generated + @param[in,out] SenseData A pointer to sense data that was generated by the execution of the SCSI Request Packet. This buffer must be allocated by the caller. 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. + @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. @param[out] HostAdapterStatus The status of the SCSI Host Controller that produces the SCSI bus containing the SCSI @@ -366,12 +366,12 @@ ScsiInquiryCommandEx ( See the EFI SCSI I/O Protocol in the UEFI Specification for details on the possible return values. - @param[in, out] InquiryDataBuffer A pointer to inquiry data that was generated + @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. - @param[in, out] InquiryDataLength On input, a pointer to the length in bytes + @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 written to the InquiryDataBuffer buffer. @@ -464,12 +464,12 @@ ScsiInquiryCommand ( If Timeout is greater than zero, then this function will return EFI_TIMEOUT if the time required to execute the SCSI Request Packet is greater than Timeout. - @param[in, out] SenseData A pointer to sense data that was generated + @param[in,out] SenseData A pointer to sense data that was generated by the execution of the SCSI Request Packet. This buffer must be allocated by the caller. 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. + @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. @param[out] HostAdapterStatus The status of the SCSI Host Controller that produces the SCSI bus containing the SCSI target @@ -482,12 +482,12 @@ ScsiInquiryCommand ( on the SCSI Host Controller. See the EFI SCSI I/O Protocol in the UEFI Specification for details on the possible return values. - @param[in, out] DataBuffer A pointer to data that was generated by the + @param[in,out] DataBuffer A pointer to data that was generated by the 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. - @param[in, out] DataLength On input, a pointer to the length in bytes of + @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. @@ -602,8 +602,8 @@ ScsiModeSense10Command ( @param[in] ScsiIo A pointer to SCSI IO protocol. @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. @@ -687,12 +687,12 @@ ScsiRequestSenseCommand ( @param[in] ScsiIo A pointer to SCSI IO protocol. @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. - @param[in, out] DataBuffer A pointer to a data buffer. - @param[in, out] DataLength The length of data buffer. + @param[in,out] DataBuffer A pointer to a data buffer. + @param[in,out] DataLength The length of data buffer. @param[in] Pmi Partial medium indicator. @retval EFI_SUCCESS Command is executed successfully. @@ -790,12 +790,12 @@ ScsiReadCapacityCommand ( @param[in] ScsiIo A pointer to SCSI IO protocol. @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. - @param[in, out] DataBuffer A pointer to a data buffer. - @param[in, out] DataLength The length of data buffer. + @param[in,out] DataBuffer A pointer to a data buffer. + @param[in,out] DataLength The length of data buffer. @param[in] Pmi Partial medium indicator. @retval EFI_SUCCESS Command is executed successfully. @@ -896,12 +896,12 @@ ScsiReadCapacity16Command ( @param[in] ScsiIo A pointer to SCSI IO protocol. @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. - @param[in, out] DataBuffer Read 10 command data. - @param[in, out] DataLength The length of data buffer. + @param[in,out] DataBuffer Read 10 command data. + @param[in,out] DataLength The length of data buffer. @param[in] StartLba The start address of LBA. @param[in] SectorSize The number of contiguous logical blocks of data that shall be transferred. @@ -995,12 +995,12 @@ ScsiRead10Command ( @param[in] ScsiIo SCSI IO Protocol to use @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. - @param[in, out] DataBuffer A pointer to a data buffer. - @param[in, out] DataLength The length of data buffer. + @param[in,out] DataBuffer A pointer to a data buffer. + @param[in,out] DataLength The length of data buffer. @param[in] StartLba The start address of LBA. @param[in] SectorSize The number of contiguous logical blocks of data that shall be transferred. @@ -1095,12 +1095,12 @@ ScsiWrite10Command ( @param[in] ScsiIo A pointer to SCSI IO protocol. @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. - @param[in, out] DataBuffer Read 16 command data. - @param[in, out] DataLength The length of data buffer. + @param[in,out] DataBuffer Read 16 command data. + @param[in,out] DataLength The length of data buffer. @param[in] StartLba The start address of LBA. @param[in] SectorSize The number of contiguous logical blocks of data that shall be transferred. @@ -1194,12 +1194,12 @@ ScsiRead16Command ( @param[in] ScsiIo SCSI IO Protocol to use @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. - @param[in, out] DataBuffer A pointer to a data buffer. - @param[in, out] DataLength The length of data buffer. + @param[in,out] DataBuffer A pointer to a data buffer. + @param[in,out] DataLength The length of data buffer. @param[in] StartLba The start address of LBA. @param[in] SectorSize The number of contiguous logical blocks of data that shall be transferred. @@ -1293,8 +1293,8 @@ ScsiWrite16Command ( @param[in] ScsiIo SCSI IO Protocol to use. @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. @param[in] SecurityProtocol The Security Protocol to use. @@ -1302,7 +1302,7 @@ ScsiWrite16Command ( @param[in] Inc512 If TRUE, 512 increment (INC_512) bit will be set for the SECURITY PROTOCOL IN command. @param[in] DataLength The size in bytes of the data buffer. - @param[in, out] DataBuffer A pointer to a data buffer. + @param[in,out] DataBuffer A pointer to a data buffer. @param[out] TransferLength A pointer to a buffer to store the size in bytes of the data written to the data buffer. @@ -1408,8 +1408,8 @@ ScsiSecurityProtocolInCommand ( @param[in] ScsiIo SCSI IO Protocol to use. @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. @param[in] SecurityProtocol The Security Protocol to use. @@ -1417,7 +1417,7 @@ ScsiSecurityProtocolInCommand ( @param[in] Inc512 If TRUE, 512 increment (INC_512) bit will be set for the SECURITY PROTOCOL OUT command. @param[in] DataLength The size in bytes of the transfer data. - @param[in, out] DataBuffer A pointer to a data buffer. + @param[in,out] DataBuffer A pointer to a data buffer. @retval EFI_SUCCESS Command is executed successfully. @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire DataBuffer could @@ -1573,12 +1573,12 @@ ScsiLibNotify ( @param[in] ScsiIo A pointer to SCSI IO protocol. @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. - @param[in, out] DataBuffer Read 16 command data. - @param[in, out] DataLength The length of data buffer. + @param[in,out] DataBuffer Read 16 command data. + @param[in,out] DataLength The length of data buffer. @param[in] StartLba The start address of LBA. @param[in] SectorSize The number of contiguous logical blocks of data that shall be transferred. @@ -1756,12 +1756,12 @@ ScsiRead10CommandEx ( @param[in] ScsiIo SCSI IO Protocol to use @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. - @param[in, out] DataBuffer A pointer to a data buffer. - @param[in, out] DataLength The length of data buffer. + @param[in,out] DataBuffer A pointer to a data buffer. + @param[in,out] DataLength The length of data buffer. @param[in] StartLba The start address of LBA. @param[in] SectorSize The number of contiguous logical blocks of data that shall be transferred. @@ -1939,12 +1939,12 @@ ScsiWrite10CommandEx ( @param[in] ScsiIo A pointer to SCSI IO protocol. @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. - @param[in, out] DataBuffer Read 16 command data. - @param[in, out] DataLength The length of data buffer. + @param[in,out] DataBuffer Read 16 command data. + @param[in,out] DataLength The length of data buffer. @param[in] StartLba The start address of LBA. @param[in] SectorSize The number of contiguous logical blocks of data that shall be transferred. @@ -2122,12 +2122,12 @@ ScsiRead16CommandEx ( @param[in] ScsiIo SCSI IO Protocol to use @param[in] Timeout The length of timeout period. - @param[in, out] SenseData A pointer to output sense data. - @param[in, out] SenseDataLength The length of output sense data. + @param[in,out] SenseData A pointer to output sense data. + @param[in,out] SenseDataLength The length of output sense data. @param[out] HostAdapterStatus The status of Host Adapter. @param[out] TargetStatus The status of the target. - @param[in, out] DataBuffer A pointer to a data buffer. - @param[in, out] DataLength The length of data buffer. + @param[in,out] DataBuffer A pointer to a data buffer. + @param[in,out] DataLength The length of data buffer. @param[in] StartLba The start address of LBA. @param[in] SectorSize The number of contiguous logical blocks of data that shall be transferred. -- 2.30.2