diff mbox series

bus: ti-sysc: Fix a build warning with W=1 for sysconfig

Message ID 20230809095633.34025-1-tony@atomide.com
State New
Headers
Series bus: ti-sysc: Fix a build warning with W=1 for sysconfig |

Commit Message

Tony Lindgren Aug. 9, 2023, 9:56 a.m. UTC 
  Dhruva reported a build warning with W=1 for "Function parameter or member
'sysconfig' not described in 'sysc'". Let's document sysconfig to fix this.

Reported-by: Dhruva Gole <d-gole@ti.com>
Signed-off-by: Tony Lindgren <tony@atomide.com>
---
 drivers/bus/ti-sysc.c | 1 +
 1 file changed, 1 insertion(+)

Comments

Dhruva Gole Aug. 9, 2023, 10:11 a.m. UTC | #1 
On Aug 09, 2023 at 12:56:33 +0300, Tony Lindgren wrote:
> Dhruva reported a build warning with W=1 for "Function parameter or member
> 'sysconfig' not described in 'sysc'". Let's document sysconfig to fix this.
> 
> Reported-by: Dhruva Gole <d-gole@ti.com>
> Signed-off-by: Tony Lindgren <tony@atomide.com>
> ---

Probably best to include a Fixes: commit no?

>  drivers/bus/ti-sysc.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/bus/ti-sysc.c b/drivers/bus/ti-sysc.c
> --- a/drivers/bus/ti-sysc.c
> +++ b/drivers/bus/ti-sysc.c
> @@ -109,6 +109,7 @@ static const char * const clock_names[SYSC_MAX_CLOCKS] = {
>   * @cookie: data used by legacy platform callbacks
>   * @name: name if available
>   * @revision: interconnect target module revision
> + * @sysconfig: saved sysconfig register value
>   * @reserved: target module is reserved and already in use
>   * @enabled: sysc runtime enabled status
>   * @needs_resume: runtime resume needed on resume from suspend
> -- 
> 2.41.0
Tony Lindgren Aug. 10, 2023, 6:23 a.m. UTC | #2 
* Dhruva Gole <d-gole@ti.com> [230809 10:11]:
> Probably best to include a Fixes: commit no?

Nah, it's a comment fix for W=1 warning for a driver private data struct :)
No need to have it applied in stable kernels as far as I can tell.

Regards,

Tony
diff mbox series

Patch

diff --git a/drivers/bus/ti-sysc.c b/drivers/bus/ti-sysc.c
--- a/drivers/bus/ti-sysc.c
+++ b/drivers/bus/ti-sysc.c
@@ -109,6 +109,7 @@  static const char * const clock_names[SYSC_MAX_CLOCKS] = {
  * @cookie: data used by legacy platform callbacks
  * @name: name if available
  * @revision: interconnect target module revision
+ * @sysconfig: saved sysconfig register value
  * @reserved: target module is reserved and already in use
  * @enabled: sysc runtime enabled status
  * @needs_resume: runtime resume needed on resume from suspend