Message ID | 20240530171740.2763221-1-devarsht@ti.com (mailing list archive) |
---|---|
State | Superseded |
Delegated to: | Sebastian Fricke |
Headers |
Received: from am.mirrors.kernel.org ([147.75.80.249]) by linuxtv.org with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.96) (envelope-from <linux-media+bounces-12265-patchwork=linuxtv.org@vger.kernel.org>) id 1sCjPt-0000el-2s for patchwork@linuxtv.org; Thu, 30 May 2024 17:18:18 +0000 Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by am.mirrors.kernel.org (Postfix) with ESMTPS id BC8661F23EC1 for <patchwork@linuxtv.org>; Thu, 30 May 2024 17:18:15 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 041DD4596F; Thu, 30 May 2024 17:18:07 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=ti.com header.i=@ti.com header.b="Pn5sa+IL" X-Original-To: linux-media@vger.kernel.org Received: from fllv0016.ext.ti.com (fllv0016.ext.ti.com [198.47.19.142]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 0A6AF45BEF; Thu, 30 May 2024 17:18:04 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=198.47.19.142 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1717089486; cv=none; b=ZHcIXquuF3ISuftStTX5XxCW5JJSg45PMQOECAwVAgPuXXGKxgZmkWeDXwLZXeFL7tBCip2SAcxXXO1TJJfkscIByDIuk6f4vEmegl2WP7UYYkQPtZPvB10WQgxPqofUAHrYnB379+lYu+JDYyvB2ZmNRc+3Zu8V9Vxa5gvpWd4= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1717089486; c=relaxed/simple; bh=HKE/ouW+dpFRHKVRnNexBfI90q8qQ3o8mx69I2FXR6s=; h=From:To:CC:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=Mo5vGCxmtWfGt/C4+vyYvMR2O38TOP19EkCDrbKuh5IrIRaKZBjIBuyJM4R2pPm81JE/VUIsrg2eSGmZks/eDUSmYiM4+LYxgfx7f+mLSBIBgXnOFf4jIP4TnwdUJ8svPvSK1GcPxTkGU8iPUP1Ev/U7gWFV6LJJexozdH8E83s= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=ti.com; spf=pass smtp.mailfrom=ti.com; dkim=pass (1024-bit key) header.d=ti.com header.i=@ti.com header.b=Pn5sa+IL; arc=none smtp.client-ip=198.47.19.142 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=ti.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=ti.com Received: from lelv0265.itg.ti.com ([10.180.67.224]) by fllv0016.ext.ti.com (8.15.2/8.15.2) with ESMTP id 44UHHgfr029338; Thu, 30 May 2024 12:17:42 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ti.com; s=ti-com-17Q1; t=1717089462; bh=Z6rnEc5uQxLXNameu8zQegOMDz/Ptp/LXEB7CavHlXE=; h=From:To:CC:Subject:Date:In-Reply-To:References; b=Pn5sa+IL1mgWy8SIlqTSpPzIDXQZyDsx4BWjV0wSz5wvTBOrJPIgVdIZYN1X3VyOm LPWxE+RJrihp2Te+B9eMORd1rIE8iXR9K5dIWbngRdOGWGe3p7ceQwodFHIi73E6z9 syuoXPCBMISxIFywk4VXw85I1Sv8LrdLbxPIVw3Y= Received: from DFLE115.ent.ti.com (dfle115.ent.ti.com [10.64.6.36]) by lelv0265.itg.ti.com (8.15.2/8.15.2) with ESMTPS id 44UHHg38022314 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=FAIL); Thu, 30 May 2024 12:17:42 -0500 Received: from DFLE105.ent.ti.com (10.64.6.26) by DFLE115.ent.ti.com (10.64.6.36) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.2507.23; Thu, 30 May 2024 12:17:41 -0500 Received: from lelvsmtp5.itg.ti.com (10.180.75.250) by DFLE105.ent.ti.com (10.64.6.26) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.2507.23 via Frontend Transport; Thu, 30 May 2024 12:17:41 -0500 Received: from localhost (ti.dhcp.ti.com [172.24.227.95] (may be forged)) by lelvsmtp5.itg.ti.com (8.15.2/8.15.2) with ESMTP id 44UHHfDi063295; Thu, 30 May 2024 12:17:41 -0500 From: Devarsh Thakkar <devarsht@ti.com> To: <mchehab@kernel.org>, <hverkuil-cisco@xs4all.nl>, <linux-media@vger.kernel.org>, <linux-kernel@vger.kernel.org>, <benjamin.gaignard@collabora.com>, <sebastian.fricke@collabora.com>, <akpm@linux-foundation.org>, <gregkh@linuxfoundation.org>, <andriy.shevchenko@linux.intel.com>, <adobriyan@gmail.com>, <jani.nikula@intel.com>, <p.zabel@pengutronix.de>, <airlied@gmail.com>, <daniel@ffwll.ch>, <dri-devel@lists.freedesktop.org>, <corbet@lwn.net>, <broonie@kernel.org>, <rdunlap@infradead.org>, <linux-doc@vger.kernel.org> CC: <laurent.pinchart@ideasonboard.com>, <praneeth@ti.com>, <nm@ti.com>, <vigneshr@ti.com>, <a-bhatia1@ti.com>, <j-luthra@ti.com>, <b-brnich@ti.com>, <detheridge@ti.com>, <p-mantena@ti.com>, <vijayp@ti.com>, <devarsht@ti.com>, <andrzej.p@collabora.com>, <nicolas@ndufresne.ca>, <davidgow@google.com>, <dlatypov@google.com> Subject: [PATCH v10 07/11] Documentation: core-api: Add math.h macros and functions Date: Thu, 30 May 2024 22:47:40 +0530 Message-ID: <20240530171740.2763221-1-devarsht@ti.com> X-Mailer: git-send-email 2.39.1 In-Reply-To: <20240530165925.2715837-1-devarsht@ti.com> References: <20240530165925.2715837-1-devarsht@ti.com> Precedence: bulk X-Mailing-List: linux-media@vger.kernel.org List-Id: <linux-media.vger.kernel.org> List-Subscribe: <mailto:linux-media+subscribe@vger.kernel.org> List-Unsubscribe: <mailto:linux-media+unsubscribe@vger.kernel.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-EXCLAIMER-MD-CONFIG: e1e8a2fd-e40a-4ac6-ac9b-f7e9cc9ee180 X-LSpam-Score: -3.6 (---) X-LSpam-Report: No, score=-3.6 required=5.0 tests=ARC_SIGNED=0.001,ARC_VALID=-0.1,BAYES_00=-1.9,DKIMWL_WL_HIGH=-1,DKIM_SIGNED=0.1,DKIM_VALID=-0.1,DKIM_VALID_AU=-0.1,DMARC_PASS=-0.001,HEADER_FROM_DIFFERENT_DOMAINS=0.5,MAILING_LIST_MULTI=-1,SPF_HELO_NONE=0.001,SPF_PASS=-0.001 autolearn=unavailable autolearn_force=no |
Series |
Add V4L2 M2M Driver for E5010 JPEG Encoder
|
|
Commit Message
Devarsh Thakkar
May 30, 2024, 5:17 p.m. UTC
Add documentation for rounding, scaling, absolute value and difference,
32-bit division related macros and functions exported by math.h header
file.
Signed-off-by: Devarsh Thakkar <devarsht@ti.com>
---
V1->V9 (No change)
V10: Patch introduced
---
Documentation/core-api/kernel-api.rst | 6 ++++++
1 file changed, 6 insertions(+)
Comments
On Thu, May 30, 2024 at 10:47:40PM +0530, Devarsh Thakkar wrote: > Add documentation for rounding, scaling, absolute value and difference, > 32-bit division related macros and functions exported by math.h header > file. ... > +Rounding, absolute value, scaling and 32bit division functions > +-------------------------------------------------------------- > + > +.. kernel-doc:: include/linux/math.h > + :internal: Please, double check that this is correct keyword in this case. Otherwise LGTM.
On 5/30/24 10:17 AM, Devarsh Thakkar wrote: > Add documentation for rounding, scaling, absolute value and difference, > 32-bit division related macros and functions exported by math.h header > file. > > Signed-off-by: Devarsh Thakkar <devarsht@ti.com> > --- > V1->V9 (No change) > V10: Patch introduced > --- > Documentation/core-api/kernel-api.rst | 6 ++++++ > 1 file changed, 6 insertions(+) > > diff --git a/Documentation/core-api/kernel-api.rst b/Documentation/core-api/kernel-api.rst > index ae92a2571388..fb467783d491 100644 > --- a/Documentation/core-api/kernel-api.rst > +++ b/Documentation/core-api/kernel-api.rst > @@ -185,6 +185,12 @@ Division Functions > .. kernel-doc:: lib/math/gcd.c > :export: > > +Rounding, absolute value, scaling and 32bit division functions 32-bit please. > +-------------------------------------------------------------- > + > +.. kernel-doc:: include/linux/math.h > + :internal: > + > UUID/GUID > --------- >
On 31/05/24 00:51, Andy Shevchenko wrote: > On Thu, May 30, 2024 at 10:47:40PM +0530, Devarsh Thakkar wrote: >> Add documentation for rounding, scaling, absolute value and difference, >> 32-bit division related macros and functions exported by math.h header >> file. > > ... > >> +Rounding, absolute value, scaling and 32bit division functions >> +-------------------------------------------------------------- >> + >> +.. kernel-doc:: include/linux/math.h >> + :internal: > > Please, double check that this is correct keyword in this case. > Yes, this is inline as per what is described here [1] as there are no export symbols in the header. Also the rendered output looks good. [1] : https://docs.kernel.org/doc-guide/kernel-doc.html#:~:text=net/mac80211/*.c-,internal,-%3A%20%5Bsource%2Dpattern Regards Devarsh
Hi Randy, Thanks for the review. On 31/05/24 04:14, Randy Dunlap wrote: > > > On 5/30/24 10:17 AM, Devarsh Thakkar wrote: >> Add documentation for rounding, scaling, absolute value and difference, >> 32-bit division related macros and functions exported by math.h header >> file. >> >> Signed-off-by: Devarsh Thakkar <devarsht@ti.com> >> --- >> V1->V9 (No change) >> V10: Patch introduced >> --- >> Documentation/core-api/kernel-api.rst | 6 ++++++ >> 1 file changed, 6 insertions(+) >> >> diff --git a/Documentation/core-api/kernel-api.rst b/Documentation/core-api/kernel-api.rst >> index ae92a2571388..fb467783d491 100644 >> --- a/Documentation/core-api/kernel-api.rst >> +++ b/Documentation/core-api/kernel-api.rst >> @@ -185,6 +185,12 @@ Division Functions >> .. kernel-doc:: lib/math/gcd.c >> :export: >> >> +Rounding, absolute value, scaling and 32bit division functions > > 32-bit > please. > Good catch. Also I see some division functions supporting non-32bit functions too, so I would make it as below : Rounding, absolute value, division and 32-bit scaling functions --------------------------------------------------------------- Regards Devarsh
diff --git a/Documentation/core-api/kernel-api.rst b/Documentation/core-api/kernel-api.rst index ae92a2571388..fb467783d491 100644 --- a/Documentation/core-api/kernel-api.rst +++ b/Documentation/core-api/kernel-api.rst @@ -185,6 +185,12 @@ Division Functions .. kernel-doc:: lib/math/gcd.c :export: +Rounding, absolute value, scaling and 32bit division functions +-------------------------------------------------------------- + +.. kernel-doc:: include/linux/math.h + :internal: + UUID/GUID ---------