watchdog: sp805: Fix kernel doc description
authorAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Mon, 17 May 2021 17:49:12 +0000 (20:49 +0300)
committerWim Van Sebroeck <wim@linux-watchdog.org>
Mon, 21 Jun 2021 06:49:01 +0000 (08:49 +0200)
commit3452239effed2b6ea25835f93bdb8a31f6829ffe
tree3d2de78356c3208b164f5eaa2c5ec17a94926037
parent05f0a994cd27bac4f49c9c4f961922f91a582295
watchdog: sp805: Fix kernel doc description

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@broadcom.com>
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Reviewed-by: Guenter Roeck <linux@roeck-us.net>
Link: https://lore.kernel.org/r/20210517174912.26419-1-andriy.shevchenko@linux.intel.com
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Signed-off-by: Wim Van Sebroeck <wim@linux-watchdog.org>
drivers/watchdog/sp805_wdt.c