From patchwork Thu Dec 7 21:05:44 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 175375 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:bcd1:0:b0:403:3b70:6f57 with SMTP id r17csp5062951vqy; Thu, 7 Dec 2023 13:06:07 -0800 (PST) X-Google-Smtp-Source: AGHT+IEcwZzgX/pAxKlsJcftpGBs+v4Czp+fKkR1R6KrfnQhmFLfwn1V2StG4lk7fQmJhTD7UJ6v X-Received: by 2002:a17:902:dac1:b0:1d0:5878:d4e7 with SMTP id q1-20020a170902dac100b001d05878d4e7mr3102078plx.10.1701983167447; Thu, 07 Dec 2023 13:06:07 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1701983167; cv=none; d=google.com; s=arc-20160816; b=0k2GEsmYx1mNf30OuVsXtzU61TjZa2Ri2/wf9sfb6rv0igyKMzUxMVCR2Zaquw/OHE pa+BpJGI0yOR3PsNMgnGvktihCeg2kHOBYYBEFxuKzD/rWh25psAXkwygJDnYIHJDULe S23L0Lg1+BXOOQa2qsHnocp8eZtLl6JhaYStF5MlCPaSkOyp8VQBwklJaMMt98wdeqMB qLM91vcFEA0r9CQMqQFLYdQt5L5DCCm/puTugzDGifV0Gyk3GyNcWfoRac0z//2DMBiw d554CSa2bbkUugjMW1Q0hmWGyLYTQgfaBlSOTpetuy+Eq9xbZMx1EzOF0/FywC97aTZZ UWxA== 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=6mtDC5GyUcoPI4rKNkhKWA7ZG2rDUkEgJdjJjzhZ94c=; fh=MVN8dvpG9w/7LcjxGbdfOtkYY9yQJWtf+RvN8rZi7cE=; b=LW06QdEzcXnEcbWG+aHX9UVYzF2+ZgROi+sKsph+JkaZ6uMqWAlUVgF0tBSSEFCyuK cq0p91ClJ9/J97olKaj7+VdyfT7zSI6eel5wnRY3mKuhPNtadOLb0hM6jAf/xsWZgIAW p66vhgAu55YsyMOTng4bxIenMJqJVsXnLza8sdN0VoMTxXHATm2NM0AKxOgPPYVDp1+0 xuZ6HtWMTb77CtEg4qJlHVsKpivnomviMLIaKtJLzuS16ir1/1VI872vLfQrtoOLm1x2 KIvO2E8sCAg/afTVubQM6g75DHBdf2Pysk3jkoTrcHIkiJ+en29Eh+e6Ah5BQQ3KtvTm Q6dA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=4q8mQkhl; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.31 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from morse.vger.email (morse.vger.email. [23.128.96.31]) by mx.google.com with ESMTPS id jd13-20020a170903260d00b001cfcd31f2cdsi328117plb.168.2023.12.07.13.06.07 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 07 Dec 2023 13:06:07 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.31 as permitted sender) client-ip=23.128.96.31; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=4q8mQkhl; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.31 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by morse.vger.email (Postfix) with ESMTP id 2763C803EBBA; Thu, 7 Dec 2023 13:06:05 -0800 (PST) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.11 at morse.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231699AbjLGVFy (ORCPT + 99 others); Thu, 7 Dec 2023 16:05:54 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:41246 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1443938AbjLGVFp (ORCPT ); Thu, 7 Dec 2023 16:05:45 -0500 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 4AE0F1718 for ; Thu, 7 Dec 2023 13:05:48 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:References:In-Reply-To:Message-ID:Date:Subject:Cc:To:From:Sender :Reply-To:Content-Type:Content-ID:Content-Description; bh=6mtDC5GyUcoPI4rKNkhKWA7ZG2rDUkEgJdjJjzhZ94c=; b=4q8mQkhll5nY6RobrfcUqzBcV5 VXEEGiTi59nu5dDNL8//BSo9M8yFRxHcLVGtrZ5mi0URHztQo9Fo5j2gBKxQ1W9qxLJiHhw5vqMrI qgpqsAzIQSKPetUluyCwJWp/w266x6ialZVj1c0TO6/DD3d3C4dp6UzrxOmv2C/3Dda+fYsOXgBQD +BsS53MBUF6KMc62PN1Ra0LEMB7lgdWiqUmanbDXeeuguoS471rZLO+spMtBLskoeMv4FQbHZNsTs voZepPukBBx4Maeu0nQr5/aowabC55JmFH2Y84+l53vvgdRYG+QlSs/M5jI9RS/nCOSXYLZF1/u9V lQODa0aQ==; Received: from [50.53.46.231] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1rBLZ6-00Duw1-0Q; Thu, 07 Dec 2023 21:05:48 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Dan Williams , Vishal Verma , Dave Jiang , Ira Weiny , nvdimm@lists.linux.dev Subject: [PATCH 2/3] nvdimm/dimm_devs: fix kernel-doc for function params Date: Thu, 7 Dec 2023 13:05:44 -0800 Message-ID: <20231207210545.24056-2-rdunlap@infradead.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20231207210545.24056-1-rdunlap@infradead.org> References: <20231207210545.24056-1-rdunlap@infradead.org> MIME-Version: 1.0 X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on morse.vger.email Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (morse.vger.email [0.0.0.0]); Thu, 07 Dec 2023 13:06:05 -0800 (PST) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1784658701728546401 X-GMAIL-MSGID: 1784658701728546401 Adjust kernel-doc notation to prevent warnings when using -Wall. dimm_devs.c:59: warning: Function parameter or member 'ndd' not described in 'nvdimm_init_nsarea' dimm_devs.c:59: warning: Excess function parameter 'nvdimm' description in 'nvdimm_init_nsarea' dimm_devs.c:59: warning: No description found for return value of 'nvdimm_init_nsarea' dimm_devs.c:728: warning: No description found for return value of 'nd_pmem_max_contiguous_dpa' dimm_devs.c:773: warning: No description found for return value of 'nd_pmem_available_dpa' dimm_devs.c:844: warning: Function parameter or member 'ndd' not described in 'nvdimm_allocated_dpa' dimm_devs.c:844: warning: Excess function parameter 'nvdimm' description in 'nvdimm_allocated_dpa' dimm_devs.c:844: warning: No description found for return value of 'nvdimm_allocated_dpa' Signed-off-by: Randy Dunlap Cc: Dan Williams Cc: Vishal Verma Cc: Dave Jiang Cc: Ira Weiny Cc: nvdimm@lists.linux.dev --- drivers/nvdimm/dimm_devs.c | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff -- a/drivers/nvdimm/dimm_devs.c b/drivers/nvdimm/dimm_devs.c --- a/drivers/nvdimm/dimm_devs.c +++ b/drivers/nvdimm/dimm_devs.c @@ -53,7 +53,10 @@ static int validate_dimm(struct nvdimm_d /** * nvdimm_init_nsarea - determine the geometry of a dimm's namespace area - * @nvdimm: dimm to initialize + * @ndd: dimm to initialize + * + * Returns: %0 if the area is already valid, -errno on error, otherwise an + * ND_CMD_* status code. */ int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd) { @@ -722,6 +725,9 @@ static unsigned long dpa_align(struct nd * contiguous unallocated dpa range. * @nd_region: constrain available space check to this reference region * @nd_mapping: container of dpa-resource-root + labels + * + * Returns: %0 if there is an alignment error, otherwise the max + * unallocated dpa range */ resource_size_t nd_pmem_max_contiguous_dpa(struct nd_region *nd_region, struct nd_mapping *nd_mapping) @@ -767,6 +773,8 @@ resource_size_t nd_pmem_max_contiguous_d * * Validate that a PMEM label, if present, aligns with the start of an * interleave set. + * + * Returns: %0 if there is an alignment error, otherwise the unallocated dpa */ resource_size_t nd_pmem_available_dpa(struct nd_region *nd_region, struct nd_mapping *nd_mapping) @@ -836,8 +844,10 @@ struct resource *nvdimm_allocate_dpa(str /** * nvdimm_allocated_dpa - sum up the dpa currently allocated to this label_id - * @nvdimm: container of dpa-resource-root + labels + * @ndd: container of dpa-resource-root + labels * @label_id: dpa resource name of the form pmem- + * + * Returns: sum of the dpa allocated to the label_id */ resource_size_t nvdimm_allocated_dpa(struct nvdimm_drvdata *ndd, struct nd_label_id *label_id)