tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

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>

authored by

Randy Dunlap and committed by
Joerg Roedel 45c6a2dc 0a4d00e2

+8 -2
+8 -2
include/linux/io-pgtable.h
··· 53 53 * tables. 54 54 * @ias: Input address (iova) size, in bits. 55 55 * @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 57 57 * by the IOMMU are coherent with the CPU caches. 58 58 * @tlb: TLB management callbacks for this set of tables. 59 59 * @iommu_dev: The device representing the DMA configuration for the ··· 136 136 void (*free)(void *cookie, void *pages, size_t size); 137 137 138 138 /* Low-level data specific to the table format */ 139 + /* private: */ 139 140 union { 140 141 struct { 141 142 u64 ttbr; ··· 204 203 * @unmap_pages: Unmap a range of virtually contiguous pages of the same size. 205 204 * @iova_to_phys: Translate iova to physical address. 206 205 * @pgtable_walk: (optional) Perform a page table walk for a given iova. 206 + * @read_and_clear_dirty: Record dirty info per IOVA. If an IOVA is dirty, 207 + * clear its dirty state from the PTE unless the 208 + * IOMMU_DIRTY_NO_CLEAR flag is passed in. 207 209 * 208 210 * These functions map directly onto the iommu_ops member functions with 209 211 * the same names. ··· 235 231 * the configuration actually provided by the allocator (e.g. the 236 232 * pgsize_bitmap may be restricted). 237 233 * @cookie: An opaque token provided by the IOMMU driver and passed back to 238 - * the callback routines in cfg->tlb. 234 + * the callback routines. 235 + * 236 + * Returns: Pointer to the &struct io_pgtable_ops for this set of page tables. 239 237 */ 240 238 struct io_pgtable_ops *alloc_io_pgtable_ops(enum io_pgtable_fmt fmt, 241 239 struct io_pgtable_cfg *cfg,