ACPI: fix doc warnings
PATCH 1/1 ACPI: fix doc warnings
Fix gcc W=1 warnings:drivers/acpi/cppc_acpi.c:1356: warning: Function parameter or member 'cpu_num' not described in 'cppc_get_transition_latency' drivers/acpi/cppc_acpi.c:573: warning: Function parameter or member 'pcc_ss_id' not described in 'pcc_data_alloc' drivers/acpi/dock.c:388: warning: Function parameter or member 'ds' not described in 'handle_eject_request' drivers/acpi/dock.c:388: warning: Function parameter or member 'event' not described in 'handle_eject_request' drivers/acpi/sleep.c:496: warning: Function parameter or member 'acpi_state' not described in 'acpi_pm_start' drivers/acpi/sleep.c:536: warning: Function parameter or member 'pm_state' not described in 'acpi_suspend_begin' drivers/acpi/sleep.c:663: warning: Function parameter or member 'pm_state' not described in 'acpi_suspend_begin_old' drivers/acpi/sleep.c:956: warning: Function parameter or member 'stage' not described in 'acpi_hibernation_begin_old'
--- drivers/acpi/cppc_acpi.c | 2 ++ drivers/acpi/dock.c | 2 ++ drivers/acpi/sleep.c | 4 ++++ 3 files changed, 8 insertions(+)
drivers/acpi/cppc_acpi.c +2 -0
@@ -561,6 +561,7 @@ bool __weak cpc_ffh_supported(void)/** * pcc_data_alloc() - Allocate the pcc_data memory for pcc subspace +* @pcc_ss_id: pcc subspace id. * * Check and allocate the cppc_pcc_data memory. * In some processor configurations it is possible that same subspace
@@ -1346,6 +1347,7 @@ EXPORT_SYMBOL_GPL(cppc_set_perf);/** * cppc_get_transition_latency - returns frequency transition latency in ns +* @cpu: CPU for which to get transition latency. * * ACPI CPPC does not explicitly specify how a platform can specify the * transition latency for performance change requests. The closest we have
drivers/acpi/dock.c +2 -0
@@ -380,6 +380,8 @@ static int dock_in_progress(struct dock_station *ds)/** * handle_eject_request - handle an undock request checking for error conditions +* @ds: the dock station. +* @event: Event code. * * Check to make sure the dock device is still present, then undock and * hotremove all the devices that may need removing.
drivers/acpi/sleep.c +4 -0
@@ -491,6 +491,7 @@ static void acpi_pm_finish(void)/** * acpi_pm_start - Start system PM transition. +* @acpi_state: Power state value. */ static void acpi_pm_start (u32 acpi_state) {
@@ -531,6 +532,7 @@ static u32 acpi_suspend_states[] = {/** * acpi_suspend_begin - Set the target system sleep state to the state * associated with given @pm_state, if supported. +* @pm_state: pm suspend state. */ static int acpi_suspend_begin (suspend_state_t pm_state) {
@@ -658,6 +660,7 @@ static const struct platform_suspend_ops acpi_suspend_ops = {* state associated with given @pm_state, if supported, and * execute the _PTS control method. This function is used if the * pre-ACPI 2.0 suspend ordering has been requested. +* @pm_state: pm suspend state. */ static int acpi_suspend_begin_old (suspend_state_t pm_state) {
@@ -951,6 +954,7 @@ static const struct platform_hibernation_ops acpi_hibernation_ops = {* ACPI_STATE_S4 and execute the _PTS control method. This * function is used if the pre-ACPI 2.0 suspend ordering has been * requested. +* @stage: pm event massage */ static int acpi_hibernation_begin_old (pm_message_t stage) {
Signature · 1 line
2.25.4
Rafael J. Wysocki
maintainerQuoted 64 lines · ChenXiaoSong
Fix gcc W=1 warnings:
drivers/acpi/cppc_acpi.c:1356: warning: Function parameter or member 'cpu_num' not described in 'cppc_get_transition_latency'drivers/acpi/cppc_acpi.c:573: warning: Function parameter or member 'pcc_ss_id' not described in 'pcc_data_alloc'drivers/acpi/dock.c:388: warning: Function parameter or member 'ds' not described in 'handle_eject_request'drivers/acpi/dock.c:388: warning: Function parameter or member 'event' not described in 'handle_eject_request'drivers/acpi/sleep.c:496: warning: Function parameter or member 'acpi_state' not described in 'acpi_pm_start'drivers/acpi/sleep.c:536: warning: Function parameter or member 'pm_state' not described in 'acpi_suspend_begin'drivers/acpi/sleep.c:663: warning: Function parameter or member 'pm_state' not described in 'acpi_suspend_begin_old'drivers/acpi/sleep.c:956: warning: Function parameter or member 'stage' not described in 'acpi_hibernation_begin_old'Signed-off-by ChenXiaoSong <[email protected]>--- drivers/acpi/cppc_acpi.c | 2 ++ drivers/acpi/dock.c | 2 ++ drivers/acpi/sleep.c | 4 ++++ 3 files changed, 8 insertions(+)drivers/acpi/cppc_acpi.c +2
-0@@ -561,6 +561,7 @@ bool __weak cpc_ffh_supported(void)/** * pcc_data_alloc() - Allocate the pcc_data memory for pcc subspace +* @pcc_ss_id: pcc subspace id. * * Check and allocate the cppc_pcc_data memory. * In some processor configurations it is possible that same subspace @@ -1346,6 +1347,7 @@ EXPORT_SYMBOL_GPL(cppc_set_perf);/** * cppc_get_transition_latency - returns frequency transition latency in ns +* @cpu: CPU for which to get transition latency. * * ACPI CPPC does not explicitly specify how a platform can specify the * transition latency for performance change requests. The closest we have drivers/acpi/dock.c +2
-0@@ -380,6 +380,8 @@ static int dock_in_progress(struct dock_station *ds)/** * handle_eject_request - handle an undock request checking for error conditions +* @ds: the dock station. +* @event: Event code. * * Check to make sure the dock device is still present, then undock and * hotremove all the devices that may need removing. drivers/acpi/sleep.c +1
-0@@ -491,6 +491,7 @@ static void acpi_pm_finish(void)/** * acpi_pm_start - Start system PM transition. +* @acpi_state: Power state value. */ static void acpi_pm_start (u32 acpi_state) {
drivers/acpi/sleep.c static u32 acpi_suspend_states[] = { · line 535
Quoted 4 lines
drivers/acpi/sleep.c +1
-0@@ -531,6 +532,7 @@ static u32 acpi_suspend_states[] = {/** * acpi_suspend_begin - Set the target system sleep state to the state * associated with given @pm_state, if supported. +* @pm_state: pm suspend state.
Well, I appreciate the effort, but this change doesn't really improve the kerneldoc too much regarding the information provided by it.
In fact, @pm_state is documented already here, you just need to rearrange this comment.
drivers/acpi/sleep.c static const struct platform_suspend_ops acpi_suspend_ops = { · line 663
Quoted 8 lines
drivers/acpi/sleep.c +1
-0*/ static int acpi_suspend_begin (suspend_state_t pm_state) {@@ -658,6 +660,7 @@ static const struct platform_suspend_ops acpi_suspend_ops = {* state associated with given @pm_state, if supported, and * execute the _PTS control method. This function is used if the * pre-ACPI 2.0 suspend ordering has been requested. +* @pm_state: pm suspend state.
Pretty much same as above.
drivers/acpi/sleep.c static const struct platform_hibernation_ops acpi_hibernation_ops = { · line 957
Quoted 8 lines
drivers/acpi/sleep.c +1
-0*/ static int acpi_suspend_begin_old (suspend_state_t pm_state) {@@ -951,6 +954,7 @@ static const struct platform_hibernation_ops acpi_hibernation_ops = {* ACPI_STATE_S4 and execute the _PTS control method. This * function is used if the pre-ACPI 2.0 suspend ordering has been * requested. +* @stage: pm event massage
And here too.
Quoted 6 lines
drivers/acpi/sleep.c +0
-1*/ static int acpi_hibernation_begin_old (pm_message_t stage) { --2.25.4