diff options
| author | Gregory Price <gourry@gourry.net> | 2025-05-12 12:21:18 -0400 |
|---|---|---|
| committer | Dave Jiang <dave.jiang@intel.com> | 2025-05-13 13:07:44 -0700 |
| commit | a770647294bb679c48b5fbc49388f1d85e9f2e9f (patch) | |
| tree | 206dc48125691b62cc9ee2e98b7654b50e7d757b | |
| parent | b4432656b36e5cc1d50a1f2dc15357543add530e (diff) | |
cxl: update documentation structure in prep for new docs
Restructure the cxl folder to make adding docs per-page cleaner.
Signed-off-by: Gregory Price <gourry@gourry.net>
Reviewed-by: Dave Jiang <dave.jiang@intel.com>
Link: https://patch.msgid.link/20250512162134.3596150-2-gourry@gourry.net
Signed-off-by: Dave Jiang <dave.jiang@intel.com>
| -rw-r--r-- | Documentation/driver-api/cxl/index.rst | 16 | ||||
| -rw-r--r-- | Documentation/driver-api/cxl/linux/access-coordinates.rst (renamed from Documentation/driver-api/cxl/access-coordinates.rst) | 0 | ||||
| -rw-r--r-- | Documentation/driver-api/cxl/theory-of-operation.rst (renamed from Documentation/driver-api/cxl/memory-devices.rst) | 10 |
3 files changed, 18 insertions, 8 deletions
diff --git a/Documentation/driver-api/cxl/index.rst b/Documentation/driver-api/cxl/index.rst index 965ba90e8fb7..fe1594dc6778 100644 --- a/Documentation/driver-api/cxl/index.rst +++ b/Documentation/driver-api/cxl/index.rst @@ -4,12 +4,22 @@ Compute Express Link ==================== +CXL device configuration has a complex handoff between platform (Hardware, +BIOS, EFI), OS (early boot, core kernel, driver), and user policy decisions +that have impacts on each other. The docs here break up configurations steps. + +.. toctree:: + :maxdepth: 2 + :caption: Overview + + theory-of-operation + maturity-map + .. toctree:: :maxdepth: 1 + :caption: Linux Kernel Configuration - memory-devices - access-coordinates + linux/access-coordinates - maturity-map .. only:: subproject and html diff --git a/Documentation/driver-api/cxl/access-coordinates.rst b/Documentation/driver-api/cxl/linux/access-coordinates.rst index b07950ea30c9..b07950ea30c9 100644 --- a/Documentation/driver-api/cxl/access-coordinates.rst +++ b/Documentation/driver-api/cxl/linux/access-coordinates.rst diff --git a/Documentation/driver-api/cxl/memory-devices.rst b/Documentation/driver-api/cxl/theory-of-operation.rst index d732c42526df..32739e253453 100644 --- a/Documentation/driver-api/cxl/memory-devices.rst +++ b/Documentation/driver-api/cxl/theory-of-operation.rst @@ -1,9 +1,9 @@ .. SPDX-License-Identifier: GPL-2.0 .. include:: <isonum.txt> -=================================== -Compute Express Link Memory Devices -=================================== +=============================================== +Compute Express Link Driver Theory of Operation +=============================================== A Compute Express Link Memory Device is a CXL component that implements the CXL.mem protocol. It contains some amount of volatile memory, persistent memory, @@ -14,8 +14,8 @@ that optionally define a device's contribution to an interleaved address range across multiple devices underneath a host-bridge or interleaved across host-bridges. -CXL Bus: Theory of Operation -============================ +The CXL Bus +=========== Similar to how a RAID driver takes disk objects and assembles them into a new logical device, the CXL subsystem is tasked to take PCIe and ACPI objects and assemble them into a CXL.mem decode topology. The need for runtime configuration |