← Back to branch summary

~ubuntu-branches/ubuntu/trusty/linux-armadaxp/trusty

« back to all changes in this revision

Viewing changes to Documentation/watchdog/watchdog-kernel-api.txt

  • Committer: Package Import Robot
  • Author(s): Michael Casadevall, Bryan Wu, Dann Frazier, Michael Casadeall
  • Date: 2012-03-10 15:00:54 UTC
  • mfrom: (1.1.1)
  • Revision ID: package-import@ubuntu.com-20120310150054-flugb39zon8vvgwe
Tags: 3.2.0-1600.1
[ Bryan Wu ]
* UBUNTU: import debian/debian.env and debian.armadaxp

[ Dann Frazier ]
* ARM: Armada XP: remove trailing '/' in dirnames in mvRules.mk

[ Michael Casadeall ]
* tools: add some tools for Marvell Armada XP processor
* kernel: timer tick hacking from Marvell
* kernel: Sheeva Errata: add delay on Sheeva when powering down
* net: add Marvell NFP netfilter
* net: socket and skb modifications made by Marvell
* miscdevice: add minor IDs for some Marvell Armada drivers
* fs: introduce memory pool for splice()
* video: EDID detection updates from Marvell Armada XP patchset
* video: backlight: add Marvell Dove LCD backlight driver
* video: display: add THS8200 display driver
* video: framebuffer: add Marvell Dove and Armada XP processor onchip LCD controller driver
* usbtest: add Interrupt transfer testing by Marvell Armada XP code
* usb: ehci: add support for Marvell EHCI controler
* tty/serial: 8250: add support for Marvell Armada XP processor and DeviceTree work
* rtc: add support for Marvell Armada XP onchip RTC controller
* net: pppoe: add Marvell ethernet NFP hook in PPPoE networking driver
* mtd: nand: add support for Marvell Armada XP Nand Flash Controller
* mtd: maps: add Marvell Armada XP specific map driver
* mmc: add support for Marvell Armada XP MMC/SD host controller
* i2c: add support for Marvell Armada XP onchip i2c bus controller
* hwmon: add Kconfig option for Armada XP onchip thermal sensor driver
* dmaengine: add Net DMA support for splice and update Marvell XOR DMA engine driver
* ata: add support for Marvell Armada XP SATA controller and update some quirks
* ARM: add Marvell Armada XP machine to mach-types
* ARM: oprofile: add support for Marvell PJ4B core
* ARM: mm: more ARMv6 switches for Marvell Armada XP
* ARM: remove static declaration to allow compilation
* ARM: alignment access fault trick
* ARM: mm: skip some fault fixing when run on NONE SMP ARMv6 mode during early abort event
* ARM: mm: add Marvell Sheeva CPU Architecture for PJ4B
* ARM: introduce optimized copy operation for Marvell Armada XP
* ARM: SAUCE: hardware breakpoint trick for Marvell Armada XP
* ARM: big endian and little endian tricks for Marvell Armada XP
* ARM: SAUCE: Add Marvell Armada XP build rules to arch/arm/kernel/Makefile
* ARM: vfp: add special handling for Marvell Armada XP
* ARM: add support for Marvell U-Boot
* ARM: add mv_controller_num for ARM PCI drivers
* ARM: add support for local PMUs, general SMP tweaks and cache flushing
* ARM: add Marvell device identifies in glue-proc.h
* ARM: add IPC driver support for Marvell platforms
* ARM: add DMA mapping for Marvell platforms
* ARM: add Sheeva errata and PJ4B code for booting
* ARM: update Kconfig and Makefile to include Marvell Armada XP platforms
* ARM: Armada XP: import LSP from Marvell for Armada XP 3.2 kernel enablement

Show diffs side-by-side

added added

removed removed

Lines of Context:
Documentation/watchdog/watchdog-kernel-api.txt
 
1
The Linux WatchDog Timer Driver Core kernel API.
 
2
===============================================
 
3
Last reviewed: 22-Jul-2011
 
4
 
 
5
Wim Van Sebroeck <wim@iguana.be>
 
6
 
 
7
Introduction
 
8
------------
 
9
This document does not describe what a WatchDog Timer (WDT) Driver or Device is.
 
10
It also does not describe the API which can be used by user space to communicate
 
11
with a WatchDog Timer. If you want to know this then please read the following
 
12
file: Documentation/watchdog/watchdog-api.txt .
 
13
 
 
14
So what does this document describe? It describes the API that can be used by
 
15
WatchDog Timer Drivers that want to use the WatchDog Timer Driver Core
 
16
Framework. This framework provides all interfacing towards user space so that
 
17
the same code does not have to be reproduced each time. This also means that
 
18
a watchdog timer driver then only needs to provide the different routines
 
19
(operations) that control the watchdog timer (WDT).
 
20
 
 
21
The API
 
22
-------
 
23
Each watchdog timer driver that wants to use the WatchDog Timer Driver Core
 
24
must #include <linux/watchdog.h> (you would have to do this anyway when
 
25
writing a watchdog device driver). This include file contains following
 
26
register/unregister routines:
 
27
 
 
28
extern int watchdog_register_device(struct watchdog_device *);
 
29
extern void watchdog_unregister_device(struct watchdog_device *);
 
30
 
 
31
The watchdog_register_device routine registers a watchdog timer device.
 
32
The parameter of this routine is a pointer to a watchdog_device structure.
 
33
This routine returns zero on success and a negative errno code for failure.
 
34
 
 
35
The watchdog_unregister_device routine deregisters a registered watchdog timer
 
36
device. The parameter of this routine is the pointer to the registered
 
37
watchdog_device structure.
 
38
 
 
39
The watchdog device structure looks like this:
 
40
 
 
41
struct watchdog_device {
 
42
        const struct watchdog_info *info;
 
43
        const struct watchdog_ops *ops;
 
44
        unsigned int bootstatus;
 
45
        unsigned int timeout;
 
46
        unsigned int min_timeout;
 
47
        unsigned int max_timeout;
 
48
        void *driver_data;
 
49
        unsigned long status;
 
50
};
 
51
 
 
52
It contains following fields:
 
53
* info: a pointer to a watchdog_info structure. This structure gives some
 
54
  additional information about the watchdog timer itself. (Like it's unique name)
 
55
* ops: a pointer to the list of watchdog operations that the watchdog supports.
 
56
* timeout: the watchdog timer's timeout value (in seconds).
 
57
* min_timeout: the watchdog timer's minimum timeout value (in seconds).
 
58
* max_timeout: the watchdog timer's maximum timeout value (in seconds).
 
59
* bootstatus: status of the device after booting (reported with watchdog
 
60
  WDIOF_* status bits).
 
61
* driver_data: a pointer to the drivers private data of a watchdog device.
 
62
  This data should only be accessed via the watchdog_set_drvadata and
 
63
  watchdog_get_drvdata routines.
 
64
* status: this field contains a number of status bits that give extra
 
65
  information about the status of the device (Like: is the watchdog timer
 
66
  running/active, is the nowayout bit set, is the device opened via
 
67
  the /dev/watchdog interface or not, ...).
 
68
 
 
69
The list of watchdog operations is defined as:
 
70
 
 
71
struct watchdog_ops {
 
72
        struct module *owner;
 
73
        /* mandatory operations */
 
74
        int (*start)(struct watchdog_device *);
 
75
        int (*stop)(struct watchdog_device *);
 
76
        /* optional operations */
 
77
        int (*ping)(struct watchdog_device *);
 
78
        unsigned int (*status)(struct watchdog_device *);
 
79
        int (*set_timeout)(struct watchdog_device *, unsigned int);
 
80
        long (*ioctl)(struct watchdog_device *, unsigned int, unsigned long);
 
81
};
 
82
 
 
83
It is important that you first define the module owner of the watchdog timer
 
84
driver's operations. This module owner will be used to lock the module when
 
85
the watchdog is active. (This to avoid a system crash when you unload the
 
86
module and /dev/watchdog is still open).
 
87
Some operations are mandatory and some are optional. The mandatory operations
 
88
are:
 
89
* start: this is a pointer to the routine that starts the watchdog timer
 
90
  device.
 
91
  The routine needs a pointer to the watchdog timer device structure as a
 
92
  parameter. It returns zero on success or a negative errno code for failure.
 
93
* stop: with this routine the watchdog timer device is being stopped.
 
94
  The routine needs a pointer to the watchdog timer device structure as a
 
95
  parameter. It returns zero on success or a negative errno code for failure.
 
96
  Some watchdog timer hardware can only be started and not be stopped. The
 
97
  driver supporting this hardware needs to make sure that a start and stop
 
98
  routine is being provided. This can be done by using a timer in the driver
 
99
  that regularly sends a keepalive ping to the watchdog timer hardware.
 
100
 
 
101
Not all watchdog timer hardware supports the same functionality. That's why
 
102
all other routines/operations are optional. They only need to be provided if
 
103
they are supported. These optional routines/operations are:
 
104
* ping: this is the routine that sends a keepalive ping to the watchdog timer
 
105
  hardware.
 
106
  The routine needs a pointer to the watchdog timer device structure as a
 
107
  parameter. It returns zero on success or a negative errno code for failure.
 
108
  Most hardware that does not support this as a separate function uses the
 
109
  start function to restart the watchdog timer hardware. And that's also what
 
110
  the watchdog timer driver core does: to send a keepalive ping to the watchdog
 
111
  timer hardware it will either use the ping operation (when available) or the
 
112
  start operation (when the ping operation is not available).
 
113
  (Note: the WDIOC_KEEPALIVE ioctl call will only be active when the
 
114
  WDIOF_KEEPALIVEPING bit has been set in the option field on the watchdog's
 
115
  info structure).
 
116
* status: this routine checks the status of the watchdog timer device. The
 
117
  status of the device is reported with watchdog WDIOF_* status flags/bits.
 
118
* set_timeout: this routine checks and changes the timeout of the watchdog
 
119
  timer device. It returns 0 on success, -EINVAL for "parameter out of range"
 
120
  and -EIO for "could not write value to the watchdog". On success the timeout
 
121
  value of the watchdog_device will be changed to the value that was just used
 
122
  to re-program the watchdog timer device.
 
123
  (Note: the WDIOF_SETTIMEOUT needs to be set in the options field of the
 
124
  watchdog's info structure).
 
125
* ioctl: if this routine is present then it will be called first before we do
 
126
  our own internal ioctl call handling. This routine should return -ENOIOCTLCMD
 
127
  if a command is not supported. The parameters that are passed to the ioctl
 
128
  call are: watchdog_device, cmd and arg.
 
129
 
 
130
The status bits should (preferably) be set with the set_bit and clear_bit alike
 
131
bit-operations. The status bits that are defined are:
 
132
* WDOG_ACTIVE: this status bit indicates whether or not a watchdog timer device
 
133
  is active or not. When the watchdog is active after booting, then you should
 
134
  set this status bit (Note: when you register the watchdog timer device with
 
135
  this bit set, then opening /dev/watchdog will skip the start operation)
 
136
* WDOG_DEV_OPEN: this status bit shows whether or not the watchdog device
 
137
  was opened via /dev/watchdog.
 
138
  (This bit should only be used by the WatchDog Timer Driver Core).
 
139
* WDOG_ALLOW_RELEASE: this bit stores whether or not the magic close character
 
140
  has been sent (so that we can support the magic close feature).
 
141
  (This bit should only be used by the WatchDog Timer Driver Core).
 
142
* WDOG_NO_WAY_OUT: this bit stores the nowayout setting for the watchdog.
 
143
  If this bit is set then the watchdog timer will not be able to stop.
 
144
 
 
145
Note: The WatchDog Timer Driver Core supports the magic close feature and
 
146
the nowayout feature. To use the magic close feature you must set the
 
147
WDIOF_MAGICCLOSE bit in the options field of the watchdog's info structure.
 
148
The nowayout feature will overrule the magic close feature.
 
149
 
 
150
To get or set driver specific data the following two helper functions should be
 
151
used:
 
152
 
 
153
static inline void watchdog_set_drvdata(struct watchdog_device *wdd, void *data)
 
154
static inline void *watchdog_get_drvdata(struct watchdog_device *wdd)
 
155
 
 
156
The watchdog_set_drvdata function allows you to add driver specific data. The
 
157
arguments of this function are the watchdog device where you want to add the
 
158
driver specific data to and a pointer to the data itself.
 
159
 
 
160
The watchdog_get_drvdata function allows you to retrieve driver specific data.
 
161
The argument of this function is the watchdog device where you want to retrieve
 
162
data from. The function retruns the pointer to the driver specific data.