On Fri, 16 Aug 2024 09:44:11 -0500
Ira Weiny <ira.we...@intel.com> wrote:
> The device DAX structure is being enhanced to track additional DCD
> information.
>
> The current range tuple was not fully documented. Document it prior to
> adding information for DC.
>
> Suggested-by: Jonathan Cameron <jonathan.came...@huawei.com>
> Signed-off-by: Ira Weiny <ira.we...@intel.com>
>
> ---
> Changes:
> [iweiny: move to start of series]
> ---
> drivers/dax/dax-private.h | 5 ++++-
> 1 file changed, 4 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/dax/dax-private.h b/drivers/dax/dax-private.h
> index 446617b73aea..ccde98c3d4e2 100644
> --- a/drivers/dax/dax-private.h
> +++ b/drivers/dax/dax-private.h
> @@ -58,7 +58,10 @@ struct dax_mapping {
> * @dev - device core
> * @pgmap - pgmap for memmap setup / lifetime (driver owned)
> * @nr_range: size of @ranges
> - * @ranges: resource-span + pgoff tuples for the instance
> + * @ranges: range tuples of memory used
> + * @pgoff: page offset
> + * @range: resource-span
> + * @mapping: device to assist in interrogating the range layout
I think the kernel doc format for this should be
@ranges.pgoff: etc
https://docs.kernel.org/doc-guide/kernel-doc.html#nested-structs-unions
Though not quite sure what happens for pointers to structures, maybe
this is correct as it stands?
> */
> struct dev_dax {
> struct dax_region *region;
>
