2015-10-03 01:48:24 +02:00
|
|
|
/****************************************************************************
|
2014-08-08 22:21:48 +02:00
|
|
|
* sched/wdog/wdog.h
|
2007-02-18 00:21:28 +01:00
|
|
|
*
|
2020-03-11 20:51:28 +01:00
|
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
* contributor license agreements. See the NOTICE file distributed with
|
|
|
|
* this work for additional information regarding copyright ownership. The
|
|
|
|
* ASF licenses this file to you under the Apache License, Version 2.0 (the
|
|
|
|
* "License"); you may not use this file except in compliance with the
|
|
|
|
* License. You may obtain a copy of the License at
|
2007-02-18 00:21:28 +01:00
|
|
|
*
|
2020-03-11 20:51:28 +01:00
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
2007-02-18 00:21:28 +01:00
|
|
|
*
|
2020-03-11 20:51:28 +01:00
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
|
|
* License for the specific language governing permissions and limitations
|
|
|
|
* under the License.
|
2007-02-18 00:21:28 +01:00
|
|
|
*
|
2015-10-03 01:48:24 +02:00
|
|
|
****************************************************************************/
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2014-08-08 22:21:48 +02:00
|
|
|
#ifndef __SCHED_WDOG_WDOG_H
|
|
|
|
#define __SCHED_WDOG_WDOG_H
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2015-10-03 01:48:24 +02:00
|
|
|
/****************************************************************************
|
2007-02-18 00:21:28 +01:00
|
|
|
* Included Files
|
2015-10-03 01:48:24 +02:00
|
|
|
****************************************************************************/
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2007-02-21 22:55:16 +01:00
|
|
|
#include <nuttx/config.h>
|
2009-12-14 19:39:29 +01:00
|
|
|
|
2009-12-14 20:30:18 +01:00
|
|
|
#include <stdint.h>
|
2009-12-14 22:15:18 +01:00
|
|
|
#include <stdbool.h>
|
2012-07-14 21:30:31 +02:00
|
|
|
|
2007-02-18 00:21:28 +01:00
|
|
|
#include <nuttx/compiler.h>
|
2018-11-09 16:26:34 +01:00
|
|
|
#include <nuttx/clock.h>
|
2014-08-21 19:16:55 +02:00
|
|
|
#include <nuttx/wdog.h>
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2018-11-09 16:26:34 +01:00
|
|
|
/****************************************************************************
|
|
|
|
* Pre-processor Definitions
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Name: wd_elapse
|
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* This function is used to get time-elapse from last time wd_timer() be
|
|
|
|
* called. In case of CONFIG_SCHED_TICKLESS configured, wd_timer() may
|
|
|
|
* take lots of ticks, during this time, wd_start()/wd_cancel() may
|
|
|
|
* called, so we need wd_elapse() to correct the delay/lag.
|
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#ifdef CONFIG_SCHED_TICKLESS
|
|
|
|
# define wd_elapse() (clock_systimer() - g_wdtickbase)
|
|
|
|
#else
|
|
|
|
# define wd_elapse() (0)
|
|
|
|
#endif
|
|
|
|
|
2015-10-03 01:48:24 +02:00
|
|
|
/****************************************************************************
|
2015-10-03 00:30:35 +02:00
|
|
|
* Public Data
|
2015-10-03 01:48:24 +02:00
|
|
|
****************************************************************************/
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2014-08-07 19:39:16 +02:00
|
|
|
#ifdef __cplusplus
|
|
|
|
#define EXTERN extern "C"
|
|
|
|
extern "C"
|
|
|
|
{
|
|
|
|
#else
|
|
|
|
#define EXTERN extern
|
|
|
|
#endif
|
|
|
|
|
2012-07-14 21:30:31 +02:00
|
|
|
/* The g_wdfreelist data structure is a singly linked list of watchdogs
|
|
|
|
* available to the system for delayed function use.
|
2007-02-18 00:21:28 +01:00
|
|
|
*/
|
|
|
|
|
|
|
|
extern sq_queue_t g_wdfreelist;
|
|
|
|
|
2012-07-14 21:30:31 +02:00
|
|
|
/* The g_wdactivelist data structure is a singly linked list ordered by
|
|
|
|
* watchdog expiration time. When watchdog timers expire,the functions on
|
|
|
|
* this linked list are removed and the function is called.
|
2007-02-18 00:21:28 +01:00
|
|
|
*/
|
|
|
|
|
|
|
|
extern sq_queue_t g_wdactivelist;
|
|
|
|
|
2014-08-21 16:44:29 +02:00
|
|
|
/* This is the number of free, pre-allocated watchdog structures in the
|
|
|
|
* g_wdfreelist. This value is used to enforce a reserve for interrupt
|
|
|
|
* handlers.
|
|
|
|
*/
|
|
|
|
|
|
|
|
extern uint16_t g_wdnfree;
|
|
|
|
|
2018-11-09 16:26:34 +01:00
|
|
|
/* This is wdog tickbase, for wd_gettime() may called many times
|
|
|
|
* between 2 times of wd_timer(), we use it to update wd_gettime().
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifdef CONFIG_SCHED_TICKLESS
|
|
|
|
extern clock_t g_wdtickbase;
|
|
|
|
#endif
|
|
|
|
|
2015-10-03 01:48:24 +02:00
|
|
|
/****************************************************************************
|
2007-02-18 00:21:28 +01:00
|
|
|
* Public Function Prototypes
|
2015-10-03 01:48:24 +02:00
|
|
|
****************************************************************************/
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2015-10-03 01:48:24 +02:00
|
|
|
/****************************************************************************
|
2014-08-07 19:39:16 +02:00
|
|
|
* Name: wd_initialize
|
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* This function initializes the watchdog data structures
|
|
|
|
*
|
2018-03-13 16:52:27 +01:00
|
|
|
* Input Parameters:
|
2014-08-07 19:39:16 +02:00
|
|
|
* None
|
|
|
|
*
|
2018-02-01 17:00:02 +01:00
|
|
|
* Returned Value:
|
2014-08-07 19:39:16 +02:00
|
|
|
* None
|
|
|
|
*
|
|
|
|
* Assumptions:
|
|
|
|
* This function must be called early in the initialization sequence
|
|
|
|
* before the timer interrupt is attached and before any watchdog
|
|
|
|
* services are used.
|
|
|
|
*
|
2015-10-03 01:48:24 +02:00
|
|
|
****************************************************************************/
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2014-04-25 20:38:56 +02:00
|
|
|
void weak_function wd_initialize(void);
|
2014-08-07 19:39:16 +02:00
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Name: wd_timer
|
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* This function is called from the timer interrupt handler to determine
|
|
|
|
* if it is time to execute a watchdog function. If so, the watchdog
|
|
|
|
* function will be executed in the context of the timer interrupt
|
|
|
|
* handler.
|
|
|
|
*
|
2018-03-13 16:52:27 +01:00
|
|
|
* Input Parameters:
|
2014-08-07 19:39:16 +02:00
|
|
|
* ticks - If CONFIG_SCHED_TICKLESS is defined then the number of ticks
|
2017-05-11 21:35:56 +02:00
|
|
|
* in the interval that just expired is provided. Otherwise,
|
2014-08-07 19:39:16 +02:00
|
|
|
* this function is called on each timer interrupt and a value of one
|
|
|
|
* is implicit.
|
|
|
|
*
|
2018-02-01 17:00:02 +01:00
|
|
|
* Returned Value:
|
2014-08-07 19:39:16 +02:00
|
|
|
* If CONFIG_SCHED_TICKLESS is defined then the number of ticks for the
|
|
|
|
* next delay is provided (zero if no delay). Otherwise, this function
|
|
|
|
* has no returned value.
|
|
|
|
*
|
|
|
|
* Assumptions:
|
|
|
|
* Called from interrupt handler logic with interrupts disabled.
|
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#ifdef CONFIG_SCHED_TICKLESS
|
|
|
|
unsigned int wd_timer(int ticks);
|
|
|
|
#else
|
|
|
|
void wd_timer(void);
|
|
|
|
#endif
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2014-12-13 19:02:25 +01:00
|
|
|
/****************************************************************************
|
|
|
|
* Name: wd_recover
|
|
|
|
*
|
|
|
|
* Description:
|
This commit renames all internal OS functions defined under sched/task so that they begin with the prefix. For example, nxtask_exit() vs. task_exit().
Squashed commit of the following:
Trivial, cosmetic
sched/, arch/, and include: Rename task_vforkstart() as nxtask_vforkstart()
sched/, arch/, and include: Rename task_vforkabort() as nxtask_vforkabort()
sched/, arch/, and include: Rename task_vforksetup() as nxtask_vfork_setup()
sched/: Rename notify_cancellation() as nxnotify_cancellation()
sched/: Rename task_recover() to nxtask_recover()
sched/task, sched/pthread/, Documentation/: Rename task_argsetup() and task_terminate() to nxtask_argsetup() and nxtask_terminate(), respectively.
sched/task: Rename task_schedsetup() to nxtask_schedsetup()
sched/ (plus some binfmt/, include/, and arch/): Rename task_start() and task_starthook() to nxtask_start() and nxtask_starthook().
arch/ and sched/: Rename task_exit() and task_exithook() to nxtask_exit() and nxtask_exithook(), respectively.
sched/task: Rename all internal, static, functions to begin with the nx prefix.
2019-02-04 20:42:51 +01:00
|
|
|
* This function is called from nxtask_recover() when a task is deleted via
|
2014-12-13 19:02:25 +01:00
|
|
|
* task_delete() or via pthread_cancel(). It checks if the deleted task
|
|
|
|
* is waiting for a timed event and if so cancels the timeout
|
|
|
|
*
|
2018-02-01 17:00:02 +01:00
|
|
|
* Input Parameters:
|
2014-12-13 19:02:25 +01:00
|
|
|
* tcb - The TCB of the terminated task or thread
|
|
|
|
*
|
2018-02-01 17:00:02 +01:00
|
|
|
* Returned Value:
|
2014-12-13 19:02:25 +01:00
|
|
|
* None.
|
|
|
|
*
|
|
|
|
* Assumptions:
|
|
|
|
* This function is called from task deletion logic in a safe context.
|
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
struct tcb_s;
|
|
|
|
void wd_recover(FAR struct tcb_s *tcb);
|
|
|
|
|
2007-02-18 00:21:28 +01:00
|
|
|
#undef EXTERN
|
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2014-08-08 22:21:48 +02:00
|
|
|
#endif /* __SCHED_WDOG_WDOG_H */
|