Convert some C-style comments to Doxygen style for coding standard compliance.

[mirror_edk2.git] / PcAtChipsetPkg / Bus / Pci / IdeControllerDxe / IdeController.h

diff --git a/PcAtChipsetPkg/Bus/Pci/IdeControllerDxe/IdeController.h b/PcAtChipsetPkg/Bus/Pci/IdeControllerDxe/IdeController.h
index 301b781337e20b784c01e8f0d06294d4cd63c1ef..581361d24f3b8f08449177ee4e9811d23873a4b0 100644 (file)
--- a/PcAtChipsetPkg/Bus/Pci/IdeControllerDxe/IdeController.h
+++ b/PcAtChipsetPkg/Bus/Pci/IdeControllerDxe/IdeController.h
@@ -2,13 +2,13 @@
   Header file for IDE controller driver.\r
 \r
   Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.<BR>\r
   Header file for IDE controller driver.\r
 \r
   Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.<BR>\r

-  This program and the accompanying materials                          \r
-  are licensed and made available under the terms and conditions of the BSD License         \r
-  which accompanies this distribution.  The full text of the license may be found at        \r
-  http://opensource.org/licenses/bsd-license.php                                            \r
+  This program and the accompanying materials\r
+  are licensed and made available under the terms and conditions of the BSD License\r
+  which accompanies this distribution.  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.php\r

 \r
 \r

-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r

 \r
 **/\r
 \r
 \r
 **/\r
 \r


@@ -36,13 +36,14 @@ extern EFI_DRIVER_BINDING_PROTOCOL  gIdeControllerDriverBinding;
 extern EFI_COMPONENT_NAME_PROTOCOL  gIdeControllerComponentName;\r
 extern EFI_COMPONENT_NAME2_PROTOCOL gIdeControllerComponentName2;\r
 \r
 extern EFI_COMPONENT_NAME_PROTOCOL  gIdeControllerComponentName;\r
 extern EFI_COMPONENT_NAME2_PROTOCOL gIdeControllerComponentName2;\r
 \r

-//\r
-// Supports 2 channel max\r
-//\r
+///\r
+/// Supports 2 channel max\r
+///\r

 #define ICH_IDE_MAX_CHANNEL 0x02\r
 #define ICH_IDE_MAX_CHANNEL 0x02\r

-//\r
-// Supports 2 devices max\r
-//\r
+\r
+///\r
+/// Supports 2 devices max\r
+///\r

 #define ICH_IDE_MAX_DEVICES 0x02\r
 #define ICH_IDE_ENUMER_ALL  FALSE\r
 \r
 #define ICH_IDE_MAX_DEVICES 0x02\r
 #define ICH_IDE_ENUMER_ALL  FALSE\r
 \r


@@ -53,12 +54,12 @@ extern EFI_COMPONENT_NAME2_PROTOCOL gIdeControllerComponentName2;
   Register Driver Binding protocol for this driver.\r
 \r
   @param This                   A pointer points to the Binding Protocol instance\r
   Register Driver Binding protocol for this driver.\r
 \r
   @param This                   A pointer points to the Binding Protocol instance\r

-  @param Controller             The handle of controller to be tested. \r
+  @param Controller             The handle of controller to be tested.\r

   @param RemainingDevicePath    A pointer to the device path. Ignored by device\r
                                 driver but used by bus driver\r
   @param RemainingDevicePath    A pointer to the device path. Ignored by device\r
                                 driver but used by bus driver\r

-  \r
-  @retval EFI_SUCCESS           Driver loaded. \r
-  @retval !EFI_SUCESS           Driver not loaded. \r
+\r
+  @retval EFI_SUCCESS           Driver loaded.\r
+  @retval !EFI_SUCESS           Driver not loaded.\r

 **/\r
 EFI_STATUS\r
 EFIAPI\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r


@@ -70,16 +71,16 @@ IdeControllerSupported (
 ;\r
 \r
 /**\r
 ;\r
 \r
 /**\r

-  This routine is called right after the .Supported() called and return \r
+  This routine is called right after the .Supported() called and return\r

   EFI_SUCCESS. Notes: The supported protocols are checked but the Protocols\r
   EFI_SUCCESS. Notes: The supported protocols are checked but the Protocols\r

-  are closed.  \r
+  are closed.\r

 \r
   @param This                   A pointer points to the Binding Protocol instance\r
   @param Controller             The handle of controller to be tested. Parameter\r
                                 passed by the caller\r
   @param RemainingDevicePath    A pointer to the device path. Should be ignored by\r
                                 device driver\r
 \r
   @param This                   A pointer points to the Binding Protocol instance\r
   @param Controller             The handle of controller to be tested. Parameter\r
                                 passed by the caller\r
   @param RemainingDevicePath    A pointer to the device path. Should be ignored by\r
                                 device driver\r

-  \r
+\r

   @return EFI_STATUS            Status of InstallMultipleProtocolInterfaces()\r
 **/\r
 EFI_STATUS\r
   @return EFI_STATUS            Status of InstallMultipleProtocolInterfaces()\r
 **/\r
 EFI_STATUS\r


@@ -92,15 +93,15 @@ IdeControllerStart (
 ;\r
 \r
 /**\r
 ;\r
 \r
 /**\r

-  Stop this driver on Controller Handle. \r
+  Stop this driver on Controller Handle.\r

 \r
   @param This               Protocol instance pointer.\r
 \r
   @param This               Protocol instance pointer.\r

-  @param Controller         Handle of device to stop driver on \r
+  @param Controller         Handle of device to stop driver on\r

   @param NumberOfChildren   Not used\r
   @param ChildHandleBuffer  Not used\r
   @param NumberOfChildren   Not used\r
   @param ChildHandleBuffer  Not used\r

-  \r
-  @retval EFI_SUCESS        This driver is removed DeviceHandle \r
-  @retval !EFI_SUCCESS      This driver was not removed from this device \r
+\r
+  @retval EFI_SUCESS        This driver is removed DeviceHandle\r
+  @retval !EFI_SUCCESS      This driver was not removed from this device\r

 **/\r
 EFI_STATUS\r
 EFIAPI\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r


@@ -116,16 +117,16 @@ IdeControllerStop (
 // IDE controller init functions declaration\r
 //\r
 /**\r
 // IDE controller init functions declaration\r
 //\r
 /**\r

-  This function can be used to obtain information about a specified channel. \r
-  It's usually used by IDE Bus driver during enumeration process.  \r
+  This function can be used to obtain information about a specified channel.\r
+  It's usually used by IDE Bus driver during enumeration process.\r

 \r
   @param This           the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
   @param Channel        Channel number (0 based, either 0 or 1)\r
 \r
   @param This           the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
   @param Channel        Channel number (0 based, either 0 or 1)\r

-  @param Enabled        TRUE if the channel is enabled. If the channel is disabled, \r
+  @param Enabled        TRUE if the channel is enabled. If the channel is disabled,\r

                         then it will no be enumerated.\r
   @param MaxDevices     The Max number of IDE devices that the bus driver can expect\r
                         on this channel. For ATA/ATAPI, this number is either 1 or 2.\r
                         then it will no be enumerated.\r
   @param MaxDevices     The Max number of IDE devices that the bus driver can expect\r
                         on this channel. For ATA/ATAPI, this number is either 1 or 2.\r

-  \r
+\r

   @retval EFI_SUCCESS           Success to get channel information\r
   @retval EFI_INVALID_PARAMETER Invalid channel id.\r
 **/\r
   @retval EFI_SUCCESS           Success to get channel information\r
   @retval EFI_INVALID_PARAMETER Invalid channel id.\r
 **/\r


@@ -140,13 +141,13 @@ IdeInitGetChannelInfo (
 ;\r
 \r
 /**\r
 ;\r
 \r
 /**\r

-  This function is called by IdeBus driver before executing certain actions. \r
-  This allows IDE Controller Init to prepare for each action.  \r
+  This function is called by IdeBus driver before executing certain actions.\r
+  This allows IDE Controller Init to prepare for each action.\r

 \r
   @param This       the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
   @param Phase      phase indicator defined by IDE_CONTROLLER_INIT protocol\r
   @param Channel    Channel number (0 based, either 0 or 1)\r
 \r
   @param This       the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
   @param Phase      phase indicator defined by IDE_CONTROLLER_INIT protocol\r
   @param Channel    Channel number (0 based, either 0 or 1)\r

-  \r
+\r

   @return EFI_SUCCESS Success operation.\r
 **/\r
 EFI_STATUS\r
   @return EFI_SUCCESS Success operation.\r
 **/\r
 EFI_STATUS\r


@@ -160,14 +161,14 @@ IdeInitNotifyPhase (
 \r
 /**\r
   This function is called by IdeBus driver to submit EFI_IDENTIFY_DATA data structure\r
 \r
 /**\r
   This function is called by IdeBus driver to submit EFI_IDENTIFY_DATA data structure\r

-  obtained from IDE deivce. This structure is used to set IDE timing  \r
+  obtained from IDE deivce. This structure is used to set IDE timing\r

 \r
   @param This           The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
   @param Channel        IDE channel number (0 based, either 0 or 1)\r
   @param Device         IDE device number\r
   @param IdentifyData   A pointer to EFI_IDENTIFY_DATA data structure\r
 \r
   @param This           The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
   @param Channel        IDE channel number (0 based, either 0 or 1)\r
   @param Device         IDE device number\r
   @param IdentifyData   A pointer to EFI_IDENTIFY_DATA data structure\r

-  \r
-  @return EFI_SUCCESS   Success operation. \r
+\r
+  @return EFI_SUCCESS   Success operation.\r

 **/\r
 EFI_STATUS\r
 EFIAPI\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r


@@ -181,14 +182,14 @@ IdeInitSubmitData (
 \r
 /**\r
   This function is called by IdeBus driver to disqualify unsupported operation\r
 \r
 /**\r
   This function is called by IdeBus driver to disqualify unsupported operation\r

-  mode on specfic IDE device  \r
+  mode on specfic IDE device\r

 \r
   @param This       the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
   @param Channel    IDE channel number (0 based, either 0 or 1)\r
   @param Device     IDE device number\r
   @param BadModes   Operation mode indicator\r
 \r
   @param This       the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
   @param Channel    IDE channel number (0 based, either 0 or 1)\r
   @param Device     IDE device number\r
   @param BadModes   Operation mode indicator\r

-  \r
-  @return EFI_SUCCESS Success operation. \r
+\r
+  @return EFI_SUCCESS Success operation.\r

 **/\r
 EFI_STATUS\r
 EFIAPI\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r


@@ -202,14 +203,14 @@ IdeInitDisqualifyMode (
 \r
 /**\r
   This function is called by IdeBus driver to calculate the best operation mode\r
 \r
 /**\r
   This function is called by IdeBus driver to calculate the best operation mode\r

-  supported by specific IDE device  \r
+  supported by specific IDE device\r

 \r
   @param This               the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
   @param Channel            IDE channel number (0 based, either 0 or 1)\r
   @param Device             IDE device number\r
   @param SupportedModes     Modes collection supported by IDE device\r
 \r
   @param This               the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
   @param Channel            IDE channel number (0 based, either 0 or 1)\r
   @param Device             IDE device number\r
   @param SupportedModes     Modes collection supported by IDE device\r

-  \r
-  @retval EFI_OUT_OF_RESOURCES  Fail to allocate pool. \r
+\r
+  @retval EFI_OUT_OF_RESOURCES  Fail to allocate pool.\r

   @retval EFI_INVALID_PARAMETER Invalid channel id and device id.\r
 **/\r
 EFI_STATUS\r
   @retval EFI_INVALID_PARAMETER Invalid channel id and device id.\r
 **/\r
 EFI_STATUS\r


@@ -224,13 +225,13 @@ IdeInitCalculateMode (
 \r
 /**\r
   This function is called by IdeBus driver to set appropriate timing on IDE\r
 \r
 /**\r
   This function is called by IdeBus driver to set appropriate timing on IDE\r

-  controller according supported operation mode.  \r
+  controller according supported operation mode.\r

 \r
   @param This       the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
   @param Channel    IDE channel number (0 based, either 0 or 1)\r
   @param Device     IDE device number\r
   @param Modes      IDE device modes\r
 \r
   @param This       the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
   @param Channel    IDE channel number (0 based, either 0 or 1)\r
   @param Device     IDE device number\r
   @param Modes      IDE device modes\r

-  \r
+\r

   @retval EFI_SUCCESS Sucess operation.\r
 **/\r
 EFI_STATUS\r
   @retval EFI_SUCCESS Sucess operation.\r
 **/\r
 EFI_STATUS\r


@@ -258,7 +259,7 @@ IdeInitSetTiming (
   @param DriverName     A pointer to the Unicode string to return.  This Unicode string\r
                         is the name of the driver specified by This in the language\r
                         specified by Language.\r
   @param DriverName     A pointer to the Unicode string to return.  This Unicode string\r
                         is the name of the driver specified by This in the language\r
                         specified by Language.\r

-  \r
+\r

   @retval EFI_SUCCESS           The Unicode string for the Driver specified by This\r
                                 and the language specified by Language was returned\r
                                 in DriverName.\r
   @retval EFI_SUCCESS           The Unicode string for the Driver specified by This\r
                                 and the language specified by Language was returned\r
                                 in DriverName.\r


@@ -278,7 +279,7 @@ IdeControllerComponentNameGetDriverName (
 \r
 /**\r
   Retrieves a Unicode string that is the user readable name of the controller\r
 \r
 /**\r
   Retrieves a Unicode string that is the user readable name of the controller\r

-  that is being managed by an EFI Driver.  \r
+  that is being managed by an EFI Driver.\r

 \r
   @param This                   A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
   @param ControllerHandle       The handle of a controller that the driver specified by\r
 \r
   @param This                   A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
   @param ControllerHandle       The handle of a controller that the driver specified by\r


@@ -301,7 +302,7 @@ IdeControllerComponentNameGetDriverName (
                                 ControllerHandle and ChildHandle in the language\r
                                 specified by Language from the point of view of the\r
                                 driver specified by This.\r
                                 ControllerHandle and ChildHandle in the language\r
                                 specified by Language from the point of view of the\r
                                 driver specified by This.\r

-  \r
+\r

   @retval EFI_SUCCESS           The Unicode string for the user readable name in the\r
                                 language specified by Language for the driver\r
                                 specified by This was returned in DriverName.\r
   @retval EFI_SUCCESS           The Unicode string for the user readable name in the\r
                                 language specified by Language for the driver\r
                                 specified by This was returned in DriverName.\r