Committing changes to the comments, to improve code documentation.
authorpkandel <pkandel@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 9 Jul 2009 12:36:25 +0000 (12:36 +0000)
committerpkandel <pkandel@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 9 Jul 2009 12:36:25 +0000 (12:36 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8842 6f19259b-4bc3-4df7-8a09-765794883524

IntelFrameworkModulePkg/Include/Protocol/DiskInfo.h
IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h
IntelFrameworkModulePkg/Include/Protocol/IsaIo.h
IntelFrameworkModulePkg/Include/Protocol/OEMBadging.h
IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h

index 7f82a40..b6695e1 100644 (file)
@@ -37,7 +37,7 @@ typedef struct _EFI_DISK_INFO_PROTOCOL  EFI_DISK_INFO_PROTOCOL;
   @retval EFI_SUCCESS           The command was accepted without any errors.\r
   @retval EFI_NOT_FOUND         Device does not support this data class \r
   @retval EFI_DEVICE_ERROR      Error reading InquiryData from device \r
-  @retval EFI_BUFFER_TOO_SMALL  IntquiryDataSize not big enough \r
+  @retval EFI_BUFFER_TOO_SMALL  InquiryDataSize not big enough \r
 \r
 **/\r
 typedef\r
index 81e75f9..819d5b4 100644 (file)
@@ -112,8 +112,8 @@ typedef struct {
 \r
   This service allows all the ISA controllers on an ISA bus to be enumerated.  If\r
   Device is a pointer to a NULL value, then the first ISA controller on the ISA\r
-  bus is returned in Device and EFI_SUCESS is returned.  If Device is a pointer \r
-  to value that was returned on a prior call to DeviceEnumerate(), then the next \r
+  bus is returned in Device and EFI_SUCCESS is returned.  If Device is a pointer \r
+  to value that was returned on a prior call to DeviceEnumerate(), then the next \r
   ISA controller on the ISA bus is returned in Device and EFI_SUCCESS is returned.\r
   If Device is a pointer to the last ISA controller on the ISA bus, then \r
   EFI_NOT_FOUND is returned.\r
@@ -136,15 +136,13 @@ EFI_STATUS
   Sets the power state of an ISA controller.\r
 \r
   This services sets the power state of the ISA controller specified by Device to \r
-  the power state specified by OnOff.  If OnOff is TRUE, then power is applied to \r
-  the ISA controller.  If OnOff is FALSE, then power is remobed from the ISA \r
-  controller.  If the power state is sucessfully set on the ISA Controller, then\r
+  the power state specified by OnOff.  TRUE denotes on, FALSE denotes off. \r
+  If the power state is sucessfully set on the ISA Controller, then\r
   EFI_SUCCESS is returned.\r
 \r
   @param[in] This     Pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
   @param[in] Device   Pointer to an ISA controller named by ACPI HID/UID.\r
-  @param[in] OnOff    TRUE to apply power to the ISA controller.  FALSE to remove\r
-                      power from the ISA controller.\r
+  @param[in] OnOff    TRUE denotes on, FALSE denotes off.\r
 \r
   @retval EFI_SUCCESS   Successfully set the power state of the ISA controller.\r
   @retval Other         The ISA controller cound not be placed in the requested power state.\r
@@ -159,7 +157,7 @@ EFI_STATUS
   );\r
   \r
 /**\r
-  Retrieves the current set of resource associated with an ISA controller.\r
+  Retrieves the current set of resources associated with an ISA controller.\r
 \r
   Retrieves the set of I/O, MMIO, DMA, and interrupt resources currently \r
   assigned to the ISA controller specified by Device.  These resources\r
@@ -192,7 +190,7 @@ EFI_STATUS
   @param[in]  Device         Pointer to an ISA controller named by ACPI HID/UID.\r
   @param[out] ResourceList   Pointer to the returned list of resource lists.\r
 \r
-  @retval EFI_UNSUPPORTED  This services is not supported.\r
+  @retval EFI_UNSUPPORTED  This service is not supported.\r
 \r
 **/\r
 typedef\r
@@ -207,8 +205,7 @@ EFI_STATUS
   Assigns resources to an ISA controller.\r
 \r
   Assigns the I/O, MMIO, DMA, and interrupt resources specified by ResourceList\r
-  to the ISA controller specified by Device.  ResourceList must match on of the\r
-  possible resource lists returned by GetPosResource() for the same ISA controller.\r
+  to the ISA controller specified by Device.  ResourceList must match a resource list returned by GetPosResource() for the same ISA controller.\r
 \r
   @param[in] This           Pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
   @param[in] Device         Pointer to an ISA controller named by ACPI HID/UID.\r
@@ -249,7 +246,7 @@ EFI_STATUS
   );    \r
 \r
 /**\r
-  Places an ISA controller into a usable state.  This service must be called\r
+  Initializes an ISA controller, so that it can be used.  This service must be called\r
   before SetResource(), EnableDevice(), or SetPower() will behave as expected.\r
 \r
   @param[in] This     Pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
@@ -267,8 +264,8 @@ EFI_STATUS
   );  \r
 \r
 /**\r
-  Initializes all the HW state required for the ISA controlers on the ISA bus \r
-  to be enumerated and managed by this rest of the services in this prorotol.\r
+  Initializes all the HW states required for the ISA controllers on the ISA bus \r
+  to be enumerated and managed by the rest of the services in this prorotol.\r
   This service must be called before any of the other services in this\r
   protocol will function as expected.\r
  \r
@@ -285,10 +282,10 @@ EFI_STATUS
   );\r
 \r
 ///\r
-/// The EFI_ISA_ACPI_PROTOCOL provides the services to enumberate and manage\r
-/// ISA controllers on an ISA bus.  This include the ability to initialize, \r
-/// enable, disable, and manag the power state of ISA controllers.  It also \r
-/// includes services to query current ressources, query possible resources, \r
+/// The EFI_ISA_ACPI_PROTOCOL provides the services to enumerate and manage\r
+/// ISA controllers on an ISA bus.  These services include the ability to initialize, \r
+/// enable, disable, and manage the power state of ISA controllers.  It also \r
+/// includes services to query current resources, query possible resources, \r
 /// and assign resources to an ISA controller.\r
 ///\r
 struct _EFI_ISA_ACPI_PROTOCOL {\r
index 63999b0..395f295 100644 (file)
@@ -54,7 +54,7 @@ typedef enum {
 /// Attributes for the EFI_ISA_IO_PROTOCOL common DMA buffer allocations\r
 ///\r
 #define EFI_ISA_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE  0x080    ///< Map a memory range so write are combined\r
-#define EFI_ISA_IO_ATTRIBUTE_MEMORY_CACHED         0x800    ///< Map a memory range so all r/w accesses are cached\r
+#define EFI_ISA_IO_ATTRIBUTE_MEMORY_CACHED         0x800    ///< Map a memory range so all read and write accesses are cached\r
 #define EFI_ISA_IO_ATTRIBUTE_MEMORY_DISABLE        0x1000   ///< Disable a memory range \r
 \r
 ///\r
@@ -67,7 +67,7 @@ typedef enum {
 #define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_WIDTH_8           0x010   ///< Request 8-bit DMA transfers.  Only available on channels 0..3\r
 #define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_WIDTH_16          0x020   ///< Request 16-bit DMA transfers.  Only available on channels 4..7\r
 #define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SINGLE_MODE       0x040   ///< Request a single DMA transfer\r
-#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_DEMAND_MODE       0x080   ///< Request multiple DMA transfers until TC(Terminal Count) or EOP(End of Process)\r
+#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_DEMAND_MODE       0x080   ///< Request multiple DMA transfers until TC (Terminal Count) or EOP (End of Process)\r
 #define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_AUTO_INITIALIZE   0x100   ///< Automatically reload base and count at the end of the DMA transfer\r
 \r
 ///\r
@@ -111,7 +111,7 @@ typedef enum {
                            the results. For write operations, the source buffer to \r
                            write data from. \r
                                  \r
-  @retval EFI_SUCCESS             The data was read from / written to the device sucessfully.\r
+  @retval EFI_SUCCESS             The data was successfully read from or written to the device.\r
   @retval EFI_UNSUPPORTED         The Offset is not valid for this device.\r
   @retval EFI_INVALID_PARAMETER   Width or Count, or both, were invalid.\r
   @retval EFI_OUT_OF_RESOURCES    The request could not be completed due to a lack of resources.\r
@@ -170,23 +170,25 @@ EFI_STATUS
 /**\r
   Maps a memory region for DMA.\r
 \r
-  This function returns the device specific addresses required to access system memory.\r
+  This function returns the device-specific addresses required to access system memory.\r
   This function is used to map system memory for ISA DMA operations.  All ISA DMA \r
-  operations must be performed through their mapped addresses and such mappings must \r
-  be freed with EFI_ISA_IO_PROTOCOL.Unmap() after the DMA operation is completed.  \r
+  operations must be performed through their mapped addresses, and such mappings must \r
+  be freed with EFI_ISA_IO_PROTOCOL.Unmap() after the DMA operation is completed.\r
+    \r
   If the DMA operation is a single read or write data transfer through an ISA bus \r
   master, then EfiIsaIoOperationBusMasterRead or EfiIsaIoOperationBusMasterWrite \r
   is used and the range is unmapped to complete the operation. If the DMA operation\r
   is a single read or write data transfer through an ISA slave controller, then \r
   EfiIsaIoOperationSlaveRead or EfiIsaIoOperationSlaveWrite is used and the range \r
-  is unmapped to complete the operation.  If performing a DMA read operation, all \r
-  the data must be present in system memory before the Map() is performed.  Similarly, \r
+  is unmapped to complete the operation.  \r
+  \r
+  If performing a DMA read operation, all the data must be present in system memory before the Map() is performed.  Similarly, \r
   if performing a DMA write operation, the data must not be accessed in system \r
   memory until EFI_ISA_IO_PROTOCOL.Unmap() is performed.  Bus master operations that \r
   require both read and write access or require multiple host device interactions \r
   within the same mapped region must use EfiIsaIoOperationBusMasterCommonBuffer.  \r
   However, only memory allocated via the EFI_ISA_IO_PROTOCOL.AllocateBuffer() interface \r
-  are guaranteed to be able to be mapped for this operation type.  In all mapping \r
+  is guaranteed to be able to be mapped for this operation type.  In all mapping \r
   requests the NumberOfBytes returned may be less than originally requested.  It is\r
   the caller's responsibility to make additional requests to complete the entire\r
   transfer.\r
@@ -308,7 +310,7 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Flushes a DMA buffer.  This forces all DMA posted write transactions to complete.\r
+  Flushes a DMA buffer, which forces all DMA posted write transactions to complete.\r
 \r
   @param[in] This   A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
 \r
@@ -327,7 +329,7 @@ EFI_STATUS
 /// used to abstract accesses to ISA controllers.  There is one EFI_ISA_IO_PROTOCOL \r
 /// instance for each ISA controller on a ISA bus. A device driver that wishes \r
 /// to manage an ISA controller in a system will have to retrieve the \r
-/// ISA_PCI_IO_PROTOCOL instance that is associated with the ISA controller.\r
+/// ISA_PCI_IO_PROTOCOL instance associated with the ISA controller.\r
 ///\r
 struct _EFI_ISA_IO_PROTOCOL {\r
   EFI_ISA_IO_PROTOCOL_ACCESS           Mem;\r
index c274dab..a0d3808 100644 (file)
@@ -1,6 +1,6 @@
 /** @file\r
   The OEM Badging Protocol defines the interface to get the OEM badging \r
-  image with the dispaly attribute. This protocol can be produced based on OEM badging images.\r
+  image with the display attribute. This protocol can be produced based on OEM badging images.\r
 \r
 Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r
@@ -48,11 +48,11 @@ typedef enum {
 \r
 /**\r
 \r
-  Load an OEM badge image and return its data as well as attributes.\r
+  Load an OEM badge image and return its data and attributes.\r
 \r
   @param This              Pointer to this protocol instance.\r
-  @param Instance          The visiable image instance is found.\r
-  @param Format            Format of the image such as BMP,JPEG,etc.\r
+  @param Instance          The visible image instance is found.\r
+  @param Format            Format of the image. Examples: BMP, JPEG.\r
   @param ImageData         Image data returned.\r
   @param ImageSize         Size of the image returned.\r
   @param Attribute         Display attributes of the image returned.\r
index d4a36ae..40c1349 100644 (file)
@@ -1,6 +1,6 @@
 /** @file\r
-  Provides services to notify PCI bus driver that some events have happened in a hot-plug controller\r
-  (for example, PC Card socket, or PHPC), and ask PCI bus driver to create or destroy handles for the\r
+  Provides services to notify the PCI bus driver that some events have happened in a hot-plug controller\r
+  (such as a PC Card socket, or PHPC), and to ask the PCI bus driver to create or destroy handles for \r
   PCI-like devices.\r
 \r
 Copyright (c) 2006 - 2009, Intel Corporation                                                         \r
@@ -25,7 +25,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 typedef enum {\r
   ///\r
   /// The PCI bus driver is requested to create handles for the specified devices. An array of\r
-  /// EFI_HANDLE is returned, a NULL element marks the end of the array.\r
+  /// EFI_HANDLE is returned, with a NULL element marking the end of the array.\r
   ///\r
   EfiPciHotPlugRequestAdd,\r
 \r
@@ -38,18 +38,16 @@ typedef enum {
 typedef struct _EFI_PCI_HOTPLUG_REQUEST_PROTOCOL  EFI_PCI_HOTPLUG_REQUEST_PROTOCOL;\r
 \r
 /**\r
-  This function allows the PCI bus driver to be notified to act as requested when a hot-plug event has\r
-  happened on the hot-plug controller. Currently, the operations include add operation and remove operation.\r
-  \r
+  This function allows the PCI bus driver to be notified to act as requested when a hot-plug event has  happened on the hot-plug controller. Currently, the operations include add operation and remove operation.  \r
   @param This                    A pointer to the hot plug request protocol.\r
   @param Operation               The operation the PCI bus driver is requested to make.\r
   @param Controller              The handle of the hot-plug controller.\r
   @param RemainingDevicePath     The remaining device path for the PCI-like hot-plug device.\r
-  @param NumberOfChildren        The number of child handles. For a add operation, it is an output parameter. \r
+  @param NumberOfChildren        The number of child handles. For an add operation, it is an output parameter. \r
                                  For a remove operation, it's an input parameter. When it contains a non-zero\r
                                  value, children handles specified in ChildHandleBuffer are destroyed. Otherwise,\r
                                  PCI bus driver is notified to stop managing the controller handle.\r
-  @param ChildHandleBuffer       The buffer which contains the child handles. For a add operation, it is an output \r
+  @param ChildHandleBuffer       The buffer which contains the child handles. For an add operation, it is an output \r
                                  parameter and contains all newly created child handles. For a remove operation, it \r
                                  contains child handles to be destroyed when NumberOfChildren contains a non-\r
                                  zero value. It can be NULL when NumberOfChildren is 0. It's the caller's \r