Wdg.h

Go to the documentation of this file.

/*
*
* Copyright (c) 2019 Texas Instruments Incorporated
*
* All rights reserved not granted herein.
*
* Limited License.
*
* Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
* license under copyrights and patents it now or hereafter owns or controls to make,
* have made, use, import, offer to sell and sell ("Utilize") this software subject to the
* terms herein.  With respect to the foregoing patent license, such license is granted
* solely to the extent that any such patent is necessary to Utilize the software alone.
* The patent license shall not apply to any combinations which include this software,
* other than combinations with devices manufactured by or for TI ("TI Devices").
* No hardware patent is licensed hereunder.
*
* Redistributions must preserve existing copyright notices and reproduce this license
* (including the above copyright notice and the disclaimer and (if applicable) source
* code license limitations below) in the documentation and/or other materials provided
* with the distribution
*
* Redistribution and use in binary form, without modification, are permitted provided
* that the following conditions are met:
*
* *       No reverse engineering, decompilation, or disassembly of this software is
* permitted with respect to any software provided in binary form.
*
* *       any redistribution and use are licensed by TI for use only with TI Devices.
*
* *       Nothing shall obligate TI to provide you with source code for the software
* licensed and provided to you in object code.
*
* If software source code is provided to you, modification and redistribution of the
* source code are permitted provided that the following conditions are met:
*
* *       any redistribution and use of the source code, including any resulting derivative
* works, are licensed by TI for use only with TI Devices.
*
* *       any redistribution and use of any object code compiled from the source code
* and any resulting derivative works, are licensed by TI for use only with TI Devices.
*
* Neither the name of Texas Instruments Incorporated nor the names of its suppliers
*
* may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* DISCLAIMER.
*
* THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "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 TI AND TI'S LICENSORS 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.
*
*/

/*
 * Below are the global design requirements which are met by this WDG
 * which can't be mapped to a particular source ID
 */
/*
 * Design: MCAL-5599,MCAL-5558,MCAL-5603,MCAL-5559,MCAL-5560,MCAL-5568,MCAL-5564,MCAL-5547
 */

#ifndef WDG_H_
#define WDG_H_

/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */

/*
 * Design: MCAL-5557
 */
#include "WdgIf_Types.h"
/*
 * Design: MCAL-5573
 */
#include "Wdg_Cfg.h"
#ifdef __cplusplus
extern "C"
{
#endif

/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */

#define WDG_SW_MAJOR_VERSION            (2U)

#define WDG_SW_MINOR_VERSION            (0U)

#define WDG_SW_PATCH_VERSION            (0U)
/* @} */

#define WDG_AR_RELEASE_MAJOR_VERSION    (4U)

#define WDG_AR_RELEASE_MINOR_VERSION    (3U)

#define WDG_AR_RELEASE_REVISION_VERSION (1U)
/* @} */

#define WDG_VENDOR_ID                   ((uint16) 44U)

#define WDG_MODULE_ID                   ((uint16) 102U)

#define WDG_INSTANCE_ID                 ((uint8) 0U)
/* @} */

/*
 * Design: MCAL-5591
 */
#define WDG_E_DRIVER_STATE              ((uint8) 0x10U)

#define WDG_E_PARAM_MODE                ((uint8) 0x11U)

#define WDG_E_PARAM_CONFIG              ((uint8) 0x12U)

#define WDG_E_PARAM_TIMEOUT             ((uint8) 0x13U)

#define WDG_E_PARAM_POINTER             ((uint8) 0x14U)

#define WDG_E_INIT_FAILED               ((uint8) 0x15U)
/* @} */

/*
 * Design: MCAL-5604
 */
#define WDG_API_INIT                   ((uint8) 0x00U)

#define WDG_API_SET_MODE               ((uint8) 0x01U)

#define WDG_SET_TRIGGER_CONDITION      ((uint8) 0x03U)

#define WDG_API_GET_VERSION_INFO       ((uint8) 0x04U)

#define WDG_API_TRIGGER                ((uint8) 0x05U)

#define WDG_API_REGISTER_READBACK      ((uint8) 0x06U)
/* @} */

#define WDG_WINDOW_100_PERCENT              ((uint32) 0x00000005U)

#define WDG_WINDOW_50_PERCENT               ((uint32) 0x00000050U)

#define WDG_WINDOW_25_PERCENT               ((uint32) 0x00000500U)

#define WDG_WINDOW_12P5_PERCENT             ((uint32) 0x00005000U)

#define WDG_WINDOW_6P25_PERCENT             ((uint32) 0x00050000U)

#define WDG_WINDOW_3P125_PERCENT             ((uint32) 0x00500000U)
/* @} */

#define INIT_VAL_ZERO                   (0U)

/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
typedef enum
{
    WDG_UNINIT,
    WDG_IDLE,
    WDG_BUSY
} Wdg_StatusType;

typedef struct
{
    uint32 reaction;
    uint32 windowSize;
    uint32 timeOutVal;
} Wdg_ModeInfoType;

/*
 * Design: MCAL-5587
 */
typedef struct Wdg_ConfigType_s
{
    WdgIf_ModeType   defaultMode;
    Wdg_ModeInfoType fastModeCfg;
    Wdg_ModeInfoType slowModeCfg;
} Wdg_ConfigType;

/*
 * Design: MCAL-5609,MCAL-5556
 */
typedef struct Wdg_ConfigType_PC_s
{
    uint16           instanceId;
    uint32           initialTimeOut;
} Wdg_ConfigType_PC;

#if (STD_ON == WDG_REGISTER_READBACK_API)
typedef struct
{
   uint32 rtiDwdCtrl;
   uint32 rtiDwdprld;
   uint32 rtiWdStatus;
   uint32 rtiWdKey;
   uint32 rtiWwdRxnCtrl;
   uint32 rtiWwdSizeCtrl;
}Wdg_RegisterReadbackType;
#endif /* STD_ON == WDG_REGISTER_READBACK_API */

/* @} */

/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */

#if (STD_ON == WDG_GET_VERSION_INFO_API)

FUNC(void, WDG_CODE) Wdg_GetVersionInfo(Std_VersionInfoType * versioninfo);
#endif

FUNC(void, WDG_CODE) Wdg_Init(
    P2CONST(Wdg_ConfigType, AUTOMATIC, WDG_APPL_CONST) CfgPtr);
FUNC(void, WDG_CODE) Wdg_SetTriggerCondition(uint16 timeout);
FUNC(void, WDG_CODE) Wdg_Trigger(void);
FUNC(Std_ReturnType, WDG_CODE) Wdg_SetMode(WdgIf_ModeType Mode);
#if (STD_ON == WDG_REGISTER_READBACK_API)

FUNC(Std_ReturnType, WDG_CODE) Wdg_RegisterReadback
                            (P2VAR(Wdg_RegisterReadbackType, AUTOMATIC,
                                                WDG_APPL_DATA) regRbPtr);
#endif
#ifdef __cplusplus
}
#endif

#endif  /* #ifndef WDG_H_ */

/* @} */