watchdog.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef WATCHDOG_H
#define WATCHDOG_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
 
#define WATCHDOG_SETUP_TIME_MODE_0                                 0x00
#define WATCHDOG_SETUP_TIME_MODE_1                                 0x01
#define WATCHDOG_SETUP_TIME_MODE_DISABLE                           0x02
#define WATCHDOG_SETUP_TIME_MODE_2                                 0x03
 
 // watchdog_set
 
#define WATCHDOG_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.s0 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.s1 = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.wdi = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.wdo = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // watchdog_map
 // watchdog
 
typedef struct
{
    digital_out_t  s0;      
    digital_out_t  s1;      
    digital_out_t  wdi;     
    digital_in_t   wdo;     
} watchdog_t;
 
typedef struct
{
    pin_name_t  s0;     
    pin_name_t  s1;     
    pin_name_t  wdi;    
    pin_name_t  wdo;    
} watchdog_cfg_t;
 
typedef enum
{
   WATCHDOG_OK = 0,
   WATCHDOG_ERROR = -1
 
} watchdog_return_value_t;
 
void watchdog_cfg_setup ( watchdog_cfg_t *cfg );
 
err_t watchdog_init ( watchdog_t *ctx, watchdog_cfg_t *cfg );
 
err_t watchdog_default_cfg ( watchdog_t *ctx );
 
 
void watchdog_set_set0 ( watchdog_t *ctx, uint8_t set0_state );
 
void watchdog_set_set1 ( watchdog_t *ctx, uint8_t set1_state );
 
void watchdog_set_wdi ( watchdog_t *ctx, uint8_t wdi_state );
 
uint8_t watchdog_get_wdo ( watchdog_t *ctx );
 
void watchdog_send_pulse ( watchdog_t *ctx, uint16_t p_duration_ms );
 
void watchdog_setup_time ( watchdog_t *ctx, uint8_t setup_time_mode );
 
 
#ifdef __cplusplus
}
#endif
#endif // WATCHDOG_H
 
 // watchdog
 
// ------------------------------------------------------------------------ END