arm64: kernel: Update the stale comment

zhangshk · ctmarinas · commit c76fba33467b · 2021-05-06T12:26:26.000+01:00
Commit af391b1 ("arm64: kernel: rename __cpu_suspend to keep it aligned with arm") has used @index instead of @arg, but the comment is stale, update it. Cc: Sudeep Holla <sudeep.holla@arm.com> Cc: Will Deacon <will@kernel.org> Signed-off-by: Shaokun Zhang <zhangshaokun@hisilicon.com> Reviewed-by: Sudeep Holla <sudeep.holla@arm.com> Link: https://lore.kernel.org/r/1620280462-21937-1-git-send-email-zhangshaokun@hisilicon.com Signed-off-by: Catalin Marinas <catalin.marinas@arm.com>
diff --git a/arch/arm64/kernel/cpuidle.c b/arch/arm64/kernel/cpuidle.c
@@ -29,7 +29,7 @@ int arm_cpuidle_init(unsigned int cpu)
 
 /**
  * arm_cpuidle_suspend() - function to enter a low-power idle state
- * @arg: argument to pass to CPU suspend operations
+ * @index: argument to pass to CPU suspend operations
  *
  * Return: 0 on success, -EOPNOTSUPP if CPU suspend hook not initialized, CPU
  * operations back-end error code otherwise.

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ int arm_cpuidle_init(unsigned int cpu)`
`29`	`29`
`30`	`30`	`/**`
`31`	`31`	`* arm_cpuidle_suspend() - function to enter a low-power idle state`
`32`		`- * @arg: argument to pass to CPU suspend operations`
	`32`	`+ * @index: argument to pass to CPU suspend operations`
`33`	`33`	`*`
`34`	`34`	`* Return: 0 on success, -EOPNOTSUPP if CPU suspend hook not initialized, CPU`
`35`	`35`	`* operations back-end error code otherwise.`