iommupt: Documentation fixes

Some adjustments pointed out by Randy:

 "decodes an full 64-bit" -> "decodes the full 64 bit"

 Correct the function parameter name for iova_to_phys()

 Use the recommended section heading style.

Suggested-by: Randy Dunlap <rdunlap@infradead.org>
Fixes: ab0b572847ac ("genpt: Add Documentation/ files")
Fixes: 879ced2bab1b ("iommupt: Add the AMD IOMMU v1 page table format")
Fixes: 9d4c274cd7d5 ("iommupt: Add iova_to_phys op")
Signed-off-by: Jason Gunthorpe <jgg@nvidia.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Joerg Roedel <joerg.roedel@amd.com>

diff --git a/Documentation/driver-api/generic_pt.rst b/Documentation/driver-api/generic_pt.rst
index 7a9ca9f2878d4ffea1610eae042cd0964a2ea559..fd29d1b525e51dd3d1d2f14b8457fbc1b6f077f1 100644 (file)
--- a/Documentation/driver-api/generic_pt.rst
+++ b/Documentation/driver-api/generic_pt.rst
@@ -10,9 +10,8 @@ Generic Radix Page Table
 .. kernel-doc:: drivers/iommu/generic_pt/pt_defs.h
        :doc: Generic Page Table Language
 
------
 Usage
------
+=====
 
 Generic PT is structured as a multi-compilation system. Since each format
 provides an API using a common set of names there can be only one format active
@@ -61,7 +60,6 @@ format-specific information.
 The implementation will further wrap struct pt_common in its own top-level
 struct, such as struct pt_iommu_amdv1.
 
-----------------------------------------------
 Format functions at the struct pt_common level
 ----------------------------------------------
 
@@ -69,13 +67,11 @@ Format functions at the struct pt_common level
        :identifiers:
 .. kernel-doc:: drivers/iommu/generic_pt/pt_common.h
 
------------------
 Iteration Helpers
 -----------------
 
 .. kernel-doc:: drivers/iommu/generic_pt/pt_iter.h
 
-----------------
 Writing a Format
 ----------------
 
@@ -112,7 +108,6 @@ The generic tests are intended to prove out the format functions and give
 clearer failures to speed up finding the problems. Once those pass then the
 entire kunit suite should be run.
 
----------------------------
 IOMMU Invalidation Features
 ---------------------------
 
@@ -124,7 +119,7 @@ on its design. Every HW has its own approach on how to describe what has changed
 to have changed items removed from the TLB.
 
 PT_FEAT_FLUSH_RANGE
--------------------
+~~~~~~~~~~~~~~~~~~~
 
 PT_FEAT_FLUSH_RANGE is the easiest scheme to understand. It tries to generate a
 single range invalidation for each operation, over-invalidating if there are
@@ -134,7 +129,7 @@ however, if pages have to be freed then page table pointers have to be cleaned
 from the walk cache. The range can start/end at any page boundary.
 
 PT_FEAT_FLUSH_RANGE_NO_GAPS
----------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 PT_FEAT_FLUSH_RANGE_NO_GAPS is similar to PT_FEAT_FLUSH_RANGE; however, it tries
 to minimize the amount of impacted VA by issuing extra flush operations. This is

diff --git a/drivers/iommu/generic_pt/Kconfig b/drivers/iommu/generic_pt/Kconfig
index 79f65268f31212d27120feaf49b137e606667ce8..c88971675662feb562581f50132cd4a14c297074 100644 (file)
--- a/drivers/iommu/generic_pt/Kconfig
+++ b/drivers/iommu/generic_pt/Kconfig
@@ -38,7 +38,7 @@ config IOMMU_PT_AMDV1
        help
          iommu_domain implementation for the AMD v1 page table. AMDv1 is the
          "host" page table. It supports granular page sizes of almost every
-         power of 2 and decodes an full 64-bit IOVA space.
+         power of 2 and decodes the full 64-bit IOVA space.
 
          Selected automatically by an IOMMU driver that uses this format.
 

diff --git a/drivers/iommu/generic_pt/iommu_pt.h b/drivers/iommu/generic_pt/iommu_pt.h
index 1dcd85620f9b9c429bb933a771600b731e25dfaa..0e046fe0eea34ccb50125eece1f0ab434cafe3a8 100644 (file)
--- a/drivers/iommu/generic_pt/iommu_pt.h
+++ b/drivers/iommu/generic_pt/iommu_pt.h
@@ -158,7 +158,7 @@ PT_MAKE_LEVELS(__iova_to_phys, __do_iova_to_phys);
 
 /**
  * iova_to_phys() - Return the output address for the given IOVA
- * @iommu_table: Table to query
+ * @domain: Table to query
  * @iova: IO virtual address to query
  *
  * Determine the output address from the given IOVA. @iova may have any