Commit 439cf01b authored by Kari Argillander's avatar Kari Argillander Committed by Wim Van Sebroeck
Browse files

watchdog: Make API functions const correct 



Many watchdog API functions do not modify the watchdog_device nor
device. Mark their arguments as const to reflect this and improve
const-correctness of the API.

No functional change intended.

Signed-off-by: default avatarKari Argillander <kari.argillander@gmail.com>
Reviewed-by: default avatarGuenter Roeck <linux@roeck-us.net>
Signed-off-by: default avatarGuenter Roeck <linux@roeck-us.net>
Signed-off-by: default avatarWim Van Sebroeck <wim@linux-watchdog.org>
parent d303d37e

Documentation/watchdog/watchdog-kernel-api.rst

+1 −1
Original line number Diff line number Diff line
@@ -293,7 +293,7 @@ To initialize the timeout field, the following function can be used:: 


  extern int watchdog_init_timeout(struct watchdog_device *wdd,

                                   unsigned int timeout_parm,

                                   struct device *dev);

                                   const struct device *dev);



The watchdog_init_timeout function allows you to initialize the timeout field

using the module timeout parameter or by retrieving the timeout-sec property from

drivers/watchdog/watchdog_core.c

+2 −1
Original line number Diff line number Diff line
@@ -117,7 +117,8 @@ static void watchdog_check_min_max_timeout(struct watchdog_device *wdd) 
 * bounds.

 */

int watchdog_init_timeout(struct watchdog_device *wdd,

				unsigned int timeout_parm, struct device *dev)

			  unsigned int timeout_parm,

			  const struct device *dev)

{

	const char *dev_str = wdd->parent ? dev_name(wdd->parent) :

			      (const char *)wdd->info->identity;

include/linux/watchdog.h

+7 −5
Original line number Diff line number Diff line
@@ -129,7 +129,7 @@ struct watchdog_device { 
#define WATCHDOG_NOWAYOUT_INIT_STATUS	(WATCHDOG_NOWAYOUT << WDOG_NO_WAY_OUT)



/* Use the following function to check whether or not the watchdog is active */

static inline bool watchdog_active(struct watchdog_device *wdd)

static inline bool watchdog_active(const struct watchdog_device *wdd)

{

	return test_bit(WDOG_ACTIVE, &wdd->status);

}
@@ -138,7 +138,7 @@ static inline bool watchdog_active(struct watchdog_device *wdd) 
 * Use the following function to check whether or not the hardware watchdog

 * is running

 */

static inline bool watchdog_hw_running(struct watchdog_device *wdd)

static inline bool watchdog_hw_running(const struct watchdog_device *wdd)

{

	return test_bit(WDOG_HW_RUNNING, &wdd->status);

}
@@ -169,7 +169,8 @@ static inline void watchdog_stop_ping_on_suspend(struct watchdog_device *wdd) 
}



/* Use the following function to check if a timeout value is invalid */

static inline bool watchdog_timeout_invalid(struct watchdog_device *wdd, unsigned int t)

static inline bool watchdog_timeout_invalid(const struct watchdog_device *wdd,

					    unsigned int t)

{

	/*

	 * The timeout is invalid if
@@ -188,7 +189,7 @@ static inline bool watchdog_timeout_invalid(struct watchdog_device *wdd, unsigne 
}



/* Use the following function to check if a pretimeout value is invalid */

static inline bool watchdog_pretimeout_invalid(struct watchdog_device *wdd,

static inline bool watchdog_pretimeout_invalid(const struct watchdog_device *wdd,

					       unsigned int t)

{

	return t && wdd->timeout && t >= wdd->timeout;
@@ -218,7 +219,8 @@ static inline void watchdog_notify_pretimeout(struct watchdog_device *wdd) 
/* drivers/watchdog/watchdog_core.c */

void watchdog_set_restart_priority(struct watchdog_device *wdd, int priority);

extern int watchdog_init_timeout(struct watchdog_device *wdd,

				  unsigned int timeout_parm, struct device *dev);

				 unsigned int timeout_parm,

				 const struct device *dev);

extern int watchdog_register_device(struct watchdog_device *);

extern void watchdog_unregister_device(struct watchdog_device *);

int watchdog_dev_suspend(struct watchdog_device *wdd);