From: Devarsh Thakkar <devarsht@ti.com>
To: <mchehab@kernel.org>, <hverkuil-cisco@xs4all.nl>,
<linux-media@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
<sebastian.fricke@collabora.com>, <linux-doc@vger.kernel.org>
Cc: <praneeth@ti.com>, <nm@ti.com>, <vigneshr@ti.com>,
<s-jain1@ti.com>, <r-donadkar@ti.com>, <b-brnich@ti.com>,
<detheridge@ti.com>, <p-mantena@ti.com>, <vijayp@ti.com>,
<devarsht@ti.com>, <andi.shyti@linux.intel.com>,
<nicolas@ndufresne.ca>, <andriy.shevchenko@linux.intel.com>,
<jirislaby@kernel.org>, <davidgow@google.com>,
<dlatypov@google.com>, <corbet@lwn.net>, <broonie@kernel.org>,
<jani.nikula@intel.com>, <rdunlap@infradead.org>,
<nik.borisov@suse.com>, <Dave.Martin@arm.com>
Subject: [PATCH v2 2/6] math.h: Use kernel-doc syntax for division macros
Date: Mon, 26 Aug 2024 20:38:18 +0530 [thread overview]
Message-ID: <20240826150822.4057164-3-devarsht@ti.com> (raw)
In-Reply-To: <20240826150822.4057164-1-devarsht@ti.com>
Enable reST documentation for division macros DIV_ROUND_CLOSEST and
DIV_ROUND_CLOSEST_ULL by using kernel-doc markup and syntax for documenting
them.
Signed-off-by: Devarsh Thakkar <devarsht@ti.com>
---
V2: Fix spelling for division and reST
---
include/linux/math.h | 23 +++++++++++++++++------
1 file changed, 17 insertions(+), 6 deletions(-)
diff --git a/include/linux/math.h b/include/linux/math.h
index b59a02a007d7..f3ba3ebe4fcb 100644
--- a/include/linux/math.h
+++ b/include/linux/math.h
@@ -140,9 +140,14 @@
*/
#define roundclosest(x, y) roundup((x) - (y) / 2, (y))
-/*
- * Divide positive or negative dividend by positive or negative divisor
- * and round to closest integer. Result is undefined for negative
+/**
+ * DIV_ROUND_CLOSEST - Divide positive or negative dividend by positive or
+ * negative divisor and round to closest value
+ * @x: dividend value
+ * @divisor: divisor value
+ *
+ * Divide positive or negative dividend value @x by positive or negative
+ * @divisor value and round to closest integer. Result is undefined for negative
* divisors if the dividend variable type is unsigned and for negative
* dividends if the divisor variable type is unsigned.
*/
@@ -157,9 +162,15 @@
(((__x) - ((__d) / 2)) / (__d)); \
} \
)
-/*
- * Same as above but for u64 dividends. divisor must be a 32-bit
- * number.
+
+/**
+ * DIV_ROUND_CLOSEST_ULL - Divide 64-bit unsigned dividend by 32-bit divisor and
+ * round to closest value
+ * @x: unsigned 64-bit dividend
+ * @divisor: 32-bit divisor
+ *
+ * Divide unsigned 64-bit dividend value @x by 32-bit @divisor value
+ * and round to closest integer. Result is undefined for negative divisors.
*/
#define DIV_ROUND_CLOSEST_ULL(x, divisor)( \
{ \
--
2.39.1
next prev parent reply other threads:[~2024-08-26 15:08 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-08-26 15:08 [PATCH v2 0/6] Add rounding macros and enable KUnit tests Devarsh Thakkar
2024-08-26 15:08 ` [PATCH v2 1/6] math.h: Add macros for rounding to the closest value Devarsh Thakkar
2024-08-26 17:44 ` Andy Shevchenko
2024-08-27 11:27 ` Devarsh Thakkar
2024-08-27 12:40 ` Jani Nikula
2024-08-27 15:14 ` Devarsh Thakkar
2024-08-29 9:19 ` Jani Nikula
2024-08-29 9:54 ` Jiri Slaby
2024-08-30 16:09 ` Devarsh Thakkar
2024-09-30 1:18 ` Randy Dunlap
2024-08-30 13:45 ` Dave Martin
2024-08-26 15:08 ` Devarsh Thakkar [this message]
2024-08-26 15:08 ` [PATCH v2 3/6] Documentation: core-api: Add math.h macros and functions Devarsh Thakkar
2024-08-26 15:08 ` [PATCH v2 4/6] lib: Add basic KUnit test for lib/math Devarsh Thakkar
2024-08-26 15:08 ` [PATCH v2 5/6] lib: math_kunit: Add tests for new macros related to rounding to nearest value Devarsh Thakkar
2024-08-30 14:07 ` Dave Martin
2024-08-26 15:08 ` [PATCH v2 6/6] media: imagination: Round to closest multiple for cropping region Devarsh Thakkar
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240826150822.4057164-3-devarsht@ti.com \
--to=devarsht@ti.com \
--cc=Dave.Martin@arm.com \
--cc=andi.shyti@linux.intel.com \
--cc=andriy.shevchenko@linux.intel.com \
--cc=b-brnich@ti.com \
--cc=broonie@kernel.org \
--cc=corbet@lwn.net \
--cc=davidgow@google.com \
--cc=detheridge@ti.com \
--cc=dlatypov@google.com \
--cc=hverkuil-cisco@xs4all.nl \
--cc=jani.nikula@intel.com \
--cc=jirislaby@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=mchehab@kernel.org \
--cc=nicolas@ndufresne.ca \
--cc=nik.borisov@suse.com \
--cc=nm@ti.com \
--cc=p-mantena@ti.com \
--cc=praneeth@ti.com \
--cc=r-donadkar@ti.com \
--cc=rdunlap@infradead.org \
--cc=s-jain1@ti.com \
--cc=sebastian.fricke@collabora.com \
--cc=vigneshr@ti.com \
--cc=vijayp@ti.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.