From: Dave Jiang <dave.jiang@intel.com>
To: Gregory Price <gourry@gourry.net>, linux-cxl@vger.kernel.org
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
kernel-team@meta.com, dave@stgolabs.net,
jonathan.cameron@huawei.com, alison.schofield@intel.com,
vishal.l.verma@intel.com, ira.weiny@intel.com,
dan.j.williams@intel.com, corbet@lwn.net,
Joshua Hahn <joshua.hahnjy@gmail.com>
Subject: Re: [PATCH v3 00/17] CXL Boot to Bash Documentation
Date: Tue, 13 May 2025 13:38:37 -0700 [thread overview]
Message-ID: <c164b38f-f6ee-456b-b6f5-3aef943890fb@intel.com> (raw)
In-Reply-To: <20250512162134.3596150-1-gourry@gourry.net>
On 5/12/25 9:21 AM, Gregory Price wrote:
> v3:
> - Cross-links (Bagas)
> - Grammar and spelling (Randy)
> - added fixups to access-coordinates (Bagas)
> - Drop TODO sections (use-case, memory-tiering, CDAT/UEFI, SRAT Genport)
> I unfortunately won't be able to come back around to this for
> a while, so I'd rather not let this rot.
Applied to cxl/next
>
> ---
>
> This series converts CXL Boot to Bash Docs from LSFMM '25 to Linux
> Kernel Docs. In brief, this document covers (almost) everything Linux
> expects from platforms to successfully bring volatile CXL memory
> capacity online as a DAX device and/or SystemRAM.
>
> It covers:
>
> - Platform configuration data (ACPI Tables, EFI Memory Map, EFI Configs)
> - Linux Build and Boot Parameters
> - Linux consumption of Platform, Build, and Boot params
> - Linux creation of base resources (NUMA nodes, memory tiers, etc)
> - CXL Driver probe process and sysfs structure
> - DAX Driver interactions between the CXL driver and memory hotplug
> - Memory hotplug interactions
> - Page allocator interactions (NUMA nodes, Memory Zones, Reclaim, etc).
>
> Included are example platform configurations (ACPI tables) and cxl
> decoder configurations to guide platform developers on expected
> configurations (which may be more strict than the CXL spec).
>
> Co-developed-by: Joshua Hahn <joshua.hahnjy@gmail.com>
> Signed-off-by: Joshua Hahn <joshua.hahnjy@gmail.com>
> Signed-off-by: Gregory Price <gourry@gourry.net>
>
> Gregory Price (17):
> cxl: update documentation structure in prep for new docs
> cxl: docs - access-coordinates doc fixups
> cxl: docs/devices - add cxl device and protocol reference
> cxl: docs/platform/bios-and-efi documentation
> cxl: docs/platform/acpi reference documentation
> cxl: docs/platform/example-configs documentation
> cxl: docs/linux - overview
> cxl: docs/linux - early boot configuration
> cxl: docs/linux - add cxl-driver theory of operation
> cxl: docs/linux/cxl-driver - add example configurations
> cxl: docs/linux/dax-driver documentation
> cxl: docs/linux/memory-hotplug
> cxl: docs/allocation/dax
> cxl: docs/allocation/page-allocator
> cxl: docs/allocation/reclaim
> cxl: docs/allocation/hugepages
> cxl: docs - add self-referencing cross-links
>
> .../driver-api/cxl/allocation/dax.rst | 60 ++
> .../driver-api/cxl/allocation/hugepages.rst | 32 +
> .../cxl/allocation/page-allocator.rst | 85 +++
> .../driver-api/cxl/allocation/reclaim.rst | 51 ++
> .../driver-api/cxl/devices/device-types.rst | 165 +++++
> Documentation/driver-api/cxl/index.rst | 45 +-
> .../cxl/{ => linux}/access-coordinates.rst | 35 +-
> .../driver-api/cxl/linux/cxl-driver.rst | 630 ++++++++++++++++++
> .../driver-api/cxl/linux/dax-driver.rst | 43 ++
> .../driver-api/cxl/linux/early-boot.rst | 137 ++++
> .../example-configurations/hb-interleave.rst | 314 +++++++++
> .../intra-hb-interleave.rst | 291 ++++++++
> .../multi-interleave.rst | 401 +++++++++++
> .../example-configurations/single-device.rst | 246 +++++++
> .../driver-api/cxl/linux/memory-hotplug.rst | 78 +++
> .../driver-api/cxl/linux/overview.rst | 103 +++
> .../driver-api/cxl/platform/acpi.rst | 76 +++
> .../driver-api/cxl/platform/acpi/cedt.rst | 62 ++
> .../driver-api/cxl/platform/acpi/dsdt.rst | 28 +
> .../driver-api/cxl/platform/acpi/hmat.rst | 32 +
> .../driver-api/cxl/platform/acpi/slit.rst | 21 +
> .../driver-api/cxl/platform/acpi/srat.rst | 44 ++
> .../driver-api/cxl/platform/bios-and-efi.rst | 262 ++++++++
> .../cxl/platform/example-configs.rst | 13 +
> .../example-configurations/flexible.rst | 296 ++++++++
> .../example-configurations/hb-interleave.rst | 107 +++
> .../multi-dev-per-hb.rst | 90 +++
> .../example-configurations/one-dev-per-hb.rst | 136 ++++
> ...ry-devices.rst => theory-of-operation.rst} | 10 +-
> 29 files changed, 3867 insertions(+), 26 deletions(-)
> create mode 100644 Documentation/driver-api/cxl/allocation/dax.rst
> create mode 100644 Documentation/driver-api/cxl/allocation/hugepages.rst
> create mode 100644 Documentation/driver-api/cxl/allocation/page-allocator.rst
> create mode 100644 Documentation/driver-api/cxl/allocation/reclaim.rst
> create mode 100644 Documentation/driver-api/cxl/devices/device-types.rst
> rename Documentation/driver-api/cxl/{ => linux}/access-coordinates.rst (84%)
> create mode 100644 Documentation/driver-api/cxl/linux/cxl-driver.rst
> create mode 100644 Documentation/driver-api/cxl/linux/dax-driver.rst
> create mode 100644 Documentation/driver-api/cxl/linux/early-boot.rst
> create mode 100644 Documentation/driver-api/cxl/linux/example-configurations/hb-interleave.rst
> create mode 100644 Documentation/driver-api/cxl/linux/example-configurations/intra-hb-interleave.rst
> create mode 100644 Documentation/driver-api/cxl/linux/example-configurations/multi-interleave.rst
> create mode 100644 Documentation/driver-api/cxl/linux/example-configurations/single-device.rst
> create mode 100644 Documentation/driver-api/cxl/linux/memory-hotplug.rst
> create mode 100644 Documentation/driver-api/cxl/linux/overview.rst
> create mode 100644 Documentation/driver-api/cxl/platform/acpi.rst
> create mode 100644 Documentation/driver-api/cxl/platform/acpi/cedt.rst
> create mode 100644 Documentation/driver-api/cxl/platform/acpi/dsdt.rst
> create mode 100644 Documentation/driver-api/cxl/platform/acpi/hmat.rst
> create mode 100644 Documentation/driver-api/cxl/platform/acpi/slit.rst
> create mode 100644 Documentation/driver-api/cxl/platform/acpi/srat.rst
> create mode 100644 Documentation/driver-api/cxl/platform/bios-and-efi.rst
> create mode 100644 Documentation/driver-api/cxl/platform/example-configs.rst
> create mode 100644 Documentation/driver-api/cxl/platform/example-configurations/flexible.rst
> create mode 100644 Documentation/driver-api/cxl/platform/example-configurations/hb-interleave.rst
> create mode 100644 Documentation/driver-api/cxl/platform/example-configurations/multi-dev-per-hb.rst
> create mode 100644 Documentation/driver-api/cxl/platform/example-configurations/one-dev-per-hb.rst
> rename Documentation/driver-api/cxl/{memory-devices.rst => theory-of-operation.rst} (98%)
>
prev parent reply other threads:[~2025-05-13 20:38 UTC|newest]
Thread overview: 33+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-05-12 16:21 [PATCH v3 00/17] CXL Boot to Bash Documentation Gregory Price
2025-05-12 16:21 ` [PATCH v3 01/17] cxl: update documentation structure in prep for new docs Gregory Price
2025-05-12 22:46 ` Dave Jiang
2025-05-12 16:21 ` [PATCH v3 02/17] cxl: docs - access-coordinates doc fixups Gregory Price
2025-05-12 22:47 ` Dave Jiang
2025-05-12 16:21 ` [PATCH v3 03/17] cxl: docs/devices - add cxl device and protocol reference Gregory Price
2025-05-12 23:08 ` Dave Jiang
2025-05-12 23:22 ` Gregory Price
2025-05-12 16:21 ` [PATCH v3 04/17] cxl: docs/platform/bios-and-efi documentation Gregory Price
2025-05-12 23:31 ` Dave Jiang
2025-05-12 16:21 ` [PATCH v3 05/17] cxl: docs/platform/acpi reference documentation Gregory Price
2025-05-12 23:49 ` Dave Jiang
2025-05-12 16:21 ` [PATCH v3 06/17] cxl: docs/platform/example-configs documentation Gregory Price
2025-05-13 0:05 ` Dave Jiang
2025-05-12 16:21 ` [PATCH v3 07/17] cxl: docs/linux - overview Gregory Price
2025-05-13 0:09 ` Dave Jiang
2025-05-12 16:21 ` [PATCH v3 08/17] cxl: docs/linux - early boot configuration Gregory Price
2025-05-13 17:56 ` Dave Jiang
2025-05-12 16:21 ` [PATCH v3 09/17] cxl: docs/linux - add cxl-driver theory of operation Gregory Price
2025-05-12 16:21 ` [PATCH v3 10/17] cxl: docs/linux/cxl-driver - add example configurations Gregory Price
2025-05-12 16:21 ` [PATCH v3 11/17] cxl: docs/linux/dax-driver documentation Gregory Price
2025-05-12 16:21 ` [PATCH v3 12/17] cxl: docs/linux/memory-hotplug Gregory Price
2025-05-12 16:21 ` [PATCH v3 13/17] cxl: docs/allocation/dax Gregory Price
2025-05-12 16:21 ` [PATCH v3 14/17] cxl: docs/allocation/page-allocator Gregory Price
2025-05-12 16:34 ` Matthew Wilcox
2025-05-12 16:38 ` Gregory Price
2025-05-12 17:52 ` Matthew Wilcox
2025-05-12 18:09 ` Gregory Price
2025-05-13 2:39 ` dan.j.williams
2025-05-12 16:21 ` [PATCH v3 15/17] cxl: docs/allocation/reclaim Gregory Price
2025-05-12 16:21 ` [PATCH v3 16/17] cxl: docs/allocation/hugepages Gregory Price
2025-05-12 16:21 ` [PATCH v3 17/17] cxl: docs - add self-referencing cross-links Gregory Price
2025-05-13 20:38 ` Dave Jiang [this message]
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=c164b38f-f6ee-456b-b6f5-3aef943890fb@intel.com \
--to=dave.jiang@intel.com \
--cc=alison.schofield@intel.com \
--cc=corbet@lwn.net \
--cc=dan.j.williams@intel.com \
--cc=dave@stgolabs.net \
--cc=gourry@gourry.net \
--cc=ira.weiny@intel.com \
--cc=jonathan.cameron@huawei.com \
--cc=joshua.hahnjy@gmail.com \
--cc=kernel-team@meta.com \
--cc=linux-cxl@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=vishal.l.verma@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).