Skip to content

Commit 40103d2

Browse files
l1kbjorn-helgaas
authored andcommitted
Documentation: PCI: Tidy error recovery doc's PCIe nomenclature
Commit 11502fe ("Documentation: PCI: Tidy AER documentation") replaced the terms "PCI-E", "PCI-Express" and "PCI Express" with "PCIe" in the AER documentation. Do the same in the documentation on PCI error recovery. While at it, add a missing period and a missing blank. Signed-off-by: Lukas Wunner <lukas@wunner.de> Signed-off-by: Bjorn Helgaas <bhelgaas@google.com> Reviewed-by: Brian Norris <briannorris@chromium.org> Reviewed-by: Niklas Schnelle <schnelle@linux.ibm.com> Reviewed-by: Kuppuswamy Sathyanarayanan <sathyanarayanan.kuppuswamy@linux.intel.com> Link: https://patch.msgid.link/db56b7ef12043f709a04ce67c1d1e102ab5f4e19.1757942121.git.lukas@wunner.de
1 parent 15dea68 commit 40103d2

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

Documentation/PCI/pci-error-recovery.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ PCI Error Recovery
1313
Many PCI bus controllers are able to detect a variety of hardware
1414
PCI errors on the bus, such as parity errors on the data and address
1515
buses, as well as SERR and PERR errors. Some of the more advanced
16-
chipsets are able to deal with these errors; these include PCI-E chipsets,
16+
chipsets are able to deal with these errors; these include PCIe chipsets,
1717
and the PCI-host bridges found on IBM Power4, Power5 and Power6-based
1818
pSeries boxes. A typical action taken is to disconnect the affected device,
1919
halting all I/O to it. The goal of a disconnection is to avoid system
@@ -206,7 +206,7 @@ reset or some such, but not restart operations. This callback is made if
206206
all drivers on a segment agree that they can try to recover and if no automatic
207207
link reset was performed by the HW. If the platform can't just re-enable IOs
208208
without a slot reset or a link reset, it will not call this callback, and
209-
instead will have gone directly to STEP 3 (Link Reset) or STEP 4 (Slot Reset)
209+
instead will have gone directly to STEP 3 (Link Reset) or STEP 4 (Slot Reset).
210210

211211
.. note::
212212

@@ -259,14 +259,14 @@ The driver should return one of the following result codes:
259259

260260
The next step taken depends on the results returned by the drivers.
261261
If all drivers returned PCI_ERS_RESULT_RECOVERED, then the platform
262-
proceeds to either STEP3 (Link Reset) or to STEP 5 (Resume Operations).
262+
proceeds to either STEP 3 (Link Reset) or to STEP 5 (Resume Operations).
263263

264264
If any driver returned PCI_ERS_RESULT_NEED_RESET, then the platform
265265
proceeds to STEP 4 (Slot Reset)
266266

267267
STEP 3: Link Reset
268268
------------------
269-
The platform resets the link. This is a PCI-Express specific step
269+
The platform resets the link. This is a PCIe specific step
270270
and is done whenever a fatal error has been detected that can be
271271
"solved" by resetting the link.
272272

@@ -288,13 +288,13 @@ that is equivalent to what it would be after a fresh system
288288
power-on followed by power-on BIOS/system firmware initialization.
289289
Soft reset is also known as hot-reset.
290290

291-
Powerpc fundamental reset is supported by PCI Express cards only
291+
Powerpc fundamental reset is supported by PCIe cards only
292292
and results in device's state machines, hardware logic, port states and
293293
configuration registers to initialize to their default conditions.
294294

295295
For most PCI devices, a soft reset will be sufficient for recovery.
296296
Optional fundamental reset is provided to support a limited number
297-
of PCI Express devices for which a soft reset is not sufficient
297+
of PCIe devices for which a soft reset is not sufficient
298298
for recovery.
299299

300300
If the platform supports PCI hotplug, then the reset might be
@@ -338,7 +338,7 @@ Result codes:
338338
- PCI_ERS_RESULT_DISCONNECT
339339
Same as above.
340340

341-
Drivers for PCI Express cards that require a fundamental reset must
341+
Drivers for PCIe cards that require a fundamental reset must
342342
set the needs_freset bit in the pci_dev structure in their probe function.
343343
For example, the QLogic qla2xxx driver sets the needs_freset bit for certain
344344
PCI card types::

0 commit comments

Comments
 (0)