Gpt.h

Go to the documentation of this file.

/*
*
* Copyright (c) 2023 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.
*
*/

#ifndef GPT_H_
#define GPT_H_

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

#include "Std_Types.h"
#include "Gpt_Cfg.h"
#if (GPT_WAKEUP_FUNCTIONALITY_API == STD_ON)
    /* included for Wakeup handling */
    #include "EcuM_Cbk.h"
#endif

#ifdef __cplusplus
extern "C"
{
#endif

/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
/*
 * Design : MCAL-6324
 */
#define GPT_SW_MAJOR_VERSION            (9U)

#define GPT_SW_MINOR_VERSION            (0U)

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

#define GPT_AR_RELEASE_MAJOR_VERSION    (4U)

#define GPT_AR_RELEASE_MINOR_VERSION    (3U)

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

#define GPT_VENDOR_ID                   ((uint16) 44U)

#define GPT_MODULE_ID                   ((uint16) 100U)

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

/*
 * GPT channel notification/wakeup function index.
 * This is used store function index into ISR array.
 */
#define GPT_CH_ISR_MODE_CONTINUOUS     (0U)

#define GPT_CH_ISR_MODE_ONESHOT        (1U)

#define GPT_CH_ISR_MODE_CONT_WAKEUP    (2U)

#define GPT_CH_ISR_MODE_ONESHOT_WAKEUP (3U)

/*
 * Design : MCAL-6255,MCAL-6197,MCAL-6193
 */

#ifndef GPT_E_UNINIT

#define GPT_E_UNINIT                (0x0AU)
#endif

/*
 * Design : MCAL-6318
 */
#ifndef GPT_E_BUSY

#define GPT_E_BUSY                  (0x0BU)
#endif

/*
 * Design : MCAL-2514
 */
#ifndef GPT_E_MODE

#define GPT_E_MODE                  (0x0CU)
#endif

/*
 * Design : MCAL-6255
 */
#ifndef GPT_E_ALREADY_INITIALIZED

#define GPT_E_ALREADY_INITIALIZED   (0x0DU)
#endif

/*
 * Design : MCAL-6243
 */
#ifndef GPT_E_INIT_FAILED

#define GPT_E_INIT_FAILED           (0x0EU)
#endif

/*
 * Design : MCAL-6232
 */
#ifndef GPT_E_PARAM_CHANNEL

#define GPT_E_PARAM_CHANNEL         (0x14U)
#endif

/*
 * Design : MCAL-6285
 */
#ifndef GPT_E_PARAM_VALUE

#define GPT_E_PARAM_VALUE           (0x15U)
#endif

/*
 * Design : MCAL-6313
 */
#ifndef GPT_E_PARAM_POINTER

#define GPT_E_PARAM_POINTER         (0x16U)
#endif
#ifndef GPT_E_PARAM_PREDEF_TIMER

#define GPT_E_PARAM_PREDEF_TIMER    (0x17U)
#endif

/*
 * Design : MCAL-6258
 */
#ifndef GPT_E_PARAM_MODE

#define GPT_E_PARAM_MODE            (0x1FU)
#endif
#ifndef GPT_E_INVALID_ISR

#define GPT_E_INVALID_ISR           (0x80U)
#endif
/* @} */

#define GPT_SID_GET_VERSION_INFO    (0x00U)

#define GPT_SID_INIT                (0x01U)

#define GPT_SID_DEINIT              (0x02U)

#define GPT_SID_GET_TIME_ELAPSED    (0x03U)

#define GPT_SID_GET_TIME_REMAINING  (0x04U)

#define GPT_SID_START_TIMER         (0x05U)

#define GPT_SID_STOP_TIMER          (0x06U)

#define GPT_SID_ENABLE_NOTIFY       (0x07U)

#define GPT_SID_DISABLE_NOTIFY      (0x08U)

#define GPT_SID_SET_MODE            (0x09U)

#define GPT_SID_DISABLE_WAKEUP      (0x0AU)

#define GPT_SID_ENABLE_WAKEUP       (0x0BU)

#define GPT_SID_CHECK_WAKEUP        (0x0CU)

#define GPT_SID_GET_PREDEFTIMERVALUE    (0x0DU)

#define GPT_SID_GET_GETHWUNITOBJ        (0x0EU)

#define GPT_SID_REGISTER_READBACK       (0x0FU)
/* @} */

/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */

/*
 * Design : MCAL-6368
 */
typedef uint32 Gpt_ChannelType;


/*
 * Design : MCAL-6282
 */
typedef uint32 Gpt_ValueType;


/*
 * Design : MCAL-6349
 */
typedef enum
{
    GPT_MODE_NORMAL = 0U,
    GPT_MODE_SLEEP = 1U,
    GPT_MODE_INVALID = 0xFFU
} Gpt_ModeType;


typedef enum
{
   GPT_PREDEF_TIMER_1US_16BIT = 0U,
   GPT_PREDEF_TIMER_1US_24BIT = 1U,
   GPT_PREDEF_TIMER_1US_32BIT = 2U,
   GPT_PREDEF_TIMER_100US_32BIT = 3U
} Gpt_PredefTimerType;


typedef enum
{
    GPT_PRESCALER_CLK_DIV_BY_2 = 0x0U,
    GPT_PRESCALER_CLK_DIV_BY_4 = 0x1U,
    GPT_PRESCALER_CLK_DIV_BY_8 = 0x2U,
    GPT_PRESCALER_CLK_DIV_BY_16 = 0x3U,
    GPT_PRESCALER_CLK_DIV_BY_32 = 0x4U,
    GPT_PRESCALER_CLK_DIV_BY_64 = 0x5U,
    GPT_PRESCALER_CLK_DIV_BY_128 = 0x6U,
    GPT_PRESCALER_CLK_DIV_BY_256 = 0x7U,
    GPT_PRESCALER_NO_PRESCALE = 0xFFU,
} Gpt_PrescaleValueType;


/*
 * Design : MCAL-6221
 */
typedef void (*Gpt_NotifyType)(void);

typedef enum
{
    GPT_CH_MODE_CONTINUOUS = 0U,
    GPT_CH_MODE_ONESHOT
} Gpt_ChannelMode;

typedef enum
{
    GPT_UNINITIALIZED = 0U,
    GPT_INITIALIZED,
    GPT_RUNNING,
    GPT_STOPPED,
    GPT_EXPIRED
} Gpt_ChannelStateType;


/*
 * Design : MCAL-6362,MCAL-6332,MCAL-6334
 */
typedef struct
{
    Gpt_ChannelMode         channelMode;
    uint32                  tickValueMax;
    uint8                   enableWakeupFlag;
    Gpt_NotifyType          fnPtrNotifyFunction;
#if (STD_ON == GPT_REPORT_WAKEUP_SOURCE) && (STD_ON == \
                                                 GPT_WAKEUP_FUNCTIONALITY_API)
    EcuM_WakeupSourceType   wakeupSourceRef;
#endif
    uint32                  prescale;
} Gpt_ChannelConfigType;

typedef struct Gpt_ChannelConfigType_PC_s
{
    Gpt_ChannelType         channelId;
} Gpt_ChannelConfigType_PC;


/*
 * Design : MCAL-6344
 */
typedef struct Gpt_ConfigType_s
{
    P2CONST(Gpt_ChannelConfigType, AUTOMATIC, GPT_CONST) ChannelCfgPtr;
    uint32 channelCount;
} Gpt_ConfigType;

#if (STD_ON == GPT_REGISTER_READBACK_API)

typedef struct
{
    /*
     * GPT related registers
     */
    uint32 gptRev;
    uint32 gptTtgr;
    uint32 gptTimerSynCtrl;
    uint32 gptTiocpCfg;
    uint32 gptTclr;
} Gpt_RegisterReadbackType;

#endif  /* #if (STD_ON == GPT_REGISTER_READBACK_API) */

/* @} */

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

#if (STD_ON == GPT_VERSION_INFO_API)

FUNC(void,
     GPT_CODE) Gpt_GetVersionInfo(P2VAR(Std_VersionInfoType, AUTOMATIC,
                                        GPT_APPL_DATA) VersionInfoPtr);
#endif /*(STD_ON == GPT_VERSION_INFO_API)*/

FUNC(void, GPT_CODE) Gpt_Init(P2CONST(Gpt_ConfigType, AUTOMATIC,
                                      GPT_CONST) CfgPtr);

#if (STD_ON == GPT_DEINIT_API)

FUNC(void, GPT_CODE) Gpt_DeInit(void);
#endif /*(STD_ON == GPT_DEINIT_API)*/

#if (STD_ON == GPT_TIME_ELAPSED_API)

FUNC(Gpt_ValueType, GPT_CODE) Gpt_GetTimeElapsed(Gpt_ChannelType Channel);
#endif /*(STD_ON == GPT_TIME_ELAPSED_API)*/

#if (STD_ON == GPT_TIME_REMAINING_API)

FUNC(Gpt_ValueType, GPT_CODE) Gpt_GetTimeRemaining(Gpt_ChannelType Channel);
#endif /*(STD_ON == GPT_CFG_TIME_REMAINING_API)*/

FUNC(void, GPT_CODE) Gpt_StartTimer(Gpt_ChannelType Channel,
                                    Gpt_ValueType Value);

FUNC(void, GPT_CODE) Gpt_StopTimer(Gpt_ChannelType Channel);

#if (STD_ON == GPT_ENABLE_DISABLE_NOTIFICATION_API)

FUNC(void, GPT_CODE) Gpt_EnableNotification(Gpt_ChannelType Channel);
#endif /*(STD_ON == GPT_ENABLE_DISABLE_NOTIFICATION_API)*/

#if (STD_ON == GPT_ENABLE_DISABLE_NOTIFICATION_API)

FUNC(void, GPT_CODE) Gpt_DisableNotification(Gpt_ChannelType Channel);
#endif /*(STD_ON == GPT_ENABLE_DISABLE_NOTIFICATION_API)*/

#if (STD_ON == GPT_REPORT_WAKEUP_SOURCE) && (STD_ON == \
                                                 GPT_WAKEUP_FUNCTIONALITY_API)

FUNC(void, GPT_CODE) Gpt_SetMode(Gpt_ModeType Mode);
#endif /*(STD_ON == GPT_WAKEUP_FUNCTIONALITY_API)*/

/*
 * Design : MCAL-6242
 */

#if (STD_ON == GPT_REPORT_WAKEUP_SOURCE) && (STD_ON == \
                                                 GPT_WAKEUP_FUNCTIONALITY_API)

FUNC(void, GPT_CODE) Gpt_DisableWakeup(Gpt_ChannelType Channel);
#endif /*(STD_ON == GPT_WAKEUP_FUNCTIONALITY_API)*/

/*
 * Design : MCAL-6242
 */

#if (STD_ON == GPT_REPORT_WAKEUP_SOURCE) && (STD_ON == \
                                                 GPT_WAKEUP_FUNCTIONALITY_API)

FUNC(void, GPT_CODE) Gpt_EnableWakeup(Gpt_ChannelType Channel);
#endif /*(STD_ON == GPT_WAKEUP_FUNCTIONALITY_API)*/

/*
 * Design : MCAL-6242
 */

#if (STD_ON == GPT_REPORT_WAKEUP_SOURCE) && (STD_ON == \
                                                 GPT_WAKEUP_FUNCTIONALITY_API)

FUNC(void, GPT_CODE) Gpt_CheckWakeup(EcuM_WakeupSourceType WakeupSource);
#endif /*(STD_ON == GPT_WAKEUP_FUNCTIONALITY_API)*/

#if (STD_ON == GPT_REGISTER_READBACK_API)

FUNC(Std_ReturnType, GPT_CODE) Gpt_RegisterReadback(
    Gpt_ChannelType GptChannel,
    P2VAR(Gpt_RegisterReadbackType, AUTOMATIC, GPT_APPL_DATA) RegRbPtr);
#endif  /* #if (STD_ON == GPT_REGISTER_READBACK_API) */

#if (GPT_PREDEF_TIMER_DISABLED == GPT_PREDEF_TIMER_TYPE)
/* Function not implemented due to hardware limitation
   Dummy Function*/
FUNC(Std_ReturnType, GPT_CODE) Gpt_GetPredefTimerValue (
     Gpt_PredefTimerType PredefTimer,uint32* TimeValuePtr);
#endif

#ifdef __cplusplus
}
#endif

#endif  /* #ifndef GPT_H_ */

/* @} */