1 | //watchdog.h: |
---|
2 | |
---|
3 | /* |
---|
4 | * Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2012-2015 |
---|
5 | * |
---|
6 | * This file is part of libroar a part of RoarAudio, |
---|
7 | * a cross-platform sound system for both, home and professional use. |
---|
8 | * See README for details. |
---|
9 | * |
---|
10 | * This file is free software; you can redistribute it and/or modify |
---|
11 | * it under the terms of the GNU General Public License version 3 |
---|
12 | * as published by the Free Software Foundation. |
---|
13 | * |
---|
14 | * libroar is distributed in the hope that it will be useful, |
---|
15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
17 | * GNU General Public License for more details. |
---|
18 | * |
---|
19 | * You should have received a copy of the GNU General Public License |
---|
20 | * along with this software; see the file COPYING. If not, write to |
---|
21 | * the Free Software Foundation, 51 Franklin Street, Fifth Floor, |
---|
22 | * Boston, MA 02110-1301, USA. |
---|
23 | * |
---|
24 | * NOTE for everyone want's to change something and send patches: |
---|
25 | * read README and HACKING! There a addition information on |
---|
26 | * the license of this document you need to read before you send |
---|
27 | * any patches. |
---|
28 | * |
---|
29 | * NOTE for uses of non-GPL (LGPL,...) software using libesd, libartsc |
---|
30 | * or libpulse*: |
---|
31 | * The libs libroaresd, libroararts and libroarpulse link this lib |
---|
32 | * and are therefore GPL. Because of this it may be illigal to use |
---|
33 | * them with any software that uses libesd, libartsc or libpulse*. |
---|
34 | */ |
---|
35 | |
---|
36 | #ifndef _LIBROARWATCHDOG_H_ |
---|
37 | #define _LIBROARWATCHDOG_H_ |
---|
38 | |
---|
39 | #include "libroar.h" |
---|
40 | |
---|
41 | enum roar_watchdog_event { |
---|
42 | ROAR_WATCHDOG_START = 0, |
---|
43 | ROAR_WATCHDOG_STOP, |
---|
44 | ROAR_WATCHDOG_TRIGGER, |
---|
45 | ROAR_WATCHDOG_TICK, |
---|
46 | ROAR_WATCHDOG_TIMEOUT, |
---|
47 | ROAR_WATCHDOG_DOUBLETIMEOUT, |
---|
48 | }; |
---|
49 | |
---|
50 | #define ROAR_WATCHDOG_CONF_DEFAULTS -1 |
---|
51 | #define ROAR_WATCHDOG_CONF_RESTART -2 |
---|
52 | #define ROAR_WATCHDOG_CONF_STOPPABLE 0x0001 |
---|
53 | #define ROAR_WATCHDOG_CONF_CLOCK_INTERNAL 0x0000 |
---|
54 | #define ROAR_WATCHDOG_CONF_CLOCK_EXTERNAL 0x0010 |
---|
55 | #define ROAR_WATCHDOG_CONF_CLOCK_ROUND_DOWN 0x0000 |
---|
56 | #define ROAR_WATCHDOG_CONF_CLOCK_ROUND_UP 0x0020 |
---|
57 | #define ROAR_WATCHDOG_CONF_EVENTS_ONLY_MAJOR 0x0000 |
---|
58 | #define ROAR_WATCHDOG_CONF_EVENTS_ALSO_MINOR 0x0100 |
---|
59 | |
---|
60 | // start the watchdog. |
---|
61 | // timeout is in ms. |
---|
62 | int roar_watchdog_start(int config, int_least32_t timeout, int (*callback)(enum roar_watchdog_event event)); |
---|
63 | |
---|
64 | // Get timeout for watchdog. |
---|
65 | // This may be diffrent from the requested time. |
---|
66 | int_least32_t roar_watchdog_gettime(void); |
---|
67 | |
---|
68 | // stop it, if stopping is enabled. |
---|
69 | int roar_watchdog_stop(void); |
---|
70 | |
---|
71 | // Trigger the watchdog to show that we are still alive. |
---|
72 | int roar_watchdog_trigger(void); |
---|
73 | |
---|
74 | // Trigger the watchdog clock. This is only used if configured to run with external clock source. |
---|
75 | int roar_watchdog_tick(void); |
---|
76 | |
---|
77 | #endif |
---|
78 | |
---|
79 | //ll |
---|