device-os/hal/inc/watchdog_hal.h at 45acfd6eff3379f82ce4efff012f32c3263001ae · particle-iot/device-os · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
/**
 ******************************************************************************
 * @file    watchdog_hal.h
 * @author  Matthew McGowan
 * @version V1.0.0
 * @date    25-Sept-2014
 * @brief
 ******************************************************************************
  Copyright (c) 2013-2015 Particle Industries, Inc.  All rights reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation, either
  version 3 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************
 */

#ifndef WATCHDOG_HAL_H
#define WATCHDOG_HAL_H

#include <stdbool.h>
#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

bool HAL_watchdog_reset_flagged();

void HAL_Notify_WDT();

#define HAL_WATCHDOG_CAPABILITY_NONE             (0x00)
// Watchdog timer will reset the CPU
#define HAL_WATCHDOG_CAPABILITY_CPU_RESET        (0x01)
// Watchdog is clocked from an independent clock source
#define HAL_WATCHDOG_CAPABILITY_INDEPENDENT      (0x02)
// Watchdog counter needs to be reset within a configured window
#define HAL_WATCHDOG_CAPABILITY_WINDOWED         (0x04)
// Watchdog timer can be reconfigured
#define HAL_WATCHDOG_CAPABILITY_RECONFIGURABLE   (0x08)
// Watchdog timer can somehow notify about its expiration
#define HAL_WATCHDOG_CAPABILITY_NOTIFY           (0x10)
// Watchdog timer can be stopped
#define HAL_WATCHDOG_CAPABILITY_STOPPABLE        (0x20)

typedef struct {
    uint16_t size;
    uint16_t version;

    uint8_t running;
    uint32_t capabilities;
    uint32_t period_us;
    uint32_t window_us;
} hal_watchdog_status_t;

typedef struct {
    uint16_t size;
    uint16_t version;

    uint32_t capabilities;
    uint32_t period_us;
    uint32_t window_us;

    void (*notify)(void*);
    void* notify_arg;
} hal_watchdog_config_t;

typedef struct {
    uint16_t size;
    uint16_t version;

    uint32_t capabilities;
    uint32_t capabilities_required;

    uint32_t min_period_us;
    uint32_t max_period_us;
} hal_watchdog_info_t;

/**
 * Queries the capabilities of a specific hardware watchdog
 */
int hal_watchdog_query(int idx, hal_watchdog_info_t* info, void* reserved);

/**
 * Starts hardware watchdog (optionally configures it if conf is provided)
 */
int hal_watchdog_start(int idx, hal_watchdog_config_t* conf, void* reserved);

/**
 * Configures specified hardware watchdog
 */
int hal_watchdog_configure(int idx, hal_watchdog_config_t* conf, void* reserved);

/**
 * Stops specified hardware watchdog
 */
int hal_watchdog_stop(int idx, void* reserved);

/**
 * Retrieves running status of specified watchdog
 */
int hal_watchdog_get_status(int idx, hal_watchdog_status_t* status, void* reserved);

/**
 * Kicks specified watchdog, or all of them if idx = -1
 */
int hal_watchdog_kick(int idx, void* reserved);

#ifdef __cplusplus
}
#endif

#include "watchdog_hal_impl.h"

#endif /* WATCHDOG_HAL_H */