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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
/*
* Copyright 2017 NXP
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of NXP nor the names of its contributors may be used
* to endorse or promote products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/*!
* Header file containing the public API for the System Controller (SC)
* Timer function.
*
* @addtogroup TIMER_SVC (SVC) Timer Service
*
* Module for the Timer service. This includes support for the watchdog, RTC,
* and system counter. Note every resource partition has a watchdog it can
* use.
*
* @{
*/
#ifndef _SC_TIMER_API_H
#define _SC_TIMER_API_H
/* Includes */
#include <sci/types.h>
#include <sci/svc/rm/api.h>
/* Defines */
/*!
* @name Defines for type widths
*/
/*@{*/
#define SC_TIMER_ACTION_W 2 /* Width of sc_timer_wdog_action_t */
/*@}*/
/*!
* @name Defines for sc_timer_wdog_action_t
*/
/*@{*/
#define SC_TIMER_WDOG_ACTION_PARTITION 0 /* Reset partition */
#define SC_TIMER_WDOG_ACTION_WARM 1 /* Warm reset system */
#define SC_TIMER_WDOG_ACTION_COLD 2 /* Cold reset system */
#define SC_TIMER_WDOG_ACTION_BOARD 3 /* Reset board */
/*@}*/
/* Types */
/*!
* This type is used to configure the watchdog action.
*/
typedef uint8_t sc_timer_wdog_action_t;
/*!
* This type is used to declare a watchdog time value in milliseconds.
*/
typedef uint32_t sc_timer_wdog_time_t;
/* Functions */
/*!
* @name Wathdog Functions
* @{
*/
/*!
* This function sets the watchdog timeout in milliseconds. If not
* set then the timeout defaults to the max. Once locked this value
* cannot be changed.
*
* @param[in] ipc IPC handle
* @param[in] timeout timeout period for the watchdog
*
* @return Returns an error code (SC_ERR_NONE = success, SC_ERR_LOCKED
* = locked).
*/
sc_err_t sc_timer_set_wdog_timeout(sc_ipc_t ipc, sc_timer_wdog_time_t timeout);
/*!
* This function starts the watchdog.
*
* @param[in] ipc IPC handle
* @param[in] lock boolean indicating the lock status
*
* @return Returns an error code (SC_ERR_NONE = success).
*
* If \a lock is set then the watchdog cannot be stopped or the timeout
* period changed.
*/
sc_err_t sc_timer_start_wdog(sc_ipc_t ipc, bool lock);
/*!
* This function stops the watchdog if it is not locked.
*
* @param[in] ipc IPC handle
*
* @return Returns an error code (SC_ERR_NONE = success, SC_ERR_LOCKED
* = locked).
*/
sc_err_t sc_timer_stop_wdog(sc_ipc_t ipc);
/*!
* This function pings (services, kicks) the watchdog resetting the time
* before expiration back to the timeout.
*
* @param[in] ipc IPC handle
*
* @return Returns an error code (SC_ERR_NONE = success).
*/
sc_err_t sc_timer_ping_wdog(sc_ipc_t ipc);
/*!
* This function gets the status of the watchdog. All arguments are
* in milliseconds.
*
* @param[in] ipc IPC handle
* @param[out] timeout pointer to return the timeout
* @param[out] max_timeout pointer to return the max timeout
* @param[out] remaining_time pointer to return the time remaining
* until trigger
*
* @return Returns an error code (SC_ERR_NONE = success).
*/
sc_err_t sc_timer_get_wdog_status(sc_ipc_t ipc,
sc_timer_wdog_time_t *timeout,
sc_timer_wdog_time_t *max_timeout,
sc_timer_wdog_time_t *remaining_time);
/*!
* This function configures the action to be taken when a watchdog
* expires.
*
* @param[in] ipc IPC handle
* @param[in] pt partition to affect
* @param[in] action action to take
*
* @return Returns an error code (SC_ERR_NONE = success).
*
* Return errors:
* - SC_ERR_PARM if invalid parameters,
* - SC_ERR_NOACCESS if caller's partition is not the SYSTEM owner,
* - SC_ERR_NOACCESS if caller's partition is not the parent of \a pt,
* - SC_ERR_LOCKED if the watchdog is locked
*/
sc_err_t sc_timer_set_wdog_action(sc_ipc_t ipc,
sc_rm_pt_t pt, sc_timer_wdog_action_t action);
/* @} */
/*!
* @name Real-Time Clock (RTC) Functions
* @{
*/
/*!
* This function sets the RTC time. Only the owner of the SC_R_SYSTEM
* resource can set the time.
*
* @param[in] ipc IPC handle
* @param[in] year year (min 1970)
* @param[in] mon month (1-12)
* @param[in] day day of the month (1-31)
* @param[in] hour hour (0-23)
* @param[in] min minute (0-59)
* @param[in] sec second (0-59)
*
* @return Returns an error code (SC_ERR_NONE = success).
*
* Return errors:
* - SC_ERR_PARM if invalid time/date parameters,
* - SC_ERR_NOACCESS if caller's partition is not the SYSTEM owner
*/
sc_err_t sc_timer_set_rtc_time(sc_ipc_t ipc, uint16_t year, uint8_t mon,
uint8_t day, uint8_t hour, uint8_t min,
uint8_t sec);
/*!
* This function gets the RTC time.
*
* @param[in] ipc IPC handle
* @param[out] year pointer to return year (min 1970)
* @param[out] mon pointer to return month (1-12)
* @param[out] day pointer to return day of the month (1-31)
* @param[out] hour pointer to return hour (0-23)
* @param[out] min pointer to return minute (0-59)
* @param[out] sec pointer to return second (0-59)
*
* @return Returns an error code (SC_ERR_NONE = success).
*/
sc_err_t sc_timer_get_rtc_time(sc_ipc_t ipc, uint16_t *year, uint8_t *mon,
uint8_t *day, uint8_t *hour, uint8_t *min,
uint8_t *sec);
/*!
* This function gets the RTC time in seconds since 1/1/1970.
*
* @param[in] ipc IPC handle
* @param[out] sec pointer to return second
*
* @return Returns an error code (SC_ERR_NONE = success).
*/
sc_err_t sc_timer_get_rtc_sec1970(sc_ipc_t ipc, uint32_t *sec);
/*!
* This function sets the RTC alarm. Only the owner of the SC_R_SYSTEM
* resource can set the alarm.
*
* @param[in] ipc IPC handle
* @param[in] year year (min 1970)
* @param[in] mon month (1-12)
* @param[in] day day of the month (1-31)
* @param[in] hour hour (0-23)
* @param[in] min minute (0-59)
* @param[in] sec second (0-59)
*
* @return Returns an error code (SC_ERR_NONE = success).
*
* Return errors:
* - SC_ERR_PARM if invalid time/date parameters
*/
sc_err_t sc_timer_set_rtc_alarm(sc_ipc_t ipc, uint16_t year, uint8_t mon,
uint8_t day, uint8_t hour, uint8_t min,
uint8_t sec);
/* @} */
#endif /* _SC_TIMER_API_H */
/**@}*/
|
