Skip to contentSkip to conversation

Doc. sources: expose watchdog

PATCH In review Randy.Dunlap 3 participants 7 messages May 22, 2006 – Jun 20, 2006

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Doc. sources: expose watchdog

From: Randy Dunlap <[email protected]>

Documentation/watchdog/:
Expose example and tool source files in the Documentation/ directory in their own files instead of being buried (almost hidden) in readme/txt files.

This will make them more visible/usable to users who may need to use them, to developers who may need to test with them, and to janitors who would update them if they were more visible.

Also, if any of these possibly should not be in the kernel tree at all, it will be clearer that they are here and we can discuss if they should be removed.

---
 Documentation/watchdog/pcwd-watchdog.txt |   73 -------------------------------
 Documentation/watchdog/watchdog-api.txt  |   17 -------
 Documentation/watchdog/watchdog-simple.c |   15 ++++++
 Documentation/watchdog/watchdog-test.c   |   68 ++++++++++++++++++++++++++++
 Documentation/watchdog/watchdog.txt      |   23 ---------
 5 files changed, 87 insertions(+), 109 deletions(-)
Documentation/watchdog/pcwd-watchdog.txt +2 -71
@@ -22,78 +22,9 @@
  to run the program with an "&" to run it in the background!)
 
  If you want to write a program to be compatible with the PC Watchdog
- driver, simply do the following:
+ driver, simply use of modify the watchdog test program:
+ Documentation/watchdog/watchdog-test.c
 
--- Snippet of code --
-/*
- * Watchdog Driver Test Program
- */
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <unistd.h>
-#include <fcntl.h>
-#include <sys/ioctl.h>
-#include <linux/types.h>
-#include <linux/watchdog.h>
-
-int fd;
-
-/*
- * This function simply sends an IOCTL to the driver, which in turn ticks
- * the PC Watchdog card to reset its internal timer so it doesn't trigger
- * a computer reset.
- */
-void keep_alive(void)
-{
-    int dummy;
-
-    ioctl(fd, WDIOC_KEEPALIVE, &dummy);
-}
-
-/*
- * The main program.  Run the program with "-d" to disable the card,
- * or "-e" to enable the card.
- */
-int main(int argc, char *argv[])
-{
-    fd = open("/dev/watchdog", O_WRONLY);
-
-    if (fd == -1) {
-	fprintf(stderr, "Watchdog device not enabled.\n");
-	fflush(stderr);
-	exit(-1);
-    }
-
-    if (argc > 1) {
-	if (!strncasecmp(argv[1], "-d", 2)) {
-	    ioctl(fd, WDIOC_SETOPTIONS, WDIOS_DISABLECARD);
-	    fprintf(stderr, "Watchdog card disabled.\n");
-	    fflush(stderr);
-	    exit(0);
-	} else if (!strncasecmp(argv[1], "-e", 2)) {
-	    ioctl(fd, WDIOC_SETOPTIONS, WDIOS_ENABLECARD);
-	    fprintf(stderr, "Watchdog card enabled.\n");
-	    fflush(stderr);
-	    exit(0);
-	} else {
-	    fprintf(stderr, "-d to disable, -e to enable.\n");
-	    fprintf(stderr, "run by itself to tick the card.\n");
-	    fflush(stderr);
-	    exit(0);
-	}
-    } else {
-	fprintf(stderr, "Watchdog Ticking Away!\n");
-	fflush(stderr);
-    }
-
-    while(1) {
-	keep_alive();
-	sleep(1);
-    }
-}
--- End snippet --
 
  Other IOCTL functions include:
 
Documentation/watchdog/watchdog-api.txt +1 -16
@@ -34,22 +34,7 @@ activates as soon as /dev/watchdog is op
 the watchdog is pinged within a certain time, this time is called the
 timeout or margin.  The simplest way to ping the watchdog is to write
 some data to the device.  So a very simple watchdog daemon would look
-like this:
-
-#include <stdlib.h>
-#include <fcntl.h>
-
-int main(int argc, const char *argv[]) {
-	int fd=open("/dev/watchdog",O_WRONLY);
-	if (fd==-1) {
-		perror("watchdog");
-		exit(1);
-	}
-	while(1) {
-		write(fd, "\0", 1);
-		sleep(10);
-	}
-}
+like this source file:  see Documentation/watchdog/watchdog-simple.c
 
 A more advanced driver could for example check that a HTTP server is
 still responding before doing the write call to ping the watchdog.
Documentation/watchdog/watchdog-simple.c new file +15 -0
@@ -0,0 +1,15 @@
+#include <stdlib.h>
+#include <fcntl.h>
+
+int main(int argc, const char *argv[]) {
+	int fd = open("/dev/watchdog", O_WRONLY);
+	if (fd == -1) {
+		perror("watchdog");
+		exit(1);
+	}
+	while (1) {
+		write(fd, "\0", 1);
+		fsync(fd);
+		sleep(10);
+	}
+}
Documentation/watchdog/watchdog-test.c new file +68 -0

68 lines not on this page · raw message

Documentation/watchdog/watchdog.txt +1 -22
@@ -65,28 +65,7 @@ The external event interfaces on the WDT
 Minor numbers are however allocated for it.
 
 
-Example Watchdog Driver
------------------------
-
-#include <stdio.h>
-#include <unistd.h>
-#include <fcntl.h>
-
-int main(int argc, const char *argv[])
-{
-	int fd=open("/dev/watchdog",O_WRONLY);
-	if(fd==-1)
-	{
-		perror("watchdog");
-		exit(1);
-	}
-	while(1)
-	{
-		write(fd,"\0",1);
-		fsync(fd);
-		sleep(10);
-	}
-}
+Example Watchdog Driver:  see Documentation/watchdog/watchdog-simple.c
 
 
 Contact Information

---

#1 lore raw

Hi Randy,

Quoted 8 lines

Documentation/watchdog/:
Expose example and tool source files in the Documentation/ directory in their own files instead of being buried (almost hidden) in readme/txt files.

This will make them more visible/usable to users who may need to use them, to developers who may need to test with them, and to janitors who would update them if they were more visible.

Quoted 5 lines

Also, if any of these possibly should not be in the kernel tree at all, it will be clearer that they are here and we can discuss if they should be removed.

Has been added to the linux-2.6-watchdog-mm git tree.

Greetings,
Wim.

#2 lore raw
In reply to Randy.Dunlap
Quoted 6 lines · Randy.Dunlap
 Documentation/watchdog/pcwd-watchdog.txt |   73 -------------------------------
  Documentation/watchdog/watchdog-api.txt  |   17 -------
  Documentation/watchdog/watchdog-simple.c |   15 ++++++
  Documentation/watchdog/watchdog-test.c   |   68 ++++++++++++++++++++++++++++
  Documentation/watchdog/watchdog.txt      |   23 ---------

Wouldn't it be better to move all the .c files into a new directory? Documentation/src or something?

#3 lore raw
Quoted 10 lines · On Mon, 22 May 2006 14:43:47 -0700 Andrew Morton wrote:
Quoted 6 lines · Randy.Dunlap
 Documentation/watchdog/pcwd-watchdog.txt |   73 -------------------------------
  Documentation/watchdog/watchdog-api.txt  |   17 -------
  Documentation/watchdog/watchdog-simple.c |   15 ++++++
  Documentation/watchdog/watchdog-test.c   |   68 ++++++++++++++++++++++++++++
  Documentation/watchdog/watchdog.txt      |   23 ---------

Wouldn't it be better to move all the .c files into a new directory? Documentation/src or something?

I dunno. I like using multiple subdirectories (like watchdog/, laptop/, block/, etc.) and not cluttering up Documentation/ with them.

Anybody else have preferences?

---
~Randy

#4 lore raw

Hi All,

Quoted 8 lines
Quoted 8 lines
Quoted 6 lines · Randy.Dunlap
 Documentation/watchdog/pcwd-watchdog.txt |   73 -------------------------------
  Documentation/watchdog/watchdog-api.txt  |   17 -------
  Documentation/watchdog/watchdog-simple.c |   15 ++++++
  Documentation/watchdog/watchdog-test.c   |   68 ++++++++++++++++++++++++++++
  Documentation/watchdog/watchdog.txt      |   23 ---------
Quoted 6 lines
Quoted 2 lines

Wouldn't it be better to move all the .c files into a new directory? Documentation/src or something?

I dunno. I like using multiple subdirectories (like watchdog/, laptop/, block/, etc.) and not cluttering up Documentation/ with them.

I think a "user" that wants to know something specific about watchdog drivers will look in Documentation/watchdog and try to find what he need as fast as he can. I would say Documentation/watchdog/src/ then...

Greetings,
Wim.

#5 lore raw

Randy, Andrew,

Quoted 9 lines
Quoted 9 lines
Quoted 8 lines
Quoted 5 lines
 Documentation/watchdog/pcwd-watchdog.txt |   73 -------------------------------
  Documentation/watchdog/watchdog-api.txt  |   17 -------
  Documentation/watchdog/watchdog-simple.c |   15 ++++++
  Documentation/watchdog/watchdog-test.c   |   68 ++++++++++++++++++++++++++++
  Documentation/watchdog/watchdog.txt      |   23 ---------

Wouldn't it be better to move all the .c files into a new directory? Documentation/src or something?

Quoted 7 lines
Quoted 3 lines

I dunno. I like using multiple subdirectories (like watchdog/, laptop/, block/, etc.) and not cluttering up Documentation/ with them.

I think a "user" that wants to know something specific about watchdog drivers will look in Documentation/watchdog and try to find what he need as fast as he can. I would say Documentation/watchdog/src/ then...

I'm going to change this patch so that we put the .c files in Documentation/watchdog/src/ . I presume this is ok for both of you?

Thanks,
Wim.

#6 lore raw
Quoted 15 lines · On Tue, 20 Jun 2006 20:48:47 +0200 Wim Van Sebroeck wrote:

Randy, Andrew,

Quoted 13 lines
Quoted 12 lines
Quoted 8 lines
Quoted 5 lines
 Documentation/watchdog/pcwd-watchdog.txt |   73 -------------------------------
  Documentation/watchdog/watchdog-api.txt  |   17 -------
  Documentation/watchdog/watchdog-simple.c |   15 ++++++
  Documentation/watchdog/watchdog-test.c   |   68 ++++++++++++++++++++++++++++
  Documentation/watchdog/watchdog.txt      |   23 ---------

Wouldn't it be better to move all the .c files into a new directory? Documentation/src or something?

I dunno. I like using multiple subdirectories (like watchdog/, laptop/, block/, etc.) and not cluttering up Documentation/ with them.

Quoted 6 lines
Quoted 3 lines

I think a "user" that wants to know something specific about watchdog drivers will look in Documentation/watchdog and try to find what he need as fast as he can. I would say Documentation/watchdog/src/ then...

I'm going to change this patch so that we put the .c files in Documentation/watchdog/src/ . I presume this is ok for both of you?

Sure, OK for me. Thanks.

---
~Randy