Skip to content

Commit 5af29a5

Browse files
aloktiwadavejiang
authored andcommitted
Documentation: cxl: fix typos and improve clarity in memory-devices.rst
This patch corrects several typographical issues and improves phrasing in memory-devices.rst: - Fixes duplicate word ("1 one") and adjusts phrasing for clarity. - Adds missing hyphen in "on-device". - Corrects "a give memory device" to "a given memory device". - fix singular/plural "decoder resource" -> "decoder resources". - Clarifies "spans to Host Bridges" -> "spans two Host Bridges". - change "at a" -> "a" These changes improve readability and accuracy of the documentation. Signed-off-by: Alok Tiwari <[email protected]> Reviewed-by: Randy Dunlap <[email protected]> Reviewed-by: Gregory Price <[email protected]> Reviewed-by: Jonathan Cameron <[email protected]> Link: https://patch.msgid.link/[email protected] Signed-off-by: Dave Jiang <[email protected]>
1 parent 60da1f6 commit 5af29a5

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ Platform firmware enumerates a menu of interleave options at the "CXL root port"
2929
(Linux term for the top of the CXL decode topology). From there, PCIe topology
3030
dictates which endpoints can participate in which Host Bridge decode regimes.
3131
Each PCIe Switch in the path between the root and an endpoint introduces a point
32-
at which the interleave can be split. For example platform firmware may say at a
33-
given range only decodes to 1 one Host Bridge, but that Host Bridge may in turn
32+
at which the interleave can be split. For example, platform firmware may say a
33+
given range only decodes to one Host Bridge, but that Host Bridge may in turn
3434
interleave cycles across multiple Root Ports. An intervening Switch between a
3535
port and an endpoint may interleave cycles across multiple Downstream Switch
3636
Ports, etc.
@@ -187,7 +187,7 @@ decodes them to "ports", "ports" decode to "endpoints", and "endpoints"
187187
represent the decode from SPA (System Physical Address) to DPA (Device Physical
188188
Address).
189189

190-
Continuing the RAID analogy, disks have both topology metadata and on device
190+
Continuing the RAID analogy, disks have both topology metadata and on-device
191191
metadata that determine RAID set assembly. CXL Port topology and CXL Port link
192192
status is metadata for CXL.mem set assembly. The CXL Port topology is enumerated
193193
by the arrival of a CXL.mem device. I.e. unless and until the PCIe core attaches
@@ -197,7 +197,7 @@ the Linux PCI core to tear down switch-level CXL resources because the endpoint
197197
->remove() event cleans up the port data that was established to support that
198198
Memory Expander.
199199

200-
The port metadata and potential decode schemes that a give memory device may
200+
The port metadata and potential decode schemes that a given memory device may
201201
participate can be determined via a command like::
202202

203203
# cxl list -BDMu -d root -m mem3
@@ -249,8 +249,8 @@ participate can be determined via a command like::
249249
...which queries the CXL topology to ask "given CXL Memory Expander with a kernel
250250
device name of 'mem3' which platform level decode ranges may this device
251251
participate". A given expander can participate in multiple CXL.mem interleave
252-
sets simultaneously depending on how many decoder resource it has. In this
253-
example mem3 can participate in one or more of a PMEM interleave that spans to
252+
sets simultaneously depending on how many decoder resources it has. In this
253+
example mem3 can participate in one or more of a PMEM interleave that spans two
254254
Host Bridges, a PMEM interleave that targets a single Host Bridge, a Volatile
255255
memory interleave that spans 2 Host Bridges, and a Volatile memory interleave
256256
that only targets a single Host Bridge.

0 commit comments

Comments
 (0)