Commit 0e2b3d54 authored by Randy Dunlap's avatar Randy Dunlap Committed by Ira Weiny
Browse files

nvdimm/dimm_devs: fix kernel-doc for function params 



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'

[iweiny: drop ND_CMD_* status code]

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Cc: Dan Williams <dan.j.williams@intel.com>
Cc: Vishal Verma <vishal.l.verma@intel.com>
Cc: Dave Jiang <dave.jiang@intel.com>
Cc: Ira Weiny <ira.weiny@intel.com>
Cc:  <nvdimm@lists.linux.dev>
Link: https://lore.kernel.org/r/20231207210545.24056-2-rdunlap@infradead.org


Signed-off-by: default avatarIra Weiny <ira.weiny@intel.com>
parent b1921141

drivers/nvdimm/dimm_devs.c

+11 −2
Original line number Diff line number Diff line
@@ -53,7 +53,9 @@ static int validate_dimm(struct nvdimm_drvdata *ndd) 


/**

 * 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

 */

int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd)

{
@@ -722,6 +724,9 @@ static unsigned long dpa_align(struct nd_region *nd_region) 
 *			   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 +772,8 @@ resource_size_t nd_pmem_max_contiguous_dpa(struct nd_region *nd_region, 
 *

 * 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 +843,10 @@ struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd, 


/**

 * 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-<human readable uuid>

 *

 * 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)