Nai-Chen Cheng
7d14230db8
Documentation: fix typo in CXL driver documentation
...
Fix typo 'enumates' to 'enumerate' in CXL driver operation
documentation to improve readability.
Signed-off-by: Nai-Chen Cheng <bleach1827@gmail.com >
Reviewed-by: Jonathan Cameron <jonathan.cameron@huawei.com >
Reviewed-by: Li Ming <ming.li@zohomail.com >
Reviewed-by: Dave Jiang <dave.jiang@intel.com >
Link: https://patch.msgid.link/20250610173152.33566-1-bleach1827@gmail.com
Signed-off-by: Dave Jiang <dave.jiang@intel.com >
2025-06-30 16:36:06 -07:00
Dave Jiang
fc78561595
cxl: doc/linux/access-coordinates Update access coordinates calculation methods
...
Add documentation on how to calculate the access coordinates for a given
CXL region in detail.
Reviewed-by: Gregory Price <gourry@gourry.net >
Reviewed-by: Alison Schofield <alison.schofield@intel.com >
Link: https://patch.msgid.link/20250515000923.2590820-4-dave.jiang@intel.com
Signed-off-by: Dave Jiang <dave.jiang@intel.com >
2025-05-15 16:39:13 -07:00
Alison Schofield
d542461211
cxl: Sync up the driver-api/cxl documentation
...
pmem.c regs.c mbox.c identifiers were missing. Add them to
memory-devices.rst following their respective DOC comment includes.
Two acpi.c identifiers were available, but not used in kernel-doc's:
1) Add add_cxl_resources to memory-devices.rst and fix up the Sphinx
complaint on the ascii art by escaping it.
2) Add cxl_acpi_evaluate_qtg_dsm to access-coordinates.rst.
core/features.c is new. Add a "DOC: cxl features" comment to the
source and identifiers to memory_devices.rst.
Signed-off-by: Alison Schofield <alison.schofield@intel.com >
Reviewed-by: Ira Weiny <ira.weiny@intel.com >
Link: https://patch.msgid.link/20250513215813.1419645-1-alison.schofield@intel.com
Signed-off-by: Dave Jiang <dave.jiang@intel.com >
2025-05-13 15:12:15 -07:00
Gregory Price
dba600d0f2
cxl: docs - add self-referencing cross-links
...
Add some crosslinks between pages in the CXL docs - mostly to the
ACPI tables.
Suggested-by: Bagas Sanjaya <bagasdotme@gmail.com >
Signed-off-by: Gregory Price <gourry@gourry.net >
Link: https://patch.msgid.link/20250512162134.3596150-18-gourry@gourry.net
Signed-off-by: Dave Jiang <dave.jiang@intel.com >
2025-05-13 13:07:46 -07:00
Gregory Price
641fdea6b9
cxl: docs/linux/memory-hotplug
...
Add documentation on how the CXL driver surfaces memory through the
DAX driver and memory-hotplug.
Signed-off-by: Gregory Price <gourry@gourry.net >
Link: https://patch.msgid.link/20250512162134.3596150-13-gourry@gourry.net
Signed-off-by: Dave Jiang <dave.jiang@intel.com >
2025-05-13 13:07:45 -07:00
Gregory Price
36e9f71bd6
cxl: docs/linux/dax-driver documentation
...
Add documentation on how the CXL driver interacts with the DAX driver.
Signed-off-by: Gregory Price <gourry@gourry.net >
Link: https://patch.msgid.link/20250512162134.3596150-12-gourry@gourry.net
Signed-off-by: Dave Jiang <dave.jiang@intel.com >
2025-05-13 13:07:45 -07:00
Gregory Price
ef3a43a691
cxl: docs/linux/cxl-driver - add example configurations
...
Add 4 example configurations:
- single device
- cross-host-bridge interleave
- intra-host-bridge-interleave
- multi-level interleave
Signed-off-by: Gregory Price <gourry@gourry.net >
Link: https://patch.msgid.link/20250512162134.3596150-11-gourry@gourry.net
Signed-off-by: Dave Jiang <dave.jiang@intel.com >
2025-05-13 13:07:45 -07:00
Gregory Price
2e2865a1d0
cxl: docs/linux - add cxl-driver theory of operation
...
Add docs for the CXL driver that explains the base devices,
decoder types, region types, mailbox interfaces, and decoder
programming.
Signed-off-by: Gregory Price <gourry@gourry.net >
Link: https://patch.msgid.link/20250512162134.3596150-10-gourry@gourry.net
Signed-off-by: Dave Jiang <dave.jiang@intel.com >
2025-05-13 13:07:45 -07:00
Gregory Price
bef826ead3
cxl: docs/linux - early boot configuration
...
Document __init time configurations that affect CXL driver probe
process and memory region configuration.
Signed-off-by: Gregory Price <gourry@gourry.net >
Reviewed-by: Dave Jiang <dave.jiang@intel.com >
Link: https://patch.msgid.link/20250512162134.3596150-9-gourry@gourry.net
Signed-off-by: Dave Jiang <dave.jiang@intel.com >
2025-05-13 13:07:45 -07:00
Gregory Price
9bd8546e59
cxl: docs/linux - overview
...
Add type-3 device configuration overview that explains the probe
process for a type-3 device from early-boot through memory-hotplug.
Signed-off-by: Gregory Price <gourry@gourry.net >
Reviewed-by: Dave Jiang <dave.jiang@intel.com >
Link: https://patch.msgid.link/20250512162134.3596150-8-gourry@gourry.net
Signed-off-by: Dave Jiang <dave.jiang@intel.com >
2025-05-13 13:07:45 -07:00
Gregory Price
a3bf6b417b
cxl: docs - access-coordinates doc fixups
...
Place the hierarchy diagram in access-coordinates.rst in a code block.
Fix a few grammar issues.
Suggested-by: Randy Dunlap <rdunlap@infradead.org >
Suggested-by: Bagas Sanjaya <bagasdotme@gmail.com >
Signed-off-by: Gregory Price <gourry@gourry.net >
Reviewed-by: Dave Jiang <dave.jiang@intel.com >
Link: https://patch.msgid.link/20250512162134.3596150-3-gourry@gourry.net
Signed-off-by: Dave Jiang <dave.jiang@intel.com >
2025-05-13 13:07:44 -07:00
Gregory Price
a770647294
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 >
2025-05-13 13:07:44 -07:00
