diff options
| author | Jason Gunthorpe <jgg@nvidia.com> | 2025-11-06 15:02:14 -0400 |
|---|---|---|
| committer | Joerg Roedel <joerg.roedel@amd.com> | 2025-11-07 11:12:03 +0100 |
| commit | 5cb637d9425d7c6282b9f7470d273e4ecac6efb8 (patch) | |
| tree | d6e455f8bf9aa052223b05145a395ef70a33e66c /Documentation/driver-api | |
| parent | e4dfaf25df1210af6776b6672191cf5e32ba5529 (diff) | |
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>
Diffstat (limited to 'Documentation/driver-api')
| -rw-r--r-- | Documentation/driver-api/generic_pt.rst | 11 |
1 files changed, 3 insertions, 8 deletions
diff --git a/Documentation/driver-api/generic_pt.rst b/Documentation/driver-api/generic_pt.rst index 7a9ca9f2878d..fd29d1b525e5 100644 --- 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 |