Commit d6550ee4 authored by Randy Dunlap's avatar Randy Dunlap Committed by Andrew Morton
Browse files

kasan: use correct kernel-doc format 

Use the correct kernel-doc character following function parameters or
struct members (':' instead of '-') to eliminate kernel-doc warnings.

kasan.h:509: warning: Function parameter or struct member 'addr' not described in 'kasan_poison'
kasan.h:509: warning: Function parameter or struct member 'size' not described in 'kasan_poison'
kasan.h:509: warning: Function parameter or struct member 'value' not described in 'kasan_poison'
kasan.h:509: warning: Function parameter or struct member 'init' not described in 'kasan_poison'
kasan.h:522: warning: Function parameter or struct member 'addr' not described in 'kasan_unpoison'
kasan.h:522: warning: Function parameter or struct member 'size' not described in 'kasan_unpoison'
kasan.h:522: warning: Function parameter or struct member 'init' not described in 'kasan_unpoison'
kasan.h:539: warning: Function parameter or struct member 'address' not described in 'kasan_poison_last_granule'
kasan.h:539: warning: Function parameter or struct member 'size' not described in 'kasan_poison_last_granule'

Link: https://lkml.kernel.org/r/20250111063249.910975-1-rdunlap@infradead.org


Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Reviewed-by: default avatarAndrey Konovalov <andreyknvl@gmail.com>
Cc: Andrey Ryabinin <ryabinin.a.a@gmail.com>
Cc: Alexander Potapenko <glider@google.com>
Cc: Dmitry Vyukov <dvyukov@google.com>
Cc: Vincenzo Frascino <vincenzo.frascino@arm.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent dfe61db4

mm/kasan/kasan.h

+9 −9
Original line number Diff line number Diff line
@@ -501,18 +501,18 @@ static inline bool kasan_byte_accessible(const void *addr) 


/**

 * kasan_poison - mark the memory range as inaccessible

 * @addr - range start address, must be aligned to KASAN_GRANULE_SIZE

 * @size - range size, must be aligned to KASAN_GRANULE_SIZE

 * @value - value that's written to metadata for the range

 * @init - whether to initialize the memory range (only for hardware tag-based)

 * @addr: range start address, must be aligned to KASAN_GRANULE_SIZE

 * @size: range size, must be aligned to KASAN_GRANULE_SIZE

 * @value: value that's written to metadata for the range

 * @init: whether to initialize the memory range (only for hardware tag-based)

 */

void kasan_poison(const void *addr, size_t size, u8 value, bool init);



/**

 * kasan_unpoison - mark the memory range as accessible

 * @addr - range start address, must be aligned to KASAN_GRANULE_SIZE

 * @size - range size, can be unaligned

 * @init - whether to initialize the memory range (only for hardware tag-based)

 * @addr: range start address, must be aligned to KASAN_GRANULE_SIZE

 * @size: range size, can be unaligned

 * @init: whether to initialize the memory range (only for hardware tag-based)

 *

 * For the tag-based modes, the @size gets aligned to KASAN_GRANULE_SIZE before

 * marking the range.
@@ -530,8 +530,8 @@ bool kasan_byte_accessible(const void *addr); 
/**

 * kasan_poison_last_granule - mark the last granule of the memory range as

 * inaccessible

 * @addr - range start address, must be aligned to KASAN_GRANULE_SIZE

 * @size - range size

 * @address: range start address, must be aligned to KASAN_GRANULE_SIZE

 * @size: range size

 *

 * This function is only available for the generic mode, as it's the only mode

 * that has partially poisoned memory granules.