mcu/interface/service/rsra/rsra_public.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:
 * ---------
 *   rsra_public.h
 *
 * Project:
 * --------
 *   VMOLY
 *
 * Description:
 * ------------
 *   Defines RSRA public interface
 *
 * Author:
 * -------
 * -------
 *
 * ==========================================================================
 * $Log$
 *
 * 01 27 2022 ot_srishti.sharma
 * [MOLY00785273] [ZM52][AT&T] LTE-BTR-1-7567/LTE_BTR_1_7536 fail on IPV6
 * 	
 * 	RS Mandatory for AT&T
 *
 *
 ****************************************************************************/
#ifndef _RSRA_PUBLIC_H_
#define _RSRA_PUBLIC_H_
#include "qmu_bm_util.h"
/*------------------------------------------------------------------------------
 * Enumerations.
 *----------------------------------------------------------------------------*/


typedef enum {
    RSRA_R_RSRA_IPV4_MTU,
    RSRA_R_RSRA_IPV6_MTU,
    RSRA_R_RSRA_PREFIX,
    RSRA_R_RSRA_INTERFACE_ID,
    RSRA_R_STK_ID,
    RSRA_R_RAN_TYPE,
    RSRA_R_ROUTER_LIFETIME,
    RSRA_R_RSRA_SUCCESS,
    RSRA_R_RSRA_FAIL,
    RSRA_R_PREFIX_EXPIRE,
    RSRA_R_DAD_SUCCESS,
    RSRA_R_DAD_FAIL
} rsra_events_e;


typedef enum {
    RSRA_O_RS_STATUS,
    RSRA_O_RS_DELAY,
    RSRA_O_RS_INTERVAL,
    RSRA_O_RS_RETRY,
    RSRA_O_RS_MANDATORY,
    RSRA_O_RS_LIFETIME_CB,
    RSRA_O_EVENT_CB
} rsra_options_e;

/*------------------------------------------------------------------------------
 * Data structure defintion.
 *----------------------------------------------------------------------------*/

typedef void (*rx_cb)(void *info, void *context, kal_int32 fid, void *head_gpd, void *tail_gpd, kal_uint32 length);

typedef kal_int32 (*rsra_lifetime_cb)(kal_uint32 sim_id, kal_uint32 *lifetime, kal_uint32 valid_lifetime, kal_uint32 preferred_lifetime, kal_uint32 router_lifetime);
typedef kal_int32 (*rsra_event_cb)(kal_uint32 netif_id, kal_uint32 event, void* param, kal_uint32 len);

/*------------------------------------------------------------------------------
 * Helper Macro.
 *----------------------------------------------------------------------------*/


/*------------------------------------------------------------------------------
 * Public fucntions.
 *----------------------------------------------------------------------------*/

void rsra_ilm_hdlr(ilm_struct *p_ilm);
void rsra_init(void);
extern void rsra_on_start(void);
kal_bool rsra_reset(void);

kal_bool rsra_data_reg_filter(kal_uint32 netif_id, rx_cb callback, void *cntx, kal_uint8 ps_id, kal_uint32 stk_id, kal_uint32 ran_type);
kal_bool rsra_data_dereg_filter(kal_uint32 netif_id);
kal_bool tcpip_rsra_proxy_bind_complete(qbm_gpd *head_gpd, kal_uint32 netif_id);

#endif  //  _RSRA_PUBLIC_H_