watchdog_rti.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2021 Texas Instruments Incorporated
 *
 *  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 Texas Instruments Incorporated 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
 *  OWNER 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.
 */
 
#ifndef WATCHDOG_RTI_H_
#define WATCHDOG_RTI_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <string.h>
#include <stdbool.h>
#include <drivers/hw_include/cslr_watchdog.h>
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define WATCHDOG_CLEAR_STATUS                   (0xFFU)
 
/* ========================================================================== */
/*                            Structures                                      */
/* ========================================================================== */
 
typedef struct Watchdog_HwAttrs_s
{
     uint8_t            instance;
    uintptr_t           baseAddr; 
 
    uint32_t            wdtClkFrequency;
} Watchdog_HwAttrs;
 
typedef enum Watchdog_DebugMode_e {
    Watchdog_DEBUG_STALL_ON = 0, 
    Watchdog_DEBUG_STALL_OFF = 1 
} Watchdog_DebugMode;
 
typedef enum Watchdog_ResetMode_e {
    Watchdog_RESET_OFF  = 0xAU, 
    Watchdog_RESET_ON   = 0x5U   
} Watchdog_ResetMode;
 
typedef enum Watchdog_WindowSize_e {
    Watchdog_WINDOW_100_PERCENT     = CSL_RTI_RTIWWDSIZECTRL_WWDSIZE_100_PERCENT, 
    Watchdog_WINDOW_50_PERCENT      = CSL_RTI_RTIWWDSIZECTRL_WWDSIZE_50_PERCENT, 
    Watchdog_WINDOW_25_PERCENT      = CSL_RTI_RTIWWDSIZECTRL_WWDSIZE_25_PERCENT, 
    Watchdog_WINDOW_12_5_PERCENT    = CSL_RTI_RTIWWDSIZECTRL_WWDSIZE_12_5_PERCENT, 
    Watchdog_WINDOW_6_25_PERCENT    = CSL_RTI_RTIWWDSIZECTRL_WWDSIZE_6_25_PERCENT, 
    Watchdog_WINDOW_3_125_PERCENT   = CSL_RTI_RTIWWDSIZECTRL_WWDSIZE_3_125_PERCENT  
} Watchdog_WindowSize;
 
typedef struct Watchdog_Config_s *Watchdog_Handle;
 
typedef void (*Watchdog_Callback)(Watchdog_Handle handle, void *callbackFxnArgs);
 
typedef struct Watchdog_Params_t {
    Watchdog_Callback       callbackFxn;        
    void                    *callbackFxnArgs;   
    Watchdog_ResetMode      resetMode;          
    Watchdog_DebugMode      debugStallMode;     
    Watchdog_WindowSize     windowSize;         
    uint32_t                expirationTime;     
} Watchdog_Params;
 
typedef struct Watchdog_Config_s {
 
    void                    *object;
 
    void              const *hwAttrs;
 
} Watchdog_Config;
 
typedef enum Watchdog_DriverState_e
{
    Watchdog_DriverState_UNINIT = 0,
 
    Watchdog_DriverState_OPERATIONAL = 1
}Watchdog_DriverState;
 
typedef struct Watchdog_MCB_t
{
    Watchdog_DriverState         state;
 
    Watchdog_Params              params;
 
    uint32_t                    interruptsRxed;
 
    uint32_t                    watchdogCleared;
} Watchdog_MCB;
 
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void Watchdog_setReaction(Watchdog_Handle handle, uint32_t dwwdReaction);
 
uint32_t Watchdog_getWindowSize(Watchdog_Handle handle);
 
void Watchdog_setWindowSize(Watchdog_Handle handle, uint32_t dwwdWindowSize);
 
bool Watchdog_isClosedWindow(Watchdog_Handle handle);
 
void Watchdog_clear(Watchdog_Handle handle);
 
 
void Watchdog_close(Watchdog_Handle handle);
 
void Watchdog_init(void);
 
void Watchdog_deinit(void);
 
Watchdog_Handle Watchdog_open(uint8_t index, Watchdog_Params *params);
 
void Watchdog_paramsInit(Watchdog_Params *params);
 
#ifdef __cplusplus
}
#endif
 
#endif /* WATCHDOG_RTI_H_ */