kevin/linux
1
Fork 0
Code

More ACPI updates for 6.9-rc1

Browse Source 
- Add markup to generate links from footnotes in the ACPI enumeration
    document (Chris Packham).
 
  - Update the handle_eject_request() kerneldoc comment to document the
    arguments of the function and improve kerneldoc comments for ACPI
    suspend and hibernation functions (Yang Li).
 -----BEGIN PGP SIGNATURE-----
 
 iQJFBAABCAAwFiEE4fcc61cGeeHD/fCwgsRv/nhiVHEFAmX5iLYSHHJqd0Byand5
 c29ja2kubmV0AAoJEILEb/54YlRxSvAP+LPrhQb9gC92N62/sMlqoaop/F8PddDw
 6it1f3q9ez4V74SpOZRFoaoDWoHrm0nvDmHZqWjNn8aGpEfY+KOeS2CSV7+avEg/
 XwJSRkHljFm/7pef0/P8m3G/r86h4OSSOzxVbbXxW9qQ830KYubYr6Anwcdp5CjT
 sueXdd1EsM4hb0UHbpRqh86rOHgMq04eaxsqBDBJMQkmeNdXzACjJ1LMUp2btbtz
 QRAB0M7p5tuUwq3yM7WmTCi9hjV0glBcLcFawwgvgAuyZdH2SXNF9wYb2y2qJl0/
 kqEvw0Z+5D9Mcc6+j1p78h9YvhGJ5OeNqGxeG6gYn5a6EERgdZTgl5dnxhD+6h9Q
 haNZ045G+eD6QuBAi/3/5ABI3V/+2Gh/IEsaROaYs2FOYaFuN1z6f93SIcCvKtBc
 BkzI591Gb5m9Btda312mBF5IN00ii1nwA6PML6VRfRSaTlBc7Av7zG7zsl+CstkW
 dKlrYxGKDb2R/KqX0MDwFOtx6kmDUJ+AB33zleJYc/Z+MLTjfFkzsxHm/HmAZPjf
 NuybjwyTiu72SqMlleNRbiyWBs0+5Hi2BwlvR9jIj0QHnhbr+tQcOMVHf5dY7ZZr
 e91UokPePHnPCiwt+meHuAsroobIb92ARUYu8mAD3yWWVw9IDb8es/ntlNNgcZZW
 bl14VCC7bXk=
 =nafx
 -----END PGP SIGNATURE-----

Merge tag 'acpi-6.9-rc1-2' of git://git.kernel.org/pub/scm/linux/kernel/git/rafael/linux-pm

Pull more ACPI updates from Rafael Wysocki:
 "These update ACPI documentation and kerneldoc comments.

  Specifics:

   - Add markup to generate links from footnotes in the ACPI enumeration
     document (Chris Packham)

   - Update the handle_eject_request() kerneldoc comment to document the
     arguments of the function and improve kerneldoc comments for ACPI
     suspend and hibernation functions (Yang Li)"

* tag 'acpi-6.9-rc1-2' of git://git.kernel.org/pub/scm/linux/kernel/git/rafael/linux-pm:
  ACPI: PM: Improve kerneldoc comments for suspend and hibernation functions
  ACPI: docs: enumeration: Make footnotes links
  ACPI: Document handle_eject_request() arguments
This commit is contained in:
Linus Torvalds 2024-03-19 11:15:14 -07:00
commit 6d37f7e7d1
3 changed files with 22 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Documentation/firmware-guide/acpi/enumeration.rst
View File

@ -595,7 +595,7 @@ bridges/switches of the board.
For example, let's assume we have a system with a PCIe serial port, an 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 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:: In this case, the ``lspci`` output for this component is::
07:00.0 Serial controller: Exar Corp. XR17V3521 Dual PCIe UART (rev 03) 07:00.0 Serial controller: Exar Corp. XR17V3521 Dual PCIe UART (rev 03)
@ -637,7 +637,7 @@ of the chipset bridge (also called "root port") with address::
Bus: 0 - Device: 14 - Function: 1 Bus: 0 - Device: 14 - Function: 1
To find this information, it is necessary to disassemble the BIOS ACPI tables, 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/ mkdir ~/tables/
cd ~/tables/ cd ~/tables/
@ -667,7 +667,7 @@ device::
} }
... other definitions follow ... ... 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`` 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 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 ACPI description for the Exar PCIe UART, also adding the list of its GPIO line
@ -724,10 +724,10 @@ created analyzing the position of the Exar UART in the PCI bus topology.
References 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, https://uefi.org/sites/default/files/resources/ACPI_6_3_May16.pdf,
referenced 2020-11-18 referenced 2020-11-18

2
drivers/acpi/dock.c
View File

@ -380,6 +380,8 @@ static int dock_in_progress(struct dock_station *ds)
/** /**
* handle_eject_request - handle an undock request checking for error conditions * handle_eject_request - handle an undock request checking for error conditions
* @ds: The dock station to undock.
* @event: The ACPI event number associated with the undock request.
* *
* Check to make sure the dock device is still present, then undock and * Check to make sure the dock device is still present, then undock and
* hotremove all the devices that may need removing. * hotremove all the devices that may need removing.

24
drivers/acpi/sleep.c
View File

@ -502,6 +502,7 @@ static void acpi_pm_finish(void)
/** /**
* acpi_pm_start - Start system PM transition. * acpi_pm_start - Start system PM transition.
* @acpi_state: The target ACPI power state to transition to.
*/ */
static void acpi_pm_start(u32 acpi_state) static void acpi_pm_start(u32 acpi_state)
{ {
@ -540,8 +541,9 @@ static u32 acpi_suspend_states[] = {
}; };
/** /**
* acpi_suspend_begin - Set the target system sleep state to the state * acpi_suspend_begin - Set the target system sleep state to the state
* associated with given @pm_state, if supported. * associated with given @pm_state, if supported.
* @pm_state: The target system power management state.
*/ */
static int acpi_suspend_begin(suspend_state_t pm_state) static int acpi_suspend_begin(suspend_state_t pm_state)
{ {
@ -671,10 +673,11 @@ static const struct platform_suspend_ops acpi_suspend_ops = {
}; };
/** /**
* acpi_suspend_begin_old - Set the target system sleep state to the * acpi_suspend_begin_old - Set the target system sleep state to the
* state associated with given @pm_state, if supported, and * state associated with given @pm_state, if supported, and
* execute the _PTS control method. This function is used if the * execute the _PTS control method. This function is used if the
* pre-ACPI 2.0 suspend ordering has been requested. * pre-ACPI 2.0 suspend ordering has been requested.
* @pm_state: The target suspend state for the system.
*/ */
static int acpi_suspend_begin_old(suspend_state_t pm_state) static int acpi_suspend_begin_old(suspend_state_t pm_state)
{ {
@ -967,10 +970,11 @@ static const struct platform_hibernation_ops acpi_hibernation_ops = {
}; };
/** /**
* acpi_hibernation_begin_old - Set the target system sleep state to * acpi_hibernation_begin_old - Set the target system sleep state to
* ACPI_STATE_S4 and execute the _PTS control method. This * ACPI_STATE_S4 and execute the _PTS control method. This
* function is used if the pre-ACPI 2.0 suspend ordering has been * function is used if the pre-ACPI 2.0 suspend ordering has been
* requested. * requested.
* @stage: The power management event message.
*/ */
static int acpi_hibernation_begin_old(pm_message_t stage) static int acpi_hibernation_begin_old(pm_message_t stage)
{ {