Skip to content

Commit 45c6a2d

Browse files
rddunlapjoergroedel
authored andcommitted
iommu/io-pgtable: fix all kernel-doc warnings in io-pgtable.h
Avoid kernel-doc warnings in io-pgtable.h: - use the correct struct member names or kernel-doc format - add a missing struct member description - add a missing function return comment section Warning: include/linux/io-pgtable.h:187 struct member 'coherent_walk' not described in 'io_pgtable_cfg' Warning: include/linux/io-pgtable.h:187 struct member 'arm_lpae_s1_cfg' not described in 'io_pgtable_cfg' Warning: include/linux/io-pgtable.h:187 struct member 'arm_lpae_s2_cfg' not described in 'io_pgtable_cfg' Warning: include/linux/io-pgtable.h:187 struct member 'arm_v7s_cfg' not described in 'io_pgtable_cfg' Warning: include/linux/io-pgtable.h:187 struct member 'arm_mali_lpae_cfg' not described in 'io_pgtable_cfg' Warning: include/linux/io-pgtable.h:187 struct member 'apple_dart_cfg' not described in 'io_pgtable_cfg' Warning: include/linux/io-pgtable.h:187 struct member 'amd' not described in 'io_pgtable_cfg' Warning: include/linux/io-pgtable.h:223 struct member 'read_and_clear_dirty' not described in 'io_pgtable_ops' Warning: include/linux/io-pgtable.h:237 No description found for return value of 'alloc_io_pgtable_ops' Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: Jason Gunthorpe <jgg@nvidia.com> Signed-off-by: Joerg Roedel <joerg.roedel@amd.com>
1 parent 0a4d00e commit 45c6a2d

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

include/linux/io-pgtable.h

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ struct iommu_flush_ops {
5353
* tables.
5454
* @ias: Input address (iova) size, in bits.
5555
* @oas: Output address (paddr) size, in bits.
56-
* @coherent_walk A flag to indicate whether or not page table walks made
56+
* @coherent_walk: A flag to indicate whether or not page table walks made
5757
* by the IOMMU are coherent with the CPU caches.
5858
* @tlb: TLB management callbacks for this set of tables.
5959
* @iommu_dev: The device representing the DMA configuration for the
@@ -136,6 +136,7 @@ struct io_pgtable_cfg {
136136
void (*free)(void *cookie, void *pages, size_t size);
137137

138138
/* Low-level data specific to the table format */
139+
/* private: */
139140
union {
140141
struct {
141142
u64 ttbr;
@@ -203,6 +204,9 @@ struct arm_lpae_io_pgtable_walk_data {
203204
* @unmap_pages: Unmap a range of virtually contiguous pages of the same size.
204205
* @iova_to_phys: Translate iova to physical address.
205206
* @pgtable_walk: (optional) Perform a page table walk for a given iova.
207+
* @read_and_clear_dirty: Record dirty info per IOVA. If an IOVA is dirty,
208+
* clear its dirty state from the PTE unless the
209+
* IOMMU_DIRTY_NO_CLEAR flag is passed in.
206210
*
207211
* These functions map directly onto the iommu_ops member functions with
208212
* the same names.
@@ -231,7 +235,9 @@ struct io_pgtable_ops {
231235
* the configuration actually provided by the allocator (e.g. the
232236
* pgsize_bitmap may be restricted).
233237
* @cookie: An opaque token provided by the IOMMU driver and passed back to
234-
* the callback routines in cfg->tlb.
238+
* the callback routines.
239+
*
240+
* Returns: Pointer to the &struct io_pgtable_ops for this set of page tables.
235241
*/
236242
struct io_pgtable_ops *alloc_io_pgtable_ops(enum io_pgtable_fmt fmt,
237243
struct io_pgtable_cfg *cfg,

0 commit comments

Comments
 (0)