Add carve-outs for use-case documentation. Complete open as to
what (if anything) we should explain here, and/or what the structure
should be.
Signed-off-by: Gregory Price <gourry@xxxxxxxxxx>
---
Documentation/driver-api/cxl/index.rst | 10 ++++++++++
.../cxl/use-case/dynamic-capacity.rst | 19 +++++++++++++++++++
.../cxl/use-case/memory-expansion.rst | 14 ++++++++++++++
.../driver-api/cxl/use-case/shared-memory.rst | 14 ++++++++++++++
.../cxl/use-case/virtual-machines.rst | 18 ++++++++++++++++++
5 files changed, 75 insertions(+)
create mode 100644 Documentation/driver-api/cxl/use-case/dynamic-capacity.rst
create mode 100644 Documentation/driver-api/cxl/use-case/memory-expansion.rst
create mode 100644 Documentation/driver-api/cxl/use-case/shared-memory.rst
create mode 100644 Documentation/driver-api/cxl/use-case/virtual-machines.rst
diff --git a/Documentation/driver-api/cxl/index.rst b/Documentation/driver-api/cxl/index.rst
index 51dd0392883b..e0a86f68b6f8 100644
--- a/Documentation/driver-api/cxl/index.rst
+++ b/Documentation/driver-api/cxl/index.rst
@@ -50,5 +50,15 @@ that have impacts on each other. The docs here break up configurations steps.
allocation/page-allocator
allocation/reclaim
allocation/hugepages.rst
+ allocation/tiering.rst
+
+.. toctree::
+ :maxdepth: 1
+ :caption: Use Cases
+
+ use-case/memory-expansion.rst
+ use-case/dynamic-capacity.rst
+ use-case/virtual-machines.rst
+ use-case/shared-memory.rst
.. only:: subproject and html
diff --git a/Documentation/driver-api/cxl/use-case/dynamic-capacity.rst b/Documentation/driver-api/cxl/use-case/dynamic-capacity.rst
new file mode 100644
index 000000000000..93a24aa1edc5
--- /dev/null
+++ b/Documentation/driver-api/cxl/use-case/dynamic-capacity.rst
@@ -0,0 +1,19 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+Dynamic Capacity
+################
+todo
+
+For Virtual Machines
+********************
+todo
+
+For Workload Orchestration
+**************************
+todo
+
+For Shared Memory
+*****************
+todo
+
+
diff --git a/Documentation/driver-api/cxl/use-case/memory-expansion.rst b/Documentation/driver-api/cxl/use-case/memory-expansion.rst
new file mode 100644
index 000000000000..d1d25e0e4498
--- /dev/null
+++ b/Documentation/driver-api/cxl/use-case/memory-expansion.rst
@@ -0,0 +1,14 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+Memory Expansion
+################
+
+todo
+
+As Page Cache
+*************
+todo
+
+As DAX Device
+*************
+todo
diff --git a/Documentation/driver-api/cxl/use-case/shared-memory.rst b/Documentation/driver-api/cxl/use-case/shared-memory.rst
new file mode 100644
index 000000000000..dfdc2c419ea2
--- /dev/null
+++ b/Documentation/driver-api/cxl/use-case/shared-memory.rst
@@ -0,0 +1,14 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+Shared Memory
+#############
+todo
+
+Coherence
+*********
+todo
+
+Fabric Attached Memory FileSystem (FAMFS)
+*****************************************
+
+todo
diff --git a/Documentation/driver-api/cxl/use-case/virtual-machines.rst b/Documentation/driver-api/cxl/use-case/virtual-machines.rst
new file mode 100644
index 000000000000..0411d37092ce
--- /dev/null
+++ b/Documentation/driver-api/cxl/use-case/virtual-machines.rst
@@ -0,0 +1,18 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+Virtual Machines
+################
+
+todo
+
+NUMA Passthrough
+****************
+todo
+
+Flexible Shapes
+***************
+todo
+
+Datacenter Efficiency
+*********************
+todo
--
2.49.0
