Skip to content

Commit a770647

Browse files
Gregory Pricedavejiang
authored andcommitted
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 <[email protected]> Reviewed-by: Dave Jiang <[email protected]> Link: https://patch.msgid.link/[email protected] Signed-off-by: Dave Jiang <[email protected]>
1 parent b443265 commit a770647

File tree

3 files changed

+18
-8
lines changed

3 files changed

+18
-8
lines changed

Documentation/driver-api/cxl/index.rst

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,22 @@
44
Compute Express Link
55
====================
66

7+
CXL device configuration has a complex handoff between platform (Hardware,
8+
BIOS, EFI), OS (early boot, core kernel, driver), and user policy decisions
9+
that have impacts on each other. The docs here break up configurations steps.
10+
11+
.. toctree::
12+
:maxdepth: 2
13+
:caption: Overview
14+
15+
theory-of-operation
16+
maturity-map
17+
718
.. toctree::
819
:maxdepth: 1
20+
:caption: Linux Kernel Configuration
921

10-
memory-devices
11-
access-coordinates
22+
linux/access-coordinates
1223

13-
maturity-map
1424

1525
.. only:: subproject and html
File renamed without changes.

Documentation/driver-api/cxl/memory-devices.rst renamed to Documentation/driver-api/cxl/theory-of-operation.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
.. SPDX-License-Identifier: GPL-2.0
22
.. include:: <isonum.txt>
33

4-
===================================
5-
Compute Express Link Memory Devices
6-
===================================
4+
===============================================
5+
Compute Express Link Driver Theory of Operation
6+
===============================================
77

88
A Compute Express Link Memory Device is a CXL component that implements the
99
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
1414
range across multiple devices underneath a host-bridge or interleaved
1515
across host-bridges.
1616

17-
CXL Bus: Theory of Operation
18-
============================
17+
The CXL Bus
18+
===========
1919
Similar to how a RAID driver takes disk objects and assembles them into a new
2020
logical device, the CXL subsystem is tasked to take PCIe and ACPI objects and
2121
assemble them into a CXL.mem decode topology. The need for runtime configuration

0 commit comments

Comments
 (0)