mcu/interface/protocol/as_c2k/evdo/slctimer.h

/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2016
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS (""MEDIATEK SOFTWARE"")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN ""AS-IS"" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/
/*************************************************************
*
* This Software is the property of VIA Telecom, Inc. and may only be used pursuant to a license from VIA Telecom, Inc.  
* 
* Any unauthorized use inconsistent with the terms of such license is strictly prohibited.
* 
* Copyright (c) 2007-2010 VIA Telecom, Inc.  All rights reserved.
*
*************************************************************/
#ifndef _SLCTIMER_H_
#define _SLCTIMER_H_ 1
/*****************************************************************************
* 
* FILE NAME   : slctimer.h
*
* DESCRIPTION : Timer Controller interface for the SLC Task
*
*****************************************************************************/
#include "tasktimer.h"


/*----------------------------------------------------------------------------
 Global Defines and Macros
----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
 Global Typedefs
----------------------------------------------------------------------------*/

/* define the timer ID for timers in SLC, match following function */
/*
static const ProtocolTimerHandlerT protocolTimerHandlerTable[NUM_SLCTMRs] = {
    GcpTimerHandler,
    DScpGaupTimerHandler,
    DScpReconfigCnfWaitTimerHandler,
    DScpANInitStWaitReqTimerHandler,
    ProcessAmpAddrTimeout,
    ProcessAmpWaitUATIRspTimeout,
    ProcessSmpKeepAliveTransTimeout,
    ProcessAmpUATICompleteTimeout,
    ProcessAmpReSendUATIReqTimeOut
};

*/
typedef enum
{
  GCP_TRANSACTION_TICK_TIMER_ID     = 0,
  DSCP_GAUP_TURNAROUND_TIMER_ID,
  DSCP_RECONFIG_CNF_WAIT_TIMER_ID,
  DSCP_AN_INIT_ST_WAIT_REQ_TIMER_ID,
  AMP_ADDRESS_TIMER_ID,
  AMP_WAIT_UATI_RSP_TIMER_ID,
  SMP_KEEPALIVE_TRANS_TIMER_ID,
  AMP_UATICOMPLETE_DURATION_TIMER_ID,
  AMP_RESEND_UATIREQ_TIMER_ID,
  NUM_SLCTMRs
} slcTimerIdT;

/* SLC timer TRACE code */
typedef enum
{
  SCP_TIMER_START = 0,
  SCP_TIMER_STOP,
  SCP_TIMER_EXPIRE
} SlcTimerTraceT;


 
/*----------------------------------------------------------------------------
 Global Data
----------------------------------------------------------------------------*/

/*----------------------------------------------------------------------------
 Global Function Prototypes
----------------------------------------------------------------------------*/
/* the following Macro defines the API of SLC timer management as followings:
     
     void slcTimerInit(void);
     void slcStartTimer(slcTimerIdT TimerId, kal_uint32 duration, kal_bool periodic, kal_uint16 prot);
     void slcStopTimer(slcTimerIdT TimerId);
     void slcStopAllProtocolTimers(void);
     void slcStopProtProtocolTimers(kal_uint16 prot);
     kal_bool slcIsTimerActive(slcTimerIdT TimerId);
     void slcProcessTimerExpiredMsg(void* MsgP);
 
  Note: slc is the Macro parameter, it corresponds to the "slc" in the names 
        of each API function. Note: no ; is needed at the line end 
 */

TaskTimerAPIDef(slc)       

/*****************************************************************************
* End of File
*****************************************************************************/
#endif /*_SLCTIMER_H_*/