Skip to content

Commit d542461

Browse files
AlisonSchofielddavejiang
authored andcommitted
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>
1 parent 58dfd95 commit d542461

File tree

4 files changed

+33
-3
lines changed

4 files changed

+33
-3
lines changed

Documentation/driver-api/cxl/linux/access-coordinates.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,3 +90,6 @@ under the same ACPI0017 device to form a new xarray.
9090
Finally, the cxl_region_update_bandwidth() is called and the aggregated
9191
bandwidth from all the members of the last xarray is updated for the
9292
access coordinates residing in the cxl region (cxlr) context.
93+
94+
.. kernel-doc:: drivers/cxl/acpi.c
95+
:identifiers: cxl_acpi_evaluate_qtg_dsm

Documentation/driver-api/cxl/theory-of-operation.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -347,6 +347,9 @@ CXL Core
347347
.. kernel-doc:: drivers/cxl/cxl.h
348348
:internal:
349349

350+
.. kernel-doc:: drivers/cxl/acpi.c
351+
:identifiers: add_cxl_resources
352+
350353
.. kernel-doc:: drivers/cxl/core/hdm.c
351354
:doc: cxl core hdm
352355

@@ -371,12 +374,27 @@ CXL Core
371374
.. kernel-doc:: drivers/cxl/core/pmem.c
372375
:doc: cxl pmem
373376

377+
.. kernel-doc:: drivers/cxl/core/pmem.c
378+
:identifiers:
379+
374380
.. kernel-doc:: drivers/cxl/core/regs.c
375381
:doc: cxl registers
376382

383+
.. kernel-doc:: drivers/cxl/core/regs.c
384+
:identifiers:
385+
377386
.. kernel-doc:: drivers/cxl/core/mbox.c
378387
:doc: cxl mbox
379388

389+
.. kernel-doc:: drivers/cxl/core/mbox.c
390+
:identifiers:
391+
392+
.. kernel-doc:: drivers/cxl/core/features.c
393+
:doc: cxl features
394+
395+
.. kernel-doc:: drivers/cxl/core/features.c
396+
:identifiers:
397+
380398
CXL Regions
381399
-----------
382400
.. kernel-doc:: drivers/cxl/core/region.c

drivers/cxl/acpi.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -749,10 +749,10 @@ static void remove_cxl_resources(void *data)
749749
* expanding its boundaries to ensure that any conflicting resources become
750750
* children. If a window is expanded it may then conflict with a another window
751751
* entry and require the window to be truncated or trimmed. Consider this
752-
* situation:
752+
* situation::
753753
*
754-
* |-- "CXL Window 0" --||----- "CXL Window 1" -----|
755-
* |--------------- "System RAM" -------------|
754+
* |-- "CXL Window 0" --||----- "CXL Window 1" -----|
755+
* |--------------- "System RAM" -------------|
756756
*
757757
* ...where platform firmware has established as System RAM resource across 2
758758
* windows, but has left some portion of window 1 for dynamic CXL region

drivers/cxl/core/features.c

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,15 @@
99
#include "core.h"
1010
#include "cxlmem.h"
1111

12+
/**
13+
* DOC: cxl features
14+
*
15+
* A CXL device that includes a mailbox supports commands that allows
16+
* listing, getting, and setting of optionally defined features such
17+
* as memory sparing or post package sparing. Vendors may define custom
18+
* features for the device.
19+
*/
20+
1221
/* All the features below are exclusive to the kernel */
1322
static const uuid_t cxl_exclusive_feats[] = {
1423
CXL_FEAT_PATROL_SCRUB_UUID,

0 commit comments

Comments
 (0)