MCUSW
Wdg.h File Reference

Introduction

This file contains interface header for WDG MCAL driver.

Go to the source code of this file.

Data Structures

struct  Wdg_ModeInfoType
 Mode info type. More...
 
struct  Wdg_ConfigType
 WDG config structure. More...
 
struct  Wdg_ConfigType_PC
 WDG pre-compile config structure. More...
 
struct  Wdg_RegisterReadbackType
 

Macros

#define INIT_VAL_ZERO   (0U)
 For assigning use macro name instead of value 0U to avoid MISRAC violation. More...
 
WDG Driver Module SW Version Info

Defines for WDG Driver version used for compatibility checks

#define WDG_SW_MAJOR_VERSION   (3U)
 Driver Implementation Major Version. More...
 
#define WDG_SW_MINOR_VERSION   (0U)
 Driver Implementation Minor Version. More...
 
#define WDG_SW_PATCH_VERSION   (0U)
 Driver Implementation Patch Version. More...
 
WDG Driver Module AUTOSAR Version Info

Defines for WDG Driver AUTOSAR version used for compatibility checks

#define WDG_AR_RELEASE_MAJOR_VERSION   (4U)
 AUTOSAR Major version specification implemented by WDG Driver. More...
 
#define WDG_AR_RELEASE_MINOR_VERSION   (3U)
 AUTOSAR Minor version specification implemented by WDG Driver. More...
 
#define WDG_AR_RELEASE_REVISION_VERSION   (1U)
 AUTOSAR Patch version specification implemented by WDG Driver. More...
 
WDG Driver ID Info
#define WDG_VENDOR_ID   ((uint16) 44U)
 Texas Instruments Vendor ID. More...
 
#define WDG_MODULE_ID   ((uint16) 102U)
 WDG Driver Module ID. More...
 
#define WDG_INSTANCE_ID   ((uint8) 0U)
 WDG Driver Instance ID. More...
 
WDG Error Codes

Error codes returned by Driver functions

#define WDG_E_DRIVER_STATE   ((uint8) 0x10U)
 ERROR:Invalid driver state. More...
 
#define WDG_E_PARAM_MODE   ((uint8) 0x11U)
 ERROR:Invalid mode param. More...
 
#define WDG_E_PARAM_CONFIG   ((uint8) 0x12U)
 ERROR:Invalid config param. More...
 
#define WDG_E_PARAM_TIMEOUT   ((uint8) 0x13U)
 ERROR:Invalid timeout value. More...
 
#define WDG_E_PARAM_POINTER   ((uint8) 0x14U)
 ERROR:Invalid NULL ptr param. More...
 
#define WDG_E_INIT_FAILED   ((uint8) 0x15U)
 ERROR:Invalid configuration set selection. More...
 
WDG Service Ids

The Service Id is one of the argument to Det_ReportError function and is used to identify the source of the error

#define WDG_API_INIT   ((uint8) 0x00U)
 Wdg_Init() More...
 
#define WDG_API_SET_MODE   ((uint8) 0x01U)
 Wdg_SetMode() More...
 
#define WDG_SET_TRIGGER_CONDITION   ((uint8) 0x03U)
 Wdg_SetTriggerCondition() More...
 
#define WDG_API_GET_VERSION_INFO   ((uint8) 0x04U)
 Wdg_GetVersionInfo() More...
 
#define WDG_API_TRIGGER   ((uint8) 0x05U)
 Wdg_Trigger() More...
 
#define WDG_API_REGISTER_READBACK   ((uint8) 0x06U)
 Wdg_RegisterReadback() More...
 
Watchdog Window Size

Windowed watchdog trigger window size define

#define WDG_WINDOW_100_PERCENT   ((uint32) 0x00000005U)
 Window open 100% of interval. More...
 
#define WDG_WINDOW_50_PERCENT   ((uint32) 0x00000050U)
 Window open 50% of interval. More...
 
#define WDG_WINDOW_25_PERCENT   ((uint32) 0x00000500U)
 Window open 25% of interval. More...
 
#define WDG_WINDOW_12P5_PERCENT   ((uint32) 0x00005000U)
 Window open 12.5% of interval. More...
 
#define WDG_WINDOW_6P25_PERCENT   ((uint32) 0x00050000U)
 Window open 6.25% of interval. More...
 
#define WDG_WINDOW_3P125_PERCENT   ((uint32) 0x00500000U)
 Window open 3.125% of interval. More...
 

Enumerations

enum  Wdg_StatusType { WDG_UNINIT, WDG_IDLE, WDG_BUSY }
 Watchdog driver state. More...
 

Functions

void Wdg_GetVersionInfo (Std_VersionInfoType *versioninfo)
 This service returns the version information of this module. More...
 
void Wdg_Init (const Wdg_ConfigType *CfgPtr)
 This service initializes the WDG driver. More...
 
void Wdg_SetTriggerCondition (uint16 timeout)
 Sets the timeout value for the trigger counter. More...
 
void Wdg_Trigger (void)
 This function triggers the servicing of the watchdog. More...
 
Std_ReturnType Wdg_SetMode (WdgIf_ModeType Mode)
 This function triggers the servicing of the watchdog. More...
 
Std_ReturnType Wdg_RegisterReadback (Wdg_RegisterReadbackType *regRbPtr)
 This function reads the important registers of the hardware unit and returns the value in the structure. More...