Update comments for Protocol definitions to match UEFI spec.

[mirror_edk2.git] / MdePkg / Include / Protocol / UsbHostController.h

diff --git a/MdePkg/Include/Protocol/UsbHostController.h b/MdePkg/Include/Protocol/UsbHostController.h
index 3a0fe6dfa8046bcc90071814ce2d4abf5d0f53c2..803316f145fec475738063a8a163e83d08ca64aa 100644 (file)
--- a/MdePkg/Include/Protocol/UsbHostController.h
+++ b/MdePkg/Include/Protocol/UsbHostController.h
@@ -468,67 +468,13 @@ EFI_STATUS
   );\r
 \r
 \r
-/**  \r
-  @par Protocol Description:\r
-  The EFI_USB_HC_PROTOCOL provides USB host controller management, basic data transactions\r
-  over a USB bus, and USB root hub access. A device driver that wishes to manage a USB bus in a\r
-  system retrieves the EFI_USB_HC_PROTOCOL instance that is associated with the USB bus to be\r
-  managed. A device handle for a USB host controller will minimally contain an\r
-  EFI_DEVICE_PATH_PROTOCOL instance, and an EFI_USB_HC_PROTOCOL instance. \r
-  \r
-  @param Reset \r
-  Software reset of USB. \r
-\r
-  @param GetState \r
-  Retrieves the current state of the USB host controller. \r
-\r
-  @param SetState \r
-  Sets the USB host controller to a specific state. \r
-\r
-  @param ControlTransfer \r
-  Submits a control transfer to a target USB device. \r
-\r
-  @param BulkTransfer \r
-  Submits a bulk transfer to a bulk endpoint of a USB device. \r
-\r
-  @param AsyncInterruptTransfer\r
-  Submits an asynchronous interrupt transfer to an interrupt endpoint\r
-  of a USB device. \r
-\r
-  @param SyncInterruptTransfer\r
-  Submits a synchronous interrupt transfer to an interrupt endpoint\r
-  of a USB device.\r
-\r
-  @param IsochronousTransfer \r
-  Submits isochronous transfer to an isochronous endpoint of a USB device.\r
-\r
-  @param AsyncIsochronousTransfer\r
-  Submits nonblocking USB isochronous transfer.\r
-\r
-  @param GetRootHubPortNumber \r
-  Retrieves the number of root hub ports that are produced by the\r
-  USB host controller. \r
-\r
-  @param GetRootHubPortStatus \r
-  Retrieves the status of the specified root hub port. \r
-\r
-  @param SetRootHubPortFeature\r
-  Sets the feature for the specified root hub port.\r
-\r
-  @param ClearRootHubPortFeature\r
-  Clears the feature for the specified root hub port. \r
-\r
-  @param MajorRevision \r
-  The major revision number of the USB host controller. The\r
-  revision information indicates the release of the Universal Serial\r
-  Bus Specification with which the host controller is compliant.\r
-\r
-  @param MinorRevision \r
-  The minor revision number of the USB host controller. The\r
-  revision information indicates the release of the Universal Serial\r
-  Bus Specification with which the host controller is compliant.\r
- \r
-**/\r
+///\r
+/// The EFI_USB_HC_PROTOCOL provides USB host controller management, basic data transactions\r
+/// over a USB bus, and USB root hub access. A device driver that wishes to manage a USB bus in a\r
+/// system retrieves the EFI_USB_HC_PROTOCOL instance that is associated with the USB bus to be\r
+/// managed. A device handle for a USB host controller will minimally contain an\r
+/// EFI_DEVICE_PATH_PROTOCOL instance, and an EFI_USB_HC_PROTOCOL instance. \r
+///\r
 struct _EFI_USB_HC_PROTOCOL {\r
   EFI_USB_HC_PROTOCOL_RESET                       Reset;\r
   EFI_USB_HC_PROTOCOL_GET_STATE                   GetState;\r
@@ -543,7 +489,17 @@ struct _EFI_USB_HC_PROTOCOL {
   EFI_USB_HC_PROTOCOL_GET_ROOTHUB_PORT_STATUS     GetRootHubPortStatus;\r
   EFI_USB_HC_PROTOCOL_SET_ROOTHUB_PORT_FEATURE    SetRootHubPortFeature;\r
   EFI_USB_HC_PROTOCOL_CLEAR_ROOTHUB_PORT_FEATURE  ClearRootHubPortFeature;\r
+  ///\r
+  /// The major revision number of the USB host controller. The revision information \r
+  /// indicates the release of the Universal Serial Bus Specification with which the \r
+  /// host controller is compliant.\r
+  ///  \r
   UINT16                                          MajorRevision;\r
+  ///\r
+  /// The minor revision number of the USB host controller. The revision information \r
+  /// indicates the release of the Universal Serial Bus Specification with which the \r
+  /// host controller is compliant.  \r
+  ///  \r
   UINT16                                          MinorRevision;\r
 };\r
 \r