Committing changes to the comments, to improve code documentation.

[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Protocol / IsaIo.h

diff --git a/IntelFrameworkModulePkg/Include/Protocol/IsaIo.h b/IntelFrameworkModulePkg/Include/Protocol/IsaIo.h
index 63999b0dc6d4c3465d86747067095c18fb49ade6..395f295479c7f7f5fa2279698891db859f9886d3 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Protocol/IsaIo.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/IsaIo.h
@@ -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