public-mirrors/linux
1
0
Fork 0
mirror of git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2025-09-18 22:14:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

watchdog: clarify that stop() is optional

Browse source 
The commit d0684c8a93 ("watchdog: Make stop function optional")
made stop function not mandatory, but the comments
and the doc weren't reflected. Fix it to clarify.

Signed-off-by: Bumsik Kim <k.bumsik@gmail.com>
Reviewed-by: Guenter Roeck <linux@roeck-us.net>
Link: https://lore.kernel.org/r/20200403031507.63487-1-k.bumsik@gmail.com
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Signed-off-by: Wim Van Sebroeck <wim@linux-watchdog.org>
This commit is contained in:
Bumsik Kim 2020-04-03 12:15:07 +09:00 • committed by Wim Van Sebroeck
parent e56d48e92b
commit f249eef9e6
3 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Documentation/watchdog/convert_drivers_to_kernel_api.rst
View file

@ -115,7 +115,7 @@ Add the watchdog operations
--------------------------- ---------------------------
All possible callbacks are defined in 'struct watchdog_ops'. You can find it All possible callbacks are defined in 'struct watchdog_ops'. You can find it
explained in 'watchdog-kernel-api.txt' in this directory. start(), stop() and explained in 'watchdog-kernel-api.txt' in this directory. start() and
owner must be set, the rest are optional. You will easily find corresponding owner must be set, the rest are optional. You will easily find corresponding
functions in the old driver. Note that you will now get a pointer to the functions in the old driver. Note that you will now get a pointer to the
watchdog_device as a parameter to these functions, so you probably have to watchdog_device as a parameter to these functions, so you probably have to

2
Documentation/watchdog/watchdog-kernel-api.rst
View file

@ -123,8 +123,8 @@ The list of watchdog operations is defined as::
struct module *owner; struct module *owner;
/* mandatory operations */ /* mandatory operations */
int (*start)(struct watchdog_device *); int (*start)(struct watchdog_device *);
int (*stop)(struct watchdog_device *);
/* optional operations */ /* optional operations */
int (*stop)(struct watchdog_device *);
int (*ping)(struct watchdog_device *); int (*ping)(struct watchdog_device *);
unsigned int (*status)(struct watchdog_device *); unsigned int (*status)(struct watchdog_device *);
int (*set_timeout)(struct watchdog_device *, unsigned int); int (*set_timeout)(struct watchdog_device *, unsigned int);

4
include/linux/watchdog.h
View file

@ -37,15 +37,15 @@ struct watchdog_governor;
* *
* The watchdog_ops structure contains a list of low-level operations * The watchdog_ops structure contains a list of low-level operations
* that control a watchdog device. It also contains the module that owns * that control a watchdog device. It also contains the module that owns
* these operations. The start and stop function are mandatory, all other * these operations. The start function is mandatory, all other
* functions are optional. * functions are optional.
*/ */
struct watchdog_ops { struct watchdog_ops {
struct module *owner; struct module *owner;
/* mandatory operations */ /* mandatory operations */
int (*start)(struct watchdog_device *); int (*start)(struct watchdog_device *);
int (*stop)(struct watchdog_device *);
/* optional operations */ /* optional operations */
int (*stop)(struct watchdog_device *);
int (*ping)(struct watchdog_device *); int (*ping)(struct watchdog_device *);
unsigned int (*status)(struct watchdog_device *); unsigned int (*status)(struct watchdog_device *);
int (*set_timeout)(struct watchdog_device *, unsigned int); int (*set_timeout)(struct watchdog_device *, unsigned int);