On Mon, May 17, 2021 at 08:49:12PM +0300, Andy Shevchenko wrote:
> Kernel doc validation script is not happy
>
> CHECK .../sp805_wdt.c
> .../sp805_wdt.c:73: warning: Function parameter or member 'rate' not described in 'sp805_wdt'
>
> Fix this by describing rate parameter.
>
> While at it, mark clk one optional.
>
> Fixes: dc0e4a3bb7dc ("watchdog: sp805: Add clock-frequency property")
> Cc: Srinath Mannam <srinath.mannam@xxxxxxxxxxxx>
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@xxxxxxxxxxxxxxx>
Reviewed-by: Guenter Roeck <linux@xxxxxxxxxxxx>
> ---
> drivers/watchdog/sp805_wdt.c | 3 ++-
> 1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/watchdog/sp805_wdt.c b/drivers/watchdog/sp805_wdt.c
> index 531551216c8c..dbeb2146c968 100644
> --- a/drivers/watchdog/sp805_wdt.c
> +++ b/drivers/watchdog/sp805_wdt.c
> @@ -57,7 +57,8 @@
> * @wdd: instance of struct watchdog_device
> * @lock: spin lock protecting dev structure and io access
> * @base: base address of wdt
> - * @clk: clock structure of wdt
> + * @clk: (optional) clock structure of wdt
> + * @rate: (optional) clock rate when provided via properties
> * @adev: amba device structure of wdt
> * @status: current status of wdt
> * @load_val: load value to be set for current timeout
> --
> 2.30.2
>
