From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pj1-f47.google.com (mail-pj1-f47.google.com [209.85.216.47]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 941652DB7A3 for ; Sun, 12 Apr 2026 08:22:19 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.216.47 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1775982140; cv=none; b=j+IEjmXh4DSI8hzieu9Rl1idybTQpcXpx0MDpj/wIMlF5seYZaPCJIWCJ7kjf5cVvyLVtbQLsIF3rx2MQbu8oos3Fa7/c0tYZ9zkiP7FiSx8Ynlnqg6G/nDzHV51g3Mtglln6Ycl9kww2XAhjHG/U/JMIY/3TPlf1rC3oPbgArI= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1775982140; c=relaxed/simple; bh=07CBgzXeAUWv4NrmNUnsSFnmCkQR2o04FGbGs92uPQ4=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=Jv4t520ObP5gt3uxpep+71bW/iZ5fnDrkgY5HoGxQHGbV+cGSzg/dXevyARXN1v4bTW+jaDJccQadSFxm5aHCoJUiZWTWpmlW2rKFM+OAc3ra1ToOTVAvwctd2h4SbOFQa8YELdUViL3uHAfVl9bgI2JOMvDoSTXIw7nvRxKazc= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=aQLfiFB9; arc=none smtp.client-ip=209.85.216.47 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="aQLfiFB9" Received: by mail-pj1-f47.google.com with SMTP id 98e67ed59e1d1-35d99bae2ebso3050313a91.3 for ; Sun, 12 Apr 2026 01:22:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1775982139; x=1776586939; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=NIdNWDTJB8MnCsFnYSBxZ8TNMLf27pK1qRPFQutjdXY=; b=aQLfiFB91mXJE7xmdEgsnoQ3zJWvpbSFYG4vhs0XdpL0gdwH90WLM+P5PQUlPPz/LF pQSG9M+C2JpPXyf7rFr3NpobOs7rsGE1/aavAfv7Yml56XK5lPhom43Yw+OUyc9YkQhe fymHieeFwSZhXlsvkwnpe70Nu/LWLtjJtI6r/Ah+XKKX+ltE3OKpc12rGknh3umzCUV6 cPL/xvSfst4tjwEGk0hxDyPZ0G47MPrVDst2JG2ZcZvW7N2eKEnEWqvVfRjl8Ny1hSvH BxzkkfuhEGCDmoJLFhd4BWIvfBHd1BMFREkWfjJKHAFuDGUnD1s1W8zH2+y/OInGf+0N zatg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1775982139; x=1776586939; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-gg:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=NIdNWDTJB8MnCsFnYSBxZ8TNMLf27pK1qRPFQutjdXY=; b=c0Z3NsGi9zlLA+B79+ywSEaEUfu3AQomK+3h/qigNKA27GM3TS/iQd2XfsTr7InVby z1nJJ5aZ98yj2qv4cleZ34iNGFvaCmD1E7vuR9W86KZgEZ/2o+JHSOkv3nSHASH1MV0O LgGqlBufKkAYp43EiM8Ze4ImPLp1alTdxI6rj2TTdHIRMbGDz0g1bkuSPz5IVZp1L1Rd yeOhwyQrApG1gpY86lxekJL28KX07du1mzfWgXly+3NBS2vWWThLLCdNLAbXaSEt213M b5kTkAxThBLHwAVTasYOw7+XIgYNQwQGm/f/HZZe6ylw/c1PiLtWIdSw67MHbkyf8+ei 6a1A== X-Gm-Message-State: AOJu0YxJZhS+b+kEevpYAGtkse51Zi3LFl9oHysaXU6ao20nn624T0Oz GcHOrghNNRMZUafFPK/j+xjj2pyHtO/7cHdNrwkhvqXZx6Y1CE/Wph7o0nzlAVV2Bi8= X-Gm-Gg: AeBDievNBbkAwG7qg51wVEPuRgk6gSBUbU3EapUdMT94TrTT2rYfgibOA4ZFF6zo13J N1DNO2KA7mCOLyJuTCJa5mrCgTo6bKll5Gwzxw1zcrL79riq5B1VIEQmmYIZRBEq5HyUWPVNyVZ rGF68rbkDqUDggeENLUATvbEXs/RME5Wx9pATsE824+hHLn7h44WzRiGKW8/md6vvUZ7P7NLtJO RJjDpoPd+iAU2lmv4zy0nGhAemwlt6Cf9Qi7G+9g2LIJAQBi7CfM6yp6CfNIFAC2Mh74FC3v5AH JOLdTIp2mKd4MOziINI45PSTUw/67cla112/5BUCg6AIGMmxftsmRQoupY/QDoqcASlIAcCW7Jo Fw9FKDCz5nUe/+EdHluEqS0Ol49+M5rXsusmFoL2UcIQKTafrhHh9uaCm3f5filJES6QB4khHJF CNtCqf+LW0h3rL/p8aSi3lpdSvclD/yyq3jnQ59U2Ht+NVucnH67VE1vo= X-Received: by 2002:a17:90b:390d:b0:35b:929f:7e92 with SMTP id 98e67ed59e1d1-35e42827fbbmr9779773a91.18.1775982138636; Sun, 12 Apr 2026 01:22:18 -0700 (PDT) Received: from tech-Alienware-m15-R6.. ([122.171.18.84]) by smtp.gmail.com with ESMTPSA id 98e67ed59e1d1-35e4131d1desm8593167a91.9.2026.04.12.01.22.15 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 12 Apr 2026 01:22:18 -0700 (PDT) From: Sunny Patel To: linux-doc@vger.kernel.org Cc: linux-watchdog@vger.kernel.org, linux-kernel@vger.kernel.org, corbet@lwn.net, wim@linux-watchdog.org, linux@roeck-us.net, rdunlap@infradead.org, Sunny Patel Subject: [PATCH v3] Documentation: Refactored watchdog old doc Date: Sun, 12 Apr 2026 13:52:05 +0530 Message-ID: <20260412082210.31352-1-nueralspacetech@gmail.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20260411150922.20536-1-nueralspacetech@gmail.com> References: <20260411150922.20536-1-nueralspacetech@gmail.com> Precedence: bulk X-Mailing-List: linux-doc@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Mark WDIOC_GETTEMP and WDIOS_TEMPPANIC as deprecated since neither is implemented by the watchdog core and both are only present in a small number of legacy drivers. Add documentation for previously undocumented status bits WDIOF_MAGICCLOSE and WDIOF_ALARMONLY in the options field. Add documentation for WDIOF_PRETIMEOUT and WDIOF_SETTIMEOUT status bits describing their respective ioctls. Fix the following issues in existing documentation: - Remove version-specific reference to Linux 2.4.18 from the GETTIMEOUT ioctl description - Fix duplicate "was is" in printf format strings - Replace [FIXME] placeholder with proper descriptions for WDIOS_DISABLECARD, WDIOS_ENABLECARD and WDIOS_TEMPPANIC Signed-off-by: Sunny Patel --- Changes in v3: - Replaced .. deprecated:: with .. note:: to avoid Sphinx build warning due to missing version argument - Fixed WDIOF_MAGICCLOSE description: corrected inverted behaviour — without 'V', watchdog remains active and reboots, it does not disable unconditionally - Fixed comma splice: "Magic Close feature, The" -> "Magic Close feature. The" - Fixed WDIOF_ALARMONLY table alignment (malformed table) - Fixed "driver-specific," -> "driver-specific;" (semicolon) - Fixed identity row indentation in watchdog_info table Note: This is sent as v3 and not v4. The previous submission was v2 and this directly addresses the review comments on it. The version was not bumped to v4 to keep the revision history consistent with the actual number of review cycles this patch has gone through. Documentation/watchdog/watchdog-api.rst | 63 +++++++++++++++++++++---- 1 file changed, 53 insertions(+), 10 deletions(-) diff --git a/Documentation/watchdog/watchdog-api.rst b/Documentation/watchdog/watchdog-api.rst index 78e228c272cf..83848d02959d 100644 --- a/Documentation/watchdog/watchdog-api.rst +++ b/Documentation/watchdog/watchdog-api.rst @@ -2,7 +2,7 @@ The Linux Watchdog driver API ============================= -Last reviewed: 10/05/2007 +Last reviewed: 04/08/2026 @@ -42,7 +42,7 @@ activates as soon as /dev/watchdog is opened and will reboot unless 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 source file: see samples/watchdog/watchdog-simple.c +like this source file: see samples/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. @@ -106,11 +106,10 @@ the requested one due to limitation of the hardware:: This example might actually print "The timeout was set to 60 seconds" if the device has a granularity of minutes for its timeout. -Starting with the Linux 2.4.18 kernel, it is possible to query the -current timeout using the GETTIMEOUT ioctl:: +It is also possible to get the current timeout with the GETTIMEOUT ioctl:: ioctl(fd, WDIOC_GETTIMEOUT, &timeout); - printf("The timeout was is %d seconds\n", timeout); + printf("The timeout is %d seconds\n", timeout); Pretimeouts =========== @@ -133,7 +132,7 @@ seconds. Setting a pretimeout to zero disables it. There is also a get function for getting the pretimeout:: ioctl(fd, WDIOC_GETPRETIMEOUT, &timeout); - printf("The pretimeout was is %d seconds\n", timeout); + printf("The pretimeout is %d seconds\n", timeout); Not all watchdog drivers will support a pretimeout. @@ -145,12 +144,12 @@ before the system will reboot. The WDIOC_GETTIMELEFT is the ioctl that returns the number of seconds before reboot:: ioctl(fd, WDIOC_GETTIMELEFT, &timeleft); - printf("The timeout was is %d seconds\n", timeleft); + printf("The timeout is %d seconds\n", timeleft); Environmental monitoring ======================== -All watchdog drivers are required return more information about the system, +All watchdog drivers are required to return more information about the system, some do temperature, fan and power level monitoring, some can tell you the reason for the last reboot of the system. The GETSUPPORT ioctl is available to ask what the device can do:: @@ -227,12 +226,33 @@ The watchdog saw a keepalive ping since it was last queried. WDIOF_SETTIMEOUT Can set/get the timeout ================ ======================= -The watchdog can do pretimeouts. +The watchdog supports timeout set/get via the WDIOC_SETTIMEOUT and +WDIOC_GETTIMEOUT ioctls. ================ ================================ WDIOF_PRETIMEOUT Pretimeout (in seconds), get/set ================ ================================ +The watchdog supports a pretimeout, a warning interrupt that fires before +the actual reboot timeout. Use WDIOC_SETPRETIMEOUT and WDIOC_GETPRETIMEOUT +to set/get the pretimeout. + + ================ ================================ + WDIOF_MAGICCLOSE Supports magic close char + ================ ================================ + +The driver supports the Magic Close feature. The watchdog is only disabled +if the character 'V' is written to /dev/watchdog before the file descriptor +is closed. Without writing 'V' before closing, the watchdog remains active +and will trigger a reboot after the timeout expires. + + ================ ================================ + WDIOF_ALARMONLY Not a reboot watchdog + ================ ================================ + +The watchdog will not reboot the system when it expires. Instead it +triggers a management or other external alarm. Userspace should not +rely on a system reboot occurring. For those drivers that return any bits set in the option field, the GETSTATUS and GETBOOTSTATUS ioctls can be used to ask for the current @@ -254,6 +274,11 @@ returned value is the temperature in degrees Fahrenheit:: int temperature; ioctl(fd, WDIOC_GETTEMP, &temperature); +.. note:: + ``WDIOC_GETTEMP`` is not implemented by the watchdog core and is + considered deprecated. It is only supported by a small number of + legacy drivers. New drivers should not implement it. + Finally the SETOPTIONS ioctl can be used to control some aspects of the cards operation:: @@ -268,4 +293,22 @@ The following options are available: WDIOS_TEMPPANIC Kernel panic on temperature trip ================= ================================ -[FIXME -- better explanations] +``WDIOS_DISABLECARD`` stops the watchdog timer. The driver will cease +pinging the hardware watchdog, allowing a controlled shutdown without +a forced reboot. This is equivalent to the watchdog being disarmed. + +``WDIOS_ENABLECARD`` starts the watchdog timer. If the watchdog was +previously stopped via ``WDIOS_DISABLECARD``, this will re-enable it. The +hardware watchdog will begin counting down from the configured timeout. + +``WDIOS_TEMPPANIC`` enables temperature-based kernel panic. When set, +the driver will call ``panic()`` (or ``kernel_power_off()`` on some +drivers) if the hardware temperature sensor exceeds its threshold, +rather than only setting the ``WDIOF_OVERHEAT`` status bit. Support +for this option is driver-specific; not all watchdog drivers implement +temperature monitoring. + +.. note:: + ``WDIOS_TEMPPANIC`` is not implemented by the watchdog core and is + considered deprecated. It is only present in a small number of + legacy drivers. New drivers should not implement it. -- 2.43.0