watchdog: clarify that stop() is optional
Subsystems (2)
PATCH 1/1 watchdog: clarify that stop() is optional
The commit d0684c8a9354 ("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 <[email protected]>
--- Documentation/watchdog/convert_drivers_to_kernel_api.rst | 2 +- Documentation/watchdog/watchdog-kernel-api.rst | 2 +- include/linux/watchdog.h | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-)
Documentation/watchdog/convert_drivers_to_kernel_api.rst +1 -1
@@ -115,7 +115,7 @@ Add the watchdog operations --------------------------- 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 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
Documentation/watchdog/watchdog-kernel-api.rst +1 -1
@@ -123,8 +123,8 @@ The list of watchdog operations is defined as:: struct module *owner; /* mandatory operations */ int (*start)(struct watchdog_device *); - int (*stop)(struct watchdog_device *); /* optional operations */ + int (*stop)(struct watchdog_device *); int (*ping)(struct watchdog_device *); unsigned int (*status)(struct watchdog_device *); int (*set_timeout)(struct watchdog_device *, unsigned int);
include/linux/watchdog.h +2 -2
@@ -37,15 +37,15 @@ struct watchdog_governor;* * The watchdog_ops structure contains a list of low-level operations * 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. */ struct watchdog_ops {struct module *owner;/* mandatory operations */ int (*start)(struct watchdog_device *); -int (*stop)(struct watchdog_device *);/* optional operations */ +int (*stop)(struct watchdog_device *);int (*ping)(struct watchdog_device *);unsigned int (*status)(struct watchdog_device *);int (*set_timeout)(struct watchdog_device *,unsigned int );
Signature · 1 line
2.26.0
Quoted 5 lines · Bumsik Kim
The commit
d0684c8a9354("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 <[email protected]>
Reviewed-by Guenter Roeck <[email protected]>
Quoted 56 lines
--- Documentation/watchdog/convert_drivers_to_kernel_api.rst | 2 +- Documentation/watchdog/watchdog-kernel-api.rst | 2 +- include/linux/watchdog.h | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-)Documentation/watchdog/convert_drivers_to_kernel_api.rst +1
-1@@ -115,7 +115,7 @@ Add the watchdog operations --------------------------- 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 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 toDocumentation/watchdog/watchdog-kernel-api.rst +1
-1@@ -123,8 +123,8 @@ The list of watchdog operations is defined as:: struct module *owner; /* mandatory operations */ int (*start)(struct watchdog_device *); - int (*stop)(struct watchdog_device *); /* optional operations */ + int (*stop)(struct watchdog_device *); int (*ping)(struct watchdog_device *); unsigned int (*status)(struct watchdog_device *); int (*set_timeout)(struct watchdog_device *, unsigned int);include/linux/watchdog.h +2
-2@@ -37,15 +37,15 @@ struct watchdog_governor;* * The watchdog_ops structure contains a list of low-level operations * 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. */ struct watchdog_ops {struct module *owner;/* mandatory operations */ int (*start)(struct watchdog_device *); -int (*stop)(struct watchdog_device *);/* optional operations */ +int (*stop)(struct watchdog_device *);int (*ping)(struct watchdog_device *);unsigned int (*status)(struct watchdog_device *);int (*set_timeout)(struct watchdog_device *,unsigned int );
Quoted 8 lines · On Thu, 2 Apr 2020 21:07:27 -0700 Guenter Roeck <[email protected]> wrote:
Quoted 5 lines · Bumsik Kim
The commit
d0684c8a9354("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 <[email protected]>Reviewed-by Guenter Roeck <[email protected]>
Applied, thanks.
jon