mcu/interface/protocol/l2_c2k/evdo/rcptxagc.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).
*
*****************************************************************************/

/*******************************************************************************
 *
 * Filename:
 * ---------
 * rcptxagc.h
 *
 * Project:
 * --------
 * C2K
 *
 * Description:
 * ------------
 * global definition of RxAGC in Slot Tick.
 *
 * Author:
 * -------
 *
 *
 *==============================================================================
 *             HISTORY
 * Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *------------------------------------------------------------------------------
 *
 *
 *------------------------------------------------------------------------------
 * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *==============================================================================
 *******************************************************************************/

#ifndef  _RCP_TXAGC_H_
#define  _RCP_TXAGC_H_

#include "sysapi.h"
#include "evl1shtxagc.h"

/* define the close loop RPC step set structure */
typedef struct TxAgcClosedLoopRpcStepSetEvtTag
{
    kal_uint8 RpcStep;    /* 00: 0.5dB, 01: 1dB, all other values: invalid */
} TxAgcClosedLoopRpcStepSetEvtT;

/* define the CMU RETAP flag set structure */
typedef struct TxAgcCmuRetapFlagSetEvtTag
{
    kal_bool CmuRetapFlag;
} TxAgcCmuRetapFlagSetEvtT;

typedef struct
{
    /* TX AGC control type,
       0: stop sw txagc,
       1: start sw txagc,
       2: obtain current request power */
    kal_uint8               CtrlType;

    /* Tx slot */
    kal_uint8               TxSlot;

    /* Access/ Traffic channel */
    TxAgcChanTypeE          ChanType;

    /* PHY subtype */
    TxAgcPhySubTypeE        PhySubType;

    /* Power reference used for open loop estimation in 1/64dBm@S9.6 unit.*/
    kal_int16               PowerBase; /* Q6 dB */

    /* Bit0: trans ind TRUE/FALSE,
       Bit8: Close loop parameters enable/disable */
    kal_uint16              TestBmp;

    /* close loop step up size in 1/64dB@S2.6 unit */
    kal_int16               ClStepUp;

    /* close loop step down size in 1/64dB@S2.6 unit */
    kal_int16               ClStepDown;

    /* close loop adjustment limited in 1/64dB@S8.6 unit */
    kal_int16               ClAdjMax;

    /* close loop adjustment limited in 1/64dB@S8.6 unit */
    kal_int16               ClAdjMin;

    /* maximum transmit power adjustment in 1/64dB@S5.6 unit, set zero
    if not use it */
    kal_int16               MaxPwrAdj;

    /* RPC bit in SW mode with U2.0 unit*/
    kal_uint16              RpcBitSw; /* Q6 dB */

    /* KS value in SW mode with S6.6 unit*/
    kal_int16               KsValueSw; /* Q6 dB */

    /* Reserved */
    kal_uint16              Reserved;

} TxAgcCtrlEvtT;

/* define the power information report structure */
typedef struct
{
    kal_int16   openLoopRxPwr; /* The RxPwr after each access probe */
    kal_int16   TxPilotPwr;    /* The final "clipped" pilot pwr after each access probe */
    kal_int16   KsAdj;
} RcpRtcPwrRefParamMsgT;

/** MSG_ID_RCP_TXAGC_RTC_PWR_REF_PARAM_MSG
*/
typedef struct
{
    LOCAL_PARA_HDR
    RcpRtcPwrRefParamMsgT Msg;
} rcp_txagc_rtc_pwr_ref_param_msg_struct;

/*----------------------------------------------------------------------------
 Global Defines And Macros
----------------------------------------------------------------------------*/
extern void TxAgcInit();
extern kal_int16 RcpTxAgcGetCurrRxPwr();
extern kal_int16 RcpTxAgcGetMaxTxPwr();
extern kal_int16 RcpTxAgcGetAvailTxPwr();
extern void RcpTxAgcClosedLoopRpcStepSet(kal_uint8 RpcStep);
extern void RcpTxAgcCMURetapFlagSet(kal_bool CmuRetapFlag);
/*****************************************************************************
* End of File
*****************************************************************************/
#endif