Skip to content

Commit

Permalink
Merge branch 'acpi-docs'
Browse files Browse the repository at this point in the history
Merge an ACPI documentation update for 6.9-rc1 which adds markup to
generate links from footnotes in the enumeration document.

* acpi-docs:
  ACPI: docs: enumeration: Make footnotes links
  • Loading branch information
rafaeljw committed Mar 19, 2024
2 parents d7ef570 + e1c69f3 commit a873add
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions Documentation/firmware-guide/acpi/enumeration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -595,7 +595,7 @@ bridges/switches of the board.

For example, let's assume we have a system with a PCIe serial port, an
Exar XR17V3521, soldered on the main board. This UART chip also includes
16 GPIOs and we want to add the property ``gpio-line-names`` [1] to these pins.
16 GPIOs and we want to add the property ``gpio-line-names`` [1]_ to these pins.
In this case, the ``lspci`` output for this component is::

07:00.0 Serial controller: Exar Corp. XR17V3521 Dual PCIe UART (rev 03)
Expand Down Expand Up @@ -637,7 +637,7 @@ of the chipset bridge (also called "root port") with address::
Bus: 0 - Device: 14 - Function: 1

To find this information, it is necessary to disassemble the BIOS ACPI tables,
in particular the DSDT (see also [2])::
in particular the DSDT (see also [2]_)::

mkdir ~/tables/
cd ~/tables/
Expand Down Expand Up @@ -667,7 +667,7 @@ device::
}
... other definitions follow ...

and the _ADR method [3] returns exactly the device/function couple that
and the _ADR method [3]_ returns exactly the device/function couple that
we are looking for. With this information and analyzing the above ``lspci``
output (both the devices list and the devices tree), we can write the following
ACPI description for the Exar PCIe UART, also adding the list of its GPIO line
Expand Down Expand Up @@ -724,10 +724,10 @@ created analyzing the position of the Exar UART in the PCI bus topology.
References
==========

[1] Documentation/firmware-guide/acpi/gpio-properties.rst
.. [1] Documentation/firmware-guide/acpi/gpio-properties.rst
[2] Documentation/admin-guide/acpi/initrd_table_override.rst
.. [2] Documentation/admin-guide/acpi/initrd_table_override.rst
[3] ACPI Specifications, Version 6.3 - Paragraph 6.1.1 _ADR Address)
.. [3] ACPI Specifications, Version 6.3 - Paragraph 6.1.1 _ADR Address)
https://uefi.org/sites/default/files/resources/ACPI_6_3_May16.pdf,
referenced 2020-11-18

0 comments on commit a873add

Please sign in to comment.