cxl/region: describe targets and nr_targets members of cxl_region_params

bagasme · djbw · commit 038e6eb80387 · 2022-08-05T08:41:02.000-07:00
Sphinx reported undescribed parameters in cxl_region_params struct: ./drivers/cxl/cxl.h:376: warning: Function parameter or member 'targets' not described in 'cxl_region_params' ./drivers/cxl/cxl.h:376: warning: Function parameter or member 'nr_targets' not described in 'cxl_region_params' Describe these members. Fixes: b9686e8 ("cxl/region: Enable the assignment of endpoint decoders to regions") Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> Link: https://lore.kernel.org/r/20220804075448.98241-3-bagasdotme@gmail.com Signed-off-by: Dan Williams <dan.j.williams@intel.com>
diff --git a/drivers/cxl/cxl.h b/drivers/cxl/cxl.h
@@ -364,6 +364,8 @@ enum cxl_config_state {
  * @interleave_ways: number of endpoints in the region
  * @interleave_granularity: capacity each endpoint contributes to a stripe
  * @res: allocated iomem capacity for this region
+ * @targets: active ordered targets in current decoder configuration
+ * @nr_targets: number of targets
  *
  * State transitions are protected by the cxl_region_rwsem
  */

Original file line number	Diff line number	Diff line change
`@@ -364,6 +364,8 @@ enum cxl_config_state {`
`364`	`364`	`* @interleave_ways: number of endpoints in the region`
`365`	`365`	`* @interleave_granularity: capacity each endpoint contributes to a stripe`
`366`	`366`	`* @res: allocated iomem capacity for this region`
	`367`	`+ * @targets: active ordered targets in current decoder configuration`
	`368`	`+ * @nr_targets: number of targets`
`367`	`369`	`*`
`368`	`370`	`* State transitions are protected by the cxl_region_rwsem`
`369`	`371`	`*/`