mcu/interface/protocol/l2_c2k/evdo/rcpcsm.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  _RMCCSM_H_
#define  _RMCCSM_H_
/*****************************************************************************
* 
* FILE NAME   :   rcpcsm.h
*
DESCRIPTION :   This file contains function prototypes and other definitions
*               for the RCP CSM component used within RMC task 
*
*
* HISTORY     :
*     See Log at end of file
*
*****************************************************************************/

/*----------------------------------------------------------------------------
* Include Files
----------------------------------------------------------------------------*/
#include "evl1shcsm.h"
#include "do_rcpapi.h"

/*----------------------------------------------------------------------------
 Global Defines And Macros
----------------------------------------------------------------------------*/


/*----------------------------------------------------------------------------
Global Typedefs
----------------------------------------------------------------------------*/

typedef enum
{
  CSM_START_NEW,
  CSM_START_UPDATE,
  CSM_START_CANCEL,
} Evl1shCsmEvtStartTypT;

typedef enum
{
  INTRA_CELL,
  INTER_CELL
} CsmSoftHOTypeT;


typedef struct
{
    Evl1ShCsmPhySubtypeT PhySubtype;
    kal_uint16 DrcLength;
    kal_uint16 DscLength;
    kal_uint8  FrameOffset; 
}RcpCsmActiveMsgT;

typedef  struct
{
  kal_uint32 ResyncFrcCnt;
  kal_bool   ResyncFrcCntValid;
} RcpCsmHscStopTxMsgT;



typedef struct 
{
    kal_uint8 DrcLockValid;
    kal_uint8 DrcLockPcgFinal[CSM_MAX_ACTIVE_PILOTS];
}RcpCsmSectorC2IUpdateMsgT;


typedef  struct
{
    kal_uint16 PilotPN;
    kal_uint8  MACIndex;
    kal_uint8  DRCCover;
    kal_uint8  DSC;
} RcpCsmActiveParamsT;


typedef struct
{
    kal_uint8  ActiveNum;
    RcpCsmActiveParamsT ActiveParams[CSM_MAX_ACTIVE_PILOTS];
}RcpCsmTcaIndMsgT;


typedef enum
{
  RESUME,
  NULLCOVER,
  NULLCOVER_SUSPEND,
} CsmForceNullCoverT;



typedef struct
{
    kal_int16 TestPn;
    kal_int8  DRCCover;          /* The target DRCCover */
    kal_int8  DSC;          /* The target DSCCover */
    kal_int8  PcgId;       /*The target PcgId*/  
}RcpCsmTestSwtichParamT;


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


/*----------------------------------------------------------------------------
 Global Function Prototypes
----------------------------------------------------------------------------*/
void RcpCsmActiveMsg(RcpCsmActiveMsgT *CsmActiveMsgPtr);
void RcpCsmDeActiveMsg(void);
void RcpCsmSectorInfoUpdateMsg(RcpUpdateSectorInfoMsg *CsmSectorInfoPtr);
void RcpCsmSectorC2IUpdateMsg(RcpCsmSectorC2IUpdateMsgT *CsmSectorC2IInfoPtr);
void RcpCsmHscPreemptMsg(RcpCsmHscStopTxMsgT *HscStopTxMsgPtr);
void RcpCsmHscResumeMsg(void);
void RcpCsmDoneMsg(Evl1CsmDoneMsgT *CsmDoneMsgptr);
void RcpCsmTxFreezeMsg(void);
void RcpCsmTxUnfreezeMsg(void);
void RcpCsmTcaIndMsg(RcpCsmTcaIndMsgT *TcaIndMsgPtr);
void RcpCsmC2iRdMsg(Evl1CsmC2iRdMsgT *C2iRdMsgPtr);
void RcpCsmSuspendMsg(void);
void RcpCsmResumeMsg(void);
void RcpCsmForceNullCover(module_type SrcMod, CsmForceNullCoverT ForceNullCover);
kal_bool RcpCsmGetCellSwitchStatus(void);
kal_uint8 RcpCsmGetC2IHwCounterThreshold(void);
kal_bool RcpCsmGet1XScheduledWakeupTime(kal_uint64 *time1xWakeupInDOSlots);
void RcpCsmTestSwich(RcpCsmTestSwtichParamT *RcpCsmTestSwtichParamPtr);
void RcpCsmPreempTimeUpMsg(void);
#ifdef __EVL1_EM_MODE__
void * Evl1EmRcpCsmInfoGet(void);
#endif
void RcpCsmInit(kal_bool TcaInit);

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