include/aul_watchdog.h

   1 /*
   2  * Copyright (c) 2018 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __AUL_WATCHDOG_H__
  18 #define __AUL_WATCHDOG_H__
  19
  20 #ifdef __cplusplus
  21 extern "C" {
  22 #endif
  23
  24 /**
  25  * @brief Enables watchdog timer.
  26  *
  27  * @return      @c 0 on success,
  28  *              otherwise a negative error value
  29  *
  30  * @remarks This function is only for App Framework internally.
  31  */
  32 int aul_watchdog_enable(void);
  33
  34 /**
  35  * @brief Disables watchdog timer.
  36  *
  37  * @return      @c 0 on success,
  38  *              otherwise a negative error value
  39  *
  40  * @remarks This function is only for App Framework internally.
  41  */
  42 int aul_watchdog_disable(void);
  43
  44 /**
  45  * @brief Kicks whatchdog timer.
  46  *
  47  * @return      @c 0 on success,
  48  *              otherwise a negative error value
  49  *
  50  * @remarks This function is only for App Framework internally.
  51  */
  52 int aul_watchdog_kick(void);
  53
  54 /**
  55  * @brief Starts watchdog timer.
  56  *
  57  * @param[in]   interval        The interval of the timer
  58  * @return      @c 0 on success,
  59  *              otherwise a negative error value
  60  *
  61  * @remarks This function is only for App Framework internally.
  62  */
  63 void aul_watchdog_start(unsigned int interval);
  64
  65 /**
  66  * @brief Stops watchdog timer.
  67  *
  68  * @return      @c 0 on success,
  69  *              otherwise a negative error value
  70  *
  71  * @remarks This function is only for App Framework internally.
  72  */
  73 void aul_watchdog_stop(void);
  74
  75 #ifdef __cplusplus
  76 }
  77 #endif
  78
  79 #endif /* __AUL_WATCHDOG_H__ */