From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=134.134.136.126; helo=mga18.intel.com; envelope-from=star.zeng@intel.com; receiver=edk2-devel@lists.01.org Received: from mga18.intel.com (mga18.intel.com [134.134.136.126]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 70C4D21E49037 for ; Wed, 14 Mar 2018 02:27:44 -0700 (PDT) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga007.jf.intel.com ([10.7.209.58]) by orsmga106.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 14 Mar 2018 02:34:07 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.47,469,1515484800"; d="scan'208";a="24534672" Received: from shwdeopenpsi068.ccr.corp.intel.com ([10.239.158.46]) by orsmga007.jf.intel.com with ESMTP; 14 Mar 2018 02:34:06 -0700 From: Star Zeng To: edk2-devel@lists.01.org Cc: Star Zeng , Ruiyu Ni , Hao Wu Date: Wed, 14 Mar 2018 17:33:57 +0800 Message-Id: <1521020038-102684-6-git-send-email-star.zeng@intel.com> X-Mailer: git-send-email 2.7.0.windows.1 In-Reply-To: <1521020038-102684-1-git-send-email-star.zeng@intel.com> References: <1521020038-102684-1-git-send-email-star.zeng@intel.com> Subject: [PATCH V2 5/6] SourceLevelDebugPkg DebugCommUsb3: Refine some formats/comments X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 14 Mar 2018 09:27:44 -0000 Refine some formats/comments and remove some unused prototypes. Cc: Ruiyu Ni Cc: Hao Wu Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Star Zeng --- .../DebugCommunicationLibUsb3Common.c | 16 ++++---- .../DebugCommunicationLibUsb3Internal.h | 47 +++------------------- 2 files changed, 13 insertions(+), 50 deletions(-) diff --git a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Common.c b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Common.c index 3b0f81cf88fd..37f49ad822f5 100644 --- a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Common.c +++ b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Common.c @@ -85,15 +85,15 @@ XhcClearR32Bit( Write the data to the XHCI debug register. @param Handle Debug port handle. - @param Offset The offset of the runtime register. + @param Offset The offset of the debug register. @param Data The data to write. **/ VOID XhcWriteDebugReg ( IN USB3_DEBUG_PORT_HANDLE *Handle, - IN UINT32 Offset, - IN UINT32 Data + IN UINT32 Offset, + IN UINT32 Data ) { EFI_PHYSICAL_ADDRESS DebugCapabilityBase; @@ -116,7 +116,7 @@ XhcWriteDebugReg ( UINT32 XhcReadDebugReg ( IN USB3_DEBUG_PORT_HANDLE *Handle, - IN UINT32 Offset + IN UINT32 Offset ) { UINT32 Data; @@ -129,16 +129,16 @@ XhcReadDebugReg ( } /** - Set one bit of the runtime register while keeping other bits. + Set one bit of the debug register while keeping other bits. @param Handle Debug port handle. - @param Offset The offset of the runtime register. + @param Offset The offset of the debug register. @param Bit The bit mask of the register to set. **/ VOID XhcSetDebugRegBit ( - IN USB3_DEBUG_PORT_HANDLE *Handle, + IN USB3_DEBUG_PORT_HANDLE *Handle, IN UINT32 Offset, IN UINT32 Bit ) @@ -216,7 +216,7 @@ UpdateXhcResource ( @param Handle Debug port handle. - @retval RETURN_UNSUPPORTED The usb host controller does not supported usb debug port capability. + @retval RETURN_UNSUPPORTED The usb host controller does not support usb debug port capability. @retval RETURN_SUCCESS Get bar and offset successfully. **/ diff --git a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Internal.h b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Internal.h index 356485c5f697..9da49f964401 100644 --- a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Internal.h +++ b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Internal.h @@ -1,7 +1,7 @@ /** @file Debug Port Library implementation based on usb3 debug port. - Copyright (c) 2014 - 2015, Intel Corporation. All rights reserved.
+ Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at @@ -540,7 +540,7 @@ typedef struct _USB3_DEBUG_PORT_INSTANCE { UINT32 XhcReadDebugReg ( IN USB3_DEBUG_PORT_HANDLE *Handle, - IN UINT32 Offset + IN UINT32 Offset ); /** @@ -554,8 +554,8 @@ XhcReadDebugReg ( VOID XhcSetDebugRegBit ( IN USB3_DEBUG_PORT_HANDLE *Handle, - IN UINT32 Offset, - IN UINT32 Bit + IN UINT32 Offset, + IN UINT32 Bit ); /** @@ -574,43 +574,6 @@ XhcWriteDebugReg ( ); /** - Discover the USB3 debug device. - - @param Handle Debug port handle. - - @retval RETURN_SUCCESS The serial device was initialized. - @retval RETURN_DEVICE_ERROR The serial device could not be initialized. - -**/ -RETURN_STATUS -DiscoverUsb3DebugPort( - USB3_DEBUG_PORT_HANDLE *Handle - ); - -/** - Initialize the Serial Device hardware. - - @param Handle Debug port handle. - - @retval RETURN_SUCCESS The serial device was initialized successfully. - @retval !RETURN_SUCCESS Error. - -**/ -RETURN_STATUS -InitializeUsb3DebugPort ( - USB3_DEBUG_PORT_HANDLE *Handle - ); - -/** - Return XHCI MMIO base address. - -**/ -EFI_PHYSICAL_ADDRESS -GetXhciBaseAddress ( - VOID - ); - -/** Verifies if the bit positions specified by a mask are set in a register. @param[in, out] Register UNITN register @@ -728,4 +691,4 @@ XhcDataTransfer ( IN UINTN Timeout ); -#endif //__SERIAL_PORT_LIB_USB__ +#endif //__USB3_DEBUG_PORT_LIB_INTERNAL__ -- 2.7.0.windows.1