share/man/man4/man4.arm/imx_wdog.4

   1 .\"
   2 .\" Copyright (c) 2018 Ian Lepore <ian@freebsd.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd July 7, 2018
  29 .Dt IMX_WDOG 4
  30 .Os
  31 .Sh NAME
  32 .Nm imx_wdog
  33 .Nd device driver for the NXP i.MX5 and i.MX6 watchdog timer
  34 .Sh SYNOPSIS
  35 To compile this driver into the kernel,
  36 place the following line in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device imxwdt"
  40 .Ed
  41 .Pp
  42 Alternatively, to load the driver as a
  43 module at boot time, place the following line in
  44 .Xr loader.conf 5 :
  45 .Bd -literal -offset indent
  46 imx_wdog_load="YES"
  47 .Ed
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 driver provides
  52 .Xr watchdog 4
  53 support for the watchdog timer present on NXP i.MX5 and i.MX6 processors.
  54 The i.MX watchdog hardware supports programmable timeouts ranging from
  55 0.5 to 128 seconds, in half-second increments.
  56 Once activated, the watchdog hardware cannot be deactivated, but the
  57 timeout period can be changed to any valid non-zero value.
  58 .Pp
  59 At power-on, a special 16-second
  60 .Sq power-down timer
  61 mode is automatically enabled by the hardware.
  62 It will assert the external WDOG_B signal, which may be connected to
  63 external hardware that causes the system to reset or power-down.
  64 The power-down timer is often reset by the boot loader (typically U-Boot).
  65 If the power-down timer is still active at the time when the normal
  66 watchdog is first enabled, the
  67 .Nm
  68 driver automatically disables it.
  69 .Pp
  70 The
  71 .Nm
  72 driver supports the FDT
  73 .Va fsl,external-reset
  74 property by enabling the assertion of the WDOG_B external timeout signal
  75 when the property is present.
  76 When running this way, the need to reset the system due to watchdog
  77 timeout is signaled by driving the WDOG_B line low; some external
  78 entity is expected to assert the chip's POR pin in response.
  79 The
  80 .Nm
  81 driver attempts to backstop this external reset by scheduling an
  82 interrupt to occur as well.
  83 The interrupt handler waits 1 second for the external reset to occur,
  84 then it triggers a normal software reset.
  85 Note that the WDOG_B signal can be configured to use a variety of
  86 pins on the chip.
  87 For the
  88 .Va fsl,external-reset
  89 property to be effective, the signal must be connected to an appropriate
  90 pin by the system's FDT pinctrl data.
  91 .Pp
  92 The
  93 .Nm
  94 driver supports the FDT
  95 .Va timeout-secs
  96 property by enabling the watchdog as soon as the driver attaches,
  97 using the given timeout value.
  98 This extends watchdog protection to much of the system startup process,
  99 but it still requires that
 100 .Xr watchdogd 4
 101 be configured to service the watchdog.
 102 .Sh SEE ALSO
 103 .Xr fdt 4 ,
 104 .Xr watchdog 4 ,
 105 .Xr watchdog 8 ,
 106 .Xr watchdogd 8 ,
 107 .Xr watchdog 9
 108 .Sh HISTORY
 109 The
 110 .Nm
 111 driver first appeared in
 112 .Fx 10.0 .