app_timer_id.h

/***************************************************************************//**
* \file app_timer_id.h
* \version 2.0
*
* Provides Application Software Timer Identifier definitions.
*
********************************************************************************
* \copyright
* Copyright 2023, Cypress Semiconductor Corporation. All rights reserved.
* You may use this file only in accordance with the license, terms, conditions,
* disclaimers, and limitations in the end user license agreement accompanying
* the software package with which this file was provided.
*******************************************************************************/

#ifndef _APP_TIMER_ID_H_
#define _APP_TIMER_ID_H_

#include <stdint.h>
#include <cy_pdutils_sw_timer.h>

#define APP_PORT0_TIMER_START              (CY_PDUTILS_TIMER_APP_PORT0_START_ID + 32u)
#define APP_PORT1_TIMER_START              (CY_PDUTILS_TIMER_APP_PORT1_START_ID + 32u)

#define GET_APP_TIMER_ID(context, id)                                 \
    (uint16_t)(((context)->port != 0U) ? ((((uint16_t)id) & 0x00FFU) + (uint16_t)APP_PORT1_TIMER_START) : (uint16_t)(id))

#define GET_PDL_TIMER_ID(context, id)                                 \
    (((uint16_t)id & 0xFF) + (uint16_t)((((context)->port != 0U) ? (uint16_t)CY_PDUTILS_TIMER_APP_PORT1_START_ID : (uint16_t)CY_PDUTILS_TIMER_APP_PORT0_START_ID)))

typedef enum {
    APP_TIMERS_START_ID = APP_PORT0_TIMER_START,
    /**< Start index for Application level timers. */

    APP_PSOURCE_EN_TIMER = APP_TIMERS_START_ID,
    /**< Timer used to ensure timely completion of power source enable operation. */

    APP_PSOURCE_EN_MONITOR_TIMER,
    /**< Timer used to monitor voltage during power source enable operation. */

    APP_PSOURCE_EN_HYS_TIMER,
    /**< Timer used to add hysteresis at the end of a power source enable operation. */

    APP_PSOURCE_DIS_TIMER,
    /**< Timer used to ensure timely completion of power source disable operation. */

    APP_PSOURCE_DIS_MONITOR_TIMER,
    /**< Timer used to monitor voltage during power source disable operation. */

    APP_PSOURCE_CF_TIMER,
    /**< Power source Current foldback restart timer ID. */

    APP_PSOURCE_DIS_EXT_DIS_TIMER,
    /**< Timer used to discharge VBus for some extra time at the end of a power source disable operation. */

    APP_DB_SNK_FET_DIS_DELAY_TIMER,
    /**< Dead battery Sink Fet disable delay timer. */

    APP_PSINK_DIS_TIMER,
    /**< Timer used to ensure timely completion of power sink disable operation. */

    APP_PSINK_DIS_MONITOR_TIMER,
    /**< Timer used to monitor voltage during power sink disable operation. */

    APP_VDM_BUSY_TIMER,
    /**< Timer used to delay retry of VDMs due to BUSY responses or errors. */

    APP_AME_TIMEOUT_TIMER,
    /**< Timer used to implement AME timeout. */

    APP_VBUS_OCP_OFF_TIMER,
    /**< Timer used to disable VBus supply after OC fault. */

    APP_VBUS_OVP_OFF_TIMER,
    /**< Timer used to disable VBus supply after OV fault. */

    APP_VBUS_UVP_OFF_TIMER,
    /**< Timer used to disable VBus supply after UV fault. */

    APP_VBUS_SCP_OFF_TIMER,
    /**< Timer used to disable VBus supply after SC fault. */

    APP_FAULT_RECOVERY_TIMER,
    /**< App timer used to delay port enable after detecting a fault. */

    APP_SBU_DELAYED_CONNECT_TIMER,
    /**< Timer used to do delayed SBU connection in Thunderbolt mode. */

    APP_MUX_DELAY_TIMER,
    /**< Timer used to delay VDM response. */

    APP_MUX_POLL_TIMER,
    /**< Timer used to MUX status. */

    APP_CBL_DISC_TRIGGER_TIMER,
    /**< Timer used to trigger cable discovery after a V5V supply change. */

    APP_V5V_CHANGE_DEBOUNCE_TIMER,
    /**< Timer used to debounce V5V voltage changes. */

    APP_VCONN_RECOVERY_TIMER,
    /**< Timer used to run Vconn swap after V5V was lost and recovered while UFP. */

    APP_OT_DETECTION_TIMER,
    /**< Timer used to call OT measurement handler. */

    APP_CHUNKED_MSG_RESP_TIMER,
    /**< Timer ID used to respond to chunked messages with NOT_SUPPORTED. */

    APP_RESET_VDM_LAYER_TIMER,
    /**< Timer used to run reset of VDM layer. */

    APP_BB_ON_TIMER,
    /**< Timer used to provide delay between disabling the Billboard device and re-enabling it. */

    APP_BB_OFF_TIMER,
    /**< Timer used to display USB billboard interface to save power. */

    APP_INITIATE_SWAP_TIMER,
    /**< Timer used to initiate SWAP operations in DRP applications with a power/data role preference. */

    APP_VDM_NOT_SUPPORT_RESP_TIMER_ID,
    /**< VDM Not supported response timer. */

    APP_BC_TIMERS_START_ID,
    /**< Start of Battery Charging State Machine timers. */

    APP_BC_GENERIC_TIMER1,
    /**< Generic timer #1 used by the BC state machine. */

    APP_BC_GENERIC_TIMER2,
    /**< Generic timer #2 used by the BC state machine. */

    APP_BC_DP_DM_DEBOUNCE_TIMER,
    /**< Timer used to debounce voltage changes on DP and DM pins. */

    APP_BC_DETACH_DETECT_TIMER,
    /**< Timer used to detect detach of a BC 1.2 sink while functioning as a CDP. */

    APP_CDP_DP_DM_POLL_TIMER,
    /**< Timer used to initiate DP/DM voltage polling while connected as a CDP. */

    APP_EPR_MODE_TIMER,
    /**< Timer used by EPR state machine. */

    APP_EPR_EXT_CMD_TIMER,
    /**< Timer used to send enter/exit EPR mode events to EPR state machine. */

    APP_TIMER_HPD_DELAY_TIMER,
    /**< This timer is used to delay HPD events. */

    APP_PSOURCE_VBUS_SET_TIMER_ID,
    /**< Power source VBUS set timer ID. */

    APP_PSOURCE_SAFE_FET_ON_MONITOR_TIMER_ID,
    /**< Timer to monitor voltage during FET On operation. */

    APP_PSOURCE_SAFE_FET_ON_TIMER_ID,
    /**< Timeout timer to set safe voltage during FET On operation. */

    VBUS_DISCHARGE_SCHEDULE_TIMER,
    /**< Timer for VBUS SLow Discharge */

    CCG_LS_MASTER_PORT_DEBOUNCE_TIMER_ID,
    /**< Macro defines Master Debounce Timer ID. */

    CCG_LS_SLAVE_PORT_DEBOUNCE_TIMER_ID,
    /**< Macro defines Slave Debounce Timer ID. */

    CCG_LS_MASTER_WRITE_TIMER_ID,
    /**< Macro defines Master Write Timer ID. */

    CCG_LS_HEART_BEAT_TIMER_ID,
    /**< Macro defines Heart Beat Timer ID. */

    THROTTLE_TIMER_ID,
    /**< Power Throttling timer ID. */

    THROTTLE_WAIT_FOR_PD_TIMER_ID,
    /**< Power Throttling timer ID. */

    APP_RESERVED_TIMER_ID,
    /**< Timer ID reserved for future use. */

    LINS_BUS_INACTIVE_TIMER,
    /**< Bus Inactivity Timeout for LIN. */
    
    LINS_BUS_LISTEN_TIMER,
    /**< Nominal Time for Reception of a single frame from BREAK */
    
    LINS_MULTIFRAME_DROP_TIMER,
    /**< Multi-frame timer to drop the frame upon late reception. */

    APP_FET_SOFT_START_TIMER_ID,
    /**< Timer used to control soft turn-on of power FET gate drivers. */

    APP_HAL_VREG_TIMER,
    /**< Timer that can be used for Vreg fault handling. */

    APP_HAL_GENERIC_TIMER,
    /**< Timer that can be used for generic HAL functions. */

    APP_REGULATOR_STARTUP_MONITOR_TIMER,             
    /**< Timer ID reserved for regulator startup monitoring. */

    APP_DATA_RESET_TIMER,
    /**< Timer ID for DATA Reset handling. */

    SYS_BLACK_BOX_TIMER_ID,
    /**< Timer ID reserved for blackbox. */

    APP_PSOURCE_REGULATOR_MON_TIMER,
    /**< Timer ID used to monitor regulator enable status periodically. */

    APP_BAD_SINK_TIMEOUT_TIMER,
    /**< PD bad sink timeout timer ID. */

    APP_VBAT_GND_SCP_TIMER_ID,
    /**< VBAT-GND SCP recovery timer. */

    APP_VCONN_OCP_TIMER,
    /**< Timer to perform delayed start for VCONN OCP. */
    
    CCG_LS_SNK_CAP_TIMEOUT_TIMER_ID,
    /**< PD Timeout Timer for LS Slave. */

    APP_GPIO_HPD_TIMER_ID,
    /**< GPIO based HPD timer. */
    
    APP_VBUS_FET_ON_TIMER,
    /** Timer used for providing delay for VBUS FET ON. */

    APP_VBUS_FET_OFF_TIMER,
    /** Timer used for providing delay for VBUS FET OFF. */

    APP_VCONN_TURN_ON_DELAY_TIMER,
    /** Timer used for providing delay for VConn Gate Pull Up enable. */

    APP_LPM_TIMER,
    /** Timer used for Low Power Mode. */

} app_timer_id_t;

#endif /* _APP_TIMER_ID_H_ */

/* [] END OF FILE */