[v1,2/2] math64: add kernel-doc for DIV64_U64_ROUND_UP

Message ID 20221117023510.2338176-2-liambeguin@gmail.com
State New
Headers
Series [v1,1/2] math64: favor kernel-doc from header files |

Commit Message

Liam Beguin Nov. 17, 2022, 2:35 a.m. UTC
  Add kernel-doc for DIV64_U64_ROUND_UP so that it appears in the
documentation.

Signed-off-by: Liam Beguin <liambeguin@gmail.com>
---
 include/linux/math64.h | 10 ++++++++++
 1 file changed, 10 insertions(+)
  

Comments

Randy Dunlap Nov. 17, 2022, 5:02 p.m. UTC | #1
On 11/16/22 18:35, Liam Beguin wrote:
> Add kernel-doc for DIV64_U64_ROUND_UP so that it appears in the
> documentation.
> 
> Signed-off-by: Liam Beguin <liambeguin@gmail.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  include/linux/math64.h | 10 ++++++++++
>  1 file changed, 10 insertions(+)
  

Patch

diff --git a/include/linux/math64.h b/include/linux/math64.h
index 1538844fcb51..cf3b0099674a 100644
--- a/include/linux/math64.h
+++ b/include/linux/math64.h
@@ -284,6 +284,16 @@  static inline u64 mul_u64_u32_div(u64 a, u32 mul, u32 divisor)
 
 u64 mul_u64_u64_div_u64(u64 a, u64 mul, u64 div);
 
+/**
+ * DIV64_U64_ROUND_UP - unsigned 64bit divide with 64bit divisor rounded up
+ * @ll: unsigned 64bit dividend
+ * @d: unsigned 64bit divisor
+ *
+ * Divide unsigned 64bit dividend by unsigned 64bit divisor
+ * and round up.
+ *
+ * Return: dividend / divisor rounded up
+ */
 #define DIV64_U64_ROUND_UP(ll, d)	\
 	({ u64 _tmp = (d); div64_u64((ll) + _tmp - 1, _tmp); })