mcu/interface/service/wlc/intctrl_user_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) 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:
 * ---------
 * intctrl_user_struct.h
 *
 * Project:
 * --------
 * VMOLY
 *
 * Description:
 * ------------
 * Structs be used in Interfaces of INTCTRL - USER.
 *
 * Author:
 * -------
 * -------
 *
 *============================================================================
*****************************************************************************/
#ifndef __INTCTRL_USER_STRUCT_H__
#define __INTCTRL_USER_STRUCT_H__
/****************************************************************************/

#include "kal_general_types.h"
#include "kal_public_defs.h"
#include "wlc_user_struct.h"
/****************************************************************************/

/****************************************************************************/
typedef enum {
    INTCTRL_VODATA = 0,
    INTCTRL_MAX,
} intctrl_reg_type_e;

typedef enum {
    INTCTRL_VODATA_INFO_BIT_SSID = 0,
    INTCTRL_VODATA_INFO_BIT_BSSID = 1,
    INTCTRL_VODATA_INFO_BIT_CID = 2,
    INTCTRL_VODATA_INFO_BIT_PATH_READY = 3,
    INTCTRL_VODATA_INFO_BIT_WIFI_EN = 4,
    INTCTRL_VODATA_INFO_BIT_INTERFACE_ID = 5,
    INTCTRL_VODATA_INFO_BIT_IPV4_ADDR = 6,
    INTCTRL_VODATA_INFO_BIT_IPV6_ADDR = 7,
    INTCTRL_VODATA_INFO_BIT_MTU = 8,
    INTCTRL_VODATA_INFO_BIT_WIFI_TYPE = 9,
    INTCTRL_VODATA_INFO_BIT_IS_DATA_CARD = 10,
    INTCTRL_VODATA_INFO_BIT_MAX,
} intctrl_vodata_reg_info_bit_enum;

typedef enum {
    INTCTRL_VODATA_INFO_SSID = (1 << INTCTRL_VODATA_INFO_BIT_SSID),
    INTCTRL_VODATA_INFO_BSSID = (1 << INTCTRL_VODATA_INFO_BIT_BSSID),
    INTCTRL_VODATA_INFO_CID = (1 << INTCTRL_VODATA_INFO_BIT_CID),
    INTCTRL_VODATA_INFO_PATH_READY = (1 << INTCTRL_VODATA_INFO_BIT_PATH_READY),
    INTCTRL_VODATA_INFO_WIFI_EN = (1 << INTCTRL_VODATA_INFO_BIT_WIFI_EN),
    INTCTRL_VODATA_INFO_INTERFACE_ID = (1 << INTCTRL_VODATA_INFO_BIT_INTERFACE_ID),
    INTCTRL_VODATA_INFO_IPV4 =           (1 << INTCTRL_VODATA_INFO_BIT_IPV4_ADDR),
    INTCTRL_VODATA_INFO_IPV6 =           (1 << INTCTRL_VODATA_INFO_BIT_IPV6_ADDR),
    INTCTRL_VODATA_INFO_MTU =            (1 << INTCTRL_VODATA_INFO_BIT_MTU),
    INTCTRL_VODATA_INFO_WIFI_TYPE =       (1 << INTCTRL_VODATA_INFO_BIT_WIFI_TYPE),
    INTCTRL_VODATA_INFO_IS_DATA_CARD =       (1 << INTCTRL_VODATA_INFO_BIT_IS_DATA_CARD),
} intctrl_vodata_reg_info_enum;

typedef enum {
    INTCTRL_INTERNET_NONE = 0,
    INTCTRL_INTERNET_IPV4,
    INTCTRL_INTERNET_IPV6,
    INTCTRL_INTERNET_IPV4V6,
    INTCTRL_INTERNET_STATUS_MAX
} intctrl_internet_status_e;

typedef struct {
    kal_uint8 ssid[32]; /* get from imsi */
    kal_bool wifi_en; /* AT+ECNCFG */
    wlc_wifi_rat_type_e wifi_type; /* default is WLC_WIFI_RAT_TYPE_802_11 */
} vodata_info_t;

typedef struct {
    kal_uint8 imsi[32];
    kal_bool data_en;
}normal_data_info_t;

// MSG_ID_INTCTRL_INTERNET_INFO_QUERY_REQ
typedef struct {
    LOCAL_PARA_HDR
    intctrl_reg_type_e reg_type;
} intctrl_internet_info_query_req_struct;
// MSG_ID_INTCTRL_INTERNET_LOCK_ACQUIRE_REQ & MSG_ID_INTCTRL_INTERNET_LOCK_RELEASE_REQ
typedef intctrl_internet_info_query_req_struct intctrl_internet_lock_acquire_struct;
typedef intctrl_internet_info_query_req_struct intctrl_internet_lock_release_struct;
// MSG_ID_INTCTRL_INTERNET_INFO_QUERY_CNF
// MSG_ID_INTCTRL_INTERNET_INFO_UPDATE_IND

typedef struct {
    LOCAL_PARA_HDR
    kal_uint8 ps_id;
    kal_uint32 reg_info;
    kal_bool is_pdu_alive;
    kal_uint32 cid;
    kal_uint32 if_id;

    kal_uint32 tif_id; /* transaction id */
    intctrl_reg_type_e reg_type;
    
    kal_uint8 bssid[6]; /* default is random, then get from AP */
    intctrl_internet_status_e path_ready;
    kal_uint8 ipv4_addr[4]; /* Binary */
    kal_uint8 ipv6_addr[16]; /* Binary */

    union {
        vodata_info_t   vodata_info;
        normal_data_info_t normal_data_info;
    }data_info;

    kal_int32                       mtu;
    kal_bool is_data_card; // data is set on this ps, it will be true
} intctrl_internet_info_update_ind_struct,
    intctrl_internet_info_query_cnf_struct;

// MSG_ID_INTCTRL_INTERNET_INFO_REGISTER_REQ
typedef struct {
    LOCAL_PARA_HDR
    kal_uint32      reg_info; // intctrl_internet_reg_info_enum
    intctrl_reg_type_e reg_type;
} intctrl_internet_info_register_req_struct;
/****************************************************************************/


#endif /* __INTCTRL_USER_STRUCT_H__ */