mcu/protocol/interface/iwlan/iwlan_ltecsr_struct.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) 2012
*
*  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:
 * ---------
 *   iwlan_ltecsr_struct.h
 *
 * Project:
 * --------
 *   
 *
 * Description:
 * ------------
 *
 *
 * Author:
 * -------
 *  
 *   
 *
 * ==========================================================================
 *
 ****************************************************************************/

#ifndef  _IWLAN_LTECSR_STRUCT_H
#define  _IWLAN_LTECSR_STRUCT_H

#include "kal_general_types.h"
#include "kal_public_defs.h"
#include "ps_public_enum.h"

#include "ltecsr_struct.h"


#define IWLAN_LTECSR_PAYLOAD_SZ 64
#define IWLAN_PDN_CID_NOT_AVAILABLE 0xFF

typedef enum e_iwlan_ltecsr_jitter_result {
    IWLAN_LTECSR_JITTER_INIT           = 0,
    IWLAN_LTECSR_JITTER_DL_RTCP_THR    = 1,
    IWLAN_LTECSR_JITTER_UL_RTCP_THR    = 2,
    IWLAN_LTECSR_NEVER_DL_RTCP         = 3,
    IWLAN_LTECSR_JITTER_DL_RTCP_LOST   = 4,
} iwlan_ltecsr_jitter_result_e;

typedef enum e_iwlan_ltecsr_pkt_present_result {
    IWLAN_LTECSR_PRESENT_FALSE          = 0,
    IWLAN_LTECSR_PRESENT_TRUE           = 1,
    IWLAN_LTECSR_PRESENT_UNKNOWN        = 2,
} iwlan_ltecsr_pkt_present_result_e;

//Max is 255 for better better UT coding, (kal_uint8 payload[IWLAN_LTECSR_PAYLOAD_SZ])
typedef enum {
    IWLAN_LTECSR_EOP = 0, //end of payload
    IWLAN_LTECSR_DURATION,
    IWLAN_LTECSR_PACKET_LOSS, //0~100
    IWLAN_LTECSR_JITTER_LOSS, // 0~255
    IWLAN_LTECSR_PCSCF_PING_STAT, // FULL_REPLY, PART_REPLY, NO_REPLY
    
    /* AT&T Jitter req */
    IWLAN_LTECSR_RTCP_JITTER_THRESHOLD,     // unit: ms
    IWLAN_LTECSR_RTCP_JITTER_RESULT,              // iwlan_ltecsr_jitter_result_e

    /* WFC Silence Timeout */
    IWLAN_LTECSR_WFC_SILENCE_TIMEOUT,

    /* AT&T RTCP PLR req */
    IWLAN_LTECSR_RTCP_PLR_THRESHOLD,     // percentage

    /* For on demand info query */
    IWLAN_LTECSR_PACKET_NOT_PRESENT, // bool

    /* For no RTCP trigger H.O. */
    IWLAN_LTECSR_RTCP_TIMEOUT,      // no RTCP timeout
} iwlan_ltecsr_entity_id;


typedef struct _iwlan_ltecsr_entity_t
{
    iwlan_ltecsr_entity_id entity_id;
    kal_int32              value; 
} iwlan_ltecsr_entity_t; 


//MSG_ID_EVHD_WMOB_WANS_LTECSR_INFO_CFG_REQ
//MSG_ID_EVHD_WMOB_WANS_LTECSR_INFO_CFG_CNF
//MSG_ID_EVHD_WMOB_WANS_LTECSR_INFO_RPT_IND

typedef struct
{
    LOCAL_PARA_HDR

    iwlan_ran_e ran;
    iwlan_ltecsr_entity_t payload[IWLAN_LTECSR_PAYLOAD_SZ/sizeof(iwlan_ltecsr_entity_t)];

}iwlan_ltecsr_req_st,
 iwlan_ltecsr_cnf_st;

typedef struct
{
    LOCAL_PARA_HDR

    iwlan_ran_e ran;
    kal_uint32 pdn_cid;
    iwlan_ltecsr_entity_t payload[IWLAN_LTECSR_PAYLOAD_SZ/sizeof(iwlan_ltecsr_entity_t)];

}iwlan_ltecsr_ind_st;


/*

//MSG_ID_IWLAN_LTECSR_PKTINFO_CFG_REQ
typedef struct
{
    LOCAL_PARA_HDR

    kal_int32  version;
    kal_int32  id;
    kal_int32  threshold;
    kal_int32  duration;
    kal_uint8  ext_body[512];
}iwlan_ltecsr_pktinfo_cfg_req_struct;

//MSG_ID_IWLAN_LTECSR_PKTINFO_CFG_CNF
typedef struct
{
    LOCAL_PARA_HDR

    kal_int32  version;
    kal_bool   succ;
}iwlan_ltecsr_pktinfo_cfg_cnf_struct;

//MSG_ID_IWLAN_LTECSR_PKTINFO_RPT_IND
typedef struct
{
    LOCAL_PARA_HDR

    kal_int32  version;
    kal_int32  state;
    kal_int32  id;
    kal_int32  loss_rate;
    kal_int32  thrpt;
    kal_uint8  ext_body[512];
}iwlan_ltecsr_pktinfo_rpt_ind_struct;
*/

// MSG_ID_IWLAN_LTECSR_INFO_QUERY_REQ
typedef struct {
    LOCAL_PARA_HDR

    iwlan_ran_e ran;
    iwlan_ltecsr_entity_id entity_id;
    kal_uint32 duration; // milliseconds
} iwlan_ltecsr_info_query_req_struct;

// MSG_ID_IWLAN_LTECSR_INFO_QUERY_CNF
typedef struct {
    LOCAL_PARA_HDR

    iwlan_ran_e ran;
    iwlan_ltecsr_entity_id entity_id;
} iwlan_ltecsr_info_query_cnf_struct;

// MSG_ID_IWLAN_LTECSR_INFO_QUERY_IND
typedef struct {
    LOCAL_PARA_HDR

    iwlan_ran_e ran;
    kal_uint32 pdn_cid;
    iwlan_ltecsr_entity_id entity_id;
    kal_int32 value;
} iwlan_ltecsr_info_query_ind_struct;

#endif