From: Jonathan Cameron <Jonathan.Cameron@Huawei.com>
To: Vishal Verma <vishal.l.verma@intel.com>
Cc: Dan Williams <dan.j.williams@intel.com>,
Dave Jiang <dave.jiang@intel.com>, <linux-kernel@vger.kernel.org>,
<nvdimm@lists.linux.dev>, <linux-cxl@vger.kernel.org>,
David Hildenbrand <david@redhat.com>,
Dave Hansen <dave.hansen@linux.intel.com>,
Huang Ying <ying.huang@intel.com>
Subject: Re: [PATCH v4 1/3] Documentatiion/ABI: Add ABI documentation for sys-bus-dax
Date: Wed, 13 Dec 2023 16:50:52 +0000 [thread overview]
Message-ID: <20231213165052.00007d74@Huawei.com> (raw)
In-Reply-To: <20231212-vv-dax_abi-v4-1-1351758f0c92@intel.com>
On Tue, 12 Dec 2023 12:08:30 -0700
Vishal Verma <vishal.l.verma@intel.com> wrote:
> Add the missing sysfs ABI documentation for the device DAX subsystem.
> Various ABI attributes under this have been present since v5.1, and more
> have been added over time. In preparation for adding a new attribute,
> add this file with the historical details.
>
> Cc: Dan Williams <dan.j.williams@intel.com>
> Signed-off-by: Vishal Verma <vishal.l.verma@intel.com>
Hi Vishal, One editorial suggestions.
I don't know the interface well enough to do a good review of the content
so leaving that for Dan or others.
> +What: /sys/bus/dax/devices/daxX.Y/mapping[0..N]/start
> +Date: October, 2020
> +KernelVersion: v5.10
> +Contact: nvdimm@lists.linux.dev
> +Description:
> + (RO) A dax device may have multiple constituent discontiguous
> + address ranges. These are represented by the different
> + 'mappingX' subdirectories. The 'start' attribute indicates the
> + start physical address for the given range.
A common option for these files is to have a single entry with two What:
lines. Here that would avoid duplication of majority of this text across
the start, end and page_offset entries. Alternatively you could do an
entry for the mapping[0..N] directory with the shared text then separate
entries for the 3 files under there.
> +
> +What: /sys/bus/dax/devices/daxX.Y/mapping[0..N]/end
> +Date: October, 2020
> +KernelVersion: v5.10
> +Contact: nvdimm@lists.linux.dev
> +Description:
> + (RO) A dax device may have multiple constituent discontiguous
> + address ranges. These are represented by the different
> + 'mappingX' subdirectories. The 'end' attribute indicates the
> + end physical address for the given range.
> +
> +What: /sys/bus/dax/devices/daxX.Y/mapping[0..N]/page_offset
> +Date: October, 2020
> +KernelVersion: v5.10
> +Contact: nvdimm@lists.linux.dev
> +Description:
> + (RO) A dax device may have multiple constituent discontiguous
> + address ranges. These are represented by the different
> + 'mappingX' subdirectories. The 'page_offset' attribute indicates the
> + offset of the current range in the dax device.
next prev parent reply other threads:[~2023-12-13 16:51 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-12 19:08 [PATCH v4 0/3] Add DAX ABI for memmap_on_memory Vishal Verma
2023-12-12 19:08 ` [PATCH v4 1/3] Documentatiion/ABI: Add ABI documentation for sys-bus-dax Vishal Verma
2023-12-13 16:50 ` Jonathan Cameron [this message]
2023-12-12 19:08 ` [PATCH v4 2/3] dax/bus: Introduce guard(device) for device_{lock,unlock} flows Vishal Verma
2023-12-12 19:41 ` Ira Weiny
2023-12-13 17:05 ` Jonathan Cameron
2023-12-12 19:08 ` [PATCH v4 3/3] dax: add a sysfs knob to control memmap_on_memory behavior Vishal Verma
2023-12-13 1:10 ` Huang, Ying
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20231213165052.00007d74@Huawei.com \
--to=jonathan.cameron@huawei.com \
--cc=dan.j.williams@intel.com \
--cc=dave.hansen@linux.intel.com \
--cc=dave.jiang@intel.com \
--cc=david@redhat.com \
--cc=linux-cxl@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=nvdimm@lists.linux.dev \
--cc=vishal.l.verma@intel.com \
--cc=ying.huang@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.