mips: clean up kernel-doc in mm/c-octeon.c

Clean up kernel-doc warnings in arch/mips/mm/c-octeon.c.

   arch/mips/mm/c-octeon.c:34: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Octeon automatically flushes the dcache on tlb changes, so
   arch/mips/mm/c-octeon.c:65: warning: expecting prototype for Flush caches as necessary for all cores affected by a(). Prototype was for octeon_flush_icache_all_cores() instead
   arch/mips/mm/c-octeon.c:99: warning: expecting prototype for Called to flush the icache on all cores(). Prototype was for octeon_flush_icache_all() instead
   arch/mips/mm/c-octeon.c:111: warning: expecting prototype for Called to flush all memory associated with a memory(). Prototype was for octeon_flush_cache_mm() instead
   arch/mips/mm/c-octeon.c:124: warning: Function parameter or member 'start' not described in 'octeon_flush_icache_range'
   arch/mips/mm/c-octeon.c:124: warning: Function parameter or member 'end' not described in 'octeon_flush_icache_range'
   arch/mips/mm/c-octeon.c:124: warning: expecting prototype for Flush a range of kernel addresses out of the icache(). Prototype was for octeon_flush_icache_range() instead
   arch/mips/mm/c-octeon.c:138: warning: expecting prototype for Flush a range out of a vma(). Prototype was for octeon_flush_cache_range() instead
   arch/mips/mm/c-octeon.c:153: warning: expecting prototype for Flush a specific page of a vma(). Prototype was for octeon_flush_cache_page() instead
   arch/mips/mm/c-octeon.c:164: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Probe Octeon's caches
   arch/mips/mm/c-octeon.c:264: warning: expecting prototype for Setup the Octeon cache flush routines(). Prototype was for octeon_cache_init() instead
   arch/mips/mm/c-octeon.c:349: warning: expecting prototype for Called when the the exception is not recoverable(). Prototype was for cache_parity_error_octeon_non_recoverable() instead

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Cc: Aditya Srivastava <yashsri421@gmail.com>
Cc: Thomas Bogendoerfer <tsbogend@alpha.franken.de>
Cc: linux-mips@vger.kernel.org
Signed-off-by: Thomas Bogendoerfer <tsbogend@alpha.franken.de>
This commit is contained in:
Randy Dunlap 2021-07-25 09:02:58 -07:00 committed by Thomas Bogendoerfer
parent 64c888ce33
commit d2ac3a11cb
1 changed files with 14 additions and 15 deletions

View File

@ -30,7 +30,7 @@
unsigned long long cache_err_dcache[NR_CPUS]; unsigned long long cache_err_dcache[NR_CPUS];
EXPORT_SYMBOL_GPL(cache_err_dcache); EXPORT_SYMBOL_GPL(cache_err_dcache);
/** /*
* Octeon automatically flushes the dcache on tlb changes, so * Octeon automatically flushes the dcache on tlb changes, so
* from Linux's viewpoint it acts much like a physically * from Linux's viewpoint it acts much like a physically
* tagged cache. No flushing is needed * tagged cache. No flushing is needed
@ -56,8 +56,8 @@ static void local_octeon_flush_icache_range(unsigned long start,
} }
/** /**
* Flush caches as necessary for all cores affected by a * octeon_flush_icache_all_cores - Flush caches as necessary for all cores
* vma. If no vma is supplied, all cores are flushed. * affected by a vma. If no vma is supplied, all cores are flushed.
* *
* @vma: VMA to flush or NULL to flush all icaches. * @vma: VMA to flush or NULL to flush all icaches.
*/ */
@ -92,7 +92,7 @@ static void octeon_flush_icache_all_cores(struct vm_area_struct *vma)
} }
/** /*
* Called to flush the icache on all cores * Called to flush the icache on all cores
*/ */
static void octeon_flush_icache_all(void) static void octeon_flush_icache_all(void)
@ -102,8 +102,7 @@ static void octeon_flush_icache_all(void)
/** /**
* Called to flush all memory associated with a memory * octeon_flush_cache_mm - flush all memory associated with a memory context.
* context.
* *
* @mm: Memory context to flush * @mm: Memory context to flush
*/ */
@ -116,7 +115,7 @@ static void octeon_flush_cache_mm(struct mm_struct *mm)
} }
/** /*
* Flush a range of kernel addresses out of the icache * Flush a range of kernel addresses out of the icache
* *
*/ */
@ -127,11 +126,11 @@ static void octeon_flush_icache_range(unsigned long start, unsigned long end)
/** /**
* Flush a range out of a vma * octeon_flush_cache_range - Flush a range out of a vma
* *
* @vma: VMA to flush * @vma: VMA to flush
* @start: * @start: beginning address for flush
* @end: * @end: ending address for flush
*/ */
static void octeon_flush_cache_range(struct vm_area_struct *vma, static void octeon_flush_cache_range(struct vm_area_struct *vma,
unsigned long start, unsigned long end) unsigned long start, unsigned long end)
@ -142,11 +141,11 @@ static void octeon_flush_cache_range(struct vm_area_struct *vma,
/** /**
* Flush a specific page of a vma * octeon_flush_cache_page - Flush a specific page of a vma
* *
* @vma: VMA to flush page for * @vma: VMA to flush page for
* @page: Page to flush * @page: Page to flush
* @pfn: * @pfn: Page frame number
*/ */
static void octeon_flush_cache_page(struct vm_area_struct *vma, static void octeon_flush_cache_page(struct vm_area_struct *vma,
unsigned long page, unsigned long pfn) unsigned long page, unsigned long pfn)
@ -160,7 +159,7 @@ static void octeon_flush_kernel_vmap_range(unsigned long vaddr, int size)
BUG(); BUG();
} }
/** /*
* Probe Octeon's caches * Probe Octeon's caches
* *
*/ */
@ -256,7 +255,7 @@ static void octeon_cache_error_setup(void)
set_handler(0x100, &except_vec2_octeon, 0x80); set_handler(0x100, &except_vec2_octeon, 0x80);
} }
/** /*
* Setup the Octeon cache flush routines * Setup the Octeon cache flush routines
* *
*/ */
@ -341,7 +340,7 @@ asmlinkage void cache_parity_error_octeon_recoverable(void)
co_cache_error_call_notifiers(0); co_cache_error_call_notifiers(0);
} }
/** /*
* Called when the the exception is not recoverable * Called when the the exception is not recoverable
*/ */