mcu/protocol/interface/el2/errc_emacmch_msg.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:
 * ---------
 *   errc_emacmch_msg.h
 *
 * Project:
 * --------
 *   MOLY
 *
 * Description:
 * ------------
 *   Define ERRC EMACMCH interface enums, structures and constants
 *
 * Author:
 * -------
 * -------
 *
 ****************************************************************************/

#ifndef ERRC_EMACMCH_MSG_H
#define ERRC_EMACMCH_MSG_H

#include "kal_public_api.h"
#include "el2_sap_common.h"
#include "common_def.h"
#include "el1_enum.h"

typedef struct {
    kal_uint8   num; //fdd: 1-6, tdd: 1-5
    kal_uint8   sf[MAX_SF_IN_ONE_RF]; //fdd: 123678, tdd: 34789
}sf_alloc_map_t; 

typedef struct {
    kal_uint8   rf_alloc_period; /*1, 2, 4, 8, 16, 32 */
    kal_uint8   rf_alloc_offset; /* 0.. 7*/ // TODO: if offset > period?
    kal_bool    is_one_frame_alloc;
    sf_alloc_map_t sf_alloc_map[4];
}sf_config_t; 

typedef struct {
    kal_uint8      num_sf_config;  /* 0...8 */
    sf_config_t    sf_config_list[MAX_MBSFN_ALLOCATIONS];
}mbsfn_sf_config_list_t; 

// SYNCAREA_CFG
typedef struct {
    kal_uint8   mbsfn_area_id; // 0-255
    kal_uint8   non_mbsfn_region_len; // 1-2
    kal_uint8   signalMCS; // 2,7,13,19
    kal_uint8   offset; // 0-10
    kal_uint16  repetition_period; // 32, 64, 128, 256
    kal_uint16  modification_period; // 512, 1024
    sf_alloc_map_t sf_alloc_info;
    el1_ch_mch_mcch_reception_mode_enum    recv_mode; // EVY_RP, EVY_MP, CNG_DTT
}mcch_config_t;

typedef struct
{
    //kal_uint8                   syncarea_id;
    kal_uint8                   mcch_cfg_num; // 0-8
    mcch_config_t               mcch_cfg[MAX_AREA_NUM_PER_CELL];
    mbsfn_sf_config_list_t      sib2_sf_config_list; 
    
} errc_emacmch_syncarea_cfg_t;

// AREA_CFG
typedef struct {
    kal_uint8   pmch_id;
    kal_bool    is_cfg_pmch_info_list_ext; //MT6293
    kal_bool    is_higher_order_data_mcs; //MT6293
    kal_uint8   dataMCS; /* 0 ..28*/
    kal_uint8   session_num_in_pmch; //MT6293
    kal_uint16  sf_alloc_start;
    kal_uint16  sf_alloc_end;
    kal_uint16  mch_sched_period; /* 8, 16, 32, 64, 128, 256, 512, 1024 */
    
}pmch_info_t;

typedef struct {
    kal_uint8   mbsfn_area_id; /* 0 .. 255 */
    kal_uint16  common_sf_alloc_period; /* 4, 8, 16, 32, 64, 128, 256 */
    
    kal_uint8   num_sf_config; 
    sf_config_t sf_config_list[MAX_MBSFN_ALLOCATIONS];
    
    kal_uint8   num_pmch_info;  /* 0 represent all PMCH close */
    pmch_info_t pmch_info_list[MAX_PMCH_PER_MBSFN];
    
}mbsfn_area_config_t;

typedef struct
{
    //kal_uint8                   syncarea_id;
    kal_uint8                   area_cfg_num; 
    mbsfn_area_config_t         area_cfg[MAX_AREA_NUM_PER_CELL];
        
} errc_emacmch_syncarea_area_cfg_t;

// MXCH_CFG
typedef struct
{
    kal_uint8   area_id;        // 0~255
    kal_uint8   mcch_idx;       // numbered by ERRC
    
} errc_emacmch_establish_mcch_t;

typedef struct
{
    kal_uint8   area_id;        // 0~255, currently for debug purpose only
    kal_uint8   mcch_idx;       // numbered by ERRC
    
} errc_emacmch_release_mcch_t;

typedef struct
{
    kal_uint8   area_id;        // 0~255
    kal_uint8   pmch_id;        // 0~15, numbered by ERRC (directly use the index in asn ie) = pmch_ie_idx
    kal_uint8   lcid;           // 0~28
    kal_uint8   mtch_idx;       // numbered by ERRC, The range of mrb_idx depends on L2 HW capability
    kal_uint8   tmgi[6];        // tmgi info to identify MBMS session, required by VZW EM
    
} errc_emacmch_establish_mtch_t;

typedef struct
{
    kal_uint8   area_id;        // 0~255, currently for debug purpose only
    kal_uint8   pmch_id;        // 0~15, currently for debug purpose only
    kal_uint8   lcid;           // 0~28, currently for debug purpose only
    kal_uint8   mtch_idx;       // numbered by ERRC, The range of mrb_idx depends on L2 HW capability
    kal_uint8   tmgi[6];        // tmgi info to identify MBMS session, required by VZW EM
    
} errc_emacmch_release_mtch_t;

typedef struct
{
    //kal_uint8                     syncarea_id;
    kal_uint8                     release_mcch_num;
    errc_emacmch_release_mcch_t   release_mcch[MAX_EMBMS_MCCH_SUPPORT];

    kal_uint8                     establish_mcch_num; 
    errc_emacmch_establish_mcch_t establish_mcch[MAX_EMBMS_MCCH_SUPPORT]; 
    
    kal_uint8                     release_mtch_num;
    errc_emacmch_release_mtch_t   release_mtch[MAX_EMBMS_MTCH_SUPPORT];

    kal_uint8                     establish_mtch_num;
    errc_emacmch_establish_mtch_t establish_mtch[MAX_EMBMS_MTCH_SUPPORT];
        
} errc_emacmch_syncarea_mxch_cfg_t;

// MCCH_RCV_MODE_CHANGE
typedef struct 
{
    kal_uint8   mbsfn_area_id;
    el1_ch_mch_mcch_reception_mode_enum    recv_mode;
    
}mcch_rept_mode_config_t;

typedef struct
{
    //kal_uint8                       syncarea_id;
    kal_uint8                       mcch_rcv_mode_change_num;
    mcch_rept_mode_config_t         mcch_rcv_mode_change[MAX_AREA_NUM_PER_CELL]; 
    
} errc_emacmch_syncarea_mcch_rcv_mode_change_t;

// MTCH_SUSPEND_IND
typedef struct
{
    kal_uint8   lcid;           // 0~28
    kal_uint8   mtch_idx;       // numbered by ERRC, The range of mrb_idx depends on L2 HW capability
        
} errc_emacmch_mtch_t;


/****************************************************************************
 *                          ERRC -> EMACMCH
 ****************************************************************************/

// MSG_ID_ERRC_EMACMCH_SYNCAREA_CFG_REQ
typedef struct
{

    LOCAL_PARA_HDR
    kal_uint32                  tid; // 0x00000000 - 0x7FFFFFFF
    kal_bool                    syncarea_cfg_valid[MAX_EMBMS_FREQ_SUPPORT];
    errc_emacmch_syncarea_cfg_t syncarea_cfg[MAX_EMBMS_FREQ_SUPPORT];
           
} errc_emacmch_syncarea_cfg_req_struct;

// MSG_ID_ERRC_EMACMCH_AREA_CFG_REQ
typedef struct
{
    LOCAL_PARA_HDR
    kal_uint32                       tid; // 0x00000000 - 0x7FFFFFFF
    kal_bool                         syncarea_area_cfg_valid[MAX_EMBMS_FREQ_SUPPORT];
    errc_emacmch_syncarea_area_cfg_t syncarea_area_cfg[MAX_EMBMS_FREQ_SUPPORT];
           
} errc_emacmch_area_cfg_req_struct;

// MSG_ID_ERRC_EMACMCH_MXCH_CFG_REQ
typedef struct
{
    LOCAL_PARA_HDR
    errc_emacmch_syncarea_mxch_cfg_t syncarea_mxch_cfg[MAX_EMBMS_FREQ_SUPPORT]; // for 2 freq
    
} errc_emacmch_mxch_cfg_req_struct;


/* MSG_ID_ERRC_EMACMCH_MCCH_RCV_MODE_CHANGE_REQ */
// Possible modes that could be changed by ERRC includes:
// EL1_RECV_EVERY_REPETITION_PERIOD    = 0,
// EL1_RECV_EVERY_MODIFICATION_PERIOD  = 1,
// EL1_RECV_CHANGE_DETECTION           = 2,

typedef struct
{
    LOCAL_PARA_HDR
    kal_uint32                                   tid;  // 0x00000000 - 0x7FFFFFFF
    kal_bool                                     syncarea_mcch_rcv_mode_change_valid[MAX_EMBMS_FREQ_SUPPORT];
    errc_emacmch_syncarea_mcch_rcv_mode_change_t syncarea_mcch_rcv_mode_change[MAX_EMBMS_FREQ_SUPPORT];

} errc_emacmch_mcch_rcv_mode_change_req_struct;


/****************************************************************************
 *                          EMACMCH -> ERRC
 ****************************************************************************/

// MSG_ID_ERRC_EMACMCH_SYNCAREA_CFG_CNF
typedef struct
{
    LOCAL_PARA_HDR
    errc_el2_cfg_result_enum result; 
    
} errc_emacmch_syncarea_cfg_cnf_struct;

// MSG_ID_ERRC_EMACMCH_AREA_CFG_CNF
typedef struct
{
    LOCAL_PARA_HDR
    errc_el2_cfg_result_enum result; 
    
} errc_emacmch_area_cfg_cnf_struct;

// MSG_ID_ERRC_EMACMCH_MXCH_CFG_CNF
typedef struct
{
    LOCAL_PARA_HDR
    errc_el2_cfg_result_enum result;  
    
} errc_emacmch_mxch_cfg_cnf_struct;

/* MSG_ID_ERRC_EMACMCH_MCCH_RCV_MODE_CHANGE_CNF */
typedef struct
{
    LOCAL_PARA_HDR
    errc_el2_cfg_result_enum result;  

} errc_emacmch_mcch_rcv_mode_change_cnf_struct;

// MSG_ID_ERRC_EMACMCH_MTCH_SUSPEND_IND
typedef struct
{
    LOCAL_PARA_HDR
    kal_uint8           syncarea_id;      // 0:PCELL 1:SCELL     
    kal_uint8           area_id;          // 0~255
    kal_uint8           pmch_id;          // 0~15
    kal_uint8           suspend_mtch_num;
    errc_emacmch_mtch_t suspend_mtch[MAX_MTCH_NUM_PER_PMCH_29];
    
} errc_emacmch_mtch_suspend_ind_struct;


#endif /*ERRC_EMACMCH_MSG_H*/