hal_wdt.h

/* Copyright Statement:
 *
 * (C) 2005-2016  MediaTek Inc. All rights reserved.
 *
 * This software/firmware and related documentation ("MediaTek Software") are
 * protected under relevant copyright laws. The information contained herein
 * is confidential and proprietary to MediaTek Inc. ("MediaTek") and/or its licensors.
 * Without the prior written permission of MediaTek and/or its licensors,
 * any reproduction, modification, use or disclosure of MediaTek Software,
 * and information contained herein, in whole or in part, shall be strictly prohibited.
 * You may only use, reproduce, modify, or distribute (as applicable) MediaTek Software
 * if you have agreed to and been bound by the applicable license agreement with
 * MediaTek ("License Agreement") and been granted explicit permission to do so within
 * the License Agreement ("Permitted User").  If you are not a Permitted User,
 * please cease any access or use of MediaTek Software immediately.
 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 * THAT MEDIATEK SOFTWARE RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES
 * ARE PROVIDED TO RECEIVER ON AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL
 * WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
 * NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
 * SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
 * SUPPLIED WITH MEDIATEK SOFTWARE, AND RECEIVER AGREES TO LOOK ONLY TO SUCH
 * THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. RECEIVER EXPRESSLY ACKNOWLEDGES
 * THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES
 * CONTAINED IN MEDIATEK SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK
 * SOFTWARE RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND
 * CUMULATIVE LIABILITY WITH RESPECT TO MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
 * AT MEDIATEK'S OPTION, TO REVISE OR REPLACE MEDIATEK SOFTWARE AT ISSUE,
 * OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY RECEIVER TO
 * MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
 */

#ifndef __HAL_WDT_H__
#define __HAL_WDT_H__
#include "hal_platform.h"

#ifdef HAL_WDT_MODULE_ENABLED

#ifdef __cplusplus
extern "C" {
#endif


#define HAL_WDT_ENABLE_MAGIC    (3405691582)


#define HAL_WDT_DISABLE_MAGIC   (3405643877)


#define HAL_WDT_FEED_MAGIC      (3735931646)

typedef enum {
    HAL_WDT_STATUS_INVALID_PARAMETER = -2,       
    HAL_WDT_STATUS_INVALID_MAGIC = -1,           
    HAL_WDT_STATUS_OK = 0                        
} hal_wdt_status_t;


typedef enum {
    HAL_WDT_TIMEOUT_RESET    = 0, 
    HAL_WDT_SOFTWARE_RESET   = 1, 
    HAL_WDT_NONE_RESET       = 2  
} hal_wdt_reset_status_t;


typedef enum {
    HAL_WDT_MODE_RESET = 0,        
    HAL_WDT_MODE_INTERRUPT = 1     
} hal_wdt_mode_t;


typedef struct {
    hal_wdt_mode_t  mode;       
    uint32_t        seconds;    
} hal_wdt_config_t;

typedef void (*hal_wdt_callback_t)(hal_wdt_reset_status_t wdt_reset_status);


hal_wdt_status_t hal_wdt_init(hal_wdt_config_t *wdt_config);


hal_wdt_status_t hal_wdt_deinit(void);


hal_wdt_status_t hal_wdt_enable(uint32_t magic);


hal_wdt_status_t hal_wdt_disable(uint32_t magic);


hal_wdt_status_t hal_wdt_software_reset(void);


hal_wdt_status_t hal_wdt_feed(uint32_t magic);


hal_wdt_callback_t hal_wdt_register_callback(hal_wdt_callback_t wdt_callback);


hal_wdt_reset_status_t hal_wdt_get_reset_status(void);


bool hal_wdt_get_enable_status(void);


hal_wdt_mode_t hal_wdt_get_mode(void);


#ifdef __cplusplus
}
#endif


#endif /*HAL_WDT_MODULE_ENABLED*/
#endif /* __HAL_WDT_H__ */