From patchwork Thu Nov 17 02:35:09 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Liam Beguin X-Patchwork-Id: 21384 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:f944:0:0:0:0:0 with SMTP id q4csp180542wrr; Wed, 16 Nov 2022 18:47:43 -0800 (PST) X-Google-Smtp-Source: AA0mqf5reJXhyul8Dx1i3rwD4+DCAe2TYrRlWlHOnQAqYAOOwiCskcBzFvqoS8QGLbXmMIVgHHLr X-Received: by 2002:a17:903:428d:b0:184:dc59:cc9f with SMTP id ju13-20020a170903428d00b00184dc59cc9fmr773700plb.89.1668653263108; Wed, 16 Nov 2022 18:47:43 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1668653263; cv=none; d=google.com; s=arc-20160816; b=HTlBv5XFkDaKppxzQaeVD8h5luw8YEYeQqJg/X9ukNQdlHA+XzbNQ8EbSG4wcMps44 UTymSqR/yFb2+NbD1dVWC6r6kiJOAyHL2eals6DMwvwWa6QBf7M9jHXqm4KNj6frUmvh Ar5n3I+0N/5MSLGhbz3MrbXQDxIcC2oGq33G6SA4cQ9RK1qw0mm97ZBK4AmxcOUPUFE6 VT8Wipw8+QNYxlZGHH+XxKMVISlDozIGvuWwhOm9LHDeT9Me+69ifg4sbl8ZeW7BYjHD YEyMlqfsAWrFUcIhndBtsg3nKquRrsn95O+9kstOBbWAHU8i7Brovr/6fxVvDiXSHd2U 1Frg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=1R6WF366RVPx4k/kufiGJ4ymsD6DvKzhVq3zPc5qv00=; b=EYjDsxjUdsNySJbOMSFwb4OrNKCJw0bVuM2DZXsZfD7KmrtXltVW7aNDQ79X6YT/3Q zjJcCUNVeLooMmqsHsWiBbb+myHNfMiZneOyuxK3/uKaY9Z+j1Ybdk9jyYq2MwGTO/Tu fdgklVpL9hExTzjfNgReHvsLqnkUau0qJMKoeGoZQSVlZpVtIda5dOaAXetNSiKqOg7u gihcjlWwbWFTsvQ1ReaDlqLAGqCLWsWifsCus+hwScVPe/Of6+d9fnDv6uFQ0gQbtk3g NlJp+ENmJ2E4vtqLjldBRR3EZM7BZiKlvA3kP6l+/K2ez/mzF/CKq7a8KQ7N7dFjDLIY ymnA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=P8m96K1Z; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id g11-20020a63200b000000b0043c3747f236si16751297pgg.367.2022.11.16.18.47.28; Wed, 16 Nov 2022 18:47:43 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=P8m96K1Z; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238865AbiKQCfe (ORCPT + 99 others); Wed, 16 Nov 2022 21:35:34 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:59226 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232809AbiKQCfa (ORCPT ); Wed, 16 Nov 2022 21:35:30 -0500 Received: from mail-qk1-x72c.google.com (mail-qk1-x72c.google.com [IPv6:2607:f8b0:4864:20::72c]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 4C0B01AF0F; Wed, 16 Nov 2022 18:35:29 -0800 (PST) Received: by mail-qk1-x72c.google.com with SMTP id x18so361344qki.4; Wed, 16 Nov 2022 18:35:29 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=1R6WF366RVPx4k/kufiGJ4ymsD6DvKzhVq3zPc5qv00=; b=P8m96K1ZioaHAYdCVkO+NZQXHaF7XDUUGmXvKGDFEW9ZzDAXCXi+XcjwpkvbideCj3 mWjAXyFV1eygBgdobg+luk2umR/0fM+uutXcUDkwUvifrndPbnZ/O0JWtpnyqOrq0zoX IsbRMaTO8BGzqfqy4TVVrzdH9WRX+KspQ3RW85cc35KKYqMB7zCLFmKaX2ZcCBFJJjnz IpMDDNTEok5pB73Q+p/UkV01rOMgQh+wbb9O5CDHV9OmLRRE5l6TjSZf7Iu6ve/3zijG rfRBmxG5/xdukSR5hAtaowez4U92dnC8M85rEqs1DcX1r2z+DtfGX+B4ps4Wj7ho0Ll3 5LRA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=1R6WF366RVPx4k/kufiGJ4ymsD6DvKzhVq3zPc5qv00=; b=bACVz7rQuFpmt9mJPH3NRJYEAibxJ8gzpJnh3Wv4JgacmMj/nSNf9JV5Ui7FBcmH0W MeJlJfol9APawN+eEg8ObEpMPOZ9eK9QssNtdNUpyuo+GFzpjb1uHT0YxTPWr+yOu+Fd LtMMRSL/V9Dzk+GRNe2sxGk+tl7n4GODSNyIlaCsBQAd3Aut+vYQcvEEg7WijP7qLzvl +f5SSzHmeulSDJe0kqENJix5t19APGTTLARYvS/rXP5K0aHTiteQAuyyyyStlNf2C6YI ACI1h4cjDWLEUXIQQsrVcwVqra5e8HxiYVdGYPz+i0QTVWGdUdSMTxud0u/5gKa4nf33 9KtQ== X-Gm-Message-State: ANoB5pnlnbd50/EIOJkXxBlCLeS4hdIpA+GTbxVI+xvo3YJXemDwh++g rVNC4EW0Dkh9NkxQYGCBCXs5oMPe3ZI= X-Received: by 2002:ae9:dc01:0:b0:6fa:aee9:9d40 with SMTP id q1-20020ae9dc01000000b006faaee99d40mr199237qkf.194.1668652528413; Wed, 16 Nov 2022 18:35:28 -0800 (PST) Received: from shaak.xiphos.ca (modemcable055.92-163-184.mc.videotron.ca. [184.163.92.55]) by smtp.gmail.com with ESMTPSA id v5-20020a05620a0f0500b006eec09eed39sm11311888qkl.40.2022.11.16.18.35.27 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 16 Nov 2022 18:35:27 -0800 (PST) From: Liam Beguin To: liambeguin@gmail.com, corbet@lwn.net Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v1 1/2] math64: favor kernel-doc from header files Date: Wed, 16 Nov 2022 21:35:09 -0500 Message-Id: <20221117023510.2338176-1-liambeguin@gmail.com> X-Mailer: git-send-email 2.37.1.223.g6a475b71f8c4 MIME-Version: 1.0 X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM, RCVD_IN_DNSWL_NONE,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1749709764184118733?= X-GMAIL-MSGID: =?utf-8?q?1749709764184118733?= Fix the kernel-doc markings for div64 functions to point to the header file instead of the lib/ directory. This avoids having implementation specific comments in generic documentation. Furthermore, given that some kernel-doc comments are identical, drop them from lib/math64 and only keep there comments that add implementation details. Signed-off-by: Liam Beguin Acked-by: Randy Dunlap Tested-by: Randy Dunlap --- Documentation/core-api/kernel-api.rst | 3 --- include/linux/math64.h | 12 ++++++------ lib/math/div64.c | 15 ++------------- 3 files changed, 8 insertions(+), 22 deletions(-) base-commit: 59d0d52c30d4991ac4b329f049cc37118e00f5b0 diff --git a/Documentation/core-api/kernel-api.rst b/Documentation/core-api/kernel-api.rst index 06f4ab122697..c9412eb85552 100644 --- a/Documentation/core-api/kernel-api.rst +++ b/Documentation/core-api/kernel-api.rst @@ -171,9 +171,6 @@ Division Functions .. kernel-doc:: include/linux/math64.h :internal: -.. kernel-doc:: lib/math/div64.c - :functions: div_s64_rem div64_u64_rem div64_u64 div64_s64 - .. kernel-doc:: lib/math/gcd.c :export: diff --git a/include/linux/math64.h b/include/linux/math64.h index a14f40de1dca..1538844fcb51 100644 --- a/include/linux/math64.h +++ b/include/linux/math64.h @@ -29,7 +29,7 @@ static inline u64 div_u64_rem(u64 dividend, u32 divisor, u32 *remainder) return dividend / divisor; } -/* +/** * div_s64_rem - signed 64bit divide with 32bit divisor with remainder * @dividend: signed 64bit dividend * @divisor: signed 32bit divisor @@ -43,7 +43,7 @@ static inline s64 div_s64_rem(s64 dividend, s32 divisor, s32 *remainder) return dividend / divisor; } -/* +/** * div64_u64_rem - unsigned 64bit divide with 64bit divisor and remainder * @dividend: unsigned 64bit dividend * @divisor: unsigned 64bit divisor @@ -57,7 +57,7 @@ static inline u64 div64_u64_rem(u64 dividend, u64 divisor, u64 *remainder) return dividend / divisor; } -/* +/** * div64_u64 - unsigned 64bit divide with 64bit divisor * @dividend: unsigned 64bit dividend * @divisor: unsigned 64bit divisor @@ -69,7 +69,7 @@ static inline u64 div64_u64(u64 dividend, u64 divisor) return dividend / divisor; } -/* +/** * div64_s64 - signed 64bit divide with 64bit divisor * @dividend: signed 64bit dividend * @divisor: signed 64bit divisor @@ -300,7 +300,7 @@ u64 mul_u64_u64_div_u64(u64 a, u64 mul, u64 div); #define DIV64_U64_ROUND_CLOSEST(dividend, divisor) \ ({ u64 _tmp = (divisor); div64_u64((dividend) + _tmp / 2, _tmp); }) -/* +/** * DIV_U64_ROUND_CLOSEST - unsigned 64bit divide with 32bit divisor rounded to nearest integer * @dividend: unsigned 64bit dividend * @divisor: unsigned 32bit divisor @@ -313,7 +313,7 @@ u64 mul_u64_u64_div_u64(u64 a, u64 mul, u64 div); #define DIV_U64_ROUND_CLOSEST(dividend, divisor) \ ({ u32 _tmp = (divisor); div_u64((u64)(dividend) + _tmp / 2, _tmp); }) -/* +/** * DIV_S64_ROUND_CLOSEST - signed 64bit divide with 32bit divisor rounded to nearest integer * @dividend: signed 64bit dividend * @divisor: signed 32bit divisor diff --git a/lib/math/div64.c b/lib/math/div64.c index 46866394fc84..55a81782e271 100644 --- a/lib/math/div64.c +++ b/lib/math/div64.c @@ -63,12 +63,6 @@ uint32_t __attribute__((weak)) __div64_32(uint64_t *n, uint32_t base) EXPORT_SYMBOL(__div64_32); #endif -/** - * div_s64_rem - signed 64bit divide with 64bit divisor and remainder - * @dividend: 64bit dividend - * @divisor: 64bit divisor - * @remainder: 64bit remainder - */ #ifndef div_s64_rem s64 div_s64_rem(s64 dividend, s32 divisor, s32 *remainder) { @@ -89,7 +83,7 @@ s64 div_s64_rem(s64 dividend, s32 divisor, s32 *remainder) EXPORT_SYMBOL(div_s64_rem); #endif -/** +/* * div64_u64_rem - unsigned 64bit divide with 64bit divisor and remainder * @dividend: 64bit dividend * @divisor: 64bit divisor @@ -129,7 +123,7 @@ u64 div64_u64_rem(u64 dividend, u64 divisor, u64 *remainder) EXPORT_SYMBOL(div64_u64_rem); #endif -/** +/* * div64_u64 - unsigned 64bit divide with 64bit divisor * @dividend: 64bit dividend * @divisor: 64bit divisor @@ -163,11 +157,6 @@ u64 div64_u64(u64 dividend, u64 divisor) EXPORT_SYMBOL(div64_u64); #endif -/** - * div64_s64 - signed 64bit divide with 64bit divisor - * @dividend: 64bit dividend - * @divisor: 64bit divisor - */ #ifndef div64_s64 s64 div64_s64(s64 dividend, s64 divisor) { From patchwork Thu Nov 17 02:35:10 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Liam Beguin X-Patchwork-Id: 21385 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:f944:0:0:0:0:0 with SMTP id q4csp181125wrr; Wed, 16 Nov 2022 18:50:12 -0800 (PST) X-Google-Smtp-Source: AA0mqf7FpZOMiS3m+HBo7tOl5D48Oa/8C8NpSpLxjTgaOe+UgopaZmv9lcWbkuK80/DmsKeKXrrm X-Received: by 2002:a17:90b:3c0a:b0:212:510b:5851 with SMTP id pb10-20020a17090b3c0a00b00212510b5851mr733726pjb.57.1668653412470; Wed, 16 Nov 2022 18:50:12 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1668653412; cv=none; d=google.com; s=arc-20160816; b=APe0ujJzfrxbi1Op18rZU4VLOnTGQq7+ZweJO01tf8CtMJzgkm52g6aNtNKQbFIu9x jVFWEGoJKb/FB7bk4UJaLxxa0PnXmswDn2BwEdolpWFdZ5j3PjdxC5etfOS6C1afJEF4 koAk0pVfXyyBRCsDk7sumX60KtpzIA/8LVrBENiXBBJ/5P7Uh9Dlm4g5SmOMFj8NFy/Z 7SWUX10TPds4q+PdvbwMPW2/3OEjlbowCfqgO90ZlAqTUYt/wE6ahNxW5shVtvbI+cgA l3AjdxFTKYZGb1rqk9UHosSPxmzdPqnDwYCOtCAZQWED5pJuieG0g5Xm2v3S+oEmOCpW 6ICg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=QqARHLyM93858hT/zUtYfVfE9lsDDkBej8c72F7kBKA=; b=f3AwuEvm2ySIzPPxzIhqPxsbFeqE6r+OMqgKURd4DVweeyMJAu/UmuO8zfW2ePcjVD i3bW3KqzZXXdWCrm7aJUCIN1o6eDO5XEfZtOMXAVujWrBitl28BdWQljgYYYqdzWuaWb 9uf9vdY7cjwgSA9lTfcWVurh261ftiLJ+w8xjqcrvyykkD6v3qnGnU9ulF+uyEkXkK+r Cm+AT15VLFeKgMBTHHRw3P5LASq+nGe6igb19cHSMFkvZm3TnapxLd/NEmmJ6FgNYYhi ISdNyqnXrcbXeAF5UDY4n4Las6zNAG6aI8Xozv3E5FXpkkoaMJMjgW4EgCSO3kn1FYG8 eoDg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=bLxEWBRo; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id k4-20020a170902c40400b001889ad48288si17074927plk.384.2022.11.16.18.49.59; Wed, 16 Nov 2022 18:50:12 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=bLxEWBRo; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238829AbiKQCfi (ORCPT + 99 others); Wed, 16 Nov 2022 21:35:38 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:59232 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234513AbiKQCfc (ORCPT ); Wed, 16 Nov 2022 21:35:32 -0500 Received: from mail-qk1-x732.google.com (mail-qk1-x732.google.com [IPv6:2607:f8b0:4864:20::732]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E33702E9DB; Wed, 16 Nov 2022 18:35:30 -0800 (PST) Received: by mail-qk1-x732.google.com with SMTP id k2so350909qkk.7; Wed, 16 Nov 2022 18:35:30 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=QqARHLyM93858hT/zUtYfVfE9lsDDkBej8c72F7kBKA=; b=bLxEWBRozQYASr45/ecjEYgRpvqNtmBKo9VXhMeNTTTuygjewjl8vqI/xwTmxNfMve uoFd9sqirHtC5RJT9EYfaCqm3vveeyb7jY4GqbpGwN11IDTF/7wsYo1NbOXrgvIflUSi 92chBTGabPnUeEWaHd7y4EqBeMxQ7MrhqjMMyefsUSVDK6dZaUyNeopgKyrUgqGYQKsD zXldSaRxQi+ZXkWJ53LuhX9JhU2CXP/W5S6swYWKm4olf3f9YJgq7K8cxiNTWyfV0i/R h4wAdFmYaCgVJRWRwxGJj/Vk9XWXHZMvZts1pQiMNOt71hxLz0a+k04siHaSlahReVzX yg7w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=QqARHLyM93858hT/zUtYfVfE9lsDDkBej8c72F7kBKA=; b=l76DVN+ZrWFXVIM0hzbgkd53m9tG0KKORyKq4yFO7/BvZsM1binqLv1E9BmMqqi2P6 fd3S/Kb4ofcAxBkM7XC9KWj9tURrGCJRJYb6g6IAfCb2CRr5Hbo6GsE9P7USfq99IcnF dRl9pZbjgbV+tWu649mnELQLotEs0wgOpPTKame3fEkdxDJQWLT6hBkdOSUeFKWcwK7t P5WkmuA/AGrjmNYduHUkfB0kCWySwgmWX540nSnAfza4Dqrbqu7e2G/u5DGYy+n4F6Yy 9JE2BADpgTpNrqNdoqCVYDwMwi6jf0dyJ/ymcj2k7MVY/oUW3J1i0uH9Cj6SQHYewU35 PDIQ== X-Gm-Message-State: ANoB5pmjlwyHR4tnDaP5gz2e3kOZu0nVD8l+q0EB9b5DTM4mywU358On JaUXOGwgBD/z7OVN0gzBUwVxxVYG/hU= X-Received: by 2002:ae9:ee01:0:b0:6ee:ca70:6451 with SMTP id i1-20020ae9ee01000000b006eeca706451mr146447qkg.545.1668652529530; Wed, 16 Nov 2022 18:35:29 -0800 (PST) Received: from shaak.xiphos.ca (modemcable055.92-163-184.mc.videotron.ca. [184.163.92.55]) by smtp.gmail.com with ESMTPSA id v5-20020a05620a0f0500b006eec09eed39sm11311888qkl.40.2022.11.16.18.35.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 16 Nov 2022 18:35:28 -0800 (PST) From: Liam Beguin To: liambeguin@gmail.com, corbet@lwn.net Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v1 2/2] math64: add kernel-doc for DIV64_U64_ROUND_UP Date: Wed, 16 Nov 2022 21:35:10 -0500 Message-Id: <20221117023510.2338176-2-liambeguin@gmail.com> X-Mailer: git-send-email 2.37.1.223.g6a475b71f8c4 In-Reply-To: <20221117023510.2338176-1-liambeguin@gmail.com> References: <20221117023510.2338176-1-liambeguin@gmail.com> MIME-Version: 1.0 X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM, RCVD_IN_DNSWL_NONE,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1749709920619803325?= X-GMAIL-MSGID: =?utf-8?q?1749709920619803325?= Add kernel-doc for DIV64_U64_ROUND_UP so that it appears in the documentation. Signed-off-by: Liam Beguin Acked-by: Randy Dunlap Tested-by: Randy Dunlap --- include/linux/math64.h | 10 ++++++++++ 1 file changed, 10 insertions(+) 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); })