mcu/protocol/interface/el2/el2_public_api.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:
 * ---------
 *   el2_pulbic_api.h
 *
 * Project:
 * --------
 *   UMOLYA
 *
 * Description:
 * ------------
 *    EL2 API for other modules
 *
 * Author:
 * -------
 * -------
 *
 ****************************************************************************/

#ifndef _EL2_PUBLIC_API_H_
#define _EL2_PUBLIC_API_H_


// ===========================================================================
//   VRB release API for other layer: ERRC
// ===========================================================================

void epdcp_errc_mcch_data_buffer_free(void *p_data, kal_uint32 data_len);
void epdcp_errc_dcch_data_buffer_free(void *p_data, kal_uint32 data_len);
void emac_errc_ccch_data_buffer_free(void *p_data, kal_uint32 data_len);


// ===========================================================================
//   EL2POW API for other layer: ERRC/L1S
// ===========================================================================

void el2pow_errc_config_copro_power_on_req(kal_uint8 protocol_idx);
void el2pow_errc_config_copro_power_off_req(kal_uint8 protocol_idx);

void el2pow_l1s_power_on();

// ===========================================================================
//   EL2 API for other layer: RSVAS
// ===========================================================================
// @brief Tell RSVAS the sequence to send SUSPEND_SERVICE_REQ for each modules

// EMACDLPORTAL ID: b'01
// EL2HPORTAL ID:   b'10
// EL2PORTAL ID:    b'11

// Default sequence: EL2HPORTAL -> EMACDLPORTAL -> EL2PORTAL
// Default return value: b'00 11 01 10 (0x36)

// return     B7B6    B5B4        B3B2          B1B0
// meaning    N/A     3rd         2nd           1st
// module     N/A     EL2PORTAL   EMACDLPORTAL  EL2HPORTAL
// module id  00      11          01            10

kal_uint32 el2_rsvas_forward_sequence_for_suspend_service_req();


// ===========================================================================
//   EL2 API for other layer: ICD
// ===========================================================================

// For MAC_DL_TB record
void el2icd_mac_dl_transport_block_paging_handler(kal_uint32 protocol_idx, kal_uint32 sfn, kal_uint32 subframe);
void el2icd_mac_dl_transport_block_si_handler(kal_uint32 protocol_idx, kal_uint32 sfn, kal_uint32 subframe, kal_bool is_si);

// ===========================================================================
//   EL2 API for other layer: UPCM
// ===========================================================================

/*  
 *  @brief epdcp_is_non_ims_ul_psn_print_by_epdcp
 *  Query if EPDCP is printing PSN for uplink packets of non-IMS DRBs for the 
 *  protocol_idx specified.
 *
 *  @param protocol_idx
 *
 *  @return kal_bool
 *       KAL_TRUE:
 *           EPDCP prints PSN for uplink packets of non-IMS DRBs periodically
 *           for the protocol_idx specified.
 *       KAL_FALSE:
 *           EPDCP dows not print PSN for uplink packets at all for the 
 *           protocol_idx specified.
 */
kal_bool epdcp_is_non_ims_ul_psn_print_by_epdcp(kal_uint32 protocol_idx);


#endif /* _EL2_PUBLIC_API_H_ */